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/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/videobuf2-vmalloc.h>
  40 #ifdef CONFIG_USB_PWC_INPUT_EVDEV
  41 #include <linux/input.h>
  42 #endif
  43
  44 #include "pwc-uncompress.h"
  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 /* Turn certain features on/off */
 110 #define PWC_INT_PIPE 0
 111
 112 /* Ignore errors in the first N frames, to allow for startup delays */
 113 #define FRAME_LOWMARK 5
 114
 115 /* Size and number of buffers for the ISO pipe. */
 116 #define MAX_ISO_BUFS            3
 117 #define ISO_FRAMES_PER_DESC     10
 118 #define ISO_MAX_FRAME_SIZE      960
 119 #define ISO_BUFFER_SIZE         (ISO_FRAMES_PER_DESC * ISO_MAX_FRAME_SIZE)
 120
 121 /* Maximum size after decompression is 640x480 YUV data, 1.5 * 640 * 480 */
 122 #define PWC_FRAME_SIZE          (460800 + TOUCAM_HEADER_SIZE + TOUCAM_TRAILER_SIZE)
 123
 124 /* Absolute minimum and maximum number of buffers available for mmap() */
 125 #define MIN_FRAMES              2
 126 #define MAX_FRAMES              16
 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 /* The following structures were based on cpia.h. Why reinvent the wheel? :-) */
 135 struct pwc_iso_buf
 136 {
 137         void *data;
 138         int  length;
 139         int  read;
 140         struct urb *urb;
 141 };
 142
 143 /* intermediate buffers with raw data from the USB cam */
 144 struct pwc_frame_buf
 145 {
 146         struct vb2_buffer vb;   /* common v4l buffer stuff -- must be first */
 147         struct list_head list;
 148         void *data;
 149         int filled;             /* number of bytes filled */
 150 };
 151
 152 struct pwc_device
 153 {
 154         struct video_device vdev;
 155         struct mutex modlock;
 156
 157         /* Pointer to our usb_device, may be NULL after unplug */
 158         struct usb_device *udev;
 159         /* type of cam (645, 646, 675, 680, 690, 720, 730, 740, 750) */
 160         int type;
 161         int release;            /* release number */
 162         int features;           /* feature bits */
 163         char serial[30];        /* serial number (string) */
 164         int usb_init;           /* set when the cam has been initialized */
 165
 166         /*** Video data ***/
 167         int vopen;              /* flag */
 168         int vendpoint;          /* video isoc endpoint */
 169         int vcinterface;        /* video control interface */
 170         int valternate;         /* alternate interface needed */
 171         int vframes, vsize;     /* frames-per-second & size (see PSZ_*) */
 172         int pixfmt;             /* pixelformat: V4L2_PIX_FMT_YUV420 or _PWCX */
 173         int vframe_count;       /* received frames */
 174         int vmax_packet_size;   /* USB maxpacket size */
 175         int vlast_packet_size;  /* for frame synchronisation */
 176         int visoc_errors;       /* number of contiguous ISOC errors */
 177         int vcompression;       /* desired compression factor */
 178         int vbandlength;        /* compressed band length; 0 is uncompressed */
 179         char vsnapshot;         /* snapshot mode */
 180         char vsync;             /* used by isoc handler */
 181         char vmirror;           /* for ToUCaM series */
 182
 183         int cmd_len;
 184         unsigned char cmd_buf[13];
 185
 186         struct pwc_iso_buf sbuf[MAX_ISO_BUFS];
 187         char iso_init;
 188
 189         /* videobuf2 queue and queued buffers list */
 190         struct vb2_queue vb_queue;
 191         struct list_head queued_bufs;
 192         spinlock_t queued_bufs_lock;
 193
 194         /*
 195          * Frame currently being filled, this only gets touched by the
 196          * isoc urb complete handler, and by stream start / stop since
 197          * start / stop touch it before / after starting / killing the urbs
 198          * no locking is needed around this
 199          */
 200         struct pwc_frame_buf *fill_buf;
 201
 202         int frame_header_size, frame_trailer_size;
 203         int frame_size;
 204         int frame_total_size;   /* including header & trailer */
 205         int drop_frames;
 206
 207         void *decompress_data;  /* private data for decompression engine */
 208
 209         /*
 210          * We have an 'image' and a 'view', where 'image' is the fixed-size img
 211          * as delivered by the camera, and 'view' is the size requested by the
 212          * program. The camera image is centered in this viewport, laced with
 213          * a gray or black border. view_min <= image <= view <= view_max;
 214          */
 215         int image_mask;                         /* supported sizes */
 216         struct pwc_coord view_min, view_max;    /* minimum and maximum view */
 217         struct pwc_coord abs_max;               /* maximum supported size */
 218         struct pwc_coord image, view;           /* image and viewport size */
 219         struct pwc_coord offset;                /* offset of the viewport */
 220
 221         /*** motorized pan/tilt feature */
 222         struct pwc_mpt_range angle_range;
 223         int pan_angle;                  /* in degrees * 100 */
 224         int tilt_angle;                 /* absolute angle; 0,0 is home */
 225
 226         /*
 227          * Set to 1 when the user push the button, reset to 0
 228          * when this value is read from sysfs.
 229          */
 230         int snapshot_button_status;
 231 #ifdef CONFIG_USB_PWC_INPUT_EVDEV
 232         struct input_dev *button_dev;   /* webcam snapshot button input */
 233         char button_phys[64];
 234 #endif
 235
 236         /*** Misc. data ***/
 237 #if PWC_INT_PIPE
 238         void *usb_int_handler;          /* for the interrupt endpoint */
 239 #endif
 240 };
 241
 242 /* Global variables */
 243 #ifdef CONFIG_USB_PWC_DEBUG
 244 extern int pwc_trace;
 245 #endif
 246
 247 /** Functions in pwc-misc.c */
 248 /* sizes in pixels */
 249 extern const struct pwc_coord pwc_image_sizes[PSZ_MAX];
 250
 251 int pwc_decode_size(struct pwc_device *pdev, int width, int height);
 252 void pwc_construct(struct pwc_device *pdev);
 253
 254 /** Functions in pwc-ctrl.c */
 255 /* Request a certain video mode. Returns < 0 if not possible */
 256 extern int pwc_set_video_mode(struct pwc_device *pdev, int width, int height, int frames, int compression, int snapshot);
 257 extern unsigned int pwc_get_fps(struct pwc_device *pdev, unsigned int index, unsigned int size);
 258 /* Calculate the number of bytes per image (not frame) */
 259 extern int pwc_mpt_reset(struct pwc_device *pdev, int flags);
 260 extern int pwc_mpt_set_angle(struct pwc_device *pdev, int pan, int tilt);
 261
 262 /* Various controls; should be obvious. Value 0..65535, or < 0 on error */
 263 extern int pwc_get_brightness(struct pwc_device *pdev);
 264 extern int pwc_set_brightness(struct pwc_device *pdev, int value);
 265 extern int pwc_get_contrast(struct pwc_device *pdev);
 266 extern int pwc_set_contrast(struct pwc_device *pdev, int value);
 267 extern int pwc_get_gamma(struct pwc_device *pdev);
 268 extern int pwc_set_gamma(struct pwc_device *pdev, int value);
 269 extern int pwc_get_saturation(struct pwc_device *pdev, int *value);
 270 extern int pwc_set_saturation(struct pwc_device *pdev, int value);
 271 extern int pwc_set_leds(struct pwc_device *pdev, int on_value, int off_value);
 272 extern int pwc_get_cmos_sensor(struct pwc_device *pdev, int *sensor);
 273 extern int pwc_restore_user(struct pwc_device *pdev);
 274 extern int pwc_save_user(struct pwc_device *pdev);
 275 extern int pwc_restore_factory(struct pwc_device *pdev);
 276
 277 /* exported for use by v4l2 controls */
 278 extern int pwc_get_red_gain(struct pwc_device *pdev, int *value);
 279 extern int pwc_set_red_gain(struct pwc_device *pdev, int value);
 280 extern int pwc_get_blue_gain(struct pwc_device *pdev, int *value);
 281 extern int pwc_set_blue_gain(struct pwc_device *pdev, int value);
 282 extern int pwc_get_awb(struct pwc_device *pdev);
 283 extern int pwc_set_awb(struct pwc_device *pdev, int mode);
 284 extern int pwc_set_agc(struct pwc_device *pdev, int mode, int value);
 285 extern int pwc_get_agc(struct pwc_device *pdev, int *value);
 286 extern int pwc_set_shutter_speed(struct pwc_device *pdev, int mode, int value);
 287 extern int pwc_get_shutter_speed(struct pwc_device *pdev, int *value);
 288
 289 extern int pwc_set_colour_mode(struct pwc_device *pdev, int colour);
 290 extern int pwc_get_colour_mode(struct pwc_device *pdev, int *colour);
 291 extern int pwc_set_contour(struct pwc_device *pdev, int contour);
 292 extern int pwc_get_contour(struct pwc_device *pdev, int *contour);
 293 extern int pwc_set_backlight(struct pwc_device *pdev, int backlight);
 294 extern int pwc_get_backlight(struct pwc_device *pdev, int *backlight);
 295 extern int pwc_set_flicker(struct pwc_device *pdev, int flicker);
 296 extern int pwc_get_flicker(struct pwc_device *pdev, int *flicker);
 297 extern int pwc_set_dynamic_noise(struct pwc_device *pdev, int noise);
 298 extern int pwc_get_dynamic_noise(struct pwc_device *pdev, int *noise);
 299
 300 /* Power down or up the camera; not supported by all models */
 301 extern int pwc_camera_power(struct pwc_device *pdev, int power);
 302
 303 /* Private ioctl()s; see pwc-ioctl.h */
 304 extern long pwc_ioctl(struct pwc_device *pdev, unsigned int cmd, void *arg);
 305
 306 extern const struct v4l2_ioctl_ops pwc_ioctl_ops;
 307
 308 /** pwc-uncompress.c */
 309 /* Expand frame to image, possibly including decompression. Uses read_frame and fill_image */
 310 int pwc_decompress(struct pwc_device *pdev, struct pwc_frame_buf *fbuf);
 311
 312 #endif