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>
48 #include <media/pwc-ioctl.h>
51 #define PWC_VERSION "10.0.15"
52 #define PWC_NAME "pwc"
53 #define PFX PWC_NAME ": "
56 /* Trace certain actions in the driver */
57 #define PWC_DEBUG_LEVEL_MODULE (1<<0)
58 #define PWC_DEBUG_LEVEL_PROBE (1<<1)
59 #define PWC_DEBUG_LEVEL_OPEN (1<<2)
60 #define PWC_DEBUG_LEVEL_READ (1<<3)
61 #define PWC_DEBUG_LEVEL_MEMORY (1<<4)
62 #define PWC_DEBUG_LEVEL_FLOW (1<<5)
63 #define PWC_DEBUG_LEVEL_SIZE (1<<6)
64 #define PWC_DEBUG_LEVEL_IOCTL (1<<7)
65 #define PWC_DEBUG_LEVEL_TRACE (1<<8)
67 #define PWC_DEBUG_MODULE(fmt, args...) PWC_DEBUG(MODULE, fmt, ##args)
68 #define PWC_DEBUG_PROBE(fmt, args...) PWC_DEBUG(PROBE, fmt, ##args)
69 #define PWC_DEBUG_OPEN(fmt, args...) PWC_DEBUG(OPEN, fmt, ##args)
70 #define PWC_DEBUG_READ(fmt, args...) PWC_DEBUG(READ, fmt, ##args)
71 #define PWC_DEBUG_MEMORY(fmt, args...) PWC_DEBUG(MEMORY, fmt, ##args)
72 #define PWC_DEBUG_FLOW(fmt, args...) PWC_DEBUG(FLOW, fmt, ##args)
73 #define PWC_DEBUG_SIZE(fmt, args...) PWC_DEBUG(SIZE, fmt, ##args)
74 #define PWC_DEBUG_IOCTL(fmt, args...) PWC_DEBUG(IOCTL, fmt, ##args)
75 #define PWC_DEBUG_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args)
78 #ifdef CONFIG_USB_PWC_DEBUG
80 #define PWC_DEBUG_LEVEL (PWC_DEBUG_LEVEL_MODULE)
82 #define PWC_DEBUG(level, fmt, args...) do {\
83 if ((PWC_DEBUG_LEVEL_ ##level) & pwc_trace) \
84 printk(KERN_DEBUG PFX fmt, ##args); \
87 #define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args)
88 #define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args)
89 #define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args)
90 #define PWC_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args)
92 #else /* if ! CONFIG_USB_PWC_DEBUG */
94 #define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args)
95 #define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args)
96 #define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args)
97 #define PWC_TRACE(fmt, args...) do { } while(0)
98 #define PWC_DEBUG(level, fmt, args...) do { } while(0)
104 /* Defines for ToUCam cameras */
105 #define TOUCAM_HEADER_SIZE 8
106 #define TOUCAM_TRAILER_SIZE 4
108 #define FEATURE_MOTOR_PANTILT 0x0001
109 #define FEATURE_CODEC1 0x0002
110 #define FEATURE_CODEC2 0x0004
112 /* Ignore errors in the first N frames, to allow for startup delays */
113 #define FRAME_LOWMARK 5
115 /* Size and number of buffers for the ISO pipe. */
116 #define MAX_ISO_BUFS 3
117 #define ISO_FRAMES_PER_DESC 10
118 #define ISO_MAX_FRAME_SIZE 960
119 #define ISO_BUFFER_SIZE (ISO_FRAMES_PER_DESC * ISO_MAX_FRAME_SIZE)
121 /* Maximum size after decompression is 640x480 YUV data, 1.5 * 640 * 480 */
122 #define PWC_FRAME_SIZE (460800 + TOUCAM_HEADER_SIZE + TOUCAM_TRAILER_SIZE)
124 /* Absolute minimum and maximum number of buffers available for mmap() */
126 #define MAX_FRAMES 16
128 /* Some macros to quickly find the type of a webcam */
129 #define DEVICE_USE_CODEC1(x) ((x)<675)
130 #define DEVICE_USE_CODEC2(x) ((x)>=675 && (x)<700)
131 #define DEVICE_USE_CODEC3(x) ((x)>=700)
132 #define DEVICE_USE_CODEC23(x) ((x)>=675)
135 #define PWCX_FLAG_PLANAR 0x0001
137 /* Request types: video */
138 #define SET_LUM_CTL 0x01
139 #define GET_LUM_CTL 0x02
140 #define SET_CHROM_CTL 0x03
141 #define GET_CHROM_CTL 0x04
142 #define SET_STATUS_CTL 0x05
143 #define GET_STATUS_CTL 0x06
144 #define SET_EP_STREAM_CTL 0x07
145 #define GET_EP_STREAM_CTL 0x08
146 #define GET_XX_CTL 0x09
147 #define SET_XX_CTL 0x0A
148 #define GET_XY_CTL 0x0B
149 #define SET_XY_CTL 0x0C
150 #define SET_MPT_CTL 0x0D
151 #define GET_MPT_CTL 0x0E
153 /* Selectors for the Luminance controls [GS]ET_LUM_CTL */
154 #define AGC_MODE_FORMATTER 0x2000
155 #define PRESET_AGC_FORMATTER 0x2100
156 #define SHUTTER_MODE_FORMATTER 0x2200
157 #define PRESET_SHUTTER_FORMATTER 0x2300
158 #define PRESET_CONTOUR_FORMATTER 0x2400
159 #define AUTO_CONTOUR_FORMATTER 0x2500
160 #define BACK_LIGHT_COMPENSATION_FORMATTER 0x2600
161 #define CONTRAST_FORMATTER 0x2700
162 #define DYNAMIC_NOISE_CONTROL_FORMATTER 0x2800
163 #define FLICKERLESS_MODE_FORMATTER 0x2900
164 #define AE_CONTROL_SPEED 0x2A00
165 #define BRIGHTNESS_FORMATTER 0x2B00
166 #define GAMMA_FORMATTER 0x2C00
168 /* Selectors for the Chrominance controls [GS]ET_CHROM_CTL */
169 #define WB_MODE_FORMATTER 0x1000
170 #define AWB_CONTROL_SPEED_FORMATTER 0x1100
171 #define AWB_CONTROL_DELAY_FORMATTER 0x1200
172 #define PRESET_MANUAL_RED_GAIN_FORMATTER 0x1300
173 #define PRESET_MANUAL_BLUE_GAIN_FORMATTER 0x1400
174 #define COLOUR_MODE_FORMATTER 0x1500
175 #define SATURATION_MODE_FORMATTER1 0x1600
176 #define SATURATION_MODE_FORMATTER2 0x1700
178 /* Selectors for the Status controls [GS]ET_STATUS_CTL */
179 #define SAVE_USER_DEFAULTS_FORMATTER 0x0200
180 #define RESTORE_USER_DEFAULTS_FORMATTER 0x0300
181 #define RESTORE_FACTORY_DEFAULTS_FORMATTER 0x0400
182 #define READ_AGC_FORMATTER 0x0500
183 #define READ_SHUTTER_FORMATTER 0x0600
184 #define READ_RED_GAIN_FORMATTER 0x0700
185 #define READ_BLUE_GAIN_FORMATTER 0x0800
187 /* Formatters for the motorized pan & tilt [GS]ET_MPT_CTL */
188 #define PT_RELATIVE_CONTROL_FORMATTER 0x01
189 #define PT_RESET_CONTROL_FORMATTER 0x02
190 #define PT_STATUS_FORMATTER 0x03
192 /* intermediate buffers with raw data from the USB cam */
195 struct vb2_buffer vb
; /* common v4l buffer stuff -- must be first */
196 struct list_head list
;
198 int filled
; /* number of bytes filled */
203 struct video_device vdev
;
204 struct v4l2_device v4l2_dev
;
205 struct mutex modlock
;
207 /* Pointer to our usb_device, may be NULL after unplug */
208 struct usb_device
*udev
;
209 /* Protects the setting of udev to NULL by our disconnect handler */
210 struct mutex udevlock
;
212 /* type of cam (645, 646, 675, 680, 690, 720, 730, 740, 750) */
214 int release
; /* release number */
215 int features
; /* feature bits */
216 char serial
[30]; /* serial number (string) */
219 struct file
*capt_file
; /* file doing video capture */
220 int vendpoint
; /* video isoc endpoint */
221 int vcinterface
; /* video control interface */
222 int valternate
; /* alternate interface needed */
223 int vframes
, vsize
; /* frames-per-second & size (see PSZ_*) */
224 int pixfmt
; /* pixelformat: V4L2_PIX_FMT_YUV420 or _PWCX */
225 int vframe_count
; /* received frames */
226 int vmax_packet_size
; /* USB maxpacket size */
227 int vlast_packet_size
; /* for frame synchronisation */
228 int visoc_errors
; /* number of contiguous ISOC errors */
229 int vcompression
; /* desired compression factor */
230 int vbandlength
; /* compressed band length; 0 is uncompressed */
231 char vsnapshot
; /* snapshot mode */
232 char vsync
; /* used by isoc handler */
233 char vmirror
; /* for ToUCaM series */
234 char power_save
; /* Do powersaving for this cam */
237 unsigned char cmd_buf
[13];
239 struct urb
*urbs
[MAX_ISO_BUFS
];
242 /* videobuf2 queue and queued buffers list */
243 struct vb2_queue vb_queue
;
244 struct list_head queued_bufs
;
245 spinlock_t queued_bufs_lock
;
248 * Frame currently being filled, this only gets touched by the
249 * isoc urb complete handler, and by stream start / stop since
250 * start / stop touch it before / after starting / killing the urbs
251 * no locking is needed around this
253 struct pwc_frame_buf
*fill_buf
;
255 int frame_header_size
, frame_trailer_size
;
257 int frame_total_size
; /* including header & trailer */
260 void *decompress_data
; /* private data for decompression engine */
263 * We have an 'image' and a 'view', where 'image' is the fixed-size img
264 * as delivered by the camera, and 'view' is the size requested by the
265 * program. The camera image is centered in this viewport, laced with
266 * a gray or black border. view_min <= image <= view <= view_max;
268 int image_mask
; /* supported sizes */
269 struct pwc_coord view_min
, view_max
; /* minimum and maximum view */
270 struct pwc_coord abs_max
; /* maximum supported size */
271 struct pwc_coord image
, view
; /* image and viewport size */
272 struct pwc_coord offset
; /* offset of the viewport */
274 /*** motorized pan/tilt feature */
275 struct pwc_mpt_range angle_range
;
276 int pan_angle
; /* in degrees * 100 */
277 int tilt_angle
; /* absolute angle; 0,0 is home */
280 * Set to 1 when the user push the button, reset to 0
281 * when this value is read from sysfs.
283 int snapshot_button_status
;
284 #ifdef CONFIG_USB_PWC_INPUT_EVDEV
285 struct input_dev
*button_dev
; /* webcam snapshot button input */
286 char button_phys
[64];
290 struct v4l2_ctrl_handler ctrl_handler
;
292 struct v4l2_ctrl
*brightness
;
293 struct v4l2_ctrl
*contrast
;
294 struct v4l2_ctrl
*saturation
;
295 struct v4l2_ctrl
*gamma
;
297 /* awb / red-blue balance cluster */
298 struct v4l2_ctrl
*auto_white_balance
;
299 struct v4l2_ctrl
*red_balance
;
300 struct v4l2_ctrl
*blue_balance
;
301 /* usb ctrl transfers are slow, so we cache things */
303 unsigned long last_color_bal_update
; /* In jiffies */
304 s32 last_red_balance
;
305 s32 last_blue_balance
;
308 /* autogain / gain cluster */
309 struct v4l2_ctrl
*autogain
;
310 struct v4l2_ctrl
*gain
;
312 unsigned long last_gain_update
; /* In jiffies */
316 /* exposure_auto / exposure cluster */
317 struct v4l2_ctrl
*exposure_auto
;
318 struct v4l2_ctrl
*exposure
;
320 unsigned long last_exposure_update
; /* In jiffies */
323 struct v4l2_ctrl
*colorfx
;
325 /* autocontour/contour cluster */
326 struct v4l2_ctrl
*autocontour
;
327 struct v4l2_ctrl
*contour
;
329 struct v4l2_ctrl
*backlight
;
330 struct v4l2_ctrl
*flicker
;
331 struct v4l2_ctrl
*noise_reduction
;
332 struct v4l2_ctrl
*save_user
;
333 struct v4l2_ctrl
*restore_user
;
334 struct v4l2_ctrl
*restore_factory
;
335 struct v4l2_ctrl
*awb_speed
;
336 struct v4l2_ctrl
*awb_delay
;
338 /* motor control cluster */
339 struct v4l2_ctrl
*motor_pan
;
340 struct v4l2_ctrl
*motor_tilt
;
341 struct v4l2_ctrl
*motor_pan_reset
;
342 struct v4l2_ctrl
*motor_tilt_reset
;
344 /* CODEC3 models have both gain and exposure controlled by autogain */
345 struct v4l2_ctrl
*autogain_expo_cluster
[3];
348 /* Global variables */
349 #ifdef CONFIG_USB_PWC_DEBUG
350 extern int pwc_trace
;
353 /** Functions in pwc-misc.c */
354 /* sizes in pixels */
355 extern const struct pwc_coord pwc_image_sizes
[PSZ_MAX
];
357 int pwc_decode_size(struct pwc_device
*pdev
, int width
, int height
);
358 void pwc_construct(struct pwc_device
*pdev
);
360 /** Functions in pwc-ctrl.c */
361 /* Request a certain video mode. Returns < 0 if not possible */
362 extern int pwc_set_video_mode(struct pwc_device
*pdev
, int width
, int height
, int frames
, int compression
, int snapshot
);
363 extern unsigned int pwc_get_fps(struct pwc_device
*pdev
, unsigned int index
, unsigned int size
);
364 extern int pwc_mpt_reset(struct pwc_device
*pdev
, int flags
);
365 extern int pwc_mpt_set_angle(struct pwc_device
*pdev
, int pan
, int tilt
);
366 extern int pwc_set_leds(struct pwc_device
*pdev
, int on_value
, int off_value
);
367 extern int pwc_get_cmos_sensor(struct pwc_device
*pdev
, int *sensor
);
368 extern int send_control_msg(struct pwc_device
*pdev
,
369 u8 request
, u16 value
, void *buf
, int buflen
);
371 /* Control get / set helpers */
372 int pwc_get_u8_ctrl(struct pwc_device
*pdev
, u8 request
, u16 value
, int *data
);
373 int pwc_set_u8_ctrl(struct pwc_device
*pdev
, u8 request
, u16 value
, u8 data
);
374 int pwc_get_s8_ctrl(struct pwc_device
*pdev
, u8 request
, u16 value
, int *data
);
375 #define pwc_set_s8_ctrl pwc_set_u8_ctrl
376 int pwc_get_u16_ctrl(struct pwc_device
*pdev
, u8 request
, u16 value
, int *dat
);
377 int pwc_set_u16_ctrl(struct pwc_device
*pdev
, u8 request
, u16 value
, u16 data
);
378 int pwc_button_ctrl(struct pwc_device
*pdev
, u16 value
);
379 int pwc_init_controls(struct pwc_device
*pdev
);
381 /* Power down or up the camera; not supported by all models */
382 extern void pwc_camera_power(struct pwc_device
*pdev
, int power
);
384 /* Private ioctl()s; see pwc-ioctl.h */
385 extern long pwc_ioctl(struct pwc_device
*pdev
, unsigned int cmd
, void *arg
);
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
);