usbvision.h revision 781aa1d1ab7ba13314af0af6c5d70c0eb0e96bf4
1/*
2 * USBVISION.H
3 *  usbvision header file
4 *
5 * Copyright (c) 1999-2005 Joerg Heckenbach <joerg@heckenbach-aw.de>
6 *
7 * This module is part of usbvision driver project.
8 * Updates to driver completed by Dwaine P. Garden
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
26#ifndef __LINUX_USBVISION_H
27#define __LINUX_USBVISION_H
28
29#include <linux/list.h>
30
31#ifndef VID_HARDWARE_USBVISION
32	#define VID_HARDWARE_USBVISION 34   /* USBVision Video Grabber */
33#endif
34
35#define USBVISION_PWR_REG		0x00
36	#define USBVISION_SSPND_EN		(1 << 1)
37	#define USBVISION_RES2			(1 << 2)
38	#define USBVISION_PWR_VID		(1 << 5)
39        #define USBVISION_E2_EN			(1 << 7)
40#define USBVISION_CONFIG_REG		0x01
41#define USBVISION_ADRS_REG		0x02
42#define USBVISION_ALTER_REG		0x03
43#define USBVISION_FORCE_ALTER_REG	0x04
44#define USBVISION_STATUS_REG		0x05
45#define USBVISION_IOPIN_REG		0x06
46	#define USBVISION_IO_1			(1 << 0)
47	#define USBVISION_IO_2			(1 << 1)
48	#define USBVISION_AUDIO_IN		0
49	#define USBVISION_AUDIO_TV		1
50	#define USBVISION_AUDIO_RADIO		2
51	#define USBVISION_AUDIO_MUTE		3
52#define USBVISION_SER_MODE		0x07
53#define USBVISION_SER_ADRS		0x08
54#define USBVISION_SER_CONT		0x09
55#define USBVISION_SER_DAT1		0x0A
56#define USBVISION_SER_DAT2		0x0B
57#define USBVISION_SER_DAT3		0x0C
58#define USBVISION_SER_DAT4		0x0D
59#define USBVISION_EE_DATA		0x0E
60#define USBVISION_EE_LSBAD		0x0F
61#define USBVISION_EE_CONT		0x10
62#define USBVISION_DRM_CONT			0x12
63	#define USBVISION_REF			(1 << 0)
64	#define USBVISION_RES_UR		(1 << 2)
65	#define USBVISION_RES_FDL		(1 << 3)
66	#define USBVISION_RES_VDW		(1 << 4)
67#define USBVISION_DRM_PRM1		0x13
68#define USBVISION_DRM_PRM2		0x14
69#define USBVISION_DRM_PRM3		0x15
70#define USBVISION_DRM_PRM4		0x16
71#define USBVISION_DRM_PRM5		0x17
72#define USBVISION_DRM_PRM6		0x18
73#define USBVISION_DRM_PRM7		0x19
74#define USBVISION_DRM_PRM8		0x1A
75#define USBVISION_VIN_REG1		0x1B
76	#define USBVISION_8_422_SYNC		0x01
77	#define USBVISION_16_422_SYNC		0x02
78	#define USBVISION_VSNC_POL		(1 << 3)
79	#define USBVISION_HSNC_POL		(1 << 4)
80	#define USBVISION_FID_POL		(1 << 5)
81	#define USBVISION_HVALID_PO		(1 << 6)
82	#define USBVISION_VCLK_POL		(1 << 7)
83#define USBVISION_VIN_REG2		0x1C
84	#define USBVISION_AUTO_FID		(1 << 0)
85	#define USBVISION_NONE_INTER		(1 << 1)
86	#define USBVISION_NOHVALID		(1 << 2)
87	#define USBVISION_UV_ID			(1 << 3)
88	#define USBVISION_FIX_2C		(1 << 4)
89	#define USBVISION_SEND_FID		(1 << 5)
90	#define USBVISION_KEEP_BLANK		(1 << 7)
91#define USBVISION_LXSIZE_I		0x1D
92#define USBVISION_MXSIZE_I		0x1E
93#define USBVISION_LYSIZE_I		0x1F
94#define USBVISION_MYSIZE_I		0x20
95#define USBVISION_LX_OFFST		0x21
96#define USBVISION_MX_OFFST		0x22
97#define USBVISION_LY_OFFST		0x23
98#define USBVISION_MY_OFFST		0x24
99#define USBVISION_FRM_RATE		0x25
100#define USBVISION_LXSIZE_O		0x26
101#define USBVISION_MXSIZE_O		0x27
102#define USBVISION_LYSIZE_O		0x28
103#define USBVISION_MYSIZE_O		0x29
104#define USBVISION_FILT_CONT		0x2A
105#define USBVISION_VO_MODE		0x2B
106#define USBVISION_INTRA_CYC		0x2C
107#define USBVISION_STRIP_SZ		0x2D
108#define USBVISION_FORCE_INTRA		0x2E
109#define USBVISION_FORCE_UP		0x2F
110#define USBVISION_BUF_THR		0x30
111#define USBVISION_DVI_YUV		0x31
112#define USBVISION_AUDIO_CONT		0x32
113#define USBVISION_AUD_PK_LEN		0x33
114#define USBVISION_BLK_PK_LEN		0x34
115#define USBVISION_PCM_THR1		0x38
116#define USBVISION_PCM_THR2		0x39
117#define USBVISION_DIST_THR_L		0x3A
118#define USBVISION_DIST_THR_H		0x3B
119#define USBVISION_MAX_DIST_L		0x3C
120#define USBVISION_MAX_DIST_H		0x3D
121#define USBVISION_OP_CODE		0x33
122
123#define MAX_BYTES_PER_PIXEL		4
124
125#define MIN_FRAME_WIDTH			64
126#define MAX_USB_WIDTH			320  //384
127#define MAX_FRAME_WIDTH			320  //384			/*streching sometimes causes crashes*/
128
129#define MIN_FRAME_HEIGHT		48
130#define MAX_USB_HEIGHT			240  //288
131#define MAX_FRAME_HEIGHT		240  //288			/*Streching sometimes causes crashes*/
132
133#define MAX_FRAME_SIZE     		(MAX_FRAME_WIDTH * MAX_FRAME_HEIGHT * MAX_BYTES_PER_PIXEL)
134#define USBVISION_CLIPMASK_SIZE		(MAX_FRAME_WIDTH * MAX_FRAME_HEIGHT / 8) //bytesize of clipmask
135
136#define USBVISION_URB_FRAMES		32
137#define USBVISION_MAX_ISOC_PACKET_SIZE 	959			// NT1003 Specs Document says 1023
138
139#define USBVISION_NUM_HEADERMARKER	20
140#define USBVISION_NUMFRAMES		2
141#define USBVISION_NUMSBUF		2
142
143#define USBVISION_POWEROFF_TIME		3 * (HZ)		// 3 seconds
144
145/* This macro restricts an int variable to an inclusive range */
146#define RESTRICT_TO_RANGE(v,mi,ma) { if ((v) < (mi)) (v) = (mi); else if ((v) > (ma)) (v) = (ma); }
147
148/*
149 * We use macros to do YUV -> RGB conversion because this is
150 * very important for speed and totally unimportant for size.
151 *
152 * YUV -> RGB Conversion
153 * ---------------------
154 *
155 * B = 1.164*(Y-16)		    + 2.018*(V-128)
156 * G = 1.164*(Y-16) - 0.813*(U-128) - 0.391*(V-128)
157 * R = 1.164*(Y-16) + 1.596*(U-128)
158 *
159 * If you fancy integer arithmetics (as you should), hear this:
160 *
161 * 65536*B = 76284*(Y-16)		  + 132252*(V-128)
162 * 65536*G = 76284*(Y-16) -  53281*(U-128) -  25625*(V-128)
163 * 65536*R = 76284*(Y-16) + 104595*(U-128)
164 *
165 * Make sure the output values are within [0..255] range.
166 */
167#define LIMIT_RGB(x) (((x) < 0) ? 0 : (((x) > 255) ? 255 : (x)))
168#define YUV_TO_RGB_BY_THE_BOOK(my,mu,mv,mr,mg,mb) { \
169    int mm_y, mm_yc, mm_u, mm_v, mm_r, mm_g, mm_b; \
170    mm_y = (my) - 16;  \
171    mm_u = (mu) - 128; \
172    mm_v = (mv) - 128; \
173    mm_yc= mm_y * 76284; \
174    mm_b = (mm_yc		+ 132252*mm_v	) >> 16; \
175    mm_g = (mm_yc -  53281*mm_u -  25625*mm_v	) >> 16; \
176    mm_r = (mm_yc + 104595*mm_u			) >> 16; \
177    mb = LIMIT_RGB(mm_b); \
178    mg = LIMIT_RGB(mm_g); \
179    mr = LIMIT_RGB(mm_r); \
180}
181
182
183
184/* Debugging aid */
185#define USBVISION_SAY_AND_WAIT(what) { \
186	wait_queue_head_t wq; \
187	init_waitqueue_head(&wq); \
188	printk(KERN_INFO "Say: %s\n", what); \
189	interruptible_sleep_on_timeout (&wq, HZ*3); \
190}
191
192/*
193 * This macro checks if usbvision is still operational. The 'usbvision'
194 * pointer must be valid, usbvision->dev must be valid, we are not
195 * removing the device and the device has not erred on us.
196 */
197#define USBVISION_IS_OPERATIONAL(udevice) (\
198	(udevice != NULL) && \
199	((udevice)->dev != NULL) && \
200	((udevice)->last_error == 0) && \
201	(!(udevice)->remove_pending))
202
203
204enum ScanState {
205	ScanState_Scanning,	/* Scanning for header */
206	ScanState_Lines		/* Parsing lines */
207};
208
209/* Completion states of the data parser */
210enum ParseState {
211	ParseState_Continue,	/* Just parse next item */
212	ParseState_NextFrame,	/* Frame done, send it to V4L */
213	ParseState_Out,		/* Not enough data for frame */
214	ParseState_EndParse	/* End parsing */
215};
216
217enum FrameState {
218	FrameState_Unused,	/* Unused (no MCAPTURE) */
219	FrameState_Ready,	/* Ready to start grabbing */
220	FrameState_Grabbing,	/* In the process of being grabbed into */
221	FrameState_Done,	/* Finished grabbing, but not been synced yet */
222	FrameState_DoneHold,	/* Are syncing or reading */
223	FrameState_Error,	/* Something bad happened while processing */
224};
225
226enum IsocState {
227	IsocState_InFrame,	/* Isoc packet is member of frame */
228	IsocState_NoFrame,	/* Isoc packet is not member of any frame */
229};
230
231struct usb_device;
232
233struct usbvision_sbuf {
234	char *data;
235	struct urb *urb;
236};
237
238#define USBVISION_MAGIC_1      			0x55
239#define USBVISION_MAGIC_2      			0xAA
240#define USBVISION_HEADER_LENGTH			0x0c
241#define USBVISION_SAA7111_ADDR			0x48
242#define USBVISION_SAA7113_ADDR			0x4a
243#define USBVISION_IIC_LRACK			0x20
244#define USBVISION_IIC_LRNACK			0x30
245#define USBVISION_FRAME_FORMAT_PARAM_INTRA	(1<<7)
246
247static struct usbvision_v4l2_format_st {
248	int		supported;
249	int		bytes_per_pixel;
250	int		depth;
251	int		format;
252	char		*desc;
253} usbvision_v4l2_format[] = {
254  { 1, 1,  8, V4L2_PIX_FMT_GREY    , "GREY" },
255  { 1, 2, 16, V4L2_PIX_FMT_RGB565  , "RGB565" },
256  { 1, 3, 24, V4L2_PIX_FMT_RGB24   , "RGB24" },
257  { 1, 4, 32, V4L2_PIX_FMT_RGB32   , "RGB32" },
258  { 1, 2, 16, V4L2_PIX_FMT_RGB555  , "RGB555" },
259  { 1, 2, 16, V4L2_PIX_FMT_YUYV    , "YUV422" },
260  { 1, 2, 12, V4L2_PIX_FMT_YVU420  , "YUV420P" }, // 1.5 !
261  { 1, 2, 16, V4L2_PIX_FMT_YUV422P , "YUV422P" }
262};
263#define USBVISION_SUPPORTED_PALETTES ARRAY_SIZE(usbvision_v4l2_format)
264
265struct usbvision_frame_header {
266	unsigned char magic_1;				/* 0 magic */
267	unsigned char magic_2;				/* 1  magic */
268	unsigned char headerLength;			/* 2 */
269	unsigned char frameNum;				/* 3 */
270	unsigned char framePhase;			/* 4 */
271	unsigned char frameLatency;			/* 5 */
272	unsigned char dataFormat;			/* 6 */
273	unsigned char formatParam;			/* 7 */
274	unsigned char frameWidthLo;			/* 8 */
275	unsigned char frameWidthHi;			/* 9 */
276	unsigned char frameHeightLo;			/* 10 */
277	unsigned char frameHeightHi;			/* 11 */
278	__u16 frameWidth;				/* 8 - 9 after endian correction*/
279	__u16 frameHeight;				/* 10 - 11 after endian correction*/
280};
281
282struct usbvision_frame {
283	char *data;					/* Frame buffer */
284	struct usbvision_frame_header isocHeader;	/* Header from stream */
285
286	int width;					/* Width application is expecting */
287	int height;					/* Height */
288
289	int frmwidth;					/* Width the frame actually is */
290	int frmheight;					/* Height */
291
292	volatile int grabstate;				/* State of grabbing */
293	int scanstate;					/* State of scanning */
294
295	int curline;					/* Line of frame we're working on */
296
297	long scanlength;				/* uncompressed, raw data length of frame */
298	long bytes_read;				/* amount of scanlength that has been read from data */
299	struct usbvision_v4l2_format_st v4l2_format;	/* format the user needs*/
300	int v4l2_linesize;				/* bytes for one videoline*/
301        struct timeval timestamp;
302	wait_queue_head_t wq;				/* Processes waiting */
303	int sequence;					// How many video frames we send to user
304};
305
306#define CODEC_SAA7113	7113
307#define CODEC_SAA7111	7111
308#define BRIDGE_NT1003	1003
309#define BRIDGE_NT1004	1004
310#define BRIDGE_NT1005   1005
311
312/* Supported Devices: A table for usbvision.c*/
313
314static struct usbvision_device_data_st {
315	int idVendor;
316	int idProduct;
317	int Interface;					/* to handle special interface number like BELKIN and Hauppauge WinTV-USB II */
318	int Codec;
319	int VideoChannels;
320	__u64 VideoNorm;
321	int AudioChannels;
322	int Radio;
323	int vbi;
324	int Tuner;
325	int TunerType;
326	int Vin_Reg1;
327	int Vin_Reg2;
328	int X_Offset;
329	int Y_Offset;
330	int Dvi_yuv;
331	char *ModelString;
332} usbvision_device_data[] = {
333	{0xFFF0, 0xFFF0, -1, CODEC_SAA7111, 3, V4L2_STD_NTSC,  1, 1, 1, 1, TUNER_PHILIPS_NTSC_M,       -1, -1, -1, -1, -1, "Custom Dummy USBVision Device"},
334	{0x0A6F, 0x0400, -1, CODEC_SAA7113, 4, V4L2_STD_NTSC,  1, 0, 1, 0, 0,                          -1, -1, -1, -1, -1, "Xanboo"},
335	{0x050D, 0x0208, -1, CODEC_SAA7113, 2, V4L2_STD_PAL,   1, 0, 1, 0, 0,                          -1, -1,  0,  3,  7, "Belkin USBView II"},
336	{0x0571, 0x0002,  0, CODEC_SAA7111, 2, V4L2_STD_PAL,   0, 0, 1, 0, 0,                          -1, -1, -1, -1,  7, "echoFX InterView Lite"},
337	{0x0573, 0x0003, -1, CODEC_SAA7111, 2, V4L2_STD_NTSC,  1, 0, 1, 0, 0,                          -1, -1, -1, -1, -1, "USBGear USBG-V1 resp. HAMA USB"},
338	{0x0573, 0x0400, -1, CODEC_SAA7113, 4, V4L2_STD_NTSC,  0, 0, 1, 0, 0,                          -1, -1,  0,  3,  7, "D-Link V100"},
339	{0x0573, 0x2000, -1, CODEC_SAA7111, 2, V4L2_STD_NTSC,  1, 0, 1, 0, 0,                          -1, -1, -1, -1, -1, "X10 USB Camera"},
340	{0x0573, 0x2d00, -1, CODEC_SAA7111, 2, V4L2_STD_PAL,   1, 0, 1, 0, 0,                          -1, -1, -1,  3,  7, "Osprey 50"},
341	{0x0573, 0x2d01, -1, CODEC_SAA7113, 2, V4L2_STD_NTSC,	 0, 0, 1, 0, 0,			         -1, -1,  0,  3,  7, "Hauppauge USB-Live Model 600"},
342	{0x0573, 0x2101, -1, CODEC_SAA7113, 2, V4L2_STD_PAL, 	 2, 0, 1, 0, 0,                          -1, -1,  0,  3,  7, "Zoran Co. PMD (Nogatech) AV-grabber Manhattan"},
343	{0x0573, 0x4100, -1, CODEC_SAA7111, 3, V4L2_STD_NTSC,  1, 1, 1, 1, TUNER_PHILIPS_NTSC_M,       -1, -1, -1, 20, -1, "Nogatech USB-TV (NTSC) FM"},
344    	{0x0573, 0x4110, -1, CODEC_SAA7111, 3, V4L2_STD_NTSC,  1, 1, 1, 1, TUNER_PHILIPS_NTSC_M,       -1, -1, -1, 20, -1, "PNY USB-TV (NTSC) FM"},
345	{0x0573, 0x4450,  0, CODEC_SAA7113, 3, V4L2_STD_PAL,   1, 1, 1, 1, TUNER_PHILIPS_PAL,          -1, -1,  0,  3,  7, "PixelView PlayTv-USB PRO (PAL) FM"},
346	{0x0573, 0x4550,  0, CODEC_SAA7113, 3, V4L2_STD_PAL,   1, 1, 1, 1, TUNER_PHILIPS_PAL,          -1, -1,  0,  3,  7, "ZTV ZT-721 2.4GHz USB A/V Receiver"},
347	{0x0573, 0x4d00, -1, CODEC_SAA7111, 3, V4L2_STD_NTSC,  1, 0, 1, 1, TUNER_PHILIPS_NTSC_M,       -1, -1, -1, 20, -1, "Hauppauge WinTv-USB USA"},
348	{0x0573, 0x4d01, -1, CODEC_SAA7111, 3, V4L2_STD_NTSC,  1, 0, 1, 1, TUNER_PHILIPS_NTSC_M,       -1, -1, -1, -1, -1, "Hauppauge WinTv-USB"},
349	{0x0573, 0x4d02, -1, CODEC_SAA7111, 3, V4L2_STD_NTSC,  1, 0, 1, 1, TUNER_PHILIPS_NTSC_M,       -1, -1, -1, -1, -1, "Hauppauge WinTv-USB (NTSC)"},
350	{0x0573, 0x4d03, -1, CODEC_SAA7111, 3, V4L2_STD_SECAM, 1, 0, 1, 1, TUNER_PHILIPS_SECAM,        -1, -1, -1, -1, -1, "Hauppauge WinTv-USB (SECAM) "},
351	{0x0573, 0x4d10, -1, CODEC_SAA7111, 3, V4L2_STD_NTSC,  1, 1, 1, 1, TUNER_PHILIPS_NTSC_M,       -1, -1, -1, -1, -1, "Hauppauge WinTv-USB (NTSC) FM"},
352	{0x0573, 0x4d11, -1, CODEC_SAA7111, 3, V4L2_STD_PAL,   1, 1, 1, 1, TUNER_PHILIPS_PAL,          -1, -1, -1, -1, -1, "Hauppauge WinTv-USB (PAL) FM"},
353	{0x0573, 0x4d12, -1, CODEC_SAA7111, 3, V4L2_STD_PAL,   1, 1, 1, 1, TUNER_PHILIPS_PAL,          -1, -1, -1, -1, -1, "Hauppauge WinTv-USB (PAL) FM"},
354	{0x0573, 0x4d2a,  0, CODEC_SAA7113, 3, V4L2_STD_NTSC,  1, 1, 1, 1, TUNER_MICROTUNE_4049FM5,    -1, -1,  0,  3,  7, "Hauppauge WinTv USB (NTSC) FM Model 602 40201 Rev B285"},
355	{0x0573, 0x4d2b,  0, CODEC_SAA7113, 3, V4L2_STD_NTSC,  1, 1, 1, 1, TUNER_MICROTUNE_4049FM5,    -1, -1,  0,  3,  7, "Hauppauge WinTv USB (NTSC) FM Model 602 40201 Rev B282"},
356	{0x0573, 0x4d2c,  0, CODEC_SAA7113, 3, V4L2_STD_PAL,   1, 0, 1, 1, TUNER_PHILIPS_FM1216ME_MK3, -1, -1,  0,  3,  7, "Hauppauge WinTv USB (PAL/SECAM) 40209 Rev E1A5"},
357	{0x0573, 0x4d20,  0, CODEC_SAA7113, 3, V4L2_STD_PAL,   1, 1, 1, 1, TUNER_PHILIPS_PAL,          -1, -1,  0,  3,  7, "Hauppauge WinTv-USB II (PAL) FM Model 40201 Rev B226"},
358	{0x0573, 0x4d21,  0, CODEC_SAA7113, 3, V4L2_STD_PAL,   1, 0, 1, 1, TUNER_PHILIPS_PAL,          -1, -1,  0,  3,  7, "Hauppauge WinTv-USB II (PAL)"},
359	{0x0573, 0x4d22,  0, CODEC_SAA7113, 3, V4L2_STD_PAL,   1, 0, 1, 1, TUNER_PHILIPS_PAL,          -1, -1,  0,  3,  7, "Hauppauge WinTv-USB II (PAL) MODEL 566"},
360	{0x0573, 0x4d23, -1, CODEC_SAA7113, 3, V4L2_STD_SECAM, 1, 0, 1, 1, TUNER_PHILIPS_SECAM,        -1, -1,  0,  3,  7, "Hauppauge WinTv-USB (SECAM) 4D23"},
361	{0x0573, 0x4d25, -1, CODEC_SAA7113, 3, V4L2_STD_SECAM, 1, 0, 1, 1, TUNER_PHILIPS_SECAM,        -1, -1,  0,  3,  7, "Hauppauge WinTv-USB (SECAM) Model 40209 Rev B234"},
362	{0x0573, 0x4d26, -1, CODEC_SAA7113, 3, V4L2_STD_SECAM, 1, 0, 1, 1, TUNER_PHILIPS_SECAM,        -1, -1,  0,  3,  7, "Hauppauge WinTv-USB (SECAM) Model 40209 Rev B243"},
363	{0x0573, 0x4d27, -1, CODEC_SAA7113, 3, V4L2_STD_PAL,   1, 0, 1, 1, TUNER_ALPS_TSBE1_PAL,       -1, -1,  0,  3,  7, "Hauppauge WinTv-USB Model 40204 Rev B281"},
364	{0x0573, 0x4d28, -1, CODEC_SAA7113, 3, V4L2_STD_PAL,   1, 0, 1, 1, TUNER_ALPS_TSBE1_PAL,       -1, -1,  0,  3,  7, "Hauppauge WinTv-USB Model 40204 Rev B283"},
365	{0x0573, 0x4d29, -1, CODEC_SAA7113, 3, V4L2_STD_PAL,   1, 0, 1, 1, TUNER_PHILIPS_PAL,          -1, -1,  0,  3,  7, "Hauppauge WinTv-USB Model 40205 Rev B298"},
366	{0x0573, 0x4d30, -1, CODEC_SAA7113, 3, V4L2_STD_NTSC,  1, 1, 1, 1, TUNER_PHILIPS_NTSC_M,       -1, -1,  0,  3,  7, "Hauppauge WinTv-USB FM Model 40211 Rev B123"},
367	{0x0573, 0x4d31,  0, CODEC_SAA7113, 3, V4L2_STD_PAL,   1, 1, 1, 1, TUNER_PHILIPS_PAL,          -1, -1,  0,  3,  7, "Hauppauge WinTv-USB III (PAL) FM Model 568"},
368        {0x0573, 0x4d32,  0, CODEC_SAA7113, 3, V4L2_STD_PAL,   1, 1, 1, 1, TUNER_PHILIPS_PAL,          -1, -1,  0,  3,  7, "Hauppauge WinTv-USB III (PAL) FM Model 573"},
369	{0x0573, 0x4d35,  0, CODEC_SAA7113, 3, V4L2_STD_PAL,   1, 1, 1, 1, TUNER_MICROTUNE_4049FM5,    -1, -1,  0,  3,  7, "Hauppauge WinTv-USB III (PAL) FM Model 40219 Rev B252"},
370	{0x0573, 0x4d37,  0, CODEC_SAA7113, 3, V4L2_STD_PAL,   1, 1, 1, 1, TUNER_PHILIPS_FM1216ME_MK3, -1, -1,  0,  3,  7, "Hauppauge WinTV USB device Model 40219 Rev E189"},
371	{0x0768, 0x0006, -1, CODEC_SAA7113, 3, V4L2_STD_NTSC,  1, 1, 1, 1, TUNER_PHILIPS_NTSC_M,       -1, -1,  5,  5, -1, "Camtel Technology USB TV Genie Pro FM Model TVB330"},
372	{0x07d0, 0x0001, -1, CODEC_SAA7113, 2, V4L2_STD_PAL,   0, 0, 1, 0, 0,                          -1, -1,  0,  3,  7, "Digital Video Creator I"},
373	{0x07d0, 0x0002, -1, CODEC_SAA7111, 2, V4L2_STD_NTSC,  0, 0, 1, 0, 0,   		         -1, -1, 82, 20,  7, "Global Village GV-007 (NTSC)"},
374	{0x07d0, 0x0003,  0, CODEC_SAA7113, 2, V4L2_STD_NTSC,  0, 0, 1, 0, 0,                          -1, -1,  0,  3,  7, "Dazzle Fusion Model DVC-50 Rev 1 (NTSC)"},
375	{0x07d0, 0x0004,  0, CODEC_SAA7113, 2, V4L2_STD_PAL,   0, 0, 1, 0, 0,                          -1, -1,  0,  3,  7, "Dazzle Fusion Model DVC-80 Rev 1 (PAL)"},
376	{0x07d0, 0x0005,  0, CODEC_SAA7113, 2, V4L2_STD_SECAM, 0, 0, 1, 0, 0,	   		         -1, -1,  0,  3,  7, "Dazzle Fusion Model DVC-90 Rev 1 (SECAM)"},
377        {0x2304, 0x010d, -1, CODEC_SAA7111, 3, V4L2_STD_PAL,   1, 0, 0, 1, TUNER_TEMIC_4066FY5_PAL_I,  -1, -1, -1, -1, -1, "Pinnacle Studio PCTV USB (PAL)"},
378	{0x2304, 0x0109, -1, CODEC_SAA7111, 3, V4L2_STD_SECAM, 1, 0, 1, 1, TUNER_PHILIPS_SECAM,        -1, -1, -1, -1, -1, "Pinnacle Studio PCTV USB (SECAM)"},
379	{0x2304, 0x0110, -1, CODEC_SAA7111, 3, V4L2_STD_PAL,   1, 1, 1, 1, TUNER_PHILIPS_PAL,          -1, -1,128, 23, -1, "Pinnacle Studio PCTV USB (PAL) FM"},
380	{0x2304, 0x0111, -1, CODEC_SAA7111, 3, V4L2_STD_PAL,   1, 0, 1, 1, TUNER_PHILIPS_PAL,          -1, -1, -1, -1, -1, "Miro PCTV USB"},
381	{0x2304, 0x0112, -1, CODEC_SAA7111, 3, V4L2_STD_NTSC,  1, 1, 1, 1, TUNER_PHILIPS_NTSC_M,       -1, -1, -1, -1, -1, "Pinnacle Studio PCTV USB (NTSC) FM"},
382	{0x2304, 0x0210, -1, CODEC_SAA7113, 3, V4L2_STD_PAL,   1, 1, 1, 1, TUNER_TEMIC_4009FR5_PAL,    -1, -1,  0,  3,  7, "Pinnacle Studio PCTV USB (PAL) FM"},
383	{0x2304, 0x0212, -1, CODEC_SAA7111, 3, V4L2_STD_NTSC,  1, 1, 1, 1, TUNER_TEMIC_4039FR5_NTSC,   -1, -1,  0,  3,  7, "Pinnacle Studio PCTV USB (NTSC) FM"},
384	{0x2304, 0x0214, -1, CODEC_SAA7113, 3, V4L2_STD_PAL,   1, 1, 1, 1, TUNER_TEMIC_4009FR5_PAL,    -1, -1,  0,  3,  7, "Pinnacle Studio PCTV USB (PAL) FM"},
385	{0x2304, 0x0300, -1, CODEC_SAA7113, 2, V4L2_STD_NTSC,  1, 0, 1, 0, 0,                          -1, -1,  0,  3,  7, "Pinnacle Studio Linx Video input cable (NTSC)"},
386	{0x2304, 0x0301, -1, CODEC_SAA7113, 2, V4L2_STD_PAL,   1, 0, 1, 0, 0,                          -1, -1,  0,  3,  7, "Pinnacle Studio Linx Video input cable (PAL)"},
387	{0x2304, 0x0419, -1, CODEC_SAA7113, 3, V4L2_STD_PAL,   1, 1, 1, 1, TUNER_TEMIC_4009FR5_PAL,    -1, -1,  0,  3,  7, "Pinnacle PCTV Bungee USB (PAL) FM"},
388	{0x2400, 0x4200, -1, CODEC_SAA7111, 3, VIDEO_MODE_NTSC,  1, 0, 1, 1, TUNER_PHILIPS_NTSC_M,       -1, -1, -1, -1, -1, "Hauppauge WinTv-USB"},
389	{}  /* Terminating entry */
390};
391
392
393/* Supported Devices: A table for the usb.c*/
394
395static struct usb_device_id usbvision_table [] = {
396	{ USB_DEVICE(0xFFF0, 0xFFF0) },  /* Custom Dummy USBVision Device */
397	{ USB_DEVICE(0x0A6F, 0x0400) },  /* Xanboo */
398	{ USB_DEVICE(0x050d, 0x0208) },  /* Belkin USBView II */
399	{ USB_DEVICE(0x0571, 0x0002) },  /* echoFX InterView Lite */
400	{ USB_DEVICE(0x0573, 0x0003) },  /* USBGear USBG-V1 */
401	{ USB_DEVICE(0x0573, 0x0400) },  /* D-Link V100 */
402	{ USB_DEVICE(0x0573, 0x2000) },  /* X10 USB Camera */
403	{ USB_DEVICE(0x0573, 0x2d00) },  /* Osprey 50 */
404	{ USB_DEVICE(0x0573, 0x2d01) },  /* Hauppauge USB-Live Model 600 */
405	{ USB_DEVICE(0x0573, 0x2101) },  /* Zoran Co. PMD (Nogatech) AV-grabber Manhattan */
406	{ USB_DEVICE(0x0573, 0x4100) },  /* Nogatech USB-TV FM (NTSC) */
407	{ USB_DEVICE(0x0573, 0x4110) },  /* PNY USB-TV (NTSC) FM */
408	{ USB_DEVICE(0x0573, 0x4450) },  /* PixelView PlayTv-USB PRO (PAL) FM */
409	{ USB_DEVICE(0x0573, 0x4550) },  /* ZTV ZT-721 2.4GHz USB A/V Receiver */
410	{ USB_DEVICE(0x0573, 0x4d00) },  /* Hauppauge WinTv-USB USA */
411	{ USB_DEVICE(0x0573, 0x4d01) },  /* Hauppauge WinTv-USB */
412	{ USB_DEVICE(0x0573, 0x4d02) },  /* Hauppauge WinTv-USB UK */
413	{ USB_DEVICE(0x0573, 0x4d03) },  /* Hauppauge WinTv-USB France */
414	{ USB_DEVICE(0x0573, 0x4d10) },  /* Hauppauge WinTv-USB with FM USA radio */
415	{ USB_DEVICE(0x0573, 0x4d11) },  /* Hauppauge WinTv-USB (PAL) with FM radio */
416	{ USB_DEVICE(0x0573, 0x4d12) },  /* Hauppauge WinTv-USB UK with FM Radio */
417	{ USB_DEVICE(0x0573, 0x4d2a) },  /* Hauppague WinTv USB Model 602 40201 Rev B285 */
418	{ USB_DEVICE(0x0573, 0x4d2b) },  /* Hauppague WinTv USB Model 602 40201 Rev B282 */
419	{ USB_DEVICE(0x0573, 0x4d2c) },  /* Hauppague WinTv USB Model 40209 Rev. E1A5 PAL*/
420	{ USB_DEVICE(0x0573, 0x4d20) },  /* Hauppauge WinTv-USB II (PAL) FM Model 40201 Rev B226 */
421	{ USB_DEVICE(0x0573, 0x4d21) },  /* Hauppauge WinTv-USB II (PAL) with FM radio*/
422	{ USB_DEVICE(0x0573, 0x4d22) },  /* Hauppauge WinTv-USB II (PAL) Model 566 */
423	{ USB_DEVICE(0x0573, 0x4d23) },  /* Hauppauge WinTv-USB France 4D23*/
424	{ USB_DEVICE(0x0573, 0x4d25) },  /* Hauppauge WinTv-USB Model 40209 rev B234 */
425	{ USB_DEVICE(0x0573, 0x4d26) },  /* Hauppauge WinTv-USB Model 40209 Rev B243 */
426	{ USB_DEVICE(0x0573, 0x4d27) },  /* Hauppauge WinTv-USB Model 40204 Rev B281 */
427	{ USB_DEVICE(0x0573, 0x4d28) },  /* Hauppauge WinTv-USB Model 40204 Rev B283 */
428	{ USB_DEVICE(0x0573, 0x4d29) },  /* Hauppauge WinTv-USB Model 40205 Rev B298 */
429	{ USB_DEVICE(0x0573, 0x4d30) },  /* Hauppauge WinTv-USB FM Model 40211 Rev B123 */
430	{ USB_DEVICE(0x0573, 0x4d31) },  /* Hauppauge WinTv-USB III (PAL) with FM radio Model 568 */
431	{ USB_DEVICE(0x0573, 0x4d32) },  /* Hauppauge WinTv-USB III (PAL) FM Model 573 */
432	{ USB_DEVICE(0x0573, 0x4d35) },  /* Hauppauge WinTv-USB III (SECAM) FM Model 40219 Rev B252 */
433	{ USB_DEVICE(0x0573, 0x4d37) },  /* Hauppauge WinTv-USB Model 40219 Rev E189 */
434	{ USB_DEVICE(0x0768, 0x0006) },  /* Camtel Technology USB TV Genie Pro FM Model TVB330 */
435	{ USB_DEVICE(0x07d0, 0x0001) },  /* Digital Video Creator I */
436	{ USB_DEVICE(0x07d0, 0x0002) },  /* Global Village GV-007 (NTSC) */
437	{ USB_DEVICE(0x07d0, 0x0003) },  /* Dazzle Fusion Model DVC-50 Rev 1 (NTSC) */
438	{ USB_DEVICE(0x07d0, 0x0004) },  /* Dazzle Fusion Model DVC-80 Rev 1 (PAL) */
439	{ USB_DEVICE(0x07d0, 0x0005) },  /* Dazzle Fusion Model DVC-90 Rev 1 (SECAM) */
440	{ USB_DEVICE(0x2304, 0x010d) },  /* Pinnacle Studio PCTV USB (PAL) */
441	{ USB_DEVICE(0x2304, 0x0109) },  /* Pinnacle Studio PCTV USB (SECAM) */
442	{ USB_DEVICE(0x2304, 0x0110) },  /* Pinnacle Studio PCTV USB (PAL) */
443	{ USB_DEVICE(0x2304, 0x0111) },  /* Miro PCTV USB */
444	{ USB_DEVICE(0x2304, 0x0112) },  /* Pinnacle Studio PCTV USB (NTSC) with FM radio */
445	{ USB_DEVICE(0x2304, 0x0210) },  /* Pinnacle Studio PCTV USB (PAL) with FM radio */
446	{ USB_DEVICE(0x2304, 0x0212) },  /* Pinnacle Studio PCTV USB (NTSC) with FM radio */
447	{ USB_DEVICE(0x2304, 0x0214) },  /* Pinnacle Studio PCTV USB (PAL) with FM radio */
448	{ USB_DEVICE(0x2304, 0x0300) },  /* Pinnacle Studio Linx Video input cable (NTSC) */
449	{ USB_DEVICE(0x2304, 0x0301) },  /* Pinnacle Studio Linx Video input cable (PAL) */
450	{ USB_DEVICE(0x2304, 0x0419) },  /* Pinnacle PCTV Bungee USB (PAL) FM */
451
452	{ USB_DEVICE(0x2400, 0x4200) },  /* Hauppauge WinTv-USB2 Model 42012 */
453
454	{ }  /* Terminating entry */
455};
456
457
458#define USBVISION_I2C_CLIENTS_MAX		8
459
460struct usb_usbvision {
461	struct video_device *vdev;         				/* Video Device */
462	struct video_device *rdev;               			/* Radio Device */
463	struct video_device *vbi; 					/* VBI Device   */
464	struct video_audio audio_dev;	        			/* Current audio params */
465
466	/* i2c Declaration Section*/
467	struct i2c_adapter i2c_adap;
468	struct i2c_algo_usb_data i2c_algo;
469	struct i2c_client i2c_client;
470	int i2c_state, i2c_ok;
471	struct i2c_client *i2c_clients[USBVISION_I2C_CLIENTS_MAX];
472
473	struct urb *ctrlUrb;
474	unsigned char ctrlUrbBuffer[8];
475	int ctrlUrbBusy;
476	struct usb_ctrlrequest ctrlUrbSetup;
477	wait_queue_head_t ctrlUrb_wq;					// Processes waiting
478	struct semaphore ctrlUrbLock;
479
480	int have_tuner;
481	int tuner_type;
482	int bridgeType;							// NT1003, NT1004, NT1005
483	int channel;
484	int radio;
485	int video_inputs;						// # of inputs
486	unsigned long freq;
487	int AudioMute;
488	int AudioChannel;
489	int isocMode;							// format of video data for the usb isoc-transfer
490	unsigned int nr;						// Number of the device < MAX_USBVISION
491
492	/* Device structure */
493	struct usb_device *dev;
494	unsigned char iface;						/* Video interface number */
495	unsigned char ifaceAltActive, ifaceAltInactive;			/* Alt settings */
496	unsigned char Vin_Reg2_Preset;
497	struct semaphore lock;
498	struct timer_list powerOffTimer;
499	struct work_struct powerOffWork;
500	int power;							/* is the device powered on? */
501	int user;							/* user count for exclusive use */
502	int usbvision_used;						/* Is this structure in use? */
503	int initialized;						/* Had we already sent init sequence? */
504	int DevModel;							/* What type of USBVISION device we got? */
505	int streaming;							/* Are we streaming Isochronous? */
506	int last_error;							/* What calamity struck us? */
507	int curwidth;							/* width of the frame the device is currently set to*/
508	int curheight;      						/* height of the frame the device is currently set to*/
509	int stretch_width;						/* stretch-factor for frame width (from usb to screen)*/
510	int stretch_height;						/* stretch-factor for frame height (from usb to screen)*/
511	char *fbuf;							/* Videodev buffer area for mmap*/
512	int max_frame_size;						/* Bytes in one video frame */
513	int fbuf_size;							/* Videodev buffer size */
514	int curFrameNum;						// number of current frame in frame buffer mode
515	struct usbvision_frame *curFrame;				// pointer to current frame, set by usbvision_find_header
516	struct usbvision_frame frame[USBVISION_NUMFRAMES];		// frame buffer
517	int curSbufNum;							// number of current receiving sbuf
518	struct usbvision_sbuf sbuf[USBVISION_NUMSBUF];			// S buffering
519	volatile int remove_pending;					/* If set then about to exit */
520
521	/* Scratch space from the Isochronous Pipe.*/
522	unsigned char *scratch;
523	int scratch_read_ptr;
524	int scratch_write_ptr;
525	int scratch_headermarker[USBVISION_NUM_HEADERMARKER];
526	int scratch_headermarker_read_ptr;
527	int scratch_headermarker_write_ptr;
528	int isocstate;
529        /* color controls */
530	int saturation;
531	int hue;
532	int brightness;
533        int contrast;
534	int depth;
535	struct usbvision_v4l2_format_st palette;
536
537	struct v4l2_capability vcap;					/* Video capabilities */
538	struct v4l2_input input;					/* May be used for tuner support */
539	unsigned char video_endp;					/* 0x82 for USBVISION devices based */
540
541	// Overlay stuff:
542        struct v4l2_framebuffer vid_buf;
543	struct v4l2_format vid_win;
544	int vid_buf_valid;						// Status: video buffer is valid (set)
545	int vid_win_valid;						// Status: video window is valid (set)
546	int	overlay;						/*Status: Are we overlaying? */
547	unsigned int 	clipmask[USBVISION_CLIPMASK_SIZE / 4];
548	unsigned char   *overlay_base;					/* Virtual base address of video buffer */
549	unsigned char   *overlay_win;					/* virt start address of overlay window */
550	struct usbvision_frame overlay_frame;
551
552	// Decompression stuff:
553	unsigned char *IntraFrameBuffer;				/* Buffer for reference frame */
554	int BlockPos; 							//for test only
555	int requestIntra;						// 0 = normal; 1 = intra frame is requested;
556	int lastIsocFrameNum;						// check for lost isoc frames
557	int isocPacketSize;						// need to calculate usedBandwidth
558	int usedBandwidth;						// used bandwidth 0-100%, need to set comprLevel
559	int comprLevel;							// How strong (100) or weak (0) is compression
560	int lastComprLevel;						// How strong (100) or weak (0) was compression
561	int usb_bandwidth;						/* Mbit/s */
562
563	/* /proc entries, relative to /proc/video/usbvision/ */
564	struct proc_dir_entry *proc_devdir;		/* Per-device proc directory */
565	struct proc_dir_entry *proc_info;		/* <minor#>/info entry */
566	struct proc_dir_entry *proc_register;		/* <minor#>/register entry */
567	struct proc_dir_entry *proc_freq; 		/* <minor#>/freq entry */
568	struct proc_dir_entry *proc_input; 		/* <minor#>/input entry */
569	struct proc_dir_entry *proc_frame;		/* <minor#>/frame entry */
570	struct proc_dir_entry *proc_button;		/* <minor#>/button entry */
571	struct proc_dir_entry *proc_control;		/* <minor#>/control entry */
572
573	/* Statistics that can be overlayed on the screen */
574	unsigned long isocUrbCount;			// How many URBs we received so far
575	unsigned long urb_length;			/* Length of last URB */
576	unsigned long isocDataCount;			/* How many bytes we received */
577	unsigned long header_count;			/* How many frame headers we found */
578	unsigned long scratch_ovf_count;		/* How many times we overflowed scratch */
579	unsigned long isocSkipCount;			/* How many empty ISO packets received */
580	unsigned long isocErrCount;			/* How many bad ISO packets received */
581	unsigned long isocPacketCount;			// How many packets we totally got
582	unsigned long timeInIrq;			// How long do we need for interrupt
583	int isocMeasureBandwidthCount;
584	int frame_num;					// How many video frames we send to user
585	int maxStripLen;				// How big is the biggest strip
586	int comprBlockPos;
587	int stripLenErrors;				// How many times was BlockPos greater than StripLen
588	int stripMagicErrors;
589	int stripLineNumberErrors;
590	int ComprBlockTypes[4];
591};
592
593#endif									/* __LINUX_USBVISION_H */
594
595