spca5xx.h

凌阳SPCA5XX解码芯片USB驱动源代码

#ifndef SPCA50X_H
#define SPCA50X_H

/*
 * Header file for SPCA50x based camera driver. Originally copied from ov511 driver.
 * Originally by Mark W. McClelland
 * SPCA50x version by Joel Crisp; all bugs are mine, all nice features are his.
 */

#ifdef __KERNEL__
#include <asm/uaccess.h>
#include <linux/videodev.h>
#include <linux/smp_lock.h>
#include <linux/usb.h>
/*
 *      tq_scheduler disappeared @ lk-2.4.0-test12
 *      (right when <linux/sched.h> newly defined TQ_ACTIVE)
 *
 *      (snagged from linux/drivers/message/fusion/mptscsih.h)
 *
 */

#if LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0) 
#define HAVE_TQ_SCHED 1
#if LINUX_VERSION_CODE >= KERNEL_VERSION(2,4,0) 
#       include <linux/sched.h>
#       ifdef TQ_ACTIVE
#               undef HAVE_TQ_SCHED
#       endif /* TQ_ACTIVE */
#endif /* LINUX_VERSION_CODE >= KERNEL_VERSION(2,4,0) */
#ifdef HAVE_TQ_SCHED
#define SCHEDULE_TASK(x)                \
	/*MOD_INC_USE_COUNT*/;          \
	(x)->next = NULL;               \
	queue_task(x, &tq_scheduler)
#else /* HAVE_TQ_SCHED */
#define SCHEDULE_TASK(x)                \
	/*MOD_INC_USE_COUNT*/;          \
	if (schedule_task(x) == 0) {    \
		/*MOD_DEC_USE_COUNT*/;  \
	}
#endif /* HAVE_TQ_SCHED */
#endif 
#if LINUX_VERSION_CODE > KERNEL_VERSION(2,5,41)
# include <linux/workqueue.h>
# define tq_struct work_struct 
# define INIT_TQUEUE INIT_WORK
//# define schedule_task schedule_work 
# define SCHEDULE_TASK schedule_work
#else
# include <linux/tqueue.h>
#endif

#if LINUX_VERSION_CODE >= KERNEL_VERSION(2,4,20) && LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0)

#define urb_t struct urb
#endif /* LINUX_VERSION_CODE >= KERNEL_VERSION(2,4,20) */

//static const char SPCA50X_H_CVS_VERSION[]="$Id: spca50x.h,v 1.28 2004/01/10 21:37:40 mxhaard Exp $";

/* V4L API extension for raw JPEG (=JPEG without header) and JPEG with header   
 */
#define VIDEO_PALETTE_RAW_JPEG  20
#define VIDEO_PALETTE_JPEG 21

#ifdef SPCA50X_ENABLE_DEBUG

