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