drivers/media/usb/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/mutex.h>
  33 #include <linux/mm.h>
  34 #include <linux/slab.h>
  35 #include <asm/errno.h>
  36 #include <linux/videodev2.h>
  37 #include <media/v4l2-common.h>
  38 #include <media/v4l2-device.h>
  39 #include <media/v4l2-ioctl.h>
  40 #include <media/v4l2-ctrls.h>
  41 #include <media/v4l2-fh.h>
  42 #include <media/v4l2-event.h>
  43 #include <media/videobuf2-v4l2.h>
  44 #include <media/videobuf2-vmalloc.h>
  45 #ifdef CONFIG_USB_PWC_INPUT_EVDEV
  46 #include <linux/input.h>
  47 #endif
  48 #include "pwc-dec1.h"
  49 #include "pwc-dec23.h"
  50
  51 /* Version block */
  52 #define PWC_VERSION     "10.0.15"
  53 #define PWC_NAME        "pwc"
  54 #define PFX             PWC_NAME ": "
  55
  56
  57 /* Trace certain actions in the driver */
  58 #define PWC_DEBUG_LEVEL_MODULE  (1<<0)
  59 #define PWC_DEBUG_LEVEL_PROBE   (1<<1)
  60 #define PWC_DEBUG_LEVEL_OPEN    (1<<2)
  61 #define PWC_DEBUG_LEVEL_READ    (1<<3)
  62 #define PWC_DEBUG_LEVEL_MEMORY  (1<<4)
  63 #define PWC_DEBUG_LEVEL_FLOW    (1<<5)
  64 #define PWC_DEBUG_LEVEL_SIZE    (1<<6)
  65 #define PWC_DEBUG_LEVEL_IOCTL   (1<<7)
  66 #define PWC_DEBUG_LEVEL_TRACE   (1<<8)
  67
  68 #define PWC_DEBUG_MODULE(fmt, args...) PWC_DEBUG(MODULE, fmt, ##args)
  69 #define PWC_DEBUG_PROBE(fmt, args...) PWC_DEBUG(PROBE, fmt, ##args)
  70 #define PWC_DEBUG_OPEN(fmt, args...) PWC_DEBUG(OPEN, fmt, ##args)
  71 #define PWC_DEBUG_READ(fmt, args...) PWC_DEBUG(READ, fmt, ##args)
  72 #define PWC_DEBUG_MEMORY(fmt, args...) PWC_DEBUG(MEMORY, fmt, ##args)
  73 #define PWC_DEBUG_FLOW(fmt, args...) PWC_DEBUG(FLOW, fmt, ##args)
  74 #define PWC_DEBUG_SIZE(fmt, args...) PWC_DEBUG(SIZE, fmt, ##args)
  75 #define PWC_DEBUG_IOCTL(fmt, args...) PWC_DEBUG(IOCTL, fmt, ##args)
  76 #define PWC_DEBUG_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args)
  77
  78
  79 #ifdef CONFIG_USB_PWC_DEBUG
  80
  81 #define PWC_DEBUG_LEVEL (PWC_DEBUG_LEVEL_MODULE)
  82
  83 #define PWC_DEBUG(level, fmt, args...) do {\
  84         if ((PWC_DEBUG_LEVEL_ ##level) & pwc_trace) \
  85                 printk(KERN_DEBUG PFX fmt, ##args); \
  86         } while (0)
  87
  88 #define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args)
  89 #define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args)
  90 #define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args)
  91 #define PWC_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args)
  92
  93 #else /* if ! CONFIG_USB_PWC_DEBUG */
  94
  95 #define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args)
  96 #define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args)
  97 #define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args)
  98 #define PWC_TRACE(fmt, args...) do { } while(0)
  99 #define PWC_DEBUG(level, fmt, args...) do { } while(0)
 100
 101 #define pwc_trace 0
 102
 103 #endif
 104
 105 /* Defines for ToUCam cameras */
 106 #define TOUCAM_HEADER_SIZE              8
 107 #define TOUCAM_TRAILER_SIZE             4
 108
 109 #define FEATURE_MOTOR_PANTILT           0x0001
 110 #define FEATURE_CODEC1                  0x0002
 111 #define FEATURE_CODEC2                  0x0004
 112
 113 #define MAX_WIDTH               640
 114 #define MAX_HEIGHT              480
 115
 116 /* Ignore errors in the first N frames, to allow for startup delays */
 117 #define FRAME_LOWMARK 5
 118
 119 /* Size and number of buffers for the ISO pipe. */
 120 #define MAX_ISO_BUFS            3
 121 #define ISO_FRAMES_PER_DESC     10
 122 #define ISO_MAX_FRAME_SIZE      960
 123 #define ISO_BUFFER_SIZE         (ISO_FRAMES_PER_DESC * ISO_MAX_FRAME_SIZE)
 124
 125 /* Maximum size after decompression is 640x480 YUV data, 1.5 * 640 * 480 */
 126 #define PWC_FRAME_SIZE          (460800 + TOUCAM_HEADER_SIZE + TOUCAM_TRAILER_SIZE)
 127
 128 /* Absolute minimum and maximum number of buffers available for mmap() */
 129 #define MIN_FRAMES              2
 130 #define MAX_FRAMES              16
 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 /* Request types: video */
 139 #define SET_LUM_CTL                     0x01
 140 #define GET_LUM_CTL                     0x02
 141 #define SET_CHROM_CTL                   0x03
 142 #define GET_CHROM_CTL                   0x04
 143 #define SET_STATUS_CTL                  0x05
 144 #define GET_STATUS_CTL                  0x06
 145 #define SET_EP_STREAM_CTL               0x07
 146 #define GET_EP_STREAM_CTL               0x08
 147 #define GET_XX_CTL                      0x09
 148 #define SET_XX_CTL                      0x0A
 149 #define GET_XY_CTL                      0x0B
 150 #define SET_XY_CTL                      0x0C
 151 #define SET_MPT_CTL                     0x0D
 152 #define GET_MPT_CTL                     0x0E
 153
 154 /* Selectors for the Luminance controls [GS]ET_LUM_CTL */
 155 #define AGC_MODE_FORMATTER                      0x2000
 156 #define PRESET_AGC_FORMATTER                    0x2100
 157 #define SHUTTER_MODE_FORMATTER                  0x2200
 158 #define PRESET_SHUTTER_FORMATTER                0x2300
 159 #define PRESET_CONTOUR_FORMATTER                0x2400
 160 #define AUTO_CONTOUR_FORMATTER                  0x2500
 161 #define BACK_LIGHT_COMPENSATION_FORMATTER       0x2600
 162 #define CONTRAST_FORMATTER                      0x2700
 163 #define DYNAMIC_NOISE_CONTROL_FORMATTER         0x2800
 164 #define FLICKERLESS_MODE_FORMATTER              0x2900
 165 #define AE_CONTROL_SPEED                        0x2A00
 166 #define BRIGHTNESS_FORMATTER                    0x2B00
 167 #define GAMMA_FORMATTER                         0x2C00
 168
 169 /* Selectors for the Chrominance controls [GS]ET_CHROM_CTL */
 170 #define WB_MODE_FORMATTER                       0x1000
 171 #define AWB_CONTROL_SPEED_FORMATTER             0x1100
 172 #define AWB_CONTROL_DELAY_FORMATTER             0x1200
 173 #define PRESET_MANUAL_RED_GAIN_FORMATTER        0x1300
 174 #define PRESET_MANUAL_BLUE_GAIN_FORMATTER       0x1400
 175 #define COLOUR_MODE_FORMATTER                   0x1500
 176 #define SATURATION_MODE_FORMATTER1              0x1600
 177 #define SATURATION_MODE_FORMATTER2              0x1700
 178
 179 /* Selectors for the Status controls [GS]ET_STATUS_CTL */
 180 #define SAVE_USER_DEFAULTS_FORMATTER            0x0200
 181 #define RESTORE_USER_DEFAULTS_FORMATTER         0x0300
 182 #define RESTORE_FACTORY_DEFAULTS_FORMATTER      0x0400
 183 #define READ_AGC_FORMATTER                      0x0500
 184 #define READ_SHUTTER_FORMATTER                  0x0600
 185 #define READ_RED_GAIN_FORMATTER                 0x0700
 186 #define READ_BLUE_GAIN_FORMATTER                0x0800
 187
 188 /* Formatters for the motorized pan & tilt [GS]ET_MPT_CTL */
 189 #define PT_RELATIVE_CONTROL_FORMATTER           0x01
 190 #define PT_RESET_CONTROL_FORMATTER              0x02
 191 #define PT_STATUS_FORMATTER                     0x03
 192
 193 /* Enumeration of image sizes */
 194 #define PSZ_SQCIF       0x00
 195 #define PSZ_QSIF        0x01
 196 #define PSZ_QCIF        0x02
 197 #define PSZ_SIF         0x03
 198 #define PSZ_CIF         0x04
 199 #define PSZ_VGA         0x05
 200 #define PSZ_MAX         6
 201
 202 struct pwc_raw_frame {
 203         __le16 type;            /* type of the webcam */
 204         __le16 vbandlength;     /* Size of 4 lines compressed (used by the
 205                                    decompressor) */
 206         __u8   cmd[4];          /* the four byte of the command (in case of
 207                                    nala, only the first 3 bytes is filled) */
 208         __u8   rawframe[0];     /* frame_size = H / 4 * vbandlength */
 209 } __packed;
 210
 211 /* intermediate buffers with raw data from the USB cam */
 212 struct pwc_frame_buf
 213 {
 214         /* common v4l buffer stuff -- must be first */
 215         struct vb2_v4l2_buffer vb;
 216         struct list_head list;
 217         void *data;
 218         int filled;             /* number of bytes filled */
 219 };
 220
 221 struct pwc_device
 222 {
 223         struct video_device vdev;
 224         struct v4l2_device v4l2_dev;
 225
 226         /* videobuf2 queue and queued buffers list */
 227         struct vb2_queue vb_queue;
 228         struct list_head queued_bufs;
 229         spinlock_t queued_bufs_lock; /* Protects queued_bufs */
 230
 231         /* If taking both locks vb_queue_lock must always be locked first! */
 232         struct mutex v4l2_lock;      /* Protects everything else */
 233         struct mutex vb_queue_lock;  /* Protects vb_queue and capt_file */
 234
 235         /* Pointer to our usb_device, will be NULL after unplug */
 236         struct usb_device *udev; /* Both mutexes most be hold when setting! */
 237
 238         /* type of cam (645, 646, 675, 680, 690, 720, 730, 740, 750) */
 239         int type;
 240         int release;            /* release number */
 241         int features;           /* feature bits */
 242
 243         /*** Video data ***/
 244         int vendpoint;          /* video isoc endpoint */
 245         int vcinterface;        /* video control interface */
 246         int valternate;         /* alternate interface needed */
 247         int vframes;            /* frames-per-second */
 248         int pixfmt;             /* pixelformat: V4L2_PIX_FMT_YUV420 or _PWCX */
 249         int vframe_count;       /* received frames */
 250         int vmax_packet_size;   /* USB maxpacket size */
 251         int vlast_packet_size;  /* for frame synchronisation */
 252         int visoc_errors;       /* number of contiguous ISOC errors */
 253         int vbandlength;        /* compressed band length; 0 is uncompressed */
 254         char vsync;             /* used by isoc handler */
 255         char vmirror;           /* for ToUCaM series */
 256         char power_save;        /* Do powersaving for this cam */
 257
 258         unsigned char cmd_buf[13];
 259         unsigned char *ctrl_buf;
 260
 261         struct urb *urbs[MAX_ISO_BUFS];
 262
 263         /*
 264          * Frame currently being filled, this only gets touched by the
 265          * isoc urb complete handler, and by stream start / stop since
 266          * start / stop touch it before / after starting / killing the urbs
 267          * no locking is needed around this
 268          */
 269         struct pwc_frame_buf *fill_buf;
 270
 271         int frame_header_size, frame_trailer_size;
 272         int frame_size;
 273         int frame_total_size;   /* including header & trailer */
 274         int drop_frames;
 275
 276         union { /* private data for decompression engine */
 277                 struct pwc_dec1_private dec1;
 278                 struct pwc_dec23_private dec23;
 279         };
 280
 281         /*
 282          * We have an 'image' and a 'view', where 'image' is the fixed-size img
 283          * as delivered by the camera, and 'view' is the size requested by the
 284          * program. The camera image is centered in this viewport, laced with
 285          * a gray or black border. view_min <= image <= view <= view_max;
 286          */
 287         int image_mask;                         /* supported sizes */
 288         int width, height;                      /* current resolution */
 289
 290 #ifdef CONFIG_USB_PWC_INPUT_EVDEV
 291         struct input_dev *button_dev;   /* webcam snapshot button input */
 292         char button_phys[64];
 293 #endif
 294
 295         /* controls */
 296         struct v4l2_ctrl_handler        ctrl_handler;
 297         u16                             saturation_fmt;
 298         struct v4l2_ctrl                *brightness;
 299         struct v4l2_ctrl                *contrast;
 300         struct v4l2_ctrl                *saturation;
 301         struct v4l2_ctrl                *gamma;
 302         struct {
 303                 /* awb / red-blue balance cluster */
 304                 struct v4l2_ctrl        *auto_white_balance;
 305                 struct v4l2_ctrl        *red_balance;
 306                 struct v4l2_ctrl        *blue_balance;
 307                 /* usb ctrl transfers are slow, so we cache things */
 308                 int                     color_bal_valid;
 309                 unsigned long           last_color_bal_update; /* In jiffies */
 310                 s32                     last_red_balance;
 311                 s32                     last_blue_balance;
 312         };
 313         struct {
 314                 /* autogain / gain cluster */
 315                 struct v4l2_ctrl        *autogain;
 316                 struct v4l2_ctrl        *gain;
 317                 int                     gain_valid;
 318                 unsigned long           last_gain_update; /* In jiffies */
 319                 s32                     last_gain;
 320         };
 321         struct {
 322                 /* exposure_auto / exposure cluster */
 323                 struct v4l2_ctrl        *exposure_auto;
 324                 struct v4l2_ctrl        *exposure;
 325                 int                     exposure_valid;
 326                 unsigned long           last_exposure_update; /* In jiffies */
 327                 s32                     last_exposure;
 328         };
 329         struct v4l2_ctrl                *colorfx;
 330         struct {
 331                 /* autocontour/contour cluster */
 332                 struct v4l2_ctrl        *autocontour;
 333                 struct v4l2_ctrl        *contour;
 334         };
 335         struct v4l2_ctrl                *backlight;
 336         struct v4l2_ctrl                *flicker;
 337         struct v4l2_ctrl                *noise_reduction;
 338         struct v4l2_ctrl                *save_user;
 339         struct v4l2_ctrl                *restore_user;
 340         struct v4l2_ctrl                *restore_factory;
 341         struct v4l2_ctrl                *awb_speed;
 342         struct v4l2_ctrl                *awb_delay;
 343         struct {
 344                 /* motor control cluster */
 345                 struct v4l2_ctrl        *motor_pan;
 346                 struct v4l2_ctrl        *motor_tilt;
 347                 struct v4l2_ctrl        *motor_pan_reset;
 348                 struct v4l2_ctrl        *motor_tilt_reset;
 349         };
 350         /* CODEC3 models have both gain and exposure controlled by autogain */
 351         struct v4l2_ctrl                *autogain_expo_cluster[3];
 352 };
 353
 354 /* Global variables */
 355 #ifdef CONFIG_USB_PWC_DEBUG
 356 extern int pwc_trace;
 357 #endif
 358
 359 /** Functions in pwc-misc.c */
 360 /* sizes in pixels */
 361 extern const int pwc_image_sizes[PSZ_MAX][2];
 362
 363 int pwc_get_size(struct pwc_device *pdev, int width, int height);
 364 void pwc_construct(struct pwc_device *pdev);
 365
 366 /** Functions in pwc-ctrl.c */
 367 /* Request a certain video mode. Returns < 0 if not possible */
 368 extern int pwc_set_video_mode(struct pwc_device *pdev, int width, int height,
 369         int pixfmt, int frames, int *compression, int send_to_cam);
 370 extern unsigned int pwc_get_fps(struct pwc_device *pdev, unsigned int index, unsigned int size);
 371 extern int pwc_set_leds(struct pwc_device *pdev, int on_value, int off_value);
 372 extern int pwc_get_cmos_sensor(struct pwc_device *pdev, int *sensor);
 373 extern int send_control_msg(struct pwc_device *pdev,
 374                             u8 request, u16 value, void *buf, int buflen);
 375
 376 /* Control get / set helpers */
 377 int pwc_get_u8_ctrl(struct pwc_device *pdev, u8 request, u16 value, int *data);
 378 int pwc_set_u8_ctrl(struct pwc_device *pdev, u8 request, u16 value, u8 data);
 379 int pwc_get_s8_ctrl(struct pwc_device *pdev, u8 request, u16 value, int *data);
 380 #define pwc_set_s8_ctrl pwc_set_u8_ctrl
 381 int pwc_get_u16_ctrl(struct pwc_device *pdev, u8 request, u16 value, int *dat);
 382 int pwc_set_u16_ctrl(struct pwc_device *pdev, u8 request, u16 value, u16 data);
 383 int pwc_button_ctrl(struct pwc_device *pdev, u16 value);
 384 int pwc_init_controls(struct pwc_device *pdev);
 385
 386 /* Power down or up the camera; not supported by all models */
 387 extern void pwc_camera_power(struct pwc_device *pdev, int power);
 388
 389 extern const struct v4l2_ioctl_ops pwc_ioctl_ops;
 390
 391 /** pwc-uncompress.c */
 392 /* Expand frame to image, possibly including decompression. Uses read_frame and fill_image */
 393 int pwc_decompress(struct pwc_device *pdev, struct pwc_frame_buf *fbuf);
 394
 395 #endif