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 #define EM28XX_VERSION "0.2.2"
  30 #define DRIVER_DESC    "Empia em28xx device driver"
  31
  32 #include <linux/workqueue.h>
  33 #include <linux/i2c.h>
  34 #include <linux/mutex.h>
  35 #include <linux/kref.h>
  36 #include <linux/videodev2.h>
  37
  38 #include <media/videobuf2-v4l2.h>
  39 #include <media/videobuf2-vmalloc.h>
  40 #include <media/v4l2-device.h>
  41 #include <media/v4l2-ctrls.h>
  42 #include <media/v4l2-fh.h>
  43 #include <media/i2c/ir-kbd-i2c.h>
  44 #include <media/rc-core.h>
  45 #include "tuner-xc2028.h"
  46 #include "xc5000.h"
  47 #include "em28xx-reg.h"
  48
  49 /* Boards supported by driver */
  50 #define EM2800_BOARD_UNKNOWN                      0
  51 #define EM2820_BOARD_UNKNOWN                      1
  52 #define EM2820_BOARD_TERRATEC_CINERGY_250         2
  53 #define EM2820_BOARD_PINNACLE_USB_2               3
  54 #define EM2820_BOARD_HAUPPAUGE_WINTV_USB_2        4
  55 #define EM2820_BOARD_MSI_VOX_USB_2                5
  56 #define EM2800_BOARD_TERRATEC_CINERGY_200         6
  57 #define EM2800_BOARD_LEADTEK_WINFAST_USBII        7
  58 #define EM2800_BOARD_KWORLD_USB2800               8
  59 #define EM2820_BOARD_PINNACLE_DVC_90              9
  60 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900      10
  61 #define EM2880_BOARD_TERRATEC_HYBRID_XS           11
  62 #define EM2820_BOARD_KWORLD_PVRTV2800RF           12
  63 #define EM2880_BOARD_TERRATEC_PRODIGY_XS          13
  64 #define EM2820_BOARD_PROLINK_PLAYTV_USB2          14
  65 #define EM2800_BOARD_VGEAR_POCKETTV               15
  66 #define EM2883_BOARD_HAUPPAUGE_WINTV_HVR_950      16
  67 #define EM2880_BOARD_PINNACLE_PCTV_HD_PRO         17
  68 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900_R2   18
  69 #define EM2860_BOARD_SAA711X_REFERENCE_DESIGN     19
  70 #define EM2880_BOARD_AMD_ATI_TV_WONDER_HD_600     20
  71 #define EM2800_BOARD_GRABBEEX_USB2800             21
  72 #define EM2750_BOARD_UNKNOWN                      22
  73 #define EM2750_BOARD_DLCW_130                     23
  74 #define EM2820_BOARD_DLINK_USB_TV                 24
  75 #define EM2820_BOARD_GADMEI_UTV310                25
  76 #define EM2820_BOARD_HERCULES_SMART_TV_USB2       26
  77 #define EM2820_BOARD_PINNACLE_USB_2_FM1216ME      27
  78 #define EM2820_BOARD_LEADTEK_WINFAST_USBII_DELUXE 28
  79 #define EM2860_BOARD_TVP5150_REFERENCE_DESIGN     29
  80 #define EM2820_BOARD_VIDEOLOGY_20K14XUSB          30
  81 #define EM2821_BOARD_USBGEAR_VD204                31
  82 #define EM2821_BOARD_SUPERCOMP_USB_2              32
  83 #define EM2860_BOARD_ELGATO_VIDEO_CAPTURE         33
  84 #define EM2860_BOARD_TERRATEC_HYBRID_XS           34
  85 #define EM2860_BOARD_TYPHOON_DVD_MAKER            35
  86 #define EM2860_BOARD_NETGMBH_CAM                  36
  87 #define EM2860_BOARD_GADMEI_UTV330                37
  88 #define EM2861_BOARD_YAKUMO_MOVIE_MIXER           38
  89 #define EM2861_BOARD_KWORLD_PVRTV_300U            39
  90 #define EM2861_BOARD_PLEXTOR_PX_TV100U            40
  91 #define EM2870_BOARD_KWORLD_350U                  41
  92 #define EM2870_BOARD_KWORLD_355U                  42
  93 #define EM2870_BOARD_TERRATEC_XS                  43
  94 #define EM2870_BOARD_TERRATEC_XS_MT2060           44
  95 #define EM2870_BOARD_PINNACLE_PCTV_DVB            45
  96 #define EM2870_BOARD_COMPRO_VIDEOMATE             46
  97 #define EM2880_BOARD_KWORLD_DVB_305U              47
  98 #define EM2880_BOARD_KWORLD_DVB_310U              48
  99 #define EM2880_BOARD_MSI_DIGIVOX_AD               49
 100 #define EM2880_BOARD_MSI_DIGIVOX_AD_II            50
 101 #define EM2880_BOARD_TERRATEC_HYBRID_XS_FR        51
 102 #define EM2881_BOARD_DNT_DA2_HYBRID               52
 103 #define EM2881_BOARD_PINNACLE_HYBRID_PRO          53
 104 #define EM2882_BOARD_KWORLD_VS_DVBT               54
 105 #define EM2882_BOARD_TERRATEC_HYBRID_XS           55
 106 #define EM2882_BOARD_PINNACLE_HYBRID_PRO_330E     56
 107 #define EM2883_BOARD_KWORLD_HYBRID_330U           57
 108 #define EM2820_BOARD_COMPRO_VIDEOMATE_FORYOU      58
 109 #define EM2874_BOARD_PCTV_HD_MINI_80E             59
 110 #define EM2883_BOARD_HAUPPAUGE_WINTV_HVR_850      60
 111 #define EM2820_BOARD_PROLINK_PLAYTV_BOX4_USB2     61
 112 #define EM2820_BOARD_GADMEI_TVR200                62
 113 #define EM2860_BOARD_KAIOMY_TVNPC_U2              63
 114 #define EM2860_BOARD_EASYCAP                      64
 115 #define EM2820_BOARD_IODATA_GVMVP_SZ              65
 116 #define EM2880_BOARD_EMPIRE_DUAL_TV               66
 117 #define EM2860_BOARD_TERRATEC_GRABBY              67
 118 #define EM2860_BOARD_TERRATEC_AV350               68
 119 #define EM2882_BOARD_KWORLD_ATSC_315U             69
 120 #define EM2882_BOARD_EVGA_INDTUBE                 70
 121 #define EM2820_BOARD_SILVERCREST_WEBCAM           71
 122 #define EM2861_BOARD_GADMEI_UTV330PLUS            72
 123 #define EM2870_BOARD_REDDO_DVB_C_USB_BOX          73
 124 #define EM2800_BOARD_VC211A                       74
 125 #define EM2882_BOARD_DIKOM_DK300                  75
 126 #define EM2870_BOARD_KWORLD_A340                  76
 127 #define EM2874_BOARD_LEADERSHIP_ISDBT             77
 128 #define EM28174_BOARD_PCTV_290E                   78
 129 #define EM2884_BOARD_TERRATEC_H5                  79
 130 #define EM28174_BOARD_PCTV_460E                   80
 131 #define EM2884_BOARD_HAUPPAUGE_WINTV_HVR_930C     81
 132 #define EM2884_BOARD_CINERGY_HTC_STICK            82
 133 #define EM2860_BOARD_HT_VIDBOX_NW03               83
 134 #define EM2874_BOARD_MAXMEDIA_UB425_TC            84
 135 #define EM2884_BOARD_PCTV_510E                    85
 136 #define EM2884_BOARD_PCTV_520E                    86
 137 #define EM2884_BOARD_TERRATEC_HTC_USB_XS          87
 138 #define EM2884_BOARD_C3TECH_DIGITAL_DUO           88
 139 #define EM2874_BOARD_DELOCK_61959                 89
 140 #define EM2874_BOARD_KWORLD_UB435Q_V2             90
 141 #define EM2765_BOARD_SPEEDLINK_VAD_LAPLACE        91
 142 #define EM28178_BOARD_PCTV_461E                   92
 143 #define EM2874_BOARD_KWORLD_UB435Q_V3             93
 144 #define EM28178_BOARD_PCTV_292E                   94
 145 #define EM2861_BOARD_LEADTEK_VC100                95
 146 #define EM28178_BOARD_TERRATEC_T2_STICK_HD        96
 147 #define EM2884_BOARD_ELGATO_EYETV_HYBRID_2008     97
 148 #define EM28178_BOARD_PLEX_PX_BCUD                98
 149 #define EM28174_BOARD_HAUPPAUGE_WINTV_DUALHD_DVB  99
 150 #define EM28174_BOARD_HAUPPAUGE_WINTV_DUALHD_01595 100
 151
 152 /* Limits minimum and default number of buffers */
 153 #define EM28XX_MIN_BUF 4
 154 #define EM28XX_DEF_BUF 8
 155
 156 /*Limits the max URB message size */
 157 #define URB_MAX_CTRL_SIZE 80
 158
 159 /* Params for validated field */
 160 #define EM28XX_BOARD_NOT_VALIDATED 1
 161 #define EM28XX_BOARD_VALIDATED     0
 162
 163 /* Params for em28xx_cmd() audio */
 164 #define EM28XX_START_AUDIO      1
 165 #define EM28XX_STOP_AUDIO       0
 166
 167 /* maximum number of em28xx boards */
 168 #define EM28XX_MAXBOARDS 4 /*FIXME: should be bigger */
 169
 170 /* maximum number of frames that can be queued */
 171 #define EM28XX_NUM_FRAMES 5
 172 /* number of frames that get used for v4l2_read() */
 173 #define EM28XX_NUM_READ_FRAMES 2
 174
 175 /* number of buffers for isoc transfers */
 176 #define EM28XX_NUM_BUFS 5
 177 #define EM28XX_DVB_NUM_BUFS 5
 178
 179 /* max number of I2C buses on em28xx devices */
 180 #define NUM_I2C_BUSES   2
 181
 182 /* isoc transfers: number of packets for each buffer
 183    windows requests only 64 packets .. so we better do the same
 184    this is what I found out for all alternate numbers there!
 185  */
 186 #define EM28XX_NUM_ISOC_PACKETS 64
 187 #define EM28XX_DVB_NUM_ISOC_PACKETS 64
 188
 189 /* bulk transfers: transfer buffer size = packet size * packet multiplier
 190    USB 2.0 spec says bulk packet size is always 512 bytes
 191  */
 192 #define EM28XX_BULK_PACKET_MULTIPLIER 384
 193 #define EM28XX_DVB_BULK_PACKET_MULTIPLIER 384
 194
 195 #define EM28XX_INTERLACED_DEFAULT 1
 196
 197 /*
 198  * Time in msecs to wait for i2c xfers to finish.
 199  * 35ms is the maximum time a SMBUS device could wait when
 200  * clock stretching is used. As the transfer itself will take
 201  * some time to happen, set it to 35 ms.
 202  *
 203  * Ok, I2C doesn't specify any limit. So, eventually, we may need
 204  * to increase this timeout.
 205  *
 206  * FIXME: this assumes that an I2C message is not longer than 1ms.
 207  * This is actually dependent on the I2C bus speed, although most
 208  * devices use a 100kHz clock. So, this assumtion is true most of
 209  * the time.
 210  */
 211 #define EM28XX_I2C_XFER_TIMEOUT         36
 212
 213 /* time in msecs to wait for AC97 xfers to finish */
 214 #define EM28XX_AC97_XFER_TIMEOUT        100
 215
 216 /* max. number of button state polling addresses */
 217 #define EM28XX_NUM_BUTTON_ADDRESSES_MAX         5
 218
 219 enum em28xx_mode {
 220         EM28XX_SUSPEND,
 221         EM28XX_ANALOG_MODE,
 222         EM28XX_DIGITAL_MODE,
 223 };
 224
 225 struct em28xx;
 226
 227 struct em28xx_usb_bufs {
 228                 /* max packet size of isoc transaction */
 229         int                             max_pkt_size;
 230
 231                 /* number of packets in each buffer */
 232         int                             num_packets;
 233
 234                 /* number of allocated urbs */
 235         int                             num_bufs;
 236
 237                 /* urb for isoc/bulk transfers */
 238         struct urb                      **urb;
 239
 240                 /* transfer buffers for isoc/bulk transfer */
 241         char                            **transfer_buffer;
 242 };
 243
 244 struct em28xx_usb_ctl {
 245                 /* isoc/bulk transfer buffers for analog mode */
 246         struct em28xx_usb_bufs          analog_bufs;
 247
 248                 /* isoc/bulk transfer buffers for digital mode */
 249         struct em28xx_usb_bufs          digital_bufs;
 250
 251                 /* Stores already requested buffers */
 252         struct em28xx_buffer    *vid_buf;
 253         struct em28xx_buffer    *vbi_buf;
 254
 255                 /* copy data from URB */
 256         int (*urb_data_copy)(struct em28xx *dev, struct urb *urb);
 257
 258 };
 259
 260 /* Struct to enumberate video formats */
 261 struct em28xx_fmt {
 262         char  *name;
 263         u32   fourcc;          /* v4l2 format id */
 264         int   depth;
 265         int   reg;
 266 };
 267
 268 /* buffer for one video frame */
 269 struct em28xx_buffer {
 270         /* common v4l buffer stuff -- must be first */
 271         struct vb2_v4l2_buffer vb;
 272         struct list_head list;
 273
 274         void *mem;
 275         unsigned int length;
 276         int top_field;
 277
 278         /* counter to control buffer fill */
 279         unsigned int pos;
 280         /* NOTE; in interlaced mode, this value is reset to zero at
 281          * the start of each new field (not frame !)               */
 282
 283         /* pointer to vmalloc memory address in vb */
 284         char *vb_buf;
 285 };
 286
 287 struct em28xx_dmaqueue {
 288         struct list_head       active;
 289
 290         wait_queue_head_t          wq;
 291 };
 292
 293 /* inputs */
 294
 295 #define MAX_EM28XX_INPUT 4
 296 enum enum28xx_itype {
 297         EM28XX_VMUX_COMPOSITE = 1,
 298         EM28XX_VMUX_SVIDEO,
 299         EM28XX_VMUX_TELEVISION,
 300         EM28XX_RADIO,
 301 };
 302
 303 enum em28xx_ac97_mode {
 304         EM28XX_NO_AC97 = 0,
 305         EM28XX_AC97_EM202,
 306         EM28XX_AC97_SIGMATEL,
 307         EM28XX_AC97_OTHER,
 308 };
 309
 310 struct em28xx_audio_mode {
 311         enum em28xx_ac97_mode ac97;
 312 };
 313
 314 enum em28xx_int_audio_type {
 315         EM28XX_INT_AUDIO_NONE = 0,
 316         EM28XX_INT_AUDIO_AC97,
 317         EM28XX_INT_AUDIO_I2S,
 318 };
 319
 320 enum em28xx_usb_audio_type {
 321         EM28XX_USB_AUDIO_NONE = 0,
 322         EM28XX_USB_AUDIO_CLASS,
 323         EM28XX_USB_AUDIO_VENDOR,
 324 };
 325
 326 /* em28xx has two audio inputs: tuner and line in.
 327    However, on most devices, an auxiliary AC97 codec device is used.
 328    The AC97 device may have several different inputs and outputs,
 329    depending on their model. So, it is possible to use AC97 mixer to
 330    address more than two different entries.
 331  */
 332 enum em28xx_amux {
 333         /* This is the only entry for em28xx tuner input */
 334         EM28XX_AMUX_VIDEO,      /* em28xx tuner, AC97 mixer Video */
 335
 336         EM28XX_AMUX_LINE_IN,    /* AC97 mixer Line In */
 337
 338         /* Some less-common mixer setups */
 339         EM28XX_AMUX_VIDEO2,     /* em28xx Line in, AC97 mixer Video */
 340         EM28XX_AMUX_PHONE,
 341         EM28XX_AMUX_MIC,
 342         EM28XX_AMUX_CD,
 343         EM28XX_AMUX_AUX,
 344         EM28XX_AMUX_PCM_OUT,
 345 };
 346
 347 enum em28xx_aout {
 348         /* AC97 outputs */
 349         EM28XX_AOUT_MASTER = 1 << 0,
 350         EM28XX_AOUT_LINE   = 1 << 1,
 351         EM28XX_AOUT_MONO   = 1 << 2,
 352         EM28XX_AOUT_LFE    = 1 << 3,
 353         EM28XX_AOUT_SURR   = 1 << 4,
 354
 355         /* PCM IN Mixer - used by AC97_RECORD_SELECT register */
 356         EM28XX_AOUT_PCM_IN = 1 << 7,
 357
 358         /* Bits 10-8 are used to indicate the PCM IN record select */
 359         EM28XX_AOUT_PCM_MIC_PCM = 0 << 8,
 360         EM28XX_AOUT_PCM_CD      = 1 << 8,
 361         EM28XX_AOUT_PCM_VIDEO   = 2 << 8,
 362         EM28XX_AOUT_PCM_AUX     = 3 << 8,
 363         EM28XX_AOUT_PCM_LINE    = 4 << 8,
 364         EM28XX_AOUT_PCM_STEREO  = 5 << 8,
 365         EM28XX_AOUT_PCM_MONO    = 6 << 8,
 366         EM28XX_AOUT_PCM_PHONE   = 7 << 8,
 367 };
 368
 369 static inline int ac97_return_record_select(int a_out)
 370 {
 371         return (a_out & 0x700) >> 8;
 372 }
 373
 374 struct em28xx_reg_seq {
 375         int reg;
 376         unsigned char val, mask;
 377         int sleep;
 378 };
 379
 380 struct em28xx_input {
 381         enum enum28xx_itype type;
 382         unsigned int vmux;
 383         enum em28xx_amux amux;
 384         enum em28xx_aout aout;
 385         struct em28xx_reg_seq *gpio;
 386 };
 387
 388 #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
 389
 390 enum em28xx_decoder {
 391         EM28XX_NODECODER = 0,
 392         EM28XX_TVP5150,
 393         EM28XX_SAA711X,
 394 };
 395
 396 enum em28xx_sensor {
 397         EM28XX_NOSENSOR = 0,
 398         EM28XX_MT9V011,
 399         EM28XX_MT9M001,
 400         EM28XX_MT9M111,
 401         EM28XX_OV2640,
 402 };
 403
 404 enum em28xx_adecoder {
 405         EM28XX_NOADECODER = 0,
 406         EM28XX_TVAUDIO,
 407 };
 408
 409 enum em28xx_led_role {
 410         EM28XX_LED_ANALOG_CAPTURING = 0,
 411         EM28XX_LED_DIGITAL_CAPTURING,
 412         EM28XX_LED_DIGITAL_CAPTURING_TS2,
 413         EM28XX_LED_ILLUMINATION,
 414         EM28XX_NUM_LED_ROLES, /* must be the last */
 415 };
 416
 417 struct em28xx_led {
 418         enum em28xx_led_role role;
 419         u8 gpio_reg;
 420         u8 gpio_mask;
 421         bool inverted;
 422 };
 423
 424 enum em28xx_button_role {
 425         EM28XX_BUTTON_SNAPSHOT = 0,
 426         EM28XX_BUTTON_ILLUMINATION,
 427         EM28XX_NUM_BUTTON_ROLES, /* must be the last */
 428 };
 429
 430 struct em28xx_button {
 431         enum em28xx_button_role role;
 432         u8 reg_r;
 433         u8 reg_clearing;
 434         u8 mask;
 435         bool inverted;
 436 };
 437
 438 struct em28xx_board {
 439         char *name;
 440         int vchannels;
 441         int tuner_type;
 442         int tuner_addr;
 443         unsigned def_i2c_bus;   /* Default I2C bus */
 444
 445         /* i2c flags */
 446         unsigned int tda9887_conf;
 447
 448         /* GPIO sequences */
 449         struct em28xx_reg_seq *dvb_gpio;
 450         struct em28xx_reg_seq *suspend_gpio;
 451         struct em28xx_reg_seq *tuner_gpio;
 452         struct em28xx_reg_seq *mute_gpio;
 453
 454         unsigned int is_em2800:1;
 455         unsigned int has_msp34xx:1;
 456         unsigned int mts_firmware:1;
 457         unsigned int max_range_640_480:1;
 458         unsigned int has_dvb:1;
 459         unsigned int is_webcam:1;
 460         unsigned int valid:1;
 461         unsigned int has_ir_i2c:1;
 462
 463         unsigned char xclk, i2c_speed;
 464         unsigned char radio_addr;
 465         unsigned short tvaudio_addr;
 466
 467         enum em28xx_decoder decoder;
 468         enum em28xx_adecoder adecoder;
 469
 470         struct em28xx_input       input[MAX_EM28XX_INPUT];
 471         struct em28xx_input       radio;
 472         char                      *ir_codes;
 473
 474         /* LEDs that need to be controlled explicitly */
 475         struct em28xx_led         *leds;
 476
 477         /* Buttons */
 478         struct em28xx_button      *buttons;
 479 };
 480
 481 struct em28xx_eeprom {
 482         u8 id[4];                       /* 1a eb 67 95 */
 483         __le16 vendor_ID;
 484         __le16 product_ID;
 485
 486         __le16 chip_conf;
 487
 488         __le16 board_conf;
 489
 490         __le16 string1, string2, string3;
 491
 492         u8 string_idx_table;
 493 };
 494
 495 #define EM28XX_CAPTURE_STREAM_EN 1
 496
 497 /* em28xx extensions */
 498 #define EM28XX_AUDIO   0x10
 499 #define EM28XX_DVB     0x20
 500 #define EM28XX_RC      0x30
 501 #define EM28XX_V4L2    0x40
 502
 503 /* em28xx resource types (used for res_get/res_lock etc */
 504 #define EM28XX_RESOURCE_VIDEO 0x01
 505 #define EM28XX_RESOURCE_VBI   0x02
 506
 507 struct em28xx_v4l2 {
 508         struct kref ref;
 509         struct em28xx *dev;
 510
 511         struct v4l2_device v4l2_dev;
 512         struct v4l2_ctrl_handler ctrl_handler;
 513
 514         struct video_device vdev;
 515         struct video_device vbi_dev;
 516         struct video_device radio_dev;
 517
 518         /* Videobuf2 */
 519         struct vb2_queue vb_vidq;
 520         struct vb2_queue vb_vbiq;
 521         struct mutex vb_queue_lock;
 522         struct mutex vb_vbi_queue_lock;
 523
 524         u8 vinmode;
 525         u8 vinctl;
 526
 527         /* Camera specific fields */
 528         int sensor_xres;
 529         int sensor_yres;
 530         int sensor_xtal;
 531
 532         int users;              /* user count for exclusive use */
 533         int streaming_users;    /* number of actively streaming users */
 534
 535         u32 frequency;          /* selected tuner frequency */
 536
 537         struct em28xx_fmt *format;
 538         v4l2_std_id norm;       /* selected tv norm */
 539
 540         /* Progressive/interlaced mode */
 541         bool progressive;
 542         int interlaced_fieldmode; /* 1=interlaced fields, 0=just top fields */
 543         /* FIXME: everything else than interlaced_fieldmode=1 doesn't work */
 544
 545         /* Frame properties */
 546         int width;              /* current frame width */
 547         int height;             /* current frame height */
 548         unsigned hscale;        /* horizontal scale factor (see datasheet) */
 549         unsigned vscale;        /* vertical scale factor (see datasheet) */
 550         unsigned int vbi_width;
 551         unsigned int vbi_height; /* lines per field */
 552
 553         /* Capture state tracking */
 554         int capture_type;
 555         bool top_field;
 556         int vbi_read;
 557         unsigned int field_count;
 558
 559 #ifdef CONFIG_MEDIA_CONTROLLER
 560         struct media_pad video_pad, vbi_pad;
 561         struct media_entity *decoder;
 562 #endif
 563 };
 564
 565 struct em28xx_audio {
 566         char name[50];
 567         unsigned num_urb;
 568         char **transfer_buffer;
 569         struct urb **urb;
 570         struct usb_device *udev;
 571         unsigned int capture_transfer_done;
 572         struct snd_pcm_substream   *capture_pcm_substream;
 573
 574         unsigned int hwptr_done_capture;
 575         struct snd_card            *sndcard;
 576
 577         size_t period;
 578
 579         int users;
 580         spinlock_t slock;
 581
 582         /* Controls streaming */
 583         struct work_struct wq_trigger;  /* trigger to start/stop audio */
 584         atomic_t       stream_started;  /* stream should be running if true */
 585 };
 586
 587 struct em28xx;
 588
 589 enum em28xx_i2c_algo_type {
 590         EM28XX_I2C_ALGO_EM28XX = 0,
 591         EM28XX_I2C_ALGO_EM2800,
 592         EM28XX_I2C_ALGO_EM25XX_BUS_B,
 593 };
 594
 595 struct em28xx_i2c_bus {
 596         struct em28xx *dev;
 597
 598         unsigned bus;
 599         enum em28xx_i2c_algo_type algo_type;
 600 };
 601
 602 /* main device struct */
 603 struct em28xx {
 604         struct kref ref;
 605
 606         /* Sub-module data */
 607         struct em28xx_v4l2 *v4l2;
 608         struct em28xx_dvb *dvb;
 609         struct em28xx_audio adev;
 610         struct em28xx_IR *ir;
 611
 612         /* generic device properties */
 613         int model;              /* index in the device_data struct */
 614         int devno;              /* marks the number of this device */
 615         enum em28xx_chip_id chip_id;
 616
 617         unsigned int is_em25xx:1;       /* em25xx/em276x/7x/8x family bridge */
 618         unsigned char disconnected:1;   /* device has been diconnected */
 619         unsigned int has_video:1;
 620         unsigned int is_audio_only:1;
 621         enum em28xx_int_audio_type int_audio_type;
 622         enum em28xx_usb_audio_type usb_audio_type;
 623
 624         struct em28xx_board board;
 625
 626         enum em28xx_sensor em28xx_sensor;       /* camera specific */
 627
 628         /* Some older em28xx chips needs a waiting time after writing */
 629         unsigned int wait_after_write;
 630
 631         struct list_head        devlist;
 632
 633         u32 i2s_speed;          /* I2S speed for audio digital stream */
 634
 635         struct em28xx_audio_mode audio_mode;
 636
 637         int tuner_type;         /* type of the tuner */
 638
 639         /* i2c i/o */
 640         struct i2c_adapter i2c_adap[NUM_I2C_BUSES];
 641         struct i2c_client i2c_client[NUM_I2C_BUSES];
 642         struct em28xx_i2c_bus i2c_bus[NUM_I2C_BUSES];
 643
 644         unsigned char eeprom_addrwidth_16bit:1;
 645         unsigned def_i2c_bus;   /* Default I2C bus */
 646         unsigned cur_i2c_bus;   /* Current I2C bus */
 647         struct rt_mutex i2c_bus_lock;
 648
 649         /* video for linux */
 650         unsigned int ctl_input; /* selected input */
 651         unsigned int ctl_ainput;/* selected audio input */
 652         unsigned int ctl_aoutput;/* selected audio output */
 653         int mute;
 654         int volume;
 655
 656         unsigned long hash;     /* eeprom hash - for boards with generic ID */
 657         unsigned long i2c_hash; /* i2c devicelist hash -
 658                                    for boards with generic ID */
 659
 660         struct work_struct         request_module_wk;
 661
 662         /* locks */
 663         struct mutex lock;
 664         struct mutex ctrl_urb_lock;     /* protects urb_buf */
 665
 666         /* resources in use */
 667         unsigned int resources;
 668
 669         /* eeprom content */
 670         u8 *eedata;
 671         u16 eedata_len;
 672
 673         /* Isoc control struct */
 674         struct em28xx_dmaqueue vidq;
 675         struct em28xx_dmaqueue vbiq;
 676         struct em28xx_usb_ctl usb_ctl;
 677         spinlock_t slock;
 678
 679         /* usb transfer */
 680         struct usb_interface *intf;     /* the usb interface */
 681         u8 ifnum;               /* number of the assigned usb interface */
 682         u8 analog_ep_isoc;      /* address of isoc endpoint for analog */
 683         u8 analog_ep_bulk;      /* address of bulk endpoint for analog */
 684         u8 dvb_ep_isoc;         /* address of isoc endpoint for DVB */
 685         u8 dvb_ep_bulk;         /* address of bulk endpoint for DVB */
 686         int alt;                /* alternate setting */
 687         int max_pkt_size;       /* max packet size of the selected ep at alt */
 688         int packet_multiplier;  /* multiplier for wMaxPacketSize, used for
 689                                    URB buffer size definition */
 690         int num_alt;            /* number of alternative settings */
 691         unsigned int *alt_max_pkt_size_isoc; /* array of isoc wMaxPacketSize */
 692         unsigned int analog_xfer_bulk:1;        /* use bulk instead of isoc
 693                                                    transfers for analog      */
 694         int dvb_alt_isoc;       /* alternate setting for DVB isoc transfers */
 695         unsigned int dvb_max_pkt_size_isoc;     /* isoc max packet size of the
 696                                                    selected DVB ep at dvb_alt */
 697         unsigned int dvb_xfer_bulk:1;           /* use bulk instead of isoc
 698                                                    transfers for DVB          */
 699         char urb_buf[URB_MAX_CTRL_SIZE];        /* urb control msg buffer */
 700
 701         /* helper funcs that call usb_control_msg */
 702         int (*em28xx_write_regs)(struct em28xx *dev, u16 reg,
 703                                  char *buf, int len);
 704         int (*em28xx_read_reg)(struct em28xx *dev, u16 reg);
 705         int (*em28xx_read_reg_req_len)(struct em28xx *dev, u8 req, u16 reg,
 706                                        char *buf, int len);
 707         int (*em28xx_write_regs_req)(struct em28xx *dev, u8 req, u16 reg,
 708                                      char *buf, int len);
 709         int (*em28xx_read_reg_req)(struct em28xx *dev, u8 req, u16 reg);
 710
 711         enum em28xx_mode mode;
 712
 713         /* Button state polling */
 714         struct delayed_work buttons_query_work;
 715         u8 button_polling_addresses[EM28XX_NUM_BUTTON_ADDRESSES_MAX];
 716         u8 button_polling_last_values[EM28XX_NUM_BUTTON_ADDRESSES_MAX];
 717         u8 num_button_polling_addresses;
 718         u16 button_polling_interval; /* [ms] */
 719         /* Snapshot button input device */
 720         char snapshot_button_path[30];  /* path of the input dev */
 721         struct input_dev *sbutton_input_dev;
 722
 723 #ifdef CONFIG_MEDIA_CONTROLLER
 724         struct media_device *media_dev;
 725         struct media_entity input_ent[MAX_EM28XX_INPUT];
 726         struct media_pad input_pad[MAX_EM28XX_INPUT];
 727 #endif
 728 };
 729
 730 #define kref_to_dev(d) container_of(d, struct em28xx, ref)
 731
 732 struct em28xx_ops {
 733         struct list_head next;
 734         char *name;
 735         int id;
 736         int (*init)(struct em28xx *);
 737         int (*fini)(struct em28xx *);
 738         int (*suspend)(struct em28xx *);
 739         int (*resume)(struct em28xx *);
 740 };
 741
 742 /* Provided by em28xx-i2c.c */
 743 void em28xx_do_i2c_scan(struct em28xx *dev, unsigned bus);
 744 int  em28xx_i2c_register(struct em28xx *dev, unsigned bus,
 745                          enum em28xx_i2c_algo_type algo_type);
 746 int  em28xx_i2c_unregister(struct em28xx *dev, unsigned bus);
 747
 748 /* Provided by em28xx-core.c */
 749 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
 750                             char *buf, int len);
 751 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
 752 int em28xx_read_reg(struct em28xx *dev, u16 reg);
 753 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
 754                           int len);
 755 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
 756 int em28xx_write_reg(struct em28xx *dev, u16 reg, u8 val);
 757 int em28xx_write_reg_bits(struct em28xx *dev, u16 reg, u8 val,
 758                           u8 bitmask);
 759 int em28xx_toggle_reg_bits(struct em28xx *dev, u16 reg, u8 bitmask);
 760
 761 int em28xx_read_ac97(struct em28xx *dev, u8 reg);
 762 int em28xx_write_ac97(struct em28xx *dev, u8 reg, u16 val);
 763
 764 int em28xx_audio_analog_set(struct em28xx *dev);
 765 int em28xx_audio_setup(struct em28xx *dev);
 766
 767 const struct em28xx_led *em28xx_find_led(struct em28xx *dev,
 768                                          enum em28xx_led_role role);
 769 int em28xx_capture_start(struct em28xx *dev, int start);
 770 int em28xx_alloc_urbs(struct em28xx *dev, enum em28xx_mode mode, int xfer_bulk,
 771                       int num_bufs, int max_pkt_size, int packet_multiplier);
 772 int em28xx_init_usb_xfer(struct em28xx *dev, enum em28xx_mode mode,
 773                          int xfer_bulk,
 774                          int num_bufs, int max_pkt_size, int packet_multiplier,
 775                          int (*urb_data_copy)
 776                                         (struct em28xx *dev, struct urb *urb));
 777 void em28xx_uninit_usb_xfer(struct em28xx *dev, enum em28xx_mode mode);
 778 void em28xx_stop_urbs(struct em28xx *dev);
 779 int em28xx_set_mode(struct em28xx *dev, enum em28xx_mode set_mode);
 780 int em28xx_gpio_set(struct em28xx *dev, struct em28xx_reg_seq *gpio);
 781 int em28xx_register_extension(struct em28xx_ops *dev);
 782 void em28xx_unregister_extension(struct em28xx_ops *dev);
 783 void em28xx_init_extension(struct em28xx *dev);
 784 void em28xx_close_extension(struct em28xx *dev);
 785 int em28xx_suspend_extension(struct em28xx *dev);
 786 int em28xx_resume_extension(struct em28xx *dev);
 787
 788 /* Provided by em28xx-cards.c */
 789 extern struct em28xx_board em28xx_boards[];
 790 extern struct usb_device_id em28xx_id_table[];
 791 int em28xx_tuner_callback(void *ptr, int component, int command, int arg);
 792 void em28xx_setup_xc3028(struct em28xx *dev, struct xc2028_ctrl *ctl);
 793 void em28xx_free_device(struct kref *ref);
 794
 795 /* Provided by em28xx-camera.c */
 796 int em28xx_detect_sensor(struct em28xx *dev);
 797 int em28xx_init_camera(struct em28xx *dev);
 798
 799 #endif