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