1 /* (C) 1999-2003 Nemosoft Unv. (webcam@smcc.demon.nl)
3 This program is free software; you can redistribute it and/or modify
4 it under the terms of the GNU General Public License as published by
5 the Free Software Foundation; either version 2 of the License, or
6 (at your option) any later version.
8 This program is distributed in the hope that it will be useful,
9 but WITHOUT ANY WARRANTY; without even the implied warranty of
10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 GNU General Public License for more details.
13 You should have received a copy of the GNU General Public License
14 along with this program; if not, write to the Free Software
15 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #include <linux/version.h>
23 #include <linux/config.h>
24 #include <linux/module.h>
25 #include <linux/usb.h>
26 #include <linux/spinlock.h>
27 #include <linux/videodev.h>
28 #include <linux/wait.h>
29 #include <linux/smp_lock.h>
30 #include <asm/semaphore.h>
31 #include <asm/errno.h>
33 #include "pwc-uncompress.h"
34 #include "pwc-ioctl.h"
36 /* Defines and structures for the Philips webcam */
37 /* Used for checking memory corruption/pointer validation */
38 #define PWC_MAGIC 0x89DC10ABUL
41 /* Turn some debugging options on/off */
44 /* Trace certain actions in the driver */
45 #define TRACE_MODULE 0x0001
46 #define TRACE_PROBE 0x0002
47 #define TRACE_OPEN 0x0004
48 #define TRACE_READ 0x0008
49 #define TRACE_MEMORY 0x0010
50 #define TRACE_FLOW 0x0020
51 #define TRACE_SIZE 0x0040
52 #define TRACE_PWCX 0x0080
53 #define TRACE_SEQUENCE 0x1000
55 #define Trace(R, A...) if (pwc_trace & R) printk(KERN_DEBUG PWC_NAME " " A)
56 #define Debug(A...) printk(KERN_DEBUG PWC_NAME " " A)
57 #define Info(A...) printk(KERN_INFO PWC_NAME " " A)
58 #define Err(A...) printk(KERN_ERR PWC_NAME " " A)
61 /* Defines for ToUCam cameras */
62 #define TOUCAM_HEADER_SIZE 8
63 #define TOUCAM_TRAILER_SIZE 4
65 #define FEATURE_MOTOR_PANTILT 0x0001
70 #define PWC_VERSION "9.0.1"
71 #define PWC_NAME "pwc"
73 /* Turn certain features on/off */
74 #define PWC_INT_PIPE 0
76 /* Ignore errors in the first N frames, to allow for startup delays */
77 #define FRAME_LOWMARK 5
79 /* Size and number of buffers for the ISO pipe. */
80 #define MAX_ISO_BUFS 2
81 #define ISO_FRAMES_PER_DESC 10
82 #define ISO_MAX_FRAME_SIZE 960
83 #define ISO_BUFFER_SIZE (ISO_FRAMES_PER_DESC * ISO_MAX_FRAME_SIZE)
85 /* Frame buffers: contains compressed or uncompressed video data. */
87 /* Maximum size after decompression is 640x480 YUV data, 1.5 * 640 * 480 */
88 #define PWC_FRAME_SIZE (460800 + TOUCAM_HEADER_SIZE + TOUCAM_TRAILER_SIZE)
90 /* Absolute maximum number of buffers available for mmap() */
93 /* The following structures were based on cpia.h. Why reinvent the wheel? :-) */
102 /* intermediate buffers with raw data from the USB cam */
106 volatile int filled; /* number of bytes filled */
107 struct pwc_frame_buf *next; /* list */
109 int sequence; /* Sequence number */
115 struct video_device *vdev;
119 /* Pointer to our usb_device */
120 struct usb_device *udev;
122 int type; /* type of cam (645, 646, 675, 680, 690, 720, 730, 740, 750) */
123 int release; /* release number */
124 int features; /* feature bits */
125 char serial[30]; /* serial number (string) */
126 int error_status; /* set when something goes wrong with the cam (unplugged, USB errors) */
127 int usb_init; /* set when the cam has been initialized over USB */
130 int vopen; /* flag */
131 int vendpoint; /* video isoc endpoint */
132 int vcinterface; /* video control interface */
133 int valternate; /* alternate interface needed */
134 int vframes, vsize; /* frames-per-second & size (see PSZ_*) */
135 int vpalette; /* palette: 420P, RAW or RGBBAYER */
136 int vframe_count; /* received frames */
137 int vframes_dumped; /* counter for dumped frames */
138 int vframes_error; /* frames received in error */
139 int vmax_packet_size; /* USB maxpacket size */
140 int vlast_packet_size; /* for frame synchronisation */
141 int visoc_errors; /* number of contiguous ISOC errors */
142 int vcompression; /* desired compression factor */
143 int vbandlength; /* compressed band length; 0 is uncompressed */
144 char vsnapshot; /* snapshot mode */
145 char vsync; /* used by isoc handler */
146 char vmirror; /* for ToUCaM series */
149 unsigned char cmd_buf[13];
151 /* The image acquisition requires 3 to 4 steps:
152 1. data is gathered in short packets from the USB controller
153 2. data is synchronized and packed into a frame buffer
154 3a. in case data is compressed, decompress it directly into image buffer
155 3b. in case data is uncompressed, copy into image buffer with viewport
156 4. data is transferred to the user process
158 Note that MAX_ISO_BUFS != MAX_FRAMES != MAX_IMAGES....
159 We have in effect a back-to-back-double-buffer system.
162 struct pwc_iso_buf sbuf[MAX_ISO_BUFS];
166 struct pwc_frame_buf *fbuf; /* all frames */
167 struct pwc_frame_buf *empty_frames, *empty_frames_tail; /* all empty frames */
168 struct pwc_frame_buf *full_frames, *full_frames_tail; /* all filled frames */
169 struct pwc_frame_buf *fill_frame; /* frame currently being filled */
170 struct pwc_frame_buf *read_frame; /* frame currently read by user process */
171 int frame_header_size, frame_trailer_size;
173 int frame_total_size; /* including header & trailer */
176 int sequence; /* Debugging aid */
179 /* 3: decompression */
180 struct pwc_decompressor *decompressor; /* function block with decompression routines */
181 void *decompress_data; /* private data for decompression engine */
184 /* We have an 'image' and a 'view', where 'image' is the fixed-size image
185 as delivered by the camera, and 'view' is the size requested by the
186 program. The camera image is centered in this viewport, laced with
187 a gray or black border. view_min <= image <= view <= view_max;
189 int image_mask; /* bitmask of supported sizes */
190 struct pwc_coord view_min, view_max; /* minimum and maximum viewable sizes */
191 struct pwc_coord abs_max; /* maximum supported size with compression */
192 struct pwc_coord image, view; /* image and viewport size */
193 struct pwc_coord offset; /* offset within the viewport */
195 void *image_data; /* total buffer, which is subdivided into ... */
196 void *image_ptr[MAX_IMAGES]; /* ...several images... */
197 int fill_image; /* ...which are rotated. */
198 int len_per_image; /* length per image */
199 int image_read_pos; /* In case we read data in pieces, keep track of were we are in the imagebuffer */
200 int image_used[MAX_IMAGES]; /* For MCAPTURE and SYNC */
202 struct semaphore modlock; /* to prevent races in video_open(), etc */
203 spinlock_t ptrlock; /* for manipulating the buffer pointers */
205 /*** motorized pan/tilt feature */
206 struct pwc_mpt_range angle_range;
207 int pan_angle; /* in degrees * 100 */
208 int tilt_angle; /* absolute angle; 0,0 is home position */
211 wait_queue_head_t frameq; /* When waiting for a frame to finish... */
213 void *usb_int_handler; /* for the interrupt endpoint */
222 /* Global variables */
223 extern int pwc_trace;
224 extern int pwc_preferred_compression;
226 /** functions in pwc-if.c */
227 int pwc_try_video_mode(struct pwc_device *pdev, int width, int height, int new_fps, int new_compression, int new_snapshot);
229 /** Functions in pwc-misc.c */
230 /* sizes in pixels */
231 extern struct pwc_coord pwc_image_sizes[PSZ_MAX];
233 int pwc_decode_size(struct pwc_device *pdev, int width, int height);
234 void pwc_construct(struct pwc_device *pdev);
236 /** Functions in pwc-ctrl.c */
237 /* Request a certain video mode. Returns < 0 if not possible */
238 extern int pwc_set_video_mode(struct pwc_device *pdev, int width, int height, int frames, int compression, int snapshot);
239 /* Calculate the number of bytes per image (not frame) */
240 extern void pwc_set_image_buffer_size(struct pwc_device *pdev);
242 /* Various controls; should be obvious. Value 0..65535, or < 0 on error */
243 extern int pwc_get_brightness(struct pwc_device *pdev);
244 extern int pwc_set_brightness(struct pwc_device *pdev, int value);
245 extern int pwc_get_contrast(struct pwc_device *pdev);
246 extern int pwc_set_contrast(struct pwc_device *pdev, int value);
247 extern int pwc_get_gamma(struct pwc_device *pdev);
248 extern int pwc_set_gamma(struct pwc_device *pdev, int value);
249 extern int pwc_get_saturation(struct pwc_device *pdev);
250 extern int pwc_set_saturation(struct pwc_device *pdev, int value);
251 extern int pwc_set_leds(struct pwc_device *pdev, int on_value, int off_value);
252 extern int pwc_get_leds(struct pwc_device *pdev, int *on_value, int *off_value);
253 extern int pwc_get_cmos_sensor(struct pwc_device *pdev, int *sensor);
255 /* Power down or up the camera; not supported by all models */
256 extern int pwc_camera_power(struct pwc_device *pdev, int power);
258 /* Private ioctl()s; see pwc-ioctl.h */
259 extern int pwc_ioctl(struct pwc_device *pdev, unsigned int cmd, void *arg);
262 /** pwc-uncompress.c */
263 /* Expand frame to image, possibly including decompression. Uses read_frame and fill_image */
264 extern int pwc_decompress(struct pwc_device *pdev);