drivers/media/video/uvc/uvc_driver.c

   1 /*
   2  *      uvc_driver.c  --  USB Video Class driver
   3  *
   4  *      Copyright (C) 2005-2009
   5  *          Laurent Pinchart (laurent.pinchart@skynet.be)
   6  *
   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.
  11  *
  12  */
  13
  14 /*
  15  * This driver aims to support video input and ouput devices compliant with the
  16  * 'USB Video Class' specification.
  17  *
  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.
  24  */
  25
  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>
  35
  36 #include <media/v4l2-common.h>
  37
  38 #include "uvcvideo.h"
  39
  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"
  44 #endif
  45
  46 unsigned int uvc_no_drop_param;
  47 static unsigned int uvc_quirks_param;
  48 unsigned int uvc_trace_param;
  49 unsigned int uvc_timeout_param = UVC_CTRL_STREAMING_TIMEOUT;
  50
  51 /* ------------------------------------------------------------------------
  52  * Video formats
  53  */
  54
  55 static struct uvc_format_desc uvc_fmts[] = {
  56         {
  57                 .name           = "YUV 4:2:2 (YUYV)",
  58                 .guid           = UVC_GUID_FORMAT_YUY2,
  59                 .fcc            = V4L2_PIX_FMT_YUYV,
  60         },
  61         {
  62                 .name           = "YUV 4:2:0 (NV12)",
  63                 .guid           = UVC_GUID_FORMAT_NV12,
  64                 .fcc            = V4L2_PIX_FMT_NV12,
  65         },
  66         {
  67                 .name           = "MJPEG",
  68                 .guid           = UVC_GUID_FORMAT_MJPEG,
  69                 .fcc            = V4L2_PIX_FMT_MJPEG,
  70         },
  71         {
  72                 .name           = "YVU 4:2:0 (YV12)",
  73                 .guid           = UVC_GUID_FORMAT_YV12,
  74                 .fcc            = V4L2_PIX_FMT_YVU420,
  75         },
  76         {
  77                 .name           = "YUV 4:2:0 (I420)",
  78                 .guid           = UVC_GUID_FORMAT_I420,
  79                 .fcc            = V4L2_PIX_FMT_YUV420,
  80         },
  81         {
  82                 .name           = "YUV 4:2:2 (UYVY)",
  83                 .guid           = UVC_GUID_FORMAT_UYVY,
  84                 .fcc            = V4L2_PIX_FMT_UYVY,
  85         },
  86         {
  87                 .name           = "Greyscale",
  88                 .guid           = UVC_GUID_FORMAT_Y800,
  89                 .fcc            = V4L2_PIX_FMT_GREY,
  90         },
  91         {
  92                 .name           = "RGB Bayer",
  93                 .guid           = UVC_GUID_FORMAT_BY8,
  94                 .fcc            = V4L2_PIX_FMT_SBGGR8,
  95         },
  96 };
  97
  98 /* ------------------------------------------------------------------------
  99  * Utility functions
 100  */
 101
 102 struct usb_host_endpoint *uvc_find_endpoint(struct usb_host_interface *alts,
 103                 __u8 epaddr)
 104 {
 105         struct usb_host_endpoint *ep;
 106         unsigned int i;
 107
 108         for (i = 0; i < alts->desc.bNumEndpoints; ++i) {
 109                 ep = &alts->endpoint[i];
 110                 if (ep->desc.bEndpointAddress == epaddr)
 111                         return ep;
 112         }
 113
 114         return NULL;
 115 }
 116
 117 static struct uvc_format_desc *uvc_format_by_guid(const __u8 guid[16])
 118 {
 119         unsigned int len = ARRAY_SIZE(uvc_fmts);
 120         unsigned int i;
 121
 122         for (i = 0; i < len; ++i) {
 123                 if (memcmp(guid, uvc_fmts[i].guid, 16) == 0)
 124                         return &uvc_fmts[i];
 125         }
 126
 127         return NULL;
 128 }
 129
 130 static __u32 uvc_colorspace(const __u8 primaries)
 131 {
 132         static const __u8 colorprimaries[] = {
 133                 0,
 134                 V4L2_COLORSPACE_SRGB,
 135                 V4L2_COLORSPACE_470_SYSTEM_M,
 136                 V4L2_COLORSPACE_470_SYSTEM_BG,
 137                 V4L2_COLORSPACE_SMPTE170M,
 138                 V4L2_COLORSPACE_SMPTE240M,
 139         };
 140
 141         if (primaries < ARRAY_SIZE(colorprimaries))
 142                 return colorprimaries[primaries];
 143
 144         return 0;
 145 }
 146
 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.
 153  */
 154 void uvc_simplify_fraction(uint32_t *numerator, uint32_t *denominator,
 155                 unsigned int n_terms, unsigned int threshold)
 156 {
 157         uint32_t *an;
 158         uint32_t x, y, r;
 159         unsigned int i, n;
 160
 161         an = kmalloc(n_terms * sizeof *an, GFP_KERNEL);
 162         if (an == NULL)
 163                 return;
 164
 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
 168          * threshold.
 169          */
 170         x = *numerator;
 171         y = *denominator;
 172
 173         for (n = 0; n < n_terms && y != 0; ++n) {
 174                 an[n] = x / y;
 175                 if (an[n] >= threshold) {
 176                         if (n < 2)
 177                                 n++;
 178                         break;
 179                 }
 180
 181                 r = x - an[n] * y;
 182                 x = y;
 183                 y = r;
 184         }
 185
 186         /* Expand the simple continued fraction back to an integer fraction. */
 187         x = 0;
 188         y = 1;
 189
 190         for (i = n; i > 0; --i) {
 191                 r = y;
 192                 y = an[i-1] * y + x;
 193                 x = r;
 194         }
 195
 196         *numerator = y;
 197         *denominator = x;
 198         kfree(an);
 199 }
 200
 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
 203  * arithmetic only.
 204  */
 205 uint32_t uvc_fraction_to_interval(uint32_t numerator, uint32_t denominator)
 206 {
 207         uint32_t multiplier;
 208
 209         /* Saturate the result if the operation would overflow. */
 210         if (denominator == 0 ||
 211             numerator/denominator >= ((uint32_t)-1)/10000000)
 212                 return (uint32_t)-1;
 213
 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.
 217          */
 218         multiplier = 10000000;
 219         while (numerator > ((uint32_t)-1)/multiplier) {
 220                 multiplier /= 2;
 221                 denominator /= 2;
 222         }
 223
 224         return denominator ? numerator * multiplier / denominator : 0;
 225 }
 226
 227 /* ------------------------------------------------------------------------
 228  * Terminal and unit management
 229  */
 230
 231 static struct uvc_entity *uvc_entity_by_id(struct uvc_device *dev, int id)
 232 {
 233         struct uvc_entity *entity;
 234
 235         list_for_each_entry(entity, &dev->entities, list) {
 236                 if (entity->id == id)
 237                         return entity;
 238         }
 239
 240         return NULL;
 241 }
 242
 243 static struct uvc_entity *uvc_entity_by_reference(struct uvc_device *dev,
 244         int id, struct uvc_entity *entity)
 245 {
 246         unsigned int i;
 247
 248         if (entity == NULL)
 249                 entity = list_entry(&dev->entities, struct uvc_entity, list);
 250
 251         list_for_each_entry_continue(entity, &dev->entities, list) {
 252                 for (i = 0; i < entity->bNrInPins; ++i)
 253                         if (entity->baSourceID[i] == id)
 254                                 return entity;
 255         }
 256
 257         return NULL;
 258 }
 259
 260 static struct uvc_streaming *uvc_stream_by_id(struct uvc_device *dev, int id)
 261 {
 262         struct uvc_streaming *stream;
 263
 264         list_for_each_entry(stream, &dev->streams, list) {
 265                 if (stream->header.bTerminalLink == id)
 266                         return stream;
 267         }
 268
 269         return NULL;
 270 }
 271
 272 /* ------------------------------------------------------------------------
 273  * Descriptors parsing
 274  */
 275
 276 static int uvc_parse_format(struct uvc_device *dev,
 277         struct uvc_streaming *streaming, struct uvc_format *format,
 278         __u32 **intervals, unsigned char *buffer, int buflen)
 279 {
 280         struct usb_interface *intf = streaming->intf;
 281         struct usb_host_interface *alts = intf->cur_altsetting;
 282         struct uvc_format_desc *fmtdesc;
 283         struct uvc_frame *frame;
 284         const unsigned char *start = buffer;
 285         unsigned int interval;
 286         unsigned int i, n;
 287         __u8 ftype;
 288
 289         format->type = buffer[2];
 290         format->index = buffer[3];
 291
 292         switch (buffer[2]) {
 293         case UVC_VS_FORMAT_UNCOMPRESSED:
 294         case UVC_VS_FORMAT_FRAME_BASED:
 295                 n = buffer[2] == UVC_VS_FORMAT_UNCOMPRESSED ? 27 : 28;
 296                 if (buflen < n) {
 297                         uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
 298                                "interface %d FORMAT error\n",
 299                                dev->udev->devnum,
 300                                alts->desc.bInterfaceNumber);
 301                         return -EINVAL;
 302                 }
 303
 304                 /* Find the format descriptor from its GUID. */
 305                 fmtdesc = uvc_format_by_guid(&buffer[5]);
 306
 307                 if (fmtdesc != NULL) {
 308                         strlcpy(format->name, fmtdesc->name,
 309                                 sizeof format->name);
 310                         format->fcc = fmtdesc->fcc;
 311                 } else {
 312                         uvc_printk(KERN_INFO, "Unknown video format "
 313                                 UVC_GUID_FORMAT "\n",
 314                                 UVC_GUID_ARGS(&buffer[5]));
 315                         snprintf(format->name, sizeof format->name,
 316                                 UVC_GUID_FORMAT, UVC_GUID_ARGS(&buffer[5]));
 317                         format->fcc = 0;
 318                 }
 319
 320                 format->bpp = buffer[21];
 321                 if (buffer[2] == UVC_VS_FORMAT_UNCOMPRESSED) {
 322                         ftype = UVC_VS_FRAME_UNCOMPRESSED;
 323                 } else {
 324                         ftype = UVC_VS_FRAME_FRAME_BASED;
 325                         if (buffer[27])
 326                                 format->flags = UVC_FMT_FLAG_COMPRESSED;
 327                 }
 328                 break;
 329
 330         case UVC_VS_FORMAT_MJPEG:
 331                 if (buflen < 11) {
 332                         uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
 333                                "interface %d FORMAT error\n",
 334                                dev->udev->devnum,
 335                                alts->desc.bInterfaceNumber);
 336                         return -EINVAL;
 337                 }
 338
 339                 strlcpy(format->name, "MJPEG", sizeof format->name);
 340                 format->fcc = V4L2_PIX_FMT_MJPEG;
 341                 format->flags = UVC_FMT_FLAG_COMPRESSED;
 342                 format->bpp = 0;
 343                 ftype = UVC_VS_FRAME_MJPEG;
 344                 break;
 345
 346         case UVC_VS_FORMAT_DV:
 347                 if (buflen < 9) {
 348                         uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
 349                                "interface %d FORMAT error\n",
 350                                dev->udev->devnum,
 351                                alts->desc.bInterfaceNumber);
 352                         return -EINVAL;
 353                 }
 354
 355                 switch (buffer[8] & 0x7f) {
 356                 case 0:
 357                         strlcpy(format->name, "SD-DV", sizeof format->name);
 358                         break;
 359                 case 1:
 360                         strlcpy(format->name, "SDL-DV", sizeof format->name);
 361                         break;
 362                 case 2:
 363                         strlcpy(format->name, "HD-DV", sizeof format->name);
 364                         break;
 365                 default:
 366                         uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
 367                                "interface %d: unknown DV format %u\n",
 368                                dev->udev->devnum,
 369                                alts->desc.bInterfaceNumber, buffer[8]);
 370                         return -EINVAL;
 371                 }
 372
 373                 strlcat(format->name, buffer[8] & (1 << 7) ? " 60Hz" : " 50Hz",
 374                         sizeof format->name);
 375
 376                 format->fcc = V4L2_PIX_FMT_DV;
 377                 format->flags = UVC_FMT_FLAG_COMPRESSED | UVC_FMT_FLAG_STREAM;
 378                 format->bpp = 0;
 379                 ftype = 0;
 380
 381                 /* Create a dummy frame descriptor. */
 382                 frame = &format->frame[0];
 383                 memset(&format->frame[0], 0, sizeof format->frame[0]);
 384                 frame->bFrameIntervalType = 1;
 385                 frame->dwDefaultFrameInterval = 1;
 386                 frame->dwFrameInterval = *intervals;
 387                 *(*intervals)++ = 1;
 388                 format->nframes = 1;
 389                 break;
 390
 391         case UVC_VS_FORMAT_MPEG2TS:
 392         case UVC_VS_FORMAT_STREAM_BASED:
 393                 /* Not supported yet. */
 394         default:
 395                 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
 396                        "interface %d unsupported format %u\n",
 397                        dev->udev->devnum, alts->desc.bInterfaceNumber,
 398                        buffer[2]);
 399                 return -EINVAL;
 400         }
 401
 402         uvc_trace(UVC_TRACE_DESCR, "Found format %s.\n", format->name);
 403
 404         buflen -= buffer[0];
 405         buffer += buffer[0];
 406
 407         /* Parse the frame descriptors. Only uncompressed, MJPEG and frame
 408          * based formats have frame descriptors.
 409          */
 410         while (buflen > 2 && buffer[1] == USB_DT_CS_INTERFACE &&
 411                buffer[2] == ftype) {
 412                 frame = &format->frame[format->nframes];
 413                 if (ftype != UVC_VS_FRAME_FRAME_BASED)
 414                         n = buflen > 25 ? buffer[25] : 0;
 415                 else
 416                         n = buflen > 21 ? buffer[21] : 0;
 417
 418                 n = n ? n : 3;
 419
 420                 if (buflen < 26 + 4*n) {
 421                         uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
 422                                "interface %d FRAME error\n", dev->udev->devnum,
 423                                alts->desc.bInterfaceNumber);
 424                         return -EINVAL;
 425                 }
 426
 427                 frame->bFrameIndex = buffer[3];
 428                 frame->bmCapabilities = buffer[4];
 429                 frame->wWidth = get_unaligned_le16(&buffer[5]);
 430                 frame->wHeight = get_unaligned_le16(&buffer[7]);
 431                 frame->dwMinBitRate = get_unaligned_le32(&buffer[9]);
 432                 frame->dwMaxBitRate = get_unaligned_le32(&buffer[13]);
 433                 if (ftype != UVC_VS_FRAME_FRAME_BASED) {
 434                         frame->dwMaxVideoFrameBufferSize =
 435                                 get_unaligned_le32(&buffer[17]);
 436                         frame->dwDefaultFrameInterval =
 437                                 get_unaligned_le32(&buffer[21]);
 438                         frame->bFrameIntervalType = buffer[25];
 439                 } else {
 440                         frame->dwMaxVideoFrameBufferSize = 0;
 441                         frame->dwDefaultFrameInterval =
 442                                 get_unaligned_le32(&buffer[17]);
 443                         frame->bFrameIntervalType = buffer[21];
 444                 }
 445                 frame->dwFrameInterval = *intervals;
 446
 447                 /* Several UVC chipsets screw up dwMaxVideoFrameBufferSize
 448                  * completely. Observed behaviours range from setting the
 449                  * value to 1.1x the actual frame size to hardwiring the
 450                  * 16 low bits to 0. This results in a higher than necessary
 451                  * memory usage as well as a wrong image size information. For
 452                  * uncompressed formats this can be fixed by computing the
 453                  * value from the frame size.
 454                  */
 455                 if (!(format->flags & UVC_FMT_FLAG_COMPRESSED))
 456                         frame->dwMaxVideoFrameBufferSize = format->bpp
 457                                 * frame->wWidth * frame->wHeight / 8;
 458
 459                 /* Some bogus devices report dwMinFrameInterval equal to
 460                  * dwMaxFrameInterval and have dwFrameIntervalStep set to
 461                  * zero. Setting all null intervals to 1 fixes the problem and
 462                  * some other divisions by zero that could happen.
 463                  */
 464                 for (i = 0; i < n; ++i) {
 465                         interval = get_unaligned_le32(&buffer[26+4*i]);
 466                         *(*intervals)++ = interval ? interval : 1;
 467                 }
 468
 469                 /* Make sure that the default frame interval stays between
 470                  * the boundaries.
 471                  */
 472                 n -= frame->bFrameIntervalType ? 1 : 2;
 473                 frame->dwDefaultFrameInterval =
 474                         min(frame->dwFrameInterval[n],
 475                             max(frame->dwFrameInterval[0],
 476                                 frame->dwDefaultFrameInterval));
 477
 478                 uvc_trace(UVC_TRACE_DESCR, "- %ux%u (%u.%u fps)\n",
 479                         frame->wWidth, frame->wHeight,
 480                         10000000/frame->dwDefaultFrameInterval,
 481                         (100000000/frame->dwDefaultFrameInterval)%10);
 482
 483                 format->nframes++;
 484                 buflen -= buffer[0];
 485                 buffer += buffer[0];
 486         }
 487
 488         if (buflen > 2 && buffer[1] == USB_DT_CS_INTERFACE &&
 489             buffer[2] == UVC_VS_STILL_IMAGE_FRAME) {
 490                 buflen -= buffer[0];
 491                 buffer += buffer[0];
 492         }
 493
 494         if (buflen > 2 && buffer[1] == USB_DT_CS_INTERFACE &&
 495             buffer[2] == UVC_VS_COLORFORMAT) {
 496                 if (buflen < 6) {
 497                         uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
 498                                "interface %d COLORFORMAT error\n",
 499                                dev->udev->devnum,
 500                                alts->desc.bInterfaceNumber);
 501                         return -EINVAL;
 502                 }
 503
 504                 format->colorspace = uvc_colorspace(buffer[3]);
 505
 506                 buflen -= buffer[0];
 507                 buffer += buffer[0];
 508         }
 509
 510         return buffer - start;
 511 }
 512
 513 static int uvc_parse_streaming(struct uvc_device *dev,
 514         struct usb_interface *intf)
 515 {
 516         struct uvc_streaming *streaming = NULL;
 517         struct uvc_format *format;
 518         struct uvc_frame *frame;
 519         struct usb_host_interface *alts = &intf->altsetting[0];
 520         unsigned char *_buffer, *buffer = alts->extra;
 521         int _buflen, buflen = alts->extralen;
 522         unsigned int nformats = 0, nframes = 0, nintervals = 0;
 523         unsigned int size, i, n, p;
 524         __u32 *interval;
 525         __u16 psize;
 526         int ret = -EINVAL;
 527
 528         if (intf->cur_altsetting->desc.bInterfaceSubClass
 529                 != UVC_SC_VIDEOSTREAMING) {
 530                 uvc_trace(UVC_TRACE_DESCR, "device %d interface %d isn't a "
 531                         "video streaming interface\n", dev->udev->devnum,
 532                         intf->altsetting[0].desc.bInterfaceNumber);
 533                 return -EINVAL;
 534         }
 535
 536         if (usb_driver_claim_interface(&uvc_driver.driver, intf, dev)) {
 537                 uvc_trace(UVC_TRACE_DESCR, "device %d interface %d is already "
 538                         "claimed\n", dev->udev->devnum,
 539                         intf->altsetting[0].desc.bInterfaceNumber);
 540                 return -EINVAL;
 541         }
 542
 543         streaming = kzalloc(sizeof *streaming, GFP_KERNEL);
 544         if (streaming == NULL) {
 545                 usb_driver_release_interface(&uvc_driver.driver, intf);
 546                 return -EINVAL;
 547         }
 548
 549         mutex_init(&streaming->mutex);
 550         streaming->dev = dev;
 551         streaming->intf = usb_get_intf(intf);
 552         streaming->intfnum = intf->cur_altsetting->desc.bInterfaceNumber;
 553
 554         /* The Pico iMage webcam has its class-specific interface descriptors
 555          * after the endpoint descriptors.
 556          */
 557         if (buflen == 0) {
 558                 for (i = 0; i < alts->desc.bNumEndpoints; ++i) {
 559                         struct usb_host_endpoint *ep = &alts->endpoint[i];
 560
 561                         if (ep->extralen == 0)
 562                                 continue;
 563
 564                         if (ep->extralen > 2 &&
 565                             ep->extra[1] == USB_DT_CS_INTERFACE) {
 566                                 uvc_trace(UVC_TRACE_DESCR, "trying extra data "
 567                                         "from endpoint %u.\n", i);
 568                                 buffer = alts->endpoint[i].extra;
 569                                 buflen = alts->endpoint[i].extralen;
 570                                 break;
 571                         }
 572                 }
 573         }
 574
 575         /* Skip the standard interface descriptors. */
 576         while (buflen > 2 && buffer[1] != USB_DT_CS_INTERFACE) {
 577                 buflen -= buffer[0];
 578                 buffer += buffer[0];
 579         }
 580
 581         if (buflen <= 2) {
 582                 uvc_trace(UVC_TRACE_DESCR, "no class-specific streaming "
 583                         "interface descriptors found.\n");
 584                 goto error;
 585         }
 586
 587         /* Parse the header descriptor. */
 588         switch (buffer[2]) {
 589         case UVC_VS_OUTPUT_HEADER:
 590                 streaming->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
 591                 size = 9;
 592                 break;
 593
 594         case UVC_VS_INPUT_HEADER:
 595                 streaming->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
 596                 size = 13;
 597                 break;
 598
 599         default:
 600                 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming interface "
 601                         "%d HEADER descriptor not found.\n", dev->udev->devnum,
 602                         alts->desc.bInterfaceNumber);
 603                 goto error;
 604         }
 605
 606         p = buflen >= 4 ? buffer[3] : 0;
 607         n = buflen >= size ? buffer[size-1] : 0;
 608
 609         if (buflen < size + p*n) {
 610                 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
 611                         "interface %d HEADER descriptor is invalid.\n",
 612                         dev->udev->devnum, alts->desc.bInterfaceNumber);
 613                 goto error;
 614         }
 615
 616         streaming->header.bNumFormats = p;
 617         streaming->header.bEndpointAddress = buffer[6];
 618         if (buffer[2] == UVC_VS_INPUT_HEADER) {
 619                 streaming->header.bmInfo = buffer[7];
 620                 streaming->header.bTerminalLink = buffer[8];
 621                 streaming->header.bStillCaptureMethod = buffer[9];
 622                 streaming->header.bTriggerSupport = buffer[10];
 623                 streaming->header.bTriggerUsage = buffer[11];
 624         } else {
 625                 streaming->header.bTerminalLink = buffer[7];
 626         }
 627         streaming->header.bControlSize = n;
 628
 629         streaming->header.bmaControls = kmalloc(p*n, GFP_KERNEL);
 630         if (streaming->header.bmaControls == NULL) {
 631                 ret = -ENOMEM;
 632                 goto error;
 633         }
 634
 635         memcpy(streaming->header.bmaControls, &buffer[size], p*n);
 636
 637         buflen -= buffer[0];
 638         buffer += buffer[0];
 639
 640         _buffer = buffer;
 641         _buflen = buflen;
 642
 643         /* Count the format and frame descriptors. */
 644         while (_buflen > 2 && _buffer[1] == USB_DT_CS_INTERFACE) {
 645                 switch (_buffer[2]) {
 646                 case UVC_VS_FORMAT_UNCOMPRESSED:
 647                 case UVC_VS_FORMAT_MJPEG:
 648                 case UVC_VS_FORMAT_FRAME_BASED:
 649                         nformats++;
 650                         break;
 651
 652                 case UVC_VS_FORMAT_DV:
 653                         /* DV format has no frame descriptor. We will create a
 654                          * dummy frame descriptor with a dummy frame interval.
 655                          */
 656                         nformats++;
 657                         nframes++;
 658                         nintervals++;
 659                         break;
 660
 661                 case UVC_VS_FORMAT_MPEG2TS:
 662                 case UVC_VS_FORMAT_STREAM_BASED:
 663                         uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
 664                                 "interface %d FORMAT %u is not supported.\n",
 665                                 dev->udev->devnum,
 666                                 alts->desc.bInterfaceNumber, _buffer[2]);
 667                         break;
 668
 669                 case UVC_VS_FRAME_UNCOMPRESSED:
 670                 case UVC_VS_FRAME_MJPEG:
 671                         nframes++;
 672                         if (_buflen > 25)
 673                                 nintervals += _buffer[25] ? _buffer[25] : 3;
 674                         break;
 675
 676                 case UVC_VS_FRAME_FRAME_BASED:
 677                         nframes++;
 678                         if (_buflen > 21)
 679                                 nintervals += _buffer[21] ? _buffer[21] : 3;
 680                         break;
 681                 }
 682
 683                 _buflen -= _buffer[0];
 684                 _buffer += _buffer[0];
 685         }
 686
 687         if (nformats == 0) {
 688                 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming interface "
 689                         "%d has no supported formats defined.\n",
 690                         dev->udev->devnum, alts->desc.bInterfaceNumber);
 691                 goto error;
 692         }
 693
 694         size = nformats * sizeof *format + nframes * sizeof *frame
 695              + nintervals * sizeof *interval;
 696         format = kzalloc(size, GFP_KERNEL);
 697         if (format == NULL) {
 698                 ret = -ENOMEM;
 699                 goto error;
 700         }
 701
 702         frame = (struct uvc_frame *)&format[nformats];
 703         interval = (__u32 *)&frame[nframes];
 704
 705         streaming->format = format;
 706         streaming->nformats = nformats;
 707
 708         /* Parse the format descriptors. */
 709         while (buflen > 2 && buffer[1] == USB_DT_CS_INTERFACE) {
 710                 switch (buffer[2]) {
 711                 case UVC_VS_FORMAT_UNCOMPRESSED:
 712                 case UVC_VS_FORMAT_MJPEG:
 713                 case UVC_VS_FORMAT_DV:
 714                 case UVC_VS_FORMAT_FRAME_BASED:
 715                         format->frame = frame;
 716                         ret = uvc_parse_format(dev, streaming, format,
 717                                 &interval, buffer, buflen);
 718                         if (ret < 0)
 719                                 goto error;
 720
 721                         frame += format->nframes;
 722                         format++;
 723
 724                         buflen -= ret;
 725                         buffer += ret;
 726                         continue;
 727
 728                 default:
 729                         break;
 730                 }
 731
 732                 buflen -= buffer[0];
 733                 buffer += buffer[0];
 734         }
 735
 736         if (buflen)
 737                 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming interface "
 738                         "%d has %u bytes of trailing descriptor garbage.\n",
 739                         dev->udev->devnum, alts->desc.bInterfaceNumber, buflen);
 740
 741         /* Parse the alternate settings to find the maximum bandwidth. */
 742         for (i = 0; i < intf->num_altsetting; ++i) {
 743                 struct usb_host_endpoint *ep;
 744                 alts = &intf->altsetting[i];
 745                 ep = uvc_find_endpoint(alts,
 746                                 streaming->header.bEndpointAddress);
 747                 if (ep == NULL)
 748                         continue;
 749
 750                 psize = le16_to_cpu(ep->desc.wMaxPacketSize);
 751                 psize = (psize & 0x07ff) * (1 + ((psize >> 11) & 3));
 752                 if (psize > streaming->maxpsize)
 753                         streaming->maxpsize = psize;
 754         }
 755
 756         list_add_tail(&streaming->list, &dev->streams);
 757         return 0;
 758
 759 error:
 760         usb_driver_release_interface(&uvc_driver.driver, intf);
 761         usb_put_intf(intf);
 762         kfree(streaming->format);
 763         kfree(streaming->header.bmaControls);
 764         kfree(streaming);
 765         return ret;
 766 }
 767
 768 static struct uvc_entity *uvc_alloc_entity(u16 type, u8 id,
 769                 unsigned int num_pads, unsigned int extra_size)
 770 {
 771         struct uvc_entity *entity;
 772         unsigned int num_inputs;
 773         unsigned int size;
 774
 775         num_inputs = (type & UVC_TERM_OUTPUT) ? num_pads : num_pads - 1;
 776         size = sizeof(*entity) + extra_size + num_inputs;
 777         entity = kzalloc(size, GFP_KERNEL);
 778         if (entity == NULL)
 779                 return NULL;
 780
 781         entity->id = id;
 782         entity->type = type;
 783
 784         entity->bNrInPins = num_inputs;
 785         entity->baSourceID = ((__u8 *)entity) + sizeof(*entity) + extra_size;
 786
 787         return entity;
 788 }
 789
 790 /* Parse vendor-specific extensions. */
 791 static int uvc_parse_vendor_control(struct uvc_device *dev,
 792         const unsigned char *buffer, int buflen)
 793 {
 794         struct usb_device *udev = dev->udev;
 795         struct usb_host_interface *alts = dev->intf->cur_altsetting;
 796         struct uvc_entity *unit;
 797         unsigned int n, p;
 798         int handled = 0;
 799
 800         switch (le16_to_cpu(dev->udev->descriptor.idVendor)) {
 801         case 0x046d:            /* Logitech */
 802                 if (buffer[1] != 0x41 || buffer[2] != 0x01)
 803                         break;
 804
 805                 /* Logitech implements several vendor specific functions
 806                  * through vendor specific extension units (LXU).
 807                  *
 808                  * The LXU descriptors are similar to XU descriptors
 809                  * (see "USB Device Video Class for Video Devices", section
 810                  * 3.7.2.6 "Extension Unit Descriptor") with the following
 811                  * differences:
 812                  *
 813                  * ----------------------------------------------------------
 814                  * 0            bLength         1        Number
 815                  *      Size of this descriptor, in bytes: 24+p+n*2
 816                  * ----------------------------------------------------------
 817                  * 23+p+n       bmControlsType  N       Bitmap
 818                  *      Individual bits in the set are defined:
 819                  *      0: Absolute
 820                  *      1: Relative
 821                  *
 822                  *      This bitset is mapped exactly the same as bmControls.
 823                  * ----------------------------------------------------------
 824                  * 23+p+n*2     bReserved       1       Boolean
 825                  * ----------------------------------------------------------
 826                  * 24+p+n*2     iExtension      1       Index
 827                  *      Index of a string descriptor that describes this
 828                  *      extension unit.
 829                  * ----------------------------------------------------------
 830                  */
 831                 p = buflen >= 22 ? buffer[21] : 0;
 832                 n = buflen >= 25 + p ? buffer[22+p] : 0;
 833
 834                 if (buflen < 25 + p + 2*n) {
 835                         uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
 836                                 "interface %d EXTENSION_UNIT error\n",
 837                                 udev->devnum, alts->desc.bInterfaceNumber);
 838                         break;
 839                 }
 840
 841                 unit = uvc_alloc_entity(UVC_VC_EXTENSION_UNIT, buffer[3],
 842                                         p + 1, 2*n);
 843                 if (unit == NULL)
 844                         return -ENOMEM;
 845
 846                 memcpy(unit->extension.guidExtensionCode, &buffer[4], 16);
 847                 unit->extension.bNumControls = buffer[20];
 848                 memcpy(unit->baSourceID, &buffer[22], p);
 849                 unit->extension.bControlSize = buffer[22+p];
 850                 unit->extension.bmControls = (__u8 *)unit + sizeof(*unit);
 851                 unit->extension.bmControlsType = (__u8 *)unit + sizeof(*unit)
 852                                                + n;
 853                 memcpy(unit->extension.bmControls, &buffer[23+p], 2*n);
 854
 855                 if (buffer[24+p+2*n] != 0)
 856                         usb_string(udev, buffer[24+p+2*n], unit->name,
 857                                    sizeof unit->name);
 858                 else
 859                         sprintf(unit->name, "Extension %u", buffer[3]);
 860
 861                 list_add_tail(&unit->list, &dev->entities);
 862                 handled = 1;
 863                 break;
 864         }
 865
 866         return handled;
 867 }
 868
 869 static int uvc_parse_standard_control(struct uvc_device *dev,
 870         const unsigned char *buffer, int buflen)
 871 {
 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;
 877         __u16 type;
 878
 879         switch (buffer[2]) {
 880         case UVC_VC_HEADER:
 881                 n = buflen >= 12 ? buffer[11] : 0;
 882
 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);
 887                         return -EINVAL;
 888                 }
 889
 890                 dev->uvc_version = get_unaligned_le16(&buffer[3]);
 891                 dev->clock_frequency = get_unaligned_le32(&buffer[7]);
 892
 893                 /* Parse all USB Video Streaming interfaces. */
 894                 for (i = 0; i < n; ++i) {
 895                         intf = usb_ifnum_to_if(udev, buffer[12+i]);
 896                         if (intf == NULL) {
 897                                 uvc_trace(UVC_TRACE_DESCR, "device %d "
 898                                         "interface %d doesn't exists\n",
 899                                         udev->devnum, i);
 900                                 continue;
 901                         }
 902
 903                         uvc_parse_streaming(dev, intf);
 904                 }
 905                 break;
 906
 907         case UVC_VC_INPUT_TERMINAL:
 908                 if (buflen < 8) {
 909                         uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
 910                                 "interface %d INPUT_TERMINAL error\n",
 911                                 udev->devnum, alts->desc.bInterfaceNumber);
 912                         return -EINVAL;
 913                 }
 914
 915                 /* Make sure the terminal type MSB is not null, otherwise it
 916                  * could be confused with a unit.
 917                  */
 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,
 924                                 buffer[3], type);
 925                         return 0;
 926                 }
 927
 928                 n = 0;
 929                 p = 0;
 930                 len = 8;
 931
 932                 if (type == UVC_ITT_CAMERA) {
 933                         n = buflen >= 15 ? buffer[14] : 0;
 934                         len = 15;
 935
 936                 } else if (type == UVC_ITT_MEDIA_TRANSPORT_INPUT) {
 937                         n = buflen >= 9 ? buffer[8] : 0;
 938                         p = buflen >= 10 + n ? buffer[9+n] : 0;
 939                         len = 10;
 940                 }
 941
 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);
 946                         return -EINVAL;
 947                 }
 948
 949                 term = uvc_alloc_entity(type | UVC_TERM_INPUT, buffer[3],
 950                                         1, n + p);
 951                 if (term == NULL)
 952                         return -ENOMEM;
 953
 954                 if (UVC_ENTITY_TYPE(term) == UVC_ITT_CAMERA) {
 955                         term->camera.bControlSize = n;
 956                         term->camera.bmControls = (__u8 *)term + sizeof *term;
 957                         term->camera.wObjectiveFocalLengthMin =
 958                                 get_unaligned_le16(&buffer[8]);
 959                         term->camera.wObjectiveFocalLengthMax =
 960                                 get_unaligned_le16(&buffer[10]);
 961                         term->camera.wOcularFocalLength =
 962                                 get_unaligned_le16(&buffer[12]);
 963                         memcpy(term->camera.bmControls, &buffer[15], n);
 964                 } else if (UVC_ENTITY_TYPE(term) ==
 965                            UVC_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
 970                                                      + sizeof *term + n;
 971                         memcpy(term->media.bmControls, &buffer[9], n);
 972                         memcpy(term->media.bmTransportModes, &buffer[10+n], p);
 973                 }
 974
 975                 if (buffer[7] != 0)
 976                         usb_string(udev, buffer[7], term->name,
 977                                    sizeof term->name);
 978                 else if (UVC_ENTITY_TYPE(term) == UVC_ITT_CAMERA)
 979                         sprintf(term->name, "Camera %u", buffer[3]);
 980                 else if (UVC_ENTITY_TYPE(term) == UVC_ITT_MEDIA_TRANSPORT_INPUT)
 981                         sprintf(term->name, "Media %u", buffer[3]);
 982                 else
 983                         sprintf(term->name, "Input %u", buffer[3]);
 984
 985                 list_add_tail(&term->list, &dev->entities);
 986                 break;
 987
 988         case UVC_VC_OUTPUT_TERMINAL:
 989                 if (buflen < 9) {
 990                         uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
 991                                 "interface %d OUTPUT_TERMINAL error\n",
 992                                 udev->devnum, alts->desc.bInterfaceNumber);
 993                         return -EINVAL;
 994                 }
 995
 996                 /* Make sure the terminal type MSB is not null, otherwise it
 997                  * could be confused with a unit.
 998                  */
 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);
