[mirror_ubuntu-hirsute-kernel.git] / drivers / media / video / usbvision / usbvision.h

/* 
 * USBVISION.H
 *  usbvision header file
 *
 * Copyright (c) 1999-2005 Joerg Heckenbach <joerg@heckenbach-aw.de>
 *
 * This module is part of usbvision driver project.
 * Updates to driver completed by Dwaine P. Garden
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */


#ifndef __LINUX_USBVISION_H
#define __LINUX_USBVISION_H

#include <linux/list.h>
#include <linux/usb.h>
#include "usbvision-i2c.h"

#ifndef VID_HARDWARE_USBVISION
	#define VID_HARDWARE_USBVISION 34   /* USBVision Video Grabber */
#endif

#define USBVISION_PWR_REG		0x00
	#define USBVISION_SSPND_EN		(1 << 1)
	#define USBVISION_RES2			(1 << 2)
	#define USBVISION_PWR_VID		(1 << 5)
        #define USBVISION_E2_EN			(1 << 7)
#define USBVISION_CONFIG_REG		0x01
#define USBVISION_ADRS_REG		0x02
#define USBVISION_ALTER_REG		0x03
#define USBVISION_FORCE_ALTER_REG	0x04
#define USBVISION_STATUS_REG		0x05
#define USBVISION_IOPIN_REG		0x06
	#define USBVISION_IO_1			(1 << 0)
	#define USBVISION_IO_2			(1 << 1)
	#define USBVISION_AUDIO_IN		0
	#define USBVISION_AUDIO_TV		1
	#define USBVISION_AUDIO_RADIO		2
	#define USBVISION_AUDIO_MUTE		3
#define USBVISION_SER_MODE		0x07
#define USBVISION_SER_ADRS		0x08
#define USBVISION_SER_CONT		0x09
#define USBVISION_SER_DAT1		0x0A
#define USBVISION_SER_DAT2		0x0B
#define USBVISION_SER_DAT3		0x0C
#define USBVISION_SER_DAT4		0x0D
#define USBVISION_EE_DATA		0x0E
#define USBVISION_EE_LSBAD		0x0F
#define USBVISION_EE_CONT		0x10
#define USBVISION_DRM_CONT			0x12
	#define USBVISION_REF			(1 << 0)
	#define USBVISION_RES_UR		(1 << 2)
	#define USBVISION_RES_FDL		(1 << 3)
	#define USBVISION_RES_VDW		(1 << 4)
#define USBVISION_DRM_PRM1		0x13
#define USBVISION_DRM_PRM2		0x14
#define USBVISION_DRM_PRM3		0x15
#define USBVISION_DRM_PRM4		0x16
#define USBVISION_DRM_PRM5		0x17
#define USBVISION_DRM_PRM6		0x18
#define USBVISION_DRM_PRM7		0x19
#define USBVISION_DRM_PRM8		0x1A
#define USBVISION_VIN_REG1		0x1B
	#define USBVISION_8_422_SYNC		0x01
	#define USBVISION_16_422_SYNC		0x02
	#define USBVISION_VSNC_POL		(1 << 3)
	#define USBVISION_HSNC_POL		(1 << 4)
	#define USBVISION_FID_POL		(1 << 5)
	#define USBVISION_HVALID_PO		(1 << 6)
	#define USBVISION_VCLK_POL		(1 << 7)
#define USBVISION_VIN_REG2		0x1C
	#define USBVISION_AUTO_FID		(1 << 0)
	#define USBVISION_NONE_INTER		(1 << 1)
	#define USBVISION_NOHVALID		(1 << 2)
	#define USBVISION_UV_ID			(1 << 3)
	#define USBVISION_FIX_2C		(1 << 4)
	#define USBVISION_SEND_FID		(1 << 5)
	#define USBVISION_KEEP_BLANK		(1 << 7)
#define USBVISION_LXSIZE_I		0x1D
#define USBVISION_MXSIZE_I		0x1E
#define USBVISION_LYSIZE_I		0x1F
#define USBVISION_MYSIZE_I		0x20
#define USBVISION_LX_OFFST		0x21
#define USBVISION_MX_OFFST		0x22
#define USBVISION_LY_OFFST		0x23
#define USBVISION_MY_OFFST		0x24
#define USBVISION_FRM_RATE		0x25
#define USBVISION_LXSIZE_O		0x26
#define USBVISION_MXSIZE_O		0x27
#define USBVISION_LYSIZE_O		0x28
#define USBVISION_MYSIZE_O		0x29
#define USBVISION_FILT_CONT		0x2A
#define USBVISION_VO_MODE		0x2B
#define USBVISION_INTRA_CYC		0x2C
#define USBVISION_STRIP_SZ		0x2D
#define USBVISION_FORCE_INTRA		0x2E
#define USBVISION_FORCE_UP		0x2F
#define USBVISION_BUF_THR		0x30
#define USBVISION_DVI_YUV		0x31
#define USBVISION_AUDIO_CONT		0x32
#define USBVISION_AUD_PK_LEN		0x33
#define USBVISION_BLK_PK_LEN		0x34
#define USBVISION_PCM_THR1		0x38
#define USBVISION_PCM_THR2		0x39
#define USBVISION_DIST_THR_L		0x3A
#define USBVISION_DIST_THR_H		0x3B
#define USBVISION_MAX_DIST_L		0x3C
#define USBVISION_MAX_DIST_H		0x3D
#define USBVISION_OP_CODE		0x33

