drivers/media/video/uvc/uvcvideo.h

   1 #ifndef _USB_VIDEO_H_
   2 #define _USB_VIDEO_H_
   3
   4 #include <linux/kernel.h>
   5 #include <linux/videodev2.h>
   6
   7
   8 /*
   9  * Dynamic controls
  10  */
  11
  12 /* Data types for UVC control data */
  13 #define UVC_CTRL_DATA_TYPE_RAW          0
  14 #define UVC_CTRL_DATA_TYPE_SIGNED       1
  15 #define UVC_CTRL_DATA_TYPE_UNSIGNED     2
  16 #define UVC_CTRL_DATA_TYPE_BOOLEAN      3
  17 #define UVC_CTRL_DATA_TYPE_ENUM         4
  18 #define UVC_CTRL_DATA_TYPE_BITMASK      5
  19
  20 /* Control flags */
  21 #define UVC_CONTROL_SET_CUR     (1 << 0)
  22 #define UVC_CONTROL_GET_CUR     (1 << 1)
  23 #define UVC_CONTROL_GET_MIN     (1 << 2)
  24 #define UVC_CONTROL_GET_MAX     (1 << 3)
  25 #define UVC_CONTROL_GET_RES     (1 << 4)
  26 #define UVC_CONTROL_GET_DEF     (1 << 5)
  27 /* Control should be saved at suspend and restored at resume. */
  28 #define UVC_CONTROL_RESTORE     (1 << 6)
  29 /* Control can be updated by the camera. */
  30 #define UVC_CONTROL_AUTO_UPDATE (1 << 7)
  31
  32 #define UVC_CONTROL_GET_RANGE   (UVC_CONTROL_GET_CUR | UVC_CONTROL_GET_MIN | \
  33                                  UVC_CONTROL_GET_MAX | UVC_CONTROL_GET_RES | \
  34                                  UVC_CONTROL_GET_DEF)
  35
  36 struct uvc_xu_control_info {
  37         __u8 entity[16];
  38         __u8 index;
  39         __u8 selector;
  40         __u16 size;
  41         __u32 flags;
  42 };
  43
  44 struct uvc_xu_control_mapping {
  45         __u32 id;
  46         __u8 name[32];
  47         __u8 entity[16];
  48         __u8 selector;
  49
  50         __u8 size;
  51         __u8 offset;
  52         enum v4l2_ctrl_type v4l2_type;
  53         __u32 data_type;
  54 };
  55
  56 struct uvc_xu_control {
  57         __u8 unit;
  58         __u8 selector;
  59         __u16 size;
  60         __u8 __user *data;
  61 };
  62
  63 #define UVCIOC_CTRL_ADD         _IOW('U', 1, struct uvc_xu_control_info)
  64 #define UVCIOC_CTRL_MAP         _IOWR('U', 2, struct uvc_xu_control_mapping)
  65 #define UVCIOC_CTRL_GET         _IOWR('U', 3, struct uvc_xu_control)
  66 #define UVCIOC_CTRL_SET         _IOW('U', 4, struct uvc_xu_control)
  67
  68 #ifdef __KERNEL__
  69
  70 #include <linux/poll.h>
  71
  72 /* --------------------------------------------------------------------------
  73  * UVC constants
  74  */
  75
  76 #define SC_UNDEFINED                    0x00
  77 #define SC_VIDEOCONTROL                 0x01
  78 #define SC_VIDEOSTREAMING               0x02
  79 #define SC_VIDEO_INTERFACE_COLLECTION   0x03
  80
  81 #define PC_PROTOCOL_UNDEFINED           0x00
  82
  83 #define CS_UNDEFINED                    0x20
  84 #define CS_DEVICE                       0x21
  85 #define CS_CONFIGURATION                0x22
  86 #define CS_STRING                       0x23
  87 #define CS_INTERFACE                    0x24
  88 #define CS_ENDPOINT                     0x25
  89
  90 /* VideoControl class specific interface descriptor */
  91 #define VC_DESCRIPTOR_UNDEFINED         0x00
  92 #define VC_HEADER                       0x01
  93 #define VC_INPUT_TERMINAL               0x02
  94 #define VC_OUTPUT_TERMINAL              0x03
  95 #define VC_SELECTOR_UNIT                0x04
  96 #define VC_PROCESSING_UNIT              0x05
  97 #define VC_EXTENSION_UNIT               0x06
  98
  99 /* VideoStreaming class specific interface descriptor */
 100 #define VS_UNDEFINED                    0x00
 101 #define VS_INPUT_HEADER                 0x01
 102 #define VS_OUTPUT_HEADER                0x02
 103 #define VS_STILL_IMAGE_FRAME            0x03
 104 #define VS_FORMAT_UNCOMPRESSED          0x04
 105 #define VS_FRAME_UNCOMPRESSED           0x05
 106 #define VS_FORMAT_MJPEG                 0x06
 107 #define VS_FRAME_MJPEG                  0x07
 108 #define VS_FORMAT_MPEG2TS               0x0a
 109 #define VS_FORMAT_DV                    0x0c
 110 #define VS_COLORFORMAT                  0x0d
 111 #define VS_FORMAT_FRAME_BASED           0x10
 112 #define VS_FRAME_FRAME_BASED            0x11
 113 #define VS_FORMAT_STREAM_BASED          0x12
 114
 115 /* Endpoint type */
 116 #define EP_UNDEFINED                    0x00
 117 #define EP_GENERAL                      0x01
 118 #define EP_ENDPOINT                     0x02
 119 #define EP_INTERRUPT                    0x03
 120
 121 /* Request codes */
 122 #define RC_UNDEFINED                    0x00
 123 #define SET_CUR                         0x01
 124 #define GET_CUR                         0x81
 125 #define GET_MIN                         0x82
 126 #define GET_MAX                         0x83
 127 #define GET_RES                         0x84
 128 #define GET_LEN                         0x85
 129 #define GET_INFO                        0x86
 130 #define GET_DEF                         0x87
 131
 132 /* VideoControl interface controls */
 133 #define VC_CONTROL_UNDEFINED            0x00
 134 #define VC_VIDEO_POWER_MODE_CONTROL     0x01
 135 #define VC_REQUEST_ERROR_CODE_CONTROL   0x02
 136
 137 /* Terminal controls */
 138 #define TE_CONTROL_UNDEFINED            0x00
 139
 140 /* Selector Unit controls */
 141 #define SU_CONTROL_UNDEFINED            0x00
 142 #define SU_INPUT_SELECT_CONTROL         0x01
 143
 144 /* Camera Terminal controls */
 145 #define CT_CONTROL_UNDEFINED                            0x00
 146 #define CT_SCANNING_MODE_CONTROL                        0x01
 147 #define CT_AE_MODE_CONTROL                              0x02
 148 #define CT_AE_PRIORITY_CONTROL                          0x03
 149 #define CT_EXPOSURE_TIME_ABSOLUTE_CONTROL               0x04
 150 #define CT_EXPOSURE_TIME_RELATIVE_CONTROL               0x05
 151 #define CT_FOCUS_ABSOLUTE_CONTROL                       0x06
 152 #define CT_FOCUS_RELATIVE_CONTROL                       0x07
 153 #define CT_FOCUS_AUTO_CONTROL                           0x08
 154 #define CT_IRIS_ABSOLUTE_CONTROL                        0x09
 155 #define CT_IRIS_RELATIVE_CONTROL                        0x0a
 156 #define CT_ZOOM_ABSOLUTE_CONTROL                        0x0b
 157 #define CT_ZOOM_RELATIVE_CONTROL                        0x0c
 158 #define CT_PANTILT_ABSOLUTE_CONTROL                     0x0d
 159 #define CT_PANTILT_RELATIVE_CONTROL                     0x0e
 160 #define CT_ROLL_ABSOLUTE_CONTROL                        0x0f
 161 #define CT_ROLL_RELATIVE_CONTROL                        0x10
 162 #define CT_PRIVACY_CONTROL                              0x11
 163
 164 /* Processing Unit controls */
 165 #define PU_CONTROL_UNDEFINED                            0x00
 166 #define PU_BACKLIGHT_COMPENSATION_CONTROL               0x01
 167 #define PU_BRIGHTNESS_CONTROL                           0x02
 168 #define PU_CONTRAST_CONTROL                             0x03
 169 #define PU_GAIN_CONTROL                                 0x04
 170 #define PU_POWER_LINE_FREQUENCY_CONTROL                 0x05
 171 #define PU_HUE_CONTROL                                  0x06
 172 #define PU_SATURATION_CONTROL                           0x07
 173 #define PU_SHARPNESS_CONTROL                            0x08
 174 #define PU_GAMMA_CONTROL                                0x09
 175 #define PU_WHITE_BALANCE_TEMPERATURE_CONTROL            0x0a
 176 #define PU_WHITE_BALANCE_TEMPERATURE_AUTO_CONTROL       0x0b
 177 #define PU_WHITE_BALANCE_COMPONENT_CONTROL              0x0c
 178 #define PU_WHITE_BALANCE_COMPONENT_AUTO_CONTROL         0x0d
 179 #define PU_DIGITAL_MULTIPLIER_CONTROL                   0x0e
 180 #define PU_DIGITAL_MULTIPLIER_LIMIT_CONTROL             0x0f
 181 #define PU_HUE_AUTO_CONTROL                             0x10
 182 #define PU_ANALOG_VIDEO_STANDARD_CONTROL                0x11
 183 #define PU_ANALOG_LOCK_STATUS_CONTROL                   0x12
 184
 185 #define LXU_MOTOR_PANTILT_RELATIVE_CONTROL              0x01
 186 #define LXU_MOTOR_PANTILT_RESET_CONTROL                 0x02
 187 #define LXU_MOTOR_FOCUS_MOTOR_CONTROL                   0x03
 188
 189 /* VideoStreaming interface controls */
 190 #define VS_CONTROL_UNDEFINED            0x00
 191 #define VS_PROBE_CONTROL                0x01
 192 #define VS_COMMIT_CONTROL               0x02
 193 #define VS_STILL_PROBE_CONTROL          0x03
 194 #define VS_STILL_COMMIT_CONTROL         0x04
 195 #define VS_STILL_IMAGE_TRIGGER_CONTROL  0x05
 196 #define VS_STREAM_ERROR_CODE_CONTROL    0x06
 197 #define VS_GENERATE_KEY_FRAME_CONTROL   0x07
 198 #define VS_UPDATE_FRAME_SEGMENT_CONTROL 0x08
 199 #define VS_SYNC_DELAY_CONTROL           0x09
 200
 201 #define TT_VENDOR_SPECIFIC              0x0100
 202 #define TT_STREAMING                    0x0101
 203
 204 /* Input Terminal types */
 205 #define ITT_VENDOR_SPECIFIC             0x0200
 206 #define ITT_CAMERA                      0x0201
 207 #define ITT_MEDIA_TRANSPORT_INPUT       0x0202
 208
 209 /* Output Terminal types */
 210 #define OTT_VENDOR_SPECIFIC             0x0300
 211 #define OTT_DISPLAY                     0x0301
 212 #define OTT_MEDIA_TRANSPORT_OUTPUT      0x0302
 213
 214 /* External Terminal types */
 215 #define EXTERNAL_VENDOR_SPECIFIC        0x0400
 216 #define COMPOSITE_CONNECTOR             0x0401
 217 #define SVIDEO_CONNECTOR                0x0402
 218 #define COMPONENT_CONNECTOR             0x0403
 219
 220 #define UVC_TERM_INPUT                  0x0000
 221 #define UVC_TERM_OUTPUT                 0x8000
 222
 223 #define UVC_ENTITY_TYPE(entity)         ((entity)->type & 0x7fff)
 224 #define UVC_ENTITY_IS_UNIT(entity)      (((entity)->type & 0xff00) == 0)
 225 #define UVC_ENTITY_IS_TERM(entity)      (((entity)->type & 0xff00) != 0)
 226 #define UVC_ENTITY_IS_ITERM(entity) \
 227         (((entity)->type & 0x8000) == UVC_TERM_INPUT)
 228 #define UVC_ENTITY_IS_OTERM(entity) \
 229         (((entity)->type & 0x8000) == UVC_TERM_OUTPUT)
 230
 231 #define UVC_STATUS_TYPE_CONTROL         1
 232 #define UVC_STATUS_TYPE_STREAMING       2
 233
 234 /* ------------------------------------------------------------------------
 235  * GUIDs
 236  */
 237 #define UVC_GUID_UVC_CAMERA \
 238         {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 239          0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01}
 240 #define UVC_GUID_UVC_OUTPUT \
 241         {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 242          0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02}
 243 #define UVC_GUID_UVC_MEDIA_TRANSPORT_INPUT \
 244         {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 245          0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03}
 246 #define UVC_GUID_UVC_PROCESSING \
 247         {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 248          0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x01}
 249 #define UVC_GUID_UVC_SELECTOR \
 250         {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 251          0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x02}
 252
 253 #define UVC_GUID_LOGITECH_DEV_INFO \
 254         {0x82, 0x06, 0x61, 0x63, 0x70, 0x50, 0xab, 0x49, \
 255          0xb8, 0xcc, 0xb3, 0x85, 0x5e, 0x8d, 0x22, 0x1e}
 256 #define UVC_GUID_LOGITECH_USER_HW \
 257         {0x82, 0x06, 0x61, 0x63, 0x70, 0x50, 0xab, 0x49, \
 258          0xb8, 0xcc, 0xb3, 0x85, 0x5e, 0x8d, 0x22, 0x1f}
 259 #define UVC_GUID_LOGITECH_VIDEO \
 260         {0x82, 0x06, 0x61, 0x63, 0x70, 0x50, 0xab, 0x49, \
 261          0xb8, 0xcc, 0xb3, 0x85, 0x5e, 0x8d, 0x22, 0x50}
 262 #define UVC_GUID_LOGITECH_MOTOR \
 263         {0x82, 0x06, 0x61, 0x63, 0x70, 0x50, 0xab, 0x49, \
 264          0xb8, 0xcc, 0xb3, 0x85, 0x5e, 0x8d, 0x22, 0x56}
 265
 266 #define UVC_GUID_FORMAT_MJPEG \
 267         { 'M',  'J',  'P',  'G', 0x00, 0x00, 0x10, 0x00, \
 268          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 269 #define UVC_GUID_FORMAT_YUY2 \
 270         { 'Y',  'U',  'Y',  '2', 0x00, 0x00, 0x10, 0x00, \
 271          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 272 #define UVC_GUID_FORMAT_NV12 \
 273         { 'N',  'V',  '1',  '2', 0x00, 0x00, 0x10, 0x00, \
 274          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 275 #define UVC_GUID_FORMAT_YV12 \
 276         { 'Y',  'V',  '1',  '2', 0x00, 0x00, 0x10, 0x00, \
 277          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 278 #define UVC_GUID_FORMAT_I420 \
 279         { 'I',  '4',  '2',  '0', 0x00, 0x00, 0x10, 0x00, \
 280          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 281 #define UVC_GUID_FORMAT_UYVY \
 282         { 'U',  'Y',  'V',  'Y', 0x00, 0x00, 0x10, 0x00, \
 283          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 284 #define UVC_GUID_FORMAT_Y800 \
 285         { 'Y',  '8',  '0',  '0', 0x00, 0x00, 0x10, 0x00, \
 286          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 287 #define UVC_GUID_FORMAT_BY8 \
 288         { 'B',  'Y',  '8',  ' ', 0x00, 0x00, 0x10, 0x00, \
 289          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 290
 291
 292 /* ------------------------------------------------------------------------
 293  * Driver specific constants.
 294  */
 295
 296 #define DRIVER_VERSION_NUMBER   KERNEL_VERSION(0, 1, 0)
 297
 298 /* Number of isochronous URBs. */
 299 #define UVC_URBS                5
 300 /* Maximum number of packets per isochronous URB. */
 301 #define UVC_MAX_ISO_PACKETS     40
 302 /* Maximum frame size in bytes, for sanity checking. */
 303 #define UVC_MAX_FRAME_SIZE      (16*1024*1024)
 304 /* Maximum number of video buffers. */
 305 #define UVC_MAX_VIDEO_BUFFERS   32
 306
 307 #define UVC_CTRL_CONTROL_TIMEOUT        300
 308 #define UVC_CTRL_STREAMING_TIMEOUT      1000
 309
 310 /* Devices quirks */
 311 #define UVC_QUIRK_STATUS_INTERVAL       0x00000001
 312 #define UVC_QUIRK_PROBE_MINMAX          0x00000002
 313 #define UVC_QUIRK_PROBE_EXTRAFIELDS     0x00000004
 314 #define UVC_QUIRK_BUILTIN_ISIGHT        0x00000008
 315 #define UVC_QUIRK_STREAM_NO_FID         0x00000010
 316 #define UVC_QUIRK_IGNORE_SELECTOR_UNIT  0x00000020
 317
 318 /* Format flags */
 319 #define UVC_FMT_FLAG_COMPRESSED         0x00000001
 320 #define UVC_FMT_FLAG_STREAM             0x00000002
 321
 322 /* ------------------------------------------------------------------------
 323  * Structures.
 324  */
 325
 326 struct uvc_device;
 327
 328 /* TODO: Put the most frequently accessed fields at the beginning of
 329  * structures to maximize cache efficiency.
 330  */
 331 struct uvc_streaming_control {
 332         __u16 bmHint;
 333         __u8  bFormatIndex;
 334         __u8  bFrameIndex;
 335         __u32 dwFrameInterval;
 336         __u16 wKeyFrameRate;
 337         __u16 wPFrameRate;
 338         __u16 wCompQuality;
 339         __u16 wCompWindowSize;
 340         __u16 wDelay;
 341         __u32 dwMaxVideoFrameSize;
 342         __u32 dwMaxPayloadTransferSize;
 343         __u32 dwClockFrequency;
 344         __u8  bmFramingInfo;
 345         __u8  bPreferedVersion;
 346         __u8  bMinVersion;
 347         __u8  bMaxVersion;
 348 };
 349
 350 struct uvc_menu_info {
 351         __u32 value;
 352         __u8 name[32];
 353 };
 354
 355 struct uvc_control_info {
 356         struct list_head list;
 357         struct list_head mappings;
 358
 359         __u8 entity[16];
 360         __u8 index;
 361         __u8 selector;
 362
 363         __u16 size;
 364         __u32 flags;
 365 };
 366
 367 struct uvc_control_mapping {
 368         struct list_head list;
 369
 370         struct uvc_control_info *ctrl;
 371
 372         __u32 id;
 373         __u8 name[32];
 374         __u8 entity[16];
 375         __u8 selector;
 376
 377         __u8 size;
 378         __u8 offset;
 379         enum v4l2_ctrl_type v4l2_type;
 380         __u32 data_type;
 381
 382         struct uvc_menu_info *menu_info;
 383         __u32 menu_count;
 384 };
 385
 386 struct uvc_control {
 387         struct uvc_entity *entity;
 388         struct uvc_control_info *info;
 389
 390         __u8 index;     /* Used to match the uvc_control entry with a
 391                            uvc_control_info. */
 392         __u8 dirty : 1,
 393              loaded : 1,
 394              modified : 1;
 395
 396         __u8 *data;
 397 };
 398
 399 struct uvc_format_desc {
 400         char *name;
 401         __u8 guid[16];
 402         __u32 fcc;
 403 };
 404
 405 /* The term 'entity' refers to both UVC units and UVC terminals.
 406  *
 407  * The type field is either the terminal type (wTerminalType in the terminal
 408  * descriptor), or the unit type (bDescriptorSubtype in the unit descriptor).
 409  * As the bDescriptorSubtype field is one byte long, the type value will
 410  * always have a null MSB for units. All terminal types defined by the UVC
 411  * specification have a non-null MSB, so it is safe to use the MSB to
 412  * differentiate between units and terminals as long as the descriptor parsing
 413  * code makes sure terminal types have a non-null MSB.
 414  *
 415  * For terminals, the type's most significant bit stores the terminal
 416  * direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should
 417  * always be accessed with the UVC_ENTITY_* macros and never directly.
 418  */
 419
 420 struct uvc_entity {
 421         struct list_head list;          /* Entity as part of a UVC device. */
 422         struct list_head chain;         /* Entity as part of a video device
 423                                          * chain. */
 424         __u8 id;
 425         __u16 type;
 426         char name[64];
 427
 428         union {
 429                 struct {
 430                         __u16 wObjectiveFocalLengthMin;
 431                         __u16 wObjectiveFocalLengthMax;
 432                         __u16 wOcularFocalLength;
 433                         __u8  bControlSize;
 434                         __u8  *bmControls;
 435                 } camera;
 436
 437                 struct {
 438                         __u8  bControlSize;
 439                         __u8  *bmControls;
 440                         __u8  bTransportModeSize;
 441                         __u8  *bmTransportModes;
 442                 } media;
 443
 444                 struct {
 445                         __u8  bSourceID;
 446                 } output;
 447
 448                 struct {
 449                         __u8  bSourceID;
 450                         __u16 wMaxMultiplier;
 451                         __u8  bControlSize;
 452                         __u8  *bmControls;
 453                         __u8  bmVideoStandards;
 454                 } processing;
 455
 456                 struct {
 457                         __u8  bNrInPins;
 458                         __u8  *baSourceID;
 459                 } selector;
 460
 461                 struct {
 462                         __u8  guidExtensionCode[16];
 463                         __u8  bNumControls;
 464                         __u8  bNrInPins;
 465                         __u8  *baSourceID;
 466                         __u8  bControlSize;
 467                         __u8  *bmControls;
 468                         __u8  *bmControlsType;
 469                 } extension;
 470         };
 471
 472         unsigned int ncontrols;
 473         struct uvc_control *controls;
 474 };
 475
 476 struct uvc_frame {
 477         __u8  bFrameIndex;
 478         __u8  bmCapabilities;
 479         __u16 wWidth;
 480         __u16 wHeight;
 481         __u32 dwMinBitRate;
 482         __u32 dwMaxBitRate;
 483         __u32 dwMaxVideoFrameBufferSize;
 484         __u8  bFrameIntervalType;
 485         __u32 dwDefaultFrameInterval;
 486         __u32 *dwFrameInterval;
 487 };
 488
 489 struct uvc_format {
 490         __u8 type;
 491         __u8 index;
 492         __u8 bpp;
 493         __u8 colorspace;
 494         __u32 fcc;
 495         __u32 flags;
 496
 497         char name[32];
 498
 499         unsigned int nframes;
 500         struct uvc_frame *frame;
 501 };
 502
 503 struct uvc_streaming_header {
 504         __u8 bNumFormats;
 505         __u8 bEndpointAddress;
 506         __u8 bTerminalLink;
 507         __u8 bControlSize;
 508         __u8 *bmaControls;
 509         /* The following fields are used by input headers only. */
 510         __u8 bmInfo;
 511         __u8 bStillCaptureMethod;
 512         __u8 bTriggerSupport;
 513         __u8 bTriggerUsage;
 514 };
 515
 516 struct uvc_streaming {
 517         struct list_head list;
 518
 519         struct usb_interface *intf;
 520         int intfnum;
 521         __u16 maxpsize;
 522
 523         struct uvc_streaming_header header;
 524
 525         unsigned int nformats;
 526         struct uvc_format *format;
 527
 528         struct uvc_streaming_control ctrl;
 529         struct uvc_format *cur_format;
 530         struct uvc_frame *cur_frame;
 531
 532         struct mutex mutex;
 533 };
 534
 535 enum uvc_buffer_state {
 536         UVC_BUF_STATE_IDLE       = 0,
 537         UVC_BUF_STATE_QUEUED     = 1,
 538         UVC_BUF_STATE_ACTIVE     = 2,
 539         UVC_BUF_STATE_DONE       = 3,
 540         UVC_BUF_STATE_ERROR      = 4,
 541 };
 542
 543 struct uvc_buffer {
 544         unsigned long vma_use_count;
 545         struct list_head stream;
 546
 547         /* Touched by interrupt handler. */
 548         struct v4l2_buffer buf;
 549         struct list_head queue;
 550         wait_queue_head_t wait;
 551         enum uvc_buffer_state state;
 552 };
 553
 554 #define UVC_QUEUE_STREAMING             (1 << 0)
 555 #define UVC_QUEUE_DISCONNECTED          (1 << 1)
 556 #define UVC_QUEUE_DROP_INCOMPLETE       (1 << 2)
 557
 558 struct uvc_video_queue {
 559         void *mem;
 560         unsigned int flags;
 561         __u32 sequence;
 562
 563         unsigned int count;
 564         unsigned int buf_size;
 565         struct uvc_buffer buffer[UVC_MAX_VIDEO_BUFFERS];
 566         struct mutex mutex;     /* protects buffers and mainqueue */
 567         spinlock_t irqlock;     /* protects irqqueue */
 568
 569         struct list_head mainqueue;
 570         struct list_head irqqueue;
 571 };
 572
 573 struct uvc_video_device {
 574         struct uvc_device *dev;
 575         struct video_device *vdev;
 576         atomic_t active;
 577         unsigned int frozen : 1;
 578
 579         struct list_head iterms;
 580         struct uvc_entity *oterm;
 581         struct uvc_entity *processing;
 582         struct uvc_entity *selector;
 583         struct list_head extensions;
 584         struct mutex ctrl_mutex;
 585
 586         struct uvc_video_queue queue;
 587
 588         /* Video streaming object, must always be non-NULL. */
 589         struct uvc_streaming *streaming;
 590
 591         void (*decode) (struct urb *urb, struct uvc_video_device *video,
 592                         struct uvc_buffer *buf);
 593
 594         /* Context data used by the bulk completion handler. */
 595         struct {
 596                 __u8 header[256];
 597                 unsigned int header_size;
 598                 int skip_payload;
 599                 __u32 payload_size;
 600                 __u32 max_payload_size;
 601         } bulk;
 602
 603         struct urb *urb[UVC_URBS];
 604         char *urb_buffer[UVC_URBS];
 605
 606         __u8 last_fid;
 607 };
 608
 609 enum uvc_device_state {
 610         UVC_DEV_DISCONNECTED = 1,
 611 };
 612
 613 struct uvc_device {
 614         struct usb_device *udev;
 615         struct usb_interface *intf;
 616         __u32 quirks;
 617         int intfnum;
 618         char name[32];
 619
 620         enum uvc_device_state state;
 621         struct kref kref;
 622         struct list_head list;
 623
 624         /* Video control interface */
 625         __u16 uvc_version;
 626         __u32 clock_frequency;
 627
 628         struct list_head entities;
 629
 630         struct uvc_video_device video;
 631
 632         /* Status Interrupt Endpoint */
 633         struct usb_host_endpoint *int_ep;
 634         struct urb *int_urb;
 635         __u8 status[16];
 636         struct input_dev *input;
 637
 638         /* Video Streaming interfaces */
 639         struct list_head streaming;
 640 };
 641
 642 enum uvc_handle_state {
 643         UVC_HANDLE_PASSIVE      = 0,
 644         UVC_HANDLE_ACTIVE       = 1,
 645 };
 646
 647 struct uvc_fh {
 648         struct uvc_video_device *device;
 649         enum uvc_handle_state state;
 650 };
 651
 652 struct uvc_driver {
 653         struct usb_driver driver;
 654
 655         struct mutex open_mutex;        /* protects from open/disconnect race */
 656
 657         struct list_head devices;       /* struct uvc_device list */
 658         struct list_head controls;      /* struct uvc_control_info list */
 659         struct mutex ctrl_mutex;        /* protects controls and devices
 660                                            lists */
 661 };
 662
 663 /* ------------------------------------------------------------------------
 664  * Debugging, printing and logging
 665  */
 666
 667 #define UVC_TRACE_PROBE         (1 << 0)
 668 #define UVC_TRACE_DESCR         (1 << 1)
 669 #define UVC_TRACE_CONTROL       (1 << 2)
 670 #define UVC_TRACE_FORMAT        (1 << 3)
 671 #define UVC_TRACE_CAPTURE       (1 << 4)
 672 #define UVC_TRACE_CALLS         (1 << 5)
 673 #define UVC_TRACE_IOCTL         (1 << 6)
 674 #define UVC_TRACE_FRAME         (1 << 7)
 675 #define UVC_TRACE_SUSPEND       (1 << 8)
 676 #define UVC_TRACE_STATUS        (1 << 9)
 677
 678 extern unsigned int uvc_trace_param;
 679
 680 #define uvc_trace(flag, msg...) \
 681         do { \
 682                 if (uvc_trace_param & flag) \
 683                         printk(KERN_DEBUG "uvcvideo: " msg); \
 684         } while (0)
 685
 686 #define uvc_printk(level, msg...) \
 687         printk(level "uvcvideo: " msg)
 688
 689 #define UVC_GUID_FORMAT "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-" \
 690                         "%02x%02x%02x%02x%02x%02x"
 691 #define UVC_GUID_ARGS(guid) \
 692         (guid)[3],  (guid)[2],  (guid)[1],  (guid)[0], \
 693         (guid)[5],  (guid)[4], \
 694         (guid)[7],  (guid)[6], \
 695         (guid)[8],  (guid)[9], \
 696         (guid)[10], (guid)[11], (guid)[12], \
 697         (guid)[13], (guid)[14], (guid)[15]
 698
 699 /* --------------------------------------------------------------------------
 700  * Internal functions.
 701  */
 702
 703 /* Core driver */
 704 extern struct uvc_driver uvc_driver;
 705 extern void uvc_delete(struct kref *kref);
 706
 707 /* Video buffers queue management. */
 708 extern void uvc_queue_init(struct uvc_video_queue *queue);
 709 extern int uvc_alloc_buffers(struct uvc_video_queue *queue,
 710                 unsigned int nbuffers, unsigned int buflength);
 711 extern int uvc_free_buffers(struct uvc_video_queue *queue);
 712 extern int uvc_query_buffer(struct uvc_video_queue *queue,
 713                 struct v4l2_buffer *v4l2_buf);
 714 extern int uvc_queue_buffer(struct uvc_video_queue *queue,
 715                 struct v4l2_buffer *v4l2_buf);
 716 extern int uvc_dequeue_buffer(struct uvc_video_queue *queue,
 717                 struct v4l2_buffer *v4l2_buf, int nonblocking);
 718 extern int uvc_queue_enable(struct uvc_video_queue *queue, int enable);
 719 extern void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect);
 720 extern struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue,
 721                 struct uvc_buffer *buf);
 722 extern unsigned int uvc_queue_poll(struct uvc_video_queue *queue,
 723                 struct file *file, poll_table *wait);
 724 static inline int uvc_queue_streaming(struct uvc_video_queue *queue)
 725 {
 726         return queue->flags & UVC_QUEUE_STREAMING;
 727 }
 728
 729 /* V4L2 interface */
 730 extern struct file_operations uvc_fops;
 731
 732 /* Video */
 733 extern int uvc_video_init(struct uvc_video_device *video);
 734 extern int uvc_video_suspend(struct uvc_video_device *video);
 735 extern int uvc_video_resume(struct uvc_video_device *video);
 736 extern int uvc_video_enable(struct uvc_video_device *video, int enable);
 737 extern int uvc_probe_video(struct uvc_video_device *video,
 738                 struct uvc_streaming_control *probe);
 739 extern int uvc_query_ctrl(struct uvc_device *dev, __u8 query, __u8 unit,
 740                 __u8 intfnum, __u8 cs, void *data, __u16 size);
 741 extern int uvc_set_video_ctrl(struct uvc_video_device *video,
 742                 struct uvc_streaming_control *ctrl, int probe);
 743
 744 /* Status */
 745 extern int uvc_status_init(struct uvc_device *dev);
 746 extern void uvc_status_cleanup(struct uvc_device *dev);
 747 extern int uvc_status_suspend(struct uvc_device *dev);
 748 extern int uvc_status_resume(struct uvc_device *dev);
 749
 750 /* Controls */
 751 extern struct uvc_control *uvc_find_control(struct uvc_video_device *video,
 752                 __u32 v4l2_id, struct uvc_control_mapping **mapping);
 753 extern int uvc_query_v4l2_ctrl(struct uvc_video_device *video,
 754                 struct v4l2_queryctrl *v4l2_ctrl);
 755
 756 extern int uvc_ctrl_add_info(struct uvc_control_info *info);
 757 extern int uvc_ctrl_add_mapping(struct uvc_control_mapping *mapping);
 758 extern int uvc_ctrl_init_device(struct uvc_device *dev);
 759 extern void uvc_ctrl_cleanup_device(struct uvc_device *dev);
 760 extern int uvc_ctrl_resume_device(struct uvc_device *dev);
 761 extern void uvc_ctrl_init(void);
 762
 763 extern int uvc_ctrl_begin(struct uvc_video_device *video);
 764 extern int __uvc_ctrl_commit(struct uvc_video_device *video, int rollback);
 765 static inline int uvc_ctrl_commit(struct uvc_video_device *video)
 766 {
 767         return __uvc_ctrl_commit(video, 0);
 768 }
 769 static inline int uvc_ctrl_rollback(struct uvc_video_device *video)
 770 {
 771         return __uvc_ctrl_commit(video, 1);
 772 }
 773
 774 extern int uvc_ctrl_get(struct uvc_video_device *video,
 775                 struct v4l2_ext_control *xctrl);
 776 extern int uvc_ctrl_set(struct uvc_video_device *video,
 777                 struct v4l2_ext_control *xctrl);
 778
 779 extern int uvc_xu_ctrl_query(struct uvc_video_device *video,
 780                 struct uvc_xu_control *ctrl, int set);
 781
 782 /* Utility functions */
 783 extern void uvc_simplify_fraction(uint32_t *numerator, uint32_t *denominator,
 784                 unsigned int n_terms, unsigned int threshold);
 785 extern uint32_t uvc_fraction_to_interval(uint32_t numerator,
 786                 uint32_t denominator);
 787 extern struct usb_host_endpoint *uvc_find_endpoint(
 788                 struct usb_host_interface *alts, __u8 epaddr);
 789
 790 /* Quirks support */
 791 void uvc_video_decode_isight(struct urb *urb, struct uvc_video_device *video,
 792                 struct uvc_buffer *buf);
 793
 794 #endif /* __KERNEL__ */
 795
 796 #endif