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_YUY2_ISIGHT \
117 { 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \
118 0x80, 0x00, 0x00, 0x00, 0x00, 0x38, 0x9b, 0x71}
119 #define UVC_GUID_FORMAT_NV12 \
120 { 'N', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
121 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
122 #define UVC_GUID_FORMAT_YV12 \
123 { 'Y', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
124 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
125 #define UVC_GUID_FORMAT_I420 \
126 { 'I', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \
127 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
128 #define UVC_GUID_FORMAT_UYVY \
129 { 'U', 'Y', 'V', 'Y', 0x00, 0x00, 0x10, 0x00, \
130 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
131 #define UVC_GUID_FORMAT_Y800 \
132 { 'Y', '8', '0', '0', 0x00, 0x00, 0x10, 0x00, \
133 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
134 #define UVC_GUID_FORMAT_BY8 \
135 { 'B', 'Y', '8', ' ', 0x00, 0x00, 0x10, 0x00, \
136 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
139 /* ------------------------------------------------------------------------
140 * Driver specific constants.
143 #define DRIVER_VERSION_NUMBER KERNEL_VERSION(0, 1, 0)
145 /* Number of isochronous URBs. */
147 /* Maximum number of packets per URB. */
148 #define UVC_MAX_PACKETS 32
149 /* Maximum number of video buffers. */
150 #define UVC_MAX_VIDEO_BUFFERS 32
151 /* Maximum status buffer size in bytes of interrupt URB. */
152 #define UVC_MAX_STATUS_SIZE 16
154 #define UVC_CTRL_CONTROL_TIMEOUT 300
155 #define UVC_CTRL_STREAMING_TIMEOUT 3000
158 #define UVC_QUIRK_STATUS_INTERVAL 0x00000001
159 #define UVC_QUIRK_PROBE_MINMAX 0x00000002
160 #define UVC_QUIRK_PROBE_EXTRAFIELDS 0x00000004
161 #define UVC_QUIRK_BUILTIN_ISIGHT 0x00000008
162 #define UVC_QUIRK_STREAM_NO_FID 0x00000010
163 #define UVC_QUIRK_IGNORE_SELECTOR_UNIT 0x00000020
164 #define UVC_QUIRK_FIX_BANDWIDTH 0x00000080
165 #define UVC_QUIRK_PROBE_DEF 0x00000100
168 #define UVC_FMT_FLAG_COMPRESSED 0x00000001
169 #define UVC_FMT_FLAG_STREAM 0x00000002
171 /* ------------------------------------------------------------------------
177 /* TODO: Put the most frequently accessed fields at the beginning of
178 * structures to maximize cache efficiency.
180 struct uvc_streaming_control
{
184 __u32 dwFrameInterval
;
188 __u16 wCompWindowSize
;
190 __u32 dwMaxVideoFrameSize
;
191 __u32 dwMaxPayloadTransferSize
;
192 __u32 dwClockFrequency
;
194 __u8 bPreferedVersion
;
199 struct uvc_menu_info
{
204 struct uvc_control_info
{
205 struct list_head list
;
206 struct list_head mappings
;
216 struct uvc_control_mapping
{
217 struct list_head list
;
219 struct uvc_control_info
*ctrl
;
228 enum v4l2_ctrl_type v4l2_type
;
231 struct uvc_menu_info
*menu_info
;
234 __s32 (*get
) (struct uvc_control_mapping
*mapping
, __u8 query
,
236 void (*set
) (struct uvc_control_mapping
*mapping
, __s32 value
,
241 struct uvc_entity
*entity
;
242 struct uvc_control_info
*info
;
244 __u8 index
; /* Used to match the uvc_control entry with a
253 struct uvc_format_desc
{
259 /* The term 'entity' refers to both UVC units and UVC terminals.
261 * The type field is either the terminal type (wTerminalType in the terminal
262 * descriptor), or the unit type (bDescriptorSubtype in the unit descriptor).
263 * As the bDescriptorSubtype field is one byte long, the type value will
264 * always have a null MSB for units. All terminal types defined by the UVC
265 * specification have a non-null MSB, so it is safe to use the MSB to
266 * differentiate between units and terminals as long as the descriptor parsing
267 * code makes sure terminal types have a non-null MSB.
269 * For terminals, the type's most significant bit stores the terminal
270 * direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should
271 * always be accessed with the UVC_ENTITY_* macros and never directly.
275 struct list_head list
; /* Entity as part of a UVC device. */
276 struct list_head chain
; /* Entity as part of a video device
284 __u16 wObjectiveFocalLengthMin
;
285 __u16 wObjectiveFocalLengthMax
;
286 __u16 wOcularFocalLength
;
294 __u8 bTransportModeSize
;
295 __u8
*bmTransportModes
;
302 __u16 wMaxMultiplier
;
305 __u8 bmVideoStandards
;
312 __u8 guidExtensionCode
[16];
316 __u8
*bmControlsType
;
323 unsigned int ncontrols
;
324 struct uvc_control
*controls
;
334 __u32 dwMaxVideoFrameBufferSize
;
335 __u8 bFrameIntervalType
;
336 __u32 dwDefaultFrameInterval
;
337 __u32
*dwFrameInterval
;
350 unsigned int nframes
;
351 struct uvc_frame
*frame
;
354 struct uvc_streaming_header
{
356 __u8 bEndpointAddress
;
360 /* The following fields are used by input headers only. */
362 __u8 bStillCaptureMethod
;
363 __u8 bTriggerSupport
;
367 enum uvc_buffer_state
{
368 UVC_BUF_STATE_IDLE
= 0,
369 UVC_BUF_STATE_QUEUED
= 1,
370 UVC_BUF_STATE_ACTIVE
= 2,
371 UVC_BUF_STATE_READY
= 3,
372 UVC_BUF_STATE_DONE
= 4,
373 UVC_BUF_STATE_ERROR
= 5,
377 unsigned long vma_use_count
;
378 struct list_head stream
;
380 /* Touched by interrupt handler. */
381 struct v4l2_buffer buf
;
382 struct list_head queue
;
383 wait_queue_head_t wait
;
384 enum uvc_buffer_state state
;
387 #define UVC_QUEUE_STREAMING (1 << 0)
388 #define UVC_QUEUE_DISCONNECTED (1 << 1)
389 #define UVC_QUEUE_DROP_INCOMPLETE (1 << 2)
391 struct uvc_video_queue
{
392 enum v4l2_buf_type type
;
399 unsigned int buf_size
;
400 unsigned int buf_used
;
401 struct uvc_buffer buffer
[UVC_MAX_VIDEO_BUFFERS
];
402 struct mutex mutex
; /* protects buffers and mainqueue */
403 spinlock_t irqlock
; /* protects irqqueue */
405 struct list_head mainqueue
;
406 struct list_head irqqueue
;
409 struct uvc_video_chain
{
410 struct uvc_device
*dev
;
411 struct list_head list
;
413 struct list_head entities
; /* All entities */
414 struct uvc_entity
*processing
; /* Processing unit */
415 struct uvc_entity
*selector
; /* Selector unit */
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
;
478 struct list_head list
;
481 /* Video control interface */
483 __u32 clock_frequency
;
485 struct list_head entities
;
486 struct list_head chains
;
488 /* Video Streaming interfaces */
489 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 list_head devices
; /* struct uvc_device list */
515 struct list_head controls
; /* struct uvc_control_info list */
516 struct mutex ctrl_mutex
; /* protects controls and devices
520 /* ------------------------------------------------------------------------
521 * Debugging, printing and logging
524 #define UVC_TRACE_PROBE (1 << 0)
525 #define UVC_TRACE_DESCR (1 << 1)
526 #define UVC_TRACE_CONTROL (1 << 2)
527 #define UVC_TRACE_FORMAT (1 << 3)
528 #define UVC_TRACE_CAPTURE (1 << 4)
529 #define UVC_TRACE_CALLS (1 << 5)
530 #define UVC_TRACE_IOCTL (1 << 6)
531 #define UVC_TRACE_FRAME (1 << 7)
532 #define UVC_TRACE_SUSPEND (1 << 8)
533 #define UVC_TRACE_STATUS (1 << 9)
534 #define UVC_TRACE_VIDEO (1 << 10)
536 #define UVC_WARN_MINMAX 0
537 #define UVC_WARN_PROBE_DEF 1
539 extern unsigned int uvc_clock_param
;
540 extern unsigned int uvc_no_drop_param
;
541 extern unsigned int uvc_trace_param
;
542 extern unsigned int uvc_timeout_param
;
544 #define uvc_trace(flag, msg...) \
546 if (uvc_trace_param & flag) \
547 printk(KERN_DEBUG "uvcvideo: " msg); \
550 #define uvc_warn_once(dev, warn, msg...) \
552 if (!test_and_set_bit(warn, &dev->warnings)) \
553 printk(KERN_INFO "uvcvideo: " msg); \
556 #define uvc_printk(level, msg...) \
557 printk(level "uvcvideo: " msg)
559 #define UVC_GUID_FORMAT "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-" \
560 "%02x%02x%02x%02x%02x%02x"
561 #define UVC_GUID_ARGS(guid) \
562 (guid)[3], (guid)[2], (guid)[1], (guid)[0], \
563 (guid)[5], (guid)[4], \
564 (guid)[7], (guid)[6], \
565 (guid)[8], (guid)[9], \
566 (guid)[10], (guid)[11], (guid)[12], \
567 (guid)[13], (guid)[14], (guid)[15]
569 /* --------------------------------------------------------------------------
570 * Internal functions.
574 extern struct uvc_driver uvc_driver
;
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__ */