#define MAX_BYTES_PER_PIXEL		4

#define MIN_FRAME_WIDTH			64
#define MAX_USB_WIDTH			320  //384
#define MAX_FRAME_WIDTH			320  //384			/*streching sometimes causes crashes*/

#define MIN_FRAME_HEIGHT		48
#define MAX_USB_HEIGHT			240  //288
#define MAX_FRAME_HEIGHT		240  //288			/*Streching sometimes causes crashes*/

#define MAX_FRAME_SIZE     		(MAX_FRAME_WIDTH * MAX_FRAME_HEIGHT * MAX_BYTES_PER_PIXEL)
#define USBVISION_CLIPMASK_SIZE		(MAX_FRAME_WIDTH * MAX_FRAME_HEIGHT / 8) //bytesize of clipmask

#define USBVISION_URB_FRAMES		32
#define USBVISION_MAX_ISOC_PACKET_SIZE 	959			// NT1003 Specs Document says 1023

#define USBVISION_NUM_HEADERMARKER	20
#define USBVISION_NUMFRAMES		2
#define USBVISION_NUMSBUF		2

#define USBVISION_POWEROFF_TIME		3 * (HZ)		// 3 seconds

/* This macro restricts an int variable to an inclusive range */
#define RESTRICT_TO_RANGE(v,mi,ma) { if ((v) < (mi)) (v) = (mi); else if ((v) > (ma)) (v) = (ma); }

/*
 * We use macros to do YUV -> RGB conversion because this is
 * very important for speed and totally unimportant for size.
 *
 * YUV -> RGB Conversion
 * ---------------------
 *
 * B = 1.164*(Y-16)		    + 2.018*(V-128)
 * G = 1.164*(Y-16) - 0.813*(U-128) - 0.391*(V-128)
 * R = 1.164*(Y-16) + 1.596*(U-128)
 *
 * If you fancy integer arithmetics (as you should), hear this:
 *
 * 65536*B = 76284*(Y-16)		  + 132252*(V-128)
 * 65536*G = 76284*(Y-16) -  53281*(U-128) -  25625*(V-128)
 * 65536*R = 76284*(Y-16) + 104595*(U-128)
 *
 * Make sure the output values are within [0..255] range.
 */
#define LIMIT_RGB(x) (((x) < 0) ? 0 : (((x) > 255) ? 255 : (x)))
#define YUV_TO_RGB_BY_THE_BOOK(my,mu,mv,mr,mg,mb) { \
    int mm_y, mm_yc, mm_u, mm_v, mm_r, mm_g, mm_b; \
    mm_y = (my) - 16;  \
    mm_u = (mu) - 128; \
    mm_v = (mv) - 128; \
    mm_yc= mm_y * 76284; \
    mm_b = (mm_yc		+ 132252*mm_v	) >> 16; \
    mm_g = (mm_yc -  53281*mm_u -  25625*mm_v	) >> 16; \
    mm_r = (mm_yc + 104595*mm_u			) >> 16; \
    mb = LIMIT_RGB(mm_b); \
    mg = LIMIT_RGB(mm_g); \
    mr = LIMIT_RGB(mm_r); \
}


/* Debugging aid */
#define USBVISION_SAY_AND_WAIT(what) { \
	wait_queue_head_t wq; \
	init_waitqueue_head(&wq); \
	printk(KERN_INFO "Say: %s\n", what); \
	interruptible_sleep_on_timeout (&wq, HZ*3); \
}

/*
 * This macro checks if usbvision is still operational. The 'usbvision'
 * pointer must be valid, usbvision->dev must be valid, we are not
 * removing the device and the device has not erred on us.
 */
#define USBVISION_IS_OPERATIONAL(udevice) (\
	(udevice != NULL) && \
	((udevice)->dev != NULL) && \
	((udevice)->last_error == 0) && \
	(!(udevice)->remove_pending))


enum ScanState {
	ScanState_Scanning,	/* Scanning for header */
	ScanState_Lines		/* Parsing lines */
};

/* Completion states of the data parser */
enum ParseState {
	ParseState_Continue,	/* Just parse next item */
	ParseState_NextFrame,	/* Frame done, send it to V4L */
	ParseState_Out,		/* Not enough data for frame */
	ParseState_EndParse	/* End parsing */
};

enum FrameState {
	FrameState_Unused,	/* Unused (no MCAPTURE) */
	FrameState_Ready,	/* Ready to start grabbing */
	FrameState_Grabbing,	/* In the process of being grabbed into */
	FrameState_Done,	/* Finished grabbing, but not been synced yet */
	FrameState_DoneHold,	/* Are syncing or reading */
	FrameState_Error,	/* Something bad happened while processing */
};

enum IsocState {
	IsocState_InFrame,	/* Isoc packet is member of frame */
	IsocState_NoFrame,	/* Isoc packet is not member of any frame */
};

struct usb_device;

struct usbvision_sbuf {
	char *data;
	struct urb *urb;
};

