[linux-2.6-block.git] / drivers / media / video / w9968cf.h

/***************************************************************************
 * Video4Linux driver for W996[87]CF JPEG USB Dual Mode Camera Chip.       *
 *                                                                         *
 * Copyright (C) 2002-2004 by Luca Risolia <luca.risolia@studio.unibo.it>  *
 *                                                                         *
 * 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 _W9968CF_H_
#define _W9968CF_H_

#include <linux/videodev2.h>
#include <linux/usb.h>
#include <linux/i2c.h>
#include <linux/device.h>
#include <linux/spinlock.h>
#include <linux/list.h>
#include <linux/wait.h>
#include <linux/param.h>
#include <linux/types.h>
#include <linux/rwsem.h>
#include <linux/mutex.h>

#include <media/v4l2-device.h>
#include <media/ovcamchip.h>

#include "w9968cf_vpp.h"


/****************************************************************************
 * Default values                                                           *
 ****************************************************************************/

#define W9968CF_VPPMOD_LOAD     1  /* automatic 'w9968cf-vpp' module loading */

/* Comment/uncomment the following line to enable/disable debugging messages */
#define W9968CF_DEBUG

/* These have effect only if W9968CF_DEBUG is defined */
#define W9968CF_DEBUG_LEVEL    2 /* from 0 to 6. 0 for no debug informations */
#define W9968CF_SPECIFIC_DEBUG 0 /* 0 or 1 */

#define W9968CF_MAX_DEVICES    32
#define W9968CF_SIMCAMS        W9968CF_MAX_DEVICES /* simultaneous cameras */

#define W9968CF_MAX_BUFFERS   32
#define W9968CF_BUFFERS       2 /* n. of frame buffers from 2 to MAX_BUFFERS */

/* Maximum data payload sizes in bytes for alternate settings */
static const u16 wMaxPacketSize[] = {1023, 959, 895, 831, 767, 703, 639, 575,
				      511, 447, 383, 319, 255, 191, 127,  63};
#define W9968CF_PACKET_SIZE      1023 /* according to wMaxPacketSizes[] */
#define W9968CF_MIN_PACKET_SIZE  63 /* minimum value */
#define W9968CF_ISO_PACKETS      5 /* n.of packets for isochronous transfers */
#define W9968CF_USB_CTRL_TIMEOUT 1000 /* timeout (ms) for usb control commands */
#define W9968CF_URBS             2 /* n. of scheduled URBs for ISO transfer */

#define W9968CF_I2C_BUS_DELAY    4 /* delay in us for I2C bit r/w operations */
#define W9968CF_I2C_RW_RETRIES   15 /* number of max I2C r/w retries */

/* Available video formats */
struct w9968cf_format {
	const u16 palette;
	const u16 depth;
	const u8 compression;
};

static const struct w9968cf_format w9968cf_formatlist[] = {
	{ VIDEO_PALETTE_UYVY,    16, 0 }, /* original video */
	{ VIDEO_PALETTE_YUV422P, 16, 1 }, /* with JPEG compression */
	{ VIDEO_PALETTE_YUV420P, 12, 1 }, /* with JPEG compression */
	{ VIDEO_PALETTE_YUV420,  12, 1 }, /* same as YUV420P */
	{ VIDEO_PALETTE_YUYV,    16, 0 }, /* software conversion */
	{ VIDEO_PALETTE_YUV422,  16, 0 }, /* software conversion */
	{ VIDEO_PALETTE_GREY,     8, 0 }, /* software conversion */
	{ VIDEO_PALETTE_RGB555,  16, 0 }, /* software conversion */
	{ VIDEO_PALETTE_RGB565,  16, 0 }, /* software conversion */
	{ VIDEO_PALETTE_RGB24,   24, 0 }, /* software conversion */
	{ VIDEO_PALETTE_RGB32,   32, 0 }, /* software conversion */
	{ 0,                      0, 0 }  /* 0 is a terminating entry */
};

#define W9968CF_DECOMPRESSION    2 /* decomp:0=disable,1=force,2=any formats */
#define W9968CF_PALETTE_DECOMP_OFF   VIDEO_PALETTE_UYVY    /* when decomp=0 */
#define W9968CF_PALETTE_DECOMP_FORCE VIDEO_PALETTE_YUV420P /* when decomp=1 */
#define W9968CF_PALETTE_DECOMP_ON    VIDEO_PALETTE_UYVY    /* when decomp=2 */