1005                         return 0;
1006                 }
1007
1008                 term = uvc_alloc_entity(type | UVC_TERM_OUTPUT, buffer[3],
1009                                         1, 0);
1010                 if (term == NULL)
1011                         return -ENOMEM;
1012
1013                 memcpy(term->baSourceID, &buffer[7], 1);
1014
1015                 if (buffer[8] != 0)
1016                         usb_string(udev, buffer[8], term->name,
1017                                    sizeof term->name);
1018                 else
1019                         sprintf(term->name, "Output %u", buffer[3]);
1020
1021                 list_add_tail(&term->list, &dev->entities);
1022                 break;
1023
1024         case UVC_VC_SELECTOR_UNIT:
1025                 p = buflen >= 5 ? buffer[4] : 0;
1026
1027                 if (buflen < 5 || buflen < 6 + p) {
1028                         uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1029                                 "interface %d SELECTOR_UNIT error\n",
1030                                 udev->devnum, alts->desc.bInterfaceNumber);
1031                         return -EINVAL;
1032                 }
1033
1034                 unit = uvc_alloc_entity(buffer[2], buffer[3], p + 1, 0);
1035                 if (unit == NULL)
1036                         return -ENOMEM;
1037
1038                 memcpy(unit->baSourceID, &buffer[5], p);
1039
1040                 if (buffer[5+p] != 0)
1041                         usb_string(udev, buffer[5+p], unit->name,
1042                                    sizeof unit->name);
1043                 else
1044                         sprintf(unit->name, "Selector %u", buffer[3]);
1045
1046                 list_add_tail(&unit->list, &dev->entities);
1047                 break;
1048
1049         case UVC_VC_PROCESSING_UNIT:
1050                 n = buflen >= 8 ? buffer[7] : 0;
1051                 p = dev->uvc_version >= 0x0110 ? 10 : 9;
1052
1053                 if (buflen < p + n) {
1054                         uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1055                                 "interface %d PROCESSING_UNIT error\n",
1056                                 udev->devnum, alts->desc.bInterfaceNumber);
1057                         return -EINVAL;
1058                 }
1059
1060                 unit = uvc_alloc_entity(buffer[2], buffer[3], 2, n);
1061                 if (unit == NULL)
1062                         return -ENOMEM;
1063
1064                 memcpy(unit->baSourceID, &buffer[4], 1);
1065                 unit->processing.wMaxMultiplier =
1066                         get_unaligned_le16(&buffer[5]);
1067                 unit->processing.bControlSize = buffer[7];
1068                 unit->processing.bmControls = (__u8 *)unit + sizeof *unit;
1069                 memcpy(unit->processing.bmControls, &buffer[8], n);
1070                 if (dev->uvc_version >= 0x0110)
1071                         unit->processing.bmVideoStandards = buffer[9+n];
1072
1073                 if (buffer[8+n] != 0)
1074                         usb_string(udev, buffer[8+n], unit->name,
1075                                    sizeof unit->name);
1076                 else
1077                         sprintf(unit->name, "Processing %u", buffer[3]);
1078
1079                 list_add_tail(&unit->list, &dev->entities);
1080                 break;
1081
1082         case UVC_VC_EXTENSION_UNIT:
1083                 p = buflen >= 22 ? buffer[21] : 0;
1084                 n = buflen >= 24 + p ? buffer[22+p] : 0;
1085
1086                 if (buflen < 24 + p + n) {
1087                         uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1088                                 "interface %d EXTENSION_UNIT error\n",
1089                                 udev->devnum, alts->desc.bInterfaceNumber);
1090                         return -EINVAL;
1091                 }
1092
1093                 unit = uvc_alloc_entity(buffer[2], buffer[3], p + 1, n);
1094                 if (unit == NULL)
1095                         return -ENOMEM;
1096
1097                 memcpy(unit->extension.guidExtensionCode, &buffer[4], 16);
1098                 unit->extension.bNumControls = buffer[20];
1099                 memcpy(unit->baSourceID, &buffer[22], p);
1100                 unit->extension.bControlSize = buffer[22+p];
1101                 unit->extension.bmControls = (__u8 *)unit + sizeof *unit;
1102                 memcpy(unit->extension.bmControls, &buffer[23+p], n);
1103
1104                 if (buffer[23+p+n] != 0)
1105                         usb_string(udev, buffer[23+p+n], unit->name,
1106                                    sizeof unit->name);
1107                 else
1108                         sprintf(unit->name, "Extension %u", buffer[3]);
1109
1110                 list_add_tail(&unit->list, &dev->entities);
1111                 break;
1112
1113         default:
1114                 uvc_trace(UVC_TRACE_DESCR, "Found an unknown CS_INTERFACE "
1115                         "descriptor (%u)\n", buffer[2]);
1116                 break;
1117         }
1118
1119         return 0;
1120 }
1121
1122 static int uvc_parse_control(struct uvc_device *dev)
1123 {
1124         struct usb_host_interface *alts = dev->intf->cur_altsetting;
1125         unsigned char *buffer = alts->extra;
1126         int buflen = alts->extralen;
1127         int ret;
1128
1129         /* Parse the default alternate setting only, as the UVC specification
1130          * defines a single alternate setting, the default alternate setting
1131          * zero.
1132          */
1133
1134         while (buflen > 2) {
1135                 if (uvc_parse_vendor_control(dev, buffer, buflen) ||
1136                     buffer[1] != USB_DT_CS_INTERFACE)
1137                         goto next_descriptor;
1138
1139                 if ((ret = uvc_parse_standard_control(dev, buffer, buflen)) < 0)
1140                         return ret;
1141
1142 next_descriptor:
1143                 buflen -= buffer[0];
1144                 buffer += buffer[0];
1145         }
1146
1147         /* Check if the optional status endpoint is present. Built-in iSight
1148          * webcams have an interrupt endpoint but spit proprietary data that
1149          * don't conform to the UVC status endpoint messages. Don't try to
1150          * handle the interrupt endpoint for those cameras.
1151          */
1152         if (alts->desc.bNumEndpoints == 1 &&
1153             !(dev->quirks & UVC_QUIRK_BUILTIN_ISIGHT)) {
1154                 struct usb_host_endpoint *ep = &alts->endpoint[0];
1155                 struct usb_endpoint_descriptor *desc = &ep->desc;
1156
1157                 if (usb_endpoint_is_int_in(desc) &&
1158                     le16_to_cpu(desc->wMaxPacketSize) >= 8 &&
1159                     desc->bInterval != 0) {
1160                         uvc_trace(UVC_TRACE_DESCR, "Found a Status endpoint "
1161                                 "(addr %02x).\n", desc->bEndpointAddress);
1162                         dev->int_ep = ep;
1163                 }
1164         }
1165
1166         return 0;
1167 }
1168
1169 /* ------------------------------------------------------------------------
1170  * UVC device scan
1171  */
1172
1173 /*
1174  * Scan the UVC descriptors to locate a chain starting at an Output Terminal
1175  * and containing the following units:
1176  *
1177  * - one or more Output Terminals (USB Streaming or Display)
1178  * - zero or one Processing Unit
1179  * - zero, one or more single-input Selector Units
1180  * - zero or one multiple-input Selector Units, provided all inputs are
1181  *   connected to input terminals
1182  * - zero, one or mode single-input Extension Units
1183  * - one or more Input Terminals (Camera, External or USB Streaming)
1184  *
1185  * The terminal and units must match on of the following structures:
1186  *
1187  * ITT_*(0) -> +---------+    +---------+    +---------+ -> TT_STREAMING(0)
1188  * ...         | SU{0,1} | -> | PU{0,1} | -> | XU{0,n} |    ...
1189  * ITT_*(n) -> +---------+    +---------+    +---------+ -> TT_STREAMING(n)
1190  *
1191  *                 +---------+    +---------+ -> OTT_*(0)
1192  * TT_STREAMING -> | PU{0,1} | -> | XU{0,n} |    ...
1193  *                 +---------+    +---------+ -> OTT_*(n)
1194  *
1195  * The Processing Unit and Extension Units can be in any order. Additional
1196  * Extension Units connected to the main chain as single-unit branches are
1197  * also supported. Single-input Selector Units are ignored.
1198  */
1199 static int uvc_scan_chain_entity(struct uvc_video_chain *chain,
1200         struct uvc_entity *entity)
1201 {
1202         switch (UVC_ENTITY_TYPE(entity)) {
1203         case UVC_VC_EXTENSION_UNIT:
1204                 if (uvc_trace_param & UVC_TRACE_PROBE)
1205                         printk(" <- XU %d", entity->id);
1206
1207                 if (entity->bNrInPins != 1) {
1208                         uvc_trace(UVC_TRACE_DESCR, "Extension unit %d has more "
1209                                 "than 1 input pin.\n", entity->id);
1210                         return -1;
1211                 }
1212
1213                 break;
1214
1215         case UVC_VC_PROCESSING_UNIT:
1216                 if (uvc_trace_param & UVC_TRACE_PROBE)
1217                         printk(" <- PU %d", entity->id);
1218
1219                 if (chain->processing != NULL) {
1220                         uvc_trace(UVC_TRACE_DESCR, "Found multiple "
1221                                 "Processing Units in chain.\n");
1222                         return -1;
1223                 }
1224
1225                 chain->processing = entity;
1226                 break;
1227
1228         case UVC_VC_SELECTOR_UNIT:
1229                 if (uvc_trace_param & UVC_TRACE_PROBE)
1230                         printk(" <- SU %d", entity->id);
1231
1232                 /* Single-input selector units are ignored. */
1233                 if (entity->bNrInPins == 1)
1234                         break;
1235
1236                 if (chain->selector != NULL) {
1237                         uvc_trace(UVC_TRACE_DESCR, "Found multiple Selector "
1238                                 "Units in chain.\n");
1239                         return -1;
1240                 }
1241
1242                 chain->selector = entity;
1243                 break;
1244
1245         case UVC_ITT_VENDOR_SPECIFIC:
1246         case UVC_ITT_CAMERA:
1247         case UVC_ITT_MEDIA_TRANSPORT_INPUT:
1248                 if (uvc_trace_param & UVC_TRACE_PROBE)
1249                         printk(" <- IT %d\n", entity->id);
1250
1251                 break;
1252
1253         case UVC_TT_STREAMING:
1254                 if (UVC_ENTITY_IS_ITERM(entity)) {
1255                         if (uvc_trace_param & UVC_TRACE_PROBE)
1256                                 printk(" <- IT %d\n", entity->id);
1257                 } else {
1258                         if (uvc_trace_param & UVC_TRACE_PROBE)
1259                                 printk(" OT %d", entity->id);
1260                 }
1261
1262                 break;
1263
1264         default:
1265                 uvc_trace(UVC_TRACE_DESCR, "Unsupported entity type "
1266                         "0x%04x found in chain.\n", UVC_ENTITY_TYPE(entity));
1267                 return -1;
1268         }
1269
1270         list_add_tail(&entity->chain, &chain->entities);
1271         return 0;
1272 }
1273
1274 static int uvc_scan_chain_forward(struct uvc_video_chain *chain,
1275         struct uvc_entity *entity, struct uvc_entity *prev)
1276 {
1277         struct uvc_entity *forward;
1278         int found;
1279
1280         /* Forward scan */
1281         forward = NULL;
1282         found = 0;
1283
1284         while (1) {
1285                 forward = uvc_entity_by_reference(chain->dev, entity->id,
1286                         forward);
1287                 if (forward == NULL)
1288                         break;
1289                 if (forward == prev)
1290                         continue;
1291
1292                 switch (UVC_ENTITY_TYPE(forward)) {
1293                 case UVC_VC_EXTENSION_UNIT:
1294                         if (forward->bNrInPins != 1) {
1295                                 uvc_trace(UVC_TRACE_DESCR, "Extension unit %d "
1296                                           "has more than 1 input pin.\n",
1297                                           entity->id);
1298                                 return -EINVAL;
1299                         }
1300
1301                         list_add_tail(&forward->chain, &chain->entities);
1302                         if (uvc_trace_param & UVC_TRACE_PROBE) {
1303                                 if (!found)
1304                                         printk(" (->");
1305
1306                                 printk(" XU %d", forward->id);
1307                                 found = 1;
1308                         }
1309                         break;
1310
1311                 case UVC_OTT_VENDOR_SPECIFIC:
1312                 case UVC_OTT_DISPLAY:
1313                 case UVC_OTT_MEDIA_TRANSPORT_OUTPUT:
1314                 case UVC_TT_STREAMING:
1315                         if (UVC_ENTITY_IS_ITERM(forward)) {
1316                                 uvc_trace(UVC_TRACE_DESCR, "Unsupported input "
1317                                         "terminal %u.\n", forward->id);
1318                                 return -EINVAL;
1319                         }
1320
1321                         list_add_tail(&forward->chain, &chain->entities);
1322                         if (uvc_trace_param & UVC_TRACE_PROBE) {
1323                                 if (!found)
1324                                         printk(" (->");
1325
1326                                 printk(" OT %d", forward->id);
1327                                 found = 1;
1328                         }
1329                         break;
1330                 }
1331         }
1332         if (found)
1333                 printk(")");
1334
1335         return 0;
1336 }
1337
1338 static int uvc_scan_chain_backward(struct uvc_video_chain *chain,
1339         struct uvc_entity **_entity)
1340 {
1341         struct uvc_entity *entity = *_entity;
1342         struct uvc_entity *term;
1343         int id = -EINVAL, i;
1344
1345         switch (UVC_ENTITY_TYPE(entity)) {
1346         case UVC_VC_EXTENSION_UNIT:
1347         case UVC_VC_PROCESSING_UNIT:
1348                 id = entity->baSourceID[0];
1349                 break;
1350
1351         case UVC_VC_SELECTOR_UNIT:
1352                 /* Single-input selector units are ignored. */
1353                 if (entity->bNrInPins == 1) {
1354                         id = entity->baSourceID[0];
1355                         break;
1356                 }
1357
1358                 if (uvc_trace_param & UVC_TRACE_PROBE)
1359                         printk(" <- IT");
1360
1361                 chain->selector = entity;
1362                 for (i = 0; i < entity->bNrInPins; ++i) {
1363                         id = entity->baSourceID[i];
1364                         term = uvc_entity_by_id(chain->dev, id);
1365                         if (term == NULL || !UVC_ENTITY_IS_ITERM(term)) {
1366                                 uvc_trace(UVC_TRACE_DESCR, "Selector unit %d "
1367                                         "input %d isn't connected to an "
1368                                         "input terminal\n", entity->id, i);
1369                                 return -1;
1370                         }
1371
1372                         if (uvc_trace_param & UVC_TRACE_PROBE)
1373                                 printk(" %d", term->id);
1374
1375                         list_add_tail(&term->chain, &chain->entities);
1376                         uvc_scan_chain_forward(chain, term, entity);
1377                 }
1378
1379                 if (uvc_trace_param & UVC_TRACE_PROBE)
1380                         printk("\n");
1381
1382                 id = 0;
1383                 break;
1384
1385         case UVC_ITT_VENDOR_SPECIFIC:
1386         case UVC_ITT_CAMERA:
1387         case UVC_ITT_MEDIA_TRANSPORT_INPUT:
1388         case UVC_OTT_VENDOR_SPECIFIC:
1389         case UVC_OTT_DISPLAY:
1390         case UVC_OTT_MEDIA_TRANSPORT_OUTPUT:
1391         case UVC_TT_STREAMING:
1392                 id = UVC_ENTITY_IS_OTERM(entity) ? entity->baSourceID[0] : 0;
1393                 break;
1394         }
1395
1396         if (id <= 0) {
1397                 *_entity = NULL;
1398                 return id;
1399         }
1400
1401         entity = uvc_entity_by_id(chain->dev, id);
1402         if (entity == NULL) {
1403                 uvc_trace(UVC_TRACE_DESCR, "Found reference to "
1404                         "unknown entity %d.\n", id);
1405                 return -EINVAL;
1406         }
1407
1408         *_entity = entity;
1409         return 0;
1410 }
1411
1412 static int uvc_scan_chain(struct uvc_video_chain *chain,
1413                           struct uvc_entity *term)
1414 {
1415         struct uvc_entity *entity, *prev;
1416
1417         uvc_trace(UVC_TRACE_PROBE, "Scanning UVC chain:");
1418
1419         entity = term;
1420         prev = NULL;
1421
1422         while (entity != NULL) {
1423                 /* Entity must not be part of an existing chain */
1424                 if (entity->chain.next || entity->chain.prev) {
1425                         uvc_trace(UVC_TRACE_DESCR, "Found reference to "
1426                                 "entity %d already in chain.\n", entity->id);
1427                         return -EINVAL;
1428                 }
1429
1430                 /* Process entity */
1431                 if (uvc_scan_chain_entity(chain, entity) < 0)
1432                         return -EINVAL;
1433
1434                 /* Forward scan */
1435                 if (uvc_scan_chain_forward(chain, entity, prev) < 0)
1436                         return -EINVAL;
1437
1438                 /* Backward scan */
1439                 prev = entity;
1440                 if (uvc_scan_chain_backward(chain, &entity) < 0)
1441                         return -EINVAL;
1442         }
1443
1444         return 0;
1445 }
1446
1447 static unsigned int uvc_print_terms(struct list_head *terms, u16 dir,
1448                 char *buffer)
1449 {
1450         struct uvc_entity *term;
1451         unsigned int nterms = 0;
1452         char *p = buffer;
1453
1454         list_for_each_entry(term, terms, chain) {
1455                 if (!UVC_ENTITY_IS_TERM(term) ||
1456                     UVC_TERM_DIRECTION(term) != dir)
1457                         continue;
1458
1459                 if (nterms)
1460                         p += sprintf(p, ",");
1461                 if (++nterms >= 4) {
1462                         p += sprintf(p, "...");
1463                         break;
1464                 }
1465                 p += sprintf(p, "%u", term->id);
1466         }
1467
1468         return p - buffer;
1469 }
1470
1471 static const char *uvc_print_chain(struct uvc_video_chain *chain)
1472 {
1473         static char buffer[43];
1474         char *p = buffer;
1475
1476         p += uvc_print_terms(&chain->entities, UVC_TERM_INPUT, p);
1477         p += sprintf(p, " -> ");
1478         uvc_print_terms(&chain->entities, UVC_TERM_OUTPUT, p);
1479
1480         return buffer;
1481 }
1482
1483 /*
1484  * Scan the device for video chains and register video devices.
1485  *
1486  * Chains are scanned starting at their output terminals and walked backwards.
1487  */
1488 static int uvc_scan_device(struct uvc_device *dev)
1489 {
1490         struct uvc_video_chain *chain;
1491         struct uvc_entity *term;
1492
1493         list_for_each_entry(term, &dev->entities, list) {
1494                 if (!UVC_ENTITY_IS_OTERM(term))
1495                         continue;
1496
1497                 /* If the terminal is already included in a chain, skip it.
1498                  * This can happen for chains that have multiple output
1499                  * terminals, where all output terminals beside the first one
1500                  * will be inserted in the chain in forward scans.
1501                  */
1502                 if (term->chain.next || term->chain.prev)
1503                         continue;
1504
1505                 chain = kzalloc(sizeof(*chain), GFP_KERNEL);
1506                 if (chain == NULL)
1507                         return -ENOMEM;
1508
1509                 INIT_LIST_HEAD(&chain->entities);
1510                 mutex_init(&chain->ctrl_mutex);
1511                 chain->dev = dev;
1512
1513                 if (uvc_scan_chain(chain, term) < 0) {
1514                         kfree(chain);
1515                         continue;
1516                 }
1517
1518                 uvc_trace(UVC_TRACE_PROBE, "Found a valid video chain (%s).\n",
1519                           uvc_print_chain(chain));
1520
1521                 list_add_tail(&chain->list, &dev->chains);
1522         }
1523
1524         if (list_empty(&dev->chains)) {
1525                 uvc_printk(KERN_INFO, "No valid video chain found.\n");
1526                 return -1;
1527         }
1528
1529         return 0;
1530 }
1531
1532 /* ------------------------------------------------------------------------
1533  * Video device registration and unregistration
1534  */
1535
1536 /*
1537  * Delete the UVC device.
1538  *
1539  * Called by the kernel when the last reference to the uvc_device structure
1540  * is released.
1541  *
1542  * As this function is called after or during disconnect(), all URBs have
1543  * already been canceled by the USB core. There is no need to kill the
1544  * interrupt URB manually.
1545  */
1546 static void uvc_delete(struct uvc_device *dev)
1547 {
1548         struct list_head *p, *n;
1549
1550         usb_put_intf(dev->intf);
1551         usb_put_dev(dev->udev);
1552
1553         uvc_status_cleanup(dev);
1554         uvc_ctrl_cleanup_device(dev);
1555
1556         list_for_each_safe(p, n, &dev->chains) {
1557                 struct uvc_video_chain *chain;
1558                 chain = list_entry(p, struct uvc_video_chain, list);
1559                 kfree(chain);
1560         }
1561
1562         list_for_each_safe(p, n, &dev->entities) {
1563                 struct uvc_entity *entity;
1564                 entity = list_entry(p, struct uvc_entity, list);
1565                 kfree(entity);
1566         }
1567
1568         list_for_each_safe(p, n, &dev->streams) {
1569                 struct uvc_streaming *streaming;
1570                 streaming = list_entry(p, struct uvc_streaming, list);
1571                 usb_driver_release_interface(&uvc_driver.driver,
1572                         streaming->intf);
1573                 usb_put_intf(streaming->intf);
1574                 kfree(streaming->format);
1575                 kfree(streaming->header.bmaControls);
1576                 kfree(streaming);
1577         }
1578
1579         kfree(dev);
1580 }
1581
1582 static void uvc_release(struct video_device *vdev)
1583 {
1584         struct uvc_streaming *stream = video_get_drvdata(vdev);
1585         struct uvc_device *dev = stream->dev;
1586
1587         video_device_release(vdev);
1588
1589         /* Decrement the registered streams count and delete the device when it
1590          * reaches zero.
1591          */
1592         if (atomic_dec_and_test(&dev->nstreams))
1593                 uvc_delete(dev);
1594 }
1595
1596 /*
1597  * Unregister the video devices.
1598  */
1599 static void uvc_unregister_video(struct uvc_device *dev)
1600 {
1601         struct uvc_streaming *stream;
1602
1603         /* Unregistering all video devices might result in uvc_delete() being
1604          * called from inside the loop if there's no open file handle. To avoid
1605          * that, increment the stream count before iterating over the streams
1606          * and decrement it when done.
1607          */
1608         atomic_inc(&dev->nstreams);
1609
1610         list_for_each_entry(stream, &dev->streams, list) {
1611                 if (stream->vdev == NULL)
1612                         continue;
1613
1614                 video_unregister_device(stream->vdev);
1615                 stream->vdev = NULL;
1616         }
1617
1618         /* Decrement the stream count and call uvc_delete explicitly if there
1619          * are no stream left.
1620          */
1621         if (atomic_dec_and_test(&dev->nstreams))
1622                 uvc_delete(dev);
1623 }
1624
1625 static int uvc_register_video(struct uvc_device *dev,
1626                 struct uvc_streaming *stream)
1627 {
1628         struct video_device *vdev;
1629         int ret;
1630
1631         /* Initialize the streaming interface with default streaming
1632          * parameters.
1633          */
1634         ret = uvc_video_init(stream);
1635         if (ret < 0) {
1636                 uvc_printk(KERN_ERR, "Failed to initialize the device "
1637                         "(%d).\n", ret);
1638                 return ret;
1639         }
1640
1641         /* Register the device with V4L. */
1642         vdev = video_device_alloc();
1643         if (vdev == NULL) {
1644                 uvc_printk(KERN_ERR, "Failed to allocate video device (%d).\n",
1645                            ret);
1646                 return -ENOMEM;
1647         }
1648
1649         /* We already hold a reference to dev->udev. The video device will be
1650          * unregistered before the reference is released, so we don't need to
1651          * get another one.
1652          */
1653         vdev->parent = &dev->intf->dev;
1654         vdev->minor = -1;
1655         vdev->fops = &uvc_fops;
1656         vdev->release = uvc_release;
1657         strlcpy(vdev->name, dev->name, sizeof vdev->name);
1658
1659         /* Set the driver data before calling video_register_device, otherwise
1660          * uvc_v4l2_open might race us.
1661          */
1662         stream->vdev = vdev;
1663         video_set_drvdata(vdev, stream);
1664
1665         ret = video_register_device(vdev, VFL_TYPE_GRABBER, -1);
1666         if (ret < 0) {
1667                 uvc_printk(KERN_ERR, "Failed to register video device (%d).\n",
1668                            ret);
1669                 stream->vdev = NULL;
1670                 video_device_release(vdev);
1671                 return ret;
1672         }
1673
1674         atomic_inc(&dev->nstreams);
1675         return 0;
1676 }
1677
1678 /*
1679  * Register all video devices in all chains.
1680  */
1681 static int uvc_register_terms(struct uvc_device *dev,
1682         struct uvc_video_chain *chain)
1683 {
1684         struct uvc_streaming *stream;
1685         struct uvc_entity *term;
1686         int ret;
1687
1688         list_for_each_entry(term, &chain->entities, chain) {
1689                 if (UVC_ENTITY_TYPE(term) != UVC_TT_STREAMING)
1690                         continue;
1691
1692                 stream = uvc_stream_by_id(dev, term->id);
1693                 if (stream == NULL) {
1694                         uvc_printk(KERN_INFO, "No streaming interface found "
1695                                    "for terminal %u.", term->id);
1696                         continue;
1697                 }
1698
1699                 stream->chain = chain;
1700                 ret = uvc_register_video(dev, stream);
1701                 if (ret < 0)
1702                         return ret;
1703         }
1704
1705         return 0;
1706 }
1707
1708 static int uvc_register_chains(struct uvc_device *dev)
1709 {
1710         struct uvc_video_chain *chain;
1711         int ret;
1712
1713         list_for_each_entry(chain, &dev->chains, list) {
1714                 ret = uvc_register_terms(dev, chain);
1715                 if (ret < 0)
1716                         return ret;
1717         }
1718
1719         return 0;
1720 }
1721
1722 /* ------------------------------------------------------------------------
1723  * USB probe, disconnect, suspend and resume
1724  */
1725
1726 static int uvc_probe(struct usb_interface *intf,
1727                      const struct usb_device_id *id)
1728 {
1729         struct usb_device *udev = interface_to_usbdev(intf);
1730         struct uvc_device *dev;
1731         int ret;
1732
1733         if (id->idVendor && id->idProduct)
1734                 uvc_trace(UVC_TRACE_PROBE, "Probing known UVC device %s "
1735                                 "(%04x:%04x)\n", udev->devpath, id->idVendor,
1736                                 id->idProduct);
1737         else
1738                 uvc_trace(UVC_TRACE_PROBE, "Probing generic UVC device %s\n",
1739                                 udev->devpath);
1740
1741         /* Allocate memory for the device and initialize it. */
1742         if ((dev = kzalloc(sizeof *dev, GFP_KERNEL)) == NULL)
1743                 return -ENOMEM;
1744
1745         INIT_LIST_HEAD(&dev->entities);
1746         INIT_LIST_HEAD(&dev->chains);
1747         INIT_LIST_HEAD(&dev->streams);
1748         atomic_set(&dev->nstreams, 0);
1749         atomic_set(&dev->users, 0);
1750
1751         dev->udev = usb_get_dev(udev);
1752         dev->intf = usb_get_intf(intf);
1753         dev->intfnum = intf->cur_altsetting->desc.bInterfaceNumber;
1754         dev->quirks = id->driver_info | uvc_quirks_param;
1755
1756         if (udev->product != NULL)
1757                 strlcpy(dev->name, udev->product, sizeof dev->name);
1758         else
1759                 snprintf(dev->name, sizeof dev->name,
1760                         "UVC Camera (%04x:%04x)",
1761                         le16_to_cpu(udev->descriptor.idVendor),
1762                         le16_to_cpu(udev->descriptor.idProduct));
1763
1764         /* Parse the Video Class control descriptor. */
1765         if (uvc_parse_control(dev) < 0) {
1766                 uvc_trace(UVC_TRACE_PROBE, "Unable to parse UVC "
1767                         "descriptors.\n");
1768                 goto error;
1769         }
1770
1771         uvc_printk(KERN_INFO, "Found UVC %u.%02x device %s (%04x:%04x)\n",
1772                 dev->uvc_version >> 8, dev->uvc_version & 0xff,
1773                 udev->product ? udev->product : "<unnamed>",
1774                 le16_to_cpu(udev->descriptor.idVendor),
1775                 le16_to_cpu(udev->descriptor.idProduct));
1776
1777         if (uvc_quirks_param != 0) {
1778                 uvc_printk(KERN_INFO, "Forcing device quirks 0x%x by module "
1779                         "parameter for testing purpose.\n", uvc_quirks_param);
1780                 uvc_printk(KERN_INFO, "Please report required quirks to the "
1781                         "linux-uvc-devel mailing list.\n");
1782         }
1783
1784         /* Initialize controls. */
1785         if (uvc_ctrl_init_device(dev) < 0)
1786                 goto error;
1787
1788         /* Scan the device for video chains. */
1789         if (uvc_scan_device(dev) < 0)
1790                 goto error;
1791
1792         /* Register video devices. */
1793         if (uvc_register_chains(dev) < 0)
1794                 goto error;
1795
1796         /* Save our data pointer in the interface data. */
1797         usb_set_intfdata(intf, dev);
1798
1799         /* Initialize the interrupt URB. */
1800         if ((ret = uvc_status_init(dev)) < 0) {
1801                 uvc_printk(KERN_INFO, "Unable to initialize the status "
1802                         "endpoint (%d), status interrupt will not be "
1803                         "supported.\n", ret);
1804         }
1805
1806         uvc_trace(UVC_TRACE_PROBE, "UVC device initialized.\n");
1807         return 0;
1808
1809 error:
1810         uvc_unregister_video(dev);
1811         return -ENODEV;
1812 }
1813
1814 static void uvc_disconnect(struct usb_interface *intf)
1815 {
1816         struct uvc_device *dev = usb_get_intfdata(intf);
1817
1818         /* Set the USB interface data to NULL. This can be done outside the
1819          * lock, as there's no other reader.
1820          */
1821         usb_set_intfdata(intf, NULL);
1822
1823         if (intf->cur_altsetting->desc.bInterfaceSubClass ==
1824             UVC_SC_VIDEOSTREAMING)
1825                 return;
1826
1827         dev->state |= UVC_DEV_DISCONNECTED;
1828
1829         uvc_unregister_video(dev);
1830 }
1831
1832 static int uvc_suspend(struct usb_interface *intf, pm_message_t message)
1833 {
1834         struct uvc_device *dev = usb_get_intfdata(intf);
1835         struct uvc_streaming *stream;
1836
1837         uvc_trace(UVC_TRACE_SUSPEND, "Suspending interface %u\n",
1838                 intf->cur_altsetting->desc.bInterfaceNumber);
1839
1840         /* Controls are cached on the fly so they don't need to be saved. */
1841         if (intf->cur_altsetting->desc.bInterfaceSubClass ==
1842             UVC_SC_VIDEOCONTROL)
1843                 return uvc_status_suspend(dev);
1844
1845         list_for_each_entry(stream, &dev->streams, list) {
1846                 if (stream->intf == intf)
1847                         return uvc_video_suspend(stream);
1848         }
1849
1850         uvc_trace(UVC_TRACE_SUSPEND, "Suspend: video streaming USB interface "
1851                         "mismatch.\n");
1852         return -EINVAL;
1853 }
1854
1855 static int __uvc_resume(struct usb_interface *intf, int reset)
1856 {
1857         struct uvc_device *dev = usb_get_intfdata(intf);
1858         struct uvc_streaming *stream;
1859
1860         uvc_trace(UVC_TRACE_SUSPEND, "Resuming interface %u\n",
1861                 intf->cur_altsetting->desc.bInterfaceNumber);
1862
1863         if (intf->cur_altsetting->desc.bInterfaceSubClass ==
1864             UVC_SC_VIDEOCONTROL) {
1865                 if (reset) {
1866                         int ret = uvc_ctrl_resume_device(dev);
1867
1868                         if (ret < 0)
1869                                 return ret;
1870                 }
1871
1872                 return uvc_status_resume(dev);
1873         }
1874
1875         list_for_each_entry(stream, &dev->streams, list) {
1876                 if (stream->intf == intf)
1877                         return uvc_video_resume(stream);
1878         }
1879
1880         uvc_trace(UVC_TRACE_SUSPEND, "Resume: video streaming USB interface "
1881                         "mismatch.\n");
1882         return -EINVAL;
1883 }
1884
1885 static int uvc_resume(struct usb_interface *intf)
1886 {
1887         return __uvc_resume(intf, 0);
1888 }
1889
1890 static int uvc_reset_resume(struct usb_interface *intf)
1891 {
1892         return __uvc_resume(intf, 1);
1893 }
1894
1895 /* ------------------------------------------------------------------------
1896  * Driver initialization and cleanup
1897  */
1898
1899 /*
1900  * The Logitech cameras listed below have their interface class set to
1901  * VENDOR_SPEC because they don't announce themselves as UVC devices, even
1902  * though they are compliant.
1903  */
1904 static struct usb_device_id uvc_ids[] = {
1905         /* Genius eFace 2025 */
1906         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
1907                                 | USB_DEVICE_ID_MATCH_INT_INFO,
1908           .idVendor             = 0x0458,
1909           .idProduct            = 0x706e,
1910           .bInterfaceClass      = USB_CLASS_VIDEO,
1911           .bInterfaceSubClass   = 1,
1912           .bInterfaceProtocol   = 0,
1913           .driver_info          = UVC_QUIRK_PROBE_MINMAX },
1914         /* Microsoft Lifecam NX-6000 */
1915         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
1916                                 | USB_DEVICE_ID_MATCH_INT_INFO,
1917           .idVendor             = 0x045e,
1918           .idProduct            = 0x00f8,
1919           .bInterfaceClass      = USB_CLASS_VIDEO,
1920           .bInterfaceSubClass   = 1,
1921           .bInterfaceProtocol   = 0,
1922           .driver_info          = UVC_QUIRK_PROBE_MINMAX },
1923         /* Microsoft Lifecam VX-7000 */
1924         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
1925                                 | USB_DEVICE_ID_MATCH_INT_INFO,
1926           .idVendor             = 0x045e,
1927           .idProduct            = 0x0723,
1928           .bInterfaceClass      = USB_CLASS_VIDEO,
1929           .bInterfaceSubClass   = 1,
1930           .bInterfaceProtocol   = 0,
1931           .driver_info          = UVC_QUIRK_PROBE_MINMAX },
1932         /* Logitech Quickcam Fusion */
1933         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
1934                                 | USB_DEVICE_ID_MATCH_INT_INFO,
1935           .idVendor             = 0x046d,
1936           .idProduct            = 0x08c1,
1937           .bInterfaceClass      = USB_CLASS_VENDOR_SPEC,
1938           .bInterfaceSubClass   = 1,
1939           .bInterfaceProtocol   = 0 },
1940         /* Logitech Quickcam Orbit MP */
1941         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
1942                                 | USB_DEVICE_ID_MATCH_INT_INFO,
1943           .idVendor             = 0x046d,
1944           .idProduct            = 0x08c2,
1945           .bInterfaceClass      = USB_CLASS_VENDOR_SPEC,
1946           .bInterfaceSubClass   = 1,
1947           .bInterfaceProtocol   = 0 },
1948         /* Logitech Quickcam Pro for Notebook */
1949         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
1950                                 | USB_DEVICE_ID_MATCH_INT_INFO,
1951           .idVendor             = 0x046d,
1952           .idProduct            = 0x08c3,
1953           .bInterfaceClass      = USB_CLASS_VENDOR_SPEC,
1954           .bInterfaceSubClass   = 1,
1955           .bInterfaceProtocol   = 0 },
1956         /* Logitech Quickcam Pro 5000 */
1957         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
1958                                 | USB_DEVICE_ID_MATCH_INT_INFO,
1959           .idVendor             = 0x046d,
1960           .idProduct            = 0x08c5,
1961           .bInterfaceClass      = USB_CLASS_VENDOR_SPEC,
1962           .bInterfaceSubClass   = 1,
1963           .bInterfaceProtocol   = 0 },
1964         /* Logitech Quickcam OEM Dell Notebook */
1965         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
1966                                 | USB_DEVICE_ID_MATCH_INT_INFO,
1967           .idVendor             = 0x046d,
1968           .idProduct            = 0x08c6,
1969           .bInterfaceClass      = USB_CLASS_VENDOR_SPEC,
1970           .bInterfaceSubClass   = 1,
1971           .bInterfaceProtocol   = 0 },
1972         /* Logitech Quickcam OEM Cisco VT Camera II */
1973         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
1974                                 | USB_DEVICE_ID_MATCH_INT_INFO,
1975           .idVendor             = 0x046d,
1976           .idProduct            = 0x08c7,
1977           .bInterfaceClass      = USB_CLASS_VENDOR_SPEC,
1978           .bInterfaceSubClass   = 1,
1979           .bInterfaceProtocol   = 0 },
1980         /* Alcor Micro AU3820 (Future Boy PC USB Webcam) */
1981         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
1982                                 | USB_DEVICE_ID_MATCH_INT_INFO,
1983           .idVendor             = 0x058f,
1984           .idProduct            = 0x3820,
1985           .bInterfaceClass      = USB_CLASS_VIDEO,
1986           .bInterfaceSubClass   = 1,
1987           .bInterfaceProtocol   = 0,
1988           .driver_info          = UVC_QUIRK_PROBE_MINMAX },
1989         /* Apple Built-In iSight */
1990         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
1991                                 | USB_DEVICE_ID_MATCH_INT_INFO,
1992           .idVendor             = 0x05ac,
1993           .idProduct            = 0x8501,
1994           .bInterfaceClass      = USB_CLASS_VIDEO,
1995           .bInterfaceSubClass   = 1,
1996           .bInterfaceProtocol   = 0,
1997           .driver_info          = UVC_QUIRK_PROBE_MINMAX
1998                                 | UVC_QUIRK_BUILTIN_ISIGHT },
1999         /* Genesys Logic USB 2.0 PC Camera */
2000         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
2001                                 | USB_DEVICE_ID_MATCH_INT_INFO,
2002           .idVendor             = 0x05e3,
2003           .idProduct            = 0x0505,
2004           .bInterfaceClass      = USB_CLASS_VIDEO,
2005           .bInterfaceSubClass   = 1,
2006           .bInterfaceProtocol   = 0,
2007           .driver_info          = UVC_QUIRK_STREAM_NO_FID },
2008         /* ViMicro Vega */
2009         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
2010                                 | USB_DEVICE_ID_MATCH_INT_INFO,
2011           .idVendor             = 0x0ac8,
2012           .idProduct            = 0x332d,
2013           .bInterfaceClass      = USB_CLASS_VIDEO,
2014           .bInterfaceSubClass   = 1,
2015           .bInterfaceProtocol   = 0,
2016           .driver_info          = UVC_QUIRK_FIX_BANDWIDTH },
2017         /* ViMicro - Minoru3D */
2018         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
2019                                 | USB_DEVICE_ID_MATCH_INT_INFO,
2020           .idVendor             = 0x0ac8,
2021           .idProduct            = 0x3410,
2022           .bInterfaceClass      = USB_CLASS_VIDEO,
2023           .bInterfaceSubClass   = 1,
2024           .bInterfaceProtocol   = 0,
2025           .driver_info          = UVC_QUIRK_FIX_BANDWIDTH },
2026         /* ViMicro Venus - Minoru3D */
2027         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
2028                                 | USB_DEVICE_ID_MATCH_INT_INFO,
2029           .idVendor             = 0x0ac8,
2030           .idProduct            = 0x3420,
2031           .bInterfaceClass      = USB_CLASS_VIDEO,
2032           .bInterfaceSubClass   = 1,
2033           .bInterfaceProtocol   = 0,
2034           .driver_info          = UVC_QUIRK_FIX_BANDWIDTH },
2035         /* MT6227 */
2036         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
2037                                 | USB_DEVICE_ID_MATCH_INT_INFO,
2038           .idVendor             = 0x0e8d,
2039           .idProduct            = 0x0004,
2040           .bInterfaceClass      = USB_CLASS_VIDEO,
2041           .bInterfaceSubClass   = 1,
2042           .bInterfaceProtocol   = 0,
2043           .driver_info          = UVC_QUIRK_PROBE_MINMAX
2044                                 | UVC_QUIRK_PROBE_DEF },
2045         /* Syntek (HP Spartan) */
2046         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
2047                                 | USB_DEVICE_ID_MATCH_INT_INFO,
2048           .idVendor             = 0x174f,
2049           .idProduct            = 0x5212,
2050           .bInterfaceClass      = USB_CLASS_VIDEO,
2051           .bInterfaceSubClass   = 1,
2052           .bInterfaceProtocol   = 0,
2053           .driver_info          = UVC_QUIRK_STREAM_NO_FID },
2054         /* Syntek (Samsung Q310) */
2055         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
2056                                 | USB_DEVICE_ID_MATCH_INT_INFO,
2057           .idVendor             = 0x174f,
2058           .idProduct            = 0x5931,
2059           .bInterfaceClass      = USB_CLASS_VIDEO,
2060           .bInterfaceSubClass   = 1,
2061           .bInterfaceProtocol   = 0,
2062           .driver_info          = UVC_QUIRK_STREAM_NO_FID },
2063         /* Syntek (Asus F9SG) */
2064         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
2065                                 | USB_DEVICE_ID_MATCH_INT_INFO,
2066           .idVendor             = 0x174f,
2067           .idProduct            = 0x8a31,
2068           .bInterfaceClass      = USB_CLASS_VIDEO,
2069           .bInterfaceSubClass   = 1,
2070           .bInterfaceProtocol   = 0,
2071           .driver_info          = UVC_QUIRK_STREAM_NO_FID },
2072         /* Syntek (Asus U3S) */
2073         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
2074                                 | USB_DEVICE_ID_MATCH_INT_INFO,
2075           .idVendor             = 0x174f,
2076           .idProduct            = 0x8a33,
2077           .bInterfaceClass      = USB_CLASS_VIDEO,
2078           .bInterfaceSubClass   = 1,
2079           .bInterfaceProtocol   = 0,
2080           .driver_info          = UVC_QUIRK_STREAM_NO_FID },
2081         /* Syntek (JAOtech Smart Terminal) */
2082         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
2083                                 | USB_DEVICE_ID_MATCH_INT_INFO,
2084           .idVendor             = 0x174f,
2085           .idProduct            = 0x8a34,
2086           .bInterfaceClass      = USB_CLASS_VIDEO,
2087           .bInterfaceSubClass   = 1,
2088           .bInterfaceProtocol   = 0,
2089           .driver_info          = UVC_QUIRK_STREAM_NO_FID },
2090         /* Lenovo Thinkpad SL400/SL500 */
2091         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
2092                                 | USB_DEVICE_ID_MATCH_INT_INFO,
2093           .idVendor             = 0x17ef,
2094           .idProduct            = 0x480b,
2095           .bInterfaceClass      = USB_CLASS_VIDEO,
2096           .bInterfaceSubClass   = 1,
2097           .bInterfaceProtocol   = 0,
2098           .driver_info          = UVC_QUIRK_STREAM_NO_FID },
2099         /* Aveo Technology USB 2.0 Camera */
2100         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
2101                                 | USB_DEVICE_ID_MATCH_INT_INFO,
2102           .idVendor             = 0x1871,
2103           .idProduct            = 0x0306,
2104           .bInterfaceClass      = USB_CLASS_VIDEO,
2105           .bInterfaceSubClass   = 1,
2106           .bInterfaceProtocol   = 0,
2107           .driver_info          = UVC_QUIRK_PROBE_MINMAX
2108                                 | UVC_QUIRK_PROBE_EXTRAFIELDS },
2109         /* Ecamm Pico iMage */
2110         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
2111                                 | USB_DEVICE_ID_MATCH_INT_INFO,
2112           .idVendor             = 0x18cd,
2113           .idProduct            = 0xcafe,
2114           .bInterfaceClass      = USB_CLASS_VIDEO,
2115           .bInterfaceSubClass   = 1,
2116           .bInterfaceProtocol   = 0,
2117           .driver_info          = UVC_QUIRK_PROBE_EXTRAFIELDS },
2118         /* FSC WebCam V30S */
2119         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
2120                                 | USB_DEVICE_ID_MATCH_INT_INFO,
2121           .idVendor             = 0x18ec,
2122           .idProduct            = 0x3288,
2123           .bInterfaceClass      = USB_CLASS_VIDEO,
2124           .bInterfaceSubClass   = 1,
2125           .bInterfaceProtocol   = 0,
2126           .driver_info          = UVC_QUIRK_PROBE_MINMAX },
2127         /* Bodelin ProScopeHR */
2128         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
2129                                 | USB_DEVICE_ID_MATCH_DEV_HI
2130                                 | USB_DEVICE_ID_MATCH_INT_INFO,
2131           .idVendor             = 0x19ab,
2132           .idProduct            = 0x1000,
2133           .bcdDevice_hi         = 0x0126,
2134           .bInterfaceClass      = USB_CLASS_VIDEO,
2135           .bInterfaceSubClass   = 1,
2136           .bInterfaceProtocol   = 0,
2137           .driver_info          = UVC_QUIRK_STATUS_INTERVAL },
2138         /* MSI StarCam 370i */
2139         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
2140                                 | USB_DEVICE_ID_MATCH_INT_INFO,
2141           .idVendor             = 0x1b3b,
2142           .idProduct            = 0x2951,
2143           .bInterfaceClass      = USB_CLASS_VIDEO,
2144           .bInterfaceSubClass   = 1,
2145           .bInterfaceProtocol   = 0,
2146           .driver_info          = UVC_QUIRK_PROBE_MINMAX },
2147         /* SiGma Micro USB Web Camera */
2148         { .match_flags          = USB_DEVICE_ID_MATCH_DEVICE
2149                                 | USB_DEVICE_ID_MATCH_INT_INFO,
2150           .idVendor             = 0x1c4f,
2151           .idProduct            = 0x3000,
2152           .bInterfaceClass      = USB_CLASS_VIDEO,
2153           .bInterfaceSubClass   = 1,
2154           .bInterfaceProtocol   = 0,
2155           .driver_info          = UVC_QUIRK_PROBE_MINMAX
2156                                 | UVC_QUIRK_IGNORE_SELECTOR_UNIT },
2157         /* Generic USB Video Class */
2158         { USB_INTERFACE_INFO(USB_CLASS_VIDEO, 1, 0) },
2159         {}
2160 };
2161
2162 MODULE_DEVICE_TABLE(usb, uvc_ids);
2163
2164 struct uvc_driver uvc_driver = {
2165         .driver = {
2166                 .name           = "uvcvideo",
2167                 .probe          = uvc_probe,
2168                 .disconnect     = uvc_disconnect,
2169                 .suspend        = uvc_suspend,
2170                 .resume         = uvc_resume,
2171                 .reset_resume   = uvc_reset_resume,
2172                 .id_table       = uvc_ids,
2173                 .supports_autosuspend = 1,
2174         },
2175 };
2176
2177 static int __init uvc_init(void)
2178 {
2179         int result;
2180
2181         INIT_LIST_HEAD(&uvc_driver.devices);
2182         INIT_LIST_HEAD(&uvc_driver.controls);
2183         mutex_init(&uvc_driver.ctrl_mutex);
2184
2185         uvc_ctrl_init();
2186
2187         result = usb_register(&uvc_driver.driver);
2188         if (result == 0)
2189                 printk(KERN_INFO DRIVER_DESC " (" DRIVER_VERSION ")\n");
2190         return result;
2191 }
2192
2193 static void __exit uvc_cleanup(void)
2194 {
2195         usb_deregister(&uvc_driver.driver);
2196 }
2197
2198 module_init(uvc_init);
2199 module_exit(uvc_cleanup);
2200
2201 module_param_named(nodrop, uvc_no_drop_param, uint, S_IRUGO|S_IWUSR);
2202 MODULE_PARM_DESC(nodrop, "Don't drop incomplete frames");
2203 module_param_named(quirks, uvc_quirks_param, uint, S_IRUGO|S_IWUSR);
2204 MODULE_PARM_DESC(quirks, "Forced device quirks");
2205 module_param_named(trace, uvc_trace_param, uint, S_IRUGO|S_IWUSR);
2206 MODULE_PARM_DESC(trace, "Trace level bitmask");
2207 module_param_named(timeout, uvc_timeout_param, uint, S_IRUGO|S_IWUSR);
2208 MODULE_PARM_DESC(timeout, "Streaming control requests timeout");
2209
2210 MODULE_AUTHOR(DRIVER_AUTHOR);
2211 MODULE_DESCRIPTION(DRIVER_DESC);
2212 MODULE_LICENSE("GPL");
2213 MODULE_VERSION(DRIVER_VERSION);
2214