Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* (C) 1999-2003 Nemosoft Unv. |
2b455db6 | 2 | (C) 2004-2006 Luc Saillard (luc@saillard.org) |
1da177e4 LT |
3 | |
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. | |
9 | ||
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. | |
14 | ||
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. | |
19 | ||
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 | |
23 | */ | |
24 | ||
25 | #ifndef PWC_H | |
26 | #define PWC_H | |
27 | ||
1da177e4 LT |
28 | #include <linux/module.h> |
29 | #include <linux/usb.h> | |
30 | #include <linux/spinlock.h> | |
1da177e4 | 31 | #include <linux/wait.h> |
2b455db6 | 32 | #include <linux/version.h> |
b9378fdb | 33 | #include <linux/mutex.h> |
38413fd2 | 34 | #include <linux/mm.h> |
5a0e3ad6 | 35 | #include <linux/slab.h> |
1da177e4 | 36 | #include <asm/errno.h> |
479567ce | 37 | #include <linux/videodev2.h> |
5e87efa3 | 38 | #include <media/v4l2-common.h> |
35ea11ff | 39 | #include <media/v4l2-ioctl.h> |
e32a7ecc NPT |
40 | #ifdef CONFIG_USB_PWC_INPUT_EVDEV |
41 | #include <linux/input.h> | |
42 | #endif | |
1da177e4 LT |
43 | |
44 | #include "pwc-uncompress.h" | |
2b455db6 | 45 | #include <media/pwc-ioctl.h> |
1da177e4 | 46 | |
2b455db6 LS |
47 | /* Version block */ |
48 | #define PWC_MAJOR 10 | |
49 | #define PWC_MINOR 0 | |
50 | #define PWC_EXTRAMINOR 12 | |
51 | #define PWC_VERSION_CODE KERNEL_VERSION(PWC_MAJOR,PWC_MINOR,PWC_EXTRAMINOR) | |
479567ce | 52 | #define PWC_VERSION "10.0.14" |
2b455db6 LS |
53 | #define PWC_NAME "pwc" |
54 | #define PFX PWC_NAME ": " | |
55 | ||
1da177e4 LT |
56 | |
57 | /* Trace certain actions in the driver */ | |
2b455db6 LS |
58 | #define PWC_DEBUG_LEVEL_MODULE (1<<0) |
59 | #define PWC_DEBUG_LEVEL_PROBE (1<<1) | |
60 | #define PWC_DEBUG_LEVEL_OPEN (1<<2) | |
61 | #define PWC_DEBUG_LEVEL_READ (1<<3) | |
62 | #define PWC_DEBUG_LEVEL_MEMORY (1<<4) | |
63 | #define PWC_DEBUG_LEVEL_FLOW (1<<5) | |
64 | #define PWC_DEBUG_LEVEL_SIZE (1<<6) | |
65 | #define PWC_DEBUG_LEVEL_IOCTL (1<<7) | |
66 | #define PWC_DEBUG_LEVEL_TRACE (1<<8) | |
67 | ||
68 | #define PWC_DEBUG_MODULE(fmt, args...) PWC_DEBUG(MODULE, fmt, ##args) | |
69 | #define PWC_DEBUG_PROBE(fmt, args...) PWC_DEBUG(PROBE, fmt, ##args) | |
70 | #define PWC_DEBUG_OPEN(fmt, args...) PWC_DEBUG(OPEN, fmt, ##args) | |
71 | #define PWC_DEBUG_READ(fmt, args...) PWC_DEBUG(READ, fmt, ##args) | |
72 | #define PWC_DEBUG_MEMORY(fmt, args...) PWC_DEBUG(MEMORY, fmt, ##args) | |
73 | #define PWC_DEBUG_FLOW(fmt, args...) PWC_DEBUG(FLOW, fmt, ##args) | |
74 | #define PWC_DEBUG_SIZE(fmt, args...) PWC_DEBUG(SIZE, fmt, ##args) | |
75 | #define PWC_DEBUG_IOCTL(fmt, args...) PWC_DEBUG(IOCTL, fmt, ##args) | |
76 | #define PWC_DEBUG_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args) | |
77 | ||
78 | ||
05ad3907 | 79 | #ifdef CONFIG_USB_PWC_DEBUG |
2b455db6 LS |
80 | |
81 | #define PWC_DEBUG_LEVEL (PWC_DEBUG_LEVEL_MODULE) | |
82 | ||
83 | #define PWC_DEBUG(level, fmt, args...) do {\ | |
84 | if ((PWC_DEBUG_LEVEL_ ##level) & pwc_trace) \ | |
85 | printk(KERN_DEBUG PFX fmt, ##args); \ | |
86 | } while(0) | |
87 | ||
88 | #define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args) | |
89 | #define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args) | |
90 | #define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args) | |
91 | #define PWC_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args) | |
92 | ||
9ee6d78c | 93 | #else /* if ! CONFIG_USB_PWC_DEBUG */ |
2b455db6 LS |
94 | |
95 | #define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args) | |
96 | #define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args) | |
97 | #define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args) | |
98 | #define PWC_TRACE(fmt, args...) do { } while(0) | |
99 | #define PWC_DEBUG(level, fmt, args...) do { } while(0) | |
100 | ||
101 | #define pwc_trace 0 | |
1da177e4 | 102 | |
2b455db6 | 103 | #endif |
1da177e4 LT |
104 | |
105 | /* Defines for ToUCam cameras */ | |
106 | #define TOUCAM_HEADER_SIZE 8 | |
107 | #define TOUCAM_TRAILER_SIZE 4 | |
108 | ||
109 | #define FEATURE_MOTOR_PANTILT 0x0001 | |
2b455db6 LS |
110 | #define FEATURE_CODEC1 0x0002 |
111 | #define FEATURE_CODEC2 0x0004 | |
1da177e4 LT |
112 | |
113 | /* Turn certain features on/off */ | |
114 | #define PWC_INT_PIPE 0 | |
115 | ||
116 | /* Ignore errors in the first N frames, to allow for startup delays */ | |
117 | #define FRAME_LOWMARK 5 | |
118 | ||
119 | /* Size and number of buffers for the ISO pipe. */ | |
120 | #define MAX_ISO_BUFS 2 | |
121 | #define ISO_FRAMES_PER_DESC 10 | |
122 | #define ISO_MAX_FRAME_SIZE 960 | |
123 | #define ISO_BUFFER_SIZE (ISO_FRAMES_PER_DESC * ISO_MAX_FRAME_SIZE) | |
124 | ||
125 | /* Frame buffers: contains compressed or uncompressed video data. */ | |
126 | #define MAX_FRAMES 5 | |
127 | /* Maximum size after decompression is 640x480 YUV data, 1.5 * 640 * 480 */ | |
128 | #define PWC_FRAME_SIZE (460800 + TOUCAM_HEADER_SIZE + TOUCAM_TRAILER_SIZE) | |
129 | ||
130 | /* Absolute maximum number of buffers available for mmap() */ | |
131 | #define MAX_IMAGES 10 | |
132 | ||
2b455db6 LS |
133 | /* Some macros to quickly find the type of a webcam */ |
134 | #define DEVICE_USE_CODEC1(x) ((x)<675) | |
135 | #define DEVICE_USE_CODEC2(x) ((x)>=675 && (x)<700) | |
136 | #define DEVICE_USE_CODEC3(x) ((x)>=700) | |
137 | #define DEVICE_USE_CODEC23(x) ((x)>=675) | |
138 | ||
1da177e4 LT |
139 | /* The following structures were based on cpia.h. Why reinvent the wheel? :-) */ |
140 | struct pwc_iso_buf | |
141 | { | |
142 | void *data; | |
143 | int length; | |
144 | int read; | |
145 | struct urb *urb; | |
146 | }; | |
147 | ||
148 | /* intermediate buffers with raw data from the USB cam */ | |
149 | struct pwc_frame_buf | |
150 | { | |
151 | void *data; | |
152 | volatile int filled; /* number of bytes filled */ | |
153 | struct pwc_frame_buf *next; /* list */ | |
2b455db6 LS |
154 | }; |
155 | ||
156 | /* additionnal informations used when dealing image between kernel and userland */ | |
157 | struct pwc_imgbuf | |
158 | { | |
159 | unsigned long offset; /* offset of this buffer in the big array of image_data */ | |
160 | int vma_use_count; /* count the number of time this memory is mapped */ | |
1da177e4 LT |
161 | }; |
162 | ||
163 | struct pwc_device | |
164 | { | |
165 | struct video_device *vdev; | |
2b455db6 | 166 | |
1da177e4 LT |
167 | /* Pointer to our usb_device */ |
168 | struct usb_device *udev; | |
d56410e0 | 169 | |
1da177e4 LT |
170 | int type; /* type of cam (645, 646, 675, 680, 690, 720, 730, 740, 750) */ |
171 | int release; /* release number */ | |
172 | int features; /* feature bits */ | |
173 | char serial[30]; /* serial number (string) */ | |
174 | int error_status; /* set when something goes wrong with the cam (unplugged, USB errors) */ | |
175 | int usb_init; /* set when the cam has been initialized over USB */ | |
176 | ||
177 | /*** Video data ***/ | |
178 | int vopen; /* flag */ | |
179 | int vendpoint; /* video isoc endpoint */ | |
180 | int vcinterface; /* video control interface */ | |
181 | int valternate; /* alternate interface needed */ | |
182 | int vframes, vsize; /* frames-per-second & size (see PSZ_*) */ | |
479567ce | 183 | int pixfmt; /* pixelformat: V4L2_PIX_FMT_YUV420 or raw: _PWC1, _PWC2 */ |
1da177e4 LT |
184 | int vframe_count; /* received frames */ |
185 | int vframes_dumped; /* counter for dumped frames */ | |
186 | int vframes_error; /* frames received in error */ | |
187 | int vmax_packet_size; /* USB maxpacket size */ | |
188 | int vlast_packet_size; /* for frame synchronisation */ | |
189 | int visoc_errors; /* number of contiguous ISOC errors */ | |
190 | int vcompression; /* desired compression factor */ | |
191 | int vbandlength; /* compressed band length; 0 is uncompressed */ | |
192 | char vsnapshot; /* snapshot mode */ | |
193 | char vsync; /* used by isoc handler */ | |
194 | char vmirror; /* for ToUCaM series */ | |
85237f20 | 195 | char unplugged; |
d56410e0 | 196 | |
1da177e4 LT |
197 | int cmd_len; |
198 | unsigned char cmd_buf[13]; | |
199 | ||
200 | /* The image acquisition requires 3 to 4 steps: | |
201 | 1. data is gathered in short packets from the USB controller | |
202 | 2. data is synchronized and packed into a frame buffer | |
203 | 3a. in case data is compressed, decompress it directly into image buffer | |
204 | 3b. in case data is uncompressed, copy into image buffer with viewport | |
205 | 4. data is transferred to the user process | |
206 | ||
207 | Note that MAX_ISO_BUFS != MAX_FRAMES != MAX_IMAGES.... | |
208 | We have in effect a back-to-back-double-buffer system. | |
209 | */ | |
210 | /* 1: isoc */ | |
211 | struct pwc_iso_buf sbuf[MAX_ISO_BUFS]; | |
212 | char iso_init; | |
213 | ||
214 | /* 2: frame */ | |
215 | struct pwc_frame_buf *fbuf; /* all frames */ | |
216 | struct pwc_frame_buf *empty_frames, *empty_frames_tail; /* all empty frames */ | |
217 | struct pwc_frame_buf *full_frames, *full_frames_tail; /* all filled frames */ | |
218 | struct pwc_frame_buf *fill_frame; /* frame currently being filled */ | |
219 | struct pwc_frame_buf *read_frame; /* frame currently read by user process */ | |
220 | int frame_header_size, frame_trailer_size; | |
221 | int frame_size; | |
222 | int frame_total_size; /* including header & trailer */ | |
223 | int drop_frames; | |
1da177e4 LT |
224 | |
225 | /* 3: decompression */ | |
1da177e4 LT |
226 | void *decompress_data; /* private data for decompression engine */ |
227 | ||
228 | /* 4: image */ | |
229 | /* We have an 'image' and a 'view', where 'image' is the fixed-size image | |
230 | as delivered by the camera, and 'view' is the size requested by the | |
231 | program. The camera image is centered in this viewport, laced with | |
232 | a gray or black border. view_min <= image <= view <= view_max; | |
233 | */ | |
234 | int image_mask; /* bitmask of supported sizes */ | |
235 | struct pwc_coord view_min, view_max; /* minimum and maximum viewable sizes */ | |
236 | struct pwc_coord abs_max; /* maximum supported size with compression */ | |
237 | struct pwc_coord image, view; /* image and viewport size */ | |
238 | struct pwc_coord offset; /* offset within the viewport */ | |
239 | ||
240 | void *image_data; /* total buffer, which is subdivided into ... */ | |
2b455db6 | 241 | struct pwc_imgbuf images[MAX_IMAGES];/* ...several images... */ |
1da177e4 LT |
242 | int fill_image; /* ...which are rotated. */ |
243 | int len_per_image; /* length per image */ | |
244 | int image_read_pos; /* In case we read data in pieces, keep track of were we are in the imagebuffer */ | |
245 | int image_used[MAX_IMAGES]; /* For MCAPTURE and SYNC */ | |
246 | ||
b9378fdb | 247 | struct mutex modlock; /* to prevent races in video_open(), etc */ |
1da177e4 LT |
248 | spinlock_t ptrlock; /* for manipulating the buffer pointers */ |
249 | ||
250 | /*** motorized pan/tilt feature */ | |
251 | struct pwc_mpt_range angle_range; | |
252 | int pan_angle; /* in degrees * 100 */ | |
253 | int tilt_angle; /* absolute angle; 0,0 is home position */ | |
2b455db6 | 254 | int snapshot_button_status; /* set to 1 when the user push the button, reset to 0 when this value is read */ |
e32a7ecc NPT |
255 | #ifdef CONFIG_USB_PWC_INPUT_EVDEV |
256 | struct input_dev *button_dev; /* webcam snapshot button input */ | |
89dec01b | 257 | char button_phys[64]; |
e32a7ecc | 258 | #endif |
1da177e4 LT |
259 | |
260 | /*** Misc. data ***/ | |
261 | wait_queue_head_t frameq; /* When waiting for a frame to finish... */ | |
262 | #if PWC_INT_PIPE | |
263 | void *usb_int_handler; /* for the interrupt endpoint */ | |
264 | #endif | |
265 | }; | |
266 | ||
1da177e4 LT |
267 | #ifdef __cplusplus |
268 | extern "C" { | |
269 | #endif | |
270 | ||
2b455db6 | 271 | /* Global variables */ |
05ad3907 | 272 | #ifdef CONFIG_USB_PWC_DEBUG |
1da177e4 | 273 | extern int pwc_trace; |
2b455db6 | 274 | #endif |
2b455db6 | 275 | extern int pwc_mbufs; |
1da177e4 LT |
276 | |
277 | /** functions in pwc-if.c */ | |
2b455db6 LS |
278 | int pwc_handle_frame(struct pwc_device *pdev); |
279 | void pwc_next_image(struct pwc_device *pdev); | |
280 | int pwc_isoc_init(struct pwc_device *pdev); | |
281 | void pwc_isoc_cleanup(struct pwc_device *pdev); | |
1da177e4 LT |
282 | |
283 | /** Functions in pwc-misc.c */ | |
284 | /* sizes in pixels */ | |
2b455db6 | 285 | extern const struct pwc_coord pwc_image_sizes[PSZ_MAX]; |
1da177e4 LT |
286 | |
287 | int pwc_decode_size(struct pwc_device *pdev, int width, int height); | |
288 | void pwc_construct(struct pwc_device *pdev); | |
289 | ||
290 | /** Functions in pwc-ctrl.c */ | |
291 | /* Request a certain video mode. Returns < 0 if not possible */ | |
292 | extern int pwc_set_video_mode(struct pwc_device *pdev, int width, int height, int frames, int compression, int snapshot); | |
9ee6d78c | 293 | extern unsigned int pwc_get_fps(struct pwc_device *pdev, unsigned int index, unsigned int size); |
2b455db6 LS |
294 | /* Calculate the number of bytes per image (not frame) */ |
295 | extern int pwc_mpt_reset(struct pwc_device *pdev, int flags); | |
296 | extern int pwc_mpt_set_angle(struct pwc_device *pdev, int pan, int tilt); | |
1da177e4 LT |
297 | |
298 | /* Various controls; should be obvious. Value 0..65535, or < 0 on error */ | |
299 | extern int pwc_get_brightness(struct pwc_device *pdev); | |
300 | extern int pwc_set_brightness(struct pwc_device *pdev, int value); | |
301 | extern int pwc_get_contrast(struct pwc_device *pdev); | |
302 | extern int pwc_set_contrast(struct pwc_device *pdev, int value); | |
303 | extern int pwc_get_gamma(struct pwc_device *pdev); | |
304 | extern int pwc_set_gamma(struct pwc_device *pdev, int value); | |
2b455db6 | 305 | extern int pwc_get_saturation(struct pwc_device *pdev, int *value); |
1da177e4 LT |
306 | extern int pwc_set_saturation(struct pwc_device *pdev, int value); |
307 | extern int pwc_set_leds(struct pwc_device *pdev, int on_value, int off_value); | |
1da177e4 | 308 | extern int pwc_get_cmos_sensor(struct pwc_device *pdev, int *sensor); |
2b455db6 LS |
309 | extern int pwc_restore_user(struct pwc_device *pdev); |
310 | extern int pwc_save_user(struct pwc_device *pdev); | |
311 | extern int pwc_restore_factory(struct pwc_device *pdev); | |
312 | ||
313 | /* exported for use by v4l2 controls */ | |
314 | extern int pwc_get_red_gain(struct pwc_device *pdev, int *value); | |
315 | extern int pwc_set_red_gain(struct pwc_device *pdev, int value); | |
316 | extern int pwc_get_blue_gain(struct pwc_device *pdev, int *value); | |
317 | extern int pwc_set_blue_gain(struct pwc_device *pdev, int value); | |
318 | extern int pwc_get_awb(struct pwc_device *pdev); | |
319 | extern int pwc_set_awb(struct pwc_device *pdev, int mode); | |
320 | extern int pwc_set_agc(struct pwc_device *pdev, int mode, int value); | |
321 | extern int pwc_get_agc(struct pwc_device *pdev, int *value); | |
322 | extern int pwc_set_shutter_speed(struct pwc_device *pdev, int mode, int value); | |
323 | extern int pwc_get_shutter_speed(struct pwc_device *pdev, int *value); | |
324 | ||
325 | extern int pwc_set_colour_mode(struct pwc_device *pdev, int colour); | |
326 | extern int pwc_get_colour_mode(struct pwc_device *pdev, int *colour); | |
327 | extern int pwc_set_contour(struct pwc_device *pdev, int contour); | |
328 | extern int pwc_get_contour(struct pwc_device *pdev, int *contour); | |
329 | extern int pwc_set_backlight(struct pwc_device *pdev, int backlight); | |
330 | extern int pwc_get_backlight(struct pwc_device *pdev, int *backlight); | |
331 | extern int pwc_set_flicker(struct pwc_device *pdev, int flicker); | |
332 | extern int pwc_get_flicker(struct pwc_device *pdev, int *flicker); | |
333 | extern int pwc_set_dynamic_noise(struct pwc_device *pdev, int noise); | |
334 | extern int pwc_get_dynamic_noise(struct pwc_device *pdev, int *noise); | |
1da177e4 LT |
335 | |
336 | /* Power down or up the camera; not supported by all models */ | |
337 | extern int pwc_camera_power(struct pwc_device *pdev, int power); | |
338 | ||
339 | /* Private ioctl()s; see pwc-ioctl.h */ | |
069b7479 | 340 | extern long pwc_ioctl(struct pwc_device *pdev, unsigned int cmd, void *arg); |
1da177e4 | 341 | |
afa38521 | 342 | extern const struct v4l2_ioctl_ops pwc_ioctl_ops; |
1da177e4 LT |
343 | |
344 | /** pwc-uncompress.c */ | |
345 | /* Expand frame to image, possibly including decompression. Uses read_frame and fill_image */ | |
346 | extern int pwc_decompress(struct pwc_device *pdev); | |
347 | ||
348 | #ifdef __cplusplus | |
349 | } | |
350 | #endif | |
351 | ||
352 | ||
353 | #endif | |
2b455db6 | 354 | /* vim: set cino= formatoptions=croql cindent shiftwidth=8 tabstop=8: */ |