aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/media/video/pwc/pwc.h
diff options
context:
space:
mode:
Diffstat (limited to 'drivers/media/video/pwc/pwc.h')
-rw-r--r--drivers/media/video/pwc/pwc.h387
1 files changed, 387 insertions, 0 deletions
diff --git a/drivers/media/video/pwc/pwc.h b/drivers/media/video/pwc/pwc.h
new file mode 100644
index 00000000000..0e4e2d7b787
--- /dev/null
+++ b/drivers/media/video/pwc/pwc.h
@@ -0,0 +1,387 @@
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/mutex.h>
33#include <linux/mm.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-ioctl.h>
39#include <media/v4l2-ctrls.h>
40#include <media/videobuf2-vmalloc.h>
41#ifdef CONFIG_USB_PWC_INPUT_EVDEV
42#include <linux/input.h>
43#endif
44
45#include <media/pwc-ioctl.h>
46
47/* Version block */
48#define PWC_VERSION "10.0.15"
49#define PWC_NAME "pwc"
50#define PFX PWC_NAME ": "
51
52
53/* Trace certain actions in the driver */
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
75#ifdef CONFIG_USB_PWC_DEBUG
76
77#define PWC_DEBUG_LEVEL (PWC_DEBUG_LEVEL_MODULE)
78
79#define PWC_DEBUG(level, fmt, args...) do {\
80 if ((PWC_DEBUG_LEVEL_ ##level) & pwc_trace) \
81 printk(KERN_DEBUG PFX fmt, ##args); \
82 } while (0)
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
89#else /* if ! CONFIG_USB_PWC_DEBUG */
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
98
99#endif
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
106#define FEATURE_CODEC1 0x0002
107#define FEATURE_CODEC2 0x0004
108
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. */
113#define MAX_ISO_BUFS 3
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
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
121/* Absolute minimum and maximum number of buffers available for mmap() */
122#define MIN_FRAMES 2
123#define MAX_FRAMES 16
124
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
131/* from pwc-dec.h */
132#define PWCX_FLAG_PLANAR 0x0001
133
134/* Request types: video */
135#define SET_LUM_CTL 0x01
136#define GET_LUM_CTL 0x02
137#define SET_CHROM_CTL 0x03
138#define GET_CHROM_CTL 0x04
139#define SET_STATUS_CTL 0x05
140#define GET_STATUS_CTL 0x06
141#define SET_EP_STREAM_CTL 0x07
142#define GET_EP_STREAM_CTL 0x08
143#define GET_XX_CTL 0x09
144#define SET_XX_CTL 0x0A
145#define GET_XY_CTL 0x0B
146#define SET_XY_CTL 0x0C
147#define SET_MPT_CTL 0x0D
148#define GET_MPT_CTL 0x0E
149
150/* Selectors for the Luminance controls [GS]ET_LUM_CTL */
151#define AGC_MODE_FORMATTER 0x2000
152#define PRESET_AGC_FORMATTER 0x2100
153#define SHUTTER_MODE_FORMATTER 0x2200
154#define PRESET_SHUTTER_FORMATTER 0x2300
155#define PRESET_CONTOUR_FORMATTER 0x2400
156#define AUTO_CONTOUR_FORMATTER 0x2500
157#define BACK_LIGHT_COMPENSATION_FORMATTER 0x2600
158#define CONTRAST_FORMATTER 0x2700
159#define DYNAMIC_NOISE_CONTROL_FORMATTER 0x2800
160#define FLICKERLESS_MODE_FORMATTER 0x2900
161#define AE_CONTROL_SPEED 0x2A00
162#define BRIGHTNESS_FORMATTER 0x2B00
163#define GAMMA_FORMATTER 0x2C00
164
165/* Selectors for the Chrominance controls [GS]ET_CHROM_CTL */
166#define WB_MODE_FORMATTER 0x1000
167#define AWB_CONTROL_SPEED_FORMATTER 0x1100
168#define AWB_CONTROL_DELAY_FORMATTER 0x1200
169#define PRESET_MANUAL_RED_GAIN_FORMATTER 0x1300
170#define PRESET_MANUAL_BLUE_GAIN_FORMATTER 0x1400
171#define COLOUR_MODE_FORMATTER 0x1500
172#define SATURATION_MODE_FORMATTER1 0x1600
173#define SATURATION_MODE_FORMATTER2 0x1700
174
175/* Selectors for the Status controls [GS]ET_STATUS_CTL */
176#define SAVE_USER_DEFAULTS_FORMATTER 0x0200
177#define RESTORE_USER_DEFAULTS_FORMATTER 0x0300
178#define RESTORE_FACTORY_DEFAULTS_FORMATTER 0x0400
179#define READ_AGC_FORMATTER 0x0500
180#define READ_SHUTTER_FORMATTER 0x0600
181#define READ_RED_GAIN_FORMATTER 0x0700
182#define READ_BLUE_GAIN_FORMATTER 0x0800
183
184/* Formatters for the motorized pan & tilt [GS]ET_MPT_CTL */
185#define PT_RELATIVE_CONTROL_FORMATTER 0x01
186#define PT_RESET_CONTROL_FORMATTER 0x02
187#define PT_STATUS_FORMATTER 0x03
188
189/* intermediate buffers with raw data from the USB cam */
190struct pwc_frame_buf
191{
192 struct vb2_buffer vb; /* common v4l buffer stuff -- must be first */
193 struct list_head list;
194 void *data;
195 int filled; /* number of bytes filled */
196};
197
198struct pwc_device
199{
200 struct video_device vdev;
201 struct mutex modlock;
202
203 /* Pointer to our usb_device, may be NULL after unplug */
204 struct usb_device *udev;
205 /* Protects the setting of udev to NULL by our disconnect handler */
206 struct mutex udevlock;
207
208 /* type of cam (645, 646, 675, 680, 690, 720, 730, 740, 750) */
209 int type;
210 int release; /* release number */
211 int features; /* feature bits */
212 char serial[30]; /* serial number (string) */
213
214 /*** Video data ***/
215 struct file *capt_file; /* file doing video capture */
216 int vendpoint; /* video isoc endpoint */
217 int vcinterface; /* video control interface */
218 int valternate; /* alternate interface needed */
219 int vframes, vsize; /* frames-per-second & size (see PSZ_*) */
220 int pixfmt; /* pixelformat: V4L2_PIX_FMT_YUV420 or _PWCX */
221 int vframe_count; /* received frames */
222 int vmax_packet_size; /* USB maxpacket size */
223 int vlast_packet_size; /* for frame synchronisation */
224 int visoc_errors; /* number of contiguous ISOC errors */
225 int vcompression; /* desired compression factor */
226 int vbandlength; /* compressed band length; 0 is uncompressed */
227 char vsnapshot; /* snapshot mode */
228 char vsync; /* used by isoc handler */
229 char vmirror; /* for ToUCaM series */
230 char power_save; /* Do powersaving for this cam */
231
232 int cmd_len;
233 unsigned char cmd_buf[13];
234
235 struct urb *urbs[MAX_ISO_BUFS];
236 char iso_init;
237
238 /* videobuf2 queue and queued buffers list */
239 struct vb2_queue vb_queue;
240 struct list_head queued_bufs;
241 spinlock_t queued_bufs_lock;
242
243 /*
244 * Frame currently being filled, this only gets touched by the
245 * isoc urb complete handler, and by stream start / stop since
246 * start / stop touch it before / after starting / killing the urbs
247 * no locking is needed around this
248 */
249 struct pwc_frame_buf *fill_buf;
250
251 int frame_header_size, frame_trailer_size;
252 int frame_size;
253 int frame_total_size; /* including header & trailer */
254 int drop_frames;
255
256 void *decompress_data; /* private data for decompression engine */
257
258 /*
259 * We have an 'image' and a 'view', where 'image' is the fixed-size img
260 * as delivered by the camera, and 'view' is the size requested by the
261 * program. The camera image is centered in this viewport, laced with
262 * a gray or black border. view_min <= image <= view <= view_max;
263 */
264 int image_mask; /* supported sizes */
265 struct pwc_coord view_min, view_max; /* minimum and maximum view */
266 struct pwc_coord abs_max; /* maximum supported size */
267 struct pwc_coord image, view; /* image and viewport size */
268 struct pwc_coord offset; /* offset of the viewport */
269
270 /*** motorized pan/tilt feature */
271 struct pwc_mpt_range angle_range;
272 int pan_angle; /* in degrees * 100 */
273 int tilt_angle; /* absolute angle; 0,0 is home */
274
275 /*
276 * Set to 1 when the user push the button, reset to 0
277 * when this value is read from sysfs.
278 */
279 int snapshot_button_status;
280#ifdef CONFIG_USB_PWC_INPUT_EVDEV
281 struct input_dev *button_dev; /* webcam snapshot button input */
282 char button_phys[64];
283#endif
284
285 /* controls */
286 struct v4l2_ctrl_handler ctrl_handler;
287 u16 saturation_fmt;
288 struct v4l2_ctrl *brightness;
289 struct v4l2_ctrl *contrast;
290 struct v4l2_ctrl *saturation;
291 struct v4l2_ctrl *gamma;
292 struct {
293 /* awb / red-blue balance cluster */
294 struct v4l2_ctrl *auto_white_balance;
295 struct v4l2_ctrl *red_balance;
296 struct v4l2_ctrl *blue_balance;
297 /* usb ctrl transfers are slow, so we cache things */
298 int color_bal_valid;
299 unsigned long last_color_bal_update; /* In jiffies */
300 s32 last_red_balance;
301 s32 last_blue_balance;
302 };
303 struct {
304 /* autogain / gain cluster */
305 struct v4l2_ctrl *autogain;
306 struct v4l2_ctrl *gain;
307 int gain_valid;
308 unsigned long last_gain_update; /* In jiffies */
309 s32 last_gain;
310 };
311 struct {
312 /* exposure_auto / exposure cluster */
313 struct v4l2_ctrl *exposure_auto;
314 struct v4l2_ctrl *exposure;
315 int exposure_valid;
316 unsigned long last_exposure_update; /* In jiffies */
317 s32 last_exposure;
318 };
319 struct v4l2_ctrl *colorfx;
320 struct {
321 /* autocontour/contour cluster */
322 struct v4l2_ctrl *autocontour;
323 struct v4l2_ctrl *contour;
324 };
325 struct v4l2_ctrl *backlight;
326 struct v4l2_ctrl *flicker;
327 struct v4l2_ctrl *noise_reduction;
328 struct v4l2_ctrl *save_user;
329 struct v4l2_ctrl *restore_user;
330 struct v4l2_ctrl *restore_factory;
331 struct {
332 /* motor control cluster */
333 struct v4l2_ctrl *motor_pan;
334 struct v4l2_ctrl *motor_tilt;
335 struct v4l2_ctrl *motor_pan_reset;
336 struct v4l2_ctrl *motor_tilt_reset;
337 };
338 /* CODEC3 models have both gain and exposure controlled by autogain */
339 struct v4l2_ctrl *autogain_expo_cluster[3];
340};
341
342/* Global variables */
343#ifdef CONFIG_USB_PWC_DEBUG
344extern int pwc_trace;
345#endif
346
347/** Functions in pwc-misc.c */
348/* sizes in pixels */
349extern const struct pwc_coord pwc_image_sizes[PSZ_MAX];
350
351int pwc_decode_size(struct pwc_device *pdev, int width, int height);
352void pwc_construct(struct pwc_device *pdev);
353
354/** Functions in pwc-ctrl.c */
355/* Request a certain video mode. Returns < 0 if not possible */
356extern int pwc_set_video_mode(struct pwc_device *pdev, int width, int height, int frames, int compression, int snapshot);
357extern unsigned int pwc_get_fps(struct pwc_device *pdev, unsigned int index, unsigned int size);
358extern int pwc_mpt_reset(struct pwc_device *pdev, int flags);
359extern int pwc_mpt_set_angle(struct pwc_device *pdev, int pan, int tilt);
360extern int pwc_set_leds(struct pwc_device *pdev, int on_value, int off_value);
361extern int pwc_get_cmos_sensor(struct pwc_device *pdev, int *sensor);
362extern int send_control_msg(struct pwc_device *pdev,
363 u8 request, u16 value, void *buf, int buflen);
364
365/* Control get / set helpers */
366int pwc_get_u8_ctrl(struct pwc_device *pdev, u8 request, u16 value, int *data);
367int pwc_set_u8_ctrl(struct pwc_device *pdev, u8 request, u16 value, u8 data);
368int pwc_get_s8_ctrl(struct pwc_device *pdev, u8 request, u16 value, int *data);
369#define pwc_set_s8_ctrl pwc_set_u8_ctrl
370int pwc_get_u16_ctrl(struct pwc_device *pdev, u8 request, u16 value, int *dat);
371int pwc_set_u16_ctrl(struct pwc_device *pdev, u8 request, u16 value, u16 data);
372int pwc_button_ctrl(struct pwc_device *pdev, u16 value);
373int pwc_init_controls(struct pwc_device *pdev);
374
375/* Power down or up the camera; not supported by all models */
376extern void pwc_camera_power(struct pwc_device *pdev, int power);
377
378/* Private ioctl()s; see pwc-ioctl.h */
379extern long pwc_ioctl(struct pwc_device *pdev, unsigned int cmd, void *arg);
380
381extern const struct v4l2_ioctl_ops pwc_ioctl_ops;
382
383/** pwc-uncompress.c */
384/* Expand frame to image, possibly including decompression. Uses read_frame and fill_image */
385int pwc_decompress(struct pwc_device *pdev, struct pwc_frame_buf *fbuf);
386
387#endif
generated by cgit v1.2.2 (git 2.25.0) at 2025-03-14 23:29:02 -0400