• 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 (ftype && 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_new_entity(struct uvc_device * dev,u16 type,u16 id,unsigned int num_pads,unsigned int extra_size)1022 static struct uvc_entity *uvc_alloc_new_entity(struct uvc_device *dev, u16 type,
1023 					       u16 id, unsigned int num_pads,
1024 					       unsigned int extra_size)
1025 {
1026 	struct uvc_entity *entity;
1027 	unsigned int num_inputs;
1028 	unsigned int size;
1029 	unsigned int i;
1030 
1031 	/* Per UVC 1.1+ spec 3.7.2, the ID should be non-zero. */
1032 	if (id == 0) {
1033 		dev_err(&dev->udev->dev, "Found Unit with invalid ID 0.\n");
1034 		return ERR_PTR(-EINVAL);
1035 	}
1036 
1037 	/* Per UVC 1.1+ spec 3.7.2, the ID is unique. */
1038 	if (uvc_entity_by_id(dev, id)) {
1039 		dev_err(&dev->udev->dev, "Found multiple Units with ID %u\n", id);
1040 		return ERR_PTR(-EINVAL);
1041 	}
1042 
1043 	extra_size = roundup(extra_size, sizeof(*entity->pads));
1044 	if (num_pads)
1045 		num_inputs = type & UVC_TERM_OUTPUT ? num_pads : num_pads - 1;
1046 	else
1047 		num_inputs = 0;
1048 	size = sizeof(*entity) + extra_size + sizeof(*entity->pads) * num_pads
1049 	     + num_inputs;
1050 	entity = kzalloc(size, GFP_KERNEL);
1051 	if (entity == NULL)
1052 		return ERR_PTR(-ENOMEM);
1053 
1054 	entity->id = id;
1055 	entity->type = type;
1056 
1057 	entity->num_links = 0;
1058 	entity->num_pads = num_pads;
1059 	entity->pads = ((void *)(entity + 1)) + extra_size;
1060 
1061 	for (i = 0; i < num_inputs; ++i)
1062 		entity->pads[i].flags = MEDIA_PAD_FL_SINK;
1063 	if (!UVC_ENTITY_IS_OTERM(entity) && num_pads)
1064 		entity->pads[num_pads-1].flags = MEDIA_PAD_FL_SOURCE;
1065 
1066 	entity->bNrInPins = num_inputs;
1067 	entity->baSourceID = (u8 *)(&entity->pads[num_pads]);
1068 
1069 	return entity;
1070 }
1071 
1072 /* Parse vendor-specific extensions. */
uvc_parse_vendor_control(struct uvc_device * dev,const unsigned char * buffer,int buflen)1073 static int uvc_parse_vendor_control(struct uvc_device *dev,
1074 	const unsigned char *buffer, int buflen)
1075 {
1076 	struct usb_device *udev = dev->udev;
1077 	struct usb_host_interface *alts = dev->intf->cur_altsetting;
1078 	struct uvc_entity *unit;
1079 	unsigned int n, p;
1080 	int handled = 0;
1081 
1082 	switch (le16_to_cpu(dev->udev->descriptor.idVendor)) {
1083 	case 0x046d:		/* Logitech */
1084 		if (buffer[1] != 0x41 || buffer[2] != 0x01)
1085 			break;
1086 
1087 		/* Logitech implements several vendor specific functions
1088 		 * through vendor specific extension units (LXU).
1089 		 *
1090 		 * The LXU descriptors are similar to XU descriptors
1091 		 * (see "USB Device Video Class for Video Devices", section
1092 		 * 3.7.2.6 "Extension Unit Descriptor") with the following
1093 		 * differences:
1094 		 *
1095 		 * ----------------------------------------------------------
1096 		 * 0		bLength		1	 Number
1097 		 *	Size of this descriptor, in bytes: 24+p+n*2
1098 		 * ----------------------------------------------------------
1099 		 * 23+p+n	bmControlsType	N	Bitmap
1100 		 *	Individual bits in the set are defined:
1101 		 *	0: Absolute
1102 		 *	1: Relative
1103 		 *
1104 		 *	This bitset is mapped exactly the same as bmControls.
1105 		 * ----------------------------------------------------------
1106 		 * 23+p+n*2	bReserved	1	Boolean
1107 		 * ----------------------------------------------------------
1108 		 * 24+p+n*2	iExtension	1	Index
1109 		 *	Index of a string descriptor that describes this
1110 		 *	extension unit.
1111 		 * ----------------------------------------------------------
1112 		 */
1113 		p = buflen >= 22 ? buffer[21] : 0;
1114 		n = buflen >= 25 + p ? buffer[22+p] : 0;
1115 
1116 		if (buflen < 25 + p + 2*n) {
1117 			uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1118 				"interface %d EXTENSION_UNIT error\n",
1119 				udev->devnum, alts->desc.bInterfaceNumber);
1120 			break;
1121 		}
1122 
1123 		unit = uvc_alloc_new_entity(dev, UVC_VC_EXTENSION_UNIT,
1124 					    buffer[3], p + 1, 2 * n);
1125 		if (IS_ERR(unit))
1126 			return PTR_ERR(unit);
1127 
1128 		memcpy(unit->extension.guidExtensionCode, &buffer[4], 16);
1129 		unit->extension.bNumControls = buffer[20];
1130 		memcpy(unit->baSourceID, &buffer[22], p);
1131 		unit->extension.bControlSize = buffer[22+p];
1132 		unit->extension.bmControls = (u8 *)unit + sizeof(*unit);
1133 		unit->extension.bmControlsType = (u8 *)unit + sizeof(*unit)
1134 					       + n;
1135 		memcpy(unit->extension.bmControls, &buffer[23+p], 2*n);
1136 
1137 		if (buffer[24+p+2*n] == 0 ||
1138 		    usb_string(udev, buffer[24+p+2*n], unit->name, sizeof(unit->name)) < 0)
1139 			sprintf(unit->name, "Extension %u", buffer[3]);
1140 
1141 		list_add_tail(&unit->list, &dev->entities);
1142 		handled = 1;
1143 		break;
1144 	}
1145 
1146 	return handled;
1147 }
1148 
uvc_parse_standard_control(struct uvc_device * dev,const unsigned char * buffer,int buflen)1149 static int uvc_parse_standard_control(struct uvc_device *dev,
1150 	const unsigned char *buffer, int buflen)
1151 {
1152 	struct usb_device *udev = dev->udev;
1153 	struct uvc_entity *unit, *term;
1154 	struct usb_interface *intf;
1155 	struct usb_host_interface *alts = dev->intf->cur_altsetting;
1156 	unsigned int i, n, p, len;
1157 	u16 type;
1158 
1159 	switch (buffer[2]) {
1160 	case UVC_VC_HEADER:
1161 		n = buflen >= 12 ? buffer[11] : 0;
1162 
1163 		if (buflen < 12 + n) {
1164 			uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1165 				"interface %d HEADER error\n", udev->devnum,
1166 				alts->desc.bInterfaceNumber);
1167 			return -EINVAL;
1168 		}
1169 
1170 		dev->uvc_version = get_unaligned_le16(&buffer[3]);
1171 		dev->clock_frequency = get_unaligned_le32(&buffer[7]);
1172 
1173 		/* Parse all USB Video Streaming interfaces. */
1174 		for (i = 0; i < n; ++i) {
1175 			intf = usb_ifnum_to_if(udev, buffer[12+i]);
1176 			if (intf == NULL) {
1177 				uvc_trace(UVC_TRACE_DESCR, "device %d "
1178 					"interface %d doesn't exists\n",
1179 					udev->devnum, i);
1180 				continue;
1181 			}
1182 
1183 			uvc_parse_streaming(dev, intf);
1184 		}
1185 		break;
1186 
1187 	case UVC_VC_INPUT_TERMINAL:
1188 		if (buflen < 8) {
1189 			uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1190 				"interface %d INPUT_TERMINAL error\n",
1191 				udev->devnum, alts->desc.bInterfaceNumber);
1192 			return -EINVAL;
1193 		}
1194 
1195 		/*
1196 		 * Reject invalid terminal types that would cause issues:
1197 		 *
1198 		 * - The high byte must be non-zero, otherwise it would be
1199 		 *   confused with a unit.
1200 		 *
1201 		 * - Bit 15 must be 0, as we use it internally as a terminal
1202 		 *   direction flag.
1203 		 *
1204 		 * Other unknown types are accepted.
1205 		 */
1206 		type = get_unaligned_le16(&buffer[4]);
1207 		if ((type & 0x7f00) == 0 || (type & 0x8000) != 0) {
1208 			uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1209 				"interface %d INPUT_TERMINAL %d has invalid "
1210 				"type 0x%04x, skipping\n", udev->devnum,
1211 				alts->desc.bInterfaceNumber,
1212 				buffer[3], type);
1213 			return 0;
1214 		}
1215 
1216 		n = 0;
1217 		p = 0;
1218 		len = 8;
1219 
1220 		if (type == UVC_ITT_CAMERA) {
1221 			n = buflen >= 15 ? buffer[14] : 0;
1222 			len = 15;
1223 
1224 		} else if (type == UVC_ITT_MEDIA_TRANSPORT_INPUT) {
1225 			n = buflen >= 9 ? buffer[8] : 0;
1226 			p = buflen >= 10 + n ? buffer[9+n] : 0;
1227 			len = 10;
1228 		}
1229 
1230 		if (buflen < len + n + p) {
1231 			uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1232 				"interface %d INPUT_TERMINAL error\n",
1233 				udev->devnum, alts->desc.bInterfaceNumber);
1234 			return -EINVAL;
1235 		}
1236 
1237 		term = uvc_alloc_new_entity(dev, type | UVC_TERM_INPUT,
1238 					    buffer[3], 1, n + p);
1239 		if (IS_ERR(term))
1240 			return PTR_ERR(term);
1241 
1242 		if (UVC_ENTITY_TYPE(term) == UVC_ITT_CAMERA) {
1243 			term->camera.bControlSize = n;
1244 			term->camera.bmControls = (u8 *)term + sizeof(*term);
1245 			term->camera.wObjectiveFocalLengthMin =
1246 				get_unaligned_le16(&buffer[8]);
1247 			term->camera.wObjectiveFocalLengthMax =
1248 				get_unaligned_le16(&buffer[10]);
1249 			term->camera.wOcularFocalLength =
1250 				get_unaligned_le16(&buffer[12]);
1251 			memcpy(term->camera.bmControls, &buffer[15], n);
1252 		} else if (UVC_ENTITY_TYPE(term) ==
1253 			   UVC_ITT_MEDIA_TRANSPORT_INPUT) {
1254 			term->media.bControlSize = n;
1255 			term->media.bmControls = (u8 *)term + sizeof(*term);
1256 			term->media.bTransportModeSize = p;
1257 			term->media.bmTransportModes = (u8 *)term
1258 						     + sizeof(*term) + n;
1259 			memcpy(term->media.bmControls, &buffer[9], n);
1260 			memcpy(term->media.bmTransportModes, &buffer[10+n], p);
1261 		}
1262 
1263 		if (buffer[7] == 0 ||
1264 		    usb_string(udev, buffer[7], term->name, sizeof(term->name)) < 0) {
1265 			if (UVC_ENTITY_TYPE(term) == UVC_ITT_CAMERA)
1266 				sprintf(term->name, "Camera %u", buffer[3]);
1267 			if (UVC_ENTITY_TYPE(term) == UVC_ITT_MEDIA_TRANSPORT_INPUT)
1268 				sprintf(term->name, "Media %u", buffer[3]);
1269 			else
1270 				sprintf(term->name, "Input %u", buffer[3]);
1271 		}
1272 
1273 		list_add_tail(&term->list, &dev->entities);
1274 		break;
1275 
1276 	case UVC_VC_OUTPUT_TERMINAL:
1277 		if (buflen < 9) {
1278 			uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1279 				"interface %d OUTPUT_TERMINAL error\n",
1280 				udev->devnum, alts->desc.bInterfaceNumber);
1281 			return -EINVAL;
1282 		}
1283 
1284 		/* Make sure the terminal type MSB is not null, otherwise it
1285 		 * could be confused with a unit.
1286 		 */
1287 		type = get_unaligned_le16(&buffer[4]);
1288 		if ((type & 0xff00) == 0) {
1289 			uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1290 				"interface %d OUTPUT_TERMINAL %d has invalid "
1291 				"type 0x%04x, skipping\n", udev->devnum,
1292 				alts->desc.bInterfaceNumber, buffer[3], type);
1293 			return 0;
1294 		}
1295 
1296 		term = uvc_alloc_new_entity(dev, type | UVC_TERM_OUTPUT,
1297 					    buffer[3], 1, 0);
1298 		if (IS_ERR(term))
1299 			return PTR_ERR(term);
1300 
1301 		memcpy(term->baSourceID, &buffer[7], 1);
1302 
1303 		if (buffer[8] == 0 ||
1304 		    usb_string(udev, buffer[8], term->name, sizeof(term->name)) < 0)
1305 			sprintf(term->name, "Output %u", buffer[3]);
1306 
1307 		list_add_tail(&term->list, &dev->entities);
1308 		break;
1309 
1310 	case UVC_VC_SELECTOR_UNIT:
1311 		p = buflen >= 5 ? buffer[4] : 0;
1312 
1313 		if (buflen < 5 || buflen < 6 + p) {
1314 			uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1315 				"interface %d SELECTOR_UNIT error\n",
1316 				udev->devnum, alts->desc.bInterfaceNumber);
1317 			return -EINVAL;
1318 		}
1319 
1320 		unit = uvc_alloc_new_entity(dev, buffer[2], buffer[3],
1321 					    p + 1, 0);
1322 		if (IS_ERR(unit))
1323 			return PTR_ERR(unit);
1324 
1325 		memcpy(unit->baSourceID, &buffer[5], p);
1326 
1327 		if (buffer[5+p] == 0 ||
1328 		    usb_string(udev, buffer[5+p], unit->name, sizeof(unit->name)) < 0)
1329 			sprintf(unit->name, "Selector %u", buffer[3]);
1330 
1331 		list_add_tail(&unit->list, &dev->entities);
1332 		break;
1333 
1334 	case UVC_VC_PROCESSING_UNIT:
1335 		n = buflen >= 8 ? buffer[7] : 0;
1336 		p = dev->uvc_version >= 0x0110 ? 10 : 9;
1337 
1338 		if (buflen < p + n) {
1339 			uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1340 				"interface %d PROCESSING_UNIT error\n",
1341 				udev->devnum, alts->desc.bInterfaceNumber);
1342 			return -EINVAL;
1343 		}
1344 
1345 		unit = uvc_alloc_new_entity(dev, buffer[2], buffer[3], 2, n);
1346 		if (IS_ERR(unit))
1347 			return PTR_ERR(unit);
1348 
1349 		memcpy(unit->baSourceID, &buffer[4], 1);
1350 		unit->processing.wMaxMultiplier =
1351 			get_unaligned_le16(&buffer[5]);
1352 		unit->processing.bControlSize = buffer[7];
1353 		unit->processing.bmControls = (u8 *)unit + sizeof(*unit);
1354 		memcpy(unit->processing.bmControls, &buffer[8], n);
1355 		if (dev->uvc_version >= 0x0110)
1356 			unit->processing.bmVideoStandards = buffer[9+n];
1357 
1358 		if (buffer[8+n] == 0 ||
1359 		    usb_string(udev, buffer[8+n], unit->name, sizeof(unit->name)) < 0)
1360 			sprintf(unit->name, "Processing %u", buffer[3]);
1361 
1362 		list_add_tail(&unit->list, &dev->entities);
1363 		break;
1364 
1365 	case UVC_VC_EXTENSION_UNIT:
1366 		p = buflen >= 22 ? buffer[21] : 0;
1367 		n = buflen >= 24 + p ? buffer[22+p] : 0;
1368 
1369 		if (buflen < 24 + p + n) {
1370 			uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1371 				"interface %d EXTENSION_UNIT error\n",
1372 				udev->devnum, alts->desc.bInterfaceNumber);
1373 			return -EINVAL;
1374 		}
1375 
1376 		unit = uvc_alloc_new_entity(dev, buffer[2], buffer[3],
1377 					    p + 1, n);
1378 		if (IS_ERR(unit))
1379 			return PTR_ERR(unit);
1380 
1381 		memcpy(unit->extension.guidExtensionCode, &buffer[4], 16);
1382 		unit->extension.bNumControls = buffer[20];
1383 		memcpy(unit->baSourceID, &buffer[22], p);
1384 		unit->extension.bControlSize = buffer[22+p];
1385 		unit->extension.bmControls = (u8 *)unit + sizeof(*unit);
1386 		memcpy(unit->extension.bmControls, &buffer[23+p], n);
1387 
1388 		if (buffer[23+p+n] == 0 ||
1389 		    usb_string(udev, buffer[23+p+n], unit->name, sizeof(unit->name)) < 0)
1390 			sprintf(unit->name, "Extension %u", buffer[3]);
1391 
1392 		list_add_tail(&unit->list, &dev->entities);
1393 		break;
1394 
1395 	default:
1396 		uvc_trace(UVC_TRACE_DESCR, "Found an unknown CS_INTERFACE "
1397 			"descriptor (%u)\n", buffer[2]);
1398 		break;
1399 	}
1400 
1401 	return 0;
1402 }
1403 
uvc_parse_control(struct uvc_device * dev)1404 static int uvc_parse_control(struct uvc_device *dev)
1405 {
1406 	struct usb_host_interface *alts = dev->intf->cur_altsetting;
1407 	unsigned char *buffer = alts->extra;
1408 	int buflen = alts->extralen;
1409 	int ret;
1410 
1411 	/* Parse the default alternate setting only, as the UVC specification
1412 	 * defines a single alternate setting, the default alternate setting
1413 	 * zero.
1414 	 */
1415 
1416 	while (buflen > 2) {
1417 		if (uvc_parse_vendor_control(dev, buffer, buflen) ||
1418 		    buffer[1] != USB_DT_CS_INTERFACE)
1419 			goto next_descriptor;
1420 
1421 		if ((ret = uvc_parse_standard_control(dev, buffer, buflen)) < 0)
1422 			return ret;
1423 
1424 next_descriptor:
1425 		buflen -= buffer[0];
1426 		buffer += buffer[0];
1427 	}
1428 
1429 	/* Check if the optional status endpoint is present. Built-in iSight
1430 	 * webcams have an interrupt endpoint but spit proprietary data that
1431 	 * don't conform to the UVC status endpoint messages. Don't try to
1432 	 * handle the interrupt endpoint for those cameras.
1433 	 */
1434 	if (alts->desc.bNumEndpoints == 1 &&
1435 	    !(dev->quirks & UVC_QUIRK_BUILTIN_ISIGHT)) {
1436 		struct usb_host_endpoint *ep = &alts->endpoint[0];
1437 		struct usb_endpoint_descriptor *desc = &ep->desc;
1438 
1439 		if (usb_endpoint_is_int_in(desc) &&
1440 		    le16_to_cpu(desc->wMaxPacketSize) >= 8 &&
1441 		    desc->bInterval != 0) {
1442 			uvc_trace(UVC_TRACE_DESCR, "Found a Status endpoint "
1443 				"(addr %02x).\n", desc->bEndpointAddress);
1444 			dev->int_ep = ep;
1445 		}
1446 	}
1447 
1448 	return 0;
1449 }
1450 
1451 /* ------------------------------------------------------------------------
1452  * UVC device scan
1453  */
1454 
1455 /*
1456  * Scan the UVC descriptors to locate a chain starting at an Output Terminal
1457  * and containing the following units:
1458  *
1459  * - one or more Output Terminals (USB Streaming or Display)
1460  * - zero or one Processing Unit
1461  * - zero, one or more single-input Selector Units
1462  * - zero or one multiple-input Selector Units, provided all inputs are
1463  *   connected to input terminals
1464  * - zero, one or mode single-input Extension Units
1465  * - one or more Input Terminals (Camera, External or USB Streaming)
1466  *
1467  * The terminal and units must match on of the following structures:
1468  *
1469  * ITT_*(0) -> +---------+    +---------+    +---------+ -> TT_STREAMING(0)
1470  * ...         | SU{0,1} | -> | PU{0,1} | -> | XU{0,n} |    ...
1471  * ITT_*(n) -> +---------+    +---------+    +---------+ -> TT_STREAMING(n)
1472  *
1473  *                 +---------+    +---------+ -> OTT_*(0)
1474  * TT_STREAMING -> | PU{0,1} | -> | XU{0,n} |    ...
1475  *                 +---------+    +---------+ -> OTT_*(n)
1476  *
1477  * The Processing Unit and Extension Units can be in any order. Additional
1478  * Extension Units connected to the main chain as single-unit branches are
1479  * also supported. Single-input Selector Units are ignored.
1480  */
uvc_scan_chain_entity(struct uvc_video_chain * chain,struct uvc_entity * entity)1481 static int uvc_scan_chain_entity(struct uvc_video_chain *chain,
1482 	struct uvc_entity *entity)
1483 {
1484 	switch (UVC_ENTITY_TYPE(entity)) {
1485 	case UVC_VC_EXTENSION_UNIT:
1486 		if (uvc_trace_param & UVC_TRACE_PROBE)
1487 			printk(KERN_CONT " <- XU %d", entity->id);
1488 
1489 		if (entity->bNrInPins != 1) {
1490 			uvc_trace(UVC_TRACE_DESCR, "Extension unit %d has more "
1491 				"than 1 input pin.\n", entity->id);
1492 			return -1;
1493 		}
1494 
1495 		break;
1496 
1497 	case UVC_VC_PROCESSING_UNIT:
1498 		if (uvc_trace_param & UVC_TRACE_PROBE)
1499 			printk(KERN_CONT " <- PU %d", entity->id);
1500 
1501 		if (chain->processing != NULL) {
1502 			uvc_trace(UVC_TRACE_DESCR, "Found multiple "
1503 				"Processing Units in chain.\n");
1504 			return -1;
1505 		}
1506 
1507 		chain->processing = entity;
1508 		break;
1509 
1510 	case UVC_VC_SELECTOR_UNIT:
1511 		if (uvc_trace_param & UVC_TRACE_PROBE)
1512 			printk(KERN_CONT " <- SU %d", entity->id);
1513 
1514 		/* Single-input selector units are ignored. */
1515 		if (entity->bNrInPins == 1)
1516 			break;
1517 
1518 		if (chain->selector != NULL) {
1519 			uvc_trace(UVC_TRACE_DESCR, "Found multiple Selector "
1520 				"Units in chain.\n");
1521 			return -1;
1522 		}
1523 
1524 		chain->selector = entity;
1525 		break;
1526 
1527 	case UVC_ITT_VENDOR_SPECIFIC:
1528 	case UVC_ITT_CAMERA:
1529 	case UVC_ITT_MEDIA_TRANSPORT_INPUT:
1530 		if (uvc_trace_param & UVC_TRACE_PROBE)
1531 			printk(KERN_CONT " <- IT %d\n", entity->id);
1532 
1533 		break;
1534 
1535 	case UVC_OTT_VENDOR_SPECIFIC:
1536 	case UVC_OTT_DISPLAY:
1537 	case UVC_OTT_MEDIA_TRANSPORT_OUTPUT:
1538 		if (uvc_trace_param & UVC_TRACE_PROBE)
1539 			printk(KERN_CONT " OT %d", entity->id);
1540 
1541 		break;
1542 
1543 	case UVC_TT_STREAMING:
1544 		if (UVC_ENTITY_IS_ITERM(entity)) {
1545 			if (uvc_trace_param & UVC_TRACE_PROBE)
1546 				printk(KERN_CONT " <- IT %d\n", entity->id);
1547 		} else {
1548 			if (uvc_trace_param & UVC_TRACE_PROBE)
1549 				printk(KERN_CONT " OT %d", entity->id);
1550 		}
1551 
1552 		break;
1553 
1554 	default:
1555 		uvc_trace(UVC_TRACE_DESCR, "Unsupported entity type "
1556 			"0x%04x found in chain.\n", UVC_ENTITY_TYPE(entity));
1557 		return -1;
1558 	}
1559 
1560 	list_add_tail(&entity->chain, &chain->entities);
1561 	return 0;
1562 }
1563 
uvc_scan_chain_forward(struct uvc_video_chain * chain,struct uvc_entity * entity,struct uvc_entity * prev)1564 static int uvc_scan_chain_forward(struct uvc_video_chain *chain,
1565 	struct uvc_entity *entity, struct uvc_entity *prev)
1566 {
1567 	struct uvc_entity *forward;
1568 	int found;
1569 
1570 	/* Forward scan */
1571 	forward = NULL;
1572 	found = 0;
1573 
1574 	while (1) {
1575 		forward = uvc_entity_by_reference(chain->dev, entity->id,
1576 			forward);
1577 		if (forward == NULL)
1578 			break;
1579 		if (forward == prev)
1580 			continue;
1581 		if (forward->chain.next || forward->chain.prev) {
1582 			uvc_trace(UVC_TRACE_DESCR, "Found reference to "
1583 				"entity %d already in chain.\n", forward->id);
1584 			return -EINVAL;
1585 		}
1586 
1587 		switch (UVC_ENTITY_TYPE(forward)) {
1588 		case UVC_VC_EXTENSION_UNIT:
1589 			if (forward->bNrInPins != 1) {
1590 				uvc_trace(UVC_TRACE_DESCR, "Extension unit %d "
1591 					  "has more than 1 input pin.\n",
1592 					  entity->id);
1593 				return -EINVAL;
1594 			}
1595 
1596 			/*
1597 			 * Some devices reference an output terminal as the
1598 			 * source of extension units. This is incorrect, as
1599 			 * output terminals only have an input pin, and thus
1600 			 * can't be connected to any entity in the forward
1601 			 * direction. The resulting topology would cause issues
1602 			 * when registering the media controller graph. To
1603 			 * avoid this problem, connect the extension unit to
1604 			 * the source of the output terminal instead.
1605 			 */
1606 			if (UVC_ENTITY_IS_OTERM(entity)) {
1607 				struct uvc_entity *source;
1608 
1609 				source = uvc_entity_by_id(chain->dev,
1610 							  entity->baSourceID[0]);
1611 				if (!source) {
1612 					uvc_trace(UVC_TRACE_DESCR,
1613 						"Can't connect extension unit %u in chain\n",
1614 						forward->id);
1615 					break;
1616 				}
1617 
1618 				forward->baSourceID[0] = source->id;
1619 			}
1620 
1621 			list_add_tail(&forward->chain, &chain->entities);
1622 			if (uvc_trace_param & UVC_TRACE_PROBE) {
1623 				if (!found)
1624 					printk(KERN_CONT " (->");
1625 
1626 				printk(KERN_CONT " XU %d", forward->id);
1627 				found = 1;
1628 			}
1629 			break;
1630 
1631 		case UVC_OTT_VENDOR_SPECIFIC:
1632 		case UVC_OTT_DISPLAY:
1633 		case UVC_OTT_MEDIA_TRANSPORT_OUTPUT:
1634 		case UVC_TT_STREAMING:
1635 			if (UVC_ENTITY_IS_ITERM(forward)) {
1636 				uvc_trace(UVC_TRACE_DESCR, "Unsupported input "
1637 					"terminal %u.\n", forward->id);
1638 				return -EINVAL;
1639 			}
1640 
1641 			if (UVC_ENTITY_IS_OTERM(entity)) {
1642 				uvc_trace(UVC_TRACE_DESCR,
1643 					"Unsupported connection between output terminals %u and %u\n",
1644 					entity->id, forward->id);
1645 				break;
1646 			}
1647 
1648 			list_add_tail(&forward->chain, &chain->entities);
1649 			if (uvc_trace_param & UVC_TRACE_PROBE) {
1650 				if (!found)
1651 					printk(KERN_CONT " (->");
1652 
1653 				printk(KERN_CONT " OT %d", forward->id);
1654 				found = 1;
1655 			}
1656 			break;
1657 		}
1658 	}
1659 	if (found)
1660 		printk(KERN_CONT ")");
1661 
1662 	return 0;
1663 }
1664 
uvc_scan_chain_backward(struct uvc_video_chain * chain,struct uvc_entity ** _entity)1665 static int uvc_scan_chain_backward(struct uvc_video_chain *chain,
1666 	struct uvc_entity **_entity)
1667 {
1668 	struct uvc_entity *entity = *_entity;
1669 	struct uvc_entity *term;
1670 	int id = -EINVAL, i;
1671 
1672 	switch (UVC_ENTITY_TYPE(entity)) {
1673 	case UVC_VC_EXTENSION_UNIT:
1674 	case UVC_VC_PROCESSING_UNIT:
1675 		id = entity->baSourceID[0];
1676 		break;
1677 
1678 	case UVC_VC_SELECTOR_UNIT:
1679 		/* Single-input selector units are ignored. */
1680 		if (entity->bNrInPins == 1) {
1681 			id = entity->baSourceID[0];
1682 			break;
1683 		}
1684 
1685 		if (uvc_trace_param & UVC_TRACE_PROBE)
1686 			printk(KERN_CONT " <- IT");
1687 
1688 		chain->selector = entity;
1689 		for (i = 0; i < entity->bNrInPins; ++i) {
1690 			id = entity->baSourceID[i];
1691 			term = uvc_entity_by_id(chain->dev, id);
1692 			if (term == NULL || !UVC_ENTITY_IS_ITERM(term)) {
1693 				uvc_trace(UVC_TRACE_DESCR, "Selector unit %d "
1694 					"input %d isn't connected to an "
1695 					"input terminal\n", entity->id, i);
1696 				return -1;
1697 			}
1698 
1699 			if (term->chain.next || term->chain.prev) {
1700 				uvc_trace(UVC_TRACE_DESCR, "Found reference to "
1701 					"entity %d already in chain.\n",
1702 					term->id);
1703 				return -EINVAL;
1704 			}
1705 
1706 			if (uvc_trace_param & UVC_TRACE_PROBE)
1707 				printk(KERN_CONT " %d", term->id);
1708 
1709 			list_add_tail(&term->chain, &chain->entities);
1710 			uvc_scan_chain_forward(chain, term, entity);
1711 		}
1712 
1713 		if (uvc_trace_param & UVC_TRACE_PROBE)
1714 			printk(KERN_CONT "\n");
1715 
1716 		id = 0;
1717 		break;
1718 
1719 	case UVC_ITT_VENDOR_SPECIFIC:
1720 	case UVC_ITT_CAMERA:
1721 	case UVC_ITT_MEDIA_TRANSPORT_INPUT:
1722 	case UVC_OTT_VENDOR_SPECIFIC:
1723 	case UVC_OTT_DISPLAY:
1724 	case UVC_OTT_MEDIA_TRANSPORT_OUTPUT:
1725 	case UVC_TT_STREAMING:
1726 		id = UVC_ENTITY_IS_OTERM(entity) ? entity->baSourceID[0] : 0;
1727 		break;
1728 	}
1729 
1730 	if (id <= 0) {
1731 		*_entity = NULL;
1732 		return id;
1733 	}
1734 
1735 	entity = uvc_entity_by_id(chain->dev, id);
1736 	if (entity == NULL) {
1737 		uvc_trace(UVC_TRACE_DESCR, "Found reference to "
1738 			"unknown entity %d.\n", id);
1739 		return -EINVAL;
1740 	}
1741 
1742 	*_entity = entity;
1743 	return 0;
1744 }
1745 
uvc_scan_chain(struct uvc_video_chain * chain,struct uvc_entity * term)1746 static int uvc_scan_chain(struct uvc_video_chain *chain,
1747 			  struct uvc_entity *term)
1748 {
1749 	struct uvc_entity *entity, *prev;
1750 
1751 	uvc_trace(UVC_TRACE_PROBE, "Scanning UVC chain:");
1752 
1753 	entity = term;
1754 	prev = NULL;
1755 
1756 	while (entity != NULL) {
1757 		/* Entity must not be part of an existing chain */
1758 		if (entity->chain.next || entity->chain.prev) {
1759 			uvc_trace(UVC_TRACE_DESCR, "Found reference to "
1760 				"entity %d already in chain.\n", entity->id);
1761 			return -EINVAL;
1762 		}
1763 
1764 		/* Process entity */
1765 		if (uvc_scan_chain_entity(chain, entity) < 0)
1766 			return -EINVAL;
1767 
1768 		/* Forward scan */
1769 		if (uvc_scan_chain_forward(chain, entity, prev) < 0)
1770 			return -EINVAL;
1771 
1772 		/* Backward scan */
1773 		prev = entity;
1774 		if (uvc_scan_chain_backward(chain, &entity) < 0)
1775 			return -EINVAL;
1776 	}
1777 
1778 	return 0;
1779 }
1780 
uvc_print_terms(struct list_head * terms,u16 dir,char * buffer)1781 static unsigned int uvc_print_terms(struct list_head *terms, u16 dir,
1782 		char *buffer)
1783 {
1784 	struct uvc_entity *term;
1785 	unsigned int nterms = 0;
1786 	char *p = buffer;
1787 
1788 	list_for_each_entry(term, terms, chain) {
1789 		if (!UVC_ENTITY_IS_TERM(term) ||
1790 		    UVC_TERM_DIRECTION(term) != dir)
1791 			continue;
1792 
1793 		if (nterms)
1794 			p += sprintf(p, ",");
1795 		if (++nterms >= 4) {
1796 			p += sprintf(p, "...");
1797 			break;
1798 		}
1799 		p += sprintf(p, "%u", term->id);
1800 	}
1801 
1802 	return p - buffer;
1803 }
1804 
uvc_print_chain(struct uvc_video_chain * chain)1805 static const char *uvc_print_chain(struct uvc_video_chain *chain)
1806 {
1807 	static char buffer[43];
1808 	char *p = buffer;
1809 
1810 	p += uvc_print_terms(&chain->entities, UVC_TERM_INPUT, p);
1811 	p += sprintf(p, " -> ");
1812 	uvc_print_terms(&chain->entities, UVC_TERM_OUTPUT, p);
1813 
1814 	return buffer;
1815 }
1816 
uvc_alloc_chain(struct uvc_device * dev)1817 static struct uvc_video_chain *uvc_alloc_chain(struct uvc_device *dev)
1818 {
1819 	struct uvc_video_chain *chain;
1820 
1821 	chain = kzalloc(sizeof(*chain), GFP_KERNEL);
1822 	if (chain == NULL)
1823 		return NULL;
1824 
1825 	INIT_LIST_HEAD(&chain->entities);
1826 	mutex_init(&chain->ctrl_mutex);
1827 	chain->dev = dev;
1828 	v4l2_prio_init(&chain->prio);
1829 
1830 	return chain;
1831 }
1832 
1833 /*
1834  * Fallback heuristic for devices that don't connect units and terminals in a
1835  * valid chain.
1836  *
1837  * Some devices have invalid baSourceID references, causing uvc_scan_chain()
1838  * to fail, but if we just take the entities we can find and put them together
1839  * in the most sensible chain we can think of, turns out they do work anyway.
1840  * Note: This heuristic assumes there is a single chain.
1841  *
1842  * At the time of writing, devices known to have such a broken chain are
1843  *  - Acer Integrated Camera (5986:055a)
1844  *  - Realtek rtl157a7 (0bda:57a7)
1845  */
uvc_scan_fallback(struct uvc_device * dev)1846 static int uvc_scan_fallback(struct uvc_device *dev)
1847 {
1848 	struct uvc_video_chain *chain;
1849 	struct uvc_entity *iterm = NULL;
1850 	struct uvc_entity *oterm = NULL;
1851 	struct uvc_entity *entity;
1852 	struct uvc_entity *prev;
1853 
1854 	/*
1855 	 * Start by locating the input and output terminals. We only support
1856 	 * devices with exactly one of each for now.
1857 	 */
1858 	list_for_each_entry(entity, &dev->entities, list) {
1859 		if (UVC_ENTITY_IS_ITERM(entity)) {
1860 			if (iterm)
1861 				return -EINVAL;
1862 			iterm = entity;
1863 		}
1864 
1865 		if (UVC_ENTITY_IS_OTERM(entity)) {
1866 			if (oterm)
1867 				return -EINVAL;
1868 			oterm = entity;
1869 		}
1870 	}
1871 
1872 	if (iterm == NULL || oterm == NULL)
1873 		return -EINVAL;
1874 
1875 	/* Allocate the chain and fill it. */
1876 	chain = uvc_alloc_chain(dev);
1877 	if (chain == NULL)
1878 		return -ENOMEM;
1879 
1880 	if (uvc_scan_chain_entity(chain, oterm) < 0)
1881 		goto error;
1882 
1883 	prev = oterm;
1884 
1885 	/*
1886 	 * Add all Processing and Extension Units with two pads. The order
1887 	 * doesn't matter much, use reverse list traversal to connect units in
1888 	 * UVC descriptor order as we build the chain from output to input. This
1889 	 * leads to units appearing in the order meant by the manufacturer for
1890 	 * the cameras known to require this heuristic.
1891 	 */
1892 	list_for_each_entry_reverse(entity, &dev->entities, list) {
1893 		if (entity->type != UVC_VC_PROCESSING_UNIT &&
1894 		    entity->type != UVC_VC_EXTENSION_UNIT)
1895 			continue;
1896 
1897 		if (entity->num_pads != 2)
1898 			continue;
1899 
1900 		if (uvc_scan_chain_entity(chain, entity) < 0)
1901 			goto error;
1902 
1903 		prev->baSourceID[0] = entity->id;
1904 		prev = entity;
1905 	}
1906 
1907 	if (uvc_scan_chain_entity(chain, iterm) < 0)
1908 		goto error;
1909 
1910 	prev->baSourceID[0] = iterm->id;
1911 
1912 	list_add_tail(&chain->list, &dev->chains);
1913 
1914 	uvc_trace(UVC_TRACE_PROBE,
1915 		  "Found a video chain by fallback heuristic (%s).\n",
1916 		  uvc_print_chain(chain));
1917 
1918 	return 0;
1919 
1920 error:
1921 	kfree(chain);
1922 	return -EINVAL;
1923 }
1924 
1925 /*
1926  * Scan the device for video chains and register video devices.
1927  *
1928  * Chains are scanned starting at their output terminals and walked backwards.
1929  */
uvc_scan_device(struct uvc_device * dev)1930 static int uvc_scan_device(struct uvc_device *dev)
1931 {
1932 	struct uvc_video_chain *chain;
1933 	struct uvc_entity *term;
1934 
1935 	list_for_each_entry(term, &dev->entities, list) {
1936 		if (!UVC_ENTITY_IS_OTERM(term))
1937 			continue;
1938 
1939 		/* If the terminal is already included in a chain, skip it.
1940 		 * This can happen for chains that have multiple output
1941 		 * terminals, where all output terminals beside the first one
1942 		 * will be inserted in the chain in forward scans.
1943 		 */
1944 		if (term->chain.next || term->chain.prev)
1945 			continue;
1946 
1947 		chain = uvc_alloc_chain(dev);
1948 		if (chain == NULL)
1949 			return -ENOMEM;
1950 
1951 		term->flags |= UVC_ENTITY_FLAG_DEFAULT;
1952 
1953 		if (uvc_scan_chain(chain, term) < 0) {
1954 			kfree(chain);
1955 			continue;
1956 		}
1957 
1958 		uvc_trace(UVC_TRACE_PROBE, "Found a valid video chain (%s).\n",
1959 			  uvc_print_chain(chain));
1960 
1961 		list_add_tail(&chain->list, &dev->chains);
1962 	}
1963 
1964 	if (list_empty(&dev->chains))
1965 		uvc_scan_fallback(dev);
1966 
1967 	if (list_empty(&dev->chains)) {
1968 		uvc_printk(KERN_INFO, "No valid video chain found.\n");
1969 		return -1;
1970 	}
1971 
1972 	return 0;
1973 }
1974 
1975 /* ------------------------------------------------------------------------
1976  * Video device registration and unregistration
1977  */
1978 
1979 /*
1980  * Delete the UVC device.
1981  *
1982  * Called by the kernel when the last reference to the uvc_device structure
1983  * is released.
1984  *
1985  * As this function is called after or during disconnect(), all URBs have
1986  * already been cancelled by the USB core. There is no need to kill the
1987  * interrupt URB manually.
1988  */
uvc_delete(struct kref * kref)1989 static void uvc_delete(struct kref *kref)
1990 {
1991 	struct uvc_device *dev = container_of(kref, struct uvc_device, ref);
1992 	struct list_head *p, *n;
1993 
1994 	uvc_status_cleanup(dev);
1995 	uvc_ctrl_cleanup_device(dev);
1996 
1997 	usb_put_intf(dev->intf);
1998 	usb_put_dev(dev->udev);
1999 
2000 #ifdef CONFIG_MEDIA_CONTROLLER
2001 	media_device_cleanup(&dev->mdev);
2002 #endif
2003 
2004 	list_for_each_safe(p, n, &dev->chains) {
2005 		struct uvc_video_chain *chain;
2006 		chain = list_entry(p, struct uvc_video_chain, list);
2007 		kfree(chain);
2008 	}
2009 
2010 	list_for_each_safe(p, n, &dev->entities) {
2011 		struct uvc_entity *entity;
2012 		entity = list_entry(p, struct uvc_entity, list);
2013 #ifdef CONFIG_MEDIA_CONTROLLER
2014 		uvc_mc_cleanup_entity(entity);
2015 #endif
2016 		kfree(entity);
2017 	}
2018 
2019 	list_for_each_safe(p, n, &dev->streams) {
2020 		struct uvc_streaming *streaming;
2021 		streaming = list_entry(p, struct uvc_streaming, list);
2022 		usb_driver_release_interface(&uvc_driver.driver,
2023 			streaming->intf);
2024 		uvc_stream_delete(streaming);
2025 	}
2026 
2027 	kfree(dev);
2028 }
2029 
uvc_release(struct video_device * vdev)2030 static void uvc_release(struct video_device *vdev)
2031 {
2032 	struct uvc_streaming *stream = video_get_drvdata(vdev);
2033 	struct uvc_device *dev = stream->dev;
2034 
2035 	kref_put(&dev->ref, uvc_delete);
2036 }
2037 
2038 /*
2039  * Unregister the video devices.
2040  */
uvc_unregister_video(struct uvc_device * dev)2041 static void uvc_unregister_video(struct uvc_device *dev)
2042 {
2043 	struct uvc_streaming *stream;
2044 
2045 	list_for_each_entry(stream, &dev->streams, list) {
2046 		if (!video_is_registered(&stream->vdev))
2047 			continue;
2048 
2049 		video_unregister_device(&stream->vdev);
2050 		video_unregister_device(&stream->meta.vdev);
2051 
2052 		uvc_debugfs_cleanup_stream(stream);
2053 	}
2054 
2055 	uvc_status_unregister(dev);
2056 
2057 	if (dev->vdev.dev)
2058 		v4l2_device_unregister(&dev->vdev);
2059 #ifdef CONFIG_MEDIA_CONTROLLER
2060 	if (media_devnode_is_registered(dev->mdev.devnode))
2061 		media_device_unregister(&dev->mdev);
2062 #endif
2063 }
2064 
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)2065 int uvc_register_video_device(struct uvc_device *dev,
2066 			      struct uvc_streaming *stream,
2067 			      struct video_device *vdev,
2068 			      struct uvc_video_queue *queue,
2069 			      enum v4l2_buf_type type,
2070 			      const struct v4l2_file_operations *fops,
2071 			      const struct v4l2_ioctl_ops *ioctl_ops)
2072 {
2073 	int ret;
2074 
2075 	/* Initialize the video buffers queue. */
2076 	ret = uvc_queue_init(queue, type, !uvc_no_drop_param);
2077 	if (ret)
2078 		return ret;
2079 
2080 	/* Register the device with V4L. */
2081 
2082 	/*
2083 	 * We already hold a reference to dev->udev. The video device will be
2084 	 * unregistered before the reference is released, so we don't need to
2085 	 * get another one.
2086 	 */
2087 	vdev->v4l2_dev = &dev->vdev;
2088 	vdev->fops = fops;
2089 	vdev->ioctl_ops = ioctl_ops;
2090 	vdev->release = uvc_release;
2091 	vdev->prio = &stream->chain->prio;
2092 	if (type == V4L2_BUF_TYPE_VIDEO_OUTPUT)
2093 		vdev->vfl_dir = VFL_DIR_TX;
2094 	else
2095 		vdev->vfl_dir = VFL_DIR_RX;
2096 
2097 	switch (type) {
2098 	case V4L2_BUF_TYPE_VIDEO_CAPTURE:
2099 	default:
2100 		vdev->device_caps = V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_STREAMING;
2101 		break;
2102 	case V4L2_BUF_TYPE_VIDEO_OUTPUT:
2103 		vdev->device_caps = V4L2_CAP_VIDEO_OUTPUT | V4L2_CAP_STREAMING;
2104 		break;
2105 	case V4L2_BUF_TYPE_META_CAPTURE:
2106 		vdev->device_caps = V4L2_CAP_META_CAPTURE | V4L2_CAP_STREAMING;
2107 		break;
2108 	}
2109 
2110 	strscpy(vdev->name, dev->name, sizeof(vdev->name));
2111 
2112 	/*
2113 	 * Set the driver data before calling video_register_device, otherwise
2114 	 * the file open() handler might race us.
2115 	 */
2116 	video_set_drvdata(vdev, stream);
2117 
2118 	ret = video_register_device(vdev, VFL_TYPE_VIDEO, -1);
2119 	if (ret < 0) {
2120 		uvc_printk(KERN_ERR, "Failed to register %s device (%d).\n",
2121 			   v4l2_type_names[type], ret);
2122 		return ret;
2123 	}
2124 
2125 	kref_get(&dev->ref);
2126 	return 0;
2127 }
2128 
uvc_register_video(struct uvc_device * dev,struct uvc_streaming * stream)2129 static int uvc_register_video(struct uvc_device *dev,
2130 		struct uvc_streaming *stream)
2131 {
2132 	int ret;
2133 
2134 	/* Initialize the streaming interface with default parameters. */
2135 	ret = uvc_video_init(stream);
2136 	if (ret < 0) {
2137 		uvc_printk(KERN_ERR, "Failed to initialize the device (%d).\n",
2138 			   ret);
2139 		return ret;
2140 	}
2141 
2142 	if (stream->type == V4L2_BUF_TYPE_VIDEO_CAPTURE)
2143 		stream->chain->caps |= V4L2_CAP_VIDEO_CAPTURE
2144 			| V4L2_CAP_META_CAPTURE;
2145 	else
2146 		stream->chain->caps |= V4L2_CAP_VIDEO_OUTPUT;
2147 
2148 	uvc_debugfs_init_stream(stream);
2149 
2150 	/* Register the device with V4L. */
2151 	return uvc_register_video_device(dev, stream, &stream->vdev,
2152 					 &stream->queue, stream->type,
2153 					 &uvc_fops, &uvc_ioctl_ops);
2154 }
2155 
2156 /*
2157  * Register all video devices in all chains.
2158  */
uvc_register_terms(struct uvc_device * dev,struct uvc_video_chain * chain)2159 static int uvc_register_terms(struct uvc_device *dev,
2160 	struct uvc_video_chain *chain)
2161 {
2162 	struct uvc_streaming *stream;
2163 	struct uvc_entity *term;
2164 	int ret;
2165 
2166 	list_for_each_entry(term, &chain->entities, chain) {
2167 		if (UVC_ENTITY_TYPE(term) != UVC_TT_STREAMING)
2168 			continue;
2169 
2170 		stream = uvc_stream_by_id(dev, term->id);
2171 		if (stream == NULL) {
2172 			uvc_printk(KERN_INFO, "No streaming interface found "
2173 				   "for terminal %u.", term->id);
2174 			continue;
2175 		}
2176 
2177 		stream->chain = chain;
2178 		ret = uvc_register_video(dev, stream);
2179 		if (ret < 0)
2180 			return ret;
2181 
2182 		/* Register a metadata node, but ignore a possible failure,
2183 		 * complete registration of video nodes anyway.
2184 		 */
2185 		uvc_meta_register(stream);
2186 
2187 		term->vdev = &stream->vdev;
2188 	}
2189 
2190 	return 0;
2191 }
2192 
uvc_register_chains(struct uvc_device * dev)2193 static int uvc_register_chains(struct uvc_device *dev)
2194 {
2195 	struct uvc_video_chain *chain;
2196 	int ret;
2197 
2198 	list_for_each_entry(chain, &dev->chains, list) {
2199 		ret = uvc_register_terms(dev, chain);
2200 		if (ret < 0)
2201 			return ret;
2202 
2203 #ifdef CONFIG_MEDIA_CONTROLLER
2204 		ret = uvc_mc_register_entities(chain);
2205 		if (ret < 0)
2206 			uvc_printk(KERN_INFO,
2207 				   "Failed to register entities (%d).\n", ret);
2208 #endif
2209 	}
2210 
2211 	return 0;
2212 }
2213 
2214 /* ------------------------------------------------------------------------
2215  * USB probe, disconnect, suspend and resume
2216  */
2217 
2218 static const struct uvc_device_info uvc_quirk_none = { 0 };
2219 
uvc_probe(struct usb_interface * intf,const struct usb_device_id * id)2220 static int uvc_probe(struct usb_interface *intf,
2221 		     const struct usb_device_id *id)
2222 {
2223 	struct usb_device *udev = interface_to_usbdev(intf);
2224 	struct uvc_device *dev;
2225 	const struct uvc_device_info *info =
2226 		(const struct uvc_device_info *)id->driver_info;
2227 	int function;
2228 	int ret;
2229 
2230 	if (id->idVendor && id->idProduct)
2231 		uvc_trace(UVC_TRACE_PROBE, "Probing known UVC device %s "
2232 				"(%04x:%04x)\n", udev->devpath, id->idVendor,
2233 				id->idProduct);
2234 	else
2235 		uvc_trace(UVC_TRACE_PROBE, "Probing generic UVC device %s\n",
2236 				udev->devpath);
2237 
2238 	/* Allocate memory for the device and initialize it. */
2239 	dev = kzalloc(sizeof(*dev), GFP_KERNEL);
2240 	if (dev == NULL)
2241 		return -ENOMEM;
2242 
2243 	INIT_LIST_HEAD(&dev->entities);
2244 	INIT_LIST_HEAD(&dev->chains);
2245 	INIT_LIST_HEAD(&dev->streams);
2246 	kref_init(&dev->ref);
2247 	atomic_set(&dev->nmappings, 0);
2248 	mutex_init(&dev->lock);
2249 
2250 	dev->udev = usb_get_dev(udev);
2251 	dev->intf = usb_get_intf(intf);
2252 	dev->intfnum = intf->cur_altsetting->desc.bInterfaceNumber;
2253 	dev->info = info ? info : &uvc_quirk_none;
2254 	dev->quirks = uvc_quirks_param == -1
2255 		    ? dev->info->quirks : uvc_quirks_param;
2256 
2257 	if (udev->product != NULL)
2258 		strscpy(dev->name, udev->product, sizeof(dev->name));
2259 	else
2260 		snprintf(dev->name, sizeof(dev->name),
2261 			 "UVC Camera (%04x:%04x)",
2262 			 le16_to_cpu(udev->descriptor.idVendor),
2263 			 le16_to_cpu(udev->descriptor.idProduct));
2264 
2265 	/*
2266 	 * Add iFunction or iInterface to names when available as additional
2267 	 * distinguishers between interfaces. iFunction is prioritized over
2268 	 * iInterface which matches Windows behavior at the point of writing.
2269 	 */
2270 	if (intf->intf_assoc && intf->intf_assoc->iFunction != 0)
2271 		function = intf->intf_assoc->iFunction;
2272 	else
2273 		function = intf->cur_altsetting->desc.iInterface;
2274 	if (function != 0) {
2275 		size_t len;
2276 
2277 		strlcat(dev->name, ": ", sizeof(dev->name));
2278 		len = strlen(dev->name);
2279 		usb_string(udev, function, dev->name + len,
2280 			   sizeof(dev->name) - len);
2281 	}
2282 
2283 	/* Initialize the media device. */
2284 #ifdef CONFIG_MEDIA_CONTROLLER
2285 	dev->mdev.dev = &intf->dev;
2286 	strscpy(dev->mdev.model, dev->name, sizeof(dev->mdev.model));
2287 	if (udev->serial)
2288 		strscpy(dev->mdev.serial, udev->serial,
2289 			sizeof(dev->mdev.serial));
2290 	usb_make_path(udev, dev->mdev.bus_info, sizeof(dev->mdev.bus_info));
2291 	dev->mdev.hw_revision = le16_to_cpu(udev->descriptor.bcdDevice);
2292 	media_device_init(&dev->mdev);
2293 
2294 	dev->vdev.mdev = &dev->mdev;
2295 #endif
2296 
2297 	/* Parse the Video Class control descriptor. */
2298 	if (uvc_parse_control(dev) < 0) {
2299 		uvc_trace(UVC_TRACE_PROBE, "Unable to parse UVC "
2300 			"descriptors.\n");
2301 		goto error;
2302 	}
2303 
2304 	uvc_printk(KERN_INFO, "Found UVC %u.%02x device %s (%04x:%04x)\n",
2305 		dev->uvc_version >> 8, dev->uvc_version & 0xff,
2306 		udev->product ? udev->product : "<unnamed>",
2307 		le16_to_cpu(udev->descriptor.idVendor),
2308 		le16_to_cpu(udev->descriptor.idProduct));
2309 
2310 	if (dev->quirks != dev->info->quirks) {
2311 		uvc_printk(KERN_INFO, "Forcing device quirks to 0x%x by module "
2312 			"parameter for testing purpose.\n", dev->quirks);
2313 		uvc_printk(KERN_INFO, "Please report required quirks to the "
2314 			"linux-uvc-devel mailing list.\n");
2315 	}
2316 
2317 	/* Register the V4L2 device. */
2318 	if (v4l2_device_register(&intf->dev, &dev->vdev) < 0)
2319 		goto error;
2320 
2321 	/* Initialize controls. */
2322 	if (uvc_ctrl_init_device(dev) < 0)
2323 		goto error;
2324 
2325 	/* Scan the device for video chains. */
2326 	if (uvc_scan_device(dev) < 0)
2327 		goto error;
2328 
2329 	/* Register video device nodes. */
2330 	if (uvc_register_chains(dev) < 0)
2331 		goto error;
2332 
2333 #ifdef CONFIG_MEDIA_CONTROLLER
2334 	/* Register the media device node */
2335 	if (media_device_register(&dev->mdev) < 0)
2336 		goto error;
2337 #endif
2338 	/* Save our data pointer in the interface data. */
2339 	usb_set_intfdata(intf, dev);
2340 
2341 	/* Initialize the interrupt URB. */
2342 	if ((ret = uvc_status_init(dev)) < 0) {
2343 		uvc_printk(KERN_INFO, "Unable to initialize the status "
2344 			"endpoint (%d), status interrupt will not be "
2345 			"supported.\n", ret);
2346 	}
2347 
2348 	uvc_trace(UVC_TRACE_PROBE, "UVC device initialized.\n");
2349 	usb_enable_autosuspend(udev);
2350 	return 0;
2351 
2352 error:
2353 	uvc_unregister_video(dev);
2354 	kref_put(&dev->ref, uvc_delete);
2355 	return -ENODEV;
2356 }
2357 
uvc_disconnect(struct usb_interface * intf)2358 static void uvc_disconnect(struct usb_interface *intf)
2359 {
2360 	struct uvc_device *dev = usb_get_intfdata(intf);
2361 
2362 	/* Set the USB interface data to NULL. This can be done outside the
2363 	 * lock, as there's no other reader.
2364 	 */
2365 	usb_set_intfdata(intf, NULL);
2366 
2367 	if (intf->cur_altsetting->desc.bInterfaceSubClass ==
2368 	    UVC_SC_VIDEOSTREAMING)
2369 		return;
2370 
2371 	uvc_unregister_video(dev);
2372 	kref_put(&dev->ref, uvc_delete);
2373 }
2374 
uvc_suspend(struct usb_interface * intf,pm_message_t message)2375 static int uvc_suspend(struct usb_interface *intf, pm_message_t message)
2376 {
2377 	struct uvc_device *dev = usb_get_intfdata(intf);
2378 	struct uvc_streaming *stream;
2379 
2380 	uvc_trace(UVC_TRACE_SUSPEND, "Suspending interface %u\n",
2381 		intf->cur_altsetting->desc.bInterfaceNumber);
2382 
2383 	/* Controls are cached on the fly so they don't need to be saved. */
2384 	if (intf->cur_altsetting->desc.bInterfaceSubClass ==
2385 	    UVC_SC_VIDEOCONTROL) {
2386 		mutex_lock(&dev->lock);
2387 		if (dev->users)
2388 			uvc_status_stop(dev);
2389 		mutex_unlock(&dev->lock);
2390 		return 0;
2391 	}
2392 
2393 	list_for_each_entry(stream, &dev->streams, list) {
2394 		if (stream->intf == intf)
2395 			return uvc_video_suspend(stream);
2396 	}
2397 
2398 	uvc_trace(UVC_TRACE_SUSPEND, "Suspend: video streaming USB interface "
2399 			"mismatch.\n");
2400 	return -EINVAL;
2401 }
2402 
__uvc_resume(struct usb_interface * intf,int reset)2403 static int __uvc_resume(struct usb_interface *intf, int reset)
2404 {
2405 	struct uvc_device *dev = usb_get_intfdata(intf);
2406 	struct uvc_streaming *stream;
2407 	int ret = 0;
2408 
2409 	uvc_trace(UVC_TRACE_SUSPEND, "Resuming interface %u\n",
2410 		intf->cur_altsetting->desc.bInterfaceNumber);
2411 
2412 	if (intf->cur_altsetting->desc.bInterfaceSubClass ==
2413 	    UVC_SC_VIDEOCONTROL) {
2414 		if (reset) {
2415 			ret = uvc_ctrl_restore_values(dev);
2416 			if (ret < 0)
2417 				return ret;
2418 		}
2419 
2420 		mutex_lock(&dev->lock);
2421 		if (dev->users)
2422 			ret = uvc_status_start(dev, GFP_NOIO);
2423 		mutex_unlock(&dev->lock);
2424 
2425 		return ret;
2426 	}
2427 
2428 	list_for_each_entry(stream, &dev->streams, list) {
2429 		if (stream->intf == intf) {
2430 			ret = uvc_video_resume(stream, reset);
2431 			if (ret < 0)
2432 				uvc_queue_streamoff(&stream->queue,
2433 						    stream->queue.queue.type);
2434 			return ret;
2435 		}
2436 	}
2437 
2438 	uvc_trace(UVC_TRACE_SUSPEND, "Resume: video streaming USB interface "
2439 			"mismatch.\n");
2440 	return -EINVAL;
2441 }
2442 
uvc_resume(struct usb_interface * intf)2443 static int uvc_resume(struct usb_interface *intf)
2444 {
2445 	return __uvc_resume(intf, 0);
2446 }
2447 
uvc_reset_resume(struct usb_interface * intf)2448 static int uvc_reset_resume(struct usb_interface *intf)
2449 {
2450 	return __uvc_resume(intf, 1);
2451 }
2452 
2453 /* ------------------------------------------------------------------------
2454  * Module parameters
2455  */
2456 
uvc_clock_param_get(char * buffer,const struct kernel_param * kp)2457 static int uvc_clock_param_get(char *buffer, const struct kernel_param *kp)
2458 {
2459 	if (uvc_clock_param == CLOCK_MONOTONIC)
2460 		return sprintf(buffer, "CLOCK_MONOTONIC");
2461 	else
2462 		return sprintf(buffer, "CLOCK_REALTIME");
2463 }
2464 
uvc_clock_param_set(const char * val,const struct kernel_param * kp)2465 static int uvc_clock_param_set(const char *val, const struct kernel_param *kp)
2466 {
2467 	if (strncasecmp(val, "clock_", strlen("clock_")) == 0)
2468 		val += strlen("clock_");
2469 
2470 	if (strcasecmp(val, "monotonic") == 0)
2471 		uvc_clock_param = CLOCK_MONOTONIC;
2472 	else if (strcasecmp(val, "realtime") == 0)
2473 		uvc_clock_param = CLOCK_REALTIME;
2474 	else
2475 		return -EINVAL;
2476 
2477 	return 0;
2478 }
2479 
2480 module_param_call(clock, uvc_clock_param_set, uvc_clock_param_get,
2481 		  &uvc_clock_param, S_IRUGO|S_IWUSR);
2482 MODULE_PARM_DESC(clock, "Video buffers timestamp clock");
2483 module_param_named(hwtimestamps, uvc_hw_timestamps_param, uint, S_IRUGO|S_IWUSR);
2484 MODULE_PARM_DESC(hwtimestamps, "Use hardware timestamps");
2485 module_param_named(nodrop, uvc_no_drop_param, uint, S_IRUGO|S_IWUSR);
2486 MODULE_PARM_DESC(nodrop, "Don't drop incomplete frames");
2487 module_param_named(quirks, uvc_quirks_param, uint, S_IRUGO|S_IWUSR);
2488 MODULE_PARM_DESC(quirks, "Forced device quirks");
2489 module_param_named(trace, uvc_trace_param, uint, S_IRUGO|S_IWUSR);
2490 MODULE_PARM_DESC(trace, "Trace level bitmask");
2491 module_param_named(timeout, uvc_timeout_param, uint, S_IRUGO|S_IWUSR);
2492 MODULE_PARM_DESC(timeout, "Streaming control requests timeout");
2493 
2494 /* ------------------------------------------------------------------------
2495  * Driver initialization and cleanup
2496  */
2497 
2498 static const struct uvc_device_info uvc_quirk_probe_minmax = {
2499 	.quirks = UVC_QUIRK_PROBE_MINMAX,
2500 };
2501 
2502 static const struct uvc_device_info uvc_quirk_fix_bandwidth = {
2503 	.quirks = UVC_QUIRK_FIX_BANDWIDTH,
2504 };
2505 
2506 static const struct uvc_device_info uvc_quirk_probe_def = {
2507 	.quirks = UVC_QUIRK_PROBE_DEF,
2508 };
2509 
2510 static const struct uvc_device_info uvc_quirk_stream_no_fid = {
2511 	.quirks = UVC_QUIRK_STREAM_NO_FID,
2512 };
2513 
2514 static const struct uvc_device_info uvc_quirk_force_y8 = {
2515 	.quirks = UVC_QUIRK_FORCE_Y8,
2516 };
2517 
2518 #define UVC_INFO_QUIRK(q) (kernel_ulong_t)&(struct uvc_device_info){.quirks = q}
2519 #define UVC_INFO_META(m) (kernel_ulong_t)&(struct uvc_device_info) \
2520 	{.meta_format = m}
2521 
2522 /*
2523  * The Logitech cameras listed below have their interface class set to
2524  * VENDOR_SPEC because they don't announce themselves as UVC devices, even
2525  * though they are compliant.
2526  */
2527 static const struct usb_device_id uvc_ids[] = {
2528 	/* LogiLink Wireless Webcam */
2529 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2530 				| USB_DEVICE_ID_MATCH_INT_INFO,
2531 	  .idVendor		= 0x0416,
2532 	  .idProduct		= 0xa91a,
2533 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2534 	  .bInterfaceSubClass	= 1,
2535 	  .bInterfaceProtocol	= 0,
2536 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2537 	/* Genius eFace 2025 */
2538 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2539 				| USB_DEVICE_ID_MATCH_INT_INFO,
2540 	  .idVendor		= 0x0458,
2541 	  .idProduct		= 0x706e,
2542 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2543 	  .bInterfaceSubClass	= 1,
2544 	  .bInterfaceProtocol	= 0,
2545 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2546 	/* Microsoft Lifecam NX-6000 */
2547 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2548 				| USB_DEVICE_ID_MATCH_INT_INFO,
2549 	  .idVendor		= 0x045e,
2550 	  .idProduct		= 0x00f8,
2551 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2552 	  .bInterfaceSubClass	= 1,
2553 	  .bInterfaceProtocol	= 0,
2554 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2555 	/* Microsoft Lifecam NX-3000 */
2556 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2557 				| USB_DEVICE_ID_MATCH_INT_INFO,
2558 	  .idVendor		= 0x045e,
2559 	  .idProduct		= 0x0721,
2560 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2561 	  .bInterfaceSubClass	= 1,
2562 	  .bInterfaceProtocol	= 0,
2563 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_def },
2564 	/* Microsoft Lifecam VX-7000 */
2565 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2566 				| USB_DEVICE_ID_MATCH_INT_INFO,
2567 	  .idVendor		= 0x045e,
2568 	  .idProduct		= 0x0723,
2569 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2570 	  .bInterfaceSubClass	= 1,
2571 	  .bInterfaceProtocol	= 0,
2572 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2573 	/* Logitech, Webcam C910 */
2574 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2575 				| USB_DEVICE_ID_MATCH_INT_INFO,
2576 	  .idVendor		= 0x046d,
2577 	  .idProduct		= 0x0821,
2578 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2579 	  .bInterfaceSubClass	= 1,
2580 	  .bInterfaceProtocol	= 0,
2581 	  .driver_info		= UVC_INFO_QUIRK(UVC_QUIRK_WAKE_AUTOSUSPEND)},
2582 	/* Logitech, Webcam B910 */
2583 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2584 				| USB_DEVICE_ID_MATCH_INT_INFO,
2585 	  .idVendor		= 0x046d,
2586 	  .idProduct		= 0x0823,
2587 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2588 	  .bInterfaceSubClass	= 1,
2589 	  .bInterfaceProtocol	= 0,
2590 	  .driver_info		= UVC_INFO_QUIRK(UVC_QUIRK_WAKE_AUTOSUSPEND)},
2591 	/* Logitech Quickcam Fusion */
2592 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2593 				| USB_DEVICE_ID_MATCH_INT_INFO,
2594 	  .idVendor		= 0x046d,
2595 	  .idProduct		= 0x08c1,
2596 	  .bInterfaceClass	= USB_CLASS_VENDOR_SPEC,
2597 	  .bInterfaceSubClass	= 1,
2598 	  .bInterfaceProtocol	= 0 },
2599 	/* Logitech Quickcam Orbit MP */
2600 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2601 				| USB_DEVICE_ID_MATCH_INT_INFO,
2602 	  .idVendor		= 0x046d,
2603 	  .idProduct		= 0x08c2,
2604 	  .bInterfaceClass	= USB_CLASS_VENDOR_SPEC,
2605 	  .bInterfaceSubClass	= 1,
2606 	  .bInterfaceProtocol	= 0 },
2607 	/* Logitech Quickcam Pro for Notebook */
2608 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2609 				| USB_DEVICE_ID_MATCH_INT_INFO,
2610 	  .idVendor		= 0x046d,
2611 	  .idProduct		= 0x08c3,
2612 	  .bInterfaceClass	= USB_CLASS_VENDOR_SPEC,
2613 	  .bInterfaceSubClass	= 1,
2614 	  .bInterfaceProtocol	= 0 },
2615 	/* Logitech Quickcam Pro 5000 */
2616 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2617 				| USB_DEVICE_ID_MATCH_INT_INFO,
2618 	  .idVendor		= 0x046d,
2619 	  .idProduct		= 0x08c5,
2620 	  .bInterfaceClass	= USB_CLASS_VENDOR_SPEC,
2621 	  .bInterfaceSubClass	= 1,
2622 	  .bInterfaceProtocol	= 0 },
2623 	/* Logitech Quickcam OEM Dell Notebook */
2624 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2625 				| USB_DEVICE_ID_MATCH_INT_INFO,
2626 	  .idVendor		= 0x046d,
2627 	  .idProduct		= 0x08c6,
2628 	  .bInterfaceClass	= USB_CLASS_VENDOR_SPEC,
2629 	  .bInterfaceSubClass	= 1,
2630 	  .bInterfaceProtocol	= 0 },
2631 	/* Logitech Quickcam OEM Cisco VT Camera II */
2632 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2633 				| USB_DEVICE_ID_MATCH_INT_INFO,
2634 	  .idVendor		= 0x046d,
2635 	  .idProduct		= 0x08c7,
2636 	  .bInterfaceClass	= USB_CLASS_VENDOR_SPEC,
2637 	  .bInterfaceSubClass	= 1,
2638 	  .bInterfaceProtocol	= 0 },
2639 	/* Logitech HD Pro Webcam C920 */
2640 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2641 				| USB_DEVICE_ID_MATCH_INT_INFO,
2642 	  .idVendor		= 0x046d,
2643 	  .idProduct		= 0x082d,
2644 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2645 	  .bInterfaceSubClass	= 1,
2646 	  .bInterfaceProtocol	= 0,
2647 	  .driver_info		= UVC_INFO_QUIRK(UVC_QUIRK_RESTORE_CTRLS_ON_INIT) },
2648 	/* Chicony CNF7129 (Asus EEE 100HE) */
2649 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2650 				| USB_DEVICE_ID_MATCH_INT_INFO,
2651 	  .idVendor		= 0x04f2,
2652 	  .idProduct		= 0xb071,
2653 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2654 	  .bInterfaceSubClass	= 1,
2655 	  .bInterfaceProtocol	= 0,
2656 	  .driver_info		= UVC_INFO_QUIRK(UVC_QUIRK_RESTRICT_FRAME_RATE) },
2657 	/* Alcor Micro AU3820 (Future Boy PC USB Webcam) */
2658 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2659 				| USB_DEVICE_ID_MATCH_INT_INFO,
2660 	  .idVendor		= 0x058f,
2661 	  .idProduct		= 0x3820,
2662 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2663 	  .bInterfaceSubClass	= 1,
2664 	  .bInterfaceProtocol	= 0,
2665 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2666 	/* Dell XPS m1530 */
2667 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2668 				| USB_DEVICE_ID_MATCH_INT_INFO,
2669 	  .idVendor		= 0x05a9,
2670 	  .idProduct		= 0x2640,
2671 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2672 	  .bInterfaceSubClass	= 1,
2673 	  .bInterfaceProtocol	= 0,
2674 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_def },
2675 	/* Dell SP2008WFP Monitor */
2676 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2677 				| USB_DEVICE_ID_MATCH_INT_INFO,
2678 	  .idVendor		= 0x05a9,
2679 	  .idProduct		= 0x2641,
2680 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2681 	  .bInterfaceSubClass	= 1,
2682 	  .bInterfaceProtocol	= 0,
2683 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_def },
2684 	/* Dell Alienware X51 */
2685 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2686 				| USB_DEVICE_ID_MATCH_INT_INFO,
2687 	  .idVendor		= 0x05a9,
2688 	  .idProduct		= 0x2643,
2689 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2690 	  .bInterfaceSubClass	= 1,
2691 	  .bInterfaceProtocol	= 0,
2692 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_def },
2693 	/* Dell Studio Hybrid 140g (OmniVision webcam) */
2694 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2695 				| USB_DEVICE_ID_MATCH_INT_INFO,
2696 	  .idVendor		= 0x05a9,
2697 	  .idProduct		= 0x264a,
2698 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2699 	  .bInterfaceSubClass	= 1,
2700 	  .bInterfaceProtocol	= 0,
2701 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_def },
2702 	/* Dell XPS M1330 (OmniVision OV7670 webcam) */
2703 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2704 				| USB_DEVICE_ID_MATCH_INT_INFO,
2705 	  .idVendor		= 0x05a9,
2706 	  .idProduct		= 0x7670,
2707 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2708 	  .bInterfaceSubClass	= 1,
2709 	  .bInterfaceProtocol	= 0,
2710 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_def },
2711 	/* Apple Built-In iSight */
2712 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2713 				| USB_DEVICE_ID_MATCH_INT_INFO,
2714 	  .idVendor		= 0x05ac,
2715 	  .idProduct		= 0x8501,
2716 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2717 	  .bInterfaceSubClass	= 1,
2718 	  .bInterfaceProtocol	= 0,
2719 	  .driver_info		= UVC_INFO_QUIRK(UVC_QUIRK_PROBE_MINMAX
2720 					| UVC_QUIRK_BUILTIN_ISIGHT) },
2721 	/* Apple Built-In iSight via iBridge */
2722 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2723 				| USB_DEVICE_ID_MATCH_INT_INFO,
2724 	  .idVendor		= 0x05ac,
2725 	  .idProduct		= 0x8600,
2726 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2727 	  .bInterfaceSubClass	= 1,
2728 	  .bInterfaceProtocol	= 0,
2729 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_def },
2730 	/* Foxlink ("HP Webcam" on HP Mini 5103) */
2731 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2732 				| USB_DEVICE_ID_MATCH_INT_INFO,
2733 	  .idVendor		= 0x05c8,
2734 	  .idProduct		= 0x0403,
2735 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2736 	  .bInterfaceSubClass	= 1,
2737 	  .bInterfaceProtocol	= 0,
2738 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_fix_bandwidth },
2739 	/* Genesys Logic USB 2.0 PC Camera */
2740 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2741 				| USB_DEVICE_ID_MATCH_INT_INFO,
2742 	  .idVendor		= 0x05e3,
2743 	  .idProduct		= 0x0505,
2744 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2745 	  .bInterfaceSubClass	= 1,
2746 	  .bInterfaceProtocol	= 0,
2747 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_stream_no_fid },
2748 	/* Hercules Classic Silver */
2749 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2750 				| USB_DEVICE_ID_MATCH_INT_INFO,
2751 	  .idVendor		= 0x06f8,
2752 	  .idProduct		= 0x300c,
2753 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2754 	  .bInterfaceSubClass	= 1,
2755 	  .bInterfaceProtocol	= 0,
2756 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_fix_bandwidth },
2757 	/* ViMicro Vega */
2758 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2759 				| USB_DEVICE_ID_MATCH_INT_INFO,
2760 	  .idVendor		= 0x0ac8,
2761 	  .idProduct		= 0x332d,
2762 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2763 	  .bInterfaceSubClass	= 1,
2764 	  .bInterfaceProtocol	= 0,
2765 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_fix_bandwidth },
2766 	/* ViMicro - Minoru3D */
2767 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2768 				| USB_DEVICE_ID_MATCH_INT_INFO,
2769 	  .idVendor		= 0x0ac8,
2770 	  .idProduct		= 0x3410,
2771 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2772 	  .bInterfaceSubClass	= 1,
2773 	  .bInterfaceProtocol	= 0,
2774 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_fix_bandwidth },
2775 	/* ViMicro Venus - Minoru3D */
2776 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2777 				| USB_DEVICE_ID_MATCH_INT_INFO,
2778 	  .idVendor		= 0x0ac8,
2779 	  .idProduct		= 0x3420,
2780 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2781 	  .bInterfaceSubClass	= 1,
2782 	  .bInterfaceProtocol	= 0,
2783 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_fix_bandwidth },
2784 	/* Ophir Optronics - SPCAM 620U */
2785 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2786 				| USB_DEVICE_ID_MATCH_INT_INFO,
2787 	  .idVendor		= 0x0bd3,
2788 	  .idProduct		= 0x0555,
2789 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2790 	  .bInterfaceSubClass	= 1,
2791 	  .bInterfaceProtocol	= 0,
2792 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2793 	/* MT6227 */
2794 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2795 				| USB_DEVICE_ID_MATCH_INT_INFO,
2796 	  .idVendor		= 0x0e8d,
2797 	  .idProduct		= 0x0004,
2798 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2799 	  .bInterfaceSubClass	= 1,
2800 	  .bInterfaceProtocol	= 0,
2801 	  .driver_info		= UVC_INFO_QUIRK(UVC_QUIRK_PROBE_MINMAX
2802 					| UVC_QUIRK_PROBE_DEF) },
2803 	/* IMC Networks (Medion Akoya) */
2804 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2805 				| USB_DEVICE_ID_MATCH_INT_INFO,
2806 	  .idVendor		= 0x13d3,
2807 	  .idProduct		= 0x5103,
2808 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2809 	  .bInterfaceSubClass	= 1,
2810 	  .bInterfaceProtocol	= 0,
2811 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_stream_no_fid },
2812 	/* JMicron USB2.0 XGA WebCam */
2813 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2814 				| USB_DEVICE_ID_MATCH_INT_INFO,
2815 	  .idVendor		= 0x152d,
2816 	  .idProduct		= 0x0310,
2817 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2818 	  .bInterfaceSubClass	= 1,
2819 	  .bInterfaceProtocol	= 0,
2820 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2821 	/* Syntek (HP Spartan) */
2822 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2823 				| USB_DEVICE_ID_MATCH_INT_INFO,
2824 	  .idVendor		= 0x174f,
2825 	  .idProduct		= 0x5212,
2826 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2827 	  .bInterfaceSubClass	= 1,
2828 	  .bInterfaceProtocol	= 0,
2829 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_stream_no_fid },
2830 	/* Syntek (Samsung Q310) */
2831 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2832 				| USB_DEVICE_ID_MATCH_INT_INFO,
2833 	  .idVendor		= 0x174f,
2834 	  .idProduct		= 0x5931,
2835 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2836 	  .bInterfaceSubClass	= 1,
2837 	  .bInterfaceProtocol	= 0,
2838 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_stream_no_fid },
2839 	/* Syntek (Packard Bell EasyNote MX52 */
2840 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2841 				| USB_DEVICE_ID_MATCH_INT_INFO,
2842 	  .idVendor		= 0x174f,
2843 	  .idProduct		= 0x8a12,
2844 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2845 	  .bInterfaceSubClass	= 1,
2846 	  .bInterfaceProtocol	= 0,
2847 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_stream_no_fid },
2848 	/* Syntek (Asus F9SG) */
2849 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2850 				| USB_DEVICE_ID_MATCH_INT_INFO,
2851 	  .idVendor		= 0x174f,
2852 	  .idProduct		= 0x8a31,
2853 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2854 	  .bInterfaceSubClass	= 1,
2855 	  .bInterfaceProtocol	= 0,
2856 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_stream_no_fid },
2857 	/* Syntek (Asus U3S) */
2858 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2859 				| USB_DEVICE_ID_MATCH_INT_INFO,
2860 	  .idVendor		= 0x174f,
2861 	  .idProduct		= 0x8a33,
2862 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2863 	  .bInterfaceSubClass	= 1,
2864 	  .bInterfaceProtocol	= 0,
2865 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_stream_no_fid },
2866 	/* Syntek (JAOtech Smart Terminal) */
2867 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2868 				| USB_DEVICE_ID_MATCH_INT_INFO,
2869 	  .idVendor		= 0x174f,
2870 	  .idProduct		= 0x8a34,
2871 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2872 	  .bInterfaceSubClass	= 1,
2873 	  .bInterfaceProtocol	= 0,
2874 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_stream_no_fid },
2875 	/* Miricle 307K */
2876 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2877 				| USB_DEVICE_ID_MATCH_INT_INFO,
2878 	  .idVendor		= 0x17dc,
2879 	  .idProduct		= 0x0202,
2880 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2881 	  .bInterfaceSubClass	= 1,
2882 	  .bInterfaceProtocol	= 0,
2883 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_stream_no_fid },
2884 	/* Lenovo Thinkpad SL400/SL500 */
2885 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2886 				| USB_DEVICE_ID_MATCH_INT_INFO,
2887 	  .idVendor		= 0x17ef,
2888 	  .idProduct		= 0x480b,
2889 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2890 	  .bInterfaceSubClass	= 1,
2891 	  .bInterfaceProtocol	= 0,
2892 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_stream_no_fid },
2893 	/* Aveo Technology USB 2.0 Camera */
2894 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2895 				| USB_DEVICE_ID_MATCH_INT_INFO,
2896 	  .idVendor		= 0x1871,
2897 	  .idProduct		= 0x0306,
2898 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2899 	  .bInterfaceSubClass	= 1,
2900 	  .bInterfaceProtocol	= 0,
2901 	  .driver_info		= UVC_INFO_QUIRK(UVC_QUIRK_PROBE_MINMAX
2902 					| UVC_QUIRK_PROBE_EXTRAFIELDS) },
2903 	/* Aveo Technology USB 2.0 Camera (Tasco USB Microscope) */
2904 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2905 				| USB_DEVICE_ID_MATCH_INT_INFO,
2906 	  .idVendor		= 0x1871,
2907 	  .idProduct		= 0x0516,
2908 	  .bInterfaceClass	= USB_CLASS_VENDOR_SPEC,
2909 	  .bInterfaceSubClass	= 1,
2910 	  .bInterfaceProtocol	= 0 },
2911 	/* Ecamm Pico iMage */
2912 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2913 				| USB_DEVICE_ID_MATCH_INT_INFO,
2914 	  .idVendor		= 0x18cd,
2915 	  .idProduct		= 0xcafe,
2916 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2917 	  .bInterfaceSubClass	= 1,
2918 	  .bInterfaceProtocol	= 0,
2919 	  .driver_info		= UVC_INFO_QUIRK(UVC_QUIRK_PROBE_EXTRAFIELDS) },
2920 	/* Manta MM-353 Plako */
2921 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2922 				| USB_DEVICE_ID_MATCH_INT_INFO,
2923 	  .idVendor		= 0x18ec,
2924 	  .idProduct		= 0x3188,
2925 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2926 	  .bInterfaceSubClass	= 1,
2927 	  .bInterfaceProtocol	= 0,
2928 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2929 	/* FSC WebCam V30S */
2930 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2931 				| USB_DEVICE_ID_MATCH_INT_INFO,
2932 	  .idVendor		= 0x18ec,
2933 	  .idProduct		= 0x3288,
2934 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2935 	  .bInterfaceSubClass	= 1,
2936 	  .bInterfaceProtocol	= 0,
2937 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2938 	/* Arkmicro unbranded */
2939 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2940 				| USB_DEVICE_ID_MATCH_INT_INFO,
2941 	  .idVendor		= 0x18ec,
2942 	  .idProduct		= 0x3290,
2943 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2944 	  .bInterfaceSubClass	= 1,
2945 	  .bInterfaceProtocol	= 0,
2946 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_def },
2947 	/* The Imaging Source USB CCD cameras */
2948 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2949 				| USB_DEVICE_ID_MATCH_INT_INFO,
2950 	  .idVendor		= 0x199e,
2951 	  .idProduct		= 0x8102,
2952 	  .bInterfaceClass	= USB_CLASS_VENDOR_SPEC,
2953 	  .bInterfaceSubClass	= 1,
2954 	  .bInterfaceProtocol	= 0 },
2955 	/* Bodelin ProScopeHR */
2956 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2957 				| USB_DEVICE_ID_MATCH_DEV_HI
2958 				| USB_DEVICE_ID_MATCH_INT_INFO,
2959 	  .idVendor		= 0x19ab,
2960 	  .idProduct		= 0x1000,
2961 	  .bcdDevice_hi		= 0x0126,
2962 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2963 	  .bInterfaceSubClass	= 1,
2964 	  .bInterfaceProtocol	= 0,
2965 	  .driver_info		= UVC_INFO_QUIRK(UVC_QUIRK_STATUS_INTERVAL) },
2966 	/* MSI StarCam 370i */
2967 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2968 				| USB_DEVICE_ID_MATCH_INT_INFO,
2969 	  .idVendor		= 0x1b3b,
2970 	  .idProduct		= 0x2951,
2971 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2972 	  .bInterfaceSubClass	= 1,
2973 	  .bInterfaceProtocol	= 0,
2974 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2975 	/* Generalplus Technology Inc. 808 Camera */
2976 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2977 				| USB_DEVICE_ID_MATCH_INT_INFO,
2978 	  .idVendor		= 0x1b3f,
2979 	  .idProduct		= 0x2002,
2980 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2981 	  .bInterfaceSubClass	= 1,
2982 	  .bInterfaceProtocol	= 0,
2983 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_probe_minmax },
2984 	/* SiGma Micro USB Web Camera */
2985 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2986 				| USB_DEVICE_ID_MATCH_INT_INFO,
2987 	  .idVendor		= 0x1c4f,
2988 	  .idProduct		= 0x3000,
2989 	  .bInterfaceClass	= USB_CLASS_VIDEO,
2990 	  .bInterfaceSubClass	= 1,
2991 	  .bInterfaceProtocol	= 0,
2992 	  .driver_info		= UVC_INFO_QUIRK(UVC_QUIRK_PROBE_MINMAX
2993 					| UVC_QUIRK_IGNORE_SELECTOR_UNIT) },
2994 	/* Oculus VR Positional Tracker DK2 */
2995 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
2996 				| USB_DEVICE_ID_MATCH_INT_INFO,
2997 	  .idVendor		= 0x2833,
2998 	  .idProduct		= 0x0201,
2999 	  .bInterfaceClass	= USB_CLASS_VIDEO,
3000 	  .bInterfaceSubClass	= 1,
3001 	  .bInterfaceProtocol	= 0,
3002 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_force_y8 },
3003 	/* Oculus VR Rift Sensor */
3004 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
3005 				| USB_DEVICE_ID_MATCH_INT_INFO,
3006 	  .idVendor		= 0x2833,
3007 	  .idProduct		= 0x0211,
3008 	  .bInterfaceClass	= USB_CLASS_VENDOR_SPEC,
3009 	  .bInterfaceSubClass	= 1,
3010 	  .bInterfaceProtocol	= 0,
3011 	  .driver_info		= (kernel_ulong_t)&uvc_quirk_force_y8 },
3012 	/* GEO Semiconductor GC6500 */
3013 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
3014 				| USB_DEVICE_ID_MATCH_INT_INFO,
3015 	  .idVendor		= 0x29fe,
3016 	  .idProduct		= 0x4d53,
3017 	  .bInterfaceClass	= USB_CLASS_VIDEO,
3018 	  .bInterfaceSubClass	= 1,
3019 	  .bInterfaceProtocol	= 0,
3020 	  .driver_info		= UVC_INFO_QUIRK(UVC_QUIRK_FORCE_BPP) },
3021 	/* Intel RealSense D4M */
3022 	{ .match_flags		= USB_DEVICE_ID_MATCH_DEVICE
3023 				| USB_DEVICE_ID_MATCH_INT_INFO,
3024 	  .idVendor		= 0x8086,
3025 	  .idProduct		= 0x0b03,
3026 	  .bInterfaceClass	= USB_CLASS_VIDEO,
3027 	  .bInterfaceSubClass	= 1,
3028 	  .bInterfaceProtocol	= 0,
3029 	  .driver_info		= UVC_INFO_META(V4L2_META_FMT_D4XX) },
3030 	/* Generic USB Video Class */
3031 	{ USB_INTERFACE_INFO(USB_CLASS_VIDEO, 1, UVC_PC_PROTOCOL_UNDEFINED) },
3032 	{ USB_INTERFACE_INFO(USB_CLASS_VIDEO, 1, UVC_PC_PROTOCOL_15) },
3033 	{}
3034 };
3035 
3036 MODULE_DEVICE_TABLE(usb, uvc_ids);
3037 
3038 struct uvc_driver uvc_driver = {
3039 	.driver = {
3040 		.name		= "uvcvideo",
3041 		.probe		= uvc_probe,
3042 		.disconnect	= uvc_disconnect,
3043 		.suspend	= uvc_suspend,
3044 		.resume		= uvc_resume,
3045 		.reset_resume	= uvc_reset_resume,
3046 		.id_table	= uvc_ids,
3047 		.supports_autosuspend = 1,
3048 	},
3049 };
3050 
uvc_init(void)3051 static int __init uvc_init(void)
3052 {
3053 	int ret;
3054 
3055 	uvc_debugfs_init();
3056 
3057 	ret = usb_register(&uvc_driver.driver);
3058 	if (ret < 0) {
3059 		uvc_debugfs_cleanup();
3060 		return ret;
3061 	}
3062 
3063 	printk(KERN_INFO DRIVER_DESC " (" DRIVER_VERSION ")\n");
3064 	return 0;
3065 }
3066 
uvc_cleanup(void)3067 static void __exit uvc_cleanup(void)
3068 {
3069 	usb_deregister(&uvc_driver.driver);
3070 	uvc_debugfs_cleanup();
3071 }
3072 
3073 module_init(uvc_init);
3074 module_exit(uvc_cleanup);
3075 
3076 MODULE_AUTHOR(DRIVER_AUTHOR);
3077 MODULE_DESCRIPTION(DRIVER_DESC);
3078 MODULE_LICENSE("GPL");
3079 MODULE_VERSION(DRIVER_VERSION);
3080 
3081