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