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 #include <linux/device-id/usb.h>
27
28 #include <media/videobuf2-v4l2.h>
29 #include <media/videobuf2-vmalloc.h>
30 #include <media/v4l2-device.h>
31 #include <media/v4l2-ctrls.h>
32 #include <media/v4l2-fh.h>
33 #include <media/i2c/ir-kbd-i2c.h>
34 #include <media/rc-core.h>
35 #include "xc2028.h"
36 #include "xc5000.h"
37 #include "em28xx-reg.h"
38
39 /* Boards supported by driver */
40 #define EM2800_BOARD_UNKNOWN 0
41 #define EM2820_BOARD_UNKNOWN 1
42 #define EM2820_BOARD_TERRATEC_CINERGY_250 2
43 #define EM2820_BOARD_PINNACLE_USB_2 3
44 #define EM2820_BOARD_HAUPPAUGE_WINTV_USB_2 4
45 #define EM2820_BOARD_MSI_VOX_USB_2 5
46 #define EM2800_BOARD_TERRATEC_CINERGY_200 6
47 #define EM2800_BOARD_LEADTEK_WINFAST_USBII 7
48 #define EM2800_BOARD_KWORLD_USB2800 8
49 #define EM2820_BOARD_PINNACLE_DVC_90 9
50 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900 10
51 #define EM2880_BOARD_TERRATEC_HYBRID_XS 11
52 #define EM2820_BOARD_KWORLD_PVRTV2800RF 12
53 #define EM2880_BOARD_TERRATEC_PRODIGY_XS 13
54 #define EM2820_BOARD_PROLINK_PLAYTV_USB2 14
55 #define EM2800_BOARD_VGEAR_POCKETTV 15
56 #define EM2883_BOARD_HAUPPAUGE_WINTV_HVR_950 16
57 #define EM2880_BOARD_PINNACLE_PCTV_HD_PRO 17
58 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900_R2 18
59 #define EM2860_BOARD_SAA711X_REFERENCE_DESIGN 19
60 #define EM2880_BOARD_AMD_ATI_TV_WONDER_HD_600 20
61 #define EM2800_BOARD_GRABBEEX_USB2800 21
62 #define EM2750_BOARD_UNKNOWN 22
63 #define EM2750_BOARD_DLCW_130 23
64 #define EM2820_BOARD_DLINK_USB_TV 24
65 #define EM2820_BOARD_GADMEI_UTV310 25
66 #define EM2820_BOARD_HERCULES_SMART_TV_USB2 26
67 #define EM2820_BOARD_PINNACLE_USB_2_FM1216ME 27
68 #define EM2820_BOARD_LEADTEK_WINFAST_USBII_DELUXE 28
69 #define EM2860_BOARD_TVP5150_REFERENCE_DESIGN 29
70 #define EM2820_BOARD_VIDEOLOGY_20K14XUSB 30
71 #define EM2821_BOARD_USBGEAR_VD204 31
72 #define EM2821_BOARD_SUPERCOMP_USB_2 32
73 #define EM2860_BOARD_ELGATO_VIDEO_CAPTURE 33
74 #define EM2860_BOARD_TERRATEC_HYBRID_XS 34
75 #define EM2860_BOARD_TYPHOON_DVD_MAKER 35
76 #define EM2860_BOARD_NETGMBH_CAM 36
77 #define EM2860_BOARD_GADMEI_UTV330 37
78 #define EM2861_BOARD_YAKUMO_MOVIE_MIXER 38
79 #define EM2861_BOARD_KWORLD_PVRTV_300U 39
80 #define EM2861_BOARD_PLEXTOR_PX_TV100U 40
81 #define EM2870_BOARD_KWORLD_350U 41
82 #define EM2870_BOARD_KWORLD_355U 42
83 #define EM2870_BOARD_TERRATEC_XS 43
84 #define EM2870_BOARD_TERRATEC_XS_MT2060 44
85 #define EM2870_BOARD_PINNACLE_PCTV_DVB 45
86 #define EM2870_BOARD_COMPRO_VIDEOMATE 46
87 #define EM2880_BOARD_KWORLD_DVB_305U 47
88 #define EM2880_BOARD_KWORLD_DVB_310U 48
89 #define EM2880_BOARD_MSI_DIGIVOX_AD 49
90 #define EM2880_BOARD_MSI_DIGIVOX_AD_II 50
91 #define EM2880_BOARD_TERRATEC_HYBRID_XS_FR 51
92 #define EM2881_BOARD_DNT_DA2_HYBRID 52
93 #define EM2881_BOARD_PINNACLE_HYBRID_PRO 53
94 #define EM2882_BOARD_KWORLD_VS_DVBT 54
95 #define EM2882_BOARD_TERRATEC_HYBRID_XS 55
96 #define EM2882_BOARD_PINNACLE_HYBRID_PRO_330E 56
97 #define EM2883_BOARD_KWORLD_HYBRID_330U 57
98 #define EM2820_BOARD_COMPRO_VIDEOMATE_FORYOU 58
99 #define EM2874_BOARD_PCTV_HD_MINI_80E 59
100 #define EM2883_BOARD_HAUPPAUGE_WINTV_HVR_850 60
101 #define EM2820_BOARD_PROLINK_PLAYTV_BOX4_USB2 61
102 #define EM2820_BOARD_GADMEI_TVR200 62
103 #define EM2860_BOARD_KAIOMY_TVNPC_U2 63
104 #define EM2860_BOARD_EASYCAP 64
105 #define EM2820_BOARD_IODATA_GVMVP_SZ 65
106 #define EM2880_BOARD_EMPIRE_DUAL_TV 66
107 #define EM2860_BOARD_TERRATEC_GRABBY 67
108 #define EM2860_BOARD_TERRATEC_AV350 68
109 #define EM2882_BOARD_KWORLD_ATSC_315U 69
110 #define EM2882_BOARD_EVGA_INDTUBE 70
111 #define EM2820_BOARD_SILVERCREST_WEBCAM 71
112 #define EM2861_BOARD_GADMEI_UTV330PLUS 72
113 #define EM2870_BOARD_REDDO_DVB_C_USB_BOX 73
114 #define EM2800_BOARD_VC211A 74
115 #define EM2882_BOARD_DIKOM_DK300 75
116 #define EM2870_BOARD_KWORLD_A340 76
117 #define EM2874_BOARD_LEADERSHIP_ISDBT 77
118 #define EM28174_BOARD_PCTV_290E 78
119 #define EM2884_BOARD_TERRATEC_H5 79
120 #define EM28174_BOARD_PCTV_460E 80
121 #define EM2884_BOARD_HAUPPAUGE_WINTV_HVR_930C 81
122 #define EM2884_BOARD_CINERGY_HTC_STICK 82
123 #define EM2860_BOARD_HT_VIDBOX_NW03 83
124 #define EM2874_BOARD_MAXMEDIA_UB425_TC 84
125 #define EM2884_BOARD_PCTV_510E 85
126 #define EM2884_BOARD_PCTV_520E 86
127 #define EM2884_BOARD_TERRATEC_HTC_USB_XS 87
128 #define EM2884_BOARD_C3TECH_DIGITAL_DUO 88
129 #define EM2874_BOARD_DELOCK_61959 89
130 #define EM2874_BOARD_KWORLD_UB435Q_V2 90
131 #define EM2765_BOARD_SPEEDLINK_VAD_LAPLACE 91
132 #define EM28178_BOARD_PCTV_461E 92
133 #define EM2874_BOARD_KWORLD_UB435Q_V3 93
134 #define EM28178_BOARD_PCTV_292E 94
135 #define EM2861_BOARD_LEADTEK_VC100 95
136 #define EM28178_BOARD_TERRATEC_T2_STICK_HD 96
137 #define EM2884_BOARD_ELGATO_EYETV_HYBRID_2008 97
138 #define EM28178_BOARD_PLEX_PX_BCUD 98
139 #define EM28174_BOARD_HAUPPAUGE_WINTV_DUALHD_DVB 99
140 #define EM28174_BOARD_HAUPPAUGE_WINTV_DUALHD_01595 100
141 #define EM2884_BOARD_TERRATEC_H6 101
142 #define EM2882_BOARD_ZOLID_HYBRID_TV_STICK 102
143 #define EM2861_BOARD_MAGIX_VIDEOWANDLER2 103
144 #define EM28178_BOARD_PCTV_461E_V2 104
145 #define EM2860_BOARD_MYGICA_IGRABBER 105
146 #define EM2874_BOARD_HAUPPAUGE_USB_QUADHD 106
147 #define EM2860_BOARD_MYGICA_UTV3 107
148 #define EM2828X_BOARD_HAUPPAUGE_USB_LIVE2 108
149 #define EM2828X_BOARD_HAUPPAUGE_935_V2 109
150 #define EM2828X_BOARD_HAUPPAUGE_955_V2 110
151 #define EM2828X_BOARD_HAUPPAUGE_975_V2 111
152 #define EM28178_BOARD_PCTV_461E_V3 112
153 #define EM28281_BOARD_STARTECH_SVID2USB232 113
154
155 /* Limits minimum and default number of buffers */
156 #define EM28XX_MIN_BUF 4
157 #define EM28XX_DEF_BUF 8
158
159 /*Limits the max URB message size */
160 #define URB_MAX_CTRL_SIZE 80
161
162 /* Params for validated field */
163 #define EM28XX_BOARD_NOT_VALIDATED 1
164 #define EM28XX_BOARD_VALIDATED 0
165
166 /* Params for em28xx_cmd() audio */
167 #define EM28XX_START_AUDIO 1
168 #define EM28XX_STOP_AUDIO 0
169
170 /* maximum number of em28xx boards */
171 #define EM28XX_MAXBOARDS DVB_MAX_ADAPTERS /* All adapters could be em28xx */
172
173 /* maximum number of frames that can be queued */
174 #define EM28XX_NUM_FRAMES 5
175 /* number of frames that get used for v4l2_read() */
176 #define EM28XX_NUM_READ_FRAMES 2
177
178 /* number of buffers for isoc transfers */
179 #define EM28XX_NUM_BUFS 5
180 #define EM28XX_DVB_NUM_BUFS 5
181
182 /* max number of I2C buses on em28xx devices */
183 #define NUM_I2C_BUSES 2
184
185 /*
186 * isoc transfers: number of packets for each buffer
187 * windows requests only 64 packets .. so we better do the same
188 * this is what I found out for all alternate numbers there!
189 */
190 #define EM28XX_NUM_ISOC_PACKETS 64
191 #define EM28XX_DVB_NUM_ISOC_PACKETS 64
192
193 /*
194 * bulk transfers: transfer buffer size = packet size * packet multiplier
195 * USB 2.0 spec says bulk packet size is always 512 bytes
196 */
197 #define EM28XX_BULK_PACKET_MULTIPLIER 384
198 #define EM28XX_DVB_BULK_PACKET_MULTIPLIER 94
199
200 #define EM28XX_INTERLACED_DEFAULT 1
201
202 /* time in msecs to wait for AC97 xfers to finish */
203 #define EM28XX_AC97_XFER_TIMEOUT 100
204
205 /* max. number of button state polling addresses */
206 #define EM28XX_NUM_BUTTON_ADDRESSES_MAX 5
207
208 #define PRIMARY_TS 0
209 #define SECONDARY_TS 1
210
211 enum em28xx_mode {
212 EM28XX_SUSPEND,
213 EM28XX_ANALOG_MODE,
214 EM28XX_DIGITAL_MODE,
215 };
216
217 struct em28xx;
218
219 /**
220 * struct em28xx_usb_bufs - Contains URB-related buffer data
221 *
222 * @max_pkt_size: max packet size of isoc transaction
223 * @num_packets: number of packets in each buffer
224 * @num_bufs: number of allocated urb
225 * @urb: urb for isoc/bulk transfers
226 * @buf: transfer buffers for isoc/bulk transfer
227 */
228 struct em28xx_usb_bufs {
229 int max_pkt_size;
230 int num_packets;
231 int num_bufs;
232 struct urb **urb;
233 char **buf;
234 };
235
236 /**
237 * struct em28xx_usb_ctl - Contains URB-related buffer data
238 *
239 * @analog_bufs: isoc/bulk transfer buffers for analog mode
240 * @digital_bufs: isoc/bulk transfer buffers for digital mode
241 * @vid_buf: Stores already requested video buffers
242 * @vbi_buf: Stores already requested VBI buffers
243 * @urb_data_copy: copy data from URB
244 */
245 struct em28xx_usb_ctl {
246 struct em28xx_usb_bufs analog_bufs;
247 struct em28xx_usb_bufs digital_bufs;
248 struct em28xx_buffer *vid_buf;
249 struct em28xx_buffer *vbi_buf;
250 int (*urb_data_copy)(struct em28xx *dev, struct urb *urb);
251 };
252
253 /**
254 * struct em28xx_fmt - Struct to enumberate video formats
255 *
256 * @fourcc: v4l2 format id
257 * @depth: mean number of bits to represent a pixel
258 * @reg: em28xx register value to set it
259 */
260 struct em28xx_fmt {
261 u32 fourcc;
262 int depth;
263 int reg;
264 };
265
266 /**
267 * struct em28xx_buffer- buffer for storing one video frame
268 *
269 * @vb: common v4l buffer stuff
270 * @list: List to associate it with the other buffers
271 * @mem: pointer to the buffer, as returned by vb2_plane_vaddr()
272 * @length: length of the buffer, as returned by vb2_plane_size()
273 * @top_field: If non-zero, indicate that the buffer is the top field
274 * @pos: Indicate the next position of the buffer to be filled.
275 * @vb_buf: pointer to vmalloc memory address in vb
276 *
277 * .. note::
278 *
279 * in interlaced mode, @pos is reset to zero at the start of each new
280 * field (not frame !)
281 */
282 struct em28xx_buffer {
283 struct vb2_v4l2_buffer vb; /* must be first */
284
285 struct list_head list;
286
287 void *mem;
288 unsigned int length;
289 int top_field;
290
291 unsigned int pos;
292
293 char *vb_buf;
294 };
295
296 struct em28xx_dmaqueue {
297 struct list_head active;
298
299 wait_queue_head_t wq;
300 };
301
302 /* inputs */
303
304 #define MAX_EM28XX_INPUT 4
305 enum enum28xx_itype {
306 EM28XX_VMUX_COMPOSITE = 1,
307 EM28XX_VMUX_SVIDEO,
308 EM28XX_VMUX_TELEVISION,
309 EM28XX_RADIO,
310 };
311
312 enum em28xx_ac97_mode {
313 EM28XX_NO_AC97 = 0,
314 EM28XX_AC97_EM202,
315 EM28XX_AC97_SIGMATEL,
316 EM28XX_AC97_OTHER,
317 };
318
319 struct em28xx_audio_mode {
320 enum em28xx_ac97_mode ac97;
321 };
322
323 enum em28xx_int_audio_type {
324 EM28XX_INT_AUDIO_NONE = 0,
325 EM28XX_INT_AUDIO_AC97,
326 EM28XX_INT_AUDIO_I2S,
327 };
328
329 enum em28xx_usb_audio_type {
330 EM28XX_USB_AUDIO_NONE = 0,
331 EM28XX_USB_AUDIO_CLASS,
332 EM28XX_USB_AUDIO_VENDOR,
333 };
334
335 /**
336 * enum em28xx_amux - describes the type of audio input used by em28xx
337 *
338 * @EM28XX_AMUX_UNUSED:
339 * Used only on em28xx dev->map field, in order to mark an entry
340 * as unused.
341 * @EM28XX_AMUX_VIDEO:
342 * On devices without AC97, this is the only value that it is currently
343 * allowed.
344 * On devices with AC97, it corresponds to the AC97 mixer "Video" control.
345 * @EM28XX_AMUX_LINE_IN:
346 * Only for devices with AC97. Corresponds to AC97 mixer "Line In".
347 * @EM28XX_AMUX_VIDEO2:
348 * Only for devices with AC97. It means that em28xx should use "Line In"
349 * And AC97 should use the "Video" mixer control.
350 * @EM28XX_AMUX_PHONE:
351 * Only for devices with AC97. Corresponds to AC97 mixer "Phone".
352 * @EM28XX_AMUX_MIC:
353 * Only for devices with AC97. Corresponds to AC97 mixer "Mic".
354 * @EM28XX_AMUX_CD:
355 * Only for devices with AC97. Corresponds to AC97 mixer "CD".
356 * @EM28XX_AMUX_AUX:
357 * Only for devices with AC97. Corresponds to AC97 mixer "Aux".
358 * @EM28XX_AMUX_PCM_OUT:
359 * Only for devices with AC97. Corresponds to AC97 mixer "PCM out".
360 *
361 * The em28xx chip itself has only two audio inputs: tuner and line in.
362 * On almost all devices, only the tuner input is used.
363 *
364 * However, on most devices, an auxiliary AC97 codec device is used,
365 * usually connected to the em28xx tuner input (except for
366 * @EM28XX_AMUX_LINE_IN).
367 *
368 * The AC97 device typically have several different inputs and outputs.
369 * The exact number and description depends on their model.
370 *
371 * It is possible to AC97 to mixer more than one different entries at the
372 * same time, via the alsa mux.
373 */
374 enum em28xx_amux {
375 EM28XX_AMUX_UNUSED = -1,
376 EM28XX_AMUX_VIDEO = 0,
377 EM28XX_AMUX_LINE_IN,
378
379 /* Some less-common mixer setups */
380 EM28XX_AMUX_VIDEO2,
381 EM28XX_AMUX_PHONE,
382 EM28XX_AMUX_MIC,
383 EM28XX_AMUX_CD,
384 EM28XX_AMUX_AUX,
385 EM28XX_AMUX_PCM_OUT,
386 };
387
388 enum em28xx_aout {
389 /* AC97 outputs */
390 EM28XX_AOUT_MASTER = BIT(0),
391 EM28XX_AOUT_LINE = BIT(1),
392 EM28XX_AOUT_MONO = BIT(2),
393 EM28XX_AOUT_LFE = BIT(3),
394 EM28XX_AOUT_SURR = BIT(4),
395
396 /* PCM IN Mixer - used by AC97_RECORD_SELECT register */
397 EM28XX_AOUT_PCM_IN = BIT(7),
398
399 /* Bits 10-8 are used to indicate the PCM IN record select */
400 EM28XX_AOUT_PCM_MIC_PCM = 0 << 8,
401 EM28XX_AOUT_PCM_CD = 1 << 8,
402 EM28XX_AOUT_PCM_VIDEO = 2 << 8,
403 EM28XX_AOUT_PCM_AUX = 3 << 8,
404 EM28XX_AOUT_PCM_LINE = 4 << 8,
405 EM28XX_AOUT_PCM_STEREO = 5 << 8,
406 EM28XX_AOUT_PCM_MONO = 6 << 8,
407 EM28XX_AOUT_PCM_PHONE = 7 << 8,
408 };
409
ac97_return_record_select(int a_out)410 static inline int ac97_return_record_select(int a_out)
411 {
412 return (a_out & 0x700) >> 8;
413 }
414
415 struct em28xx_reg_seq {
416 int reg;
417 unsigned char val, mask;
418 int sleep;
419 };
420
421 struct em28xx_input {
422 enum enum28xx_itype type;
423 unsigned int vmux;
424 enum em28xx_amux amux;
425 enum em28xx_aout aout;
426 const struct em28xx_reg_seq *gpio;
427 };
428
429 #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
430
431 enum em28xx_decoder {
432 EM28XX_NODECODER = 0,
433 EM28XX_TVP5150,
434 EM28XX_SAA711X,
435 EM28XX_BUILTIN,
436 };
437
438 /* Built in decoder capture options */
439 #define EM2828X_COMPOSITE 0
440 #define EM2828X_SVIDEO 1
441 #define EM2828X_TELEVISION 2
442
443 enum em28xx_sensor {
444 EM28XX_NOSENSOR = 0,
445 EM28XX_MT9V011,
446 EM28XX_MT9M001,
447 EM28XX_MT9M111,
448 EM28XX_OV2640,
449 };
450
451 enum em28xx_adecoder {
452 EM28XX_NOADECODER = 0,
453 EM28XX_TVAUDIO,
454 };
455
456 enum em28xx_led_role {
457 EM28XX_LED_ANALOG_CAPTURING = 0,
458 EM28XX_LED_DIGITAL_CAPTURING,
459 EM28XX_LED_DIGITAL_CAPTURING_TS2,
460 EM28XX_LED_ILLUMINATION,
461 EM28XX_NUM_LED_ROLES, /* must be the last */
462 };
463
464 struct em28xx_led {
465 enum em28xx_led_role role;
466 u8 gpio_reg;
467 u8 gpio_mask;
468 bool inverted;
469 };
470
471 enum em28xx_button_role {
472 EM28XX_BUTTON_SNAPSHOT = 0,
473 EM28XX_BUTTON_ILLUMINATION,
474 EM28XX_NUM_BUTTON_ROLES, /* must be the last */
475 };
476
477 struct em28xx_button {
478 enum em28xx_button_role role;
479 u8 reg_r;
480 u8 reg_clearing;
481 u8 mask;
482 bool inverted;
483 };
484
485 enum em2828x_media_pads {
486 EM2828X_PAD_INPUT,
487 EM2828X_PAD_VID_OUT,
488 EM2828X_NUM_PADS
489 };
490
491 struct em28xx_board {
492 char *name;
493 int vchannels;
494 int tuner_type;
495 int tuner_addr;
496 unsigned int def_i2c_bus; /* Default I2C bus */
497
498 /* i2c flags */
499 unsigned int tda9887_conf;
500
501 /* GPIO sequences */
502 const struct em28xx_reg_seq *dvb_gpio;
503 const struct em28xx_reg_seq *suspend_gpio;
504 const struct em28xx_reg_seq *tuner_gpio;
505 const struct em28xx_reg_seq *mute_gpio;
506
507 unsigned int is_em2800:1;
508 unsigned int has_msp34xx:1;
509 unsigned int mts_firmware:1;
510 unsigned int max_range_640_480:1;
511 unsigned int has_dvb:1;
512 unsigned int has_dual_ts:1;
513 unsigned int is_webcam:1;
514 unsigned int valid:1;
515 unsigned int has_ir_i2c:1;
516
517 unsigned char xclk, i2c_speed;
518 unsigned char radio_addr;
519 unsigned short tvaudio_addr;
520
521 enum em28xx_decoder decoder;
522 enum em28xx_adecoder adecoder;
523
524 struct em28xx_input input[MAX_EM28XX_INPUT];
525 struct em28xx_input radio;
526 char *ir_codes;
527
528 /* LEDs that need to be controlled explicitly */
529 struct em28xx_led *leds;
530
531 /* Buttons */
532 const struct em28xx_button *buttons;
533 };
534
535 struct em28xx_eeprom {
536 u8 id[4]; /* 1a eb 67 95 */
537 __le16 vendor_ID;
538 __le16 product_ID;
539
540 __le16 chip_conf;
541
542 __le16 board_conf;
543
544 __le16 string1, string2, string3;
545
546 u8 string_idx_table;
547 };
548
549 #define EM28XX_CAPTURE_STREAM_EN 1
550
551 /* em28xx extensions */
552 #define EM28XX_AUDIO 0x10
553 #define EM28XX_DVB 0x20
554 #define EM28XX_RC 0x30
555 #define EM28XX_V4L2 0x40
556
557 /* em28xx resource types (used for res_get/res_lock etc */
558 #define EM28XX_RESOURCE_VIDEO 0x01
559 #define EM28XX_RESOURCE_VBI 0x02
560
561 struct em28xx_v4l2 {
562 struct em28xx *dev;
563
564 struct v4l2_device v4l2_dev;
565 struct v4l2_ctrl_handler ctrl_handler;
566
567 struct video_device vdev;
568 struct video_device vbi_dev;
569 struct video_device radio_dev;
570
571 /* Videobuf2 */
572 struct vb2_queue vb_vidq;
573 struct vb2_queue vb_vbiq;
574 struct mutex vb_queue_lock; /* Protects vb_vidq */
575 struct mutex vb_vbi_queue_lock; /* Protects vb_vbiq */
576
577 u8 vinmode;
578 u8 vinctl;
579
580 /* Camera specific fields */
581 int sensor_xres;
582 int sensor_yres;
583 int sensor_xtal;
584
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