uvcvideo.h 20.3 KB
Newer Older
1 2 3
#ifndef _USB_VIDEO_H_
#define _USB_VIDEO_H_

4
#ifndef __KERNEL__
5 6
#error "The uvcvideo.h header is deprecated, use linux/uvcvideo.h instead."
#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 15
#include <media/media-device.h>
#include <media/v4l2-device.h>
16 17
#include <media/v4l2-event.h>
#include <media/v4l2-fh.h>
18
#include <media/videobuf2-core.h>
19 20 21 22 23 24 25

/* --------------------------------------------------------------------------
 * UVC constants
 */

#define UVC_TERM_INPUT			0x0000
#define UVC_TERM_OUTPUT			0x8000
26
#define UVC_TERM_DIRECTION(term)	((term)->type & 0x8000)
27 28 29 30 31

#define UVC_ENTITY_TYPE(entity)		((entity)->type & 0x7fff)
#define UVC_ENTITY_IS_UNIT(entity)	(((entity)->type & 0xff00) == 0)
#define UVC_ENTITY_IS_TERM(entity)	(((entity)->type & 0xff00) != 0)
#define UVC_ENTITY_IS_ITERM(entity) \
32 33
	(UVC_ENTITY_IS_TERM(entity) && \
	((entity)->type & 0x8000) == UVC_TERM_INPUT)
34
#define UVC_ENTITY_IS_OTERM(entity) \
35 36
	(UVC_ENTITY_IS_TERM(entity) && \
	((entity)->type & 0x8000) == UVC_TERM_OUTPUT)
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63


/* ------------------------------------------------------------------------
 * GUIDs
 */
#define UVC_GUID_UVC_CAMERA \
	{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
	 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01}
#define UVC_GUID_UVC_OUTPUT \
	{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
	 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02}
#define UVC_GUID_UVC_MEDIA_TRANSPORT_INPUT \
	{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
	 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03}
#define UVC_GUID_UVC_PROCESSING \
	{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
	 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x01}
#define UVC_GUID_UVC_SELECTOR \
	{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
	 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x02}

