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