]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - drivers/media/video/pwc/pwc.h
[media] pwc: Remove some unused PWC_INT_PIPE left overs
[mirror_ubuntu-zesty-kernel.git] / drivers / media / video / pwc / pwc.h
CommitLineData
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>
b9378fdb 32#include <linux/mutex.h>
38413fd2 33#include <linux/mm.h>
5a0e3ad6 34#include <linux/slab.h>
1da177e4 35#include <asm/errno.h>
479567ce 36#include <linux/videodev2.h>
5e87efa3 37#include <media/v4l2-common.h>
35ea11ff 38#include <media/v4l2-ioctl.h>
885fe18f 39#include <media/videobuf2-vmalloc.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 47/* Version block */
880c35c5 48#define PWC_VERSION "10.0.15"
2b455db6
LS
49#define PWC_NAME "pwc"
50#define PFX PWC_NAME ": "
51
1da177e4
LT
52
53/* Trace certain actions in the driver */
2b455db6
LS
54#define PWC_DEBUG_LEVEL_MODULE (1<<0)
55#define PWC_DEBUG_LEVEL_PROBE (1<<1)
56#define PWC_DEBUG_LEVEL_OPEN (1<<2)
57#define PWC_DEBUG_LEVEL_READ (1<<3)
58#define PWC_DEBUG_LEVEL_MEMORY (1<<4)
59#define PWC_DEBUG_LEVEL_FLOW (1<<5)
60#define PWC_DEBUG_LEVEL_SIZE (1<<6)
61#define PWC_DEBUG_LEVEL_IOCTL (1<<7)
62#define PWC_DEBUG_LEVEL_TRACE (1<<8)
63
64#define PWC_DEBUG_MODULE(fmt, args...) PWC_DEBUG(MODULE, fmt, ##args)
65#define PWC_DEBUG_PROBE(fmt, args...) PWC_DEBUG(PROBE, fmt, ##args)
66#define PWC_DEBUG_OPEN(fmt, args...) PWC_DEBUG(OPEN, fmt, ##args)
67#define PWC_DEBUG_READ(fmt, args...) PWC_DEBUG(READ, fmt, ##args)
68#define PWC_DEBUG_MEMORY(fmt, args...) PWC_DEBUG(MEMORY, fmt, ##args)
69#define PWC_DEBUG_FLOW(fmt, args...) PWC_DEBUG(FLOW, fmt, ##args)
70#define PWC_DEBUG_SIZE(fmt, args...) PWC_DEBUG(SIZE, fmt, ##args)
71#define PWC_DEBUG_IOCTL(fmt, args...) PWC_DEBUG(IOCTL, fmt, ##args)
72#define PWC_DEBUG_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args)
73
74
05ad3907 75#ifdef CONFIG_USB_PWC_DEBUG
2b455db6
LS
76
77#define PWC_DEBUG_LEVEL (PWC_DEBUG_LEVEL_MODULE)
78
79#define PWC_DEBUG(level, fmt, args...) do {\
1a4ede65
HG
80 if ((PWC_DEBUG_LEVEL_ ##level) & pwc_trace) \
81 printk(KERN_DEBUG PFX fmt, ##args); \
82 } while (0)
2b455db6
LS
83
84#define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args)
85#define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args)
86#define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args)
87#define PWC_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args)
88
9ee6d78c 89#else /* if ! CONFIG_USB_PWC_DEBUG */
2b455db6
LS
90
91#define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args)
92#define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args)
93#define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args)
94#define PWC_TRACE(fmt, args...) do { } while(0)
95#define PWC_DEBUG(level, fmt, args...) do { } while(0)
96
97#define pwc_trace 0
1da177e4 98
2b455db6 99#endif
1da177e4
LT
100
101/* Defines for ToUCam cameras */
102#define TOUCAM_HEADER_SIZE 8
103#define TOUCAM_TRAILER_SIZE 4
104
105#define FEATURE_MOTOR_PANTILT 0x0001
2b455db6
LS
106#define FEATURE_CODEC1 0x0002
107#define FEATURE_CODEC2 0x0004
1da177e4 108
1da177e4
LT
109/* Ignore errors in the first N frames, to allow for startup delays */
110#define FRAME_LOWMARK 5
111
112/* Size and number of buffers for the ISO pipe. */
885fe18f 113#define MAX_ISO_BUFS 3
1da177e4
LT
114#define ISO_FRAMES_PER_DESC 10
115#define ISO_MAX_FRAME_SIZE 960
116#define ISO_BUFFER_SIZE (ISO_FRAMES_PER_DESC * ISO_MAX_FRAME_SIZE)
117
1da177e4
LT
118/* Maximum size after decompression is 640x480 YUV data, 1.5 * 640 * 480 */
119#define PWC_FRAME_SIZE (460800 + TOUCAM_HEADER_SIZE + TOUCAM_TRAILER_SIZE)
120
885fe18f
HG
121/* Absolute minimum and maximum number of buffers available for mmap() */
122#define MIN_FRAMES 2
123#define MAX_FRAMES 16
1da177e4 124
2b455db6
LS
125/* Some macros to quickly find the type of a webcam */
126#define DEVICE_USE_CODEC1(x) ((x)<675)
127#define DEVICE_USE_CODEC2(x) ((x)>=675 && (x)<700)
128#define DEVICE_USE_CODEC3(x) ((x)>=700)
129#define DEVICE_USE_CODEC23(x) ((x)>=675)
130
1da177e4
LT
131/* The following structures were based on cpia.h. Why reinvent the wheel? :-) */
132struct pwc_iso_buf
133{
134 void *data;
135 int length;
136 int read;
137 struct urb *urb;
138};
139
140/* intermediate buffers with raw data from the USB cam */
141struct pwc_frame_buf
142{
885fe18f
HG
143 struct vb2_buffer vb; /* common v4l buffer stuff -- must be first */
144 struct list_head list;
145 void *data;
146 int filled; /* number of bytes filled */
1da177e4
LT
147};
148
149struct pwc_device
150{
9a7b2d1f 151 struct video_device vdev;
1a4ede65
HG
152 struct mutex modlock;
153
154 /* Pointer to our usb_device, may be NULL after unplug */
155 struct usb_device *udev;
156 /* type of cam (645, 646, 675, 680, 690, 720, 730, 740, 750) */
157 int type;
158 int release; /* release number */
159 int features; /* feature bits */
160 char serial[30]; /* serial number (string) */
1a4ede65
HG
161 int usb_init; /* set when the cam has been initialized */
162
163 /*** Video data ***/
164 int vopen; /* flag */
165 int vendpoint; /* video isoc endpoint */
166 int vcinterface; /* video control interface */
167 int valternate; /* alternate interface needed */
168 int vframes, vsize; /* frames-per-second & size (see PSZ_*) */
169 int pixfmt; /* pixelformat: V4L2_PIX_FMT_YUV420 or _PWCX */
170 int vframe_count; /* received frames */
171 int vmax_packet_size; /* USB maxpacket size */
172 int vlast_packet_size; /* for frame synchronisation */
173 int visoc_errors; /* number of contiguous ISOC errors */
174 int vcompression; /* desired compression factor */
175 int vbandlength; /* compressed band length; 0 is uncompressed */
176 char vsnapshot; /* snapshot mode */
177 char vsync; /* used by isoc handler */
178 char vmirror; /* for ToUCaM series */
d56410e0 179
1a4ede65
HG
180 int cmd_len;
181 unsigned char cmd_buf[13];
1da177e4 182
1a4ede65
HG
183 struct pwc_iso_buf sbuf[MAX_ISO_BUFS];
184 char iso_init;
1da177e4 185
885fe18f
HG
186 /* videobuf2 queue and queued buffers list */
187 struct vb2_queue vb_queue;
188 struct list_head queued_bufs;
189 spinlock_t queued_bufs_lock;
190
191 /*
192 * Frame currently being filled, this only gets touched by the
193 * isoc urb complete handler, and by stream start / stop since
194 * start / stop touch it before / after starting / killing the urbs
195 * no locking is needed around this
196 */
197 struct pwc_frame_buf *fill_buf;
198
1a4ede65
HG
199 int frame_header_size, frame_trailer_size;
200 int frame_size;
201 int frame_total_size; /* including header & trailer */
202 int drop_frames;
203
204 void *decompress_data; /* private data for decompression engine */
205
206 /*
207 * We have an 'image' and a 'view', where 'image' is the fixed-size img
208 * as delivered by the camera, and 'view' is the size requested by the
209 * program. The camera image is centered in this viewport, laced with
210 * a gray or black border. view_min <= image <= view <= view_max;
211 */
212 int image_mask; /* supported sizes */
213 struct pwc_coord view_min, view_max; /* minimum and maximum view */
214 struct pwc_coord abs_max; /* maximum supported size */
215 struct pwc_coord image, view; /* image and viewport size */
216 struct pwc_coord offset; /* offset of the viewport */
217
218 /*** motorized pan/tilt feature */
219 struct pwc_mpt_range angle_range;
220 int pan_angle; /* in degrees * 100 */
221 int tilt_angle; /* absolute angle; 0,0 is home */
222
223 /*
224 * Set to 1 when the user push the button, reset to 0
225 * when this value is read from sysfs.
226 */
227 int snapshot_button_status;
e32a7ecc 228#ifdef CONFIG_USB_PWC_INPUT_EVDEV
1a4ede65
HG
229 struct input_dev *button_dev; /* webcam snapshot button input */
230 char button_phys[64];
e32a7ecc 231#endif
1da177e4
LT
232};
233
2b455db6 234/* Global variables */
05ad3907 235#ifdef CONFIG_USB_PWC_DEBUG
1da177e4 236extern int pwc_trace;
2b455db6 237#endif
1da177e4
LT
238
239/** Functions in pwc-misc.c */
240/* sizes in pixels */
2b455db6 241extern const struct pwc_coord pwc_image_sizes[PSZ_MAX];
1da177e4
LT
242
243int pwc_decode_size(struct pwc_device *pdev, int width, int height);
244void pwc_construct(struct pwc_device *pdev);
245
246/** Functions in pwc-ctrl.c */
247/* Request a certain video mode. Returns < 0 if not possible */
248extern int pwc_set_video_mode(struct pwc_device *pdev, int width, int height, int frames, int compression, int snapshot);
9ee6d78c 249extern unsigned int pwc_get_fps(struct pwc_device *pdev, unsigned int index, unsigned int size);
2b455db6
LS
250/* Calculate the number of bytes per image (not frame) */
251extern int pwc_mpt_reset(struct pwc_device *pdev, int flags);
252extern int pwc_mpt_set_angle(struct pwc_device *pdev, int pan, int tilt);
1da177e4
LT
253
254/* Various controls; should be obvious. Value 0..65535, or < 0 on error */
255extern int pwc_get_brightness(struct pwc_device *pdev);
256extern int pwc_set_brightness(struct pwc_device *pdev, int value);
257extern int pwc_get_contrast(struct pwc_device *pdev);
258extern int pwc_set_contrast(struct pwc_device *pdev, int value);
259extern int pwc_get_gamma(struct pwc_device *pdev);
260extern int pwc_set_gamma(struct pwc_device *pdev, int value);
2b455db6 261extern int pwc_get_saturation(struct pwc_device *pdev, int *value);
1da177e4
LT
262extern int pwc_set_saturation(struct pwc_device *pdev, int value);
263extern int pwc_set_leds(struct pwc_device *pdev, int on_value, int off_value);
1da177e4 264extern int pwc_get_cmos_sensor(struct pwc_device *pdev, int *sensor);
2b455db6
LS
265extern int pwc_restore_user(struct pwc_device *pdev);
266extern int pwc_save_user(struct pwc_device *pdev);
267extern int pwc_restore_factory(struct pwc_device *pdev);
268
269/* exported for use by v4l2 controls */
270extern int pwc_get_red_gain(struct pwc_device *pdev, int *value);
271extern int pwc_set_red_gain(struct pwc_device *pdev, int value);
272extern int pwc_get_blue_gain(struct pwc_device *pdev, int *value);
273extern int pwc_set_blue_gain(struct pwc_device *pdev, int value);
274extern int pwc_get_awb(struct pwc_device *pdev);
275extern int pwc_set_awb(struct pwc_device *pdev, int mode);
276extern int pwc_set_agc(struct pwc_device *pdev, int mode, int value);
277extern int pwc_get_agc(struct pwc_device *pdev, int *value);
278extern int pwc_set_shutter_speed(struct pwc_device *pdev, int mode, int value);
279extern int pwc_get_shutter_speed(struct pwc_device *pdev, int *value);
280
281extern int pwc_set_colour_mode(struct pwc_device *pdev, int colour);
282extern int pwc_get_colour_mode(struct pwc_device *pdev, int *colour);
283extern int pwc_set_contour(struct pwc_device *pdev, int contour);
284extern int pwc_get_contour(struct pwc_device *pdev, int *contour);
285extern int pwc_set_backlight(struct pwc_device *pdev, int backlight);
286extern int pwc_get_backlight(struct pwc_device *pdev, int *backlight);
287extern int pwc_set_flicker(struct pwc_device *pdev, int flicker);
288extern int pwc_get_flicker(struct pwc_device *pdev, int *flicker);
289extern int pwc_set_dynamic_noise(struct pwc_device *pdev, int noise);
290extern int pwc_get_dynamic_noise(struct pwc_device *pdev, int *noise);
1da177e4
LT
291
292/* Power down or up the camera; not supported by all models */
293extern int pwc_camera_power(struct pwc_device *pdev, int power);
294
295/* Private ioctl()s; see pwc-ioctl.h */
069b7479 296extern long pwc_ioctl(struct pwc_device *pdev, unsigned int cmd, void *arg);
1da177e4 297
afa38521 298extern const struct v4l2_ioctl_ops pwc_ioctl_ops;
1da177e4
LT
299
300/** pwc-uncompress.c */
301/* Expand frame to image, possibly including decompression. Uses read_frame and fill_image */
885fe18f 302int pwc_decompress(struct pwc_device *pdev, struct pwc_frame_buf *fbuf);
1da177e4 303
1da177e4 304#endif