1 /* SPDX-License-Identifier: GPL-2.0 */
6 #error "The uvcvideo.h header is deprecated, use linux/uvcvideo.h instead."
7 #endif /* __KERNEL__ */
9 #include <linux/atomic.h>
10 #include <linux/kernel.h>
11 #include <linux/poll.h>
12 #include <linux/usb.h>
13 #include <linux/usb/video.h>
14 #include <linux/uvcvideo.h>
15 #include <linux/videodev2.h>
16 #include <linux/workqueue.h>
17 #include <media/media-device.h>
18 #include <media/v4l2-device.h>
19 #include <media/v4l2-event.h>
20 #include <media/v4l2-fh.h>
21 #include <media/videobuf2-v4l2.h>
23 /* --------------------------------------------------------------------------
27 #define UVC_TERM_INPUT 0x0000
28 #define UVC_TERM_OUTPUT 0x8000
29 #define UVC_TERM_DIRECTION(term) ((term)->type & 0x8000)
31 #define UVC_ENTITY_TYPE(entity) ((entity)->type & 0x7fff)
32 #define UVC_ENTITY_IS_UNIT(entity) (((entity)->type & 0xff00) == 0)
33 #define UVC_ENTITY_IS_TERM(entity) (((entity)->type & 0xff00) != 0)
34 #define UVC_ENTITY_IS_ITERM(entity) \
35 (UVC_ENTITY_IS_TERM(entity) && \
36 ((entity)->type & 0x8000) == UVC_TERM_INPUT)
37 #define UVC_ENTITY_IS_OTERM(entity) \
38 (UVC_ENTITY_IS_TERM(entity) && \
39 ((entity)->type & 0x8000) == UVC_TERM_OUTPUT)
41 #define UVC_EXT_GPIO_UNIT 0x7ffe
42 #define UVC_EXT_GPIO_UNIT_ID 0x100
44 /* ------------------------------------------------------------------------
47 #define UVC_GUID_UVC_CAMERA \
48 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
49 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01}
50 #define UVC_GUID_UVC_OUTPUT \
51 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
52 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02}
53 #define UVC_GUID_UVC_MEDIA_TRANSPORT_INPUT \
54 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
55 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03}
56 #define UVC_GUID_UVC_PROCESSING \
57 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
58 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x01}
59 #define UVC_GUID_UVC_SELECTOR \
60 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
61 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x02}
62 #define UVC_GUID_EXT_GPIO_CONTROLLER \
63 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
64 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x03}
66 #define UVC_GUID_FORMAT_MJPEG \
67 { 'M', 'J', 'P', 'G', 0x00, 0x00, 0x10, 0x00, \
68 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
69 #define UVC_GUID_FORMAT_YUY2 \
70 { 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \
71 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
72 #define UVC_GUID_FORMAT_YUY2_ISIGHT \
73 { 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \
74 0x80, 0x00, 0x00, 0x00, 0x00, 0x38, 0x9b, 0x71}
75 #define UVC_GUID_FORMAT_NV12 \
76 { 'N', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
77 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
78 #define UVC_GUID_FORMAT_YV12 \
79 { 'Y', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
80 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
81 #define UVC_GUID_FORMAT_I420 \
82 { 'I', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \
83 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
84 #define UVC_GUID_FORMAT_UYVY \
85 { 'U', 'Y', 'V', 'Y', 0x00, 0x00, 0x10, 0x00, \
86 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
87 #define UVC_GUID_FORMAT_Y800 \
88 { 'Y', '8', '0', '0', 0x00, 0x00, 0x10, 0x00, \
89 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
90 #define UVC_GUID_FORMAT_Y8 \
91 { 'Y', '8', ' ', ' ', 0x00, 0x00, 0x10, 0x00, \
92 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
93 #define UVC_GUID_FORMAT_Y10 \
94 { 'Y', '1', '0', ' ', 0x00, 0x00, 0x10, 0x00, \
95 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
96 #define UVC_GUID_FORMAT_Y12 \
97 { 'Y', '1', '2', ' ', 0x00, 0x00, 0x10, 0x00, \
98 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
99 #define UVC_GUID_FORMAT_Y16 \
100 { 'Y', '1', '6', ' ', 0x00, 0x00, 0x10, 0x00, \
101 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
102 #define UVC_GUID_FORMAT_BY8 \
103 { 'B', 'Y', '8', ' ', 0x00, 0x00, 0x10, 0x00, \
104 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
105 #define UVC_GUID_FORMAT_BA81 \
106 { 'B', 'A', '8', '1', 0x00, 0x00, 0x10, 0x00, \
107 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
108 #define UVC_GUID_FORMAT_GBRG \
109 { 'G', 'B', 'R', 'G', 0x00, 0x00, 0x10, 0x00, \
110 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
111 #define UVC_GUID_FORMAT_GRBG \
112 { 'G', 'R', 'B', 'G', 0x00, 0x00, 0x10, 0x00, \
113 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
114 #define UVC_GUID_FORMAT_RGGB \
115 { 'R', 'G', 'G', 'B', 0x00, 0x00, 0x10, 0x00, \
116 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
117 #define UVC_GUID_FORMAT_BG16 \
118 { 'B', 'G', '1', '6', 0x00, 0x00, 0x10, 0x00, \
119 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
120 #define UVC_GUID_FORMAT_GB16 \
121 { 'G', 'B', '1', '6', 0x00, 0x00, 0x10, 0x00, \
122 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
123 #define UVC_GUID_FORMAT_RG16 \
124 { 'R', 'G', '1', '6', 0x00, 0x00, 0x10, 0x00, \
125 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
126 #define UVC_GUID_FORMAT_GR16 \
127 { 'G', 'R', '1', '6', 0x00, 0x00, 0x10, 0x00, \
128 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
129 #define UVC_GUID_FORMAT_RGBP \
130 { 'R', 'G', 'B', 'P', 0x00, 0x00, 0x10, 0x00, \
131 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
132 #define UVC_GUID_FORMAT_BGR3 \
133 { 0x7d, 0xeb, 0x36, 0xe4, 0x4f, 0x52, 0xce, 0x11, \
134 0x9f, 0x53, 0x00, 0x20, 0xaf, 0x0b, 0xa7, 0x70}
135 #define UVC_GUID_FORMAT_M420 \
136 { 'M', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \
137 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
139 #define UVC_GUID_FORMAT_H264 \
140 { 'H', '2', '6', '4', 0x00, 0x00, 0x10, 0x00, \
141 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
142 #define UVC_GUID_FORMAT_Y8I \
143 { 'Y', '8', 'I', ' ', 0x00, 0x00, 0x10, 0x00, \
144 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
145 #define UVC_GUID_FORMAT_Y12I \
146 { 'Y', '1', '2', 'I', 0x00, 0x00, 0x10, 0x00, \
147 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
148 #define UVC_GUID_FORMAT_Z16 \
149 { 'Z', '1', '6', ' ', 0x00, 0x00, 0x10, 0x00, \
150 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
151 #define UVC_GUID_FORMAT_RW10 \
152 { 'R', 'W', '1', '0', 0x00, 0x00, 0x10, 0x00, \
153 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
154 #define UVC_GUID_FORMAT_INVZ \
155 { 'I', 'N', 'V', 'Z', 0x90, 0x2d, 0x58, 0x4a, \
156 0x92, 0x0b, 0x77, 0x3f, 0x1f, 0x2c, 0x55, 0x6b}
157 #define UVC_GUID_FORMAT_INZI \
158 { 'I', 'N', 'Z', 'I', 0x66, 0x1a, 0x42, 0xa2, \
159 0x90, 0x65, 0xd0, 0x18, 0x14, 0xa8, 0xef, 0x8a}
160 #define UVC_GUID_FORMAT_INVI \
161 { 'I', 'N', 'V', 'I', 0xdb, 0x57, 0x49, 0x5e, \
162 0x8e, 0x3f, 0xf4, 0x79, 0x53, 0x2b, 0x94, 0x6f}
163 #define UVC_GUID_FORMAT_CNF4 \
164 { 'C', ' ', ' ', ' ', 0x00, 0x00, 0x10, 0x00, \
165 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
167 #define UVC_GUID_FORMAT_D3DFMT_L8 \
168 {0x32, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, \
169 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
170 #define UVC_GUID_FORMAT_KSMEDIA_L8_IR \
171 {0x32, 0x00, 0x00, 0x00, 0x02, 0x00, 0x10, 0x00, \
172 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
174 #define UVC_GUID_FORMAT_HEVC \
175 { 'H', 'E', 'V', 'C', 0x00, 0x00, 0x10, 0x00, \
176 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
179 /* ------------------------------------------------------------------------
180 * Driver specific constants.
183 #define DRIVER_VERSION "1.1.1"
185 /* Number of isochronous URBs. */
187 /* Maximum number of packets per URB. */
188 #define UVC_MAX_PACKETS 32
189 /* Maximum status buffer size in bytes of interrupt URB. */
190 #define UVC_MAX_STATUS_SIZE 16
192 #define UVC_CTRL_CONTROL_TIMEOUT 500
193 #define UVC_CTRL_STREAMING_TIMEOUT 5000
195 /* Maximum allowed number of control mappings per device */
196 #define UVC_MAX_CONTROL_MAPPINGS 1024
197 #define UVC_MAX_CONTROL_MENU_ENTRIES 32
200 #define UVC_QUIRK_STATUS_INTERVAL 0x00000001
201 #define UVC_QUIRK_PROBE_MINMAX 0x00000002
202 #define UVC_QUIRK_PROBE_EXTRAFIELDS 0x00000004
203 #define UVC_QUIRK_BUILTIN_ISIGHT 0x00000008
204 #define UVC_QUIRK_STREAM_NO_FID 0x00000010
205 #define UVC_QUIRK_IGNORE_SELECTOR_UNIT 0x00000020
206 #define UVC_QUIRK_FIX_BANDWIDTH 0x00000080
207 #define UVC_QUIRK_PROBE_DEF 0x00000100
208 #define UVC_QUIRK_RESTRICT_FRAME_RATE 0x00000200
209 #define UVC_QUIRK_RESTORE_CTRLS_ON_INIT 0x00000400
210 #define UVC_QUIRK_FORCE_Y8 0x00000800
211 #define UVC_QUIRK_FORCE_BPP 0x00001000
214 #define UVC_FMT_FLAG_COMPRESSED 0x00000001
215 #define UVC_FMT_FLAG_STREAM 0x00000002
217 /* ------------------------------------------------------------------------
224 /* TODO: Put the most frequently accessed fields at the beginning of
225 * structures to maximize cache efficiency.
227 struct uvc_control_info {
228 struct list_head mappings;
231 u8 index; /* Bit index in bmControls */
238 struct uvc_control_mapping {
239 struct list_head list;
240 struct list_head ev_subs;
249 enum v4l2_ctrl_type v4l2_type;
252 const struct uvc_menu_info *menu_info;
259 s32 (*get)(struct uvc_control_mapping *mapping, u8 query,
261 void (*set)(struct uvc_control_mapping *mapping, s32 value,
266 struct uvc_entity *entity;
267 struct uvc_control_info info;
269 u8 index; /* Used to match the uvc_control entry with a
279 struct uvc_fh *handle; /* File handle that last changed the control. */
282 struct uvc_format_desc {
288 /* The term 'entity' refers to both UVC units and UVC terminals.
290 * The type field is either the terminal type (wTerminalType in the terminal
291 * descriptor), or the unit type (bDescriptorSubtype in the unit descriptor).
292 * As the bDescriptorSubtype field is one byte long, the type value will
293 * always have a null MSB for units. All terminal types defined by the UVC
294 * specification have a non-null MSB, so it is safe to use the MSB to
295 * differentiate between units and terminals as long as the descriptor parsing
296 * code makes sure terminal types have a non-null MSB.
298 * For terminals, the type's most significant bit stores the terminal
299 * direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should
300 * always be accessed with the UVC_ENTITY_* macros and never directly.
303 #define UVC_ENTITY_FLAG_DEFAULT (1 << 0)
306 struct list_head list; /* Entity as part of a UVC device. */
307 struct list_head chain; /* Entity as part of a video device
312 * Entities exposed by the UVC device use IDs 0-255, extra entities
313 * implemented by the driver (such as the GPIO entity) use IDs 256 and
321 /* Media controller-related fields. */
322 struct video_device *vdev;
323 struct v4l2_subdev subdev;
324 unsigned int num_pads;
325 unsigned int num_links;
326 struct media_pad *pads;
330 u16 wObjectiveFocalLengthMin;
331 u16 wObjectiveFocalLengthMax;
332 u16 wOcularFocalLength;
340 u8 bTransportModeSize;
341 u8 *bmTransportModes;
367 struct gpio_desc *gpio_privacy;
375 int (*get_info)(struct uvc_device *dev, struct uvc_entity *entity,
377 int (*get_cur)(struct uvc_device *dev, struct uvc_entity *entity,
378 u8 cs, void *data, u16 size);
380 unsigned int ncontrols;
381 struct uvc_control *controls;
391 u32 dwMaxVideoFrameBufferSize;
392 u8 bFrameIntervalType;
393 u32 dwDefaultFrameInterval;
394 u32 *dwFrameInterval;
401 enum v4l2_colorspace colorspace;
402 enum v4l2_xfer_func xfer_func;
403 enum v4l2_ycbcr_encoding ycbcr_enc;
409 unsigned int nframes;
410 struct uvc_frame *frame;
413 struct uvc_streaming_header {
419 /* The following fields are used by input headers only. */
421 u8 bStillCaptureMethod;
426 enum uvc_buffer_state {
427 UVC_BUF_STATE_IDLE = 0,
428 UVC_BUF_STATE_QUEUED = 1,
429 UVC_BUF_STATE_ACTIVE = 2,
430 UVC_BUF_STATE_READY = 3,
431 UVC_BUF_STATE_DONE = 4,
432 UVC_BUF_STATE_ERROR = 5,
436 struct vb2_v4l2_buffer buf;
437 struct list_head queue;
439 enum uvc_buffer_state state;
444 unsigned int bytesused;
448 /* Asynchronous buffer handling. */
452 #define UVC_QUEUE_DISCONNECTED (1 << 0)
453 #define UVC_QUEUE_DROP_CORRUPTED (1 << 1)
455 struct uvc_video_queue {
456 struct vb2_queue queue;
457 struct mutex mutex; /* Protects queue */
460 unsigned int buf_used;
462 spinlock_t irqlock; /* Protects irqqueue */
463 struct list_head irqqueue;
466 struct uvc_video_chain {
467 struct uvc_device *dev;
468 struct list_head list;
470 struct list_head entities; /* All entities */
471 struct uvc_entity *processing; /* Processing unit */
472 struct uvc_entity *selector; /* Selector unit */
474 struct mutex ctrl_mutex; /* Protects ctrl.info */
476 struct v4l2_prio_state prio; /* V4L2 priority state */
477 u32 caps; /* V4L2 chain-wide caps */
480 struct uvc_stats_frame {
481 unsigned int size; /* Number of bytes captured */
482 unsigned int first_data; /* Index of the first non-empty packet */
484 unsigned int nb_packets; /* Number of packets */
485 unsigned int nb_empty; /* Number of empty packets */
486 unsigned int nb_invalid; /* Number of packets with an invalid header */
487 unsigned int nb_errors; /* Number of packets with the error bit set */
489 unsigned int nb_pts; /* Number of packets with a PTS timestamp */
490 unsigned int nb_pts_diffs; /* Number of PTS differences inside a frame */
491 unsigned int last_pts_diff; /* Index of the last PTS difference */
492 bool has_initial_pts; /* Whether the first non-empty packet has a PTS */
493 bool has_early_pts; /* Whether a PTS is present before the first non-empty packet */
494 u32 pts; /* PTS of the last packet */
496 unsigned int nb_scr; /* Number of packets with a SCR timestamp */
497 unsigned int nb_scr_diffs; /* Number of SCR.STC differences inside a frame */
498 u16 scr_sof; /* SCR.SOF of the last packet */
499 u32 scr_stc; /* SCR.STC of the last packet */
502 struct uvc_stats_stream {
503 ktime_t start_ts; /* Stream start timestamp */
504 ktime_t stop_ts; /* Stream stop timestamp */
506 unsigned int nb_frames; /* Number of frames */
508 unsigned int nb_packets; /* Number of packets */
509 unsigned int nb_empty; /* Number of empty packets */
510 unsigned int nb_invalid; /* Number of packets with an invalid header */
511 unsigned int nb_errors; /* Number of packets with the error bit set */
513 unsigned int nb_pts_constant; /* Number of frames with constant PTS */
514 unsigned int nb_pts_early; /* Number of frames with early PTS */
515 unsigned int nb_pts_initial; /* Number of frames with initial PTS */
517 unsigned int nb_scr_count_ok; /* Number of frames with at least one SCR per non empty packet */
518 unsigned int nb_scr_diffs_ok; /* Number of frames with varying SCR.STC */
519 unsigned int scr_sof_count; /* STC.SOF counter accumulated since stream start */
520 unsigned int scr_sof; /* STC.SOF of the last packet */
521 unsigned int min_sof; /* Minimum STC.SOF value */
522 unsigned int max_sof; /* Maximum STC.SOF value */
525 #define UVC_METADATA_BUF_SIZE 1024
528 * struct uvc_copy_op: Context structure to schedule asynchronous memcpy
530 * @buf: active buf object for this operation
531 * @dst: copy destination address
532 * @src: copy source address
536 struct uvc_buffer *buf;
543 * struct uvc_urb - URB context management structure
545 * @urb: the URB described by this context structure
546 * @stream: UVC streaming context
547 * @buffer: memory storage for the URB
548 * @dma: DMA coherent addressing for the urb_buffer
549 * @async_operations: counter to indicate the number of copy operations
550 * @copy_operations: work descriptors for asynchronous copy operations
551 * @work: work queue entry for asynchronous decode
555 struct uvc_streaming *stream;
560 unsigned int async_operations;
561 struct uvc_copy_op copy_operations[UVC_MAX_PACKETS];
562 struct work_struct work;
565 struct uvc_streaming {
566 struct list_head list;
567 struct uvc_device *dev;
568 struct video_device vdev;
569 struct uvc_video_chain *chain;
572 struct usb_interface *intf;
576 struct uvc_streaming_header header;
577 enum v4l2_buf_type type;
579 unsigned int nformats;
580 struct uvc_format *format;
582 struct uvc_streaming_control ctrl;
583 struct uvc_format *def_format;
584 struct uvc_format *cur_format;
585 struct uvc_frame *cur_frame;
587 /* Protect access to ctrl, cur_format, cur_frame and hardware video
593 unsigned int frozen : 1;
594 struct uvc_video_queue queue;
595 struct workqueue_struct *async_wq;
596 void (*decode)(struct uvc_urb *uvc_urb, struct uvc_buffer *buf,
597 struct uvc_buffer *meta_buf);
600 struct video_device vdev;
601 struct uvc_video_queue queue;
605 /* Context data used by the bulk completion handler. */
608 unsigned int header_size;
611 u32 max_payload_size;
614 struct uvc_urb uvc_urb[UVC_URBS];
615 unsigned int urb_size;
621 struct dentry *debugfs_dir;
623 struct uvc_stats_frame frame;
624 struct uvc_stats_stream stream;
627 /* Timestamps support. */
629 struct uvc_clock_sample {
649 #define for_each_uvc_urb(uvc_urb, uvc_streaming) \
650 for ((uvc_urb) = &(uvc_streaming)->uvc_urb[0]; \
651 (uvc_urb) < &(uvc_streaming)->uvc_urb[UVC_URBS]; \
654 static inline u32 uvc_urb_index(const struct uvc_urb *uvc_urb)
656 return uvc_urb - &uvc_urb->stream->uvc_urb[0];
659 struct uvc_device_info {
666 struct usb_device *udev;
667 struct usb_interface *intf;
668 unsigned long warnings;
673 const struct uvc_device_info *info;
675 struct mutex lock; /* Protects users */
679 /* Video control interface */
680 #ifdef CONFIG_MEDIA_CONTROLLER
681 struct media_device mdev;
683 struct v4l2_device vdev;
687 struct list_head entities;
688 struct list_head chains;
690 /* Video Streaming interfaces */
691 struct list_head streams;
694 /* Status Interrupt Endpoint */
695 struct usb_host_endpoint *int_ep;
698 struct input_dev *input;
701 struct uvc_ctrl_work {
702 struct work_struct work;
704 struct uvc_video_chain *chain;
705 struct uvc_control *ctrl;
709 struct uvc_entity *gpio_unit;
712 enum uvc_handle_state {
713 UVC_HANDLE_PASSIVE = 0,
714 UVC_HANDLE_ACTIVE = 1,
719 struct uvc_video_chain *chain;
720 struct uvc_streaming *stream;
721 enum uvc_handle_state state;
725 struct usb_driver driver;
728 /* ------------------------------------------------------------------------
729 * Debugging, printing and logging
732 #define UVC_DBG_PROBE (1 << 0)
733 #define UVC_DBG_DESCR (1 << 1)
734 #define UVC_DBG_CONTROL (1 << 2)
735 #define UVC_DBG_FORMAT (1 << 3)
736 #define UVC_DBG_CAPTURE (1 << 4)
737 #define UVC_DBG_CALLS (1 << 5)
738 #define UVC_DBG_FRAME (1 << 7)
739 #define UVC_DBG_SUSPEND (1 << 8)
740 #define UVC_DBG_STATUS (1 << 9)
741 #define UVC_DBG_VIDEO (1 << 10)
742 #define UVC_DBG_STATS (1 << 11)
743 #define UVC_DBG_CLOCK (1 << 12)
745 #define UVC_WARN_MINMAX 0
746 #define UVC_WARN_PROBE_DEF 1
747 #define UVC_WARN_XU_GET_RES 2
749 extern unsigned int uvc_clock_param;
750 extern unsigned int uvc_no_drop_param;
751 extern unsigned int uvc_dbg_param;
752 extern unsigned int uvc_timeout_param;
753 extern unsigned int uvc_hw_timestamps_param;
755 #define uvc_dbg(_dev, flag, fmt, ...) \
757 if (uvc_dbg_param & UVC_DBG_##flag) \
758 dev_printk(KERN_DEBUG, &(_dev)->udev->dev, fmt, \
762 #define uvc_dbg_cont(flag, fmt, ...) \
764 if (uvc_dbg_param & UVC_DBG_##flag) \
765 pr_cont(fmt, ##__VA_ARGS__); \
768 #define uvc_warn_once(_dev, warn, fmt, ...) \
770 if (!test_and_set_bit(warn, &(_dev)->warnings)) \
771 dev_info(&(_dev)->udev->dev, fmt, ##__VA_ARGS__); \
774 /* --------------------------------------------------------------------------
775 * Internal functions.
779 extern struct uvc_driver uvc_driver;
781 struct uvc_entity *uvc_entity_by_id(struct uvc_device *dev, int id);
783 /* Video buffers queue management. */
784 int uvc_queue_init(struct uvc_video_queue *queue, enum v4l2_buf_type type,
786 void uvc_queue_release(struct uvc_video_queue *queue);
787 int uvc_request_buffers(struct uvc_video_queue *queue,
788 struct v4l2_requestbuffers *rb);
789 int uvc_query_buffer(struct uvc_video_queue *queue,
790 struct v4l2_buffer *v4l2_buf);
791 int uvc_create_buffers(struct uvc_video_queue *queue,
792 struct v4l2_create_buffers *v4l2_cb);
793 int uvc_queue_buffer(struct uvc_video_queue *queue,
794 struct media_device *mdev,
795 struct v4l2_buffer *v4l2_buf);
796 int uvc_export_buffer(struct uvc_video_queue *queue,
797 struct v4l2_exportbuffer *exp);
798 int uvc_dequeue_buffer(struct uvc_video_queue *queue,
799 struct v4l2_buffer *v4l2_buf, int nonblocking);
800 int uvc_queue_streamon(struct uvc_video_queue *queue, enum v4l2_buf_type type);
801 int uvc_queue_streamoff(struct uvc_video_queue *queue, enum v4l2_buf_type type);
802 void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect);
803 struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue,
804 struct uvc_buffer *buf);
805 struct uvc_buffer *uvc_queue_get_current_buffer(struct uvc_video_queue *queue);
806 void uvc_queue_buffer_release(struct uvc_buffer *buf);
807 int uvc_queue_mmap(struct uvc_video_queue *queue,
808 struct vm_area_struct *vma);
809 __poll_t uvc_queue_poll(struct uvc_video_queue *queue, struct file *file,
812 unsigned long uvc_queue_get_unmapped_area(struct uvc_video_queue *queue,
813 unsigned long pgoff);
815 int uvc_queue_allocated(struct uvc_video_queue *queue);
816 static inline int uvc_queue_streaming(struct uvc_video_queue *queue)
818 return vb2_is_streaming(&queue->queue);
821 static inline struct uvc_streaming *
822 uvc_queue_to_stream(struct uvc_video_queue *queue)
824 return container_of(queue, struct uvc_streaming, queue);
828 extern const struct v4l2_ioctl_ops uvc_ioctl_ops;
829 extern const struct v4l2_file_operations uvc_fops;
831 /* Media controller */
832 int uvc_mc_register_entities(struct uvc_video_chain *chain);
833 void uvc_mc_cleanup_entity(struct uvc_entity *entity);
836 int uvc_video_init(struct uvc_streaming *stream);
837 int uvc_video_suspend(struct uvc_streaming *stream);
838 int uvc_video_resume(struct uvc_streaming *stream, int reset);
839 int uvc_video_start_streaming(struct uvc_streaming *stream);
840 void uvc_video_stop_streaming(struct uvc_streaming *stream);
841 int uvc_probe_video(struct uvc_streaming *stream,
842 struct uvc_streaming_control *probe);
843 int uvc_query_ctrl(struct uvc_device *dev, u8 query, u8 unit,
844 u8 intfnum, u8 cs, void *data, u16 size);
845 void uvc_video_clock_update(struct uvc_streaming *stream,
846 struct vb2_v4l2_buffer *vbuf,
847 struct uvc_buffer *buf);
848 int uvc_meta_register(struct uvc_streaming *stream);
850 int uvc_register_video_device(struct uvc_device *dev,
851 struct uvc_streaming *stream,
852 struct video_device *vdev,
853 struct uvc_video_queue *queue,
854 enum v4l2_buf_type type,
855 const struct v4l2_file_operations *fops,
856 const struct v4l2_ioctl_ops *ioctl_ops);
859 int uvc_status_init(struct uvc_device *dev);
860 void uvc_status_unregister(struct uvc_device *dev);
861 void uvc_status_cleanup(struct uvc_device *dev);
862 int uvc_status_start(struct uvc_device *dev, gfp_t flags);
863 void uvc_status_stop(struct uvc_device *dev);
866 extern const struct v4l2_subscribed_event_ops uvc_ctrl_sub_ev_ops;
868 int uvc_query_v4l2_ctrl(struct uvc_video_chain *chain,
869 struct v4l2_queryctrl *v4l2_ctrl);
870 int uvc_query_v4l2_menu(struct uvc_video_chain *chain,
871 struct v4l2_querymenu *query_menu);
873 int uvc_ctrl_add_mapping(struct uvc_video_chain *chain,
874 const struct uvc_control_mapping *mapping);
875 int uvc_ctrl_init_device(struct uvc_device *dev);
876 void uvc_ctrl_cleanup_device(struct uvc_device *dev);
877 int uvc_ctrl_restore_values(struct uvc_device *dev);
878 bool uvc_ctrl_status_event_async(struct urb *urb, struct uvc_video_chain *chain,
879 struct uvc_control *ctrl, const u8 *data);
880 void uvc_ctrl_status_event(struct uvc_video_chain *chain,
881 struct uvc_control *ctrl, const u8 *data);
883 int uvc_ctrl_begin(struct uvc_video_chain *chain);
884 int __uvc_ctrl_commit(struct uvc_fh *handle, int rollback,
885 const struct v4l2_ext_control *xctrls,
886 unsigned int xctrls_count);
887 static inline int uvc_ctrl_commit(struct uvc_fh *handle,
888 const struct v4l2_ext_control *xctrls,
889 unsigned int xctrls_count)
891 return __uvc_ctrl_commit(handle, 0, xctrls, xctrls_count);
893 static inline int uvc_ctrl_rollback(struct uvc_fh *handle)
895 return __uvc_ctrl_commit(handle, 1, NULL, 0);
898 int uvc_ctrl_get(struct uvc_video_chain *chain, struct v4l2_ext_control *xctrl);
899 int uvc_ctrl_set(struct uvc_fh *handle, struct v4l2_ext_control *xctrl);
901 int uvc_xu_ctrl_query(struct uvc_video_chain *chain,
902 struct uvc_xu_control_query *xqry);
904 /* Utility functions */
905 void uvc_simplify_fraction(u32 *numerator, u32 *denominator,
906 unsigned int n_terms, unsigned int threshold);
907 u32 uvc_fraction_to_interval(u32 numerator, u32 denominator);
908 struct usb_host_endpoint *uvc_find_endpoint(struct usb_host_interface *alts,
912 void uvc_video_decode_isight(struct uvc_urb *uvc_urb,
913 struct uvc_buffer *buf,
914 struct uvc_buffer *meta_buf);
916 /* debugfs and statistics */
917 void uvc_debugfs_init(void);
918 void uvc_debugfs_cleanup(void);
919 void uvc_debugfs_init_stream(struct uvc_streaming *stream);
920 void uvc_debugfs_cleanup_stream(struct uvc_streaming *stream);
922 size_t uvc_video_stats_dump(struct uvc_streaming *stream, char *buf,