#define W9968CF_FORCE_RGB        0  /* read RGB instead of BGR, yes=1/no=0 */

#define W9968CF_MAX_WIDTH      800 /* Has effect if up-scaling is on */
#define W9968CF_MAX_HEIGHT     600 /* Has effect if up-scaling is on */
#define W9968CF_WIDTH          320 /* from 128 to 352, multiple of 16 */
#define W9968CF_HEIGHT         240 /* from  96 to 288, multiple of 16 */

#define W9968CF_CLAMPING       0 /* 0 disable, 1 enable video data clamping */
#define W9968CF_FILTER_TYPE    0 /* 0 disable  1 (1-2-1), 2 (2-3-6-3-2) */
#define W9968CF_DOUBLE_BUFFER  1 /* 0 disable, 1 enable double buffer */
#define W9968CF_LARGEVIEW      1 /* 0 disable, 1 enable */
#define W9968CF_UPSCALING      0 /* 0 disable, 1 enable */

#define W9968CF_MONOCHROME     0 /* 0 not monochrome, 1 monochrome sensor */
#define W9968CF_BRIGHTNESS     31000 /* from 0 to 65535 */
#define W9968CF_HUE            32768 /* from 0 to 65535 */
#define W9968CF_COLOUR         32768 /* from 0 to 65535 */
#define W9968CF_CONTRAST       50000 /* from 0 to 65535 */
#define W9968CF_WHITENESS      32768 /* from 0 to 65535 */

#define W9968CF_AUTOBRIGHT     0 /* 0 disable, 1 enable automatic brightness */
#define W9968CF_AUTOEXP        1 /* 0 disable, 1 enable automatic exposure */
#define W9968CF_LIGHTFREQ      50 /* light frequency. 50Hz (Europe) or 60Hz */
#define W9968CF_BANDINGFILTER  0 /* 0 disable, 1 enable banding filter */
#define W9968CF_BACKLIGHT      0 /* 0 or 1, 1=object is lit from behind */
#define W9968CF_MIRROR         0 /* 0 or 1 [don't] reverse image horizontally*/

#define W9968CF_CLOCKDIV         -1 /* -1 = automatic clock divisor */
#define W9968CF_DEF_CLOCKDIVISOR  0 /* default sensor clock divisor value */


/****************************************************************************
 * Globals                                                                  *
 ****************************************************************************/

#define W9968CF_MODULE_NAME     "V4L driver for W996[87]CF JPEG USB " \
				"Dual Mode Camera Chip"
#define W9968CF_MODULE_VERSION  "1:1.34-basic"
#define W9968CF_MODULE_AUTHOR   "(C) 2002-2004 Luca Risolia"
#define W9968CF_AUTHOR_EMAIL    "<luca.risolia@studio.unibo.it>"
#define W9968CF_MODULE_LICENSE  "GPL"

static const struct usb_device_id winbond_id_table[] = {
	{
		/* Creative Labs Video Blaster WebCam Go Plus */
		USB_DEVICE(0x041e, 0x4003),
		.driver_info = (unsigned long)"w9968cf",
	},
	{
		/* Generic W996[87]CF JPEG USB Dual Mode Camera */
		USB_DEVICE(0x1046, 0x9967),
		.driver_info = (unsigned long)"w9968cf",
	},
	{ } /* terminating entry */
};

/* W996[87]CF camera models, internal ids: */
enum w9968cf_model_id {
	W9968CF_MOD_GENERIC = 1, /* Generic W996[87]CF based device */
	W9968CF_MOD_CLVBWGP = 11,/*Creative Labs Video Blaster WebCam Go Plus*/
	W9968CF_MOD_ADPVDMA = 21, /* Aroma Digi Pen VGA Dual Mode ADG-5000 */
	W9986CF_MOD_AAU = 31,     /* AVerMedia AVerTV USB */
	W9968CF_MOD_CLVBWG = 34,  /* Creative Labs Video Blaster WebCam Go */
	W9968CF_MOD_LL = 37,      /* Lebon LDC-035A */
	W9968CF_MOD_EEEMC = 40,   /* Ezonics EZ-802 EZMega Cam */
	W9968CF_MOD_OOE = 42,     /* OmniVision OV8610-EDE */
	W9968CF_MOD_ODPVDMPC = 43,/* OPCOM Digi Pen VGA Dual Mode Pen Camera */
	W9968CF_MOD_PDPII = 46,   /* Pretec Digi Pen-II */
	W9968CF_MOD_PDP480 = 49,  /* Pretec DigiPen-480 */
};

