xref: /openbmc/linux/drivers/media/usb/em28xx/em28xx.h (revision bc000245)
1 /*
2    em28xx.h - driver for Empia EM2800/EM2820/2840 USB video capture devices
3 
4    Copyright (C) 2005 Markus Rechberger <mrechberger@gmail.com>
5 		      Ludovico Cavedon <cavedon@sssup.it>
6 		      Mauro Carvalho Chehab <mchehab@infradead.org>
7    Copyright (C) 2012 Frank Schäfer <fschaefer.oss@googlemail.com>
8 
9    Based on the em2800 driver from Sascha Sommer <saschasommer@freenet.de>
10 
11    This program is free software; you can redistribute it and/or modify
12    it under the terms of the GNU General Public License as published by
13    the Free Software Foundation; either version 2 of the License, or
14    (at your option) any later version.
15 
16    This program is distributed in the hope that it will be useful,
17    but WITHOUT ANY WARRANTY; without even the implied warranty of
18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19    GNU General Public License for more details.
20 
21    You should have received a copy of the GNU General Public License
22    along with this program; if not, write to the Free Software
23    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24  */
25 
26 #ifndef _EM28XX_H
27 #define _EM28XX_H
28 
29 #include <linux/workqueue.h>
30 #include <linux/i2c.h>
31 #include <linux/mutex.h>
32 #include <linux/videodev2.h>
33 
34 #include <media/videobuf2-vmalloc.h>
35 #include <media/v4l2-device.h>
36 #include <media/v4l2-ctrls.h>
37 #include <media/v4l2-fh.h>
38 #include <media/ir-kbd-i2c.h>
39 #include <media/rc-core.h>
40 #include "tuner-xc2028.h"
41 #include "xc5000.h"
42 #include "em28xx-reg.h"
43 
44 /* Boards supported by driver */
45 #define EM2800_BOARD_UNKNOWN			  0
46 #define EM2820_BOARD_UNKNOWN			  1
47 #define EM2820_BOARD_TERRATEC_CINERGY_250	  2
48 #define EM2820_BOARD_PINNACLE_USB_2		  3
49 #define EM2820_BOARD_HAUPPAUGE_WINTV_USB_2	  4
50 #define EM2820_BOARD_MSI_VOX_USB_2		  5
51 #define EM2800_BOARD_TERRATEC_CINERGY_200	  6
52 #define EM2800_BOARD_LEADTEK_WINFAST_USBII	  7
53 #define EM2800_BOARD_KWORLD_USB2800		  8
54 #define EM2820_BOARD_PINNACLE_DVC_90		  9
55 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900	  10
56 #define EM2880_BOARD_TERRATEC_HYBRID_XS		  11
57 #define EM2820_BOARD_KWORLD_PVRTV2800RF		  12
58 #define EM2880_BOARD_TERRATEC_PRODIGY_XS	  13
59 #define EM2820_BOARD_PROLINK_PLAYTV_USB2	  14
60 #define EM2800_BOARD_VGEAR_POCKETTV		  15
61 #define EM2883_BOARD_HAUPPAUGE_WINTV_HVR_950	  16
62 #define EM2880_BOARD_PINNACLE_PCTV_HD_PRO	  17
63 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900_R2	  18
64 #define EM2860_BOARD_SAA711X_REFERENCE_DESIGN	  19
65 #define EM2880_BOARD_AMD_ATI_TV_WONDER_HD_600	  20
66 #define EM2800_BOARD_GRABBEEX_USB2800		  21
67 #define EM2750_BOARD_UNKNOWN			  22
68 #define EM2750_BOARD_DLCW_130			  23
69 #define EM2820_BOARD_DLINK_USB_TV		  24
70 #define EM2820_BOARD_GADMEI_UTV310		  25
71 #define EM2820_BOARD_HERCULES_SMART_TV_USB2	  26
72 #define EM2820_BOARD_PINNACLE_USB_2_FM1216ME	  27
73 #define EM2820_BOARD_LEADTEK_WINFAST_USBII_DELUXE 28
74 #define EM2860_BOARD_TVP5150_REFERENCE_DESIGN	  29
75 #define EM2820_BOARD_VIDEOLOGY_20K14XUSB	  30
76 #define EM2821_BOARD_USBGEAR_VD204		  31
77 #define EM2821_BOARD_SUPERCOMP_USB_2		  32
78 #define EM2860_BOARD_ELGATO_VIDEO_CAPTURE	  33
79 #define EM2860_BOARD_TERRATEC_HYBRID_XS		  34
80 #define EM2860_BOARD_TYPHOON_DVD_MAKER		  35
81 #define EM2860_BOARD_NETGMBH_CAM		  36
82 #define EM2860_BOARD_GADMEI_UTV330		  37
83 #define EM2861_BOARD_YAKUMO_MOVIE_MIXER		  38
84 #define EM2861_BOARD_KWORLD_PVRTV_300U		  39
85 #define EM2861_BOARD_PLEXTOR_PX_TV100U		  40
86 #define EM2870_BOARD_KWORLD_350U		  41
87 #define EM2870_BOARD_KWORLD_355U		  42
88 #define EM2870_BOARD_TERRATEC_XS		  43
89 #define EM2870_BOARD_TERRATEC_XS_MT2060		  44
90 #define EM2870_BOARD_PINNACLE_PCTV_DVB		  45
91 #define EM2870_BOARD_COMPRO_VIDEOMATE		  46
92 #define EM2880_BOARD_KWORLD_DVB_305U		  47
93 #define EM2880_BOARD_KWORLD_DVB_310U		  48
94 #define EM2880_BOARD_MSI_DIGIVOX_AD		  49
95 #define EM2880_BOARD_MSI_DIGIVOX_AD_II		  50
96 #define EM2880_BOARD_TERRATEC_HYBRID_XS_FR	  51
97 #define EM2881_BOARD_DNT_DA2_HYBRID		  52
98 #define EM2881_BOARD_PINNACLE_HYBRID_PRO	  53
99 #define EM2882_BOARD_KWORLD_VS_DVBT		  54
100 #define EM2882_BOARD_TERRATEC_HYBRID_XS		  55
101 #define EM2882_BOARD_PINNACLE_HYBRID_PRO_330E	  56
102 #define EM2883_BOARD_KWORLD_HYBRID_330U		  57
103 #define EM2820_BOARD_COMPRO_VIDEOMATE_FORYOU	  58
104 #define EM2883_BOARD_HAUPPAUGE_WINTV_HVR_850	  60
105 #define EM2820_BOARD_PROLINK_PLAYTV_BOX4_USB2	  61
106 #define EM2820_BOARD_GADMEI_TVR200		  62
107 #define EM2860_BOARD_KAIOMY_TVNPC_U2		  63
108 #define EM2860_BOARD_EASYCAP			  64
109 #define EM2820_BOARD_IODATA_GVMVP_SZ		  65
110 #define EM2880_BOARD_EMPIRE_DUAL_TV		  66
111 #define EM2860_BOARD_TERRATEC_GRABBY		  67
112 #define EM2860_BOARD_TERRATEC_AV350		  68
113 #define EM2882_BOARD_KWORLD_ATSC_315U		  69
114 #define EM2882_BOARD_EVGA_INDTUBE		  70
115 #define EM2820_BOARD_SILVERCREST_WEBCAM		  71
116 #define EM2861_BOARD_GADMEI_UTV330PLUS		  72
117 #define EM2870_BOARD_REDDO_DVB_C_USB_BOX	  73
118 #define EM2800_BOARD_VC211A			  74
119 #define EM2882_BOARD_DIKOM_DK300		  75
120 #define EM2870_BOARD_KWORLD_A340		  76
121 #define EM2874_BOARD_LEADERSHIP_ISDBT		  77
122 #define EM28174_BOARD_PCTV_290E			  78
123 #define EM2884_BOARD_TERRATEC_H5		  79
124 #define EM28174_BOARD_PCTV_460E			  80
125 #define EM2884_BOARD_HAUPPAUGE_WINTV_HVR_930C	  81
126 #define EM2884_BOARD_CINERGY_HTC_STICK		  82
127 #define EM2860_BOARD_HT_VIDBOX_NW03		  83
128 #define EM2874_BOARD_MAXMEDIA_UB425_TC		  84
129 #define EM2884_BOARD_PCTV_510E			  85
130 #define EM2884_BOARD_PCTV_520E			  86
131 #define EM2884_BOARD_TERRATEC_HTC_USB_XS	  87
132 #define EM2884_BOARD_C3TECH_DIGITAL_DUO		  88
133 #define EM2874_BOARD_DELOCK_61959		  89
134 #define EM2874_BOARD_KWORLD_UB435Q_V2		  90
135 
136 /* Limits minimum and default number of buffers */
137 #define EM28XX_MIN_BUF 4
138 #define EM28XX_DEF_BUF 8
139 
140 /*Limits the max URB message size */
141 #define URB_MAX_CTRL_SIZE 80
142 
143 /* Params for validated field */
144 #define EM28XX_BOARD_NOT_VALIDATED 1
145 #define EM28XX_BOARD_VALIDATED	   0
146 
147 /* Params for em28xx_cmd() audio */
148 #define EM28XX_START_AUDIO      1
149 #define EM28XX_STOP_AUDIO       0
150 
151 /* maximum number of em28xx boards */
152 #define EM28XX_MAXBOARDS 4 /*FIXME: should be bigger */
153 
154 /* maximum number of frames that can be queued */
155 #define EM28XX_NUM_FRAMES 5
156 /* number of frames that get used for v4l2_read() */
157 #define EM28XX_NUM_READ_FRAMES 2
158 
159 /* number of buffers for isoc transfers */
160 #define EM28XX_NUM_BUFS 5
161 #define EM28XX_DVB_NUM_BUFS 5
162 
163 /* max number of I2C buses on em28xx devices */
164 #define NUM_I2C_BUSES	2
165 
166 /* isoc transfers: number of packets for each buffer
167    windows requests only 64 packets .. so we better do the same
168    this is what I found out for all alternate numbers there!
169  */
170 #define EM28XX_NUM_ISOC_PACKETS 64
171 #define EM28XX_DVB_NUM_ISOC_PACKETS 64
172 
173 /* bulk transfers: transfer buffer size = packet size * packet multiplier
174    USB 2.0 spec says bulk packet size is always 512 bytes
175  */
176 #define EM28XX_BULK_PACKET_MULTIPLIER 384
177 #define EM28XX_DVB_BULK_PACKET_MULTIPLIER 384
178 
179 #define EM28XX_INTERLACED_DEFAULT 1
180 
181 /* time in msecs to wait for i2c writes to finish */
182 #define EM2800_I2C_XFER_TIMEOUT		20
183 
184 enum em28xx_mode {
185 	EM28XX_SUSPEND,
186 	EM28XX_ANALOG_MODE,
187 	EM28XX_DIGITAL_MODE,
188 };
189 
190 
191 struct em28xx;
192 
193 struct em28xx_usb_bufs {
194 		/* max packet size of isoc transaction */
195 	int				max_pkt_size;
196 
197 		/* number of packets in each buffer */
198 	int				num_packets;
199 
200 		/* number of allocated urbs */
201 	int				num_bufs;
202 
203 		/* urb for isoc/bulk transfers */
204 	struct urb			**urb;
205 
206 		/* transfer buffers for isoc/bulk transfer */
207 	char				**transfer_buffer;
208 };
209 
210 struct em28xx_usb_ctl {
211 		/* isoc/bulk transfer buffers for analog mode */
212 	struct em28xx_usb_bufs		analog_bufs;
213 
214 		/* isoc/bulk transfer buffers for digital mode */
215 	struct em28xx_usb_bufs		digital_bufs;
216 
217 		/* Stores already requested buffers */
218 	struct em28xx_buffer    	*vid_buf;
219 	struct em28xx_buffer    	*vbi_buf;
220 
221 		/* copy data from URB */
222 	int (*urb_data_copy) (struct em28xx *dev, struct urb *urb);
223 
224 };
225 
226 /* Struct to enumberate video formats */
227 struct em28xx_fmt {
228 	char  *name;
229 	u32   fourcc;          /* v4l2 format id */
230 	int   depth;
231 	int   reg;
232 };
233 
234 /* buffer for one video frame */
235 struct em28xx_buffer {
236 	/* common v4l buffer stuff -- must be first */
237 	struct vb2_buffer vb;
238 	struct list_head list;
239 
240 	void *mem;
241 	unsigned int length;
242 	int top_field;
243 
244 	/* counter to control buffer fill */
245 	unsigned int pos;
246 	/* NOTE; in interlaced mode, this value is reset to zero at
247 	 * the start of each new field (not frame !)		   */
248 
249 	/* pointer to vmalloc memory address in vb */
250 	char *vb_buf;
251 };
252 
253 struct em28xx_dmaqueue {
254 	struct list_head       active;
255 
256 	wait_queue_head_t          wq;
257 };
258 
259 /* inputs */
260 
261 #define MAX_EM28XX_INPUT 4
262 enum enum28xx_itype {
263 	EM28XX_VMUX_COMPOSITE1 = 1,
264 	EM28XX_VMUX_COMPOSITE2,
265 	EM28XX_VMUX_COMPOSITE3,
266 	EM28XX_VMUX_COMPOSITE4,
267 	EM28XX_VMUX_SVIDEO,
268 	EM28XX_VMUX_TELEVISION,
269 	EM28XX_VMUX_CABLE,
270 	EM28XX_VMUX_DVB,
271 	EM28XX_VMUX_DEBUG,
272 	EM28XX_RADIO,
273 };
274 
275 enum em28xx_ac97_mode {
276 	EM28XX_NO_AC97 = 0,
277 	EM28XX_AC97_EM202,
278 	EM28XX_AC97_SIGMATEL,
279 	EM28XX_AC97_OTHER,
280 };
281 
282 struct em28xx_audio_mode {
283 	enum em28xx_ac97_mode ac97;
284 
285 	u16 ac97_feat;
286 	u32 ac97_vendor_id;
287 
288 	unsigned int has_audio:1;
289 
290 	unsigned int i2s_3rates:1;
291 	unsigned int i2s_5rates:1;
292 };
293 
294 /* em28xx has two audio inputs: tuner and line in.
295    However, on most devices, an auxiliary AC97 codec device is used.
296    The AC97 device may have several different inputs and outputs,
297    depending on their model. So, it is possible to use AC97 mixer to
298    address more than two different entries.
299  */
300 enum em28xx_amux {
301 	/* This is the only entry for em28xx tuner input */
302 	EM28XX_AMUX_VIDEO,	/* em28xx tuner, AC97 mixer Video */
303 
304 	EM28XX_AMUX_LINE_IN,	/* AC97 mixer Line In */
305 
306 	/* Some less-common mixer setups */
307 	EM28XX_AMUX_VIDEO2,	/* em28xx Line in, AC97 mixer Video */
308 	EM28XX_AMUX_PHONE,
309 	EM28XX_AMUX_MIC,
310 	EM28XX_AMUX_CD,
311 	EM28XX_AMUX_AUX,
312 	EM28XX_AMUX_PCM_OUT,
313 };
314 
315 enum em28xx_aout {
316 	/* AC97 outputs */
317 	EM28XX_AOUT_MASTER = 1 << 0,
318 	EM28XX_AOUT_LINE   = 1 << 1,
319 	EM28XX_AOUT_MONO   = 1 << 2,
320 	EM28XX_AOUT_LFE    = 1 << 3,
321 	EM28XX_AOUT_SURR   = 1 << 4,
322 
323 	/* PCM IN Mixer - used by AC97_RECORD_SELECT register */
324 	EM28XX_AOUT_PCM_IN = 1 << 7,
325 
326 	/* Bits 10-8 are used to indicate the PCM IN record select */
327 	EM28XX_AOUT_PCM_MIC_PCM = 0 << 8,
328 	EM28XX_AOUT_PCM_CD	= 1 << 8,
329 	EM28XX_AOUT_PCM_VIDEO	= 2 << 8,
330 	EM28XX_AOUT_PCM_AUX	= 3 << 8,
331 	EM28XX_AOUT_PCM_LINE	= 4 << 8,
332 	EM28XX_AOUT_PCM_STEREO	= 5 << 8,
333 	EM28XX_AOUT_PCM_MONO	= 6 << 8,
334 	EM28XX_AOUT_PCM_PHONE	= 7 << 8,
335 };
336 
337 static inline int ac97_return_record_select(int a_out)
338 {
339 	return (a_out & 0x700) >> 8;
340 }
341 
342 struct em28xx_reg_seq {
343 	int reg;
344 	unsigned char val, mask;
345 	int sleep;
346 };
347 
348 struct em28xx_input {
349 	enum enum28xx_itype type;
350 	unsigned int vmux;
351 	enum em28xx_amux amux;
352 	enum em28xx_aout aout;
353 	struct em28xx_reg_seq *gpio;
354 };
355 
356 #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
357 
358 enum em28xx_decoder {
359 	EM28XX_NODECODER = 0,
360 	EM28XX_TVP5150,
361 	EM28XX_SAA711X,
362 };
363 
364 enum em28xx_sensor {
365 	EM28XX_NOSENSOR = 0,
366 	EM28XX_MT9V011,
367 	EM28XX_MT9M001,
368 	EM28XX_MT9M111,
369 	EM28XX_OV2640,
370 };
371 
372 enum em28xx_adecoder {
373 	EM28XX_NOADECODER = 0,
374 	EM28XX_TVAUDIO,
375 };
376 
377 struct em28xx_board {
378 	char *name;
379 	int vchannels;
380 	int tuner_type;
381 	int tuner_addr;
382 	unsigned def_i2c_bus;	/* Default I2C bus */
383 
384 	/* i2c flags */
385 	unsigned int tda9887_conf;
386 
387 	/* GPIO sequences */
388 	struct em28xx_reg_seq *dvb_gpio;
389 	struct em28xx_reg_seq *suspend_gpio;
390 	struct em28xx_reg_seq *tuner_gpio;
391 	struct em28xx_reg_seq *mute_gpio;
392 
393 	unsigned int is_em2800:1;
394 	unsigned int has_msp34xx:1;
395 	unsigned int mts_firmware:1;
396 	unsigned int max_range_640_480:1;
397 	unsigned int has_dvb:1;
398 	unsigned int has_snapshot_button:1;
399 	unsigned int is_webcam:1;
400 	unsigned int valid:1;
401 	unsigned int has_ir_i2c:1;
402 
403 	unsigned char xclk, i2c_speed;
404 	unsigned char radio_addr;
405 	unsigned short tvaudio_addr;
406 
407 	enum em28xx_decoder decoder;
408 	enum em28xx_adecoder adecoder;
409 
410 	struct em28xx_input       input[MAX_EM28XX_INPUT];
411 	struct em28xx_input	  radio;
412 	char			  *ir_codes;
413 };
414 
415 struct em28xx_eeprom {
416 	u8 id[4];			/* 1a eb 67 95 */
417 	__le16 vendor_ID;
418 	__le16 product_ID;
419 
420 	__le16 chip_conf;
421 
422 	__le16 board_conf;
423 
424 	__le16 string1, string2, string3;
425 
426 	u8 string_idx_table;
427 };
428 
429 #define EM28XX_AUDIO_BUFS 5
430 #define EM28XX_NUM_AUDIO_PACKETS 64
431 #define EM28XX_AUDIO_MAX_PACKET_SIZE 196 /* static value */
432 #define EM28XX_CAPTURE_STREAM_EN 1
433 
434 /* em28xx extensions */
435 #define EM28XX_AUDIO   0x10
436 #define EM28XX_DVB     0x20
437 #define EM28XX_RC      0x30
438 
439 /* em28xx resource types (used for res_get/res_lock etc */
440 #define EM28XX_RESOURCE_VIDEO 0x01
441 #define EM28XX_RESOURCE_VBI   0x02
442 
443 struct em28xx_audio {
444 	char name[50];
445 	char *transfer_buffer[EM28XX_AUDIO_BUFS];
446 	struct urb *urb[EM28XX_AUDIO_BUFS];
447 	struct usb_device *udev;
448 	unsigned int capture_transfer_done;
449 	struct snd_pcm_substream   *capture_pcm_substream;
450 
451 	unsigned int hwptr_done_capture;
452 	struct snd_card            *sndcard;
453 
454 	int users;
455 	spinlock_t slock;
456 };
457 
458 struct em28xx;
459 
460 struct em28xx_fh {
461 	struct v4l2_fh fh;
462 	struct em28xx *dev;
463 
464 	enum v4l2_buf_type           type;
465 };
466 
467 enum em28xx_i2c_algo_type {
468 	EM28XX_I2C_ALGO_EM28XX = 0,
469 	EM28XX_I2C_ALGO_EM2800,
470 	EM28XX_I2C_ALGO_EM25XX_BUS_B,
471 };
472 
473 struct em28xx_i2c_bus {
474 	struct em28xx *dev;
475 
476 	unsigned bus;
477 	enum em28xx_i2c_algo_type algo_type;
478 };
479 
480 
481 /* main device struct */
482 struct em28xx {
483 	/* generic device properties */
484 	char name[30];		/* name (including minor) of the device */
485 	int model;		/* index in the device_data struct */
486 	int devno;		/* marks the number of this device */
487 	enum em28xx_chip_id chip_id;
488 	unsigned int is_em25xx:1;	/* em25xx/em276x/7x/8x family bridge */
489 
490 	unsigned char disconnected:1;	/* device has been diconnected */
491 
492 	int audio_ifnum;
493 
494 	struct v4l2_device v4l2_dev;
495 	struct v4l2_ctrl_handler ctrl_handler;
496 	struct v4l2_clk *clk;
497 	struct em28xx_board board;
498 
499 	/* Webcam specific fields */
500 	enum em28xx_sensor em28xx_sensor;
501 	int sensor_xres, sensor_yres;
502 	int sensor_xtal;
503 
504 	/* Progressive (non-interlaced) mode */
505 	int progressive;
506 
507 	/* Vinmode/Vinctl used at the driver */
508 	int vinmode, vinctl;
509 
510 	unsigned int has_audio_class:1;
511 	unsigned int has_alsa_audio:1;
512 	unsigned int is_audio_only:1;
513 
514 	/* Controls audio streaming */
515 	struct work_struct wq_trigger;	/* Trigger to start/stop audio for alsa module */
516 	atomic_t       stream_started;	/* stream should be running if true */
517 
518 	struct em28xx_fmt *format;
519 
520 	struct em28xx_IR *ir;
521 
522 	/* Some older em28xx chips needs a waiting time after writing */
523 	unsigned int wait_after_write;
524 
525 	struct list_head	devlist;
526 
527 	u32 i2s_speed;		/* I2S speed for audio digital stream */
528 
529 	struct em28xx_audio_mode audio_mode;
530 
531 	int tuner_type;		/* type of the tuner */
532 	int tuner_addr;		/* tuner address */
533 	int tda9887_conf;
534 
535 	/* i2c i/o */
536 	struct i2c_adapter i2c_adap[NUM_I2C_BUSES];
537 	struct i2c_client i2c_client[NUM_I2C_BUSES];
538 	struct em28xx_i2c_bus i2c_bus[NUM_I2C_BUSES];
539 
540 	unsigned char eeprom_addrwidth_16bit:1;
541 	unsigned def_i2c_bus;	/* Default I2C bus */
542 	unsigned cur_i2c_bus;	/* Current I2C bus */
543 	struct rt_mutex i2c_bus_lock;
544 
545 	/* video for linux */
546 	int users;		/* user count for exclusive use */
547 	int streaming_users;    /* Number of actively streaming users */
548 	struct video_device *vdev;	/* video for linux device struct */
549 	v4l2_std_id norm;	/* selected tv norm */
550 	int ctl_freq;		/* selected frequency */
551 	unsigned int ctl_input;	/* selected input */
552 	unsigned int ctl_ainput;/* selected audio input */
553 	unsigned int ctl_aoutput;/* selected audio output */
554 	int mute;
555 	int volume;
556 	/* frame properties */
557 	int width;		/* current frame width */
558 	int height;		/* current frame height */
559 	unsigned hscale;	/* horizontal scale factor (see datasheet) */
560 	unsigned vscale;	/* vertical scale factor (see datasheet) */
561 	int interlaced;		/* 1=interlace fileds, 0=just top fileds */
562 	unsigned int video_bytesread;	/* Number of bytes read */
563 
564 	unsigned long hash;	/* eeprom hash - for boards with generic ID */
565 	unsigned long i2c_hash;	/* i2c devicelist hash -
566 				   for boards with generic ID */
567 
568 	struct em28xx_audio adev;
569 
570 	/* capture state tracking */
571 	int capture_type;
572 	unsigned char top_field:1;
573 	int vbi_read;
574 	unsigned int vbi_width;
575 	unsigned int vbi_height; /* lines per field */
576 
577 	struct work_struct         request_module_wk;
578 
579 	/* locks */
580 	struct mutex lock;
581 	struct mutex ctrl_urb_lock;	/* protects urb_buf */
582 	/* spinlock_t queue_lock; */
583 	struct list_head inqueue, outqueue;
584 	struct video_device *vbi_dev;
585 	struct video_device *radio_dev;
586 
587 	/* Videobuf2 */
588 	struct vb2_queue vb_vidq;
589 	struct vb2_queue vb_vbiq;
590 	struct mutex vb_queue_lock;
591 	struct mutex vb_vbi_queue_lock;
592 
593 	/* resources in use */
594 	unsigned int resources;
595 
596 	/* eeprom content */
597 	u8 *eedata;
598 	u16 eedata_len;
599 
600 	/* Isoc control struct */
601 	struct em28xx_dmaqueue vidq;
602 	struct em28xx_dmaqueue vbiq;
603 	struct em28xx_usb_ctl usb_ctl;
604 	spinlock_t slock;
605 
606 	unsigned int field_count;
607 	unsigned int vbi_field_count;
608 
609 	/* usb transfer */
610 	struct usb_device *udev;	/* the usb device */
611 	u8 analog_ep_isoc;	/* address of isoc endpoint for analog */
612 	u8 analog_ep_bulk;	/* address of bulk endpoint for analog */
613 	u8 dvb_ep_isoc;		/* address of isoc endpoint for DVB */
614 	u8 dvb_ep_bulk;		/* address of bulk endpoint for DVB */
615 	int alt;		/* alternate setting */
616 	int max_pkt_size;	/* max packet size of the selected ep at alt */
617 	int packet_multiplier;	/* multiplier for wMaxPacketSize, used for
618 				   URB buffer size definition */
619 	int num_alt;		/* number of alternative settings */
620 	unsigned int *alt_max_pkt_size_isoc; /* array of isoc wMaxPacketSize */
621 	unsigned int analog_xfer_bulk:1;	/* use bulk instead of isoc
622 						   transfers for analog      */
623 	int dvb_alt_isoc;	/* alternate setting for DVB isoc transfers */
624 	unsigned int dvb_max_pkt_size_isoc;	/* isoc max packet size of the
625 						   selected DVB ep at dvb_alt */
626 	unsigned int dvb_xfer_bulk:1;		/* use bulk instead of isoc
627 						   transfers for DVB          */
628 	char urb_buf[URB_MAX_CTRL_SIZE];	/* urb control msg buffer */
629 
630 	/* helper funcs that call usb_control_msg */
631 	int (*em28xx_write_regs) (struct em28xx *dev, u16 reg,
632 					char *buf, int len);
633 	int (*em28xx_read_reg) (struct em28xx *dev, u16 reg);
634 	int (*em28xx_read_reg_req_len) (struct em28xx *dev, u8 req, u16 reg,
635 					char *buf, int len);
636 	int (*em28xx_write_regs_req) (struct em28xx *dev, u8 req, u16 reg,
637 				      char *buf, int len);
638 	int (*em28xx_read_reg_req) (struct em28xx *dev, u8 req, u16 reg);
639 
640 	enum em28xx_mode mode;
641 
642 	/* Snapshot button */
643 	char snapshot_button_path[30];	/* path of the input dev */
644 	struct input_dev *sbutton_input_dev;
645 	struct delayed_work sbutton_query_work;
646 
647 	struct em28xx_dvb *dvb;
648 };
649 
650 struct em28xx_ops {
651 	struct list_head next;
652 	char *name;
653 	int id;
654 	int (*init)(struct em28xx *);
655 	int (*fini)(struct em28xx *);
656 };
657 
658 /* Provided by em28xx-i2c.c */
659 void em28xx_do_i2c_scan(struct em28xx *dev, unsigned bus);
660 int  em28xx_i2c_register(struct em28xx *dev, unsigned bus,
661 			 enum em28xx_i2c_algo_type algo_type);
662 int  em28xx_i2c_unregister(struct em28xx *dev, unsigned bus);
663 
664 /* Provided by em28xx-core.c */
665 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
666 			    char *buf, int len);
667 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
668 int em28xx_read_reg(struct em28xx *dev, u16 reg);
669 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
670 			  int len);
671 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
672 int em28xx_write_reg(struct em28xx *dev, u16 reg, u8 val);
673 int em28xx_write_reg_bits(struct em28xx *dev, u16 reg, u8 val,
674 				 u8 bitmask);
675 
676 int em28xx_read_ac97(struct em28xx *dev, u8 reg);
677 int em28xx_write_ac97(struct em28xx *dev, u8 reg, u16 val);
678 
679 int em28xx_audio_analog_set(struct em28xx *dev);
680 int em28xx_audio_setup(struct em28xx *dev);
681 
682 int em28xx_colorlevels_set_default(struct em28xx *dev);
683 int em28xx_capture_start(struct em28xx *dev, int start);
684 int em28xx_vbi_supported(struct em28xx *dev);
685 int em28xx_set_outfmt(struct em28xx *dev);
686 int em28xx_resolution_set(struct em28xx *dev);
687 int em28xx_set_alternate(struct em28xx *dev);
688 int em28xx_alloc_urbs(struct em28xx *dev, enum em28xx_mode mode, int xfer_bulk,
689 		      int num_bufs, int max_pkt_size, int packet_multiplier);
690 int em28xx_init_usb_xfer(struct em28xx *dev, enum em28xx_mode mode,
691 			 int xfer_bulk,
692 			 int num_bufs, int max_pkt_size, int packet_multiplier,
693 			 int (*urb_data_copy)
694 					(struct em28xx *dev, struct urb *urb));
695 void em28xx_uninit_usb_xfer(struct em28xx *dev, enum em28xx_mode mode);
696 void em28xx_stop_urbs(struct em28xx *dev);
697 int em28xx_set_mode(struct em28xx *dev, enum em28xx_mode set_mode);
698 int em28xx_gpio_set(struct em28xx *dev, struct em28xx_reg_seq *gpio);
699 void em28xx_wake_i2c(struct em28xx *dev);
700 int em28xx_register_extension(struct em28xx_ops *dev);
701 void em28xx_unregister_extension(struct em28xx_ops *dev);
702 void em28xx_init_extension(struct em28xx *dev);
703 void em28xx_close_extension(struct em28xx *dev);
704 
705 /* Provided by em28xx-video.c */
706 int em28xx_vb2_setup(struct em28xx *dev);
707 int em28xx_register_analog_devices(struct em28xx *dev);
708 void em28xx_release_analog_resources(struct em28xx *dev);
709 void em28xx_ctrl_notify(struct v4l2_ctrl *ctrl, void *priv);
710 int em28xx_start_analog_streaming(struct vb2_queue *vq, unsigned int count);
711 int em28xx_stop_vbi_streaming(struct vb2_queue *vq);
712 extern const struct v4l2_ctrl_ops em28xx_ctrl_ops;
713 
714 /* Provided by em28xx-cards.c */
715 extern struct em28xx_board em28xx_boards[];
716 extern struct usb_device_id em28xx_id_table[];
717 int em28xx_tuner_callback(void *ptr, int component, int command, int arg);
718 void em28xx_release_resources(struct em28xx *dev);
719 
720 /* Provided by em28xx-vbi.c */
721 extern struct vb2_ops em28xx_vbi_qops;
722 
723 /* Provided by em28xx-camera.c */
724 int em28xx_detect_sensor(struct em28xx *dev);
725 int em28xx_init_camera(struct em28xx *dev);
726 
727 /* printk macros */
728 
729 #define em28xx_err(fmt, arg...) do {\
730 	printk(KERN_ERR fmt , ##arg); } while (0)
731 
732 #define em28xx_errdev(fmt, arg...) do {\
733 	printk(KERN_ERR "%s: "fmt,\
734 			dev->name , ##arg); } while (0)
735 
736 #define em28xx_info(fmt, arg...) do {\
737 	printk(KERN_INFO "%s: "fmt,\
738 			dev->name , ##arg); } while (0)
739 #define em28xx_warn(fmt, arg...) do {\
740 	printk(KERN_WARNING "%s: "fmt,\
741 			dev->name , ##arg); } while (0)
742 
743 static inline int em28xx_compression_disable(struct em28xx *dev)
744 {
745 	/* side effect of disabling scaler and mixer */
746 	return em28xx_write_reg(dev, EM28XX_R26_COMPR, 0x00);
747 }
748 
749 /*FIXME: maxw should be dependent of alt mode */
750 static inline unsigned int norm_maxw(struct em28xx *dev)
751 {
752 	if (dev->board.is_webcam)
753 		return dev->sensor_xres;
754 
755 	if (dev->board.max_range_640_480)
756 		return 640;
757 
758 	return 720;
759 }
760 
761 static inline unsigned int norm_maxh(struct em28xx *dev)
762 {
763 	if (dev->board.is_webcam)
764 		return dev->sensor_yres;
765 
766 	if (dev->board.max_range_640_480)
767 		return 480;
768 
769 	return (dev->norm & V4L2_STD_625_50) ? 576 : 480;
770 }
771 #endif
772