1 /***************************************************************************
2 * Video4Linux driver for W996[87]CF JPEG USB Dual Mode Camera Chip. *
4 * Copyright (C) 2002 2003 by Luca Risolia <luca.risolia@studio.unibo.it> *
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. *
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. *
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 ***************************************************************************/
24 #include <linux/videodev.h>
25 #include <linux/usb.h>
26 #include <linux/i2c.h>
27 #ifdef CONFIG_VIDEO_PROC_FS
28 # include <linux/proc_fs.h>
30 #include <linux/spinlock.h>
31 #include <linux/list.h>
32 #include <linux/wait.h>
33 #include <linux/config.h>
34 #include <linux/param.h>
35 #include <asm/semaphore.h>
36 #include <asm/types.h>
38 #include "w9968cf_externaldef.h"
41 /****************************************************************************
43 ****************************************************************************/
45 #define W9968CF_VPPMOD_LOAD 1 /* automatic 'w9968cf-vpp' module loading */
47 /* Comment/uncomment the following line to enable/disable debugging messages */
50 /* These have effect only if W9968CF_DEBUG is defined */
51 #define W9968CF_DEBUG_LEVEL 2 /* from 0 to 6. 0 for no debug informations */
52 #define W9968CF_SPECIFIC_DEBUG 0 /* 0 or 1 */
54 #define W9968CF_MAX_DEVICES 32
55 #define W9968CF_SIMCAMS W9968CF_MAX_DEVICES /* simultaneous cameras */
57 #define W9968CF_MAX_BUFFERS 32
58 #define W9968CF_BUFFERS 2 /* n. of frame buffers from 2 to MAX_BUFFERS */
60 /* Maximum data payload sizes in bytes for alternate settings */
61 static const u16 wMaxPacketSize[] = {1023, 959, 895, 831, 767, 703, 639, 575,
62 511, 447, 383, 319, 255, 191, 127, 63};
63 #define W9968CF_PACKET_SIZE 1023 /* according to wMaxPacketSizes[] */
64 #define W9968CF_MIN_PACKET_SIZE 63 /* minimum value */
65 #define W9968CF_ISO_PACKETS 5 /* n.of packets for isochronous transfers */
66 #define W9968CF_USB_CTRL_TIMEOUT HZ /* timeout for usb control commands */
67 #define W9968CF_URBS 2 /* n. of scheduled URBs for ISO transfer */
69 #define W9968CF_I2C_BUS_DELAY 4 /* delay in us for I2C bit r/w operations */
70 #define W9968CF_I2C_RW_RETRIES 15 /* number of max I2C r/w retries */
72 /* Available video formats */
73 struct w9968cf_format {
79 static const struct w9968cf_format w9968cf_formatlist[] = {
80 { VIDEO_PALETTE_UYVY, 16, 0 }, /* original video */
81 { VIDEO_PALETTE_YUV422P, 16, 1 }, /* with JPEG compression */
82 { VIDEO_PALETTE_YUV420P, 12, 1 }, /* with JPEG compression */
83 { VIDEO_PALETTE_YUV420, 12, 1 }, /* same as YUV420P */
84 { VIDEO_PALETTE_YUYV, 16, 0 }, /* software conversion */
85 { VIDEO_PALETTE_YUV422, 16, 0 }, /* software conversion */
86 { VIDEO_PALETTE_GREY, 8, 0 }, /* software conversion */
87 { VIDEO_PALETTE_RGB555, 16, 0 }, /* software conversion */
88 { VIDEO_PALETTE_RGB565, 16, 0 }, /* software conversion */
89 { VIDEO_PALETTE_RGB24, 24, 0 }, /* software conversion */
90 { VIDEO_PALETTE_RGB32, 32, 0 }, /* software conversion */
91 { 0, 0, 0 } /* 0 is a terminating entry */
94 #define W9968CF_DECOMPRESSION 2 /* decomp:0=disable,1=force,2=any formats */
95 #define W9968CF_PALETTE_DECOMP_OFF VIDEO_PALETTE_UYVY /* when decomp=0 */
96 #define W9968CF_PALETTE_DECOMP_FORCE VIDEO_PALETTE_YUV420P /* when decomp=1 */
97 #define W9968CF_PALETTE_DECOMP_ON VIDEO_PALETTE_UYVY /* when decomp=2 */
99 #define W9968CF_FORCE_RGB 0 /* read RGB instead of BGR, yes=1/no=0 */
101 #define W9968CF_MAX_WIDTH 800 /* should be >= 640 */
102 #define W9968CF_MAX_HEIGHT 600 /* should be >= 480 */
103 #define W9968CF_WIDTH 320 /* from 128 to 352, multiple of 16 */
104 #define W9968CF_HEIGHT 240 /* from 96 to 288, multiple of 16 */
106 #define W9968CF_CLAMPING 0 /* 0 disable, 1 enable video data clamping */
107 #define W9968CF_FILTER_TYPE 0 /* 0 disable 1 (1-2-1), 2 (2-3-6-3-2) */
108 #define W9968CF_DOUBLE_BUFFER 1 /* 0 disable, 1 enable double buffer */
109 #define W9968CF_LARGEVIEW 1 /* 0 disable, 1 enable */
110 #define W9968CF_UPSCALING 0 /* 0 disable, 1 enable */
112 #define W9968CF_MONOCHROME 0 /* 0 not monochrome, 1 monochrome sensor */
113 #define W9968CF_BRIGHTNESS 31000 /* from 0 to 65535 */
114 #define W9968CF_HUE 32768 /* from 0 to 65535 */
115 #define W9968CF_COLOUR 32768 /* from 0 to 65535 */
116 #define W9968CF_CONTRAST 50000 /* from 0 to 65535 */
117 #define W9968CF_WHITENESS 32768 /* from 0 to 65535 */
119 #define W9968CF_AUTOBRIGHT 0 /* 0 disable, 1 enable automatic brightness */
120 #define W9968CF_AUTOEXP 1 /* 0 disable, 1 enable automatic exposure */
121 #define W9968CF_LIGHTFREQ 50 /* light frequency. 50Hz (Europe) or 60Hz */
122 #define W9968CF_BANDINGFILTER 0 /* 0 disable, 1 enable banding filter */
123 #define W9968CF_BACKLIGHT 0 /* 0 or 1, 1=object is lit from behind */
124 #define W9968CF_MIRROR 0 /* 0 or 1 [don't] reverse image horizontally*/
126 #define W9968CF_CLOCKDIV -1 /* -1 = automatic clock divisor */
127 #define W9968CF_DEF_CLOCKDIVISOR 0 /* default sensor clock divisor value */
130 /****************************************************************************
132 ****************************************************************************/
134 #define W9968CF_MODULE_NAME "V4L driver for W996[87]CF JPEG USB " \
135 "Dual Mode Camera Chip"
136 #define W9968CF_MODULE_VERSION "v1.24-basic"
137 #define W9968CF_MODULE_AUTHOR "(C) 2002 2003 Luca Risolia"
138 #define W9968CF_AUTHOR_EMAIL "<luca.risolia@studio.unibo.it>"
139 #define W9968CF_MODULE_LICENSE "GPL"
141 static u8 w9968cf_vppmod_present; /* status flag: yes=1, no=0 */
143 static const struct usb_device_id winbond_id_table[] = {
145 /* Creative Labs Video Blaster WebCam Go Plus */
146 USB_DEVICE(0x041e, 0x4003),
147 .driver_info = (unsigned long)"w9968cf",
150 /* Generic W996[87]CF JPEG USB Dual Mode Camera */
151 USB_DEVICE(0x1046, 0x9967),
152 .driver_info = (unsigned long)"w9968cf",
154 { } /* terminating entry */
157 MODULE_DEVICE_TABLE(usb, winbond_id_table);
159 /* W996[87]CF camera models, internal ids: */
160 enum w9968cf_model_id {
161 W9968CF_MOD_GENERIC = 1, /* Generic W996[87]CF based device */
162 W9968CF_MOD_CLVBWGP = 11,/*Creative Labs Video Blaster WebCam Go Plus*/
163 W9968CF_MOD_ADPA5R = 21, /* Aroma Digi Pen ADG-5000 Refurbished */
164 W9986CF_MOD_AU = 31, /* AVerTV USB */
165 W9968CF_MOD_CLVBWG = 34, /* Creative Labs Video Blaster WebCam Go */
166 W9968CF_MOD_DLLDK = 37, /* Die Lebon LDC-D35A Digital Kamera */
167 W9968CF_MOD_EEEMC = 40, /* Ezonics EZ-802 EZMega Cam */
168 W9968CF_MOD_ODPVDMPC = 43,/* OPCOM Digi Pen VGA Dual Mode Pen Camera */
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) */
178 struct w9968cf_frame_t {
179 #define W9968CF_HW_BUF_SIZE 640*480*2 /* buf.size of original frames */
182 enum w9968cf_frame_status status;
183 struct w9968cf_frame_t* next;
187 enum w9968cf_vpp_flag {
190 VPP_SWAP_YUV_BYTES = 0x02,
191 VPP_DECOMPRESSION = 0x04,
192 VPP_UYVY_TO_RGBX = 0x08,
195 struct list_head w9968cf_dev_list; /* head of V4L registered cameras list */
196 LIST_HEAD(w9968cf_dev_list);
197 struct semaphore w9968cf_devlist_sem; /* semaphore for list traversal */
199 /* Main device driver structure */
200 struct w9968cf_device {
201 enum w9968cf_model_id id; /* private device identifier */
203 struct video_device* v4ldev; /* -> V4L structure */
204 struct list_head v4llist; /* entry of the list of V4L cameras */
206 struct usb_device* usbdev; /* -> main USB structure */
207 struct urb* urb[W9968CF_URBS]; /* -> USB request block structs */
208 void* transfer_buffer[W9968CF_URBS]; /* -> ISO transfer buffers */
209 u16* control_buffer; /* -> buffer for control req.*/
210 u16* data_buffer; /* -> data to send to the FSB */
212 struct w9968cf_frame_t frame[W9968CF_MAX_BUFFERS];
213 struct w9968cf_frame_t frame_tmp; /* temporary frame */
214 struct w9968cf_frame_t* frame_current; /* -> frame being grabbed */
215 struct w9968cf_frame_t* requested_frame[W9968CF_MAX_BUFFERS];
216 void* vpp_buffer; /*-> helper buf.for video post-processing routines */
218 u8 max_buffers, /* number of requested buffers */
219 force_palette, /* yes=1/no=0 */
220 force_rgb, /* read RGB instead of BGR, yes=1, no=0 */
221 double_buffer, /* hardware double buffering yes=1/no=0 */
222 clamping, /* video data clamping yes=1/no=0 */
223 filter_type, /* 0=disabled, 1=3 tap, 2=5 tap filter */
224 capture, /* 0=disabled, 1=enabled */
225 largeview, /* 0=disabled, 1=enabled */
226 decompression, /* 0=disabled, 1=forced, 2=allowed */
227 upscaling; /* software image scaling, 0=enabled, 1=disabled */
229 struct video_picture picture; /* current picture settings */
230 struct video_window window; /* current window settings */
232 u16 hw_depth, /* depth (used by the chip) */
233 hw_palette, /* palette (used by the chip) */
234 hw_width, /* width (used by the chip) */
235 hw_height, /* height (used by the chip) */
236 hs_polarity, /* 0=negative sync pulse, 1=positive sync pulse */
237 vs_polarity, /* 0=negative sync pulse, 1=positive sync pulse */
238 start_cropx, /* pixels from HS inactive edge to 1st cropped pixel*/
239 start_cropy; /* pixels from VS incative edge to 1st cropped pixel*/
241 enum w9968cf_vpp_flag vpp_flag; /* post-processing routines in use */
243 u8 nbuffers, /* number of allocated frame buffers */
244 altsetting, /* camera alternate setting */
245 disconnected, /* flag: yes=1, no=0 */
246 misconfigured, /* flag: yes=1, no=0 */
247 users, /* flag: number of users holding the device */
248 streaming; /* flag: yes=1, no=0 */
250 u8 sensor_initialized; /* flag: yes=1, no=0 */
252 /* Determined by CMOS sensor type: */
253 int sensor, /* type of image sensor chip (CC_*) */
254 monochrome; /* CMOS sensor is (probably) monochrome */
255 u16 maxwidth, /* maximum width supported by the CMOS sensor */
256 maxheight, /* maximum height supported by the CMOS sensor */
257 minwidth, /* minimum width supported by the CMOS sensor */
258 minheight; /* minimum height supported by the CMOS sensor */
259 u8 auto_brt, /* auto brightness enabled flag */
260 auto_exp, /* auto exposure enabled flag */
261 backlight, /* backlight exposure algorithm flag */
262 mirror, /* image is reversed horizontally */
263 lightfreq, /* power (lighting) frequency */
264 bandfilt; /* banding filter enabled flag */
265 s8 clockdiv; /* clock divisor */
267 /* I2C interface to kernel */
268 struct i2c_adapter i2c_adapter;
269 struct i2c_client* sensor_client;
271 #ifdef CONFIG_VIDEO_PROC_FS
272 /* /proc entries, relative to /proc/video/w9968cf/ */
273 struct proc_dir_entry *proc_dev; /* rw per-device entry */
277 struct semaphore dev_sem, /* for probe, disconnect,open and close */
278 fileop_sem; /* for read and ioctl */
279 #ifdef CONFIG_VIDEO_PROC_FS
280 struct semaphore procfs_sem; /* for /proc read/write calls */
282 spinlock_t urb_lock, /* for submit_urb() and unlink_urb() */
283 flist_lock; /* for requested frame list accesses */
284 char command[16]; /* name of the program holding the device */
285 wait_queue_head_t open, wait_queue;
289 /****************************************************************************
290 * Macros for debugging *
291 ****************************************************************************/
295 # define DBG(level, fmt, args...) \
297 if ( ((specific_debug) && (debug == (level))) || \
298 ((!specific_debug) && (debug >= (level))) ) { \
301 else if ((level) == 2 || (level) == 3) \
302 info(fmt, ## args); \
303 else if ((level) == 4) \
304 warn(fmt, ## args); \
305 else if ((level) >= 5) \
306 info("[%s:%d] " fmt, \
307 __PRETTY_FUNCTION__, __LINE__ , ## args); \
311 /* Not debugging: nothing */
312 # define DBG(level, fmt, args...) do {;} while(0);
317 #define PDBG(fmt, args...) info("[%s:%d] "fmt, \
318 __PRETTY_FUNCTION__, __LINE__ , ## args);
319 #define PDBGG(fmt, args...) do {;} while(0); /* nothing: it's a placeholder */
321 #endif /* _W9968CF_H_ */