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