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