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