microdia.h

   1 /**
   2  * @file microdia.h
   3  * @author Nicolas VIVIEN
   4  * @date 2008-02-01
   5  * @version v0.0.0
   6  *
   7  * @brief Driver for Microdia USB video camera
   8  *
   9  * @note Copyright (C) Nicolas VIVIEN
  10  *
  11  * @par Licences
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or
  16  * any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with this program; if not, write to the Free Software
  25  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  26  */
  27
  28 #include <linux/kernel.h>
  29 #include <linux/version.h>
  30 #include <linux/usb.h>
  31 #include <media/v4l2-common.h>
  32
  33 #ifndef MICRODIA_H
  34 #define MICRODIA_H
  35
  36
  37 #define DRIVER_NAME                     "microdia"                      /**< Name of this driver */
  38 #define DRIVER_VERSION                  "v0.0.0"                        /**< Version of this driver */
  39 #define DRIVER_VERSION_NUM              0x000000                        /**< Version numerical of this driver */
  40 #define DRIVER_DESC                     "Microdia USB Video Camera"     /**< Short description of this driver */
  41 #define DRIVER_AUTHOR                   "Nicolas VIVIEN"                /**< Author of this driver */
  42 #define PREFIX                          DRIVER_NAME ": "                /**< Prefix use for the MICRODIA "printk" */
  43
  44 #define USB_0C45_VID                    0x0c45  /**< Vendor ID of MICRODIA */
  45 #define USB_045E_VID                    0x045e  /**< Vendor ID of MICROSOFT */
  46 #define USB_04F2_VID                    0x04f2  /**< Vendor ID of CHICONY */
  47 #define USB_145F_VID                    0x145f  /**< Vendor ID of TRUST */
  48
  49 // SN9C201:
  50 #define USB_6240_PID    0x6240                  /**< SN9C201 + MI1300 */
  51 #define USB_6242_PID    0x6242                  /**< SN9C201 + MI1310 */
  52 #define USB_6243_PID    0x6243                  /**< SN9C201 + S5K4AAFX */
  53 #define USB_6248_PID    0x6248                  /**< SN9C201 + OV9655 */
  54 #define USB_624B_PID    0x624b                  /**< SN9C201 + CX1332 */
  55 #define USB_624C_PID    0x624c                  /**< SN9C201 + MI1320 */
  56 #define USB_624E_PID    0x624e                  /**< SN9C201 + SOI968 */
  57 #define USB_624F_PID    0x624f                  /**< SN9C201 + OV9650 */
  58 #define USB_6253_PID    0x6253                  /**< SN9C201 + OV9650 */
  59 #define USB_6260_PID    0x6260                  /**< SN9C201 + OV7670ISP */
  60 #define USB_6262_PID    0x6262                  /**< SN9C201 + OM6802 */
  61 #define USB_6270_PID    0x6270                  /**< SN9C201 + MI0360/MT9V111 */
  62 #define USB_627A_PID    0x627a                  /**< SN9C201 + S5K53BEB */
  63 #define USB_627B_PID    0x627b                  /**< SN9C201 + OV7660 */
  64 #define USB_627C_PID    0x627c                  /**< SN9C201 + HV7131R */
  65 #define USB_627F_PID    0x627f                  /**< EEPROM */
  66 // SN9C202:
  67 #define USB_6280_PID    0x6280                  /**< SN9C202 + MI1300 */
  68 #define USB_6282_PID    0x6282                  /**< SN9C202 + MI1310 */
  69 #define USB_6283_PID    0x6283                  /**< SN9C202 + S5K4AAFX */
  70 #define USB_6288_PID    0x6288                  /**< SN9C202 + OV9655 */
  71 #define USB_628A_PID    0x628a                  /**< SN9C202 + ICM107 */
  72 #define USB_628B_PID    0x628b                  /**< SN9C202 + CX1332 */
  73 #define USB_628C_PID    0x628c                  /**< SN9C202 + MI1320 */
  74 #define USB_628E_PID    0x628e                  /**< SN9C202 + SOI968 */
  75 #define USB_628F_PID    0x628f                  /**< SN9C202 + OV9650 */
  76 #define USB_62A0_PID    0x62a0                  /**< SN9C202 + OV7670ISP */
  77 #define USB_62A2_PID    0x62a2                  /**< SN9C202 + OM6802 */
  78 #define USB_62B0_PID    0x62b0                  /**< SN9C202 + MI0360/MT9V111 */
  79 #define USB_62B3_PID    0x62b3                  /**< SN9C202 + OV9655 */
  80 #define USB_62BA_PID    0x62ba                  /**< SN9C202 + S5K53BEB */
  81 #define USB_62BB_PID    0x62bb                  /**< SN9C202 + OV7660 */
  82 #define USB_62BC_PID    0x62bc                  /**< SN9C202 + HV7131R */
  83 #define USB_62BE_PID    0x62be                  /**< SN9C202 + OV7663 */
  84 // SN9C325:
  85 #define USB_6128_PID    0x6128                  /**< SN9C325 + OM6802 */
  86 #define USB_612A_PID    0x612a                  /**< SN9C325 + OV7648 + POx1030xC + SOI768 + PO2030N + OV7660 + OV7670 + HV7131R */
  87 // *** "Clone"-devices ***:
  88 // Microsoft LifeCam VX-6000:
  89 #define USB_00F4_PID    0x00f4          /**< => 628f (SN9C202 + OV9650) */
  90 // Trust WB-3600R:
  91 #define USB_013D_PID    0x013d          /**< => 627b (SN9C201 + OV7660) */
  92 // Chicony Panda 7, Trust WB-3450P:
  93 #define USB_A128_PID    0xa128          /**< => 62be (SN9C202 + OV7663) */
  94
  95 #define CAMERA_MODEL(vid, pid) ((vid << 16) | pid)
  96 #define CAMERA_VID(model) ((model >> 16) & 0xFFFF)
  97 #define CAMERA_PID(model) (model & 0xFFFF)
  98
  99 /**
 100  * @def VID_HARDWARE_MICRODIA
 101  *
 102  * This value must be inserted into the kernel headers linux/videodev.h
 103  * It's useful only for the support of V4L v1
 104  */
 105 #define VID_HARDWARE_MICRODIA           88
 106
 107
 108
 109
 110 /**
 111  * @def MAX_ISO_BUFS
 112  *   Number maximal of ISOC buffers
 113  *
 114  * @def ISO_FRAMES_PER_DESC
 115  *   Number frames per ISOC descriptor
 116  */
 117 #define MAX_ISO_BUFS                            200
 118 #define ISO_FRAMES_PER_DESC                     10
 119
 120 /**
 121  * @def hb_multiplier(wMaxPacketSize)
 122  *   USB endpoint high bandwidth multiplier
 123  *
 124  * @def max_packet_sz(wMaxPacketSize)
 125  *   USB endpoint maximum packet size
 126  *
 127  * These values are both encoded within the wMaxPacketSize field of the usb_endpoint_descriptor structure.
 128  * The 11(10:0) lowest bits hold the MaxPacketSize(according to the usb specs a value over 1024 is undefined),
 129  * and the bits 12:11 will give the high bandwidth multiplier(this should be a value of 0-2).
 130  */
 131
 132 #define hb_multiplier(wMaxPacketSize) (((wMaxPacketSize >> 11) & 0x03) + 1)
 133 #define max_packet_sz(wMaxPacketSize) ((wMaxPacketSize) & 0x07ff)
 134
 135 /**
 136  * @def MICRODIA_FRAME_SIZE
 137  *   Maximum size after decompression
 138  */
 139 #define MICRODIA_FRAME_SIZE     (1280 * 1024 * 3)
 140
 141 /**
 142  * @def MICRODIA_FRAME_SIZE_DIVISOR_DEFAULT
 143  *      Most models have a Frame size of image_size + image_size/2
 144  *
 145  * @def MICRODIA_FRAME_SIZE_DIVISOR_6260
 146  *      The 6260 has a Frame size of image_size + image_size
 147  */
 148 #define MICRODIA_FRAME_SIZE_DIVISOR_DEFAULT     2
 149 #define MICRODIA_FRAME_SIZE_DIVISOR_6260        1
 150
 151 /**
 152  * @def DRIVER_SUPPORT
 153  *
 154  * List of supported devices
 155  */
 156 #define DRIVER_SUPPORT                          "Microdia USB Camera"
 157
 158
 159 #define MICRODIA_INFO           (1 << 0)
 160 #define MICRODIA_WARNING        (1 << 1)
 161 #define MICRODIA_ERROR          (1 << 2)
 162 #define MICRODIA_DEBUG          (1 << 3)
 163 #define MICRODIA_STREAM         (1 << 4)
 164
 165 /**
 166  * @def UDIA_INFO(str, args...)
 167  *   Print information message.
 168  *   @a Use this function like the function printf.
 169  *
 170  * @def UDIA_ERROR(str, args...)
 171  *   Print error message.
 172  *   @a Use this function like the function printf.
 173  *
 174  * @def UDIA_WARNING(str, args...)
 175  *   Print warning message.
 176  *   @a Use this function like the function printf.
 177  *
 178  * @def UDIA_DEBUG(str, args...)
 179  *   Print debug message.
 180  *   @a Use this function like the function printf.
 181  *
 182  * @def UDIA_STREAM(str, args...)
 183  *   Print stream debug message.
 184  *   @a Use this function like the function printf.
 185  */
 186 extern __u8 log_level;
 187
 188 #define UDIA_INFO(str, args...) \
 189 do { \
 190         if (log_level & MICRODIA_INFO) \
 191                 printk(KERN_INFO PREFIX str, ##args); \
 192 } while (0)
 193
 194 #define UDIA_WARNING(str, args...) \
 195 do { \
 196         if (log_level & MICRODIA_WARNING) \
 197                 printk(KERN_WARNING PREFIX str, ##args); \
 198 } while (0)
 199
 200 #define UDIA_ERROR(str, args...) \
 201 do { \
 202         if (log_level & MICRODIA_ERROR) \
 203                 printk(KERN_ERR PREFIX str, ##args); \
 204 } while (0)
 205
 206 #define UDIA_DEBUG(str, args...) \
 207 do { \
 208         if (log_level & MICRODIA_DEBUG) \
 209                 printk(KERN_DEBUG PREFIX str, ##args); \
 210 } while (0)
 211
 212 #define UDIA_STREAM(str, args...) \
 213 do { \
 214         if (log_level & MICRODIA_STREAM) \
 215                 printk(KERN_DEBUG PREFIX str, ##args); \
 216 } while (0)
 217
 218 /**
 219  * @enum T_MICRODIA_VIDEOMODE Video feature supported by camera
 220  */
 221 typedef enum {
 222         MICRODIA_VGA,                                           /**< For VGA video camera */
 223         MICRODIA_SXGA,                                          /**< For SXGA video camera 1.3M */
 224         MICRODIA_UXGA                                           /**< For UXGA video camera 2M */
 225 } T_MICRODIA_VIDEOMODE;
 226
 227
 228 /**
 229  * @enum T_MICRODIA_RESOLUTION Video resolution
 230  */
 231 typedef enum {
 232         MICRODIA_80x60,
 233         /*MICRODIA_128x96,*/
 234         MICRODIA_160x120,
 235         /*MICRODIA_213x160, */
 236         MICRODIA_320x240,
 237         MICRODIA_640x480,
 238         MICRODIA_800x600,
 239         MICRODIA_1024x768,
 240         MICRODIA_1280x1024,
 241         MICRODIA_NBR_SIZES
 242 } T_MICRODIA_RESOLUTION;
 243
 244 enum microdia_buffer_state {
 245         MICRODIA_BUF_STATE_IDLE       = 0,
 246         MICRODIA_BUF_STATE_QUEUED     = 1,
 247         MICRODIA_BUF_STATE_ACTIVE     = 2,
 248         MICRODIA_BUF_STATE_DONE       = 3,
 249         MICRODIA_BUF_STATE_ERROR      = 4,
 250 };
 251
 252 enum microdia_mode {
 253         MICRODIA_MODE_IDLE       = 0,
 254         MICRODIA_MODE_READ       = 1,
 255         MICRODIA_MODE_STREAM     = 2,
 256 };
 257
 258 struct microdia_buffer {
 259         unsigned long vma_use_count;
 260         struct list_head stream;
 261
 262         /* Touched by interrupt handler. */
 263         struct v4l2_buffer buf;
 264         struct list_head queue;
 265         wait_queue_head_t wait;
 266         enum microdia_buffer_state state;
 267 };
 268
 269 struct microdia_video_queue {
 270         void *mem;
 271         void *scratch;
 272         unsigned int streaming : 1,
 273                      frozen : 1,
 274                      drop_incomplete : 1;
 275         __u32 sequence;
 276
 277         unsigned int count;
 278         unsigned int min_buffers;
 279         unsigned int max_buffers;
 280         unsigned int buf_size;
 281         unsigned int frame_size; /*current frame size */
 282         struct microdia_buffer *buffer;
 283         struct microdia_buffer *read_buffer;
 284         struct mutex mutex;     /* protects buffers and mainqueue */
 285         spinlock_t irqlock;     /* protects irqqueue */
 286
 287         struct list_head mainqueue;
 288         struct list_head irqqueue;
 289 };
 290
 291
 292 /**
 293  * @struct microdia_iso_buf
 294  */
 295 struct microdia_iso_buf {
 296         void *data;
 297         struct urb *urb;
 298 };
 299
 300 /**
 301  * @struct microdia_coord
 302  */
 303 struct microdia_coord {
 304         int x;                                                          /**< X-coordonate */
 305         int y;                                                          /**< Y-coordonate */
 306 };
 307
 308 /**
 309  * @struct microdia_video
 310  */
 311 struct microdia_video {
 312         struct v4l2_pix_format format;
 313         int fps;                                /**< FPS setting */
 314         int brightness;                         /**< Brightness setting */
 315         int contrast;                           /**< Contrast setting */
 316         int whiteness;                          /**< Whiteness setting */
 317         int colour;                             /**< Colour setting */
 318         int hue;                                /**< Hue setting */
 319         int hflip;                              /**< Horizontal flip */
 320         int vflip;                              /**< Vertical flip */
 321         int exposure;                           /**< Exposure */
 322         int sharpness;                          /**< Sharpness */
 323         __u8 rgb_gain[4];                       /**< RGB Gain (RGGB) */
 324         int auto_exposure;                      /**< Automatic exposure */
 325         int auto_whitebalance;                  /**< Automatic whitebalance */
 326 };
 327
 328 /**
 329  * @struct microdia_debugfs
 330  */
 331 struct microdia_debugfs {
 332         struct dentry *dent_device;
 333         struct dentry *dent_bridge_addr;
 334         struct dentry *dent_bridge_val;
 335         struct dentry *dent_bridge_dump;
 336         struct dentry *dent_sensor_addr;
 337         struct dentry *dent_sensor_val8;
 338         struct dentry *dent_sensor_val16;
 339         struct dentry *dent_sensor_val32;
 340
 341         __u16 bridge_addr; /**< Current bridge register address */
 342         __u8 sensor_addr; /**< Current sensor register address */
 343 };
 344
 345 /**
 346  * @struct usb_microdia
 347  */
 348 struct usb_microdia {
 349         struct video_device *vdev;                      /**< Pointer on a V4L2 video device */
 350         struct usb_device *udev;                        /**< Pointer on a USB device */
 351         struct usb_interface *interface;        /**< Pointer on a USB interface */
 352
 353         int release;                                            /**< Release of the device (bcdDevice) */
 354         __u32 webcam_model;                                     /**< Model of video camera device */
 355         __u8 webcam_type;                                       /**< Type of camera : VGA, SXGA (1.3M), UXGA (2M) */
 356
 357         int frame_size_divisor;                 /**> Used to calculate frame_size        */
 358
 359         __u8 sensor_slave_address;              /**< I2C/SCCB slave address of the image sensor */
 360         __u8 sensor_flags;                      /**< I2C/SCCB flags of the image sensor */
 361
 362         unsigned char *int_in_buffer;           /**< Interrupt IN buffer */
 363         size_t int_in_size;                                     /**< Interrupt IN buffer size */
 364         __u8 int_in_endpointAddr;                       /**< Interrupt IN endpoint address */
 365
 366         size_t isoc_in_size;                            /**< Isochrone IN size */
 367         __u8 isoc_in_endpointAddr;                      /**< Isochrone IN endpoint address */
 368
 369         struct microdia_video vsettings;                /**< Video settings (brightness, whiteness...) */
 370         struct microdia_debugfs debug; /**< debugfs information structure */
 371
 372         struct kref vopen;      /**< Video status (Opened or Closed) */
 373         struct file *owner;     /**< file handler of stream owner */
 374         enum microdia_mode mode;/**< camera mode */
 375
 376         int vframes_overflow;   /**< Buffer overflow frames */
 377         int vframes_incomplete; /**< Incomplete frames */
 378         int vframes_dropped;    /**< Dropped frames */
 379
 380         struct mutex mutex;                             /**< Mutex */
 381
 382         struct microdia_iso_buf isobuf[MAX_ISO_BUFS];
 383
 384         int resolution;
 385         struct microdia_coord view;
 386         struct microdia_coord image;
 387
 388         struct microdia_video_queue queue;
 389
 390         __u8 supported_fmts;
 391
 392         int (* initialize) (struct usb_microdia *dev);
 393         int (*sensor_init) (struct usb_microdia *dev);
 394         int (* start_stream) (struct usb_microdia *dev);
 395         int (* stop_stream) (struct usb_microdia *dev);
 396         int (* set_contrast) (struct usb_microdia *dev);
 397         int (* set_brightness) (struct usb_microdia *dev);
 398         int (* set_gamma) (struct usb_microdia *dev);
 399         int (* set_exposure) (struct usb_microdia *dev);
 400         int (* flip_detect) (struct usb_microdia *dev);
 401         int (* set_hvflip) (struct usb_microdia *dev);
 402         int (* set_sharpness) (struct usb_microdia *dev);
 403         int (*set_rgb_gain) (struct usb_microdia *dev);
 404         int (* set_auto_exposure) (struct usb_microdia *dev);
 405         int (* set_auto_whitebalance) (struct usb_microdia *dev);
 406 };
 407
 408 struct microdia_camera {
 409
 410         __u32 model;    /**< Model of video camera device */
 411         __u8  type;     /**< Type of camera : VGA, SXGA, UXGA */
 412         __u8  supported_fmts;
 413         __u8 sensor_slave_address;
 414         __u8 sensor_flags;
 415
 416         int (*initialize) (struct usb_microdia *dev);
 417         int (*sensor_init) (struct usb_microdia *dev);
 418         int (*start_stream) (struct usb_microdia *dev);
 419         int (*stop_stream) (struct usb_microdia *dev);
 420         int (*set_contrast) (struct usb_microdia *dev);
 421         int (*set_brightness) (struct usb_microdia *dev);
 422         int (*set_gamma) (struct usb_microdia *dev);
 423         int (*set_exposure) (struct usb_microdia *dev);
 424         int (*flip_detect) (struct usb_microdia *dev);
 425         int (*set_hvflip) (struct usb_microdia *dev);
 426         int (*set_sharpness) (struct usb_microdia *dev);
 427         int (*set_rgb_gain) (struct usb_microdia *dev);
 428         int (*set_auto_exposure) (struct usb_microdia *dev);
 429         int (*set_auto_whitebalance) (struct usb_microdia *dev);
 430 };
 431
 432 /**
 433  * @def MICRODIA_PERCENT
 434  *   Calculate a value from a percent
 435  */
 436 #define MICRODIA_PERCENT(x,y) ( ((int)x * (int)y) / 100)
 437
 438
 439 /**
 440  * @def to_microdia_dev(d)
 441  * Cast a member of a structure out to the containing structure
 442  */
 443 #define to_microdia_dev(d) container_of(d, struct usb_microdia, kref)
 444
 445
 446 extern const struct microdia_coord microdia_image_sizes[MICRODIA_NBR_SIZES];
 447 extern struct mutex open_lock;
 448
 449 int usb_microdia_control_write(struct usb_microdia *, __u16, __u8 *, __u16);
 450 int usb_microdia_control_write_multi(struct usb_microdia *, __u16*, __u8 *,
 451         __u16, __u16);
 452 int usb_microdia_control_read(struct usb_microdia *, __u16, __u8 *, __u16);
 453 int usb_microdia_set_feature(struct usb_microdia *, int);
 454
 455 int usb_microdia_set_configuration(struct usb_microdia *);
 456 int usb_microdia_isoc_init(struct usb_microdia *);
 457 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,19)
 458 void usb_microdia_isoc_handler(struct urb *, struct pt_regs *);
 459 #else
 460 void usb_microdia_isoc_handler(struct urb *);
 461 #endif
 462 void usb_microdia_isoc_cleanup(struct usb_microdia *);
 463 void usb_microdia_delete(struct kref *);
 464
 465
 466 int dev_microdia_initialize_device(struct usb_microdia *);
 467 int dev_microdia_start_stream(struct usb_microdia *);
 468 int dev_microdia_stop_stream(struct usb_microdia *);
 469 int dev_microdia_check_device(struct usb_microdia *, int);
 470 int dev_microdia_camera_on(struct usb_microdia *);
 471 int dev_microdia_camera_off(struct usb_microdia *);
 472 int dev_microdia_camera_asleep(struct usb_microdia *);
 473 int dev_microdia_init_camera(struct usb_microdia *);
 474 int dev_microdia_reconf_camera(struct usb_microdia *);
 475 int dev_microdia_camera_settings(struct usb_microdia *);
 476 int dev_microdia_camera_set_contrast(struct usb_microdia *);
 477 int dev_microdia_camera_set_brightness(struct usb_microdia *);
 478 int dev_microdia_camera_set_gamma(struct usb_microdia *);
 479 int dev_microdia_camera_set_exposure(struct usb_microdia *);
 480 int dev_microdia_camera_set_hvflip(struct usb_microdia *);
 481 int dev_microdia_camera_set_sharpness(struct usb_microdia *dev);
 482 int dev_microdia_camera_set_rgb_gain(struct usb_microdia *dev);
 483 int dev_microdia_camera_set_auto_exposure(struct usb_microdia *dev);
 484 int dev_microdia_camera_set_auto_whitebalance(struct usb_microdia *dev);
 485 //int dev_microdia_set_camera_quality(struct usb_microdia *);
 486 int dev_microdia_set_camera_fps(struct usb_microdia *);
 487
 488 struct v4l2_pix_format *v4l2_enum_supported_formats(struct usb_microdia *,
 489         __u8);
 490 int v4l_microdia_select_video_mode(struct usb_microdia *, int);
 491 int v4l_microdia_register_video_device(struct usb_microdia *);
 492 int v4l_microdia_unregister_video_device(struct usb_microdia *);
 493
 494 int microdia_create_sysfs_files(struct video_device *);
 495 void microdia_remove_sysfs_files(struct video_device *);
 496
 497 void microdia_init_debugfs(void);
 498 void microdia_uninit_debugfs(void);
 499 int microdia_create_debugfs_files(struct usb_microdia *);
 500 int microdia_remove_debugfs_files(struct usb_microdia *);
 501
 502 void microdia_queue_init(struct microdia_video_queue *);
 503 int microdia_alloc_buffers(struct microdia_video_queue *,
 504         unsigned int, unsigned int);
 505 int microdia_free_buffers(struct microdia_video_queue *);
 506 int microdia_queue_enable(struct microdia_video_queue *, int);
 507 void microdia_queue_cancel(struct microdia_video_queue *);
 508 unsigned int microdia_queue_poll(struct microdia_video_queue *,
 509         struct file *, poll_table *);
 510 int microdia_query_buffer(struct microdia_video_queue *, struct v4l2_buffer *);
 511 int microdia_queue_buffer(struct microdia_video_queue *, struct v4l2_buffer *);
 512 int microdia_dequeue_buffer(struct microdia_video_queue *,
 513         struct v4l2_buffer *, int);
 514 struct microdia_buffer *microdia_queue_next_buffer(
 515         struct microdia_video_queue *, struct microdia_buffer *);
 516
 517 int microdia_decompress(struct usb_microdia *, struct v4l2_buffer *);
 518 #endif