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