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
79 #define UVC_ENTITY_TYPE(entity) ((entity)->type & 0x7fff)
80 #define UVC_ENTITY_IS_UNIT(entity) (((entity)->type & 0xff00) == 0)
81 #define UVC_ENTITY_IS_TERM(entity) (((entity)->type & 0xff00) != 0)
82 #define UVC_ENTITY_IS_ITERM(entity) \
83 (UVC_ENTITY_IS_TERM(entity) && \
84 ((entity)->type & 0x8000) == UVC_TERM_INPUT)
85 #define UVC_ENTITY_IS_OTERM(entity) \
86 (UVC_ENTITY_IS_TERM(entity) && \
87 ((entity)->type & 0x8000) == UVC_TERM_OUTPUT)
90 /* ------------------------------------------------------------------------
93 #define UVC_GUID_UVC_CAMERA \
94 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
95 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01}
96 #define UVC_GUID_UVC_OUTPUT \
97 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
98 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02}
99 #define UVC_GUID_UVC_MEDIA_TRANSPORT_INPUT \
100 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
101 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03}
102 #define UVC_GUID_UVC_PROCESSING \
103 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
104 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x01}
105 #define UVC_GUID_UVC_SELECTOR \
106 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
107 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x02}
109 #define UVC_GUID_FORMAT_MJPEG \
110 { 'M', 'J', 'P', 'G', 0x00, 0x00, 0x10, 0x00, \
111 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
112 #define UVC_GUID_FORMAT_YUY2 \
113 { 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \
114 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
115 #define UVC_GUID_FORMAT_NV12 \
116 { 'N', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
117 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
118 #define UVC_GUID_FORMAT_YV12 \
119 { 'Y', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
120 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
121 #define UVC_GUID_FORMAT_I420 \
122 { 'I', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \
123 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
124 #define UVC_GUID_FORMAT_UYVY \
125 { 'U', 'Y', 'V', 'Y', 0x00, 0x00, 0x10, 0x00, \
126 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
127 #define UVC_GUID_FORMAT_Y800 \
128 { 'Y', '8', '0', '0', 0x00, 0x00, 0x10, 0x00, \
129 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
130 #define UVC_GUID_FORMAT_BY8 \
131 { 'B', 'Y', '8', ' ', 0x00, 0x00, 0x10, 0x00, \
132 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
135 /* ------------------------------------------------------------------------
136 * Driver specific constants.
139 #define DRIVER_VERSION_NUMBER KERNEL_VERSION(0, 1, 0)
141 /* Number of isochronous URBs. */
143 /* Maximum number of packets per URB. */
144 #define UVC_MAX_PACKETS 32
145 /* Maximum number of video buffers. */
146 #define UVC_MAX_VIDEO_BUFFERS 32
147 /* Maximum status buffer size in bytes of interrupt URB. */
148 #define UVC_MAX_STATUS_SIZE 16
150 #define UVC_CTRL_CONTROL_TIMEOUT 300
151 #define UVC_CTRL_STREAMING_TIMEOUT 1000
154 #define UVC_QUIRK_STATUS_INTERVAL 0x00000001
155 #define UVC_QUIRK_PROBE_MINMAX 0x00000002
156 #define UVC_QUIRK_PROBE_EXTRAFIELDS 0x00000004
157 #define UVC_QUIRK_BUILTIN_ISIGHT 0x00000008
158 #define UVC_QUIRK_STREAM_NO_FID 0x00000010
159 #define UVC_QUIRK_IGNORE_SELECTOR_UNIT 0x00000020
160 #define UVC_QUIRK_FIX_BANDWIDTH 0x00000080
161 #define UVC_QUIRK_PROBE_DEF 0x00000100
164 #define UVC_FMT_FLAG_COMPRESSED 0x00000001
165 #define UVC_FMT_FLAG_STREAM 0x00000002
167 /* ------------------------------------------------------------------------
173 /* TODO: Put the most frequently accessed fields at the beginning of
174 * structures to maximize cache efficiency.
176 struct uvc_streaming_control
{
180 __u32 dwFrameInterval
;
184 __u16 wCompWindowSize
;
186 __u32 dwMaxVideoFrameSize
;
187 __u32 dwMaxPayloadTransferSize
;
188 __u32 dwClockFrequency
;
190 __u8 bPreferedVersion
;
195 struct uvc_menu_info
{
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
249 struct uvc_format_desc
{
255 /* The term 'entity' refers to both UVC units and UVC terminals.
257 * The type field is either the terminal type (wTerminalType in the terminal
258 * descriptor), or the unit type (bDescriptorSubtype in the unit descriptor).
259 * As the bDescriptorSubtype field is one byte long, the type value will
260 * always have a null MSB for units. All terminal types defined by the UVC
261 * specification have a non-null MSB, so it is safe to use the MSB to
262 * differentiate between units and terminals as long as the descriptor parsing
263 * code makes sure terminal types have a non-null MSB.
265 * For terminals, the type's most significant bit stores the terminal
266 * direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should
267 * always be accessed with the UVC_ENTITY_* macros and never directly.
271 struct list_head list
; /* Entity as part of a UVC device. */
272 struct list_head chain
; /* Entity as part of a video device
280 __u16 wObjectiveFocalLengthMin
;
281 __u16 wObjectiveFocalLengthMax
;
282 __u16 wOcularFocalLength
;
290 __u8 bTransportModeSize
;
291 __u8
*bmTransportModes
;
300 __u16 wMaxMultiplier
;
303 __u8 bmVideoStandards
;
312 __u8 guidExtensionCode
[16];
318 __u8
*bmControlsType
;
322 unsigned int ncontrols
;
323 struct uvc_control
*controls
;
333 __u32 dwMaxVideoFrameBufferSize
;
334 __u8 bFrameIntervalType
;
335 __u32 dwDefaultFrameInterval
;
336 __u32
*dwFrameInterval
;
349 unsigned int nframes
;
350 struct uvc_frame
*frame
;
353 struct uvc_streaming_header
{
355 __u8 bEndpointAddress
;
359 /* The following fields are used by input headers only. */
361 __u8 bStillCaptureMethod
;
362 __u8 bTriggerSupport
;
366 enum uvc_buffer_state
{
367 UVC_BUF_STATE_IDLE
= 0,
368 UVC_BUF_STATE_QUEUED
= 1,
369 UVC_BUF_STATE_ACTIVE
= 2,
370 UVC_BUF_STATE_DONE
= 3,
371 UVC_BUF_STATE_ERROR
= 4,
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
;
385 #define UVC_QUEUE_STREAMING (1 << 0)
386 #define UVC_QUEUE_DISCONNECTED (1 << 1)
387 #define UVC_QUEUE_DROP_INCOMPLETE (1 << 2)
389 struct uvc_video_queue
{
390 enum v4l2_buf_type type
;
397 unsigned int buf_size
;
398 unsigned int buf_used
;
399 struct uvc_buffer buffer
[UVC_MAX_VIDEO_BUFFERS
];
400 struct mutex mutex
; /* protects buffers and mainqueue */
401 spinlock_t irqlock
; /* protects irqqueue */
403 struct list_head mainqueue
;
404 struct list_head irqqueue
;
407 struct uvc_video_chain
{
408 struct uvc_device
*dev
;
409 struct list_head list
;
411 struct list_head iterms
; /* Input terminals */
412 struct list_head oterms
; /* Output terminals */
413 struct uvc_entity
*processing
; /* Processing unit */
414 struct uvc_entity
*selector
; /* Selector unit */
415 struct list_head extensions
; /* Extension units */
417 struct mutex ctrl_mutex
;
420 struct uvc_streaming
{
421 struct list_head list
;
422 struct uvc_device
*dev
;
423 struct video_device
*vdev
;
424 struct uvc_video_chain
*chain
;
427 struct usb_interface
*intf
;
431 struct uvc_streaming_header header
;
432 enum v4l2_buf_type type
;
434 unsigned int nformats
;
435 struct uvc_format
*format
;
437 struct uvc_streaming_control ctrl
;
438 struct uvc_format
*cur_format
;
439 struct uvc_frame
*cur_frame
;
443 unsigned int frozen
: 1;
444 struct uvc_video_queue queue
;
445 void (*decode
) (struct urb
*urb
, struct uvc_streaming
*video
,
446 struct uvc_buffer
*buf
);
448 /* Context data used by the bulk completion handler. */
451 unsigned int header_size
;
454 __u32 max_payload_size
;
457 struct urb
*urb
[UVC_URBS
];
458 char *urb_buffer
[UVC_URBS
];
459 dma_addr_t urb_dma
[UVC_URBS
];
460 unsigned int urb_size
;
465 enum uvc_device_state
{
466 UVC_DEV_DISCONNECTED
= 1,
470 struct usb_device
*udev
;
471 struct usb_interface
*intf
;
472 unsigned long warnings
;
477 enum uvc_device_state state
;
479 struct list_head list
;
482 /* Video control interface */
484 __u32 clock_frequency
;
486 struct list_head entities
;
487 struct list_head chains
;
489 /* Video Streaming interfaces */
490 struct list_head streams
;
492 /* Status Interrupt Endpoint */
493 struct usb_host_endpoint
*int_ep
;
496 struct input_dev
*input
;
500 enum uvc_handle_state
{
501 UVC_HANDLE_PASSIVE
= 0,
502 UVC_HANDLE_ACTIVE
= 1,
506 struct uvc_video_chain
*chain
;
507 struct uvc_streaming
*stream
;
508 enum uvc_handle_state state
;
512 struct usb_driver driver
;
514 struct mutex open_mutex
; /* protects from open/disconnect race */
516 struct list_head devices
; /* struct uvc_device list */
517 struct list_head controls
; /* struct uvc_control_info list */
518 struct mutex ctrl_mutex
; /* protects controls and devices
522 /* ------------------------------------------------------------------------
523 * Debugging, printing and logging
526 #define UVC_TRACE_PROBE (1 << 0)
527 #define UVC_TRACE_DESCR (1 << 1)
528 #define UVC_TRACE_CONTROL (1 << 2)
529 #define UVC_TRACE_FORMAT (1 << 3)
530 #define UVC_TRACE_CAPTURE (1 << 4)
531 #define UVC_TRACE_CALLS (1 << 5)
532 #define UVC_TRACE_IOCTL (1 << 6)
533 #define UVC_TRACE_FRAME (1 << 7)
534 #define UVC_TRACE_SUSPEND (1 << 8)
535 #define UVC_TRACE_STATUS (1 << 9)
537 #define UVC_WARN_MINMAX 0
538 #define UVC_WARN_PROBE_DEF 1
540 extern unsigned int uvc_no_drop_param
;
541 extern unsigned int uvc_trace_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 #define UVC_GUID_FORMAT "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-" \
559 "%02x%02x%02x%02x%02x%02x"
560 #define UVC_GUID_ARGS(guid) \
561 (guid)[3], (guid)[2], (guid)[1], (guid)[0], \
562 (guid)[5], (guid)[4], \
563 (guid)[7], (guid)[6], \
564 (guid)[8], (guid)[9], \
565 (guid)[10], (guid)[11], (guid)[12], \
566 (guid)[13], (guid)[14], (guid)[15]
568 /* --------------------------------------------------------------------------
569 * Internal functions.
573 extern struct uvc_driver uvc_driver
;
574 extern void uvc_delete(struct kref
*kref
);
576 /* Video buffers queue management. */
577 extern void uvc_queue_init(struct uvc_video_queue
*queue
,
578 enum v4l2_buf_type type
);
579 extern int uvc_alloc_buffers(struct uvc_video_queue
*queue
,
580 unsigned int nbuffers
, unsigned int buflength
);
581 extern int uvc_free_buffers(struct uvc_video_queue
*queue
);
582 extern int uvc_query_buffer(struct uvc_video_queue
*queue
,
583 struct v4l2_buffer
*v4l2_buf
);
584 extern int uvc_queue_buffer(struct uvc_video_queue
*queue
,
585 struct v4l2_buffer
*v4l2_buf
);
586 extern int uvc_dequeue_buffer(struct uvc_video_queue
*queue
,
587 struct v4l2_buffer
*v4l2_buf
, int nonblocking
);
588 extern int uvc_queue_enable(struct uvc_video_queue
*queue
, int enable
);
589 extern void uvc_queue_cancel(struct uvc_video_queue
*queue
, int disconnect
);
590 extern struct uvc_buffer
*uvc_queue_next_buffer(struct uvc_video_queue
*queue
,
591 struct uvc_buffer
*buf
);
592 extern unsigned int uvc_queue_poll(struct uvc_video_queue
*queue
,
593 struct file
*file
, poll_table
*wait
);
594 extern int uvc_queue_allocated(struct uvc_video_queue
*queue
);
595 static inline int uvc_queue_streaming(struct uvc_video_queue
*queue
)
597 return queue
->flags
& UVC_QUEUE_STREAMING
;
601 extern const struct v4l2_file_operations uvc_fops
;
604 extern int uvc_video_init(struct uvc_streaming
*stream
);
605 extern int uvc_video_suspend(struct uvc_streaming
*stream
);
606 extern int uvc_video_resume(struct uvc_streaming
*stream
);
607 extern int uvc_video_enable(struct uvc_streaming
*stream
, int enable
);
608 extern int uvc_probe_video(struct uvc_streaming
*stream
,
609 struct uvc_streaming_control
*probe
);
610 extern int uvc_commit_video(struct uvc_streaming
*stream
,
611 struct uvc_streaming_control
*ctrl
);
612 extern int uvc_query_ctrl(struct uvc_device
*dev
, __u8 query
, __u8 unit
,
613 __u8 intfnum
, __u8 cs
, void *data
, __u16 size
);
616 extern int uvc_status_init(struct uvc_device
*dev
);
617 extern void uvc_status_cleanup(struct uvc_device
*dev
);
618 extern int uvc_status_start(struct uvc_device
*dev
);
619 extern void uvc_status_stop(struct uvc_device
*dev
);
620 extern int uvc_status_suspend(struct uvc_device
*dev
);
621 extern int uvc_status_resume(struct uvc_device
*dev
);
624 extern struct uvc_control
*uvc_find_control(struct uvc_video_chain
*chain
,
625 __u32 v4l2_id
, struct uvc_control_mapping
**mapping
);
626 extern int uvc_query_v4l2_ctrl(struct uvc_video_chain
*chain
,
627 struct v4l2_queryctrl
*v4l2_ctrl
);
629 extern int uvc_ctrl_add_info(struct uvc_control_info
*info
);
630 extern int uvc_ctrl_add_mapping(struct uvc_control_mapping
*mapping
);
631 extern int uvc_ctrl_init_device(struct uvc_device
*dev
);
632 extern void uvc_ctrl_cleanup_device(struct uvc_device
*dev
);
633 extern int uvc_ctrl_resume_device(struct uvc_device
*dev
);
634 extern void uvc_ctrl_init(void);
636 extern int uvc_ctrl_begin(struct uvc_video_chain
*chain
);
637 extern int __uvc_ctrl_commit(struct uvc_video_chain
*chain
, int rollback
);
638 static inline int uvc_ctrl_commit(struct uvc_video_chain
*chain
)
640 return __uvc_ctrl_commit(chain
, 0);
642 static inline int uvc_ctrl_rollback(struct uvc_video_chain
*chain
)
644 return __uvc_ctrl_commit(chain
, 1);
647 extern int uvc_ctrl_get(struct uvc_video_chain
*chain
,
648 struct v4l2_ext_control
*xctrl
);
649 extern int uvc_ctrl_set(struct uvc_video_chain
*chain
,
650 struct v4l2_ext_control
*xctrl
);
652 extern int uvc_xu_ctrl_query(struct uvc_video_chain
*chain
,
653 struct uvc_xu_control
*ctrl
, int set
);
655 /* Utility functions */
656 extern void uvc_simplify_fraction(uint32_t *numerator
, uint32_t *denominator
,
657 unsigned int n_terms
, unsigned int threshold
);
658 extern uint32_t uvc_fraction_to_interval(uint32_t numerator
,
659 uint32_t denominator
);
660 extern struct usb_host_endpoint
*uvc_find_endpoint(
661 struct usb_host_interface
*alts
, __u8 epaddr
);
664 void uvc_video_decode_isight(struct urb
*urb
, struct uvc_streaming
*stream
,
665 struct uvc_buffer
*buf
);
667 #endif /* __KERNEL__ */