]> Pileus Git - ~andy/linux/blob - drivers/media/usb/em28xx/em28xx.h
Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/sage/ceph...
[~andy/linux] / 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/videobuf2-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 #include "tuner-xc2028.h"
41 #include "xc5000.h"
42 #include "em28xx-reg.h"
43
44 /* Boards supported by driver */
45 #define EM2800_BOARD_UNKNOWN                    0
46 #define EM2820_BOARD_UNKNOWN                    1
47 #define EM2820_BOARD_TERRATEC_CINERGY_250       2
48 #define EM2820_BOARD_PINNACLE_USB_2             3
49 #define EM2820_BOARD_HAUPPAUGE_WINTV_USB_2      4
50 #define EM2820_BOARD_MSI_VOX_USB_2              5
51 #define EM2800_BOARD_TERRATEC_CINERGY_200       6
52 #define EM2800_BOARD_LEADTEK_WINFAST_USBII      7
53 #define EM2800_BOARD_KWORLD_USB2800             8
54 #define EM2820_BOARD_PINNACLE_DVC_90            9
55 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900    10
56 #define EM2880_BOARD_TERRATEC_HYBRID_XS         11
57 #define EM2820_BOARD_KWORLD_PVRTV2800RF         12
58 #define EM2880_BOARD_TERRATEC_PRODIGY_XS        13
59 #define EM2820_BOARD_PROLINK_PLAYTV_USB2        14
60 #define EM2800_BOARD_VGEAR_POCKETTV             15
61 #define EM2883_BOARD_HAUPPAUGE_WINTV_HVR_950    16
62 #define EM2880_BOARD_PINNACLE_PCTV_HD_PRO       17
63 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900_R2 18
64 #define EM2860_BOARD_SAA711X_REFERENCE_DESIGN   19
65 #define EM2880_BOARD_AMD_ATI_TV_WONDER_HD_600   20
66 #define EM2800_BOARD_GRABBEEX_USB2800           21
67 #define EM2750_BOARD_UNKNOWN                      22
68 #define EM2750_BOARD_DLCW_130                     23
69 #define EM2820_BOARD_DLINK_USB_TV                 24
70 #define EM2820_BOARD_GADMEI_UTV310                25
71 #define EM2820_BOARD_HERCULES_SMART_TV_USB2       26
72 #define EM2820_BOARD_PINNACLE_USB_2_FM1216ME      27
73 #define EM2820_BOARD_LEADTEK_WINFAST_USBII_DELUXE 28
74 #define EM2860_BOARD_TVP5150_REFERENCE_DESIGN     29
75 #define EM2820_BOARD_VIDEOLOGY_20K14XUSB          30
76 #define EM2821_BOARD_USBGEAR_VD204                31
77 #define EM2821_BOARD_SUPERCOMP_USB_2              32
78 #define EM2860_BOARD_ELGATO_VIDEO_CAPTURE         33
79 #define EM2860_BOARD_TERRATEC_HYBRID_XS           34
80 #define EM2860_BOARD_TYPHOON_DVD_MAKER            35
81 #define EM2860_BOARD_NETGMBH_CAM                  36
82 #define EM2860_BOARD_GADMEI_UTV330                37
83 #define EM2861_BOARD_YAKUMO_MOVIE_MIXER           38
84 #define EM2861_BOARD_KWORLD_PVRTV_300U            39
85 #define EM2861_BOARD_PLEXTOR_PX_TV100U            40
86 #define EM2870_BOARD_KWORLD_350U                  41
87 #define EM2870_BOARD_KWORLD_355U                  42
88 #define EM2870_BOARD_TERRATEC_XS                  43
89 #define EM2870_BOARD_TERRATEC_XS_MT2060           44
90 #define EM2870_BOARD_PINNACLE_PCTV_DVB            45
91 #define EM2870_BOARD_COMPRO_VIDEOMATE             46
92 #define EM2880_BOARD_KWORLD_DVB_305U              47
93 #define EM2880_BOARD_KWORLD_DVB_310U              48
94 #define EM2880_BOARD_MSI_DIGIVOX_AD               49
95 #define EM2880_BOARD_MSI_DIGIVOX_AD_II            50
96 #define EM2880_BOARD_TERRATEC_HYBRID_XS_FR        51
97 #define EM2881_BOARD_DNT_DA2_HYBRID               52
98 #define EM2881_BOARD_PINNACLE_HYBRID_PRO          53
99 #define EM2882_BOARD_KWORLD_VS_DVBT               54
100 #define EM2882_BOARD_TERRATEC_HYBRID_XS           55
101 #define EM2882_BOARD_PINNACLE_HYBRID_PRO_330E     56
102 #define EM2883_BOARD_KWORLD_HYBRID_330U                  57
103 #define EM2820_BOARD_COMPRO_VIDEOMATE_FORYOU      58
104 #define EM2883_BOARD_HAUPPAUGE_WINTV_HVR_850      60
105 #define EM2820_BOARD_PROLINK_PLAYTV_BOX4_USB2     61
106 #define EM2820_BOARD_GADMEI_TVR200                62
107 #define EM2860_BOARD_KAIOMY_TVNPC_U2              63
108 #define EM2860_BOARD_EASYCAP                      64
109 #define EM2820_BOARD_IODATA_GVMVP_SZ              65
110 #define EM2880_BOARD_EMPIRE_DUAL_TV               66
111 #define EM2860_BOARD_TERRATEC_GRABBY              67
112 #define EM2860_BOARD_TERRATEC_AV350               68
113 #define EM2882_BOARD_KWORLD_ATSC_315U             69
114 #define EM2882_BOARD_EVGA_INDTUBE                 70
115 #define EM2820_BOARD_SILVERCREST_WEBCAM           71
116 #define EM2861_BOARD_GADMEI_UTV330PLUS           72
117 #define EM2870_BOARD_REDDO_DVB_C_USB_BOX          73
118 #define EM2800_BOARD_VC211A                       74
119 #define EM2882_BOARD_DIKOM_DK300                  75
120 #define EM2870_BOARD_KWORLD_A340                  76
121 #define EM2874_BOARD_LEADERSHIP_ISDBT             77
122 #define EM28174_BOARD_PCTV_290E                   78
123 #define EM2884_BOARD_TERRATEC_H5                  79
124 #define EM28174_BOARD_PCTV_460E                   80
125 #define EM2884_BOARD_HAUPPAUGE_WINTV_HVR_930C     81
126 #define EM2884_BOARD_CINERGY_HTC_STICK            82
127 #define EM2860_BOARD_HT_VIDBOX_NW03               83
128 #define EM2874_BOARD_MAXMEDIA_UB425_TC            84
129 #define EM2884_BOARD_PCTV_510E                    85
130 #define EM2884_BOARD_PCTV_520E                    86
131 #define EM2884_BOARD_TERRATEC_HTC_USB_XS          87
132
133 /* Limits minimum and default number of buffers */
134 #define EM28XX_MIN_BUF 4
135 #define EM28XX_DEF_BUF 8
136
137 /*Limits the max URB message size */
138 #define URB_MAX_CTRL_SIZE 80
139
140 /* Params for validated field */
141 #define EM28XX_BOARD_NOT_VALIDATED 1
142 #define EM28XX_BOARD_VALIDATED     0
143
144 /* Params for em28xx_cmd() audio */
145 #define EM28XX_START_AUDIO      1
146 #define EM28XX_STOP_AUDIO       0
147
148 /* maximum number of em28xx boards */
149 #define EM28XX_MAXBOARDS 4 /*FIXME: should be bigger */
150
151 /* maximum number of frames that can be queued */
152 #define EM28XX_NUM_FRAMES 5
153 /* number of frames that get used for v4l2_read() */
154 #define EM28XX_NUM_READ_FRAMES 2
155
156 /* number of buffers for isoc transfers */
157 #define EM28XX_NUM_BUFS 5
158 #define EM28XX_DVB_NUM_BUFS 5
159
160 /* isoc transfers: number of packets for each buffer
161    windows requests only 64 packets .. so we better do the same
162    this is what I found out for all alternate numbers there!
163  */
164 #define EM28XX_NUM_ISOC_PACKETS 64
165 #define EM28XX_DVB_NUM_ISOC_PACKETS 64
166
167 /* bulk transfers: transfer buffer size = packet size * packet multiplier
168    USB 2.0 spec says bulk packet size is always 512 bytes
169  */
170 #define EM28XX_BULK_PACKET_MULTIPLIER 384
171 #define EM28XX_DVB_BULK_PACKET_MULTIPLIER 384
172
173 #define EM28XX_INTERLACED_DEFAULT 1
174
175 /*
176 #define (use usbview if you want to get the other alternate number infos)
177 #define
178 #define alternate number 2
179 #define                         Endpoint Address: 82
180                         Direction: in
181                         Attribute: 1
182                         Type: Isoc
183                         Max Packet Size: 1448
184                         Interval: 125us
185
186   alternate number 7
187
188                         Endpoint Address: 82
189                         Direction: in
190                         Attribute: 1
191                         Type: Isoc
192                         Max Packet Size: 3072
193                         Interval: 125us
194 */
195
196 /* time in msecs to wait for i2c writes to finish */
197 #define EM2800_I2C_XFER_TIMEOUT         20
198
199 enum em28xx_mode {
200         EM28XX_SUSPEND,
201         EM28XX_ANALOG_MODE,
202         EM28XX_DIGITAL_MODE,
203 };
204
205
206 struct em28xx;
207
208 struct em28xx_usb_bufs {
209                 /* max packet size of isoc transaction */
210         int                             max_pkt_size;
211
212                 /* number of packets in each buffer */
213         int                             num_packets;
214
215                 /* number of allocated urbs */
216         int                             num_bufs;
217
218                 /* urb for isoc/bulk transfers */
219         struct urb                      **urb;
220
221                 /* transfer buffers for isoc/bulk transfer */
222         char                            **transfer_buffer;
223 };
224
225 struct em28xx_usb_ctl {
226                 /* isoc/bulk transfer buffers for analog mode */
227         struct em28xx_usb_bufs          analog_bufs;
228
229                 /* isoc/bulk transfer buffers for digital mode */
230         struct em28xx_usb_bufs          digital_bufs;
231
232                 /* Stores already requested buffers */
233         struct em28xx_buffer            *vid_buf;
234         struct em28xx_buffer            *vbi_buf;
235
236                 /* copy data from URB */
237         int (*urb_data_copy) (struct em28xx *dev, struct urb *urb);
238
239 };
240
241 /* Struct to enumberate video formats */
242 struct em28xx_fmt {
243         char  *name;
244         u32   fourcc;          /* v4l2 format id */
245         int   depth;
246         int   reg;
247 };
248
249 /* buffer for one video frame */
250 struct em28xx_buffer {
251         /* common v4l buffer stuff -- must be first */
252         struct vb2_buffer vb;
253         struct list_head list;
254
255         void *mem;
256         unsigned int length;
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 #define EM28XX_AUDIO_BUFS 5
443 #define EM28XX_NUM_AUDIO_PACKETS 64
444 #define EM28XX_AUDIO_MAX_PACKET_SIZE 196 /* static value */
445 #define EM28XX_CAPTURE_STREAM_EN 1
446
447 /* em28xx extensions */
448 #define EM28XX_AUDIO   0x10
449 #define EM28XX_DVB     0x20
450 #define EM28XX_RC      0x30
451
452 /* em28xx resource types (used for res_get/res_lock etc */
453 #define EM28XX_RESOURCE_VIDEO 0x01
454 #define EM28XX_RESOURCE_VBI   0x02
455
456 struct em28xx_audio {
457         char name[50];
458         char *transfer_buffer[EM28XX_AUDIO_BUFS];
459         struct urb *urb[EM28XX_AUDIO_BUFS];
460         struct usb_device *udev;
461         unsigned int capture_transfer_done;
462         struct snd_pcm_substream   *capture_pcm_substream;
463
464         unsigned int hwptr_done_capture;
465         struct snd_card            *sndcard;
466
467         int users;
468         spinlock_t slock;
469 };
470
471 struct em28xx;
472
473 struct em28xx_fh {
474         struct v4l2_fh fh;
475         struct em28xx *dev;
476
477         enum v4l2_buf_type           type;
478 };
479
480 /* main device struct */
481 struct em28xx {
482         /* generic device properties */
483         char name[30];          /* name (including minor) of the device */
484         int model;              /* index in the device_data struct */
485         int devno;              /* marks the number of this device */
486         enum em28xx_chip_id chip_id;
487
488         unsigned char disconnected:1;   /* device has been diconnected */
489
490         int audio_ifnum;
491
492         struct v4l2_device v4l2_dev;
493         struct v4l2_ctrl_handler ctrl_handler;
494         /* provides ac97 mute and volume overrides */
495         struct v4l2_ctrl_handler ac97_ctrl_handler;
496         struct em28xx_board board;
497
498         /* Webcam specific fields */
499         enum em28xx_sensor em28xx_sensor;
500         int sensor_xres, sensor_yres;
501         int sensor_xtal;
502
503         /* Progressive (non-interlaced) mode */
504         int progressive;
505
506         /* Vinmode/Vinctl used at the driver */
507         int vinmode, vinctl;
508
509         unsigned int has_audio_class:1;
510         unsigned int has_alsa_audio:1;
511         unsigned int is_audio_only:1;
512
513         /* Controls audio streaming */
514         struct work_struct wq_trigger;              /* Trigger to start/stop audio for alsa module */
515          atomic_t       stream_started;      /* stream should be running if true */
516
517         struct em28xx_fmt *format;
518
519         struct em28xx_IR *ir;
520
521         /* Some older em28xx chips needs a waiting time after writing */
522         unsigned int wait_after_write;
523
524         struct list_head        devlist;
525
526         u32 i2s_speed;          /* I2S speed for audio digital stream */
527
528         struct em28xx_audio_mode audio_mode;
529
530         int tuner_type;         /* type of the tuner */
531         int tuner_addr;         /* tuner address */
532         int tda9887_conf;
533         /* i2c i/o */
534         struct i2c_adapter i2c_adap;
535         struct i2c_client i2c_client;
536         /* video for linux */
537         int users;              /* user count for exclusive use */
538         int streaming_users;    /* Number of actively streaming users */
539         struct video_device *vdev;      /* video for linux device struct */
540         v4l2_std_id norm;       /* selected tv norm */
541         int ctl_freq;           /* selected frequency */
542         unsigned int ctl_input; /* selected input */
543         unsigned int ctl_ainput;/* selected audio input */
544         unsigned int ctl_aoutput;/* selected audio output */
545         int mute;
546         int volume;
547         /* frame properties */
548         int width;              /* current frame width */
549         int height;             /* current frame height */
550         unsigned hscale;        /* horizontal scale factor (see datasheet) */
551         unsigned vscale;        /* vertical scale factor (see datasheet) */
552         int interlaced;         /* 1=interlace fileds, 0=just top fileds */
553         unsigned int video_bytesread;   /* Number of bytes read */
554
555         unsigned long hash;     /* eeprom hash - for boards with generic ID */
556         unsigned long i2c_hash; /* i2c devicelist hash -
557                                    for boards with generic ID */
558
559         struct em28xx_audio adev;
560
561         /* capture state tracking */
562         int capture_type;
563         unsigned char top_field:1;
564         int vbi_read;
565         unsigned int vbi_width;
566         unsigned int vbi_height; /* lines per field */
567
568         struct work_struct         request_module_wk;
569
570         /* locks */
571         struct mutex lock;
572         struct mutex ctrl_urb_lock;     /* protects urb_buf */
573         /* spinlock_t queue_lock; */
574         struct list_head inqueue, outqueue;
575         struct video_device *vbi_dev;
576         struct video_device *radio_dev;
577
578         /* Videobuf2 */
579         struct vb2_queue vb_vidq;
580         struct vb2_queue vb_vbiq;
581         struct mutex vb_queue_lock;
582         struct mutex vb_vbi_queue_lock;
583
584         /* resources in use */
585         unsigned int resources;
586
587         unsigned char eedata[256];
588
589         /* Isoc control struct */
590         struct em28xx_dmaqueue vidq;
591         struct em28xx_dmaqueue vbiq;
592         struct em28xx_usb_ctl usb_ctl;
593         spinlock_t slock;
594
595         unsigned int field_count;
596         unsigned int vbi_field_count;
597
598         /* usb transfer */
599         struct usb_device *udev;        /* the usb device */
600         u8 analog_ep_isoc;      /* address of isoc endpoint for analog */
601         u8 analog_ep_bulk;      /* address of bulk endpoint for analog */
602         u8 dvb_ep_isoc;         /* address of isoc endpoint for DVB */
603         u8 dvb_ep_bulk;         /* address of bulk endpoint for DVC */
604         int alt;                /* alternate setting */
605         int max_pkt_size;       /* max packet size of the selected ep at alt */
606         int packet_multiplier;  /* multiplier for wMaxPacketSize, used for
607                                    URB buffer size definition */
608         int num_alt;            /* number of alternative settings */
609         unsigned int *alt_max_pkt_size_isoc; /* array of isoc wMaxPacketSize */
610         unsigned int analog_xfer_bulk:1;        /* use bulk instead of isoc
611                                                    transfers for analog      */
612         int dvb_alt_isoc;       /* alternate setting for DVB isoc transfers */
613         unsigned int dvb_max_pkt_size_isoc;     /* isoc max packet size of the
614                                                    selected DVB ep at dvb_alt */
615         unsigned int dvb_xfer_bulk:1;           /* use bulk instead of isoc
616                                                    transfers for DVB          */
617         char urb_buf[URB_MAX_CTRL_SIZE];        /* urb control msg buffer */
618
619         /* helper funcs that call usb_control_msg */
620         int (*em28xx_write_regs) (struct em28xx *dev, u16 reg,
621                                         char *buf, int len);
622         int (*em28xx_read_reg) (struct em28xx *dev, u16 reg);
623         int (*em28xx_read_reg_req_len) (struct em28xx *dev, u8 req, u16 reg,
624                                         char *buf, int len);
625         int (*em28xx_write_regs_req) (struct em28xx *dev, u8 req, u16 reg,
626                                       char *buf, int len);
627         int (*em28xx_read_reg_req) (struct em28xx *dev, u8 req, u16 reg);
628
629         enum em28xx_mode mode;
630
631         /* register numbers for GPO/GPIO registers */
632         u16 reg_gpo_num, reg_gpio_num;
633
634         /* Caches GPO and GPIO registers */
635         unsigned char   reg_gpo, reg_gpio;
636
637         /* Snapshot button */
638         char snapshot_button_path[30];  /* path of the input dev */
639         struct input_dev *sbutton_input_dev;
640         struct delayed_work sbutton_query_work;
641
642         struct em28xx_dvb *dvb;
643 };
644
645 struct em28xx_ops {
646         struct list_head next;
647         char *name;
648         int id;
649         int (*init)(struct em28xx *);
650         int (*fini)(struct em28xx *);
651 };
652
653 /* Provided by em28xx-i2c.c */
654 void em28xx_do_i2c_scan(struct em28xx *dev);
655 int  em28xx_i2c_register(struct em28xx *dev);
656 int  em28xx_i2c_unregister(struct em28xx *dev);
657
658 /* Provided by em28xx-core.c */
659
660 u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
661 void em28xx_queue_unusedframes(struct em28xx *dev);
662 void em28xx_release_buffers(struct em28xx *dev);
663
664 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
665                             char *buf, int len);
666 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
667 int em28xx_read_reg(struct em28xx *dev, u16 reg);
668 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
669                           int len);
670 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
671 int em28xx_write_reg(struct em28xx *dev, u16 reg, u8 val);
672 int em28xx_write_reg_bits(struct em28xx *dev, u16 reg, u8 val,
673                                  u8 bitmask);
674
675 int em28xx_read_ac97(struct em28xx *dev, u8 reg);
676 int em28xx_write_ac97(struct em28xx *dev, u8 reg, u16 val);
677
678 int em28xx_audio_analog_set(struct em28xx *dev);
679 int em28xx_audio_setup(struct em28xx *dev);
680
681 int em28xx_colorlevels_set_default(struct em28xx *dev);
682 int em28xx_capture_start(struct em28xx *dev, int start);
683 int em28xx_vbi_supported(struct em28xx *dev);
684 int em28xx_set_outfmt(struct em28xx *dev);
685 int em28xx_resolution_set(struct em28xx *dev);
686 int em28xx_set_alternate(struct em28xx *dev);
687 int em28xx_alloc_urbs(struct em28xx *dev, enum em28xx_mode mode, int xfer_bulk,
688                       int num_bufs, int max_pkt_size, int packet_multiplier);
689 int em28xx_init_usb_xfer(struct em28xx *dev, enum em28xx_mode mode,
690                          int xfer_bulk,
691                          int num_bufs, int max_pkt_size, int packet_multiplier,
692                          int (*urb_data_copy)
693                                         (struct em28xx *dev, struct urb *urb));
694 void em28xx_uninit_usb_xfer(struct em28xx *dev, enum em28xx_mode mode);
695 void em28xx_stop_urbs(struct em28xx *dev);
696 int em28xx_isoc_dvb_max_packetsize(struct em28xx *dev);
697 int em28xx_set_mode(struct em28xx *dev, enum em28xx_mode set_mode);
698 int em28xx_gpio_set(struct em28xx *dev, struct em28xx_reg_seq *gpio);
699 void em28xx_wake_i2c(struct em28xx *dev);
700 int em28xx_register_extension(struct em28xx_ops *dev);
701 void em28xx_unregister_extension(struct em28xx_ops *dev);
702 void em28xx_init_extension(struct em28xx *dev);
703 void em28xx_close_extension(struct em28xx *dev);
704
705 /* Provided by em28xx-video.c */
706 int em28xx_vb2_setup(struct em28xx *dev);
707 int em28xx_register_analog_devices(struct em28xx *dev);
708 void em28xx_release_analog_resources(struct em28xx *dev);
709 void em28xx_ctrl_notify(struct v4l2_ctrl *ctrl, void *priv);
710 int em28xx_start_analog_streaming(struct vb2_queue *vq, unsigned int count);
711 int em28xx_stop_vbi_streaming(struct vb2_queue *vq);
712 extern const struct v4l2_ctrl_ops em28xx_ctrl_ops;
713
714 /* Provided by em28xx-cards.c */
715 extern int em2800_variant_detect(struct usb_device *udev, int model);
716 extern struct em28xx_board em28xx_boards[];
717 extern struct usb_device_id em28xx_id_table[];
718 extern const unsigned int em28xx_bcount;
719 int em28xx_tuner_callback(void *ptr, int component, int command, int arg);
720 void em28xx_release_resources(struct em28xx *dev);
721
722 /* Provided by em28xx-vbi.c */
723 extern struct vb2_ops em28xx_vbi_qops;
724
725 /* printk macros */
726
727 #define em28xx_err(fmt, arg...) do {\
728         printk(KERN_ERR fmt , ##arg); } while (0)
729
730 #define em28xx_errdev(fmt, arg...) do {\
731         printk(KERN_ERR "%s: "fmt,\
732                         dev->name , ##arg); } while (0)
733
734 #define em28xx_info(fmt, arg...) do {\
735         printk(KERN_INFO "%s: "fmt,\
736                         dev->name , ##arg); } while (0)
737 #define em28xx_warn(fmt, arg...) do {\
738         printk(KERN_WARNING "%s: "fmt,\
739                         dev->name , ##arg); } while (0)
740
741 static inline int em28xx_compression_disable(struct em28xx *dev)
742 {
743         /* side effect of disabling scaler and mixer */
744         return em28xx_write_reg(dev, EM28XX_R26_COMPR, 0x00);
745 }
746
747 static inline int em28xx_contrast_get(struct em28xx *dev)
748 {
749         return em28xx_read_reg(dev, EM28XX_R20_YGAIN) & 0x1f;
750 }
751
752 static inline int em28xx_brightness_get(struct em28xx *dev)
753 {
754         return em28xx_read_reg(dev, EM28XX_R21_YOFFSET);
755 }
756
757 static inline int em28xx_saturation_get(struct em28xx *dev)
758 {
759         return em28xx_read_reg(dev, EM28XX_R22_UVGAIN) & 0x1f;
760 }
761
762 static inline int em28xx_u_balance_get(struct em28xx *dev)
763 {
764         return em28xx_read_reg(dev, EM28XX_R23_UOFFSET);
765 }
766
767 static inline int em28xx_v_balance_get(struct em28xx *dev)
768 {
769         return em28xx_read_reg(dev, EM28XX_R24_VOFFSET);
770 }
771
772 static inline int em28xx_gamma_get(struct em28xx *dev)
773 {
774         return em28xx_read_reg(dev, EM28XX_R14_GAMMA) & 0x3f;
775 }
776
777 static inline int em28xx_contrast_set(struct em28xx *dev, s32 val)
778 {
779         u8 tmp = (u8) val;
780         return em28xx_write_regs(dev, EM28XX_R20_YGAIN, &tmp, 1);
781 }
782
783 static inline int em28xx_brightness_set(struct em28xx *dev, s32 val)
784 {
785         u8 tmp = (u8) val;
786         return em28xx_write_regs(dev, EM28XX_R21_YOFFSET, &tmp, 1);
787 }
788
789 static inline int em28xx_saturation_set(struct em28xx *dev, s32 val)
790 {
791         u8 tmp = (u8) val;
792         return em28xx_write_regs(dev, EM28XX_R22_UVGAIN, &tmp, 1);
793 }
794
795 static inline int em28xx_u_balance_set(struct em28xx *dev, s32 val)
796 {
797         u8 tmp = (u8) val;
798         return em28xx_write_regs(dev, EM28XX_R23_UOFFSET, &tmp, 1);
799 }
800
801 static inline int em28xx_v_balance_set(struct em28xx *dev, s32 val)
802 {
803         u8 tmp = (u8) val;
804         return em28xx_write_regs(dev, EM28XX_R24_VOFFSET, &tmp, 1);
805 }
806
807 static inline int em28xx_gamma_set(struct em28xx *dev, s32 val)
808 {
809         u8 tmp = (u8) val;
810         return em28xx_write_regs(dev, EM28XX_R14_GAMMA, &tmp, 1);
811 }
812
813 /*FIXME: maxw should be dependent of alt mode */
814 static inline unsigned int norm_maxw(struct em28xx *dev)
815 {
816         if (dev->board.is_webcam)
817                 return dev->sensor_xres;
818
819         if (dev->board.max_range_640_480)
820                 return 640;
821
822         return 720;
823 }
824
825 static inline unsigned int norm_maxh(struct em28xx *dev)
826 {
827         if (dev->board.is_webcam)
828                 return dev->sensor_yres;
829
830         if (dev->board.max_range_640_480)
831                 return 480;
832
833         return (dev->norm & V4L2_STD_625_50) ? 576 : 480;
834 }
835 #endif