drivers/media/usb/uvc/uvcvideo.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _USB_VIDEO_H_
   3 #define _USB_VIDEO_H_
   4
   5 #ifndef __KERNEL__
   6 #error "The uvcvideo.h header is deprecated, use linux/uvcvideo.h instead."
   7 #endif /* __KERNEL__ */
   8
   9 #include <linux/kernel.h>
  10 #include <linux/poll.h>
  11 #include <linux/usb.h>
  12 #include <linux/usb/video.h>
  13 #include <linux/uvcvideo.h>
  14 #include <linux/videodev2.h>
  15 #include <linux/workqueue.h>
  16 #include <media/media-device.h>
  17 #include <media/v4l2-device.h>
  18 #include <media/v4l2-event.h>
  19 #include <media/v4l2-fh.h>
  20 #include <media/videobuf2-v4l2.h>
  21
  22 /* --------------------------------------------------------------------------
  23  * UVC constants
  24  */
  25
  26 #define UVC_TERM_INPUT                  0x0000
  27 #define UVC_TERM_OUTPUT                 0x8000
  28 #define UVC_TERM_DIRECTION(term)        ((term)->type & 0x8000)
  29
  30 #define UVC_ENTITY_TYPE(entity)         ((entity)->type & 0x7fff)
  31 #define UVC_ENTITY_IS_UNIT(entity)      (((entity)->type & 0xff00) == 0)
  32 #define UVC_ENTITY_IS_TERM(entity)      (((entity)->type & 0xff00) != 0)
  33 #define UVC_ENTITY_IS_ITERM(entity) \
  34         (UVC_ENTITY_IS_TERM(entity) && \
  35         ((entity)->type & 0x8000) == UVC_TERM_INPUT)
  36 #define UVC_ENTITY_IS_OTERM(entity) \
  37         (UVC_ENTITY_IS_TERM(entity) && \
  38         ((entity)->type & 0x8000) == UVC_TERM_OUTPUT)
  39
  40
  41 /* ------------------------------------------------------------------------
  42  * GUIDs
  43  */
  44 #define UVC_GUID_UVC_CAMERA \
  45         {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
  46          0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01}
  47 #define UVC_GUID_UVC_OUTPUT \
  48         {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
  49          0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02}
  50 #define UVC_GUID_UVC_MEDIA_TRANSPORT_INPUT \
  51         {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
  52          0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03}
  53 #define UVC_GUID_UVC_PROCESSING \
  54         {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
  55          0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x01}
  56 #define UVC_GUID_UVC_SELECTOR \
  57         {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
  58          0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x02}
  59
  60 #define UVC_GUID_FORMAT_MJPEG \
  61         { 'M',  'J',  'P',  'G', 0x00, 0x00, 0x10, 0x00, \
  62          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  63 #define UVC_GUID_FORMAT_YUY2 \
  64         { 'Y',  'U',  'Y',  '2', 0x00, 0x00, 0x10, 0x00, \
  65          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  66 #define UVC_GUID_FORMAT_YUY2_ISIGHT \
  67         { 'Y',  'U',  'Y',  '2', 0x00, 0x00, 0x10, 0x00, \
  68          0x80, 0x00, 0x00, 0x00, 0x00, 0x38, 0x9b, 0x71}
  69 #define UVC_GUID_FORMAT_NV12 \
  70         { 'N',  'V',  '1',  '2', 0x00, 0x00, 0x10, 0x00, \
  71          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  72 #define UVC_GUID_FORMAT_YV12 \
  73         { 'Y',  'V',  '1',  '2', 0x00, 0x00, 0x10, 0x00, \
  74          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  75 #define UVC_GUID_FORMAT_I420 \
  76         { 'I',  '4',  '2',  '0', 0x00, 0x00, 0x10, 0x00, \
  77          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  78 #define UVC_GUID_FORMAT_UYVY \
  79         { 'U',  'Y',  'V',  'Y', 0x00, 0x00, 0x10, 0x00, \
  80          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  81 #define UVC_GUID_FORMAT_Y800 \
  82         { 'Y',  '8',  '0',  '0', 0x00, 0x00, 0x10, 0x00, \
  83          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  84 #define UVC_GUID_FORMAT_Y8 \
  85         { 'Y',  '8',  ' ',  ' ', 0x00, 0x00, 0x10, 0x00, \
  86          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  87 #define UVC_GUID_FORMAT_Y10 \
  88         { 'Y',  '1',  '0',  ' ', 0x00, 0x00, 0x10, 0x00, \
  89          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  90 #define UVC_GUID_FORMAT_Y12 \
  91         { 'Y',  '1',  '2',  ' ', 0x00, 0x00, 0x10, 0x00, \
  92          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  93 #define UVC_GUID_FORMAT_Y16 \
  94         { 'Y',  '1',  '6',  ' ', 0x00, 0x00, 0x10, 0x00, \
  95          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  96 #define UVC_GUID_FORMAT_BY8 \
  97         { 'B',  'Y',  '8',  ' ', 0x00, 0x00, 0x10, 0x00, \
  98          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  99 #define UVC_GUID_FORMAT_BA81 \
 100         { 'B',  'A',  '8',  '1', 0x00, 0x00, 0x10, 0x00, \
 101          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 102 #define UVC_GUID_FORMAT_GBRG \
 103         { 'G',  'B',  'R',  'G', 0x00, 0x00, 0x10, 0x00, \
 104          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 105 #define UVC_GUID_FORMAT_GRBG \
 106         { 'G',  'R',  'B',  'G', 0x00, 0x00, 0x10, 0x00, \
 107          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 108 #define UVC_GUID_FORMAT_RGGB \
 109         { 'R',  'G',  'G',  'B', 0x00, 0x00, 0x10, 0x00, \
 110          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 111 #define UVC_GUID_FORMAT_BG16 \
 112         { 'B',  'G',  '1',  '6', 0x00, 0x00, 0x10, 0x00, \
 113          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 114 #define UVC_GUID_FORMAT_GB16 \
 115         { 'G',  'B',  '1',  '6', 0x00, 0x00, 0x10, 0x00, \
 116          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 117 #define UVC_GUID_FORMAT_RG16 \
 118         { 'R',  'G',  '1',  '6', 0x00, 0x00, 0x10, 0x00, \
 119          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 120 #define UVC_GUID_FORMAT_GR16 \
 121         { 'G',  'R',  '1',  '6', 0x00, 0x00, 0x10, 0x00, \
 122          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 123 #define UVC_GUID_FORMAT_RGBP \
 124         { 'R',  'G',  'B',  'P', 0x00, 0x00, 0x10, 0x00, \
 125          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 126 #define UVC_GUID_FORMAT_BGR3 \
 127         { 0x7d, 0xeb, 0x36, 0xe4, 0x4f, 0x52, 0xce, 0x11, \
 128          0x9f, 0x53, 0x00, 0x20, 0xaf, 0x0b, 0xa7, 0x70}
 129 #define UVC_GUID_FORMAT_M420 \
 130         { 'M',  '4',  '2',  '0', 0x00, 0x00, 0x10, 0x00, \
 131          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 132
 133 #define UVC_GUID_FORMAT_H264 \
 134         { 'H',  '2',  '6',  '4', 0x00, 0x00, 0x10, 0x00, \
 135          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 136 #define UVC_GUID_FORMAT_Y8I \
 137         { 'Y',  '8',  'I',  ' ', 0x00, 0x00, 0x10, 0x00, \
 138          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 139 #define UVC_GUID_FORMAT_Y12I \
 140         { 'Y',  '1',  '2',  'I', 0x00, 0x00, 0x10, 0x00, \
 141          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 142 #define UVC_GUID_FORMAT_Z16 \
 143         { 'Z',  '1',  '6',  ' ', 0x00, 0x00, 0x10, 0x00, \
 144          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 145 #define UVC_GUID_FORMAT_RW10 \
 146         { 'R',  'W',  '1',  '0', 0x00, 0x00, 0x10, 0x00, \
 147          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 148 #define UVC_GUID_FORMAT_INVZ \
 149         { 'I',  'N',  'V',  'Z', 0x90, 0x2d, 0x58, 0x4a, \
 150          0x92, 0x0b, 0x77, 0x3f, 0x1f, 0x2c, 0x55, 0x6b}
 151 #define UVC_GUID_FORMAT_INZI \
 152         { 'I',  'N',  'Z',  'I', 0x66, 0x1a, 0x42, 0xa2, \
 153          0x90, 0x65, 0xd0, 0x18, 0x14, 0xa8, 0xef, 0x8a}
 154 #define UVC_GUID_FORMAT_INVI \
 155         { 'I',  'N',  'V',  'I', 0xdb, 0x57, 0x49, 0x5e, \
 156          0x8e, 0x3f, 0xf4, 0x79, 0x53, 0x2b, 0x94, 0x6f}
 157 #define UVC_GUID_FORMAT_CNF4 \
 158         { 'C',  ' ',  ' ',  ' ', 0x00, 0x00, 0x10, 0x00, \
 159          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 160
 161 #define UVC_GUID_FORMAT_D3DFMT_L8 \
 162         {0x32, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, \
 163          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 164 #define UVC_GUID_FORMAT_KSMEDIA_L8_IR \
 165         {0x32, 0x00, 0x00, 0x00, 0x02, 0x00, 0x10, 0x00, \
 166          0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
 167
 168
 169 /* ------------------------------------------------------------------------
 170  * Driver specific constants.
 171  */
 172
 173 #define DRIVER_VERSION          "1.1.1"
 174
 175 /* Number of isochronous URBs. */
 176 #define UVC_URBS                5
 177 /* Maximum number of packets per URB. */
 178 #define UVC_MAX_PACKETS         32
 179 /* Maximum status buffer size in bytes of interrupt URB. */
 180 #define UVC_MAX_STATUS_SIZE     16
 181
 182 #define UVC_CTRL_CONTROL_TIMEOUT        500
 183 #define UVC_CTRL_STREAMING_TIMEOUT      5000
 184
 185 /* Maximum allowed number of control mappings per device */
 186 #define UVC_MAX_CONTROL_MAPPINGS        1024
 187 #define UVC_MAX_CONTROL_MENU_ENTRIES    32
 188
 189 /* Devices quirks */
 190 #define UVC_QUIRK_STATUS_INTERVAL       0x00000001
 191 #define UVC_QUIRK_PROBE_MINMAX          0x00000002
 192 #define UVC_QUIRK_PROBE_EXTRAFIELDS     0x00000004
 193 #define UVC_QUIRK_BUILTIN_ISIGHT        0x00000008
 194 #define UVC_QUIRK_STREAM_NO_FID         0x00000010
 195 #define UVC_QUIRK_IGNORE_SELECTOR_UNIT  0x00000020
 196 #define UVC_QUIRK_FIX_BANDWIDTH         0x00000080
 197 #define UVC_QUIRK_PROBE_DEF             0x00000100
 198 #define UVC_QUIRK_RESTRICT_FRAME_RATE   0x00000200
 199 #define UVC_QUIRK_RESTORE_CTRLS_ON_INIT 0x00000400
 200 #define UVC_QUIRK_FORCE_Y8              0x00000800
 201 #define UVC_QUIRK_FORCE_BPP             0x00001000
 202
 203 /* Format flags */
 204 #define UVC_FMT_FLAG_COMPRESSED         0x00000001
 205 #define UVC_FMT_FLAG_STREAM             0x00000002
 206
 207 /* ------------------------------------------------------------------------
 208  * Structures.
 209  */
 210
 211 struct uvc_device;
 212
 213 /* TODO: Put the most frequently accessed fields at the beginning of
 214  * structures to maximize cache efficiency.
 215  */
 216 struct uvc_control_info {
 217         struct list_head mappings;
 218
 219         u8 entity[16];
 220         u8 index;       /* Bit index in bmControls */
 221         u8 selector;
 222
 223         u16 size;
 224         u32 flags;
 225 };
 226
 227 struct uvc_control_mapping {
 228         struct list_head list;
 229         struct list_head ev_subs;
 230
 231         u32 id;
 232         u8 name[32];
 233         u8 entity[16];
 234         u8 selector;
 235
 236         u8 size;
 237         u8 offset;
 238         enum v4l2_ctrl_type v4l2_type;
 239         u32 data_type;
 240
 241         const struct uvc_menu_info *menu_info;
 242         u32 menu_count;
 243
 244         u32 master_id;
 245         s32 master_manual;
 246         u32 slave_ids[2];
 247
 248         s32 (*get)(struct uvc_control_mapping *mapping, u8 query,
 249                    const u8 *data);
 250         void (*set)(struct uvc_control_mapping *mapping, s32 value,
 251                     u8 *data);
 252 };
 253
 254 struct uvc_control {
 255         struct uvc_entity *entity;
 256         struct uvc_control_info info;
 257
 258         u8 index;       /* Used to match the uvc_control entry with a
 259                            uvc_control_info. */
 260         u8 dirty:1,
 261            loaded:1,
 262            modified:1,
 263            cached:1,
 264            initialized:1;
 265
 266         u8 *uvc_data;
 267
 268         struct uvc_fh *handle;  /* File handle that last changed the control. */
 269 };
 270
 271 struct uvc_format_desc {
 272         char *name;
 273         u8 guid[16];
 274         u32 fcc;
 275 };
 276
 277 /* The term 'entity' refers to both UVC units and UVC terminals.
 278  *
 279  * The type field is either the terminal type (wTerminalType in the terminal
 280  * descriptor), or the unit type (bDescriptorSubtype in the unit descriptor).
 281  * As the bDescriptorSubtype field is one byte long, the type value will
 282  * always have a null MSB for units. All terminal types defined by the UVC
 283  * specification have a non-null MSB, so it is safe to use the MSB to
 284  * differentiate between units and terminals as long as the descriptor parsing
 285  * code makes sure terminal types have a non-null MSB.
 286  *
 287  * For terminals, the type's most significant bit stores the terminal
 288  * direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should
 289  * always be accessed with the UVC_ENTITY_* macros and never directly.
 290  */
 291
 292 #define UVC_ENTITY_FLAG_DEFAULT         (1 << 0)
 293
 294 struct uvc_entity {
 295         struct list_head list;          /* Entity as part of a UVC device. */
 296         struct list_head chain;         /* Entity as part of a video device
 297                                          * chain. */
 298         unsigned int flags;
 299
 300         u8 id;
 301         u16 type;
 302         char name[64];
 303
 304         /* Media controller-related fields. */
 305         struct video_device *vdev;
 306         struct v4l2_subdev subdev;
 307         unsigned int num_pads;
 308         unsigned int num_links;
 309         struct media_pad *pads;
 310
 311         union {
 312                 struct {
 313                         u16 wObjectiveFocalLengthMin;
 314                         u16 wObjectiveFocalLengthMax;
 315                         u16 wOcularFocalLength;
 316                         u8  bControlSize;
 317                         u8  *bmControls;
 318                 } camera;
 319
 320                 struct {
 321                         u8  bControlSize;
 322                         u8  *bmControls;
 323                         u8  bTransportModeSize;
 324                         u8  *bmTransportModes;
 325                 } media;
 326
 327                 struct {
 328                 } output;
 329
 330                 struct {
 331                         u16 wMaxMultiplier;
 332                         u8  bControlSize;
 333                         u8  *bmControls;
 334                         u8  bmVideoStandards;
 335                 } processing;
 336
 337                 struct {
 338                 } selector;
 339
 340                 struct {
 341                         u8  guidExtensionCode[16];
 342                         u8  bNumControls;
 343                         u8  bControlSize;
 344                         u8  *bmControls;
 345                         u8  *bmControlsType;
 346                 } extension;
 347         };
 348
 349         u8 bNrInPins;
 350         u8 *baSourceID;
 351
 352         unsigned int ncontrols;
 353         struct uvc_control *controls;
 354 };
 355
 356 struct uvc_frame {
 357         u8  bFrameIndex;
 358         u8  bmCapabilities;
 359         u16 wWidth;
 360         u16 wHeight;
 361         u32 dwMinBitRate;
 362         u32 dwMaxBitRate;
 363         u32 dwMaxVideoFrameBufferSize;
 364         u8  bFrameIntervalType;
 365         u32 dwDefaultFrameInterval;
 366         u32 *dwFrameInterval;
 367 };
 368
 369 struct uvc_format {
 370         u8 type;
 371         u8 index;
 372         u8 bpp;
 373         u8 colorspace;
 374         u32 fcc;
 375         u32 flags;
 376
 377         char name[32];
 378
 379         unsigned int nframes;
 380         struct uvc_frame *frame;
 381 };
 382
 383 struct uvc_streaming_header {
 384         u8 bNumFormats;
 385         u8 bEndpointAddress;
 386         u8 bTerminalLink;
 387         u8 bControlSize;
 388         u8 *bmaControls;
 389         /* The following fields are used by input headers only. */
 390         u8 bmInfo;
 391         u8 bStillCaptureMethod;
 392         u8 bTriggerSupport;
 393         u8 bTriggerUsage;
 394 };
 395
 396 enum uvc_buffer_state {
 397         UVC_BUF_STATE_IDLE      = 0,
 398         UVC_BUF_STATE_QUEUED    = 1,
 399         UVC_BUF_STATE_ACTIVE    = 2,
 400         UVC_BUF_STATE_READY     = 3,
 401         UVC_BUF_STATE_DONE      = 4,
 402         UVC_BUF_STATE_ERROR     = 5,
 403 };
 404
 405 struct uvc_buffer {
 406         struct vb2_v4l2_buffer buf;
 407         struct list_head queue;
 408
 409         enum uvc_buffer_state state;
 410         unsigned int error;
 411
 412         void *mem;
 413         unsigned int length;
 414         unsigned int bytesused;
 415
 416         u32 pts;
 417
 418         /* Asynchronous buffer handling. */
 419         struct kref ref;
 420 };
 421
 422 #define UVC_QUEUE_DISCONNECTED          (1 << 0)
 423 #define UVC_QUEUE_DROP_CORRUPTED        (1 << 1)
 424
 425 struct uvc_video_queue {
 426         struct vb2_queue queue;
 427         struct mutex mutex;                     /* Protects queue */
 428
 429         unsigned int flags;
 430         unsigned int buf_used;
 431
 432         spinlock_t irqlock;                     /* Protects irqqueue */
 433         struct list_head irqqueue;
 434 };
 435
 436 struct uvc_video_chain {
 437         struct uvc_device *dev;
 438         struct list_head list;
 439
 440         struct list_head entities;              /* All entities */
 441         struct uvc_entity *processing;          /* Processing unit */
 442         struct uvc_entity *selector;            /* Selector unit */
 443
 444         struct mutex ctrl_mutex;                /* Protects ctrl.info */
 445
 446         struct v4l2_prio_state prio;            /* V4L2 priority state */
 447         u32 caps;                               /* V4L2 chain-wide caps */
 448 };
 449
 450 struct uvc_stats_frame {
 451         unsigned int size;              /* Number of bytes captured */
 452         unsigned int first_data;        /* Index of the first non-empty packet */
 453
 454         unsigned int nb_packets;        /* Number of packets */
 455         unsigned int nb_empty;          /* Number of empty packets */
 456         unsigned int nb_invalid;        /* Number of packets with an invalid header */
 457         unsigned int nb_errors;         /* Number of packets with the error bit set */
 458
 459         unsigned int nb_pts;            /* Number of packets with a PTS timestamp */
 460         unsigned int nb_pts_diffs;      /* Number of PTS differences inside a frame */
 461         unsigned int last_pts_diff;     /* Index of the last PTS difference */
 462         bool has_initial_pts;           /* Whether the first non-empty packet has a PTS */
 463         bool has_early_pts;             /* Whether a PTS is present before the first non-empty packet */
 464         u32 pts;                        /* PTS of the last packet */
 465
 466         unsigned int nb_scr;            /* Number of packets with a SCR timestamp */
 467         unsigned int nb_scr_diffs;      /* Number of SCR.STC differences inside a frame */
 468         u16 scr_sof;                    /* SCR.SOF of the last packet */
 469         u32 scr_stc;                    /* SCR.STC of the last packet */
 470 };
 471
 472 struct uvc_stats_stream {
 473         ktime_t start_ts;               /* Stream start timestamp */
 474         ktime_t stop_ts;                /* Stream stop timestamp */
 475
 476         unsigned int nb_frames;         /* Number of frames */
 477
 478         unsigned int nb_packets;        /* Number of packets */
 479         unsigned int nb_empty;          /* Number of empty packets */
 480         unsigned int nb_invalid;        /* Number of packets with an invalid header */
 481         unsigned int nb_errors;         /* Number of packets with the error bit set */
 482
 483         unsigned int nb_pts_constant;   /* Number of frames with constant PTS */
 484         unsigned int nb_pts_early;      /* Number of frames with early PTS */
 485         unsigned int nb_pts_initial;    /* Number of frames with initial PTS */
 486
 487         unsigned int nb_scr_count_ok;   /* Number of frames with at least one SCR per non empty packet */
 488         unsigned int nb_scr_diffs_ok;   /* Number of frames with varying SCR.STC */
 489         unsigned int scr_sof_count;     /* STC.SOF counter accumulated since stream start */
 490         unsigned int scr_sof;           /* STC.SOF of the last packet */
 491         unsigned int min_sof;           /* Minimum STC.SOF value */
 492         unsigned int max_sof;           /* Maximum STC.SOF value */
 493 };
 494
 495 #define UVC_METATADA_BUF_SIZE 1024
 496
 497 /**
 498  * struct uvc_copy_op: Context structure to schedule asynchronous memcpy
 499  *
 500  * @buf: active buf object for this operation
 501  * @dst: copy destination address
 502  * @src: copy source address
 503  * @len: copy length
 504  */
 505 struct uvc_copy_op {
 506         struct uvc_buffer *buf;
 507         void *dst;
 508         const __u8 *src;
 509         size_t len;
 510 };
 511
 512 /**
 513  * struct uvc_urb - URB context management structure
 514  *
 515  * @urb: the URB described by this context structure
 516  * @stream: UVC streaming context
 517  * @buffer: memory storage for the URB
 518  * @dma: DMA coherent addressing for the urb_buffer
 519  * @async_operations: counter to indicate the number of copy operations
 520  * @copy_operations: work descriptors for asynchronous copy operations
 521  * @work: work queue entry for asynchronous decode
 522  */
 523 struct uvc_urb {
 524         struct urb *urb;
 525         struct uvc_streaming *stream;
 526
 527         char *buffer;
 528         dma_addr_t dma;
 529
 530         unsigned int async_operations;
 531         struct uvc_copy_op copy_operations[UVC_MAX_PACKETS];
 532         struct work_struct work;
 533 };
 534
 535 struct uvc_streaming {
 536         struct list_head list;
 537         struct uvc_device *dev;
 538         struct video_device vdev;
 539         struct uvc_video_chain *chain;
 540         atomic_t active;
 541
 542         struct usb_interface *intf;
 543         int intfnum;
 544         u16 maxpsize;
 545
 546         struct uvc_streaming_header header;
 547         enum v4l2_buf_type type;
 548
 549         unsigned int nformats;
 550         struct uvc_format *format;
 551
 552         struct uvc_streaming_control ctrl;
 553         struct uvc_format *def_format;
 554         struct uvc_format *cur_format;
 555         struct uvc_frame *cur_frame;
 556
 557         /* Protect access to ctrl, cur_format, cur_frame and hardware video
 558          * probe control.
 559          */
 560         struct mutex mutex;
 561
 562         /* Buffers queue. */
 563         unsigned int frozen : 1;
 564         struct uvc_video_queue queue;
 565         struct workqueue_struct *async_wq;
 566         void (*decode)(struct uvc_urb *uvc_urb, struct uvc_buffer *buf,
 567                        struct uvc_buffer *meta_buf);
 568
 569         struct {
 570                 struct video_device vdev;
 571                 struct uvc_video_queue queue;
 572                 u32 format;
 573         } meta;
 574
 575         /* Context data used by the bulk completion handler. */
 576         struct {
 577                 u8 header[256];
 578                 unsigned int header_size;
 579                 int skip_payload;
 580                 u32 payload_size;
 581                 u32 max_payload_size;
 582         } bulk;
 583
 584         struct uvc_urb uvc_urb[UVC_URBS];
 585         unsigned int urb_size;
 586
 587         u32 sequence;
 588         u8 last_fid;
 589
 590         /* debugfs */
 591         struct dentry *debugfs_dir;
 592         struct {
 593                 struct uvc_stats_frame frame;
 594                 struct uvc_stats_stream stream;
 595         } stats;
 596
 597         /* Timestamps support. */
 598         struct uvc_clock {
 599                 struct uvc_clock_sample {
 600                         u32 dev_stc;
 601                         u16 dev_sof;
 602                         u16 host_sof;
 603                         ktime_t host_time;
 604                 } *samples;
 605
 606                 unsigned int head;
 607                 unsigned int count;
 608                 unsigned int size;
 609
 610                 u16 last_sof;
 611                 u16 sof_offset;
 612
 613                 u8 last_scr[6];
 614
 615                 spinlock_t lock;
 616         } clock;
 617 };
 618
 619 #define for_each_uvc_urb(uvc_urb, uvc_streaming) \
 620         for ((uvc_urb) = &(uvc_streaming)->uvc_urb[0]; \
 621              (uvc_urb) < &(uvc_streaming)->uvc_urb[UVC_URBS]; \
 622              ++(uvc_urb))
 623
 624 static inline u32 uvc_urb_index(const struct uvc_urb *uvc_urb)
 625 {
 626         return uvc_urb - &uvc_urb->stream->uvc_urb[0];
 627 }
 628
 629 struct uvc_device_info {
 630         u32     quirks;
 631         u32     meta_format;
 632 };
 633
 634 struct uvc_device {
 635         struct usb_device *udev;
 636         struct usb_interface *intf;
 637         unsigned long warnings;
 638         u32 quirks;
 639         int intfnum;
 640         char name[32];
 641
 642         const struct uvc_device_info *info;
 643
 644         struct mutex lock;              /* Protects users */
 645         unsigned int users;
 646         atomic_t nmappings;
 647
 648         /* Video control interface */
 649 #ifdef CONFIG_MEDIA_CONTROLLER
 650         struct media_device mdev;
 651 #endif
 652         struct v4l2_device vdev;
 653         u16 uvc_version;
 654         u32 clock_frequency;
 655
 656         struct list_head entities;
 657         struct list_head chains;
 658
 659         /* Video Streaming interfaces */
 660         struct list_head streams;
 661         struct kref ref;
 662
 663         /* Status Interrupt Endpoint */
 664         struct usb_host_endpoint *int_ep;
 665         struct urb *int_urb;
 666         u8 *status;
 667         struct input_dev *input;
 668         char input_phys[64];
 669
 670         struct uvc_ctrl_work {
 671                 struct work_struct work;
 672                 struct urb *urb;
 673                 struct uvc_video_chain *chain;
 674                 struct uvc_control *ctrl;
 675                 const void *data;
 676         } async_ctrl;
 677 };
 678
 679 enum uvc_handle_state {
 680         UVC_HANDLE_PASSIVE      = 0,
 681         UVC_HANDLE_ACTIVE       = 1,
 682 };
 683
 684 struct uvc_fh {
 685         struct v4l2_fh vfh;
 686         struct uvc_video_chain *chain;
 687         struct uvc_streaming *stream;
 688         enum uvc_handle_state state;
 689 };
 690
 691 struct uvc_driver {
 692         struct usb_driver driver;
 693 };
 694
 695 /* ------------------------------------------------------------------------
 696  * Debugging, printing and logging
 697  */
 698
 699 #define UVC_TRACE_PROBE         (1 << 0)
 700 #define UVC_TRACE_DESCR         (1 << 1)
 701 #define UVC_TRACE_CONTROL       (1 << 2)
 702 #define UVC_TRACE_FORMAT        (1 << 3)
 703 #define UVC_TRACE_CAPTURE       (1 << 4)
 704 #define UVC_TRACE_CALLS         (1 << 5)
 705 #define UVC_TRACE_FRAME         (1 << 7)
 706 #define UVC_TRACE_SUSPEND       (1 << 8)
 707 #define UVC_TRACE_STATUS        (1 << 9)
 708 #define UVC_TRACE_VIDEO         (1 << 10)
 709 #define UVC_TRACE_STATS         (1 << 11)
 710 #define UVC_TRACE_CLOCK         (1 << 12)
 711
 712 #define UVC_WARN_MINMAX         0
 713 #define UVC_WARN_PROBE_DEF      1
 714 #define UVC_WARN_XU_GET_RES     2
 715
 716 extern unsigned int uvc_clock_param;
 717 extern unsigned int uvc_no_drop_param;
 718 extern unsigned int uvc_trace_param;
 719 extern unsigned int uvc_timeout_param;
 720 extern unsigned int uvc_hw_timestamps_param;
 721
 722 #define uvc_trace(flag, msg...) \
 723         do { \
 724                 if (uvc_trace_param & flag) \
 725                         printk(KERN_DEBUG "uvcvideo: " msg); \
 726         } while (0)
 727
 728 #define uvc_warn_once(dev, warn, msg...) \
 729         do { \
 730                 if (!test_and_set_bit(warn, &dev->warnings)) \
 731                         printk(KERN_INFO "uvcvideo: " msg); \
 732         } while (0)
 733
 734 #define uvc_printk(level, msg...) \
 735         printk(level "uvcvideo: " msg)
 736
 737 /* --------------------------------------------------------------------------
 738  * Internal functions.
 739  */
 740
 741 /* Core driver */
 742 extern struct uvc_driver uvc_driver;
 743
 744 struct uvc_entity *uvc_entity_by_id(struct uvc_device *dev, int id);
 745
 746 /* Video buffers queue management. */
 747 int uvc_queue_init(struct uvc_video_queue *queue, enum v4l2_buf_type type,
 748                    int drop_corrupted);
 749 void uvc_queue_release(struct uvc_video_queue *queue);
 750 int uvc_request_buffers(struct uvc_video_queue *queue,
 751                         struct v4l2_requestbuffers *rb);
 752 int uvc_query_buffer(struct uvc_video_queue *queue,
 753                      struct v4l2_buffer *v4l2_buf);
 754 int uvc_create_buffers(struct uvc_video_queue *queue,
 755                        struct v4l2_create_buffers *v4l2_cb);
 756 int uvc_queue_buffer(struct uvc_video_queue *queue,
 757                      struct media_device *mdev,
 758                      struct v4l2_buffer *v4l2_buf);
 759 int uvc_export_buffer(struct uvc_video_queue *queue,
 760                       struct v4l2_exportbuffer *exp);
 761 int uvc_dequeue_buffer(struct uvc_video_queue *queue,
 762                        struct v4l2_buffer *v4l2_buf, int nonblocking);
 763 int uvc_queue_streamon(struct uvc_video_queue *queue, enum v4l2_buf_type type);
 764 int uvc_queue_streamoff(struct uvc_video_queue *queue, enum v4l2_buf_type type);
 765 void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect);
 766 struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue,
 767                                          struct uvc_buffer *buf);
 768 struct uvc_buffer *uvc_queue_get_current_buffer(struct uvc_video_queue *queue);
 769 void uvc_queue_buffer_release(struct uvc_buffer *buf);
 770 int uvc_queue_mmap(struct uvc_video_queue *queue,
 771                    struct vm_area_struct *vma);
 772 __poll_t uvc_queue_poll(struct uvc_video_queue *queue, struct file *file,
 773                         poll_table *wait);
 774 #ifndef CONFIG_MMU
 775 unsigned long uvc_queue_get_unmapped_area(struct uvc_video_queue *queue,
 776                                           unsigned long pgoff);
 777 #endif
 778 int uvc_queue_allocated(struct uvc_video_queue *queue);
 779 static inline int uvc_queue_streaming(struct uvc_video_queue *queue)
 780 {
 781         return vb2_is_streaming(&queue->queue);
 782 }
 783
 784 /* V4L2 interface */
 785 extern const struct v4l2_ioctl_ops uvc_ioctl_ops;
 786 extern const struct v4l2_file_operations uvc_fops;
 787
 788 /* Media controller */
 789 int uvc_mc_register_entities(struct uvc_video_chain *chain);
 790 void uvc_mc_cleanup_entity(struct uvc_entity *entity);
 791
 792 /* Video */
 793 int uvc_video_init(struct uvc_streaming *stream);
 794 int uvc_video_suspend(struct uvc_streaming *stream);
 795 int uvc_video_resume(struct uvc_streaming *stream, int reset);
 796 int uvc_video_start_streaming(struct uvc_streaming *stream);
 797 void uvc_video_stop_streaming(struct uvc_streaming *stream);
 798 int uvc_probe_video(struct uvc_streaming *stream,
 799                     struct uvc_streaming_control *probe);
 800 int uvc_query_ctrl(struct uvc_device *dev, u8 query, u8 unit,
 801                    u8 intfnum, u8 cs, void *data, u16 size);
 802 void uvc_video_clock_update(struct uvc_streaming *stream,
 803                             struct vb2_v4l2_buffer *vbuf,
 804                             struct uvc_buffer *buf);
 805 int uvc_meta_register(struct uvc_streaming *stream);
 806
 807 int uvc_register_video_device(struct uvc_device *dev,
 808                               struct uvc_streaming *stream,
 809                               struct video_device *vdev,
 810                               struct uvc_video_queue *queue,
 811                               enum v4l2_buf_type type,
 812                               const struct v4l2_file_operations *fops,
 813                               const struct v4l2_ioctl_ops *ioctl_ops);
 814
 815 /* Status */
 816 int uvc_status_init(struct uvc_device *dev);
 817 void uvc_status_unregister(struct uvc_device *dev);
 818 void uvc_status_cleanup(struct uvc_device *dev);
 819 int uvc_status_start(struct uvc_device *dev, gfp_t flags);
 820 void uvc_status_stop(struct uvc_device *dev);
 821
 822 /* Controls */
 823 extern const struct v4l2_subscribed_event_ops uvc_ctrl_sub_ev_ops;
 824
 825 int uvc_query_v4l2_ctrl(struct uvc_video_chain *chain,
 826                         struct v4l2_queryctrl *v4l2_ctrl);
 827 int uvc_query_v4l2_menu(struct uvc_video_chain *chain,
 828                         struct v4l2_querymenu *query_menu);
 829
 830 int uvc_ctrl_add_mapping(struct uvc_video_chain *chain,
 831                          const struct uvc_control_mapping *mapping);
 832 int uvc_ctrl_init_device(struct uvc_device *dev);
 833 void uvc_ctrl_cleanup_device(struct uvc_device *dev);
 834 int uvc_ctrl_restore_values(struct uvc_device *dev);
 835 bool uvc_ctrl_status_event(struct urb *urb, struct uvc_video_chain *chain,
 836                            struct uvc_control *ctrl, const u8 *data);
 837
 838 int uvc_ctrl_begin(struct uvc_video_chain *chain);
 839 int __uvc_ctrl_commit(struct uvc_fh *handle, int rollback,
 840                       const struct v4l2_ext_control *xctrls,
 841                       unsigned int xctrls_count);
 842 static inline int uvc_ctrl_commit(struct uvc_fh *handle,
 843                                   const struct v4l2_ext_control *xctrls,
 844                                   unsigned int xctrls_count)
 845 {
 846         return __uvc_ctrl_commit(handle, 0, xctrls, xctrls_count);
 847 }
 848 static inline int uvc_ctrl_rollback(struct uvc_fh *handle)
 849 {
 850         return __uvc_ctrl_commit(handle, 1, NULL, 0);
 851 }
 852
 853 int uvc_ctrl_get(struct uvc_video_chain *chain, struct v4l2_ext_control *xctrl);
 854 int uvc_ctrl_set(struct uvc_fh *handle, struct v4l2_ext_control *xctrl);
 855
 856 int uvc_xu_ctrl_query(struct uvc_video_chain *chain,
 857                       struct uvc_xu_control_query *xqry);
 858
 859 /* Utility functions */
 860 void uvc_simplify_fraction(u32 *numerator, u32 *denominator,
 861                            unsigned int n_terms, unsigned int threshold);
 862 u32 uvc_fraction_to_interval(u32 numerator, u32 denominator);
 863 struct usb_host_endpoint *uvc_find_endpoint(struct usb_host_interface *alts,
 864                                             u8 epaddr);
 865
 866 /* Quirks support */
 867 void uvc_video_decode_isight(struct uvc_urb *uvc_urb,
 868                              struct uvc_buffer *buf,
 869                              struct uvc_buffer *meta_buf);
 870
 871 /* debugfs and statistics */
 872 void uvc_debugfs_init(void);
 873 void uvc_debugfs_cleanup(void);
 874 void uvc_debugfs_init_stream(struct uvc_streaming *stream);
 875 void uvc_debugfs_cleanup_stream(struct uvc_streaming *stream);
 876
 877 size_t uvc_video_stats_dump(struct uvc_streaming *stream, char *buf,
 878                             size_t size);
 879
 880 #endif