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 <linux/mutex.h>
  35 #include <linux/mm.h>
  36 #include <asm/errno.h>
  37 #include <linux/videodev.h>
  38 #include <media/v4l2-common.h>
  39 #include <media/v4l2-ioctl.h>
  40
  41 #include "pwc-uncompress.h"
  42 #include <media/pwc-ioctl.h>
  43
  44 /* Version block */
  45 #define PWC_MAJOR       10
  46 #define PWC_MINOR       0
  47 #define PWC_EXTRAMINOR  12
  48 #define PWC_VERSION_CODE KERNEL_VERSION(PWC_MAJOR,PWC_MINOR,PWC_EXTRAMINOR)
  49 #define PWC_VERSION     "10.0.13"
  50 #define PWC_NAME        "pwc"
  51 #define PFX             PWC_NAME ": "
  52
  53
  54 /* Trace certain actions in the driver */
  55 #define PWC_DEBUG_LEVEL_MODULE  (1<<0)
  56 #define PWC_DEBUG_LEVEL_PROBE   (1<<1)
  57 #define PWC_DEBUG_LEVEL_OPEN    (1<<2)
  58 #define PWC_DEBUG_LEVEL_READ    (1<<3)
  59 #define PWC_DEBUG_LEVEL_MEMORY  (1<<4)
  60 #define PWC_DEBUG_LEVEL_FLOW    (1<<5)
  61 #define PWC_DEBUG_LEVEL_SIZE    (1<<6)
  62 #define PWC_DEBUG_LEVEL_IOCTL   (1<<7)
  63 #define PWC_DEBUG_LEVEL_TRACE   (1<<8)
  64
  65 #define PWC_DEBUG_MODULE(fmt, args...) PWC_DEBUG(MODULE, fmt, ##args)
  66 #define PWC_DEBUG_PROBE(fmt, args...) PWC_DEBUG(PROBE, fmt, ##args)
  67 #define PWC_DEBUG_OPEN(fmt, args...) PWC_DEBUG(OPEN, fmt, ##args)
  68 #define PWC_DEBUG_READ(fmt, args...) PWC_DEBUG(READ, fmt, ##args)
  69 #define PWC_DEBUG_MEMORY(fmt, args...) PWC_DEBUG(MEMORY, fmt, ##args)
  70 #define PWC_DEBUG_FLOW(fmt, args...) PWC_DEBUG(FLOW, fmt, ##args)
  71 #define PWC_DEBUG_SIZE(fmt, args...) PWC_DEBUG(SIZE, fmt, ##args)
  72 #define PWC_DEBUG_IOCTL(fmt, args...) PWC_DEBUG(IOCTL, fmt, ##args)
  73 #define PWC_DEBUG_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args)
  74
  75
  76 #ifdef CONFIG_USB_PWC_DEBUG
  77
  78 #define PWC_DEBUG_LEVEL (PWC_DEBUG_LEVEL_MODULE)
  79
  80 #define PWC_DEBUG(level, fmt, args...) do {\
  81           if ((PWC_DEBUG_LEVEL_ ##level) & pwc_trace) \
  82              printk(KERN_DEBUG PFX fmt, ##args); \
  83           } while(0)
  84
  85 #define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args)
  86 #define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args)
  87 #define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args)
  88 #define PWC_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args)
  89
  90 #else /* if ! CONFIG_USB_PWC_DEBUG */
  91
  92 #define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args)
  93 #define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args)
  94 #define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args)
  95 #define PWC_TRACE(fmt, args...) do { } while(0)
  96 #define PWC_DEBUG(level, fmt, args...) do { } while(0)
  97
  98 #define pwc_trace 0
  99
 100 #endif
 101
 102 /* Defines for ToUCam cameras */
 103 #define TOUCAM_HEADER_SIZE              8
 104 #define TOUCAM_TRAILER_SIZE             4
 105
 106 #define FEATURE_MOTOR_PANTILT           0x0001
 107 #define FEATURE_CODEC1                  0x0002
 108 #define FEATURE_CODEC2                  0x0004
 109
 110 /* Turn certain features on/off */
 111 #define PWC_INT_PIPE 0
 112
 113 /* Ignore errors in the first N frames, to allow for startup delays */
 114 #define FRAME_LOWMARK 5
 115
 116 /* Size and number of buffers for the ISO pipe. */
 117 #define MAX_ISO_BUFS            2
 118 #define ISO_FRAMES_PER_DESC     10
 119 #define ISO_MAX_FRAME_SIZE      960
 120 #define ISO_BUFFER_SIZE         (ISO_FRAMES_PER_DESC * ISO_MAX_FRAME_SIZE)
 121
 122 /* Frame buffers: contains compressed or uncompressed video data. */
 123 #define MAX_FRAMES              5
 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 maximum number of buffers available for mmap() */
 128 #define MAX_IMAGES              10
 129
 130 /* Some macros to quickly find the type of a webcam */
 131 #define DEVICE_USE_CODEC1(x) ((x)<675)
 132 #define DEVICE_USE_CODEC2(x) ((x)>=675 && (x)<700)
 133 #define DEVICE_USE_CODEC3(x) ((x)>=700)
 134 #define DEVICE_USE_CODEC23(x) ((x)>=675)
 135
 136
 137 #ifndef V4L2_PIX_FMT_PWC1
 138 #define V4L2_PIX_FMT_PWC1       v4l2_fourcc('P','W','C','1')
 139 #define V4L2_PIX_FMT_PWC2       v4l2_fourcc('P','W','C','2')
 140 #endif
 141
 142 /* The following structures were based on cpia.h. Why reinvent the wheel? :-) */
 143 struct pwc_iso_buf
 144 {
 145         void *data;
 146         int  length;
 147         int  read;
 148         struct urb *urb;
 149 };
 150
 151 /* intermediate buffers with raw data from the USB cam */
 152 struct pwc_frame_buf
 153 {
 154    void *data;
 155    volatile int filled;         /* number of bytes filled */
 156    struct pwc_frame_buf *next;  /* list */
 157 };
 158
 159 /* additionnal informations used when dealing image between kernel and userland */
 160 struct pwc_imgbuf
 161 {
 162         unsigned long offset;   /* offset of this buffer in the big array of image_data */
 163         int   vma_use_count;    /* count the number of time this memory is mapped */
 164 };
 165
 166 struct pwc_device
 167 {
 168    struct video_device *vdev;
 169
 170    /* Pointer to our usb_device */
 171    struct usb_device *udev;
 172
 173    int type;                    /* type of cam (645, 646, 675, 680, 690, 720, 730, 740, 750) */
 174    int release;                 /* release number */
 175    int features;                /* feature bits */
 176    char serial[30];             /* serial number (string) */
 177    int error_status;            /* set when something goes wrong with the cam (unplugged, USB errors) */
 178    int usb_init;                /* set when the cam has been initialized over USB */
 179
 180    /*** Video data ***/
 181    int vopen;                   /* flag */
 182    int vendpoint;               /* video isoc endpoint */
 183    int vcinterface;             /* video control interface */
 184    int valternate;              /* alternate interface needed */
 185    int vframes, vsize;          /* frames-per-second & size (see PSZ_*) */
 186    int vpalette;                /* palette: 420P, RAW or RGBBAYER */
 187    int vframe_count;            /* received frames */
 188    int vframes_dumped;          /* counter for dumped frames */
 189    int vframes_error;           /* frames received in error */
 190    int vmax_packet_size;        /* USB maxpacket size */
 191    int vlast_packet_size;       /* for frame synchronisation */
 192    int visoc_errors;            /* number of contiguous ISOC errors */
 193    int vcompression;            /* desired compression factor */
 194    int vbandlength;             /* compressed band length; 0 is uncompressed */
 195    char vsnapshot;              /* snapshot mode */
 196    char vsync;                  /* used by isoc handler */
 197    char vmirror;                /* for ToUCaM series */
 198         char unplugged;
 199
 200    int cmd_len;
 201    unsigned char cmd_buf[13];
 202
 203    /* The image acquisition requires 3 to 4 steps:
 204       1. data is gathered in short packets from the USB controller
 205       2. data is synchronized and packed into a frame buffer
 206       3a. in case data is compressed, decompress it directly into image buffer
 207       3b. in case data is uncompressed, copy into image buffer with viewport
 208       4. data is transferred to the user process
 209
 210       Note that MAX_ISO_BUFS != MAX_FRAMES != MAX_IMAGES....
 211       We have in effect a back-to-back-double-buffer system.
 212     */
 213    /* 1: isoc */
 214    struct pwc_iso_buf sbuf[MAX_ISO_BUFS];
 215    char iso_init;
 216
 217    /* 2: frame */
 218    struct pwc_frame_buf *fbuf;  /* all frames */
 219    struct pwc_frame_buf *empty_frames, *empty_frames_tail;      /* all empty frames */
 220    struct pwc_frame_buf *full_frames, *full_frames_tail;        /* all filled frames */
 221    struct pwc_frame_buf *fill_frame;    /* frame currently being filled */
 222    struct pwc_frame_buf *read_frame;    /* frame currently read by user process */
 223    int frame_header_size, frame_trailer_size;
 224    int frame_size;
 225    int frame_total_size; /* including header & trailer */
 226    int drop_frames;
 227
 228    /* 3: decompression */
 229    void *decompress_data;               /* private data for decompression engine */
 230
 231    /* 4: image */
 232    /* We have an 'image' and a 'view', where 'image' is the fixed-size image
 233       as delivered by the camera, and 'view' is the size requested by the
 234       program. The camera image is centered in this viewport, laced with
 235       a gray or black border. view_min <= image <= view <= view_max;
 236     */
 237    int image_mask;                      /* bitmask of supported sizes */
 238    struct pwc_coord view_min, view_max; /* minimum and maximum viewable sizes */
 239    struct pwc_coord abs_max;            /* maximum supported size with compression */
 240    struct pwc_coord image, view;        /* image and viewport size */
 241    struct pwc_coord offset;             /* offset within the viewport */
 242
 243    void *image_data;                    /* total buffer, which is subdivided into ... */
 244    struct pwc_imgbuf images[MAX_IMAGES];/* ...several images... */
 245    int fill_image;                      /* ...which are rotated. */
 246    int len_per_image;                   /* length per image */
 247    int image_read_pos;                  /* In case we read data in pieces, keep track of were we are in the imagebuffer */
 248    int image_used[MAX_IMAGES];          /* For MCAPTURE and SYNC */
 249
 250    struct mutex modlock;                /* to prevent races in video_open(), etc */
 251    spinlock_t ptrlock;                  /* for manipulating the buffer pointers */
 252
 253    /*** motorized pan/tilt feature */
 254    struct pwc_mpt_range angle_range;
 255    int pan_angle;                       /* in degrees * 100 */
 256    int tilt_angle;                      /* absolute angle; 0,0 is home position */
 257    int snapshot_button_status;          /* set to 1 when the user push the button, reset to 0 when this value is read */
 258
 259    /*** Misc. data ***/
 260    wait_queue_head_t frameq;            /* When waiting for a frame to finish... */
 261 #if PWC_INT_PIPE
 262    void *usb_int_handler;               /* for the interrupt endpoint */
 263 #endif
 264 };
 265
 266 #ifdef __cplusplus
 267 extern "C" {
 268 #endif
 269
 270 /* Global variables */
 271 #ifdef CONFIG_USB_PWC_DEBUG
 272 extern int pwc_trace;
 273 #endif
 274 extern int pwc_mbufs;
 275
 276 /** functions in pwc-if.c */
 277 int pwc_try_video_mode(struct pwc_device *pdev, int width, int height, int new_fps, int new_compression, int new_snapshot);
 278 int pwc_handle_frame(struct pwc_device *pdev);
 279 void pwc_next_image(struct pwc_device *pdev);
 280 int pwc_isoc_init(struct pwc_device *pdev);
 281 void pwc_isoc_cleanup(struct pwc_device *pdev);
 282
 283 /** Functions in pwc-misc.c */
 284 /* sizes in pixels */
 285 extern const struct pwc_coord pwc_image_sizes[PSZ_MAX];
 286
 287 int pwc_decode_size(struct pwc_device *pdev, int width, int height);
 288 void pwc_construct(struct pwc_device *pdev);
 289
 290 /** Functions in pwc-ctrl.c */
 291 /* Request a certain video mode. Returns < 0 if not possible */
 292 extern int pwc_set_video_mode(struct pwc_device *pdev, int width, int height, int frames, int compression, int snapshot);
 293 extern unsigned int pwc_get_fps(struct pwc_device *pdev, unsigned int index, unsigned int size);
 294 /* Calculate the number of bytes per image (not frame) */
 295 extern int pwc_mpt_reset(struct pwc_device *pdev, int flags);
 296 extern int pwc_mpt_set_angle(struct pwc_device *pdev, int pan, int tilt);
 297
 298 /* Various controls; should be obvious. Value 0..65535, or < 0 on error */
 299 extern int pwc_get_brightness(struct pwc_device *pdev);
 300 extern int pwc_set_brightness(struct pwc_device *pdev, int value);
 301 extern int pwc_get_contrast(struct pwc_device *pdev);
 302 extern int pwc_set_contrast(struct pwc_device *pdev, int value);
 303 extern int pwc_get_gamma(struct pwc_device *pdev);
 304 extern int pwc_set_gamma(struct pwc_device *pdev, int value);
 305 extern int pwc_get_saturation(struct pwc_device *pdev, int *value);
 306 extern int pwc_set_saturation(struct pwc_device *pdev, int value);
 307 extern int pwc_set_leds(struct pwc_device *pdev, int on_value, int off_value);
 308 extern int pwc_get_cmos_sensor(struct pwc_device *pdev, int *sensor);
 309 extern int pwc_restore_user(struct pwc_device *pdev);
 310 extern int pwc_save_user(struct pwc_device *pdev);
 311 extern int pwc_restore_factory(struct pwc_device *pdev);
 312
 313 /* exported for use by v4l2 controls */
 314 extern int pwc_get_red_gain(struct pwc_device *pdev, int *value);
 315 extern int pwc_set_red_gain(struct pwc_device *pdev, int value);
 316 extern int pwc_get_blue_gain(struct pwc_device *pdev, int *value);
 317 extern int pwc_set_blue_gain(struct pwc_device *pdev, int value);
 318 extern int pwc_get_awb(struct pwc_device *pdev);
 319 extern int pwc_set_awb(struct pwc_device *pdev, int mode);
 320 extern int pwc_set_agc(struct pwc_device *pdev, int mode, int value);
 321 extern int pwc_get_agc(struct pwc_device *pdev, int *value);
 322 extern int pwc_set_shutter_speed(struct pwc_device *pdev, int mode, int value);
 323 extern int pwc_get_shutter_speed(struct pwc_device *pdev, int *value);
 324
 325 extern int pwc_set_colour_mode(struct pwc_device *pdev, int colour);
 326 extern int pwc_get_colour_mode(struct pwc_device *pdev, int *colour);
 327 extern int pwc_set_contour(struct pwc_device *pdev, int contour);
 328 extern int pwc_get_contour(struct pwc_device *pdev, int *contour);
 329 extern int pwc_set_backlight(struct pwc_device *pdev, int backlight);
 330 extern int pwc_get_backlight(struct pwc_device *pdev, int *backlight);
 331 extern int pwc_set_flicker(struct pwc_device *pdev, int flicker);
 332 extern int pwc_get_flicker(struct pwc_device *pdev, int *flicker);
 333 extern int pwc_set_dynamic_noise(struct pwc_device *pdev, int noise);
 334 extern int pwc_get_dynamic_noise(struct pwc_device *pdev, int *noise);
 335
 336 /* Power down or up the camera; not supported by all models */
 337 extern int pwc_camera_power(struct pwc_device *pdev, int power);
 338
 339 /* Private ioctl()s; see pwc-ioctl.h */
 340 extern int pwc_ioctl(struct pwc_device *pdev, unsigned int cmd, void *arg);
 341
 342 /** Functions in pwc-v4l.c */
 343 extern int pwc_video_do_ioctl(struct inode *inode, struct file *file,
 344                               unsigned int cmd, void *arg);
 345
 346 /** pwc-uncompress.c */
 347 /* Expand frame to image, possibly including decompression. Uses read_frame and fill_image */
 348 extern int pwc_decompress(struct pwc_device *pdev);
 349
 350 #ifdef __cplusplus
 351 }
 352 #endif
 353
 354
 355 #endif
 356 /* vim: set cino= formatoptions=croql cindent shiftwidth=8 tabstop=8: */