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)
30 /* Control is an extension unit control. */
31 #define UVC_CONTROL_EXTENSION (1 << 8)
33 #define UVC_CONTROL_GET_RANGE (UVC_CONTROL_GET_CUR | UVC_CONTROL_GET_MIN | \
34 UVC_CONTROL_GET_MAX | UVC_CONTROL_GET_RES | \
37 struct uvc_xu_control_info {
45 struct uvc_menu_info {
50 struct uvc_xu_control_mapping_old {
54 struct uvc_xu_control_mapping {
62 enum v4l2_ctrl_type v4l2_type;
65 struct uvc_menu_info __user *menu_info;
71 struct uvc_xu_control {
78 #define UVCIOC_CTRL_ADD _IOW('U', 1, struct uvc_xu_control_info)
79 #define UVCIOC_CTRL_MAP_OLD _IOWR('U', 2, struct uvc_xu_control_mapping_old)
80 #define UVCIOC_CTRL_MAP _IOWR('U', 2, struct uvc_xu_control_mapping)
81 #define UVCIOC_CTRL_GET _IOWR('U', 3, struct uvc_xu_control)
82 #define UVCIOC_CTRL_SET _IOW('U', 4, struct uvc_xu_control)
86 #include <linux/poll.h>
87 #include <linux/usb/video.h>
89 /* --------------------------------------------------------------------------
93 #define UVC_TERM_INPUT 0x0000
94 #define UVC_TERM_OUTPUT 0x8000
95 #define UVC_TERM_DIRECTION(term) ((term)->type & 0x8000)
97 #define UVC_ENTITY_TYPE(entity) ((entity)->type & 0x7fff)
98 #define UVC_ENTITY_IS_UNIT(entity) (((entity)->type & 0xff00) == 0)
99 #define UVC_ENTITY_IS_TERM(entity) (((entity)->type & 0xff00) != 0)
100 #define UVC_ENTITY_IS_ITERM(entity) \
101 (UVC_ENTITY_IS_TERM(entity) && \
102 ((entity)->type & 0x8000) == UVC_TERM_INPUT)
103 #define UVC_ENTITY_IS_OTERM(entity) \
104 (UVC_ENTITY_IS_TERM(entity) && \
105 ((entity)->type & 0x8000) == UVC_TERM_OUTPUT)
108 /* ------------------------------------------------------------------------
111 #define UVC_GUID_UVC_CAMERA \
112 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
113 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01}
114 #define UVC_GUID_UVC_OUTPUT \
115 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
116 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02}
117 #define UVC_GUID_UVC_MEDIA_TRANSPORT_INPUT \
118 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
119 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03}
120 #define UVC_GUID_UVC_PROCESSING \
121 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
122 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x01}
123 #define UVC_GUID_UVC_SELECTOR \
124 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
125 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x02}
127 #define UVC_GUID_FORMAT_MJPEG \
128 { 'M', 'J', 'P', 'G', 0x00, 0x00, 0x10, 0x00, \
129 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
130 #define UVC_GUID_FORMAT_YUY2 \
131 { 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \
132 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
133 #define UVC_GUID_FORMAT_YUY2_ISIGHT \
134 { 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \
135 0x80, 0x00, 0x00, 0x00, 0x00, 0x38, 0x9b, 0x71}
136 #define UVC_GUID_FORMAT_NV12 \
137 { 'N', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
138 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
139 #define UVC_GUID_FORMAT_YV12 \
140 { 'Y', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
141 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
142 #define UVC_GUID_FORMAT_I420 \
143 { 'I', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \
144 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
145 #define UVC_GUID_FORMAT_UYVY \
146 { 'U', 'Y', 'V', 'Y', 0x00, 0x00, 0x10, 0x00, \
147 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
148 #define UVC_GUID_FORMAT_Y800 \
149 { 'Y', '8', '0', '0', 0x00, 0x00, 0x10, 0x00, \
150 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
151 #define UVC_GUID_FORMAT_Y16 \
152 { 'Y', '1', '6', ' ', 0x00, 0x00, 0x10, 0x00, \
153 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
154 #define UVC_GUID_FORMAT_BY8 \
155 { 'B', 'Y', '8', ' ', 0x00, 0x00, 0x10, 0x00, \
156 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
158 /* ------------------------------------------------------------------------
159 * Driver specific constants.
162 #define DRIVER_VERSION_NUMBER KERNEL_VERSION(0, 1, 0)
164 /* Number of isochronous URBs. */
166 /* Maximum number of packets per URB. */
167 #define UVC_MAX_PACKETS 32
168 /* Maximum number of video buffers. */
169 #define UVC_MAX_VIDEO_BUFFERS 32
170 /* Maximum status buffer size in bytes of interrupt URB. */
171 #define UVC_MAX_STATUS_SIZE 16
173 #define UVC_CTRL_CONTROL_TIMEOUT 300
174 #define UVC_CTRL_STREAMING_TIMEOUT 5000
177 #define UVC_QUIRK_STATUS_INTERVAL 0x00000001
178 #define UVC_QUIRK_PROBE_MINMAX 0x00000002
179 #define UVC_QUIRK_PROBE_EXTRAFIELDS 0x00000004
180 #define UVC_QUIRK_BUILTIN_ISIGHT 0x00000008
181 #define UVC_QUIRK_STREAM_NO_FID 0x00000010
182 #define UVC_QUIRK_IGNORE_SELECTOR_UNIT 0x00000020
183 #define UVC_QUIRK_FIX_BANDWIDTH 0x00000080
184 #define UVC_QUIRK_PROBE_DEF 0x00000100
185 #define UVC_QUIRK_RESTRICT_FRAME_RATE 0x00000200
188 #define UVC_FMT_FLAG_COMPRESSED 0x00000001
189 #define UVC_FMT_FLAG_STREAM 0x00000002
191 /* ------------------------------------------------------------------------
197 /* TODO: Put the most frequently accessed fields at the beginning of
198 * structures to maximize cache efficiency.
200 struct uvc_control_info {
201 struct list_head list;
202 struct list_head mappings;
212 struct uvc_control_mapping {
213 struct list_head list;
215 struct uvc_control_info *ctrl;
224 enum v4l2_ctrl_type v4l2_type;
227 struct uvc_menu_info *menu_info;
230 __s32 (*get) (struct uvc_control_mapping *mapping, __u8 query,
232 void (*set) (struct uvc_control_mapping *mapping, __s32 value,
237 struct uvc_entity *entity;
238 struct uvc_control_info *info;
240 __u8 index; /* Used to match the uvc_control entry with a
251 struct uvc_format_desc {
257 /* The term 'entity' refers to both UVC units and UVC terminals.
259 * The type field is either the terminal type (wTerminalType in the terminal
260 * descriptor), or the unit type (bDescriptorSubtype in the unit descriptor).
261 * As the bDescriptorSubtype field is one byte long, the type value will
262 * always have a null MSB for units. All terminal types defined by the UVC
263 * specification have a non-null MSB, so it is safe to use the MSB to
264 * differentiate between units and terminals as long as the descriptor parsing
265 * code makes sure terminal types have a non-null MSB.
267 * For terminals, the type's most significant bit stores the terminal
268 * direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should
269 * always be accessed with the UVC_ENTITY_* macros and never directly.
273 struct list_head list; /* Entity as part of a UVC device. */
274 struct list_head chain; /* Entity as part of a video device
282 __u16 wObjectiveFocalLengthMin;
283 __u16 wObjectiveFocalLengthMax;
284 __u16 wOcularFocalLength;
292 __u8 bTransportModeSize;
293 __u8 *bmTransportModes;
300 __u16 wMaxMultiplier;
303 __u8 bmVideoStandards;
310 __u8 guidExtensionCode[16];
314 __u8 *bmControlsType;
321 unsigned int ncontrols;
322 struct uvc_control *controls;
332 __u32 dwMaxVideoFrameBufferSize;
333 __u8 bFrameIntervalType;
334 __u32 dwDefaultFrameInterval;
335 __u32 *dwFrameInterval;
348 unsigned int nframes;
349 struct uvc_frame *frame;
352 struct uvc_streaming_header {
354 __u8 bEndpointAddress;
358 /* The following fields are used by input headers only. */
360 __u8 bStillCaptureMethod;
361 __u8 bTriggerSupport;
365 enum uvc_buffer_state {
366 UVC_BUF_STATE_IDLE = 0,
367 UVC_BUF_STATE_QUEUED = 1,
368 UVC_BUF_STATE_ACTIVE = 2,
369 UVC_BUF_STATE_READY = 3,
370 UVC_BUF_STATE_DONE = 4,
371 UVC_BUF_STATE_ERROR = 5,
375 unsigned long vma_use_count;
376 struct list_head stream;
378 /* Touched by interrupt handler. */
379 struct v4l2_buffer buf;
380 struct list_head queue;
381 wait_queue_head_t wait;
382 enum uvc_buffer_state state;
386 #define UVC_QUEUE_STREAMING (1 << 0)
387 #define UVC_QUEUE_DISCONNECTED (1 << 1)
388 #define UVC_QUEUE_DROP_CORRUPTED (1 << 2)
390 struct uvc_video_queue {
391 enum v4l2_buf_type type;
398 unsigned int buf_size;
399 unsigned int buf_used;
400 struct uvc_buffer buffer[UVC_MAX_VIDEO_BUFFERS];
401 struct mutex mutex; /* protects buffers and mainqueue */
402 spinlock_t irqlock; /* protects irqqueue */
404 struct list_head mainqueue;
405 struct list_head irqqueue;
408 struct uvc_video_chain {
409 struct uvc_device *dev;
410 struct list_head list;
412 struct list_head entities; /* All entities */
413 struct uvc_entity *processing; /* Processing unit */
414 struct uvc_entity *selector; /* Selector unit */
416 struct mutex ctrl_mutex;
419 struct uvc_streaming {
420 struct list_head list;
421 struct uvc_device *dev;
422 struct video_device *vdev;
423 struct uvc_video_chain *chain;
426 struct usb_interface *intf;
430 struct uvc_streaming_header header;
431 enum v4l2_buf_type type;
433 unsigned int nformats;
434 struct uvc_format *format;
436 struct uvc_streaming_control ctrl;
437 struct uvc_format *cur_format;
438 struct uvc_frame *cur_frame;
442 unsigned int frozen : 1;
443 struct uvc_video_queue queue;
444 void (*decode) (struct urb *urb, struct uvc_streaming *video,
445 struct uvc_buffer *buf);
447 /* Context data used by the bulk completion handler. */
450 unsigned int header_size;
453 __u32 max_payload_size;
456 struct urb *urb[UVC_URBS];
457 char *urb_buffer[UVC_URBS];
458 dma_addr_t urb_dma[UVC_URBS];
459 unsigned int urb_size;
464 enum uvc_device_state {
465 UVC_DEV_DISCONNECTED = 1,
469 struct usb_device *udev;
470 struct usb_interface *intf;
471 unsigned long warnings;
476 enum uvc_device_state state;
477 struct list_head list;
480 /* Video control interface */
482 __u32 clock_frequency;
484 struct list_head entities;
485 struct list_head chains;
487 /* Video Streaming interfaces */
488 struct list_head streams;
491 /* Status Interrupt Endpoint */
492 struct usb_host_endpoint *int_ep;
495 struct input_dev *input;
499 enum uvc_handle_state {
500 UVC_HANDLE_PASSIVE = 0,
501 UVC_HANDLE_ACTIVE = 1,
505 struct uvc_video_chain *chain;
506 struct uvc_streaming *stream;
507 enum uvc_handle_state state;
511 struct usb_driver driver;
513 struct list_head devices; /* struct uvc_device list */
514 struct list_head controls; /* struct uvc_control_info list */
515 struct mutex ctrl_mutex; /* protects controls and devices
519 /* ------------------------------------------------------------------------
520 * Debugging, printing and logging
523 #define UVC_TRACE_PROBE (1 << 0)
524 #define UVC_TRACE_DESCR (1 << 1)
525 #define UVC_TRACE_CONTROL (1 << 2)
526 #define UVC_TRACE_FORMAT (1 << 3)
527 #define UVC_TRACE_CAPTURE (1 << 4)
528 #define UVC_TRACE_CALLS (1 << 5)
529 #define UVC_TRACE_IOCTL (1 << 6)
530 #define UVC_TRACE_FRAME (1 << 7)
531 #define UVC_TRACE_SUSPEND (1 << 8)
532 #define UVC_TRACE_STATUS (1 << 9)
533 #define UVC_TRACE_VIDEO (1 << 10)
535 #define UVC_WARN_MINMAX 0
536 #define UVC_WARN_PROBE_DEF 1
538 extern unsigned int uvc_clock_param;
539 extern unsigned int uvc_no_drop_param;
540 extern unsigned int uvc_trace_param;
541 extern unsigned int uvc_timeout_param;
543 #define uvc_trace(flag, msg...) \
545 if (uvc_trace_param & flag) \
546 printk(KERN_DEBUG "uvcvideo: " msg); \
549 #define uvc_warn_once(dev, warn, msg...) \
551 if (!test_and_set_bit(warn, &dev->warnings)) \
552 printk(KERN_INFO "uvcvideo: " msg); \
555 #define uvc_printk(level, msg...) \
556 printk(level "uvcvideo: " msg)
558 /* --------------------------------------------------------------------------
559 * Internal functions.
563 extern struct uvc_driver uvc_driver;
565 /* Video buffers queue management. */
566 extern void uvc_queue_init(struct uvc_video_queue *queue,
567 enum v4l2_buf_type type, int drop_corrupted);
568 extern int uvc_alloc_buffers(struct uvc_video_queue *queue,
569 unsigned int nbuffers, unsigned int buflength);
570 extern int uvc_free_buffers(struct uvc_video_queue *queue);
571 extern int uvc_query_buffer(struct uvc_video_queue *queue,
572 struct v4l2_buffer *v4l2_buf);
573 extern int uvc_queue_buffer(struct uvc_video_queue *queue,
574 struct v4l2_buffer *v4l2_buf);
575 extern int uvc_dequeue_buffer(struct uvc_video_queue *queue,
576 struct v4l2_buffer *v4l2_buf, int nonblocking);
577 extern int uvc_queue_enable(struct uvc_video_queue *queue, int enable);
578 extern void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect);
579 extern struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue,
580 struct uvc_buffer *buf);
581 extern unsigned int uvc_queue_poll(struct uvc_video_queue *queue,
582 struct file *file, poll_table *wait);
583 extern int uvc_queue_allocated(struct uvc_video_queue *queue);
584 static inline int uvc_queue_streaming(struct uvc_video_queue *queue)
586 return queue->flags & UVC_QUEUE_STREAMING;
590 extern const struct v4l2_file_operations uvc_fops;
593 extern int uvc_video_init(struct uvc_streaming *stream);
594 extern int uvc_video_suspend(struct uvc_streaming *stream);
595 extern int uvc_video_resume(struct uvc_streaming *stream);
596 extern int uvc_video_enable(struct uvc_streaming *stream, int enable);
597 extern int uvc_probe_video(struct uvc_streaming *stream,
598 struct uvc_streaming_control *probe);
599 extern int uvc_commit_video(struct uvc_streaming *stream,
600 struct uvc_streaming_control *ctrl);
601 extern int uvc_query_ctrl(struct uvc_device *dev, __u8 query, __u8 unit,
602 __u8 intfnum, __u8 cs, void *data, __u16 size);
605 extern int uvc_status_init(struct uvc_device *dev);
606 extern void uvc_status_cleanup(struct uvc_device *dev);
607 extern int uvc_status_start(struct uvc_device *dev);
608 extern void uvc_status_stop(struct uvc_device *dev);
609 extern int uvc_status_suspend(struct uvc_device *dev);
610 extern int uvc_status_resume(struct uvc_device *dev);
613 extern struct uvc_control *uvc_find_control(struct uvc_video_chain *chain,
614 __u32 v4l2_id, struct uvc_control_mapping **mapping);
615 extern int uvc_query_v4l2_ctrl(struct uvc_video_chain *chain,
616 struct v4l2_queryctrl *v4l2_ctrl);
618 extern int uvc_ctrl_add_info(struct uvc_control_info *info);
619 extern int uvc_ctrl_add_mapping(struct uvc_control_mapping *mapping);
620 extern int uvc_ctrl_init_device(struct uvc_device *dev);
621 extern void uvc_ctrl_cleanup_device(struct uvc_device *dev);
622 extern int uvc_ctrl_resume_device(struct uvc_device *dev);
623 extern void uvc_ctrl_init(void);
624 extern void uvc_ctrl_cleanup(void);
626 extern int uvc_ctrl_begin(struct uvc_video_chain *chain);
627 extern int __uvc_ctrl_commit(struct uvc_video_chain *chain, int rollback);
628 static inline int uvc_ctrl_commit(struct uvc_video_chain *chain)
630 return __uvc_ctrl_commit(chain, 0);
632 static inline int uvc_ctrl_rollback(struct uvc_video_chain *chain)
634 return __uvc_ctrl_commit(chain, 1);
637 extern int uvc_ctrl_get(struct uvc_video_chain *chain,
638 struct v4l2_ext_control *xctrl);
639 extern int uvc_ctrl_set(struct uvc_video_chain *chain,
640 struct v4l2_ext_control *xctrl);
642 extern int uvc_xu_ctrl_query(struct uvc_video_chain *chain,
643 struct uvc_xu_control *ctrl, int set);
645 /* Utility functions */
646 extern void uvc_simplify_fraction(uint32_t *numerator, uint32_t *denominator,
647 unsigned int n_terms, unsigned int threshold);
648 extern uint32_t uvc_fraction_to_interval(uint32_t numerator,
649 uint32_t denominator);
650 extern struct usb_host_endpoint *uvc_find_endpoint(
651 struct usb_host_interface *alts, __u8 epaddr);
654 void uvc_video_decode_isight(struct urb *urb, struct uvc_streaming *stream,
655 struct uvc_buffer *buf);
657 #endif /* __KERNEL__ */