drivers/usb/media/pwc.h

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