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