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