#define USBVISION_MAGIC_1      			0x55
#define USBVISION_MAGIC_2      			0xAA
#define USBVISION_HEADER_LENGTH			0x0c
#define USBVISION_SAA7111_ADDR			0x48
#define USBVISION_SAA7113_ADDR			0x4a
#define USBVISION_IIC_LRACK			0x20
#define USBVISION_IIC_LRNACK			0x30
#define USBVISION_FRAME_FORMAT_PARAM_INTRA	(1<<7)

struct usbvision_v4l2_format_st {
	int		supported;
	int		bytes_per_pixel;
	int		depth;
	int		format;
	char		*desc;
};
#define USBVISION_SUPPORTED_PALETTES ARRAY_SIZE(usbvision_v4l2_format)

struct usbvision_frame_header {
	unsigned char magic_1;				/* 0 magic */
	unsigned char magic_2;				/* 1  magic */
	unsigned char headerLength;			/* 2 */
	unsigned char frameNum;				/* 3 */
	unsigned char framePhase;			/* 4 */
	unsigned char frameLatency;			/* 5 */
	unsigned char dataFormat;			/* 6 */
	unsigned char formatParam;			/* 7 */
	unsigned char frameWidthLo;			/* 8 */
	unsigned char frameWidthHi;			/* 9 */
	unsigned char frameHeightLo;			/* 10 */
	unsigned char frameHeightHi;			/* 11 */
	__u16 frameWidth;				/* 8 - 9 after endian correction*/
	__u16 frameHeight;				/* 10 - 11 after endian correction*/
};

struct usbvision_frame {
	char *data;					/* Frame buffer */
	struct usbvision_frame_header isocHeader;	/* Header from stream */

	int width;					/* Width application is expecting */
	int height;					/* Height */

	int frmwidth;					/* Width the frame actually is */
	int frmheight;					/* Height */

	volatile int grabstate;				/* State of grabbing */
	int scanstate;					/* State of scanning */

	int curline;					/* Line of frame we're working on */

	long scanlength;				/* uncompressed, raw data length of frame */
	long bytes_read;				/* amount of scanlength that has been read from data */
	struct usbvision_v4l2_format_st v4l2_format;	/* format the user needs*/
	int v4l2_linesize;				/* bytes for one videoline*/
        struct timeval timestamp;
	wait_queue_head_t wq;				/* Processes waiting */
	int sequence;					// How many video frames we send to user
};

#define CODEC_SAA7113	7113
#define CODEC_SAA7111	7111
#define BRIDGE_NT1003	1003
#define BRIDGE_NT1004	1004
#define BRIDGE_NT1005   1005

#define USBVISION_I2C_CLIENTS_MAX		8

struct usbvision_device_data_st {
        int idVendor;
        int idProduct;
        int Interface; /* to handle special interface number like BELKIN and Hauppauge WinTV-USB II */
        int Codec;
        int VideoChannels;
        __u64 VideoNorm;
        int AudioChannels;
        int Radio;
        int vbi;
        int Tuner;
        int TunerType;
        int Vin_Reg1;
        int Vin_Reg2;
        int X_Offset;
        int Y_Offset;
        int Dvi_yuv;
        char *ModelString;
};

/* Declared on usbvision-cards.c */
extern struct usbvision_device_data_st usbvision_device_data[];
extern struct usb_device_id usbvision_table[];

struct usb_usbvision {
	struct video_device *vdev;         				/* Video Device */
	struct video_device *rdev;               			/* Radio Device */
	struct video_device *vbi; 					/* VBI Device   */
	struct video_audio audio_dev;	        			/* Current audio params */

	/* i2c Declaration Section*/
	struct i2c_adapter i2c_adap;
	struct i2c_algo_usb_data i2c_algo;
	struct i2c_client i2c_client;
	int i2c_state, i2c_ok;
	struct i2c_client *i2c_clients[USBVISION_I2C_CLIENTS_MAX];

	struct urb *ctrlUrb;
	unsigned char ctrlUrbBuffer[8];
	int ctrlUrbBusy;
	struct usb_ctrlrequest ctrlUrbSetup;
	wait_queue_head_t ctrlUrb_wq;					// Processes waiting
	struct semaphore ctrlUrbLock;

	int have_tuner;
	int tuner_type;
	int bridgeType;							// NT1003, NT1004, NT1005
	int channel;
	int radio;
	int video_inputs;						// # of inputs
	unsigned long freq;
	int AudioMute;
	int AudioChannel;
	int isocMode;							// format of video data for the usb isoc-transfer
	unsigned int nr;						// Number of the device < MAX_USBVISION

