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