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/kernel.h>
10 #include <linux/poll.h>
11 #include <linux/usb.h>
12 #include <linux/usb/video.h>
13 #include <linux/uvcvideo.h>
14 #include <linux/videodev2.h>
15 #include <linux/workqueue.h>
16 #include <media/media-device.h>
17 #include <media/v4l2-device.h>
18 #include <media/v4l2-event.h>
19 #include <media/v4l2-fh.h>
20 #include <media/videobuf2-v4l2.h>
21
22 /* --------------------------------------------------------------------------
23 * UVC constants
24 */
25
26 #define UVC_TERM_INPUT 0x0000
27 #define UVC_TERM_OUTPUT 0x8000
28 #define UVC_TERM_DIRECTION(term) ((term)->type & 0x8000)
29
30 #define UVC_ENTITY_TYPE(entity) ((entity)->type & 0x7fff)
31 #define UVC_ENTITY_IS_UNIT(entity) (((entity)->type & 0xff00) == 0)
32 #define UVC_ENTITY_IS_TERM(entity) (((entity)->type & 0xff00) != 0)
33 #define UVC_ENTITY_IS_ITERM(entity) \
34 (UVC_ENTITY_IS_TERM(entity) && \
35 ((entity)->type & 0x8000) == UVC_TERM_INPUT)
36 #define UVC_ENTITY_IS_OTERM(entity) \
37 (UVC_ENTITY_IS_TERM(entity) && \
38 ((entity)->type & 0x8000) == UVC_TERM_OUTPUT)
39
40
41 /* ------------------------------------------------------------------------
42 * GUIDs
43 */
44 #define UVC_GUID_UVC_CAMERA \
45 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
46 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01}
47 #define UVC_GUID_UVC_OUTPUT \
48 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
49 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02}
50 #define UVC_GUID_UVC_MEDIA_TRANSPORT_INPUT \
51 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
52 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03}
53 #define UVC_GUID_UVC_PROCESSING \
54 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
55 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x01}
56 #define UVC_GUID_UVC_SELECTOR \
57 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
58 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x02}
59
60 #define UVC_GUID_FORMAT_MJPEG \
61 { 'M', 'J', 'P', 'G', 0x00, 0x00, 0x10, 0x00, \
62 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
63 #define UVC_GUID_FORMAT_YUY2 \
64 { 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \
65 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
66 #define UVC_GUID_FORMAT_YUY2_ISIGHT \
67 { 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \
68 0x80, 0x00, 0x00, 0x00, 0x00, 0x38, 0x9b, 0x71}
69 #define UVC_GUID_FORMAT_NV12 \
70 { 'N', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
71 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
72 #define UVC_GUID_FORMAT_YV12 \
73 { 'Y', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
74 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
75 #define UVC_GUID_FORMAT_I420 \
76 { 'I', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \
77 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
78 #define UVC_GUID_FORMAT_UYVY \
79 { 'U', 'Y', 'V', 'Y', 0x00, 0x00, 0x10, 0x00, \
80 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
81 #define UVC_GUID_FORMAT_Y800 \
82 { 'Y', '8', '0', '0', 0x00, 0x00, 0x10, 0x00, \
83 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
84 #define UVC_GUID_FORMAT_Y8 \
85 { 'Y', '8', ' ', ' ', 0x00, 0x00, 0x10, 0x00, \
86 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
87 #define UVC_GUID_FORMAT_Y10 \
88 { 'Y', '1', '0', ' ', 0x00, 0x00, 0x10, 0x00, \
89 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
90 #define UVC_GUID_FORMAT_Y12 \
91 { 'Y', '1', '2', ' ', 0x00, 0x00, 0x10, 0x00, \
92 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
93 #define UVC_GUID_FORMAT_Y16 \
94 { 'Y', '1', '6', ' ', 0x00, 0x00, 0x10, 0x00, \
95 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
96 #define UVC_GUID_FORMAT_BY8 \
97 { 'B', 'Y', '8', ' ', 0x00, 0x00, 0x10, 0x00, \
98 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
99 #define UVC_GUID_FORMAT_BA81 \
100 { 'B', 'A', '8', '1', 0x00, 0x00, 0x10, 0x00, \
101 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
102 #define UVC_GUID_FORMAT_GBRG \
103 { 'G', 'B', 'R', 'G', 0x00, 0x00, 0x10, 0x00, \
104 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
105 #define UVC_GUID_FORMAT_GRBG \
106 { 'G', 'R', 'B', 'G', 0x00, 0x00, 0x10, 0x00, \
107 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
108 #define UVC_GUID_FORMAT_RGGB \
109 { 'R', 'G', 'G', 'B', 0x00, 0x00, 0x10, 0x00, \
110 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
111 #define UVC_GUID_FORMAT_BG16 \
112 { 'B', 'G', '1', '6', 0x00, 0x00, 0x10, 0x00, \
113 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
114 #define UVC_GUID_FORMAT_GB16 \
115 { 'G', 'B', '1', '6', 0x00, 0x00, 0x10, 0x00, \
116 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
117 #define UVC_GUID_FORMAT_RG16 \
118 { 'R', 'G', '1', '6', 0x00, 0x00, 0x10, 0x00, \
119 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
120 #define UVC_GUID_FORMAT_GR16 \
121 { 'G', 'R', '1', '6', 0x00, 0x00, 0x10, 0x00, \
122 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
123 #define UVC_GUID_FORMAT_RGBP \
124 { 'R', 'G', 'B', 'P', 0x00, 0x00, 0x10, 0x00, \
125 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
126 #define UVC_GUID_FORMAT_BGR3 \
127 { 0x7d, 0xeb, 0x36, 0xe4, 0x4f, 0x52, 0xce, 0x11, \
128 0x9f, 0x53, 0x00, 0x20, 0xaf, 0x0b, 0xa7, 0x70}
129 #define UVC_GUID_FORMAT_M420 \
130 { 'M', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \
131 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
132
133 #define UVC_GUID_FORMAT_H264 \
134 { 'H', '2', '6', '4', 0x00, 0x00, 0x10, 0x00, \
135 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
136 #define UVC_GUID_FORMAT_Y8I \
137 { 'Y', '8', 'I', ' ', 0x00, 0x00, 0x10, 0x00, \
138 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
139 #define UVC_GUID_FORMAT_Y12I \
140 { 'Y', '1', '2', 'I', 0x00, 0x00, 0x10, 0x00, \
141 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
142 #define UVC_GUID_FORMAT_Z16 \
143 { 'Z', '1', '6', ' ', 0x00, 0x00, 0x10, 0x00, \
144 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
145 #define UVC_GUID_FORMAT_RW10 \
146 { 'R', 'W', '1', '0', 0x00, 0x00, 0x10, 0x00, \
147 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
148 #define UVC_GUID_FORMAT_INVZ \
149 { 'I', 'N', 'V', 'Z', 0x90, 0x2d, 0x58, 0x4a, \
150 0x92, 0x0b, 0x77, 0x3f, 0x1f, 0x2c, 0x55, 0x6b}
151 #define UVC_GUID_FORMAT_INZI \
152 { 'I', 'N', 'Z', 'I', 0x66, 0x1a, 0x42, 0xa2, \
153 0x90, 0x65, 0xd0, 0x18, 0x14, 0xa8, 0xef, 0x8a}
154 #define UVC_GUID_FORMAT_INVI \
155 { 'I', 'N', 'V', 'I', 0xdb, 0x57, 0x49, 0x5e, \
156 0x8e, 0x3f, 0xf4, 0x79, 0x53, 0x2b, 0x94, 0x6f}
157 #define UVC_GUID_FORMAT_CNF4 \
158 { 'C', ' ', ' ', ' ', 0x00, 0x00, 0x10, 0x00, \
159 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
160
161 #define UVC_GUID_FORMAT_D3DFMT_L8 \
162 {0x32, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, \
163 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
164 #define UVC_GUID_FORMAT_KSMEDIA_L8_IR \
165 {0x32, 0x00, 0x00, 0x00, 0x02, 0x00, 0x10, 0x00, \
166 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
167
168 #define UVC_GUID_FORMAT_HEVC \
169 { 'H', 'E', 'V', 'C', 0x00, 0x00, 0x10, 0x00, \
170 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
171
172
173 /* ------------------------------------------------------------------------
174 * Driver specific constants.
175 */
176
177 #define DRIVER_VERSION "1.1.1"
178
179 /* Number of isochronous URBs. */
180 #define UVC_URBS 5
181 /* Maximum number of packets per URB. */
182 #define UVC_MAX_PACKETS 32
183 /* Maximum status buffer size in bytes of interrupt URB. */
184 #define UVC_MAX_STATUS_SIZE 16
185
186 #define UVC_CTRL_CONTROL_TIMEOUT 5000
187 #define UVC_CTRL_STREAMING_TIMEOUT 5000
188
189 /* Maximum allowed number of control mappings per device */
190 #define UVC_MAX_CONTROL_MAPPINGS 1024
191 #define UVC_MAX_CONTROL_MENU_ENTRIES 32
192
193 /* Devices quirks */
194 #define UVC_QUIRK_STATUS_INTERVAL 0x00000001
195 #define UVC_QUIRK_PROBE_MINMAX 0x00000002
196 #define UVC_QUIRK_PROBE_EXTRAFIELDS 0x00000004
197 #define UVC_QUIRK_BUILTIN_ISIGHT 0x00000008
198 #define UVC_QUIRK_STREAM_NO_FID 0x00000010
199 #define UVC_QUIRK_IGNORE_SELECTOR_UNIT 0x00000020
200 #define UVC_QUIRK_FIX_BANDWIDTH 0x00000080
201 #define UVC_QUIRK_PROBE_DEF 0x00000100
202 #define UVC_QUIRK_RESTRICT_FRAME_RATE 0x00000200
203 #define UVC_QUIRK_RESTORE_CTRLS_ON_INIT 0x00000400
204 #define UVC_QUIRK_FORCE_Y8 0x00000800
205 #define UVC_QUIRK_FORCE_BPP 0x00001000
206 #define UVC_QUIRK_WAKE_AUTOSUSPEND 0x00002000
207
208 /* Format flags */
209 #define UVC_FMT_FLAG_COMPRESSED 0x00000001
210 #define UVC_FMT_FLAG_STREAM 0x00000002
211
212 /* ------------------------------------------------------------------------
213 * Structures.
214 */
215
216 struct uvc_device;
217
218 /* TODO: Put the most frequently accessed fields at the beginning of
219 * structures to maximize cache efficiency.
220 */
221 struct uvc_control_info {
222 struct list_head mappings;
223
224 u8 entity[16];
225 u8 index; /* Bit index in bmControls */
226 u8 selector;
227
228 u16 size;
229 u32 flags;
230 };
231
232 struct uvc_control_mapping {
233 struct list_head list;
234 struct list_head ev_subs;
235
236 u32 id;
237 u8 name[32];
238 u8 entity[16];
239 u8 selector;
240
241 u8 size;
242 u8 offset;
243 enum v4l2_ctrl_type v4l2_type;
244 u32 data_type;
245
246 const struct uvc_menu_info *menu_info;
247 u32 menu_count;
248
249 u32 master_id;
250 s32 master_manual;
251 u32 slave_ids[2];
252
253 s32 (*get)(struct uvc_control_mapping *mapping, u8 query,
254 const u8 *data);
255 void (*set)(struct uvc_control_mapping *mapping, s32 value,
256 u8 *data);
257 };
258
259 struct uvc_control {
260 struct uvc_entity *entity;
261 struct uvc_control_info info;
262
263 u8 index; /* Used to match the uvc_control entry with a
264 uvc_control_info. */
265 u8 dirty:1,
266 loaded:1,
267 modified:1,
268 cached:1,
269 initialized:1;
270
271 u8 *uvc_data;
272
273 struct uvc_fh *handle; /* File handle that last changed the control. */
274 };
275
276 struct uvc_format_desc {
277 char *name;
278 u8 guid[16];
279 u32 fcc;
280 };
281
282 /* The term 'entity' refers to both UVC units and UVC terminals.
283 *
284 * The type field is either the terminal type (wTerminalType in the terminal
285 * descriptor), or the unit type (bDescriptorSubtype in the unit descriptor).
286 * As the bDescriptorSubtype field is one byte long, the type value will
287 * always have a null MSB for units. All terminal types defined by the UVC
288 * specification have a non-null MSB, so it is safe to use the MSB to
289 * differentiate between units and terminals as long as the descriptor parsing
290 * code makes sure terminal types have a non-null MSB.
291 *
292 * For terminals, the type's most significant bit stores the terminal
293 * direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should
294 * always be accessed with the UVC_ENTITY_* macros and never directly.
295 */
296
297 #define UVC_ENTITY_FLAG_DEFAULT (1 << 0)
298
299 struct uvc_entity {
300 struct list_head list; /* Entity as part of a UVC device. */
301 struct list_head chain; /* Entity as part of a video device
302 * chain. */
303 unsigned int flags;
304
305 u8 id;
306 u16 type;
307 char name[64];
308
309 /* Media controller-related fields. */
310 struct video_device *vdev;
311 struct v4l2_subdev subdev;
312 unsigned int num_pads;
313 unsigned int num_links;
314 struct media_pad *pads;
315
316 union {
317 struct {
318 u16 wObjectiveFocalLengthMin;
319 u16 wObjectiveFocalLengthMax;
320 u16 wOcularFocalLength;
321 u8 bControlSize;
322 u8 *bmControls;
323 } camera;
324
325 struct {
326 u8 bControlSize;
327 u8 *bmControls;
328 u8 bTransportModeSize;
329 u8 *bmTransportModes;
330 } media;
331
332 struct {
333 } output;
334
335 struct {
336 u16 wMaxMultiplier;
337 u8 bControlSize;
338 u8 *bmControls;
339 u8 bmVideoStandards;
340 } processing;
341
342 struct {
343 } selector;
344
345 struct {
346 u8 guidExtensionCode[16];
347 u8 bNumControls;
348 u8 bControlSize;
349 u8 *bmControls;
350 u8 *bmControlsType;
351 } extension;
352 };
353
354 u8 bNrInPins;
355 u8 *baSourceID;
356
357 unsigned int ncontrols;
358 struct uvc_control *controls;
359 };
360
361 struct uvc_frame {
362 u8 bFrameIndex;
363 u8 bmCapabilities;
364 u16 wWidth;
365 u16 wHeight;
366 u32 dwMinBitRate;
367 u32 dwMaxBitRate;
368 u32 dwMaxVideoFrameBufferSize;
369 u8 bFrameIntervalType;
370 u32 dwDefaultFrameInterval;
371 u32 *dwFrameInterval;
372 };
373
374 struct uvc_format {
375 u8 type;
376 u8 index;
377 u8 bpp;
378 enum v4l2_colorspace colorspace;
379 enum v4l2_xfer_func xfer_func;
380 enum v4l2_ycbcr_encoding ycbcr_enc;
381 u32 fcc;
382 u32 flags;
383
384 char name[32];
385
386 unsigned int nframes;
387 struct uvc_frame *frame;
388 };
389
390 struct uvc_streaming_header {
391 u8 bNumFormats;
392 u8 bEndpointAddress;
393 u8 bTerminalLink;
394 u8 bControlSize;
395 u8 *bmaControls;
396 /* The following fields are used by input headers only. */
397 u8 bmInfo;
398 u8 bStillCaptureMethod;
399 u8 bTriggerSupport;
400 u8 bTriggerUsage;
401 };
402
403 enum uvc_buffer_state {
404 UVC_BUF_STATE_IDLE = 0,
405 UVC_BUF_STATE_QUEUED = 1,
406 UVC_BUF_STATE_ACTIVE = 2,
407 UVC_BUF_STATE_READY = 3,
408 UVC_BUF_STATE_DONE = 4,
409 UVC_BUF_STATE_ERROR = 5,
410 };
411
412 struct uvc_buffer {
413 struct vb2_v4l2_buffer buf;
414 struct list_head queue;
415
416 enum uvc_buffer_state state;
417 unsigned int error;
418
419 void *mem;
420 unsigned int length;
421 unsigned int bytesused;
422
423 u32 pts;
424
425 /* Asynchronous buffer handling. */
426 struct kref ref;
427 };
428
429 #define UVC_QUEUE_DISCONNECTED (1 << 0)
430 #define UVC_QUEUE_DROP_CORRUPTED (1 << 1)
431
432 struct uvc_video_queue {
433 struct vb2_queue queue;
434 struct mutex mutex; /* Protects queue */
435
436 unsigned int flags;
437 unsigned int buf_used;
438
439 spinlock_t irqlock; /* Protects irqqueue */
440 struct list_head irqqueue;
441 };
442
443 struct uvc_video_chain {
444 struct uvc_device *dev;
445 struct list_head list;
446
447 struct list_head entities; /* All entities */
448 struct uvc_entity *processing; /* Processing unit */
449 struct uvc_entity *selector; /* Selector unit */
450
451 struct mutex ctrl_mutex; /* Protects ctrl.info */
452
453 struct v4l2_prio_state prio; /* V4L2 priority state */
454 u32 caps; /* V4L2 chain-wide caps */
455 };
456
457 struct uvc_stats_frame {
458 unsigned int size; /* Number of bytes captured */
459 unsigned int first_data; /* Index of the first non-empty packet */
460
461 unsigned int nb_packets; /* Number of packets */
462 unsigned int nb_empty; /* Number of empty packets */
463 unsigned int nb_invalid; /* Number of packets with an invalid header */
464 unsigned int nb_errors; /* Number of packets with the error bit set */
465
466 unsigned int nb_pts; /* Number of packets with a PTS timestamp */
467 unsigned int nb_pts_diffs; /* Number of PTS differences inside a frame */
468 unsigned int last_pts_diff; /* Index of the last PTS difference */
469 bool has_initial_pts; /* Whether the first non-empty packet has a PTS */
470 bool has_early_pts; /* Whether a PTS is present before the first non-empty packet */
471 u32 pts; /* PTS of the last packet */
472
473 unsigned int nb_scr; /* Number of packets with a SCR timestamp */
474 unsigned int nb_scr_diffs; /* Number of SCR.STC differences inside a frame */
475 u16 scr_sof; /* SCR.SOF of the last packet */
476 u32 scr_stc; /* SCR.STC of the last packet */
477 };
478
479 struct uvc_stats_stream {
480 ktime_t start_ts; /* Stream start timestamp */
481 ktime_t stop_ts; /* Stream stop timestamp */
482
483 unsigned int nb_frames; /* Number of frames */
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_constant; /* Number of frames with constant PTS */
491 unsigned int nb_pts_early; /* Number of frames with early PTS */
492 unsigned int nb_pts_initial; /* Number of frames with initial PTS */
493
494 unsigned int nb_scr_count_ok; /* Number of frames with at least one SCR per non empty packet */
495 unsigned int nb_scr_diffs_ok; /* Number of frames with varying SCR.STC */
496 unsigned int scr_sof_count; /* STC.SOF counter accumulated since stream start */
497 unsigned int scr_sof; /* STC.SOF of the last packet */
498 unsigned int min_sof; /* Minimum STC.SOF value */
499 unsigned int max_sof; /* Maximum STC.SOF value */
500 };
501
502 #define UVC_METADATA_BUF_SIZE 1024
503
504 /**
505 * struct uvc_copy_op: Context structure to schedule asynchronous memcpy
506 *
507 * @buf: active buf object for this operation
508 * @dst: copy destination address
509 * @src: copy source address
510 * @len: copy length
511 */
512 struct uvc_copy_op {
513 struct uvc_buffer *buf;
514 void *dst;
515 const __u8 *src;
516 size_t len;
517 };
518
519 /**
520 * struct uvc_urb - URB context management structure
521 *
522 * @urb: the URB described by this context structure
523 * @stream: UVC streaming context
524 * @buffer: memory storage for the URB
525 * @dma: DMA coherent addressing for the urb_buffer
526 * @async_operations: counter to indicate the number of copy operations
527 * @copy_operations: work descriptors for asynchronous copy operations
528 * @work: work queue entry for asynchronous decode
529 */
530 struct uvc_urb {
531 struct urb *urb;
532 struct uvc_streaming *stream;
533
534 char *buffer;
535 dma_addr_t dma;
536
537 unsigned int async_operations;
538 struct uvc_copy_op copy_operations[UVC_MAX_PACKETS];
539 struct work_struct work;
540 };
541
542 struct uvc_streaming {
543 struct list_head list;
544 struct uvc_device *dev;
545 struct video_device vdev;
546 struct uvc_video_chain *chain;
547 atomic_t active;
548
549 struct usb_interface *intf;
550 int intfnum;
551 u16 maxpsize;
552
553 struct uvc_streaming_header header;
554 enum v4l2_buf_type type;
555
556 unsigned int nformats;
557 struct uvc_format *format;
558
559 struct uvc_streaming_control ctrl;
560 struct uvc_format *def_format;
561 struct uvc_format *cur_format;
562 struct uvc_frame *cur_frame;
563
564 /* Protect access to ctrl, cur_format, cur_frame and hardware video
565 * probe control.
566 */
567 struct mutex mutex;
568
569 /* Buffers queue. */
570 unsigned int frozen : 1;
571 struct uvc_video_queue queue;
572 struct workqueue_struct *async_wq;
573 void (*decode)(struct uvc_urb *uvc_urb, struct uvc_buffer *buf,
574 struct uvc_buffer *meta_buf);
575
576 struct {
577 struct video_device vdev;
578 struct uvc_video_queue queue;
579 u32 format;
580 } meta;
581
582 /* Context data used by the bulk completion handler. */
583 struct {
584 u8 header[256];
585 unsigned int header_size;
586 int skip_payload;
587 u32 payload_size;
588 u32 max_payload_size;
589 } bulk;
590
591 struct uvc_urb uvc_urb[UVC_URBS];
592 unsigned int urb_size;
593
594 u32 sequence;
595 u8 last_fid;
596
597 /* debugfs */
598 struct dentry *debugfs_dir;
599 struct {
600 struct uvc_stats_frame frame;
601 struct uvc_stats_stream stream;
602 } stats;
603
604 /* Timestamps support. */
605 struct uvc_clock {
606 struct uvc_clock_sample {
607 u32 dev_stc;
608 u16 dev_sof;
609 u16 host_sof;
610 ktime_t host_time;
611 } *samples;
612
613 unsigned int head;
614 unsigned int count;
615 unsigned int size;
616
617 u16 last_sof;
618 u16 sof_offset;
619
620 u8 last_scr[6];
621
622 spinlock_t lock;
623 } clock;
624 };
625
626 #define for_each_uvc_urb(uvc_urb, uvc_streaming) \
627 for ((uvc_urb) = &(uvc_streaming)->uvc_urb[0]; \
628 (uvc_urb) < &(uvc_streaming)->uvc_urb[UVC_URBS]; \
629 ++(uvc_urb))
630
uvc_urb_index(const struct uvc_urb * uvc_urb)631 static inline u32 uvc_urb_index(const struct uvc_urb *uvc_urb)
632 {
633 return uvc_urb - &uvc_urb->stream->uvc_urb[0];
634 }
635
636 struct uvc_device_info {
637 u32 quirks;
638 u32 meta_format;
639 };
640
641 struct uvc_device {
642 struct usb_device *udev;
643 struct usb_interface *intf;
644 unsigned long warnings;
645 u32 quirks;
646 int intfnum;
647 char name[32];
648
649 const struct uvc_device_info *info;
650
651 struct mutex lock; /* Protects users */
652 unsigned int users;
653 atomic_t nmappings;
654
655 /* Video control interface */
656 #ifdef CONFIG_MEDIA_CONTROLLER
657 struct media_device mdev;
658 #endif
659 struct v4l2_device vdev;
660 u16 uvc_version;
661 u32 clock_frequency;
662
663 struct list_head entities;
664 struct list_head chains;
665
666 /* Video Streaming interfaces */
667 struct list_head streams;
668 struct kref ref;
669
670 /* Status Interrupt Endpoint */
671 struct usb_host_endpoint *int_ep;
672 struct urb *int_urb;
673 bool flush_status;
674 u8 *status;
675 struct input_dev *input;
676 char input_phys[64];
677
678 struct uvc_ctrl_work {
679 struct work_struct work;
680 struct urb *urb;
681 struct uvc_video_chain *chain;
682 struct uvc_control *ctrl;
683 const void *data;
684 } async_ctrl;
685 };
686
687 enum uvc_handle_state {
688 UVC_HANDLE_PASSIVE = 0,
689 UVC_HANDLE_ACTIVE = 1,
690 };
691
692 struct uvc_fh {
693 struct v4l2_fh vfh;
694 struct uvc_video_chain *chain;
695 struct uvc_streaming *stream;
696 enum uvc_handle_state state;
697 };
698
699 struct uvc_driver {
700 struct usb_driver driver;
701 };
702
703 /* ------------------------------------------------------------------------
704 * Debugging, printing and logging
705 */
706
707 #define UVC_TRACE_PROBE (1 << 0)
708 #define UVC_TRACE_DESCR (1 << 1)
709 #define UVC_TRACE_CONTROL (1 << 2)
710 #define UVC_TRACE_FORMAT (1 << 3)
711 #define UVC_TRACE_CAPTURE (1 << 4)
712 #define UVC_TRACE_CALLS (1 << 5)
713 #define UVC_TRACE_FRAME (1 << 7)
714 #define UVC_TRACE_SUSPEND (1 << 8)
715 #define UVC_TRACE_STATUS (1 << 9)
716 #define UVC_TRACE_VIDEO (1 << 10)
717 #define UVC_TRACE_STATS (1 << 11)
718 #define UVC_TRACE_CLOCK (1 << 12)
719
720 #define UVC_WARN_MINMAX 0
721 #define UVC_WARN_PROBE_DEF 1
722 #define UVC_WARN_XU_GET_RES 2
723
724 extern unsigned int uvc_clock_param;
725 extern unsigned int uvc_no_drop_param;
726 extern unsigned int uvc_trace_param;
727 extern unsigned int uvc_timeout_param;
728 extern unsigned int uvc_hw_timestamps_param;
729
730 #define uvc_trace(flag, msg...) \
731 do { \
732 if (uvc_trace_param & flag) \
733 printk(KERN_DEBUG "uvcvideo: " msg); \
734 } while (0)
735
736 #define uvc_warn_once(dev, warn, msg...) \
737 do { \
738 if (!test_and_set_bit(warn, &dev->warnings)) \
739 printk(KERN_INFO "uvcvideo: " msg); \
740 } while (0)
741
742 #define uvc_printk(level, msg...) \
743 printk(level "uvcvideo: " msg)
744
745 /* --------------------------------------------------------------------------
746 * Internal functions.
747 */
748
749 /* Core driver */
750 extern struct uvc_driver uvc_driver;
751
752 struct uvc_entity *uvc_entity_by_id(struct uvc_device *dev, int id);
753
754 /* Video buffers queue management. */
755 int uvc_queue_init(struct uvc_video_queue *queue, enum v4l2_buf_type type,
756 int drop_corrupted);
757 void uvc_queue_release(struct uvc_video_queue *queue);
758 int uvc_request_buffers(struct uvc_video_queue *queue,
759 struct v4l2_requestbuffers *rb);
760 int uvc_query_buffer(struct uvc_video_queue *queue,
761 struct v4l2_buffer *v4l2_buf);
762 int uvc_create_buffers(struct uvc_video_queue *queue,
763 struct v4l2_create_buffers *v4l2_cb);
764 int uvc_queue_buffer(struct uvc_video_queue *queue,
765 struct media_device *mdev,
766 struct v4l2_buffer *v4l2_buf);
767 int uvc_export_buffer(struct uvc_video_queue *queue,
768 struct v4l2_exportbuffer *exp);
769 int uvc_dequeue_buffer(struct uvc_video_queue *queue,
770 struct v4l2_buffer *v4l2_buf, int nonblocking);
771 int uvc_queue_streamon(struct uvc_video_queue *queue, enum v4l2_buf_type type);
772 int uvc_queue_streamoff(struct uvc_video_queue *queue, enum v4l2_buf_type type);
773 void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect);
774 struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue,
775 struct uvc_buffer *buf);
776 struct uvc_buffer *uvc_queue_get_current_buffer(struct uvc_video_queue *queue);
777 void uvc_queue_buffer_release(struct uvc_buffer *buf);
778 int uvc_queue_mmap(struct uvc_video_queue *queue,
779 struct vm_area_struct *vma);
780 __poll_t uvc_queue_poll(struct uvc_video_queue *queue, struct file *file,
781 poll_table *wait);
782 #ifndef CONFIG_MMU
783 unsigned long uvc_queue_get_unmapped_area(struct uvc_video_queue *queue,
784 unsigned long pgoff);
785 #endif
786 int uvc_queue_allocated(struct uvc_video_queue *queue);
uvc_queue_streaming(struct uvc_video_queue * queue)787 static inline int uvc_queue_streaming(struct uvc_video_queue *queue)
788 {
789 return vb2_is_streaming(&queue->queue);
790 }
791
792 /* V4L2 interface */
793 extern const struct v4l2_ioctl_ops uvc_ioctl_ops;
794 extern const struct v4l2_file_operations uvc_fops;
795
796 /* Media controller */
797 int uvc_mc_register_entities(struct uvc_video_chain *chain);
798 void uvc_mc_cleanup_entity(struct uvc_entity *entity);
799
800 /* Video */
801 int uvc_video_init(struct uvc_streaming *stream);
802 int uvc_video_suspend(struct uvc_streaming *stream);
803 int uvc_video_resume(struct uvc_streaming *stream, int reset);
804 int uvc_video_start_streaming(struct uvc_streaming *stream);
805 void uvc_video_stop_streaming(struct uvc_streaming *stream);
806 int uvc_probe_video(struct uvc_streaming *stream,
807 struct uvc_streaming_control *probe);
808 int uvc_query_ctrl(struct uvc_device *dev, u8 query, u8 unit,
809 u8 intfnum, u8 cs, void *data, u16 size);
810 void uvc_video_clock_update(struct uvc_streaming *stream,
811 struct vb2_v4l2_buffer *vbuf,
812 struct uvc_buffer *buf);
813 int uvc_meta_register(struct uvc_streaming *stream);
814
815 int uvc_register_video_device(struct uvc_device *dev,
816 struct uvc_streaming *stream,
817 struct video_device *vdev,
818 struct uvc_video_queue *queue,
819 enum v4l2_buf_type type,
820 const struct v4l2_file_operations *fops,
821 const struct v4l2_ioctl_ops *ioctl_ops);
822
823 /* Status */
824 int uvc_status_init(struct uvc_device *dev);
825 void uvc_status_unregister(struct uvc_device *dev);
826 void uvc_status_cleanup(struct uvc_device *dev);
827 int uvc_status_start(struct uvc_device *dev, gfp_t flags);
828 void uvc_status_stop(struct uvc_device *dev);
829
830 /* Controls */
831 extern const struct v4l2_subscribed_event_ops uvc_ctrl_sub_ev_ops;
832
833 int uvc_query_v4l2_ctrl(struct uvc_video_chain *chain,
834 struct v4l2_queryctrl *v4l2_ctrl);
835 int uvc_query_v4l2_menu(struct uvc_video_chain *chain,
836 struct v4l2_querymenu *query_menu);
837
838 int uvc_ctrl_add_mapping(struct uvc_video_chain *chain,
839 const struct uvc_control_mapping *mapping);
840 int uvc_ctrl_init_device(struct uvc_device *dev);
841 void uvc_ctrl_cleanup_device(struct uvc_device *dev);
842 int uvc_ctrl_restore_values(struct uvc_device *dev);
843 bool uvc_ctrl_status_event_async(struct urb *urb, struct uvc_video_chain *chain,
844 struct uvc_control *ctrl, const u8 *data);
845 void uvc_ctrl_status_event(struct uvc_video_chain *chain,
846 struct uvc_control *ctrl, const u8 *data);
847
848 int uvc_ctrl_begin(struct uvc_video_chain *chain);
849 int __uvc_ctrl_commit(struct uvc_fh *handle, int rollback,
850 const struct v4l2_ext_control *xctrls,
851 unsigned int xctrls_count);
uvc_ctrl_commit(struct uvc_fh * handle,const struct v4l2_ext_control * xctrls,unsigned int xctrls_count)852 static inline int uvc_ctrl_commit(struct uvc_fh *handle,
853 const struct v4l2_ext_control *xctrls,
854 unsigned int xctrls_count)
855 {
856 return __uvc_ctrl_commit(handle, 0, xctrls, xctrls_count);
857 }
uvc_ctrl_rollback(struct uvc_fh * handle)858 static inline int uvc_ctrl_rollback(struct uvc_fh *handle)
859 {
860 return __uvc_ctrl_commit(handle, 1, NULL, 0);
861 }
862
863 int uvc_ctrl_get(struct uvc_video_chain *chain, struct v4l2_ext_control *xctrl);
864 int uvc_ctrl_set(struct uvc_fh *handle, struct v4l2_ext_control *xctrl);
865
866 int uvc_xu_ctrl_query(struct uvc_video_chain *chain,
867 struct uvc_xu_control_query *xqry);
868
869 /* Utility functions */
870 void uvc_simplify_fraction(u32 *numerator, u32 *denominator,
871 unsigned int n_terms, unsigned int threshold);
872 u32 uvc_fraction_to_interval(u32 numerator, u32 denominator);
873 struct usb_host_endpoint *uvc_find_endpoint(struct usb_host_interface *alts,
874 u8 epaddr);
875
876 /* Quirks support */
877 void uvc_video_decode_isight(struct uvc_urb *uvc_urb,
878 struct uvc_buffer *buf,
879 struct uvc_buffer *meta_buf);
880
881 /* debugfs and statistics */
882 void uvc_debugfs_init(void);
883 void uvc_debugfs_cleanup(void);
884 void uvc_debugfs_init_stream(struct uvc_streaming *stream);
885 void uvc_debugfs_cleanup_stream(struct uvc_streaming *stream);
886
887 size_t uvc_video_stats_dump(struct uvc_streaming *stream, char *buf,
888 size_t size);
889
890 #endif
891