drivers/usb/media/pwc/pwc.h

   1 /* (C) 1999-2003 Nemosoft Unv.
   2    (C) 2004      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/config.h>
  29 #include <linux/module.h>
  30 #include <linux/usb.h>
  31 #include <linux/spinlock.h>
  32 #include <linux/videodev.h>
  33 #include <linux/wait.h>
  34 #include <linux/smp_lock.h>
  35 #include <asm/semaphore.h>
  36 #include <asm/errno.h>
  37
  38 #include "pwc-uncompress.h"
  39 #include "pwc-ioctl.h"
  40
  41 /* Defines and structures for the Philips webcam */
  42 /* Used for checking memory corruption/pointer validation */
  43 #define PWC_MAGIC 0x89DC10ABUL
  44 #undef PWC_MAGIC
  45
  46 /* Turn some debugging options on/off */
  47 #define PWC_DEBUG 0
  48
  49 /* Trace certain actions in the driver */
  50 #define TRACE_MODULE    0x0001
  51 #define TRACE_PROBE     0x0002
  52 #define TRACE_OPEN      0x0004
  53 #define TRACE_READ      0x0008
  54 #define TRACE_MEMORY    0x0010
  55 #define TRACE_FLOW      0x0020
  56 #define TRACE_SIZE      0x0040
  57 #define TRACE_PWCX      0x0080
  58 #define TRACE_SEQUENCE  0x1000
  59
  60 #define Trace(R, A...) if (pwc_trace & R) printk(KERN_DEBUG PWC_NAME " " A)
  61 #define Debug(A...) printk(KERN_DEBUG PWC_NAME " " A)
  62 #define Info(A...)  printk(KERN_INFO  PWC_NAME " " A)
  63 #define Err(A...)   printk(KERN_ERR   PWC_NAME " " A)
  64
  65
  66 /* Defines for ToUCam cameras */
  67 #define TOUCAM_HEADER_SIZE              8
  68 #define TOUCAM_TRAILER_SIZE             4
  69
  70 #define FEATURE_MOTOR_PANTILT           0x0001
  71
  72 /* Version block */
  73 #define PWC_MAJOR       9
  74 #define PWC_MINOR       0
  75 #define PWC_VERSION     "9.0.2-unofficial"
  76 #define PWC_NAME        "pwc"
  77
  78 /* Turn certain features on/off */
  79 #define PWC_INT_PIPE 0
  80
  81 /* Ignore errors in the first N frames, to allow for startup delays */
  82 #define FRAME_LOWMARK 5
  83
  84 /* Size and number of buffers for the ISO pipe. */
  85 #define MAX_ISO_BUFS            2
  86 #define ISO_FRAMES_PER_DESC     10
  87 #define ISO_MAX_FRAME_SIZE      960
  88 #define ISO_BUFFER_SIZE         (ISO_FRAMES_PER_DESC * ISO_MAX_FRAME_SIZE)
  89
  90 /* Frame buffers: contains compressed or uncompressed video data. */
  91 #define MAX_FRAMES              5
  92 /* Maximum size after decompression is 640x480 YUV data, 1.5 * 640 * 480 */
  93 #define PWC_FRAME_SIZE          (460800 + TOUCAM_HEADER_SIZE + TOUCAM_TRAILER_SIZE)
  94
  95 /* Absolute maximum number of buffers available for mmap() */
  96 #define MAX_IMAGES              10
  97
  98 /* The following structures were based on cpia.h. Why reinvent the wheel? :-) */
  99 struct pwc_iso_buf
 100 {
 101         void *data;
 102         int  length;
 103         int  read;
 104         struct urb *urb;
 105 };
 106
 107 /* intermediate buffers with raw data from the USB cam */
 108 struct pwc_frame_buf
 109 {
 110    void *data;
 111    volatile int filled;         /* number of bytes filled */
 112    struct pwc_frame_buf *next;  /* list */
 113 #if PWC_DEBUG
 114    int sequence;                /* Sequence number */
 115 #endif
 116 };
 117
 118 struct pwc_device
 119 {
 120    struct video_device *vdev;
 121 #ifdef PWC_MAGIC
 122    int magic;
 123 #endif
 124    /* Pointer to our usb_device */
 125    struct usb_device *udev;
 126
 127    int type;                    /* type of cam (645, 646, 675, 680, 690, 720, 730, 740, 750) */
 128    int release;                 /* release number */
 129    int features;                /* feature bits */
 130    char serial[30];             /* serial number (string) */
 131    int error_status;            /* set when something goes wrong with the cam (unplugged, USB errors) */
 132    int usb_init;                /* set when the cam has been initialized over USB */
 133
 134    /*** Video data ***/
 135    int vopen;                   /* flag */
 136    int vendpoint;               /* video isoc endpoint */
 137    int vcinterface;             /* video control interface */
 138    int valternate;              /* alternate interface needed */
 139    int vframes, vsize;          /* frames-per-second & size (see PSZ_*) */
 140    int vpalette;                /* palette: 420P, RAW or RGBBAYER */
 141    int vframe_count;            /* received frames */
 142    int vframes_dumped;          /* counter for dumped frames */
 143    int vframes_error;           /* frames received in error */
 144    int vmax_packet_size;        /* USB maxpacket size */
 145    int vlast_packet_size;       /* for frame synchronisation */
 146    int visoc_errors;            /* number of contiguous ISOC errors */
 147    int vcompression;            /* desired compression factor */
 148    int vbandlength;             /* compressed band length; 0 is uncompressed */
 149    char vsnapshot;              /* snapshot mode */
 150    char vsync;                  /* used by isoc handler */
 151    char vmirror;                /* for ToUCaM series */
 152
 153    int cmd_len;
 154    unsigned char cmd_buf[13];
 155
 156    /* The image acquisition requires 3 to 4 steps:
 157       1. data is gathered in short packets from the USB controller
 158       2. data is synchronized and packed into a frame buffer
 159       3a. in case data is compressed, decompress it directly into image buffer
 160       3b. in case data is uncompressed, copy into image buffer with viewport
 161       4. data is transferred to the user process
 162
 163       Note that MAX_ISO_BUFS != MAX_FRAMES != MAX_IMAGES....
 164       We have in effect a back-to-back-double-buffer system.
 165     */
 166    /* 1: isoc */
 167    struct pwc_iso_buf sbuf[MAX_ISO_BUFS];
 168    char iso_init;
 169
 170    /* 2: frame */
 171    struct pwc_frame_buf *fbuf;  /* all frames */
 172    struct pwc_frame_buf *empty_frames, *empty_frames_tail;      /* all empty frames */
 173    struct pwc_frame_buf *full_frames, *full_frames_tail;        /* all filled frames */
 174    struct pwc_frame_buf *fill_frame;    /* frame currently being filled */
 175    struct pwc_frame_buf *read_frame;    /* frame currently read by user process */
 176    int frame_header_size, frame_trailer_size;
 177    int frame_size;
 178    int frame_total_size; /* including header & trailer */
 179    int drop_frames;
 180 #if PWC_DEBUG
 181    int sequence;                        /* Debugging aid */
 182 #endif
 183
 184    /* 3: decompression */
 185    struct pwc_decompressor *decompressor;       /* function block with decompression routines */
 186    void *decompress_data;               /* private data for decompression engine */
 187
 188    /* 4: image */
 189    /* We have an 'image' and a 'view', where 'image' is the fixed-size image
 190       as delivered by the camera, and 'view' is the size requested by the
 191       program. The camera image is centered in this viewport, laced with
 192       a gray or black border. view_min <= image <= view <= view_max;
 193     */
 194    int image_mask;                      /* bitmask of supported sizes */
 195    struct pwc_coord view_min, view_max; /* minimum and maximum viewable sizes */
 196    struct pwc_coord abs_max;            /* maximum supported size with compression */
 197    struct pwc_coord image, view;        /* image and viewport size */
 198    struct pwc_coord offset;             /* offset within the viewport */
 199
 200    void *image_data;                    /* total buffer, which is subdivided into ... */
 201    void *image_ptr[MAX_IMAGES];         /* ...several images... */
 202    int fill_image;                      /* ...which are rotated. */
 203    int len_per_image;                   /* length per image */
 204    int image_read_pos;                  /* In case we read data in pieces, keep track of were we are in the imagebuffer */
 205    int image_used[MAX_IMAGES];          /* For MCAPTURE and SYNC */
 206
 207    struct semaphore modlock;            /* to prevent races in video_open(), etc */
 208    spinlock_t ptrlock;                  /* for manipulating the buffer pointers */
 209
 210    /*** motorized pan/tilt feature */
 211    struct pwc_mpt_range angle_range;
 212    int pan_angle;                       /* in degrees * 100 */
 213    int tilt_angle;                      /* absolute angle; 0,0 is home position */
 214
 215    /*** Misc. data ***/
 216    wait_queue_head_t frameq;            /* When waiting for a frame to finish... */
 217 #if PWC_INT_PIPE
 218    void *usb_int_handler;               /* for the interrupt endpoint */
 219 #endif
 220 };
 221
 222
 223 #ifdef __cplusplus
 224 extern "C" {
 225 #endif
 226
 227 /* Global variable */
 228 extern int pwc_trace;
 229
 230 /** functions in pwc-if.c */
 231 int pwc_try_video_mode(struct pwc_device *pdev, int width, int height, int new_fps, int new_compression, int new_snapshot);
 232
 233 /** Functions in pwc-misc.c */
 234 /* sizes in pixels */
 235 extern struct pwc_coord pwc_image_sizes[PSZ_MAX];
 236
 237 int pwc_decode_size(struct pwc_device *pdev, int width, int height);
 238 void pwc_construct(struct pwc_device *pdev);
 239
 240 /** Functions in pwc-ctrl.c */
 241 /* Request a certain video mode. Returns < 0 if not possible */
 242 extern int pwc_set_video_mode(struct pwc_device *pdev, int width, int height, int frames, int compression, int snapshot);
 243
 244 /* Various controls; should be obvious. Value 0..65535, or < 0 on error */
 245 extern int pwc_get_brightness(struct pwc_device *pdev);
 246 extern int pwc_set_brightness(struct pwc_device *pdev, int value);
 247 extern int pwc_get_contrast(struct pwc_device *pdev);
 248 extern int pwc_set_contrast(struct pwc_device *pdev, int value);
 249 extern int pwc_get_gamma(struct pwc_device *pdev);
 250 extern int pwc_set_gamma(struct pwc_device *pdev, int value);
 251 extern int pwc_get_saturation(struct pwc_device *pdev);
 252 extern int pwc_set_saturation(struct pwc_device *pdev, int value);
 253 extern int pwc_set_leds(struct pwc_device *pdev, int on_value, int off_value);
 254 extern int pwc_get_cmos_sensor(struct pwc_device *pdev, int *sensor);
 255
 256 /* Power down or up the camera; not supported by all models */
 257 extern int pwc_camera_power(struct pwc_device *pdev, int power);
 258
 259 /* Private ioctl()s; see pwc-ioctl.h */
 260 extern int pwc_ioctl(struct pwc_device *pdev, unsigned int cmd, void *arg);
 261
 262
 263 /** pwc-uncompress.c */
 264 /* Expand frame to image, possibly including decompression. Uses read_frame and fill_image */
 265 extern int pwc_decompress(struct pwc_device *pdev);
 266
 267 #ifdef __cplusplus
 268 }
 269 #endif
 270
 271
 272 #endif