patch-2.4.10 linux/drivers/usb/usbvideo.h

• Lines: 425
• Date: Fri Sep 7 09:28:37 2001
• Orig file: v2.4.9/linux/drivers/usb/usbvideo.h
• Orig date: Wed Dec 31 16:00:00 1969

diff -u --recursive --new-file v2.4.9/linux/drivers/usb/usbvideo.h linux/drivers/usb/usbvideo.h
@@ -0,0 +1,424 @@
+/*
+ * 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, 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 usbvideo_h
+#define	usbvideo_h
+
+#include <linux/config.h>
+#include <linux/proc_fs.h>
+#include <linux/videodev.h>
+#include <linux/usb.h>
+
+/* Most helpful debugging aid */
+#define assert(expr) ((void) ((expr) ? 0 : (err("assert failed at line %d",__LINE__))))
+
+#define USES_PROC_FS	(defined(CONFIG_PROC_FS) && defined(CONFIG_VIDEO_PROC_FS))
+#define USBVIDEO_REPORT_STATS	1	/* Set to 0 to block statistics on close */
+
+/* Bit flags (options) */
+#define FLAGS_RETRY_VIDIOCSYNC		(1 << 0)
+#define	FLAGS_MONOCHROME		(1 << 1)
+#define FLAGS_DISPLAY_HINTS		(1 << 2)
+#define FLAGS_OVERLAY_STATS		(1 << 3)
+#define FLAGS_FORCE_TESTPATTERN		(1 << 4)
+#define FLAGS_SEPARATE_FRAMES		(1 << 5)
+#define FLAGS_CLEAN_FRAMES		(1 << 6)
+#define	FLAGS_NO_DECODING		(1 << 7)
+
+/* Bit flags for frames (apply to the frame where they are specified) */
+#define USBVIDEO_FRAME_FLAG_SOFTWARE_CONTRAST	(1 << 0)
+
+/* Camera capabilities (maximum) */
+#define CAMERA_URB_FRAMES       32
+#define CAMERA_MAX_ISO_PACKET   1023 /* 1022 actually sent by camera */
+#define FRAMES_PER_DESC		(CAMERA_URB_FRAMES)
+#define FRAME_SIZE_PER_DESC	(CAMERA_MAX_ISO_PACKET)
+
+/* 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); }
+
+#define V4L_BYTES_PER_PIXEL     3	/* Because we produce RGB24 */
+
+/*
+ * Use this macro to construct constants for different video sizes.
+ * We have to deal with different video sizes that have to be
+ * configured in the device or compared against when we receive
+ * a data. Normally one would define a bunch of VIDEOSIZE_x_by_y
+ * #defines and that's the end of story. However this solution
+ * does not allow to convert between real pixel sizes and the
+ * constant (integer) value that may be used to tag a frame or
+ * whatever. The set of macros below constructs videosize constants
+ * from the pixel size and allows to reconstruct the pixel size
+ * from the combined value later.
+ */
+#define	VIDEOSIZE(x,y)	(((x) & 0xFFFFL) | (((y) & 0xFFFFL) << 16))
+#define	VIDEOSIZE_X(vs)	((vs) & 0xFFFFL)
+#define	VIDEOSIZE_Y(vs)	(((vs) >> 16) & 0xFFFFL)
+typedef unsigned long videosize_t;
+
+/*
+ * This macro checks if the camera is still operational. The 'uvd'
+ * pointer must be valid, uvd->dev must be valid, we are not
+ * removing the device and the device has not erred on us.
+ */
+#define CAMERA_IS_OPERATIONAL(uvd) (\
+	(uvd != NULL) && \
+	((uvd)->dev != NULL) && \
+	((uvd)->last_error == 0) && \
+	(!(uvd)->remove_pending))
+
+/*
+ * 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); \
+}
+
+#define	RING_QUEUE_ADVANCE_INDEX(rq,ind,n) (rq)->ind = ((rq)->ind + (n)) % (rq)->length
+#define	RING_QUEUE_DEQUEUE_BYTES(rq,n) RING_QUEUE_ADVANCE_INDEX(rq,ri,n)
+#define	RING_QUEUE_PEEK(rq,ofs) ((rq)->queue[((ofs) + (rq)->ri) % (rq)->length])
+
+typedef struct {
+	unsigned char *queue;	/* Data from the Isoc data pump */
+	int length;		/* How many bytes allocated for the queue */
+	int wi;			/* That's where we write */
+	int ri;			/* Read from here until you hit write index */
+	wait_queue_head_t wqh;	/* Processes waiting */
+} RingQueue_t;
+
+typedef enum {
+	ScanState_Scanning,	/* Scanning for header */
+	ScanState_Lines		/* Parsing lines */
+} ScanState_t;
+
+/* Completion states of the data parser */
+typedef enum {
+	scan_Continue,		/* Just parse next item */
+	scan_NextFrame,		/* Frame done, send it to V4L */
+	scan_Out,		/* Not enough data for frame */
+	scan_EndParse		/* End parsing */
+} ParseState_t;
+
+typedef enum {
+	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_Done_Hold,	/* Are syncing or reading */
+	FrameState_Error,	/* Something bad happened while processing */
+} FrameState_t;
+
+/*
+ * Some frames may contain only even or odd lines. This type
+ * specifies what type of deinterlacing is required.
+ */
+typedef enum {
+	Deinterlace_None=0,
+	Deinterlace_FillOddLines,
+	Deinterlace_FillEvenLines
+} Deinterlace_t;
+
+struct usb_device;
+
+#define USBVIDEO_NUMFRAMES	2	/* How many frames we work with */
+#define USBVIDEO_NUMSBUF	2	/* How many URBs linked in a ring */
+
+/* This structure represents one Isoc request - URB and buffer */
+typedef struct {
+	char *data;
+	urb_t *urb;
+} usbvideo_sbuf_t;
+
+typedef struct {
+	char *data;		/* Frame buffer */
+	unsigned long header;	/* Significant bits from the header */
+
+	videosize_t canvas;	/* The canvas (max. image) allocated */
+	videosize_t request;	/* That's what the application asked for */
+	unsigned short palette;	/* The desired format */
+
+	FrameState_t frameState;/* State of grabbing */
+	ScanState_t scanstate;	/* State of scanning */
+	Deinterlace_t deinterlace;
+	int flags;		/* USBVIDEO_FRAME_FLAG_xxx bit flags */
+
+	int curline;		/* Line of frame we're working on */
+
+	long seqRead_Length;	/* Raw data length of frame */
+	long seqRead_Index;	/* Amount of data that has been already read */
+
+	void *user;		/* Additional data that user may need */
+} usbvideo_frame_t;
+
+/* Statistics that can be overlaid on screen */
+typedef struct {
+        unsigned long frame_num;	/* Sequential number of the frame */
+        unsigned long urb_count;        /* How many URBs we received so far */
+        unsigned long urb_length;       /* Length of last URB */
+        unsigned long data_count;       /* How many bytes we received */
+        unsigned long header_count;     /* How many frame headers we found */
+	unsigned long iso_skip_count;	/* How many empty ISO packets received */
+	unsigned long iso_err_count;	/* How many bad ISO packets received */
+} usbvideo_statistics_t;
+
+struct s_usbvideo_t;
+
+typedef struct {
+	struct video_device vdev;	/* Must be the first field! */
+	struct usb_device *dev;
+	struct s_usbvideo_t *handle;	/* Points back to the usbvideo_t */
+	void *user_data;		/* Camera-dependent data */
+	int user_size;			/* Size of that camera-dependent data */
+	int debug;			/* Debug level for usbvideo */
+	unsigned char iface;		/* Video interface number */
+	unsigned char video_endp;
+	unsigned char ifaceAltActive;
+	unsigned char ifaceAltInactive; /* Alt settings */
+	unsigned long flags;		/* FLAGS_USBVIDEO_xxx */
+	unsigned long paletteBits;	/* Which palettes we accept? */
+	unsigned short defaultPalette;	/* What palette to use for read() */
+	struct semaphore lock;
+	int user;		/* user count for exclusive use */
+
+	videosize_t videosize;	/* Current setting */
+	videosize_t canvas;	/* This is the width,height of the V4L canvas */
+	int max_frame_size;	/* Bytes in one video frame */
+
+	int uvd_used;        	/* Is this structure in use? */
+	int streaming;		/* Are we streaming Isochronous? */
+	int grabbing;		/* Are we grabbing? */
+	int settingsAdjusted;	/* Have we adjusted contrast etc.? */
+	int last_error;		/* What calamity struck us? */
+
+	char *fbuf;		/* Videodev buffer area */
+	int fbuf_size;		/* Videodev buffer size */
+
+	int curframe;
+	int iso_packet_len;	/* Videomode-dependent, saves bus bandwidth */
+
+	RingQueue_t dp;		/* Isoc data pump */
+	usbvideo_frame_t frame[USBVIDEO_NUMFRAMES];
+	usbvideo_sbuf_t sbuf[USBVIDEO_NUMSBUF];
+
+	volatile int remove_pending;	/* If set then about to exit */
+
+	struct video_picture vpic, vpic_old;	/* Picture settings */
+	struct video_capability vcap;		/* Video capabilities */
+	struct video_channel vchan;	/* May be used for tuner support */
+	usbvideo_statistics_t stats;
+	struct proc_dir_entry *procfs_vEntry;	/* /proc/video/MYDRIVER/video2 */
+	char videoName[32];		/* Holds name like "video7" */
+} uvd_t;
+
+/*
+ * usbvideo callbacks (virtual methods). They are set when usbvideo
+ * services are registered. All of these default to NULL, except those
+ * that default to usbvideo-provided methods.
+ */
+typedef struct {
+#if defined(usb_device_id_ver)
+	/* New style probe (for 2.4.x kernels with hotplugging) */
+	void *(*probe)(struct usb_device *, unsigned int,const struct usb_device_id *);
+#else
+	/* Old style probe (for 2.2.x kernels) */
+	void *(*probe)(struct usb_device *, unsigned int);
+#endif
+	void (*userFree)(uvd_t *);
+	void (*disconnect)(struct usb_device *, void *);
+	int (*setupOnOpen)(uvd_t *);
+	void (*videoStart)(uvd_t *);
+	void (*videoStop)(uvd_t *);
+	void (*processData)(uvd_t *, usbvideo_frame_t *);
+	void (*postProcess)(uvd_t *, usbvideo_frame_t *);
+	void (*adjustPicture)(uvd_t *);
+	int (*getFPS)(uvd_t *);
+	int (*overlayHook)(uvd_t *, usbvideo_frame_t *);
+	int (*getFrame)(uvd_t *, int);
+	int (*procfs_read)(char *page,char **start,off_t off,int count,int *eof,void *data);
+	int (*procfs_write)(struct file *file,const char *buffer,unsigned long count,void *data);
+} usbvideo_cb_t;
+
+struct s_usbvideo_t {
+	int num_cameras;		/* As allocated */
+	struct usb_driver usbdrv;	/* Interface to the USB stack */
+	char drvName[80];		/* Driver name */
+	struct semaphore lock;		/* Mutex protecting camera structures */
+	usbvideo_cb_t cb;		/* Table of callbacks (virtual methods) */
+	struct video_device vdt;	/* Video device template */
+	uvd_t *cam;			/* Array of camera structures */
+	int uses_procfs;		/* Non-zero if we create /proc entries */
+	struct proc_dir_entry *procfs_dEntry;	/* /proc/video/MYDRIVER */
+	struct module *md_module;	/* Minidriver module */
+};
+typedef struct s_usbvideo_t usbvideo_t;
+
+/*
+ * This macro retrieves callback address from the uvd_t object.
+ * No validity checks are done here, so be sure to check the
+ * callback beforehand with VALID_CALLBACK.
+ */
+#define	GET_CALLBACK(uvd,cbName) ((uvd)->handle->cb.cbName)
+
+/*
+ * This macro returns either callback pointer or NULL. This is safe
+ * macro, meaning that most of components of data structures involved
+ * may be NULL - this only results in NULL being returned. You may
+ * wish to use this macro to make sure that the callback is callable.
+ * However keep in mind that those checks take time.
+ */
+#define	VALID_CALLBACK(uvd,cbName) ((((uvd) != NULL) && \
+		((uvd)->handle != NULL)) ? GET_CALLBACK(uvd,cbName) : NULL)
+
+void RingQueue_Initialize(RingQueue_t *rq);
+void RingQueue_Allocate(RingQueue_t *rq, int rqLen);
+int  RingQueue_IsAllocated(const RingQueue_t *rq);
+void RingQueue_Free(RingQueue_t *rq);
+int  RingQueue_Dequeue(RingQueue_t *rq, unsigned char *dst, int len);
+int  RingQueue_Enqueue(RingQueue_t *rq, const unsigned char *cdata, int n);
+int  RingQueue_GetLength(const RingQueue_t *rq);
+void RingQueue_InterruptibleSleepOn(RingQueue_t *rq);
+void RingQueue_WakeUpInterruptible(RingQueue_t *rq);
+
+void usbvideo_CollectRawData(uvd_t *uvd, usbvideo_frame_t *frame);
+void usbvideo_DrawLine(
+	usbvideo_frame_t *frame,
+	int x1, int y1,
+	int x2, int y2,
+	unsigned char cr, unsigned char cg, unsigned char cb);
+void usbvideo_HexDump(const unsigned char *data, int len);
+void usbvideo_OverlayChar(uvd_t *uvd, usbvideo_frame_t *frame, int x, int y, int ch);
+void usbvideo_OverlayString(uvd_t *uvd, usbvideo_frame_t *frame, int x, int y, const char *str);
+void usbvideo_OverlayStats(uvd_t *uvd, usbvideo_frame_t *frame);
+void usbvideo_ReportStatistics(const uvd_t *uvd);
+void usbvideo_SayAndWait(const char *what);
+void usbvideo_TestPattern(uvd_t *uvd, int fullframe, int pmode);
+void usbvideo_VideosizeToString(char *buf, int bufLen, videosize_t vs);
+
+/* Memory allocation routines */
+unsigned long usbvideo_uvirt_to_kva(pgd_t *pgd, unsigned long adr);
+unsigned long usbvideo_uvirt_to_bus(unsigned long adr);
+unsigned long usbvideo_kvirt_to_bus(unsigned long adr);
+unsigned long usbvideo_kvirt_to_pa(unsigned long adr);
+void *usbvideo_rvmalloc(unsigned long size);
+void usbvideo_rvfree(void *mem, unsigned long size);
+
+int usbvideo_register(
+	usbvideo_t **pCams,
+	const int num_cams,
+	const int num_extra,
+	const char *driverName,
+	const usbvideo_cb_t *cbTable,
+	struct module *md);
+uvd_t *usbvideo_AllocateDevice(usbvideo_t *cams);
+int usbvideo_RegisterVideoDevice(uvd_t *uvd);
+void usbvideo_Deregister(usbvideo_t **uvt);
+void usbvideo_Disconnect(struct usb_device *dev, void *ptr);
+void usbvideo_CameraRelease(uvd_t *uvd);
+
+void usbvideo_v4l_close(struct video_device *dev);
+int usbvideo_v4l_initialize(struct video_device *dev);
+int usbvideo_v4l_ioctl(struct video_device *dev, unsigned int cmd, void *arg);
+int usbvideo_v4l_mmap(struct video_device *dev, const char *adr, unsigned long size);
+int usbvideo_v4l_open(struct video_device *dev, int flags);
+long usbvideo_v4l_read(struct video_device *dev, char *buf,
+			unsigned long count, int noblock);
+long usbvideo_v4l_write(struct video_device *dev, const char *buf,
+			unsigned long count, int noblock);
+
+int usbvideo_GetFrame(uvd_t *uvd, int frameNum);
+int usbvideo_NewFrame(uvd_t *uvd, int framenum);
+int usbvideo_StartDataPump(uvd_t *uvd);
+void usbvideo_StopDataPump(uvd_t *uvd);
+void usbvideo_DeinterlaceFrame(uvd_t *uvd, usbvideo_frame_t *frame);
+void usbvideo_SoftwareContrastAdjustment(uvd_t *uvd, usbvideo_frame_t *frame);
+
+/*
+ * This code performs bounds checking - use it when working with
+ * new formats, or else you may get oopses all over the place.
+ * If pixel falls out of bounds then it gets shoved back (as close
+ * to place of offence as possible) and is painted bright red.
+ *
+ * There are two important concepts: frame width, height and
+ * V4L canvas width, height. The former is the area requested by
+ * the application -for this very frame-. The latter is the largest
+ * possible frame that we can serve (we advertise that via V4L ioctl).
+ * The frame data is expected to be formatted as lines of length
+ * VIDEOSIZE_X(fr->request), total VIDEOSIZE_Y(frame->request) lines.
+ */
+static inline void RGB24_PUTPIXEL(
+	usbvideo_frame_t *fr,
+	int ix, int iy,
+	unsigned char vr,
+	unsigned char vg,
+	unsigned char vb)
+{
+	register unsigned char *pf;
+	int limiter = 0, mx, my;
+	mx = ix;
+	my = iy;
+	if (mx < 0) {
+		mx=0;
+		limiter++;
+	} else if (mx >= VIDEOSIZE_X((fr)->request)) {
+		mx= VIDEOSIZE_X((fr)->request) - 1;
+		limiter++;
+	}
+	if (my < 0) {
+		my = 0;
+		limiter++;
+	} else if (my >= VIDEOSIZE_Y((fr)->request)) {
+		my = VIDEOSIZE_Y((fr)->request) - 1;
+		limiter++;
+	}
+	pf = (fr)->data + V4L_BYTES_PER_PIXEL*((iy)*VIDEOSIZE_X((fr)->request) + (ix));
+	if (limiter) {
+		*pf++ = 0;
+		*pf++ = 0;
+		*pf++ = 0xFF;
+	} else {
+		*pf++ = (vb);
+		*pf++ = (vg);
+		*pf++ = (vr);
+	}
+}
+
+#endif /* usbvideo_h */