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