	/* Device structure */
	struct usb_device *dev;
	unsigned char iface;						/* Video interface number */
	unsigned char ifaceAltActive, ifaceAltInactive;			/* Alt settings */
	unsigned char Vin_Reg2_Preset;
	struct semaphore lock;
	struct timer_list powerOffTimer;
	struct work_struct powerOffWork;
	int power;							/* is the device powered on? */
	int user;							/* user count for exclusive use */
	int usbvision_used;						/* Is this structure in use? */
	int initialized;						/* Had we already sent init sequence? */
	int DevModel;							/* What type of USBVISION device we got? */
	int streaming;							/* Are we streaming Isochronous? */
	int last_error;							/* What calamity struck us? */
	int curwidth;							/* width of the frame the device is currently set to*/
	int curheight;      						/* height of the frame the device is currently set to*/
	int stretch_width;						/* stretch-factor for frame width (from usb to screen)*/
	int stretch_height;						/* stretch-factor for frame height (from usb to screen)*/
	char *fbuf;							/* Videodev buffer area for mmap*/
	int max_frame_size;						/* Bytes in one video frame */
	int fbuf_size;							/* Videodev buffer size */
	int curFrameNum;						// number of current frame in frame buffer mode
	struct usbvision_frame *curFrame;				// pointer to current frame, set by usbvision_find_header
	struct usbvision_frame frame[USBVISION_NUMFRAMES];		// frame buffer
	int curSbufNum;							// number of current receiving sbuf
	struct usbvision_sbuf sbuf[USBVISION_NUMSBUF];			// S buffering
	volatile int remove_pending;					/* If set then about to exit */

	/* Scratch space from the Isochronous Pipe.*/
	unsigned char *scratch;
	int scratch_read_ptr;
	int scratch_write_ptr;
	int scratch_headermarker[USBVISION_NUM_HEADERMARKER];
	int scratch_headermarker_read_ptr;
	int scratch_headermarker_write_ptr;
	int isocstate;
        /* color controls */
	int saturation;
	int hue;
	int brightness;
        int contrast;
	int depth;
	struct usbvision_v4l2_format_st palette;

	struct v4l2_capability vcap;					/* Video capabilities */
	struct v4l2_input input;					/* May be used for tuner support */
	unsigned char video_endp;					/* 0x82 for USBVISION devices based */

	// Overlay stuff:
        struct v4l2_framebuffer vid_buf;
	struct v4l2_format vid_win;
	int vid_buf_valid;						// Status: video buffer is valid (set)
	int vid_win_valid;						// Status: video window is valid (set)
	int	overlay;						/*Status: Are we overlaying? */
	unsigned int 	clipmask[USBVISION_CLIPMASK_SIZE / 4];
	unsigned char   *overlay_base;					/* Virtual base address of video buffer */
	unsigned char   *overlay_win;					/* virt start address of overlay window */
	struct usbvision_frame overlay_frame;

	// Decompression stuff:
	unsigned char *IntraFrameBuffer;				/* Buffer for reference frame */
	int BlockPos; 							//for test only
	int requestIntra;						// 0 = normal; 1 = intra frame is requested;
	int lastIsocFrameNum;						// check for lost isoc frames
	int isocPacketSize;						// need to calculate usedBandwidth
	int usedBandwidth;						// used bandwidth 0-100%, need to set comprLevel
	int comprLevel;							// How strong (100) or weak (0) is compression
	int lastComprLevel;						// How strong (100) or weak (0) was compression
	int usb_bandwidth;						/* Mbit/s */

	/* /proc entries, relative to /proc/video/usbvision/ */
	struct proc_dir_entry *proc_devdir;		/* Per-device proc directory */
	struct proc_dir_entry *proc_info;		/* <minor#>/info entry */
	struct proc_dir_entry *proc_register;		/* <minor#>/register entry */
	struct proc_dir_entry *proc_freq; 		/* <minor#>/freq entry */ 
	struct proc_dir_entry *proc_input; 		/* <minor#>/input entry */ 
	struct proc_dir_entry *proc_frame;		/* <minor#>/frame entry */
	struct proc_dir_entry *proc_button;		/* <minor#>/button entry */
	struct proc_dir_entry *proc_control;		/* <minor#>/control entry */

	/* Statistics that can be overlayed on the screen */
	unsigned long isocUrbCount;			// How many URBs we received so far
	unsigned long urb_length;			/* Length of last URB */
	unsigned long isocDataCount;			/* How many bytes we received */
	unsigned long header_count;			/* How many frame headers we found */
	unsigned long scratch_ovf_count;		/* How many times we overflowed scratch */
	unsigned long isocSkipCount;			/* How many empty ISO packets received */
	unsigned long isocErrCount;			/* How many bad ISO packets received */
	unsigned long isocPacketCount;			// How many packets we totally got
	unsigned long timeInIrq;			// How long do we need for interrupt
	int isocMeasureBandwidthCount;
	int frame_num;					// How many video frames we send to user
	int maxStripLen;				// How big is the biggest strip
	int comprBlockPos;
	int stripLenErrors;				// How many times was BlockPos greater than StripLen
	int stripMagicErrors;
	int stripLineNumberErrors;
	int ComprBlockTypes[4];
};

