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