1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _USB_VIDEO_H_
3 #define _USB_VIDEO_H_
4
5 #ifndef __KERNEL__
6 #error "The uvcvideo.h header is deprecated, use linux/uvcvideo.h instead."
7 #endif /* __KERNEL__ */
8
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>
22
23 /* --------------------------------------------------------------------------
24 * UVC constants
25 */
26
27 #define UVC_TERM_INPUT 0x0000
28 #define UVC_TERM_OUTPUT 0x8000
29 #define UVC_TERM_DIRECTION(term) ((term)->type & 0x8000)
30
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)
40
41 #define UVC_EXT_GPIO_UNIT 0x7ffe
42 #define UVC_EXT_GPIO_UNIT_ID 0x100
43
44 /* ------------------------------------------------------------------------
45 * GUIDs
46 */
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}
65
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}
138
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}
166
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}
173
174 #define UVC_GUID_FORMAT_HEVC \
175 { 'H', 'E', 'V', 'C', 0x00, 0x00, 0x10, 0x00, \
176 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
177
178
179 /* ------------------------------------------------------------------------
180 * Driver specific constants.
181 */
182
183 #define DRIVER_VERSION "1.1.1"
184
185 /* Number of isochronous URBs. */
186 #define UVC_URBS 2U
187 /* Maximum number of packets per URB. */
188 #define UVC_MAX_PACKETS 128U /* at 8000 FPS */
189 /* Maximum status buffer size in bytes of interrupt URB. */
190 #define UVC_MAX_STATUS_SIZE 16
191
192 #define UVC_CTRL_CONTROL_TIMEOUT 500
193 #define UVC_CTRL_STREAMING_TIMEOUT 5000
194
195 /* Maximum allowed number of control mappings per device */
196 #define UVC_MAX_CONTROL_MAPPINGS 1024
197 #define UVC_MAX_CONTROL_MENU_ENTRIES 32
198
199 /* Devices quirks */
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
212
213 /* Format flags */
214 #define UVC_FMT_FLAG_COMPRESSED 0x00000001
215 #define UVC_FMT_FLAG_STREAM 0x00000002
216
217 /* ------------------------------------------------------------------------
218 * Structures.
219 */
220
221 struct gpio_desc;
222 struct sg_table;
223 struct uvc_device;
224
225 /* TODO: Put the most frequently accessed fields at the beginning of
226 * structures to maximize cache efficiency.
227 */
228 struct uvc_control_info {
229 struct list_head mappings;
230
231 u8 entity[16];
232 u8 index; /* Bit index in bmControls */
233 u8 selector;
234
235 u16 size;
236 u32 flags;
237 };
238
239 struct uvc_control_mapping {
240 struct list_head list;
241 struct list_head ev_subs;
242
243 u32 id;
244 u8 name[32];
245 u8 entity[16];
246 u8 selector;
247
248 u8 size;
249 u8 offset;
250 enum v4l2_ctrl_type v4l2_type;
251 u32 data_type;
252
253 const struct uvc_menu_info *menu_info;
254 u32 menu_count;
255
256 u32 master_id;
257 s32 master_manual;
258 u32 slave_ids[2];
259
260 s32 (*get)(struct uvc_control_mapping *mapping, u8 query,
261 const u8 *data);
262 void (*set)(struct uvc_control_mapping *mapping, s32 value,
263 u8 *data);
264 };
265
266 struct uvc_control {
267 struct uvc_entity *entity;
268 struct uvc_control_info info;
269
270 u8 index; /* Used to match the uvc_control entry with a
271 uvc_control_info. */
272 u8 dirty:1,
273 loaded:1,
274 modified:1,
275 cached:1,
276 initialized:1;
277
278 u8 *uvc_data;
279
280 struct uvc_fh *handle; /* File handle that last changed the control. */
281 };
282
283 struct uvc_format_desc {
284 char *name;
285 u8 guid[16];
286 u32 fcc;
287 };
288
289 /* The term 'entity' refers to both UVC units and UVC terminals.
290 *
291 * The type field is either the terminal type (wTerminalType in the terminal
292 * descriptor), or the unit type (bDescriptorSubtype in the unit descriptor).
293 * As the bDescriptorSubtype field is one byte long, the type value will
294 * always have a null MSB for units. All terminal types defined by the UVC
295 * specification have a non-null MSB, so it is safe to use the MSB to
296 * differentiate between units and terminals as long as the descriptor parsing
297 * code makes sure terminal types have a non-null MSB.
298 *
299 * For terminals, the type's most significant bit stores the terminal
300 * direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should
301 * always be accessed with the UVC_ENTITY_* macros and never directly.
302 */
303
304 #define UVC_ENTITY_FLAG_DEFAULT (1 << 0)
305
306 struct uvc_entity {
307 struct list_head list; /* Entity as part of a UVC device. */
308 struct list_head chain; /* Entity as part of a video device
309 * chain. */
310 unsigned int flags;
311
312 /*
313 * Entities exposed by the UVC device use IDs 0-255, extra entities
314 * implemented by the driver (such as the GPIO entity) use IDs 256 and
315 * up.
316 */
317 u16 id;
318 u16 type;
319 char name[64];
320 u8 guid[16];
321
322 /* Media controller-related fields. */
323 struct video_device *vdev;
324 struct v4l2_subdev subdev;
325 unsigned int num_pads;
326 unsigned int num_links;
327 struct media_pad *pads;
328
329 union {
330 struct {
331 u16 wObjectiveFocalLengthMin;
332 u16 wObjectiveFocalLengthMax;
333 u16 wOcularFocalLength;
334 u8 bControlSize;
335 u8 *bmControls;
336 } camera;
337
338 struct {
339 u8 bControlSize;
340 u8 *bmControls;
341 u8 bTransportModeSize;
342 u8 *bmTransportModes;
343 } media;
344
345 struct {
346 } output;
347
348 struct {
349 u16 wMaxMultiplier;
350 u8 bControlSize;
351 u8 *bmControls;
352 u8 bmVideoStandards;
353 } processing;
354
355 struct {
356 } selector;
357
358 struct {
359 u8 bNumControls;
360 u8 bControlSize;
361 u8 *bmControls;
362 u8 *bmControlsType;
363 } extension;
364
365 struct {
366 u8 bControlSize;
367 u8 *bmControls;
368 struct gpio_desc *gpio_privacy;
369 int irq;
370 } gpio;
371 };
372
373 u8 bNrInPins;
374 u8 *baSourceID;
375
376 int (*get_info)(struct uvc_device *dev, struct uvc_entity *entity,
377 u8 cs, u8 *caps);
378 int (*get_cur)(struct uvc_device *dev, struct uvc_entity *entity,
379 u8 cs, void *data, u16 size);
380
381 unsigned int ncontrols;
382 struct uvc_control *controls;
383 };
384
385 struct uvc_frame {
386 u8 bFrameIndex;
387 u8 bmCapabilities;
388 u16 wWidth;
389 u16 wHeight;
390 u32 dwMinBitRate;
391 u32 dwMaxBitRate;
392 u32 dwMaxVideoFrameBufferSize;
393 u8 bFrameIntervalType;
394 u32 dwDefaultFrameInterval;
395 u32 *dwFrameInterval;
396 };
397
398 struct uvc_format {
399 u8 type;
400 u8 index;
401 u8 bpp;
402 enum v4l2_colorspace colorspace;
403 enum v4l2_xfer_func xfer_func;
404 enum v4l2_ycbcr_encoding ycbcr_enc;
405 u32 fcc;
406 u32 flags;
407
408 char name[32];
409
410 unsigned int nframes;
411 struct uvc_frame *frame;
412 };
413
414 struct uvc_streaming_header {
415 u8 bNumFormats;
416 u8 bEndpointAddress;
417 u8 bTerminalLink;
418 u8 bControlSize;
419 u8 *bmaControls;
420 /* The following fields are used by input headers only. */
421 u8 bmInfo;
422 u8 bStillCaptureMethod;
423 u8 bTriggerSupport;
424 u8 bTriggerUsage;
425 };
426
427 enum uvc_buffer_state {
428 UVC_BUF_STATE_IDLE = 0,
429 UVC_BUF_STATE_QUEUED = 1,
430 UVC_BUF_STATE_ACTIVE = 2,
431 UVC_BUF_STATE_READY = 3,
432 UVC_BUF_STATE_DONE = 4,
433 UVC_BUF_STATE_ERROR = 5,
434 };
435
436 struct uvc_buffer {
437 struct vb2_v4l2_buffer buf;
438 struct list_head queue;
439
440 enum uvc_buffer_state state;
441 unsigned int error;
442
443 void *mem;
444 unsigned int length;
445 unsigned int bytesused;
446
447 u32 pts;
448
449 /* Asynchronous buffer handling. */
450 struct kref ref;
451 };
452
453 #define UVC_QUEUE_DISCONNECTED (1 << 0)
454 #define UVC_QUEUE_DROP_CORRUPTED (1 << 1)
455
456 struct uvc_video_queue {
457 struct vb2_queue queue;
458 struct mutex mutex; /* Protects queue */
459
460 unsigned int flags;
461 unsigned int buf_used;
462
463 spinlock_t irqlock; /* Protects irqqueue */
464 struct list_head irqqueue;
465 };
466
467 struct uvc_video_chain {
468 struct uvc_device *dev;
469 struct list_head list;
470
471 struct list_head entities; /* All entities */
472 struct uvc_entity *processing; /* Processing unit */
473 struct uvc_entity *selector; /* Selector unit */
474
475 struct mutex ctrl_mutex; /* Protects ctrl.info */
476
477 struct v4l2_prio_state prio; /* V4L2 priority state */
478 u32 caps; /* V4L2 chain-wide caps */
479 };
480
481 struct uvc_stats_frame {
482 unsigned int size; /* Number of bytes captured */
483 unsigned int first_data; /* Index of the first non-empty packet */
484
485 unsigned int nb_packets; /* Number of packets */
486 unsigned int nb_empty; /* Number of empty packets */
487 unsigned int nb_invalid; /* Number of packets with an invalid header */
488 unsigned int nb_errors; /* Number of packets with the error bit set */
489
490 unsigned int nb_pts; /* Number of packets with a PTS timestamp */
491 unsigned int nb_pts_diffs; /* Number of PTS differences inside a frame */
492 unsigned int last_pts_diff; /* Index of the last PTS difference */
493 bool has_initial_pts; /* Whether the first non-empty packet has a PTS */
494 bool has_early_pts; /* Whether a PTS is present before the first non-empty packet */
495 u32 pts; /* PTS of the last packet */
496
497 unsigned int nb_scr; /* Number of packets with a SCR timestamp */
498 unsigned int nb_scr_diffs; /* Number of SCR.STC differences inside a frame */
499 u16 scr_sof; /* SCR.SOF of the last packet */
500 u32 scr_stc; /* SCR.STC of the last packet */
501 };
502
503 struct uvc_stats_stream {
504 ktime_t start_ts; /* Stream start timestamp */
505 ktime_t stop_ts; /* Stream stop timestamp */
506
507 unsigned int nb_frames; /* Number of frames */
508
509 unsigned int nb_packets; /* Number of packets */
510 unsigned int nb_empty; /* Number of empty packets */
511 unsigned int nb_invalid; /* Number of packets with an invalid header */
512 unsigned int nb_errors; /* Number of packets with the error bit set */
513
514 unsigned int nb_pts_constant; /* Number of frames with constant PTS */
515 unsigned int nb_pts_early; /* Number of frames with early PTS */
516 unsigned int nb_pts_initial; /* Number of frames with initial PTS */
517
518 unsigned int nb_scr_count_ok; /* Number of frames with at least one SCR per non empty packet */
519 unsigned int nb_scr_diffs_ok; /* Number of frames with varying SCR.STC */
520 unsigned int scr_sof_count; /* STC.SOF counter accumulated since stream start */
521 unsigned int scr_sof; /* STC.SOF of the last packet */
522 unsigned int min_sof; /* Minimum STC.SOF value */
523 unsigned int max_sof; /* Maximum STC.SOF value */
524 };
525
526 #define UVC_METADATA_BUF_SIZE 1024
527
528 /**
529 * struct uvc_copy_op: Context structure to schedule asynchronous memcpy
530 *
531 * @buf: active buf object for this operation
532 * @dst: copy destination address
533 * @src: copy source address
534 * @len: copy length
535 */
536 struct uvc_copy_op {
537 struct uvc_buffer *buf;
538 void *dst;
539 const __u8 *src;
540 size_t len;
541 };
542
543 /**
544 * struct uvc_urb - URB context management structure
545 *
546 * @urb: the URB described by this context structure
547 * @stream: UVC streaming context
548 * @buffer: memory storage for the URB
549 * @dma: Allocated DMA handle
550 * @sgt: sgt_table with the urb locations in memory
551 * @async_operations: counter to indicate the number of copy operations
552 * @copy_operations: work descriptors for asynchronous copy operations
553 * @work: work queue entry for asynchronous decode
554 */
555 struct uvc_urb {
556 struct urb *urb;
557 struct uvc_streaming *stream;
558
559 char *buffer;
560 dma_addr_t dma;
561 struct sg_table *sgt;
562
563 unsigned int async_operations;
564 struct uvc_copy_op copy_operations[UVC_MAX_PACKETS];
565 struct work_struct work;
566 };
567
568 struct uvc_streaming {
569 struct list_head list;
570 struct uvc_device *dev;
571 struct video_device vdev;
572 struct uvc_video_chain *chain;
573 atomic_t active;
574
575 struct usb_interface *intf;
576 int intfnum;
577 u16 maxpsize;
578
579 struct uvc_streaming_header header;
580 enum v4l2_buf_type type;
581
582 unsigned int nformats;
583 struct uvc_format *format;
584
585 struct uvc_streaming_control ctrl;
586 struct uvc_format *def_format;
587 struct uvc_format *cur_format;
588 struct uvc_frame *cur_frame;
589
590 /* Protect access to ctrl, cur_format, cur_frame and hardware video
591 * probe control.
592 */
593 struct mutex mutex;
594
595 /* Buffers queue. */
596 unsigned int frozen : 1;
597 struct uvc_video_queue queue;
598 struct workqueue_struct *async_wq;
599 void (*decode)(struct uvc_urb *uvc_urb, struct uvc_buffer *buf,
600 struct uvc_buffer *meta_buf);
601
602 struct {
603 struct video_device vdev;
604 struct uvc_video_queue queue;
605 u32 format;
606 } meta;
607
608 /* Context data used by the bulk completion handler. */
609 struct {
610 u8 header[256];
611 unsigned int header_size;
612 int skip_payload;
613 u32 payload_size;
614 u32 max_payload_size;
615 } bulk;
616
617 struct uvc_urb uvc_urb[UVC_URBS];
618 unsigned int urb_size;
619
620 u32 sequence;
621 u8 last_fid;
622
623 /* debugfs */
624 struct dentry *debugfs_dir;
625 struct {
626 struct uvc_stats_frame frame;
627 struct uvc_stats_stream stream;
628 } stats;
629
630 /* Timestamps support. */
631 struct uvc_clock {
632 struct uvc_clock_sample {
633 u32 dev_stc;
634 u16 dev_sof;
635 u16 host_sof;
636 ktime_t host_time;
637 } *samples;
638
639 unsigned int head;
640 unsigned int count;
641 unsigned int size;
642
643 u16 last_sof;
644 u16 sof_offset;
645
646 u8 last_scr[6];
647
648 spinlock_t lock;
649 } clock;
650 };
651
652 #define for_each_uvc_urb(uvc_urb, uvc_streaming) \
653 for ((uvc_urb) = &(uvc_streaming)->uvc_urb[0]; \
654 (uvc_urb) < &(uvc_streaming)->uvc_urb[UVC_URBS]; \
655 ++(uvc_urb))
656
uvc_urb_index(const struct uvc_urb * uvc_urb)657 static inline u32 uvc_urb_index(const struct uvc_urb *uvc_urb)
658 {
659 return uvc_urb - &uvc_urb->stream->uvc_urb[0];
660 }
661
662 struct uvc_device_info {
663 u32 quirks;
664 u32 meta_format;
665 u16 uvc_version;
666 };
667
668 struct uvc_device {
669 struct usb_device *udev;
670 struct usb_interface *intf;
671 unsigned long warnings;
672 u32 quirks;
673 int intfnum;
674 char name[32];
675
676 const struct uvc_device_info *info;
677
678 struct mutex lock; /* Protects users */
679 unsigned int users;
680 atomic_t nmappings;
681
682 /* Video control interface */
683 #ifdef CONFIG_MEDIA_CONTROLLER
684 struct media_device mdev;
685 #endif
686 struct v4l2_device vdev;
687 u16 uvc_version;
688 u32 clock_frequency;
689
690 struct list_head entities;
691 struct list_head chains;
692
693 /* Video Streaming interfaces */
694 struct list_head streams;
695 struct kref ref;
696
697 /* Status Interrupt Endpoint */
698 struct usb_host_endpoint *int_ep;
699 struct urb *int_urb;
700 u8 *status;
701 struct input_dev *input;
702 char input_phys[64];
703
704 struct uvc_ctrl_work {
705 struct work_struct work;
706 struct urb *urb;
707 struct uvc_video_chain *chain;
708 struct uvc_control *ctrl;
709 const void *data;
710 } async_ctrl;
711
712 struct uvc_entity *gpio_unit;
713 };
714
715 enum uvc_handle_state {
716 UVC_HANDLE_PASSIVE = 0,
717 UVC_HANDLE_ACTIVE = 1,
718 };
719
720 struct uvc_fh {
721 struct v4l2_fh vfh;
722 struct uvc_video_chain *chain;
723 struct uvc_streaming *stream;
724 enum uvc_handle_state state;
725 };
726
727 struct uvc_driver {
728 struct usb_driver driver;
729 };
730
731 /* ------------------------------------------------------------------------
732 * Debugging, printing and logging
733 */
734
735 #define UVC_DBG_PROBE (1 << 0)
736 #define UVC_DBG_DESCR (1 << 1)
737 #define UVC_DBG_CONTROL (1 << 2)
738 #define UVC_DBG_FORMAT (1 << 3)
739 #define UVC_DBG_CAPTURE (1 << 4)
740 #define UVC_DBG_CALLS (1 << 5)
741 #define UVC_DBG_FRAME (1 << 7)
742 #define UVC_DBG_SUSPEND (1 << 8)
743 #define UVC_DBG_STATUS (1 << 9)
744 #define UVC_DBG_VIDEO (1 << 10)
745 #define UVC_DBG_STATS (1 << 11)
746 #define UVC_DBG_CLOCK (1 << 12)
747
748 #define UVC_WARN_MINMAX 0
749 #define UVC_WARN_PROBE_DEF 1
750 #define UVC_WARN_XU_GET_RES 2
751
752 extern unsigned int uvc_clock_param;
753 extern unsigned int uvc_no_drop_param;
754 extern unsigned int uvc_dbg_param;
755 extern unsigned int uvc_timeout_param;
756 extern unsigned int uvc_hw_timestamps_param;
757
758 #define uvc_dbg(_dev, flag, fmt, ...) \
759 do { \
760 if (uvc_dbg_param & UVC_DBG_##flag) \
761 dev_printk(KERN_DEBUG, &(_dev)->udev->dev, fmt, \
762 ##__VA_ARGS__); \
763 } while (0)
764
765 #define uvc_dbg_cont(flag, fmt, ...) \
766 do { \
767 if (uvc_dbg_param & UVC_DBG_##flag) \
768 pr_cont(fmt, ##__VA_ARGS__); \
769 } while (0)
770
771 #define uvc_warn_once(_dev, warn, fmt, ...) \
772 do { \
773 if (!test_and_set_bit(warn, &(_dev)->warnings)) \
774 dev_info(&(_dev)->udev->dev, fmt, ##__VA_ARGS__); \
775 } while (0)
776
777 /* --------------------------------------------------------------------------
778 * Internal functions.
779 */
780
781 /* Core driver */
782 extern struct uvc_driver uvc_driver;
783
784 struct uvc_entity *uvc_entity_by_id(struct uvc_device *dev, int id);
785
786 /* Video buffers queue management. */
787 int uvc_queue_init(struct uvc_video_queue *queue, enum v4l2_buf_type type,
788 int drop_corrupted);
789 void uvc_queue_release(struct uvc_video_queue *queue);
790 int uvc_request_buffers(struct uvc_video_queue *queue,
791 struct v4l2_requestbuffers *rb);
792 int uvc_query_buffer(struct uvc_video_queue *queue,
793 struct v4l2_buffer *v4l2_buf);
794 int uvc_create_buffers(struct uvc_video_queue *queue,
795 struct v4l2_create_buffers *v4l2_cb);
796 int uvc_queue_buffer(struct uvc_video_queue *queue,
797 struct media_device *mdev,
798 struct v4l2_buffer *v4l2_buf);
799 int uvc_export_buffer(struct uvc_video_queue *queue,
800 struct v4l2_exportbuffer *exp);
801 int uvc_dequeue_buffer(struct uvc_video_queue *queue,
802 struct v4l2_buffer *v4l2_buf, int nonblocking);
803 int uvc_queue_streamon(struct uvc_video_queue *queue, enum v4l2_buf_type type);
804 int uvc_queue_streamoff(struct uvc_video_queue *queue, enum v4l2_buf_type type);
805 void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect);
806 struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue,
807 struct uvc_buffer *buf);
808 struct uvc_buffer *uvc_queue_get_current_buffer(struct uvc_video_queue *queue);
809 void uvc_queue_buffer_release(struct uvc_buffer *buf);
810 int uvc_queue_mmap(struct uvc_video_queue *queue,
811 struct vm_area_struct *vma);
812 __poll_t uvc_queue_poll(struct uvc_video_queue *queue, struct file *file,
813 poll_table *wait);
814 #ifndef CONFIG_MMU
815 unsigned long uvc_queue_get_unmapped_area(struct uvc_video_queue *queue,
816 unsigned long pgoff);
817 #endif
818 int uvc_queue_allocated(struct uvc_video_queue *queue);
uvc_queue_streaming(struct uvc_video_queue * queue)819 static inline int uvc_queue_streaming(struct uvc_video_queue *queue)
820 {
821 return vb2_is_streaming(&queue->queue);
822 }
823
824 static inline struct uvc_streaming *
uvc_queue_to_stream(struct uvc_video_queue * queue)825 uvc_queue_to_stream(struct uvc_video_queue *queue)
826 {
827 return container_of(queue, struct uvc_streaming, queue);
828 }
829
830 /* V4L2 interface */
831 extern const struct v4l2_ioctl_ops uvc_ioctl_ops;
832 extern const struct v4l2_file_operations uvc_fops;
833
834 /* Media controller */
835 int uvc_mc_register_entities(struct uvc_video_chain *chain);
836 void uvc_mc_cleanup_entity(struct uvc_entity *entity);
837
838 /* Video */
839 int uvc_video_init(struct uvc_streaming *stream);
840 int uvc_video_suspend(struct uvc_streaming *stream);
841 int uvc_video_resume(struct uvc_streaming *stream, int reset);
842 int uvc_video_start_streaming(struct uvc_streaming *stream);
843 void uvc_video_stop_streaming(struct uvc_streaming *stream);
844 int uvc_probe_video(struct uvc_streaming *stream,
845 struct uvc_streaming_control *probe);
846 int uvc_query_ctrl(struct uvc_device *dev, u8 query, u8 unit,
847 u8 intfnum, u8 cs, void *data, u16 size);
848 void uvc_video_clock_update(struct uvc_streaming *stream,
849 struct vb2_v4l2_buffer *vbuf,
850 struct uvc_buffer *buf);
851 int uvc_meta_register(struct uvc_streaming *stream);
852
853 int uvc_register_video_device(struct uvc_device *dev,
854 struct uvc_streaming *stream,
855 struct video_device *vdev,
856 struct uvc_video_queue *queue,
857 enum v4l2_buf_type type,
858 const struct v4l2_file_operations *fops,
859 const struct v4l2_ioctl_ops *ioctl_ops);
860
861 /* Status */
862 int uvc_status_init(struct uvc_device *dev);
863 void uvc_status_unregister(struct uvc_device *dev);
864 void uvc_status_cleanup(struct uvc_device *dev);
865 int uvc_status_start(struct uvc_device *dev, gfp_t flags);
866 void uvc_status_stop(struct uvc_device *dev);
867
868 /* Controls */
869 extern const struct v4l2_subscribed_event_ops uvc_ctrl_sub_ev_ops;
870
871 int uvc_query_v4l2_ctrl(struct uvc_video_chain *chain,
872 struct v4l2_queryctrl *v4l2_ctrl);
873 int uvc_query_v4l2_menu(struct uvc_video_chain *chain,
874 struct v4l2_querymenu *query_menu);
875
876 int uvc_ctrl_add_mapping(struct uvc_video_chain *chain,
877 const struct uvc_control_mapping *mapping);
878 int uvc_ctrl_init_device(struct uvc_device *dev);
879 void uvc_ctrl_cleanup_device(struct uvc_device *dev);
880 int uvc_ctrl_restore_values(struct uvc_device *dev);
881 bool uvc_ctrl_status_event_async(struct urb *urb, struct uvc_video_chain *chain,
882 struct uvc_control *ctrl, const u8 *data);
883 void uvc_ctrl_status_event(struct uvc_video_chain *chain,
884 struct uvc_control *ctrl, const u8 *data);
885
886 int uvc_ctrl_begin(struct uvc_video_chain *chain);
887 int __uvc_ctrl_commit(struct uvc_fh *handle, int rollback,
888 const struct v4l2_ext_control *xctrls,
889 unsigned int xctrls_count);
uvc_ctrl_commit(struct uvc_fh * handle,const struct v4l2_ext_control * xctrls,unsigned int xctrls_count)890 static inline int uvc_ctrl_commit(struct uvc_fh *handle,
891 const struct v4l2_ext_control *xctrls,
892 unsigned int xctrls_count)
893 {
894 return __uvc_ctrl_commit(handle, 0, xctrls, xctrls_count);
895 }
uvc_ctrl_rollback(struct uvc_fh * handle)896 static inline int uvc_ctrl_rollback(struct uvc_fh *handle)
897 {
898 return __uvc_ctrl_commit(handle, 1, NULL, 0);
899 }
900
901 int uvc_ctrl_get(struct uvc_video_chain *chain, struct v4l2_ext_control *xctrl);
902 int uvc_ctrl_set(struct uvc_fh *handle, struct v4l2_ext_control *xctrl);
903
904 int uvc_xu_ctrl_query(struct uvc_video_chain *chain,
905 struct uvc_xu_control_query *xqry);
906
907 /* Utility functions */
908 void uvc_simplify_fraction(u32 *numerator, u32 *denominator,
909 unsigned int n_terms, unsigned int threshold);
910 u32 uvc_fraction_to_interval(u32 numerator, u32 denominator);
911 struct usb_host_endpoint *uvc_find_endpoint(struct usb_host_interface *alts,
912 u8 epaddr);
913
914 /* Quirks support */
915 void uvc_video_decode_isight(struct uvc_urb *uvc_urb,
916 struct uvc_buffer *buf,
917 struct uvc_buffer *meta_buf);
918
919 /* debugfs and statistics */
920 void uvc_debugfs_init(void);
921 void uvc_debugfs_cleanup(void);
922 void uvc_debugfs_init_stream(struct uvc_streaming *stream);
923 void uvc_debugfs_cleanup_stream(struct uvc_streaming *stream);
924
925 size_t uvc_video_stats_dump(struct uvc_streaming *stream, char *buf,
926 size_t size);
927
928 #endif
929