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