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.1"
  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-vmalloc.h>
  39 #include <media/v4l2-device.h>
  40 #include <media/v4l2-ctrls.h>
  41 #include <media/v4l2-fh.h>
  42 #include <media/ir-kbd-i2c.h>
  43 #include <media/rc-core.h>
  44 #include "tuner-xc2028.h"
  45 #include "xc5000.h"
  46 #include "em28xx-reg.h"
  47
  48 /* Boards supported by driver */
  49 #define EM2800_BOARD_UNKNOWN                      0
  50 #define EM2820_BOARD_UNKNOWN                      1
  51 #define EM2820_BOARD_TERRATEC_CINERGY_250         2
  52 #define EM2820_BOARD_PINNACLE_USB_2               3
  53 #define EM2820_BOARD_HAUPPAUGE_WINTV_USB_2        4
  54 #define EM2820_BOARD_MSI_VOX_USB_2                5
  55 #define EM2800_BOARD_TERRATEC_CINERGY_200         6
  56 #define EM2800_BOARD_LEADTEK_WINFAST_USBII        7
  57 #define EM2800_BOARD_KWORLD_USB2800               8
  58 #define EM2820_BOARD_PINNACLE_DVC_90              9
  59 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900      10
  60 #define EM2880_BOARD_TERRATEC_HYBRID_XS           11
  61 #define EM2820_BOARD_KWORLD_PVRTV2800RF           12
  62 #define EM2880_BOARD_TERRATEC_PRODIGY_XS          13
  63 #define EM2820_BOARD_PROLINK_PLAYTV_USB2          14
  64 #define EM2800_BOARD_VGEAR_POCKETTV               15
  65 #define EM2883_BOARD_HAUPPAUGE_WINTV_HVR_950      16
  66 #define EM2880_BOARD_PINNACLE_PCTV_HD_PRO         17
  67 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900_R2   18
  68 #define EM2860_BOARD_SAA711X_REFERENCE_DESIGN     19
  69 #define EM2880_BOARD_AMD_ATI_TV_WONDER_HD_600     20
  70 #define EM2800_BOARD_GRABBEEX_USB2800             21
  71 #define EM2750_BOARD_UNKNOWN                      22
  72 #define EM2750_BOARD_DLCW_130                     23
  73 #define EM2820_BOARD_DLINK_USB_TV                 24
  74 #define EM2820_BOARD_GADMEI_UTV310                25
  75 #define EM2820_BOARD_HERCULES_SMART_TV_USB2       26
  76 #define EM2820_BOARD_PINNACLE_USB_2_FM1216ME      27
  77 #define EM2820_BOARD_LEADTEK_WINFAST_USBII_DELUXE 28
  78 #define EM2860_BOARD_TVP5150_REFERENCE_DESIGN     29
  79 #define EM2820_BOARD_VIDEOLOGY_20K14XUSB          30
  80 #define EM2821_BOARD_USBGEAR_VD204                31
  81 #define EM2821_BOARD_SUPERCOMP_USB_2              32
  82 #define EM2860_BOARD_ELGATO_VIDEO_CAPTURE         33
  83 #define EM2860_BOARD_TERRATEC_HYBRID_XS           34
  84 #define EM2860_BOARD_TYPHOON_DVD_MAKER            35
  85 #define EM2860_BOARD_NETGMBH_CAM                  36
  86 #define EM2860_BOARD_GADMEI_UTV330                37
  87 #define EM2861_BOARD_YAKUMO_MOVIE_MIXER           38
  88 #define EM2861_BOARD_KWORLD_PVRTV_300U            39
  89 #define EM2861_BOARD_PLEXTOR_PX_TV100U            40
  90 #define EM2870_BOARD_KWORLD_350U                  41
  91 #define EM2870_BOARD_KWORLD_355U                  42
  92 #define EM2870_BOARD_TERRATEC_XS                  43
  93 #define EM2870_BOARD_TERRATEC_XS_MT2060           44
  94 #define EM2870_BOARD_PINNACLE_PCTV_DVB            45
  95 #define EM2870_BOARD_COMPRO_VIDEOMATE             46
  96 #define EM2880_BOARD_KWORLD_DVB_305U              47
  97 #define EM2880_BOARD_KWORLD_DVB_310U              48
  98 #define EM2880_BOARD_MSI_DIGIVOX_AD               49
  99 #define EM2880_BOARD_MSI_DIGIVOX_AD_II            50
 100 #define EM2880_BOARD_TERRATEC_HYBRID_XS_FR        51
 101 #define EM2881_BOARD_DNT_DA2_HYBRID               52
 102 #define EM2881_BOARD_PINNACLE_HYBRID_PRO          53
 103 #define EM2882_BOARD_KWORLD_VS_DVBT               54
 104 #define EM2882_BOARD_TERRATEC_HYBRID_XS           55
 105 #define EM2882_BOARD_PINNACLE_HYBRID_PRO_330E     56
 106 #define EM2883_BOARD_KWORLD_HYBRID_330U           57
 107 #define EM2820_BOARD_COMPRO_VIDEOMATE_FORYOU      58
 108 #define EM2874_BOARD_PCTV_HD_MINI_80E             59
 109 #define EM2883_BOARD_HAUPPAUGE_WINTV_HVR_850      60
 110 #define EM2820_BOARD_PROLINK_PLAYTV_BOX4_USB2     61
 111 #define EM2820_BOARD_GADMEI_TVR200                62
 112 #define EM2860_BOARD_KAIOMY_TVNPC_U2              63
 113 #define EM2860_BOARD_EASYCAP                      64
 114 #define EM2820_BOARD_IODATA_GVMVP_SZ              65
 115 #define EM2880_BOARD_EMPIRE_DUAL_TV               66
 116 #define EM2860_BOARD_TERRATEC_GRABBY              67
 117 #define EM2860_BOARD_TERRATEC_AV350               68
 118 #define EM2882_BOARD_KWORLD_ATSC_315U             69
 119 #define EM2882_BOARD_EVGA_INDTUBE                 70
 120 #define EM2820_BOARD_SILVERCREST_WEBCAM           71
 121 #define EM2861_BOARD_GADMEI_UTV330PLUS            72
 122 #define EM2870_BOARD_REDDO_DVB_C_USB_BOX          73
 123 #define EM2800_BOARD_VC211A                       74
 124 #define EM2882_BOARD_DIKOM_DK300                  75
 125 #define EM2870_BOARD_KWORLD_A340                  76
 126 #define EM2874_BOARD_LEADERSHIP_ISDBT             77
 127 #define EM28174_BOARD_PCTV_290E                   78
 128 #define EM2884_BOARD_TERRATEC_H5                  79
 129 #define EM28174_BOARD_PCTV_460E                   80
 130 #define EM2884_BOARD_HAUPPAUGE_WINTV_HVR_930C     81
 131 #define EM2884_BOARD_CINERGY_HTC_STICK            82
 132 #define EM2860_BOARD_HT_VIDBOX_NW03               83
 133 #define EM2874_BOARD_MAXMEDIA_UB425_TC            84
 134 #define EM2884_BOARD_PCTV_510E                    85
 135 #define EM2884_BOARD_PCTV_520E                    86
 136 #define EM2884_BOARD_TERRATEC_HTC_USB_XS          87
 137 #define EM2884_BOARD_C3TECH_DIGITAL_DUO           88
 138 #define EM2874_BOARD_DELOCK_61959                 89
 139 #define EM2874_BOARD_KWORLD_UB435Q_V2             90
 140 #define EM2765_BOARD_SPEEDLINK_VAD_LAPLACE        91
 141 #define EM28178_BOARD_PCTV_461E                   92
 142 #define EM2874_BOARD_KWORLD_UB435Q_V3             93
 143 #define EM28178_BOARD_PCTV_292E                   94
 144 #define EM2861_BOARD_LEADTEK_VC100                95
 145 #define EM28178_BOARD_TERRATEC_T2_STICK_HD        96
 146
 147 /* Limits minimum and default number of buffers */
 148 #define EM28XX_MIN_BUF 4
 149 #define EM28XX_DEF_BUF 8
 150
 151 /*Limits the max URB message size */
 152 #define URB_MAX_CTRL_SIZE 80
 153
 154 /* Params for validated field */
 155 #define EM28XX_BOARD_NOT_VALIDATED 1
 156 #define EM28XX_BOARD_VALIDATED     0
 157
 158 /* Params for em28xx_cmd() audio */
 159 #define EM28XX_START_AUDIO      1
 160 #define EM28XX_STOP_AUDIO       0
 161
 162 /* maximum number of em28xx boards */
 163 #define EM28XX_MAXBOARDS 4 /*FIXME: should be bigger */
 164
 165 /* maximum number of frames that can be queued */
 166 #define EM28XX_NUM_FRAMES 5
 167 /* number of frames that get used for v4l2_read() */
 168 #define EM28XX_NUM_READ_FRAMES 2
 169
 170 /* number of buffers for isoc transfers */
 171 #define EM28XX_NUM_BUFS 5
 172 #define EM28XX_DVB_NUM_BUFS 5
 173
 174 /* max number of I2C buses on em28xx devices */
 175 #define NUM_I2C_BUSES   2
 176
 177 /* isoc transfers: number of packets for each buffer
 178    windows requests only 64 packets .. so we better do the same
 179    this is what I found out for all alternate numbers there!
 180  */
 181 #define EM28XX_NUM_ISOC_PACKETS 64
 182 #define EM28XX_DVB_NUM_ISOC_PACKETS 64
 183
 184 /* bulk transfers: transfer buffer size = packet size * packet multiplier
 185    USB 2.0 spec says bulk packet size is always 512 bytes
 186  */
 187 #define EM28XX_BULK_PACKET_MULTIPLIER 384
 188 #define EM28XX_DVB_BULK_PACKET_MULTIPLIER 384
 189
 190 #define EM28XX_INTERLACED_DEFAULT 1
 191
 192 /*
 193  * Time in msecs to wait for i2c xfers to finish.
 194  * 35ms is the maximum time a SMBUS device could wait when
 195  * clock stretching is used. As the transfer itself will take
 196  * some time to happen, set it to 35 ms.
 197  *
 198  * Ok, I2C doesn't specify any limit. So, eventually, we may need
 199  * to increase this timeout.
 200  *
 201  * FIXME: this assumes that an I2C message is not longer than 1ms.
 202  * This is actually dependent on the I2C bus speed, although most
 203  * devices use a 100kHz clock. So, this assumtion is true most of
 204  * the time.
 205  */
 206 #define EM28XX_I2C_XFER_TIMEOUT         36
 207
 208 /* time in msecs to wait for AC97 xfers to finish */
 209 #define EM28XX_AC97_XFER_TIMEOUT        100
 210
 211 /* max. number of button state polling addresses */
 212 #define EM28XX_NUM_BUTTON_ADDRESSES_MAX         5
 213
 214 enum em28xx_mode {
 215         EM28XX_SUSPEND,
 216         EM28XX_ANALOG_MODE,
 217         EM28XX_DIGITAL_MODE,
 218 };
 219
 220 struct em28xx;
 221
 222 struct em28xx_usb_bufs {
 223                 /* max packet size of isoc transaction */
 224         int                             max_pkt_size;
 225
 226                 /* number of packets in each buffer */
 227         int                             num_packets;
 228
 229                 /* number of allocated urbs */
 230         int                             num_bufs;
 231
 232                 /* urb for isoc/bulk transfers */
 233         struct urb                      **urb;
 234
 235                 /* transfer buffers for isoc/bulk transfer */
 236         char                            **transfer_buffer;
 237 };
 238
 239 struct em28xx_usb_ctl {
 240                 /* isoc/bulk transfer buffers for analog mode */
 241         struct em28xx_usb_bufs          analog_bufs;
 242
 243                 /* isoc/bulk transfer buffers for digital mode */
 244         struct em28xx_usb_bufs          digital_bufs;
 245
 246                 /* Stores already requested buffers */
 247         struct em28xx_buffer    *vid_buf;
 248         struct em28xx_buffer    *vbi_buf;
 249
 250                 /* copy data from URB */
 251         int (*urb_data_copy)(struct em28xx *dev, struct urb *urb);
 252
 253 };
 254
 255 /* Struct to enumberate video formats */
 256 struct em28xx_fmt {
 257         char  *name;
 258         u32   fourcc;          /* v4l2 format id */
 259         int   depth;
 260         int   reg;
 261 };
 262
 263 /* buffer for one video frame */
 264 struct em28xx_buffer {
 265         /* common v4l buffer stuff -- must be first */
 266         struct vb2_buffer vb;
 267         struct list_head list;
 268
 269         void *mem;
 270         unsigned int length;
 271         int top_field;
 272
 273         /* counter to control buffer fill */
 274         unsigned int pos;
 275         /* NOTE; in interlaced mode, this value is reset to zero at
 276          * the start of each new field (not frame !)               */
 277
 278         /* pointer to vmalloc memory address in vb */
 279         char *vb_buf;
 280 };
 281
 282 struct em28xx_dmaqueue {
 283         struct list_head       active;
 284
 285         wait_queue_head_t          wq;
 286 };
 287
 288 /* inputs */
 289
 290 #define MAX_EM28XX_INPUT 4
 291 enum enum28xx_itype {
 292         EM28XX_VMUX_COMPOSITE1 = 1,
 293         EM28XX_VMUX_COMPOSITE2,
 294         EM28XX_VMUX_COMPOSITE3,
 295         EM28XX_VMUX_COMPOSITE4,
 296         EM28XX_VMUX_SVIDEO,
 297         EM28XX_VMUX_TELEVISION,
 298         EM28XX_VMUX_CABLE,
 299         EM28XX_VMUX_DVB,
 300         EM28XX_VMUX_DEBUG,
 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_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         struct v4l2_clk *clk;
 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
 561 struct em28xx_audio {
 562         char name[50];
 563         unsigned num_urb;
 564         char **transfer_buffer;
 565         struct urb **urb;
 566         struct usb_device *udev;
 567         unsigned int capture_transfer_done;
 568         struct snd_pcm_substream   *capture_pcm_substream;
 569
 570         unsigned int hwptr_done_capture;
 571         struct snd_card            *sndcard;
 572
 573         size_t period;
 574
 575         int users;
 576         spinlock_t slock;
 577
 578         /* Controls streaming */
 579         struct work_struct wq_trigger;  /* trigger to start/stop audio */
 580         atomic_t       stream_started;  /* stream should be running if true */
 581 };
 582
 583 struct em28xx;
 584
 585 enum em28xx_i2c_algo_type {
 586         EM28XX_I2C_ALGO_EM28XX = 0,
 587         EM28XX_I2C_ALGO_EM2800,
 588         EM28XX_I2C_ALGO_EM25XX_BUS_B,
 589 };
 590
 591 struct em28xx_i2c_bus {
 592         struct em28xx *dev;
 593
 594         unsigned bus;
 595         enum em28xx_i2c_algo_type algo_type;
 596 };
 597
 598 /* main device struct */
 599 struct em28xx {
 600         struct kref ref;
 601
 602         /* Sub-module data */
 603         struct em28xx_v4l2 *v4l2;
 604         struct em28xx_dvb *dvb;
 605         struct em28xx_audio adev;
 606         struct em28xx_IR *ir;
 607
 608         /* generic device properties */
 609         char name[30];          /* name (including minor) of the device */
 610         int model;              /* index in the device_data struct */
 611         int devno;              /* marks the number of this device */
 612         enum em28xx_chip_id chip_id;
 613
 614         unsigned int is_em25xx:1;       /* em25xx/em276x/7x/8x family bridge */
 615         unsigned char disconnected:1;   /* device has been diconnected */
 616         unsigned int has_video:1;
 617         unsigned int is_audio_only:1;
 618         enum em28xx_int_audio_type int_audio_type;
 619         enum em28xx_usb_audio_type usb_audio_type;
 620
 621         struct em28xx_board board;
 622
 623         enum em28xx_sensor em28xx_sensor;       /* camera specific */
 624
 625         /* Some older em28xx chips needs a waiting time after writing */
 626         unsigned int wait_after_write;
 627
 628         struct list_head        devlist;
 629
 630         u32 i2s_speed;          /* I2S speed for audio digital stream */
 631
 632         struct em28xx_audio_mode audio_mode;
 633
 634         int tuner_type;         /* type of the tuner */
 635
 636         /* i2c i/o */
 637         struct i2c_adapter i2c_adap[NUM_I2C_BUSES];
 638         struct i2c_client i2c_client[NUM_I2C_BUSES];
 639         struct em28xx_i2c_bus i2c_bus[NUM_I2C_BUSES];
 640
 641         unsigned char eeprom_addrwidth_16bit:1;
 642         unsigned def_i2c_bus;   /* Default I2C bus */
 643         unsigned cur_i2c_bus;   /* Current I2C bus */
 644         struct rt_mutex i2c_bus_lock;
 645
 646         /* video for linux */
 647         unsigned int ctl_input; /* selected input */
 648         unsigned int ctl_ainput;/* selected audio input */
 649         unsigned int ctl_aoutput;/* selected audio output */
 650         int mute;
 651         int volume;
 652
 653         unsigned long hash;     /* eeprom hash - for boards with generic ID */
 654         unsigned long i2c_hash; /* i2c devicelist hash -
 655                                    for boards with generic ID */
 656
 657         struct work_struct         request_module_wk;
 658
 659         /* locks */
 660         struct mutex lock;
 661         struct mutex ctrl_urb_lock;     /* protects urb_buf */
 662
 663         /* resources in use */
 664         unsigned int resources;
 665
 666         /* eeprom content */
 667         u8 *eedata;
 668         u16 eedata_len;
 669
 670         /* Isoc control struct */
 671         struct em28xx_dmaqueue vidq;
 672         struct em28xx_dmaqueue vbiq;
 673         struct em28xx_usb_ctl usb_ctl;
 674         spinlock_t slock;
 675
 676         /* usb transfer */
 677         struct usb_device *udev;        /* the usb device */
 678         u8 ifnum;               /* number of the assigned usb interface */
 679         u8 analog_ep_isoc;      /* address of isoc endpoint for analog */
 680         u8 analog_ep_bulk;      /* address of bulk endpoint for analog */
 681         u8 dvb_ep_isoc;         /* address of isoc endpoint for DVB */
 682         u8 dvb_ep_bulk;         /* address of bulk endpoint for DVB */
 683         int alt;                /* alternate setting */
 684         int max_pkt_size;       /* max packet size of the selected ep at alt */
 685         int packet_multiplier;  /* multiplier for wMaxPacketSize, used for
 686                                    URB buffer size definition */
 687         int num_alt;            /* number of alternative settings */
 688         unsigned int *alt_max_pkt_size_isoc; /* array of isoc wMaxPacketSize */
 689         unsigned int analog_xfer_bulk:1;        /* use bulk instead of isoc
 690                                                    transfers for analog      */
 691         int dvb_alt_isoc;       /* alternate setting for DVB isoc transfers */
 692         unsigned int dvb_max_pkt_size_isoc;     /* isoc max packet size of the
 693                                                    selected DVB ep at dvb_alt */
 694         unsigned int dvb_xfer_bulk:1;           /* use bulk instead of isoc
 695                                                    transfers for DVB          */
 696         char urb_buf[URB_MAX_CTRL_SIZE];        /* urb control msg buffer */
 697
 698         /* helper funcs that call usb_control_msg */
 699         int (*em28xx_write_regs)(struct em28xx *dev, u16 reg,
 700                                  char *buf, int len);
 701         int (*em28xx_read_reg)(struct em28xx *dev, u16 reg);
 702         int (*em28xx_read_reg_req_len)(struct em28xx *dev, u8 req, u16 reg,
 703                                        char *buf, int len);
 704         int (*em28xx_write_regs_req)(struct em28xx *dev, u8 req, u16 reg,
 705                                      char *buf, int len);
 706         int (*em28xx_read_reg_req)(struct em28xx *dev, u8 req, u16 reg);
 707
 708         enum em28xx_mode mode;
 709
 710         /* Button state polling */
 711         struct delayed_work buttons_query_work;
 712         u8 button_polling_addresses[EM28XX_NUM_BUTTON_ADDRESSES_MAX];
 713         u8 button_polling_last_values[EM28XX_NUM_BUTTON_ADDRESSES_MAX];
 714         u8 num_button_polling_addresses;
 715         u16 button_polling_interval; /* [ms] */
 716         /* Snapshot button input device */
 717         char snapshot_button_path[30];  /* path of the input dev */
 718         struct input_dev *sbutton_input_dev;
 719 };
 720
 721 #define kref_to_dev(d) container_of(d, struct em28xx, ref)
 722
 723 struct em28xx_ops {
 724         struct list_head next;
 725         char *name;
 726         int id;
 727         int (*init)(struct em28xx *);
 728         int (*fini)(struct em28xx *);
 729         int (*suspend)(struct em28xx *);
 730         int (*resume)(struct em28xx *);
 731 };
 732
 733 /* Provided by em28xx-i2c.c */
 734 void em28xx_do_i2c_scan(struct em28xx *dev, unsigned bus);
 735 int  em28xx_i2c_register(struct em28xx *dev, unsigned bus,
 736                          enum em28xx_i2c_algo_type algo_type);
 737 int  em28xx_i2c_unregister(struct em28xx *dev, unsigned bus);
 738
 739 /* Provided by em28xx-core.c */
 740 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
 741                             char *buf, int len);
 742 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
 743 int em28xx_read_reg(struct em28xx *dev, u16 reg);
 744 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
 745                           int len);
 746 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
 747 int em28xx_write_reg(struct em28xx *dev, u16 reg, u8 val);
 748 int em28xx_write_reg_bits(struct em28xx *dev, u16 reg, u8 val,
 749                           u8 bitmask);
 750 int em28xx_toggle_reg_bits(struct em28xx *dev, u16 reg, u8 bitmask);
 751
 752 int em28xx_read_ac97(struct em28xx *dev, u8 reg);
 753 int em28xx_write_ac97(struct em28xx *dev, u8 reg, u16 val);
 754
 755 int em28xx_audio_analog_set(struct em28xx *dev);
 756 int em28xx_audio_setup(struct em28xx *dev);
 757
 758 const struct em28xx_led *em28xx_find_led(struct em28xx *dev,
 759                                          enum em28xx_led_role role);
 760 int em28xx_capture_start(struct em28xx *dev, int start);
 761 int em28xx_alloc_urbs(struct em28xx *dev, enum em28xx_mode mode, int xfer_bulk,
 762                       int num_bufs, int max_pkt_size, int packet_multiplier);
 763 int em28xx_init_usb_xfer(struct em28xx *dev, enum em28xx_mode mode,
 764                          int xfer_bulk,
 765                          int num_bufs, int max_pkt_size, int packet_multiplier,
 766                          int (*urb_data_copy)
 767                                         (struct em28xx *dev, struct urb *urb));
 768 void em28xx_uninit_usb_xfer(struct em28xx *dev, enum em28xx_mode mode);
 769 void em28xx_stop_urbs(struct em28xx *dev);
 770 int em28xx_set_mode(struct em28xx *dev, enum em28xx_mode set_mode);
 771 int em28xx_gpio_set(struct em28xx *dev, struct em28xx_reg_seq *gpio);
 772 int em28xx_register_extension(struct em28xx_ops *dev);
 773 void em28xx_unregister_extension(struct em28xx_ops *dev);
 774 void em28xx_init_extension(struct em28xx *dev);
 775 void em28xx_close_extension(struct em28xx *dev);
 776 int em28xx_suspend_extension(struct em28xx *dev);
 777 int em28xx_resume_extension(struct em28xx *dev);
 778
 779 /* Provided by em28xx-cards.c */
 780 extern struct em28xx_board em28xx_boards[];
 781 extern struct usb_device_id em28xx_id_table[];
 782 int em28xx_tuner_callback(void *ptr, int component, int command, int arg);
 783 void em28xx_setup_xc3028(struct em28xx *dev, struct xc2028_ctrl *ctl);
 784 void em28xx_free_device(struct kref *ref);
 785
 786 /* Provided by em28xx-camera.c */
 787 int em28xx_detect_sensor(struct em28xx *dev);
 788 int em28xx_init_camera(struct em28xx *dev);
 789
 790 /* printk macros */
 791
 792 #define em28xx_err(fmt, arg...) do {\
 793         printk(KERN_ERR fmt , ##arg); } while (0)
 794
 795 #define em28xx_errdev(fmt, arg...) do {\
 796         printk(KERN_ERR "%s: "fmt,\
 797                         dev->name , ##arg); } while (0)
 798
 799 #define em28xx_info(fmt, arg...) do {\
 800         printk(KERN_INFO "%s: "fmt,\
 801                         dev->name , ##arg); } while (0)
 802 #define em28xx_warn(fmt, arg...) do {\
 803         printk(KERN_WARNING "%s: "fmt,\
 804                         dev->name , ##arg); } while (0)
 805
 806 #endif