#define UVC_GUID_FORMAT_MJPEG \
	{ 'M',  'J',  'P',  'G', 0x00, 0x00, 0x10, 0x00, \
	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
#define UVC_GUID_FORMAT_YUY2 \
	{ 'Y',  'U',  'Y',  '2', 0x00, 0x00, 0x10, 0x00, \
	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
64 65 66
#define UVC_GUID_FORMAT_YUY2_ISIGHT \
	{ 'Y',  'U',  'Y',  '2', 0x00, 0x00, 0x10, 0x00, \
	 0x80, 0x00, 0x00, 0x00, 0x00, 0x38, 0x9b, 0x71}
67 68 69 70 71 72 73 74 75 76 77 78 79 80
#define UVC_GUID_FORMAT_NV12 \
	{ 'N',  'V',  '1',  '2', 0x00, 0x00, 0x10, 0x00, \
	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
#define UVC_GUID_FORMAT_YV12 \
	{ 'Y',  'V',  '1',  '2', 0x00, 0x00, 0x10, 0x00, \
	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
#define UVC_GUID_FORMAT_I420 \
	{ 'I',  '4',  '2',  '0', 0x00, 0x00, 0x10, 0x00, \
	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
#define UVC_GUID_FORMAT_UYVY \
	{ 'U',  'Y',  'V',  'Y', 0x00, 0x00, 0x10, 0x00, \
	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
#define UVC_GUID_FORMAT_Y800 \
	{ 'Y',  '8',  '0',  '0', 0x00, 0x00, 0x10, 0x00, \
81 82 83 84 85 86 87 88 89
	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
#define UVC_GUID_FORMAT_Y8 \
	{ 'Y',  '8',  ' ',  ' ', 0x00, 0x00, 0x10, 0x00, \
	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
#define UVC_GUID_FORMAT_Y10 \
	{ 'Y',  '1',  '0',  ' ', 0x00, 0x00, 0x10, 0x00, \
	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
#define UVC_GUID_FORMAT_Y12 \
	{ 'Y',  '1',  '2',  ' ', 0x00, 0x00, 0x10, 0x00, \
90
	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
91 92 93
#define UVC_GUID_FORMAT_Y16 \
	{ 'Y',  '1',  '6',  ' ', 0x00, 0x00, 0x10, 0x00, \
	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
94 95 96
#define UVC_GUID_FORMAT_BY8 \
	{ 'B',  'Y',  '8',  ' ', 0x00, 0x00, 0x10, 0x00, \
	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
97 98 99
#define UVC_GUID_FORMAT_RGBP \
	{ 'R',  'G',  'B',  'P', 0x00, 0x00, 0x10, 0x00, \
	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
100 101 102
#define UVC_GUID_FORMAT_M420 \
	{ 'M',  '4',  '2',  '0', 0x00, 0x00, 0x10, 0x00, \
	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
103

104 105 106 107
#define UVC_GUID_FORMAT_H264 \
	{ 'H',  '2',  '6',  '4', 0x00, 0x00, 0x10, 0x00, \
	 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}

108 109 110 111
/* ------------------------------------------------------------------------
 * Driver specific constants.
 */

112
#define DRIVER_VERSION		"1.1.1"
113 114 115

/* Number of isochronous URBs. */
#define UVC_URBS		5
116 117
/* Maximum number of packets per URB. */
#define UVC_MAX_PACKETS		32
118 119
/* Maximum status buffer size in bytes of interrupt URB. */
#define UVC_MAX_STATUS_SIZE	16
120 121

#define UVC_CTRL_CONTROL_TIMEOUT	300
122
#define UVC_CTRL_STREAMING_TIMEOUT	5000
123

124 125
/* Maximum allowed number of control mappings per device */
#define UVC_MAX_CONTROL_MAPPINGS	1024
126
#define UVC_MAX_CONTROL_MENU_ENTRIES	32
127

128 129 130 131 132 133 134
/* Devices quirks */
#define UVC_QUIRK_STATUS_INTERVAL	0x00000001
#define UVC_QUIRK_PROBE_MINMAX		0x00000002
#define UVC_QUIRK_PROBE_EXTRAFIELDS	0x00000004
#define UVC_QUIRK_BUILTIN_ISIGHT	0x00000008
#define UVC_QUIRK_STREAM_NO_FID		0x00000010
#define UVC_QUIRK_IGNORE_SELECTOR_UNIT	0x00000020
135
#define UVC_QUIRK_FIX_BANDWIDTH		0x00000080
136
#define UVC_QUIRK_PROBE_DEF		0x00000100
137
#define UVC_QUIRK_RESTRICT_FRAME_RATE	0x00000200
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155

/* Format flags */
#define UVC_FMT_FLAG_COMPRESSED		0x00000001
#define UVC_FMT_FLAG_STREAM		0x00000002

/* ------------------------------------------------------------------------
 * Structures.
 */

struct uvc_device;

/* TODO: Put the most frequently accessed fields at the beginning of
 * structures to maximize cache efficiency.
 */
struct uvc_control_info {
	struct list_head mappings;

	__u8 entity[16];
156
	__u8 index;	/* Bit index in bmControls */
157 158 159 160 161 162 163 164
	__u8 selector;

	__u16 size;
	__u32 flags;
};

struct uvc_control_mapping {
	struct list_head list;
165
	struct list_head ev_subs;
166 167 168 169 170 171 172 173 174 175 176 177 178

	__u32 id;
	__u8 name[32];
	__u8 entity[16];
	__u8 selector;

	__u8 size;
	__u8 offset;
	enum v4l2_ctrl_type v4l2_type;
	__u32 data_type;

	struct uvc_menu_info *menu_info;
	__u32 menu_count;
179

180 181 182 183
	__u32 master_id;
	__s32 master_manual;
	__u32 slave_ids[2];

184 185 186 187
	__s32 (*get) (struct uvc_control_mapping *mapping, __u8 query,
		      const __u8 *data);
	void (*set) (struct uvc_control_mapping *mapping, __s32 value,
		     __u8 *data);
188 189 190 191
};

struct uvc_control {
	struct uvc_entity *entity;
192
	struct uvc_control_info info;
193 194 195

	__u8 index;	/* Used to match the uvc_control entry with a
			   uvc_control_info. */
196 197 198 199 200
	__u8 dirty:1,
	     loaded:1,
	     modified:1,
	     cached:1,
	     initialized:1;
201

202
	__u8 *uvc_data;
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
};

struct uvc_format_desc {
	char *name;
	__u8 guid[16];
	__u32 fcc;
};

/* The term 'entity' refers to both UVC units and UVC terminals.
 *
 * The type field is either the terminal type (wTerminalType in the terminal
 * descriptor), or the unit type (bDescriptorSubtype in the unit descriptor).
 * As the bDescriptorSubtype field is one byte long, the type value will
 * always have a null MSB for units. All terminal types defined by the UVC
 * specification have a non-null MSB, so it is safe to use the MSB to
 * differentiate between units and terminals as long as the descriptor parsing
 * code makes sure terminal types have a non-null MSB.
 *
 * For terminals, the type's most significant bit stores the terminal
 * direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should
 * always be accessed with the UVC_ENTITY_* macros and never directly.
 */

226 227
#define UVC_ENTITY_FLAG_DEFAULT		(1 << 0)

228 229 230 231
struct uvc_entity {
	struct list_head list;		/* Entity as part of a UVC device. */
	struct list_head chain;		/* Entity as part of a video device
					 * chain. */
232 233
	unsigned int flags;

234 235 236 237
	__u8 id;
	__u16 type;
	char name[64];

238
	/* Media controller-related fields. */
239
	struct video_device *vdev;
240 241 242 243 244
	struct v4l2_subdev subdev;
	unsigned int num_pads;
	unsigned int num_links;
	struct media_pad *pads;

245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
	union {
		struct {
			__u16 wObjectiveFocalLengthMin;
			__u16 wObjectiveFocalLengthMax;
			__u16 wOcularFocalLength;
			__u8  bControlSize;
			__u8  *bmControls;
		} camera;

		struct {
			__u8  bControlSize;
			__u8  *bmControls;
			__u8  bTransportModeSize;
			__u8  *bmTransportModes;
		} media;

		struct {
		} output;

		struct {
			__u16 wMaxMultiplier;
			__u8  bControlSize;
			__u8  *bmControls;
			__u8  bmVideoStandards;
		} processing;

		struct {
		} selector;

		struct {
			__u8  guidExtensionCode[16];
			__u8  bNumControls;
			__u8  bControlSize;
			__u8  *bmControls;
			__u8  *bmControlsType;
		} extension;
	};

283 284 285
	__u8 bNrInPins;
	__u8 *baSourceID;

286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
	unsigned int ncontrols;
	struct uvc_control *controls;
};

struct uvc_frame {
	__u8  bFrameIndex;
	__u8  bmCapabilities;
	__u16 wWidth;
	__u16 wHeight;
	__u32 dwMinBitRate;
	__u32 dwMaxBitRate;
	__u32 dwMaxVideoFrameBufferSize;
	__u8  bFrameIntervalType;
	__u32 dwDefaultFrameInterval;
	__u32 *dwFrameInterval;
};

struct uvc_format {
	__u8 type;
	__u8 index;
	__u8 bpp;
	__u8 colorspace;
	__u32 fcc;
	__u32 flags;

	char name[32];

	unsigned int nframes;
	struct uvc_frame *frame;
};

struct uvc_streaming_header {
	__u8 bNumFormats;
	__u8 bEndpointAddress;
	__u8 bTerminalLink;
	__u8 bControlSize;
	__u8 *bmaControls;
	/* The following fields are used by input headers only. */
	__u8 bmInfo;
	__u8 bStillCaptureMethod;
	__u8 bTriggerSupport;
	__u8 bTriggerUsage;
};

enum uvc_buffer_state {
331 332 333
	UVC_BUF_STATE_IDLE	= 0,
	UVC_BUF_STATE_QUEUED	= 1,
	UVC_BUF_STATE_ACTIVE	= 2,
334 335 336
	UVC_BUF_STATE_READY	= 3,
	UVC_BUF_STATE_DONE	= 4,
	UVC_BUF_STATE_ERROR	= 5,
337 338 339
};

struct uvc_buffer {
340
	struct vb2_buffer buf;
341
	struct list_head queue;
342

343
	enum uvc_buffer_state state;
344
	unsigned int error;
345 346 347 348

	void *mem;
	unsigned int length;
	unsigned int bytesused;
349 350

	u32 pts;
351 352
};

353 354
#define UVC_QUEUE_DISCONNECTED		(1 << 0)
#define UVC_QUEUE_DROP_CORRUPTED	(1 << 1)
355 356

struct uvc_video_queue {
357 358
	struct vb2_queue queue;
	struct mutex mutex;			/* Protects queue */
359

360
	unsigned int flags;
361
	unsigned int buf_used;
362

363
	spinlock_t irqlock;			/* Protects irqqueue */
364 365 366
	struct list_head irqqueue;
};

367 368 369 370
struct uvc_video_chain {
	struct uvc_device *dev;
	struct list_head list;

371
	struct list_head entities;		/* All entities */
372 373 374
	struct uvc_entity *processing;		/* Processing unit */
	struct uvc_entity *selector;		/* Selector unit */

375
	struct mutex ctrl_mutex;		/* Protects ctrl.info */
376

377
	struct v4l2_prio_state prio;		/* V4L2 priority state */
378
	u32 caps;				/* V4L2 chain-wide caps */
379 380
};

381 382 383 384 385 386 387 388
struct uvc_stats_frame {
	unsigned int size;		/* Number of bytes captured */
	unsigned int first_data;	/* Index of the first non-empty packet */

	unsigned int nb_packets;	/* Number of packets */
	unsigned int nb_empty;		/* Number of empty packets */
	unsigned int nb_invalid;	/* Number of packets with an invalid header */
	unsigned int nb_errors;		/* Number of packets with the error bit set */
389 390 391 392 393 394 395 396 397 398 399 400

	unsigned int nb_pts;		/* Number of packets with a PTS timestamp */
	unsigned int nb_pts_diffs;	/* Number of PTS differences inside a frame */
	unsigned int last_pts_diff;	/* Index of the last PTS difference */
	bool has_initial_pts;		/* Whether the first non-empty packet has a PTS */
	bool has_early_pts;		/* Whether a PTS is present before the first non-empty packet */
	u32 pts;			/* PTS of the last packet */

	unsigned int nb_scr;		/* Number of packets with a SCR timestamp */
	unsigned int nb_scr_diffs;	/* Number of SCR.STC differences inside a frame */
	u16 scr_sof;			/* SCR.SOF of the last packet */
	u32 scr_stc;			/* SCR.STC of the last packet */
401 402 403 404 405 406 407 408 409 410 411 412
};

struct uvc_stats_stream {
	struct timespec start_ts;	/* Stream start timestamp */
	struct timespec stop_ts;	/* Stream stop timestamp */

	unsigned int nb_frames;		/* Number of frames */

	unsigned int nb_packets;	/* Number of packets */
	unsigned int nb_empty;		/* Number of empty packets */
	unsigned int nb_invalid;	/* Number of packets with an invalid header */
	unsigned int nb_errors;		/* Number of packets with the error bit set */
413 414 415 416 417 418 419 420 421 422 423

	unsigned int nb_pts_constant;	/* Number of frames with constant PTS */
	unsigned int nb_pts_early;	/* Number of frames with early PTS */
	unsigned int nb_pts_initial;	/* Number of frames with initial PTS */

	unsigned int nb_scr_count_ok;	/* Number of frames with at least one SCR per non empty packet */
	unsigned int nb_scr_diffs_ok;	/* Number of frames with varying SCR.STC */
	unsigned int scr_sof_count;	/* STC.SOF counter accumulated since stream start */
	unsigned int scr_sof;		/* STC.SOF of the last packet */
	unsigned int min_sof;		/* Minimum STC.SOF value */
	unsigned int max_sof;		/* Maximum STC.SOF value */
424 425
};

426 427
struct uvc_streaming {
	struct list_head list;
428 429
	struct uvc_device *dev;
	struct video_device *vdev;
430
	struct uvc_video_chain *chain;
431 432
	atomic_t active;

433 434 435
	struct usb_interface *intf;
	int intfnum;
	__u16 maxpsize;
436

437 438 439 440 441
	struct uvc_streaming_header header;
	enum v4l2_buf_type type;

	unsigned int nformats;
	struct uvc_format *format;
442

443
	struct uvc_streaming_control ctrl;
444
	struct uvc_format *def_format;
445 446
	struct uvc_format *cur_format;
	struct uvc_frame *cur_frame;
447 448 449
	/* Protect access to ctrl, cur_format, cur_frame and hardware video
	 * probe control.
	 */
450
	struct mutex mutex;
451

452
	/* Buffers queue. */
453 454 455
	unsigned int frozen : 1;
	struct uvc_video_queue queue;
	void (*decode) (struct urb *urb, struct uvc_streaming *video,
456 457 458 459 460 461 462 463 464 465 466 467 468
			struct uvc_buffer *buf);

	/* Context data used by the bulk completion handler. */
	struct {
		__u8 header[256];
		unsigned int header_size;
		int skip_payload;
		__u32 payload_size;
		__u32 max_payload_size;
	} bulk;

	struct urb *urb[UVC_URBS];
	char *urb_buffer[UVC_URBS];
469 470
	dma_addr_t urb_dma[UVC_URBS];
	unsigned int urb_size;
471

472
	__u32 sequence;
473
	__u8 last_fid;
474 475 476

	/* debugfs */
	struct dentry *debugfs_dir;
477 478 479 480
	struct {
		struct uvc_stats_frame frame;
		struct uvc_stats_stream stream;
	} stats;
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499

	/* Timestamps support. */
	struct uvc_clock {
		struct uvc_clock_sample {
			u32 dev_stc;
			u16 dev_sof;
			struct timespec host_ts;
			u16 host_sof;
		} *samples;

		unsigned int head;
		unsigned int count;
		unsigned int size;

		u16 last_sof;
		u16 sof_offset;

		spinlock_t lock;
	} clock;
500 501 502 503 504 505 506 507 508
};

enum uvc_device_state {
	UVC_DEV_DISCONNECTED = 1,
};

struct uvc_device {
	struct usb_device *udev;
	struct usb_interface *intf;
509
	unsigned long warnings;
510 511 512 513 514
	__u32 quirks;
	int intfnum;
	char name[32];

	enum uvc_device_state state;
515 516
	struct mutex lock;		/* Protects users */
	unsigned int users;
517
	atomic_t nmappings;
518 519

	/* Video control interface */
520 521 522 523
#ifdef CONFIG_MEDIA_CONTROLLER
	struct media_device mdev;
#endif
	struct v4l2_device vdev;
524 525 526 527
	__u16 uvc_version;
	__u32 clock_frequency;

	struct list_head entities;
528
	struct list_head chains;
529

530 531
	/* Video Streaming interfaces */
	struct list_head streams;
532
	atomic_t nstreams;
533

534 535 536
	/* Status Interrupt Endpoint */
	struct usb_host_endpoint *int_ep;
	struct urb *int_urb;
537
	__u8 *status;
538
	struct input_dev *input;
539
	char input_phys[64];
540 541 542 543 544 545 546 547
};

enum uvc_handle_state {
	UVC_HANDLE_PASSIVE	= 0,
	UVC_HANDLE_ACTIVE	= 1,
};

struct uvc_fh {
548
	struct v4l2_fh vfh;
549
	struct uvc_video_chain *chain;
550
	struct uvc_streaming *stream;
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
	enum uvc_handle_state state;
};

struct uvc_driver {
	struct usb_driver driver;
};

/* ------------------------------------------------------------------------
 * Debugging, printing and logging
 */

#define UVC_TRACE_PROBE		(1 << 0)
#define UVC_TRACE_DESCR		(1 << 1)
#define UVC_TRACE_CONTROL	(1 << 2)
#define UVC_TRACE_FORMAT	(1 << 3)
#define UVC_TRACE_CAPTURE	(1 << 4)
#define UVC_TRACE_CALLS		(1 << 5)
#define UVC_TRACE_IOCTL		(1 << 6)
#define UVC_TRACE_FRAME		(1 << 7)
#define UVC_TRACE_SUSPEND	(1 << 8)
#define UVC_TRACE_STATUS	(1 << 9)
572
#define UVC_TRACE_VIDEO		(1 << 10)
573
#define UVC_TRACE_STATS		(1 << 11)
574
#define UVC_TRACE_CLOCK		(1 << 12)
575

576 577
#define UVC_WARN_MINMAX		0
#define UVC_WARN_PROBE_DEF	1
578
#define UVC_WARN_XU_GET_RES	2
579

580
extern unsigned int uvc_clock_param;
581
extern unsigned int uvc_no_drop_param;
582
extern unsigned int uvc_trace_param;
583
extern unsigned int uvc_timeout_param;
584 585 586 587 588 589 590

#define uvc_trace(flag, msg...) \
	do { \
		if (uvc_trace_param & flag) \
			printk(KERN_DEBUG "uvcvideo: " msg); \
	} while (0)

591 592 593 594 595 596
#define uvc_warn_once(dev, warn, msg...) \
	do { \
		if (!test_and_set_bit(warn, &dev->warnings)) \
			printk(KERN_INFO "uvcvideo: " msg); \
	} while (0)

597 598 599 600 601 602 603 604 605 606
#define uvc_printk(level, msg...) \
	printk(level "uvcvideo: " msg)

/* --------------------------------------------------------------------------
 * Internal functions.
 */

/* Core driver */
extern struct uvc_driver uvc_driver;

607 608
extern struct uvc_entity *uvc_entity_by_id(struct uvc_device *dev, int id);

609
/* Video buffers queue management. */
610
extern int uvc_queue_init(struct uvc_video_queue *queue,
611
		enum v4l2_buf_type type, int drop_corrupted);
612
extern int uvc_alloc_buffers(struct uvc_video_queue *queue,
613 614
		struct v4l2_requestbuffers *rb);
extern void uvc_free_buffers(struct uvc_video_queue *queue);
615 616 617 618 619 620 621 622 623 624
extern int uvc_query_buffer(struct uvc_video_queue *queue,
		struct v4l2_buffer *v4l2_buf);
extern int uvc_queue_buffer(struct uvc_video_queue *queue,
		struct v4l2_buffer *v4l2_buf);
extern int uvc_dequeue_buffer(struct uvc_video_queue *queue,
		struct v4l2_buffer *v4l2_buf, int nonblocking);
extern int uvc_queue_enable(struct uvc_video_queue *queue, int enable);
extern void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect);
extern struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue,
		struct uvc_buffer *buf);
625 626
extern int uvc_queue_mmap(struct uvc_video_queue *queue,
		struct vm_area_struct *vma);
627 628
extern unsigned int uvc_queue_poll(struct uvc_video_queue *queue,
		struct file *file, poll_table *wait);
629 630 631 632
#ifndef CONFIG_MMU
extern unsigned long uvc_queue_get_unmapped_area(struct uvc_video_queue *queue,
		unsigned long pgoff);
#endif
633
extern int uvc_queue_allocated(struct uvc_video_queue *queue);
634 635
static inline int uvc_queue_streaming(struct uvc_video_queue *queue)
{
636
	return vb2_is_streaming(&queue->queue);
637 638 639
}

/* V4L2 interface */
640
extern const struct v4l2_file_operations uvc_fops;
641

642 643 644 645
/* Media controller */
extern int uvc_mc_register_entities(struct uvc_video_chain *chain);
extern void uvc_mc_cleanup_entity(struct uvc_entity *entity);

646
/* Video */
647 648
extern int uvc_video_init(struct uvc_streaming *stream);
extern int uvc_video_suspend(struct uvc_streaming *stream);
649
extern int uvc_video_resume(struct uvc_streaming *stream, int reset);
650 651
extern int uvc_video_enable(struct uvc_streaming *stream, int enable);
extern int uvc_probe_video(struct uvc_streaming *stream,
652 653 654
		struct uvc_streaming_control *probe);
extern int uvc_query_ctrl(struct uvc_device *dev, __u8 query, __u8 unit,
		__u8 intfnum, __u8 cs, void *data, __u16 size);
655 656 657
void uvc_video_clock_update(struct uvc_streaming *stream,
			    struct v4l2_buffer *v4l2_buf,
			    struct uvc_buffer *buf);
658 659 660 661

/* Status */
extern int uvc_status_init(struct uvc_device *dev);
extern void uvc_status_cleanup(struct uvc_device *dev);
662
extern int uvc_status_start(struct uvc_device *dev, gfp_t flags);
663
extern void uvc_status_stop(struct uvc_device *dev);
664 665

/* Controls */
666 667
extern const struct v4l2_subscribed_event_ops uvc_ctrl_sub_ev_ops;

668
extern int uvc_query_v4l2_ctrl(struct uvc_video_chain *chain,
669
		struct v4l2_queryctrl *v4l2_ctrl);
670 671
extern int uvc_query_v4l2_menu(struct uvc_video_chain *chain,
		struct v4l2_querymenu *query_menu);
672

673 674
extern int uvc_ctrl_add_mapping(struct uvc_video_chain *chain,
		const struct uvc_control_mapping *mapping);
675 676 677 678
extern int uvc_ctrl_init_device(struct uvc_device *dev);
extern void uvc_ctrl_cleanup_device(struct uvc_device *dev);
extern int uvc_ctrl_resume_device(struct uvc_device *dev);

679
extern int uvc_ctrl_begin(struct uvc_video_chain *chain);
680 681 682 683 684 685
extern int __uvc_ctrl_commit(struct uvc_fh *handle, int rollback,
			const struct v4l2_ext_control *xctrls,
			unsigned int xctrls_count);
static inline int uvc_ctrl_commit(struct uvc_fh *handle,
			const struct v4l2_ext_control *xctrls,
			unsigned int xctrls_count)
686
{
687
	return __uvc_ctrl_commit(handle, 0, xctrls, xctrls_count);
688
}
689
static inline int uvc_ctrl_rollback(struct uvc_fh *handle)
690
{
691
	return __uvc_ctrl_commit(handle, 1, NULL, 0);
692 693
}

694
extern int uvc_ctrl_get(struct uvc_video_chain *chain,
695
		struct v4l2_ext_control *xctrl);
696
extern int uvc_ctrl_set(struct uvc_video_chain *chain,
697 698
		struct v4l2_ext_control *xctrl);

699
extern int uvc_xu_ctrl_query(struct uvc_video_chain *chain,
700
		struct uvc_xu_control_query *xqry);
701 702 703 704 705 706 707 708 709 710

/* Utility functions */
extern void uvc_simplify_fraction(uint32_t *numerator, uint32_t *denominator,
		unsigned int n_terms, unsigned int threshold);
extern uint32_t uvc_fraction_to_interval(uint32_t numerator,
		uint32_t denominator);
extern struct usb_host_endpoint *uvc_find_endpoint(
		struct usb_host_interface *alts, __u8 epaddr);

/* Quirks support */
711
void uvc_video_decode_isight(struct urb *urb, struct uvc_streaming *stream,
712 713
		struct uvc_buffer *buf);

714
/* debugfs and statistics */
715 716 717 718 719
int uvc_debugfs_init(void);
void uvc_debugfs_cleanup(void);
int uvc_debugfs_init_stream(struct uvc_streaming *stream);
void uvc_debugfs_cleanup_stream(struct uvc_streaming *stream);

720 721 722
size_t uvc_video_stats_dump(struct uvc_streaming *stream, char *buf,
			    size_t size);

723
#endif