V4L/DVB (5166): Remove obsolete alias defines of CONFIG_* settings
[linux-2.6.git] / drivers / media / video / pwc / pwc.h
1 /* (C) 1999-2003 Nemosoft Unv.
2    (C) 2004-2006 Luc Saillard (luc@saillard.org)
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
28 #include <linux/module.h>
29 #include <linux/usb.h>
30 #include <linux/spinlock.h>
31 #include <linux/wait.h>
32 #include <linux/smp_lock.h>
33 #include <linux/version.h>
34 #include <asm/semaphore.h>
35 #include <asm/errno.h>
36 #include <linux/videodev.h>
37 #include <media/v4l2-common.h>
38
39 #include "pwc-uncompress.h"
40 #include <media/pwc-ioctl.h>
41
42 /* Version block */
43 #define PWC_MAJOR       10
44 #define PWC_MINOR       0
45 #define PWC_EXTRAMINOR  12
46 #define PWC_VERSION_CODE KERNEL_VERSION(PWC_MAJOR,PWC_MINOR,PWC_EXTRAMINOR)
47 #define PWC_VERSION     "10.0.12"
48 #define PWC_NAME        "pwc"
49 #define PFX             PWC_NAME ": "
50
51
52 /* Trace certain actions in the driver */
53 #define PWC_DEBUG_LEVEL_MODULE  (1<<0)
54 #define PWC_DEBUG_LEVEL_PROBE   (1<<1)
55 #define PWC_DEBUG_LEVEL_OPEN    (1<<2)
56 #define PWC_DEBUG_LEVEL_READ    (1<<3)
57 #define PWC_DEBUG_LEVEL_MEMORY  (1<<4)
58 #define PWC_DEBUG_LEVEL_FLOW    (1<<5)
59 #define PWC_DEBUG_LEVEL_SIZE    (1<<6)
60 #define PWC_DEBUG_LEVEL_IOCTL   (1<<7)
61 #define PWC_DEBUG_LEVEL_TRACE   (1<<8)
62
63 #define PWC_DEBUG_MODULE(fmt, args...) PWC_DEBUG(MODULE, fmt, ##args)
64 #define PWC_DEBUG_PROBE(fmt, args...) PWC_DEBUG(PROBE, fmt, ##args)
65 #define PWC_DEBUG_OPEN(fmt, args...) PWC_DEBUG(OPEN, fmt, ##args)
66 #define PWC_DEBUG_READ(fmt, args...) PWC_DEBUG(READ, fmt, ##args)
67 #define PWC_DEBUG_MEMORY(fmt, args...) PWC_DEBUG(MEMORY, fmt, ##args)
68 #define PWC_DEBUG_FLOW(fmt, args...) PWC_DEBUG(FLOW, fmt, ##args)
69 #define PWC_DEBUG_SIZE(fmt, args...) PWC_DEBUG(SIZE, fmt, ##args)
70 #define PWC_DEBUG_IOCTL(fmt, args...) PWC_DEBUG(IOCTL, fmt, ##args)
71 #define PWC_DEBUG_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args)
72
73
74 #ifdef CONFIG_USB_PWC_DEBUG
75
76 #define PWC_DEBUG_LEVEL (PWC_DEBUG_LEVEL_MODULE)
77
78 #define PWC_DEBUG(level, fmt, args...) do {\
79           if ((PWC_DEBUG_LEVEL_ ##level) & pwc_trace) \
80              printk(KERN_DEBUG PFX fmt, ##args); \
81           } while(0)
82
83 #define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args)
84 #define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args)
85 #define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args)
86 #define PWC_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args)
87
88 #else /* if ! CONFIG_PWC_DEBUG */
89
90 #define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args)
91 #define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args)
92 #define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args)
93 #define PWC_TRACE(fmt, args...) do { } while(0)
94 #define PWC_DEBUG(level, fmt, args...) do { } while(0)
95
96 #define pwc_trace 0
97
98 #endif
99
100 /* Defines for ToUCam cameras */
101 #define TOUCAM_HEADER_SIZE              8
102 #define TOUCAM_TRAILER_SIZE             4
103
104 #define FEATURE_MOTOR_PANTILT           0x0001
105 #define FEATURE_CODEC1                  0x0002
106 #define FEATURE_CODEC2                  0x0004
107
108 /* Turn certain features on/off */
109 #define PWC_INT_PIPE 0
110
111 /* Ignore errors in the first N frames, to allow for startup delays */
112 #define FRAME_LOWMARK 5
113
114 /* Size and number of buffers for the ISO pipe. */
115 #define MAX_ISO_BUFS            2
116 #define ISO_FRAMES_PER_DESC     10
117 #define ISO_MAX_FRAME_SIZE      960
118 #define ISO_BUFFER_SIZE         (ISO_FRAMES_PER_DESC * ISO_MAX_FRAME_SIZE)
119
120 /* Frame buffers: contains compressed or uncompressed video data. */
121 #define MAX_FRAMES              5
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)
124
125 /* Absolute maximum number of buffers available for mmap() */
126 #define MAX_IMAGES              10
127
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)
133
134
135 #ifndef V4L2_PIX_FMT_PWC1
136 #define V4L2_PIX_FMT_PWC1       v4l2_fourcc('P','W','C','1')
137 #define V4L2_PIX_FMT_PWC2       v4l2_fourcc('P','W','C','2')
138 #endif
139
140 /* The following structures were based on cpia.h. Why reinvent the wheel? :-) */
141 struct pwc_iso_buf
142 {
143         void *data;
144         int  length;
145         int  read;
146         struct urb *urb;
147 };
148
149 /* intermediate buffers with raw data from the USB cam */
150 struct pwc_frame_buf
151 {
152    void *data;
153    volatile int filled;         /* number of bytes filled */
154    struct pwc_frame_buf *next;  /* list */
155 };
156
157 /* additionnal informations used when dealing image between kernel and userland */
158 struct pwc_imgbuf
159 {
160         unsigned long offset;   /* offset of this buffer in the big array of image_data */
161         int   vma_use_count;    /* count the number of time this memory is mapped */
162 };
163
164 struct pwc_device
165 {
166    struct video_device *vdev;
167
168    /* Pointer to our usb_device */
169    struct usb_device *udev;
170
171    int type;                    /* type of cam (645, 646, 675, 680, 690, 720, 730, 740, 750) */
172    int release;                 /* release number */
173    int features;                /* feature bits */
174    char serial[30];             /* serial number (string) */
175    int error_status;            /* set when something goes wrong with the cam (unplugged, USB errors) */
176    int usb_init;                /* set when the cam has been initialized over USB */
177
178    /*** Video data ***/
179    int vopen;                   /* flag */
180    int vendpoint;               /* video isoc endpoint */
181    int vcinterface;             /* video control interface */
182    int valternate;              /* alternate interface needed */
183    int vframes, vsize;          /* frames-per-second & size (see PSZ_*) */
184    int vpalette;                /* palette: 420P, RAW or RGBBAYER */
185    int vframe_count;            /* received frames */
186    int vframes_dumped;          /* counter for dumped frames */
187    int vframes_error;           /* frames received in error */
188    int vmax_packet_size;        /* USB maxpacket size */
189    int vlast_packet_size;       /* for frame synchronisation */
190    int visoc_errors;            /* number of contiguous ISOC errors */
191    int vcompression;            /* desired compression factor */
192    int vbandlength;             /* compressed band length; 0 is uncompressed */
193    char vsnapshot;              /* snapshot mode */
194    char vsync;                  /* used by isoc handler */
195    char vmirror;                /* for ToUCaM series */
196
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;
224
225    /* 3: decompression */
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 ... */
241    struct pwc_imgbuf images[MAX_IMAGES];/* ...several images... */
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
247    struct semaphore modlock;            /* to prevent races in video_open(), etc */
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 */
254    int snapshot_button_status;          /* set to 1 when the user push the button, reset to 0 when this value is read */
255
256    /*** Misc. data ***/
257    wait_queue_head_t frameq;            /* When waiting for a frame to finish... */
258 #if PWC_INT_PIPE
259    void *usb_int_handler;               /* for the interrupt endpoint */
260 #endif
261 };
262
263 #ifdef __cplusplus
264 extern "C" {
265 #endif
266
267 /* Global variables */
268 #ifdef CONFIG_USB_PWC_DEBUG
269 extern int pwc_trace;
270 #endif
271 extern int pwc_mbufs;
272
273 /** functions in pwc-if.c */
274 int pwc_try_video_mode(struct pwc_device *pdev, int width, int height, int new_fps, int new_compression, int new_snapshot);
275 int pwc_handle_frame(struct pwc_device *pdev);
276 void pwc_next_image(struct pwc_device *pdev);
277 int pwc_isoc_init(struct pwc_device *pdev);
278 void pwc_isoc_cleanup(struct pwc_device *pdev);
279
280 /** Functions in pwc-misc.c */
281 /* sizes in pixels */
282 extern const struct pwc_coord pwc_image_sizes[PSZ_MAX];
283
284 int pwc_decode_size(struct pwc_device *pdev, int width, int height);
285 void pwc_construct(struct pwc_device *pdev);
286
287 /** Functions in pwc-ctrl.c */
288 /* Request a certain video mode. Returns < 0 if not possible */
289 extern int pwc_set_video_mode(struct pwc_device *pdev, int width, int height, int frames, int compression, int snapshot);
290 /* Calculate the number of bytes per image (not frame) */
291 extern int pwc_mpt_reset(struct pwc_device *pdev, int flags);
292 extern int pwc_mpt_set_angle(struct pwc_device *pdev, int pan, int tilt);
293
294 /* Various controls; should be obvious. Value 0..65535, or < 0 on error */
295 extern int pwc_get_brightness(struct pwc_device *pdev);
296 extern int pwc_set_brightness(struct pwc_device *pdev, int value);
297 extern int pwc_get_contrast(struct pwc_device *pdev);
298 extern int pwc_set_contrast(struct pwc_device *pdev, int value);
299 extern int pwc_get_gamma(struct pwc_device *pdev);
300 extern int pwc_set_gamma(struct pwc_device *pdev, int value);
301 extern int pwc_get_saturation(struct pwc_device *pdev, int *value);
302 extern int pwc_set_saturation(struct pwc_device *pdev, int value);
303 extern int pwc_set_leds(struct pwc_device *pdev, int on_value, int off_value);
304 extern int pwc_get_cmos_sensor(struct pwc_device *pdev, int *sensor);
305 extern int pwc_restore_user(struct pwc_device *pdev);
306 extern int pwc_save_user(struct pwc_device *pdev);
307 extern int pwc_restore_factory(struct pwc_device *pdev);
308
309 /* exported for use by v4l2 controls */
310 extern int pwc_get_red_gain(struct pwc_device *pdev, int *value);
311 extern int pwc_set_red_gain(struct pwc_device *pdev, int value);
312 extern int pwc_get_blue_gain(struct pwc_device *pdev, int *value);
313 extern int pwc_set_blue_gain(struct pwc_device *pdev, int value);
314 extern int pwc_get_awb(struct pwc_device *pdev);
315 extern int pwc_set_awb(struct pwc_device *pdev, int mode);
316 extern int pwc_set_agc(struct pwc_device *pdev, int mode, int value);
317 extern int pwc_get_agc(struct pwc_device *pdev, int *value);
318 extern int pwc_set_shutter_speed(struct pwc_device *pdev, int mode, int value);
319 extern int pwc_get_shutter_speed(struct pwc_device *pdev, int *value);
320
321 extern int pwc_set_colour_mode(struct pwc_device *pdev, int colour);
322 extern int pwc_get_colour_mode(struct pwc_device *pdev, int *colour);
323 extern int pwc_set_contour(struct pwc_device *pdev, int contour);
324 extern int pwc_get_contour(struct pwc_device *pdev, int *contour);
325 extern int pwc_set_backlight(struct pwc_device *pdev, int backlight);
326 extern int pwc_get_backlight(struct pwc_device *pdev, int *backlight);
327 extern int pwc_set_flicker(struct pwc_device *pdev, int flicker);
328 extern int pwc_get_flicker(struct pwc_device *pdev, int *flicker);
329 extern int pwc_set_dynamic_noise(struct pwc_device *pdev, int noise);
330 extern int pwc_get_dynamic_noise(struct pwc_device *pdev, int *noise);
331
332 /* Power down or up the camera; not supported by all models */
333 extern int pwc_camera_power(struct pwc_device *pdev, int power);
334
335 /* Private ioctl()s; see pwc-ioctl.h */
336 extern int pwc_ioctl(struct pwc_device *pdev, unsigned int cmd, void *arg);
337
338 /** Functions in pwc-v4l.c */
339 extern int pwc_video_do_ioctl(struct inode *inode, struct file *file,
340                               unsigned int cmd, void *arg);
341
342 /** pwc-uncompress.c */
343 /* Expand frame to image, possibly including decompression. Uses read_frame and fill_image */
344 extern int pwc_decompress(struct pwc_device *pdev);
345
346 #ifdef __cplusplus
347 }
348 #endif
349
350
351 #endif
352 /* vim: set cino= formatoptions=croql cindent shiftwidth=8 tabstop=8: */