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