drivers/media/usb/pwc/pwc.h

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