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