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