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