2 * uvc_driver.c -- USB Video Class driver
4 * Copyright (C) 2005-2008
5 * Laurent Pinchart (laurent.pinchart@skynet.be)
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
15 * This driver aims to support video input and ouput devices compliant with the
16 * 'USB Video Class' specification.
18 * The driver doesn't support the deprecated v4l1 interface. It implements the
19 * mmap capture method only, and doesn't do any image format conversion in
20 * software. If your user-space application doesn't support YUYV or MJPEG, fix
21 * it :-). Please note that the MJPEG data have been stripped from their
22 * Huffman tables (DHT marker), you will need to add it back if your JPEG
23 * codec can't handle MJPEG data.
26 #include <linux/kernel.h>
27 #include <linux/version.h>
28 #include <linux/list.h>
29 #include <linux/module.h>
30 #include <linux/usb.h>
31 #include <linux/videodev2.h>
32 #include <linux/vmalloc.h>
33 #include <linux/wait.h>
34 #include <asm/atomic.h>
35 #include <asm/unaligned.h>
37 #include <media/v4l2-common.h>
41 #define DRIVER_AUTHOR "Laurent Pinchart <laurent.pinchart@skynet.be>"
42 #define DRIVER_DESC "USB Video Class driver"
43 #ifndef DRIVER_VERSION
44 #define DRIVER_VERSION "v0.1.0"
47 unsigned int uvc_no_drop_param;
48 static unsigned int uvc_quirks_param;
49 unsigned int uvc_trace_param;
51 /* ------------------------------------------------------------------------
52 * Control, formats, ...
55 static struct uvc_format_desc uvc_fmts[] = {
57 .name = "YUV 4:2:2 (YUYV)",
58 .guid = UVC_GUID_FORMAT_YUY2,
59 .fcc = V4L2_PIX_FMT_YUYV,
62 .name = "YUV 4:2:0 (NV12)",
63 .guid = UVC_GUID_FORMAT_NV12,
64 .fcc = V4L2_PIX_FMT_NV12,
68 .guid = UVC_GUID_FORMAT_MJPEG,
69 .fcc = V4L2_PIX_FMT_MJPEG,
72 .name = "YVU 4:2:0 (YV12)",
73 .guid = UVC_GUID_FORMAT_YV12,
74 .fcc = V4L2_PIX_FMT_YVU420,
77 .name = "YUV 4:2:0 (I420)",
78 .guid = UVC_GUID_FORMAT_I420,
79 .fcc = V4L2_PIX_FMT_YUV420,
82 .name = "YUV 4:2:2 (UYVY)",
83 .guid = UVC_GUID_FORMAT_UYVY,
84 .fcc = V4L2_PIX_FMT_UYVY,
88 .guid = UVC_GUID_FORMAT_Y800,
89 .fcc = V4L2_PIX_FMT_GREY,
93 .guid = UVC_GUID_FORMAT_BY8,
94 .fcc = V4L2_PIX_FMT_SBGGR8,
98 /* ------------------------------------------------------------------------
102 struct usb_host_endpoint *uvc_find_endpoint(struct usb_host_interface *alts,
105 struct usb_host_endpoint *ep;
108 for (i = 0; i < alts->desc.bNumEndpoints; ++i) {
109 ep = &alts->endpoint[i];
110 if (ep->desc.bEndpointAddress == epaddr)
117 static struct uvc_format_desc *uvc_format_by_guid(const __u8 guid[16])
119 unsigned int len = ARRAY_SIZE(uvc_fmts);
122 for (i = 0; i < len; ++i) {
123 if (memcmp(guid, uvc_fmts[i].guid, 16) == 0)
130 static __u32 uvc_colorspace(const __u8 primaries)
132 static const __u8 colorprimaries[] = {
134 V4L2_COLORSPACE_SRGB,
135 V4L2_COLORSPACE_470_SYSTEM_M,
136 V4L2_COLORSPACE_470_SYSTEM_BG,
137 V4L2_COLORSPACE_SMPTE170M,
138 V4L2_COLORSPACE_SMPTE240M,
141 if (primaries < ARRAY_SIZE(colorprimaries))
142 return colorprimaries[primaries];
147 /* Simplify a fraction using a simple continued fraction decomposition. The
148 * idea here is to convert fractions such as 333333/10000000 to 1/30 using
149 * 32 bit arithmetic only. The algorithm is not perfect and relies upon two
150 * arbitrary parameters to remove non-significative terms from the simple
151 * continued fraction decomposition. Using 8 and 333 for n_terms and threshold
152 * respectively seems to give nice results.
154 void uvc_simplify_fraction(uint32_t *numerator, uint32_t *denominator,
155 unsigned int n_terms, unsigned int threshold)
161 an = kmalloc(n_terms * sizeof *an, GFP_KERNEL);
165 /* Convert the fraction to a simple continued fraction. See
166 * http://mathforum.org/dr.math/faq/faq.fractions.html
167 * Stop if the current term is bigger than or equal to the given
173 for (n = 0; n < n_terms && y != 0; ++n) {
175 if (an[n] >= threshold) {
186 /* Expand the simple continued fraction back to an integer fraction. */
190 for (i = n; i > 0; --i) {
201 /* Convert a fraction to a frame interval in 100ns multiples. The idea here is
202 * to compute numerator / denominator * 10000000 using 32 bit fixed point
205 uint32_t uvc_fraction_to_interval(uint32_t numerator, uint32_t denominator)
209 /* Saturate the result if the operation would overflow. */
210 if (denominator == 0 ||
211 numerator/denominator >= ((uint32_t)-1)/10000000)
214 /* Divide both the denominator and the multiplier by two until
215 * numerator * multiplier doesn't overflow. If anyone knows a better
216 * algorithm please let me know.
218 multiplier = 10000000;
219 while (numerator > ((uint32_t)-1)/multiplier) {
224 return denominator ? numerator * multiplier / denominator : 0;
227 /* ------------------------------------------------------------------------
228 * Terminal and unit management
231 static struct uvc_entity *uvc_entity_by_id(struct uvc_device *dev, int id)
233 struct uvc_entity *entity;
235 list_for_each_entry(entity, &dev->entities, list) {
236 if (entity->id == id)
243 static struct uvc_entity *uvc_entity_by_reference(struct uvc_device *dev,
244 int id, struct uvc_entity *entity)
249 entity = list_entry(&dev->entities, struct uvc_entity, list);
251 list_for_each_entry_continue(entity, &dev->entities, list) {
252 switch (UVC_ENTITY_TYPE(entity)) {
254 if (entity->output.bSourceID == id)
258 case VC_PROCESSING_UNIT:
259 if (entity->processing.bSourceID == id)
263 case VC_SELECTOR_UNIT:
264 for (i = 0; i < entity->selector.bNrInPins; ++i)
265 if (entity->selector.baSourceID[i] == id)
269 case VC_EXTENSION_UNIT:
270 for (i = 0; i < entity->extension.bNrInPins; ++i)
271 if (entity->extension.baSourceID[i] == id)
280 /* ------------------------------------------------------------------------
281 * Descriptors handling
284 static int uvc_parse_format(struct uvc_device *dev,
285 struct uvc_streaming *streaming, struct uvc_format *format,
286 __u32 **intervals, unsigned char *buffer, int buflen)
288 struct usb_interface *intf = streaming->intf;
289 struct usb_host_interface *alts = intf->cur_altsetting;
290 struct uvc_format_desc *fmtdesc;
291 struct uvc_frame *frame;
292 const unsigned char *start = buffer;
293 unsigned char *_buffer;
294 unsigned int interval;
299 format->type = buffer[2];
300 format->index = buffer[3];
303 case VS_FORMAT_UNCOMPRESSED:
304 case VS_FORMAT_FRAME_BASED:
305 n = buffer[2] == VS_FORMAT_UNCOMPRESSED ? 27 : 28;
307 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming"
308 "interface %d FORMAT error\n",
310 alts->desc.bInterfaceNumber);
314 /* Find the format descriptor from its GUID. */
315 fmtdesc = uvc_format_by_guid(&buffer[5]);
317 if (fmtdesc != NULL) {
318 strncpy(format->name, fmtdesc->name,
319 sizeof format->name);
320 format->fcc = fmtdesc->fcc;
322 uvc_printk(KERN_INFO, "Unknown video format "
323 UVC_GUID_FORMAT "\n",
324 UVC_GUID_ARGS(&buffer[5]));
325 snprintf(format->name, sizeof format->name,
326 UVC_GUID_FORMAT, UVC_GUID_ARGS(&buffer[5]));
330 format->bpp = buffer[21];
331 if (buffer[2] == VS_FORMAT_UNCOMPRESSED) {
332 ftype = VS_FRAME_UNCOMPRESSED;
334 ftype = VS_FRAME_FRAME_BASED;
336 format->flags = UVC_FMT_FLAG_COMPRESSED;
340 case VS_FORMAT_MJPEG:
342 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming"
343 "interface %d FORMAT error\n",
345 alts->desc.bInterfaceNumber);
349 strncpy(format->name, "MJPEG", sizeof format->name);
350 format->fcc = V4L2_PIX_FMT_MJPEG;
351 format->flags = UVC_FMT_FLAG_COMPRESSED;
353 ftype = VS_FRAME_MJPEG;
358 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming"
359 "interface %d FORMAT error\n",
361 alts->desc.bInterfaceNumber);
365 switch (buffer[8] & 0x7f) {
367 strncpy(format->name, "SD-DV", sizeof format->name);
370 strncpy(format->name, "SDL-DV", sizeof format->name);
373 strncpy(format->name, "HD-DV", sizeof format->name);
376 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming"
377 "interface %d: unknown DV format %u\n",
379 alts->desc.bInterfaceNumber, buffer[8]);
383 strncat(format->name, buffer[8] & (1 << 7) ? " 60Hz" : " 50Hz",
384 sizeof format->name);
386 format->fcc = V4L2_PIX_FMT_DV;
387 format->flags = UVC_FMT_FLAG_COMPRESSED | UVC_FMT_FLAG_STREAM;
391 /* Create a dummy frame descriptor. */
392 frame = &format->frame[0];
393 memset(&format->frame[0], 0, sizeof format->frame[0]);
394 frame->bFrameIntervalType = 1;
395 frame->dwDefaultFrameInterval = 1;
396 frame->dwFrameInterval = *intervals;
401 case VS_FORMAT_MPEG2TS:
402 case VS_FORMAT_STREAM_BASED:
403 /* Not supported yet. */
405 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming"
406 "interface %d unsupported format %u\n",
407 dev->udev->devnum, alts->desc.bInterfaceNumber,
412 uvc_trace(UVC_TRACE_DESCR, "Found format %s.\n", format->name);
417 /* Count the number of frame descriptors to test the bFrameIndex
418 * field when parsing the descriptors. We can't rely on the
419 * bNumFrameDescriptors field as some cameras don't initialize it
422 for (_buflen = buflen, _buffer = buffer;
423 _buflen > 2 && _buffer[2] == ftype;
424 _buflen -= _buffer[0], _buffer += _buffer[0])
427 /* Parse the frame descriptors. Only uncompressed, MJPEG and frame
428 * based formats have frame descriptors.
430 while (buflen > 2 && buffer[2] == ftype) {
431 if (ftype != VS_FRAME_FRAME_BASED)
432 n = buflen > 25 ? buffer[25] : 0;
434 n = buflen > 21 ? buffer[21] : 0;
438 if (buflen < 26 + 4*n) {
439 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming"
440 "interface %d FRAME error\n", dev->udev->devnum,
441 alts->desc.bInterfaceNumber);
445 if (buffer[3] - 1 >= format->nframes) {
446 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming"
447 "interface %d frame index %u out of range\n",
448 dev->udev->devnum, alts->desc.bInterfaceNumber,
453 frame = &format->frame[buffer[3] - 1];
455 frame->bFrameIndex = buffer[3];
456 frame->bmCapabilities = buffer[4];
457 frame->wWidth = get_unaligned_le16(&buffer[5]);
458 frame->wHeight = get_unaligned_le16(&buffer[7]);
459 frame->dwMinBitRate = get_unaligned_le32(&buffer[9]);
460 frame->dwMaxBitRate = get_unaligned_le32(&buffer[13]);
461 if (ftype != VS_FRAME_FRAME_BASED) {
462 frame->dwMaxVideoFrameBufferSize =
463 get_unaligned_le32(&buffer[17]);
464 frame->dwDefaultFrameInterval =
465 get_unaligned_le32(&buffer[21]);
466 frame->bFrameIntervalType = buffer[25];
468 frame->dwMaxVideoFrameBufferSize = 0;
469 frame->dwDefaultFrameInterval =
470 get_unaligned_le32(&buffer[17]);
471 frame->bFrameIntervalType = buffer[21];
473 frame->dwFrameInterval = *intervals;
475 /* Several UVC chipsets screw up dwMaxVideoFrameBufferSize
476 * completely. Observed behaviours range from setting the
477 * value to 1.1x the actual frame size of hardwiring the
478 * 16 low bits to 0. This results in a higher than necessary
479 * memory usage as well as a wrong image size information. For
480 * uncompressed formats this can be fixed by computing the
481 * value from the frame size.
483 if (!(format->flags & UVC_FMT_FLAG_COMPRESSED))
484 frame->dwMaxVideoFrameBufferSize = format->bpp
485 * frame->wWidth * frame->wHeight / 8;
487 /* Some bogus devices report dwMinFrameInterval equal to
488 * dwMaxFrameInterval and have dwFrameIntervalStep set to
489 * zero. Setting all null intervals to 1 fixes the problem and
490 * some other divisions by zero which could happen.
492 for (i = 0; i < n; ++i) {
493 interval = get_unaligned_le32(&buffer[26+4*i]);
494 *(*intervals)++ = interval ? interval : 1;
497 /* Make sure that the default frame interval stays between
500 n -= frame->bFrameIntervalType ? 1 : 2;
501 frame->dwDefaultFrameInterval =
502 min(frame->dwFrameInterval[n],
503 max(frame->dwFrameInterval[0],
504 frame->dwDefaultFrameInterval));
506 uvc_trace(UVC_TRACE_DESCR, "- %ux%u (%u.%u fps)\n",
507 frame->wWidth, frame->wHeight,
508 10000000/frame->dwDefaultFrameInterval,
509 (100000000/frame->dwDefaultFrameInterval)%10);
515 if (buflen > 2 && buffer[2] == VS_STILL_IMAGE_FRAME) {
520 if (buflen > 2 && buffer[2] == VS_COLORFORMAT) {
522 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming"
523 "interface %d COLORFORMAT error\n",
525 alts->desc.bInterfaceNumber);
529 format->colorspace = uvc_colorspace(buffer[3]);
535 return buffer - start;
538 static int uvc_parse_streaming(struct uvc_device *dev,
539 struct usb_interface *intf)
541 struct uvc_streaming *streaming = NULL;
542 struct uvc_format *format;
543 struct uvc_frame *frame;
544 struct usb_host_interface *alts = &intf->altsetting[0];
545 unsigned char *_buffer, *buffer = alts->extra;
546 int _buflen, buflen = alts->extralen;
547 unsigned int nformats = 0, nframes = 0, nintervals = 0;
548 unsigned int size, i, n, p;
553 if (intf->cur_altsetting->desc.bInterfaceSubClass
554 != SC_VIDEOSTREAMING) {
555 uvc_trace(UVC_TRACE_DESCR, "device %d interface %d isn't a "
556 "video streaming interface\n", dev->udev->devnum,
557 intf->altsetting[0].desc.bInterfaceNumber);
561 if (usb_driver_claim_interface(&uvc_driver.driver, intf, dev)) {
562 uvc_trace(UVC_TRACE_DESCR, "device %d interface %d is already "
563 "claimed\n", dev->udev->devnum,
564 intf->altsetting[0].desc.bInterfaceNumber);
568 streaming = kzalloc(sizeof *streaming, GFP_KERNEL);
569 if (streaming == NULL) {
570 usb_driver_release_interface(&uvc_driver.driver, intf);
574 mutex_init(&streaming->mutex);
575 streaming->intf = usb_get_intf(intf);
576 streaming->intfnum = intf->cur_altsetting->desc.bInterfaceNumber;
578 /* The Pico iMage webcam has its class-specific interface descriptors
579 * after the endpoint descriptors.
582 for (i = 0; i < alts->desc.bNumEndpoints; ++i) {
583 struct usb_host_endpoint *ep = &alts->endpoint[i];
585 if (ep->extralen == 0)
588 if (ep->extralen > 2 &&
589 ep->extra[1] == USB_DT_CS_INTERFACE) {
590 uvc_trace(UVC_TRACE_DESCR, "trying extra data "
591 "from endpoint %u.\n", i);
592 buffer = alts->endpoint[i].extra;
593 buflen = alts->endpoint[i].extralen;
599 /* Skip the standard interface descriptors. */
600 while (buflen > 2 && buffer[1] != USB_DT_CS_INTERFACE) {
606 uvc_trace(UVC_TRACE_DESCR, "no class-specific streaming "
607 "interface descriptors found.\n");
611 /* Parse the header descriptor. */
613 case VS_OUTPUT_HEADER:
614 streaming->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
618 case VS_INPUT_HEADER:
619 streaming->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
624 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming interface "
625 "%d HEADER descriptor not found.\n", dev->udev->devnum,
626 alts->desc.bInterfaceNumber);
630 p = buflen >= 4 ? buffer[3] : 0;
631 n = buflen >= size ? buffer[size-1] : 0;
633 if (buflen < size + p*n) {
634 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
635 "interface %d HEADER descriptor is invalid.\n",
636 dev->udev->devnum, alts->desc.bInterfaceNumber);
640 streaming->header.bNumFormats = p;
641 streaming->header.bEndpointAddress = buffer[6];
642 if (buffer[2] == VS_INPUT_HEADER) {
643 streaming->header.bmInfo = buffer[7];
644 streaming->header.bTerminalLink = buffer[8];
645 streaming->header.bStillCaptureMethod = buffer[9];
646 streaming->header.bTriggerSupport = buffer[10];
647 streaming->header.bTriggerUsage = buffer[11];
649 streaming->header.bTerminalLink = buffer[7];
651 streaming->header.bControlSize = n;
653 streaming->header.bmaControls = kmalloc(p*n, GFP_KERNEL);
654 if (streaming->header.bmaControls == NULL) {
659 memcpy(streaming->header.bmaControls, &buffer[size], p*n);
667 /* Count the format and frame descriptors. */
668 while (_buflen > 2) {
669 switch (_buffer[2]) {
670 case VS_FORMAT_UNCOMPRESSED:
671 case VS_FORMAT_MJPEG:
672 case VS_FORMAT_FRAME_BASED:
677 /* DV format has no frame descriptor. We will create a
678 * dummy frame descriptor with a dummy frame interval.
685 case VS_FORMAT_MPEG2TS:
686 case VS_FORMAT_STREAM_BASED:
687 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
688 "interface %d FORMAT %u is not supported.\n",
690 alts->desc.bInterfaceNumber, _buffer[2]);
693 case VS_FRAME_UNCOMPRESSED:
697 nintervals += _buffer[25] ? _buffer[25] : 3;
700 case VS_FRAME_FRAME_BASED:
703 nintervals += _buffer[21] ? _buffer[21] : 3;
707 _buflen -= _buffer[0];
708 _buffer += _buffer[0];
712 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming interface "
713 "%d has no supported formats defined.\n",
714 dev->udev->devnum, alts->desc.bInterfaceNumber);
718 size = nformats * sizeof *format + nframes * sizeof *frame
719 + nintervals * sizeof *interval;
720 format = kzalloc(size, GFP_KERNEL);
721 if (format == NULL) {
726 frame = (struct uvc_frame *)&format[nformats];
727 interval = (__u32 *)&frame[nframes];
729 streaming->format = format;
730 streaming->nformats = nformats;
732 /* Parse the format descriptors. */
735 case VS_FORMAT_UNCOMPRESSED:
736 case VS_FORMAT_MJPEG:
738 case VS_FORMAT_FRAME_BASED:
739 format->frame = frame;
740 ret = uvc_parse_format(dev, streaming, format,
741 &interval, buffer, buflen);
745 frame += format->nframes;
760 /* Parse the alternate settings to find the maximum bandwidth. */
761 for (i = 0; i < intf->num_altsetting; ++i) {
762 struct usb_host_endpoint *ep;
763 alts = &intf->altsetting[i];
764 ep = uvc_find_endpoint(alts,
765 streaming->header.bEndpointAddress);
769 psize = le16_to_cpu(ep->desc.wMaxPacketSize);
770 psize = (psize & 0x07ff) * (1 + ((psize >> 11) & 3));
771 if (psize > streaming->maxpsize)
772 streaming->maxpsize = psize;
775 list_add_tail(&streaming->list, &dev->streaming);
779 usb_driver_release_interface(&uvc_driver.driver, intf);
781 kfree(streaming->format);
782 kfree(streaming->header.bmaControls);
787 /* Parse vendor-specific extensions. */
788 static int uvc_parse_vendor_control(struct uvc_device *dev,
789 const unsigned char *buffer, int buflen)
791 struct usb_device *udev = dev->udev;
792 struct usb_host_interface *alts = dev->intf->cur_altsetting;
793 struct uvc_entity *unit;
797 switch (le16_to_cpu(dev->udev->descriptor.idVendor)) {
798 case 0x046d: /* Logitech */
799 if (buffer[1] != 0x41 || buffer[2] != 0x01)
802 /* Logitech implements several vendor specific functions
803 * through vendor specific extension units (LXU).
805 * The LXU descriptors are similar to XU descriptors
806 * (see "USB Device Video Class for Video Devices", section
807 * 3.7.2.6 "Extension Unit Descriptor") with the following
810 * ----------------------------------------------------------
812 * Size of this descriptor, in bytes: 24+p+n*2
813 * ----------------------------------------------------------
814 * 23+p+n bmControlsType N Bitmap
815 * Individual bits in the set are defined:
819 * This bitset is mapped exactly the same as bmControls.
820 * ----------------------------------------------------------
821 * 23+p+n*2 bReserved 1 Boolean
822 * ----------------------------------------------------------
823 * 24+p+n*2 iExtension 1 Index
824 * Index of a string descriptor that describes this
826 * ----------------------------------------------------------
828 p = buflen >= 22 ? buffer[21] : 0;
829 n = buflen >= 25 + p ? buffer[22+p] : 0;
831 if (buflen < 25 + p + 2*n) {
832 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
833 "interface %d EXTENSION_UNIT error\n",
834 udev->devnum, alts->desc.bInterfaceNumber);
838 unit = kzalloc(sizeof *unit + p + 2*n, GFP_KERNEL);
842 unit->id = buffer[3];
843 unit->type = VC_EXTENSION_UNIT;
844 memcpy(unit->extension.guidExtensionCode, &buffer[4], 16);
845 unit->extension.bNumControls = buffer[20];
846 unit->extension.bNrInPins = get_unaligned_le16(&buffer[21]);
847 unit->extension.baSourceID = (__u8 *)unit + sizeof *unit;
848 memcpy(unit->extension.baSourceID, &buffer[22], p);
849 unit->extension.bControlSize = buffer[22+p];
850 unit->extension.bmControls = (__u8 *)unit + sizeof *unit + p;
851 unit->extension.bmControlsType = (__u8 *)unit + sizeof *unit
853 memcpy(unit->extension.bmControls, &buffer[23+p], 2*n);
855 if (buffer[24+p+2*n] != 0)
856 usb_string(udev, buffer[24+p+2*n], unit->name,
859 sprintf(unit->name, "Extension %u", buffer[3]);
861 list_add_tail(&unit->list, &dev->entities);
869 static int uvc_parse_standard_control(struct uvc_device *dev,
870 const unsigned char *buffer, int buflen)
872 struct usb_device *udev = dev->udev;
873 struct uvc_entity *unit, *term;
874 struct usb_interface *intf;
875 struct usb_host_interface *alts = dev->intf->cur_altsetting;
876 unsigned int i, n, p, len;
881 n = buflen >= 12 ? buffer[11] : 0;
883 if (buflen < 12 || buflen < 12 + n) {
884 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
885 "interface %d HEADER error\n", udev->devnum,
886 alts->desc.bInterfaceNumber);
890 dev->uvc_version = get_unaligned_le16(&buffer[3]);
891 dev->clock_frequency = get_unaligned_le32(&buffer[7]);
893 /* Parse all USB Video Streaming interfaces. */
894 for (i = 0; i < n; ++i) {
895 intf = usb_ifnum_to_if(udev, buffer[12+i]);
897 uvc_trace(UVC_TRACE_DESCR, "device %d "
898 "interface %d doesn't exists\n",
903 uvc_parse_streaming(dev, intf);
907 case VC_INPUT_TERMINAL:
909 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
910 "interface %d INPUT_TERMINAL error\n",
911 udev->devnum, alts->desc.bInterfaceNumber);
915 /* Make sure the terminal type MSB is not null, otherwise it
916 * could be confused with a unit.
918 type = get_unaligned_le16(&buffer[4]);
919 if ((type & 0xff00) == 0) {
920 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
921 "interface %d INPUT_TERMINAL %d has invalid "
922 "type 0x%04x, skipping\n", udev->devnum,
923 alts->desc.bInterfaceNumber,
932 if (type == ITT_CAMERA) {
933 n = buflen >= 15 ? buffer[14] : 0;
936 } else if (type == ITT_MEDIA_TRANSPORT_INPUT) {
937 n = buflen >= 9 ? buffer[8] : 0;
938 p = buflen >= 10 + n ? buffer[9+n] : 0;
942 if (buflen < len + n + p) {
943 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
944 "interface %d INPUT_TERMINAL error\n",
945 udev->devnum, alts->desc.bInterfaceNumber);
949 term = kzalloc(sizeof *term + n + p, GFP_KERNEL);
953 term->id = buffer[3];
954 term->type = type | UVC_TERM_INPUT;
956 if (UVC_ENTITY_TYPE(term) == ITT_CAMERA) {
957 term->camera.bControlSize = n;
958 term->camera.bmControls = (__u8 *)term + sizeof *term;
959 term->camera.wObjectiveFocalLengthMin =
960 get_unaligned_le16(&buffer[8]);
961 term->camera.wObjectiveFocalLengthMax =
962 get_unaligned_le16(&buffer[10]);
963 term->camera.wOcularFocalLength =
964 get_unaligned_le16(&buffer[12]);
965 memcpy(term->camera.bmControls, &buffer[15], n);
966 } else if (UVC_ENTITY_TYPE(term) == ITT_MEDIA_TRANSPORT_INPUT) {
967 term->media.bControlSize = n;
968 term->media.bmControls = (__u8 *)term + sizeof *term;
969 term->media.bTransportModeSize = p;
970 term->media.bmTransportModes = (__u8 *)term
972 memcpy(term->media.bmControls, &buffer[9], n);
973 memcpy(term->media.bmTransportModes, &buffer[10+n], p);
977 usb_string(udev, buffer[7], term->name,
979 else if (UVC_ENTITY_TYPE(term) == ITT_CAMERA)
980 sprintf(term->name, "Camera %u", buffer[3]);
981 else if (UVC_ENTITY_TYPE(term) == ITT_MEDIA_TRANSPORT_INPUT)
982 sprintf(term->name, "Media %u", buffer[3]);
984 sprintf(term->name, "Input %u", buffer[3]);
986 list_add_tail(&term->list, &dev->entities);
989 case VC_OUTPUT_TERMINAL:
991 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
992 "interface %d OUTPUT_TERMINAL error\n",
993 udev->devnum, alts->desc.bInterfaceNumber);
997 /* Make sure the terminal type MSB is not null, otherwise it
998 * could be confused with a unit.
1000 type = get_unaligned_le16(&buffer[4]);
1001 if ((type & 0xff00) == 0) {
1002 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1003 "interface %d OUTPUT_TERMINAL %d has invalid "
1004 "type 0x%04x, skipping\n", udev->devnum,
1005 alts->desc.bInterfaceNumber, buffer[3], type);
1009 term = kzalloc(sizeof *term, GFP_KERNEL);
1013 term->id = buffer[3];
1014 term->type = type | UVC_TERM_OUTPUT;
1015 term->output.bSourceID = buffer[7];
1018 usb_string(udev, buffer[8], term->name,
1021 sprintf(term->name, "Output %u", buffer[3]);
1023 list_add_tail(&term->list, &dev->entities);
1026 case VC_SELECTOR_UNIT:
1027 p = buflen >= 5 ? buffer[4] : 0;
1029 if (buflen < 5 || buflen < 6 + p) {
1030 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1031 "interface %d SELECTOR_UNIT error\n",
1032 udev->devnum, alts->desc.bInterfaceNumber);
1036 unit = kzalloc(sizeof *unit + p, GFP_KERNEL);
1040 unit->id = buffer[3];
1041 unit->type = buffer[2];
1042 unit->selector.bNrInPins = buffer[4];
1043 unit->selector.baSourceID = (__u8 *)unit + sizeof *unit;
1044 memcpy(unit->selector.baSourceID, &buffer[5], p);
1046 if (buffer[5+p] != 0)
1047 usb_string(udev, buffer[5+p], unit->name,
1050 sprintf(unit->name, "Selector %u", buffer[3]);
1052 list_add_tail(&unit->list, &dev->entities);
1055 case VC_PROCESSING_UNIT:
1056 n = buflen >= 8 ? buffer[7] : 0;
1057 p = dev->uvc_version >= 0x0110 ? 10 : 9;
1059 if (buflen < p + n) {
1060 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1061 "interface %d PROCESSING_UNIT error\n",
1062 udev->devnum, alts->desc.bInterfaceNumber);
1066 unit = kzalloc(sizeof *unit + n, GFP_KERNEL);
1070 unit->id = buffer[3];
1071 unit->type = buffer[2];
1072 unit->processing.bSourceID = buffer[4];
1073 unit->processing.wMaxMultiplier =
1074 get_unaligned_le16(&buffer[5]);
1075 unit->processing.bControlSize = buffer[7];
1076 unit->processing.bmControls = (__u8 *)unit + sizeof *unit;
1077 memcpy(unit->processing.bmControls, &buffer[8], n);
1078 if (dev->uvc_version >= 0x0110)
1079 unit->processing.bmVideoStandards = buffer[9+n];
1081 if (buffer[8+n] != 0)
1082 usb_string(udev, buffer[8+n], unit->name,
1085 sprintf(unit->name, "Processing %u", buffer[3]);
1087 list_add_tail(&unit->list, &dev->entities);
1090 case VC_EXTENSION_UNIT:
1091 p = buflen >= 22 ? buffer[21] : 0;
1092 n = buflen >= 24 + p ? buffer[22+p] : 0;
1094 if (buflen < 24 + p + n) {
1095 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1096 "interface %d EXTENSION_UNIT error\n",
1097 udev->devnum, alts->desc.bInterfaceNumber);
1101 unit = kzalloc(sizeof *unit + p + n, GFP_KERNEL);
1105 unit->id = buffer[3];
1106 unit->type = buffer[2];
1107 memcpy(unit->extension.guidExtensionCode, &buffer[4], 16);
1108 unit->extension.bNumControls = buffer[20];
1109 unit->extension.bNrInPins = get_unaligned_le16(&buffer[21]);
1110 unit->extension.baSourceID = (__u8 *)unit + sizeof *unit;
1111 memcpy(unit->extension.baSourceID, &buffer[22], p);
1112 unit->extension.bControlSize = buffer[22+p];
1113 unit->extension.bmControls = (__u8 *)unit + sizeof *unit + p;
1114 memcpy(unit->extension.bmControls, &buffer[23+p], n);
1116 if (buffer[23+p+n] != 0)
1117 usb_string(udev, buffer[23+p+n], unit->name,
1120 sprintf(unit->name, "Extension %u", buffer[3]);
1122 list_add_tail(&unit->list, &dev->entities);
1126 uvc_trace(UVC_TRACE_DESCR, "Found an unknown CS_INTERFACE "
1127 "descriptor (%u)\n", buffer[2]);
1134 static int uvc_parse_control(struct uvc_device *dev)
1136 struct usb_host_interface *alts = dev->intf->cur_altsetting;
1137 unsigned char *buffer = alts->extra;
1138 int buflen = alts->extralen;
1141 /* Parse the default alternate setting only, as the UVC specification
1142 * defines a single alternate setting, the default alternate setting
1146 while (buflen > 2) {
1147 if (uvc_parse_vendor_control(dev, buffer, buflen) ||
1148 buffer[1] != USB_DT_CS_INTERFACE)
1149 goto next_descriptor;
1151 if ((ret = uvc_parse_standard_control(dev, buffer, buflen)) < 0)
1155 buflen -= buffer[0];
1156 buffer += buffer[0];
1159 /* Check if the optional status endpoint is present. Built-in iSight
1160 * webcams have an interrupt endpoint but spit proprietary data that
1161 * don't conform to the UVC status endpoint messages. Don't try to
1162 * handle the interrupt endpoint for those cameras.
1164 if (alts->desc.bNumEndpoints == 1 &&
1165 !(dev->quirks & UVC_QUIRK_BUILTIN_ISIGHT)) {
1166 struct usb_host_endpoint *ep = &alts->endpoint[0];
1167 struct usb_endpoint_descriptor *desc = &ep->desc;
1169 if (usb_endpoint_is_int_in(desc) &&
1170 le16_to_cpu(desc->wMaxPacketSize) >= 8 &&
1171 desc->bInterval != 0) {
1172 uvc_trace(UVC_TRACE_DESCR, "Found a Status endpoint "
1173 "(addr %02x).\n", desc->bEndpointAddress);
1181 /* ------------------------------------------------------------------------
1182 * USB probe and disconnect
1186 * Unregister the video devices.
1188 static void uvc_unregister_video(struct uvc_device *dev)
1190 if (dev->video.vdev) {
1191 if (dev->video.vdev->minor == -1)
1192 video_device_release(dev->video.vdev);
1194 video_unregister_device(dev->video.vdev);
1195 dev->video.vdev = NULL;
1200 * Scan the UVC descriptors to locate a chain starting at an Output Terminal
1201 * and containing the following units:
1203 * - a USB Streaming Output Terminal
1204 * - zero or one Processing Unit
1205 * - zero, one or mode single-input Selector Units
1206 * - zero or one multiple-input Selector Units, provided all inputs are
1207 * connected to input terminals
1208 * - zero, one or mode single-input Extension Units
1209 * - one Camera Input Terminal, or one or more External terminals.
1211 * A side forward scan is made on each detected entity to check for additional
1214 static int uvc_scan_chain_entity(struct uvc_video_device *video,
1215 struct uvc_entity *entity)
1217 switch (UVC_ENTITY_TYPE(entity)) {
1218 case VC_EXTENSION_UNIT:
1219 if (uvc_trace_param & UVC_TRACE_PROBE)
1220 printk(" <- XU %d", entity->id);
1222 if (entity->extension.bNrInPins != 1) {
1223 uvc_trace(UVC_TRACE_DESCR, "Extension unit %d has more "
1224 "than 1 input pin.\n", entity->id);
1228 list_add_tail(&entity->chain, &video->extensions);
1231 case VC_PROCESSING_UNIT:
1232 if (uvc_trace_param & UVC_TRACE_PROBE)
1233 printk(" <- PU %d", entity->id);
1235 if (video->processing != NULL) {
1236 uvc_trace(UVC_TRACE_DESCR, "Found multiple "
1237 "Processing Units in chain.\n");
1241 video->processing = entity;
1244 case VC_SELECTOR_UNIT:
1245 if (uvc_trace_param & UVC_TRACE_PROBE)
1246 printk(" <- SU %d", entity->id);
1248 /* Single-input selector units are ignored. */
1249 if (entity->selector.bNrInPins == 1)
1252 if (video->selector != NULL) {
1253 uvc_trace(UVC_TRACE_DESCR, "Found multiple Selector "
1254 "Units in chain.\n");
1258 video->selector = entity;
1261 case ITT_VENDOR_SPECIFIC:
1263 case ITT_MEDIA_TRANSPORT_INPUT:
1264 if (uvc_trace_param & UVC_TRACE_PROBE)
1265 printk(" <- IT %d\n", entity->id);
1267 list_add_tail(&entity->chain, &video->iterms);
1271 if (uvc_trace_param & UVC_TRACE_PROBE)
1272 printk(" <- IT %d\n", entity->id);
1274 if (!UVC_ENTITY_IS_ITERM(entity)) {
1275 uvc_trace(UVC_TRACE_DESCR, "Unsupported input "
1276 "terminal %u.\n", entity->id);
1280 if (video->sterm != NULL) {
1281 uvc_trace(UVC_TRACE_DESCR, "Found multiple streaming "
1282 "entities in chain.\n");
1286 list_add_tail(&entity->chain, &video->iterms);
1287 video->sterm = entity;
1291 uvc_trace(UVC_TRACE_DESCR, "Unsupported entity type "
1292 "0x%04x found in chain.\n", UVC_ENTITY_TYPE(entity));
1299 static int uvc_scan_chain_forward(struct uvc_video_device *video,
1300 struct uvc_entity *entity, struct uvc_entity *prev)
1302 struct uvc_entity *forward;
1310 forward = uvc_entity_by_reference(video->dev, entity->id,
1312 if (forward == NULL)
1315 if (UVC_ENTITY_TYPE(forward) != VC_EXTENSION_UNIT ||
1319 if (forward->extension.bNrInPins != 1) {
1320 uvc_trace(UVC_TRACE_DESCR, "Extension unit %d has"
1321 "more than 1 input pin.\n", entity->id);
1325 list_add_tail(&forward->chain, &video->extensions);
1326 if (uvc_trace_param & UVC_TRACE_PROBE) {
1330 printk(" %d", forward->id);
1340 static int uvc_scan_chain_backward(struct uvc_video_device *video,
1341 struct uvc_entity *entity)
1343 struct uvc_entity *term;
1346 switch (UVC_ENTITY_TYPE(entity)) {
1347 case VC_EXTENSION_UNIT:
1348 id = entity->extension.baSourceID[0];
1351 case VC_PROCESSING_UNIT:
1352 id = entity->processing.bSourceID;
1355 case VC_SELECTOR_UNIT:
1356 /* Single-input selector units are ignored. */
1357 if (entity->selector.bNrInPins == 1) {
1358 id = entity->selector.baSourceID[0];
1362 if (uvc_trace_param & UVC_TRACE_PROBE)
1365 video->selector = entity;
1366 for (i = 0; i < entity->selector.bNrInPins; ++i) {
1367 id = entity->selector.baSourceID[i];
1368 term = uvc_entity_by_id(video->dev, id);
1369 if (term == NULL || !UVC_ENTITY_IS_ITERM(term)) {
1370 uvc_trace(UVC_TRACE_DESCR, "Selector unit %d "
1371 "input %d isn't connected to an "
1372 "input terminal\n", entity->id, i);
1376 if (uvc_trace_param & UVC_TRACE_PROBE)
1377 printk(" %d", term->id);
1379 list_add_tail(&term->chain, &video->iterms);
1380 uvc_scan_chain_forward(video, term, entity);
1383 if (uvc_trace_param & UVC_TRACE_PROBE)
1393 static int uvc_scan_chain(struct uvc_video_device *video)
1395 struct uvc_entity *entity, *prev;
1398 entity = video->oterm;
1399 uvc_trace(UVC_TRACE_PROBE, "Scanning UVC chain: OT %d", entity->id);
1401 if (UVC_ENTITY_TYPE(entity) == TT_STREAMING)
1402 video->sterm = entity;
1404 id = entity->output.bSourceID;
1407 entity = uvc_entity_by_id(video->dev, id);
1408 if (entity == NULL) {
1409 uvc_trace(UVC_TRACE_DESCR, "Found reference to "
1410 "unknown entity %d.\n", id);
1414 /* Process entity */
1415 if (uvc_scan_chain_entity(video, entity) < 0)
1419 if (uvc_scan_chain_forward(video, entity, prev) < 0)
1422 /* Stop when a terminal is found. */
1423 if (!UVC_ENTITY_IS_UNIT(entity))
1427 id = uvc_scan_chain_backward(video, entity);
1432 if (video->sterm == NULL) {
1433 uvc_trace(UVC_TRACE_DESCR, "No streaming entity found in "
1442 * Register the video devices.
1444 * The driver currently supports a single video device per control interface
1445 * only. The terminal and units must match the following structure:
1447 * ITT_* -> VC_PROCESSING_UNIT -> VC_EXTENSION_UNIT{0,n} -> TT_STREAMING
1448 * TT_STREAMING -> VC_PROCESSING_UNIT -> VC_EXTENSION_UNIT{0,n} -> OTT_*
1450 * The Extension Units, if present, must have a single input pin. The
1451 * Processing Unit and Extension Units can be in any order. Additional
1452 * Extension Units connected to the main chain as single-unit branches are
1455 static int uvc_register_video(struct uvc_device *dev)
1457 struct video_device *vdev;
1458 struct uvc_entity *term;
1461 /* Check if the control interface matches the structure we expect. */
1462 list_for_each_entry(term, &dev->entities, list) {
1463 struct uvc_streaming *streaming;
1465 if (!UVC_ENTITY_IS_TERM(term) || !UVC_ENTITY_IS_OTERM(term))
1468 memset(&dev->video, 0, sizeof dev->video);
1469 mutex_init(&dev->video.ctrl_mutex);
1470 INIT_LIST_HEAD(&dev->video.iterms);
1471 INIT_LIST_HEAD(&dev->video.extensions);
1472 dev->video.oterm = term;
1473 dev->video.dev = dev;
1474 if (uvc_scan_chain(&dev->video) < 0)
1477 list_for_each_entry(streaming, &dev->streaming, list) {
1478 if (streaming->header.bTerminalLink ==
1479 dev->video.sterm->id) {
1480 dev->video.streaming = streaming;
1491 uvc_printk(KERN_INFO, "No valid video chain found.\n");
1495 if (uvc_trace_param & UVC_TRACE_PROBE) {
1496 uvc_printk(KERN_INFO, "Found a valid video chain (");
1497 list_for_each_entry(term, &dev->video.iterms, chain) {
1498 printk("%d", term->id);
1499 if (term->chain.next != &dev->video.iterms)
1502 printk(" -> %d).\n", dev->video.oterm->id);
1505 /* Initialize the video buffers queue. */
1506 uvc_queue_init(&dev->video.queue, dev->video.streaming->type);
1508 /* Initialize the streaming interface with default streaming
1511 if ((ret = uvc_video_init(&dev->video)) < 0) {
1512 uvc_printk(KERN_ERR, "Failed to initialize the device "
1517 /* Register the device with V4L. */
1518 vdev = video_device_alloc();
1522 /* We already hold a reference to dev->udev. The video device will be
1523 * unregistered before the reference is released, so we don't need to
1526 vdev->parent = &dev->intf->dev;
1528 vdev->fops = &uvc_fops;
1529 vdev->release = video_device_release;
1530 strncpy(vdev->name, dev->name, sizeof vdev->name);
1532 /* Set the driver data before calling video_register_device, otherwise
1533 * uvc_v4l2_open might race us.
1535 * FIXME: usb_set_intfdata hasn't been called so far. Is that a
1536 * problem ? Does any function which could be called here get
1537 * a pointer to the usb_interface ?
1539 dev->video.vdev = vdev;
1540 video_set_drvdata(vdev, &dev->video);
1542 if (video_register_device(vdev, VFL_TYPE_GRABBER, -1) < 0) {
1543 dev->video.vdev = NULL;
1544 video_device_release(vdev);
1552 * Delete the UVC device.
1554 * Called by the kernel when the last reference to the uvc_device structure
1557 * Unregistering the video devices is done here because every opened instance
1558 * must be closed before the device can be unregistered. An alternative would
1559 * have been to use another reference count for uvc_v4l2_open/uvc_release, and
1560 * unregister the video devices on disconnect when that reference count drops
1563 * As this function is called after or during disconnect(), all URBs have
1564 * already been canceled by the USB core. There is no need to kill the
1565 * interrupt URB manually.
1567 void uvc_delete(struct kref *kref)
1569 struct uvc_device *dev = container_of(kref, struct uvc_device, kref);
1570 struct list_head *p, *n;
1572 /* Unregister the video device */
1573 uvc_unregister_video(dev);
1574 usb_put_intf(dev->intf);
1575 usb_put_dev(dev->udev);
1577 uvc_status_cleanup(dev);
1578 uvc_ctrl_cleanup_device(dev);
1580 list_for_each_safe(p, n, &dev->entities) {
1581 struct uvc_entity *entity;
1582 entity = list_entry(p, struct uvc_entity, list);
1586 list_for_each_safe(p, n, &dev->streaming) {
1587 struct uvc_streaming *streaming;
1588 streaming = list_entry(p, struct uvc_streaming, list);
1589 usb_driver_release_interface(&uvc_driver.driver,
1591 usb_put_intf(streaming->intf);
1592 kfree(streaming->format);
1593 kfree(streaming->header.bmaControls);
1600 static int uvc_probe(struct usb_interface *intf,
1601 const struct usb_device_id *id)
1603 struct usb_device *udev = interface_to_usbdev(intf);
1604 struct uvc_device *dev;
1607 if (id->idVendor && id->idProduct)
1608 uvc_trace(UVC_TRACE_PROBE, "Probing known UVC device %s "
1609 "(%04x:%04x)\n", udev->devpath, id->idVendor,
1612 uvc_trace(UVC_TRACE_PROBE, "Probing generic UVC device %s\n",
1615 /* Allocate memory for the device and initialize it */
1616 if ((dev = kzalloc(sizeof *dev, GFP_KERNEL)) == NULL)
1619 INIT_LIST_HEAD(&dev->entities);
1620 INIT_LIST_HEAD(&dev->streaming);
1621 kref_init(&dev->kref);
1623 dev->udev = usb_get_dev(udev);
1624 dev->intf = usb_get_intf(intf);
1625 dev->intfnum = intf->cur_altsetting->desc.bInterfaceNumber;
1626 dev->quirks = id->driver_info | uvc_quirks_param;
1628 if (udev->product != NULL)
1629 strncpy(dev->name, udev->product, sizeof dev->name);
1631 snprintf(dev->name, sizeof dev->name,
1632 "UVC Camera (%04x:%04x)",
1633 le16_to_cpu(udev->descriptor.idVendor),
1634 le16_to_cpu(udev->descriptor.idProduct));
1636 /* Parse the Video Class control descriptor */
1637 if (uvc_parse_control(dev) < 0) {
1638 uvc_trace(UVC_TRACE_PROBE, "Unable to parse UVC "
1643 uvc_printk(KERN_INFO, "Found UVC %u.%02u device %s (%04x:%04x)\n",
1644 dev->uvc_version >> 8, dev->uvc_version & 0xff,
1645 udev->product ? udev->product : "<unnamed>",
1646 le16_to_cpu(udev->descriptor.idVendor),
1647 le16_to_cpu(udev->descriptor.idProduct));
1649 if (uvc_quirks_param != 0) {
1650 uvc_printk(KERN_INFO, "Forcing device quirks 0x%x by module "
1651 "parameter for testing purpose.\n", uvc_quirks_param);
1652 uvc_printk(KERN_INFO, "Please report required quirks to the "
1653 "linux-uvc-devel mailing list.\n");
1656 /* Initialize controls */
1657 if (uvc_ctrl_init_device(dev) < 0)
1660 /* Register the video devices */
1661 if (uvc_register_video(dev) < 0)
1664 /* Save our data pointer in the interface data */
1665 usb_set_intfdata(intf, dev);
1667 /* Initialize the interrupt URB */
1668 if ((ret = uvc_status_init(dev)) < 0) {
1669 uvc_printk(KERN_INFO, "Unable to initialize the status "
1670 "endpoint (%d), status interrupt will not be "
1671 "supported.\n", ret);
1674 uvc_trace(UVC_TRACE_PROBE, "UVC device initialized.\n");
1678 kref_put(&dev->kref, uvc_delete);
1682 static void uvc_disconnect(struct usb_interface *intf)
1684 struct uvc_device *dev = usb_get_intfdata(intf);
1686 /* Set the USB interface data to NULL. This can be done outside the
1687 * lock, as there's no other reader.
1689 usb_set_intfdata(intf, NULL);
1691 if (intf->cur_altsetting->desc.bInterfaceSubClass == SC_VIDEOSTREAMING)
1694 /* uvc_v4l2_open() might race uvc_disconnect(). A static driver-wide
1695 * lock is needed to prevent uvc_disconnect from releasing its
1696 * reference to the uvc_device instance after uvc_v4l2_open() received
1697 * the pointer to the device (video_devdata) but before it got the
1698 * chance to increase the reference count (kref_get).
1700 * Note that the reference can't be released with the lock held,
1701 * otherwise a AB-BA deadlock can occur with videodev_lock that
1702 * videodev acquires in videodev_open() and video_unregister_device().
1704 mutex_lock(&uvc_driver.open_mutex);
1705 dev->state |= UVC_DEV_DISCONNECTED;
1706 mutex_unlock(&uvc_driver.open_mutex);
1708 kref_put(&dev->kref, uvc_delete);
1711 static int uvc_suspend(struct usb_interface *intf, pm_message_t message)
1713 struct uvc_device *dev = usb_get_intfdata(intf);
1715 uvc_trace(UVC_TRACE_SUSPEND, "Suspending interface %u\n",
1716 intf->cur_altsetting->desc.bInterfaceNumber);
1718 /* Controls are cached on the fly so they don't need to be saved. */
1719 if (intf->cur_altsetting->desc.bInterfaceSubClass == SC_VIDEOCONTROL)
1720 return uvc_status_suspend(dev);
1722 if (dev->video.streaming->intf != intf) {
1723 uvc_trace(UVC_TRACE_SUSPEND, "Suspend: video streaming USB "
1724 "interface mismatch.\n");
1728 return uvc_video_suspend(&dev->video);
1731 static int __uvc_resume(struct usb_interface *intf, int reset)
1733 struct uvc_device *dev = usb_get_intfdata(intf);
1736 uvc_trace(UVC_TRACE_SUSPEND, "Resuming interface %u\n",
1737 intf->cur_altsetting->desc.bInterfaceNumber);
1739 if (intf->cur_altsetting->desc.bInterfaceSubClass == SC_VIDEOCONTROL) {
1740 if (reset && (ret = uvc_ctrl_resume_device(dev)) < 0)
1743 return uvc_status_resume(dev);
1746 if (dev->video.streaming->intf != intf) {
1747 uvc_trace(UVC_TRACE_SUSPEND, "Resume: video streaming USB "
1748 "interface mismatch.\n");
1752 return uvc_video_resume(&dev->video);
1755 static int uvc_resume(struct usb_interface *intf)
1757 return __uvc_resume(intf, 0);
1760 static int uvc_reset_resume(struct usb_interface *intf)
1762 return __uvc_resume(intf, 1);
1765 /* ------------------------------------------------------------------------
1766 * Driver initialization and cleanup
1770 * The Logitech cameras listed below have their interface class set to
1771 * VENDOR_SPEC because they don't announce themselves as UVC devices, even
1772 * though they are compliant.
1774 static struct usb_device_id uvc_ids[] = {
1775 /* Microsoft Lifecam NX-6000 */
1776 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1777 | USB_DEVICE_ID_MATCH_INT_INFO,
1779 .idProduct = 0x00f8,
1780 .bInterfaceClass = USB_CLASS_VIDEO,
1781 .bInterfaceSubClass = 1,
1782 .bInterfaceProtocol = 0,
1783 .driver_info = UVC_QUIRK_PROBE_MINMAX },
1784 /* Microsoft Lifecam VX-7000 */
1785 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1786 | USB_DEVICE_ID_MATCH_INT_INFO,
1788 .idProduct = 0x0723,
1789 .bInterfaceClass = USB_CLASS_VIDEO,
1790 .bInterfaceSubClass = 1,
1791 .bInterfaceProtocol = 0,
1792 .driver_info = UVC_QUIRK_PROBE_MINMAX },
1793 /* Logitech Quickcam Fusion */
1794 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1795 | USB_DEVICE_ID_MATCH_INT_INFO,
1797 .idProduct = 0x08c1,
1798 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
1799 .bInterfaceSubClass = 1,
1800 .bInterfaceProtocol = 0 },
1801 /* Logitech Quickcam Orbit MP */
1802 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1803 | USB_DEVICE_ID_MATCH_INT_INFO,
1805 .idProduct = 0x08c2,
1806 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
1807 .bInterfaceSubClass = 1,
1808 .bInterfaceProtocol = 0 },
1809 /* Logitech Quickcam Pro for Notebook */
1810 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1811 | USB_DEVICE_ID_MATCH_INT_INFO,
1813 .idProduct = 0x08c3,
1814 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
1815 .bInterfaceSubClass = 1,
1816 .bInterfaceProtocol = 0 },
1817 /* Logitech Quickcam Pro 5000 */
1818 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1819 | USB_DEVICE_ID_MATCH_INT_INFO,
1821 .idProduct = 0x08c5,
1822 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
1823 .bInterfaceSubClass = 1,
1824 .bInterfaceProtocol = 0 },
1825 /* Logitech Quickcam OEM Dell Notebook */
1826 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1827 | USB_DEVICE_ID_MATCH_INT_INFO,
1829 .idProduct = 0x08c6,
1830 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
1831 .bInterfaceSubClass = 1,
1832 .bInterfaceProtocol = 0 },
1833 /* Logitech Quickcam OEM Cisco VT Camera II */
1834 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1835 | USB_DEVICE_ID_MATCH_INT_INFO,
1837 .idProduct = 0x08c7,
1838 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
1839 .bInterfaceSubClass = 1,
1840 .bInterfaceProtocol = 0 },
1841 /* Apple Built-In iSight */
1842 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1843 | USB_DEVICE_ID_MATCH_INT_INFO,
1845 .idProduct = 0x8501,
1846 .bInterfaceClass = USB_CLASS_VIDEO,
1847 .bInterfaceSubClass = 1,
1848 .bInterfaceProtocol = 0,
1849 .driver_info = UVC_QUIRK_PROBE_MINMAX
1850 | UVC_QUIRK_BUILTIN_ISIGHT },
1851 /* Genesys Logic USB 2.0 PC Camera */
1852 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1853 | USB_DEVICE_ID_MATCH_INT_INFO,
1855 .idProduct = 0x0505,
1856 .bInterfaceClass = USB_CLASS_VIDEO,
1857 .bInterfaceSubClass = 1,
1858 .bInterfaceProtocol = 0,
1859 .driver_info = UVC_QUIRK_STREAM_NO_FID },
1861 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1862 | USB_DEVICE_ID_MATCH_INT_INFO,
1864 .idProduct = 0x0004,
1865 .bInterfaceClass = USB_CLASS_VIDEO,
1866 .bInterfaceSubClass = 1,
1867 .bInterfaceProtocol = 0,
1868 .driver_info = UVC_QUIRK_PROBE_MINMAX },
1869 /* Syntek (HP Spartan) */
1870 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1871 | USB_DEVICE_ID_MATCH_INT_INFO,
1873 .idProduct = 0x5212,
1874 .bInterfaceClass = USB_CLASS_VIDEO,
1875 .bInterfaceSubClass = 1,
1876 .bInterfaceProtocol = 0,
1877 .driver_info = UVC_QUIRK_STREAM_NO_FID },
1878 /* Syntek (Samsung Q310) */
1879 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1880 | USB_DEVICE_ID_MATCH_INT_INFO,
1882 .idProduct = 0x5931,
1883 .bInterfaceClass = USB_CLASS_VIDEO,
1884 .bInterfaceSubClass = 1,
1885 .bInterfaceProtocol = 0,
1886 .driver_info = UVC_QUIRK_STREAM_NO_FID },
1888 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1889 | USB_DEVICE_ID_MATCH_INT_INFO,
1891 .idProduct = 0x8a31,
1892 .bInterfaceClass = USB_CLASS_VIDEO,
1893 .bInterfaceSubClass = 1,
1894 .bInterfaceProtocol = 0,
1895 .driver_info = UVC_QUIRK_STREAM_NO_FID },
1896 /* Syntek (Asus U3S) */
1897 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1898 | USB_DEVICE_ID_MATCH_INT_INFO,
1900 .idProduct = 0x8a33,
1901 .bInterfaceClass = USB_CLASS_VIDEO,
1902 .bInterfaceSubClass = 1,
1903 .bInterfaceProtocol = 0,
1904 .driver_info = UVC_QUIRK_STREAM_NO_FID },
1905 /* Lenovo Thinkpad SL500 */
1906 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1907 | USB_DEVICE_ID_MATCH_INT_INFO,
1909 .idProduct = 0x480b,
1910 .bInterfaceClass = USB_CLASS_VIDEO,
1911 .bInterfaceSubClass = 1,
1912 .bInterfaceProtocol = 0,
1913 .driver_info = UVC_QUIRK_STREAM_NO_FID },
1914 /* Ecamm Pico iMage */
1915 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1916 | USB_DEVICE_ID_MATCH_INT_INFO,
1918 .idProduct = 0xcafe,
1919 .bInterfaceClass = USB_CLASS_VIDEO,
1920 .bInterfaceSubClass = 1,
1921 .bInterfaceProtocol = 0,
1922 .driver_info = UVC_QUIRK_PROBE_EXTRAFIELDS },
1923 /* Bodelin ProScopeHR */
1924 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1925 | USB_DEVICE_ID_MATCH_DEV_HI
1926 | USB_DEVICE_ID_MATCH_INT_INFO,
1928 .idProduct = 0x1000,
1929 .bcdDevice_hi = 0x0126,
1930 .bInterfaceClass = USB_CLASS_VIDEO,
1931 .bInterfaceSubClass = 1,
1932 .bInterfaceProtocol = 0,
1933 .driver_info = UVC_QUIRK_STATUS_INTERVAL },
1934 /* SiGma Micro USB Web Camera */
1935 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1936 | USB_DEVICE_ID_MATCH_INT_INFO,
1938 .idProduct = 0x3000,
1939 .bInterfaceClass = USB_CLASS_VIDEO,
1940 .bInterfaceSubClass = 1,
1941 .bInterfaceProtocol = 0,
1942 .driver_info = UVC_QUIRK_PROBE_MINMAX
1943 | UVC_QUIRK_IGNORE_SELECTOR_UNIT
1944 | UVC_QUIRK_PRUNE_CONTROLS },
1945 /* Generic USB Video Class */
1946 { USB_INTERFACE_INFO(USB_CLASS_VIDEO, 1, 0) },
1950 MODULE_DEVICE_TABLE(usb, uvc_ids);
1952 struct uvc_driver uvc_driver = {
1956 .disconnect = uvc_disconnect,
1957 .suspend = uvc_suspend,
1958 .resume = uvc_resume,
1959 .reset_resume = uvc_reset_resume,
1960 .id_table = uvc_ids,
1961 .supports_autosuspend = 1,
1965 static int __init uvc_init(void)
1969 INIT_LIST_HEAD(&uvc_driver.devices);
1970 INIT_LIST_HEAD(&uvc_driver.controls);
1971 mutex_init(&uvc_driver.open_mutex);
1972 mutex_init(&uvc_driver.ctrl_mutex);
1976 result = usb_register(&uvc_driver.driver);
1978 printk(KERN_INFO DRIVER_DESC " (" DRIVER_VERSION ")\n");
1982 static void __exit uvc_cleanup(void)
1984 usb_deregister(&uvc_driver.driver);
1987 module_init(uvc_init);
1988 module_exit(uvc_cleanup);
1990 module_param_named(nodrop, uvc_no_drop_param, uint, S_IRUGO|S_IWUSR);
1991 MODULE_PARM_DESC(nodrop, "Don't drop incomplete frames");
1992 module_param_named(quirks, uvc_quirks_param, uint, S_IRUGO|S_IWUSR);
1993 MODULE_PARM_DESC(quirks, "Forced device quirks");
1994 module_param_named(trace, uvc_trace_param, uint, S_IRUGO|S_IWUSR);
1995 MODULE_PARM_DESC(trace, "Trace level bitmask");
1997 MODULE_AUTHOR(DRIVER_AUTHOR);
1998 MODULE_DESCRIPTION(DRIVER_DESC);
1999 MODULE_LICENSE("GPL");
2000 MODULE_VERSION(DRIVER_VERSION);