enum w9968cf_frame_status {
	F_READY,            /* finished grabbing & ready to be read/synced */
	F_GRABBING,         /* in the process of being grabbed into */
	F_ERROR,            /* something bad happened while processing */
	F_UNUSED            /* unused (no VIDIOCMCAPTURE) */
};

struct w9968cf_frame_t {
	void* buffer;
	unsigned long size;
	u32 length;
	int number;
	enum w9968cf_frame_status status;
	struct w9968cf_frame_t* next;
	u8 queued;
};

enum w9968cf_vpp_flag {
	VPP_NONE = 0x00,
	VPP_UPSCALE = 0x01,
	VPP_SWAP_YUV_BYTES = 0x02,
	VPP_DECOMPRESSION = 0x04,
	VPP_UYVY_TO_RGBX = 0x08,
};

/* Main device driver structure */
struct w9968cf_device {
	enum w9968cf_model_id id;   /* private device identifier */

	struct v4l2_device v4l2_dev;
	struct video_device* v4ldev; /* -> V4L structure */
	struct list_head v4llist;    /* entry of the list of V4L cameras */

	struct usb_device* usbdev;           /* -> main USB structure */
	struct urb* urb[W9968CF_URBS];       /* -> USB request block structs */
	void* transfer_buffer[W9968CF_URBS]; /* -> ISO transfer buffers */
	u16* control_buffer;                 /* -> buffer for control req.*/
	u16* data_buffer;                    /* -> data to send to the FSB */

	struct w9968cf_frame_t frame[W9968CF_MAX_BUFFERS];
	struct w9968cf_frame_t frame_tmp; /* temporary frame */
	struct w9968cf_frame_t frame_vpp; /* helper frame.*/
	struct w9968cf_frame_t* frame_current; /* -> frame being grabbed */
	struct w9968cf_frame_t* requested_frame[W9968CF_MAX_BUFFERS];

	u8 max_buffers,   /* number of requested buffers */
	   force_palette, /* yes=1/no=0 */
	   force_rgb,     /* read RGB instead of BGR, yes=1, no=0 */
	   double_buffer, /* hardware double buffering yes=1/no=0 */
	   clamping,      /* video data clamping yes=1/no=0 */
	   filter_type,   /* 0=disabled, 1=3 tap, 2=5 tap filter */
	   capture,       /* 0=disabled, 1=enabled */
	   largeview,     /* 0=disabled, 1=enabled */
	   decompression, /* 0=disabled, 1=forced, 2=allowed */
	   upscaling;     /* software image scaling, 0=enabled, 1=disabled */

	struct video_picture picture; /* current picture settings */
	struct video_window window;   /* current window settings */

	u16 hw_depth,    /* depth (used by the chip) */
	    hw_palette,  /* palette (used by the chip) */
	    hw_width,    /* width (used by the chip) */
	    hw_height,   /* height (used by the chip) */
	    hs_polarity, /* 0=negative sync pulse, 1=positive sync pulse */
	    vs_polarity, /* 0=negative sync pulse, 1=positive sync pulse */
	    start_cropx, /* pixels from HS inactive edge to 1st cropped pixel*/
	    start_cropy; /* pixels from VS inactive edge to 1st cropped pixel*/

	enum w9968cf_vpp_flag vpp_flag; /* post-processing routines in use */

	u8 nbuffers,      /* number of allocated frame buffers */
	   altsetting,    /* camera alternate setting */
	   disconnected,  /* flag: yes=1, no=0 */
	   misconfigured, /* flag: yes=1, no=0 */
	   users,         /* flag: number of users holding the device */
	   streaming;     /* flag: yes=1, no=0 */

	u8 sensor_initialized; /* flag: yes=1, no=0 */

	/* Determined by the image sensor type: */
	int sensor,       /* type of image sensor chip (CC_*) */
	    monochrome;   /* image sensor is (probably) monochrome */
	u16 maxwidth,     /* maximum width supported by the image sensor */
	    maxheight,    /* maximum height supported by the image sensor */
	    minwidth,     /* minimum width supported by the image sensor */
	    minheight;    /* minimum height supported by the image sensor */
	u8  auto_brt,     /* auto brightness enabled flag */
	    auto_exp,     /* auto exposure enabled flag */
	    backlight,    /* backlight exposure algorithm flag */
	    mirror,       /* image is reversed horizontally */
	    lightfreq,    /* power (lighting) frequency */
	    bandfilt;     /* banding filter enabled flag */
	s8  clockdiv;     /* clock divisor */

