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-device.h> 39#include <media/v4l2-ioctl.h> 40#include <media/v4l2-ctrls.h> 41#include <media/v4l2-fh.h> 42#include <media/v4l2-event.h> 43#include <media/videobuf2-vmalloc.h> 44#ifdef CONFIG_USB_PWC_INPUT_EVDEV 45#include <linux/input.h> 46#endif 47#include "pwc-dec1.h" 48#include "pwc-dec23.h" 49 50/* Version block */ 51#define PWC_VERSION "10.0.15" 52#define PWC_NAME "pwc" 53#define PFX PWC_NAME ": " 54 55 56/* Trace certain actions in the driver */ 57#define PWC_DEBUG_LEVEL_MODULE (1<<0) 58#define PWC_DEBUG_LEVEL_PROBE (1<<1) 59#define PWC_DEBUG_LEVEL_OPEN (1<<2) 60#define PWC_DEBUG_LEVEL_READ (1<<3) 61#define PWC_DEBUG_LEVEL_MEMORY (1<<4) 62#define PWC_DEBUG_LEVEL_FLOW (1<<5) 63#define PWC_DEBUG_LEVEL_SIZE (1<<6) 64#define PWC_DEBUG_LEVEL_IOCTL (1<<7) 65#define PWC_DEBUG_LEVEL_TRACE (1<<8) 66 67#define PWC_DEBUG_MODULE(fmt, args...) PWC_DEBUG(MODULE, fmt, ##args) 68#define PWC_DEBUG_PROBE(fmt, args...) PWC_DEBUG(PROBE, fmt, ##args) 69#define PWC_DEBUG_OPEN(fmt, args...) PWC_DEBUG(OPEN, fmt, ##args) 70#define PWC_DEBUG_READ(fmt, args...) PWC_DEBUG(READ, fmt, ##args) 71#define PWC_DEBUG_MEMORY(fmt, args...) PWC_DEBUG(MEMORY, fmt, ##args) 72#define PWC_DEBUG_FLOW(fmt, args...) PWC_DEBUG(FLOW, fmt, ##args) 73#define PWC_DEBUG_SIZE(fmt, args...) PWC_DEBUG(SIZE, fmt, ##args) 74#define PWC_DEBUG_IOCTL(fmt, args...) PWC_DEBUG(IOCTL, fmt, ##args) 75#define PWC_DEBUG_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args) 76 77 78#ifdef CONFIG_USB_PWC_DEBUG 79 80#define PWC_DEBUG_LEVEL (PWC_DEBUG_LEVEL_MODULE) 81 82#define PWC_DEBUG(level, fmt, args...) do {\ 83 if ((PWC_DEBUG_LEVEL_ ##level) & pwc_trace) \ 84 printk(KERN_DEBUG PFX fmt, ##args); \ 85 } while (0) 86 87#define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args) 88#define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args) 89#define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args) 90#define PWC_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args) 91 92#else /* if ! CONFIG_USB_PWC_DEBUG */ 93 94#define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args) 95#define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args) 96#define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args) 97#define PWC_TRACE(fmt, args...) do { } while(0) 98#define PWC_DEBUG(level, fmt, args...) do { } while(0) 99 100#define pwc_trace 0 101 102#endif 103 104/* Defines for ToUCam cameras */ 105#define TOUCAM_HEADER_SIZE 8 106#define TOUCAM_TRAILER_SIZE 4 107 108#define FEATURE_MOTOR_PANTILT 0x0001 109#define FEATURE_CODEC1 0x0002 110#define FEATURE_CODEC2 0x0004 111 112#define MAX_WIDTH 640 113#define MAX_HEIGHT 480 114 115/* Ignore errors in the first N frames, to allow for startup delays */ 116#define FRAME_LOWMARK 5 117 118/* Size and number of buffers for the ISO pipe. */ 119#define MAX_ISO_BUFS 3 120#define ISO_FRAMES_PER_DESC 10 121#define ISO_MAX_FRAME_SIZE 960 122#define ISO_BUFFER_SIZE (ISO_FRAMES_PER_DESC * ISO_MAX_FRAME_SIZE) 123 124/* Maximum size after decompression is 640x480 YUV data, 1.5 * 640 * 480 */ 125#define PWC_FRAME_SIZE (460800 + TOUCAM_HEADER_SIZE + TOUCAM_TRAILER_SIZE) 126 127/* Absolute minimum and maximum number of buffers available for mmap() */ 128#define MIN_FRAMES 2 129#define MAX_FRAMES 16 130 131/* Some macros to quickly find the type of a webcam */ 132#define DEVICE_USE_CODEC1(x) ((x)<675) 133#define DEVICE_USE_CODEC2(x) ((x)>=675 && (x)<700) 134#define DEVICE_USE_CODEC3(x) ((x)>=700) 135#define DEVICE_USE_CODEC23(x) ((x)>=675) 136 137/* Request types: video */ 138#define SET_LUM_CTL 0x01 139#define GET_LUM_CTL 0x02 140#define SET_CHROM_CTL 0x03 141#define GET_CHROM_CTL 0x04 142#define SET_STATUS_CTL 0x05 143#define GET_STATUS_CTL 0x06 144#define SET_EP_STREAM_CTL 0x07 145#define GET_EP_STREAM_CTL 0x08 146#define GET_XX_CTL 0x09 147#define SET_XX_CTL 0x0A 148#define GET_XY_CTL 0x0B 149#define SET_XY_CTL 0x0C 150#define SET_MPT_CTL 0x0D 151#define GET_MPT_CTL 0x0E 152 153/* Selectors for the Luminance controls [GS]ET_LUM_CTL */ 154#define AGC_MODE_FORMATTER 0x2000 155#define PRESET_AGC_FORMATTER 0x2100 156#define SHUTTER_MODE_FORMATTER 0x2200 157#define PRESET_SHUTTER_FORMATTER 0x2300 158#define PRESET_CONTOUR_FORMATTER 0x2400 159#define AUTO_CONTOUR_FORMATTER 0x2500 160#define BACK_LIGHT_COMPENSATION_FORMATTER 0x2600 161#define CONTRAST_FORMATTER 0x2700 162#define DYNAMIC_NOISE_CONTROL_FORMATTER 0x2800 163#define FLICKERLESS_MODE_FORMATTER 0x2900 164#define AE_CONTROL_SPEED 0x2A00 165#define BRIGHTNESS_FORMATTER 0x2B00 166#define GAMMA_FORMATTER 0x2C00 167 168/* Selectors for the Chrominance controls [GS]ET_CHROM_CTL */ 169#define WB_MODE_FORMATTER 0x1000 170#define AWB_CONTROL_SPEED_FORMATTER 0x1100 171#define AWB_CONTROL_DELAY_FORMATTER 0x1200 172#define PRESET_MANUAL_RED_GAIN_FORMATTER 0x1300 173#define PRESET_MANUAL_BLUE_GAIN_FORMATTER 0x1400 174#define COLOUR_MODE_FORMATTER 0x1500 175#define SATURATION_MODE_FORMATTER1 0x1600 176#define SATURATION_MODE_FORMATTER2 0x1700 177 178/* Selectors for the Status controls [GS]ET_STATUS_CTL */ 179#define SAVE_USER_DEFAULTS_FORMATTER 0x0200 180#define RESTORE_USER_DEFAULTS_FORMATTER 0x0300 181#define RESTORE_FACTORY_DEFAULTS_FORMATTER 0x0400 182#define READ_AGC_FORMATTER 0x0500 183#define READ_SHUTTER_FORMATTER 0x0600 184#define READ_RED_GAIN_FORMATTER 0x0700 185#define READ_BLUE_GAIN_FORMATTER 0x0800 186 187/* Formatters for the motorized pan & tilt [GS]ET_MPT_CTL */ 188#define PT_RELATIVE_CONTROL_FORMATTER 0x01 189#define PT_RESET_CONTROL_FORMATTER 0x02 190#define PT_STATUS_FORMATTER 0x03 191 192/* Enumeration of image sizes */ 193#define PSZ_SQCIF 0x00 194#define PSZ_QSIF 0x01 195#define PSZ_QCIF 0x02 196#define PSZ_SIF 0x03 197#define PSZ_CIF 0x04 198#define PSZ_VGA 0x05 199#define PSZ_MAX 6 200 201struct pwc_raw_frame { 202 __le16 type; /* type of the webcam */ 203 __le16 vbandlength; /* Size of 4 lines compressed (used by the 204 decompressor) */ 205 __u8 cmd[4]; /* the four byte of the command (in case of 206 nala, only the first 3 bytes is filled) */ 207 __u8 rawframe[0]; /* frame_size = H / 4 * vbandlength */ 208} __packed; 209 210/* intermediate buffers with raw data from the USB cam */ 211struct pwc_frame_buf 212{ 213 struct vb2_buffer vb; /* common v4l buffer stuff -- must be first */ 214 struct list_head list; 215 void *data; 216 int filled; /* number of bytes filled */ 217}; 218 219struct pwc_device 220{ 221 struct video_device vdev; 222 struct v4l2_device v4l2_dev; 223 224 /* Pointer to our usb_device, may be NULL after unplug */ 225 struct usb_device *udev; 226 struct mutex udevlock; 227 228 /* type of cam (645, 646, 675, 680, 690, 720, 730, 740, 750) */ 229 int type; 230 int release; /* release number */ 231 int features; /* feature bits */ 232 233 /*** Video data ***/ 234 struct file *capt_file; /* file doing video capture */ 235 struct mutex capt_file_lock; 236 int vendpoint; /* video isoc endpoint */ 237 int vcinterface; /* video control interface */ 238 int valternate; /* alternate interface needed */ 239 int vframes; /* frames-per-second */ 240 int pixfmt; /* pixelformat: V4L2_PIX_FMT_YUV420 or _PWCX */ 241 int vframe_count; /* received frames */ 242 int vmax_packet_size; /* USB maxpacket size */ 243 int vlast_packet_size; /* for frame synchronisation */ 244 int visoc_errors; /* number of contiguous ISOC errors */ 245 int vbandlength; /* compressed band length; 0 is uncompressed */ 246 char vsync; /* used by isoc handler */ 247 char vmirror; /* for ToUCaM series */ 248 char power_save; /* Do powersaving for this cam */ 249 250 unsigned char cmd_buf[13]; 251 unsigned char *ctrl_buf; 252 253 struct urb *urbs[MAX_ISO_BUFS]; 254 char iso_init; 255 256 /* videobuf2 queue and queued buffers list */ 257 struct vb2_queue vb_queue; 258 struct list_head queued_bufs; 259 spinlock_t queued_bufs_lock; 260 261 /* 262 * Frame currently being filled, this only gets touched by the 263 * isoc urb complete handler, and by stream start / stop since 264 * start / stop touch it before / after starting / killing the urbs 265 * no locking is needed around this 266 */ 267 struct pwc_frame_buf *fill_buf; 268 269 int frame_header_size, frame_trailer_size; 270 int frame_size; 271 int frame_total_size; /* including header & trailer */ 272 int drop_frames; 273 274 union { /* private data for decompression engine */ 275 struct pwc_dec1_private dec1; 276 struct pwc_dec23_private dec23; 277 }; 278 279 /* 280 * We have an 'image' and a 'view', where 'image' is the fixed-size img 281 * as delivered by the camera, and 'view' is the size requested by the 282 * program. The camera image is centered in this viewport, laced with 283 * a gray or black border. view_min <= image <= view <= view_max; 284 */ 285 int image_mask; /* supported sizes */ 286 int width, height; /* current resolution */ 287 288#ifdef CONFIG_USB_PWC_INPUT_EVDEV 289 struct input_dev *button_dev; /* webcam snapshot button input */ 290 char button_phys[64]; 291#endif 292 293 /* controls */ 294 struct v4l2_ctrl_handler ctrl_handler; 295 u16 saturation_fmt; 296 struct v4l2_ctrl *brightness; 297 struct v4l2_ctrl *contrast; 298 struct v4l2_ctrl *saturation; 299 struct v4l2_ctrl *gamma; 300 struct { 301 /* awb / red-blue balance cluster */ 302 struct v4l2_ctrl *auto_white_balance; 303 struct v4l2_ctrl *red_balance; 304 struct v4l2_ctrl *blue_balance; 305 /* usb ctrl transfers are slow, so we cache things */ 306 int color_bal_valid; 307 unsigned long last_color_bal_update; /* In jiffies */ 308 s32 last_red_balance; 309 s32 last_blue_balance; 310 }; 311 struct { 312 /* autogain / gain cluster */ 313 struct v4l2_ctrl *autogain; 314 struct v4l2_ctrl *gain; 315 int gain_valid; 316 unsigned long last_gain_update; /* In jiffies */ 317 s32 last_gain; 318 }; 319 struct { 320 /* exposure_auto / exposure cluster */ 321 struct v4l2_ctrl *exposure_auto; 322 struct v4l2_ctrl *exposure; 323 int exposure_valid; 324 unsigned long last_exposure_update; /* In jiffies */ 325 s32 last_exposure; 326 }; 327 struct v4l2_ctrl *colorfx; 328 struct { 329 /* autocontour/contour cluster */ 330 struct v4l2_ctrl *autocontour; 331 struct v4l2_ctrl *contour; 332 }; 333 struct v4l2_ctrl *backlight; 334 struct v4l2_ctrl *flicker; 335 struct v4l2_ctrl *noise_reduction; 336 struct v4l2_ctrl *save_user; 337 struct v4l2_ctrl *restore_user; 338 struct v4l2_ctrl *restore_factory; 339 struct v4l2_ctrl *awb_speed; 340 struct v4l2_ctrl *awb_delay; 341 struct { 342 /* motor control cluster */ 343 struct v4l2_ctrl *motor_pan; 344 struct v4l2_ctrl *motor_tilt; 345 struct v4l2_ctrl *motor_pan_reset; 346 struct v4l2_ctrl *motor_tilt_reset; 347 }; 348 /* CODEC3 models have both gain and exposure controlled by autogain */ 349 struct v4l2_ctrl *autogain_expo_cluster[3]; 350}; 351 352/* Global variables */ 353#ifdef CONFIG_USB_PWC_DEBUG 354extern int pwc_trace; 355#endif 356 357int pwc_test_n_set_capt_file(struct pwc_device *pdev, struct file *file); 358 359/** Functions in pwc-misc.c */ 360/* sizes in pixels */ 361extern const int pwc_image_sizes[PSZ_MAX][2]; 362 363int pwc_get_size(struct pwc_device *pdev, int width, int height); 364void pwc_construct(struct pwc_device *pdev); 365 366/** Functions in pwc-ctrl.c */ 367/* Request a certain video mode. Returns < 0 if not possible */ 368extern int pwc_set_video_mode(struct pwc_device *pdev, int width, int height, 369 int pixfmt, int frames, int *compression, int send_to_cam); 370extern unsigned int pwc_get_fps(struct pwc_device *pdev, unsigned int index, unsigned int size); 371extern int pwc_set_leds(struct pwc_device *pdev, int on_value, int off_value); 372extern int pwc_get_cmos_sensor(struct pwc_device *pdev, int *sensor); 373extern int send_control_msg(struct pwc_device *pdev, 374 u8 request, u16 value, void *buf, int buflen); 375 376/* Control get / set helpers */ 377int pwc_get_u8_ctrl(struct pwc_device *pdev, u8 request, u16 value, int *data); 378int pwc_set_u8_ctrl(struct pwc_device *pdev, u8 request, u16 value, u8 data); 379int pwc_get_s8_ctrl(struct pwc_device *pdev, u8 request, u16 value, int *data); 380#define pwc_set_s8_ctrl pwc_set_u8_ctrl 381int pwc_get_u16_ctrl(struct pwc_device *pdev, u8 request, u16 value, int *dat); 382int pwc_set_u16_ctrl(struct pwc_device *pdev, u8 request, u16 value, u16 data); 383int pwc_button_ctrl(struct pwc_device *pdev, u16 value); 384int pwc_init_controls(struct pwc_device *pdev); 385 386/* Power down or up the camera; not supported by all models */ 387extern void pwc_camera_power(struct pwc_device *pdev, int power); 388 389extern const struct v4l2_ioctl_ops pwc_ioctl_ops; 390 391/** pwc-uncompress.c */ 392/* Expand frame to image, possibly including decompression. Uses read_frame and fill_image */ 393int pwc_decompress(struct pwc_device *pdev, struct pwc_frame_buf *fbuf); 394 395#endif 396