4 #include <linux/kernel.h>
5 #include <linux/videodev2.h>
11 /* Data types for UVC control data */
12 #define UVC_CTRL_DATA_TYPE_RAW 0
13 #define UVC_CTRL_DATA_TYPE_SIGNED 1
14 #define UVC_CTRL_DATA_TYPE_UNSIGNED 2
15 #define UVC_CTRL_DATA_TYPE_BOOLEAN 3
16 #define UVC_CTRL_DATA_TYPE_ENUM 4
17 #define UVC_CTRL_DATA_TYPE_BITMASK 5
20 #define UVC_CONTROL_SET_CUR (1 << 0)
21 #define UVC_CONTROL_GET_CUR (1 << 1)
22 #define UVC_CONTROL_GET_MIN (1 << 2)
23 #define UVC_CONTROL_GET_MAX (1 << 3)
24 #define UVC_CONTROL_GET_RES (1 << 4)
25 #define UVC_CONTROL_GET_DEF (1 << 5)
26 /* Control should be saved at suspend and restored at resume. */
27 #define UVC_CONTROL_RESTORE (1 << 6)
28 /* Control can be updated by the camera. */
29 #define UVC_CONTROL_AUTO_UPDATE (1 << 7)
31 #define UVC_CONTROL_GET_RANGE (UVC_CONTROL_GET_CUR | UVC_CONTROL_GET_MIN | \
32 UVC_CONTROL_GET_MAX | UVC_CONTROL_GET_RES | \
35 struct uvc_xu_control_info {
43 struct uvc_xu_control_mapping {
51 enum v4l2_ctrl_type v4l2_type;
55 struct uvc_xu_control {
62 #define UVCIOC_CTRL_ADD _IOW('U', 1, struct uvc_xu_control_info)
63 #define UVCIOC_CTRL_MAP _IOWR('U', 2, struct uvc_xu_control_mapping)
64 #define UVCIOC_CTRL_GET _IOWR('U', 3, struct uvc_xu_control)
65 #define UVCIOC_CTRL_SET _IOW('U', 4, struct uvc_xu_control)
69 #include <linux/poll.h>
70 #include <linux/usb/video.h>
72 /* --------------------------------------------------------------------------
76 #define UVC_TERM_INPUT 0x0000
77 #define UVC_TERM_OUTPUT 0x8000
78 #define UVC_TERM_DIRECTION(term) ((term)->type & 0x8000)
80 #define UVC_ENTITY_TYPE(entity) ((entity)->type & 0x7fff)
81 #define UVC_ENTITY_IS_UNIT(entity) (((entity)->type & 0xff00) == 0)
82 #define UVC_ENTITY_IS_TERM(entity) (((entity)->type & 0xff00) != 0)
83 #define UVC_ENTITY_IS_ITERM(entity) \
84 (UVC_ENTITY_IS_TERM(entity) && \
85 ((entity)->type & 0x8000) == UVC_TERM_INPUT)
86 #define UVC_ENTITY_IS_OTERM(entity) \
87 (UVC_ENTITY_IS_TERM(entity) && \
88 ((entity)->type & 0x8000) == UVC_TERM_OUTPUT)
91 /* ------------------------------------------------------------------------
94 #define UVC_GUID_UVC_CAMERA \
95 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
96 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01}
97 #define UVC_GUID_UVC_OUTPUT \
98 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
99 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02}
100 #define UVC_GUID_UVC_MEDIA_TRANSPORT_INPUT \
101 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
102 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03}
103 #define UVC_GUID_UVC_PROCESSING \
104 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
105 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x01}
106 #define UVC_GUID_UVC_SELECTOR \
107 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
108 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x02}
110 #define UVC_GUID_FORMAT_MJPEG \
111 { 'M', 'J', 'P', 'G', 0x00, 0x00, 0x10, 0x00, \
112 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
113 #define UVC_GUID_FORMAT_YUY2 \
114 { 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \
115 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
116 #define UVC_GUID_FORMAT_NV12 \
117 { 'N', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
118 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
119 #define UVC_GUID_FORMAT_YV12 \
120 { 'Y', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
121 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
122 #define UVC_GUID_FORMAT_I420 \
123 { 'I', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \
124 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
125 #define UVC_GUID_FORMAT_UYVY \
126 { 'U', 'Y', 'V', 'Y', 0x00, 0x00, 0x10, 0x00, \
127 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
128 #define UVC_GUID_FORMAT_Y800 \
129 { 'Y', '8', '0', '0', 0x00, 0x00, 0x10, 0x00, \
130 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
131 #define UVC_GUID_FORMAT_BY8 \
132 { 'B', 'Y', '8', ' ', 0x00, 0x00, 0x10, 0x00, \
133 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
136 /* ------------------------------------------------------------------------
137 * Driver specific constants.
140 #define DRIVER_VERSION_NUMBER KERNEL_VERSION(0, 1, 0)
142 /* Number of isochronous URBs. */
144 /* Maximum number of packets per URB. */
145 #define UVC_MAX_PACKETS 32
146 /* Maximum number of video buffers. */
147 #define UVC_MAX_VIDEO_BUFFERS 32
148 /* Maximum status buffer size in bytes of interrupt URB. */
149 #define UVC_MAX_STATUS_SIZE 16
151 #define UVC_CTRL_CONTROL_TIMEOUT 300
152 #define UVC_CTRL_STREAMING_TIMEOUT 3000
155 #define UVC_QUIRK_STATUS_INTERVAL 0x00000001
156 #define UVC_QUIRK_PROBE_MINMAX 0x00000002
157 #define UVC_QUIRK_PROBE_EXTRAFIELDS 0x00000004
158 #define UVC_QUIRK_BUILTIN_ISIGHT 0x00000008
159 #define UVC_QUIRK_STREAM_NO_FID 0x00000010
160 #define UVC_QUIRK_IGNORE_SELECTOR_UNIT 0x00000020
161 #define UVC_QUIRK_FIX_BANDWIDTH 0x00000080
162 #define UVC_QUIRK_PROBE_DEF 0x00000100
165 #define UVC_FMT_FLAG_COMPRESSED 0x00000001
166 #define UVC_FMT_FLAG_STREAM 0x00000002
168 /* ------------------------------------------------------------------------
174 /* TODO: Put the most frequently accessed fields at the beginning of
175 * structures to maximize cache efficiency.
177 struct uvc_streaming_control {
181 __u32 dwFrameInterval;
185 __u16 wCompWindowSize;
187 __u32 dwMaxVideoFrameSize;
188 __u32 dwMaxPayloadTransferSize;
189 __u32 dwClockFrequency;
191 __u8 bPreferedVersion;
196 struct uvc_menu_info {
201 struct uvc_control_info {
202 struct list_head list;
203 struct list_head mappings;
213 struct uvc_control_mapping {
214 struct list_head list;
216 struct uvc_control_info *ctrl;
225 enum v4l2_ctrl_type v4l2_type;
228 struct uvc_menu_info *menu_info;
231 __s32 (*get) (struct uvc_control_mapping *mapping, __u8 query,
233 void (*set) (struct uvc_control_mapping *mapping, __s32 value,
238 struct uvc_entity *entity;
239 struct uvc_control_info *info;
241 __u8 index; /* Used to match the uvc_control entry with a
250 struct uvc_format_desc {
256 /* The term 'entity' refers to both UVC units and UVC terminals.
258 * The type field is either the terminal type (wTerminalType in the terminal
259 * descriptor), or the unit type (bDescriptorSubtype in the unit descriptor).
260 * As the bDescriptorSubtype field is one byte long, the type value will
261 * always have a null MSB for units. All terminal types defined by the UVC
262 * specification have a non-null MSB, so it is safe to use the MSB to
263 * differentiate between units and terminals as long as the descriptor parsing
264 * code makes sure terminal types have a non-null MSB.
266 * For terminals, the type's most significant bit stores the terminal
267 * direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should
268 * always be accessed with the UVC_ENTITY_* macros and never directly.
272 struct list_head list; /* Entity as part of a UVC device. */
273 struct list_head chain; /* Entity as part of a video device
281 __u16 wObjectiveFocalLengthMin;
282 __u16 wObjectiveFocalLengthMax;
283 __u16 wOcularFocalLength;
291 __u8 bTransportModeSize;
292 __u8 *bmTransportModes;
299 __u16 wMaxMultiplier;
302 __u8 bmVideoStandards;
309 __u8 guidExtensionCode[16];
313 __u8 *bmControlsType;
320 unsigned int ncontrols;
321 struct uvc_control *controls;
331 __u32 dwMaxVideoFrameBufferSize;
332 __u8 bFrameIntervalType;
333 __u32 dwDefaultFrameInterval;
334 __u32 *dwFrameInterval;
347 unsigned int nframes;
348 struct uvc_frame *frame;
351 struct uvc_streaming_header {
353 __u8 bEndpointAddress;
357 /* The following fields are used by input headers only. */
359 __u8 bStillCaptureMethod;
360 __u8 bTriggerSupport;
364 enum uvc_buffer_state {
365 UVC_BUF_STATE_IDLE = 0,
366 UVC_BUF_STATE_QUEUED = 1,
367 UVC_BUF_STATE_ACTIVE = 2,
368 UVC_BUF_STATE_DONE = 3,
369 UVC_BUF_STATE_ERROR = 4,
373 unsigned long vma_use_count;
374 struct list_head stream;
376 /* Touched by interrupt handler. */
377 struct v4l2_buffer buf;
378 struct list_head queue;
379 wait_queue_head_t wait;
380 enum uvc_buffer_state state;
383 #define UVC_QUEUE_STREAMING (1 << 0)
384 #define UVC_QUEUE_DISCONNECTED (1 << 1)
385 #define UVC_QUEUE_DROP_INCOMPLETE (1 << 2)
387 struct uvc_video_queue {
388 enum v4l2_buf_type type;
395 unsigned int buf_size;
396 unsigned int buf_used;
397 struct uvc_buffer buffer[UVC_MAX_VIDEO_BUFFERS];
398 struct mutex mutex; /* protects buffers and mainqueue */
399 spinlock_t irqlock; /* protects irqqueue */
401 struct list_head mainqueue;
402 struct list_head irqqueue;
405 struct uvc_video_chain {
406 struct uvc_device *dev;
407 struct list_head list;
409 struct list_head entities; /* All entities */
410 struct uvc_entity *processing; /* Processing unit */
411 struct uvc_entity *selector; /* Selector unit */
413 struct mutex ctrl_mutex;
416 struct uvc_streaming {
417 struct list_head list;
418 struct uvc_device *dev;
419 struct video_device *vdev;
420 struct uvc_video_chain *chain;
423 struct usb_interface *intf;
427 struct uvc_streaming_header header;
428 enum v4l2_buf_type type;
430 unsigned int nformats;
431 struct uvc_format *format;
433 struct uvc_streaming_control ctrl;
434 struct uvc_format *cur_format;
435 struct uvc_frame *cur_frame;
439 unsigned int frozen : 1;
440 struct uvc_video_queue queue;
441 void (*decode) (struct urb *urb, struct uvc_streaming *video,
442 struct uvc_buffer *buf);
444 /* Context data used by the bulk completion handler. */
447 unsigned int header_size;
450 __u32 max_payload_size;
453 struct urb *urb[UVC_URBS];
454 char *urb_buffer[UVC_URBS];
455 dma_addr_t urb_dma[UVC_URBS];
456 unsigned int urb_size;
461 enum uvc_device_state {
462 UVC_DEV_DISCONNECTED = 1,
466 struct usb_device *udev;
467 struct usb_interface *intf;
468 unsigned long warnings;
473 enum uvc_device_state state;
474 struct list_head list;
477 /* Video control interface */
479 __u32 clock_frequency;
481 struct list_head entities;
482 struct list_head chains;
484 /* Video Streaming interfaces */
485 struct list_head streams;
488 /* Status Interrupt Endpoint */
489 struct usb_host_endpoint *int_ep;
492 struct input_dev *input;
496 enum uvc_handle_state {
497 UVC_HANDLE_PASSIVE = 0,
498 UVC_HANDLE_ACTIVE = 1,
502 struct uvc_video_chain *chain;
503 struct uvc_streaming *stream;
504 enum uvc_handle_state state;
508 struct usb_driver driver;
510 struct list_head devices; /* struct uvc_device list */
511 struct list_head controls; /* struct uvc_control_info list */
512 struct mutex ctrl_mutex; /* protects controls and devices
516 /* ------------------------------------------------------------------------
517 * Debugging, printing and logging
520 #define UVC_TRACE_PROBE (1 << 0)
521 #define UVC_TRACE_DESCR (1 << 1)
522 #define UVC_TRACE_CONTROL (1 << 2)
523 #define UVC_TRACE_FORMAT (1 << 3)
524 #define UVC_TRACE_CAPTURE (1 << 4)
525 #define UVC_TRACE_CALLS (1 << 5)
526 #define UVC_TRACE_IOCTL (1 << 6)
527 #define UVC_TRACE_FRAME (1 << 7)
528 #define UVC_TRACE_SUSPEND (1 << 8)
529 #define UVC_TRACE_STATUS (1 << 9)
530 #define UVC_TRACE_VIDEO (1 << 10)
532 #define UVC_WARN_MINMAX 0
533 #define UVC_WARN_PROBE_DEF 1
535 extern unsigned int uvc_no_drop_param;
536 extern unsigned int uvc_trace_param;
537 extern unsigned int uvc_timeout_param;
539 #define uvc_trace(flag, msg...) \
541 if (uvc_trace_param & flag) \
542 printk(KERN_DEBUG "uvcvideo: " msg); \
545 #define uvc_warn_once(dev, warn, msg...) \
547 if (!test_and_set_bit(warn, &dev->warnings)) \
548 printk(KERN_INFO "uvcvideo: " msg); \
551 #define uvc_printk(level, msg...) \
552 printk(level "uvcvideo: " msg)
554 #define UVC_GUID_FORMAT "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-" \
555 "%02x%02x%02x%02x%02x%02x"
556 #define UVC_GUID_ARGS(guid) \
557 (guid)[3], (guid)[2], (guid)[1], (guid)[0], \
558 (guid)[5], (guid)[4], \
559 (guid)[7], (guid)[6], \
560 (guid)[8], (guid)[9], \
561 (guid)[10], (guid)[11], (guid)[12], \
562 (guid)[13], (guid)[14], (guid)[15]
564 /* --------------------------------------------------------------------------
565 * Internal functions.
569 extern struct uvc_driver uvc_driver;
571 /* Video buffers queue management. */
572 extern void uvc_queue_init(struct uvc_video_queue *queue,
573 enum v4l2_buf_type type);
574 extern int uvc_alloc_buffers(struct uvc_video_queue *queue,
575 unsigned int nbuffers, unsigned int buflength);
576 extern int uvc_free_buffers(struct uvc_video_queue *queue);
577 extern int uvc_query_buffer(struct uvc_video_queue *queue,
578 struct v4l2_buffer *v4l2_buf);
579 extern int uvc_queue_buffer(struct uvc_video_queue *queue,
580 struct v4l2_buffer *v4l2_buf);
581 extern int uvc_dequeue_buffer(struct uvc_video_queue *queue,
582 struct v4l2_buffer *v4l2_buf, int nonblocking);
583 extern int uvc_queue_enable(struct uvc_video_queue *queue, int enable);
584 extern void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect);
585 extern struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue,
586 struct uvc_buffer *buf);
587 extern unsigned int uvc_queue_poll(struct uvc_video_queue *queue,
588 struct file *file, poll_table *wait);
589 extern int uvc_queue_allocated(struct uvc_video_queue *queue);
590 static inline int uvc_queue_streaming(struct uvc_video_queue *queue)
592 return queue->flags & UVC_QUEUE_STREAMING;
596 extern const struct v4l2_file_operations uvc_fops;
599 extern int uvc_video_init(struct uvc_streaming *stream);
600 extern int uvc_video_suspend(struct uvc_streaming *stream);
601 extern int uvc_video_resume(struct uvc_streaming *stream);
602 extern int uvc_video_enable(struct uvc_streaming *stream, int enable);
603 extern int uvc_probe_video(struct uvc_streaming *stream,
604 struct uvc_streaming_control *probe);
605 extern int uvc_commit_video(struct uvc_streaming *stream,
606 struct uvc_streaming_control *ctrl);
607 extern int uvc_query_ctrl(struct uvc_device *dev, __u8 query, __u8 unit,
608 __u8 intfnum, __u8 cs, void *data, __u16 size);
611 extern int uvc_status_init(struct uvc_device *dev);
612 extern void uvc_status_cleanup(struct uvc_device *dev);
613 extern int uvc_status_start(struct uvc_device *dev);
614 extern void uvc_status_stop(struct uvc_device *dev);
615 extern int uvc_status_suspend(struct uvc_device *dev);
616 extern int uvc_status_resume(struct uvc_device *dev);
619 extern struct uvc_control *uvc_find_control(struct uvc_video_chain *chain,
620 __u32 v4l2_id, struct uvc_control_mapping **mapping);
621 extern int uvc_query_v4l2_ctrl(struct uvc_video_chain *chain,
622 struct v4l2_queryctrl *v4l2_ctrl);
624 extern int uvc_ctrl_add_info(struct uvc_control_info *info);
625 extern int uvc_ctrl_add_mapping(struct uvc_control_mapping *mapping);
626 extern int uvc_ctrl_init_device(struct uvc_device *dev);
627 extern void uvc_ctrl_cleanup_device(struct uvc_device *dev);
628 extern int uvc_ctrl_resume_device(struct uvc_device *dev);
629 extern void uvc_ctrl_init(void);
631 extern int uvc_ctrl_begin(struct uvc_video_chain *chain);
632 extern int __uvc_ctrl_commit(struct uvc_video_chain *chain, int rollback);
633 static inline int uvc_ctrl_commit(struct uvc_video_chain *chain)
635 return __uvc_ctrl_commit(chain, 0);
637 static inline int uvc_ctrl_rollback(struct uvc_video_chain *chain)
639 return __uvc_ctrl_commit(chain, 1);
642 extern int uvc_ctrl_get(struct uvc_video_chain *chain,
643 struct v4l2_ext_control *xctrl);
644 extern int uvc_ctrl_set(struct uvc_video_chain *chain,
645 struct v4l2_ext_control *xctrl);
647 extern int uvc_xu_ctrl_query(struct uvc_video_chain *chain,
648 struct uvc_xu_control *ctrl, int set);
650 /* Utility functions */
651 extern void uvc_simplify_fraction(uint32_t *numerator, uint32_t *denominator,
652 unsigned int n_terms, unsigned int threshold);
653 extern uint32_t uvc_fraction_to_interval(uint32_t numerator,
654 uint32_t denominator);
655 extern struct usb_host_endpoint *uvc_find_endpoint(
656 struct usb_host_interface *alts, __u8 epaddr);
659 void uvc_video_decode_isight(struct urb *urb, struct uvc_streaming *stream,
660 struct uvc_buffer *buf);
662 #endif /* __KERNEL__ */