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_Y16 \
135 { 'Y', '1', '6', ' ', 0x00, 0x00, 0x10, 0x00, \
136 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
137 #define UVC_GUID_FORMAT_BY8 \
138 { 'B', 'Y', '8', ' ', 0x00, 0x00, 0x10, 0x00, \
139 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
141 /* ------------------------------------------------------------------------
142 * Driver specific constants.
145 #define DRIVER_VERSION_NUMBER KERNEL_VERSION(0, 1, 0)
147 /* Number of isochronous URBs. */
149 /* Maximum number of packets per URB. */
150 #define UVC_MAX_PACKETS 32
151 /* Maximum number of video buffers. */
152 #define UVC_MAX_VIDEO_BUFFERS 32
153 /* Maximum status buffer size in bytes of interrupt URB. */
154 #define UVC_MAX_STATUS_SIZE 16
156 #define UVC_CTRL_CONTROL_TIMEOUT 300
157 #define UVC_CTRL_STREAMING_TIMEOUT 5000
160 #define UVC_QUIRK_STATUS_INTERVAL 0x00000001
161 #define UVC_QUIRK_PROBE_MINMAX 0x00000002
162 #define UVC_QUIRK_PROBE_EXTRAFIELDS 0x00000004
163 #define UVC_QUIRK_BUILTIN_ISIGHT 0x00000008
164 #define UVC_QUIRK_STREAM_NO_FID 0x00000010
165 #define UVC_QUIRK_IGNORE_SELECTOR_UNIT 0x00000020
166 #define UVC_QUIRK_FIX_BANDWIDTH 0x00000080
167 #define UVC_QUIRK_PROBE_DEF 0x00000100
170 #define UVC_FMT_FLAG_COMPRESSED 0x00000001
171 #define UVC_FMT_FLAG_STREAM 0x00000002
173 /* ------------------------------------------------------------------------
179 /* TODO: Put the most frequently accessed fields at the beginning of
180 * structures to maximize cache efficiency.
182 struct uvc_streaming_control
{
186 __u32 dwFrameInterval
;
190 __u16 wCompWindowSize
;
192 __u32 dwMaxVideoFrameSize
;
193 __u32 dwMaxPayloadTransferSize
;
194 __u32 dwClockFrequency
;
196 __u8 bPreferedVersion
;
201 struct uvc_menu_info
{
206 struct uvc_control_info
{
207 struct list_head list
;
208 struct list_head mappings
;
218 struct uvc_control_mapping
{
219 struct list_head list
;
221 struct uvc_control_info
*ctrl
;
230 enum v4l2_ctrl_type v4l2_type
;
233 struct uvc_menu_info
*menu_info
;
236 __s32 (*get
) (struct uvc_control_mapping
*mapping
, __u8 query
,
238 void (*set
) (struct uvc_control_mapping
*mapping
, __s32 value
,
243 struct uvc_entity
*entity
;
244 struct uvc_control_info
*info
;
246 __u8 index
; /* Used to match the uvc_control entry with a
256 struct uvc_format_desc
{
262 /* The term 'entity' refers to both UVC units and UVC terminals.
264 * The type field is either the terminal type (wTerminalType in the terminal
265 * descriptor), or the unit type (bDescriptorSubtype in the unit descriptor).
266 * As the bDescriptorSubtype field is one byte long, the type value will
267 * always have a null MSB for units. All terminal types defined by the UVC
268 * specification have a non-null MSB, so it is safe to use the MSB to
269 * differentiate between units and terminals as long as the descriptor parsing
270 * code makes sure terminal types have a non-null MSB.
272 * For terminals, the type's most significant bit stores the terminal
273 * direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should
274 * always be accessed with the UVC_ENTITY_* macros and never directly.
278 struct list_head list
; /* Entity as part of a UVC device. */
279 struct list_head chain
; /* Entity as part of a video device
287 __u16 wObjectiveFocalLengthMin
;
288 __u16 wObjectiveFocalLengthMax
;
289 __u16 wOcularFocalLength
;
297 __u8 bTransportModeSize
;
298 __u8
*bmTransportModes
;
305 __u16 wMaxMultiplier
;
308 __u8 bmVideoStandards
;
315 __u8 guidExtensionCode
[16];
319 __u8
*bmControlsType
;
326 unsigned int ncontrols
;
327 struct uvc_control
*controls
;
337 __u32 dwMaxVideoFrameBufferSize
;
338 __u8 bFrameIntervalType
;
339 __u32 dwDefaultFrameInterval
;
340 __u32
*dwFrameInterval
;
353 unsigned int nframes
;
354 struct uvc_frame
*frame
;
357 struct uvc_streaming_header
{
359 __u8 bEndpointAddress
;
363 /* The following fields are used by input headers only. */
365 __u8 bStillCaptureMethod
;
366 __u8 bTriggerSupport
;
370 enum uvc_buffer_state
{
371 UVC_BUF_STATE_IDLE
= 0,
372 UVC_BUF_STATE_QUEUED
= 1,
373 UVC_BUF_STATE_ACTIVE
= 2,
374 UVC_BUF_STATE_READY
= 3,
375 UVC_BUF_STATE_DONE
= 4,
376 UVC_BUF_STATE_ERROR
= 5,
380 unsigned long vma_use_count
;
381 struct list_head stream
;
383 /* Touched by interrupt handler. */
384 struct v4l2_buffer buf
;
385 struct list_head queue
;
386 wait_queue_head_t wait
;
387 enum uvc_buffer_state state
;
390 #define UVC_QUEUE_STREAMING (1 << 0)
391 #define UVC_QUEUE_DISCONNECTED (1 << 1)
392 #define UVC_QUEUE_DROP_INCOMPLETE (1 << 2)
394 struct uvc_video_queue
{
395 enum v4l2_buf_type type
;
402 unsigned int buf_size
;
403 unsigned int buf_used
;
404 struct uvc_buffer buffer
[UVC_MAX_VIDEO_BUFFERS
];
405 struct mutex mutex
; /* protects buffers and mainqueue */
406 spinlock_t irqlock
; /* protects irqqueue */
408 struct list_head mainqueue
;
409 struct list_head irqqueue
;
412 struct uvc_video_chain
{
413 struct uvc_device
*dev
;
414 struct list_head list
;
416 struct list_head entities
; /* All entities */
417 struct uvc_entity
*processing
; /* Processing unit */
418 struct uvc_entity
*selector
; /* Selector unit */
420 struct mutex ctrl_mutex
;
423 struct uvc_streaming
{
424 struct list_head list
;
425 struct uvc_device
*dev
;
426 struct video_device
*vdev
;
427 struct uvc_video_chain
*chain
;
430 struct usb_interface
*intf
;
434 struct uvc_streaming_header header
;
435 enum v4l2_buf_type type
;
437 unsigned int nformats
;
438 struct uvc_format
*format
;
440 struct uvc_streaming_control ctrl
;
441 struct uvc_format
*cur_format
;
442 struct uvc_frame
*cur_frame
;
446 unsigned int frozen
: 1;
447 struct uvc_video_queue queue
;
448 void (*decode
) (struct urb
*urb
, struct uvc_streaming
*video
,
449 struct uvc_buffer
*buf
);
451 /* Context data used by the bulk completion handler. */
454 unsigned int header_size
;
457 __u32 max_payload_size
;
460 struct urb
*urb
[UVC_URBS
];
461 char *urb_buffer
[UVC_URBS
];
462 dma_addr_t urb_dma
[UVC_URBS
];
463 unsigned int urb_size
;
468 enum uvc_device_state
{
469 UVC_DEV_DISCONNECTED
= 1,
473 struct usb_device
*udev
;
474 struct usb_interface
*intf
;
475 unsigned long warnings
;
480 enum uvc_device_state state
;
481 struct list_head list
;
484 /* Video control interface */
486 __u32 clock_frequency
;
488 struct list_head entities
;
489 struct list_head chains
;
491 /* Video Streaming interfaces */
492 struct list_head streams
;
495 /* Status Interrupt Endpoint */
496 struct usb_host_endpoint
*int_ep
;
499 struct input_dev
*input
;
503 enum uvc_handle_state
{
504 UVC_HANDLE_PASSIVE
= 0,
505 UVC_HANDLE_ACTIVE
= 1,
509 struct uvc_video_chain
*chain
;
510 struct uvc_streaming
*stream
;
511 enum uvc_handle_state state
;
515 struct usb_driver driver
;
517 struct list_head devices
; /* struct uvc_device list */
518 struct list_head controls
; /* struct uvc_control_info list */
519 struct mutex ctrl_mutex
; /* protects controls and devices
523 /* ------------------------------------------------------------------------
524 * Debugging, printing and logging
527 #define UVC_TRACE_PROBE (1 << 0)
528 #define UVC_TRACE_DESCR (1 << 1)
529 #define UVC_TRACE_CONTROL (1 << 2)
530 #define UVC_TRACE_FORMAT (1 << 3)
531 #define UVC_TRACE_CAPTURE (1 << 4)
532 #define UVC_TRACE_CALLS (1 << 5)
533 #define UVC_TRACE_IOCTL (1 << 6)
534 #define UVC_TRACE_FRAME (1 << 7)
535 #define UVC_TRACE_SUSPEND (1 << 8)
536 #define UVC_TRACE_STATUS (1 << 9)
537 #define UVC_TRACE_VIDEO (1 << 10)
539 #define UVC_WARN_MINMAX 0
540 #define UVC_WARN_PROBE_DEF 1
542 extern unsigned int uvc_clock_param
;
543 extern unsigned int uvc_no_drop_param
;
544 extern unsigned int uvc_trace_param
;
545 extern unsigned int uvc_timeout_param
;
547 #define uvc_trace(flag, msg...) \
549 if (uvc_trace_param & flag) \
550 printk(KERN_DEBUG "uvcvideo: " msg); \
553 #define uvc_warn_once(dev, warn, msg...) \
555 if (!test_and_set_bit(warn, &dev->warnings)) \
556 printk(KERN_INFO "uvcvideo: " msg); \
559 #define uvc_printk(level, msg...) \
560 printk(level "uvcvideo: " msg)
562 /* --------------------------------------------------------------------------
563 * Internal functions.
567 extern struct uvc_driver uvc_driver
;
569 /* Video buffers queue management. */
570 extern void uvc_queue_init(struct uvc_video_queue
*queue
,
571 enum v4l2_buf_type type
);
572 extern int uvc_alloc_buffers(struct uvc_video_queue
*queue
,
573 unsigned int nbuffers
, unsigned int buflength
);
574 extern int uvc_free_buffers(struct uvc_video_queue
*queue
);
575 extern int uvc_query_buffer(struct uvc_video_queue
*queue
,
576 struct v4l2_buffer
*v4l2_buf
);
577 extern int uvc_queue_buffer(struct uvc_video_queue
*queue
,
578 struct v4l2_buffer
*v4l2_buf
);
579 extern int uvc_dequeue_buffer(struct uvc_video_queue
*queue
,
580 struct v4l2_buffer
*v4l2_buf
, int nonblocking
);
581 extern int uvc_queue_enable(struct uvc_video_queue
*queue
, int enable
);
582 extern void uvc_queue_cancel(struct uvc_video_queue
*queue
, int disconnect
);
583 extern struct uvc_buffer
*uvc_queue_next_buffer(struct uvc_video_queue
*queue
,
584 struct uvc_buffer
*buf
);
585 extern unsigned int uvc_queue_poll(struct uvc_video_queue
*queue
,
586 struct file
*file
, poll_table
*wait
);
587 extern int uvc_queue_allocated(struct uvc_video_queue
*queue
);
588 static inline int uvc_queue_streaming(struct uvc_video_queue
*queue
)
590 return queue
->flags
& UVC_QUEUE_STREAMING
;
594 extern const struct v4l2_file_operations uvc_fops
;
597 extern int uvc_video_init(struct uvc_streaming
*stream
);
598 extern int uvc_video_suspend(struct uvc_streaming
*stream
);
599 extern int uvc_video_resume(struct uvc_streaming
*stream
);
600 extern int uvc_video_enable(struct uvc_streaming
*stream
, int enable
);
601 extern int uvc_probe_video(struct uvc_streaming
*stream
,
602 struct uvc_streaming_control
*probe
);
603 extern int uvc_commit_video(struct uvc_streaming
*stream
,
604 struct uvc_streaming_control
*ctrl
);
605 extern int uvc_query_ctrl(struct uvc_device
*dev
, __u8 query
, __u8 unit
,
606 __u8 intfnum
, __u8 cs
, void *data
, __u16 size
);
609 extern int uvc_status_init(struct uvc_device
*dev
);
610 extern void uvc_status_cleanup(struct uvc_device
*dev
);
611 extern int uvc_status_start(struct uvc_device
*dev
);
612 extern void uvc_status_stop(struct uvc_device
*dev
);
613 extern int uvc_status_suspend(struct uvc_device
*dev
);
614 extern int uvc_status_resume(struct uvc_device
*dev
);
617 extern struct uvc_control
*uvc_find_control(struct uvc_video_chain
*chain
,
618 __u32 v4l2_id
, struct uvc_control_mapping
**mapping
);
619 extern int uvc_query_v4l2_ctrl(struct uvc_video_chain
*chain
,
620 struct v4l2_queryctrl
*v4l2_ctrl
);
622 extern int uvc_ctrl_add_info(struct uvc_control_info
*info
);
623 extern int uvc_ctrl_add_mapping(struct uvc_control_mapping
*mapping
);
624 extern int uvc_ctrl_init_device(struct uvc_device
*dev
);
625 extern void uvc_ctrl_cleanup_device(struct uvc_device
*dev
);
626 extern int uvc_ctrl_resume_device(struct uvc_device
*dev
);
627 extern void uvc_ctrl_init(void);
629 extern int uvc_ctrl_begin(struct uvc_video_chain
*chain
);
630 extern int __uvc_ctrl_commit(struct uvc_video_chain
*chain
, int rollback
);
631 static inline int uvc_ctrl_commit(struct uvc_video_chain
*chain
)
633 return __uvc_ctrl_commit(chain
, 0);
635 static inline int uvc_ctrl_rollback(struct uvc_video_chain
*chain
)
637 return __uvc_ctrl_commit(chain
, 1);
640 extern int uvc_ctrl_get(struct uvc_video_chain
*chain
,
641 struct v4l2_ext_control
*xctrl
);
642 extern int uvc_ctrl_set(struct uvc_video_chain
*chain
,
643 struct v4l2_ext_control
*xctrl
);
645 extern int uvc_xu_ctrl_query(struct uvc_video_chain
*chain
,
646 struct uvc_xu_control
*ctrl
, int set
);
648 /* Utility functions */
649 extern void uvc_simplify_fraction(uint32_t *numerator
, uint32_t *denominator
,
650 unsigned int n_terms
, unsigned int threshold
);
651 extern uint32_t uvc_fraction_to_interval(uint32_t numerator
,
652 uint32_t denominator
);
653 extern struct usb_host_endpoint
*uvc_find_endpoint(
654 struct usb_host_interface
*alts
, __u8 epaddr
);
657 void uvc_video_decode_isight(struct urb
*urb
, struct uvc_streaming
*stream
,
658 struct uvc_buffer
*buf
);
660 #endif /* __KERNEL__ */