2 * uvc_driver.c -- USB Video Class driver
4 * Copyright (C) 2005-2009
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/list.h>
28 #include <linux/module.h>
29 #include <linux/usb.h>
30 #include <linux/videodev2.h>
31 #include <linux/vmalloc.h>
32 #include <linux/wait.h>
33 #include <asm/atomic.h>
34 #include <asm/unaligned.h>
36 #include <media/v4l2-common.h>
40 #define DRIVER_AUTHOR "Laurent Pinchart <laurent.pinchart@skynet.be>"
41 #define DRIVER_DESC "USB Video Class driver"
42 #ifndef DRIVER_VERSION
43 #define DRIVER_VERSION "v0.1.0"
46 unsigned int uvc_no_drop_param;
47 static unsigned int uvc_quirks_param;
48 unsigned int uvc_trace_param;
50 /* ------------------------------------------------------------------------
54 static struct uvc_format_desc uvc_fmts[] = {
56 .name = "YUV 4:2:2 (YUYV)",
57 .guid = UVC_GUID_FORMAT_YUY2,
58 .fcc = V4L2_PIX_FMT_YUYV,
61 .name = "YUV 4:2:0 (NV12)",
62 .guid = UVC_GUID_FORMAT_NV12,
63 .fcc = V4L2_PIX_FMT_NV12,
67 .guid = UVC_GUID_FORMAT_MJPEG,
68 .fcc = V4L2_PIX_FMT_MJPEG,
71 .name = "YVU 4:2:0 (YV12)",
72 .guid = UVC_GUID_FORMAT_YV12,
73 .fcc = V4L2_PIX_FMT_YVU420,
76 .name = "YUV 4:2:0 (I420)",
77 .guid = UVC_GUID_FORMAT_I420,
78 .fcc = V4L2_PIX_FMT_YUV420,
81 .name = "YUV 4:2:2 (UYVY)",
82 .guid = UVC_GUID_FORMAT_UYVY,
83 .fcc = V4L2_PIX_FMT_UYVY,
87 .guid = UVC_GUID_FORMAT_Y800,
88 .fcc = V4L2_PIX_FMT_GREY,
92 .guid = UVC_GUID_FORMAT_BY8,
93 .fcc = V4L2_PIX_FMT_SBGGR8,
97 /* ------------------------------------------------------------------------
101 struct usb_host_endpoint *uvc_find_endpoint(struct usb_host_interface *alts,
104 struct usb_host_endpoint *ep;
107 for (i = 0; i < alts->desc.bNumEndpoints; ++i) {
108 ep = &alts->endpoint[i];
109 if (ep->desc.bEndpointAddress == epaddr)
116 static struct uvc_format_desc *uvc_format_by_guid(const __u8 guid[16])
118 unsigned int len = ARRAY_SIZE(uvc_fmts);
121 for (i = 0; i < len; ++i) {
122 if (memcmp(guid, uvc_fmts[i].guid, 16) == 0)
129 static __u32 uvc_colorspace(const __u8 primaries)
131 static const __u8 colorprimaries[] = {
133 V4L2_COLORSPACE_SRGB,
134 V4L2_COLORSPACE_470_SYSTEM_M,
135 V4L2_COLORSPACE_470_SYSTEM_BG,
136 V4L2_COLORSPACE_SMPTE170M,
137 V4L2_COLORSPACE_SMPTE240M,
140 if (primaries < ARRAY_SIZE(colorprimaries))
141 return colorprimaries[primaries];
146 /* Simplify a fraction using a simple continued fraction decomposition. The
147 * idea here is to convert fractions such as 333333/10000000 to 1/30 using
148 * 32 bit arithmetic only. The algorithm is not perfect and relies upon two
149 * arbitrary parameters to remove non-significative terms from the simple
150 * continued fraction decomposition. Using 8 and 333 for n_terms and threshold
151 * respectively seems to give nice results.
153 void uvc_simplify_fraction(uint32_t *numerator, uint32_t *denominator,
154 unsigned int n_terms, unsigned int threshold)
160 an = kmalloc(n_terms * sizeof *an, GFP_KERNEL);
164 /* Convert the fraction to a simple continued fraction. See
165 * http://mathforum.org/dr.math/faq/faq.fractions.html
166 * Stop if the current term is bigger than or equal to the given
172 for (n = 0; n < n_terms && y != 0; ++n) {
174 if (an[n] >= threshold) {
185 /* Expand the simple continued fraction back to an integer fraction. */
189 for (i = n; i > 0; --i) {
200 /* Convert a fraction to a frame interval in 100ns multiples. The idea here is
201 * to compute numerator / denominator * 10000000 using 32 bit fixed point
204 uint32_t uvc_fraction_to_interval(uint32_t numerator, uint32_t denominator)
208 /* Saturate the result if the operation would overflow. */
209 if (denominator == 0 ||
210 numerator/denominator >= ((uint32_t)-1)/10000000)
213 /* Divide both the denominator and the multiplier by two until
214 * numerator * multiplier doesn't overflow. If anyone knows a better
215 * algorithm please let me know.
217 multiplier = 10000000;
218 while (numerator > ((uint32_t)-1)/multiplier) {
223 return denominator ? numerator * multiplier / denominator : 0;
226 /* ------------------------------------------------------------------------
227 * Terminal and unit management
230 static struct uvc_entity *uvc_entity_by_id(struct uvc_device *dev, int id)
232 struct uvc_entity *entity;
234 list_for_each_entry(entity, &dev->entities, list) {
235 if (entity->id == id)
242 static struct uvc_entity *uvc_entity_by_reference(struct uvc_device *dev,
243 int id, struct uvc_entity *entity)
248 entity = list_entry(&dev->entities, struct uvc_entity, list);
250 list_for_each_entry_continue(entity, &dev->entities, list) {
251 switch (UVC_ENTITY_TYPE(entity)) {
253 if (entity->output.bSourceID == id)
257 case VC_PROCESSING_UNIT:
258 if (entity->processing.bSourceID == id)
262 case VC_SELECTOR_UNIT:
263 for (i = 0; i < entity->selector.bNrInPins; ++i)
264 if (entity->selector.baSourceID[i] == id)
268 case VC_EXTENSION_UNIT:
269 for (i = 0; i < entity->extension.bNrInPins; ++i)
270 if (entity->extension.baSourceID[i] == id)
279 /* ------------------------------------------------------------------------
280 * Descriptors handling
283 static int uvc_parse_format(struct uvc_device *dev,
284 struct uvc_streaming *streaming, struct uvc_format *format,
285 __u32 **intervals, unsigned char *buffer, int buflen)
287 struct usb_interface *intf = streaming->intf;
288 struct usb_host_interface *alts = intf->cur_altsetting;
289 struct uvc_format_desc *fmtdesc;
290 struct uvc_frame *frame;
291 const unsigned char *start = buffer;
292 unsigned char *_buffer;
293 unsigned int interval;
298 format->type = buffer[2];
299 format->index = buffer[3];
302 case VS_FORMAT_UNCOMPRESSED:
303 case VS_FORMAT_FRAME_BASED:
304 n = buffer[2] == VS_FORMAT_UNCOMPRESSED ? 27 : 28;
306 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming"
307 "interface %d FORMAT error\n",
309 alts->desc.bInterfaceNumber);
313 /* Find the format descriptor from its GUID. */
314 fmtdesc = uvc_format_by_guid(&buffer[5]);
316 if (fmtdesc != NULL) {
317 strlcpy(format->name, fmtdesc->name,
318 sizeof format->name);
319 format->fcc = fmtdesc->fcc;
321 uvc_printk(KERN_INFO, "Unknown video format "
322 UVC_GUID_FORMAT "\n",
323 UVC_GUID_ARGS(&buffer[5]));
324 snprintf(format->name, sizeof format->name,
325 UVC_GUID_FORMAT, UVC_GUID_ARGS(&buffer[5]));
329 format->bpp = buffer[21];
330 if (buffer[2] == VS_FORMAT_UNCOMPRESSED) {
331 ftype = VS_FRAME_UNCOMPRESSED;
333 ftype = VS_FRAME_FRAME_BASED;
335 format->flags = UVC_FMT_FLAG_COMPRESSED;
339 case VS_FORMAT_MJPEG:
341 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming"
342 "interface %d FORMAT error\n",
344 alts->desc.bInterfaceNumber);
348 strlcpy(format->name, "MJPEG", sizeof format->name);
349 format->fcc = V4L2_PIX_FMT_MJPEG;
350 format->flags = UVC_FMT_FLAG_COMPRESSED;
352 ftype = VS_FRAME_MJPEG;
357 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming"
358 "interface %d FORMAT error\n",
360 alts->desc.bInterfaceNumber);
364 switch (buffer[8] & 0x7f) {
366 strlcpy(format->name, "SD-DV", sizeof format->name);
369 strlcpy(format->name, "SDL-DV", sizeof format->name);
372 strlcpy(format->name, "HD-DV", sizeof format->name);
375 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming"
376 "interface %d: unknown DV format %u\n",
378 alts->desc.bInterfaceNumber, buffer[8]);
382 strlcat(format->name, buffer[8] & (1 << 7) ? " 60Hz" : " 50Hz",
383 sizeof format->name);
385 format->fcc = V4L2_PIX_FMT_DV;
386 format->flags = UVC_FMT_FLAG_COMPRESSED | UVC_FMT_FLAG_STREAM;
390 /* Create a dummy frame descriptor. */
391 frame = &format->frame[0];
392 memset(&format->frame[0], 0, sizeof format->frame[0]);
393 frame->bFrameIntervalType = 1;
394 frame->dwDefaultFrameInterval = 1;
395 frame->dwFrameInterval = *intervals;
400 case VS_FORMAT_MPEG2TS:
401 case VS_FORMAT_STREAM_BASED:
402 /* Not supported yet. */
404 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming"
405 "interface %d unsupported format %u\n",
406 dev->udev->devnum, alts->desc.bInterfaceNumber,
411 uvc_trace(UVC_TRACE_DESCR, "Found format %s.\n", format->name);
416 /* Count the number of frame descriptors to test the bFrameIndex
417 * field when parsing the descriptors. We can't rely on the
418 * bNumFrameDescriptors field as some cameras don't initialize it
421 for (_buflen = buflen, _buffer = buffer;
422 _buflen > 2 && _buffer[2] == ftype;
423 _buflen -= _buffer[0], _buffer += _buffer[0])
426 /* Parse the frame descriptors. Only uncompressed, MJPEG and frame
427 * based formats have frame descriptors.
429 while (buflen > 2 && buffer[2] == ftype) {
430 if (ftype != VS_FRAME_FRAME_BASED)
431 n = buflen > 25 ? buffer[25] : 0;
433 n = buflen > 21 ? buffer[21] : 0;
437 if (buflen < 26 + 4*n) {
438 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming"
439 "interface %d FRAME error\n", dev->udev->devnum,
440 alts->desc.bInterfaceNumber);
444 if (buffer[3] - 1 >= format->nframes) {
445 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming"
446 "interface %d frame index %u out of range\n",
447 dev->udev->devnum, alts->desc.bInterfaceNumber,
452 frame = &format->frame[buffer[3] - 1];
454 frame->bFrameIndex = buffer[3];
455 frame->bmCapabilities = buffer[4];
456 frame->wWidth = get_unaligned_le16(&buffer[5]);
457 frame->wHeight = get_unaligned_le16(&buffer[7]);
458 frame->dwMinBitRate = get_unaligned_le32(&buffer[9]);
459 frame->dwMaxBitRate = get_unaligned_le32(&buffer[13]);
460 if (ftype != VS_FRAME_FRAME_BASED) {
461 frame->dwMaxVideoFrameBufferSize =
462 get_unaligned_le32(&buffer[17]);
463 frame->dwDefaultFrameInterval =
464 get_unaligned_le32(&buffer[21]);
465 frame->bFrameIntervalType = buffer[25];
467 frame->dwMaxVideoFrameBufferSize = 0;
468 frame->dwDefaultFrameInterval =
469 get_unaligned_le32(&buffer[17]);
470 frame->bFrameIntervalType = buffer[21];
472 frame->dwFrameInterval = *intervals;
474 /* Several UVC chipsets screw up dwMaxVideoFrameBufferSize
475 * completely. Observed behaviours range from setting the
476 * value to 1.1x the actual frame size to hardwiring the
477 * 16 low bits to 0. This results in a higher than necessary
478 * memory usage as well as a wrong image size information. For
479 * uncompressed formats this can be fixed by computing the
480 * value from the frame size.
482 if (!(format->flags & UVC_FMT_FLAG_COMPRESSED))
483 frame->dwMaxVideoFrameBufferSize = format->bpp
484 * frame->wWidth * frame->wHeight / 8;
486 /* Some bogus devices report dwMinFrameInterval equal to
487 * dwMaxFrameInterval and have dwFrameIntervalStep set to
488 * zero. Setting all null intervals to 1 fixes the problem and
489 * some other divisions by zero that could happen.
491 for (i = 0; i < n; ++i) {
492 interval = get_unaligned_le32(&buffer[26+4*i]);
493 *(*intervals)++ = interval ? interval : 1;
496 /* Make sure that the default frame interval stays between
499 n -= frame->bFrameIntervalType ? 1 : 2;
500 frame->dwDefaultFrameInterval =
501 min(frame->dwFrameInterval[n],
502 max(frame->dwFrameInterval[0],
503 frame->dwDefaultFrameInterval));
505 uvc_trace(UVC_TRACE_DESCR, "- %ux%u (%u.%u fps)\n",
506 frame->wWidth, frame->wHeight,
507 10000000/frame->dwDefaultFrameInterval,
508 (100000000/frame->dwDefaultFrameInterval)%10);
514 if (buflen > 2 && buffer[2] == VS_STILL_IMAGE_FRAME) {
519 if (buflen > 2 && buffer[2] == VS_COLORFORMAT) {
521 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming"
522 "interface %d COLORFORMAT error\n",
524 alts->desc.bInterfaceNumber);
528 format->colorspace = uvc_colorspace(buffer[3]);
534 return buffer - start;
537 static int uvc_parse_streaming(struct uvc_device *dev,
538 struct usb_interface *intf)
540 struct uvc_streaming *streaming = NULL;
541 struct uvc_format *format;
542 struct uvc_frame *frame;
543 struct usb_host_interface *alts = &intf->altsetting[0];
544 unsigned char *_buffer, *buffer = alts->extra;
545 int _buflen, buflen = alts->extralen;
546 unsigned int nformats = 0, nframes = 0, nintervals = 0;
547 unsigned int size, i, n, p;
552 if (intf->cur_altsetting->desc.bInterfaceSubClass
553 != SC_VIDEOSTREAMING) {
554 uvc_trace(UVC_TRACE_DESCR, "device %d interface %d isn't a "
555 "video streaming interface\n", dev->udev->devnum,
556 intf->altsetting[0].desc.bInterfaceNumber);
560 if (usb_driver_claim_interface(&uvc_driver.driver, intf, dev)) {
561 uvc_trace(UVC_TRACE_DESCR, "device %d interface %d is already "
562 "claimed\n", dev->udev->devnum,
563 intf->altsetting[0].desc.bInterfaceNumber);
567 streaming = kzalloc(sizeof *streaming, GFP_KERNEL);
568 if (streaming == NULL) {
569 usb_driver_release_interface(&uvc_driver.driver, intf);
573 mutex_init(&streaming->mutex);
574 streaming->intf = usb_get_intf(intf);
575 streaming->intfnum = intf->cur_altsetting->desc.bInterfaceNumber;
577 /* The Pico iMage webcam has its class-specific interface descriptors
578 * after the endpoint descriptors.
581 for (i = 0; i < alts->desc.bNumEndpoints; ++i) {
582 struct usb_host_endpoint *ep = &alts->endpoint[i];
584 if (ep->extralen == 0)
587 if (ep->extralen > 2 &&
588 ep->extra[1] == USB_DT_CS_INTERFACE) {
589 uvc_trace(UVC_TRACE_DESCR, "trying extra data "
590 "from endpoint %u.\n", i);
591 buffer = alts->endpoint[i].extra;
592 buflen = alts->endpoint[i].extralen;
598 /* Skip the standard interface descriptors. */
599 while (buflen > 2 && buffer[1] != USB_DT_CS_INTERFACE) {
605 uvc_trace(UVC_TRACE_DESCR, "no class-specific streaming "
606 "interface descriptors found.\n");
610 /* Parse the header descriptor. */
612 case VS_OUTPUT_HEADER:
613 streaming->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
617 case VS_INPUT_HEADER:
618 streaming->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
623 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming interface "
624 "%d HEADER descriptor not found.\n", dev->udev->devnum,
625 alts->desc.bInterfaceNumber);
629 p = buflen >= 4 ? buffer[3] : 0;
630 n = buflen >= size ? buffer[size-1] : 0;
632 if (buflen < size + p*n) {
633 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
634 "interface %d HEADER descriptor is invalid.\n",
635 dev->udev->devnum, alts->desc.bInterfaceNumber);
639 streaming->header.bNumFormats = p;
640 streaming->header.bEndpointAddress = buffer[6];
641 if (buffer[2] == VS_INPUT_HEADER) {
642 streaming->header.bmInfo = buffer[7];
643 streaming->header.bTerminalLink = buffer[8];
644 streaming->header.bStillCaptureMethod = buffer[9];
645 streaming->header.bTriggerSupport = buffer[10];
646 streaming->header.bTriggerUsage = buffer[11];
648 streaming->header.bTerminalLink = buffer[7];
650 streaming->header.bControlSize = n;
652 streaming->header.bmaControls = kmalloc(p*n, GFP_KERNEL);
653 if (streaming->header.bmaControls == NULL) {
658 memcpy(streaming->header.bmaControls, &buffer[size], p*n);
666 /* Count the format and frame descriptors. */
667 while (_buflen > 2) {
668 switch (_buffer[2]) {
669 case VS_FORMAT_UNCOMPRESSED:
670 case VS_FORMAT_MJPEG:
671 case VS_FORMAT_FRAME_BASED:
676 /* DV format has no frame descriptor. We will create a
677 * dummy frame descriptor with a dummy frame interval.
684 case VS_FORMAT_MPEG2TS:
685 case VS_FORMAT_STREAM_BASED:
686 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
687 "interface %d FORMAT %u is not supported.\n",
689 alts->desc.bInterfaceNumber, _buffer[2]);
692 case VS_FRAME_UNCOMPRESSED:
696 nintervals += _buffer[25] ? _buffer[25] : 3;
699 case VS_FRAME_FRAME_BASED:
702 nintervals += _buffer[21] ? _buffer[21] : 3;
706 _buflen -= _buffer[0];
707 _buffer += _buffer[0];
711 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming interface "
712 "%d has no supported formats defined.\n",
713 dev->udev->devnum, alts->desc.bInterfaceNumber);
717 size = nformats * sizeof *format + nframes * sizeof *frame
718 + nintervals * sizeof *interval;
719 format = kzalloc(size, GFP_KERNEL);
720 if (format == NULL) {
725 frame = (struct uvc_frame *)&format[nformats];
726 interval = (__u32 *)&frame[nframes];
728 streaming->format = format;
729 streaming->nformats = nformats;
731 /* Parse the format descriptors. */
734 case VS_FORMAT_UNCOMPRESSED:
735 case VS_FORMAT_MJPEG:
737 case VS_FORMAT_FRAME_BASED:
738 format->frame = frame;
739 ret = uvc_parse_format(dev, streaming, format,
740 &interval, buffer, buflen);
744 frame += format->nframes;
759 /* Parse the alternate settings to find the maximum bandwidth. */
760 for (i = 0; i < intf->num_altsetting; ++i) {
761 struct usb_host_endpoint *ep;
762 alts = &intf->altsetting[i];
763 ep = uvc_find_endpoint(alts,
764 streaming->header.bEndpointAddress);
768 psize = le16_to_cpu(ep->desc.wMaxPacketSize);
769 psize = (psize & 0x07ff) * (1 + ((psize >> 11) & 3));
770 if (psize > streaming->maxpsize)
771 streaming->maxpsize = psize;
774 list_add_tail(&streaming->list, &dev->streaming);
778 usb_driver_release_interface(&uvc_driver.driver, intf);
780 kfree(streaming->format);
781 kfree(streaming->header.bmaControls);
786 /* Parse vendor-specific extensions. */
787 static int uvc_parse_vendor_control(struct uvc_device *dev,
788 const unsigned char *buffer, int buflen)
790 struct usb_device *udev = dev->udev;
791 struct usb_host_interface *alts = dev->intf->cur_altsetting;
792 struct uvc_entity *unit;
796 switch (le16_to_cpu(dev->udev->descriptor.idVendor)) {
797 case 0x046d: /* Logitech */
798 if (buffer[1] != 0x41 || buffer[2] != 0x01)
801 /* Logitech implements several vendor specific functions
802 * through vendor specific extension units (LXU).
804 * The LXU descriptors are similar to XU descriptors
805 * (see "USB Device Video Class for Video Devices", section
806 * 3.7.2.6 "Extension Unit Descriptor") with the following
809 * ----------------------------------------------------------
811 * Size of this descriptor, in bytes: 24+p+n*2
812 * ----------------------------------------------------------
813 * 23+p+n bmControlsType N Bitmap
814 * Individual bits in the set are defined:
818 * This bitset is mapped exactly the same as bmControls.
819 * ----------------------------------------------------------
820 * 23+p+n*2 bReserved 1 Boolean
821 * ----------------------------------------------------------
822 * 24+p+n*2 iExtension 1 Index
823 * Index of a string descriptor that describes this
825 * ----------------------------------------------------------
827 p = buflen >= 22 ? buffer[21] : 0;
828 n = buflen >= 25 + p ? buffer[22+p] : 0;
830 if (buflen < 25 + p + 2*n) {
831 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
832 "interface %d EXTENSION_UNIT error\n",
833 udev->devnum, alts->desc.bInterfaceNumber);
837 unit = kzalloc(sizeof *unit + p + 2*n, GFP_KERNEL);
841 unit->id = buffer[3];
842 unit->type = VC_EXTENSION_UNIT;
843 memcpy(unit->extension.guidExtensionCode, &buffer[4], 16);
844 unit->extension.bNumControls = buffer[20];
845 unit->extension.bNrInPins = get_unaligned_le16(&buffer[21]);
846 unit->extension.baSourceID = (__u8 *)unit + sizeof *unit;
847 memcpy(unit->extension.baSourceID, &buffer[22], p);
848 unit->extension.bControlSize = buffer[22+p];
849 unit->extension.bmControls = (__u8 *)unit + sizeof *unit + p;
850 unit->extension.bmControlsType = (__u8 *)unit + sizeof *unit
852 memcpy(unit->extension.bmControls, &buffer[23+p], 2*n);
854 if (buffer[24+p+2*n] != 0)
855 usb_string(udev, buffer[24+p+2*n], unit->name,
858 sprintf(unit->name, "Extension %u", buffer[3]);
860 list_add_tail(&unit->list, &dev->entities);
868 static int uvc_parse_standard_control(struct uvc_device *dev,
869 const unsigned char *buffer, int buflen)
871 struct usb_device *udev = dev->udev;
872 struct uvc_entity *unit, *term;
873 struct usb_interface *intf;
874 struct usb_host_interface *alts = dev->intf->cur_altsetting;
875 unsigned int i, n, p, len;
880 n = buflen >= 12 ? buffer[11] : 0;
882 if (buflen < 12 || buflen < 12 + n) {
883 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
884 "interface %d HEADER error\n", udev->devnum,
885 alts->desc.bInterfaceNumber);
889 dev->uvc_version = get_unaligned_le16(&buffer[3]);
890 dev->clock_frequency = get_unaligned_le32(&buffer[7]);
892 /* Parse all USB Video Streaming interfaces. */
893 for (i = 0; i < n; ++i) {
894 intf = usb_ifnum_to_if(udev, buffer[12+i]);
896 uvc_trace(UVC_TRACE_DESCR, "device %d "
897 "interface %d doesn't exists\n",
902 uvc_parse_streaming(dev, intf);
906 case VC_INPUT_TERMINAL:
908 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
909 "interface %d INPUT_TERMINAL error\n",
910 udev->devnum, alts->desc.bInterfaceNumber);
914 /* Make sure the terminal type MSB is not null, otherwise it
915 * could be confused with a unit.
917 type = get_unaligned_le16(&buffer[4]);
918 if ((type & 0xff00) == 0) {
919 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
920 "interface %d INPUT_TERMINAL %d has invalid "
921 "type 0x%04x, skipping\n", udev->devnum,
922 alts->desc.bInterfaceNumber,
931 if (type == ITT_CAMERA) {
932 n = buflen >= 15 ? buffer[14] : 0;
935 } else if (type == ITT_MEDIA_TRANSPORT_INPUT) {
936 n = buflen >= 9 ? buffer[8] : 0;
937 p = buflen >= 10 + n ? buffer[9+n] : 0;
941 if (buflen < len + n + p) {
942 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
943 "interface %d INPUT_TERMINAL error\n",
944 udev->devnum, alts->desc.bInterfaceNumber);
948 term = kzalloc(sizeof *term + n + p, GFP_KERNEL);
952 term->id = buffer[3];
953 term->type = type | UVC_TERM_INPUT;
955 if (UVC_ENTITY_TYPE(term) == ITT_CAMERA) {
956 term->camera.bControlSize = n;
957 term->camera.bmControls = (__u8 *)term + sizeof *term;
958 term->camera.wObjectiveFocalLengthMin =
959 get_unaligned_le16(&buffer[8]);
960 term->camera.wObjectiveFocalLengthMax =
961 get_unaligned_le16(&buffer[10]);
962 term->camera.wOcularFocalLength =
963 get_unaligned_le16(&buffer[12]);
964 memcpy(term->camera.bmControls, &buffer[15], n);
965 } else if (UVC_ENTITY_TYPE(term) == ITT_MEDIA_TRANSPORT_INPUT) {
966 term->media.bControlSize = n;
967 term->media.bmControls = (__u8 *)term + sizeof *term;
968 term->media.bTransportModeSize = p;
969 term->media.bmTransportModes = (__u8 *)term
971 memcpy(term->media.bmControls, &buffer[9], n);
972 memcpy(term->media.bmTransportModes, &buffer[10+n], p);
976 usb_string(udev, buffer[7], term->name,
978 else if (UVC_ENTITY_TYPE(term) == ITT_CAMERA)
979 sprintf(term->name, "Camera %u", buffer[3]);
980 else if (UVC_ENTITY_TYPE(term) == ITT_MEDIA_TRANSPORT_INPUT)
981 sprintf(term->name, "Media %u", buffer[3]);
983 sprintf(term->name, "Input %u", buffer[3]);
985 list_add_tail(&term->list, &dev->entities);
988 case VC_OUTPUT_TERMINAL:
990 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
991 "interface %d OUTPUT_TERMINAL error\n",
992 udev->devnum, alts->desc.bInterfaceNumber);
996 /* Make sure the terminal type MSB is not null, otherwise it
997 * could be confused with a unit.
999 type = get_unaligned_le16(&buffer[4]);
1000 if ((type & 0xff00) == 0) {
1001 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1002 "interface %d OUTPUT_TERMINAL %d has invalid "
1003 "type 0x%04x, skipping\n", udev->devnum,
1004 alts->desc.bInterfaceNumber, buffer[3], type);
1008 term = kzalloc(sizeof *term, GFP_KERNEL);
1012 term->id = buffer[3];
1013 term->type = type | UVC_TERM_OUTPUT;
1014 term->output.bSourceID = buffer[7];
1017 usb_string(udev, buffer[8], term->name,
1020 sprintf(term->name, "Output %u", buffer[3]);
1022 list_add_tail(&term->list, &dev->entities);
1025 case VC_SELECTOR_UNIT:
1026 p = buflen >= 5 ? buffer[4] : 0;
1028 if (buflen < 5 || buflen < 6 + p) {
1029 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1030 "interface %d SELECTOR_UNIT error\n",
1031 udev->devnum, alts->desc.bInterfaceNumber);
1035 unit = kzalloc(sizeof *unit + p, GFP_KERNEL);
1039 unit->id = buffer[3];
1040 unit->type = buffer[2];
1041 unit->selector.bNrInPins = buffer[4];
1042 unit->selector.baSourceID = (__u8 *)unit + sizeof *unit;
1043 memcpy(unit->selector.baSourceID, &buffer[5], p);
1045 if (buffer[5+p] != 0)
1046 usb_string(udev, buffer[5+p], unit->name,
1049 sprintf(unit->name, "Selector %u", buffer[3]);
1051 list_add_tail(&unit->list, &dev->entities);
1054 case VC_PROCESSING_UNIT:
1055 n = buflen >= 8 ? buffer[7] : 0;
1056 p = dev->uvc_version >= 0x0110 ? 10 : 9;
1058 if (buflen < p + n) {
1059 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1060 "interface %d PROCESSING_UNIT error\n",
1061 udev->devnum, alts->desc.bInterfaceNumber);
1065 unit = kzalloc(sizeof *unit + n, GFP_KERNEL);
1069 unit->id = buffer[3];
1070 unit->type = buffer[2];
1071 unit->processing.bSourceID = buffer[4];
1072 unit->processing.wMaxMultiplier =
1073 get_unaligned_le16(&buffer[5]);
1074 unit->processing.bControlSize = buffer[7];
1075 unit->processing.bmControls = (__u8 *)unit + sizeof *unit;
1076 memcpy(unit->processing.bmControls, &buffer[8], n);
1077 if (dev->uvc_version >= 0x0110)
1078 unit->processing.bmVideoStandards = buffer[9+n];
1080 if (buffer[8+n] != 0)
1081 usb_string(udev, buffer[8+n], unit->name,
1084 sprintf(unit->name, "Processing %u", buffer[3]);
1086 list_add_tail(&unit->list, &dev->entities);
1089 case VC_EXTENSION_UNIT:
1090 p = buflen >= 22 ? buffer[21] : 0;
1091 n = buflen >= 24 + p ? buffer[22+p] : 0;
1093 if (buflen < 24 + p + n) {
1094 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1095 "interface %d EXTENSION_UNIT error\n",
1096 udev->devnum, alts->desc.bInterfaceNumber);
1100 unit = kzalloc(sizeof *unit + p + n, GFP_KERNEL);
1104 unit->id = buffer[3];
1105 unit->type = buffer[2];
1106 memcpy(unit->extension.guidExtensionCode, &buffer[4], 16);
1107 unit->extension.bNumControls = buffer[20];
1108 unit->extension.bNrInPins = get_unaligned_le16(&buffer[21]);
1109 unit->extension.baSourceID = (__u8 *)unit + sizeof *unit;
1110 memcpy(unit->extension.baSourceID, &buffer[22], p);
1111 unit->extension.bControlSize = buffer[22+p];
1112 unit->extension.bmControls = (__u8 *)unit + sizeof *unit + p;
1113 memcpy(unit->extension.bmControls, &buffer[23+p], n);
1115 if (buffer[23+p+n] != 0)
1116 usb_string(udev, buffer[23+p+n], unit->name,
1119 sprintf(unit->name, "Extension %u", buffer[3]);
1121 list_add_tail(&unit->list, &dev->entities);
1125 uvc_trace(UVC_TRACE_DESCR, "Found an unknown CS_INTERFACE "
1126 "descriptor (%u)\n", buffer[2]);
1133 static int uvc_parse_control(struct uvc_device *dev)
1135 struct usb_host_interface *alts = dev->intf->cur_altsetting;
1136 unsigned char *buffer = alts->extra;
1137 int buflen = alts->extralen;
1140 /* Parse the default alternate setting only, as the UVC specification
1141 * defines a single alternate setting, the default alternate setting
1145 while (buflen > 2) {
1146 if (uvc_parse_vendor_control(dev, buffer, buflen) ||
1147 buffer[1] != USB_DT_CS_INTERFACE)
1148 goto next_descriptor;
1150 if ((ret = uvc_parse_standard_control(dev, buffer, buflen)) < 0)
1154 buflen -= buffer[0];
1155 buffer += buffer[0];
1158 /* Check if the optional status endpoint is present. Built-in iSight
1159 * webcams have an interrupt endpoint but spit proprietary data that
1160 * don't conform to the UVC status endpoint messages. Don't try to
1161 * handle the interrupt endpoint for those cameras.
1163 if (alts->desc.bNumEndpoints == 1 &&
1164 !(dev->quirks & UVC_QUIRK_BUILTIN_ISIGHT)) {
1165 struct usb_host_endpoint *ep = &alts->endpoint[0];
1166 struct usb_endpoint_descriptor *desc = &ep->desc;
1168 if (usb_endpoint_is_int_in(desc) &&
1169 le16_to_cpu(desc->wMaxPacketSize) >= 8 &&
1170 desc->bInterval != 0) {
1171 uvc_trace(UVC_TRACE_DESCR, "Found a Status endpoint "
1172 "(addr %02x).\n", desc->bEndpointAddress);
1180 /* ------------------------------------------------------------------------
1181 * USB probe and disconnect
1185 * Unregister the video devices.
1187 static void uvc_unregister_video(struct uvc_device *dev)
1189 if (dev->video.vdev) {
1190 if (dev->video.vdev->minor == -1)
1191 video_device_release(dev->video.vdev);
1193 video_unregister_device(dev->video.vdev);
1194 dev->video.vdev = NULL;
1199 * Scan the UVC descriptors to locate a chain starting at an Output Terminal
1200 * and containing the following units:
1202 * - one Output Terminal (USB Streaming or Display)
1203 * - zero or one Processing Unit
1204 * - zero, one or mode single-input Selector Units
1205 * - zero or one multiple-input Selector Units, provided all inputs are
1206 * connected to input terminals
1207 * - zero, one or mode single-input Extension Units
1208 * - one or more Input Terminals (Camera, External or USB Streaming)
1210 * A side forward scan is made on each detected entity to check for additional
1213 static int uvc_scan_chain_entity(struct uvc_video_device *video,
1214 struct uvc_entity *entity)
1216 switch (UVC_ENTITY_TYPE(entity)) {
1217 case VC_EXTENSION_UNIT:
1218 if (uvc_trace_param & UVC_TRACE_PROBE)
1219 printk(" <- XU %d", entity->id);
1221 if (entity->extension.bNrInPins != 1) {
1222 uvc_trace(UVC_TRACE_DESCR, "Extension unit %d has more "
1223 "than 1 input pin.\n", entity->id);
1227 list_add_tail(&entity->chain, &video->extensions);
1230 case VC_PROCESSING_UNIT:
1231 if (uvc_trace_param & UVC_TRACE_PROBE)
1232 printk(" <- PU %d", entity->id);
1234 if (video->processing != NULL) {
1235 uvc_trace(UVC_TRACE_DESCR, "Found multiple "
1236 "Processing Units in chain.\n");
1240 video->processing = entity;
1243 case VC_SELECTOR_UNIT:
1244 if (uvc_trace_param & UVC_TRACE_PROBE)
1245 printk(" <- SU %d", entity->id);
1247 /* Single-input selector units are ignored. */
1248 if (entity->selector.bNrInPins == 1)
1251 if (video->selector != NULL) {
1252 uvc_trace(UVC_TRACE_DESCR, "Found multiple Selector "
1253 "Units in chain.\n");
1257 video->selector = entity;
1260 case ITT_VENDOR_SPECIFIC:
1262 case ITT_MEDIA_TRANSPORT_INPUT:
1263 if (uvc_trace_param & UVC_TRACE_PROBE)
1264 printk(" <- IT %d\n", entity->id);
1266 list_add_tail(&entity->chain, &video->iterms);
1270 if (uvc_trace_param & UVC_TRACE_PROBE)
1271 printk(" <- IT %d\n", entity->id);
1273 if (!UVC_ENTITY_IS_ITERM(entity)) {
1274 uvc_trace(UVC_TRACE_DESCR, "Unsupported input "
1275 "terminal %u.\n", entity->id);
1279 if (video->sterm != NULL) {
1280 uvc_trace(UVC_TRACE_DESCR, "Found multiple streaming "
1281 "entities in chain.\n");
1285 list_add_tail(&entity->chain, &video->iterms);
1286 video->sterm = entity;
1290 uvc_trace(UVC_TRACE_DESCR, "Unsupported entity type "
1291 "0x%04x found in chain.\n", UVC_ENTITY_TYPE(entity));
1298 static int uvc_scan_chain_forward(struct uvc_video_device *video,
1299 struct uvc_entity *entity, struct uvc_entity *prev)
1301 struct uvc_entity *forward;
1309 forward = uvc_entity_by_reference(video->dev, entity->id,
1311 if (forward == NULL)
1314 if (UVC_ENTITY_TYPE(forward) != VC_EXTENSION_UNIT ||
1318 if (forward->extension.bNrInPins != 1) {
1319 uvc_trace(UVC_TRACE_DESCR, "Extension unit %d has"
1320 "more than 1 input pin.\n", entity->id);
1324 list_add_tail(&forward->chain, &video->extensions);
1325 if (uvc_trace_param & UVC_TRACE_PROBE) {
1329 printk(" %d", forward->id);
1339 static int uvc_scan_chain_backward(struct uvc_video_device *video,
1340 struct uvc_entity *entity)
1342 struct uvc_entity *term;
1345 switch (UVC_ENTITY_TYPE(entity)) {
1346 case VC_EXTENSION_UNIT:
1347 id = entity->extension.baSourceID[0];
1350 case VC_PROCESSING_UNIT:
1351 id = entity->processing.bSourceID;
1354 case VC_SELECTOR_UNIT:
1355 /* Single-input selector units are ignored. */
1356 if (entity->selector.bNrInPins == 1) {
1357 id = entity->selector.baSourceID[0];
1361 if (uvc_trace_param & UVC_TRACE_PROBE)
1364 video->selector = entity;
1365 for (i = 0; i < entity->selector.bNrInPins; ++i) {
1366 id = entity->selector.baSourceID[i];
1367 term = uvc_entity_by_id(video->dev, id);
1368 if (term == NULL || !UVC_ENTITY_IS_ITERM(term)) {
1369 uvc_trace(UVC_TRACE_DESCR, "Selector unit %d "
1370 "input %d isn't connected to an "
1371 "input terminal\n", entity->id, i);
1375 if (uvc_trace_param & UVC_TRACE_PROBE)
1376 printk(" %d", term->id);
1378 list_add_tail(&term->chain, &video->iterms);
1379 uvc_scan_chain_forward(video, term, entity);
1382 if (uvc_trace_param & UVC_TRACE_PROBE)
1392 static int uvc_scan_chain(struct uvc_video_device *video)
1394 struct uvc_entity *entity, *prev;
1397 entity = video->oterm;
1398 uvc_trace(UVC_TRACE_PROBE, "Scanning UVC chain: OT %d", entity->id);
1400 if (UVC_ENTITY_TYPE(entity) == TT_STREAMING)
1401 video->sterm = entity;
1403 id = entity->output.bSourceID;
1406 entity = uvc_entity_by_id(video->dev, id);
1407 if (entity == NULL) {
1408 uvc_trace(UVC_TRACE_DESCR, "Found reference to "
1409 "unknown entity %d.\n", id);
1413 /* Process entity */
1414 if (uvc_scan_chain_entity(video, entity) < 0)
1418 if (uvc_scan_chain_forward(video, entity, prev) < 0)
1421 /* Stop when a terminal is found. */
1422 if (!UVC_ENTITY_IS_UNIT(entity))
1426 id = uvc_scan_chain_backward(video, entity);
1431 if (video->sterm == NULL) {
1432 uvc_trace(UVC_TRACE_DESCR, "No streaming entity found in "
1441 * Register the video devices.
1443 * The driver currently supports a single video device per control interface
1444 * only. The terminal and units must match the following structure:
1446 * ITT_* -> VC_PROCESSING_UNIT -> VC_EXTENSION_UNIT{0,n} -> TT_STREAMING
1447 * TT_STREAMING -> VC_PROCESSING_UNIT -> VC_EXTENSION_UNIT{0,n} -> OTT_*
1449 * The Extension Units, if present, must have a single input pin. The
1450 * Processing Unit and Extension Units can be in any order. Additional
1451 * Extension Units connected to the main chain as single-unit branches are
1454 static int uvc_register_video(struct uvc_device *dev)
1456 struct video_device *vdev;
1457 struct uvc_entity *term;
1460 /* Check if the control interface matches the structure we expect. */
1461 list_for_each_entry(term, &dev->entities, list) {
1462 struct uvc_streaming *streaming;
1464 if (!UVC_ENTITY_IS_TERM(term) || !UVC_ENTITY_IS_OTERM(term))
1467 memset(&dev->video, 0, sizeof dev->video);
1468 mutex_init(&dev->video.ctrl_mutex);
1469 INIT_LIST_HEAD(&dev->video.iterms);
1470 INIT_LIST_HEAD(&dev->video.extensions);
1471 dev->video.oterm = term;
1472 dev->video.dev = dev;
1473 if (uvc_scan_chain(&dev->video) < 0)
1476 list_for_each_entry(streaming, &dev->streaming, list) {
1477 if (streaming->header.bTerminalLink ==
1478 dev->video.sterm->id) {
1479 dev->video.streaming = streaming;
1490 uvc_printk(KERN_INFO, "No valid video chain found.\n");
1494 if (uvc_trace_param & UVC_TRACE_PROBE) {
1495 uvc_printk(KERN_INFO, "Found a valid video chain (");
1496 list_for_each_entry(term, &dev->video.iterms, chain) {
1497 printk("%d", term->id);
1498 if (term->chain.next != &dev->video.iterms)
1501 printk(" -> %d).\n", dev->video.oterm->id);
1504 /* Initialize the video buffers queue. */
1505 uvc_queue_init(&dev->video.queue, dev->video.streaming->type);
1507 /* Initialize the streaming interface with default streaming
1510 if ((ret = uvc_video_init(&dev->video)) < 0) {
1511 uvc_printk(KERN_ERR, "Failed to initialize the device "
1516 /* Register the device with V4L. */
1517 vdev = video_device_alloc();
1521 /* We already hold a reference to dev->udev. The video device will be
1522 * unregistered before the reference is released, so we don't need to
1525 vdev->parent = &dev->intf->dev;
1527 vdev->fops = &uvc_fops;
1528 vdev->release = video_device_release;
1529 strlcpy(vdev->name, dev->name, sizeof vdev->name);
1531 /* Set the driver data before calling video_register_device, otherwise
1532 * uvc_v4l2_open might race us.
1534 dev->video.vdev = vdev;
1535 video_set_drvdata(vdev, &dev->video);
1537 if (video_register_device(vdev, VFL_TYPE_GRABBER, -1) < 0) {
1538 dev->video.vdev = NULL;
1539 video_device_release(vdev);
1547 * Delete the UVC device.
1549 * Called by the kernel when the last reference to the uvc_device structure
1552 * Unregistering the video devices is done here because every opened instance
1553 * must be closed before the device can be unregistered. An alternative would
1554 * have been to use another reference count for uvc_v4l2_open/uvc_release, and
1555 * unregister the video devices on disconnect when that reference count drops
1558 * As this function is called after or during disconnect(), all URBs have
1559 * already been canceled by the USB core. There is no need to kill the
1560 * interrupt URB manually.
1562 void uvc_delete(struct kref *kref)
1564 struct uvc_device *dev = container_of(kref, struct uvc_device, kref);
1565 struct list_head *p, *n;
1567 /* Unregister the video device. */
1568 uvc_unregister_video(dev);
1569 usb_put_intf(dev->intf);
1570 usb_put_dev(dev->udev);
1572 uvc_status_cleanup(dev);
1573 uvc_ctrl_cleanup_device(dev);
1575 list_for_each_safe(p, n, &dev->entities) {
1576 struct uvc_entity *entity;
1577 entity = list_entry(p, struct uvc_entity, list);
1581 list_for_each_safe(p, n, &dev->streaming) {
1582 struct uvc_streaming *streaming;
1583 streaming = list_entry(p, struct uvc_streaming, list);
1584 usb_driver_release_interface(&uvc_driver.driver,
1586 usb_put_intf(streaming->intf);
1587 kfree(streaming->format);
1588 kfree(streaming->header.bmaControls);
1595 static int uvc_probe(struct usb_interface *intf,
1596 const struct usb_device_id *id)
1598 struct usb_device *udev = interface_to_usbdev(intf);
1599 struct uvc_device *dev;
1602 if (id->idVendor && id->idProduct)
1603 uvc_trace(UVC_TRACE_PROBE, "Probing known UVC device %s "
1604 "(%04x:%04x)\n", udev->devpath, id->idVendor,
1607 uvc_trace(UVC_TRACE_PROBE, "Probing generic UVC device %s\n",
1610 /* Allocate memory for the device and initialize it. */
1611 if ((dev = kzalloc(sizeof *dev, GFP_KERNEL)) == NULL)
1614 INIT_LIST_HEAD(&dev->entities);
1615 INIT_LIST_HEAD(&dev->streaming);
1616 kref_init(&dev->kref);
1618 dev->udev = usb_get_dev(udev);
1619 dev->intf = usb_get_intf(intf);
1620 dev->intfnum = intf->cur_altsetting->desc.bInterfaceNumber;
1621 dev->quirks = id->driver_info | uvc_quirks_param;
1623 if (udev->product != NULL)
1624 strlcpy(dev->name, udev->product, sizeof dev->name);
1626 snprintf(dev->name, sizeof dev->name,
1627 "UVC Camera (%04x:%04x)",
1628 le16_to_cpu(udev->descriptor.idVendor),
1629 le16_to_cpu(udev->descriptor.idProduct));
1631 /* Parse the Video Class control descriptor. */
1632 if (uvc_parse_control(dev) < 0) {
1633 uvc_trace(UVC_TRACE_PROBE, "Unable to parse UVC "
1638 uvc_printk(KERN_INFO, "Found UVC %u.%02x device %s (%04x:%04x)\n",
1639 dev->uvc_version >> 8, dev->uvc_version & 0xff,
1640 udev->product ? udev->product : "<unnamed>",
1641 le16_to_cpu(udev->descriptor.idVendor),
1642 le16_to_cpu(udev->descriptor.idProduct));
1644 if (uvc_quirks_param != 0) {
1645 uvc_printk(KERN_INFO, "Forcing device quirks 0x%x by module "
1646 "parameter for testing purpose.\n", uvc_quirks_param);
1647 uvc_printk(KERN_INFO, "Please report required quirks to the "
1648 "linux-uvc-devel mailing list.\n");
1651 /* Initialize controls. */
1652 if (uvc_ctrl_init_device(dev) < 0)
1655 /* Register the video devices. */
1656 if (uvc_register_video(dev) < 0)
1659 /* Save our data pointer in the interface data. */
1660 usb_set_intfdata(intf, dev);
1662 /* Initialize the interrupt URB. */
1663 if ((ret = uvc_status_init(dev)) < 0) {
1664 uvc_printk(KERN_INFO, "Unable to initialize the status "
1665 "endpoint (%d), status interrupt will not be "
1666 "supported.\n", ret);
1669 uvc_trace(UVC_TRACE_PROBE, "UVC device initialized.\n");
1673 kref_put(&dev->kref, uvc_delete);
1677 static void uvc_disconnect(struct usb_interface *intf)
1679 struct uvc_device *dev = usb_get_intfdata(intf);
1681 /* Set the USB interface data to NULL. This can be done outside the
1682 * lock, as there's no other reader.
1684 usb_set_intfdata(intf, NULL);
1686 if (intf->cur_altsetting->desc.bInterfaceSubClass == SC_VIDEOSTREAMING)
1689 /* uvc_v4l2_open() might race uvc_disconnect(). A static driver-wide
1690 * lock is needed to prevent uvc_disconnect from releasing its
1691 * reference to the uvc_device instance after uvc_v4l2_open() received
1692 * the pointer to the device (video_devdata) but before it got the
1693 * chance to increase the reference count (kref_get).
1695 * Note that the reference can't be released with the lock held,
1696 * otherwise a AB-BA deadlock can occur with videodev_lock that
1697 * videodev acquires in videodev_open() and video_unregister_device().
1699 mutex_lock(&uvc_driver.open_mutex);
1700 dev->state |= UVC_DEV_DISCONNECTED;
1701 mutex_unlock(&uvc_driver.open_mutex);
1703 kref_put(&dev->kref, uvc_delete);
1706 static int uvc_suspend(struct usb_interface *intf, pm_message_t message)
1708 struct uvc_device *dev = usb_get_intfdata(intf);
1710 uvc_trace(UVC_TRACE_SUSPEND, "Suspending interface %u\n",
1711 intf->cur_altsetting->desc.bInterfaceNumber);
1713 /* Controls are cached on the fly so they don't need to be saved. */
1714 if (intf->cur_altsetting->desc.bInterfaceSubClass == SC_VIDEOCONTROL)
1715 return uvc_status_suspend(dev);
1717 if (dev->video.streaming->intf != intf) {
1718 uvc_trace(UVC_TRACE_SUSPEND, "Suspend: video streaming USB "
1719 "interface mismatch.\n");
1723 return uvc_video_suspend(&dev->video);
1726 static int __uvc_resume(struct usb_interface *intf, int reset)
1728 struct uvc_device *dev = usb_get_intfdata(intf);
1730 uvc_trace(UVC_TRACE_SUSPEND, "Resuming interface %u\n",
1731 intf->cur_altsetting->desc.bInterfaceNumber);
1733 if (intf->cur_altsetting->desc.bInterfaceSubClass == SC_VIDEOCONTROL) {
1735 int ret = uvc_ctrl_resume_device(dev);
1741 return uvc_status_resume(dev);
1744 if (dev->video.streaming->intf != intf) {
1745 uvc_trace(UVC_TRACE_SUSPEND, "Resume: video streaming USB "
1746 "interface mismatch.\n");
1750 return uvc_video_resume(&dev->video);
1753 static int uvc_resume(struct usb_interface *intf)
1755 return __uvc_resume(intf, 0);
1758 static int uvc_reset_resume(struct usb_interface *intf)
1760 return __uvc_resume(intf, 1);
1763 /* ------------------------------------------------------------------------
1764 * Driver initialization and cleanup
1768 * The Logitech cameras listed below have their interface class set to
1769 * VENDOR_SPEC because they don't announce themselves as UVC devices, even
1770 * though they are compliant.
1772 static struct usb_device_id uvc_ids[] = {
1773 /* Microsoft Lifecam NX-6000 */
1774 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1775 | USB_DEVICE_ID_MATCH_INT_INFO,
1777 .idProduct = 0x00f8,
1778 .bInterfaceClass = USB_CLASS_VIDEO,
1779 .bInterfaceSubClass = 1,
1780 .bInterfaceProtocol = 0,
1781 .driver_info = UVC_QUIRK_PROBE_MINMAX },
1782 /* Microsoft Lifecam VX-7000 */
1783 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1784 | USB_DEVICE_ID_MATCH_INT_INFO,
1786 .idProduct = 0x0723,
1787 .bInterfaceClass = USB_CLASS_VIDEO,
1788 .bInterfaceSubClass = 1,
1789 .bInterfaceProtocol = 0,
1790 .driver_info = UVC_QUIRK_PROBE_MINMAX },
1791 /* Logitech Quickcam Fusion */
1792 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1793 | USB_DEVICE_ID_MATCH_INT_INFO,
1795 .idProduct = 0x08c1,
1796 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
1797 .bInterfaceSubClass = 1,
1798 .bInterfaceProtocol = 0 },
1799 /* Logitech Quickcam Orbit MP */
1800 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1801 | USB_DEVICE_ID_MATCH_INT_INFO,
1803 .idProduct = 0x08c2,
1804 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
1805 .bInterfaceSubClass = 1,
1806 .bInterfaceProtocol = 0 },
1807 /* Logitech Quickcam Pro for Notebook */
1808 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1809 | USB_DEVICE_ID_MATCH_INT_INFO,
1811 .idProduct = 0x08c3,
1812 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
1813 .bInterfaceSubClass = 1,
1814 .bInterfaceProtocol = 0 },
1815 /* Logitech Quickcam Pro 5000 */
1816 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1817 | USB_DEVICE_ID_MATCH_INT_INFO,
1819 .idProduct = 0x08c5,
1820 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
1821 .bInterfaceSubClass = 1,
1822 .bInterfaceProtocol = 0 },
1823 /* Logitech Quickcam OEM Dell Notebook */
1824 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1825 | USB_DEVICE_ID_MATCH_INT_INFO,
1827 .idProduct = 0x08c6,
1828 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
1829 .bInterfaceSubClass = 1,
1830 .bInterfaceProtocol = 0 },
1831 /* Logitech Quickcam OEM Cisco VT Camera II */
1832 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1833 | USB_DEVICE_ID_MATCH_INT_INFO,
1835 .idProduct = 0x08c7,
1836 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
1837 .bInterfaceSubClass = 1,
1838 .bInterfaceProtocol = 0 },
1839 /* Alcor Micro AU3820 (Future Boy PC USB Webcam) */
1840 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1841 | USB_DEVICE_ID_MATCH_INT_INFO,
1843 .idProduct = 0x3820,
1844 .bInterfaceClass = USB_CLASS_VIDEO,
1845 .bInterfaceSubClass = 1,
1846 .bInterfaceProtocol = 0,
1847 .driver_info = UVC_QUIRK_PROBE_MINMAX },
1848 /* Apple Built-In iSight */
1849 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1850 | USB_DEVICE_ID_MATCH_INT_INFO,
1852 .idProduct = 0x8501,
1853 .bInterfaceClass = USB_CLASS_VIDEO,
1854 .bInterfaceSubClass = 1,
1855 .bInterfaceProtocol = 0,
1856 .driver_info = UVC_QUIRK_PROBE_MINMAX
1857 | UVC_QUIRK_BUILTIN_ISIGHT },
1858 /* Genesys Logic USB 2.0 PC Camera */
1859 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1860 | USB_DEVICE_ID_MATCH_INT_INFO,
1862 .idProduct = 0x0505,
1863 .bInterfaceClass = USB_CLASS_VIDEO,
1864 .bInterfaceSubClass = 1,
1865 .bInterfaceProtocol = 0,
1866 .driver_info = UVC_QUIRK_STREAM_NO_FID },
1868 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
1869 | USB_DEVICE_ID_MATCH_INT_INFO,
1871 .idProduct = 0x0000,
1872 .bInterfaceClass = USB_CLASS_VIDEO,
1873 .bInterfaceSubClass = 1,
1874 .bInterfaceProtocol = 0,
1875 .driver_info = UVC_QUIRK_FIX_BANDWIDTH },
1877 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1878 | USB_DEVICE_ID_MATCH_INT_INFO,
1880 .idProduct = 0x0004,
1881 .bInterfaceClass = USB_CLASS_VIDEO,
1882 .bInterfaceSubClass = 1,
1883 .bInterfaceProtocol = 0,
1884 .driver_info = UVC_QUIRK_PROBE_MINMAX },
1885 /* Syntek (HP Spartan) */
1886 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1887 | USB_DEVICE_ID_MATCH_INT_INFO,
1889 .idProduct = 0x5212,
1890 .bInterfaceClass = USB_CLASS_VIDEO,
1891 .bInterfaceSubClass = 1,
1892 .bInterfaceProtocol = 0,
1893 .driver_info = UVC_QUIRK_STREAM_NO_FID },
1894 /* Syntek (Samsung Q310) */
1895 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1896 | USB_DEVICE_ID_MATCH_INT_INFO,
1898 .idProduct = 0x5931,
1899 .bInterfaceClass = USB_CLASS_VIDEO,
1900 .bInterfaceSubClass = 1,
1901 .bInterfaceProtocol = 0,
1902 .driver_info = UVC_QUIRK_STREAM_NO_FID },
1903 /* Syntek (Asus F9SG) */
1904 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1905 | USB_DEVICE_ID_MATCH_INT_INFO,
1907 .idProduct = 0x8a31,
1908 .bInterfaceClass = USB_CLASS_VIDEO,
1909 .bInterfaceSubClass = 1,
1910 .bInterfaceProtocol = 0,
1911 .driver_info = UVC_QUIRK_STREAM_NO_FID },
1912 /* Syntek (Asus U3S) */
1913 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1914 | USB_DEVICE_ID_MATCH_INT_INFO,
1916 .idProduct = 0x8a33,
1917 .bInterfaceClass = USB_CLASS_VIDEO,
1918 .bInterfaceSubClass = 1,
1919 .bInterfaceProtocol = 0,
1920 .driver_info = UVC_QUIRK_STREAM_NO_FID },
1921 /* Syntek (JAOtech Smart Terminal) */
1922 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1923 | USB_DEVICE_ID_MATCH_INT_INFO,
1925 .idProduct = 0x8a34,
1926 .bInterfaceClass = USB_CLASS_VIDEO,
1927 .bInterfaceSubClass = 1,
1928 .bInterfaceProtocol = 0,
1929 .driver_info = UVC_QUIRK_STREAM_NO_FID },
1930 /* Lenovo Thinkpad SL500 */
1931 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1932 | USB_DEVICE_ID_MATCH_INT_INFO,
1934 .idProduct = 0x480b,
1935 .bInterfaceClass = USB_CLASS_VIDEO,
1936 .bInterfaceSubClass = 1,
1937 .bInterfaceProtocol = 0,
1938 .driver_info = UVC_QUIRK_STREAM_NO_FID },
1939 /* Ecamm Pico iMage */
1940 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1941 | USB_DEVICE_ID_MATCH_INT_INFO,
1943 .idProduct = 0xcafe,
1944 .bInterfaceClass = USB_CLASS_VIDEO,
1945 .bInterfaceSubClass = 1,
1946 .bInterfaceProtocol = 0,
1947 .driver_info = UVC_QUIRK_PROBE_EXTRAFIELDS },
1948 /* Bodelin ProScopeHR */
1949 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1950 | USB_DEVICE_ID_MATCH_DEV_HI
1951 | USB_DEVICE_ID_MATCH_INT_INFO,
1953 .idProduct = 0x1000,
1954 .bcdDevice_hi = 0x0126,
1955 .bInterfaceClass = USB_CLASS_VIDEO,
1956 .bInterfaceSubClass = 1,
1957 .bInterfaceProtocol = 0,
1958 .driver_info = UVC_QUIRK_STATUS_INTERVAL },
1959 /* SiGma Micro USB Web Camera */
1960 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1961 | USB_DEVICE_ID_MATCH_INT_INFO,
1963 .idProduct = 0x3000,
1964 .bInterfaceClass = USB_CLASS_VIDEO,
1965 .bInterfaceSubClass = 1,
1966 .bInterfaceProtocol = 0,
1967 .driver_info = UVC_QUIRK_PROBE_MINMAX
1968 | UVC_QUIRK_IGNORE_SELECTOR_UNIT
1969 | UVC_QUIRK_PRUNE_CONTROLS },
1970 /* Generic USB Video Class */
1971 { USB_INTERFACE_INFO(USB_CLASS_VIDEO, 1, 0) },
1975 MODULE_DEVICE_TABLE(usb, uvc_ids);
1977 struct uvc_driver uvc_driver = {
1981 .disconnect = uvc_disconnect,
1982 .suspend = uvc_suspend,
1983 .resume = uvc_resume,
1984 .reset_resume = uvc_reset_resume,
1985 .id_table = uvc_ids,
1986 .supports_autosuspend = 1,
1990 static int __init uvc_init(void)
1994 INIT_LIST_HEAD(&uvc_driver.devices);
1995 INIT_LIST_HEAD(&uvc_driver.controls);
1996 mutex_init(&uvc_driver.open_mutex);
1997 mutex_init(&uvc_driver.ctrl_mutex);
2001 result = usb_register(&uvc_driver.driver);
2003 printk(KERN_INFO DRIVER_DESC " (" DRIVER_VERSION ")\n");
2007 static void __exit uvc_cleanup(void)
2009 usb_deregister(&uvc_driver.driver);
2012 module_init(uvc_init);
2013 module_exit(uvc_cleanup);
2015 module_param_named(nodrop, uvc_no_drop_param, uint, S_IRUGO|S_IWUSR);
2016 MODULE_PARM_DESC(nodrop, "Don't drop incomplete frames");
2017 module_param_named(quirks, uvc_quirks_param, uint, S_IRUGO|S_IWUSR);
2018 MODULE_PARM_DESC(quirks, "Forced device quirks");
2019 module_param_named(trace, uvc_trace_param, uint, S_IRUGO|S_IWUSR);
2020 MODULE_PARM_DESC(trace, "Trace level bitmask");
2022 MODULE_AUTHOR(DRIVER_AUTHOR);
2023 MODULE_DESCRIPTION(DRIVER_DESC);
2024 MODULE_LICENSE("GPL");
2025 MODULE_VERSION(DRIVER_VERSION);