	/* I2C interface to kernel */
	struct i2c_adapter i2c_adapter;
	struct v4l2_subdev *sensor_sd;

	/* Locks */
	struct mutex dev_mutex,    /* for probe, disconnect,open and close */
			 fileop_mutex; /* for read and ioctl */
	spinlock_t urb_lock,   /* for submit_urb() and unlink_urb() */
		   flist_lock; /* for requested frame list accesses */
	wait_queue_head_t open, wait_queue;

	char command[16]; /* name of the program holding the device */
};

static inline struct w9968cf_device *to_cam(struct v4l2_device *v4l2_dev)
{
	return container_of(v4l2_dev, struct w9968cf_device, v4l2_dev);
}


/****************************************************************************
 * Macros for debugging                                                     *
 ****************************************************************************/

#undef DBG
#undef KDBG
#ifdef W9968CF_DEBUG
/* For device specific debugging messages */
#	define DBG(level, fmt, args...)                                       \
{                                                                             \
	if ( ((specific_debug) && (debug == (level))) ||                      \
	     ((!specific_debug) && (debug >= (level))) ) {                    \
		if ((level) == 1)                                             \
			v4l2_err(&cam->v4l2_dev, fmt "\n", ## args);          \
		else if ((level) == 2 || (level) == 3)                        \
			v4l2_info(&cam->v4l2_dev, fmt "\n", ## args);         \
		else if ((level) == 4)                                        \
			v4l2_warn(&cam->v4l2_dev, fmt "\n", ## args);         \
		else if ((level) >= 5)                                        \
			v4l2_info(&cam->v4l2_dev, "[%s:%d] " fmt "\n",        \
				 __func__, __LINE__ , ## args);               \
	}                                                                     \
}
/* For generic kernel (not device specific) messages */
#	define KDBG(level, fmt, args...)                                      \
{                                                                             \
	if ( ((specific_debug) && (debug == (level))) ||                      \
	     ((!specific_debug) && (debug >= (level))) ) {                    \
		if ((level) >= 1 && (level) <= 4)                             \
			pr_info("w9968cf: " fmt "\n", ## args);               \
		else if ((level) >= 5)                                        \
			pr_debug("w9968cf: [%s:%d] " fmt "\n", __func__,  \
				 __LINE__ , ## args);                         \
	}                                                                     \
}
#else
	/* Not debugging: nothing */
#	define DBG(level, fmt, args...) do {;} while(0);
#	define KDBG(level, fmt, args...) do {;} while(0);
#endif

#undef PDBG
#define PDBG(fmt, args...)                                                    \
v4l2_info(&cam->v4l2_dev, "[%s:%d] " fmt "\n", __func__, __LINE__ , ## args);

#undef PDBGG
#define PDBGG(fmt, args...) do {;} while(0); /* nothing: it's a placeholder */

#endif /* _W9968CF_H_ */
Commit	Line	Data
1da177e4 LT	1	/***************************************************************************
	2	* Video4Linux driver for W996[87]CF JPEG USB Dual Mode Camera Chip. *
	3	* *
	4	* Copyright (C) 2002-2004 by Luca Risolia <luca.risolia@studio.unibo.it> *
	5	* *
	6	* This program is free software; you can redistribute it and/or modify *
	7	* it under the terms of the GNU General Public License as published by *
	8	* the Free Software Foundation; either version 2 of the License, or *
	9	* (at your option) any later version. *
	10	* *
	11	* This program is distributed in the hope that it will be useful, *
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of *
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
	14	* GNU General Public License for more details. *
	15	* *
	16	* You should have received a copy of the GNU General Public License *
	17	* along with this program; if not, write to the Free Software *
	18	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. *
	19	***************************************************************************/
	20
	21	#ifndef _W9968CF_H_
	22	#define _W9968CF_H_
	23
33b687cf	24	#include <linux/videodev2.h>
1da177e4 LT	25	#include <linux/usb.h>
	26	#include <linux/i2c.h>
	27	#include <linux/device.h>
	28	#include <linux/spinlock.h>
	29	#include <linux/list.h>
	30	#include <linux/wait.h>
1da177e4 LT	31	#include <linux/param.h>
	32	#include <linux/types.h>
	33	#include <linux/rwsem.h>
4186ecf8	34	#include <linux/mutex.h>
1da177e4	35
4e06839f	36	#include <media/v4l2-device.h>
1da177e4 LT	37	#include <media/ovcamchip.h>
	38
	39	#include "w9968cf_vpp.h"
	40
	41
	42	/****************************************************************************
	43	* Default values *
	44	****************************************************************************/
	45
1da177e4 LT	46	#define W9968CF_VPPMOD_LOAD 1 /* automatic 'w9968cf-vpp' module loading */
	47
	48	/* Comment/uncomment the following line to enable/disable debugging messages */
	49	#define W9968CF_DEBUG
	50
	51	/* These have effect only if W9968CF_DEBUG is defined */
	52	#define W9968CF_DEBUG_LEVEL 2 /* from 0 to 6. 0 for no debug informations */
	53	#define W9968CF_SPECIFIC_DEBUG 0 /* 0 or 1 */
	54
	55	#define W9968CF_MAX_DEVICES 32
	56	#define W9968CF_SIMCAMS W9968CF_MAX_DEVICES /* simultaneous cameras */
	57
	58	#define W9968CF_MAX_BUFFERS 32
	59	#define W9968CF_BUFFERS 2 /* n. of frame buffers from 2 to MAX_BUFFERS */
	60
	61	/* Maximum data payload sizes in bytes for alternate settings */
	62	static const u16 wMaxPacketSize[] = {1023, 959, 895, 831, 767, 703, 639, 575,
d56410e0	63	511, 447, 383, 319, 255, 191, 127, 63};
1da177e4 LT	64	#define W9968CF_PACKET_SIZE 1023 /* according to wMaxPacketSizes[] */
	65	#define W9968CF_MIN_PACKET_SIZE 63 /* minimum value */
	66	#define W9968CF_ISO_PACKETS 5 /* n.of packets for isochronous transfers */
	67	#define W9968CF_USB_CTRL_TIMEOUT 1000 /* timeout (ms) for usb control commands */
	68	#define W9968CF_URBS 2 /* n. of scheduled URBs for ISO transfer */
	69
	70	#define W9968CF_I2C_BUS_DELAY 4 /* delay in us for I2C bit r/w operations */
	71	#define W9968CF_I2C_RW_RETRIES 15 /* number of max I2C r/w retries */
	72
	73	/* Available video formats */
	74	struct w9968cf_format {
	75	const u16 palette;
	76	const u16 depth;
	77	const u8 compression;
	78	};
	79
	80	static const struct w9968cf_format w9968cf_formatlist[] = {
	81	{ VIDEO_PALETTE_UYVY, 16, 0 }, /* original video */
	82	{ VIDEO_PALETTE_YUV422P, 16, 1 }, /* with JPEG compression */
	83	{ VIDEO_PALETTE_YUV420P, 12, 1 }, /* with JPEG compression */
	84	{ VIDEO_PALETTE_YUV420, 12, 1 }, /* same as YUV420P */
	85	{ VIDEO_PALETTE_YUYV, 16, 0 }, /* software conversion */
	86	{ VIDEO_PALETTE_YUV422, 16, 0 }, /* software conversion */
	87	{ VIDEO_PALETTE_GREY, 8, 0 }, /* software conversion */
	88	{ VIDEO_PALETTE_RGB555, 16, 0 }, /* software conversion */
	89	{ VIDEO_PALETTE_RGB565, 16, 0 }, /* software conversion */
	90	{ VIDEO_PALETTE_RGB24, 24, 0 }, /* software conversion */
	91	{ VIDEO_PALETTE_RGB32, 32, 0 }, /* software conversion */
	92	{ 0, 0, 0 } /* 0 is a terminating entry */
	93	};
	94
	95	#define W9968CF_DECOMPRESSION 2 /* decomp:0=disable,1=force,2=any formats */
	96	#define W9968CF_PALETTE_DECOMP_OFF VIDEO_PALETTE_UYVY /* when decomp=0 */
	97	#define W9968CF_PALETTE_DECOMP_FORCE VIDEO_PALETTE_YUV420P /* when decomp=1 */
	98	#define W9968CF_PALETTE_DECOMP_ON VIDEO_PALETTE_UYVY /* when decomp=2 */
	99
	100	#define W9968CF_FORCE_RGB 0 /* read RGB instead of BGR, yes=1/no=0 */
	101
	102	#define W9968CF_MAX_WIDTH 800 /* Has effect if up-scaling is on */
	103	#define W9968CF_MAX_HEIGHT 600 /* Has effect if up-scaling is on */
	104	#define W9968CF_WIDTH 320 /* from 128 to 352, multiple of 16 */
	105	#define W9968CF_HEIGHT 240 /* from 96 to 288, multiple of 16 */
	106
	107	#define W9968CF_CLAMPING 0 /* 0 disable, 1 enable video data clamping */
	108	#define W9968CF_FILTER_TYPE 0 /* 0 disable 1 (1-2-1), 2 (2-3-6-3-2) */
	109	#define W9968CF_DOUBLE_BUFFER 1 /* 0 disable, 1 enable double buffer */
	110	#define W9968CF_LARGEVIEW 1 /* 0 disable, 1 enable */
	111	#define W9968CF_UPSCALING 0 /* 0 disable, 1 enable */
	112
	113	#define W9968CF_MONOCHROME 0 /* 0 not monochrome, 1 monochrome sensor */
	114	#define W9968CF_BRIGHTNESS 31000 /* from 0 to 65535 */
	115	#define W9968CF_HUE 32768 /* from 0 to 65535 */
	116	#define W9968CF_COLOUR 32768 /* from 0 to 65535 */
	117	#define W9968CF_CONTRAST 50000 /* from 0 to 65535 */
	118	#define W9968CF_WHITENESS 32768 /* from 0 to 65535 */
	119
	120	#define W9968CF_AUTOBRIGHT 0 /* 0 disable, 1 enable automatic brightness */
	121	#define W9968CF_AUTOEXP 1 /* 0 disable, 1 enable automatic exposure */
	122	#define W9968CF_LIGHTFREQ 50 /* light frequency. 50Hz (Europe) or 60Hz */
	123	#define W9968CF_BANDINGFILTER 0 /* 0 disable, 1 enable banding filter */
	124	#define W9968CF_BACKLIGHT 0 /* 0 or 1, 1=object is lit from behind */
	125	#define W9968CF_MIRROR 0 /* 0 or 1 [don't] reverse image horizontally*/
	126
	127	#define W9968CF_CLOCKDIV -1 /* -1 = automatic clock divisor */
128	#define W9968CF_DEF_CLOCKDIVISOR 0 /* default sensor clock divisor value */
129
130
131	/****************************************************************************
132	* Globals *
133	****************************************************************************/
134
135	#define W9968CF_MODULE_NAME "V4L driver for W996[87]CF JPEG USB " \
d56410e0	136	"Dual Mode Camera Chip"
3ff4ad81	137	#define W9968CF_MODULE_VERSION "1:1.34-basic"
1da177e4 LT	138	#define W9968CF_MODULE_AUTHOR "(C) 2002-2004 Luca Risolia"
	139	#define W9968CF_AUTHOR_EMAIL "<luca.risolia@studio.unibo.it>"
	140	#define W9968CF_MODULE_LICENSE "GPL"
	141
	142	static const struct usb_device_id winbond_id_table[] = {
	143	{
	144	/* Creative Labs Video Blaster WebCam Go Plus */
	145	USB_DEVICE(0x041e, 0x4003),
	146	.driver_info = (unsigned long)"w9968cf",
	147	},
	148	{
	149	/* Generic W996[87]CF JPEG USB Dual Mode Camera */
	150	USB_DEVICE(0x1046, 0x9967),
	151	.driver_info = (unsigned long)"w9968cf",
	152	},
	153	{ } /* terminating entry */
	154	};
	155
	156	/* W996[87]CF camera models, internal ids: */
	157	enum w9968cf_model_id {
	158	W9968CF_MOD_GENERIC = 1, /* Generic W996[87]CF based device */
	159	W9968CF_MOD_CLVBWGP = 11,/Creative Labs Video Blaster WebCam Go Plus/
	160	W9968CF_MOD_ADPVDMA = 21, /* Aroma Digi Pen VGA Dual Mode ADG-5000 */
	161	W9986CF_MOD_AAU = 31, /* AVerMedia AVerTV USB */
	162	W9968CF_MOD_CLVBWG = 34, /* Creative Labs Video Blaster WebCam Go */
	163	W9968CF_MOD_LL = 37, /* Lebon LDC-035A */
	164	W9968CF_MOD_EEEMC = 40, /* Ezonics EZ-802 EZMega Cam */
	165	W9968CF_MOD_OOE = 42, /* OmniVision OV8610-EDE */
	166	W9968CF_MOD_ODPVDMPC = 43,/* OPCOM Digi Pen VGA Dual Mode Pen Camera */
	167	W9968CF_MOD_PDPII = 46, /* Pretec Digi Pen-II */
	168	W9968CF_MOD_PDP480 = 49, /* Pretec DigiPen-480 */
	169	};
	170
	171	enum w9968cf_frame_status {
	172	F_READY, /* finished grabbing & ready to be read/synced */
	173	F_GRABBING, /* in the process of being grabbed into */
	174	F_ERROR, /* something bad happened while processing */
	175	F_UNUSED /* unused (no VIDIOCMCAPTURE) */
	176	};
	177
	178	struct w9968cf_frame_t {
	179	void* buffer;
	180	unsigned long size;
	181	u32 length;
	182	int number;
	183	enum w9968cf_frame_status status;
	184	struct w9968cf_frame_t* next;
	185	u8 queued;
	186	};
	187
	188	enum w9968cf_vpp_flag {
	189	VPP_NONE = 0x00,
	190	VPP_UPSCALE = 0x01,
	191	VPP_SWAP_YUV_BYTES = 0x02,
	192	VPP_DECOMPRESSION = 0x04,
	193	VPP_UYVY_TO_RGBX = 0x08,
	194	};
	195
1da177e4 LT	196	/* Main device driver structure */
1da177e4 LT	197	struct w9968cf_device {
1da177e4 LT	198	enum w9968cf_model_id id; /* private device identifier */
1da177e4 LT	199
4e06839f	200	struct v4l2_device v4l2_dev;
1da177e4 LT	201	struct video_device* v4ldev; /* -> V4L structure */
	202	struct list_head v4llist; /* entry of the list of V4L cameras */
	203
	204	struct usb_device* usbdev; /* -> main USB structure */
	205	struct urb* urb[W9968CF_URBS]; /* -> USB request block structs */
	206	void* transfer_buffer[W9968CF_URBS]; /* -> ISO transfer buffers */
	207	u16* control_buffer; /* -> buffer for control req.*/
	208	u16* data_buffer; /* -> data to send to the FSB */
	209
	210	struct w9968cf_frame_t frame[W9968CF_MAX_BUFFERS];
	211	struct w9968cf_frame_t frame_tmp; /* temporary frame */
	212	struct w9968cf_frame_t frame_vpp; /* helper frame.*/
	213	struct w9968cf_frame_t* frame_current; /* -> frame being grabbed */
	214	struct w9968cf_frame_t* requested_frame[W9968CF_MAX_BUFFERS];
	215
	216	u8 max_buffers, /* number of requested buffers */
	217	force_palette, /* yes=1/no=0 */
	218	force_rgb, /* read RGB instead of BGR, yes=1, no=0 */
	219	double_buffer, /* hardware double buffering yes=1/no=0 */
	220	clamping, /* video data clamping yes=1/no=0 */
	221	filter_type, /* 0=disabled, 1=3 tap, 2=5 tap filter */
	222	capture, /* 0=disabled, 1=enabled */
	223	largeview, /* 0=disabled, 1=enabled */
	224	decompression, /* 0=disabled, 1=forced, 2=allowed */
	225	upscaling; /* software image scaling, 0=enabled, 1=disabled */
	226
	227	struct video_picture picture; /* current picture settings */
	228	struct video_window window; /* current window settings */
	229
	230	u16 hw_depth, /* depth (used by the chip) */
	231	hw_palette, /* palette (used by the chip) */
	232	hw_width, /* width (used by the chip) */
	233	hw_height, /* height (used by the chip) */
	234	hs_polarity, /* 0=negative sync pulse, 1=positive sync pulse */
	235	vs_polarity, /* 0=negative sync pulse, 1=positive sync pulse */
	236	start_cropx, /* pixels from HS inactive edge to 1st cropped pixel*/
	237	start_cropy; /* pixels from VS inactive edge to 1st cropped pixel*/
	238
	239	enum w9968cf_vpp_flag vpp_flag; /* post-processing routines in use */
	240
	241	u8 nbuffers, /* number of allocated frame buffers */
	242	altsetting, /* camera alternate setting */
	243	disconnected, /* flag: yes=1, no=0 */
	244	misconfigured, /* flag: yes=1, no=0 */
	245	users, /* flag: number of users holding the device */
	246	streaming; /* flag: yes=1, no=0 */
	247
	248	u8 sensor_initialized; /* flag: yes=1, no=0 */
	249
	250	/* Determined by the image sensor type: */
	251	int sensor, /* type of image sensor chip (CC_) /
	252	monochrome; /* image sensor is (probably) monochrome */
	253	u16 maxwidth, /* maximum width supported by the image sensor */
	254	maxheight, /* maximum height supported by the image sensor */
	255	minwidth, /* minimum width supported by the image sensor */
	256	minheight; /* minimum height supported by the image sensor */
	257	u8 auto_brt, /* auto brightness enabled flag */
	258	auto_exp, /* auto exposure enabled flag */
	259	backlight, /* backlight exposure algorithm flag */
	260	mirror, /* image is reversed horizontally */
	261	lightfreq, /* power (lighting) frequency */
	262	bandfilt; /* banding filter enabled flag */
	263	s8 clockdiv; /* clock divisor */
	264
265	/* I2C interface to kernel */
266	struct i2c_adapter i2c_adapter;
3160fbc5	267	struct v4l2_subdev *sensor_sd;
1da177e4 LT	268
1da177e4 LT	269	/* Locks */
4186ecf8	270	struct mutex dev_mutex, /* for probe, disconnect,open and close */
d56410e0	271	fileop_mutex; /* for read and ioctl */
1da177e4	272	spinlock_t urb_lock, /* for submit_urb() and unlink_urb() */
d56410e0	273	flist_lock; /* for requested frame list accesses */
1da177e4 LT	274	wait_queue_head_t open, wait_queue;
	275
	276	char command[16]; /* name of the program holding the device */
	277	};
	278
3160fbc5 HV	279	static inline struct w9968cf_device to_cam(struct v4l2_device v4l2_dev)
	280	{
	281	return container_of(v4l2_dev, struct w9968cf_device, v4l2_dev);
	282	}
	283
1da177e4 LT	284
	285	/****************************************************************************
	286	* Macros for debugging *
	287	****************************************************************************/
	288
	289	#undef DBG
	290	#undef KDBG
	291	#ifdef W9968CF_DEBUG
	292	/* For device specific debugging messages */
	293	# define DBG(level, fmt, args...) \
	294	{ \
	295	if ( ((specific_debug) && (debug == (level))) \|\| \
	296	((!specific_debug) && (debug >= (level))) ) { \
	297	if ((level) == 1) \
4e06839f	298	v4l2_err(&cam->v4l2_dev, fmt "\n", ## args); \
1da177e4	299	else if ((level) == 2 \|\| (level) == 3) \
4e06839f	300	v4l2_info(&cam->v4l2_dev, fmt "\n", ## args); \
1da177e4	301	else if ((level) == 4) \
4e06839f	302	v4l2_warn(&cam->v4l2_dev, fmt "\n", ## args); \
1da177e4	303	else if ((level) >= 5) \
4e06839f HV	304	v4l2_info(&cam->v4l2_dev, "[%s:%d] " fmt "\n", \
4e06839f HV	305	__func__, __LINE__ , ## args); \
1da177e4 LT	306	} \
	307	}
	308	/* For generic kernel (not device specific) messages */
	309	# define KDBG(level, fmt, args...) \
	310	{ \
	311	if ( ((specific_debug) && (debug == (level))) \|\| \
	312	((!specific_debug) && (debug >= (level))) ) { \
	313	if ((level) >= 1 && (level) <= 4) \
	314	pr_info("w9968cf: " fmt "\n", ## args); \
	315	else if ((level) >= 5) \
7e28adb2	316	pr_debug("w9968cf: [%s:%d] " fmt "\n", __func__, \
d56410e0	317	__LINE__ , ## args); \
1da177e4 LT	318	} \
	319	}
	320	#else
	321	/* Not debugging: nothing */
	322	# define DBG(level, fmt, args...) do {;} while(0);
	323	# define KDBG(level, fmt, args...) do {;} while(0);
	324	#endif
	325
	326	#undef PDBG
	327	#define PDBG(fmt, args...) \
4e06839f	328	v4l2_info(&cam->v4l2_dev, "[%s:%d] " fmt "\n", __func__, __LINE__ , ## args);
1da177e4 LT	329
	330	#undef PDBGG
	331	#define PDBGG(fmt, args...) do {;} while(0); /* nothing: it's a placeholder */
	332
	333	#endif /* _W9968CF_H_ */