#endif									/* __LINUX_USBVISION_H */
Commit	Line	Data
781aa1d1 MCC	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>
6714b012 MCC	30	#include <linux/usb.h>
6714b012 MCC	31	#include "usbvision-i2c.h"
781aa1d1 MCC	32
	33	#ifndef VID_HARDWARE_USBVISION
	34	#define VID_HARDWARE_USBVISION 34 /* USBVision Video Grabber */
	35	#endif
	36
	37	#define USBVISION_PWR_REG 0x00
	38	#define USBVISION_SSPND_EN (1 << 1)
	39	#define USBVISION_RES2 (1 << 2)
	40	#define USBVISION_PWR_VID (1 << 5)
	41	#define USBVISION_E2_EN (1 << 7)
	42	#define USBVISION_CONFIG_REG 0x01
	43	#define USBVISION_ADRS_REG 0x02
	44	#define USBVISION_ALTER_REG 0x03
	45	#define USBVISION_FORCE_ALTER_REG 0x04
	46	#define USBVISION_STATUS_REG 0x05
	47	#define USBVISION_IOPIN_REG 0x06
	48	#define USBVISION_IO_1 (1 << 0)
	49	#define USBVISION_IO_2 (1 << 1)
	50	#define USBVISION_AUDIO_IN 0
	51	#define USBVISION_AUDIO_TV 1
	52	#define USBVISION_AUDIO_RADIO 2
	53	#define USBVISION_AUDIO_MUTE 3
	54	#define USBVISION_SER_MODE 0x07
	55	#define USBVISION_SER_ADRS 0x08
	56	#define USBVISION_SER_CONT 0x09
	57	#define USBVISION_SER_DAT1 0x0A
	58	#define USBVISION_SER_DAT2 0x0B
	59	#define USBVISION_SER_DAT3 0x0C
	60	#define USBVISION_SER_DAT4 0x0D
	61	#define USBVISION_EE_DATA 0x0E
	62	#define USBVISION_EE_LSBAD 0x0F
	63	#define USBVISION_EE_CONT 0x10
	64	#define USBVISION_DRM_CONT 0x12
	65	#define USBVISION_REF (1 << 0)
	66	#define USBVISION_RES_UR (1 << 2)
	67	#define USBVISION_RES_FDL (1 << 3)
	68	#define USBVISION_RES_VDW (1 << 4)
	69	#define USBVISION_DRM_PRM1 0x13
	70	#define USBVISION_DRM_PRM2 0x14
	71	#define USBVISION_DRM_PRM3 0x15
	72	#define USBVISION_DRM_PRM4 0x16
	73	#define USBVISION_DRM_PRM5 0x17
	74	#define USBVISION_DRM_PRM6 0x18
	75	#define USBVISION_DRM_PRM7 0x19
	76	#define USBVISION_DRM_PRM8 0x1A
	77	#define USBVISION_VIN_REG1 0x1B
	78	#define USBVISION_8_422_SYNC 0x01
	79	#define USBVISION_16_422_SYNC 0x02
	80	#define USBVISION_VSNC_POL (1 << 3)
	81	#define USBVISION_HSNC_POL (1 << 4)
	82	#define USBVISION_FID_POL (1 << 5)
	83	#define USBVISION_HVALID_PO (1 << 6)
	84	#define USBVISION_VCLK_POL (1 << 7)
	85	#define USBVISION_VIN_REG2 0x1C
	86	#define USBVISION_AUTO_FID (1 << 0)
	87	#define USBVISION_NONE_INTER (1 << 1)
	88	#define USBVISION_NOHVALID (1 << 2)
	89	#define USBVISION_UV_ID (1 << 3)
	90	#define USBVISION_FIX_2C (1 << 4)
	91	#define USBVISION_SEND_FID (1 << 5)
	92	#define USBVISION_KEEP_BLANK (1 << 7)
	93	#define USBVISION_LXSIZE_I 0x1D
	94	#define USBVISION_MXSIZE_I 0x1E
	95	#define USBVISION_LYSIZE_I 0x1F
