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 #include "tuner-xc2028.h"
  38 #include "em28xx-reg.h"
  39
  40 /* Boards supported by driver */
  41 #define EM2800_BOARD_UNKNOWN                    0
  42 #define EM2820_BOARD_UNKNOWN                    1
  43 #define EM2820_BOARD_TERRATEC_CINERGY_250       2
  44 #define EM2820_BOARD_PINNACLE_USB_2             3
  45 #define EM2820_BOARD_HAUPPAUGE_WINTV_USB_2      4
  46 #define EM2820_BOARD_MSI_VOX_USB_2              5
  47 #define EM2800_BOARD_TERRATEC_CINERGY_200       6
  48 #define EM2800_BOARD_LEADTEK_WINFAST_USBII      7
  49 #define EM2800_BOARD_KWORLD_USB2800             8
  50 #define EM2820_BOARD_PINNACLE_DVC_90            9
  51 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900    10
  52 #define EM2880_BOARD_TERRATEC_HYBRID_XS         11
  53 #define EM2820_BOARD_KWORLD_PVRTV2800RF         12
  54 #define EM2880_BOARD_TERRATEC_PRODIGY_XS        13
  55 #define EM2820_BOARD_PROLINK_PLAYTV_USB2        14
  56 #define EM2800_BOARD_VGEAR_POCKETTV             15
  57 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_950    16
  58 #define EM2880_BOARD_PINNACLE_PCTV_HD_PRO       17
  59 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900_R2 18
  60
  61 /* Limits minimum and default number of buffers */
  62 #define EM28XX_MIN_BUF 4
  63 #define EM28XX_DEF_BUF 8
  64
  65 /* maximum number of em28xx boards */
  66 #define EM28XX_MAXBOARDS 4 /*FIXME: should be bigger */
  67
  68 /* maximum number of frames that can be queued */
  69 #define EM28XX_NUM_FRAMES 5
  70 /* number of frames that get used for v4l2_read() */
  71 #define EM28XX_NUM_READ_FRAMES 2
  72
  73 /* number of buffers for isoc transfers */
  74 #define EM28XX_NUM_BUFS 5
  75
  76 /* number of packets for each buffer
  77    windows requests only 40 packets .. so we better do the same
  78    this is what I found out for all alternate numbers there!
  79  */
  80 #define EM28XX_NUM_PACKETS 40
  81
  82 /* default alternate; 0 means choose the best */
  83 #define EM28XX_PINOUT 0
  84
  85 #define EM28XX_INTERLACED_DEFAULT 1
  86
  87 /*
  88 #define (use usbview if you want to get the other alternate number infos)
  89 #define
  90 #define alternate number 2
  91 #define                         Endpoint Address: 82
  92                         Direction: in
  93                         Attribute: 1
  94                         Type: Isoc
  95                         Max Packet Size: 1448
  96                         Interval: 125us
  97
  98   alternate number 7
  99
 100                         Endpoint Address: 82
 101                         Direction: in
 102                         Attribute: 1
 103                         Type: Isoc
 104                         Max Packet Size: 3072
 105                         Interval: 125us
 106 */
 107
 108 /* time to wait when stopping the isoc transfer */
 109 #define EM28XX_URB_TIMEOUT       msecs_to_jiffies(EM28XX_NUM_BUFS * EM28XX_NUM_PACKETS)
 110
 111 /* time in msecs to wait for i2c writes to finish */
 112 #define EM2800_I2C_WRITE_TIMEOUT 20
 113
 114 enum em28xx_mode {
 115         EM28XX_MODE_UNDEFINED,
 116         EM28XX_ANALOG_MODE,
 117         EM28XX_DIGITAL_MODE,
 118 };
 119
 120 enum em28xx_stream_state {
 121         STREAM_OFF,
 122         STREAM_INTERRUPT,
 123         STREAM_ON,
 124 };
 125
 126 struct em28xx;
 127
 128 struct em28xx_usb_isoc_ctl {
 129                 /* max packet size of isoc transaction */
 130         int                             max_pkt_size;
 131
 132                 /* number of allocated urbs */
 133         int                             num_bufs;
 134
 135                 /* urb for isoc transfers */
 136         struct urb                      **urb;
 137
 138                 /* transfer buffers for isoc transfer */
 139         char                            **transfer_buffer;
 140
 141                 /* Last buffer command and region */
 142         u8                              cmd;
 143         int                             pos, size, pktsize;
 144
 145                 /* Last field: ODD or EVEN? */
 146         int                             field;
 147
 148                 /* Stores incomplete commands */
 149         u32                             tmp_buf;
 150         int                             tmp_buf_len;
 151
 152                 /* Stores already requested buffers */
 153         struct em28xx_buffer            *buf;
 154
 155                 /* Stores the number of received fields */
 156         int                             nfields;
 157
 158                 /* isoc urb callback */
 159         int (*isoc_copy) (struct em28xx *dev, struct urb *urb);
 160
 161 };
 162
 163 struct em28xx_fmt {
 164         char  *name;
 165         u32   fourcc;          /* v4l2 format id */
 166 };
 167
 168 /* buffer for one video frame */
 169 struct em28xx_buffer {
 170         /* common v4l buffer stuff -- must be first */
 171         struct videobuf_buffer vb;
 172
 173         struct list_head frame;
 174         int top_field;
 175         int receiving;
 176 };
 177
 178 struct em28xx_dmaqueue {
 179         struct list_head       active;
 180         struct list_head       queued;
 181
 182         wait_queue_head_t          wq;
 183
 184         /* Counters to control buffer fill */
 185         int                        pos;
 186 };
 187
 188 /* io methods */
 189 enum em28xx_io_method {
 190         IO_NONE,
 191         IO_READ,
 192         IO_MMAP,
 193 };
 194
 195 /* inputs */
 196
 197 #define MAX_EM28XX_INPUT 4
 198 enum enum28xx_itype {
 199         EM28XX_VMUX_COMPOSITE1 = 1,
 200         EM28XX_VMUX_COMPOSITE2,
 201         EM28XX_VMUX_COMPOSITE3,
 202         EM28XX_VMUX_COMPOSITE4,
 203         EM28XX_VMUX_SVIDEO,
 204         EM28XX_VMUX_TELEVISION,
 205         EM28XX_VMUX_CABLE,
 206         EM28XX_VMUX_DVB,
 207         EM28XX_VMUX_DEBUG,
 208         EM28XX_RADIO,
 209 };
 210
 211 enum em28xx_amux {
 212         EM28XX_AMUX_VIDEO,
 213         EM28XX_AMUX_LINE_IN,
 214         EM28XX_AMUX_AC97_VIDEO,
 215         EM28XX_AMUX_AC97_LINE_IN,
 216 };
 217
 218 struct em28xx_input {
 219         enum enum28xx_itype type;
 220         unsigned int vmux;
 221         enum em28xx_amux amux;
 222 };
 223
 224 #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
 225
 226 enum em28xx_decoder {
 227         EM28XX_TVP5150,
 228         EM28XX_SAA7113,
 229         EM28XX_SAA7114
 230 };
 231
 232 struct em28xx_reg_seq {
 233         int reg;
 234         unsigned char val, mask;
 235         int sleep;
 236 };
 237
 238 struct em28xx_board {
 239         char *name;
 240         int vchannels;
 241         int tuner_type;
 242
 243         /* i2c flags */
 244         unsigned int tda9887_conf;
 245
 246         unsigned int is_em2800:1;
 247         unsigned int has_msp34xx:1;
 248         unsigned int mts_firmware:1;
 249         unsigned int has_12mhz_i2s:1;
 250         unsigned int max_range_640_480:1;
 251         unsigned int has_dvb:1;
 252
 253         enum em28xx_decoder decoder;
 254
 255         struct em28xx_input       input[MAX_EM28XX_INPUT];
 256         struct em28xx_input       radio;
 257 };
 258
 259 struct em28xx_eeprom {
 260         u32 id;                 /* 0x9567eb1a */
 261         u16 vendor_ID;
 262         u16 product_ID;
 263
 264         u16 chip_conf;
 265
 266         u16 board_conf;
 267
 268         u16 string1, string2, string3;
 269
 270         u8 string_idx_table;
 271 };
 272
 273 /* device states */
 274 enum em28xx_dev_state {
 275         DEV_INITIALIZED = 0x01,
 276         DEV_DISCONNECTED = 0x02,
 277         DEV_MISCONFIGURED = 0x04,
 278 };
 279
 280 #define EM28XX_AUDIO_BUFS 5
 281 #define EM28XX_NUM_AUDIO_PACKETS 64
 282 #define EM28XX_AUDIO_MAX_PACKET_SIZE 196 /* static value */
 283 #define EM28XX_CAPTURE_STREAM_EN 1
 284
 285 /* em28xx extensions */
 286 #define EM28XX_AUDIO   0x10
 287 #define EM28XX_DVB     0x20
 288
 289 struct em28xx_audio {
 290         char name[50];
 291         char *transfer_buffer[EM28XX_AUDIO_BUFS];
 292         struct urb *urb[EM28XX_AUDIO_BUFS];
 293         struct usb_device *udev;
 294         unsigned int capture_transfer_done;
 295         struct snd_pcm_substream   *capture_pcm_substream;
 296
 297         unsigned int hwptr_done_capture;
 298         struct snd_card            *sndcard;
 299
 300         int users, shutdown;
 301         enum em28xx_stream_state capture_stream;
 302         spinlock_t slock;
 303 };
 304
 305 struct em28xx;
 306
 307 struct em28xx_fh {
 308         struct em28xx *dev;
 309         unsigned int  stream_on:1;      /* Locks streams */
 310         int           radio;
 311
 312         struct videobuf_queue        vb_vidq;
 313
 314         enum v4l2_buf_type           type;
 315 };
 316
 317 /* main device struct */
 318 struct em28xx {
 319         /* generic device properties */
 320         char name[30];          /* name (including minor) of the device */
 321         int model;              /* index in the device_data struct */
 322         int devno;              /* marks the number of this device */
 323         unsigned int is_em2800:1;
 324         unsigned int has_msp34xx:1;
 325         unsigned int has_tda9887:1;
 326         unsigned int stream_on:1;       /* Locks streams */
 327         unsigned int has_audio_class:1;
 328         unsigned int has_12mhz_i2s:1;
 329         unsigned int max_range_640_480:1;
 330         unsigned int has_dvb:1;
 331
 332         /* Some older em28xx chips needs a waiting time after writing */
 333         unsigned int wait_after_write;
 334
 335         /* GPIO sequences for analog and digital mode */
 336         struct em28xx_reg_seq *analog_gpio, *digital_gpio;
 337
 338         /* GPIO sequences for tuner callbacks */
 339         struct em28xx_reg_seq *tun_analog_gpio, *tun_digital_gpio;
 340
 341         int video_inputs;       /* number of video inputs */
 342         struct list_head        devlist;
 343
 344         u32 i2s_speed;          /* I2S speed for audio digital stream */
 345
 346         enum em28xx_decoder decoder;
 347
 348         int tuner_type;         /* type of the tuner */
 349         int tuner_addr;         /* tuner address */
 350         int tda9887_conf;
 351         /* i2c i/o */
 352         struct i2c_adapter i2c_adap;
 353         struct i2c_client i2c_client;
 354         /* video for linux */
 355         int users;              /* user count for exclusive use */
 356         struct video_device *vdev;      /* video for linux device struct */
 357         v4l2_std_id norm;       /* selected tv norm */
 358         int ctl_freq;           /* selected frequency */
 359         unsigned int ctl_input; /* selected input */
 360         unsigned int ctl_ainput;        /* slected audio input */
 361         int mute;
 362         int volume;
 363         /* frame properties */
 364         int width;              /* current frame width */
 365         int height;             /* current frame height */
 366         int hscale;             /* horizontal scale factor (see datasheet) */
 367         int vscale;             /* vertical scale factor (see datasheet) */
 368         int interlaced;         /* 1=interlace fileds, 0=just top fileds */
 369         unsigned int video_bytesread;   /* Number of bytes read */
 370
 371         unsigned long hash;     /* eeprom hash - for boards with generic ID */
 372         unsigned long i2c_hash; /* i2c devicelist hash -
 373                                    for boards with generic ID */
 374
 375         struct em28xx_audio *adev;
 376
 377         /* states */
 378         enum em28xx_dev_state state;
 379         enum em28xx_io_method io;
 380
 381         struct work_struct         request_module_wk;
 382
 383         /* locks */
 384         struct mutex lock;
 385         /* spinlock_t queue_lock; */
 386         struct list_head inqueue, outqueue;
 387         wait_queue_head_t open, wait_frame, wait_stream;
 388         struct video_device *vbi_dev;
 389         struct video_device *radio_dev;
 390
 391         unsigned char eedata[256];
 392
 393         /* Isoc control struct */
 394         struct em28xx_dmaqueue vidq;
 395         struct em28xx_usb_isoc_ctl isoc_ctl;
 396         spinlock_t slock;
 397
 398         /* usb transfer */
 399         struct usb_device *udev;        /* the usb device */
 400         int alt;                /* alternate */
 401         int max_pkt_size;       /* max packet size of isoc transaction */
 402         int num_alt;            /* Number of alternative settings */
 403         unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
 404         struct urb *urb[EM28XX_NUM_BUFS];       /* urb for isoc transfers */
 405         char *transfer_buffer[EM28XX_NUM_BUFS]; /* transfer buffers for isoc transfer */
 406         /* helper funcs that call usb_control_msg */
 407         int (*em28xx_write_regs) (struct em28xx *dev, u16 reg,
 408                                         char *buf, int len);
 409         int (*em28xx_read_reg) (struct em28xx *dev, u16 reg);
 410         int (*em28xx_read_reg_req_len) (struct em28xx *dev, u8 req, u16 reg,
 411                                         char *buf, int len);
 412         int (*em28xx_write_regs_req) (struct em28xx *dev, u8 req, u16 reg,
 413                                       char *buf, int len);
 414         int (*em28xx_read_reg_req) (struct em28xx *dev, u8 req, u16 reg);
 415
 416         enum em28xx_mode mode;
 417
 418         /* Caches GPO and GPIO registers */
 419         unsigned char   reg_gpo, reg_gpio;
 420
 421         struct em28xx_dvb *dvb;
 422 };
 423
 424 struct em28xx_ops {
 425         struct list_head next;
 426         char *name;
 427         int id;
 428         int (*init)(struct em28xx *);
 429         int (*fini)(struct em28xx *);
 430 };
 431
 432 /* Provided by em28xx-i2c.c */
 433
 434 void em28xx_i2c_call_clients(struct em28xx *dev, unsigned int cmd, void *arg);
 435 void em28xx_do_i2c_scan(struct em28xx *dev);
 436 int em28xx_i2c_register(struct em28xx *dev);
 437 int em28xx_i2c_unregister(struct em28xx *dev);
 438
 439 /* Provided by em28xx-core.c */
 440
 441 u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
 442 void em28xx_queue_unusedframes(struct em28xx *dev);
 443 void em28xx_release_buffers(struct em28xx *dev);
 444
 445 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
 446                             char *buf, int len);
 447 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
 448 int em28xx_read_reg(struct em28xx *dev, u16 reg);
 449 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
 450                           int len);
 451 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
 452 int em28xx_audio_analog_set(struct em28xx *dev);
 453
 454 int em28xx_colorlevels_set_default(struct em28xx *dev);
 455 int em28xx_capture_start(struct em28xx *dev, int start);
 456 int em28xx_outfmt_set_yuv422(struct em28xx *dev);
 457 int em28xx_resolution_set(struct em28xx *dev);
 458 int em28xx_set_alternate(struct em28xx *dev);
 459 int em28xx_init_isoc(struct em28xx *dev, int max_packets,
 460                      int num_bufs, int max_pkt_size,
 461                      int (*isoc_copy) (struct em28xx *dev, struct urb *urb));
 462 void em28xx_uninit_isoc(struct em28xx *dev);
 463 int em28xx_set_mode(struct em28xx *dev, enum em28xx_mode set_mode);
 464 int em28xx_gpio_set(struct em28xx *dev, struct em28xx_reg_seq *gpio);
 465
 466 /* Provided by em28xx-video.c */
 467 int em28xx_register_extension(struct em28xx_ops *dev);
 468 void em28xx_unregister_extension(struct em28xx_ops *dev);
 469
 470 /* Provided by em28xx-cards.c */
 471 extern int em2800_variant_detect(struct usb_device *udev, int model);
 472 extern void em28xx_pre_card_setup(struct em28xx *dev);
 473 extern void em28xx_card_setup(struct em28xx *dev);
 474 extern struct em28xx_board em28xx_boards[];
 475 extern struct usb_device_id em28xx_id_table[];
 476 extern const unsigned int em28xx_bcount;
 477 void em28xx_set_ir(struct em28xx *dev, struct IR_i2c *ir);
 478 int em28xx_tuner_callback(void *ptr, int command, int arg);
 479
 480 /* Provided by em28xx-input.c */
 481 /* TODO: Check if the standard get_key handlers on ir-common can be used */
 482 int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
 483 int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
 484 int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
 485                                      u32 *ir_raw);
 486
 487 /* printk macros */
 488
 489 #define em28xx_err(fmt, arg...) do {\
 490         printk(KERN_ERR fmt , ##arg); } while (0)
 491
 492 #define em28xx_errdev(fmt, arg...) do {\
 493         printk(KERN_ERR "%s: "fmt,\
 494                         dev->name , ##arg); } while (0)
 495
 496 #define em28xx_info(fmt, arg...) do {\
 497         printk(KERN_INFO "%s: "fmt,\
 498                         dev->name , ##arg); } while (0)
 499 #define em28xx_warn(fmt, arg...) do {\
 500         printk(KERN_WARNING "%s: "fmt,\
 501                         dev->name , ##arg); } while (0)
 502
 503 static inline int em28xx_compression_disable(struct em28xx *dev)
 504 {
 505         /* side effect of disabling scaler and mixer */
 506         return em28xx_write_regs(dev, EM28XX_R26_COMPR, "\x00", 1);
 507 }
 508
 509 static inline int em28xx_contrast_get(struct em28xx *dev)
 510 {
 511         return em28xx_read_reg(dev, EM28XX_R20_YGAIN) & 0x1f;
 512 }
 513
 514 static inline int em28xx_brightness_get(struct em28xx *dev)
 515 {
 516         return em28xx_read_reg(dev, EM28XX_R21_YOFFSET);
 517 }
 518
 519 static inline int em28xx_saturation_get(struct em28xx *dev)
 520 {
 521         return em28xx_read_reg(dev, EM28XX_R22_UVGAIN) & 0x1f;
 522 }
 523
 524 static inline int em28xx_u_balance_get(struct em28xx *dev)
 525 {
 526         return em28xx_read_reg(dev, EM28XX_R23_UOFFSET);
 527 }
 528
 529 static inline int em28xx_v_balance_get(struct em28xx *dev)
 530 {
 531         return em28xx_read_reg(dev, EM28XX_R24_VOFFSET);
 532 }
 533
 534 static inline int em28xx_gamma_get(struct em28xx *dev)
 535 {
 536         return em28xx_read_reg(dev, EM28XX_R14_GAMMA) & 0x3f;
 537 }
 538
 539 static inline int em28xx_contrast_set(struct em28xx *dev, s32 val)
 540 {
 541         u8 tmp = (u8) val;
 542         return em28xx_write_regs(dev, EM28XX_R20_YGAIN, &tmp, 1);
 543 }
 544
 545 static inline int em28xx_brightness_set(struct em28xx *dev, s32 val)
 546 {
 547         u8 tmp = (u8) val;
 548         return em28xx_write_regs(dev, EM28XX_R21_YOFFSET, &tmp, 1);
 549 }
 550
 551 static inline int em28xx_saturation_set(struct em28xx *dev, s32 val)
 552 {
 553         u8 tmp = (u8) val;
 554         return em28xx_write_regs(dev, EM28XX_R22_UVGAIN, &tmp, 1);
 555 }
 556
 557 static inline int em28xx_u_balance_set(struct em28xx *dev, s32 val)
 558 {
 559         u8 tmp = (u8) val;
 560         return em28xx_write_regs(dev, EM28XX_R23_UOFFSET, &tmp, 1);
 561 }
 562
 563 static inline int em28xx_v_balance_set(struct em28xx *dev, s32 val)
 564 {
 565         u8 tmp = (u8) val;
 566         return em28xx_write_regs(dev, EM28XX_R24_VOFFSET, &tmp, 1);
 567 }
 568
 569 static inline int em28xx_gamma_set(struct em28xx *dev, s32 val)
 570 {
 571         u8 tmp = (u8) val;
 572         return em28xx_write_regs(dev, EM28XX_R14_GAMMA, &tmp, 1);
 573 }
 574
 575 /*FIXME: maxw should be dependent of alt mode */
 576 static inline unsigned int norm_maxw(struct em28xx *dev)
 577 {
 578         if (dev->max_range_640_480)
 579                 return 640;
 580         else
 581                 return 720;
 582 }
 583
 584 static inline unsigned int norm_maxh(struct em28xx *dev)
 585 {
 586         if (dev->max_range_640_480)
 587                 return 480;
 588         else
 589                 return (dev->norm & V4L2_STD_625_50) ? 576 : 480;
 590 }
 591 #endif