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