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_Y16 \
83 { 'Y', '1', '6', ' ', 0x00, 0x00, 0x10, 0x00, \
84 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
85 #define UVC_GUID_FORMAT_BY8 \
86 { 'B', 'Y', '8', ' ', 0x00, 0x00, 0x10, 0x00, \
87 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
88 #define UVC_GUID_FORMAT_RGBP \
89 { 'R', 'G', 'B', 'P', 0x00, 0x00, 0x10, 0x00, \
90 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
91 #define UVC_GUID_FORMAT_M420 \
92 { 'M', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \
93 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
95 #define UVC_GUID_FORMAT_H264 \
96 { 'H', '2', '6', '4', 0x00, 0x00, 0x10, 0x00, \
97 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
99 /* ------------------------------------------------------------------------
100 * Driver specific constants.
103 #define DRIVER_VERSION "1.1.1"
105 /* Number of isochronous URBs. */
107 /* Maximum number of packets per URB. */
108 #define UVC_MAX_PACKETS 32
109 /* Maximum number of video buffers. */
110 #define UVC_MAX_VIDEO_BUFFERS 32
111 /* Maximum status buffer size in bytes of interrupt URB. */
112 #define UVC_MAX_STATUS_SIZE 16
114 #define UVC_CTRL_CONTROL_TIMEOUT 300
115 #define UVC_CTRL_STREAMING_TIMEOUT 5000
117 /* Maximum allowed number of control mappings per device */
118 #define UVC_MAX_CONTROL_MAPPINGS 1024
119 #define UVC_MAX_CONTROL_MENU_ENTRIES 32
122 #define UVC_QUIRK_STATUS_INTERVAL 0x00000001
123 #define UVC_QUIRK_PROBE_MINMAX 0x00000002
124 #define UVC_QUIRK_PROBE_EXTRAFIELDS 0x00000004
125 #define UVC_QUIRK_BUILTIN_ISIGHT 0x00000008
126 #define UVC_QUIRK_STREAM_NO_FID 0x00000010
127 #define UVC_QUIRK_IGNORE_SELECTOR_UNIT 0x00000020
128 #define UVC_QUIRK_FIX_BANDWIDTH 0x00000080
129 #define UVC_QUIRK_PROBE_DEF 0x00000100
130 #define UVC_QUIRK_RESTRICT_FRAME_RATE 0x00000200
133 #define UVC_FMT_FLAG_COMPRESSED 0x00000001
134 #define UVC_FMT_FLAG_STREAM 0x00000002
136 /* ------------------------------------------------------------------------
142 /* TODO: Put the most frequently accessed fields at the beginning of
143 * structures to maximize cache efficiency.
145 struct uvc_control_info {
146 struct list_head mappings;
149 __u8 index; /* Bit index in bmControls */
156 struct uvc_control_mapping {
157 struct list_head list;
158 struct list_head ev_subs;
167 enum v4l2_ctrl_type v4l2_type;
170 struct uvc_menu_info *menu_info;
177 __s32 (*get) (struct uvc_control_mapping *mapping, __u8 query,
179 void (*set) (struct uvc_control_mapping *mapping, __s32 value,
184 struct uvc_entity *entity;
185 struct uvc_control_info info;
187 __u8 index; /* Used to match the uvc_control entry with a
198 struct uvc_format_desc {
204 /* The term 'entity' refers to both UVC units and UVC terminals.
206 * The type field is either the terminal type (wTerminalType in the terminal
207 * descriptor), or the unit type (bDescriptorSubtype in the unit descriptor).
208 * As the bDescriptorSubtype field is one byte long, the type value will
209 * always have a null MSB for units. All terminal types defined by the UVC
210 * specification have a non-null MSB, so it is safe to use the MSB to
211 * differentiate between units and terminals as long as the descriptor parsing
212 * code makes sure terminal types have a non-null MSB.
214 * For terminals, the type's most significant bit stores the terminal
215 * direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should
216 * always be accessed with the UVC_ENTITY_* macros and never directly.
220 struct list_head list; /* Entity as part of a UVC device. */
221 struct list_head chain; /* Entity as part of a video device
227 /* Media controller-related fields. */
228 struct video_device *vdev;
229 struct v4l2_subdev subdev;
230 unsigned int num_pads;
231 unsigned int num_links;
232 struct media_pad *pads;
236 __u16 wObjectiveFocalLengthMin;
237 __u16 wObjectiveFocalLengthMax;
238 __u16 wOcularFocalLength;
246 __u8 bTransportModeSize;
247 __u8 *bmTransportModes;
254 __u16 wMaxMultiplier;
257 __u8 bmVideoStandards;
264 __u8 guidExtensionCode[16];
268 __u8 *bmControlsType;
275 unsigned int ncontrols;
276 struct uvc_control *controls;
286 __u32 dwMaxVideoFrameBufferSize;
287 __u8 bFrameIntervalType;
288 __u32 dwDefaultFrameInterval;
289 __u32 *dwFrameInterval;
302 unsigned int nframes;
303 struct uvc_frame *frame;
306 struct uvc_streaming_header {
308 __u8 bEndpointAddress;
312 /* The following fields are used by input headers only. */
314 __u8 bStillCaptureMethod;
315 __u8 bTriggerSupport;
319 enum uvc_buffer_state {
320 UVC_BUF_STATE_IDLE = 0,
321 UVC_BUF_STATE_QUEUED = 1,
322 UVC_BUF_STATE_ACTIVE = 2,
323 UVC_BUF_STATE_READY = 3,
324 UVC_BUF_STATE_DONE = 4,
325 UVC_BUF_STATE_ERROR = 5,
329 struct vb2_buffer buf;
330 struct list_head queue;
332 enum uvc_buffer_state state;
337 unsigned int bytesused;
342 #define UVC_QUEUE_DISCONNECTED (1 << 0)
343 #define UVC_QUEUE_DROP_CORRUPTED (1 << 1)
345 struct uvc_video_queue {
346 struct vb2_queue queue;
347 struct mutex mutex; /* Protects queue */
350 unsigned int buf_used;
352 spinlock_t irqlock; /* Protects irqqueue */
353 struct list_head irqqueue;
356 struct uvc_video_chain {
357 struct uvc_device *dev;
358 struct list_head list;
360 struct list_head entities; /* All entities */
361 struct uvc_entity *processing; /* Processing unit */
362 struct uvc_entity *selector; /* Selector unit */
364 struct mutex ctrl_mutex; /* Protects ctrl.info */
367 struct uvc_stats_frame {
368 unsigned int size; /* Number of bytes captured */
369 unsigned int first_data; /* Index of the first non-empty packet */
371 unsigned int nb_packets; /* Number of packets */
372 unsigned int nb_empty; /* Number of empty packets */
373 unsigned int nb_invalid; /* Number of packets with an invalid header */
374 unsigned int nb_errors; /* Number of packets with the error bit set */
376 unsigned int nb_pts; /* Number of packets with a PTS timestamp */
377 unsigned int nb_pts_diffs; /* Number of PTS differences inside a frame */
378 unsigned int last_pts_diff; /* Index of the last PTS difference */
379 bool has_initial_pts; /* Whether the first non-empty packet has a PTS */
380 bool has_early_pts; /* Whether a PTS is present before the first non-empty packet */
381 u32 pts; /* PTS of the last packet */
383 unsigned int nb_scr; /* Number of packets with a SCR timestamp */
384 unsigned int nb_scr_diffs; /* Number of SCR.STC differences inside a frame */
385 u16 scr_sof; /* SCR.SOF of the last packet */
386 u32 scr_stc; /* SCR.STC of the last packet */
389 struct uvc_stats_stream {
390 struct timespec start_ts; /* Stream start timestamp */
391 struct timespec stop_ts; /* Stream stop timestamp */
393 unsigned int nb_frames; /* Number of frames */
395 unsigned int nb_packets; /* Number of packets */
396 unsigned int nb_empty; /* Number of empty packets */
397 unsigned int nb_invalid; /* Number of packets with an invalid header */
398 unsigned int nb_errors; /* Number of packets with the error bit set */
400 unsigned int nb_pts_constant; /* Number of frames with constant PTS */
401 unsigned int nb_pts_early; /* Number of frames with early PTS */
402 unsigned int nb_pts_initial; /* Number of frames with initial PTS */
404 unsigned int nb_scr_count_ok; /* Number of frames with at least one SCR per non empty packet */
405 unsigned int nb_scr_diffs_ok; /* Number of frames with varying SCR.STC */
406 unsigned int scr_sof_count; /* STC.SOF counter accumulated since stream start */
407 unsigned int scr_sof; /* STC.SOF of the last packet */
408 unsigned int min_sof; /* Minimum STC.SOF value */
409 unsigned int max_sof; /* Maximum STC.SOF value */
412 struct uvc_streaming {
413 struct list_head list;
414 struct uvc_device *dev;
415 struct video_device *vdev;
416 struct uvc_video_chain *chain;
419 struct usb_interface *intf;
423 struct uvc_streaming_header header;
424 enum v4l2_buf_type type;
426 unsigned int nformats;
427 struct uvc_format *format;
429 struct uvc_streaming_control ctrl;
430 struct uvc_format *cur_format;
431 struct uvc_frame *cur_frame;
432 /* Protect access to ctrl, cur_format, cur_frame and hardware video
438 unsigned int frozen : 1;
439 struct uvc_video_queue queue;
440 void (*decode) (struct urb *urb, struct uvc_streaming *video,
441 struct uvc_buffer *buf);
443 /* Context data used by the bulk completion handler. */
446 unsigned int header_size;
449 __u32 max_payload_size;
452 struct urb *urb[UVC_URBS];
453 char *urb_buffer[UVC_URBS];
454 dma_addr_t urb_dma[UVC_URBS];
455 unsigned int urb_size;
461 struct dentry *debugfs_dir;
463 struct uvc_stats_frame frame;
464 struct uvc_stats_stream stream;
467 /* Timestamps support. */
469 struct uvc_clock_sample {
472 struct timespec host_ts;
487 enum uvc_device_state {
488 UVC_DEV_DISCONNECTED = 1,
492 struct usb_device *udev;
493 struct usb_interface *intf;
494 unsigned long warnings;
499 enum uvc_device_state state;
503 /* Video control interface */
504 #ifdef CONFIG_MEDIA_CONTROLLER
505 struct media_device mdev;
507 struct v4l2_device vdev;
509 __u32 clock_frequency;
511 struct list_head entities;
512 struct list_head chains;
514 /* Video Streaming interfaces */
515 struct list_head streams;
518 /* Status Interrupt Endpoint */
519 struct usb_host_endpoint *int_ep;
522 struct input_dev *input;
526 enum uvc_handle_state {
527 UVC_HANDLE_PASSIVE = 0,
528 UVC_HANDLE_ACTIVE = 1,
533 struct uvc_video_chain *chain;
534 struct uvc_streaming *stream;
535 enum uvc_handle_state state;
539 struct usb_driver driver;
542 /* ------------------------------------------------------------------------
543 * Debugging, printing and logging
546 #define UVC_TRACE_PROBE (1 << 0)
547 #define UVC_TRACE_DESCR (1 << 1)
548 #define UVC_TRACE_CONTROL (1 << 2)
549 #define UVC_TRACE_FORMAT (1 << 3)
550 #define UVC_TRACE_CAPTURE (1 << 4)
551 #define UVC_TRACE_CALLS (1 << 5)
552 #define UVC_TRACE_IOCTL (1 << 6)
553 #define UVC_TRACE_FRAME (1 << 7)
554 #define UVC_TRACE_SUSPEND (1 << 8)
555 #define UVC_TRACE_STATUS (1 << 9)
556 #define UVC_TRACE_VIDEO (1 << 10)
557 #define UVC_TRACE_STATS (1 << 11)
558 #define UVC_TRACE_CLOCK (1 << 12)
560 #define UVC_WARN_MINMAX 0
561 #define UVC_WARN_PROBE_DEF 1
562 #define UVC_WARN_XU_GET_RES 2
564 extern unsigned int uvc_clock_param;
565 extern unsigned int uvc_no_drop_param;
566 extern unsigned int uvc_trace_param;
567 extern unsigned int uvc_timeout_param;
569 #define uvc_trace(flag, msg...) \
571 if (uvc_trace_param & flag) \
572 printk(KERN_DEBUG "uvcvideo: " msg); \
575 #define uvc_warn_once(dev, warn, msg...) \
577 if (!test_and_set_bit(warn, &dev->warnings)) \
578 printk(KERN_INFO "uvcvideo: " msg); \
581 #define uvc_printk(level, msg...) \
582 printk(level "uvcvideo: " msg)
584 /* --------------------------------------------------------------------------
585 * Internal functions.
589 extern struct uvc_driver uvc_driver;
591 extern struct uvc_entity *uvc_entity_by_id(struct uvc_device *dev, int id);
593 /* Video buffers queue management. */
594 extern void uvc_queue_init(struct uvc_video_queue *queue,
595 enum v4l2_buf_type type, int drop_corrupted);
596 extern int uvc_alloc_buffers(struct uvc_video_queue *queue,
597 struct v4l2_requestbuffers *rb);
598 extern void uvc_free_buffers(struct uvc_video_queue *queue);
599 extern int uvc_query_buffer(struct uvc_video_queue *queue,
600 struct v4l2_buffer *v4l2_buf);
601 extern int uvc_queue_buffer(struct uvc_video_queue *queue,
602 struct v4l2_buffer *v4l2_buf);
603 extern int uvc_dequeue_buffer(struct uvc_video_queue *queue,
604 struct v4l2_buffer *v4l2_buf, int nonblocking);
605 extern int uvc_queue_enable(struct uvc_video_queue *queue, int enable);
606 extern void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect);
607 extern struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue,
608 struct uvc_buffer *buf);
609 extern int uvc_queue_mmap(struct uvc_video_queue *queue,
610 struct vm_area_struct *vma);
611 extern unsigned int uvc_queue_poll(struct uvc_video_queue *queue,
612 struct file *file, poll_table *wait);
614 extern unsigned long uvc_queue_get_unmapped_area(struct uvc_video_queue *queue,
615 unsigned long pgoff);
617 extern int uvc_queue_allocated(struct uvc_video_queue *queue);
618 static inline int uvc_queue_streaming(struct uvc_video_queue *queue)
620 return vb2_is_streaming(&queue->queue);
624 extern const struct v4l2_file_operations uvc_fops;
626 /* Media controller */
627 extern int uvc_mc_register_entities(struct uvc_video_chain *chain);
628 extern void uvc_mc_cleanup_entity(struct uvc_entity *entity);
631 extern int uvc_video_init(struct uvc_streaming *stream);
632 extern int uvc_video_suspend(struct uvc_streaming *stream);
633 extern int uvc_video_resume(struct uvc_streaming *stream, int reset);
634 extern int uvc_video_enable(struct uvc_streaming *stream, int enable);
635 extern int uvc_probe_video(struct uvc_streaming *stream,
636 struct uvc_streaming_control *probe);
637 extern int uvc_query_ctrl(struct uvc_device *dev, __u8 query, __u8 unit,
638 __u8 intfnum, __u8 cs, void *data, __u16 size);
639 void uvc_video_clock_update(struct uvc_streaming *stream,
640 struct v4l2_buffer *v4l2_buf,
641 struct uvc_buffer *buf);
644 extern int uvc_status_init(struct uvc_device *dev);
645 extern void uvc_status_cleanup(struct uvc_device *dev);
646 extern int uvc_status_start(struct uvc_device *dev);
647 extern void uvc_status_stop(struct uvc_device *dev);
648 extern int uvc_status_suspend(struct uvc_device *dev);
649 extern int uvc_status_resume(struct uvc_device *dev);
652 extern const struct v4l2_subscribed_event_ops uvc_ctrl_sub_ev_ops;
654 extern int uvc_query_v4l2_ctrl(struct uvc_video_chain *chain,
655 struct v4l2_queryctrl *v4l2_ctrl);
656 extern int uvc_query_v4l2_menu(struct uvc_video_chain *chain,
657 struct v4l2_querymenu *query_menu);
659 extern int uvc_ctrl_add_mapping(struct uvc_video_chain *chain,
660 const struct uvc_control_mapping *mapping);
661 extern int uvc_ctrl_init_device(struct uvc_device *dev);
662 extern void uvc_ctrl_cleanup_device(struct uvc_device *dev);
663 extern int uvc_ctrl_resume_device(struct uvc_device *dev);
665 extern int uvc_ctrl_begin(struct uvc_video_chain *chain);
666 extern int __uvc_ctrl_commit(struct uvc_fh *handle, int rollback,
667 const struct v4l2_ext_control *xctrls,
668 unsigned int xctrls_count);
669 static inline int uvc_ctrl_commit(struct uvc_fh *handle,
670 const struct v4l2_ext_control *xctrls,
671 unsigned int xctrls_count)
673 return __uvc_ctrl_commit(handle, 0, xctrls, xctrls_count);
675 static inline int uvc_ctrl_rollback(struct uvc_fh *handle)
677 return __uvc_ctrl_commit(handle, 1, NULL, 0);
680 extern int uvc_ctrl_get(struct uvc_video_chain *chain,
681 struct v4l2_ext_control *xctrl);
682 extern int uvc_ctrl_set(struct uvc_video_chain *chain,
683 struct v4l2_ext_control *xctrl);
685 extern int uvc_xu_ctrl_query(struct uvc_video_chain *chain,
686 struct uvc_xu_control_query *xqry);
688 /* Utility functions */
689 extern void uvc_simplify_fraction(uint32_t *numerator, uint32_t *denominator,
690 unsigned int n_terms, unsigned int threshold);
691 extern uint32_t uvc_fraction_to_interval(uint32_t numerator,
692 uint32_t denominator);
693 extern struct usb_host_endpoint *uvc_find_endpoint(
694 struct usb_host_interface *alts, __u8 epaddr);
697 void uvc_video_decode_isight(struct urb *urb, struct uvc_streaming *stream,
698 struct uvc_buffer *buf);
700 /* debugfs and statistics */
701 int uvc_debugfs_init(void);
702 void uvc_debugfs_cleanup(void);
703 int uvc_debugfs_init_stream(struct uvc_streaming *stream);
704 void uvc_debugfs_cleanup_stream(struct uvc_streaming *stream);
706 size_t uvc_video_stats_dump(struct uvc_streaming *stream, char *buf,