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