drivers/media/video/em28xx/em28xx.h

   1 /*
   2    em28xx.h - driver for Empia EM2800/EM2820/2840 USB video capture devices
   3
   4    Copyright (C) 2005 Markus Rechberger <mrechberger@gmail.com>
   5                       Ludovico Cavedon <cavedon@sssup.it>
   6                       Mauro Carvalho Chehab <mchehab@infradead.org>
   7
   8    Based on the em2800 driver from Sascha Sommer <saschasommer@freenet.de>
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 2 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program; if not, write to the Free Software
  22    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  23  */
  24
  25 #ifndef _EM28XX_H
  26 #define _EM28XX_H
  27
  28 #include <linux/videodev2.h>
  29 #include <media/videobuf-vmalloc.h>
  30
  31 #include <linux/i2c.h>
  32 #include <linux/mutex.h>
  33 #include <media/ir-kbd-i2c.h>
  34 #if defined(CONFIG_VIDEO_EM28XX_DVB) || defined(CONFIG_VIDEO_EM28XX_DVB_MODULE)
  35 #include <media/videobuf-dvb.h>
  36 #endif
  37
  38 /* Boards supported by driver */
  39 #define EM2800_BOARD_UNKNOWN                    0
  40 #define EM2820_BOARD_UNKNOWN                    1
  41 #define EM2820_BOARD_TERRATEC_CINERGY_250       2
  42 #define EM2820_BOARD_PINNACLE_USB_2             3
  43 #define EM2820_BOARD_HAUPPAUGE_WINTV_USB_2      4
  44 #define EM2820_BOARD_MSI_VOX_USB_2              5
  45 #define EM2800_BOARD_TERRATEC_CINERGY_200       6
  46 #define EM2800_BOARD_LEADTEK_WINFAST_USBII      7
  47 #define EM2800_BOARD_KWORLD_USB2800             8
  48 #define EM2820_BOARD_PINNACLE_DVC_90            9
  49 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900    10
  50 #define EM2880_BOARD_TERRATEC_HYBRID_XS         11
  51 #define EM2820_BOARD_KWORLD_PVRTV2800RF         12
  52 #define EM2880_BOARD_TERRATEC_PRODIGY_XS        13
  53 #define EM2820_BOARD_PROLINK_PLAYTV_USB2        14
  54 #define EM2800_BOARD_VGEAR_POCKETTV             15
  55 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_950    16
  56
  57 /* Limits minimum and default number of buffers */
  58 #define EM28XX_MIN_BUF 4
  59 #define EM28XX_DEF_BUF 8
  60
  61 /* maximum number of em28xx boards */
  62 #define EM28XX_MAXBOARDS 4 /*FIXME: should be bigger */
  63
  64 /* maximum number of frames that can be queued */
  65 #define EM28XX_NUM_FRAMES 5
  66 /* number of frames that get used for v4l2_read() */
  67 #define EM28XX_NUM_READ_FRAMES 2
  68
  69 /* number of buffers for isoc transfers */
  70 #define EM28XX_NUM_BUFS 5
  71
  72 /* number of packets for each buffer
  73    windows requests only 40 packets .. so we better do the same
  74    this is what I found out for all alternate numbers there!
  75  */
  76 #define EM28XX_NUM_PACKETS 40
  77
  78 /* default alternate; 0 means choose the best */
  79 #define EM28XX_PINOUT 0
  80
  81 #define EM28XX_INTERLACED_DEFAULT 1
  82
  83 /*
  84 #define (use usbview if you want to get the other alternate number infos)
  85 #define
  86 #define alternate number 2
  87 #define                         Endpoint Address: 82
  88                         Direction: in
  89                         Attribute: 1
  90                         Type: Isoc
  91                         Max Packet Size: 1448
  92                         Interval: 125us
  93
  94   alternate number 7
  95
  96                         Endpoint Address: 82
  97                         Direction: in
  98                         Attribute: 1
  99                         Type: Isoc
 100                         Max Packet Size: 3072
 101                         Interval: 125us
 102 */
 103
 104 /* time to wait when stopping the isoc transfer */
 105 #define EM28XX_URB_TIMEOUT       msecs_to_jiffies(EM28XX_NUM_BUFS * EM28XX_NUM_PACKETS)
 106
 107 /* time in msecs to wait for i2c writes to finish */
 108 #define EM2800_I2C_WRITE_TIMEOUT 20
 109
 110 enum em28xx_mode {
 111         EM28XX_ANALOG_MODE,
 112         EM28XX_DIGITAL_MODE,
 113 };
 114
 115 enum em28xx_stream_state {
 116         STREAM_OFF,
 117         STREAM_INTERRUPT,
 118         STREAM_ON,
 119 };
 120
 121 struct em28xx_usb_isoc_ctl {
 122                 /* max packet size of isoc transaction */
 123         int                             max_pkt_size;
 124
 125                 /* number of allocated urbs */
 126         int                             num_bufs;
 127
 128                 /* urb for isoc transfers */
 129         struct urb                      **urb;
 130
 131                 /* transfer buffers for isoc transfer */
 132         char                            **transfer_buffer;
 133
 134                 /* Last buffer command and region */
 135         u8                              cmd;
 136         int                             pos, size, pktsize;
 137
 138                 /* Last field: ODD or EVEN? */
 139         int                             field;
 140
 141                 /* Stores incomplete commands */
 142         u32                             tmp_buf;
 143         int                             tmp_buf_len;
 144
 145                 /* Stores already requested buffers */
 146         struct em28xx_buffer            *buf;
 147
 148                 /* Stores the number of received fields */
 149         int                             nfields;
 150 };
 151
 152 struct em28xx_fmt {
 153         char  *name;
 154         u32   fourcc;          /* v4l2 format id */
 155 };
 156
 157 /* buffer for one video frame */
 158 struct em28xx_buffer {
 159         /* common v4l buffer stuff -- must be first */
 160         struct videobuf_buffer vb;
 161
 162         struct list_head frame;
 163         int top_field;
 164         int receiving;
 165 };
 166
 167 struct em28xx_dmaqueue {
 168         struct list_head       active;
 169         struct list_head       queued;
 170
 171         wait_queue_head_t          wq;
 172
 173         /* Counters to control buffer fill */
 174         int                        pos;
 175 };
 176
 177 /* io methods */
 178 enum em28xx_io_method {
 179         IO_NONE,
 180         IO_READ,
 181         IO_MMAP,
 182 };
 183
 184 /* inputs */
 185
 186 #define MAX_EM28XX_INPUT 4
 187 enum enum28xx_itype {
 188         EM28XX_VMUX_COMPOSITE1 = 1,
 189         EM28XX_VMUX_COMPOSITE2,
 190         EM28XX_VMUX_COMPOSITE3,
 191         EM28XX_VMUX_COMPOSITE4,
 192         EM28XX_VMUX_SVIDEO,
 193         EM28XX_VMUX_TELEVISION,
 194         EM28XX_VMUX_CABLE,
 195         EM28XX_VMUX_DVB,
 196         EM28XX_VMUX_DEBUG,
 197         EM28XX_RADIO,
 198 };
 199
 200 enum em28xx_amux {
 201         EM28XX_AMUX_VIDEO,
 202         EM28XX_AMUX_LINE_IN,
 203         EM28XX_AMUX_AC97_VIDEO,
 204         EM28XX_AMUX_AC97_LINE_IN,
 205 };
 206
 207 struct em28xx_input {
 208         enum enum28xx_itype type;
 209         unsigned int vmux;
 210         enum em28xx_amux amux;
 211 };
 212
 213 #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
 214
 215 enum em28xx_decoder {
 216         EM28XX_TVP5150,
 217         EM28XX_SAA7113,
 218         EM28XX_SAA7114
 219 };
 220
 221 struct em28xx_board {
 222         char *name;
 223         int vchannels;
 224         int tuner_type;
 225
 226         /* i2c flags */
 227         unsigned int tda9887_conf;
 228
 229         unsigned int is_em2800:1;
 230         unsigned int has_msp34xx:1;
 231         unsigned int mts_firmware:1;
 232         unsigned int has_12mhz_i2s:1;
 233         unsigned int max_range_640_480:1;
 234         unsigned int has_dvb:1;
 235
 236         unsigned int analog_gpio;
 237
 238         enum em28xx_decoder decoder;
 239
 240         struct em28xx_input       input[MAX_EM28XX_INPUT];
 241         struct em28xx_input       radio;
 242 };
 243
 244 struct em28xx_eeprom {
 245         u32 id;                 /* 0x9567eb1a */
 246         u16 vendor_ID;
 247         u16 product_ID;
 248
 249         u16 chip_conf;
 250
 251         u16 board_conf;
 252
 253         u16 string1, string2, string3;
 254
 255         u8 string_idx_table;
 256 };
 257
 258 /* device states */
 259 enum em28xx_dev_state {
 260         DEV_INITIALIZED = 0x01,
 261         DEV_DISCONNECTED = 0x02,
 262         DEV_MISCONFIGURED = 0x04,
 263 };
 264
 265 #define EM28XX_AUDIO_BUFS 5
 266 #define EM28XX_NUM_AUDIO_PACKETS 64
 267 #define EM28XX_AUDIO_MAX_PACKET_SIZE 196 /* static value */
 268 #define EM28XX_CAPTURE_STREAM_EN 1
 269
 270 /* em28xx extensions */
 271 #define EM28XX_AUDIO   0x10
 272 #define EM28XX_DVB     0x20
 273
 274 struct em28xx_audio {
 275         char name[50];
 276         char *transfer_buffer[EM28XX_AUDIO_BUFS];
 277         struct urb *urb[EM28XX_AUDIO_BUFS];
 278         struct usb_device *udev;
 279         unsigned int capture_transfer_done;
 280         struct snd_pcm_substream   *capture_pcm_substream;
 281
 282         unsigned int hwptr_done_capture;
 283         struct snd_card            *sndcard;
 284
 285         int users, shutdown;
 286         enum em28xx_stream_state capture_stream;
 287         spinlock_t slock;
 288 };
 289
 290 /* main device struct */
 291 struct em28xx {
 292         /* generic device properties */
 293         char name[30];          /* name (including minor) of the device */
 294         int model;              /* index in the device_data struct */
 295         int devno;              /* marks the number of this device */
 296         unsigned int analog_gpio;
 297         unsigned int is_em2800:1;
 298         unsigned int has_msp34xx:1;
 299         unsigned int has_tda9887:1;
 300         unsigned int stream_on:1;       /* Locks streams */
 301         unsigned int has_audio_class:1;
 302         unsigned int has_12mhz_i2s:1;
 303         unsigned int max_range_640_480:1;
 304         unsigned int has_dvb:1;
 305
 306         int video_inputs;       /* number of video inputs */
 307         struct list_head        devlist;
 308
 309         u32 i2s_speed;          /* I2S speed for audio digital stream */
 310
 311         enum em28xx_decoder decoder;
 312
 313         int tuner_type;         /* type of the tuner */
 314         int tuner_addr;         /* tuner address */
 315         int tda9887_conf;
 316         /* i2c i/o */
 317         struct i2c_adapter i2c_adap;
 318         struct i2c_client i2c_client;
 319         /* video for linux */
 320         int users;              /* user count for exclusive use */
 321         struct video_device *vdev;      /* video for linux device struct */
 322         v4l2_std_id norm;       /* selected tv norm */
 323         int ctl_freq;           /* selected frequency */
 324         unsigned int ctl_input; /* selected input */
 325         unsigned int ctl_ainput;        /* slected audio input */
 326         int mute;
 327         int volume;
 328         /* frame properties */
 329         int width;              /* current frame width */
 330         int height;             /* current frame height */
 331         int hscale;             /* horizontal scale factor (see datasheet) */
 332         int vscale;             /* vertical scale factor (see datasheet) */
 333         int interlaced;         /* 1=interlace fileds, 0=just top fileds */
 334         unsigned int video_bytesread;   /* Number of bytes read */
 335
 336         unsigned long hash;     /* eeprom hash - for boards with generic ID */
 337         unsigned long i2c_hash; /* i2c devicelist hash - for boards with generic ID */
 338
 339         struct em28xx_audio *adev;
 340
 341         /* states */
 342         enum em28xx_dev_state state;
 343         enum em28xx_io_method io;
 344
 345         struct work_struct         request_module_wk;
 346
 347         /* locks */
 348         struct mutex lock;
 349         /* spinlock_t queue_lock; */
 350         struct list_head inqueue, outqueue;
 351         wait_queue_head_t open, wait_frame, wait_stream;
 352         struct video_device *vbi_dev;
 353         struct video_device *radio_dev;
 354
 355         unsigned char eedata[256];
 356
 357         /* Isoc control struct */
 358         struct em28xx_dmaqueue vidq;
 359         struct em28xx_usb_isoc_ctl isoc_ctl;
 360         spinlock_t slock;
 361
 362         /* usb transfer */
 363         struct usb_device *udev;        /* the usb device */
 364         int alt;                /* alternate */
 365         int max_pkt_size;       /* max packet size of isoc transaction */
 366         int num_alt;            /* Number of alternative settings */
 367         unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
 368         struct urb *urb[EM28XX_NUM_BUFS];       /* urb for isoc transfers */
 369         char *transfer_buffer[EM28XX_NUM_BUFS]; /* transfer buffers for isoc transfer */
 370         /* helper funcs that call usb_control_msg */
 371         int (*em28xx_write_regs) (struct em28xx * dev, u16 reg, char *buf,
 372                                   int len);
 373         int (*em28xx_read_reg) (struct em28xx * dev, u16 reg);
 374         int (*em28xx_read_reg_req_len) (struct em28xx * dev, u8 req, u16 reg,
 375                                         char *buf, int len);
 376         int (*em28xx_write_regs_req) (struct em28xx * dev, u8 req, u16 reg,
 377                                       char *buf, int len);
 378         int (*em28xx_read_reg_req) (struct em28xx * dev, u8 req, u16 reg);
 379
 380         enum em28xx_mode mode;
 381
 382 #if defined(CONFIG_VIDEO_EM28XX_DVB) || defined(CONFIG_VIDEO_EM28XX_DVB_MODULE)
 383         struct videobuf_dvb        dvb;
 384         struct videobuf_queue_ops  *qops;
 385 #endif
 386 };
 387
 388 struct em28xx_fh {
 389         struct em28xx *dev;
 390         unsigned int  stream_on:1;      /* Locks streams */
 391         int           radio;
 392
 393         struct videobuf_queue        vb_vidq;
 394
 395         enum v4l2_buf_type           type;
 396 };
 397
 398 struct em28xx_ops {
 399         struct list_head next;
 400         char *name;
 401         int id;
 402         int (*init)(struct em28xx *);
 403         int (*fini)(struct em28xx *);
 404 };
 405
 406 /* Provided by em28xx-i2c.c */
 407
 408 void em28xx_i2c_call_clients(struct em28xx *dev, unsigned int cmd, void *arg);
 409 void em28xx_do_i2c_scan(struct em28xx *dev);
 410 int em28xx_i2c_register(struct em28xx *dev);
 411 int em28xx_i2c_unregister(struct em28xx *dev);
 412
 413 /* Provided by em28xx-core.c */
 414
 415 u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
 416 void em28xx_queue_unusedframes(struct em28xx *dev);
 417 void em28xx_release_buffers(struct em28xx *dev);
 418
 419 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
 420                             char *buf, int len);
 421 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
 422 int em28xx_read_reg(struct em28xx *dev, u16 reg);
 423 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
 424                           int len);
 425 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
 426 int em28xx_audio_analog_set(struct em28xx *dev);
 427
 428 int em28xx_colorlevels_set_default(struct em28xx *dev);
 429 int em28xx_capture_start(struct em28xx *dev, int start);
 430 int em28xx_outfmt_set_yuv422(struct em28xx *dev);
 431 int em28xx_resolution_set(struct em28xx *dev);
 432 int em28xx_set_alternate(struct em28xx *dev);
 433
 434 /* Provided by em28xx-video.c */
 435 int em28xx_register_extension(struct em28xx_ops *dev);
 436 void em28xx_unregister_extension(struct em28xx_ops *dev);
 437
 438 /* Provided by em28xx-cards.c */
 439 extern int em2800_variant_detect(struct usb_device* udev,int model);
 440 extern void em28xx_pre_card_setup(struct em28xx *dev);
 441 extern void em28xx_card_setup(struct em28xx *dev);
 442 extern struct em28xx_board em28xx_boards[];
 443 extern struct usb_device_id em28xx_id_table[];
 444 extern const unsigned int em28xx_bcount;
 445 void em28xx_set_ir(struct em28xx *dev, struct IR_i2c *ir);
 446
 447 /* Provided by em28xx-input.c */
 448 /* TODO: Check if the standard get_key handlers on ir-common can be used */
 449 int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
 450 int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
 451 int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
 452                                      u32 *ir_raw);
 453
 454 /* em2800 registers */
 455 #define EM2800_AUDIOSRC_REG 0x08
 456
 457 /* em28xx registers */
 458 #define I2C_CLK_REG     0x06
 459 #define CHIPID_REG      0x0a
 460 #define USBSUSP_REG     0x0c    /* */
 461
 462 #define AUDIOSRC_REG    0x0e
 463 #define XCLK_REG        0x0f
 464
 465 #define VINMODE_REG     0x10
 466 #define VINCTRL_REG     0x11
 467 #define VINENABLE_REG   0x12    /* */
 468
 469 #define GAMMA_REG       0x14
 470 #define RGAIN_REG       0x15
 471 #define GGAIN_REG       0x16
 472 #define BGAIN_REG       0x17
 473 #define ROFFSET_REG     0x18
 474 #define GOFFSET_REG     0x19
 475 #define BOFFSET_REG     0x1a
 476
 477 #define OFLOW_REG       0x1b
 478 #define HSTART_REG      0x1c
 479 #define VSTART_REG      0x1d
 480 #define CWIDTH_REG      0x1e
 481 #define CHEIGHT_REG     0x1f
 482
 483 #define YGAIN_REG       0x20
 484 #define YOFFSET_REG     0x21
 485 #define UVGAIN_REG      0x22
 486 #define UOFFSET_REG     0x23
 487 #define VOFFSET_REG     0x24
 488 #define SHARPNESS_REG   0x25
 489
 490 #define COMPR_REG       0x26
 491 #define OUTFMT_REG      0x27
 492
 493 #define XMIN_REG        0x28
 494 #define XMAX_REG        0x29
 495 #define YMIN_REG        0x2a
 496 #define YMAX_REG        0x2b
 497
 498 #define HSCALELOW_REG   0x30
 499 #define HSCALEHIGH_REG  0x31
 500 #define VSCALELOW_REG   0x32
 501 #define VSCALEHIGH_REG  0x33
 502
 503 #define AC97LSB_REG     0x40
 504 #define AC97MSB_REG     0x41
 505 #define AC97ADDR_REG    0x42
 506 #define AC97BUSY_REG    0x43
 507
 508 /* em202 registers */
 509 #define MASTER_AC97     0x02
 510 #define LINE_IN_AC97    0x10
 511 #define VIDEO_AC97      0x14
 512
 513 /* register settings */
 514 #define EM2800_AUDIO_SRC_TUNER  0x0d
 515 #define EM2800_AUDIO_SRC_LINE   0x0c
 516 #define EM28XX_AUDIO_SRC_TUNER  0xc0
 517 #define EM28XX_AUDIO_SRC_LINE   0x80
 518
 519 /* printk macros */
 520
 521 #define em28xx_err(fmt, arg...) do {\
 522         printk(KERN_ERR fmt , ##arg); } while (0)
 523
 524 #define em28xx_errdev(fmt, arg...) do {\
 525         printk(KERN_ERR "%s: "fmt,\
 526                         dev->name , ##arg); } while (0)
 527
 528 #define em28xx_info(fmt, arg...) do {\
 529         printk(KERN_INFO "%s: "fmt,\
 530                         dev->name , ##arg); } while (0)
 531 #define em28xx_warn(fmt, arg...) do {\
 532         printk(KERN_WARNING "%s: "fmt,\
 533                         dev->name , ##arg); } while (0)
 534
 535 inline static int em28xx_compression_disable(struct em28xx *dev)
 536 {
 537         /* side effect of disabling scaler and mixer */
 538         return em28xx_write_regs(dev, COMPR_REG, "\x00", 1);
 539 }
 540
 541 inline static int em28xx_contrast_get(struct em28xx *dev)
 542 {
 543         return em28xx_read_reg(dev, YGAIN_REG) & 0x1f;
 544 }
 545
 546 inline static int em28xx_brightness_get(struct em28xx *dev)
 547 {
 548         return em28xx_read_reg(dev, YOFFSET_REG);
 549 }
 550
 551 inline static int em28xx_saturation_get(struct em28xx *dev)
 552 {
 553         return em28xx_read_reg(dev, UVGAIN_REG) & 0x1f;
 554 }
 555
 556 inline static int em28xx_u_balance_get(struct em28xx *dev)
 557 {
 558         return em28xx_read_reg(dev, UOFFSET_REG);
 559 }
 560
 561 inline static int em28xx_v_balance_get(struct em28xx *dev)
 562 {
 563         return em28xx_read_reg(dev, VOFFSET_REG);
 564 }
 565
 566 inline static int em28xx_gamma_get(struct em28xx *dev)
 567 {
 568         return em28xx_read_reg(dev, GAMMA_REG) & 0x3f;
 569 }
 570
 571 inline static int em28xx_contrast_set(struct em28xx *dev, s32 val)
 572 {
 573         u8 tmp = (u8) val;
 574         return em28xx_write_regs(dev, YGAIN_REG, &tmp, 1);
 575 }
 576
 577 inline static int em28xx_brightness_set(struct em28xx *dev, s32 val)
 578 {
 579         u8 tmp = (u8) val;
 580         return em28xx_write_regs(dev, YOFFSET_REG, &tmp, 1);
 581 }
 582
 583 inline static int em28xx_saturation_set(struct em28xx *dev, s32 val)
 584 {
 585         u8 tmp = (u8) val;
 586         return em28xx_write_regs(dev, UVGAIN_REG, &tmp, 1);
 587 }
 588
 589 inline static int em28xx_u_balance_set(struct em28xx *dev, s32 val)
 590 {
 591         u8 tmp = (u8) val;
 592         return em28xx_write_regs(dev, UOFFSET_REG, &tmp, 1);
 593 }
 594
 595 inline static int em28xx_v_balance_set(struct em28xx *dev, s32 val)
 596 {
 597         u8 tmp = (u8) val;
 598         return em28xx_write_regs(dev, VOFFSET_REG, &tmp, 1);
 599 }
 600
 601 inline static int em28xx_gamma_set(struct em28xx *dev, s32 val)
 602 {
 603         u8 tmp = (u8) val;
 604         return em28xx_write_regs(dev, GAMMA_REG, &tmp, 1);
 605 }
 606
 607 /*FIXME: maxw should be dependent of alt mode */
 608 inline static unsigned int norm_maxw(struct em28xx *dev)
 609 {
 610         if (dev->max_range_640_480)
 611                 return 640;
 612         else
 613                 return 720;
 614 }
 615
 616 inline static unsigned int norm_maxh(struct em28xx *dev)
 617 {
 618         if (dev->max_range_640_480)
 619                 return 480;
 620         else
 621                 return (dev->norm & V4L2_STD_625_50) ? 576 : 480;
 622 }
 623 #endif