96	#define USBVISION_MYSIZE_I 0x20
97	#define USBVISION_LX_OFFST 0x21
98	#define USBVISION_MX_OFFST 0x22
99	#define USBVISION_LY_OFFST 0x23
100	#define USBVISION_MY_OFFST 0x24
101	#define USBVISION_FRM_RATE 0x25
102	#define USBVISION_LXSIZE_O 0x26
103	#define USBVISION_MXSIZE_O 0x27
104	#define USBVISION_LYSIZE_O 0x28
105	#define USBVISION_MYSIZE_O 0x29
106	#define USBVISION_FILT_CONT 0x2A
107	#define USBVISION_VO_MODE 0x2B
108	#define USBVISION_INTRA_CYC 0x2C
109	#define USBVISION_STRIP_SZ 0x2D
110	#define USBVISION_FORCE_INTRA 0x2E
111	#define USBVISION_FORCE_UP 0x2F
112	#define USBVISION_BUF_THR 0x30
113	#define USBVISION_DVI_YUV 0x31
114	#define USBVISION_AUDIO_CONT 0x32
115	#define USBVISION_AUD_PK_LEN 0x33
116	#define USBVISION_BLK_PK_LEN 0x34
117	#define USBVISION_PCM_THR1 0x38
118	#define USBVISION_PCM_THR2 0x39
119	#define USBVISION_DIST_THR_L 0x3A
120	#define USBVISION_DIST_THR_H 0x3B
121	#define USBVISION_MAX_DIST_L 0x3C
122	#define USBVISION_MAX_DIST_H 0x3D
123	#define USBVISION_OP_CODE 0x33
124
125	#define MAX_BYTES_PER_PIXEL 4
126
127	#define MIN_FRAME_WIDTH 64
128	#define MAX_USB_WIDTH 320 //384
129	#define MAX_FRAME_WIDTH 320 //384 /streching sometimes causes crashes/
130
131	#define MIN_FRAME_HEIGHT 48
132	#define MAX_USB_HEIGHT 240 //288
133	#define MAX_FRAME_HEIGHT 240 //288 /Streching sometimes causes crashes/
134
135	#define MAX_FRAME_SIZE (MAX_FRAME_WIDTH * MAX_FRAME_HEIGHT * MAX_BYTES_PER_PIXEL)
136	#define USBVISION_CLIPMASK_SIZE (MAX_FRAME_WIDTH * MAX_FRAME_HEIGHT / 8) //bytesize of clipmask
137
138	#define USBVISION_URB_FRAMES 32
139	#define USBVISION_MAX_ISOC_PACKET_SIZE 959 // NT1003 Specs Document says 1023
140
141	#define USBVISION_NUM_HEADERMARKER 20
142	#define USBVISION_NUMFRAMES 2
143	#define USBVISION_NUMSBUF 2
144
145	#define USBVISION_POWEROFF_TIME 3 * (HZ) // 3 seconds
146
147	/* This macro restricts an int variable to an inclusive range */
148	#define RESTRICT_TO_RANGE(v,mi,ma) { if ((v) < (mi)) (v) = (mi); else if ((v) > (ma)) (v) = (ma); }
149
150	/*
151	* We use macros to do YUV -> RGB conversion because this is
152	* very important for speed and totally unimportant for size.
153	*
154	* YUV -> RGB Conversion
155	* ---------------------
156	*
157	* B = 1.164(Y-16) + 2.018(V-128)
158	* G = 1.164(Y-16) - 0.813(U-128) - 0.391*(V-128)
159	* R = 1.164(Y-16) + 1.596(U-128)
160	*
161	* If you fancy integer arithmetics (as you should), hear this:
162	*
163	* 65536B = 76284(Y-16) + 132252*(V-128)
164	* 65536G = 76284(Y-16) - 53281(U-128) - 25625(V-128)
165	* 65536R = 76284(Y-16) + 104595*(U-128)
166	*
167	* Make sure the output values are within [0..255] range.
168	*/
169	#define LIMIT_RGB(x) (((x) < 0) ? 0 : (((x) > 255) ? 255 : (x)))
170	#define YUV_TO_RGB_BY_THE_BOOK(my,mu,mv,mr,mg,mb) { \
171	int mm_y, mm_yc, mm_u, mm_v, mm_r, mm_g, mm_b; \
172	mm_y = (my) - 16; \
173	mm_u = (mu) - 128; \
174	mm_v = (mv) - 128; \
175	mm_yc= mm_y * 76284; \
176	mm_b = (mm_yc + 132252*mm_v ) >> 16; \
177	mm_g = (mm_yc - 53281mm_u - 25625mm_v ) >> 16; \
178	mm_r = (mm_yc + 104595*mm_u ) >> 16; \
179	mb = LIMIT_RGB(mm_b); \
180	mg = LIMIT_RGB(mm_g); \
181	mr = LIMIT_RGB(mm_r); \
182	}
183
184
185
186	/* Debugging aid */
187	#define USBVISION_SAY_AND_WAIT(what) { \
188	wait_queue_head_t wq; \
189	init_waitqueue_head(&wq); \
190	printk(KERN_INFO "Say: %s\n", what); \
191	interruptible_sleep_on_timeout (&wq, HZ*3); \
192	}
193
194	/*
195	* This macro checks if usbvision is still operational. The 'usbvision'
196	* pointer must be valid, usbvision->dev must be valid, we are not
197	* removing the device and the device has not erred on us.
198	*/
199	#define USBVISION_IS_OPERATIONAL(udevice) (\
200	(udevice != NULL) && \
201	((udevice)->dev != NULL) && \
202	((udevice)->last_error == 0) && \
203	(!(udevice)->remove_pending))
204
205
206	enum ScanState {
207	ScanState_Scanning, /* Scanning for header */
208	ScanState_Lines /* Parsing lines */
209	};
210
211	/* Completion states of the data parser */
212	enum ParseState {
213	ParseState_Continue, /* Just parse next item */
214	ParseState_NextFrame, /* Frame done, send it to V4L */
215	ParseState_Out, /* Not enough data for frame */
216	ParseState_EndParse /* End parsing */
217	};
218
219	enum FrameState {
220	FrameState_Unused, /* Unused (no MCAPTURE) */
221	FrameState_Ready, /* Ready to start grabbing */
222	FrameState_Grabbing, /* In the process of being grabbed into */
223	FrameState_Done, /* Finished grabbing, but not been synced yet */
224	FrameState_DoneHold, /* Are syncing or reading */
225	FrameState_Error, /* Something bad happened while processing */
226	};
227
228	enum IsocState {
229	IsocState_InFrame, /* Isoc packet is member of frame */
230	IsocState_NoFrame, /* Isoc packet is not member of any frame */
231	};
232
233	struct usb_device;
234
235	struct usbvision_sbuf {
236	char *data;
237	struct urb *urb;
238	};
239
240	#define USBVISION_MAGIC_1 0x55
241	#define USBVISION_MAGIC_2 0xAA
242	#define USBVISION_HEADER_LENGTH 0x0c
243	#define USBVISION_SAA7111_ADDR 0x48
244	#define USBVISION_SAA7113_ADDR 0x4a
245	#define USBVISION_IIC_LRACK 0x20
246	#define USBVISION_IIC_LRNACK 0x30
247	#define USBVISION_FRAME_FORMAT_PARAM_INTRA (1<<7)
248
6714b012	249	struct usbvision_v4l2_format_st {
781aa1d1 MCC	250	int supported;
	251	int bytes_per_pixel;
	252	int depth;
	253	int format;
	254	char *desc;
781aa1d1 MCC	255	};
	256	#define USBVISION_SUPPORTED_PALETTES ARRAY_SIZE(usbvision_v4l2_format)
	257
	258	struct usbvision_frame_header {
	259	unsigned char magic_1; /* 0 magic */
	260	unsigned char magic_2; /* 1 magic */
	261	unsigned char headerLength; /* 2 */
	262	unsigned char frameNum; /* 3 */
	263	unsigned char framePhase; /* 4 */
	264	unsigned char frameLatency; /* 5 */
	265	unsigned char dataFormat; /* 6 */
	266	unsigned char formatParam; /* 7 */
	267	unsigned char frameWidthLo; /* 8 */
	268	unsigned char frameWidthHi; /* 9 */
	269	unsigned char frameHeightLo; /* 10 */
	270	unsigned char frameHeightHi; /* 11 */
	271	__u16 frameWidth; /* 8 - 9 after endian correction*/
	272	__u16 frameHeight; /* 10 - 11 after endian correction*/
	273	};
	274
	275	struct usbvision_frame {
	276	char data; / Frame buffer */
	277	struct usbvision_frame_header isocHeader; /* Header from stream */
	278
	279	int width; /* Width application is expecting */
	280	int height; /* Height */
	281
	282	int frmwidth; /* Width the frame actually is */
	283	int frmheight; /* Height */
	284
	285	volatile int grabstate; /* State of grabbing */
	286	int scanstate; /* State of scanning */
	287
	288	int curline; /* Line of frame we're working on */
	289
	290	long scanlength; /* uncompressed, raw data length of frame */
	291	long bytes_read; /* amount of scanlength that has been read from data */
	292	struct usbvision_v4l2_format_st v4l2_format; /* format the user needs*/
	293	int v4l2_linesize; /* bytes for one videoline*/
	294	struct timeval timestamp;
	295	wait_queue_head_t wq; /* Processes waiting */
	296	int sequence; // How many video frames we send to user
	297	};
	298
	299	#define CODEC_SAA7113 7113
	300	#define CODEC_SAA7111 7111
	301	#define BRIDGE_NT1003 1003
	302	#define BRIDGE_NT1004 1004
	303	#define BRIDGE_NT1005 1005
	304
