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