drivers/media/usb/em28xx/em28xx.h

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