• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  *      uvc_driver.c  --  USB Video Class driver
4  *
5  *      Copyright (C) 2005-2010
6  *          Laurent Pinchart (laurent.pinchart@ideasonboard.com)
7  */
8 
9 #include <linux/atomic.h>
10 #include <linux/kernel.h>
11 #include <linux/list.h>
12 #include <linux/module.h>
13 #include <linux/slab.h>
14 #include <linux/usb.h>
15 #include <linux/videodev2.h>
16 #include <linux/vmalloc.h>
17 #include <linux/wait.h>
18 #include <linux/version.h>
19 #include <asm/unaligned.h>
20 
21 #include <media/v4l2-common.h>
22 #include <media/v4l2-ioctl.h>
23 
24 #include "uvcvideo.h"
25 
26 #define DRIVER_AUTHOR		"Laurent Pinchart " \
27 				"<laurent.pinchart@ideasonboard.com>"
28 #define DRIVER_DESC		"USB Video Class driver"
29 
30 unsigned int uvc_clock_param = CLOCK_MONOTONIC;
31 unsigned int uvc_hw_timestamps_param;
32 unsigned int uvc_no_drop_param;
33 static unsigned int uvc_quirks_param = -1;
34 unsigned int uvc_trace_param;
35 unsigned int uvc_timeout_param = UVC_CTRL_STREAMING_TIMEOUT;
36 
37 /* ------------------------------------------------------------------------
38  * Video formats
39  */
40 
41 static struct uvc_format_desc uvc_fmts[] = {
42 	{
43 		.name		= "YUV 4:2:2 (YUYV)",
44 		.guid		= UVC_GUID_FORMAT_YUY2,
45 		.fcc		= V4L2_PIX_FMT_YUYV,
46 	},
47 	{
48 		.name		= "YUV 4:2:2 (YUYV)",
49 		.guid		= UVC_GUID_FORMAT_YUY2_ISIGHT,
50 		.fcc		= V4L2_PIX_FMT_YUYV,
51 	},
52 	{
53 		.name		= "YUV 4:2:0 (NV12)",
54 		.guid		= UVC_GUID_FORMAT_NV12,
55 		.fcc		= V4L2_PIX_FMT_NV12,
56 	},
57 	{
58 		.name		= "MJPEG",
59 		.guid		= UVC_GUID_FORMAT_MJPEG,
60 		.fcc		= V4L2_PIX_FMT_MJPEG,
61 	},
62 	{
63 		.name		= "YVU 4:2:0 (YV12)",
64 		.guid		= UVC_GUID_FORMAT_YV12,
65 		.fcc		= V4L2_PIX_FMT_YVU420,
66 	},
67 	{
68 		.name		= "YUV 4:2:0 (I420)",
69 		.guid		= UVC_GUID_FORMAT_I420,
70 		.fcc		= V4L2_PIX_FMT_YUV420,
71 	},
72 	{
73 		.name		= "YUV 4:2:0 (M420)",
74 		.guid		= UVC_GUID_FORMAT_M420,
75 		.fcc		= V4L2_PIX_FMT_M420,
76 	},
77 	{
78 		.name		= "YUV 4:2:2 (UYVY)",
79 		.guid		= UVC_GUID_FORMAT_UYVY,
80 		.fcc		= V4L2_PIX_FMT_UYVY,
81 	},
82 	{
83 		.name		= "Greyscale 8-bit (Y800)",
84 		.guid		= UVC_GUID_FORMAT_Y800,
85 		.fcc		= V4L2_PIX_FMT_GREY,
86 	},
87 	{
88 		.name		= "Greyscale 8-bit (Y8  )",
89 		.guid		= UVC_GUID_FORMAT_Y8,
90 		.fcc		= V4L2_PIX_FMT_GREY,
91 	},
92 	{
93 		.name		= "Greyscale 8-bit (D3DFMT_L8)",
94 		.guid		= UVC_GUID_FORMAT_D3DFMT_L8,
95 		.fcc		= V4L2_PIX_FMT_GREY,
96 	},
97 	{
98 		.name		= "IR 8-bit (L8_IR)",
99 		.guid		= UVC_GUID_FORMAT_KSMEDIA_L8_IR,
100 		.fcc		= V4L2_PIX_FMT_GREY,
101 	},
102 	{
103 		.name		= "Greyscale 10-bit (Y10 )",
104 		.guid		= UVC_GUID_FORMAT_Y10,
105 		.fcc		= V4L2_PIX_FMT_Y10,
106 	},
107 	{
108 		.name		= "Greyscale 12-bit (Y12 )",
109 		.guid		= UVC_GUID_FORMAT_Y12,
110 		.fcc		= V4L2_PIX_FMT_Y12,
111 	},
112 	{
113 		.name		= "Greyscale 16-bit (Y16 )",
114 		.guid		= UVC_GUID_FORMAT_Y16,
115 		.fcc		= V4L2_PIX_FMT_Y16,
116 	},
117 	{
118 		.name		= "BGGR Bayer (BY8 )",
119 		.guid		= UVC_GUID_FORMAT_BY8,
120 		.fcc		= V4L2_PIX_FMT_SBGGR8,
121 	},
122 	{
123 		.name		= "BGGR Bayer (BA81)",
124 		.guid		= UVC_GUID_FORMAT_BA81,
125 		.fcc		= V4L2_PIX_FMT_SBGGR8,
126 	},
127 	{
128 		.name		= "GBRG Bayer (GBRG)",
129 		.guid		= UVC_GUID_FORMAT_GBRG,
130 		.fcc		= V4L2_PIX_FMT_SGBRG8,
131 	},
132 	{
133 		.name		= "GRBG Bayer (GRBG)",
134 		.guid		= UVC_GUID_FORMAT_GRBG,
135 		.fcc		= V4L2_PIX_FMT_SGRBG8,
136 	},
137 	{
138 		.name		= "RGGB Bayer (RGGB)",
139 		.guid		= UVC_GUID_FORMAT_RGGB,
140 		.fcc		= V4L2_PIX_FMT_SRGGB8,
141 	},
142 	{
143 		.name		= "RGB565",
144 		.guid		= UVC_GUID_FORMAT_RGBP,
145 		.fcc		= V4L2_PIX_FMT_RGB565,
146 	},
147 	{
148 		.name		= "BGR 8:8:8 (BGR3)",
149 		.guid		= UVC_GUID_FORMAT_BGR3,
150 		.fcc		= V4L2_PIX_FMT_BGR24,
151 	},
152 	{
153 		.name		= "H.264",
154 		.guid		= UVC_GUID_FORMAT_H264,
155 		.fcc		= V4L2_PIX_FMT_H264,
156 	},
157 	{
158 		.name		= "Greyscale 8 L/R (Y8I)",
159 		.guid		= UVC_GUID_FORMAT_Y8I,
160 		.fcc		= V4L2_PIX_FMT_Y8I,
161 	},
162 	{
163 		.name		= "Greyscale 12 L/R (Y12I)",
164 		.guid		= UVC_GUID_FORMAT_Y12I,
165 		.fcc		= V4L2_PIX_FMT_Y12I,
166 	},
167 	{
168 		.name		= "Depth data 16-bit (Z16)",
169 		.guid		= UVC_GUID_FORMAT_Z16,
170 		.fcc		= V4L2_PIX_FMT_Z16,
171 	},
172 	{
173 		.name		= "Bayer 10-bit (SRGGB10P)",
174 		.guid		= UVC_GUID_FORMAT_RW10,
175 		.fcc		= V4L2_PIX_FMT_SRGGB10P,
176 	},
177 	{
178 		.name		= "Bayer 16-bit (SBGGR16)",
179 		.guid		= UVC_GUID_FORMAT_BG16,
180 		.fcc		= V4L2_PIX_FMT_SBGGR16,
181 	},
182 	{
183 		.name		= "Bayer 16-bit (SGBRG16)",
184 		.guid		= UVC_GUID_FORMAT_GB16,
185 		.fcc		= V4L2_PIX_FMT_SGBRG16,
186 	},
187 	{
188 		.name		= "Bayer 16-bit (SRGGB16)",
189 		.guid		= UVC_GUID_FORMAT_RG16,
190 		.fcc		= V4L2_PIX_FMT_SRGGB16,
191 	},
192 	{
193 		.name		= "Bayer 16-bit (SGRBG16)",
194 		.guid		= UVC_GUID_FORMAT_GR16,
195 		.fcc		= V4L2_PIX_FMT_SGRBG16,
196 	},
197 	{
198 		.name		= "Depth data 16-bit (Z16)",
199 		.guid		= UVC_GUID_FORMAT_INVZ,
200 		.fcc		= V4L2_PIX_FMT_Z16,
201 	},
202 	{
203 		.name		= "Greyscale 10-bit (Y10 )",
204 		.guid		= UVC_GUID_FORMAT_INVI,
205 		.fcc		= V4L2_PIX_FMT_Y10,
206 	},
207 	{
208 		.name		= "IR:Depth 26-bit (INZI)",
209 		.guid		= UVC_GUID_FORMAT_INZI,
210 		.fcc		= V4L2_PIX_FMT_INZI,
211 	},
212 	{
213 		.name		= "4-bit Depth Confidence (Packed)",
214 		.guid		= UVC_GUID_FORMAT_CNF4,
215 		.fcc		= V4L2_PIX_FMT_CNF4,
216 	},
217 	{
218 		.name		= "HEVC",
219 		.guid		= UVC_GUID_FORMAT_HEVC,
220 		.fcc		= V4L2_PIX_FMT_HEVC,
221 	},
222 };
223 
224 /* ------------------------------------------------------------------------
225  * Utility functions
226  */
227 
uvc_find_endpoint(struct usb_host_interface * alts,u8 epaddr)228 struct usb_host_endpoint *uvc_find_endpoint(struct usb_host_interface *alts,
229 		u8 epaddr)
230 {
231 	struct usb_host_endpoint *ep;
232 	unsigned int i;
233 
234 	for (i = 0; i < alts->desc.bNumEndpoints; ++i) {
235 		ep = &alts->endpoint[i];
236 		if (ep->desc.bEndpointAddress == epaddr)
237 			return ep;
238 	}
239 
240 	return NULL;
241 }
242 
uvc_format_by_guid(const u8 guid[16])243 static struct uvc_format_desc *uvc_format_by_guid(const u8 guid[16])
244 {
245 	unsigned int len = ARRAY_SIZE(uvc_fmts);
246 	unsigned int i;
247 
248 	for (i = 0; i < len; ++i) {
249 		if (memcmp(guid, uvc_fmts[i].guid, 16) == 0)
250 			return &uvc_fmts[i];
251 	}
252 
253 	return NULL;
254 }
255 
uvc_colorspace(const u8 primaries)256 static enum v4l2_colorspace uvc_colorspace(const u8 primaries)
257 {
258 	static const enum v4l2_colorspace colorprimaries[] = {
259 		V4L2_COLORSPACE_DEFAULT,  /* Unspecified */
260 		V4L2_COLORSPACE_SRGB,
261 		V4L2_COLORSPACE_470_SYSTEM_M,
262 		V4L2_COLORSPACE_470_SYSTEM_BG,
263 		V4L2_COLORSPACE_SMPTE170M,
264 		V4L2_COLORSPACE_SMPTE240M,
265 	};
266 
267 	if (primaries < ARRAY_SIZE(colorprimaries))
268 		return colorprimaries[primaries];
269 
270 	return V4L2_COLORSPACE_DEFAULT;  /* Reserved */
271 }
272 
uvc_xfer_func(const u8 transfer_characteristics)273 static enum v4l2_xfer_func uvc_xfer_func(const u8 transfer_characteristics)
274 {
275 	/*
276 	 * V4L2 does not currently have definitions for all possible values of
277 	 * UVC transfer characteristics. If v4l2_xfer_func is extended with new
278 	 * values, the mapping below should be updated.
279 	 *
280 	 * Substitutions are taken from the mapping given for
281 	 * V4L2_XFER_FUNC_DEFAULT documented in videodev2.h.
282 	 */
283 	static const enum v4l2_xfer_func xfer_funcs[] = {
284 		V4L2_XFER_FUNC_DEFAULT,    /* Unspecified */
285 		V4L2_XFER_FUNC_709,
286 		V4L2_XFER_FUNC_709,        /* Substitution for BT.470-2 M */
287 		V4L2_XFER_FUNC_709,        /* Substitution for BT.470-2 B, G */
288 		V4L2_XFER_FUNC_709,        /* Substitution for SMPTE 170M */
289 		V4L2_XFER_FUNC_SMPTE240M,
290 		V4L2_XFER_FUNC_NONE,
291 		V4L2_XFER_FUNC_SRGB,
292 	};
293 
294 	if (transfer_characteristics < ARRAY_SIZE(xfer_funcs))
295 		return xfer_funcs[transfer_characteristics];
296 
297 	return V4L2_XFER_FUNC_DEFAULT;  /* Reserved */
298 }
299 
uvc_ycbcr_enc(const u8 matrix_coefficients)300 static enum v4l2_ycbcr_encoding uvc_ycbcr_enc(const u8 matrix_coefficients)
301 {
302 	/*
303 	 * V4L2 does not currently have definitions for all possible values of
304 	 * UVC matrix coefficients. If v4l2_ycbcr_encoding is extended with new
305 	 * values, the mapping below should be updated.
306 	 *
307 	 * Substitutions are taken from the mapping given for
308 	 * V4L2_YCBCR_ENC_DEFAULT documented in videodev2.h.
309 	 *
310 	 * FCC is assumed to be close enough to 601.
311 	 */
312 	static const enum v4l2_ycbcr_encoding ycbcr_encs[] = {
313 		V4L2_YCBCR_ENC_DEFAULT,  /* Unspecified */
314 		V4L2_YCBCR_ENC_709,
315 		V4L2_YCBCR_ENC_601,      /* Substitution for FCC */
316 		V4L2_YCBCR_ENC_601,      /* Substitution for BT.470-2 B, G */
317 		V4L2_YCBCR_ENC_601,
318 		V4L2_YCBCR_ENC_SMPTE240M,
319 	};
320 
321 	if (matrix_coefficients < ARRAY_SIZE(ycbcr_encs))
322 		return ycbcr_encs[matrix_coefficients];
323 
324 	return V4L2_YCBCR_ENC_DEFAULT;  /* Reserved */
325 }
326 
327 /* Simplify a fraction using a simple continued fraction decomposition. The
328  * idea here is to convert fractions such as 333333/10000000 to 1/30 using
329  * 32 bit arithmetic only. The algorithm is not perfect and relies upon two
330  * arbitrary parameters to remove non-significative terms from the simple
331  * continued fraction decomposition. Using 8 and 333 for n_terms and threshold
332  * respectively seems to give nice results.
333  */
uvc_simplify_fraction(u32 * numerator,u32 * denominator,unsigned int n_terms,unsigned int threshold)334 void uvc_simplify_fraction(u32 *numerator, u32 *denominator,
335 		unsigned int n_terms, unsigned int threshold)
336 {
337 	u32 *an;
338 	u32 x, y, r;
339 	unsigned int i, n;
340 
341 	an = kmalloc_array(n_terms, sizeof(*an), GFP_KERNEL);
342 	if (an == NULL)
343 		return;
344 
345 	/* Convert the fraction to a simple continued fraction. See
346 	 * https://mathforum.org/dr.math/faq/faq.fractions.html
347 	 * Stop if the current term is bigger than or equal to the given
348 	 * threshold.
349 	 */
350 	x = *numerator;
351 	y = *denominator;
352 
353 	for (n = 0; n < n_terms && y != 0; ++n) {
354 		an[n] = x / y;
355 		if (an[n] >= threshold) {
356 			if (n < 2)
357 				n++;
358 			break;
359 		}
360 
361 		r = x - an[n] * y;
362 		x = y;
363 		y = r;
364 	}
365 
366 	/* Expand the simple continued fraction back to an integer fraction. */
367 	x = 0;
368 	y = 1;
369 
370 	for (i = n; i > 0; --i) {
371 		r = y;
372 		y = an[i-1] * y + x;
373 		x = r;
374 	}
375 
376 	*numerator = y;
377 	*denominator = x;
378 	kfree(an);
379 }
380 
381 /* Convert a fraction to a frame interval in 100ns multiples. The idea here is
382  * to compute numerator / denominator * 10000000 using 32 bit fixed point
383  * arithmetic only.
384  */
uvc_fraction_to_interval(u32 numerator,u32 denominator)385 u32 uvc_fraction_to_interval(u32 numerator, u32 denominator)
386 {
387 	u32 multiplier;
388 
389 	/* Saturate the result if the operation would overflow. */
390 	if (denominator == 0 ||
391 	    numerator/denominator >= ((u32)-1)/10000000)
392 		return (u32)-1;
393 
394 	/* Divide both the denominator and the multiplier by two until
395 	 * numerator * multiplier doesn't overflow. If anyone knows a better
396 	 * algorithm please let me know.
397 	 */
398 	multiplier = 10000000;
399 	while (numerator > ((u32)-1)/multiplier) {
400 		multiplier /= 2;
401 		denominator /= 2;
402 	}
403 
404 	return denominator ? numerator * multiplier / denominator : 0;
405 }
406 
407 /* ------------------------------------------------------------------------
408  * Terminal and unit management
409  */
410 
uvc_entity_by_id(struct uvc_device * dev,int id)411 struct uvc_entity *uvc_entity_by_id(struct uvc_device *dev, int id)
412 {
413 	struct uvc_entity *entity;
414 
415 	list_for_each_entry(entity, &dev->entities, list) {
416 		if (entity->id == id)
417 			return entity;
418 	}
419 
420 	return NULL;
421 }
422 
uvc_entity_by_reference(struct uvc_device * dev,int id,struct uvc_entity * entity)423 static struct uvc_entity *uvc_entity_by_reference(struct uvc_device *dev,
424 	int id, struct uvc_entity *entity)
425 {
426 	unsigned int i;
427 
428 	if (entity == NULL)
429 		entity = list_entry(&dev->entities, struct uvc_entity, list);
430 
431 	list_for_each_entry_continue(entity, &dev->entities, list) {
432 		for (i = 0; i < entity->bNrInPins; ++i)
433 			if (entity->baSourceID[i] == id)
434 				return entity;
435 	}
436 
437 	return NULL;
438 }
439 
uvc_stream_by_id(struct uvc_device * dev,int id)440 static struct uvc_streaming *uvc_stream_by_id(struct uvc_device *dev, int id)
441 {
442 	struct uvc_streaming *stream;
443 
444 	list_for_each_entry(stream, &dev->streams, list) {
445 		if (stream->header.bTerminalLink == id)
446 			return stream;
447 	}
448 
449 	return NULL;
450 }
451 
452 /* ------------------------------------------------------------------------
453  * Streaming Object Management
454  */
455 
uvc_stream_delete(struct uvc_streaming * stream)456 static void uvc_stream_delete(struct uvc_streaming *stream)
457 {
458 	if (stream->async_wq)
459 		destroy_workqueue(stream->async_wq);
460 
461 	mutex_destroy(&stream->mutex);
462 
463 	usb_put_intf(stream->intf);
464 
465 	kfree(stream->format);
466 	kfree(stream->header.bmaControls);
467 	kfree(stream);
468 }
469 
uvc_stream_new(struct uvc_device * dev,struct usb_interface * intf)470 static struct uvc_streaming *uvc_stream_new(struct uvc_device *dev,
471 					    struct usb_interface *intf)
472 {
473 	struct uvc_streaming *stream;
474 
475 	stream = kzalloc(sizeof(*stream), GFP_KERNEL);
476 	if (stream == NULL)
477 		return NULL;
478 
479 	mutex_init(&stream->mutex);
480 
481 	stream->dev = dev;
482 	stream->intf = usb_get_intf(intf);
483 	stream->intfnum = intf->cur_altsetting->desc.bInterfaceNumber;
484 
485 	/* Allocate a stream specific work queue for asynchronous tasks. */
486 	stream->async_wq = alloc_workqueue("uvcvideo", WQ_UNBOUND | WQ_HIGHPRI,
487 					   0);
488 	if (!stream->async_wq) {
489 		uvc_stream_delete(stream);
490 		return NULL;
491 	}
492 
493 	return stream;
494 }
495 
496 /* ------------------------------------------------------------------------
497  * Descriptors parsing
498  */
499 
uvc_parse_format(struct uvc_device * dev,struct uvc_streaming * streaming,struct uvc_format * format,u32 ** intervals,unsigned char * buffer,int buflen)500 static int uvc_parse_format(struct uvc_device *dev,
501 	struct uvc_streaming *streaming, struct uvc_format *format,
502 	u32 **intervals, unsigned char *buffer, int buflen)
503 {
504 	struct usb_interface *intf = streaming->intf;
505 	struct usb_host_interface *alts = intf->cur_altsetting;
506 	struct uvc_format_desc *fmtdesc;
507 	struct uvc_frame *frame;
508 	const unsigned char *start = buffer;
509 	unsigned int width_multiplier = 1;
510 	unsigned int interval;
511 	unsigned int i, n;
512 	u8 ftype;
513 
514 	format->type = buffer[2];
515 	format->index = buffer[3];
516 
517 	switch (buffer[2]) {
518 	case UVC_VS_FORMAT_UNCOMPRESSED:
519 	case UVC_VS_FORMAT_FRAME_BASED:
520 		n = buffer[2] == UVC_VS_FORMAT_UNCOMPRESSED ? 27 : 28;
521 		if (buflen < n) {
522 			uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
523 			       "interface %d FORMAT error\n",
524 			       dev->udev->devnum,
525 			       alts->desc.bInterfaceNumber);
526 			return -EINVAL;
527 		}
528 
529 		/* Find the format descriptor from its GUID. */
530 		fmtdesc = uvc_format_by_guid(&buffer[5]);
531 
532 		if (fmtdesc != NULL) {
533 			strscpy(format->name, fmtdesc->name,
534 				sizeof(format->name));
535 			format->fcc = fmtdesc->fcc;
536 		} else {
537 			uvc_printk(KERN_INFO, "Unknown video format %pUl\n",
538 				&buffer[5]);
539 			snprintf(format->name, sizeof(format->name), "%pUl\n",
540 				&buffer[5]);
541 			format->fcc = 0;
542 		}
543 
544 		format->bpp = buffer[21];
545 
546 		/* Some devices report a format that doesn't match what they
547 		 * really send.
548 		 */
549 		if (dev->quirks & UVC_QUIRK_FORCE_Y8) {
550 			if (format->fcc == V4L2_PIX_FMT_YUYV) {
551 				strscpy(format->name, "Greyscale 8-bit (Y8  )",
552 					sizeof(format->name));
553 				format->fcc = V4L2_PIX_FMT_GREY;
554 				format->bpp = 8;
555 				width_multiplier = 2;
556 			}
557 		}
558 
559 		/* Some devices report bpp that doesn't match the format. */
560 		if (dev->quirks & UVC_QUIRK_FORCE_BPP) {
561 			const struct v4l2_format_info *info =
562 				v4l2_format_info(format->fcc);
563 
564 			if (info) {
565 				unsigned int div = info->hdiv * info->vdiv;
566 
567 				n = info->bpp[0] * div;
568 				for (i = 1; i < info->comp_planes; i++)
569 					n += info->bpp[i];
570 
571 				format->bpp = DIV_ROUND_UP(8 * n, div);
572 			}
573 		}
574 
575 		if (buffer[2] == UVC_VS_FORMAT_UNCOMPRESSED) {
576 			ftype = UVC_VS_FRAME_UNCOMPRESSED;
577 		} else {
578 			ftype = UVC_VS_FRAME_FRAME_BASED;
579 			if (buffer[27])
580 				format->flags = UVC_FMT_FLAG_COMPRESSED;
581 		}
582 		break;
583 
584 	case UVC_VS_FORMAT_MJPEG:
585 		if (buflen < 11) {
586 			uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
587 			       "interface %d FORMAT error\n",
588 			       dev->udev->devnum,
589 			       alts->desc.bInterfaceNumber);
590 			return -EINVAL;
591 		}
592 
593 		strscpy(format->name, "MJPEG", sizeof(format->name));
594 		format->fcc = V4L2_PIX_FMT_MJPEG;
595 		format->flags = UVC_FMT_FLAG_COMPRESSED;
596 		format->bpp = 0;
597 		ftype = UVC_VS_FRAME_MJPEG;
598 		break;
599 
600 	case UVC_VS_FORMAT_DV:
601 		if (buflen < 9) {
602 			uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
603 			       "interface %d FORMAT error\n",
604 			       dev->udev->devnum,
605 			       alts->desc.bInterfaceNumber);
606 			return -EINVAL;
607 		}
608 
609 		switch (buffer[8] & 0x7f) {
610 		case 0:
611 			strscpy(format->name, "SD-DV", sizeof(format->name));
612 			break;
613 		case 1:
614 			strscpy(format->name, "SDL-DV", sizeof(format->name));
615 			break;
616 		case 2:
617 			strscpy(format->name, "HD-DV", sizeof(format->name));
618 			break;
619 		default:
620 			uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
621 			       "interface %d: unknown DV format %u\n",
622 			       dev->udev->devnum,
623 			       alts->desc.bInterfaceNumber, buffer[8]);
624 			return -EINVAL;
625 		}
626 
627 		strlcat(format->name, buffer[8] & (1 << 7) ? " 60Hz" : " 50Hz",
628 			sizeof(format->name));
629 
630 		format->fcc = V4L2_PIX_FMT_DV;
631 		format->flags = UVC_FMT_FLAG_COMPRESSED | UVC_FMT_FLAG_STREAM;
632 		format->bpp = 0;
633 		ftype = 0;
634 
635 		/* Create a dummy frame descriptor. */
636 		frame = &format->frame[0];
637 		memset(&format->frame[0], 0, sizeof(format->frame[0]));
638 		frame->bFrameIntervalType = 1;
639 		frame->dwDefaultFrameInterval = 1;
640 		frame->dwFrameInterval = *intervals;
641 		*(*intervals)++ = 1;
642 		format->nframes = 1;
643 		break;
644 
645 	case UVC_VS_FORMAT_MPEG2TS:
646 	case UVC_VS_FORMAT_STREAM_BASED:
647 		/* Not supported yet. */
648 	default:
649 		uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
650 		       "interface %d unsupported format %u\n",
651 		       dev->udev->devnum, alts->desc.bInterfaceNumber,
652 		       buffer[2]);
653 		return -EINVAL;
654 	}
655 
656 	uvc_trace(UVC_TRACE_DESCR, "Found format %s.\n", format->name);
657 
658 	buflen -= buffer[0];
659 	buffer += buffer[0];
660 
661 	/* Parse the frame descriptors. Only uncompressed, MJPEG and frame
662 	 * based formats have frame descriptors.
663 	 */
664 	while (buflen > 2 && buffer[1] == USB_DT_CS_INTERFACE &&
665 	       buffer[2] == ftype) {
666 		frame = &format->frame[format->nframes];
667 		if (ftype != UVC_VS_FRAME_FRAME_BASED)
668 			n = buflen > 25 ? buffer[25] : 0;
669 		else
670 			n = buflen > 21 ? buffer[21] : 0;
671 
672 		n = n ? n : 3;
673 
674 		if (buflen < 26 + 4*n) {
675 			uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
676 			       "interface %d FRAME error\n", dev->udev->devnum,
677 			       alts->desc.bInterfaceNumber);
678 			return -EINVAL;
679 		}
680 
681 		frame->bFrameIndex = buffer[3];
682 		frame->bmCapabilities = buffer[4];
683 		frame->wWidth = get_unaligned_le16(&buffer[5])
684 			      * width_multiplier;
685 		frame->wHeight = get_unaligned_le16(&buffer[7]);
686 		frame->dwMinBitRate = get_unaligned_le32(&buffer[9]);
687 		frame->dwMaxBitRate = get_unaligned_le32(&buffer[13]);
688 		if (ftype != UVC_VS_FRAME_FRAME_BASED) {
689 			frame->dwMaxVideoFrameBufferSize =
690 				get_unaligned_le32(&buffer[17]);
691 			frame->dwDefaultFrameInterval =
692 				get_unaligned_le32(&buffer[21]);
693 			frame->bFrameIntervalType = buffer[25];
694 		} else {
695 			frame->dwMaxVideoFrameBufferSize = 0;
696 			frame->dwDefaultFrameInterval =
697 				get_unaligned_le32(&buffer[17]);
698 			frame->bFrameIntervalType = buffer[21];
699 		}
700 		frame->dwFrameInterval = *intervals;
701 
702 		/* Several UVC chipsets screw up dwMaxVideoFrameBufferSize
703 		 * completely. Observed behaviours range from setting the
704 		 * value to 1.1x the actual frame size to hardwiring the
705 		 * 16 low bits to 0. This results in a higher than necessary
706 		 * memory usage as well as a wrong image size information. For
707 		 * uncompressed formats this can be fixed by computing the
708 		 * value from the frame size.
709 		 */
710 		if (!(format->flags & UVC_FMT_FLAG_COMPRESSED))
711 			frame->dwMaxVideoFrameBufferSize = format->bpp
712 				* frame->wWidth * frame->wHeight / 8;
713 
714 		/* Some bogus devices report dwMinFrameInterval equal to
715 		 * dwMaxFrameInterval and have dwFrameIntervalStep set to
716 		 * zero. Setting all null intervals to 1 fixes the problem and
717 		 * some other divisions by zero that could happen.
718 		 */
719 		for (i = 0; i < n; ++i) {
720 			interval = get_unaligned_le32(&buffer[26+4*i]);
721 			*(*intervals)++ = interval ? interval : 1;
722 		}
723 
724 		/* Make sure that the default frame interval stays between
725 		 * the boundaries.
726 		 */
727 		n -= frame->bFrameIntervalType ? 1 : 2;
728 		frame->dwDefaultFrameInterval =
729 			min(frame->dwFrameInterval[n],
730 			    max(frame->dwFrameInterval[0],
731 				frame->dwDefaultFrameInterval));
732 
733 		if (dev->quirks & UVC_QUIRK_RESTRICT_FRAME_RATE) {
734 			frame->bFrameIntervalType = 1;
735 			frame->dwFrameInterval[0] =
736 				frame->dwDefaultFrameInterval;
737 		}
738 
739 		uvc_trace(UVC_TRACE_DESCR, "- %ux%u (%u.%u fps)\n",
740 			frame->wWidth, frame->wHeight,
741 			10000000/frame->dwDefaultFrameInterval,
742 			(100000000/frame->dwDefaultFrameInterval)%10);
743 
744 		format->nframes++;
745 		buflen -= buffer[0];
746 		buffer += buffer[0];
747 	}
748 
749 	if (buflen > 2 && buffer[1] == USB_DT_CS_INTERFACE &&
750 	    buffer[2] == UVC_VS_STILL_IMAGE_FRAME) {
751 		buflen -= buffer[0];
752 		buffer += buffer[0];
753 	}
754 
755 	if (buflen > 2 && buffer[1] == USB_DT_CS_INTERFACE &&
756 	    buffer[2] == UVC_VS_COLORFORMAT) {
757 		if (buflen < 6) {
758 			uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
759 			       "interface %d COLORFORMAT error\n",
760 			       dev->udev->devnum,
761 			       alts->desc.bInterfaceNumber);
762 			return -EINVAL;
763 		}
764 
765 		format->colorspace = uvc_colorspace(buffer[3]);
766 		format->xfer_func = uvc_xfer_func(buffer[4]);
767 		format->ycbcr_enc = uvc_ycbcr_enc(buffer[5]);
768 
769 		buflen -= buffer[0];
770 		buffer += buffer[0];
771 	}
772 
773 	return buffer - start;
774 }
775 
uvc_parse_streaming(struct uvc_device * dev,struct usb_interface * intf)776 static int uvc_parse_streaming(struct uvc_device *dev,
777 	struct usb_interface *intf)
778 {
779 	struct uvc_streaming *streaming = NULL;
780 	struct uvc_format *format;
781 	struct uvc_frame *frame;
782 	struct usb_host_interface *alts = &intf->altsetting[0];
783 	unsigned char *_buffer, *buffer = alts->extra;
784 	int _buflen, buflen = alts->extralen;
785 	unsigned int nformats = 0, nframes = 0, nintervals = 0;
786 	unsigned int size, i, n, p;
787 	u32 *interval;
788 	u16 psize;
789 	int ret = -EINVAL;
790 
791 	if (intf->cur_altsetting->desc.bInterfaceSubClass
792 		!= UVC_SC_VIDEOSTREAMING) {
793 		uvc_trace(UVC_TRACE_DESCR, "device %d interface %d isn't a "
794 			"video streaming interface\n", dev->udev->devnum,
795 			intf->altsetting[0].desc.bInterfaceNumber);
796 		return -EINVAL;
797 	}
798 
799 	if (usb_driver_claim_interface(&uvc_driver.driver, intf, dev)) {
800 		uvc_trace(UVC_TRACE_DESCR, "device %d interface %d is already "
801 			"claimed\n", dev->udev->devnum,
802 			intf->altsetting[0].desc.bInterfaceNumber);
803 		return -EINVAL;
804 	}
805 
806 	streaming = uvc_stream_new(dev, intf);
807 	if (streaming == NULL) {
808 		usb_driver_release_interface(&uvc_driver.driver, intf);
809 		return -ENOMEM;
810 	}
811 
812 	/* The Pico iMage webcam has its class-specific interface descriptors
813 	 * after the endpoint descriptors.
814 	 */
815 	if (buflen == 0) {
816 		for (i = 0; i < alts->desc.bNumEndpoints; ++i) {
817 			struct usb_host_endpoint *ep = &alts->endpoint[i];
818 
819 			if (ep->extralen == 0)
820 				continue;
821 
822 			if (ep->extralen > 2 &&
823 			    ep->extra[1] == USB_DT_CS_INTERFACE) {
824 				uvc_trace(UVC_TRACE_DESCR, "trying extra data "
825 					"from endpoint %u.\n", i);
826 				buffer = alts->endpoint[i].extra;
827 				buflen = alts->endpoint[i].extralen;
828 				break;
829 			}
830 		}
831 	}
832 
833 	/* Skip the standard interface descriptors. */
834 	while (buflen > 2 && buffer[1] != USB_DT_CS_INTERFACE) {
835 		buflen -= buffer[0];
836 		buffer += buffer[0];
837 	}
838 
839 	if (buflen <= 2) {
840 		uvc_trace(UVC_TRACE_DESCR, "no class-specific streaming "
841 			"interface descriptors found.\n");
842 		goto error;
843 	}
844 
845 	/* Parse the header descriptor. */
846 	switch (buffer[2]) {
847 	case UVC_VS_OUTPUT_HEADER:
848 		streaming->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
849 		size = 9;
850 		break;
851 
852 	case UVC_VS_INPUT_HEADER:
853 		streaming->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
854 		size = 13;
855 		break;
856 
857 	default:
858 		uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming interface "
859 			"%d HEADER descriptor not found.\n", dev->udev->devnum,
860 			alts->desc.bInterfaceNumber);
861 		goto error;
862 	}
863 
864 	p = buflen >= 4 ? buffer[3] : 0;
865 	n = buflen >= size ? buffer[size-1] : 0;
866 
867 	if (buflen < size + p*n) {
868 		uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
869 			"interface %d HEADER descriptor is invalid.\n",
870 			dev->udev->devnum, alts->desc.bInterfaceNumber);
871 		goto error;
872 	}
873 
874 	streaming->header.bNumFormats = p;
875 	streaming->header.bEndpointAddress = buffer[6];
876 	if (buffer[2] == UVC_VS_INPUT_HEADER) {
877 		streaming->header.bmInfo = buffer[7];
878 		streaming->header.bTerminalLink = buffer[8];
879 		streaming->header.bStillCaptureMethod = buffer[9];
880 		streaming->header.bTriggerSupport = buffer[10];
881 		streaming->header.bTriggerUsage = buffer[11];
882 	} else {
883 		streaming->header.bTerminalLink = buffer[7];
884 	}
885 	streaming->header.bControlSize = n;
886 
887 	streaming->header.bmaControls = kmemdup(&buffer[size], p * n,
888 						GFP_KERNEL);
889 	if (streaming->header.bmaControls == NULL) {
890 		ret = -ENOMEM;
891 		goto error;
892 	}
893 
894 	buflen -= buffer[0];
895 	buffer += buffer[0];
896 
897 	_buffer = buffer;
898 	_buflen = buflen;
899 
900 	/* Count the format and frame descriptors. */
901 	while (_buflen > 2 && _buffer[1] == USB_DT_CS_INTERFACE) {
902 		switch (_buffer[2]) {
903 		case UVC_VS_FORMAT_UNCOMPRESSED:
904 		case UVC_VS_FORMAT_MJPEG:
905 		case UVC_VS_FORMAT_FRAME_BASED:
906 			nformats++;
907 			break;
908 
909 		case UVC_VS_FORMAT_DV:
910 			/* DV format has no frame descriptor. We will create a
911 			 * dummy frame descriptor with a dummy frame interval.
912 			 */
913 			nformats++;
914 			nframes++;
915 			nintervals++;
916 			break;
917 
918 		case UVC_VS_FORMAT_MPEG2TS:
919 		case UVC_VS_FORMAT_STREAM_BASED:
920 			uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
921 				"interface %d FORMAT %u is not supported.\n",
922 				dev->udev->devnum,
923 				alts->desc.bInterfaceNumber, _buffer[2]);
924 			break;
925 
926 		case UVC_VS_FRAME_UNCOMPRESSED:
927 		case UVC_VS_FRAME_MJPEG:
928 			nframes++;
929 			if (_buflen > 25)
930 				nintervals += _buffer[25] ? _buffer[25] : 3;
931 			break;
932 
933 		case UVC_VS_FRAME_FRAME_BASED:
934 			nframes++;
935 			if (_buflen > 21)
936 				nintervals += _buffer[21] ? _buffer[21] : 3;
937 			break;
938 		}
939 
940 		_buflen -= _buffer[0];
941 		_buffer += _buffer[0];
942 	}
943 
944 	if (nformats == 0) {
945 		uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming interface "
946 			"%d has no supported formats defined.\n",
947 			dev->udev->devnum, alts->desc.bInterfaceNumber);
948 		goto error;
949 	}
950 
951 	size = nformats * sizeof(*format) + nframes * sizeof(*frame)
952 	     + nintervals * sizeof(*interval);
953 	format = kzalloc(size, GFP_KERNEL);
954 	if (format == NULL) {
955 		ret = -ENOMEM;
956 		goto error;
957 	}
958 
959 	frame = (struct uvc_frame *)&format[nformats];
960 	interval = (u32 *)&frame[nframes];
961 
962 	streaming->format = format;
963 	streaming->nformats = nformats;
964 
965 	/* Parse the format descriptors. */
966 	while (buflen > 2 && buffer[1] == USB_DT_CS_INTERFACE) {
967 		switch (buffer[2]) {
968 		case UVC_VS_FORMAT_UNCOMPRESSED:
969 		case UVC_VS_FORMAT_MJPEG:
970 		case UVC_VS_FORMAT_DV:
971 		case UVC_VS_FORMAT_FRAME_BASED:
972 			format->frame = frame;
973 			ret = uvc_parse_format(dev, streaming, format,
974 				&interval, buffer, buflen);
975 			if (ret < 0)
976 				goto error;
977 
978 			frame += format->nframes;
979 			format++;
980 
981 			buflen -= ret;
982 			buffer += ret;
983 			continue;
984 
985 		default:
986 			break;
987 		}
988 
989 		buflen -= buffer[0];
990 		buffer += buffer[0];
991 	}
992 
993 	if (buflen)
994 		uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming interface "
995 			"%d has %u bytes of trailing descriptor garbage.\n",
996 			dev->udev->devnum, alts->desc.bInterfaceNumber, buflen);
997 
998 	/* Parse the alternate settings to find the maximum bandwidth. */
999 	for (i = 0; i < intf->num_altsetting; ++i) {
1000 		struct usb_host_endpoint *ep;
1001 		alts = &intf->altsetting[i];
1002 		ep = uvc_find_endpoint(alts,
1003 				streaming->header.bEndpointAddress);
1004 		if (ep == NULL)
1005 			continue;
1006 
1007 		psize = le16_to_cpu(ep->desc.wMaxPacketSize);
1008 		psize = (psize & 0x07ff) * (1 + ((psize >> 11) & 3));
1009 		if (psize > streaming->maxpsize)
1010 			streaming->maxpsize = psize;
1011 	}
1012 
1013 	list_add_tail(&streaming->list, &dev->streams);
1014 	return 0;
1015 
1016 error:
1017 	usb_driver_release_interface(&uvc_driver.driver, intf);
1018 	uvc_stream_delete(streaming);
1019 	return ret;
1020 }
1021 
uvc_alloc_entity(u16 type,u8 id,unsigned int num_pads,unsigned int extra_size)1022 static struct uvc_entity *uvc_alloc_entity(u16 type, u8 id,
1023 		unsigned int num_pads, unsigned int extra_size)
1024 {
1025 	struct uvc_entity *entity;
1026 	unsigned int num_inputs;
1027 	unsigned int size;
1028 	unsigned int i;
1029 
1030 	extra_size = roundup(extra_size, sizeof(*entity->pads));
1031 	if (num_pads)
1032 		num_inputs = type & UVC_TERM_OUTPUT ? num_pads : num_pads - 1;
1033 	else
1034 		num_inputs = 0;
1035 	size = sizeof(*entity) + extra_size + sizeof(*entity->pads) * num_pads
1036 	     + num_inputs;
1037 	entity = kzalloc(size, GFP_KERNEL);
1038 	if (entity == NULL)
1039 		return NULL;
1040 
1041 	entity->id = id;
1042 	entity->type = type;
1043 
1044 	entity->num_links = 0;
1045 	entity->num_pads = num_pads;
1046 	entity->pads = ((void *)(entity + 1)) + extra_size;
1047 
1048 	for (i = 0; i < num_inputs; ++i)
1049 		entity->pads[i].flags = MEDIA_PAD_FL_SINK;
1050 	if (!UVC_ENTITY_IS_OTERM(entity) && num_pads)
1051 		entity->pads[num_pads-1].flags = MEDIA_PAD_FL_SOURCE;
1052 
1053 	entity->bNrInPins = num_inputs;
1054 	entity->baSourceID = (u8 *)(&entity->pads[num_pads]);
1055 
1056 	return entity;
1057 }
1058 
1059 /* Parse vendor-specific extensions. */
uvc_parse_vendor_control(struct uvc_device * dev,const unsigned char * buffer,int buflen)1060 static int uvc_parse_vendor_control(struct uvc_device *dev,
1061 	const unsigned char *buffer, int buflen)
1062 {
1063 	struct usb_device *udev = dev->udev;
1064 	struct usb_host_interface *alts = dev->intf->cur_altsetting;
1065 	struct uvc_entity *unit;
1066 	unsigned int n, p;
1067 	int handled = 0;
1068 
1069 	switch (le16_to_cpu(dev->udev->descriptor.idVendor)) {
1070 	case 0x046d:		/* Logitech */
1071 		if (buffer[1] != 0x41 || buffer[2] != 0x01)
1072 			break;
1073 
1074 		/* Logitech implements several vendor specific functions
1075 		 * through vendor specific extension units (LXU).
1076 		 *
1077 		 * The LXU descriptors are similar to XU descriptors
1078 		 * (see "USB Device Video Class for Video Devices", section
1079 		 * 3.7.2.6 "Extension Unit Descriptor") with the following
1080 		 * differences:
1081 		 *
1082 		 * ----------------------------------------------------------
1083 		 * 0		bLength		1	 Number
1084 		 *	Size of this descriptor, in bytes: 24+p+n*2
1085 		 * ----------------------------------------------------------
1086 		 * 23+p+n	bmControlsType	N	Bitmap
1087 		 *	Individual bits in the set are defined:
1088 		 *	0: Absolute
1089 		 *	1: Relative
1090 		 *
1091 		 *	This bitset is mapped exactly the same as bmControls.
1092 		 * ----------------------------------------------------------
1093 		 * 23+p+n*2	bReserved	1	Boolean
1094 		 * ----------------------------------------------------------
1095 		 * 24+p+n*2	iExtension	1	Index
1096 		 *	Index of a string descriptor that describes this
1097 		 *	extension unit.
1098 		 * ----------------------------------------------------------
1099 		 */
1100 		p = buflen >= 22 ? buffer[21] : 0;
1101 		n = buflen >= 25 + p ? buffer[22+p] : 0;
1102 
1103 		if (buflen < 25 + p + 2*n) {
1104 			uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1105 				"interface %d EXTENSION_UNIT error\n",
1106 				udev->devnum, alts->desc.bInterfaceNumber);
1107 			break;
1108 		}
1109 
1110 		unit = uvc_alloc_entity(UVC_VC_EXTENSION_UNIT, buffer[3],
1111 					p + 1, 2*n);
1112 		if (unit == NULL)
1113 			return -ENOMEM;
1114 
1115 		memcpy(unit->extension.guidExtensionCode, &buffer[4], 16);
1116 		unit->extension.bNumControls = buffer[20];
1117 		memcpy(unit->baSourceID, &buffer[22], p);
1118 		unit->extension.bControlSize = buffer[22+p];
1119 		unit->extension.bmControls = (u8 *)unit + sizeof(*unit);
1120 		unit->extension.bmControlsType = (u8 *)unit + sizeof(*unit)
1121 					       + n;
1122 		memcpy(unit->extension.bmControls, &buffer[23+p], 2*n);
1123 
1124 		if (buffer[24+p+2*n] != 0)
1125 			usb_string(udev, buffer[24+p+2*n], unit->name,
1126 				   sizeof(unit->name));
1127 		else
1128 			sprintf(unit->name, "Extension %u", buffer[3]);
1129 
1130 		list_add_tail(&unit->list, &dev->entities);
1131 		handled = 1;
1132 		break;
1133 	}
1134 
1135 	return handled;
1136 }
1137 
uvc_parse_standard_control(struct uvc_device * dev,const unsigned char * buffer,int buflen)1138 static int uvc_parse_standard_control(struct uvc_device *dev,
1139 	const unsigned char *buffer, int buflen)
1140 {
1141 	struct usb_device *udev = dev->udev;
1142 	struct uvc_entity *unit, *term;
1143 	struct usb_interface *intf;
1144 	struct usb_host_interface *alts = dev->intf->cur_altsetting;
1145 	unsigned int i, n, p, len;
1146 	u16 type;
1147 
1148 	switch (buffer[2]) {
1149 	case UVC_VC_HEADER:
1150 		n = buflen >= 12 ? buffer[11] : 0;
1151 
1152 		if (buflen < 12 + n) {
1153 			uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1154 				"interface %d HEADER error\n", udev->devnum,
1155 				alts->desc.bInterfaceNumber);
1156 			return -EINVAL;
1157 		}
1158 
1159 		dev->uvc_version = get_unaligned_le16(&buffer[3]);
1160 		dev->clock_frequency = get_unaligned_le32(&buffer[7]);
1161 
1162 		/* Parse all USB Video Streaming interfaces. */
1163 		for (i = 0; i < n; ++i) {
1164 			intf = usb_ifnum_to_if(udev, buffer[12+i]);
1165 			if (intf == NULL) {
1166 				uvc_trace(UVC_TRACE_DESCR, "device %d "
1167 					"interface %d doesn't exists\n",
1168 					udev->devnum, i);
1169 				continue;
1170 			}
1171 
1172 			uvc_parse_streaming(dev, intf);
1173 		}
1174 		break;
1175 
1176 	case UVC_VC_INPUT_TERMINAL:
1177 		if (buflen < 8) {
1178 			uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1179 				"interface %d INPUT_TERMINAL error\n",
1180 				udev->devnum, alts->desc.bInterfaceNumber);
1181 			return -EINVAL;
1182 		}
1183 
1184 		/*
1185 		 * Reject invalid terminal types that would cause issues:
1186 		 *
1187 		 * - The high byte must be non-zero, otherwise it would be
1188 		 *   confused with a unit.
1189 		 *
1190 		 * - Bit 15 must be 0, as we use it internally as a terminal
1191 		 *   direction flag.
1192 		 *
1193 		 * Other unknown types are accepted.
1194 		 */
1195 		type = get_unaligned_le16(&buffer[4]);
1196 		if ((type & 0x7f00) == 0 || (type & 0x8000) != 0) {
1197 			uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1198 				"interface %d INPUT_TERMINAL %d has invalid "
1199 				"type 0x%04x, skipping\n", udev->devnum,
1200 				alts->desc.bInterfaceNumber,
1201 				buffer[3], type);
1202 			return 0;
1203 		}
1204 
1205 		n = 0;
1206 		p = 0;
1207 		len = 8;
1208 
1209 		if (type == UVC_ITT_CAMERA) {
1210 			n = buflen >= 15 ? buffer[14] : 0;
1211 			len = 15;
1212 
1213 		} else if (type == UVC_ITT_MEDIA_TRANSPORT_INPUT) {
1214 			n = buflen >= 9 ? buffer[8] : 0;
1215 			p = buflen >= 10 + n ? buffer[9+n] : 0;
1216 			len = 10;
1217 		}
1218 
1219 		if (buflen < len + n + p) {
1220 			uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1221 				"interface %d INPUT_TERMINAL error\n",
1222 				udev->devnum, alts->desc.bInterfaceNumber);
1223 			return -EINVAL;
1224 		}
1225 
1226 		term = uvc_alloc_entity(type | UVC_TERM_INPUT, buffer[3],
1227 					1, n + p);
1228 		if (term == NULL)
1229 			return -ENOMEM;
1230 
1231 		if (UVC_ENTITY_TYPE(term) == UVC_ITT_CAMERA) {
1232 			term->camera.bControlSize = n;
1233 			term->camera.bmControls = (u8 *)term + sizeof(*term);
1234 			term->camera.wObjectiveFocalLengthMin =
1235 				get_unaligned_le16(&buffer[8]);
1236 			term->camera.wObjectiveFocalLengthMax =
1237 				get_unaligned_le16(&buffer[10]);
1238 			term->camera.wOcularFocalLength =
1239 				get_unaligned_le16(&buffer[12]);
1240 			memcpy(term->camera.bmControls, &buffer[15], n);
1241 		} else if (UVC_ENTITY_TYPE(term) ==
1242 			   UVC_ITT_MEDIA_TRANSPORT_INPUT) {
1243 			term->media.bControlSize = n;
1244 			term->media.bmControls = (u8 *)term + sizeof(*term);
1245 			term->media.bTransportModeSize = p;
1246 			term->media.bmTransportModes = (u8 *)term
1247 						     + sizeof(*term) + n;
1248 			memcpy(term->media.bmControls, &buffer[9], n);
1249 			memcpy(term->media.bmTransportModes, &buffer[10+n], p);
1250 		}
1251 
1252 		if (buffer[7] != 0)
1253 			usb_string(udev, buffer[7], term->name,
1254 				   sizeof(term->name));
1255 		else if (UVC_ENTITY_TYPE(term) == UVC_ITT_CAMERA)
1256 			sprintf(term->name, "Camera %u", buffer[3]);
1257 		else if (UVC_ENTITY_TYPE(term) == UVC_ITT_MEDIA_TRANSPORT_INPUT)
1258 			sprintf(term->name, "Media %u", buffer[3]);
1259 		else
1260 			sprintf(term->name, "Input %u", buffer[3]);
1261 
1262 		list_add_tail(&term->list, &dev->entities);
1263 		break;
1264 
1265 	case UVC_VC_OUTPUT_TERMINAL:
1266 		if (buflen < 9) {
1267 			uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1268 				"interface %d OUTPUT_TERMINAL error\n",
1269 				udev->devnum, alts->desc.bInterfaceNumber);
1270 			return -EINVAL;
1271 		}
1272 
1273 		/* Make sure the terminal type MSB is not null, otherwise it
1274 		 * could be confused with a unit.
1275 		 */
1276 		type = get_unaligned_le16(&buffer[4]);
1277 		if ((type & 0xff00) == 0) {
1278 			uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1279 				"interface %d OUTPUT_TERMINAL %d has invalid "
1280 				"type 0x%04x, skipping\n", udev->devnum,
1281 				alts->desc.bInterfaceNumber, buffer[3], type);
1282 			return 0;
1283 		}
1284 
1285 		term = uvc_alloc_entity(type | UVC_TERM_OUTPUT, buffer[3],
1286 					1, 0);
1287 		if (term == NULL)
1288 			return -ENOMEM;
1289 
1290 		memcpy(term->baSourceID, &buffer[7], 1);
1291 
1292 		if (buffer[8] != 0)
1293 			usb_string(udev, buffer[8], term->name,
1294 				   sizeof(term->name));
1295 		else
1296 			sprintf(term->name, "Output %u", buffer[3]);
1297 
1298 		list_add_tail(&term->list, &dev->entities);
1299 		break;
1300 
1301 	case UVC_VC_SELECTOR_UNIT:
1302 		p = buflen >= 5 ? buffer[4] : 0;
1303 
1304 		if (buflen < 5 || buflen < 6 + p) {
1305 			uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1306 				"interface %d SELECTOR_UNIT error\n",
1307 				udev->devnum, alts->desc.bInterfaceNumber);
1308 			return -EINVAL;
1309 		}
1310 
1311 		unit = uvc_alloc_entity(buffer[2], buffer[3], p + 1, 0);
1312 		if (unit == NULL)
1313 			return -ENOMEM;
1314 
1315 		memcpy(unit->baSourceID, &buffer[5], p);
1316 
1317 		if (buffer[5+p] != 0)
1318 			usb_string(udev, buffer[5+p], unit->name,
1319 				   sizeof(unit->name));
1320 		else
1321 			sprintf(unit->name, "Selector %u", buffer[3]);
1322 
1323 		list_add_tail(&unit->list, &dev->entities);
1324 		break;
1325 
1326 	case UVC_VC_PROCESSING_UNIT:
1327 		n = buflen >= 8 ? buffer[7] : 0;
1328 		p = dev->uvc_version >= 0x0110 ? 10 : 9;
1329 
1330 		if (buflen < p + n) {
1331 			uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1332 				"interface %d PROCESSING_UNIT error\n",
1333 				udev->devnum, alts->desc.bInterfaceNumber);
1334 			return -EINVAL;
1335 		}
1336 
1337 		unit = uvc_alloc_entity(buffer[2], buffer[3], 2, n);
1338 		if (unit == NULL)
1339 			return -ENOMEM;
1340 
1341 		memcpy(unit->baSourceID, &buffer[4], 1);
1342 		unit->processing.wMaxMultiplier =
1343 			get_unaligned_le16(&buffer[5]);
1344 		unit->processing.bControlSize = buffer[7];
1345 		unit->processing.bmControls = (u8 *)unit + sizeof(*unit);
1346 		memcpy(unit->processing.bmControls, &buffer[8], n);
1347 		if (dev->uvc_version >= 0x0110)
1348 			unit->processing.bmVideoStandards = buffer[9+n];
1349 
1350 		if (buffer[8+n] != 0)
1351 			usb_string(udev, buffer[8+n], unit->name,
1352 				   sizeof(unit->name));
1353 		else
1354 			sprintf(unit->name, "Processing %u", buffer[3]);
1355 
1356 		list_add_tail(&unit->list, &dev->entities);
1357 		break;
1358 
1359 	case UVC_VC_EXTENSION_UNIT:
1360 		p = buflen >= 22 ? buffer[21] : 0;
1361 		n = buflen >= 24 + p ? buffer[22+p] : 0;
1362 
1363 		if (buflen < 24 + p + n) {
1364 			uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1365 				"interface %d EXTENSION_UNIT error\n",
1366 				udev->devnum, alts->desc.bInterfaceNumber);
1367 			return -EINVAL;
1368 		}
1369 
1370 		unit = uvc_alloc_entity(buffer[2], buffer[3], p + 1, n);
1371 		if (unit == NULL)
1372 			return -ENOMEM;
1373 
1374 		memcpy(unit->extension.guidExtensionCode, &buffer[4], 16);
1375 		unit->extension.bNumControls = buffer[20];
1376 		memcpy(unit->baSourceID, &buffer[22], p);
1377 		unit->extension.bControlSize = buffer[22+p];
1378 		unit->extension.bmControls = (u8 *)unit + sizeof(*unit);
1379 		memcpy(unit->extension.bmControls, &buffer[23+p], n);
1380 
1381 		if (buffer[23+p+n] != 0)
1382 			usb_string(udev, buffer[23+p+n], unit->name,
1383 				   sizeof(unit->name));
1384 		else
1385 			sprintf(unit->name, "Extension %u", buffer[3]);
1386 
1387 		list_add_tail(&unit->list, &dev->entities);
1388 		break;
1389 
1390 	default:
1391 		uvc_trace(UVC_TRACE_DESCR, "Found an unknown CS_INTERFACE "
1392 			"descriptor (%u)\n", buffer[2]);
1393 		break;
1394 	}
1395 
1396 	return 0;
1397 }
1398 
uvc_parse_control(struct uvc_device * dev)1399 static int uvc_parse_control(struct uvc_device *dev)
1400 {
1401 	struct usb_host_interface *alts = dev->intf->cur_altsetting;
1402 	unsigned char *buffer = alts->extra;
1403 	int buflen = alts->extralen;
1404 	int ret;
1405 
1406 	/* Parse the default alternate setting only, as the UVC specification
1407 	 * defines a single alternate setting, the default alternate setting
1408 	 * zero.
1409 	 */
1410 
1411 	while (buflen > 2) {
1412 		if (uvc_parse_vendor_control(dev, buffer, buflen) ||
1413 		    buffer[1] != USB_DT_CS_INTERFACE)
1414 			goto next_descriptor;
1415 
1416 		if ((ret = uvc_parse_standard_control(dev, buffer, buflen)) < 0)
1417 			return ret;
1418 
1419 next_descriptor:
1420 		buflen -= buffer[0];
1421 		buffer += buffer[0];
1422 	}
1423 
1424 	/* Check if the optional status endpoint is present. Built-in iSight
1425 	 * webcams have an interrupt endpoint but spit proprietary data that
1426 	 * don't conform to the UVC status endpoint messages. Don't try to
1427 	 * handle the interrupt endpoint for those cameras.
1428 	 */
1429 	if (alts->desc.bNumEndpoints == 1 &&
1430 	    !(dev->quirks & UVC_QUIRK_BUILTIN_ISIGHT)) {
1431 		struct usb_host_endpoint *ep = &alts->endpoint[0];
1432 		struct usb_endpoint_descriptor *desc = &ep->desc;
1433 
1434 		if (usb_endpoint_is_int_in(desc) &&
1435 		    le16_to_cpu(desc->wMaxPacketSize) >= 8 &&
1436 		    desc->bInterval != 0) {
1437 			uvc_trace(UVC_TRACE_DESCR, "Found a Status endpoint "
1438 				"(addr %02x).\n", desc->bEndpointAddress);
1439 			dev->int_ep = ep;
1440 		}
1441 	}
1442 
1443 	return 0;
1444 }
1445 
1446 /* ------------------------------------------------------------------------
1447  * UVC device scan
1448  */
1449 
1450 /*
1451  * Scan the UVC descriptors to locate a chain starting at an Output Terminal
1452  * and containing the following units:
1453  *
1454  * - one or more Output Terminals (USB Streaming or Display)
1455  * - zero or one Processing Unit
1456  * - zero, one or more single-input Selector Units
1457  * - zero or one multiple-input Selector Units, provided all inputs are
1458  *   connected to input terminals
1459  * - zero, one or mode single-input Extension Units
1460  * - one or more Input Terminals (Camera, External or USB Streaming)
1461  *
1462  * The terminal and units must match on of the following structures:
1463  *
1464  * ITT_*(0) -> +---------+    +---------+    +---------+ -> TT_STREAMING(0)
1465  * ...         | SU{0,1} | -> | PU{0,1} | -> | XU{0,n} |    ...
1466  * ITT_*(n) -> +---------+    +---------+    +---------+ -> TT_STREAMING(n)
1467  *
1468  *                 +---------+    +---------+ -> OTT_*(0)
1469  * TT_STREAMING -> | PU{0,1} | -> | XU{0,n} |    ...
1470  *                 +---------+    +---------+ -> OTT_*(n)
1471  *
1472  * The Processing Unit and Extension Units can be in any order. Additional
1473  * Extension Units connected to the main chain as single-unit branches are
1474  * also supported. Single-input Selector Units are ignored.
1475  */
uvc_scan_chain_entity(struct uvc_video_chain * chain,struct uvc_entity * entity)1476 static int uvc_scan_chain_entity(struct uvc_video_chain *chain,
1477 	struct uvc_entity *entity)
1478 {
1479 	switch (UVC_ENTITY_TYPE(entity)) {
1480 	case UVC_VC_EXTENSION_UNIT:
1481 		if (uvc_trace_param & UVC_TRACE_PROBE)
1482 			printk(KERN_CONT " <- XU %d", entity->id);
1483 
1484 		if (entity->bNrInPins != 1) {
1485 			uvc_trace(UVC_TRACE_DESCR, "Extension unit %d has more "
1486 				"than 1 input pin.\n", entity->id);
1487 			return -1;
1488 		}
1489 
1490 		break;
1491 
1492 	case UVC_VC_PROCESSING_UNIT:
1493 		if (uvc_trace_param & UVC_TRACE_PROBE)
1494 			printk(KERN_CONT " <- PU %d", entity->id);
1495 
1496 		if (chain->processing != NULL) {
1497 			uvc_trace(UVC_TRACE_DESCR, "Found multiple "
1498 				"Processing Units in chain.\n");
1499 			return -1;
1500 		}
1501 
1502 		chain->processing = entity;
1503 		break;
1504 
1505 	case UVC_VC_SELECTOR_UNIT:
1506 		if (uvc_trace_param & UVC_TRACE_PROBE)
1507 			printk(KERN_CONT " <- SU %d", entity->id);
1508 
1509 		/* Single-input selector units are ignored. */
1510 		if (entity->bNrInPins == 1)
1511 			break;
1512 
1513 		if (chain->selector != NULL) {
1514 			uvc_trace(UVC_TRACE_DESCR, "Found multiple Selector "
1515 				"Units in chain.\n");
1516 			return -1;
1517 		}
1518 
1519 		chain->selector = entity;
1520 		break;
1521 
1522 	case UVC_ITT_VENDOR_SPECIFIC:
1523 	case UVC_ITT_CAMERA:
1524 	case UVC_ITT_MEDIA_TRANSPORT_INPUT:
1525 		if (uvc_trace_param & UVC_TRACE_PROBE)
1526 			printk(KERN_CONT " <- IT %d\n", entity->id);
1527 
1528 		break;
1529 
1530 	case UVC_OTT_VENDOR_SPECIFIC:
1531 	case UVC_OTT_DISPLAY:
1532 	case UVC_OTT_MEDIA_TRANSPORT_OUTPUT:
1533 		if (uvc_trace_param & UVC_TRACE_PROBE)
1534 			printk(KERN_CONT " OT %d", entity->id);
1535 
1536 		break;
1537 
1538 	case UVC_TT_STREAMING:
1539 		if (UVC_ENTITY_IS_ITERM(entity)) {
1540 			if (uvc_trace_param & UVC_TRACE_PROBE)
1541 				printk(KERN_CONT " <- IT %d\n", entity->id);
1542 		} else {
1543 			if (uvc_trace_param & UVC_TRACE_PROBE)
1544 				printk(KERN_CONT " OT %d", entity->id);
1545 		}
1546 
1547 		break;
1548 
1549 	default:
1550 		uvc_trace(UVC_TRACE_DESCR, "Unsupported entity type "
1551 			"0x%04x found in chain.\n", UVC_ENTITY_TYPE(entity));
1552 		return -1;
1553 	}
1554 
1555 	list_add_tail(&entity->chain, &chain->entities);
1556 	return 0;
1557 }
1558 
uvc_scan_chain_forward(struct uvc_video_chain * chain,struct uvc_entity * entity,struct uvc_entity * prev)1559 static int uvc_scan_chain_forward(struct uvc_video_chain *chain,
1560 	struct uvc_entity *entity, struct uvc_entity *prev)
1561 {
1562 	struct uvc_entity *forward;
1563 	int found;
1564 
1565 	/* Forward scan */
1566 	forward = NULL;
1567 	found = 0;
1568 
1569 	while (1) {
1570 		forward = uvc_entity_by_reference(chain->dev, entity->id,
1571 			forward);
1572 		if (forward == NULL)
1573 			break;
1574 		if (forward == prev)
1575 			continue;
1576 		if (forward->chain.next || forward->chain.prev) {
1577 			uvc_trace(UVC_TRACE_DESCR, "Found reference to "
1578 				"entity %d already in chain.\n", forward->id);
1579 			return -EINVAL;
1580 		}
1581 
1582 		switch (UVC_ENTITY_TYPE(forward)) {
1583 		case UVC_VC_EXTENSION_UNIT:
1584 			if (forward->bNrInPins != 1) {
1585 				uvc_trace(UVC_TRACE_DESCR, "Extension unit %d "
1586 					  "has more than 1 input pin.\n",
1587 					  entity->id);
1588 				return -EINVAL;
1589 			}
1590 
1591 			/*
1592 			 * Some devices reference an output terminal as the
1593 			 * source of extension units. This is incorrect, as
1594 			 * output terminals only have an input pin, and thus
1595 			 * can't be connected to any entity in the forward
1596 			 * direction. The resulting topology would cause issues
1597 			 * when registering the media controller graph. To
1598 			 * avoid this problem, connect the extension unit to
1599 			 * the source of the output terminal instead.
1600 			 */
1601 			if (UVC_ENTITY_IS_OTERM(entity)) {
1602 				struct uvc_entity *source;
1603 
1604 				source = uvc_entity_by_id(chain->dev,
1605 							  entity->baSourceID[0]);
1606 				if (!source) {
1607 					uvc_trace(UVC_TRACE_DESCR,
1608 						"Can't connect extension unit %u in chain\n",
1609 						forward->id);
1610 					break;
1611 				}
1612 
1613 				forward->baSourceID[0] = source->id;
1614 			}
1615 
1616 			list_add_tail(&forward->chain, &chain->entities);
1617 			if (uvc_trace_param & UVC_TRACE_PROBE) {
1618 				if (!found)
1619 					printk(KERN_CONT " (->");
1620 
1621 				printk(KERN_CONT " XU %d", forward->id);
1622 				found = 1;
1623 			}
1624 			break;
1625 
1626 		case UVC_OTT_VENDOR_SPECIFIC:
1627 		case UVC_OTT_DISPLAY:
1628 		case UVC_OTT_MEDIA_TRANSPORT_OUTPUT:
1629 		case UVC_TT_STREAMING:
1630 			if (UVC_ENTITY_IS_ITERM(forward)) {
1631 				uvc_trace(UVC_TRACE_DESCR, "Unsupported input "
1632 					"terminal %u.\n", forward->id);
1633 				return -EINVAL;
1634 			}
1635 
1636 			if (UVC_ENTITY_IS_OTERM(entity)) {
1637 				uvc_trace(UVC_TRACE_DESCR,
1638 					"Unsupported connection between output terminals %u and %u\n",
1639 					entity->id, forward->id);
1640 				break;
1641 			}
1642 
1643 			list_add_tail(&forward->chain, &chain->entities);
1644 			if (uvc_trace_param & UVC_TRACE_PROBE) {
1645 				if (!found)
1646 					printk(KERN_CONT " (->");
1647 
1648 				printk(KERN_CONT " OT %d", forward->id);
1649 				found = 1;
1650 			}
1651 			break;
1652 		}
1653 	}
1654 	if (found)
1655 		printk(KERN_CONT ")");
1656 
1657 	return 0;
1658 }
1659 
uvc_scan_chain_backward(struct uvc_video_chain * chain,struct uvc_entity ** _entity)1660 static int uvc_scan_chain_backward(struct uvc_video_chain *chain,
1661 	struct uvc_entity **_entity)
1662 {
1663 	struct uvc_entity *entity = *_entity;
1664 	struct uvc_entity *term;
1665 	int id = -EINVAL, i;
1666 
1667 	switch (UVC_ENTITY_TYPE(entity)) {
1668 	case UVC_VC_EXTENSION_UNIT:
1669 	case UVC_VC_PROCESSING_UNIT:
1670 		id = entity->baSourceID[0];
1671 		break;
1672 
1673 	case UVC_VC_SELECTOR_UNIT:
1674 		/* Single-input selector units are ignored. */
1675 		if (entity->bNrInPins == 1) {
1676 			id = entity->baSourceID[0];
1677 			break;
1678 		}
1679 
1680 		if (uvc_trace_param & UVC_TRACE_PROBE)
1681 			printk(KERN_CONT " <- IT");
1682 
1683 		chain->selector = entity;
1684 		for (i = 0; i < entity->bNrInPins; ++i) {
1685 			id = entity->baSourceID[i];
1686 			term = uvc_entity_by_id(chain->dev, id);
1687 			if (term == NULL || !UVC_ENTITY_IS_ITERM(term)) {
1688 				uvc_trace(UVC_TRACE_DESCR, "Selector unit %d "
1689 					"input %d isn't connected to an "
1690 					"input terminal\n", entity->id, i);
1691 				return -1;
1692 			}
1693 
1694 			if (term->chain.next || term->chain.prev) {
1695 				uvc_trace(UVC_TRACE_DESCR, "Found reference to "
1696 					"entity %d already in chain.\n",
1697 					term->id);
1698 				return -EINVAL;
1699 			}
1700 
1701 			if (uvc_trace_param & UVC_TRACE_PROBE)
1702 				printk(KERN_CONT " %d", term->id);
1703 
1704 			list_add_tail(&term->chain, &chain->entities);
1705 			uvc_scan_chain_forward(chain, term, entity);
1706 		}
1707 
1708 		if (uvc_trace_param & UVC_TRACE_PROBE)
1709 			printk(KERN_CONT "\n");
1710 
1711 		id = 0;
1712 		break;
1713 
1714 	case UVC_ITT_VENDOR_SPECIFIC:
1715 	case UVC_ITT_CAMERA:
1716 	case UVC_ITT_MEDIA_TRANSPORT_INPUT:
1717 	case UVC_OTT_VENDOR_SPECIFIC:
1718 	case UVC_OTT_DISPLAY:
1719 	case UVC_OTT_MEDIA_TRANSPORT_OUTPUT:
1720 	case UVC_TT_STREAMING:
1721 		id = UVC_ENTITY_IS_OTERM(entity) ? entity->baSourceID[0] : 0;
1722 		break;
1723 	}
1724 
1725 	if (id <= 0) {
1726 		*_entity = NULL;
1727 		return id;
1728 	}
1729 
1730 	entity = uvc_entity_by_id(chain->dev, id);
1731 	if (entity == NULL) {
1732 		uvc_trace(UVC_TRACE_DESCR, "Found reference to "
1733 			"unknown entity %d.\n", id);
1734 		return -EINVAL;
1735 	}
1736 
1737 	*_entity = entity;
1738 	return 0;
1739 }
1740 
uvc_scan_chain(struct uvc_video_chain * chain,struct uvc_entity * term)1741 static int uvc_scan_chain(struct uvc_video_chain *chain,
1742 			  struct uvc_entity *term)
1743 {
1744 	struct uvc_entity *entity, *prev;
1745 
1746 	uvc_trace(UVC_TRACE_PROBE, "Scanning UVC chain:");
1747 
1748 	entity = term;
1749 	prev = NULL;
1750 
1751 	while (entity != NULL) {
1752 		/* Entity must not be part of an existing chain */
1753 		if (entity->chain.next || entity->chain.prev) {
1754 			uvc_trace(UVC_TRACE_DESCR, "Found reference to "
1755 				"entity %d already in chain.\n", entity->id);
1756 			return -EINVAL;
1757 		}
1758 
1759 		/* Process entity */
1760 		if (uvc_scan_chain_entity(chain, entity) < 0)
1761 			return -EINVAL;
1762 
1763 		/* Forward scan */
1764 		if (uvc_scan_chain_forward(chain, entity, prev) < 0)
1765 			return -EINVAL;
1766 
1767 		/* Backward scan */
1768 		prev = entity;
1769 		if (uvc_scan_chain_backward(chain, &entity) < 0)
1770 			return -EINVAL;
1771 	}
1772 
1773 	return 0;
1774 }
1775 
uvc_print_terms(struct list_head * terms,u16 dir,char * buffer)1776 static unsigned int uvc_print_terms(struct list_head *terms, u16 dir,
1777 		char *buffer)
1778 {
1779 	struct uvc_entity *term;
1780 	unsigned int nterms = 0;
1781 	char *p = buffer;
1782 
1783 	list_for_each_entry(term, terms, chain) {
1784 		if (!UVC_ENTITY_IS_TERM(term) ||
1785 		    UVC_TERM_DIRECTION(term) != dir)
1786 			continue;
1787 
1788 		if (nterms)
1789 			p += sprintf(p, ",");
1790 		if (++nterms >= 4) {
1791 			p += sprintf(p, "...");
1792 			break;
1793 		}
1794 		p += sprintf(p, "%u", term->id);
1795 	}
1796 
1797 	return p - buffer;
1798 }
1799 
uvc_print_chain(struct uvc_video_chain * chain)1800 static const char *uvc_print_chain(struct uvc_video_chain *chain)
1801 {
1802 	static char buffer[43];
1803 	char *p = buffer;
1804 
1805 	p += uvc_print_terms(&chain->entities, UVC_TERM_INPUT, p);
1806 	p += sprintf(p, " -> ");
1807 	uvc_print_terms(&chain->entities, UVC_TERM_OUTPUT, p);
1808 
1809 	return buffer;
1810 }
1811 
uvc_alloc_chain(struct uvc_device * dev)1812 static struct uvc_video_chain *uvc_alloc_chain(struct uvc_device *dev)
1813 {
1814 	struct uvc_video_chain *chain;
1815 
1816 	chain = kzalloc(sizeof(*chain), GFP_KERNEL);
1817 	if (chain == NULL)
1818 		return NULL;
1819 
1820 	INIT_LIST_HEAD(&chain->entities);
1821 	mutex_init(&chain->ctrl_mutex);
1822 	chain->dev = dev;
1823 	v4l2_prio_init(&chain->prio);
1824 
1825 	return chain;
1826 }
1827 
1828 /*
1829  * Fallback heuristic for devices that don't connect units and terminals in a
1830  * valid chain.
1831  *
1832  * Some devices have invalid baSourceID references, causing uvc_scan_chain()
1833  * to fail, but if we just take the entities we can find and put them together
1834  * in the most sensible chain we can think of, turns out they do work anyway.
1835  * Note: This heuristic assumes there is a single chain.
1836  *
1837  * At the time of writing, devices known to have such a broken chain are
1838  *  - Acer Integrated Camera (5986:055a)
1839  *  - Realtek rtl157a7 (0bda:57a7)
1840  */
uvc_scan_fallback(struct uvc_device * dev)1841 static int uvc_scan_fallback(struct uvc_device *dev)
1842 {
1843 	struct uvc_video_chain *chain;
1844 	struct uvc_entity *iterm = NULL;
1845 	struct uvc_entity *oterm = NULL;
1846 	struct uvc_entity *entity;
1847 	struct uvc_entity *prev;
1848 
1849 	/*
1850 	 * Start by locating the input and output terminals. We only support
1851 	 * devices with exactly one of each for now.
1852 	 */
1853 	list_for_each_entry(entity, &dev->entities, list) {
1854 		if (UVC_ENTITY_IS_ITERM(entity)) {
1855 			if (iterm)
1856 				return -EINVAL;
1857 			iterm = entity;
1858 		}
1859 
1860 		if (UVC_ENTITY_IS_OTERM(entity)) {
1861 			if (oterm)
1862 				return -EINVAL;
1863 			oterm = entity;
1864 		}
1865 	}
1866 
1867 	if (iterm == NULL || oterm == NULL)
1868 		return -EINVAL;
1869 
1870 	/* Allocate the chain and fill it. */
1871 	chain = uvc_alloc_chain(dev);
1872 	if (chain == NULL)
1873 		return -ENOMEM;
1874 
1875 	if (uvc_scan_chain_entity(chain, oterm) < 0)
1876 		goto error;
1877 
1878 	prev = oterm;
1879 
1880 	/*
1881 	 * Add all Processing and Extension Units with two pads. The order
1882 	 * doesn't matter much, use reverse list traversal to connect units in
1883 	 * UVC descriptor order as we build the chain from output to input. This
1884 	 * leads to units appearing in the order meant by the manufacturer for
1885 	 * the cameras known to require this heuristic.
1886 	 */
1887 	list_for_each_entry_reverse(entity, &dev->entities, list) {
1888 		if (entity->type != UVC_VC_PROCESSING_UNIT &&
1889 		    entity->type != UVC_VC_EXTENSION_UNIT)
1890 			continue;
1891 
1892 		if (entity->num_pads != 2)
1893 			continue;
1894 
1895 		if (uvc_scan_chain_entity(chain, entity) < 0)
1896 			goto error;
1897 
1898 		prev->baSourceID[0] = entity->id;
1899 		prev = entity;
1900 	}
1901 
1902 	if (uvc_scan_chain_entity(chain, iterm) < 0)
1903 		goto error;
1904 
1905 	prev->baSourceID[0] = iterm->id;
1906 
1907 	list_add_tail(&chain->list, &dev->chains);
1908 
1909 	uvc_trace(UVC_TRACE_PROBE,
1910 		  "Found a video chain by fallback heuristic (%s).\n",
1911 		  uvc_print_chain(chain));
1912 
1913 	return 0;
1914 
1915 error:
1916 	kfree(chain);
1917 	return -EINVAL;
1918 }
1919 
1920 /*
1921  * Scan the device for video chains and register video devices.
1922  *
1923  * Chains are scanned starting at their output terminals and walked backwards.
1924  */
uvc_scan_device(struct uvc_device * dev)1925 static int uvc_scan_device(struct uvc_device *dev)
1926 {
1927 	struct uvc_video_chain *chain;
1928 	struct uvc_entity *term;
1929 
1930 	list_for_each_entry(term, &dev->entities, list) {
1931 		if (!UVC_ENTITY_IS_OTERM(term))
1932 			continue;
1933 
1934 		/* If the terminal is already included in a chain, skip it.
1935 		 * This can happen for chains that have multiple output
1936 		 * terminals, where all output terminals beside the first one
1937 		 * will be inserted in the chain in forward scans.
1938 		 */
1939 		if (term->chain.next || term->chain.prev)
1940 			continue;
1941 
1942 		chain = uvc_alloc_chain(dev);
1943 		if (chain == NULL)
1944 			return -ENOMEM;
1945 
1946 		term->flags |= UVC_ENTITY_FLAG_DEFAULT;
1947 
1948 		if (uvc_scan_chain(chain, term) < 0) {
1949 			kfree(chain);
1950 			continue;
1951 		}
1952 
1953 		uvc_trace(UVC_TRACE_PROBE, "Found a valid video chain (%s).\n",
1954 			  uvc_print_chain(chain));
1955 
1956 		list_add_tail(&chain->list, &dev->chains);
1957 	}
1958 
1959 	if (list_empty(&dev->chains))
1960 		uvc_scan_fallback(dev);
1961 
1962 	if (list_empty(&dev->chains)) {
1963 		uvc_printk(KERN_INFO, "No valid video chain found.\n");
1964 		return -1;
1965 	}
1966 
1967 	return 0;
1968 }
1969 
1970 /* ------------------------------------------------------------------------
1971  * Video device registration and unregistration
1972  */
1973 
1974 /*
1975  * Delete the UVC device.
1976  *
1977  * Called by the kernel when the last reference to the uvc_device structure
1978  * is released.
1979  *
1980  * As this function is called after or during disconnect(), all URBs have
1981  * already been cancelled by the USB core. There is no need to kill the
1982  * interrupt URB manually.
1983  */
uvc_delete(struct kref * kref)1984 static void uvc_delete(struct kref *kref)
1985 {
1986 	struct uvc_device *dev = container_of(kref, struct uvc_device, ref);
1987 	struct list_head *p, *n;
1988 
1989 	uvc_status_cleanup(dev);
1990 	uvc_ctrl_cleanup_device(dev);
1991 
1992 	usb_put_intf(dev->intf);
1993 	usb_put_dev(dev->udev);
1994 
1995 #ifdef CONFIG_MEDIA_CONTROLLER
1996 	media_device_cleanup(&dev->mdev);
1997 #endif
1998 
1999 	list_for_each_safe(p, n, &dev->chains) {
2000 		struct uvc_video_chain *chain;
2001 		chain = list_entry(p, struct uvc_video_chain, list);
2002 		kfree(chain);
2003 	}
2004 
2005 	list_for_each_safe(p, n, &dev->entities) {
2006 		struct uvc_entity *entity;
2007 		entity = list_entry(p, struct uvc_entity, list);
2008 #ifdef CONFIG_MEDIA_CONTROLLER
2009 		uvc_mc_cleanup_entity(entity);
2010 #endif
2011 		kfree(entity);
2012 	}
2013 
2014 	list_for_each_safe(p, n, &dev->streams) {
2015 		struct uvc_streaming *streaming;
2016 		streaming = list_entry(p, struct uvc_streaming, list);
2017 		usb_driver_release_interface(&uvc_driver.driver,
2018 			streaming->intf);
2019 		uvc_stream_delete(streaming);
2020 	}
2021 
2022 	kfree(dev);
2023 }
2024 
uvc_release(struct video_device * vdev)2025 static void uvc_release(struct video_device *vdev)
2026 {
2027 	struct uvc_streaming *stream = video_get_drvdata(vdev);
2028 	struct uvc_device *dev = stream->dev;
2029 
2030 	kref_put(&dev->ref, uvc_delete);
2031 }
2032 
2033 /*
2034  * Unregister the video devices.
2035  */
uvc_unregister_video(struct uvc_device * dev)2036 static void uvc_unregister_video(struct uvc_device *dev)
2037 {
2038 	struct uvc_streaming *stream;
2039 
2040 	list_for_each_entry(stream, &dev->streams, list) {
2041 		if (!video_is_registered(&stream->vdev))
2042 			continue;
2043 
2044 		video_unregister_device(&stream->vdev);
2045 		video_unregister_device(&stream->meta.vdev);
2046 
2047 		uvc_debugfs_cleanup_stream(stream);
2048 	}
2049 
2050 	uvc_status_unregister(dev);
2051 
2052 	if (dev->vdev.dev)
2053 		v4l2_device_unregister(&dev->vdev);
2054 #ifdef CONFIG_MEDIA_CONTROLLER
2055 	if (media_devnode_is_registered(dev->mdev.devnode))
2056 		media_device_unregister(&dev->mdev);
2057 #endif
2058 }
2059 
uvc_register_video_device(struct uvc_device * dev,struct uvc_streaming * stream,struct video_device * vdev,struct uvc_video_queue * queue,enum v4l2_buf_type type,const struct v4l2_file_operations * fops,const struct v4l2_ioctl_ops * ioctl_ops)2060 int uvc_register_video_device(struct uvc_device *dev,
2061 			      struct uvc_streaming *stream,
2062 			      struct video_device *vdev,
2063 			      struct uvc_video_queue *queue,
2064 			      enum v4l2_buf_type type,
2065 			      const struct v4l2_file_operations *fops,
2066 			      const struct v4l2_ioctl_ops *ioctl_ops)
2067 {
2068 	int ret;
2069 
2070 	/* Initialize the video buffers queue. */
2071 	ret = uvc_queue_init(queue, type, !uvc_no_drop_param);
2072 	if (ret)
2073 		return ret;
2074 
2075 	/* Register the device with V4L. */
2076 
2077 	/*
2078 	 * We already hold a reference to dev->udev. The video device will be
2079 	 * unregistered before the reference is released, so we don't need to
2080 	 * get another one.
2081 	 */
2082 	vdev->v4l2_dev = &dev->vdev;
2083 	vdev->fops = fops;
2084 	vdev->ioctl_ops = ioctl_ops;
2085 	vdev->release = uvc_release;
2086 	vdev->prio = &stream->chain->prio;
2087 	if (type == V4L2_BUF_TYPE_VIDEO_OUTPUT)
2088 		vdev->vfl_dir = VFL_DIR_TX;
2089 	else
2090 		vdev->vfl_dir = VFL_DIR_RX;
2091 
2092 	switch (type) {
2093 	case V4L2_BUF_TYPE_VIDEO_CAPTURE:
2094 	default:
2095 		vdev->device_caps = V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_STREAMING;
2096 		break;
2097 	case V4L2_BUF_TYPE_VIDEO_OUTPUT:
2098 		vdev->device_caps = V4L2_CAP_VIDEO_OUTPUT | V4L2_CAP_STREAMING;
2099 		break;
2100 	case V4L2_BUF_TYPE_META_CAPTURE:
2101 		vdev->device_caps = V4L2_CAP_META_CAPTURE | V4L2_CAP_STREAMING;
2102 		break;
2103 	}
2104 
2105 	strscpy(vdev->name, dev->name, sizeof(vdev->name));
2106 
2107 	/*
2108 	 * Set the driver data before calling video_register_device, otherwise
2109 	 * the file open() handler might race us.
2110 	 */
2111 	video_set_drvdata(vdev, stream);
2112 
2113 	ret = video_register_device(vdev, VFL_TYPE_VIDEO, -1);
2114 	if (ret < 0) {
2115 		uvc_printk(KERN_ERR, "Failed to register %s device (%d).\n",
2116 			   v4l2_type_names[type], ret);
2117 		return ret;
2118 	}
2119 
2120 	kref_get(&dev->ref);
2121 	return 0;
2122 }
2123 
uvc_register_video(struct uvc_device * dev,struct uvc_streaming * stream)2124 static int uvc_register_video(struct uvc_device *dev,
2125 		struct uvc_streaming *stream)
2126 {
2127 	int ret;
2128 
2129 	/* Initialize the streaming interface with default parameters. */
2130 	ret = uvc_video_init(stream);
2131 	if (ret < 0) {
2132 		uvc_printk(KERN_ERR, "Failed to initialize the device (%d).\n",
2133 			   ret);
2134 		return ret;
2135 	}
2136 
2137 	if (stream->type == V4L2_BUF_TYPE_VIDEO_CAPTURE)
2138 		stream->chain->caps |= V4L2_CAP_VIDEO_CAPTURE
2139 			| V4L2_CAP_META_CAPTURE;
2140 	else
2141 		stream->chain->caps |= V4L2_CAP_VIDEO_OUTPUT;
2142 
2143 	uvc_debugfs_init_stream(stream);
2144 
2145 	/* Register the device with V4L. */
2146 	return uvc_register_video_device(dev, stream, &stream->vdev,
2147 					 &stream->queue, stream->type,
2148 					 &uvc_fops, &uvc_ioctl_ops);
2149 }
2150 
2151 /*
2152  * Register all video devices in all chains.
2153  */
uvc_register_terms(struct uvc_device * dev,struct uvc_video_chain * chain)2154 static int uvc_register_terms(struct uvc_device *dev,
2155 	struct uvc_video_chain *chain)
2156 {
2157 	struct uvc_streaming *stream;
2158 	struct uvc_entity *term;
2159 	int ret;
2160 
2161 	list_for_each_entry(term, &chain->entities, chain) {
2162 		if (UVC_ENTITY_TYPE(term) != UVC_TT_STREAMING)
2163 			continue;
2164 
2165 		stream = uvc_stream_by_id(dev, term->id);
2166 		if (stream == NULL) {
2167 			uvc_printk(KERN_INFO, "No streaming interface found "
2168 				   "for terminal %u.", term->id);
2169 			continue;
2170 		}
2171 
2172 		stream->chain = chain;
2173 		ret = uvc_register_video(dev, stream);
2174 		if (ret < 0)
2175 			return ret;
2176 
2177 		/* Register a metadata node, but ignore a possible failure,
2178 		 * complete registration of video nodes anyway.
2179 		 */
2180 		uvc_meta_register(stream);
2181 
2182 		term->vdev = &stream->vdev;
2183 	}
2184 
2185 	return 0;
2186 }
2187 
uvc_register_chains(struct uvc_device * dev)2188 static int uvc_register_chains(struct uvc_device *dev)
2189 {
2190 	struct uvc_video_chain *chain;
2191 	int ret;
2192 
2193 	list_for_each_entry(chain, &dev->chains, list) {
2194 		ret = uvc_register_terms(dev, chain);
2195 		if (ret < 0)
2196 			return ret;
2197 
2198 #ifdef CONFIG_MEDIA_CONTROLLER
2199 		ret = uvc_mc_register_entities(chain);
2200 		if (ret < 0)
2201 			uvc_printk(KERN_INFO,
2202 				   "Failed to register entities (%d).\n", ret);
2203 #endif
2204 	}
2205 
2206 	return 0;
2207 }
2208 
2209 /* ------------------------------------------------------------------------
2210  * USB probe, disconnect, suspend and resume
2211  */
2212 
2213 static const struct uvc_device_info uvc_quirk_none = { 0 };
2214 
uvc_probe(struct usb_interface * intf,const struct usb_device_id * id)2215 static int uvc_probe(struct usb_interface *intf,
2216 		     const struct usb_device_id *id)
2217 {
2218 	struct usb_device *udev = interface_to_usbdev(intf);
2219 	struct uvc_device *dev;
2220 	const struct uvc_device_info *info =
2221 		(const struct uvc_device_info *)id->driver_info;
2222 	int function;
2223 	int ret;
2224 
2225 	if (id->idVendor && id->idProduct)
2226 		uvc_trace(UVC_TRACE_PROBE, "Probing known UVC device %s "
2227 				"(%04x:%04x)\n", udev->devpath, id->idVendor,
2228 				id->idProduct);
2229 	else
2230 		uvc_trace(UVC_TRACE_PROBE, "Probing generic UVC device %s\n",
2231 				udev->devpath);
2232 
2233 	/* Allocate memory for the device and initialize it. */
2234 	dev = kzalloc(sizeof(*dev), GFP_KERNEL);
2235 	if (dev == NULL)
2236 		return -ENOMEM;
2237 
2238 	INIT_LIST_HEAD(&dev->entities);
2239 	INIT_LIST_HEAD(&dev->chains);
2240 	INIT_LIST_HEAD(&dev->streams);
2241 	kref_init(&dev->ref);
2242 	atomic_set(&dev->nmappings, 0);
2243 	mutex_init(&dev->lock);
2244 
2245 	dev->udev = usb_get_dev(udev);
2246 	dev->intf = usb_get_intf(intf);
2247 	dev->intfnum = intf->cur_altsetting->desc.bInterfaceNumber;
2248 	dev->info = info ? info : &uvc_quirk_none;
2249 	dev->quirks = uvc_quirks_param == -1
2250 		    ? dev->info->quirks : uvc_quirks_param;
2251 
2252 	if (udev->product != NULL)
2253 		strscpy(dev->name, udev->product, sizeof(dev->name));
2254 	else
2255 		snprintf(dev->name, sizeof(dev->name),
2256 			 "UVC Camera (%04x:%04x)",
2257 			 le16_to_cpu(udev->descriptor.idVendor),
2258 			 le16_to_cpu(udev->descriptor.idProduct));
2259 
2260 	/*
2261 	 * Add iFunction or iInterface to names when available as additional
2262 	 * distinguishers between interfaces. iFunction is prioritized over
2263 	 * iInterface which matches Windows behavior at the point of writing.
2264 	 */
2265 	if (intf->intf_assoc && intf->intf_assoc->iFunction != 0)
2266 		function = intf->intf_assoc->iFunction;
2267 	else
2268 		function = intf->cur_altsetting->desc.iInterface;
2269 	if (function != 0) {
2270 		size_t len;
2271 
2272 		strlcat(dev->name, ": ", sizeof(dev->name));
2273 		len = strlen(dev->name);
2274 		usb_string(udev, function, dev->name + len,
2275 			   sizeof(dev->name) - len);
2276 	}
2277 
2278 	/* Initialize the media device. */
2279 #ifdef CONFIG_MEDIA_CONTROLLER
2280 	dev->mdev.dev = &intf->dev;
2281 	strscpy(dev->mdev.model, dev->name, sizeof(dev->mdev.model));
2282 	if (udev->serial)
2283 		strscpy(dev->mdev.serial, udev->serial,
2284 			sizeof(dev->mdev.serial));
2285 	usb_make_path(udev, dev->mdev.bus_info, sizeof(dev->mdev.bus_info));
2286 	dev->mdev.hw_revision = le16_to_cpu(udev->descriptor.bcdDevice);
2287 	media_device_init(&dev->mdev);
2288 
2289 	dev->vdev.mdev = &dev->mdev;
2290 #endif
2291 
2292 	/* Parse the Video Class control descriptor. */
2293 	if (uvc_parse_control(dev) < 0) {
2294 		uvc_trace(UVC_TRACE_PROBE, "Unable to parse UVC "
2295 			"descriptors.\n");
2296 		goto error;
2297 	}
2298 
2299 	uvc_printk(KERN_INFO, "Found UVC %u.%02x device %s (%04x:%04x)\n",
2300 		dev->uvc_version >> 8, dev->uvc_version & 0xff,
2301 		udev->product ? udev->product : "<unnamed>",
2302 		le16_to_cpu(udev->descriptor.idVendor),
2303 		le16_to_cpu(udev->descriptor.idProduct));
2304 
2305 	if (dev->quirks != dev->info->quirks) {
2306 		uvc_printk(KERN_INFO, "Forcing device quirks to 0x%x by module "
2307 			"parameter for testing purpose.\n", dev->quirks);
2308 		uvc_printk(KERN_INFO, "Please report required quirks to the "
2309 			"linux-uvc-devel mailing list.\n");
2310 	}
2311 
2312 	/* Register the V4L2 device. */
2313 	if (v4l2_device_register(&intf->dev, &dev->vdev) < 0)
2314 		goto error;
2315 
2316 	/* Initialize controls. */
2317 	if (uvc_ctrl_init_device(dev) < 0)
2318 		goto error;
2319 
2320 	/* Scan the device for video chains. */
2321 	if (uvc_scan_device(dev) < 0)
2322 		goto error;
2323 
2324 	/* Register video device nodes. */
2325 	if (uvc_register_chains(dev) < 0)
2326 		goto error;
2327 
2328 #ifdef CONFIG_MEDIA_CONTROLLER
2329 	/* Register the media device node */
2330 	if (media_device_register(&dev->mdev) < 0)
2331 		goto error;
2332 #endif
2333 	/* Save our data pointer in the interface data. */
2334 	usb_set_intfdata(intf, dev);
2335 
2336 	/* Initialize the interrupt URB. */
2337 	if ((ret = uvc_status_init(dev)) < 0) {
2338 		uvc_printk(KERN_INFO, "Unable to initialize the status "
2339 			"endpoint (%d), status interrupt will not be "
2340 			"supported.\n", ret);
2341 	}
2342 
2343 	uvc_trace(UVC_TRACE_PROBE, "UVC device initialized.\n");
2344 	usb_enable_autosuspend(udev);
2345 	return 0;
2346 
2347 error:
2348 	uvc_unregister_video(dev);
2349 	kref_put(&dev->ref, uvc_delete);
2350 	return -ENODEV;
2351 }
2352 
uvc_disconnect(struct usb_interface * intf)2353 static void uvc_disconnect(struct usb_interface *intf)
2354 {
2355 	struct uvc_device *dev = usb_get_intfdata(intf);
2356 
2357 	/* Set the USB interface data to NULL. This can be done outside the
2358 	 * lock, as there's no other reader.
2359 	 */
2360 	usb_set_intfdata(intf, NULL);
2361 
2362 	if (intf->cur_altsetting->desc.bInterfaceSubClass ==
2363 	    UVC_SC_VIDEOSTREAMING)
2364 		return;
2365 
2366 	uvc_unregister_video(dev);
2367 	kref_put(&dev->ref, uvc_delete);
2368 }
2369 
uvc_suspend(struct usb_interface * intf,pm_message_t message)2370 static int uvc_suspend(struct usb_interface *intf, pm_message_t message)
2371 {
2372 	struct uvc_device *dev = usb_get_intfdata(intf);
2373 	struct uvc_streaming *stream;
2374 
2375 	uvc_trace(UVC_TRACE_SUSPEND, "Suspending interface %u\n",
2376 		intf->cur_altsetting->desc.bInterfaceNumber);
2377 
2378 	/* Controls are cached on the fly so they don't need to be saved. */
2379 	if (intf->cur_altsetting->desc.bInterfaceSubClass ==
2380 	    UVC_SC_VIDEOCONTROL) {
2381 		mutex_lock(&dev->lock);
2382 		if (dev->users)
2383 			uvc_status_stop(dev);
2384 		mutex_unlock(&dev->lock);
2385 		return 0;
2386 	}
2387 
2388 	list_for_each_entry(stream, &dev->streams, list) {
2389 		if (stream->intf == intf)
2390 			return uvc_video_suspend(stream);
2391 	}
2392 
2393 	uvc_trace(UVC_TRACE_SUSPEND, "Suspend: video streaming USB interface "
2394 			"mismatch.\n");
2395 	return -EINVAL;
2396 }
2397 
__uvc_resume(struct usb_interface * intf,int reset)2398 static int __uvc_resume(struct usb_interface *intf, int reset)
2399 {
2400 	struct uvc_device *dev = usb_get_intfdata(intf);
2401 	struct uvc_streaming *stream;
2402 	int ret = 0;
2403 
2404 	uvc_trace(UVC_TRACE_SUSPEND, "Resuming interface %u\n",
2405 		intf->cur_altsetting->desc.bInterfaceNumber);
2406 
2407 	if (intf->cur_altsetting->desc.bInterfaceSubClass ==
2408 	    UVC_SC_VIDEOCONTROL) {
2409 		if (reset) {
2410 			ret = uvc_ctrl_restore_values(dev);
2411 			if (ret < 0)
2412 				return ret;
2413 		}
2414 
2415 		mutex_lock(&dev->lock);
2416 		if (dev->users)
2417 			ret = uvc_status_start(dev, GFP_NOIO);
2418 		mutex_unlock(&dev->lock);
2419 
2420 		return ret;
2421 	}
2422 
2423 	list_for_each_entry(stream, &dev->streams, list) {
2424 		if (stream->intf == intf) {
2425 			ret = uvc_video_resume(stream, reset);
2426 			if (ret < 0)
2427 				uvc_queue_streamoff(&stream->queue,
2428 						    stream->queue.queue.type);
2429 			return ret;
2430 		}
2431 	}
2432 
2433 	uvc_trace(UVC_TRACE_SUSPEND, "Resume: video streaming USB interface "
2434 			"mismatch.\n");
2435 	return -EINVAL;
2436 }
2437 
uvc_resume(struct usb_interface * intf)2438 static int uvc_resume(struct usb_interface *intf)
2439 {
2440 	return __uvc_resume(intf, 0);
2441 }
2442 
uvc_reset_resume(struct usb_interface * intf)2443 static int uvc_reset_resume(struct usb_interface *intf)
2444 {
2445 	return __uvc_resume(intf, 1);
2446 }
2447 
2448 /* ------------------------------------------------------------------------
2449  * Module parameters
2450  */
2451 
uvc_clock_param_get(char * buffer,const struct kernel_param * kp)2452 static int uvc_clock_param_get(char *buffer, const struct kernel_param *kp)
2453 {
2454 	if (uvc_clock_param == CLOCK_MONOTONIC)
2455 		return sprintf(buffer, "CLOCK_MONOTONIC");
2456 	else
2457 		return sprintf(buffer, "CLOCK_REALTIME");
2458 }
2459 
uvc_clock_param_set(const char * val,const struct kernel_param * kp)2460 static int uvc_clock_param_set(const char *val, const struct kernel_param *kp)
2461 {
2462 	if (strncasecmp(val, "clock_", strlen("clock_")) == 0)
2463 		val += strlen("clock_");
2464 
2465 	if (strcasecmp(val, "monotonic") == 0)
2466 		uvc_clock_param = CLOCK_MONOTONIC;
2467 	else if (strcasecmp(val, "realtime") == 0)
2468 		uvc_clock_param = CLOCK_REALTIME;
2469 	else
2470 		return -EINVAL;
2471 
2472 	return 0;
2473 }
2474 
2475 module_param_call(clock, uvc_clock_param_set, uvc_clock_param_get,
2476 		  &uvc_clock_param, S_IRUGO|S_IWUSR);
2477 MODULE_PARM_DESC(clock, "Video buffers timestamp clock");
2478 module_param_named(hwtimestamps, uvc_hw_timestamps_param, uint, S_IRUGO|S_IWUSR);
2479 MODULE_PARM_DESC(hwtimestamps, "Use hardware timestamps");
2480 module_param_named(nodrop, uvc_no_drop_param, uint, S_IRUGO|S_IWUSR);
2481 MODULE_PARM_DESC(nodrop, "Don't drop incomplete frames");
2482 module_param_named(quirks, uvc_quirks_param, uint, S_IRUGO|S_IWUSR);
2483 MODULE_PARM_DESC(quirks, "Forced device quirks");
2484 module_param_named(trace, uvc_trace_param, uint, S_IRUGO|S_IWUSR);
2485 MODULE_PARM_DESC(trace, "Trace level bitmask");
2486 module_param_named(timeout, uvc_timeout_param, uint, S_IRUGO|S_IWUSR);
2487 MODULE_PARM_DESC(timeout, "Streaming control requests timeout");
2488 
2489 /* ------------------------------------------------------------------------
2490  * Driver initialization and cleanup
2491  */
2492 
2493 static const struct uvc_device_info uvc_quirk_probe_minmax = {
2494 	.quirks = UVC_QUIRK_PROBE_MINMAX,
2495 };
2496 
2497 static const struct uvc_device_info uvc_quirk_fix_bandwidth = {
2498 	.quirks = UVC_QUIRK_FIX_BANDWIDTH,
2499 };
2500 
2501 static const struct uvc_device_info uvc_quirk_probe_def = {
2502 	.quirks = UVC_QUIRK_PROBE_DEF,
2503 };
2504 
2505 static const struct uvc_device_info uvc_quirk_stream_no_fid = {
2506 	.quirks = UVC_QUIRK_STREAM_NO_FID,
2507 };
2508 
2509 static const struct uvc_device_info uvc_quirk_force_y8 = {
2510 	.quirks = UVC_QUIRK_FORCE_Y8,
2511 };
2512 
2513 #define UVC_INFO_QUIRK(q) (kernel_ulong_t)&(struct uvc_device_info){.quirks = q}
2514 #define UVC_INFO_META(m) (kernel_ulong_t)&(struct uvc_device_info) \
2515 	{.meta_format = m}
2516 
2517 /*
2518  * The Logitech cameras listed below have their interface class set to
2519  * VENDOR_SPEC because they don't announce themselves as UVC devices, even
2520  * though they are compliant.
2521  */
2522 static const struct usb_device_id uvc_ids[] = {
2523 	/* LogiLink Wireless Webcam */
2524 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2525 				| USB_DEVICE_ID_MATCH_INT_INFO,
2526 	  .idVendor		= 0x0416,
2527 	  .idProduct		= 0xa91a,
2528 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2529 	  .bInterfaceSubClass	= 1,
2530 	  .bInterfaceProtocol	= 0,
2531 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2532 	/* Genius eFace 2025 */
2533 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2534 				| USB_DEVICE_ID_MATCH_INT_INFO,
2535 	  .idVendor		= 0x0458,
2536 	  .idProduct		= 0x706e,
2537 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2538 	  .bInterfaceSubClass	= 1,
2539 	  .bInterfaceProtocol	= 0,
2540 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2541 	/* Microsoft Lifecam NX-6000 */
2542 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2543 				| USB_DEVICE_ID_MATCH_INT_INFO,
2544 	  .idVendor		= 0x045e,
2545 	  .idProduct		= 0x00f8,
2546 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2547 	  .bInterfaceSubClass	= 1,
2548 	  .bInterfaceProtocol	= 0,
2549 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2550 	/* Microsoft Lifecam NX-3000 */
2551 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2552 				| USB_DEVICE_ID_MATCH_INT_INFO,
2553 	  .idVendor		= 0x045e,
2554 	  .idProduct		= 0x0721,
2555 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2556 	  .bInterfaceSubClass	= 1,
2557 	  .bInterfaceProtocol	= 0,
2558 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_def },
2559 	/* Microsoft Lifecam VX-7000 */
2560 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2561 				| USB_DEVICE_ID_MATCH_INT_INFO,
2562 	  .idVendor		= 0x045e,
2563 	  .idProduct		= 0x0723,
2564 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2565 	  .bInterfaceSubClass	= 1,
2566 	  .bInterfaceProtocol	= 0,
2567 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2568 	/* Logitech Quickcam Fusion */
2569 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2570 				| USB_DEVICE_ID_MATCH_INT_INFO,
2571 	  .idVendor		= 0x046d,
2572 	  .idProduct		= 0x08c1,
2573 	  .bInterfaceClass	= USB_CLASS_VENDOR_SPEC,
2574 	  .bInterfaceSubClass	= 1,
2575 	  .bInterfaceProtocol	= 0 },
2576 	/* Logitech Quickcam Orbit MP */
2577 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2578 				| USB_DEVICE_ID_MATCH_INT_INFO,
2579 	  .idVendor		= 0x046d,
2580 	  .idProduct		= 0x08c2,
2581 	  .bInterfaceClass	= USB_CLASS_VENDOR_SPEC,
2582 	  .bInterfaceSubClass	= 1,
2583 	  .bInterfaceProtocol	= 0 },
2584 	/* Logitech Quickcam Pro for Notebook */
2585 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2586 				| USB_DEVICE_ID_MATCH_INT_INFO,
2587 	  .idVendor		= 0x046d,
2588 	  .idProduct		= 0x08c3,
2589 	  .bInterfaceClass	= USB_CLASS_VENDOR_SPEC,
2590 	  .bInterfaceSubClass	= 1,
2591 	  .bInterfaceProtocol	= 0 },
2592 	/* Logitech Quickcam Pro 5000 */
2593 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2594 				| USB_DEVICE_ID_MATCH_INT_INFO,
2595 	  .idVendor		= 0x046d,
2596 	  .idProduct		= 0x08c5,
2597 	  .bInterfaceClass	= USB_CLASS_VENDOR_SPEC,
2598 	  .bInterfaceSubClass	= 1,
2599 	  .bInterfaceProtocol	= 0 },
2600 	/* Logitech Quickcam OEM Dell Notebook */
2601 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2602 				| USB_DEVICE_ID_MATCH_INT_INFO,
2603 	  .idVendor		= 0x046d,
2604 	  .idProduct		= 0x08c6,
2605 	  .bInterfaceClass	= USB_CLASS_VENDOR_SPEC,
2606 	  .bInterfaceSubClass	= 1,
2607 	  .bInterfaceProtocol	= 0 },
2608 	/* Logitech Quickcam OEM Cisco VT Camera II */
2609 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2610 				| USB_DEVICE_ID_MATCH_INT_INFO,
2611 	  .idVendor		= 0x046d,
2612 	  .idProduct		= 0x08c7,
2613 	  .bInterfaceClass	= USB_CLASS_VENDOR_SPEC,
2614 	  .bInterfaceSubClass	= 1,
2615 	  .bInterfaceProtocol	= 0 },
2616 	/* Logitech HD Pro Webcam C920 */
2617 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2618 				| USB_DEVICE_ID_MATCH_INT_INFO,
2619 	  .idVendor		= 0x046d,
2620 	  .idProduct		= 0x082d,
2621 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2622 	  .bInterfaceSubClass	= 1,
2623 	  .bInterfaceProtocol	= 0,
2624 	  .driver_info		= UVC_INFO_QUIRK(UVC_QUIRK_RESTORE_CTRLS_ON_INIT) },
2625 	/* Chicony CNF7129 (Asus EEE 100HE) */
2626 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2627 				| USB_DEVICE_ID_MATCH_INT_INFO,
2628 	  .idVendor		= 0x04f2,
2629 	  .idProduct		= 0xb071,
2630 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2631 	  .bInterfaceSubClass	= 1,
2632 	  .bInterfaceProtocol	= 0,
2633 	  .driver_info		= UVC_INFO_QUIRK(UVC_QUIRK_RESTRICT_FRAME_RATE) },
2634 	/* Alcor Micro AU3820 (Future Boy PC USB Webcam) */
2635 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2636 				| USB_DEVICE_ID_MATCH_INT_INFO,
2637 	  .idVendor		= 0x058f,
2638 	  .idProduct		= 0x3820,
2639 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2640 	  .bInterfaceSubClass	= 1,
2641 	  .bInterfaceProtocol	= 0,
2642 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2643 	/* Dell XPS m1530 */
2644 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2645 				| USB_DEVICE_ID_MATCH_INT_INFO,
2646 	  .idVendor		= 0x05a9,
2647 	  .idProduct		= 0x2640,
2648 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2649 	  .bInterfaceSubClass	= 1,
2650 	  .bInterfaceProtocol	= 0,
2651 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_def },
2652 	/* Dell SP2008WFP Monitor */
2653 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2654 				| USB_DEVICE_ID_MATCH_INT_INFO,
2655 	  .idVendor		= 0x05a9,
2656 	  .idProduct		= 0x2641,
2657 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2658 	  .bInterfaceSubClass	= 1,
2659 	  .bInterfaceProtocol	= 0,
2660 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_def },
2661 	/* Dell Alienware X51 */
2662 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2663 				| USB_DEVICE_ID_MATCH_INT_INFO,
2664 	  .idVendor		= 0x05a9,
2665 	  .idProduct		= 0x2643,
2666 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2667 	  .bInterfaceSubClass	= 1,
2668 	  .bInterfaceProtocol	= 0,
2669 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_def },
2670 	/* Dell Studio Hybrid 140g (OmniVision webcam) */
2671 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2672 				| USB_DEVICE_ID_MATCH_INT_INFO,
2673 	  .idVendor		= 0x05a9,
2674 	  .idProduct		= 0x264a,
2675 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2676 	  .bInterfaceSubClass	= 1,
2677 	  .bInterfaceProtocol	= 0,
2678 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_def },
2679 	/* Dell XPS M1330 (OmniVision OV7670 webcam) */
2680 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2681 				| USB_DEVICE_ID_MATCH_INT_INFO,
2682 	  .idVendor		= 0x05a9,
2683 	  .idProduct		= 0x7670,
2684 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2685 	  .bInterfaceSubClass	= 1,
2686 	  .bInterfaceProtocol	= 0,
2687 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_def },
2688 	/* Apple Built-In iSight */
2689 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2690 				| USB_DEVICE_ID_MATCH_INT_INFO,
2691 	  .idVendor		= 0x05ac,
2692 	  .idProduct		= 0x8501,
2693 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2694 	  .bInterfaceSubClass	= 1,
2695 	  .bInterfaceProtocol	= 0,
2696 	  .driver_info		= UVC_INFO_QUIRK(UVC_QUIRK_PROBE_MINMAX
2697 					| UVC_QUIRK_BUILTIN_ISIGHT) },
2698 	/* Apple Built-In iSight via iBridge */
2699 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2700 				| USB_DEVICE_ID_MATCH_INT_INFO,
2701 	  .idVendor		= 0x05ac,
2702 	  .idProduct		= 0x8600,
2703 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2704 	  .bInterfaceSubClass	= 1,
2705 	  .bInterfaceProtocol	= 0,
2706 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_def },
2707 	/* Foxlink ("HP Webcam" on HP Mini 5103) */
2708 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2709 				| USB_DEVICE_ID_MATCH_INT_INFO,
2710 	  .idVendor		= 0x05c8,
2711 	  .idProduct		= 0x0403,
2712 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2713 	  .bInterfaceSubClass	= 1,
2714 	  .bInterfaceProtocol	= 0,
2715 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_fix_bandwidth },
2716 	/* Genesys Logic USB 2.0 PC Camera */
2717 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2718 				| USB_DEVICE_ID_MATCH_INT_INFO,
2719 	  .idVendor		= 0x05e3,
2720 	  .idProduct		= 0x0505,
2721 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2722 	  .bInterfaceSubClass	= 1,
2723 	  .bInterfaceProtocol	= 0,
2724 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_stream_no_fid },
2725 	/* Hercules Classic Silver */
2726 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2727 				| USB_DEVICE_ID_MATCH_INT_INFO,
2728 	  .idVendor		= 0x06f8,
2729 	  .idProduct		= 0x300c,
2730 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2731 	  .bInterfaceSubClass	= 1,
2732 	  .bInterfaceProtocol	= 0,
2733 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_fix_bandwidth },
2734 	/* ViMicro Vega */
2735 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2736 				| USB_DEVICE_ID_MATCH_INT_INFO,
2737 	  .idVendor		= 0x0ac8,
2738 	  .idProduct		= 0x332d,
2739 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2740 	  .bInterfaceSubClass	= 1,
2741 	  .bInterfaceProtocol	= 0,
2742 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_fix_bandwidth },
2743 	/* ViMicro - Minoru3D */
2744 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2745 				| USB_DEVICE_ID_MATCH_INT_INFO,
2746 	  .idVendor		= 0x0ac8,
2747 	  .idProduct		= 0x3410,
2748 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2749 	  .bInterfaceSubClass	= 1,
2750 	  .bInterfaceProtocol	= 0,
2751 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_fix_bandwidth },
2752 	/* ViMicro Venus - Minoru3D */
2753 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2754 				| USB_DEVICE_ID_MATCH_INT_INFO,
2755 	  .idVendor		= 0x0ac8,
2756 	  .idProduct		= 0x3420,
2757 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2758 	  .bInterfaceSubClass	= 1,
2759 	  .bInterfaceProtocol	= 0,
2760 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_fix_bandwidth },
2761 	/* Ophir Optronics - SPCAM 620U */
2762 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2763 				| USB_DEVICE_ID_MATCH_INT_INFO,
2764 	  .idVendor		= 0x0bd3,
2765 	  .idProduct		= 0x0555,
2766 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2767 	  .bInterfaceSubClass	= 1,
2768 	  .bInterfaceProtocol	= 0,
2769 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2770 	/* MT6227 */
2771 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2772 				| USB_DEVICE_ID_MATCH_INT_INFO,
2773 	  .idVendor		= 0x0e8d,
2774 	  .idProduct		= 0x0004,
2775 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2776 	  .bInterfaceSubClass	= 1,
2777 	  .bInterfaceProtocol	= 0,
2778 	  .driver_info		= UVC_INFO_QUIRK(UVC_QUIRK_PROBE_MINMAX
2779 					| UVC_QUIRK_PROBE_DEF) },
2780 	/* IMC Networks (Medion Akoya) */
2781 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2782 				| USB_DEVICE_ID_MATCH_INT_INFO,
2783 	  .idVendor		= 0x13d3,
2784 	  .idProduct		= 0x5103,
2785 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2786 	  .bInterfaceSubClass	= 1,
2787 	  .bInterfaceProtocol	= 0,
2788 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_stream_no_fid },
2789 	/* JMicron USB2.0 XGA WebCam */
2790 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2791 				| USB_DEVICE_ID_MATCH_INT_INFO,
2792 	  .idVendor		= 0x152d,
2793 	  .idProduct		= 0x0310,
2794 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2795 	  .bInterfaceSubClass	= 1,
2796 	  .bInterfaceProtocol	= 0,
2797 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2798 	/* Syntek (HP Spartan) */
2799 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2800 				| USB_DEVICE_ID_MATCH_INT_INFO,
2801 	  .idVendor		= 0x174f,
2802 	  .idProduct		= 0x5212,
2803 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2804 	  .bInterfaceSubClass	= 1,
2805 	  .bInterfaceProtocol	= 0,
2806 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_stream_no_fid },
2807 	/* Syntek (Samsung Q310) */
2808 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2809 				| USB_DEVICE_ID_MATCH_INT_INFO,
2810 	  .idVendor		= 0x174f,
2811 	  .idProduct		= 0x5931,
2812 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2813 	  .bInterfaceSubClass	= 1,
2814 	  .bInterfaceProtocol	= 0,
2815 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_stream_no_fid },
2816 	/* Syntek (Packard Bell EasyNote MX52 */
2817 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2818 				| USB_DEVICE_ID_MATCH_INT_INFO,
2819 	  .idVendor		= 0x174f,
2820 	  .idProduct		= 0x8a12,
2821 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2822 	  .bInterfaceSubClass	= 1,
2823 	  .bInterfaceProtocol	= 0,
2824 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_stream_no_fid },
2825 	/* Syntek (Asus F9SG) */
2826 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2827 				| USB_DEVICE_ID_MATCH_INT_INFO,
2828 	  .idVendor		= 0x174f,
2829 	  .idProduct		= 0x8a31,
2830 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2831 	  .bInterfaceSubClass	= 1,
2832 	  .bInterfaceProtocol	= 0,
2833 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_stream_no_fid },
2834 	/* Syntek (Asus U3S) */
2835 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2836 				| USB_DEVICE_ID_MATCH_INT_INFO,
2837 	  .idVendor		= 0x174f,
2838 	  .idProduct		= 0x8a33,
2839 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2840 	  .bInterfaceSubClass	= 1,
2841 	  .bInterfaceProtocol	= 0,
2842 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_stream_no_fid },
2843 	/* Syntek (JAOtech Smart Terminal) */
2844 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2845 				| USB_DEVICE_ID_MATCH_INT_INFO,
2846 	  .idVendor		= 0x174f,
2847 	  .idProduct		= 0x8a34,
2848 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2849 	  .bInterfaceSubClass	= 1,
2850 	  .bInterfaceProtocol	= 0,
2851 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_stream_no_fid },
2852 	/* Miricle 307K */
2853 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2854 				| USB_DEVICE_ID_MATCH_INT_INFO,
2855 	  .idVendor		= 0x17dc,
2856 	  .idProduct		= 0x0202,
2857 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2858 	  .bInterfaceSubClass	= 1,
2859 	  .bInterfaceProtocol	= 0,
2860 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_stream_no_fid },
2861 	/* Lenovo Thinkpad SL400/SL500 */
2862 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2863 				| USB_DEVICE_ID_MATCH_INT_INFO,
2864 	  .idVendor		= 0x17ef,
2865 	  .idProduct		= 0x480b,
2866 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2867 	  .bInterfaceSubClass	= 1,
2868 	  .bInterfaceProtocol	= 0,
2869 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_stream_no_fid },
2870 	/* Aveo Technology USB 2.0 Camera */
2871 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2872 				| USB_DEVICE_ID_MATCH_INT_INFO,
2873 	  .idVendor		= 0x1871,
2874 	  .idProduct		= 0x0306,
2875 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2876 	  .bInterfaceSubClass	= 1,
2877 	  .bInterfaceProtocol	= 0,
2878 	  .driver_info		= UVC_INFO_QUIRK(UVC_QUIRK_PROBE_MINMAX
2879 					| UVC_QUIRK_PROBE_EXTRAFIELDS) },
2880 	/* Aveo Technology USB 2.0 Camera (Tasco USB Microscope) */
2881 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2882 				| USB_DEVICE_ID_MATCH_INT_INFO,
2883 	  .idVendor		= 0x1871,
2884 	  .idProduct		= 0x0516,
2885 	  .bInterfaceClass	= USB_CLASS_VENDOR_SPEC,
2886 	  .bInterfaceSubClass	= 1,
2887 	  .bInterfaceProtocol	= 0 },
2888 	/* Ecamm Pico iMage */
2889 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2890 				| USB_DEVICE_ID_MATCH_INT_INFO,
2891 	  .idVendor		= 0x18cd,
2892 	  .idProduct		= 0xcafe,
2893 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2894 	  .bInterfaceSubClass	= 1,
2895 	  .bInterfaceProtocol	= 0,
2896 	  .driver_info		= UVC_INFO_QUIRK(UVC_QUIRK_PROBE_EXTRAFIELDS) },
2897 	/* Manta MM-353 Plako */
2898 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2899 				| USB_DEVICE_ID_MATCH_INT_INFO,
2900 	  .idVendor		= 0x18ec,
2901 	  .idProduct		= 0x3188,
2902 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2903 	  .bInterfaceSubClass	= 1,
2904 	  .bInterfaceProtocol	= 0,
2905 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2906 	/* FSC WebCam V30S */
2907 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2908 				| USB_DEVICE_ID_MATCH_INT_INFO,
2909 	  .idVendor		= 0x18ec,
2910 	  .idProduct		= 0x3288,
2911 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2912 	  .bInterfaceSubClass	= 1,
2913 	  .bInterfaceProtocol	= 0,
2914 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2915 	/* Arkmicro unbranded */
2916 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2917 				| USB_DEVICE_ID_MATCH_INT_INFO,
2918 	  .idVendor		= 0x18ec,
2919 	  .idProduct		= 0x3290,
2920 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2921 	  .bInterfaceSubClass	= 1,
2922 	  .bInterfaceProtocol	= 0,
2923 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_def },
2924 	/* The Imaging Source USB CCD cameras */
2925 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2926 				| USB_DEVICE_ID_MATCH_INT_INFO,
2927 	  .idVendor		= 0x199e,
2928 	  .idProduct		= 0x8102,
2929 	  .bInterfaceClass	= USB_CLASS_VENDOR_SPEC,
2930 	  .bInterfaceSubClass	= 1,
2931 	  .bInterfaceProtocol	= 0 },
2932 	/* Bodelin ProScopeHR */
2933 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2934 				| USB_DEVICE_ID_MATCH_DEV_HI
2935 				| USB_DEVICE_ID_MATCH_INT_INFO,
2936 	  .idVendor		= 0x19ab,
2937 	  .idProduct		= 0x1000,
2938 	  .bcdDevice_hi		= 0x0126,
2939 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2940 	  .bInterfaceSubClass	= 1,
2941 	  .bInterfaceProtocol	= 0,
2942 	  .driver_info		= UVC_INFO_QUIRK(UVC_QUIRK_STATUS_INTERVAL) },
2943 	/* MSI StarCam 370i */
2944 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2945 				| USB_DEVICE_ID_MATCH_INT_INFO,
2946 	  .idVendor		= 0x1b3b,
2947 	  .idProduct		= 0x2951,
2948 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2949 	  .bInterfaceSubClass	= 1,
2950 	  .bInterfaceProtocol	= 0,
2951 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2952 	/* Generalplus Technology Inc. 808 Camera */
2953 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2954 				| USB_DEVICE_ID_MATCH_INT_INFO,
2955 	  .idVendor		= 0x1b3f,
2956 	  .idProduct		= 0x2002,
2957 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2958 	  .bInterfaceSubClass	= 1,
2959 	  .bInterfaceProtocol	= 0,
2960 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2961 	/* SiGma Micro USB Web Camera */
2962 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2963 				| USB_DEVICE_ID_MATCH_INT_INFO,
2964 	  .idVendor		= 0x1c4f,
2965 	  .idProduct		= 0x3000,
2966 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2967 	  .bInterfaceSubClass	= 1,
2968 	  .bInterfaceProtocol	= 0,
2969 	  .driver_info		= UVC_INFO_QUIRK(UVC_QUIRK_PROBE_MINMAX
2970 					| UVC_QUIRK_IGNORE_SELECTOR_UNIT) },
2971 	/* Oculus VR Positional Tracker DK2 */
2972 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2973 				| USB_DEVICE_ID_MATCH_INT_INFO,
2974 	  .idVendor		= 0x2833,
2975 	  .idProduct		= 0x0201,
2976 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2977 	  .bInterfaceSubClass	= 1,
2978 	  .bInterfaceProtocol	= 0,
2979 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_force_y8 },
2980 	/* Oculus VR Rift Sensor */
2981 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2982 				| USB_DEVICE_ID_MATCH_INT_INFO,
2983 	  .idVendor		= 0x2833,
2984 	  .idProduct		= 0x0211,
2985 	  .bInterfaceClass	= USB_CLASS_VENDOR_SPEC,
2986 	  .bInterfaceSubClass	= 1,
2987 	  .bInterfaceProtocol	= 0,
2988 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_force_y8 },
2989 	/* GEO Semiconductor GC6500 */
2990 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2991 				| USB_DEVICE_ID_MATCH_INT_INFO,
2992 	  .idVendor		= 0x29fe,
2993 	  .idProduct		= 0x4d53,
2994 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2995 	  .bInterfaceSubClass	= 1,
2996 	  .bInterfaceProtocol	= 0,
2997 	  .driver_info		= UVC_INFO_QUIRK(UVC_QUIRK_FORCE_BPP) },
2998 	/* Intel RealSense D4M */
2999 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
3000 				| USB_DEVICE_ID_MATCH_INT_INFO,
3001 	  .idVendor		= 0x8086,
3002 	  .idProduct		= 0x0b03,
3003 	  .bInterfaceClass	= USB_CLASS_VIDEO,
3004 	  .bInterfaceSubClass	= 1,
3005 	  .bInterfaceProtocol	= 0,
3006 	  .driver_info		= UVC_INFO_META(V4L2_META_FMT_D4XX) },
3007 	/* Generic USB Video Class */
3008 	{ USB_INTERFACE_INFO(USB_CLASS_VIDEO, 1, UVC_PC_PROTOCOL_UNDEFINED) },
3009 	{ USB_INTERFACE_INFO(USB_CLASS_VIDEO, 1, UVC_PC_PROTOCOL_15) },
3010 	{}
3011 };
3012 
3013 MODULE_DEVICE_TABLE(usb, uvc_ids);
3014 
3015 struct uvc_driver uvc_driver = {
3016 	.driver = {
3017 		.name		= "uvcvideo",
3018 		.probe		= uvc_probe,
3019 		.disconnect	= uvc_disconnect,
3020 		.suspend	= uvc_suspend,
3021 		.resume		= uvc_resume,
3022 		.reset_resume	= uvc_reset_resume,
3023 		.id_table	= uvc_ids,
3024 		.supports_autosuspend = 1,
3025 	},
3026 };
3027 
uvc_init(void)3028 static int __init uvc_init(void)
3029 {
3030 	int ret;
3031 
3032 	uvc_debugfs_init();
3033 
3034 	ret = usb_register(&uvc_driver.driver);
3035 	if (ret < 0) {
3036 		uvc_debugfs_cleanup();
3037 		return ret;
3038 	}
3039 
3040 	printk(KERN_INFO DRIVER_DESC " (" DRIVER_VERSION ")\n");
3041 	return 0;
3042 }
3043 
uvc_cleanup(void)3044 static void __exit uvc_cleanup(void)
3045 {
3046 	usb_deregister(&uvc_driver.driver);
3047 	uvc_debugfs_cleanup();
3048 }
3049 
3050 module_init(uvc_init);
3051 module_exit(uvc_cleanup);
3052 
3053 MODULE_AUTHOR(DRIVER_AUTHOR);
3054 MODULE_DESCRIPTION(DRIVER_DESC);
3055 MODULE_LICENSE("GPL");
3056 MODULE_VERSION(DRIVER_VERSION);
3057 
3058