xref: /openbmc/linux/drivers/media/usb/uvc/uvcvideo.h (revision 54cbac81)
1 #ifndef _USB_VIDEO_H_
2 #define _USB_VIDEO_H_
3 
4 #ifndef __KERNEL__
5 #error "The uvcvideo.h header is deprecated, use linux/uvcvideo.h instead."
6 #endif /* __KERNEL__ */
7 
8 #include <linux/kernel.h>
9 #include <linux/poll.h>
10 #include <linux/usb.h>
11 #include <linux/usb/video.h>
12 #include <linux/uvcvideo.h>
13 #include <linux/videodev2.h>
14 #include <media/media-device.h>
15 #include <media/v4l2-device.h>
16 #include <media/v4l2-event.h>
17 #include <media/v4l2-fh.h>
18 #include <media/videobuf2-core.h>
19 
20 /* --------------------------------------------------------------------------
21  * UVC constants
22  */
23 
24 #define UVC_TERM_INPUT			0x0000
25 #define UVC_TERM_OUTPUT			0x8000
26 #define UVC_TERM_DIRECTION(term)	((term)->type & 0x8000)
27 
28 #define UVC_ENTITY_TYPE(entity)		((entity)->type & 0x7fff)
29 #define UVC_ENTITY_IS_UNIT(entity)	(((entity)->type & 0xff00) == 0)
30 #define UVC_ENTITY_IS_TERM(entity)	(((entity)->type & 0xff00) != 0)
31 #define UVC_ENTITY_IS_ITERM(entity) \
32 	(UVC_ENTITY_IS_TERM(entity) && \
33 	((entity)->type & 0x8000) == UVC_TERM_INPUT)
34 #define UVC_ENTITY_IS_OTERM(entity) \
35 	(UVC_ENTITY_IS_TERM(entity) && \
36 	((entity)->type & 0x8000) == UVC_TERM_OUTPUT)
37 
38 
39 /* ------------------------------------------------------------------------
40  * GUIDs
41  */
42 #define UVC_GUID_UVC_CAMERA \
43 	{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
44 	 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01}
45 #define UVC_GUID_UVC_OUTPUT \
46 	{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
47 	 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02}
48 #define UVC_GUID_UVC_MEDIA_TRANSPORT_INPUT \
49 	{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
50 	 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03}
51 #define UVC_GUID_UVC_PROCESSING \
52 	{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
53 	 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x01}
54 #define UVC_GUID_UVC_SELECTOR \
55 	{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
56 	 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x02}
57 
58 #define UVC_GUID_FORMAT_MJPEG \
59 	{ 'M',  'J',  'P',  'G', 0x00, 0x00, 0x10, 0x00, \
60 	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
61 #define UVC_GUID_FORMAT_YUY2 \
62 	{ 'Y',  'U',  'Y',  '2', 0x00, 0x00, 0x10, 0x00, \
63 	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
64 #define UVC_GUID_FORMAT_YUY2_ISIGHT \
65 	{ 'Y',  'U',  'Y',  '2', 0x00, 0x00, 0x10, 0x00, \
66 	 0x80, 0x00, 0x00, 0x00, 0x00, 0x38, 0x9b, 0x71}
67 #define UVC_GUID_FORMAT_NV12 \
68 	{ 'N',  'V',  '1',  '2', 0x00, 0x00, 0x10, 0x00, \
69 	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
70 #define UVC_GUID_FORMAT_YV12 \
71 	{ 'Y',  'V',  '1',  '2', 0x00, 0x00, 0x10, 0x00, \
72 	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
73 #define UVC_GUID_FORMAT_I420 \
74 	{ 'I',  '4',  '2',  '0', 0x00, 0x00, 0x10, 0x00, \
75 	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
76 #define UVC_GUID_FORMAT_UYVY \
77 	{ 'U',  'Y',  'V',  'Y', 0x00, 0x00, 0x10, 0x00, \
78 	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
79 #define UVC_GUID_FORMAT_Y800 \
80 	{ 'Y',  '8',  '0',  '0', 0x00, 0x00, 0x10, 0x00, \
81 	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
82 #define UVC_GUID_FORMAT_Y8 \
83 	{ 'Y',  '8',  ' ',  ' ', 0x00, 0x00, 0x10, 0x00, \
84 	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
85 #define UVC_GUID_FORMAT_Y10 \
86 	{ 'Y',  '1',  '0',  ' ', 0x00, 0x00, 0x10, 0x00, \
87 	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
88 #define UVC_GUID_FORMAT_Y12 \
89 	{ 'Y',  '1',  '2',  ' ', 0x00, 0x00, 0x10, 0x00, \
90 	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
91 #define UVC_GUID_FORMAT_Y16 \
92 	{ 'Y',  '1',  '6',  ' ', 0x00, 0x00, 0x10, 0x00, \
93 	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
94 #define UVC_GUID_FORMAT_BY8 \
95 	{ 'B',  'Y',  '8',  ' ', 0x00, 0x00, 0x10, 0x00, \
96 	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
97 #define UVC_GUID_FORMAT_RGBP \
98 	{ 'R',  'G',  'B',  'P', 0x00, 0x00, 0x10, 0x00, \
99 	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
100 #define UVC_GUID_FORMAT_M420 \
101 	{ 'M',  '4',  '2',  '0', 0x00, 0x00, 0x10, 0x00, \
102 	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
103 
104 #define UVC_GUID_FORMAT_H264 \
105 	{ 'H',  '2',  '6',  '4', 0x00, 0x00, 0x10, 0x00, \
106 	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
107 
108 /* ------------------------------------------------------------------------
109  * Driver specific constants.
110  */
111 
112 #define DRIVER_VERSION		"1.1.1"
113 
114 /* Number of isochronous URBs. */
115 #define UVC_URBS		5
116 /* Maximum number of packets per URB. */
117 #define UVC_MAX_PACKETS		32
118 /* Maximum number of video buffers. */
119 #define UVC_MAX_VIDEO_BUFFERS	32
120 /* Maximum status buffer size in bytes of interrupt URB. */
121 #define UVC_MAX_STATUS_SIZE	16
122 
123 #define UVC_CTRL_CONTROL_TIMEOUT	300
124 #define UVC_CTRL_STREAMING_TIMEOUT	5000
125 
126 /* Maximum allowed number of control mappings per device */
127 #define UVC_MAX_CONTROL_MAPPINGS	1024
128 #define UVC_MAX_CONTROL_MENU_ENTRIES	32
129 
130 /* Devices quirks */
131 #define UVC_QUIRK_STATUS_INTERVAL	0x00000001
132 #define UVC_QUIRK_PROBE_MINMAX		0x00000002
133 #define UVC_QUIRK_PROBE_EXTRAFIELDS	0x00000004
134 #define UVC_QUIRK_BUILTIN_ISIGHT	0x00000008
135 #define UVC_QUIRK_STREAM_NO_FID		0x00000010
136 #define UVC_QUIRK_IGNORE_SELECTOR_UNIT	0x00000020
137 #define UVC_QUIRK_FIX_BANDWIDTH		0x00000080
138 #define UVC_QUIRK_PROBE_DEF		0x00000100
139 #define UVC_QUIRK_RESTRICT_FRAME_RATE	0x00000200
140 
141 /* Format flags */
142 #define UVC_FMT_FLAG_COMPRESSED		0x00000001
143 #define UVC_FMT_FLAG_STREAM		0x00000002
144 
145 /* ------------------------------------------------------------------------
146  * Structures.
147  */
148 
149 struct uvc_device;
150 
151 /* TODO: Put the most frequently accessed fields at the beginning of
152  * structures to maximize cache efficiency.
153  */
154 struct uvc_control_info {
155 	struct list_head mappings;
156 
157 	__u8 entity[16];
158 	__u8 index;	/* Bit index in bmControls */
159 	__u8 selector;
160 
161 	__u16 size;
162 	__u32 flags;
163 };
164 
165 struct uvc_control_mapping {
166 	struct list_head list;
167 	struct list_head ev_subs;
168 
169 	__u32 id;
170 	__u8 name[32];
171 	__u8 entity[16];
172 	__u8 selector;
173 
174 	__u8 size;
175 	__u8 offset;
176 	enum v4l2_ctrl_type v4l2_type;
177 	__u32 data_type;
178 
179 	struct uvc_menu_info *menu_info;
180 	__u32 menu_count;
181 
182 	__u32 master_id;
183 	__s32 master_manual;
184 	__u32 slave_ids[2];
185 
186 	__s32 (*get) (struct uvc_control_mapping *mapping, __u8 query,
187 		      const __u8 *data);
188 	void (*set) (struct uvc_control_mapping *mapping, __s32 value,
189 		     __u8 *data);
190 };
191 
192 struct uvc_control {
193 	struct uvc_entity *entity;
194 	struct uvc_control_info info;
195 
196 	__u8 index;	/* Used to match the uvc_control entry with a
197 			   uvc_control_info. */
198 	__u8 dirty:1,
199 	     loaded:1,
200 	     modified:1,
201 	     cached:1,
202 	     initialized:1;
203 
204 	__u8 *uvc_data;
205 };
206 
207 struct uvc_format_desc {
208 	char *name;
209 	__u8 guid[16];
210 	__u32 fcc;
211 };
212 
213 /* The term 'entity' refers to both UVC units and UVC terminals.
214  *
215  * The type field is either the terminal type (wTerminalType in the terminal
216  * descriptor), or the unit type (bDescriptorSubtype in the unit descriptor).
217  * As the bDescriptorSubtype field is one byte long, the type value will
218  * always have a null MSB for units. All terminal types defined by the UVC
219  * specification have a non-null MSB, so it is safe to use the MSB to
220  * differentiate between units and terminals as long as the descriptor parsing
221  * code makes sure terminal types have a non-null MSB.
222  *
223  * For terminals, the type's most significant bit stores the terminal
224  * direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should
225  * always be accessed with the UVC_ENTITY_* macros and never directly.
226  */
227 
228 #define UVC_ENTITY_FLAG_DEFAULT		(1 << 0)
229 
230 struct uvc_entity {
231 	struct list_head list;		/* Entity as part of a UVC device. */
232 	struct list_head chain;		/* Entity as part of a video device
233 					 * chain. */
234 	unsigned int flags;
235 
236 	__u8 id;
237 	__u16 type;
238 	char name[64];
239 
240 	/* Media controller-related fields. */
241 	struct video_device *vdev;
242 	struct v4l2_subdev subdev;
243 	unsigned int num_pads;
244 	unsigned int num_links;
245 	struct media_pad *pads;
246 
247 	union {
248 		struct {
249 			__u16 wObjectiveFocalLengthMin;
250 			__u16 wObjectiveFocalLengthMax;
251 			__u16 wOcularFocalLength;
252 			__u8  bControlSize;
253 			__u8  *bmControls;
254 		} camera;
255 
256 		struct {
257 			__u8  bControlSize;
258 			__u8  *bmControls;
259 			__u8  bTransportModeSize;
260 			__u8  *bmTransportModes;
261 		} media;
262 
263 		struct {
264 		} output;
265 
266 		struct {
267 			__u16 wMaxMultiplier;
268 			__u8  bControlSize;
269 			__u8  *bmControls;
270 			__u8  bmVideoStandards;
271 		} processing;
272 
273 		struct {
274 		} selector;
275 
276 		struct {
277 			__u8  guidExtensionCode[16];
278 			__u8  bNumControls;
279 			__u8  bControlSize;
280 			__u8  *bmControls;
281 			__u8  *bmControlsType;
282 		} extension;
283 	};
284 
285 	__u8 bNrInPins;
286 	__u8 *baSourceID;
287 
288 	unsigned int ncontrols;
289 	struct uvc_control *controls;
290 };
291 
292 struct uvc_frame {
293 	__u8  bFrameIndex;
294 	__u8  bmCapabilities;
295 	__u16 wWidth;
296 	__u16 wHeight;
297 	__u32 dwMinBitRate;
298 	__u32 dwMaxBitRate;
299 	__u32 dwMaxVideoFrameBufferSize;
300 	__u8  bFrameIntervalType;
301 	__u32 dwDefaultFrameInterval;
302 	__u32 *dwFrameInterval;
303 };
304 
305 struct uvc_format {
306 	__u8 type;
307 	__u8 index;
308 	__u8 bpp;
309 	__u8 colorspace;
310 	__u32 fcc;
311 	__u32 flags;
312 
313 	char name[32];
314 
315 	unsigned int nframes;
316 	struct uvc_frame *frame;
317 };
318 
319 struct uvc_streaming_header {
320 	__u8 bNumFormats;
321 	__u8 bEndpointAddress;
322 	__u8 bTerminalLink;
323 	__u8 bControlSize;
324 	__u8 *bmaControls;
325 	/* The following fields are used by input headers only. */
326 	__u8 bmInfo;
327 	__u8 bStillCaptureMethod;
328 	__u8 bTriggerSupport;
329 	__u8 bTriggerUsage;
330 };
331 
332 enum uvc_buffer_state {
333 	UVC_BUF_STATE_IDLE	= 0,
334 	UVC_BUF_STATE_QUEUED	= 1,
335 	UVC_BUF_STATE_ACTIVE	= 2,
336 	UVC_BUF_STATE_READY	= 3,
337 	UVC_BUF_STATE_DONE	= 4,
338 	UVC_BUF_STATE_ERROR	= 5,
339 };
340 
341 struct uvc_buffer {
342 	struct vb2_buffer buf;
343 	struct list_head queue;
344 
345 	enum uvc_buffer_state state;
346 	unsigned int error;
347 
348 	void *mem;
349 	unsigned int length;
350 	unsigned int bytesused;
351 
352 	u32 pts;
353 };
354 
355 #define UVC_QUEUE_DISCONNECTED		(1 << 0)
356 #define UVC_QUEUE_DROP_CORRUPTED	(1 << 1)
357 
358 struct uvc_video_queue {
359 	struct vb2_queue queue;
360 	struct mutex mutex;			/* Protects queue */
361 
362 	unsigned int flags;
363 	unsigned int buf_used;
364 
365 	spinlock_t irqlock;			/* Protects irqqueue */
366 	struct list_head irqqueue;
367 };
368 
369 struct uvc_video_chain {
370 	struct uvc_device *dev;
371 	struct list_head list;
372 
373 	struct list_head entities;		/* All entities */
374 	struct uvc_entity *processing;		/* Processing unit */
375 	struct uvc_entity *selector;		/* Selector unit */
376 
377 	struct mutex ctrl_mutex;		/* Protects ctrl.info */
378 
379 	struct v4l2_prio_state prio;		/* V4L2 priority state */
380 	u32 caps;				/* V4L2 chain-wide caps */
381 };
382 
383 struct uvc_stats_frame {
384 	unsigned int size;		/* Number of bytes captured */
385 	unsigned int first_data;	/* Index of the first non-empty packet */
386 
387 	unsigned int nb_packets;	/* Number of packets */
388 	unsigned int nb_empty;		/* Number of empty packets */
389 	unsigned int nb_invalid;	/* Number of packets with an invalid header */
390 	unsigned int nb_errors;		/* Number of packets with the error bit set */
391 
392 	unsigned int nb_pts;		/* Number of packets with a PTS timestamp */
393 	unsigned int nb_pts_diffs;	/* Number of PTS differences inside a frame */
394 	unsigned int last_pts_diff;	/* Index of the last PTS difference */
395 	bool has_initial_pts;		/* Whether the first non-empty packet has a PTS */
396 	bool has_early_pts;		/* Whether a PTS is present before the first non-empty packet */
397 	u32 pts;			/* PTS of the last packet */
398 
399 	unsigned int nb_scr;		/* Number of packets with a SCR timestamp */
400 	unsigned int nb_scr_diffs;	/* Number of SCR.STC differences inside a frame */
401 	u16 scr_sof;			/* SCR.SOF of the last packet */
402 	u32 scr_stc;			/* SCR.STC of the last packet */
403 };
404 
405 struct uvc_stats_stream {
406 	struct timespec start_ts;	/* Stream start timestamp */
407 	struct timespec stop_ts;	/* Stream stop timestamp */
408 
409 	unsigned int nb_frames;		/* Number of frames */
410 
411 	unsigned int nb_packets;	/* Number of packets */
412 	unsigned int nb_empty;		/* Number of empty packets */
413 	unsigned int nb_invalid;	/* Number of packets with an invalid header */
414 	unsigned int nb_errors;		/* Number of packets with the error bit set */
415 
416 	unsigned int nb_pts_constant;	/* Number of frames with constant PTS */
417 	unsigned int nb_pts_early;	/* Number of frames with early PTS */
418 	unsigned int nb_pts_initial;	/* Number of frames with initial PTS */
419 
420 	unsigned int nb_scr_count_ok;	/* Number of frames with at least one SCR per non empty packet */
421 	unsigned int nb_scr_diffs_ok;	/* Number of frames with varying SCR.STC */
422 	unsigned int scr_sof_count;	/* STC.SOF counter accumulated since stream start */
423 	unsigned int scr_sof;		/* STC.SOF of the last packet */
424 	unsigned int min_sof;		/* Minimum STC.SOF value */
425 	unsigned int max_sof;		/* Maximum STC.SOF value */
426 };
427 
428 struct uvc_streaming {
429 	struct list_head list;
430 	struct uvc_device *dev;
431 	struct video_device *vdev;
432 	struct uvc_video_chain *chain;
433 	atomic_t active;
434 
435 	struct usb_interface *intf;
436 	int intfnum;
437 	__u16 maxpsize;
438 
439 	struct uvc_streaming_header header;
440 	enum v4l2_buf_type type;
441 
442 	unsigned int nformats;
443 	struct uvc_format *format;
444 
445 	struct uvc_streaming_control ctrl;
446 	struct uvc_format *def_format;
447 	struct uvc_format *cur_format;
448 	struct uvc_frame *cur_frame;
449 	/* Protect access to ctrl, cur_format, cur_frame and hardware video
450 	 * probe control.
451 	 */
452 	struct mutex mutex;
453 
454 	/* Buffers queue. */
455 	unsigned int frozen : 1;
456 	struct uvc_video_queue queue;
457 	void (*decode) (struct urb *urb, struct uvc_streaming *video,
458 			struct uvc_buffer *buf);
459 
460 	/* Context data used by the bulk completion handler. */
461 	struct {
462 		__u8 header[256];
463 		unsigned int header_size;
464 		int skip_payload;
465 		__u32 payload_size;
466 		__u32 max_payload_size;
467 	} bulk;
468 
469 	struct urb *urb[UVC_URBS];
470 	char *urb_buffer[UVC_URBS];
471 	dma_addr_t urb_dma[UVC_URBS];
472 	unsigned int urb_size;
473 
474 	__u32 sequence;
475 	__u8 last_fid;
476 
477 	/* debugfs */
478 	struct dentry *debugfs_dir;
479 	struct {
480 		struct uvc_stats_frame frame;
481 		struct uvc_stats_stream stream;
482 	} stats;
483 
484 	/* Timestamps support. */
485 	struct uvc_clock {
486 		struct uvc_clock_sample {
487 			u32 dev_stc;
488 			u16 dev_sof;
489 			struct timespec host_ts;
490 			u16 host_sof;
491 		} *samples;
492 
493 		unsigned int head;
494 		unsigned int count;
495 		unsigned int size;
496 
497 		u16 last_sof;
498 		u16 sof_offset;
499 
500 		spinlock_t lock;
501 	} clock;
502 };
503 
504 enum uvc_device_state {
505 	UVC_DEV_DISCONNECTED = 1,
506 };
507 
508 struct uvc_device {
509 	struct usb_device *udev;
510 	struct usb_interface *intf;
511 	unsigned long warnings;
512 	__u32 quirks;
513 	int intfnum;
514 	char name[32];
515 
516 	enum uvc_device_state state;
517 	atomic_t users;
518 	atomic_t nmappings;
519 
520 	/* Video control interface */
521 #ifdef CONFIG_MEDIA_CONTROLLER
522 	struct media_device mdev;
523 #endif
524 	struct v4l2_device vdev;
525 	__u16 uvc_version;
526 	__u32 clock_frequency;
527 
528 	struct list_head entities;
529 	struct list_head chains;
530 
531 	/* Video Streaming interfaces */
532 	struct list_head streams;
533 	atomic_t nstreams;
534 
535 	/* Status Interrupt Endpoint */
536 	struct usb_host_endpoint *int_ep;
537 	struct urb *int_urb;
538 	__u8 *status;
539 	struct input_dev *input;
540 	char input_phys[64];
541 };
542 
543 enum uvc_handle_state {
544 	UVC_HANDLE_PASSIVE	= 0,
545 	UVC_HANDLE_ACTIVE	= 1,
546 };
547 
548 struct uvc_fh {
549 	struct v4l2_fh vfh;
550 	struct uvc_video_chain *chain;
551 	struct uvc_streaming *stream;
552 	enum uvc_handle_state state;
553 };
554 
555 struct uvc_driver {
556 	struct usb_driver driver;
557 };
558 
559 /* ------------------------------------------------------------------------
560  * Debugging, printing and logging
561  */
562 
563 #define UVC_TRACE_PROBE		(1 << 0)
564 #define UVC_TRACE_DESCR		(1 << 1)
565 #define UVC_TRACE_CONTROL	(1 << 2)
566 #define UVC_TRACE_FORMAT	(1 << 3)
567 #define UVC_TRACE_CAPTURE	(1 << 4)
568 #define UVC_TRACE_CALLS		(1 << 5)
569 #define UVC_TRACE_IOCTL		(1 << 6)
570 #define UVC_TRACE_FRAME		(1 << 7)
571 #define UVC_TRACE_SUSPEND	(1 << 8)
572 #define UVC_TRACE_STATUS	(1 << 9)
573 #define UVC_TRACE_VIDEO		(1 << 10)
574 #define UVC_TRACE_STATS		(1 << 11)
575 #define UVC_TRACE_CLOCK		(1 << 12)
576 
577 #define UVC_WARN_MINMAX		0
578 #define UVC_WARN_PROBE_DEF	1
579 #define UVC_WARN_XU_GET_RES	2
580 
581 extern unsigned int uvc_clock_param;
582 extern unsigned int uvc_no_drop_param;
583 extern unsigned int uvc_trace_param;
584 extern unsigned int uvc_timeout_param;
585 
586 #define uvc_trace(flag, msg...) \
587 	do { \
588 		if (uvc_trace_param & flag) \
589 			printk(KERN_DEBUG "uvcvideo: " msg); \
590 	} while (0)
591 
592 #define uvc_warn_once(dev, warn, msg...) \
593 	do { \
594 		if (!test_and_set_bit(warn, &dev->warnings)) \
595 			printk(KERN_INFO "uvcvideo: " msg); \
596 	} while (0)
597 
598 #define uvc_printk(level, msg...) \
599 	printk(level "uvcvideo: " msg)
600 
601 /* --------------------------------------------------------------------------
602  * Internal functions.
603  */
604 
605 /* Core driver */
606 extern struct uvc_driver uvc_driver;
607 
608 extern struct uvc_entity *uvc_entity_by_id(struct uvc_device *dev, int id);
609 
610 /* Video buffers queue management. */
611 extern int uvc_queue_init(struct uvc_video_queue *queue,
612 		enum v4l2_buf_type type, int drop_corrupted);
613 extern int uvc_alloc_buffers(struct uvc_video_queue *queue,
614 		struct v4l2_requestbuffers *rb);
615 extern void uvc_free_buffers(struct uvc_video_queue *queue);
616 extern int uvc_query_buffer(struct uvc_video_queue *queue,
617 		struct v4l2_buffer *v4l2_buf);
618 extern int uvc_queue_buffer(struct uvc_video_queue *queue,
619 		struct v4l2_buffer *v4l2_buf);
620 extern int uvc_dequeue_buffer(struct uvc_video_queue *queue,
621 		struct v4l2_buffer *v4l2_buf, int nonblocking);
622 extern int uvc_queue_enable(struct uvc_video_queue *queue, int enable);
623 extern void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect);
624 extern struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue,
625 		struct uvc_buffer *buf);
626 extern int uvc_queue_mmap(struct uvc_video_queue *queue,
627 		struct vm_area_struct *vma);
628 extern unsigned int uvc_queue_poll(struct uvc_video_queue *queue,
629 		struct file *file, poll_table *wait);
630 #ifndef CONFIG_MMU
631 extern unsigned long uvc_queue_get_unmapped_area(struct uvc_video_queue *queue,
632 		unsigned long pgoff);
633 #endif
634 extern int uvc_queue_allocated(struct uvc_video_queue *queue);
635 static inline int uvc_queue_streaming(struct uvc_video_queue *queue)
636 {
637 	return vb2_is_streaming(&queue->queue);
638 }
639 
640 /* V4L2 interface */
641 extern const struct v4l2_file_operations uvc_fops;
642 
643 /* Media controller */
644 extern int uvc_mc_register_entities(struct uvc_video_chain *chain);
645 extern void uvc_mc_cleanup_entity(struct uvc_entity *entity);
646 
647 /* Video */
648 extern int uvc_video_init(struct uvc_streaming *stream);
649 extern int uvc_video_suspend(struct uvc_streaming *stream);
650 extern int uvc_video_resume(struct uvc_streaming *stream, int reset);
651 extern int uvc_video_enable(struct uvc_streaming *stream, int enable);
652 extern int uvc_probe_video(struct uvc_streaming *stream,
653 		struct uvc_streaming_control *probe);
654 extern int uvc_query_ctrl(struct uvc_device *dev, __u8 query, __u8 unit,
655 		__u8 intfnum, __u8 cs, void *data, __u16 size);
656 void uvc_video_clock_update(struct uvc_streaming *stream,
657 			    struct v4l2_buffer *v4l2_buf,
658 			    struct uvc_buffer *buf);
659 
660 /* Status */
661 extern int uvc_status_init(struct uvc_device *dev);
662 extern void uvc_status_cleanup(struct uvc_device *dev);
663 extern int uvc_status_start(struct uvc_device *dev);
664 extern void uvc_status_stop(struct uvc_device *dev);
665 extern int uvc_status_suspend(struct uvc_device *dev);
666 extern int uvc_status_resume(struct uvc_device *dev);
667 
668 /* Controls */
669 extern const struct v4l2_subscribed_event_ops uvc_ctrl_sub_ev_ops;
670 
671 extern int uvc_query_v4l2_ctrl(struct uvc_video_chain *chain,
672 		struct v4l2_queryctrl *v4l2_ctrl);
673 extern int uvc_query_v4l2_menu(struct uvc_video_chain *chain,
674 		struct v4l2_querymenu *query_menu);
675 
676 extern int uvc_ctrl_add_mapping(struct uvc_video_chain *chain,
677 		const struct uvc_control_mapping *mapping);
678 extern int uvc_ctrl_init_device(struct uvc_device *dev);
679 extern void uvc_ctrl_cleanup_device(struct uvc_device *dev);
680 extern int uvc_ctrl_resume_device(struct uvc_device *dev);
681 
682 extern int uvc_ctrl_begin(struct uvc_video_chain *chain);
683 extern int __uvc_ctrl_commit(struct uvc_fh *handle, int rollback,
684 			const struct v4l2_ext_control *xctrls,
685 			unsigned int xctrls_count);
686 static inline int uvc_ctrl_commit(struct uvc_fh *handle,
687 			const struct v4l2_ext_control *xctrls,
688 			unsigned int xctrls_count)
689 {
690 	return __uvc_ctrl_commit(handle, 0, xctrls, xctrls_count);
691 }
692 static inline int uvc_ctrl_rollback(struct uvc_fh *handle)
693 {
694 	return __uvc_ctrl_commit(handle, 1, NULL, 0);
695 }
696 
697 extern int uvc_ctrl_get(struct uvc_video_chain *chain,
698 		struct v4l2_ext_control *xctrl);
699 extern int uvc_ctrl_set(struct uvc_video_chain *chain,
700 		struct v4l2_ext_control *xctrl);
701 
702 extern int uvc_xu_ctrl_query(struct uvc_video_chain *chain,
703 		struct uvc_xu_control_query *xqry);
704 
705 /* Utility functions */
706 extern void uvc_simplify_fraction(uint32_t *numerator, uint32_t *denominator,
707 		unsigned int n_terms, unsigned int threshold);
708 extern uint32_t uvc_fraction_to_interval(uint32_t numerator,
709 		uint32_t denominator);
710 extern struct usb_host_endpoint *uvc_find_endpoint(
711 		struct usb_host_interface *alts, __u8 epaddr);
712 
713 /* Quirks support */
714 void uvc_video_decode_isight(struct urb *urb, struct uvc_streaming *stream,
715 		struct uvc_buffer *buf);
716 
717 /* debugfs and statistics */
718 int uvc_debugfs_init(void);
719 void uvc_debugfs_cleanup(void);
720 int uvc_debugfs_init_stream(struct uvc_streaming *stream);
721 void uvc_debugfs_cleanup_stream(struct uvc_streaming *stream);
722 
723 size_t uvc_video_stats_dump(struct uvc_streaming *stream, char *buf,
724 			    size_t size);
725 
726 #endif
727