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/workqueue.h>
  29 #include <linux/i2c.h>
  30 #include <linux/mutex.h>
  31 #include <linux/videodev2.h>
  32
  33 #include <media/videobuf-vmalloc.h>
  34 #include <media/v4l2-device.h>
  35 #include <media/ir-kbd-i2c.h>
  36 #include <media/rc-core.h>
  37 #if defined(CONFIG_VIDEO_EM28XX_DVB) || defined(CONFIG_VIDEO_EM28XX_DVB_MODULE)
  38 #include <media/videobuf-dvb.h>
  39 #endif
  40 #include "tuner-xc2028.h"
  41 #include "em28xx-reg.h"
  42
  43 /* Boards supported by driver */
  44 #define EM2800_BOARD_UNKNOWN                    0
  45 #define EM2820_BOARD_UNKNOWN                    1
  46 #define EM2820_BOARD_TERRATEC_CINERGY_250       2
  47 #define EM2820_BOARD_PINNACLE_USB_2             3
  48 #define EM2820_BOARD_HAUPPAUGE_WINTV_USB_2      4
  49 #define EM2820_BOARD_MSI_VOX_USB_2              5
  50 #define EM2800_BOARD_TERRATEC_CINERGY_200       6
  51 #define EM2800_BOARD_LEADTEK_WINFAST_USBII      7
  52 #define EM2800_BOARD_KWORLD_USB2800             8
  53 #define EM2820_BOARD_PINNACLE_DVC_90            9
  54 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900    10
  55 #define EM2880_BOARD_TERRATEC_HYBRID_XS         11
  56 #define EM2820_BOARD_KWORLD_PVRTV2800RF         12
  57 #define EM2880_BOARD_TERRATEC_PRODIGY_XS        13
  58 #define EM2820_BOARD_PROLINK_PLAYTV_USB2        14
  59 #define EM2800_BOARD_VGEAR_POCKETTV             15
  60 #define EM2883_BOARD_HAUPPAUGE_WINTV_HVR_950    16
  61 #define EM2880_BOARD_PINNACLE_PCTV_HD_PRO       17
  62 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900_R2 18
  63 #define EM2860_BOARD_SAA711X_REFERENCE_DESIGN   19
  64 #define EM2880_BOARD_AMD_ATI_TV_WONDER_HD_600   20
  65 #define EM2800_BOARD_GRABBEEX_USB2800           21
  66 #define EM2750_BOARD_UNKNOWN                      22
  67 #define EM2750_BOARD_DLCW_130                     23
  68 #define EM2820_BOARD_DLINK_USB_TV                 24
  69 #define EM2820_BOARD_GADMEI_UTV310                25
  70 #define EM2820_BOARD_HERCULES_SMART_TV_USB2       26
  71 #define EM2820_BOARD_PINNACLE_USB_2_FM1216ME      27
  72 #define EM2820_BOARD_LEADTEK_WINFAST_USBII_DELUXE 28
  73 #define EM2860_BOARD_TVP5150_REFERENCE_DESIGN     29
  74 #define EM2820_BOARD_VIDEOLOGY_20K14XUSB          30
  75 #define EM2821_BOARD_USBGEAR_VD204                31
  76 #define EM2821_BOARD_SUPERCOMP_USB_2              32
  77 #define EM2860_BOARD_ELGATO_VIDEO_CAPTURE         33
  78 #define EM2860_BOARD_TERRATEC_HYBRID_XS           34
  79 #define EM2860_BOARD_TYPHOON_DVD_MAKER            35
  80 #define EM2860_BOARD_NETGMBH_CAM                  36
  81 #define EM2860_BOARD_GADMEI_UTV330                37
  82 #define EM2861_BOARD_YAKUMO_MOVIE_MIXER           38
  83 #define EM2861_BOARD_KWORLD_PVRTV_300U            39
  84 #define EM2861_BOARD_PLEXTOR_PX_TV100U            40
  85 #define EM2870_BOARD_KWORLD_350U                  41
  86 #define EM2870_BOARD_KWORLD_355U                  42
  87 #define EM2870_BOARD_TERRATEC_XS                  43
  88 #define EM2870_BOARD_TERRATEC_XS_MT2060           44
  89 #define EM2870_BOARD_PINNACLE_PCTV_DVB            45
  90 #define EM2870_BOARD_COMPRO_VIDEOMATE             46
  91 #define EM2880_BOARD_KWORLD_DVB_305U              47
  92 #define EM2880_BOARD_KWORLD_DVB_310U              48
  93 #define EM2880_BOARD_MSI_DIGIVOX_AD               49
  94 #define EM2880_BOARD_MSI_DIGIVOX_AD_II            50
  95 #define EM2880_BOARD_TERRATEC_HYBRID_XS_FR        51
  96 #define EM2881_BOARD_DNT_DA2_HYBRID               52
  97 #define EM2881_BOARD_PINNACLE_HYBRID_PRO          53
  98 #define EM2882_BOARD_KWORLD_VS_DVBT               54
  99 #define EM2882_BOARD_TERRATEC_HYBRID_XS           55
 100 #define EM2882_BOARD_PINNACLE_HYBRID_PRO_330E     56
 101 #define EM2883_BOARD_KWORLD_HYBRID_330U                  57
 102 #define EM2820_BOARD_COMPRO_VIDEOMATE_FORYOU      58
 103 #define EM2883_BOARD_HAUPPAUGE_WINTV_HVR_850      60
 104 #define EM2820_BOARD_PROLINK_PLAYTV_BOX4_USB2     61
 105 #define EM2820_BOARD_GADMEI_TVR200                62
 106 #define EM2860_BOARD_KAIOMY_TVNPC_U2              63
 107 #define EM2860_BOARD_EASYCAP                      64
 108 #define EM2820_BOARD_IODATA_GVMVP_SZ              65
 109 #define EM2880_BOARD_EMPIRE_DUAL_TV               66
 110 #define EM2860_BOARD_TERRATEC_GRABBY              67
 111 #define EM2860_BOARD_TERRATEC_AV350               68
 112 #define EM2882_BOARD_KWORLD_ATSC_315U             69
 113 #define EM2882_BOARD_EVGA_INDTUBE                 70
 114 #define EM2820_BOARD_SILVERCREST_WEBCAM           71
 115 #define EM2861_BOARD_GADMEI_UTV330PLUS           72
 116 #define EM2870_BOARD_REDDO_DVB_C_USB_BOX          73
 117 #define EM2800_BOARD_VC211A                       74
 118 #define EM2882_BOARD_DIKOM_DK300                  75
 119 #define EM2870_BOARD_KWORLD_A340                  76
 120 #define EM2874_LEADERSHIP_ISDBT                   77
 121
 122
 123 /* Limits minimum and default number of buffers */
 124 #define EM28XX_MIN_BUF 4
 125 #define EM28XX_DEF_BUF 8
 126
 127 /*Limits the max URB message size */
 128 #define URB_MAX_CTRL_SIZE 80
 129
 130 /* Params for validated field */
 131 #define EM28XX_BOARD_NOT_VALIDATED 1
 132 #define EM28XX_BOARD_VALIDATED     0
 133
 134 /* Params for em28xx_cmd() audio */
 135 #define EM28XX_START_AUDIO      1
 136 #define EM28XX_STOP_AUDIO       0
 137
 138 /* maximum number of em28xx boards */
 139 #define EM28XX_MAXBOARDS 4 /*FIXME: should be bigger */
 140
 141 /* maximum number of frames that can be queued */
 142 #define EM28XX_NUM_FRAMES 5
 143 /* number of frames that get used for v4l2_read() */
 144 #define EM28XX_NUM_READ_FRAMES 2
 145
 146 /* number of buffers for isoc transfers */
 147 #define EM28XX_NUM_BUFS 5
 148
 149 /* number of packets for each buffer
 150    windows requests only 64 packets .. so we better do the same
 151    this is what I found out for all alternate numbers there!
 152  */
 153 #define EM28XX_NUM_PACKETS 64
 154
 155 #define EM28XX_INTERLACED_DEFAULT 1
 156
 157 /*
 158 #define (use usbview if you want to get the other alternate number infos)
 159 #define
 160 #define alternate number 2
 161 #define                         Endpoint Address: 82
 162                         Direction: in
 163                         Attribute: 1
 164                         Type: Isoc
 165                         Max Packet Size: 1448
 166                         Interval: 125us
 167
 168   alternate number 7
 169
 170                         Endpoint Address: 82
 171                         Direction: in
 172                         Attribute: 1
 173                         Type: Isoc
 174                         Max Packet Size: 3072
 175                         Interval: 125us
 176 */
 177
 178 /* time to wait when stopping the isoc transfer */
 179 #define EM28XX_URB_TIMEOUT \
 180                         msecs_to_jiffies(EM28XX_NUM_BUFS * EM28XX_NUM_PACKETS)
 181
 182 /* time in msecs to wait for i2c writes to finish */
 183 #define EM2800_I2C_WRITE_TIMEOUT 20
 184
 185 enum em28xx_mode {
 186         EM28XX_SUSPEND,
 187         EM28XX_ANALOG_MODE,
 188         EM28XX_DIGITAL_MODE,
 189 };
 190
 191
 192 struct em28xx;
 193
 194 struct em28xx_usb_isoc_ctl {
 195                 /* max packet size of isoc transaction */
 196         int                             max_pkt_size;
 197
 198                 /* number of allocated urbs */
 199         int                             num_bufs;
 200
 201                 /* urb for isoc transfers */
 202         struct urb                      **urb;
 203
 204                 /* transfer buffers for isoc transfer */
 205         char                            **transfer_buffer;
 206
 207                 /* Last buffer command and region */
 208         u8                              cmd;
 209         int                             pos, size, pktsize;
 210
 211                 /* Last field: ODD or EVEN? */
 212         int                             field;
 213
 214                 /* Stores incomplete commands */
 215         u32                             tmp_buf;
 216         int                             tmp_buf_len;
 217
 218                 /* Stores already requested buffers */
 219         struct em28xx_buffer            *vid_buf;
 220         struct em28xx_buffer            *vbi_buf;
 221
 222                 /* Stores the number of received fields */
 223         int                             nfields;
 224
 225                 /* isoc urb callback */
 226         int (*isoc_copy) (struct em28xx *dev, struct urb *urb);
 227
 228 };
 229
 230 /* Struct to enumberate video formats */
 231 struct em28xx_fmt {
 232         char  *name;
 233         u32   fourcc;          /* v4l2 format id */
 234         int   depth;
 235         int   reg;
 236 };
 237
 238 /* buffer for one video frame */
 239 struct em28xx_buffer {
 240         /* common v4l buffer stuff -- must be first */
 241         struct videobuf_buffer vb;
 242
 243         struct list_head frame;
 244         int top_field;
 245         int receiving;
 246 };
 247
 248 struct em28xx_dmaqueue {
 249         struct list_head       active;
 250         struct list_head       queued;
 251
 252         wait_queue_head_t          wq;
 253
 254         /* Counters to control buffer fill */
 255         int                        pos;
 256 };
 257
 258 /* io methods */
 259 enum em28xx_io_method {
 260         IO_NONE,
 261         IO_READ,
 262         IO_MMAP,
 263 };
 264
 265 /* inputs */
 266
 267 #define MAX_EM28XX_INPUT 4
 268 enum enum28xx_itype {
 269         EM28XX_VMUX_COMPOSITE1 = 1,
 270         EM28XX_VMUX_COMPOSITE2,
 271         EM28XX_VMUX_COMPOSITE3,
 272         EM28XX_VMUX_COMPOSITE4,
 273         EM28XX_VMUX_SVIDEO,
 274         EM28XX_VMUX_TELEVISION,
 275         EM28XX_VMUX_CABLE,
 276         EM28XX_VMUX_DVB,
 277         EM28XX_VMUX_DEBUG,
 278         EM28XX_RADIO,
 279 };
 280
 281 enum em28xx_ac97_mode {
 282         EM28XX_NO_AC97 = 0,
 283         EM28XX_AC97_EM202,
 284         EM28XX_AC97_SIGMATEL,
 285         EM28XX_AC97_OTHER,
 286 };
 287
 288 struct em28xx_audio_mode {
 289         enum em28xx_ac97_mode ac97;
 290
 291         u16 ac97_feat;
 292         u32 ac97_vendor_id;
 293
 294         unsigned int has_audio:1;
 295
 296         unsigned int i2s_3rates:1;
 297         unsigned int i2s_5rates:1;
 298 };
 299
 300 /* em28xx has two audio inputs: tuner and line in.
 301    However, on most devices, an auxiliary AC97 codec device is used.
 302    The AC97 device may have several different inputs and outputs,
 303    depending on their model. So, it is possible to use AC97 mixer to
 304    address more than two different entries.
 305  */
 306 enum em28xx_amux {
 307         /* This is the only entry for em28xx tuner input */
 308         EM28XX_AMUX_VIDEO,      /* em28xx tuner, AC97 mixer Video */
 309
 310         EM28XX_AMUX_LINE_IN,    /* AC97 mixer Line In */
 311
 312         /* Some less-common mixer setups */
 313         EM28XX_AMUX_VIDEO2,     /* em28xx Line in, AC97 mixer Video */
 314         EM28XX_AMUX_PHONE,
 315         EM28XX_AMUX_MIC,
 316         EM28XX_AMUX_CD,
 317         EM28XX_AMUX_AUX,
 318         EM28XX_AMUX_PCM_OUT,
 319 };
 320
 321 enum em28xx_aout {
 322         /* AC97 outputs */
 323         EM28XX_AOUT_MASTER = 1 << 0,
 324         EM28XX_AOUT_LINE   = 1 << 1,
 325         EM28XX_AOUT_MONO   = 1 << 2,
 326         EM28XX_AOUT_LFE    = 1 << 3,
 327         EM28XX_AOUT_SURR   = 1 << 4,
 328
 329         /* PCM IN Mixer - used by AC97_RECORD_SELECT register */
 330         EM28XX_AOUT_PCM_IN = 1 << 7,
 331
 332         /* Bits 10-8 are used to indicate the PCM IN record select */
 333         EM28XX_AOUT_PCM_MIC_PCM = 0 << 8,
 334         EM28XX_AOUT_PCM_CD      = 1 << 8,
 335         EM28XX_AOUT_PCM_VIDEO   = 2 << 8,
 336         EM28XX_AOUT_PCM_AUX     = 3 << 8,
 337         EM28XX_AOUT_PCM_LINE    = 4 << 8,
 338         EM28XX_AOUT_PCM_STEREO  = 5 << 8,
 339         EM28XX_AOUT_PCM_MONO    = 6 << 8,
 340         EM28XX_AOUT_PCM_PHONE   = 7 << 8,
 341 };
 342
 343 static inline int ac97_return_record_select(int a_out)
 344 {
 345         return (a_out & 0x700) >> 8;
 346 }
 347
 348 struct em28xx_reg_seq {
 349         int reg;
 350         unsigned char val, mask;
 351         int sleep;
 352 };
 353
 354 struct em28xx_input {
 355         enum enum28xx_itype type;
 356         unsigned int vmux;
 357         enum em28xx_amux amux;
 358         enum em28xx_aout aout;
 359         struct em28xx_reg_seq *gpio;
 360 };
 361
 362 #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
 363
 364 enum em28xx_decoder {
 365         EM28XX_NODECODER = 0,
 366         EM28XX_TVP5150,
 367         EM28XX_SAA711X,
 368 };
 369
 370 enum em28xx_sensor {
 371         EM28XX_NOSENSOR = 0,
 372         EM28XX_MT9V011,
 373         EM28XX_MT9M001,
 374         EM28XX_MT9M111,
 375 };
 376
 377 enum em28xx_adecoder {
 378         EM28XX_NOADECODER = 0,
 379         EM28XX_TVAUDIO,
 380 };
 381
 382 struct em28xx_board {
 383         char *name;
 384         int vchannels;
 385         int tuner_type;
 386         int tuner_addr;
 387
 388         /* i2c flags */
 389         unsigned int tda9887_conf;
 390
 391         /* GPIO sequences */
 392         struct em28xx_reg_seq *dvb_gpio;
 393         struct em28xx_reg_seq *suspend_gpio;
 394         struct em28xx_reg_seq *tuner_gpio;
 395         struct em28xx_reg_seq *mute_gpio;
 396
 397         unsigned int is_em2800:1;
 398         unsigned int has_msp34xx:1;
 399         unsigned int mts_firmware:1;
 400         unsigned int max_range_640_480:1;
 401         unsigned int has_dvb:1;
 402         unsigned int has_snapshot_button:1;
 403         unsigned int is_webcam:1;
 404         unsigned int valid:1;
 405         unsigned int has_ir_i2c:1;
 406
 407         unsigned char xclk, i2c_speed;
 408         unsigned char radio_addr;
 409         unsigned short tvaudio_addr;
 410
 411         enum em28xx_decoder decoder;
 412         enum em28xx_adecoder adecoder;
 413
 414         struct em28xx_input       input[MAX_EM28XX_INPUT];
 415         struct em28xx_input       radio;
 416         char                      *ir_codes;
 417 };
 418
 419 struct em28xx_eeprom {
 420         u32 id;                 /* 0x9567eb1a */
 421         u16 vendor_ID;
 422         u16 product_ID;
 423
 424         u16 chip_conf;
 425
 426         u16 board_conf;
 427
 428         u16 string1, string2, string3;
 429
 430         u8 string_idx_table;
 431 };
 432
 433 /* device states */
 434 enum em28xx_dev_state {
 435         DEV_INITIALIZED = 0x01,
 436         DEV_DISCONNECTED = 0x02,
 437         DEV_MISCONFIGURED = 0x04,
 438 };
 439
 440 #define EM28XX_AUDIO_BUFS 5
 441 #define EM28XX_NUM_AUDIO_PACKETS 64
 442 #define EM28XX_AUDIO_MAX_PACKET_SIZE 196 /* static value */
 443 #define EM28XX_CAPTURE_STREAM_EN 1
 444
 445 /* em28xx extensions */
 446 #define EM28XX_AUDIO   0x10
 447 #define EM28XX_DVB     0x20
 448
 449 /* em28xx resource types (used for res_get/res_lock etc */
 450 #define EM28XX_RESOURCE_VIDEO 0x01
 451 #define EM28XX_RESOURCE_VBI   0x02
 452
 453 struct em28xx_audio {
 454         char name[50];
 455         char *transfer_buffer[EM28XX_AUDIO_BUFS];
 456         struct urb *urb[EM28XX_AUDIO_BUFS];
 457         struct usb_device *udev;
 458         unsigned int capture_transfer_done;
 459         struct snd_pcm_substream   *capture_pcm_substream;
 460
 461         unsigned int hwptr_done_capture;
 462         struct snd_card            *sndcard;
 463
 464         int users;
 465         spinlock_t slock;
 466 };
 467
 468 struct em28xx;
 469
 470 struct em28xx_fh {
 471         struct em28xx *dev;
 472         int           radio;
 473         unsigned int  resources;
 474
 475         struct videobuf_queue        vb_vidq;
 476         struct videobuf_queue        vb_vbiq;
 477
 478         enum v4l2_buf_type           type;
 479 };
 480
 481 /* main device struct */
 482 struct em28xx {
 483         /* generic device properties */
 484         char name[30];          /* name (including minor) of the device */
 485         int model;              /* index in the device_data struct */
 486         int devno;              /* marks the number of this device */
 487         enum em28xx_chip_id chip_id;
 488
 489         struct v4l2_device v4l2_dev;
 490         struct em28xx_board board;
 491
 492         /* Webcam specific fields */
 493         enum em28xx_sensor em28xx_sensor;
 494         int sensor_xres, sensor_yres;
 495         int sensor_xtal;
 496
 497         /* Allows progressive (e. g. non-interlaced) mode */
 498         int progressive;
 499
 500         /* Vinmode/Vinctl used at the driver */
 501         int vinmode, vinctl;
 502
 503         unsigned int has_audio_class:1;
 504         unsigned int has_alsa_audio:1;
 505
 506         /* Controls audio streaming */
 507         struct work_struct wq_trigger;              /* Trigger to start/stop audio for alsa module */
 508          atomic_t       stream_started;      /* stream should be running if true */
 509
 510         struct em28xx_fmt *format;
 511
 512         struct em28xx_IR *ir;
 513
 514         /* Some older em28xx chips needs a waiting time after writing */
 515         unsigned int wait_after_write;
 516
 517         struct list_head        devlist;
 518
 519         u32 i2s_speed;          /* I2S speed for audio digital stream */
 520
 521         struct em28xx_audio_mode audio_mode;
 522
 523         int tuner_type;         /* type of the tuner */
 524         int tuner_addr;         /* tuner address */
 525         int tda9887_conf;
 526         /* i2c i/o */
 527         struct i2c_adapter i2c_adap;
 528         struct i2c_client i2c_client;
 529         /* video for linux */
 530         int users;              /* user count for exclusive use */
 531         struct video_device *vdev;      /* video for linux device struct */
 532         v4l2_std_id norm;       /* selected tv norm */
 533         int ctl_freq;           /* selected frequency */
 534         unsigned int ctl_input; /* selected input */
 535         unsigned int ctl_ainput;/* selected audio input */
 536         unsigned int ctl_aoutput;/* selected audio output */
 537         int mute;
 538         int volume;
 539         /* frame properties */
 540         int width;              /* current frame width */
 541         int height;             /* current frame height */
 542         unsigned hscale;        /* horizontal scale factor (see datasheet) */
 543         unsigned vscale;        /* vertical scale factor (see datasheet) */
 544         int interlaced;         /* 1=interlace fileds, 0=just top fileds */
 545         unsigned int video_bytesread;   /* Number of bytes read */
 546
 547         unsigned long hash;     /* eeprom hash - for boards with generic ID */
 548         unsigned long i2c_hash; /* i2c devicelist hash -
 549                                    for boards with generic ID */
 550
 551         struct em28xx_audio adev;
 552
 553         /* states */
 554         enum em28xx_dev_state state;
 555         enum em28xx_io_method io;
 556
 557         /* vbi related state tracking */
 558         int capture_type;
 559         int vbi_read;
 560         unsigned char cur_field;
 561         unsigned int vbi_width;
 562         unsigned int vbi_height; /* lines per field */
 563
 564         struct work_struct         request_module_wk;
 565
 566         /* locks */
 567         struct mutex lock;
 568         struct mutex ctrl_urb_lock;     /* protects urb_buf */
 569         /* spinlock_t queue_lock; */
 570         struct list_head inqueue, outqueue;
 571         wait_queue_head_t open, wait_frame, wait_stream;
 572         struct video_device *vbi_dev;
 573         struct video_device *radio_dev;
 574
 575         /* resources in use */
 576         unsigned int resources;
 577
 578         unsigned char eedata[256];
 579
 580         /* Isoc control struct */
 581         struct em28xx_dmaqueue vidq;
 582         struct em28xx_dmaqueue vbiq;
 583         struct em28xx_usb_isoc_ctl isoc_ctl;
 584         spinlock_t slock;
 585
 586         /* usb transfer */
 587         struct usb_device *udev;        /* the usb device */
 588         int alt;                /* alternate */
 589         int max_pkt_size;       /* max packet size of isoc transaction */
 590         int num_alt;            /* Number of alternative settings */
 591         unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
 592         struct urb *urb[EM28XX_NUM_BUFS];       /* urb for isoc transfers */
 593         char *transfer_buffer[EM28XX_NUM_BUFS]; /* transfer buffers for isoc
 594                                                    transfer */
 595         char urb_buf[URB_MAX_CTRL_SIZE];        /* urb control msg buffer */
 596
 597         /* helper funcs that call usb_control_msg */
 598         int (*em28xx_write_regs) (struct em28xx *dev, u16 reg,
 599                                         char *buf, int len);
 600         int (*em28xx_read_reg) (struct em28xx *dev, u16 reg);
 601         int (*em28xx_read_reg_req_len) (struct em28xx *dev, u8 req, u16 reg,
 602                                         char *buf, int len);
 603         int (*em28xx_write_regs_req) (struct em28xx *dev, u8 req, u16 reg,
 604                                       char *buf, int len);
 605         int (*em28xx_read_reg_req) (struct em28xx *dev, u8 req, u16 reg);
 606
 607         enum em28xx_mode mode;
 608
 609         /* register numbers for GPO/GPIO registers */
 610         u16 reg_gpo_num, reg_gpio_num;
 611
 612         /* Caches GPO and GPIO registers */
 613         unsigned char   reg_gpo, reg_gpio;
 614
 615         /* Snapshot button */
 616         char snapshot_button_path[30];  /* path of the input dev */
 617         struct input_dev *sbutton_input_dev;
 618         struct delayed_work sbutton_query_work;
 619
 620         struct em28xx_dvb *dvb;
 621
 622         /* I2C keyboard data */
 623         struct IR_i2c_init_data init_data;
 624 };
 625
 626 struct em28xx_ops {
 627         struct list_head next;
 628         char *name;
 629         int id;
 630         int (*init)(struct em28xx *);
 631         int (*fini)(struct em28xx *);
 632 };
 633
 634 /* Provided by em28xx-i2c.c */
 635 void em28xx_do_i2c_scan(struct em28xx *dev);
 636 int  em28xx_i2c_register(struct em28xx *dev);
 637 int  em28xx_i2c_unregister(struct em28xx *dev);
 638
 639 /* Provided by em28xx-core.c */
 640
 641 u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
 642 void em28xx_queue_unusedframes(struct em28xx *dev);
 643 void em28xx_release_buffers(struct em28xx *dev);
 644
 645 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
 646                             char *buf, int len);
 647 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
 648 int em28xx_read_reg(struct em28xx *dev, u16 reg);
 649 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
 650                           int len);
 651 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
 652 int em28xx_write_reg(struct em28xx *dev, u16 reg, u8 val);
 653 int em28xx_write_reg_bits(struct em28xx *dev, u16 reg, u8 val,
 654                                  u8 bitmask);
 655
 656 int em28xx_read_ac97(struct em28xx *dev, u8 reg);
 657 int em28xx_write_ac97(struct em28xx *dev, u8 reg, u16 val);
 658
 659 int em28xx_audio_analog_set(struct em28xx *dev);
 660 int em28xx_audio_setup(struct em28xx *dev);
 661
 662 int em28xx_colorlevels_set_default(struct em28xx *dev);
 663 int em28xx_capture_start(struct em28xx *dev, int start);
 664 int em28xx_vbi_supported(struct em28xx *dev);
 665 int em28xx_set_outfmt(struct em28xx *dev);
 666 int em28xx_resolution_set(struct em28xx *dev);
 667 int em28xx_set_alternate(struct em28xx *dev);
 668 int em28xx_init_isoc(struct em28xx *dev, int max_packets,
 669                      int num_bufs, int max_pkt_size,
 670                      int (*isoc_copy) (struct em28xx *dev, struct urb *urb));
 671 void em28xx_uninit_isoc(struct em28xx *dev);
 672 int em28xx_isoc_dvb_max_packetsize(struct em28xx *dev);
 673 int em28xx_set_mode(struct em28xx *dev, enum em28xx_mode set_mode);
 674 int em28xx_gpio_set(struct em28xx *dev, struct em28xx_reg_seq *gpio);
 675 void em28xx_wake_i2c(struct em28xx *dev);
 676 void em28xx_remove_from_devlist(struct em28xx *dev);
 677 void em28xx_add_into_devlist(struct em28xx *dev);
 678 int em28xx_register_extension(struct em28xx_ops *dev);
 679 void em28xx_unregister_extension(struct em28xx_ops *dev);
 680 void em28xx_init_extension(struct em28xx *dev);
 681 void em28xx_close_extension(struct em28xx *dev);
 682
 683 /* Provided by em28xx-video.c */
 684 int em28xx_register_analog_devices(struct em28xx *dev);
 685 void em28xx_release_analog_resources(struct em28xx *dev);
 686
 687 /* Provided by em28xx-cards.c */
 688 extern int em2800_variant_detect(struct usb_device *udev, int model);
 689 extern void em28xx_pre_card_setup(struct em28xx *dev);
 690 extern void em28xx_card_setup(struct em28xx *dev);
 691 extern struct em28xx_board em28xx_boards[];
 692 extern struct usb_device_id em28xx_id_table[];
 693 extern const unsigned int em28xx_bcount;
 694 void em28xx_register_i2c_ir(struct em28xx *dev);
 695 int em28xx_tuner_callback(void *ptr, int component, int command, int arg);
 696 void em28xx_release_resources(struct em28xx *dev);
 697
 698 /* Provided by em28xx-input.c */
 699 int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
 700 int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
 701 int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
 702                                      u32 *ir_raw);
 703 int em28xx_get_key_winfast_usbii_deluxe(struct IR_i2c *ir, u32 *ir_key,
 704                                      u32 *ir_raw);
 705 void em28xx_register_snapshot_button(struct em28xx *dev);
 706 void em28xx_deregister_snapshot_button(struct em28xx *dev);
 707
 708 int em28xx_ir_init(struct em28xx *dev);
 709 int em28xx_ir_fini(struct em28xx *dev);
 710
 711 /* Provided by em28xx-vbi.c */
 712 extern struct videobuf_queue_ops em28xx_vbi_qops;
 713
 714 /* printk macros */
 715
 716 #define em28xx_err(fmt, arg...) do {\
 717         printk(KERN_ERR fmt , ##arg); } while (0)
 718
 719 #define em28xx_errdev(fmt, arg...) do {\
 720         printk(KERN_ERR "%s: "fmt,\
 721                         dev->name , ##arg); } while (0)
 722
 723 #define em28xx_info(fmt, arg...) do {\
 724         printk(KERN_INFO "%s: "fmt,\
 725                         dev->name , ##arg); } while (0)
 726 #define em28xx_warn(fmt, arg...) do {\
 727         printk(KERN_WARNING "%s: "fmt,\
 728                         dev->name , ##arg); } while (0)
 729
 730 static inline int em28xx_compression_disable(struct em28xx *dev)
 731 {
 732         /* side effect of disabling scaler and mixer */
 733         return em28xx_write_reg(dev, EM28XX_R26_COMPR, 0x00);
 734 }
 735
 736 static inline int em28xx_contrast_get(struct em28xx *dev)
 737 {
 738         return em28xx_read_reg(dev, EM28XX_R20_YGAIN) & 0x1f;
 739 }
 740
 741 static inline int em28xx_brightness_get(struct em28xx *dev)
 742 {
 743         return em28xx_read_reg(dev, EM28XX_R21_YOFFSET);
 744 }
 745
 746 static inline int em28xx_saturation_get(struct em28xx *dev)
 747 {
 748         return em28xx_read_reg(dev, EM28XX_R22_UVGAIN) & 0x1f;
 749 }
 750
 751 static inline int em28xx_u_balance_get(struct em28xx *dev)
 752 {
 753         return em28xx_read_reg(dev, EM28XX_R23_UOFFSET);
 754 }
 755
 756 static inline int em28xx_v_balance_get(struct em28xx *dev)
 757 {
 758         return em28xx_read_reg(dev, EM28XX_R24_VOFFSET);
 759 }
 760
 761 static inline int em28xx_gamma_get(struct em28xx *dev)
 762 {
 763         return em28xx_read_reg(dev, EM28XX_R14_GAMMA) & 0x3f;
 764 }
 765
 766 static inline int em28xx_contrast_set(struct em28xx *dev, s32 val)
 767 {
 768         u8 tmp = (u8) val;
 769         return em28xx_write_regs(dev, EM28XX_R20_YGAIN, &tmp, 1);
 770 }
 771
 772 static inline int em28xx_brightness_set(struct em28xx *dev, s32 val)
 773 {
 774         u8 tmp = (u8) val;
 775         return em28xx_write_regs(dev, EM28XX_R21_YOFFSET, &tmp, 1);
 776 }
 777
 778 static inline int em28xx_saturation_set(struct em28xx *dev, s32 val)
 779 {
 780         u8 tmp = (u8) val;
 781         return em28xx_write_regs(dev, EM28XX_R22_UVGAIN, &tmp, 1);
 782 }
 783
 784 static inline int em28xx_u_balance_set(struct em28xx *dev, s32 val)
 785 {
 786         u8 tmp = (u8) val;
 787         return em28xx_write_regs(dev, EM28XX_R23_UOFFSET, &tmp, 1);
 788 }
 789
 790 static inline int em28xx_v_balance_set(struct em28xx *dev, s32 val)
 791 {
 792         u8 tmp = (u8) val;
 793         return em28xx_write_regs(dev, EM28XX_R24_VOFFSET, &tmp, 1);
 794 }
 795
 796 static inline int em28xx_gamma_set(struct em28xx *dev, s32 val)
 797 {
 798         u8 tmp = (u8) val;
 799         return em28xx_write_regs(dev, EM28XX_R14_GAMMA, &tmp, 1);
 800 }
 801
 802 /*FIXME: maxw should be dependent of alt mode */
 803 static inline unsigned int norm_maxw(struct em28xx *dev)
 804 {
 805         if (dev->board.is_webcam)
 806                 return dev->sensor_xres;
 807
 808         if (dev->board.max_range_640_480 || dev->board.is_em2800)
 809                 return 640;
 810
 811         return 720;
 812 }
 813
 814 static inline unsigned int norm_maxh(struct em28xx *dev)
 815 {
 816         if (dev->board.is_webcam)
 817                 return dev->sensor_yres;
 818
 819         if (dev->board.max_range_640_480)
 820                 return 480;
 821
 822         return (dev->norm & V4L2_STD_625_50) ? 576 : 480;
 823 }
 824 #endif