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