#  define PDEBUG(level, fmt, args...) \
if (debug >= level) info("[%s:%d] " fmt, __PRETTY_FUNCTION__, __LINE__ , ## args)
#else /* SPCA50X_ENABLE_DEBUG */
#  define PDEBUG(level, fmt, args...) do {} while(0)
#endif /* SPCA50X_ENABLE_DEBUG */

#define FRAMES_PER_DESC		10	/* Default value, should be reasonable */
#define MAX_FRAME_SIZE_PER_DESC 1024

#define SPCA50X_MAX_WIDTH 640
#define SPCA50X_MAX_HEIGHT 480

#define SPCA50X_ENDPOINT_ADDRESS 1	/* Isoc endpoint number */

#define SPCA50X_NUMFRAMES	4
#define SPCA50X_NUMSBUF	2

#define BRIDGE_SPCA505 0
#define BRIDGE_SPCA506 1
#define BRIDGE_SPCA501 2
#define BRIDGE_SPCA508 3
#define BRIDGE_SPCA504 4
#define BRIDGE_SPCA500 5
#define BRIDGE_SPCA504B 6
#define BRIDGE_SPCA533 7
#define BRIDGE_SPCA504_PCCAM600 8
#define BRIDGE_SPCA561 9
#define BRIDGE_SPCA536 10
#define BRIDGE_SONIX 11
#define BRIDGE_ZC3XX 12
#define BRIDGE_CX11646 13
#define BRIDGE_TV8532 14
#define BRIDGE_ETOMS 15
#define BRIDGE_SN9C102P 16

#define SENSOR_SAA7113 0
#define SENSOR_INTERNAL 1
#define SENSOR_HV7131B  2
#define SENSOR_HDCS1020 3
#define SENSOR_PB100_BA 4
#define SENSOR_PB100_92	5
#define SENSOR_PAS106_80 6
#define SENSOR_TAS5130C 7
#define SENSOR_ICM105A 8
#define SENSOR_HDCS2020 9
#define SENSOR_PAS106 10
#define SENSOR_PB0330 11
#define SENSOR_HV7131C 12
#define SENSOR_CS2102 13
#define SENSOR_HDCS2020b 14
#define SENSOR_HV7131R 15

/* Alternate interface transfer sizes */
#define SPCA50X_ALT_SIZE_0       0
#define SPCA50X_ALT_SIZE_128     1
#define SPCA50X_ALT_SIZE_256     1
#define SPCA50X_ALT_SIZE_384     2
#define SPCA50X_ALT_SIZE_512     3
#define SPCA50X_ALT_SIZE_640     4
#define SPCA50X_ALT_SIZE_768     5
#define SPCA50X_ALT_SIZE_896     6
#define SPCA50X_ALT_SIZE_1023    7

/* Sequence packet identifier for a dropped packet */
#define SPCA50X_SEQUENCE_DROP 0xFF

/* Type bit for 10 byte header snapshot flag */
#define SPCA50X_SNAPBIT 0x40
#define SPCA50X_SNAPCTRL 0x80

/* Offsets into the 10 byte header on the first ISO packet */
#define SPCA50X_OFFSET_SEQUENCE 0

/* Generic frame packet header offsets */
#define SPCA50X_OFFSET_TYPE     1
#define SPCA50X_OFFSET_COMPRESS 2
#define SPCA50X_OFFSET_THRESHOLD 3
#define SPCA50X_OFFSET_QUANT 4
#define SPCA50X_OFFSET_QUANT2 5
#define SPCA50X_OFFSET_FRAMSEQ 6
#define SPCA50X_OFFSET_EDGE_AUDIO 7
#define SPCA50X_OFFSET_GPIO 8
#define SPCA50X_OFFSET_RESERVED 9
#define SPCA50X_OFFSET_DATA 10

/* Bitmask for properties at offsets above */
#define SPCA50X_PROP_COMP_ENABLE(d) ( (d) & 1 )
#define SPCA50X_PROP_SNAP(d) ( (d) & SPCA50X_SNAPBIT )
#define SPCA50X_PROP_SNAP_CTRL(d) ( (d) & SPCA50X_SNAPCTRL )
#define SPCA50X_PROP_COMP_T3A(d) ( ((d) & 0xA ) >> 2)
#define SPCA50X_PROP_COMP_T3D(d) ( ((d) & 0x70 ) >> 4)

/* USB control */
#define SPCA50X_REG_USB 0x2
#define SPCA50X_USB_CTRL 0x0
#define SPCA50X_CUSB_ENABLE 0x1
#define SPCA50X_CUSB_PREFETCH 0x2


/* Global control register */
#define SPCA50X_REG_GLOBAL 0x3

#define SPCA50X_GLOBAL_MISC0 0x0 // Global control miscellaneous 0
#define SPCA50X_GMISC0_IDSEL 0x1 // Global control device ID select
#define SPCA50X_GMISC0_EXTTXEN 0x2 // Global control USB Transceiver select

#define SPCA50X_GLOBAL_MISC1 0x1
#define SPCA50X_GMISC1_BLKUSBRESET 0x1
#define SPCA50X_GMISC1_BLKSUSPEND 0x2
#define SPCA50X_GMISC1_DRAMOUTEN 0x10
#define SPCA50X_GMISC1_INTRAMCRTEN 0x20

#define SPCA50X_GLOBAL_MISC2 0x2

#define SPCA50X_GLOBAL_MISC3 0x3
#define SPCA50X_GMISC3_SSC 0x1
#define SPCA50X_GMISC3_SSD 0x2
#define SPCA50X_GMISC3_SAA7113RST 0x20 /* Not sure about this one */

#define SPCA50X_GLOBAL_MISC4 0x4
#define SPCA50X_GMISC4_SSCEN 0x1
#define SPCA50X_GMISC4_SSDEN 0x2

#define SPCA50X_GLOBAL_MISC5 0x5
#define SPCA50X_GMISC5_SSD 0x2

#define SPCA50X_GLOBAL_MISC6 0x6

/* Image format and compression control */
#define SPCA50X_REG_COMPRESS 0x4

#define SPCA50X_COMPRESS_MISC1 0x1
#define SPCA50X_CMISC1_TVFIELDPROCESS 0x40

#define SPCA50X_COMPRESS_ENABLE 0x8
#define SPCA50X_CENABLE_ENABLE 0x1

/* SAA 7113 */
/* TV control register */
#define SPCA50X_REG_TV 0x8

#define SPCA50X_TV_MISC0 0x0
#define SPCA50X_TMISC0_PAL 0x1
#define SPCA50X_TMISC0_SINGLECHANNEL 0x2
#define SPCA50X_TMISC0_EXTFIELD 0x4
#define SPCA50X_TMISC0_INVFIELD 0x8
#define SPCA50X_TMISC0_PIXSEL 0x30 /* Not sure what this does */
#define SPCA50x_TMISC0_ADD128 0x80

/* I2C interface on an SPCA505, SPCA506, SPCA508 */
#define SPCA50X_REG_I2C_CTRL 0x7
#define SPCA50X_I2C_DEVICE 0x4
#define SPCA50X_I2C_SUBADDR 0x1
#define SPCA50X_I2C_VALUE 0x0
#define SPCA50X_I2C_TRIGGER 0x2
#define SPCA50X_I2C_TRIGGER_BIT 0x1
#define SPCA50X_I2C_READ 0x0
#define SPCA50X_I2C_STATUS 0x3

#define SAA7113_REG_STATUS 0x1f

#define SAA7113_I2C_BASE_WRITE 0x4A
#define SAA7113_I2C_BASE_READ 0x4A /* SPCA50x seems to add the read bit itself */
#define SAA7113_I2C_ALT_BASE_WRITE 0x48
#define SAA7113_I2C_ALT_BASE_READ 0x48 /* SPCA50x seems to add the read bit itself */




#define SAA7113_STATUS_READY(d) (d & 0x1)
#define SAA7113_STATUS_COPRO(d) (d & 0x2)
#define SAA7113_STATUS_WIPA(d)  (d & 0x4)
#define SAA7113_STATUS_GLIMB(d) (d & 0x8)
#define SAA7113_STATUS_GLIMT(d) (d & 0x10)
#define SAA7113_STATUS_FIDT(d)  (d & 0x20)
#define SAA7113_STATUS_HLVLN(d) (d & 0x40)
#define SAA7113_STATUS_INTL(d) (d & 0x80)



/* Scratch buffer for 2 lines of YUV data */
#define SCRATCH_BUF_SIZE 3*SPCA50X_MAX_WIDTH

/* Brightness autoadjustment parameters*/
#define NSTABLE_MAX 4
#define NUNSTABLE_MAX 600
#define MIN_BRIGHTNESS 10

/* Camera type jpeg yuvy yyuv yuyv grey gbrg*/
enum {  
	JPEG = 0,
	JPGH,
	JPGC,
	JPGS,
	YUVY,
	YYUV,
	YUYV,
	GREY,
	GBRG,
	SN9C,
	GBGR,
};

/* State machine for each frame in the frame buffer during capture */
enum {
	STATE_SCANNING,		/* Scanning for start */
	STATE_HEADER,		/* Parsing header */
	STATE_LINES,		/* Parsing lines */
};

/* Buffer states */
enum {
	BUF_NOT_ALLOCATED,
	BUF_ALLOCATED,
	BUF_PEND_DEALLOC,	/* spca50x->buf_timer is set */
};

struct usb_device;

/* One buffer for the USB ISO transfers */
struct spca50x_sbuf {
	char       *data;
	struct urb *urb;
};

/* States for each frame buffer. */
enum {
	FRAME_UNUSED,		/* Unused (no MCAPTURE) */
	FRAME_READY,		/* Ready to start grabbing */
	FRAME_GRABBING,		/* In the process of being grabbed into */
	FRAME_DONE,		/* Finished grabbing, but not been synced yet */
	FRAME_ERROR,		/* Something bad happened while processing */
	FRAME_ABORTING,         /* Aborting everything. Caused by hot unplugging.*/

};
struct pictparam {
	 int change;
	 int force_rgb;
         int gamma ;
	 int OffRed ;
	 int OffBlue;
	 int OffGreen;
	 int GRed ;
	 int GBlue ;
	 int GGreen ;
	};
	
struct spca50x_frame {
	unsigned char *data;		/* Frame buffer */
	unsigned char *tmpbuffer;	/* temporary buffer spca50x->tmpbuffer need for decoding*/
	/* Memory allocation for the jpeg decoders */
	int dcts[6*64+16];
	int out[6*64];
	int max[6];
	/*******************************************/
	int seq;                /* Frame sequence number */
	int depth;		/* Bytes per pixel */
	int width;		/* Width application is expecting */
	int height;		/* Height */

	int hdrwidth;		/* Width the frame actually is */
	int hdrheight;		/* Height */
	int method;		/* The decoding method for that frame 0 nothing 1 crop 2 div 4 mult */
	int cropx1;		/* value to be send with the frame for decoding feature */
	int cropx2;
	int cropy1;
	int cropy2;
	int x;
	int y;
	
	unsigned int format;	/* Format asked by apps for this frame */
	int cameratype;		/* native in frame format */
	struct pictparam pictsetting;
	volatile int grabstate;	/* State of grabbing */
	int scanstate;		/* State of scanning */
	
	long scanlength;	/* uncompressed, raw data length of frame */
	int totlength;		/* length of the current reading byte in the Iso stream */

	wait_queue_head_t wq;	/* Processes waiting */

	int snapshot;		/* True if frame was a snapshot */
	int last_packet;        /* sequence number for last packet */
	unsigned char *highwater; /* used for debugging */
	
};


struct usb_spca50x {
	struct video_device *vdev;
	struct tq_struct task; /* task structure for scheduling bh */
	char bh_requested; /* if bottom half processing requested */
	
	/* Device structure */
	struct usb_device *dev;
	
	int customid;
	int desc;
	int ccd; /* If true, using the CCD otherwise the external input */
	unsigned char iface;
	int alt;
	/* Determined by sensor type */
	int maxwidth;
	int maxheight;
	int minwidth;
	int minheight;
	/* What we think the hardware is currently set to */
	/* Not sure the 50x supports all of these */
	int brightness;
	int colour;
	int contrast;
	int hue;
	int whiteness;
	
	struct semaphore lock;
	int user;		/* user count for exclusive use */
	int present;		/* driver loaded */
	
	int streaming;		/* Are we streaming Isochronous? */
	int grabbing;		/* Are we grabbing? */
	int packet;
	int compress;		/* Should the next frame be compressed? */
	
	char *fbuf;		/* Videodev buffer area */
	
	int curframe;		/* Current receiving frame buffer */
	struct spca50x_frame frame[SPCA50X_NUMFRAMES];
	
	int cursbuf;		/* Current receiving sbuf */
	struct spca50x_sbuf sbuf[SPCA50X_NUMSBUF];
	
	/* Scratch space from the Isochronous pipe */
	unsigned char scratch[SCRATCH_BUF_SIZE];
	int scratchlen;
	
	wait_queue_head_t wq;	/* Processes waiting */
	
	int snap_enabled;	/* Snapshot mode enabled */
	
	int bridge;		/* Type of bridge (BRIDGE_SPCA505 or BRIDGE_SPCA506) */
	int sensor;		/* Type of image sensor chip */
	
	int packet_size;	/* Frame size per isoc desc */
	
				/* proc interface */
	struct semaphore param_lock;	/* params lock for this camera */
	struct proc_dir_entry *proc_entry;	/* /proc/spca50x/videoX */
	struct proc_dir_entry *ctl_proc_entry;	/* /proc/spca50x/controlX */
#ifdef SPCA50X_ENABLE_RAWPROCENTRY
	struct proc_dir_entry *raw_proc_entry;  /* /proc/spca50x/rawX */
	char   *rawBuffer;
	size_t rawBufferSize;
	size_t rawBufferMax;
#endif /* SPCA50X_ENABLE_RAWPROCENTRY */

	/* Temporary jpeg decoder workspace */
	char   *tmpBuffer;

	/* Framebuffer/sbuf management */
	int buf_state;
	struct semaphore buf_lock;
	struct timer_list buf_timer;
	struct timer_list frame_timer;
	
	int width; /* use here for the init of each frame */
	int height;
	int hdrwidth;
	int hdrheight;
	int method; /* method ask for output pict */
	int mode;
	int cameratype;		/* native in frame format */
	__u16 norme; /* norme in use Pal Ntsc Secam */
	__u16 channel; /* input composite video1 or svideo */
	struct pictparam pictsetting;
	int pipe_size; // requested pipe size set according to mode
	int header_len;
	int lastFrameRead;
	/* Statistics variables */
	int avg_lum; //The average luminance (realized for spca501 only)

	uint i2c_ctrl_reg; // Camera I2C control register
	uint i2c_base;     // Camera I2C address base
	char i2c_trigger_on_write; //do trigger bit on write
	
	__u8 force_rgb; //Read RGB instead of BGR
	__u8 min_bpp; //The minimal color depth that may be set
	__u8 lum_level; //Luminance level for brightness autoadjustment
#ifdef SPCA50X_ENABLE_EXPERIMENTAL
	uint nstable; // the stable condition counter
	uint nunstable; // the unstable position counter
    
	__u8 a_red, a_green, a_blue; //initial values of color corrections params.
	int avg_bg, avg_rg; //The average B-G and R-G for white balancing 
#endif /* SPCA50X_ENABLE_EXPERIMENTAL */
};

struct cam_list {
	int id;
	const char *description;
};

struct palette_list {
	int num;
	const char *name;
};

struct bridge_list {
	int num;
	const char *name;
};

struct mode_list {
	int width;
	int height;
	int color;		/* 0=grayscale, 1=color */
	u8 pxcnt;		/* pixel counter */
	u8 lncnt;		/* line counter */
	u8 pxdv;		/* pixel divisor */
	u8 lndv;		/* line divisor */
	u8 m420;
	u8 common_A;
	u8 common_L;
};

#endif /* __KERNEL__ */

/* Additional IOCTL numbers */
struct spca50x_params
{
	__u16 request;
	__u16 address;
	__u16 value;
};
#endif /* SPCA50X_H */