1 /* (C) 1999-2003 Nemosoft Unv.
2 (C) 2004-2006 Luc Saillard (luc@saillard.org)
4 NOTE: this version of pwc is an unofficial (modified) release of pwc & pcwx
5 driver and thus may have bugs that are not present in the original version.
6 Please send bug reports and support requests to <luc@saillard.org>.
7 The decompression routines have been implemented by reverse-engineering the
8 Nemosoft binary pwcx module. Caveat emptor.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 #include <linux/module.h>
29 #include <linux/usb.h>
30 #include <linux/spinlock.h>
31 #include <linux/wait.h>
32 #include <linux/mutex.h>
34 #include <linux/slab.h>
35 #include <asm/errno.h>
36 #include <linux/videodev2.h>
37 #include <media/v4l2-common.h>
38 #include <media/v4l2-device.h>
39 #include <media/v4l2-ioctl.h>
40 #include <media/v4l2-ctrls.h>
41 #include <media/v4l2-fh.h>
42 #include <media/v4l2-event.h>
43 #include <media/videobuf2-vmalloc.h>
44 #ifdef CONFIG_USB_PWC_INPUT_EVDEV
45 #include <linux/input.h>
49 #define PWC_VERSION "10.0.15"
50 #define PWC_NAME "pwc"
51 #define PFX PWC_NAME ": "
54 /* Trace certain actions in the driver */
55 #define PWC_DEBUG_LEVEL_MODULE (1<<0)
56 #define PWC_DEBUG_LEVEL_PROBE (1<<1)
57 #define PWC_DEBUG_LEVEL_OPEN (1<<2)
58 #define PWC_DEBUG_LEVEL_READ (1<<3)
59 #define PWC_DEBUG_LEVEL_MEMORY (1<<4)
60 #define PWC_DEBUG_LEVEL_FLOW (1<<5)
61 #define PWC_DEBUG_LEVEL_SIZE (1<<6)
62 #define PWC_DEBUG_LEVEL_IOCTL (1<<7)
63 #define PWC_DEBUG_LEVEL_TRACE (1<<8)
65 #define PWC_DEBUG_MODULE(fmt, args...) PWC_DEBUG(MODULE, fmt, ##args)
66 #define PWC_DEBUG_PROBE(fmt, args...) PWC_DEBUG(PROBE, fmt, ##args)
67 #define PWC_DEBUG_OPEN(fmt, args...) PWC_DEBUG(OPEN, fmt, ##args)
68 #define PWC_DEBUG_READ(fmt, args...) PWC_DEBUG(READ, fmt, ##args)
69 #define PWC_DEBUG_MEMORY(fmt, args...) PWC_DEBUG(MEMORY, fmt, ##args)
70 #define PWC_DEBUG_FLOW(fmt, args...) PWC_DEBUG(FLOW, fmt, ##args)
71 #define PWC_DEBUG_SIZE(fmt, args...) PWC_DEBUG(SIZE, fmt, ##args)
72 #define PWC_DEBUG_IOCTL(fmt, args...) PWC_DEBUG(IOCTL, fmt, ##args)
73 #define PWC_DEBUG_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args)
76 #ifdef CONFIG_USB_PWC_DEBUG
78 #define PWC_DEBUG_LEVEL (PWC_DEBUG_LEVEL_MODULE)
80 #define PWC_DEBUG(level, fmt, args...) do {\
81 if ((PWC_DEBUG_LEVEL_ ##level) & pwc_trace) \
82 printk(KERN_DEBUG PFX fmt, ##args); \
85 #define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args)
86 #define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args)
87 #define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args)
88 #define PWC_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args)
90 #else /* if ! CONFIG_USB_PWC_DEBUG */
92 #define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args)
93 #define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args)
94 #define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args)
95 #define PWC_TRACE(fmt, args...) do { } while(0)
96 #define PWC_DEBUG(level, fmt, args...) do { } while(0)
102 /* Defines for ToUCam cameras */
103 #define TOUCAM_HEADER_SIZE 8
104 #define TOUCAM_TRAILER_SIZE 4
106 #define FEATURE_MOTOR_PANTILT 0x0001
107 #define FEATURE_CODEC1 0x0002
108 #define FEATURE_CODEC2 0x0004
110 #define MAX_WIDTH 640
111 #define MAX_HEIGHT 480
113 /* Ignore errors in the first N frames, to allow for startup delays */
114 #define FRAME_LOWMARK 5
116 /* Size and number of buffers for the ISO pipe. */
117 #define MAX_ISO_BUFS 3
118 #define ISO_FRAMES_PER_DESC 10
119 #define ISO_MAX_FRAME_SIZE 960
120 #define ISO_BUFFER_SIZE (ISO_FRAMES_PER_DESC * ISO_MAX_FRAME_SIZE)
122 /* Maximum size after decompression is 640x480 YUV data, 1.5 * 640 * 480 */
123 #define PWC_FRAME_SIZE (460800 + TOUCAM_HEADER_SIZE + TOUCAM_TRAILER_SIZE)
125 /* Absolute minimum and maximum number of buffers available for mmap() */
127 #define MAX_FRAMES 16
129 /* Some macros to quickly find the type of a webcam */
130 #define DEVICE_USE_CODEC1(x) ((x)<675)
131 #define DEVICE_USE_CODEC2(x) ((x)>=675 && (x)<700)
132 #define DEVICE_USE_CODEC3(x) ((x)>=700)
133 #define DEVICE_USE_CODEC23(x) ((x)>=675)
136 #define PWCX_FLAG_PLANAR 0x0001
138 /* Request types: video */
139 #define SET_LUM_CTL 0x01
140 #define GET_LUM_CTL 0x02
141 #define SET_CHROM_CTL 0x03
142 #define GET_CHROM_CTL 0x04
143 #define SET_STATUS_CTL 0x05
144 #define GET_STATUS_CTL 0x06
145 #define SET_EP_STREAM_CTL 0x07
146 #define GET_EP_STREAM_CTL 0x08
147 #define GET_XX_CTL 0x09
148 #define SET_XX_CTL 0x0A
149 #define GET_XY_CTL 0x0B
150 #define SET_XY_CTL 0x0C
151 #define SET_MPT_CTL 0x0D
152 #define GET_MPT_CTL 0x0E
154 /* Selectors for the Luminance controls [GS]ET_LUM_CTL */
155 #define AGC_MODE_FORMATTER 0x2000
156 #define PRESET_AGC_FORMATTER 0x2100
157 #define SHUTTER_MODE_FORMATTER 0x2200
158 #define PRESET_SHUTTER_FORMATTER 0x2300
159 #define PRESET_CONTOUR_FORMATTER 0x2400
160 #define AUTO_CONTOUR_FORMATTER 0x2500
161 #define BACK_LIGHT_COMPENSATION_FORMATTER 0x2600
162 #define CONTRAST_FORMATTER 0x2700
163 #define DYNAMIC_NOISE_CONTROL_FORMATTER 0x2800
164 #define FLICKERLESS_MODE_FORMATTER 0x2900
165 #define AE_CONTROL_SPEED 0x2A00
166 #define BRIGHTNESS_FORMATTER 0x2B00
167 #define GAMMA_FORMATTER 0x2C00
169 /* Selectors for the Chrominance controls [GS]ET_CHROM_CTL */
170 #define WB_MODE_FORMATTER 0x1000
171 #define AWB_CONTROL_SPEED_FORMATTER 0x1100
172 #define AWB_CONTROL_DELAY_FORMATTER 0x1200
173 #define PRESET_MANUAL_RED_GAIN_FORMATTER 0x1300
174 #define PRESET_MANUAL_BLUE_GAIN_FORMATTER 0x1400
175 #define COLOUR_MODE_FORMATTER 0x1500
176 #define SATURATION_MODE_FORMATTER1 0x1600
177 #define SATURATION_MODE_FORMATTER2 0x1700
179 /* Selectors for the Status controls [GS]ET_STATUS_CTL */
180 #define SAVE_USER_DEFAULTS_FORMATTER 0x0200
181 #define RESTORE_USER_DEFAULTS_FORMATTER 0x0300
182 #define RESTORE_FACTORY_DEFAULTS_FORMATTER 0x0400
183 #define READ_AGC_FORMATTER 0x0500
184 #define READ_SHUTTER_FORMATTER 0x0600
185 #define READ_RED_GAIN_FORMATTER 0x0700
186 #define READ_BLUE_GAIN_FORMATTER 0x0800
188 /* Formatters for the motorized pan & tilt [GS]ET_MPT_CTL */
189 #define PT_RELATIVE_CONTROL_FORMATTER 0x01
190 #define PT_RESET_CONTROL_FORMATTER 0x02
191 #define PT_STATUS_FORMATTER 0x03
193 /* Enumeration of image sizes */
194 #define PSZ_SQCIF 0x00
195 #define PSZ_QSIF 0x01
196 #define PSZ_QCIF 0x02
202 struct pwc_raw_frame {
203 __le16 type; /* type of the webcam */
204 __le16 vbandlength; /* Size of 4 lines compressed (used by the
206 __u8 cmd[4]; /* the four byte of the command (in case of
207 nala, only the first 3 bytes is filled) */
208 __u8 rawframe[0]; /* frame_size = H / 4 * vbandlength */
211 /* intermediate buffers with raw data from the USB cam */
214 struct vb2_buffer vb; /* common v4l buffer stuff -- must be first */
215 struct list_head list;
217 int filled; /* number of bytes filled */
222 struct video_device vdev;
223 struct v4l2_device v4l2_dev;
225 /* Pointer to our usb_device, may be NULL after unplug */
226 struct usb_device *udev;
227 struct mutex udevlock;
229 /* type of cam (645, 646, 675, 680, 690, 720, 730, 740, 750) */
231 int release; /* release number */
232 int features; /* feature bits */
235 struct file *capt_file; /* file doing video capture */
236 struct mutex capt_file_lock;
237 int vendpoint; /* video isoc endpoint */
238 int vcinterface; /* video control interface */
239 int valternate; /* alternate interface needed */
240 int vframes; /* frames-per-second */
241 int pixfmt; /* pixelformat: V4L2_PIX_FMT_YUV420 or _PWCX */
242 int vframe_count; /* received frames */
243 int vmax_packet_size; /* USB maxpacket size */
244 int vlast_packet_size; /* for frame synchronisation */
245 int visoc_errors; /* number of contiguous ISOC errors */
246 int vbandlength; /* compressed band length; 0 is uncompressed */
247 char vsync; /* used by isoc handler */
248 char vmirror; /* for ToUCaM series */
249 char power_save; /* Do powersaving for this cam */
252 unsigned char cmd_buf[13];
254 struct urb *urbs[MAX_ISO_BUFS];
257 /* videobuf2 queue and queued buffers list */
258 struct vb2_queue vb_queue;
259 struct list_head queued_bufs;
260 spinlock_t queued_bufs_lock;
263 * Frame currently being filled, this only gets touched by the
264 * isoc urb complete handler, and by stream start / stop since
265 * start / stop touch it before / after starting / killing the urbs
266 * no locking is needed around this
268 struct pwc_frame_buf *fill_buf;
270 int frame_header_size, frame_trailer_size;
272 int frame_total_size; /* including header & trailer */
275 void *decompress_data; /* private data for decompression engine */
278 * We have an 'image' and a 'view', where 'image' is the fixed-size img
279 * as delivered by the camera, and 'view' is the size requested by the
280 * program. The camera image is centered in this viewport, laced with
281 * a gray or black border. view_min <= image <= view <= view_max;
283 int image_mask; /* supported sizes */
284 int width, height; /* current resolution */
286 #ifdef CONFIG_USB_PWC_INPUT_EVDEV
287 struct input_dev *button_dev; /* webcam snapshot button input */
288 char button_phys[64];
292 struct v4l2_ctrl_handler ctrl_handler;
294 struct v4l2_ctrl *brightness;
295 struct v4l2_ctrl *contrast;
296 struct v4l2_ctrl *saturation;
297 struct v4l2_ctrl *gamma;
299 /* awb / red-blue balance cluster */
300 struct v4l2_ctrl *auto_white_balance;
301 struct v4l2_ctrl *red_balance;
302 struct v4l2_ctrl *blue_balance;
303 /* usb ctrl transfers are slow, so we cache things */
305 unsigned long last_color_bal_update; /* In jiffies */
306 s32 last_red_balance;
307 s32 last_blue_balance;
310 /* autogain / gain cluster */
311 struct v4l2_ctrl *autogain;
312 struct v4l2_ctrl *gain;
314 unsigned long last_gain_update; /* In jiffies */
318 /* exposure_auto / exposure cluster */
319 struct v4l2_ctrl *exposure_auto;
320 struct v4l2_ctrl *exposure;
322 unsigned long last_exposure_update; /* In jiffies */
325 struct v4l2_ctrl *colorfx;
327 /* autocontour/contour cluster */
328 struct v4l2_ctrl *autocontour;
329 struct v4l2_ctrl *contour;
331 struct v4l2_ctrl *backlight;
332 struct v4l2_ctrl *flicker;
333 struct v4l2_ctrl *noise_reduction;
334 struct v4l2_ctrl *save_user;
335 struct v4l2_ctrl *restore_user;
336 struct v4l2_ctrl *restore_factory;
337 struct v4l2_ctrl *awb_speed;
338 struct v4l2_ctrl *awb_delay;
340 /* motor control cluster */
341 struct v4l2_ctrl *motor_pan;
342 struct v4l2_ctrl *motor_tilt;
343 struct v4l2_ctrl *motor_pan_reset;
344 struct v4l2_ctrl *motor_tilt_reset;
346 /* CODEC3 models have both gain and exposure controlled by autogain */
347 struct v4l2_ctrl *autogain_expo_cluster[3];
350 /* Global variables */
351 #ifdef CONFIG_USB_PWC_DEBUG
352 extern int pwc_trace;
355 int pwc_test_n_set_capt_file(struct pwc_device *pdev, struct file *file);
357 /** Functions in pwc-misc.c */
358 /* sizes in pixels */
359 extern const int pwc_image_sizes[PSZ_MAX][2];
361 int pwc_get_size(struct pwc_device *pdev, int width, int height);
362 void pwc_construct(struct pwc_device *pdev);
364 /** Functions in pwc-ctrl.c */
365 /* Request a certain video mode. Returns < 0 if not possible */
366 extern int pwc_set_video_mode(struct pwc_device *pdev, int width, int height,
367 int frames, int *compression);
368 extern unsigned int pwc_get_fps(struct pwc_device *pdev, unsigned int index, unsigned int size);
369 extern int pwc_set_leds(struct pwc_device *pdev, int on_value, int off_value);
370 extern int pwc_get_cmos_sensor(struct pwc_device *pdev, int *sensor);
371 extern int send_control_msg(struct pwc_device *pdev,
372 u8 request, u16 value, void *buf, int buflen);
374 /* Control get / set helpers */
375 int pwc_get_u8_ctrl(struct pwc_device *pdev, u8 request, u16 value, int *data);
376 int pwc_set_u8_ctrl(struct pwc_device *pdev, u8 request, u16 value, u8 data);
377 int pwc_get_s8_ctrl(struct pwc_device *pdev, u8 request, u16 value, int *data);
378 #define pwc_set_s8_ctrl pwc_set_u8_ctrl
379 int pwc_get_u16_ctrl(struct pwc_device *pdev, u8 request, u16 value, int *dat);
380 int pwc_set_u16_ctrl(struct pwc_device *pdev, u8 request, u16 value, u16 data);
381 int pwc_button_ctrl(struct pwc_device *pdev, u16 value);
382 int pwc_init_controls(struct pwc_device *pdev);
384 /* Power down or up the camera; not supported by all models */
385 extern void pwc_camera_power(struct pwc_device *pdev, int power);
387 extern const struct v4l2_ioctl_ops pwc_ioctl_ops;
389 /** pwc-uncompress.c */
390 /* Expand frame to image, possibly including decompression. Uses read_frame and fill_image */
391 int pwc_decompress(struct pwc_device *pdev, struct pwc_frame_buf *fbuf);