6714b012	305	#define USBVISION_I2C_CLIENTS_MAX 8
781aa1d1	306
6714b012 MCC	307	struct usbvision_device_data_st {
	308	int idVendor;
	309	int idProduct;
	310	int Interface; /* to handle special interface number like BELKIN and Hauppauge WinTV-USB II */
	311	int Codec;
	312	int VideoChannels;
	313	__u64 VideoNorm;
	314	int AudioChannels;
	315	int Radio;
	316	int vbi;
	317	int Tuner;
	318	int TunerType;
	319	int Vin_Reg1;
	320	int Vin_Reg2;
	321	int X_Offset;
	322	int Y_Offset;
	323	int Dvi_yuv;
	324	char *ModelString;
781aa1d1 MCC	325	};
781aa1d1 MCC	326
6714b012 MCC	327	/* Declared on usbvision-cards.c */
	328	extern struct usbvision_device_data_st usbvision_device_data[];
	329	extern struct usb_device_id usbvision_table[];
781aa1d1 MCC	330
	331	struct usb_usbvision {
	332	struct video_device vdev; / Video Device */
	333	struct video_device rdev; / Radio Device */
	334	struct video_device vbi; / VBI Device */
	335	struct video_audio audio_dev; /* Current audio params */
	336
	337	/* i2c Declaration Section*/
	338	struct i2c_adapter i2c_adap;
	339	struct i2c_algo_usb_data i2c_algo;
	340	struct i2c_client i2c_client;
	341	int i2c_state, i2c_ok;
	342	struct i2c_client *i2c_clients[USBVISION_I2C_CLIENTS_MAX];
	343
	344	struct urb *ctrlUrb;
	345	unsigned char ctrlUrbBuffer[8];
	346	int ctrlUrbBusy;
	347	struct usb_ctrlrequest ctrlUrbSetup;
	348	wait_queue_head_t ctrlUrb_wq; // Processes waiting
	349	struct semaphore ctrlUrbLock;
	350
	351	int have_tuner;
	352	int tuner_type;
	353	int bridgeType; // NT1003, NT1004, NT1005
	354	int channel;
	355	int radio;
	356	int video_inputs; // # of inputs
	357	unsigned long freq;
	358	int AudioMute;
	359	int AudioChannel;
	360	int isocMode; // format of video data for the usb isoc-transfer
	361	unsigned int nr; // Number of the device < MAX_USBVISION
	362
	363	/* Device structure */
	364	struct usb_device *dev;
	365	unsigned char iface; /* Video interface number */
	366	unsigned char ifaceAltActive, ifaceAltInactive; /* Alt settings */
	367	unsigned char Vin_Reg2_Preset;
	368	struct semaphore lock;
	369	struct timer_list powerOffTimer;
	370	struct work_struct powerOffWork;
	371	int power; /* is the device powered on? */
	372	int user; /* user count for exclusive use */
	373	int usbvision_used; /* Is this structure in use? */
	374	int initialized; /* Had we already sent init sequence? */
	375	int DevModel; /* What type of USBVISION device we got? */
	376	int streaming; /* Are we streaming Isochronous? */
	377	int last_error; /* What calamity struck us? */
	378	int curwidth; /* width of the frame the device is currently set to*/
	379	int curheight; /* height of the frame the device is currently set to*/
	380	int stretch_width; /* stretch-factor for frame width (from usb to screen)*/
	381	int stretch_height; /* stretch-factor for frame height (from usb to screen)*/
	382	char fbuf; / Videodev buffer area for mmap*/
	383	int max_frame_size; /* Bytes in one video frame */
	384	int fbuf_size; /* Videodev buffer size */
	385	int curFrameNum; // number of current frame in frame buffer mode
	386	struct usbvision_frame *curFrame; // pointer to current frame, set by usbvision_find_header
	387	struct usbvision_frame frame[USBVISION_NUMFRAMES]; // frame buffer
	388	int curSbufNum; // number of current receiving sbuf
	389	struct usbvision_sbuf sbuf[USBVISION_NUMSBUF]; // S buffering
	390	volatile int remove_pending; /* If set then about to exit */
	391
	392	/* Scratch space from the Isochronous Pipe.*/
	393	unsigned char *scratch;
394	int scratch_read_ptr;
395	int scratch_write_ptr;
396	int scratch_headermarker[USBVISION_NUM_HEADERMARKER];
397	int scratch_headermarker_read_ptr;
398	int scratch_headermarker_write_ptr;
399	int isocstate;
400	/* color controls */
401	int saturation;
402	int hue;
403	int brightness;
404	int contrast;
405	int depth;
406	struct usbvision_v4l2_format_st palette;
407
408	struct v4l2_capability vcap; /* Video capabilities */
409	struct v4l2_input input; /* May be used for tuner support */
410	unsigned char video_endp; /* 0x82 for USBVISION devices based */
411
412	// Overlay stuff:
413	struct v4l2_framebuffer vid_buf;
414	struct v4l2_format vid_win;
415	int vid_buf_valid; // Status: video buffer is valid (set)
416	int vid_win_valid; // Status: video window is valid (set)
417	int overlay; /Status: Are we overlaying? /
418	unsigned int clipmask[USBVISION_CLIPMASK_SIZE / 4];
419	unsigned char overlay_base; / Virtual base address of video buffer */
420	unsigned char overlay_win; / virt start address of overlay window */
421	struct usbvision_frame overlay_frame;
422
423	// Decompression stuff:
424	unsigned char IntraFrameBuffer; / Buffer for reference frame */
425	int BlockPos; //for test only
426	int requestIntra; // 0 = normal; 1 = intra frame is requested;
427	int lastIsocFrameNum; // check for lost isoc frames
428	int isocPacketSize; // need to calculate usedBandwidth
429	int usedBandwidth; // used bandwidth 0-100%, need to set comprLevel
430	int comprLevel; // How strong (100) or weak (0) is compression
431	int lastComprLevel; // How strong (100) or weak (0) was compression
432	int usb_bandwidth; /* Mbit/s */
433
434	/* /proc entries, relative to /proc/video/usbvision/ */
435	struct proc_dir_entry proc_devdir; / Per-device proc directory */
436	struct proc_dir_entry proc_info; / <minor#>/info entry */
437	struct proc_dir_entry proc_register; / <minor#>/register entry */
438	struct proc_dir_entry proc_freq; / <minor#>/freq entry */
439	struct proc_dir_entry proc_input; / <minor#>/input entry */
440	struct proc_dir_entry proc_frame; / <minor#>/frame entry */
441	struct proc_dir_entry proc_button; / <minor#>/button entry */
442	struct proc_dir_entry proc_control; / <minor#>/control entry */
443
444	/* Statistics that can be overlayed on the screen */
445	unsigned long isocUrbCount; // How many URBs we received so far
446	unsigned long urb_length; /* Length of last URB */
447	unsigned long isocDataCount; /* How many bytes we received */
448	unsigned long header_count; /* How many frame headers we found */
449	unsigned long scratch_ovf_count; /* How many times we overflowed scratch */
450	unsigned long isocSkipCount; /* How many empty ISO packets received */
451	unsigned long isocErrCount; /* How many bad ISO packets received */
452	unsigned long isocPacketCount; // How many packets we totally got
453	unsigned long timeInIrq; // How long do we need for interrupt
454	int isocMeasureBandwidthCount;
455	int frame_num; // How many video frames we send to user
456	int maxStripLen; // How big is the biggest strip
457	int comprBlockPos;
458	int stripLenErrors; // How many times was BlockPos greater than StripLen
459	int stripMagicErrors;
460	int stripLineNumberErrors;
461	int ComprBlockTypes[4];
462	};
463
464	#endif /* __LINUX_USBVISION_H */
465