xref: /openbmc/linux/drivers/media/usb/em28xx/em28xx.h (revision d0b73b48)
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 
8    Based on the em2800 driver from Sascha Sommer <saschasommer@freenet.de>
9 
10    This program is free software; you can redistribute it and/or modify
11    it under the terms of the GNU General Public License as published by
12    the Free Software Foundation; either version 2 of the License, or
13    (at your option) any later version.
14 
15    This program is distributed in the hope that it will be useful,
16    but WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18    GNU General Public License for more details.
19 
20    You should have received a copy of the GNU General Public License
21    along with this program; if not, write to the Free Software
22    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23  */
24 
25 #ifndef _EM28XX_H
26 #define _EM28XX_H
27 
28 #include <linux/workqueue.h>
29 #include <linux/i2c.h>
30 #include <linux/mutex.h>
31 #include <linux/videodev2.h>
32 
33 #include <media/videobuf-vmalloc.h>
34 #include <media/v4l2-device.h>
35 #include <media/ir-kbd-i2c.h>
36 #include <media/rc-core.h>
37 #if defined(CONFIG_VIDEO_EM28XX_DVB) || defined(CONFIG_VIDEO_EM28XX_DVB_MODULE)
38 #include <media/videobuf-dvb.h>
39 #endif
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 
133 /* Limits minimum and default number of buffers */
134 #define EM28XX_MIN_BUF 4
135 #define EM28XX_DEF_BUF 8
136 
137 /*Limits the max URB message size */
138 #define URB_MAX_CTRL_SIZE 80
139 
140 /* Params for validated field */
141 #define EM28XX_BOARD_NOT_VALIDATED 1
142 #define EM28XX_BOARD_VALIDATED	   0
143 
144 /* Params for em28xx_cmd() audio */
145 #define EM28XX_START_AUDIO      1
146 #define EM28XX_STOP_AUDIO       0
147 
148 /* maximum number of em28xx boards */
149 #define EM28XX_MAXBOARDS 4 /*FIXME: should be bigger */
150 
151 /* maximum number of frames that can be queued */
152 #define EM28XX_NUM_FRAMES 5
153 /* number of frames that get used for v4l2_read() */
154 #define EM28XX_NUM_READ_FRAMES 2
155 
156 /* number of buffers for isoc transfers */
157 #define EM28XX_NUM_BUFS 5
158 #define EM28XX_DVB_NUM_BUFS 5
159 
160 /* number of packets for each buffer
161    windows requests only 64 packets .. so we better do the same
162    this is what I found out for all alternate numbers there!
163  */
164 #define EM28XX_NUM_PACKETS 64
165 #define EM28XX_DVB_MAX_PACKETS 64
166 
167 #define EM28XX_INTERLACED_DEFAULT 1
168 
169 /*
170 #define (use usbview if you want to get the other alternate number infos)
171 #define
172 #define alternate number 2
173 #define 			Endpoint Address: 82
174 			Direction: in
175 			Attribute: 1
176 			Type: Isoc
177 			Max Packet Size: 1448
178 			Interval: 125us
179 
180   alternate number 7
181 
182 			Endpoint Address: 82
183 			Direction: in
184 			Attribute: 1
185 			Type: Isoc
186 			Max Packet Size: 3072
187 			Interval: 125us
188 */
189 
190 /* time to wait when stopping the isoc transfer */
191 #define EM28XX_URB_TIMEOUT \
192 			msecs_to_jiffies(EM28XX_NUM_BUFS * EM28XX_NUM_PACKETS)
193 
194 /* time in msecs to wait for i2c writes to finish */
195 #define EM2800_I2C_WRITE_TIMEOUT 20
196 
197 enum em28xx_mode {
198 	EM28XX_SUSPEND,
199 	EM28XX_ANALOG_MODE,
200 	EM28XX_DIGITAL_MODE,
201 };
202 
203 
204 struct em28xx;
205 
206 struct em28xx_usb_isoc_bufs {
207 		/* max packet size of isoc transaction */
208 	int				max_pkt_size;
209 
210 		/* number of packets in each buffer */
211 	int				num_packets;
212 
213 		/* number of allocated urbs */
214 	int				num_bufs;
215 
216 		/* urb for isoc transfers */
217 	struct urb			**urb;
218 
219 		/* transfer buffers for isoc transfer */
220 	char				**transfer_buffer;
221 };
222 
223 struct em28xx_usb_isoc_ctl {
224 		/* isoc transfer buffers for analog mode */
225 	struct em28xx_usb_isoc_bufs	analog_bufs;
226 
227 		/* isoc transfer buffers for digital mode */
228 	struct em28xx_usb_isoc_bufs	digital_bufs;
229 
230 		/* Stores already requested buffers */
231 	struct em28xx_buffer    	*vid_buf;
232 	struct em28xx_buffer    	*vbi_buf;
233 
234 		/* isoc urb callback */
235 	int (*isoc_copy) (struct em28xx *dev, struct urb *urb);
236 
237 };
238 
239 /* Struct to enumberate video formats */
240 struct em28xx_fmt {
241 	char  *name;
242 	u32   fourcc;          /* v4l2 format id */
243 	int   depth;
244 	int   reg;
245 };
246 
247 /* buffer for one video frame */
248 struct em28xx_buffer {
249 	/* common v4l buffer stuff -- must be first */
250 	struct videobuf_buffer vb;
251 
252 	struct list_head frame;
253 	int top_field;
254 };
255 
256 struct em28xx_dmaqueue {
257 	struct list_head       active;
258 
259 	wait_queue_head_t          wq;
260 
261 	/* Counters to control buffer fill */
262 	int                        pos;
263 };
264 
265 /* inputs */
266 
267 #define MAX_EM28XX_INPUT 4
268 enum enum28xx_itype {
269 	EM28XX_VMUX_COMPOSITE1 = 1,
270 	EM28XX_VMUX_COMPOSITE2,
271 	EM28XX_VMUX_COMPOSITE3,
272 	EM28XX_VMUX_COMPOSITE4,
273 	EM28XX_VMUX_SVIDEO,
274 	EM28XX_VMUX_TELEVISION,
275 	EM28XX_VMUX_CABLE,
276 	EM28XX_VMUX_DVB,
277 	EM28XX_VMUX_DEBUG,
278 	EM28XX_RADIO,
279 };
280 
281 enum em28xx_ac97_mode {
282 	EM28XX_NO_AC97 = 0,
283 	EM28XX_AC97_EM202,
284 	EM28XX_AC97_SIGMATEL,
285 	EM28XX_AC97_OTHER,
286 };
287 
288 struct em28xx_audio_mode {
289 	enum em28xx_ac97_mode ac97;
290 
291 	u16 ac97_feat;
292 	u32 ac97_vendor_id;
293 
294 	unsigned int has_audio:1;
295 
296 	unsigned int i2s_3rates:1;
297 	unsigned int i2s_5rates:1;
298 };
299 
300 /* em28xx has two audio inputs: tuner and line in.
301    However, on most devices, an auxiliary AC97 codec device is used.
302    The AC97 device may have several different inputs and outputs,
303    depending on their model. So, it is possible to use AC97 mixer to
304    address more than two different entries.
305  */
306 enum em28xx_amux {
307 	/* This is the only entry for em28xx tuner input */
308 	EM28XX_AMUX_VIDEO,	/* em28xx tuner, AC97 mixer Video */
309 
310 	EM28XX_AMUX_LINE_IN,	/* AC97 mixer Line In */
311 
312 	/* Some less-common mixer setups */
313 	EM28XX_AMUX_VIDEO2,	/* em28xx Line in, AC97 mixer Video */
314 	EM28XX_AMUX_PHONE,
315 	EM28XX_AMUX_MIC,
316 	EM28XX_AMUX_CD,
317 	EM28XX_AMUX_AUX,
318 	EM28XX_AMUX_PCM_OUT,
319 };
320 
321 enum em28xx_aout {
322 	/* AC97 outputs */
323 	EM28XX_AOUT_MASTER = 1 << 0,
324 	EM28XX_AOUT_LINE   = 1 << 1,
325 	EM28XX_AOUT_MONO   = 1 << 2,
326 	EM28XX_AOUT_LFE    = 1 << 3,
327 	EM28XX_AOUT_SURR   = 1 << 4,
328 
329 	/* PCM IN Mixer - used by AC97_RECORD_SELECT register */
330 	EM28XX_AOUT_PCM_IN = 1 << 7,
331 
332 	/* Bits 10-8 are used to indicate the PCM IN record select */
333 	EM28XX_AOUT_PCM_MIC_PCM = 0 << 8,
334 	EM28XX_AOUT_PCM_CD	= 1 << 8,
335 	EM28XX_AOUT_PCM_VIDEO	= 2 << 8,
336 	EM28XX_AOUT_PCM_AUX	= 3 << 8,
337 	EM28XX_AOUT_PCM_LINE	= 4 << 8,
338 	EM28XX_AOUT_PCM_STEREO	= 5 << 8,
339 	EM28XX_AOUT_PCM_MONO	= 6 << 8,
340 	EM28XX_AOUT_PCM_PHONE	= 7 << 8,
341 };
342 
343 static inline int ac97_return_record_select(int a_out)
344 {
345 	return (a_out & 0x700) >> 8;
346 }
347 
348 struct em28xx_reg_seq {
349 	int reg;
350 	unsigned char val, mask;
351 	int sleep;
352 };
353 
354 struct em28xx_input {
355 	enum enum28xx_itype type;
356 	unsigned int vmux;
357 	enum em28xx_amux amux;
358 	enum em28xx_aout aout;
359 	struct em28xx_reg_seq *gpio;
360 };
361 
362 #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
363 
364 enum em28xx_decoder {
365 	EM28XX_NODECODER = 0,
366 	EM28XX_TVP5150,
367 	EM28XX_SAA711X,
368 };
369 
370 enum em28xx_sensor {
371 	EM28XX_NOSENSOR = 0,
372 	EM28XX_MT9V011,
373 	EM28XX_MT9M001,
374 	EM28XX_MT9M111,
375 };
376 
377 enum em28xx_adecoder {
378 	EM28XX_NOADECODER = 0,
379 	EM28XX_TVAUDIO,
380 };
381 
382 struct em28xx_board {
383 	char *name;
384 	int vchannels;
385 	int tuner_type;
386 	int tuner_addr;
387 
388 	/* i2c flags */
389 	unsigned int tda9887_conf;
390 
391 	/* GPIO sequences */
392 	struct em28xx_reg_seq *dvb_gpio;
393 	struct em28xx_reg_seq *suspend_gpio;
394 	struct em28xx_reg_seq *tuner_gpio;
395 	struct em28xx_reg_seq *mute_gpio;
396 
397 	unsigned int is_em2800:1;
398 	unsigned int has_msp34xx:1;
399 	unsigned int mts_firmware:1;
400 	unsigned int max_range_640_480:1;
401 	unsigned int has_dvb:1;
402 	unsigned int has_snapshot_button:1;
403 	unsigned int is_webcam:1;
404 	unsigned int valid:1;
405 	unsigned int has_ir_i2c:1;
406 
407 	unsigned char xclk, i2c_speed;
408 	unsigned char radio_addr;
409 	unsigned short tvaudio_addr;
410 
411 	enum em28xx_decoder decoder;
412 	enum em28xx_adecoder adecoder;
413 
414 	struct em28xx_input       input[MAX_EM28XX_INPUT];
415 	struct em28xx_input	  radio;
416 	char			  *ir_codes;
417 };
418 
419 struct em28xx_eeprom {
420 	u32 id;			/* 0x9567eb1a */
421 	u16 vendor_ID;
422 	u16 product_ID;
423 
424 	u16 chip_conf;
425 
426 	u16 board_conf;
427 
428 	u16 string1, string2, string3;
429 
430 	u8 string_idx_table;
431 };
432 
433 /* device states */
434 enum em28xx_dev_state {
435 	DEV_INITIALIZED = 0x01,
436 	DEV_DISCONNECTED = 0x02,
437 	DEV_MISCONFIGURED = 0x04,
438 };
439 
440 #define EM28XX_AUDIO_BUFS 5
441 #define EM28XX_NUM_AUDIO_PACKETS 64
442 #define EM28XX_AUDIO_MAX_PACKET_SIZE 196 /* static value */
443 #define EM28XX_CAPTURE_STREAM_EN 1
444 
445 /* em28xx extensions */
446 #define EM28XX_AUDIO   0x10
447 #define EM28XX_DVB     0x20
448 #define EM28XX_RC      0x30
449 
450 /* em28xx resource types (used for res_get/res_lock etc */
451 #define EM28XX_RESOURCE_VIDEO 0x01
452 #define EM28XX_RESOURCE_VBI   0x02
453 
454 struct em28xx_audio {
455 	char name[50];
456 	char *transfer_buffer[EM28XX_AUDIO_BUFS];
457 	struct urb *urb[EM28XX_AUDIO_BUFS];
458 	struct usb_device *udev;
459 	unsigned int capture_transfer_done;
460 	struct snd_pcm_substream   *capture_pcm_substream;
461 
462 	unsigned int hwptr_done_capture;
463 	struct snd_card            *sndcard;
464 
465 	int users;
466 	spinlock_t slock;
467 };
468 
469 struct em28xx;
470 
471 struct em28xx_fh {
472 	struct em28xx *dev;
473 	int           radio;
474 	unsigned int  resources;
475 
476 	struct videobuf_queue        vb_vidq;
477 	struct videobuf_queue        vb_vbiq;
478 
479 	enum v4l2_buf_type           type;
480 };
481 
482 /* main device struct */
483 struct em28xx {
484 	/* generic device properties */
485 	char name[30];		/* name (including minor) of the device */
486 	int model;		/* index in the device_data struct */
487 	int devno;		/* marks the number of this device */
488 	enum em28xx_chip_id chip_id;
489 
490 	int audio_ifnum;
491 
492 	struct v4l2_device v4l2_dev;
493 	struct em28xx_board board;
494 
495 	/* Webcam specific fields */
496 	enum em28xx_sensor em28xx_sensor;
497 	int sensor_xres, sensor_yres;
498 	int sensor_xtal;
499 
500 	/* Allows progressive (e. g. non-interlaced) mode */
501 	int progressive;
502 
503 	/* Vinmode/Vinctl used at the driver */
504 	int vinmode, vinctl;
505 
506 	unsigned int has_audio_class:1;
507 	unsigned int has_alsa_audio:1;
508 	unsigned int is_audio_only:1;
509 
510 	/* Controls audio streaming */
511 	struct work_struct wq_trigger;              /* Trigger to start/stop audio for alsa module */
512 	 atomic_t       stream_started;      /* stream should be running if true */
513 
514 	struct em28xx_fmt *format;
515 
516 	struct em28xx_IR *ir;
517 
518 	/* Some older em28xx chips needs a waiting time after writing */
519 	unsigned int wait_after_write;
520 
521 	struct list_head	devlist;
522 
523 	u32 i2s_speed;		/* I2S speed for audio digital stream */
524 
525 	struct em28xx_audio_mode audio_mode;
526 
527 	int tuner_type;		/* type of the tuner */
528 	int tuner_addr;		/* tuner address */
529 	int tda9887_conf;
530 	/* i2c i/o */
531 	struct i2c_adapter i2c_adap;
532 	struct i2c_client i2c_client;
533 	/* video for linux */
534 	int users;		/* user count for exclusive use */
535 	struct video_device *vdev;	/* video for linux device struct */
536 	v4l2_std_id norm;	/* selected tv norm */
537 	int ctl_freq;		/* selected frequency */
538 	unsigned int ctl_input;	/* selected input */
539 	unsigned int ctl_ainput;/* selected audio input */
540 	unsigned int ctl_aoutput;/* selected audio output */
541 	int mute;
542 	int volume;
543 	/* frame properties */
544 	int width;		/* current frame width */
545 	int height;		/* current frame height */
546 	unsigned hscale;	/* horizontal scale factor (see datasheet) */
547 	unsigned vscale;	/* vertical scale factor (see datasheet) */
548 	int interlaced;		/* 1=interlace fileds, 0=just top fileds */
549 	unsigned int video_bytesread;	/* Number of bytes read */
550 
551 	unsigned long hash;	/* eeprom hash - for boards with generic ID */
552 	unsigned long i2c_hash;	/* i2c devicelist hash -
553 				   for boards with generic ID */
554 
555 	struct em28xx_audio adev;
556 
557 	/* states */
558 	enum em28xx_dev_state state;
559 
560 	/* vbi related state tracking */
561 	int capture_type;
562 	int vbi_read;
563 	unsigned char cur_field;
564 	unsigned int vbi_width;
565 	unsigned int vbi_height; /* lines per field */
566 
567 	struct work_struct         request_module_wk;
568 
569 	/* locks */
570 	struct mutex lock;
571 	struct mutex ctrl_urb_lock;	/* protects urb_buf */
572 	/* spinlock_t queue_lock; */
573 	struct list_head inqueue, outqueue;
574 	struct video_device *vbi_dev;
575 	struct video_device *radio_dev;
576 
577 	/* resources in use */
578 	unsigned int resources;
579 
580 	unsigned char eedata[256];
581 
582 	/* Isoc control struct */
583 	struct em28xx_dmaqueue vidq;
584 	struct em28xx_dmaqueue vbiq;
585 	struct em28xx_usb_isoc_ctl isoc_ctl;
586 	spinlock_t slock;
587 
588 	/* usb transfer */
589 	struct usb_device *udev;	/* the usb device */
590 	int alt;		/* alternate */
591 	int max_pkt_size;	/* max packet size of isoc transaction */
592 	int num_alt;		/* Number of alternative settings */
593 	unsigned int *alt_max_pkt_size;	/* array of wMaxPacketSize */
594 	int dvb_alt;				/* alternate for DVB */
595 	unsigned int dvb_max_pkt_size;		/* wMaxPacketSize for DVB */
596 	char urb_buf[URB_MAX_CTRL_SIZE];	/* urb control msg buffer */
597 
598 	/* helper funcs that call usb_control_msg */
599 	int (*em28xx_write_regs) (struct em28xx *dev, u16 reg,
600 					char *buf, int len);
601 	int (*em28xx_read_reg) (struct em28xx *dev, u16 reg);
602 	int (*em28xx_read_reg_req_len) (struct em28xx *dev, u8 req, u16 reg,
603 					char *buf, int len);
604 	int (*em28xx_write_regs_req) (struct em28xx *dev, u8 req, u16 reg,
605 				      char *buf, int len);
606 	int (*em28xx_read_reg_req) (struct em28xx *dev, u8 req, u16 reg);
607 
608 	enum em28xx_mode mode;
609 
610 	/* register numbers for GPO/GPIO registers */
611 	u16 reg_gpo_num, reg_gpio_num;
612 
613 	/* Caches GPO and GPIO registers */
614 	unsigned char	reg_gpo, reg_gpio;
615 
616 	/* Snapshot button */
617 	char snapshot_button_path[30];	/* path of the input dev */
618 	struct input_dev *sbutton_input_dev;
619 	struct delayed_work sbutton_query_work;
620 
621 	struct em28xx_dvb *dvb;
622 
623 	/* I2C keyboard data */
624 	struct IR_i2c_init_data init_data;
625 };
626 
627 struct em28xx_ops {
628 	struct list_head next;
629 	char *name;
630 	int id;
631 	int (*init)(struct em28xx *);
632 	int (*fini)(struct em28xx *);
633 };
634 
635 /* Provided by em28xx-i2c.c */
636 void em28xx_do_i2c_scan(struct em28xx *dev);
637 int  em28xx_i2c_register(struct em28xx *dev);
638 int  em28xx_i2c_unregister(struct em28xx *dev);
639 
640 /* Provided by em28xx-core.c */
641 
642 u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
643 void em28xx_queue_unusedframes(struct em28xx *dev);
644 void em28xx_release_buffers(struct em28xx *dev);
645 
646 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
647 			    char *buf, int len);
648 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
649 int em28xx_read_reg(struct em28xx *dev, u16 reg);
650 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
651 			  int len);
652 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
653 int em28xx_write_reg(struct em28xx *dev, u16 reg, u8 val);
654 int em28xx_write_reg_bits(struct em28xx *dev, u16 reg, u8 val,
655 				 u8 bitmask);
656 
657 int em28xx_read_ac97(struct em28xx *dev, u8 reg);
658 int em28xx_write_ac97(struct em28xx *dev, u8 reg, u16 val);
659 
660 int em28xx_audio_analog_set(struct em28xx *dev);
661 int em28xx_audio_setup(struct em28xx *dev);
662 
663 int em28xx_colorlevels_set_default(struct em28xx *dev);
664 int em28xx_capture_start(struct em28xx *dev, int start);
665 int em28xx_vbi_supported(struct em28xx *dev);
666 int em28xx_set_outfmt(struct em28xx *dev);
667 int em28xx_resolution_set(struct em28xx *dev);
668 int em28xx_set_alternate(struct em28xx *dev);
669 int em28xx_alloc_isoc(struct em28xx *dev, enum em28xx_mode mode,
670 		      int max_packets, int num_bufs, int max_pkt_size);
671 int em28xx_init_isoc(struct em28xx *dev, enum em28xx_mode mode,
672 		     int max_packets, int num_bufs, int max_pkt_size,
673 		     int (*isoc_copy) (struct em28xx *dev, struct urb *urb));
674 void em28xx_uninit_isoc(struct em28xx *dev, enum em28xx_mode mode);
675 void em28xx_stop_urbs(struct em28xx *dev);
676 int em28xx_isoc_dvb_max_packetsize(struct em28xx *dev);
677 int em28xx_set_mode(struct em28xx *dev, enum em28xx_mode set_mode);
678 int em28xx_gpio_set(struct em28xx *dev, struct em28xx_reg_seq *gpio);
679 void em28xx_wake_i2c(struct em28xx *dev);
680 int em28xx_register_extension(struct em28xx_ops *dev);
681 void em28xx_unregister_extension(struct em28xx_ops *dev);
682 void em28xx_init_extension(struct em28xx *dev);
683 void em28xx_close_extension(struct em28xx *dev);
684 
685 /* Provided by em28xx-video.c */
686 int em28xx_register_analog_devices(struct em28xx *dev);
687 void em28xx_release_analog_resources(struct em28xx *dev);
688 
689 /* Provided by em28xx-cards.c */
690 extern int em2800_variant_detect(struct usb_device *udev, int model);
691 extern struct em28xx_board em28xx_boards[];
692 extern struct usb_device_id em28xx_id_table[];
693 extern const unsigned int em28xx_bcount;
694 int em28xx_tuner_callback(void *ptr, int component, int command, int arg);
695 void em28xx_release_resources(struct em28xx *dev);
696 
697 /* Provided by em28xx-vbi.c */
698 extern struct videobuf_queue_ops em28xx_vbi_qops;
699 
700 /* printk macros */
701 
702 #define em28xx_err(fmt, arg...) do {\
703 	printk(KERN_ERR fmt , ##arg); } while (0)
704 
705 #define em28xx_errdev(fmt, arg...) do {\
706 	printk(KERN_ERR "%s: "fmt,\
707 			dev->name , ##arg); } while (0)
708 
709 #define em28xx_info(fmt, arg...) do {\
710 	printk(KERN_INFO "%s: "fmt,\
711 			dev->name , ##arg); } while (0)
712 #define em28xx_warn(fmt, arg...) do {\
713 	printk(KERN_WARNING "%s: "fmt,\
714 			dev->name , ##arg); } while (0)
715 
716 static inline int em28xx_compression_disable(struct em28xx *dev)
717 {
718 	/* side effect of disabling scaler and mixer */
719 	return em28xx_write_reg(dev, EM28XX_R26_COMPR, 0x00);
720 }
721 
722 static inline int em28xx_contrast_get(struct em28xx *dev)
723 {
724 	return em28xx_read_reg(dev, EM28XX_R20_YGAIN) & 0x1f;
725 }
726 
727 static inline int em28xx_brightness_get(struct em28xx *dev)
728 {
729 	return em28xx_read_reg(dev, EM28XX_R21_YOFFSET);
730 }
731 
732 static inline int em28xx_saturation_get(struct em28xx *dev)
733 {
734 	return em28xx_read_reg(dev, EM28XX_R22_UVGAIN) & 0x1f;
735 }
736 
737 static inline int em28xx_u_balance_get(struct em28xx *dev)
738 {
739 	return em28xx_read_reg(dev, EM28XX_R23_UOFFSET);
740 }
741 
742 static inline int em28xx_v_balance_get(struct em28xx *dev)
743 {
744 	return em28xx_read_reg(dev, EM28XX_R24_VOFFSET);
745 }
746 
747 static inline int em28xx_gamma_get(struct em28xx *dev)
748 {
749 	return em28xx_read_reg(dev, EM28XX_R14_GAMMA) & 0x3f;
750 }
751 
752 static inline int em28xx_contrast_set(struct em28xx *dev, s32 val)
753 {
754 	u8 tmp = (u8) val;
755 	return em28xx_write_regs(dev, EM28XX_R20_YGAIN, &tmp, 1);
756 }
757 
758 static inline int em28xx_brightness_set(struct em28xx *dev, s32 val)
759 {
760 	u8 tmp = (u8) val;
761 	return em28xx_write_regs(dev, EM28XX_R21_YOFFSET, &tmp, 1);
762 }
763 
764 static inline int em28xx_saturation_set(struct em28xx *dev, s32 val)
765 {
766 	u8 tmp = (u8) val;
767 	return em28xx_write_regs(dev, EM28XX_R22_UVGAIN, &tmp, 1);
768 }
769 
770 static inline int em28xx_u_balance_set(struct em28xx *dev, s32 val)
771 {
772 	u8 tmp = (u8) val;
773 	return em28xx_write_regs(dev, EM28XX_R23_UOFFSET, &tmp, 1);
774 }
775 
776 static inline int em28xx_v_balance_set(struct em28xx *dev, s32 val)
777 {
778 	u8 tmp = (u8) val;
779 	return em28xx_write_regs(dev, EM28XX_R24_VOFFSET, &tmp, 1);
780 }
781 
782 static inline int em28xx_gamma_set(struct em28xx *dev, s32 val)
783 {
784 	u8 tmp = (u8) val;
785 	return em28xx_write_regs(dev, EM28XX_R14_GAMMA, &tmp, 1);
786 }
787 
788 /*FIXME: maxw should be dependent of alt mode */
789 static inline unsigned int norm_maxw(struct em28xx *dev)
790 {
791 	if (dev->board.is_webcam)
792 		return dev->sensor_xres;
793 
794 	if (dev->board.max_range_640_480)
795 		return 640;
796 
797 	return 720;
798 }
799 
800 static inline unsigned int norm_maxh(struct em28xx *dev)
801 {
802 	if (dev->board.is_webcam)
803 		return dev->sensor_yres;
804 
805 	if (dev->board.max_range_640_480)
806 		return 480;
807 
808 	return (dev->norm & V4L2_STD_625_50) ? 576 : 480;
809 }
810 #endif
811