5 #error "The uvcvideo.h header is deprecated, use linux/uvcvideo.h instead."
6 #endif /* __KERNEL__ */
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>
20 /* --------------------------------------------------------------------------
24 #define UVC_TERM_INPUT 0x0000
25 #define UVC_TERM_OUTPUT 0x8000
26 #define UVC_TERM_DIRECTION(term) ((term)->type & 0x8000)
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)
39 /* ------------------------------------------------------------------------
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}
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_RGBP \
98 { 'R', 'G', 'B', 'P', 0x00, 0x00, 0x10, 0x00, \
99 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
100 #define UVC_GUID_FORMAT_M420 \
101 { 'M', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \
102 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
104 #define UVC_GUID_FORMAT_H264 \
105 { 'H', '2', '6', '4', 0x00, 0x00, 0x10, 0x00, \
106 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
108 /* ------------------------------------------------------------------------
109 * Driver specific constants.
112 #define DRIVER_VERSION "1.1.1"
114 /* Number of isochronous URBs. */
116 /* Maximum number of packets per URB. */
117 #define UVC_MAX_PACKETS 32
118 /* Maximum number of video buffers. */
119 #define UVC_MAX_VIDEO_BUFFERS 32
120 /* Maximum status buffer size in bytes of interrupt URB. */
121 #define UVC_MAX_STATUS_SIZE 16
123 #define UVC_CTRL_CONTROL_TIMEOUT 300
124 #define UVC_CTRL_STREAMING_TIMEOUT 5000
126 /* Maximum allowed number of control mappings per device */
127 #define UVC_MAX_CONTROL_MAPPINGS 1024
128 #define UVC_MAX_CONTROL_MENU_ENTRIES 32
131 #define UVC_QUIRK_STATUS_INTERVAL 0x00000001
132 #define UVC_QUIRK_PROBE_MINMAX 0x00000002
133 #define UVC_QUIRK_PROBE_EXTRAFIELDS 0x00000004
134 #define UVC_QUIRK_BUILTIN_ISIGHT 0x00000008
135 #define UVC_QUIRK_STREAM_NO_FID 0x00000010
136 #define UVC_QUIRK_IGNORE_SELECTOR_UNIT 0x00000020
137 #define UVC_QUIRK_FIX_BANDWIDTH 0x00000080
138 #define UVC_QUIRK_PROBE_DEF 0x00000100
139 #define UVC_QUIRK_RESTRICT_FRAME_RATE 0x00000200
142 #define UVC_FMT_FLAG_COMPRESSED 0x00000001
143 #define UVC_FMT_FLAG_STREAM 0x00000002
145 /* ------------------------------------------------------------------------
151 /* TODO: Put the most frequently accessed fields at the beginning of
152 * structures to maximize cache efficiency.
154 struct uvc_control_info {
155 struct list_head mappings;
158 __u8 index; /* Bit index in bmControls */
165 struct uvc_control_mapping {
166 struct list_head list;
167 struct list_head ev_subs;
176 enum v4l2_ctrl_type v4l2_type;
179 struct uvc_menu_info *menu_info;
186 __s32 (*get) (struct uvc_control_mapping *mapping, __u8 query,
188 void (*set) (struct uvc_control_mapping *mapping, __s32 value,
193 struct uvc_entity *entity;
194 struct uvc_control_info info;
196 __u8 index; /* Used to match the uvc_control entry with a
207 struct uvc_format_desc {
213 /* The term 'entity' refers to both UVC units and UVC terminals.
215 * The type field is either the terminal type (wTerminalType in the terminal
216 * descriptor), or the unit type (bDescriptorSubtype in the unit descriptor).
217 * As the bDescriptorSubtype field is one byte long, the type value will
218 * always have a null MSB for units. All terminal types defined by the UVC
219 * specification have a non-null MSB, so it is safe to use the MSB to
220 * differentiate between units and terminals as long as the descriptor parsing
221 * code makes sure terminal types have a non-null MSB.
223 * For terminals, the type's most significant bit stores the terminal
224 * direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should
225 * always be accessed with the UVC_ENTITY_* macros and never directly.
229 struct list_head list; /* Entity as part of a UVC device. */
230 struct list_head chain; /* Entity as part of a video device
236 /* Media controller-related fields. */
237 struct video_device *vdev;
238 struct v4l2_subdev subdev;
239 unsigned int num_pads;
240 unsigned int num_links;
241 struct media_pad *pads;
245 __u16 wObjectiveFocalLengthMin;
246 __u16 wObjectiveFocalLengthMax;
247 __u16 wOcularFocalLength;
255 __u8 bTransportModeSize;
256 __u8 *bmTransportModes;
263 __u16 wMaxMultiplier;
266 __u8 bmVideoStandards;
273 __u8 guidExtensionCode[16];
277 __u8 *bmControlsType;
284 unsigned int ncontrols;
285 struct uvc_control *controls;
295 __u32 dwMaxVideoFrameBufferSize;
296 __u8 bFrameIntervalType;
297 __u32 dwDefaultFrameInterval;
298 __u32 *dwFrameInterval;
311 unsigned int nframes;
312 struct uvc_frame *frame;
315 struct uvc_streaming_header {
317 __u8 bEndpointAddress;
321 /* The following fields are used by input headers only. */
323 __u8 bStillCaptureMethod;
324 __u8 bTriggerSupport;
328 enum uvc_buffer_state {
329 UVC_BUF_STATE_IDLE = 0,
330 UVC_BUF_STATE_QUEUED = 1,
331 UVC_BUF_STATE_ACTIVE = 2,
332 UVC_BUF_STATE_READY = 3,
333 UVC_BUF_STATE_DONE = 4,
334 UVC_BUF_STATE_ERROR = 5,
338 struct vb2_buffer buf;
339 struct list_head queue;
341 enum uvc_buffer_state state;
346 unsigned int bytesused;
351 #define UVC_QUEUE_DISCONNECTED (1 << 0)
352 #define UVC_QUEUE_DROP_CORRUPTED (1 << 1)
354 struct uvc_video_queue {
355 struct vb2_queue queue;
356 struct mutex mutex; /* Protects queue */
359 unsigned int buf_used;
361 spinlock_t irqlock; /* Protects irqqueue */
362 struct list_head irqqueue;
365 struct uvc_video_chain {
366 struct uvc_device *dev;
367 struct list_head list;
369 struct list_head entities; /* All entities */
370 struct uvc_entity *processing; /* Processing unit */
371 struct uvc_entity *selector; /* Selector unit */
373 struct mutex ctrl_mutex; /* Protects ctrl.info */
376 struct uvc_stats_frame {
377 unsigned int size; /* Number of bytes captured */
378 unsigned int first_data; /* Index of the first non-empty packet */
380 unsigned int nb_packets; /* Number of packets */
381 unsigned int nb_empty; /* Number of empty packets */
382 unsigned int nb_invalid; /* Number of packets with an invalid header */
383 unsigned int nb_errors; /* Number of packets with the error bit set */
385 unsigned int nb_pts; /* Number of packets with a PTS timestamp */
386 unsigned int nb_pts_diffs; /* Number of PTS differences inside a frame */
387 unsigned int last_pts_diff; /* Index of the last PTS difference */
388 bool has_initial_pts; /* Whether the first non-empty packet has a PTS */
389 bool has_early_pts; /* Whether a PTS is present before the first non-empty packet */
390 u32 pts; /* PTS of the last packet */
392 unsigned int nb_scr; /* Number of packets with a SCR timestamp */
393 unsigned int nb_scr_diffs; /* Number of SCR.STC differences inside a frame */
394 u16 scr_sof; /* SCR.SOF of the last packet */
395 u32 scr_stc; /* SCR.STC of the last packet */
398 struct uvc_stats_stream {
399 struct timespec start_ts; /* Stream start timestamp */
400 struct timespec stop_ts; /* Stream stop timestamp */
402 unsigned int nb_frames; /* Number of frames */
404 unsigned int nb_packets; /* Number of packets */
405 unsigned int nb_empty; /* Number of empty packets */
406 unsigned int nb_invalid; /* Number of packets with an invalid header */
407 unsigned int nb_errors; /* Number of packets with the error bit set */
409 unsigned int nb_pts_constant; /* Number of frames with constant PTS */
410 unsigned int nb_pts_early; /* Number of frames with early PTS */
411 unsigned int nb_pts_initial; /* Number of frames with initial PTS */
413 unsigned int nb_scr_count_ok; /* Number of frames with at least one SCR per non empty packet */
414 unsigned int nb_scr_diffs_ok; /* Number of frames with varying SCR.STC */
415 unsigned int scr_sof_count; /* STC.SOF counter accumulated since stream start */
416 unsigned int scr_sof; /* STC.SOF of the last packet */
417 unsigned int min_sof; /* Minimum STC.SOF value */
418 unsigned int max_sof; /* Maximum STC.SOF value */
421 struct uvc_streaming {
422 struct list_head list;
423 struct uvc_device *dev;
424 struct video_device *vdev;
425 struct uvc_video_chain *chain;
428 struct usb_interface *intf;
432 struct uvc_streaming_header header;
433 enum v4l2_buf_type type;
435 unsigned int nformats;
436 struct uvc_format *format;
438 struct uvc_streaming_control ctrl;
439 struct uvc_format *cur_format;
440 struct uvc_frame *cur_frame;
441 /* Protect access to ctrl, cur_format, cur_frame and hardware video
447 unsigned int frozen : 1;
448 struct uvc_video_queue queue;
449 void (*decode) (struct urb *urb, struct uvc_streaming *video,
450 struct uvc_buffer *buf);
452 /* Context data used by the bulk completion handler. */
455 unsigned int header_size;
458 __u32 max_payload_size;
461 struct urb *urb[UVC_URBS];
462 char *urb_buffer[UVC_URBS];
463 dma_addr_t urb_dma[UVC_URBS];
464 unsigned int urb_size;
470 struct dentry *debugfs_dir;
472 struct uvc_stats_frame frame;
473 struct uvc_stats_stream stream;
476 /* Timestamps support. */
478 struct uvc_clock_sample {
481 struct timespec host_ts;
496 enum uvc_device_state {
497 UVC_DEV_DISCONNECTED = 1,
501 struct usb_device *udev;
502 struct usb_interface *intf;
503 unsigned long warnings;
508 enum uvc_device_state state;
512 /* Video control interface */
513 #ifdef CONFIG_MEDIA_CONTROLLER
514 struct media_device mdev;
516 struct v4l2_device vdev;
518 __u32 clock_frequency;
520 struct list_head entities;
521 struct list_head chains;
523 /* Video Streaming interfaces */
524 struct list_head streams;
527 /* Status Interrupt Endpoint */
528 struct usb_host_endpoint *int_ep;
531 struct input_dev *input;
535 enum uvc_handle_state {
536 UVC_HANDLE_PASSIVE = 0,
537 UVC_HANDLE_ACTIVE = 1,
542 struct uvc_video_chain *chain;
543 struct uvc_streaming *stream;
544 enum uvc_handle_state state;
548 struct usb_driver driver;
551 /* ------------------------------------------------------------------------
552 * Debugging, printing and logging
555 #define UVC_TRACE_PROBE (1 << 0)
556 #define UVC_TRACE_DESCR (1 << 1)
557 #define UVC_TRACE_CONTROL (1 << 2)
558 #define UVC_TRACE_FORMAT (1 << 3)
559 #define UVC_TRACE_CAPTURE (1 << 4)
560 #define UVC_TRACE_CALLS (1 << 5)
561 #define UVC_TRACE_IOCTL (1 << 6)
562 #define UVC_TRACE_FRAME (1 << 7)
563 #define UVC_TRACE_SUSPEND (1 << 8)
564 #define UVC_TRACE_STATUS (1 << 9)
565 #define UVC_TRACE_VIDEO (1 << 10)
566 #define UVC_TRACE_STATS (1 << 11)
567 #define UVC_TRACE_CLOCK (1 << 12)
569 #define UVC_WARN_MINMAX 0
570 #define UVC_WARN_PROBE_DEF 1
571 #define UVC_WARN_XU_GET_RES 2
573 extern unsigned int uvc_clock_param;
574 extern unsigned int uvc_no_drop_param;
575 extern unsigned int uvc_trace_param;
576 extern unsigned int uvc_timeout_param;
578 #define uvc_trace(flag, msg...) \
580 if (uvc_trace_param & flag) \
581 printk(KERN_DEBUG "uvcvideo: " msg); \
584 #define uvc_warn_once(dev, warn, msg...) \
586 if (!test_and_set_bit(warn, &dev->warnings)) \
587 printk(KERN_INFO "uvcvideo: " msg); \
590 #define uvc_printk(level, msg...) \
591 printk(level "uvcvideo: " msg)
593 /* --------------------------------------------------------------------------
594 * Internal functions.
598 extern struct uvc_driver uvc_driver;
600 extern struct uvc_entity *uvc_entity_by_id(struct uvc_device *dev, int id);
602 /* Video buffers queue management. */
603 extern void uvc_queue_init(struct uvc_video_queue *queue,
604 enum v4l2_buf_type type, int drop_corrupted);
605 extern int uvc_alloc_buffers(struct uvc_video_queue *queue,
606 struct v4l2_requestbuffers *rb);
607 extern void uvc_free_buffers(struct uvc_video_queue *queue);
608 extern int uvc_query_buffer(struct uvc_video_queue *queue,
609 struct v4l2_buffer *v4l2_buf);
610 extern int uvc_queue_buffer(struct uvc_video_queue *queue,
611 struct v4l2_buffer *v4l2_buf);
612 extern int uvc_dequeue_buffer(struct uvc_video_queue *queue,
613 struct v4l2_buffer *v4l2_buf, int nonblocking);
614 extern int uvc_queue_enable(struct uvc_video_queue *queue, int enable);
615 extern void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect);
616 extern struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue,
617 struct uvc_buffer *buf);
618 extern int uvc_queue_mmap(struct uvc_video_queue *queue,
619 struct vm_area_struct *vma);
620 extern unsigned int uvc_queue_poll(struct uvc_video_queue *queue,
621 struct file *file, poll_table *wait);
623 extern unsigned long uvc_queue_get_unmapped_area(struct uvc_video_queue *queue,
624 unsigned long pgoff);
626 extern int uvc_queue_allocated(struct uvc_video_queue *queue);
627 static inline int uvc_queue_streaming(struct uvc_video_queue *queue)
629 return vb2_is_streaming(&queue->queue);
633 extern const struct v4l2_file_operations uvc_fops;
635 /* Media controller */
636 extern int uvc_mc_register_entities(struct uvc_video_chain *chain);
637 extern void uvc_mc_cleanup_entity(struct uvc_entity *entity);
640 extern int uvc_video_init(struct uvc_streaming *stream);
641 extern int uvc_video_suspend(struct uvc_streaming *stream);
642 extern int uvc_video_resume(struct uvc_streaming *stream, int reset);
643 extern int uvc_video_enable(struct uvc_streaming *stream, int enable);
644 extern int uvc_probe_video(struct uvc_streaming *stream,
645 struct uvc_streaming_control *probe);
646 extern int uvc_query_ctrl(struct uvc_device *dev, __u8 query, __u8 unit,
647 __u8 intfnum, __u8 cs, void *data, __u16 size);
648 void uvc_video_clock_update(struct uvc_streaming *stream,
649 struct v4l2_buffer *v4l2_buf,
650 struct uvc_buffer *buf);
653 extern int uvc_status_init(struct uvc_device *dev);
654 extern void uvc_status_cleanup(struct uvc_device *dev);
655 extern int uvc_status_start(struct uvc_device *dev);
656 extern void uvc_status_stop(struct uvc_device *dev);
657 extern int uvc_status_suspend(struct uvc_device *dev);
658 extern int uvc_status_resume(struct uvc_device *dev);
661 extern const struct v4l2_subscribed_event_ops uvc_ctrl_sub_ev_ops;
663 extern int uvc_query_v4l2_ctrl(struct uvc_video_chain *chain,
664 struct v4l2_queryctrl *v4l2_ctrl);
665 extern int uvc_query_v4l2_menu(struct uvc_video_chain *chain,
666 struct v4l2_querymenu *query_menu);
668 extern int uvc_ctrl_add_mapping(struct uvc_video_chain *chain,
669 const struct uvc_control_mapping *mapping);
670 extern int uvc_ctrl_init_device(struct uvc_device *dev);
671 extern void uvc_ctrl_cleanup_device(struct uvc_device *dev);
672 extern int uvc_ctrl_resume_device(struct uvc_device *dev);
674 extern int uvc_ctrl_begin(struct uvc_video_chain *chain);
675 extern int __uvc_ctrl_commit(struct uvc_fh *handle, int rollback,
676 const struct v4l2_ext_control *xctrls,
677 unsigned int xctrls_count);
678 static inline int uvc_ctrl_commit(struct uvc_fh *handle,
679 const struct v4l2_ext_control *xctrls,
680 unsigned int xctrls_count)
682 return __uvc_ctrl_commit(handle, 0, xctrls, xctrls_count);
684 static inline int uvc_ctrl_rollback(struct uvc_fh *handle)
686 return __uvc_ctrl_commit(handle, 1, NULL, 0);
689 extern int uvc_ctrl_get(struct uvc_video_chain *chain,
690 struct v4l2_ext_control *xctrl);
691 extern int uvc_ctrl_set(struct uvc_video_chain *chain,
692 struct v4l2_ext_control *xctrl);
694 extern int uvc_xu_ctrl_query(struct uvc_video_chain *chain,
695 struct uvc_xu_control_query *xqry);
697 /* Utility functions */
698 extern void uvc_simplify_fraction(uint32_t *numerator, uint32_t *denominator,
699 unsigned int n_terms, unsigned int threshold);
700 extern uint32_t uvc_fraction_to_interval(uint32_t numerator,
701 uint32_t denominator);
702 extern struct usb_host_endpoint *uvc_find_endpoint(
703 struct usb_host_interface *alts, __u8 epaddr);
706 void uvc_video_decode_isight(struct urb *urb, struct uvc_streaming *stream,
707 struct uvc_buffer *buf);
709 /* debugfs and statistics */
710 int uvc_debugfs_init(void);
711 void uvc_debugfs_cleanup(void);
712 int uvc_debugfs_init_stream(struct uvc_streaming *stream);
713 void uvc_debugfs_cleanup_stream(struct uvc_streaming *stream);
715 size_t uvc_video_stats_dump(struct uvc_streaming *stream, char *buf,