blob: dc035c0b2580f582c380326f48aa4bb3e7c89649 [file] [log] [blame]
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001/*
2 * uvc_driver.c -- USB Video Class driver
3 *
Laurent Pinchart11fc5ba2010-09-20 06:10:10 -03004 * Copyright (C) 2005-2010
5 * Laurent Pinchart (laurent.pinchart@ideasonboard.com)
Laurent Pinchartc0efd232008-06-30 15:04:50 -03006 *
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/*
Laurent Pinchartff924202008-12-28 22:32:29 -030015 * This driver aims to support video input and ouput devices compliant with the
16 * 'USB Video Class' specification.
Laurent Pinchartc0efd232008-06-30 15:04:50 -030017 *
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>
Laurent Pinchartc0efd232008-06-30 15:04:50 -030027#include <linux/list.h>
28#include <linux/module.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090029#include <linux/slab.h>
Laurent Pinchartc0efd232008-06-30 15:04:50 -030030#include <linux/usb.h>
31#include <linux/videodev2.h>
32#include <linux/vmalloc.h>
33#include <linux/wait.h>
34#include <asm/atomic.h>
Michael Hennerich9bc62182008-11-11 14:11:28 -030035#include <asm/unaligned.h>
Laurent Pinchartc0efd232008-06-30 15:04:50 -030036
37#include <media/v4l2-common.h>
38
39#include "uvcvideo.h"
40
Laurent Pinchart11fc5ba2010-09-20 06:10:10 -030041#define DRIVER_AUTHOR "Laurent Pinchart " \
42 "<laurent.pinchart@ideasonboard.com>"
Laurent Pinchartc0efd232008-06-30 15:04:50 -030043#define DRIVER_DESC "USB Video Class driver"
44#ifndef DRIVER_VERSION
45#define DRIVER_VERSION "v0.1.0"
46#endif
47
Laurent Pinchart310fe522009-12-09 22:57:48 -030048unsigned int uvc_clock_param = CLOCK_MONOTONIC;
Laurent Pinchart0fbd8ee2008-12-06 16:25:14 -030049unsigned int uvc_no_drop_param;
Laurent Pinchart73de3592009-12-10 10:00:39 -030050static unsigned int uvc_quirks_param = -1;
Laurent Pinchartc0efd232008-06-30 15:04:50 -030051unsigned int uvc_trace_param;
Laurent Pinchartb232a012009-10-09 20:55:23 -030052unsigned int uvc_timeout_param = UVC_CTRL_STREAMING_TIMEOUT;
Laurent Pinchartc0efd232008-06-30 15:04:50 -030053
54/* ------------------------------------------------------------------------
Laurent Pinchart2c2d2642009-01-03 19:12:40 -030055 * Video formats
Laurent Pinchartc0efd232008-06-30 15:04:50 -030056 */
57
58static struct uvc_format_desc uvc_fmts[] = {
59 {
60 .name = "YUV 4:2:2 (YUYV)",
61 .guid = UVC_GUID_FORMAT_YUY2,
62 .fcc = V4L2_PIX_FMT_YUYV,
63 },
64 {
Daniel Ritz68f194e2009-12-12 14:57:17 -030065 .name = "YUV 4:2:2 (YUYV)",
66 .guid = UVC_GUID_FORMAT_YUY2_ISIGHT,
67 .fcc = V4L2_PIX_FMT_YUYV,
68 },
69 {
Laurent Pinchartc0efd232008-06-30 15:04:50 -030070 .name = "YUV 4:2:0 (NV12)",
71 .guid = UVC_GUID_FORMAT_NV12,
72 .fcc = V4L2_PIX_FMT_NV12,
73 },
74 {
75 .name = "MJPEG",
76 .guid = UVC_GUID_FORMAT_MJPEG,
77 .fcc = V4L2_PIX_FMT_MJPEG,
78 },
79 {
80 .name = "YVU 4:2:0 (YV12)",
81 .guid = UVC_GUID_FORMAT_YV12,
82 .fcc = V4L2_PIX_FMT_YVU420,
83 },
84 {
85 .name = "YUV 4:2:0 (I420)",
86 .guid = UVC_GUID_FORMAT_I420,
87 .fcc = V4L2_PIX_FMT_YUV420,
88 },
89 {
90 .name = "YUV 4:2:2 (UYVY)",
91 .guid = UVC_GUID_FORMAT_UYVY,
92 .fcc = V4L2_PIX_FMT_UYVY,
93 },
94 {
Laurent Pinchart614212062010-04-12 10:41:22 -030095 .name = "Greyscale (8-bit)",
Laurent Pinchartc0efd232008-06-30 15:04:50 -030096 .guid = UVC_GUID_FORMAT_Y800,
97 .fcc = V4L2_PIX_FMT_GREY,
98 },
99 {
Laurent Pinchart614212062010-04-12 10:41:22 -0300100 .name = "Greyscale (16-bit)",
101 .guid = UVC_GUID_FORMAT_Y16,
102 .fcc = V4L2_PIX_FMT_Y16,
103 },
104 {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300105 .name = "RGB Bayer",
106 .guid = UVC_GUID_FORMAT_BY8,
107 .fcc = V4L2_PIX_FMT_SBGGR8,
108 },
109};
110
111/* ------------------------------------------------------------------------
112 * Utility functions
113 */
114
115struct usb_host_endpoint *uvc_find_endpoint(struct usb_host_interface *alts,
116 __u8 epaddr)
117{
118 struct usb_host_endpoint *ep;
119 unsigned int i;
120
121 for (i = 0; i < alts->desc.bNumEndpoints; ++i) {
122 ep = &alts->endpoint[i];
123 if (ep->desc.bEndpointAddress == epaddr)
124 return ep;
125 }
126
127 return NULL;
128}
129
130static struct uvc_format_desc *uvc_format_by_guid(const __u8 guid[16])
131{
132 unsigned int len = ARRAY_SIZE(uvc_fmts);
133 unsigned int i;
134
135 for (i = 0; i < len; ++i) {
136 if (memcmp(guid, uvc_fmts[i].guid, 16) == 0)
137 return &uvc_fmts[i];
138 }
139
140 return NULL;
141}
142
143static __u32 uvc_colorspace(const __u8 primaries)
144{
145 static const __u8 colorprimaries[] = {
146 0,
147 V4L2_COLORSPACE_SRGB,
148 V4L2_COLORSPACE_470_SYSTEM_M,
149 V4L2_COLORSPACE_470_SYSTEM_BG,
150 V4L2_COLORSPACE_SMPTE170M,
151 V4L2_COLORSPACE_SMPTE240M,
152 };
153
154 if (primaries < ARRAY_SIZE(colorprimaries))
155 return colorprimaries[primaries];
156
157 return 0;
158}
159
160/* Simplify a fraction using a simple continued fraction decomposition. The
161 * idea here is to convert fractions such as 333333/10000000 to 1/30 using
162 * 32 bit arithmetic only. The algorithm is not perfect and relies upon two
163 * arbitrary parameters to remove non-significative terms from the simple
164 * continued fraction decomposition. Using 8 and 333 for n_terms and threshold
165 * respectively seems to give nice results.
166 */
167void uvc_simplify_fraction(uint32_t *numerator, uint32_t *denominator,
168 unsigned int n_terms, unsigned int threshold)
169{
170 uint32_t *an;
171 uint32_t x, y, r;
172 unsigned int i, n;
173
174 an = kmalloc(n_terms * sizeof *an, GFP_KERNEL);
175 if (an == NULL)
176 return;
177
178 /* Convert the fraction to a simple continued fraction. See
179 * http://mathforum.org/dr.math/faq/faq.fractions.html
180 * Stop if the current term is bigger than or equal to the given
181 * threshold.
182 */
183 x = *numerator;
184 y = *denominator;
185
186 for (n = 0; n < n_terms && y != 0; ++n) {
187 an[n] = x / y;
188 if (an[n] >= threshold) {
189 if (n < 2)
190 n++;
191 break;
192 }
193
194 r = x - an[n] * y;
195 x = y;
196 y = r;
197 }
198
199 /* Expand the simple continued fraction back to an integer fraction. */
200 x = 0;
201 y = 1;
202
203 for (i = n; i > 0; --i) {
204 r = y;
205 y = an[i-1] * y + x;
206 x = r;
207 }
208
209 *numerator = y;
210 *denominator = x;
211 kfree(an);
212}
213
214/* Convert a fraction to a frame interval in 100ns multiples. The idea here is
215 * to compute numerator / denominator * 10000000 using 32 bit fixed point
216 * arithmetic only.
217 */
218uint32_t uvc_fraction_to_interval(uint32_t numerator, uint32_t denominator)
219{
220 uint32_t multiplier;
221
222 /* Saturate the result if the operation would overflow. */
223 if (denominator == 0 ||
224 numerator/denominator >= ((uint32_t)-1)/10000000)
225 return (uint32_t)-1;
226
227 /* Divide both the denominator and the multiplier by two until
228 * numerator * multiplier doesn't overflow. If anyone knows a better
229 * algorithm please let me know.
230 */
231 multiplier = 10000000;
232 while (numerator > ((uint32_t)-1)/multiplier) {
233 multiplier /= 2;
234 denominator /= 2;
235 }
236
237 return denominator ? numerator * multiplier / denominator : 0;
238}
239
240/* ------------------------------------------------------------------------
241 * Terminal and unit management
242 */
243
244static struct uvc_entity *uvc_entity_by_id(struct uvc_device *dev, int id)
245{
246 struct uvc_entity *entity;
247
248 list_for_each_entry(entity, &dev->entities, list) {
249 if (entity->id == id)
250 return entity;
251 }
252
253 return NULL;
254}
255
256static struct uvc_entity *uvc_entity_by_reference(struct uvc_device *dev,
257 int id, struct uvc_entity *entity)
258{
259 unsigned int i;
260
261 if (entity == NULL)
262 entity = list_entry(&dev->entities, struct uvc_entity, list);
263
264 list_for_each_entry_continue(entity, &dev->entities, list) {
Laurent Pinchart8ca5a632009-11-25 12:00:30 -0300265 for (i = 0; i < entity->bNrInPins; ++i)
266 if (entity->baSourceID[i] == id)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300267 return entity;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300268 }
269
270 return NULL;
271}
272
Laurent Pinchart8e113592009-07-01 20:24:47 -0300273static struct uvc_streaming *uvc_stream_by_id(struct uvc_device *dev, int id)
274{
275 struct uvc_streaming *stream;
276
277 list_for_each_entry(stream, &dev->streams, list) {
278 if (stream->header.bTerminalLink == id)
279 return stream;
280 }
281
282 return NULL;
283}
284
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300285/* ------------------------------------------------------------------------
Laurent Pinchart8e113592009-07-01 20:24:47 -0300286 * Descriptors parsing
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300287 */
288
289static int uvc_parse_format(struct uvc_device *dev,
290 struct uvc_streaming *streaming, struct uvc_format *format,
291 __u32 **intervals, unsigned char *buffer, int buflen)
292{
293 struct usb_interface *intf = streaming->intf;
294 struct usb_host_interface *alts = intf->cur_altsetting;
295 struct uvc_format_desc *fmtdesc;
296 struct uvc_frame *frame;
297 const unsigned char *start = buffer;
298 unsigned int interval;
299 unsigned int i, n;
300 __u8 ftype;
301
302 format->type = buffer[2];
303 format->index = buffer[3];
304
305 switch (buffer[2]) {
Laurent Pinchartb482d922009-06-26 11:39:42 -0300306 case UVC_VS_FORMAT_UNCOMPRESSED:
307 case UVC_VS_FORMAT_FRAME_BASED:
308 n = buffer[2] == UVC_VS_FORMAT_UNCOMPRESSED ? 27 : 28;
Laurent Pinchart233548a2008-07-04 00:34:59 -0300309 if (buflen < n) {
Laurent Pinchartb2d9cc42009-05-06 12:37:44 -0300310 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300311 "interface %d FORMAT error\n",
312 dev->udev->devnum,
313 alts->desc.bInterfaceNumber);
314 return -EINVAL;
315 }
316
317 /* Find the format descriptor from its GUID. */
318 fmtdesc = uvc_format_by_guid(&buffer[5]);
319
320 if (fmtdesc != NULL) {
Laurent Pinchartd0ebf302009-01-08 14:05:11 -0300321 strlcpy(format->name, fmtdesc->name,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300322 sizeof format->name);
323 format->fcc = fmtdesc->fcc;
324 } else {
Laurent Pinchart36bd8832010-01-19 09:06:22 -0300325 uvc_printk(KERN_INFO, "Unknown video format %pUl\n",
326 &buffer[5]);
327 snprintf(format->name, sizeof(format->name), "%pUl\n",
328 &buffer[5]);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300329 format->fcc = 0;
330 }
331
332 format->bpp = buffer[21];
Laurent Pinchartb482d922009-06-26 11:39:42 -0300333 if (buffer[2] == UVC_VS_FORMAT_UNCOMPRESSED) {
334 ftype = UVC_VS_FRAME_UNCOMPRESSED;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300335 } else {
Laurent Pinchartb482d922009-06-26 11:39:42 -0300336 ftype = UVC_VS_FRAME_FRAME_BASED;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300337 if (buffer[27])
338 format->flags = UVC_FMT_FLAG_COMPRESSED;
339 }
340 break;
341
Laurent Pinchartb482d922009-06-26 11:39:42 -0300342 case UVC_VS_FORMAT_MJPEG:
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300343 if (buflen < 11) {
Laurent Pinchartb2d9cc42009-05-06 12:37:44 -0300344 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300345 "interface %d FORMAT error\n",
346 dev->udev->devnum,
347 alts->desc.bInterfaceNumber);
348 return -EINVAL;
349 }
350
Laurent Pinchartd0ebf302009-01-08 14:05:11 -0300351 strlcpy(format->name, "MJPEG", sizeof format->name);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300352 format->fcc = V4L2_PIX_FMT_MJPEG;
353 format->flags = UVC_FMT_FLAG_COMPRESSED;
354 format->bpp = 0;
Laurent Pinchartb482d922009-06-26 11:39:42 -0300355 ftype = UVC_VS_FRAME_MJPEG;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300356 break;
357
Laurent Pinchartb482d922009-06-26 11:39:42 -0300358 case UVC_VS_FORMAT_DV:
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300359 if (buflen < 9) {
Laurent Pinchartb2d9cc42009-05-06 12:37:44 -0300360 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300361 "interface %d FORMAT error\n",
362 dev->udev->devnum,
363 alts->desc.bInterfaceNumber);
364 return -EINVAL;
365 }
366
367 switch (buffer[8] & 0x7f) {
368 case 0:
Laurent Pinchartd0ebf302009-01-08 14:05:11 -0300369 strlcpy(format->name, "SD-DV", sizeof format->name);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300370 break;
371 case 1:
Laurent Pinchartd0ebf302009-01-08 14:05:11 -0300372 strlcpy(format->name, "SDL-DV", sizeof format->name);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300373 break;
374 case 2:
Laurent Pinchartd0ebf302009-01-08 14:05:11 -0300375 strlcpy(format->name, "HD-DV", sizeof format->name);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300376 break;
377 default:
Laurent Pinchartb2d9cc42009-05-06 12:37:44 -0300378 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300379 "interface %d: unknown DV format %u\n",
380 dev->udev->devnum,
381 alts->desc.bInterfaceNumber, buffer[8]);
382 return -EINVAL;
383 }
384
Laurent Pinchartd0ebf302009-01-08 14:05:11 -0300385 strlcat(format->name, buffer[8] & (1 << 7) ? " 60Hz" : " 50Hz",
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300386 sizeof format->name);
387
388 format->fcc = V4L2_PIX_FMT_DV;
389 format->flags = UVC_FMT_FLAG_COMPRESSED | UVC_FMT_FLAG_STREAM;
390 format->bpp = 0;
391 ftype = 0;
392
393 /* Create a dummy frame descriptor. */
394 frame = &format->frame[0];
395 memset(&format->frame[0], 0, sizeof format->frame[0]);
396 frame->bFrameIntervalType = 1;
397 frame->dwDefaultFrameInterval = 1;
398 frame->dwFrameInterval = *intervals;
399 *(*intervals)++ = 1;
400 format->nframes = 1;
401 break;
402
Laurent Pinchartb482d922009-06-26 11:39:42 -0300403 case UVC_VS_FORMAT_MPEG2TS:
404 case UVC_VS_FORMAT_STREAM_BASED:
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300405 /* Not supported yet. */
406 default:
Laurent Pinchartb2d9cc42009-05-06 12:37:44 -0300407 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300408 "interface %d unsupported format %u\n",
409 dev->udev->devnum, alts->desc.bInterfaceNumber,
410 buffer[2]);
411 return -EINVAL;
412 }
413
414 uvc_trace(UVC_TRACE_DESCR, "Found format %s.\n", format->name);
415
416 buflen -= buffer[0];
417 buffer += buffer[0];
418
419 /* Parse the frame descriptors. Only uncompressed, MJPEG and frame
420 * based formats have frame descriptors.
421 */
Laurent Pinchartc4ed8c62009-10-08 19:38:10 -0300422 while (buflen > 2 && buffer[1] == USB_DT_CS_INTERFACE &&
423 buffer[2] == ftype) {
Laurent Pinchart078f8942009-05-06 12:30:30 -0300424 frame = &format->frame[format->nframes];
Laurent Pinchartb482d922009-06-26 11:39:42 -0300425 if (ftype != UVC_VS_FRAME_FRAME_BASED)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300426 n = buflen > 25 ? buffer[25] : 0;
427 else
428 n = buflen > 21 ? buffer[21] : 0;
429
430 n = n ? n : 3;
431
432 if (buflen < 26 + 4*n) {
Laurent Pinchartb2d9cc42009-05-06 12:37:44 -0300433 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300434 "interface %d FRAME error\n", dev->udev->devnum,
435 alts->desc.bInterfaceNumber);
436 return -EINVAL;
437 }
438
439 frame->bFrameIndex = buffer[3];
440 frame->bmCapabilities = buffer[4];
Michael Hennerich9bc62182008-11-11 14:11:28 -0300441 frame->wWidth = get_unaligned_le16(&buffer[5]);
442 frame->wHeight = get_unaligned_le16(&buffer[7]);
443 frame->dwMinBitRate = get_unaligned_le32(&buffer[9]);
444 frame->dwMaxBitRate = get_unaligned_le32(&buffer[13]);
Laurent Pinchartb482d922009-06-26 11:39:42 -0300445 if (ftype != UVC_VS_FRAME_FRAME_BASED) {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300446 frame->dwMaxVideoFrameBufferSize =
Michael Hennerich9bc62182008-11-11 14:11:28 -0300447 get_unaligned_le32(&buffer[17]);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300448 frame->dwDefaultFrameInterval =
Michael Hennerich9bc62182008-11-11 14:11:28 -0300449 get_unaligned_le32(&buffer[21]);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300450 frame->bFrameIntervalType = buffer[25];
451 } else {
452 frame->dwMaxVideoFrameBufferSize = 0;
453 frame->dwDefaultFrameInterval =
Michael Hennerich9bc62182008-11-11 14:11:28 -0300454 get_unaligned_le32(&buffer[17]);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300455 frame->bFrameIntervalType = buffer[21];
456 }
457 frame->dwFrameInterval = *intervals;
458
459 /* Several UVC chipsets screw up dwMaxVideoFrameBufferSize
460 * completely. Observed behaviours range from setting the
Laurent Pinchart2c2d2642009-01-03 19:12:40 -0300461 * value to 1.1x the actual frame size to hardwiring the
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300462 * 16 low bits to 0. This results in a higher than necessary
463 * memory usage as well as a wrong image size information. For
464 * uncompressed formats this can be fixed by computing the
465 * value from the frame size.
466 */
467 if (!(format->flags & UVC_FMT_FLAG_COMPRESSED))
468 frame->dwMaxVideoFrameBufferSize = format->bpp
469 * frame->wWidth * frame->wHeight / 8;
470
471 /* Some bogus devices report dwMinFrameInterval equal to
472 * dwMaxFrameInterval and have dwFrameIntervalStep set to
473 * zero. Setting all null intervals to 1 fixes the problem and
Laurent Pinchart2c2d2642009-01-03 19:12:40 -0300474 * some other divisions by zero that could happen.
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300475 */
476 for (i = 0; i < n; ++i) {
Michael Hennerich9bc62182008-11-11 14:11:28 -0300477 interval = get_unaligned_le32(&buffer[26+4*i]);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300478 *(*intervals)++ = interval ? interval : 1;
479 }
480
481 /* Make sure that the default frame interval stays between
482 * the boundaries.
483 */
484 n -= frame->bFrameIntervalType ? 1 : 2;
485 frame->dwDefaultFrameInterval =
486 min(frame->dwFrameInterval[n],
487 max(frame->dwFrameInterval[0],
488 frame->dwDefaultFrameInterval));
489
Laurent Pinchart86d8b6a2010-09-16 12:37:26 -0300490 if (dev->quirks & UVC_QUIRK_RESTRICT_FRAME_RATE) {
491 frame->bFrameIntervalType = 1;
492 frame->dwFrameInterval[0] =
493 frame->dwDefaultFrameInterval;
494 }
495
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300496 uvc_trace(UVC_TRACE_DESCR, "- %ux%u (%u.%u fps)\n",
497 frame->wWidth, frame->wHeight,
498 10000000/frame->dwDefaultFrameInterval,
499 (100000000/frame->dwDefaultFrameInterval)%10);
500
Laurent Pinchart078f8942009-05-06 12:30:30 -0300501 format->nframes++;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300502 buflen -= buffer[0];
503 buffer += buffer[0];
504 }
505
Laurent Pinchartc4ed8c62009-10-08 19:38:10 -0300506 if (buflen > 2 && buffer[1] == USB_DT_CS_INTERFACE &&
507 buffer[2] == UVC_VS_STILL_IMAGE_FRAME) {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300508 buflen -= buffer[0];
509 buffer += buffer[0];
510 }
511
Laurent Pinchartc4ed8c62009-10-08 19:38:10 -0300512 if (buflen > 2 && buffer[1] == USB_DT_CS_INTERFACE &&
513 buffer[2] == UVC_VS_COLORFORMAT) {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300514 if (buflen < 6) {
Laurent Pinchartb2d9cc42009-05-06 12:37:44 -0300515 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300516 "interface %d COLORFORMAT error\n",
517 dev->udev->devnum,
518 alts->desc.bInterfaceNumber);
519 return -EINVAL;
520 }
521
522 format->colorspace = uvc_colorspace(buffer[3]);
523
524 buflen -= buffer[0];
525 buffer += buffer[0];
526 }
527
528 return buffer - start;
529}
530
531static int uvc_parse_streaming(struct uvc_device *dev,
532 struct usb_interface *intf)
533{
534 struct uvc_streaming *streaming = NULL;
535 struct uvc_format *format;
536 struct uvc_frame *frame;
537 struct usb_host_interface *alts = &intf->altsetting[0];
538 unsigned char *_buffer, *buffer = alts->extra;
539 int _buflen, buflen = alts->extralen;
540 unsigned int nformats = 0, nframes = 0, nintervals = 0;
541 unsigned int size, i, n, p;
542 __u32 *interval;
543 __u16 psize;
544 int ret = -EINVAL;
545
546 if (intf->cur_altsetting->desc.bInterfaceSubClass
Laurent Pinchartb482d922009-06-26 11:39:42 -0300547 != UVC_SC_VIDEOSTREAMING) {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300548 uvc_trace(UVC_TRACE_DESCR, "device %d interface %d isn't a "
549 "video streaming interface\n", dev->udev->devnum,
550 intf->altsetting[0].desc.bInterfaceNumber);
551 return -EINVAL;
552 }
553
554 if (usb_driver_claim_interface(&uvc_driver.driver, intf, dev)) {
555 uvc_trace(UVC_TRACE_DESCR, "device %d interface %d is already "
556 "claimed\n", dev->udev->devnum,
557 intf->altsetting[0].desc.bInterfaceNumber);
558 return -EINVAL;
559 }
560
561 streaming = kzalloc(sizeof *streaming, GFP_KERNEL);
562 if (streaming == NULL) {
563 usb_driver_release_interface(&uvc_driver.driver, intf);
564 return -EINVAL;
565 }
566
567 mutex_init(&streaming->mutex);
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300568 streaming->dev = dev;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300569 streaming->intf = usb_get_intf(intf);
570 streaming->intfnum = intf->cur_altsetting->desc.bInterfaceNumber;
571
572 /* The Pico iMage webcam has its class-specific interface descriptors
573 * after the endpoint descriptors.
574 */
575 if (buflen == 0) {
576 for (i = 0; i < alts->desc.bNumEndpoints; ++i) {
577 struct usb_host_endpoint *ep = &alts->endpoint[i];
578
579 if (ep->extralen == 0)
580 continue;
581
582 if (ep->extralen > 2 &&
583 ep->extra[1] == USB_DT_CS_INTERFACE) {
584 uvc_trace(UVC_TRACE_DESCR, "trying extra data "
585 "from endpoint %u.\n", i);
586 buffer = alts->endpoint[i].extra;
587 buflen = alts->endpoint[i].extralen;
588 break;
589 }
590 }
591 }
592
593 /* Skip the standard interface descriptors. */
594 while (buflen > 2 && buffer[1] != USB_DT_CS_INTERFACE) {
595 buflen -= buffer[0];
596 buffer += buffer[0];
597 }
598
599 if (buflen <= 2) {
600 uvc_trace(UVC_TRACE_DESCR, "no class-specific streaming "
601 "interface descriptors found.\n");
602 goto error;
603 }
604
605 /* Parse the header descriptor. */
Laurent Pinchartff924202008-12-28 22:32:29 -0300606 switch (buffer[2]) {
Laurent Pinchartb482d922009-06-26 11:39:42 -0300607 case UVC_VS_OUTPUT_HEADER:
Laurent Pinchartff924202008-12-28 22:32:29 -0300608 streaming->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
609 size = 9;
610 break;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300611
Laurent Pinchartb482d922009-06-26 11:39:42 -0300612 case UVC_VS_INPUT_HEADER:
Laurent Pinchartff924202008-12-28 22:32:29 -0300613 streaming->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
614 size = 13;
615 break;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300616
Laurent Pinchartff924202008-12-28 22:32:29 -0300617 default:
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300618 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming interface "
619 "%d HEADER descriptor not found.\n", dev->udev->devnum,
620 alts->desc.bInterfaceNumber);
621 goto error;
622 }
623
Laurent Pinchartff924202008-12-28 22:32:29 -0300624 p = buflen >= 4 ? buffer[3] : 0;
625 n = buflen >= size ? buffer[size-1] : 0;
626
627 if (buflen < size + p*n) {
628 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
629 "interface %d HEADER descriptor is invalid.\n",
630 dev->udev->devnum, alts->desc.bInterfaceNumber);
631 goto error;
632 }
633
634 streaming->header.bNumFormats = p;
635 streaming->header.bEndpointAddress = buffer[6];
Laurent Pinchartb482d922009-06-26 11:39:42 -0300636 if (buffer[2] == UVC_VS_INPUT_HEADER) {
Laurent Pinchartff924202008-12-28 22:32:29 -0300637 streaming->header.bmInfo = buffer[7];
638 streaming->header.bTerminalLink = buffer[8];
639 streaming->header.bStillCaptureMethod = buffer[9];
640 streaming->header.bTriggerSupport = buffer[10];
641 streaming->header.bTriggerUsage = buffer[11];
642 } else {
643 streaming->header.bTerminalLink = buffer[7];
644 }
645 streaming->header.bControlSize = n;
646
Julia Lawall0b21d552010-07-01 01:33:15 -0300647 streaming->header.bmaControls = kmemdup(&buffer[size], p * n,
648 GFP_KERNEL);
Laurent Pinchartff924202008-12-28 22:32:29 -0300649 if (streaming->header.bmaControls == NULL) {
650 ret = -ENOMEM;
651 goto error;
652 }
653
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300654 buflen -= buffer[0];
655 buffer += buffer[0];
656
657 _buffer = buffer;
658 _buflen = buflen;
659
660 /* Count the format and frame descriptors. */
Laurent Pinchart042e1432009-06-26 11:30:09 -0300661 while (_buflen > 2 && _buffer[1] == USB_DT_CS_INTERFACE) {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300662 switch (_buffer[2]) {
Laurent Pinchartb482d922009-06-26 11:39:42 -0300663 case UVC_VS_FORMAT_UNCOMPRESSED:
664 case UVC_VS_FORMAT_MJPEG:
665 case UVC_VS_FORMAT_FRAME_BASED:
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300666 nformats++;
667 break;
668
Laurent Pinchartb482d922009-06-26 11:39:42 -0300669 case UVC_VS_FORMAT_DV:
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300670 /* DV format has no frame descriptor. We will create a
671 * dummy frame descriptor with a dummy frame interval.
672 */
673 nformats++;
674 nframes++;
675 nintervals++;
676 break;
677
Laurent Pinchartb482d922009-06-26 11:39:42 -0300678 case UVC_VS_FORMAT_MPEG2TS:
679 case UVC_VS_FORMAT_STREAM_BASED:
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300680 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming "
681 "interface %d FORMAT %u is not supported.\n",
682 dev->udev->devnum,
683 alts->desc.bInterfaceNumber, _buffer[2]);
684 break;
685
Laurent Pinchartb482d922009-06-26 11:39:42 -0300686 case UVC_VS_FRAME_UNCOMPRESSED:
687 case UVC_VS_FRAME_MJPEG:
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300688 nframes++;
689 if (_buflen > 25)
690 nintervals += _buffer[25] ? _buffer[25] : 3;
691 break;
692
Laurent Pinchartb482d922009-06-26 11:39:42 -0300693 case UVC_VS_FRAME_FRAME_BASED:
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300694 nframes++;
695 if (_buflen > 21)
696 nintervals += _buffer[21] ? _buffer[21] : 3;
697 break;
698 }
699
700 _buflen -= _buffer[0];
701 _buffer += _buffer[0];
702 }
703
704 if (nformats == 0) {
705 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming interface "
706 "%d has no supported formats defined.\n",
707 dev->udev->devnum, alts->desc.bInterfaceNumber);
708 goto error;
709 }
710
711 size = nformats * sizeof *format + nframes * sizeof *frame
712 + nintervals * sizeof *interval;
713 format = kzalloc(size, GFP_KERNEL);
714 if (format == NULL) {
715 ret = -ENOMEM;
716 goto error;
717 }
718
719 frame = (struct uvc_frame *)&format[nformats];
720 interval = (__u32 *)&frame[nframes];
721
722 streaming->format = format;
723 streaming->nformats = nformats;
724
725 /* Parse the format descriptors. */
Laurent Pinchart042e1432009-06-26 11:30:09 -0300726 while (buflen > 2 && buffer[1] == USB_DT_CS_INTERFACE) {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300727 switch (buffer[2]) {
Laurent Pinchartb482d922009-06-26 11:39:42 -0300728 case UVC_VS_FORMAT_UNCOMPRESSED:
729 case UVC_VS_FORMAT_MJPEG:
730 case UVC_VS_FORMAT_DV:
731 case UVC_VS_FORMAT_FRAME_BASED:
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300732 format->frame = frame;
733 ret = uvc_parse_format(dev, streaming, format,
734 &interval, buffer, buflen);
735 if (ret < 0)
736 goto error;
737
738 frame += format->nframes;
739 format++;
740
741 buflen -= ret;
742 buffer += ret;
743 continue;
744
745 default:
746 break;
747 }
748
749 buflen -= buffer[0];
750 buffer += buffer[0];
751 }
752
Laurent Pinchartc4ed8c62009-10-08 19:38:10 -0300753 if (buflen)
754 uvc_trace(UVC_TRACE_DESCR, "device %d videostreaming interface "
755 "%d has %u bytes of trailing descriptor garbage.\n",
756 dev->udev->devnum, alts->desc.bInterfaceNumber, buflen);
757
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300758 /* Parse the alternate settings to find the maximum bandwidth. */
759 for (i = 0; i < intf->num_altsetting; ++i) {
760 struct usb_host_endpoint *ep;
761 alts = &intf->altsetting[i];
762 ep = uvc_find_endpoint(alts,
763 streaming->header.bEndpointAddress);
764 if (ep == NULL)
765 continue;
766
767 psize = le16_to_cpu(ep->desc.wMaxPacketSize);
768 psize = (psize & 0x07ff) * (1 + ((psize >> 11) & 3));
769 if (psize > streaming->maxpsize)
770 streaming->maxpsize = psize;
771 }
772
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300773 list_add_tail(&streaming->list, &dev->streams);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300774 return 0;
775
776error:
777 usb_driver_release_interface(&uvc_driver.driver, intf);
778 usb_put_intf(intf);
779 kfree(streaming->format);
780 kfree(streaming->header.bmaControls);
781 kfree(streaming);
782 return ret;
783}
784
Laurent Pinchart8ca5a632009-11-25 12:00:30 -0300785static struct uvc_entity *uvc_alloc_entity(u16 type, u8 id,
786 unsigned int num_pads, unsigned int extra_size)
787{
788 struct uvc_entity *entity;
789 unsigned int num_inputs;
790 unsigned int size;
791
792 num_inputs = (type & UVC_TERM_OUTPUT) ? num_pads : num_pads - 1;
793 size = sizeof(*entity) + extra_size + num_inputs;
794 entity = kzalloc(size, GFP_KERNEL);
795 if (entity == NULL)
796 return NULL;
797
798 entity->id = id;
799 entity->type = type;
800
801 entity->bNrInPins = num_inputs;
802 entity->baSourceID = ((__u8 *)entity) + sizeof(*entity) + extra_size;
803
804 return entity;
805}
806
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300807/* Parse vendor-specific extensions. */
808static int uvc_parse_vendor_control(struct uvc_device *dev,
809 const unsigned char *buffer, int buflen)
810{
811 struct usb_device *udev = dev->udev;
812 struct usb_host_interface *alts = dev->intf->cur_altsetting;
813 struct uvc_entity *unit;
814 unsigned int n, p;
815 int handled = 0;
816
817 switch (le16_to_cpu(dev->udev->descriptor.idVendor)) {
818 case 0x046d: /* Logitech */
819 if (buffer[1] != 0x41 || buffer[2] != 0x01)
820 break;
821
822 /* Logitech implements several vendor specific functions
823 * through vendor specific extension units (LXU).
824 *
825 * The LXU descriptors are similar to XU descriptors
826 * (see "USB Device Video Class for Video Devices", section
827 * 3.7.2.6 "Extension Unit Descriptor") with the following
828 * differences:
829 *
830 * ----------------------------------------------------------
831 * 0 bLength 1 Number
832 * Size of this descriptor, in bytes: 24+p+n*2
833 * ----------------------------------------------------------
834 * 23+p+n bmControlsType N Bitmap
835 * Individual bits in the set are defined:
836 * 0: Absolute
837 * 1: Relative
838 *
839 * This bitset is mapped exactly the same as bmControls.
840 * ----------------------------------------------------------
841 * 23+p+n*2 bReserved 1 Boolean
842 * ----------------------------------------------------------
843 * 24+p+n*2 iExtension 1 Index
844 * Index of a string descriptor that describes this
845 * extension unit.
846 * ----------------------------------------------------------
847 */
848 p = buflen >= 22 ? buffer[21] : 0;
849 n = buflen >= 25 + p ? buffer[22+p] : 0;
850
851 if (buflen < 25 + p + 2*n) {
852 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
853 "interface %d EXTENSION_UNIT error\n",
854 udev->devnum, alts->desc.bInterfaceNumber);
855 break;
856 }
857
Laurent Pinchart8ca5a632009-11-25 12:00:30 -0300858 unit = uvc_alloc_entity(UVC_VC_EXTENSION_UNIT, buffer[3],
859 p + 1, 2*n);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300860 if (unit == NULL)
861 return -ENOMEM;
862
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300863 memcpy(unit->extension.guidExtensionCode, &buffer[4], 16);
864 unit->extension.bNumControls = buffer[20];
Laurent Pinchart8ca5a632009-11-25 12:00:30 -0300865 memcpy(unit->baSourceID, &buffer[22], p);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300866 unit->extension.bControlSize = buffer[22+p];
Laurent Pinchart8ca5a632009-11-25 12:00:30 -0300867 unit->extension.bmControls = (__u8 *)unit + sizeof(*unit);
868 unit->extension.bmControlsType = (__u8 *)unit + sizeof(*unit)
869 + n;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300870 memcpy(unit->extension.bmControls, &buffer[23+p], 2*n);
871
872 if (buffer[24+p+2*n] != 0)
873 usb_string(udev, buffer[24+p+2*n], unit->name,
874 sizeof unit->name);
875 else
876 sprintf(unit->name, "Extension %u", buffer[3]);
877
878 list_add_tail(&unit->list, &dev->entities);
879 handled = 1;
880 break;
881 }
882
883 return handled;
884}
885
886static int uvc_parse_standard_control(struct uvc_device *dev,
887 const unsigned char *buffer, int buflen)
888{
889 struct usb_device *udev = dev->udev;
890 struct uvc_entity *unit, *term;
891 struct usb_interface *intf;
892 struct usb_host_interface *alts = dev->intf->cur_altsetting;
893 unsigned int i, n, p, len;
894 __u16 type;
895
896 switch (buffer[2]) {
Laurent Pinchartb482d922009-06-26 11:39:42 -0300897 case UVC_VC_HEADER:
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300898 n = buflen >= 12 ? buffer[11] : 0;
899
900 if (buflen < 12 || buflen < 12 + n) {
901 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
902 "interface %d HEADER error\n", udev->devnum,
903 alts->desc.bInterfaceNumber);
904 return -EINVAL;
905 }
906
Michael Hennerich9bc62182008-11-11 14:11:28 -0300907 dev->uvc_version = get_unaligned_le16(&buffer[3]);
908 dev->clock_frequency = get_unaligned_le32(&buffer[7]);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300909
910 /* Parse all USB Video Streaming interfaces. */
911 for (i = 0; i < n; ++i) {
912 intf = usb_ifnum_to_if(udev, buffer[12+i]);
913 if (intf == NULL) {
914 uvc_trace(UVC_TRACE_DESCR, "device %d "
915 "interface %d doesn't exists\n",
916 udev->devnum, i);
917 continue;
918 }
919
920 uvc_parse_streaming(dev, intf);
921 }
922 break;
923
Laurent Pinchartb482d922009-06-26 11:39:42 -0300924 case UVC_VC_INPUT_TERMINAL:
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300925 if (buflen < 8) {
926 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
927 "interface %d INPUT_TERMINAL error\n",
928 udev->devnum, alts->desc.bInterfaceNumber);
929 return -EINVAL;
930 }
931
932 /* Make sure the terminal type MSB is not null, otherwise it
933 * could be confused with a unit.
934 */
Michael Hennerich9bc62182008-11-11 14:11:28 -0300935 type = get_unaligned_le16(&buffer[4]);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300936 if ((type & 0xff00) == 0) {
937 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
938 "interface %d INPUT_TERMINAL %d has invalid "
939 "type 0x%04x, skipping\n", udev->devnum,
940 alts->desc.bInterfaceNumber,
941 buffer[3], type);
942 return 0;
943 }
944
945 n = 0;
946 p = 0;
947 len = 8;
948
Laurent Pinchartb482d922009-06-26 11:39:42 -0300949 if (type == UVC_ITT_CAMERA) {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300950 n = buflen >= 15 ? buffer[14] : 0;
951 len = 15;
952
Laurent Pinchartb482d922009-06-26 11:39:42 -0300953 } else if (type == UVC_ITT_MEDIA_TRANSPORT_INPUT) {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300954 n = buflen >= 9 ? buffer[8] : 0;
955 p = buflen >= 10 + n ? buffer[9+n] : 0;
956 len = 10;
957 }
958
959 if (buflen < len + n + p) {
960 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
961 "interface %d INPUT_TERMINAL error\n",
962 udev->devnum, alts->desc.bInterfaceNumber);
963 return -EINVAL;
964 }
965
Laurent Pinchart8ca5a632009-11-25 12:00:30 -0300966 term = uvc_alloc_entity(type | UVC_TERM_INPUT, buffer[3],
967 1, n + p);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300968 if (term == NULL)
969 return -ENOMEM;
970
Laurent Pinchartb482d922009-06-26 11:39:42 -0300971 if (UVC_ENTITY_TYPE(term) == UVC_ITT_CAMERA) {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300972 term->camera.bControlSize = n;
973 term->camera.bmControls = (__u8 *)term + sizeof *term;
974 term->camera.wObjectiveFocalLengthMin =
Michael Hennerich9bc62182008-11-11 14:11:28 -0300975 get_unaligned_le16(&buffer[8]);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300976 term->camera.wObjectiveFocalLengthMax =
Michael Hennerich9bc62182008-11-11 14:11:28 -0300977 get_unaligned_le16(&buffer[10]);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300978 term->camera.wOcularFocalLength =
Michael Hennerich9bc62182008-11-11 14:11:28 -0300979 get_unaligned_le16(&buffer[12]);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300980 memcpy(term->camera.bmControls, &buffer[15], n);
Laurent Pinchartb482d922009-06-26 11:39:42 -0300981 } else if (UVC_ENTITY_TYPE(term) ==
982 UVC_ITT_MEDIA_TRANSPORT_INPUT) {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300983 term->media.bControlSize = n;
984 term->media.bmControls = (__u8 *)term + sizeof *term;
985 term->media.bTransportModeSize = p;
986 term->media.bmTransportModes = (__u8 *)term
987 + sizeof *term + n;
988 memcpy(term->media.bmControls, &buffer[9], n);
989 memcpy(term->media.bmTransportModes, &buffer[10+n], p);
990 }
991
992 if (buffer[7] != 0)
993 usb_string(udev, buffer[7], term->name,
994 sizeof term->name);
Laurent Pinchartb482d922009-06-26 11:39:42 -0300995 else if (UVC_ENTITY_TYPE(term) == UVC_ITT_CAMERA)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300996 sprintf(term->name, "Camera %u", buffer[3]);
Laurent Pinchartb482d922009-06-26 11:39:42 -0300997 else if (UVC_ENTITY_TYPE(term) == UVC_ITT_MEDIA_TRANSPORT_INPUT)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300998 sprintf(term->name, "Media %u", buffer[3]);
999 else
1000 sprintf(term->name, "Input %u", buffer[3]);
1001
1002 list_add_tail(&term->list, &dev->entities);
1003 break;
1004
Laurent Pinchartb482d922009-06-26 11:39:42 -03001005 case UVC_VC_OUTPUT_TERMINAL:
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001006 if (buflen < 9) {
1007 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1008 "interface %d OUTPUT_TERMINAL error\n",
1009 udev->devnum, alts->desc.bInterfaceNumber);
1010 return -EINVAL;
1011 }
1012
1013 /* Make sure the terminal type MSB is not null, otherwise it
1014 * could be confused with a unit.
1015 */
Michael Hennerich9bc62182008-11-11 14:11:28 -03001016 type = get_unaligned_le16(&buffer[4]);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001017 if ((type & 0xff00) == 0) {
1018 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1019 "interface %d OUTPUT_TERMINAL %d has invalid "
1020 "type 0x%04x, skipping\n", udev->devnum,
1021 alts->desc.bInterfaceNumber, buffer[3], type);
1022 return 0;
1023 }
1024
Laurent Pinchart8ca5a632009-11-25 12:00:30 -03001025 term = uvc_alloc_entity(type | UVC_TERM_OUTPUT, buffer[3],
1026 1, 0);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001027 if (term == NULL)
1028 return -ENOMEM;
1029
Laurent Pinchart8ca5a632009-11-25 12:00:30 -03001030 memcpy(term->baSourceID, &buffer[7], 1);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001031
1032 if (buffer[8] != 0)
1033 usb_string(udev, buffer[8], term->name,
1034 sizeof term->name);
1035 else
1036 sprintf(term->name, "Output %u", buffer[3]);
1037
1038 list_add_tail(&term->list, &dev->entities);
1039 break;
1040
Laurent Pinchartb482d922009-06-26 11:39:42 -03001041 case UVC_VC_SELECTOR_UNIT:
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001042 p = buflen >= 5 ? buffer[4] : 0;
1043
1044 if (buflen < 5 || buflen < 6 + p) {
1045 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1046 "interface %d SELECTOR_UNIT error\n",
1047 udev->devnum, alts->desc.bInterfaceNumber);
1048 return -EINVAL;
1049 }
1050
Laurent Pinchart8ca5a632009-11-25 12:00:30 -03001051 unit = uvc_alloc_entity(buffer[2], buffer[3], p + 1, 0);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001052 if (unit == NULL)
1053 return -ENOMEM;
1054
Laurent Pinchart8ca5a632009-11-25 12:00:30 -03001055 memcpy(unit->baSourceID, &buffer[5], p);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001056
1057 if (buffer[5+p] != 0)
1058 usb_string(udev, buffer[5+p], unit->name,
1059 sizeof unit->name);
1060 else
1061 sprintf(unit->name, "Selector %u", buffer[3]);
1062
1063 list_add_tail(&unit->list, &dev->entities);
1064 break;
1065
Laurent Pinchartb482d922009-06-26 11:39:42 -03001066 case UVC_VC_PROCESSING_UNIT:
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001067 n = buflen >= 8 ? buffer[7] : 0;
1068 p = dev->uvc_version >= 0x0110 ? 10 : 9;
1069
1070 if (buflen < p + n) {
1071 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1072 "interface %d PROCESSING_UNIT error\n",
1073 udev->devnum, alts->desc.bInterfaceNumber);
1074 return -EINVAL;
1075 }
1076
Laurent Pinchart8ca5a632009-11-25 12:00:30 -03001077 unit = uvc_alloc_entity(buffer[2], buffer[3], 2, n);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001078 if (unit == NULL)
1079 return -ENOMEM;
1080
Laurent Pinchart8ca5a632009-11-25 12:00:30 -03001081 memcpy(unit->baSourceID, &buffer[4], 1);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001082 unit->processing.wMaxMultiplier =
Michael Hennerich9bc62182008-11-11 14:11:28 -03001083 get_unaligned_le16(&buffer[5]);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001084 unit->processing.bControlSize = buffer[7];
1085 unit->processing.bmControls = (__u8 *)unit + sizeof *unit;
1086 memcpy(unit->processing.bmControls, &buffer[8], n);
1087 if (dev->uvc_version >= 0x0110)
1088 unit->processing.bmVideoStandards = buffer[9+n];
1089
1090 if (buffer[8+n] != 0)
1091 usb_string(udev, buffer[8+n], unit->name,
1092 sizeof unit->name);
1093 else
1094 sprintf(unit->name, "Processing %u", buffer[3]);
1095
1096 list_add_tail(&unit->list, &dev->entities);
1097 break;
1098
Laurent Pinchartb482d922009-06-26 11:39:42 -03001099 case UVC_VC_EXTENSION_UNIT:
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001100 p = buflen >= 22 ? buffer[21] : 0;
1101 n = buflen >= 24 + p ? buffer[22+p] : 0;
1102
1103 if (buflen < 24 + p + n) {
1104 uvc_trace(UVC_TRACE_DESCR, "device %d videocontrol "
1105 "interface %d EXTENSION_UNIT error\n",
1106 udev->devnum, alts->desc.bInterfaceNumber);
1107 return -EINVAL;
1108 }
1109
Laurent Pinchart8ca5a632009-11-25 12:00:30 -03001110 unit = uvc_alloc_entity(buffer[2], buffer[3], p + 1, n);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001111 if (unit == NULL)
1112 return -ENOMEM;
1113
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001114 memcpy(unit->extension.guidExtensionCode, &buffer[4], 16);
1115 unit->extension.bNumControls = buffer[20];
Laurent Pinchart8ca5a632009-11-25 12:00:30 -03001116 memcpy(unit->baSourceID, &buffer[22], p);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001117 unit->extension.bControlSize = buffer[22+p];
Laurent Pinchart8ca5a632009-11-25 12:00:30 -03001118 unit->extension.bmControls = (__u8 *)unit + sizeof *unit;
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001119 memcpy(unit->extension.bmControls, &buffer[23+p], n);
1120
1121 if (buffer[23+p+n] != 0)
1122 usb_string(udev, buffer[23+p+n], unit->name,
1123 sizeof unit->name);
1124 else
1125 sprintf(unit->name, "Extension %u", buffer[3]);
1126
1127 list_add_tail(&unit->list, &dev->entities);
1128 break;
1129
1130 default:
1131 uvc_trace(UVC_TRACE_DESCR, "Found an unknown CS_INTERFACE "
1132 "descriptor (%u)\n", buffer[2]);
1133 break;
1134 }
1135
1136 return 0;
1137}
1138
1139static int uvc_parse_control(struct uvc_device *dev)
1140{
1141 struct usb_host_interface *alts = dev->intf->cur_altsetting;
1142 unsigned char *buffer = alts->extra;
1143 int buflen = alts->extralen;
1144 int ret;
1145
1146 /* Parse the default alternate setting only, as the UVC specification
1147 * defines a single alternate setting, the default alternate setting
1148 * zero.
1149 */
1150
1151 while (buflen > 2) {
1152 if (uvc_parse_vendor_control(dev, buffer, buflen) ||
1153 buffer[1] != USB_DT_CS_INTERFACE)
1154 goto next_descriptor;
1155
1156 if ((ret = uvc_parse_standard_control(dev, buffer, buflen)) < 0)
1157 return ret;
1158
1159next_descriptor:
1160 buflen -= buffer[0];
1161 buffer += buffer[0];
1162 }
1163
Laurent Pinchart538e7a02008-12-28 20:26:32 -03001164 /* Check if the optional status endpoint is present. Built-in iSight
1165 * webcams have an interrupt endpoint but spit proprietary data that
1166 * don't conform to the UVC status endpoint messages. Don't try to
1167 * handle the interrupt endpoint for those cameras.
1168 */
1169 if (alts->desc.bNumEndpoints == 1 &&
1170 !(dev->quirks & UVC_QUIRK_BUILTIN_ISIGHT)) {
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001171 struct usb_host_endpoint *ep = &alts->endpoint[0];
1172 struct usb_endpoint_descriptor *desc = &ep->desc;
1173
1174 if (usb_endpoint_is_int_in(desc) &&
1175 le16_to_cpu(desc->wMaxPacketSize) >= 8 &&
1176 desc->bInterval != 0) {
1177 uvc_trace(UVC_TRACE_DESCR, "Found a Status endpoint "
1178 "(addr %02x).\n", desc->bEndpointAddress);
1179 dev->int_ep = ep;
1180 }
1181 }
1182
1183 return 0;
1184}
1185
1186/* ------------------------------------------------------------------------
Laurent Pinchart8e113592009-07-01 20:24:47 -03001187 * UVC device scan
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001188 */
1189
1190/*
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001191 * Scan the UVC descriptors to locate a chain starting at an Output Terminal
1192 * and containing the following units:
1193 *
Laurent Pinchart8e113592009-07-01 20:24:47 -03001194 * - one or more Output Terminals (USB Streaming or Display)
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001195 * - zero or one Processing Unit
Laurent Pinchart8e113592009-07-01 20:24:47 -03001196 * - zero, one or more single-input Selector Units
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001197 * - zero or one multiple-input Selector Units, provided all inputs are
1198 * connected to input terminals
1199 * - zero, one or mode single-input Extension Units
Laurent Pinchart2c2d2642009-01-03 19:12:40 -03001200 * - one or more Input Terminals (Camera, External or USB Streaming)
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001201 *
Laurent Pinchart8e113592009-07-01 20:24:47 -03001202 * The terminal and units must match on of the following structures:
1203 *
1204 * ITT_*(0) -> +---------+ +---------+ +---------+ -> TT_STREAMING(0)
1205 * ... | SU{0,1} | -> | PU{0,1} | -> | XU{0,n} | ...
1206 * ITT_*(n) -> +---------+ +---------+ +---------+ -> TT_STREAMING(n)
1207 *
1208 * +---------+ +---------+ -> OTT_*(0)
1209 * TT_STREAMING -> | PU{0,1} | -> | XU{0,n} | ...
1210 * +---------+ +---------+ -> OTT_*(n)
1211 *
1212 * The Processing Unit and Extension Units can be in any order. Additional
1213 * Extension Units connected to the main chain as single-unit branches are
1214 * also supported. Single-input Selector Units are ignored.
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001215 */
Laurent Pinchart8e113592009-07-01 20:24:47 -03001216static int uvc_scan_chain_entity(struct uvc_video_chain *chain,
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001217 struct uvc_entity *entity)
1218{
1219 switch (UVC_ENTITY_TYPE(entity)) {
Laurent Pinchartb482d922009-06-26 11:39:42 -03001220 case UVC_VC_EXTENSION_UNIT:
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001221 if (uvc_trace_param & UVC_TRACE_PROBE)
1222 printk(" <- XU %d", entity->id);
1223
Laurent Pinchart8ca5a632009-11-25 12:00:30 -03001224 if (entity->bNrInPins != 1) {
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001225 uvc_trace(UVC_TRACE_DESCR, "Extension unit %d has more "
1226 "than 1 input pin.\n", entity->id);
1227 return -1;
1228 }
1229
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001230 break;
1231
Laurent Pinchartb482d922009-06-26 11:39:42 -03001232 case UVC_VC_PROCESSING_UNIT:
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001233 if (uvc_trace_param & UVC_TRACE_PROBE)
1234 printk(" <- PU %d", entity->id);
1235
Laurent Pinchart8e113592009-07-01 20:24:47 -03001236 if (chain->processing != NULL) {
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001237 uvc_trace(UVC_TRACE_DESCR, "Found multiple "
1238 "Processing Units in chain.\n");
1239 return -1;
1240 }
1241
Laurent Pinchart8e113592009-07-01 20:24:47 -03001242 chain->processing = entity;
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001243 break;
1244
Laurent Pinchartb482d922009-06-26 11:39:42 -03001245 case UVC_VC_SELECTOR_UNIT:
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001246 if (uvc_trace_param & UVC_TRACE_PROBE)
1247 printk(" <- SU %d", entity->id);
1248
1249 /* Single-input selector units are ignored. */
Laurent Pinchart8ca5a632009-11-25 12:00:30 -03001250 if (entity->bNrInPins == 1)
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001251 break;
1252
Laurent Pinchart8e113592009-07-01 20:24:47 -03001253 if (chain->selector != NULL) {
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001254 uvc_trace(UVC_TRACE_DESCR, "Found multiple Selector "
1255 "Units in chain.\n");
1256 return -1;
1257 }
1258
Laurent Pinchart8e113592009-07-01 20:24:47 -03001259 chain->selector = entity;
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001260 break;
1261
Laurent Pinchartb482d922009-06-26 11:39:42 -03001262 case UVC_ITT_VENDOR_SPECIFIC:
1263 case UVC_ITT_CAMERA:
1264 case UVC_ITT_MEDIA_TRANSPORT_INPUT:
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001265 if (uvc_trace_param & UVC_TRACE_PROBE)
1266 printk(" <- IT %d\n", entity->id);
1267
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001268 break;
1269
Laurent Pinchartb482d922009-06-26 11:39:42 -03001270 case UVC_TT_STREAMING:
Laurent Pinchart4057ac62009-11-25 12:00:29 -03001271 if (UVC_ENTITY_IS_ITERM(entity)) {
1272 if (uvc_trace_param & UVC_TRACE_PROBE)
1273 printk(" <- IT %d\n", entity->id);
1274 } else {
1275 if (uvc_trace_param & UVC_TRACE_PROBE)
1276 printk(" OT %d", entity->id);
Laurent Pinchartff924202008-12-28 22:32:29 -03001277 }
1278
Laurent Pinchartff924202008-12-28 22:32:29 -03001279 break;
1280
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001281 default:
1282 uvc_trace(UVC_TRACE_DESCR, "Unsupported entity type "
1283 "0x%04x found in chain.\n", UVC_ENTITY_TYPE(entity));
1284 return -1;
1285 }
1286
Laurent Pinchart6241d8c2009-11-25 12:00:22 -03001287 list_add_tail(&entity->chain, &chain->entities);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001288 return 0;
1289}
1290
Laurent Pinchart8e113592009-07-01 20:24:47 -03001291static int uvc_scan_chain_forward(struct uvc_video_chain *chain,
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001292 struct uvc_entity *entity, struct uvc_entity *prev)
1293{
1294 struct uvc_entity *forward;
1295 int found;
1296
1297 /* Forward scan */
1298 forward = NULL;
1299 found = 0;
1300
1301 while (1) {
Laurent Pinchart8e113592009-07-01 20:24:47 -03001302 forward = uvc_entity_by_reference(chain->dev, entity->id,
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001303 forward);
1304 if (forward == NULL)
1305 break;
Laurent Pinchart8e113592009-07-01 20:24:47 -03001306 if (forward == prev)
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001307 continue;
1308
Laurent Pinchart8e113592009-07-01 20:24:47 -03001309 switch (UVC_ENTITY_TYPE(forward)) {
1310 case UVC_VC_EXTENSION_UNIT:
Laurent Pinchart8ca5a632009-11-25 12:00:30 -03001311 if (forward->bNrInPins != 1) {
Laurent Pinchart8e113592009-07-01 20:24:47 -03001312 uvc_trace(UVC_TRACE_DESCR, "Extension unit %d "
1313 "has more than 1 input pin.\n",
1314 entity->id);
1315 return -EINVAL;
1316 }
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001317
Laurent Pinchart6241d8c2009-11-25 12:00:22 -03001318 list_add_tail(&forward->chain, &chain->entities);
Laurent Pinchart8e113592009-07-01 20:24:47 -03001319 if (uvc_trace_param & UVC_TRACE_PROBE) {
1320 if (!found)
1321 printk(" (->");
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001322
Laurent Pinchart8e113592009-07-01 20:24:47 -03001323 printk(" XU %d", forward->id);
1324 found = 1;
1325 }
1326 break;
1327
1328 case UVC_OTT_VENDOR_SPECIFIC:
1329 case UVC_OTT_DISPLAY:
1330 case UVC_OTT_MEDIA_TRANSPORT_OUTPUT:
1331 case UVC_TT_STREAMING:
1332 if (UVC_ENTITY_IS_ITERM(forward)) {
1333 uvc_trace(UVC_TRACE_DESCR, "Unsupported input "
1334 "terminal %u.\n", forward->id);
1335 return -EINVAL;
1336 }
1337
Laurent Pinchart6241d8c2009-11-25 12:00:22 -03001338 list_add_tail(&forward->chain, &chain->entities);
Laurent Pinchart8e113592009-07-01 20:24:47 -03001339 if (uvc_trace_param & UVC_TRACE_PROBE) {
1340 if (!found)
1341 printk(" (->");
1342
1343 printk(" OT %d", forward->id);
1344 found = 1;
1345 }
1346 break;
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001347 }
1348 }
1349 if (found)
1350 printk(")");
1351
1352 return 0;
1353}
1354
Laurent Pinchart8e113592009-07-01 20:24:47 -03001355static int uvc_scan_chain_backward(struct uvc_video_chain *chain,
Laurent Pinchart4057ac62009-11-25 12:00:29 -03001356 struct uvc_entity **_entity)
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001357{
Laurent Pinchart4057ac62009-11-25 12:00:29 -03001358 struct uvc_entity *entity = *_entity;
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001359 struct uvc_entity *term;
Laurent Pinchart4057ac62009-11-25 12:00:29 -03001360 int id = -EINVAL, i;
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001361
1362 switch (UVC_ENTITY_TYPE(entity)) {
Laurent Pinchartb482d922009-06-26 11:39:42 -03001363 case UVC_VC_EXTENSION_UNIT:
Laurent Pinchartb482d922009-06-26 11:39:42 -03001364 case UVC_VC_PROCESSING_UNIT:
Laurent Pinchart8ca5a632009-11-25 12:00:30 -03001365 id = entity->baSourceID[0];
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001366 break;
1367
Laurent Pinchartb482d922009-06-26 11:39:42 -03001368 case UVC_VC_SELECTOR_UNIT:
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001369 /* Single-input selector units are ignored. */
Laurent Pinchart8ca5a632009-11-25 12:00:30 -03001370 if (entity->bNrInPins == 1) {
1371 id = entity->baSourceID[0];
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001372 break;
1373 }
1374
1375 if (uvc_trace_param & UVC_TRACE_PROBE)
1376 printk(" <- IT");
1377
Laurent Pinchart8e113592009-07-01 20:24:47 -03001378 chain->selector = entity;
Laurent Pinchart8ca5a632009-11-25 12:00:30 -03001379 for (i = 0; i < entity->bNrInPins; ++i) {
1380 id = entity->baSourceID[i];
Laurent Pinchart8e113592009-07-01 20:24:47 -03001381 term = uvc_entity_by_id(chain->dev, id);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001382 if (term == NULL || !UVC_ENTITY_IS_ITERM(term)) {
1383 uvc_trace(UVC_TRACE_DESCR, "Selector unit %d "
1384 "input %d isn't connected to an "
1385 "input terminal\n", entity->id, i);
1386 return -1;
1387 }
1388
1389 if (uvc_trace_param & UVC_TRACE_PROBE)
1390 printk(" %d", term->id);
1391
Laurent Pinchart6241d8c2009-11-25 12:00:22 -03001392 list_add_tail(&term->chain, &chain->entities);
Laurent Pinchart8e113592009-07-01 20:24:47 -03001393 uvc_scan_chain_forward(chain, term, entity);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001394 }
1395
1396 if (uvc_trace_param & UVC_TRACE_PROBE)
1397 printk("\n");
1398
1399 id = 0;
1400 break;
Laurent Pinchart4057ac62009-11-25 12:00:29 -03001401
1402 case UVC_ITT_VENDOR_SPECIFIC:
1403 case UVC_ITT_CAMERA:
1404 case UVC_ITT_MEDIA_TRANSPORT_INPUT:
1405 case UVC_OTT_VENDOR_SPECIFIC:
1406 case UVC_OTT_DISPLAY:
1407 case UVC_OTT_MEDIA_TRANSPORT_OUTPUT:
1408 case UVC_TT_STREAMING:
Laurent Pinchart8ca5a632009-11-25 12:00:30 -03001409 id = UVC_ENTITY_IS_OTERM(entity) ? entity->baSourceID[0] : 0;
Laurent Pinchart4057ac62009-11-25 12:00:29 -03001410 break;
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001411 }
1412
Laurent Pinchart4057ac62009-11-25 12:00:29 -03001413 if (id <= 0) {
1414 *_entity = NULL;
1415 return id;
1416 }
1417
1418 entity = uvc_entity_by_id(chain->dev, id);
1419 if (entity == NULL) {
1420 uvc_trace(UVC_TRACE_DESCR, "Found reference to "
1421 "unknown entity %d.\n", id);
1422 return -EINVAL;
1423 }
1424
1425 *_entity = entity;
1426 return 0;
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001427}
1428
Laurent Pinchart8e113592009-07-01 20:24:47 -03001429static int uvc_scan_chain(struct uvc_video_chain *chain,
Laurent Pinchart4057ac62009-11-25 12:00:29 -03001430 struct uvc_entity *term)
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001431{
1432 struct uvc_entity *entity, *prev;
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001433
Laurent Pinchart4057ac62009-11-25 12:00:29 -03001434 uvc_trace(UVC_TRACE_PROBE, "Scanning UVC chain:");
Laurent Pinchartff924202008-12-28 22:32:29 -03001435
Laurent Pinchart4057ac62009-11-25 12:00:29 -03001436 entity = term;
1437 prev = NULL;
Laurent Pinchart8e113592009-07-01 20:24:47 -03001438
Laurent Pinchart4057ac62009-11-25 12:00:29 -03001439 while (entity != NULL) {
1440 /* Entity must not be part of an existing chain */
Laurent Pinchart8e113592009-07-01 20:24:47 -03001441 if (entity->chain.next || entity->chain.prev) {
1442 uvc_trace(UVC_TRACE_DESCR, "Found reference to "
Laurent Pinchart4057ac62009-11-25 12:00:29 -03001443 "entity %d already in chain.\n", entity->id);
Laurent Pinchart8e113592009-07-01 20:24:47 -03001444 return -EINVAL;
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001445 }
1446
1447 /* Process entity */
Laurent Pinchart8e113592009-07-01 20:24:47 -03001448 if (uvc_scan_chain_entity(chain, entity) < 0)
1449 return -EINVAL;
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001450
1451 /* Forward scan */
Laurent Pinchart8e113592009-07-01 20:24:47 -03001452 if (uvc_scan_chain_forward(chain, entity, prev) < 0)
1453 return -EINVAL;
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001454
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001455 /* Backward scan */
Laurent Pinchart4057ac62009-11-25 12:00:29 -03001456 prev = entity;
1457 if (uvc_scan_chain_backward(chain, &entity) < 0)
1458 return -EINVAL;
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001459 }
1460
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001461 return 0;
1462}
1463
Laurent Pinchart6241d8c2009-11-25 12:00:22 -03001464static unsigned int uvc_print_terms(struct list_head *terms, u16 dir,
1465 char *buffer)
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001466{
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001467 struct uvc_entity *term;
Laurent Pinchart8e113592009-07-01 20:24:47 -03001468 unsigned int nterms = 0;
1469 char *p = buffer;
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001470
Laurent Pinchart8e113592009-07-01 20:24:47 -03001471 list_for_each_entry(term, terms, chain) {
Laurent Pinchart6241d8c2009-11-25 12:00:22 -03001472 if (!UVC_ENTITY_IS_TERM(term) ||
1473 UVC_TERM_DIRECTION(term) != dir)
1474 continue;
1475
1476 if (nterms)
Laurent Pinchart8e113592009-07-01 20:24:47 -03001477 p += sprintf(p, ",");
Laurent Pinchart6241d8c2009-11-25 12:00:22 -03001478 if (++nterms >= 4) {
1479 p += sprintf(p, "...");
1480 break;
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001481 }
Laurent Pinchart6241d8c2009-11-25 12:00:22 -03001482 p += sprintf(p, "%u", term->id);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001483 }
1484
Laurent Pinchart8e113592009-07-01 20:24:47 -03001485 return p - buffer;
1486}
1487
1488static const char *uvc_print_chain(struct uvc_video_chain *chain)
1489{
1490 static char buffer[43];
1491 char *p = buffer;
1492
Laurent Pinchart6241d8c2009-11-25 12:00:22 -03001493 p += uvc_print_terms(&chain->entities, UVC_TERM_INPUT, p);
Laurent Pinchart8e113592009-07-01 20:24:47 -03001494 p += sprintf(p, " -> ");
Laurent Pinchart6241d8c2009-11-25 12:00:22 -03001495 uvc_print_terms(&chain->entities, UVC_TERM_OUTPUT, p);
Laurent Pinchart8e113592009-07-01 20:24:47 -03001496
1497 return buffer;
1498}
1499
1500/*
1501 * Scan the device for video chains and register video devices.
1502 *
1503 * Chains are scanned starting at their output terminals and walked backwards.
1504 */
1505static int uvc_scan_device(struct uvc_device *dev)
1506{
1507 struct uvc_video_chain *chain;
1508 struct uvc_entity *term;
1509
1510 list_for_each_entry(term, &dev->entities, list) {
1511 if (!UVC_ENTITY_IS_OTERM(term))
1512 continue;
1513
1514 /* If the terminal is already included in a chain, skip it.
1515 * This can happen for chains that have multiple output
1516 * terminals, where all output terminals beside the first one
1517 * will be inserted in the chain in forward scans.
1518 */
1519 if (term->chain.next || term->chain.prev)
1520 continue;
1521
1522 chain = kzalloc(sizeof(*chain), GFP_KERNEL);
1523 if (chain == NULL)
1524 return -ENOMEM;
1525
Laurent Pinchart6241d8c2009-11-25 12:00:22 -03001526 INIT_LIST_HEAD(&chain->entities);
Laurent Pinchart8e113592009-07-01 20:24:47 -03001527 mutex_init(&chain->ctrl_mutex);
1528 chain->dev = dev;
1529
1530 if (uvc_scan_chain(chain, term) < 0) {
1531 kfree(chain);
1532 continue;
1533 }
1534
1535 uvc_trace(UVC_TRACE_PROBE, "Found a valid video chain (%s).\n",
1536 uvc_print_chain(chain));
1537
1538 list_add_tail(&chain->list, &dev->chains);
1539 }
1540
1541 if (list_empty(&dev->chains)) {
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001542 uvc_printk(KERN_INFO, "No valid video chain found.\n");
1543 return -1;
1544 }
1545
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001546 return 0;
1547}
1548
Laurent Pinchart8e113592009-07-01 20:24:47 -03001549/* ------------------------------------------------------------------------
1550 * Video device registration and unregistration
1551 */
1552
1553/*
Laurent Pinchart716fdee2009-09-29 21:07:19 -03001554 * Delete the UVC device.
1555 *
1556 * Called by the kernel when the last reference to the uvc_device structure
1557 * is released.
1558 *
1559 * As this function is called after or during disconnect(), all URBs have
1560 * already been canceled by the USB core. There is no need to kill the
1561 * interrupt URB manually.
1562 */
1563static void uvc_delete(struct uvc_device *dev)
1564{
1565 struct list_head *p, *n;
1566
1567 usb_put_intf(dev->intf);
1568 usb_put_dev(dev->udev);
1569
1570 uvc_status_cleanup(dev);
1571 uvc_ctrl_cleanup_device(dev);
1572
1573 list_for_each_safe(p, n, &dev->chains) {
1574 struct uvc_video_chain *chain;
1575 chain = list_entry(p, struct uvc_video_chain, list);
1576 kfree(chain);
1577 }
1578
1579 list_for_each_safe(p, n, &dev->entities) {
1580 struct uvc_entity *entity;
1581 entity = list_entry(p, struct uvc_entity, list);
1582 kfree(entity);
1583 }
1584
1585 list_for_each_safe(p, n, &dev->streams) {
1586 struct uvc_streaming *streaming;
1587 streaming = list_entry(p, struct uvc_streaming, list);
1588 usb_driver_release_interface(&uvc_driver.driver,
1589 streaming->intf);
1590 usb_put_intf(streaming->intf);
1591 kfree(streaming->format);
1592 kfree(streaming->header.bmaControls);
1593 kfree(streaming);
1594 }
1595
1596 kfree(dev);
1597}
1598
1599static void uvc_release(struct video_device *vdev)
1600{
1601 struct uvc_streaming *stream = video_get_drvdata(vdev);
1602 struct uvc_device *dev = stream->dev;
1603
1604 video_device_release(vdev);
1605
1606 /* Decrement the registered streams count and delete the device when it
1607 * reaches zero.
1608 */
1609 if (atomic_dec_and_test(&dev->nstreams))
1610 uvc_delete(dev);
1611}
1612
1613/*
Laurent Pinchart8e113592009-07-01 20:24:47 -03001614 * Unregister the video devices.
1615 */
1616static void uvc_unregister_video(struct uvc_device *dev)
1617{
1618 struct uvc_streaming *stream;
1619
Laurent Pinchart716fdee2009-09-29 21:07:19 -03001620 /* Unregistering all video devices might result in uvc_delete() being
1621 * called from inside the loop if there's no open file handle. To avoid
1622 * that, increment the stream count before iterating over the streams
1623 * and decrement it when done.
1624 */
1625 atomic_inc(&dev->nstreams);
1626
Laurent Pinchart8e113592009-07-01 20:24:47 -03001627 list_for_each_entry(stream, &dev->streams, list) {
1628 if (stream->vdev == NULL)
1629 continue;
1630
Laurent Pinchart716fdee2009-09-29 21:07:19 -03001631 video_unregister_device(stream->vdev);
Laurent Pinchart8e113592009-07-01 20:24:47 -03001632 stream->vdev = NULL;
1633 }
Laurent Pinchart716fdee2009-09-29 21:07:19 -03001634
1635 /* Decrement the stream count and call uvc_delete explicitly if there
1636 * are no stream left.
1637 */
1638 if (atomic_dec_and_test(&dev->nstreams))
1639 uvc_delete(dev);
Laurent Pinchart8e113592009-07-01 20:24:47 -03001640}
1641
1642static int uvc_register_video(struct uvc_device *dev,
1643 struct uvc_streaming *stream)
1644{
1645 struct video_device *vdev;
1646 int ret;
1647
1648 /* Initialize the streaming interface with default streaming
1649 * parameters.
1650 */
1651 ret = uvc_video_init(stream);
1652 if (ret < 0) {
1653 uvc_printk(KERN_ERR, "Failed to initialize the device "
1654 "(%d).\n", ret);
1655 return ret;
1656 }
1657
1658 /* Register the device with V4L. */
1659 vdev = video_device_alloc();
1660 if (vdev == NULL) {
1661 uvc_printk(KERN_ERR, "Failed to allocate video device (%d).\n",
1662 ret);
1663 return -ENOMEM;
1664 }
1665
1666 /* We already hold a reference to dev->udev. The video device will be
1667 * unregistered before the reference is released, so we don't need to
1668 * get another one.
1669 */
1670 vdev->parent = &dev->intf->dev;
Laurent Pinchart8e113592009-07-01 20:24:47 -03001671 vdev->fops = &uvc_fops;
Laurent Pinchart716fdee2009-09-29 21:07:19 -03001672 vdev->release = uvc_release;
Laurent Pinchart8e113592009-07-01 20:24:47 -03001673 strlcpy(vdev->name, dev->name, sizeof vdev->name);
1674
1675 /* Set the driver data before calling video_register_device, otherwise
1676 * uvc_v4l2_open might race us.
1677 */
1678 stream->vdev = vdev;
1679 video_set_drvdata(vdev, stream);
1680
1681 ret = video_register_device(vdev, VFL_TYPE_GRABBER, -1);
1682 if (ret < 0) {
1683 uvc_printk(KERN_ERR, "Failed to register video device (%d).\n",
1684 ret);
1685 stream->vdev = NULL;
1686 video_device_release(vdev);
1687 return ret;
1688 }
1689
Laurent Pinchart716fdee2009-09-29 21:07:19 -03001690 atomic_inc(&dev->nstreams);
Laurent Pinchart8e113592009-07-01 20:24:47 -03001691 return 0;
1692}
1693
1694/*
1695 * Register all video devices in all chains.
1696 */
1697static int uvc_register_terms(struct uvc_device *dev,
Laurent Pinchart6241d8c2009-11-25 12:00:22 -03001698 struct uvc_video_chain *chain)
Laurent Pinchart8e113592009-07-01 20:24:47 -03001699{
1700 struct uvc_streaming *stream;
1701 struct uvc_entity *term;
1702 int ret;
1703
Laurent Pinchart6241d8c2009-11-25 12:00:22 -03001704 list_for_each_entry(term, &chain->entities, chain) {
Laurent Pinchart8e113592009-07-01 20:24:47 -03001705 if (UVC_ENTITY_TYPE(term) != UVC_TT_STREAMING)
1706 continue;
1707
1708 stream = uvc_stream_by_id(dev, term->id);
1709 if (stream == NULL) {
1710 uvc_printk(KERN_INFO, "No streaming interface found "
1711 "for terminal %u.", term->id);
1712 continue;
1713 }
1714
1715 stream->chain = chain;
1716 ret = uvc_register_video(dev, stream);
1717 if (ret < 0)
1718 return ret;
1719 }
1720
1721 return 0;
1722}
1723
1724static int uvc_register_chains(struct uvc_device *dev)
1725{
1726 struct uvc_video_chain *chain;
1727 int ret;
1728
1729 list_for_each_entry(chain, &dev->chains, list) {
Laurent Pinchart6241d8c2009-11-25 12:00:22 -03001730 ret = uvc_register_terms(dev, chain);
Laurent Pinchart8e113592009-07-01 20:24:47 -03001731 if (ret < 0)
1732 return ret;
1733 }
1734
1735 return 0;
1736}
1737
1738/* ------------------------------------------------------------------------
1739 * USB probe, disconnect, suspend and resume
1740 */
1741
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001742static int uvc_probe(struct usb_interface *intf,
1743 const struct usb_device_id *id)
1744{
1745 struct usb_device *udev = interface_to_usbdev(intf);
1746 struct uvc_device *dev;
1747 int ret;
1748
1749 if (id->idVendor && id->idProduct)
1750 uvc_trace(UVC_TRACE_PROBE, "Probing known UVC device %s "
1751 "(%04x:%04x)\n", udev->devpath, id->idVendor,
1752 id->idProduct);
1753 else
1754 uvc_trace(UVC_TRACE_PROBE, "Probing generic UVC device %s\n",
1755 udev->devpath);
1756
Laurent Pinchart2c2d2642009-01-03 19:12:40 -03001757 /* Allocate memory for the device and initialize it. */
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001758 if ((dev = kzalloc(sizeof *dev, GFP_KERNEL)) == NULL)
1759 return -ENOMEM;
1760
1761 INIT_LIST_HEAD(&dev->entities);
Laurent Pinchart8e113592009-07-01 20:24:47 -03001762 INIT_LIST_HEAD(&dev->chains);
Laurent Pinchart35f02a62009-06-28 08:37:50 -03001763 INIT_LIST_HEAD(&dev->streams);
Laurent Pinchart716fdee2009-09-29 21:07:19 -03001764 atomic_set(&dev->nstreams, 0);
Laurent Pinchart04a37e02009-05-19 10:08:03 -03001765 atomic_set(&dev->users, 0);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001766
1767 dev->udev = usb_get_dev(udev);
1768 dev->intf = usb_get_intf(intf);
1769 dev->intfnum = intf->cur_altsetting->desc.bInterfaceNumber;
Laurent Pinchart73de3592009-12-10 10:00:39 -03001770 dev->quirks = (uvc_quirks_param == -1)
1771 ? id->driver_info : uvc_quirks_param;
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001772
1773 if (udev->product != NULL)
Laurent Pinchartd0ebf302009-01-08 14:05:11 -03001774 strlcpy(dev->name, udev->product, sizeof dev->name);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001775 else
1776 snprintf(dev->name, sizeof dev->name,
1777 "UVC Camera (%04x:%04x)",
1778 le16_to_cpu(udev->descriptor.idVendor),
1779 le16_to_cpu(udev->descriptor.idProduct));
1780
Laurent Pinchart2c2d2642009-01-03 19:12:40 -03001781 /* Parse the Video Class control descriptor. */
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001782 if (uvc_parse_control(dev) < 0) {
1783 uvc_trace(UVC_TRACE_PROBE, "Unable to parse UVC "
1784 "descriptors.\n");
1785 goto error;
1786 }
1787
Laurent Pinchartfba45782009-01-03 19:24:38 -03001788 uvc_printk(KERN_INFO, "Found UVC %u.%02x device %s (%04x:%04x)\n",
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001789 dev->uvc_version >> 8, dev->uvc_version & 0xff,
1790 udev->product ? udev->product : "<unnamed>",
1791 le16_to_cpu(udev->descriptor.idVendor),
1792 le16_to_cpu(udev->descriptor.idProduct));
1793
Laurent Pinchart73de3592009-12-10 10:00:39 -03001794 if (dev->quirks != id->driver_info) {
1795 uvc_printk(KERN_INFO, "Forcing device quirks to 0x%x by module "
1796 "parameter for testing purpose.\n", dev->quirks);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001797 uvc_printk(KERN_INFO, "Please report required quirks to the "
1798 "linux-uvc-devel mailing list.\n");
1799 }
1800
Laurent Pinchart2c2d2642009-01-03 19:12:40 -03001801 /* Initialize controls. */
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001802 if (uvc_ctrl_init_device(dev) < 0)
1803 goto error;
1804
Laurent Pinchart8e113592009-07-01 20:24:47 -03001805 /* Scan the device for video chains. */
Laurent Pinchart35f02a62009-06-28 08:37:50 -03001806 if (uvc_scan_device(dev) < 0)
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001807 goto error;
1808
Laurent Pinchart8e113592009-07-01 20:24:47 -03001809 /* Register video devices. */
1810 if (uvc_register_chains(dev) < 0)
1811 goto error;
1812
Laurent Pinchart2c2d2642009-01-03 19:12:40 -03001813 /* Save our data pointer in the interface data. */
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001814 usb_set_intfdata(intf, dev);
1815
Laurent Pinchart2c2d2642009-01-03 19:12:40 -03001816 /* Initialize the interrupt URB. */
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001817 if ((ret = uvc_status_init(dev)) < 0) {
1818 uvc_printk(KERN_INFO, "Unable to initialize the status "
1819 "endpoint (%d), status interrupt will not be "
1820 "supported.\n", ret);
1821 }
1822
1823 uvc_trace(UVC_TRACE_PROBE, "UVC device initialized.\n");
Matthew Garrett3dae8b42010-09-16 15:00:04 -03001824 usb_enable_autosuspend(udev);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001825 return 0;
1826
1827error:
Laurent Pinchart716fdee2009-09-29 21:07:19 -03001828 uvc_unregister_video(dev);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001829 return -ENODEV;
1830}
1831
1832static void uvc_disconnect(struct usb_interface *intf)
1833{
1834 struct uvc_device *dev = usb_get_intfdata(intf);
1835
1836 /* Set the USB interface data to NULL. This can be done outside the
1837 * lock, as there's no other reader.
1838 */
1839 usb_set_intfdata(intf, NULL);
1840
Laurent Pinchartb482d922009-06-26 11:39:42 -03001841 if (intf->cur_altsetting->desc.bInterfaceSubClass ==
1842 UVC_SC_VIDEOSTREAMING)
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001843 return;
1844
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001845 dev->state |= UVC_DEV_DISCONNECTED;
Laurent Pincharta9e28582008-07-11 19:32:15 -03001846
Laurent Pinchart716fdee2009-09-29 21:07:19 -03001847 uvc_unregister_video(dev);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001848}
1849
1850static int uvc_suspend(struct usb_interface *intf, pm_message_t message)
1851{
1852 struct uvc_device *dev = usb_get_intfdata(intf);
Laurent Pinchart35f02a62009-06-28 08:37:50 -03001853 struct uvc_streaming *stream;
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001854
1855 uvc_trace(UVC_TRACE_SUSPEND, "Suspending interface %u\n",
1856 intf->cur_altsetting->desc.bInterfaceNumber);
1857
1858 /* Controls are cached on the fly so they don't need to be saved. */
Laurent Pinchartb482d922009-06-26 11:39:42 -03001859 if (intf->cur_altsetting->desc.bInterfaceSubClass ==
1860 UVC_SC_VIDEOCONTROL)
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001861 return uvc_status_suspend(dev);
1862
Laurent Pinchart35f02a62009-06-28 08:37:50 -03001863 list_for_each_entry(stream, &dev->streams, list) {
1864 if (stream->intf == intf)
1865 return uvc_video_suspend(stream);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001866 }
1867
Laurent Pinchart35f02a62009-06-28 08:37:50 -03001868 uvc_trace(UVC_TRACE_SUSPEND, "Suspend: video streaming USB interface "
1869 "mismatch.\n");
1870 return -EINVAL;
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001871}
1872
Laurent Pinchart9b0ae862008-08-22 17:25:10 -03001873static int __uvc_resume(struct usb_interface *intf, int reset)
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001874{
1875 struct uvc_device *dev = usb_get_intfdata(intf);
Laurent Pinchart35f02a62009-06-28 08:37:50 -03001876 struct uvc_streaming *stream;
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001877
1878 uvc_trace(UVC_TRACE_SUSPEND, "Resuming interface %u\n",
1879 intf->cur_altsetting->desc.bInterfaceNumber);
1880
Laurent Pinchartb482d922009-06-26 11:39:42 -03001881 if (intf->cur_altsetting->desc.bInterfaceSubClass ==
1882 UVC_SC_VIDEOCONTROL) {
Hans Verkuil7564f672009-05-02 08:12:36 -03001883 if (reset) {
1884 int ret = uvc_ctrl_resume_device(dev);
1885
1886 if (ret < 0)
1887 return ret;
1888 }
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001889
1890 return uvc_status_resume(dev);
1891 }
1892
Laurent Pinchart35f02a62009-06-28 08:37:50 -03001893 list_for_each_entry(stream, &dev->streams, list) {
1894 if (stream->intf == intf)
1895 return uvc_video_resume(stream);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001896 }
1897
Laurent Pinchart35f02a62009-06-28 08:37:50 -03001898 uvc_trace(UVC_TRACE_SUSPEND, "Resume: video streaming USB interface "
1899 "mismatch.\n");
1900 return -EINVAL;
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001901}
1902
Laurent Pinchart9b0ae862008-08-22 17:25:10 -03001903static int uvc_resume(struct usb_interface *intf)
1904{
1905 return __uvc_resume(intf, 0);
1906}
1907
1908static int uvc_reset_resume(struct usb_interface *intf)
1909{
1910 return __uvc_resume(intf, 1);
1911}
1912
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001913/* ------------------------------------------------------------------------
Laurent Pinchart310fe522009-12-09 22:57:48 -03001914 * Module parameters
1915 */
1916
1917static int uvc_clock_param_get(char *buffer, struct kernel_param *kp)
1918{
1919 if (uvc_clock_param == CLOCK_MONOTONIC)
1920 return sprintf(buffer, "CLOCK_MONOTONIC");
1921 else
1922 return sprintf(buffer, "CLOCK_REALTIME");
1923}
1924
1925static int uvc_clock_param_set(const char *val, struct kernel_param *kp)
1926{
1927 if (strncasecmp(val, "clock_", strlen("clock_")) == 0)
1928 val += strlen("clock_");
1929
1930 if (strcasecmp(val, "monotonic") == 0)
1931 uvc_clock_param = CLOCK_MONOTONIC;
1932 else if (strcasecmp(val, "realtime") == 0)
1933 uvc_clock_param = CLOCK_REALTIME;
1934 else
1935 return -EINVAL;
1936
1937 return 0;
1938}
1939
1940module_param_call(clock, uvc_clock_param_set, uvc_clock_param_get,
1941 &uvc_clock_param, S_IRUGO|S_IWUSR);
1942MODULE_PARM_DESC(clock, "Video buffers timestamp clock");
1943module_param_named(nodrop, uvc_no_drop_param, uint, S_IRUGO|S_IWUSR);
1944MODULE_PARM_DESC(nodrop, "Don't drop incomplete frames");
1945module_param_named(quirks, uvc_quirks_param, uint, S_IRUGO|S_IWUSR);
1946MODULE_PARM_DESC(quirks, "Forced device quirks");
1947module_param_named(trace, uvc_trace_param, uint, S_IRUGO|S_IWUSR);
1948MODULE_PARM_DESC(trace, "Trace level bitmask");
1949module_param_named(timeout, uvc_timeout_param, uint, S_IRUGO|S_IWUSR);
1950MODULE_PARM_DESC(timeout, "Streaming control requests timeout");
1951
1952/* ------------------------------------------------------------------------
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001953 * Driver initialization and cleanup
1954 */
1955
1956/*
1957 * The Logitech cameras listed below have their interface class set to
1958 * VENDOR_SPEC because they don't announce themselves as UVC devices, even
1959 * though they are compliant.
1960 */
1961static struct usb_device_id uvc_ids[] = {
Laurent Pinchartbce039c2009-11-25 11:15:56 -03001962 /* Genius eFace 2025 */
1963 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1964 | USB_DEVICE_ID_MATCH_INT_INFO,
1965 .idVendor = 0x0458,
1966 .idProduct = 0x706e,
1967 .bInterfaceClass = USB_CLASS_VIDEO,
1968 .bInterfaceSubClass = 1,
1969 .bInterfaceProtocol = 0,
1970 .driver_info = UVC_QUIRK_PROBE_MINMAX },
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001971 /* Microsoft Lifecam NX-6000 */
1972 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1973 | USB_DEVICE_ID_MATCH_INT_INFO,
1974 .idVendor = 0x045e,
1975 .idProduct = 0x00f8,
1976 .bInterfaceClass = USB_CLASS_VIDEO,
1977 .bInterfaceSubClass = 1,
1978 .bInterfaceProtocol = 0,
1979 .driver_info = UVC_QUIRK_PROBE_MINMAX },
1980 /* Microsoft Lifecam VX-7000 */
1981 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1982 | USB_DEVICE_ID_MATCH_INT_INFO,
1983 .idVendor = 0x045e,
1984 .idProduct = 0x0723,
1985 .bInterfaceClass = USB_CLASS_VIDEO,
1986 .bInterfaceSubClass = 1,
1987 .bInterfaceProtocol = 0,
1988 .driver_info = UVC_QUIRK_PROBE_MINMAX },
1989 /* Logitech Quickcam Fusion */
1990 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1991 | USB_DEVICE_ID_MATCH_INT_INFO,
1992 .idVendor = 0x046d,
1993 .idProduct = 0x08c1,
1994 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
1995 .bInterfaceSubClass = 1,
1996 .bInterfaceProtocol = 0 },
1997 /* Logitech Quickcam Orbit MP */
1998 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
1999 | USB_DEVICE_ID_MATCH_INT_INFO,
2000 .idVendor = 0x046d,
2001 .idProduct = 0x08c2,
2002 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
2003 .bInterfaceSubClass = 1,
2004 .bInterfaceProtocol = 0 },
2005 /* Logitech Quickcam Pro for Notebook */
2006 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2007 | USB_DEVICE_ID_MATCH_INT_INFO,
2008 .idVendor = 0x046d,
2009 .idProduct = 0x08c3,
2010 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
2011 .bInterfaceSubClass = 1,
2012 .bInterfaceProtocol = 0 },
2013 /* Logitech Quickcam Pro 5000 */
2014 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2015 | USB_DEVICE_ID_MATCH_INT_INFO,
2016 .idVendor = 0x046d,
2017 .idProduct = 0x08c5,
2018 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
2019 .bInterfaceSubClass = 1,
2020 .bInterfaceProtocol = 0 },
2021 /* Logitech Quickcam OEM Dell Notebook */
2022 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2023 | USB_DEVICE_ID_MATCH_INT_INFO,
2024 .idVendor = 0x046d,
2025 .idProduct = 0x08c6,
2026 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
2027 .bInterfaceSubClass = 1,
2028 .bInterfaceProtocol = 0 },
2029 /* Logitech Quickcam OEM Cisco VT Camera II */
2030 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2031 | USB_DEVICE_ID_MATCH_INT_INFO,
2032 .idVendor = 0x046d,
2033 .idProduct = 0x08c7,
2034 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
2035 .bInterfaceSubClass = 1,
2036 .bInterfaceProtocol = 0 },
Laurent Pinchart86d8b6a2010-09-16 12:37:26 -03002037 /* Chicony CNF7129 (Asus EEE 100HE) */
2038 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2039 | USB_DEVICE_ID_MATCH_INT_INFO,
2040 .idVendor = 0x04f2,
2041 .idProduct = 0xb071,
2042 .bInterfaceClass = USB_CLASS_VIDEO,
2043 .bInterfaceSubClass = 1,
2044 .bInterfaceProtocol = 0,
2045 .driver_info = UVC_QUIRK_RESTRICT_FRAME_RATE },
Laurent Pinchartf61d1d82009-01-14 12:49:11 -03002046 /* Alcor Micro AU3820 (Future Boy PC USB Webcam) */
2047 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2048 | USB_DEVICE_ID_MATCH_INT_INFO,
2049 .idVendor = 0x058f,
2050 .idProduct = 0x3820,
2051 .bInterfaceClass = USB_CLASS_VIDEO,
2052 .bInterfaceSubClass = 1,
2053 .bInterfaceProtocol = 0,
2054 .driver_info = UVC_QUIRK_PROBE_MINMAX },
Laurent Pinchartc0efd232008-06-30 15:04:50 -03002055 /* Apple Built-In iSight */
Laurent Pinchart2c2d2642009-01-03 19:12:40 -03002056 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
Laurent Pinchartc0efd232008-06-30 15:04:50 -03002057 | USB_DEVICE_ID_MATCH_INT_INFO,
2058 .idVendor = 0x05ac,
2059 .idProduct = 0x8501,
Laurent Pinchart2c2d2642009-01-03 19:12:40 -03002060 .bInterfaceClass = USB_CLASS_VIDEO,
2061 .bInterfaceSubClass = 1,
2062 .bInterfaceProtocol = 0,
Laurent Pinchartc0efd232008-06-30 15:04:50 -03002063 .driver_info = UVC_QUIRK_PROBE_MINMAX
2064 | UVC_QUIRK_BUILTIN_ISIGHT },
2065 /* Genesys Logic USB 2.0 PC Camera */
Laurent Pinchart2c2d2642009-01-03 19:12:40 -03002066 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
Laurent Pinchartc0efd232008-06-30 15:04:50 -03002067 | USB_DEVICE_ID_MATCH_INT_INFO,
Laurent Pinchart2c2d2642009-01-03 19:12:40 -03002068 .idVendor = 0x05e3,
2069 .idProduct = 0x0505,
2070 .bInterfaceClass = USB_CLASS_VIDEO,
2071 .bInterfaceSubClass = 1,
2072 .bInterfaceProtocol = 0,
2073 .driver_info = UVC_QUIRK_STREAM_NO_FID },
Laurent Pinchartd79cd832009-07-19 19:16:05 -03002074 /* ViMicro Vega */
2075 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
Laurent Pinchart50144ae2009-02-16 17:41:52 -03002076 | USB_DEVICE_ID_MATCH_INT_INFO,
2077 .idVendor = 0x0ac8,
Laurent Pinchartd79cd832009-07-19 19:16:05 -03002078 .idProduct = 0x332d,
2079 .bInterfaceClass = USB_CLASS_VIDEO,
2080 .bInterfaceSubClass = 1,
2081 .bInterfaceProtocol = 0,
2082 .driver_info = UVC_QUIRK_FIX_BANDWIDTH },
2083 /* ViMicro - Minoru3D */
2084 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2085 | USB_DEVICE_ID_MATCH_INT_INFO,
2086 .idVendor = 0x0ac8,
2087 .idProduct = 0x3410,
2088 .bInterfaceClass = USB_CLASS_VIDEO,
2089 .bInterfaceSubClass = 1,
2090 .bInterfaceProtocol = 0,
2091 .driver_info = UVC_QUIRK_FIX_BANDWIDTH },
2092 /* ViMicro Venus - Minoru3D */
2093 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2094 | USB_DEVICE_ID_MATCH_INT_INFO,
2095 .idVendor = 0x0ac8,
2096 .idProduct = 0x3420,
Laurent Pinchart50144ae2009-02-16 17:41:52 -03002097 .bInterfaceClass = USB_CLASS_VIDEO,
2098 .bInterfaceSubClass = 1,
2099 .bInterfaceProtocol = 0,
2100 .driver_info = UVC_QUIRK_FIX_BANDWIDTH },
Laurent Pinchartc0efd232008-06-30 15:04:50 -03002101 /* MT6227 */
2102 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2103 | USB_DEVICE_ID_MATCH_INT_INFO,
2104 .idVendor = 0x0e8d,
2105 .idProduct = 0x0004,
2106 .bInterfaceClass = USB_CLASS_VIDEO,
2107 .bInterfaceSubClass = 1,
2108 .bInterfaceProtocol = 0,
Laurent Pinchartbab6f662009-07-19 18:39:56 -03002109 .driver_info = UVC_QUIRK_PROBE_MINMAX
2110 | UVC_QUIRK_PROBE_DEF },
Laurent Pinchart9275b322010-09-12 08:31:29 -03002111 /* IMC Networks (Medion Akoya) */
2112 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2113 | USB_DEVICE_ID_MATCH_INT_INFO,
2114 .idVendor = 0x13d3,
2115 .idProduct = 0x5103,
2116 .bInterfaceClass = USB_CLASS_VIDEO,
2117 .bInterfaceSubClass = 1,
2118 .bInterfaceProtocol = 0,
2119 .driver_info = UVC_QUIRK_STREAM_NO_FID },
Laurent Pinchartc0efd232008-06-30 15:04:50 -03002120 /* Syntek (HP Spartan) */
2121 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2122 | USB_DEVICE_ID_MATCH_INT_INFO,
2123 .idVendor = 0x174f,
2124 .idProduct = 0x5212,
2125 .bInterfaceClass = USB_CLASS_VIDEO,
2126 .bInterfaceSubClass = 1,
2127 .bInterfaceProtocol = 0,
2128 .driver_info = UVC_QUIRK_STREAM_NO_FID },
Laurent Pinchart562f0fe2008-11-08 18:47:28 -03002129 /* Syntek (Samsung Q310) */
2130 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2131 | USB_DEVICE_ID_MATCH_INT_INFO,
2132 .idVendor = 0x174f,
2133 .idProduct = 0x5931,
2134 .bInterfaceClass = USB_CLASS_VIDEO,
2135 .bInterfaceSubClass = 1,
2136 .bInterfaceProtocol = 0,
2137 .driver_info = UVC_QUIRK_STREAM_NO_FID },
Laurent Pinchartf129b032010-03-13 18:12:15 -03002138 /* Syntek (Packard Bell EasyNote MX52 */
2139 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2140 | USB_DEVICE_ID_MATCH_INT_INFO,
2141 .idVendor = 0x174f,
2142 .idProduct = 0x8a12,
2143 .bInterfaceClass = USB_CLASS_VIDEO,
2144 .bInterfaceSubClass = 1,
2145 .bInterfaceProtocol = 0,
2146 .driver_info = UVC_QUIRK_STREAM_NO_FID },
Laurent Pinchartf61d1d82009-01-14 12:49:11 -03002147 /* Syntek (Asus F9SG) */
Laurent Pinchart25e69852008-07-09 18:29:59 -03002148 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2149 | USB_DEVICE_ID_MATCH_INT_INFO,
2150 .idVendor = 0x174f,
2151 .idProduct = 0x8a31,
2152 .bInterfaceClass = USB_CLASS_VIDEO,
2153 .bInterfaceSubClass = 1,
2154 .bInterfaceProtocol = 0,
2155 .driver_info = UVC_QUIRK_STREAM_NO_FID },
Laurent Pinchartc0efd232008-06-30 15:04:50 -03002156 /* Syntek (Asus U3S) */
2157 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2158 | USB_DEVICE_ID_MATCH_INT_INFO,
2159 .idVendor = 0x174f,
2160 .idProduct = 0x8a33,
2161 .bInterfaceClass = USB_CLASS_VIDEO,
2162 .bInterfaceSubClass = 1,
2163 .bInterfaceProtocol = 0,
2164 .driver_info = UVC_QUIRK_STREAM_NO_FID },
Laurent Pinchart0ce566d2009-03-27 10:46:49 -03002165 /* Syntek (JAOtech Smart Terminal) */
2166 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2167 | USB_DEVICE_ID_MATCH_INT_INFO,
2168 .idVendor = 0x174f,
2169 .idProduct = 0x8a34,
2170 .bInterfaceClass = USB_CLASS_VIDEO,
2171 .bInterfaceSubClass = 1,
2172 .bInterfaceProtocol = 0,
2173 .driver_info = UVC_QUIRK_STREAM_NO_FID },
Laurent Pinchart70092c22010-08-03 11:18:01 -03002174 /* Miricle 307K */
2175 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2176 | USB_DEVICE_ID_MATCH_INT_INFO,
2177 .idVendor = 0x17dc,
2178 .idProduct = 0x0202,
2179 .bInterfaceClass = USB_CLASS_VIDEO,
2180 .bInterfaceSubClass = 1,
2181 .bInterfaceProtocol = 0,
2182 .driver_info = UVC_QUIRK_STREAM_NO_FID },
Filipe Rosset849a3ab2009-05-19 10:12:17 -03002183 /* Lenovo Thinkpad SL400/SL500 */
Laurent Pinchart2f384832008-11-08 18:52:04 -03002184 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2185 | USB_DEVICE_ID_MATCH_INT_INFO,
2186 .idVendor = 0x17ef,
2187 .idProduct = 0x480b,
2188 .bInterfaceClass = USB_CLASS_VIDEO,
2189 .bInterfaceSubClass = 1,
2190 .bInterfaceProtocol = 0,
2191 .driver_info = UVC_QUIRK_STREAM_NO_FID },
Laurent Pinchart2d2bf2a2009-06-09 12:40:59 -03002192 /* Aveo Technology USB 2.0 Camera */
2193 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2194 | USB_DEVICE_ID_MATCH_INT_INFO,
2195 .idVendor = 0x1871,
2196 .idProduct = 0x0306,
2197 .bInterfaceClass = USB_CLASS_VIDEO,
2198 .bInterfaceSubClass = 1,
2199 .bInterfaceProtocol = 0,
Laurent Pinchart5bdf1372009-07-03 12:32:46 -03002200 .driver_info = UVC_QUIRK_PROBE_MINMAX
2201 | UVC_QUIRK_PROBE_EXTRAFIELDS },
Laurent Pinchartc0efd232008-06-30 15:04:50 -03002202 /* Ecamm Pico iMage */
2203 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2204 | USB_DEVICE_ID_MATCH_INT_INFO,
2205 .idVendor = 0x18cd,
2206 .idProduct = 0xcafe,
2207 .bInterfaceClass = USB_CLASS_VIDEO,
2208 .bInterfaceSubClass = 1,
2209 .bInterfaceProtocol = 0,
2210 .driver_info = UVC_QUIRK_PROBE_EXTRAFIELDS },
Laurent Pinchart2bb00fe2010-06-25 04:58:43 -03002211 /* Manta MM-353 Plako */
2212 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2213 | USB_DEVICE_ID_MATCH_INT_INFO,
2214 .idVendor = 0x18ec,
2215 .idProduct = 0x3188,
2216 .bInterfaceClass = USB_CLASS_VIDEO,
2217 .bInterfaceSubClass = 1,
2218 .bInterfaceProtocol = 0,
2219 .driver_info = UVC_QUIRK_PROBE_MINMAX },
Laurent Pinchartca4a3452009-06-09 12:46:43 -03002220 /* FSC WebCam V30S */
2221 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2222 | USB_DEVICE_ID_MATCH_INT_INFO,
2223 .idVendor = 0x18ec,
2224 .idProduct = 0x3288,
2225 .bInterfaceClass = USB_CLASS_VIDEO,
2226 .bInterfaceSubClass = 1,
2227 .bInterfaceProtocol = 0,
2228 .driver_info = UVC_QUIRK_PROBE_MINMAX },
Laurent Pinchart1e4d05b2010-03-04 07:51:25 -03002229 /* Arkmicro unbranded */
2230 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2231 | USB_DEVICE_ID_MATCH_INT_INFO,
2232 .idVendor = 0x18ec,
2233 .idProduct = 0x3290,
2234 .bInterfaceClass = USB_CLASS_VIDEO,
2235 .bInterfaceSubClass = 1,
2236 .bInterfaceProtocol = 0,
2237 .driver_info = UVC_QUIRK_PROBE_DEF },
Laurent Pinchartc0efd232008-06-30 15:04:50 -03002238 /* Bodelin ProScopeHR */
2239 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2240 | USB_DEVICE_ID_MATCH_DEV_HI
2241 | USB_DEVICE_ID_MATCH_INT_INFO,
2242 .idVendor = 0x19ab,
2243 .idProduct = 0x1000,
2244 .bcdDevice_hi = 0x0126,
2245 .bInterfaceClass = USB_CLASS_VIDEO,
2246 .bInterfaceSubClass = 1,
2247 .bInterfaceProtocol = 0,
2248 .driver_info = UVC_QUIRK_STATUS_INTERVAL },
Laurent Pinchart3bc766a2009-10-21 18:36:18 -03002249 /* MSI StarCam 370i */
2250 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2251 | USB_DEVICE_ID_MATCH_INT_INFO,
2252 .idVendor = 0x1b3b,
2253 .idProduct = 0x2951,
2254 .bInterfaceClass = USB_CLASS_VIDEO,
2255 .bInterfaceSubClass = 1,
2256 .bInterfaceProtocol = 0,
2257 .driver_info = UVC_QUIRK_PROBE_MINMAX },
Laurent Pinchartc0efd232008-06-30 15:04:50 -03002258 /* SiGma Micro USB Web Camera */
2259 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE
2260 | USB_DEVICE_ID_MATCH_INT_INFO,
2261 .idVendor = 0x1c4f,
2262 .idProduct = 0x3000,
2263 .bInterfaceClass = USB_CLASS_VIDEO,
2264 .bInterfaceSubClass = 1,
2265 .bInterfaceProtocol = 0,
2266 .driver_info = UVC_QUIRK_PROBE_MINMAX
Laurent Pinchartd732c442009-05-31 17:05:55 -03002267 | UVC_QUIRK_IGNORE_SELECTOR_UNIT },
Laurent Pinchartc0efd232008-06-30 15:04:50 -03002268 /* Generic USB Video Class */
2269 { USB_INTERFACE_INFO(USB_CLASS_VIDEO, 1, 0) },
2270 {}
2271};
2272
2273MODULE_DEVICE_TABLE(usb, uvc_ids);
2274
2275struct uvc_driver uvc_driver = {
2276 .driver = {
2277 .name = "uvcvideo",
2278 .probe = uvc_probe,
2279 .disconnect = uvc_disconnect,
2280 .suspend = uvc_suspend,
2281 .resume = uvc_resume,
Laurent Pinchart9b0ae862008-08-22 17:25:10 -03002282 .reset_resume = uvc_reset_resume,
Laurent Pinchartc0efd232008-06-30 15:04:50 -03002283 .id_table = uvc_ids,
2284 .supports_autosuspend = 1,
2285 },
2286};
2287
2288static int __init uvc_init(void)
2289{
2290 int result;
2291
2292 INIT_LIST_HEAD(&uvc_driver.devices);
2293 INIT_LIST_HEAD(&uvc_driver.controls);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03002294 mutex_init(&uvc_driver.ctrl_mutex);
2295
2296 uvc_ctrl_init();
2297
2298 result = usb_register(&uvc_driver.driver);
2299 if (result == 0)
2300 printk(KERN_INFO DRIVER_DESC " (" DRIVER_VERSION ")\n");
2301 return result;
2302}
2303
2304static void __exit uvc_cleanup(void)
2305{
2306 usb_deregister(&uvc_driver.driver);
Laurent Pinchart561474c22010-02-18 16:38:52 -03002307 uvc_ctrl_cleanup();
Laurent Pinchartc0efd232008-06-30 15:04:50 -03002308}
2309
2310module_init(uvc_init);
2311module_exit(uvc_cleanup);
2312
Laurent Pinchartc0efd232008-06-30 15:04:50 -03002313MODULE_AUTHOR(DRIVER_AUTHOR);
2314MODULE_DESCRIPTION(DRIVER_DESC);
2315MODULE_LICENSE("GPL");
2316MODULE_VERSION(DRIVER_VERSION);
Hans Verkuilf87086e2008-07-18 00:50:58 -03002317