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