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