V4L/DVB (13827): uvcvideo: Switch to a monotonic clock for V4L2 buffers timestamps
[linux-2.6.git] / drivers / media / video / uvc / uvc_video.c
1 /*
2  *      uvc_video.c  --  USB Video Class driver - Video handling
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 #include <linux/kernel.h>
15 #include <linux/list.h>
16 #include <linux/module.h>
17 #include <linux/usb.h>
18 #include <linux/videodev2.h>
19 #include <linux/vmalloc.h>
20 #include <linux/wait.h>
21 #include <asm/atomic.h>
22 #include <asm/unaligned.h>
23
24 #include <media/v4l2-common.h>
25
26 #include "uvcvideo.h"
27
28 /* ------------------------------------------------------------------------
29  * UVC Controls
30  */
31
32 static int __uvc_query_ctrl(struct uvc_device *dev, __u8 query, __u8 unit,
33                         __u8 intfnum, __u8 cs, void *data, __u16 size,
34                         int timeout)
35 {
36         __u8 type = USB_TYPE_CLASS | USB_RECIP_INTERFACE;
37         unsigned int pipe;
38
39         pipe = (query & 0x80) ? usb_rcvctrlpipe(dev->udev, 0)
40                               : usb_sndctrlpipe(dev->udev, 0);
41         type |= (query & 0x80) ? USB_DIR_IN : USB_DIR_OUT;
42
43         return usb_control_msg(dev->udev, pipe, query, type, cs << 8,
44                         unit << 8 | intfnum, data, size, timeout);
45 }
46
47 int uvc_query_ctrl(struct uvc_device *dev, __u8 query, __u8 unit,
48                         __u8 intfnum, __u8 cs, void *data, __u16 size)
49 {
50         int ret;
51
52         ret = __uvc_query_ctrl(dev, query, unit, intfnum, cs, data, size,
53                                 UVC_CTRL_CONTROL_TIMEOUT);
54         if (ret != size) {
55                 uvc_printk(KERN_ERR, "Failed to query (%u) UVC control %u "
56                         "(unit %u) : %d (exp. %u).\n", query, cs, unit, ret,
57                         size);
58                 return -EIO;
59         }
60
61         return 0;
62 }
63
64 static void uvc_fixup_video_ctrl(struct uvc_streaming *stream,
65         struct uvc_streaming_control *ctrl)
66 {
67         struct uvc_format *format;
68         struct uvc_frame *frame = NULL;
69         unsigned int i;
70
71         if (ctrl->bFormatIndex <= 0 ||
72             ctrl->bFormatIndex > stream->nformats)
73                 return;
74
75         format = &stream->format[ctrl->bFormatIndex - 1];
76
77         for (i = 0; i < format->nframes; ++i) {
78                 if (format->frame[i].bFrameIndex == ctrl->bFrameIndex) {
79                         frame = &format->frame[i];
80                         break;
81                 }
82         }
83
84         if (frame == NULL)
85                 return;
86
87         if (!(format->flags & UVC_FMT_FLAG_COMPRESSED) ||
88              (ctrl->dwMaxVideoFrameSize == 0 &&
89               stream->dev->uvc_version < 0x0110))
90                 ctrl->dwMaxVideoFrameSize =
91                         frame->dwMaxVideoFrameBufferSize;
92
93         if (!(format->flags & UVC_FMT_FLAG_COMPRESSED) &&
94             stream->dev->quirks & UVC_QUIRK_FIX_BANDWIDTH &&
95             stream->intf->num_altsetting > 1) {
96                 u32 interval;
97                 u32 bandwidth;
98
99                 interval = (ctrl->dwFrameInterval > 100000)
100                          ? ctrl->dwFrameInterval
101                          : frame->dwFrameInterval[0];
102
103                 /* Compute a bandwidth estimation by multiplying the frame
104                  * size by the number of video frames per second, divide the
105                  * result by the number of USB frames (or micro-frames for
106                  * high-speed devices) per second and add the UVC header size
107                  * (assumed to be 12 bytes long).
108                  */
109                 bandwidth = frame->wWidth * frame->wHeight / 8 * format->bpp;
110                 bandwidth *= 10000000 / interval + 1;
111                 bandwidth /= 1000;
112                 if (stream->dev->udev->speed == USB_SPEED_HIGH)
113                         bandwidth /= 8;
114                 bandwidth += 12;
115
116                 ctrl->dwMaxPayloadTransferSize = bandwidth;
117         }
118 }
119
120 static int uvc_get_video_ctrl(struct uvc_streaming *stream,
121         struct uvc_streaming_control *ctrl, int probe, __u8 query)
122 {
123         __u8 *data;
124         __u16 size;
125         int ret;
126
127         size = stream->dev->uvc_version >= 0x0110 ? 34 : 26;
128         if ((stream->dev->quirks & UVC_QUIRK_PROBE_DEF) &&
129                         query == UVC_GET_DEF)
130                 return -EIO;
131
132         data = kmalloc(size, GFP_KERNEL);
133         if (data == NULL)
134                 return -ENOMEM;
135
136         ret = __uvc_query_ctrl(stream->dev, query, 0, stream->intfnum,
137                 probe ? UVC_VS_PROBE_CONTROL : UVC_VS_COMMIT_CONTROL, data,
138                 size, uvc_timeout_param);
139
140         if ((query == UVC_GET_MIN || query == UVC_GET_MAX) && ret == 2) {
141                 /* Some cameras, mostly based on Bison Electronics chipsets,
142                  * answer a GET_MIN or GET_MAX request with the wCompQuality
143                  * field only.
144                  */
145                 uvc_warn_once(stream->dev, UVC_WARN_MINMAX, "UVC non "
146                         "compliance - GET_MIN/MAX(PROBE) incorrectly "
147                         "supported. Enabling workaround.\n");
148                 memset(ctrl, 0, sizeof *ctrl);
149                 ctrl->wCompQuality = le16_to_cpup((__le16 *)data);
150                 ret = 0;
151                 goto out;
152         } else if (query == UVC_GET_DEF && probe == 1 && ret != size) {
153                 /* Many cameras don't support the GET_DEF request on their
154                  * video probe control. Warn once and return, the caller will
155                  * fall back to GET_CUR.
156                  */
157                 uvc_warn_once(stream->dev, UVC_WARN_PROBE_DEF, "UVC non "
158                         "compliance - GET_DEF(PROBE) not supported. "
159                         "Enabling workaround.\n");
160                 ret = -EIO;
161                 goto out;
162         } else if (ret != size) {
163                 uvc_printk(KERN_ERR, "Failed to query (%u) UVC %s control : "
164                         "%d (exp. %u).\n", query, probe ? "probe" : "commit",
165                         ret, size);
166                 ret = -EIO;
167                 goto out;
168         }
169
170         ctrl->bmHint = le16_to_cpup((__le16 *)&data[0]);
171         ctrl->bFormatIndex = data[2];
172         ctrl->bFrameIndex = data[3];
173         ctrl->dwFrameInterval = le32_to_cpup((__le32 *)&data[4]);
174         ctrl->wKeyFrameRate = le16_to_cpup((__le16 *)&data[8]);
175         ctrl->wPFrameRate = le16_to_cpup((__le16 *)&data[10]);
176         ctrl->wCompQuality = le16_to_cpup((__le16 *)&data[12]);
177         ctrl->wCompWindowSize = le16_to_cpup((__le16 *)&data[14]);
178         ctrl->wDelay = le16_to_cpup((__le16 *)&data[16]);
179         ctrl->dwMaxVideoFrameSize = get_unaligned_le32(&data[18]);
180         ctrl->dwMaxPayloadTransferSize = get_unaligned_le32(&data[22]);
181
182         if (size == 34) {
183                 ctrl->dwClockFrequency = get_unaligned_le32(&data[26]);
184                 ctrl->bmFramingInfo = data[30];
185                 ctrl->bPreferedVersion = data[31];
186                 ctrl->bMinVersion = data[32];
187                 ctrl->bMaxVersion = data[33];
188         } else {
189                 ctrl->dwClockFrequency = stream->dev->clock_frequency;
190                 ctrl->bmFramingInfo = 0;
191                 ctrl->bPreferedVersion = 0;
192                 ctrl->bMinVersion = 0;
193                 ctrl->bMaxVersion = 0;
194         }
195
196         /* Some broken devices return null or wrong dwMaxVideoFrameSize and
197          * dwMaxPayloadTransferSize fields. Try to get the value from the
198          * format and frame descriptors.
199          */
200         uvc_fixup_video_ctrl(stream, ctrl);
201         ret = 0;
202
203 out:
204         kfree(data);
205         return ret;
206 }
207
208 static int uvc_set_video_ctrl(struct uvc_streaming *stream,
209         struct uvc_streaming_control *ctrl, int probe)
210 {
211         __u8 *data;
212         __u16 size;
213         int ret;
214
215         size = stream->dev->uvc_version >= 0x0110 ? 34 : 26;
216         data = kzalloc(size, GFP_KERNEL);
217         if (data == NULL)
218                 return -ENOMEM;
219
220         *(__le16 *)&data[0] = cpu_to_le16(ctrl->bmHint);
221         data[2] = ctrl->bFormatIndex;
222         data[3] = ctrl->bFrameIndex;
223         *(__le32 *)&data[4] = cpu_to_le32(ctrl->dwFrameInterval);
224         *(__le16 *)&data[8] = cpu_to_le16(ctrl->wKeyFrameRate);
225         *(__le16 *)&data[10] = cpu_to_le16(ctrl->wPFrameRate);
226         *(__le16 *)&data[12] = cpu_to_le16(ctrl->wCompQuality);
227         *(__le16 *)&data[14] = cpu_to_le16(ctrl->wCompWindowSize);
228         *(__le16 *)&data[16] = cpu_to_le16(ctrl->wDelay);
229         put_unaligned_le32(ctrl->dwMaxVideoFrameSize, &data[18]);
230         put_unaligned_le32(ctrl->dwMaxPayloadTransferSize, &data[22]);
231
232         if (size == 34) {
233                 put_unaligned_le32(ctrl->dwClockFrequency, &data[26]);
234                 data[30] = ctrl->bmFramingInfo;
235                 data[31] = ctrl->bPreferedVersion;
236                 data[32] = ctrl->bMinVersion;
237                 data[33] = ctrl->bMaxVersion;
238         }
239
240         ret = __uvc_query_ctrl(stream->dev, UVC_SET_CUR, 0, stream->intfnum,
241                 probe ? UVC_VS_PROBE_CONTROL : UVC_VS_COMMIT_CONTROL, data,
242                 size, uvc_timeout_param);
243         if (ret != size) {
244                 uvc_printk(KERN_ERR, "Failed to set UVC %s control : "
245                         "%d (exp. %u).\n", probe ? "probe" : "commit",
246                         ret, size);
247                 ret = -EIO;
248         }
249
250         kfree(data);
251         return ret;
252 }
253
254 int uvc_probe_video(struct uvc_streaming *stream,
255         struct uvc_streaming_control *probe)
256 {
257         struct uvc_streaming_control probe_min, probe_max;
258         __u16 bandwidth;
259         unsigned int i;
260         int ret;
261
262         mutex_lock(&stream->mutex);
263
264         /* Perform probing. The device should adjust the requested values
265          * according to its capabilities. However, some devices, namely the
266          * first generation UVC Logitech webcams, don't implement the Video
267          * Probe control properly, and just return the needed bandwidth. For
268          * that reason, if the needed bandwidth exceeds the maximum available
269          * bandwidth, try to lower the quality.
270          */
271         ret = uvc_set_video_ctrl(stream, probe, 1);
272         if (ret < 0)
273                 goto done;
274
275         /* Get the minimum and maximum values for compression settings. */
276         if (!(stream->dev->quirks & UVC_QUIRK_PROBE_MINMAX)) {
277                 ret = uvc_get_video_ctrl(stream, &probe_min, 1, UVC_GET_MIN);
278                 if (ret < 0)
279                         goto done;
280                 ret = uvc_get_video_ctrl(stream, &probe_max, 1, UVC_GET_MAX);
281                 if (ret < 0)
282                         goto done;
283
284                 probe->wCompQuality = probe_max.wCompQuality;
285         }
286
287         for (i = 0; i < 2; ++i) {
288                 ret = uvc_set_video_ctrl(stream, probe, 1);
289                 if (ret < 0)
290                         goto done;
291                 ret = uvc_get_video_ctrl(stream, probe, 1, UVC_GET_CUR);
292                 if (ret < 0)
293                         goto done;
294
295                 if (stream->intf->num_altsetting == 1)
296                         break;
297
298                 bandwidth = probe->dwMaxPayloadTransferSize;
299                 if (bandwidth <= stream->maxpsize)
300                         break;
301
302                 if (stream->dev->quirks & UVC_QUIRK_PROBE_MINMAX) {
303                         ret = -ENOSPC;
304                         goto done;
305                 }
306
307                 /* TODO: negotiate compression parameters */
308                 probe->wKeyFrameRate = probe_min.wKeyFrameRate;
309                 probe->wPFrameRate = probe_min.wPFrameRate;
310                 probe->wCompQuality = probe_max.wCompQuality;
311                 probe->wCompWindowSize = probe_min.wCompWindowSize;
312         }
313
314 done:
315         mutex_unlock(&stream->mutex);
316         return ret;
317 }
318
319 int uvc_commit_video(struct uvc_streaming *stream,
320         struct uvc_streaming_control *probe)
321 {
322         return uvc_set_video_ctrl(stream, probe, 0);
323 }
324
325 /* ------------------------------------------------------------------------
326  * Video codecs
327  */
328
329 /* Values for bmHeaderInfo (Video and Still Image Payload Headers, 2.4.3.3) */
330 #define UVC_STREAM_EOH  (1 << 7)
331 #define UVC_STREAM_ERR  (1 << 6)
332 #define UVC_STREAM_STI  (1 << 5)
333 #define UVC_STREAM_RES  (1 << 4)
334 #define UVC_STREAM_SCR  (1 << 3)
335 #define UVC_STREAM_PTS  (1 << 2)
336 #define UVC_STREAM_EOF  (1 << 1)
337 #define UVC_STREAM_FID  (1 << 0)
338
339 /* Video payload decoding is handled by uvc_video_decode_start(),
340  * uvc_video_decode_data() and uvc_video_decode_end().
341  *
342  * uvc_video_decode_start is called with URB data at the start of a bulk or
343  * isochronous payload. It processes header data and returns the header size
344  * in bytes if successful. If an error occurs, it returns a negative error
345  * code. The following error codes have special meanings.
346  *
347  * - EAGAIN informs the caller that the current video buffer should be marked
348  *   as done, and that the function should be called again with the same data
349  *   and a new video buffer. This is used when end of frame conditions can be
350  *   reliably detected at the beginning of the next frame only.
351  *
352  * If an error other than -EAGAIN is returned, the caller will drop the current
353  * payload. No call to uvc_video_decode_data and uvc_video_decode_end will be
354  * made until the next payload. -ENODATA can be used to drop the current
355  * payload if no other error code is appropriate.
356  *
357  * uvc_video_decode_data is called for every URB with URB data. It copies the
358  * data to the video buffer.
359  *
360  * uvc_video_decode_end is called with header data at the end of a bulk or
361  * isochronous payload. It performs any additional header data processing and
362  * returns 0 or a negative error code if an error occured. As header data have
363  * already been processed by uvc_video_decode_start, this functions isn't
364  * required to perform sanity checks a second time.
365  *
366  * For isochronous transfers where a payload is always transfered in a single
367  * URB, the three functions will be called in a row.
368  *
369  * To let the decoder process header data and update its internal state even
370  * when no video buffer is available, uvc_video_decode_start must be prepared
371  * to be called with a NULL buf parameter. uvc_video_decode_data and
372  * uvc_video_decode_end will never be called with a NULL buffer.
373  */
374 static int uvc_video_decode_start(struct uvc_streaming *stream,
375                 struct uvc_buffer *buf, const __u8 *data, int len)
376 {
377         __u8 fid;
378
379         /* Sanity checks:
380          * - packet must be at least 2 bytes long
381          * - bHeaderLength value must be at least 2 bytes (see above)
382          * - bHeaderLength value can't be larger than the packet size.
383          */
384         if (len < 2 || data[0] < 2 || data[0] > len)
385                 return -EINVAL;
386
387         /* Skip payloads marked with the error bit ("error frames"). */
388         if (data[1] & UVC_STREAM_ERR) {
389                 uvc_trace(UVC_TRACE_FRAME, "Dropping payload (error bit "
390                           "set).\n");
391                 return -ENODATA;
392         }
393
394         fid = data[1] & UVC_STREAM_FID;
395
396         /* Store the payload FID bit and return immediately when the buffer is
397          * NULL.
398          */
399         if (buf == NULL) {
400                 stream->last_fid = fid;
401                 return -ENODATA;
402         }
403
404         /* Synchronize to the input stream by waiting for the FID bit to be
405          * toggled when the the buffer state is not UVC_BUF_STATE_ACTIVE.
406          * stream->last_fid is initialized to -1, so the first isochronous
407          * frame will always be in sync.
408          *
409          * If the device doesn't toggle the FID bit, invert stream->last_fid
410          * when the EOF bit is set to force synchronisation on the next packet.
411          */
412         if (buf->state != UVC_BUF_STATE_ACTIVE) {
413                 struct timespec ts;
414
415                 if (fid == stream->last_fid) {
416                         uvc_trace(UVC_TRACE_FRAME, "Dropping payload (out of "
417                                 "sync).\n");
418                         if ((stream->dev->quirks & UVC_QUIRK_STREAM_NO_FID) &&
419                             (data[1] & UVC_STREAM_EOF))
420                                 stream->last_fid ^= UVC_STREAM_FID;
421                         return -ENODATA;
422                 }
423
424                 if (uvc_clock_param == CLOCK_MONOTONIC)
425                         ktime_get_ts(&ts);
426                 else
427                         ktime_get_real_ts(&ts);
428
429                 buf->buf.timestamp.tv_sec = ts.tv_sec;
430                 buf->buf.timestamp.tv_usec = ts.tv_nsec / NSEC_PER_USEC;
431
432                 /* TODO: Handle PTS and SCR. */
433                 buf->state = UVC_BUF_STATE_ACTIVE;
434         }
435
436         /* Mark the buffer as done if we're at the beginning of a new frame.
437          * End of frame detection is better implemented by checking the EOF
438          * bit (FID bit toggling is delayed by one frame compared to the EOF
439          * bit), but some devices don't set the bit at end of frame (and the
440          * last payload can be lost anyway). We thus must check if the FID has
441          * been toggled.
442          *
443          * stream->last_fid is initialized to -1, so the first isochronous
444          * frame will never trigger an end of frame detection.
445          *
446          * Empty buffers (bytesused == 0) don't trigger end of frame detection
447          * as it doesn't make sense to return an empty buffer. This also
448          * avoids detecting end of frame conditions at FID toggling if the
449          * previous payload had the EOF bit set.
450          */
451         if (fid != stream->last_fid && buf->buf.bytesused != 0) {
452                 uvc_trace(UVC_TRACE_FRAME, "Frame complete (FID bit "
453                                 "toggled).\n");
454                 buf->state = UVC_BUF_STATE_READY;
455                 return -EAGAIN;
456         }
457
458         stream->last_fid = fid;
459
460         return data[0];
461 }
462
463 static void uvc_video_decode_data(struct uvc_streaming *stream,
464                 struct uvc_buffer *buf, const __u8 *data, int len)
465 {
466         struct uvc_video_queue *queue = &stream->queue;
467         unsigned int maxlen, nbytes;
468         void *mem;
469
470         if (len <= 0)
471                 return;
472
473         /* Copy the video data to the buffer. */
474         maxlen = buf->buf.length - buf->buf.bytesused;
475         mem = queue->mem + buf->buf.m.offset + buf->buf.bytesused;
476         nbytes = min((unsigned int)len, maxlen);
477         memcpy(mem, data, nbytes);
478         buf->buf.bytesused += nbytes;
479
480         /* Complete the current frame if the buffer size was exceeded. */
481         if (len > maxlen) {
482                 uvc_trace(UVC_TRACE_FRAME, "Frame complete (overflow).\n");
483                 buf->state = UVC_BUF_STATE_READY;
484         }
485 }
486
487 static void uvc_video_decode_end(struct uvc_streaming *stream,
488                 struct uvc_buffer *buf, const __u8 *data, int len)
489 {
490         /* Mark the buffer as done if the EOF marker is set. */
491         if (data[1] & UVC_STREAM_EOF && buf->buf.bytesused != 0) {
492                 uvc_trace(UVC_TRACE_FRAME, "Frame complete (EOF found).\n");
493                 if (data[0] == len)
494                         uvc_trace(UVC_TRACE_FRAME, "EOF in empty payload.\n");
495                 buf->state = UVC_BUF_STATE_READY;
496                 if (stream->dev->quirks & UVC_QUIRK_STREAM_NO_FID)
497                         stream->last_fid ^= UVC_STREAM_FID;
498         }
499 }
500
501 /* Video payload encoding is handled by uvc_video_encode_header() and
502  * uvc_video_encode_data(). Only bulk transfers are currently supported.
503  *
504  * uvc_video_encode_header is called at the start of a payload. It adds header
505  * data to the transfer buffer and returns the header size. As the only known
506  * UVC output device transfers a whole frame in a single payload, the EOF bit
507  * is always set in the header.
508  *
509  * uvc_video_encode_data is called for every URB and copies the data from the
510  * video buffer to the transfer buffer.
511  */
512 static int uvc_video_encode_header(struct uvc_streaming *stream,
513                 struct uvc_buffer *buf, __u8 *data, int len)
514 {
515         data[0] = 2;    /* Header length */
516         data[1] = UVC_STREAM_EOH | UVC_STREAM_EOF
517                 | (stream->last_fid & UVC_STREAM_FID);
518         return 2;
519 }
520
521 static int uvc_video_encode_data(struct uvc_streaming *stream,
522                 struct uvc_buffer *buf, __u8 *data, int len)
523 {
524         struct uvc_video_queue *queue = &stream->queue;
525         unsigned int nbytes;
526         void *mem;
527
528         /* Copy video data to the URB buffer. */
529         mem = queue->mem + buf->buf.m.offset + queue->buf_used;
530         nbytes = min((unsigned int)len, buf->buf.bytesused - queue->buf_used);
531         nbytes = min(stream->bulk.max_payload_size - stream->bulk.payload_size,
532                         nbytes);
533         memcpy(data, mem, nbytes);
534
535         queue->buf_used += nbytes;
536
537         return nbytes;
538 }
539
540 /* ------------------------------------------------------------------------
541  * URB handling
542  */
543
544 /*
545  * Completion handler for video URBs.
546  */
547 static void uvc_video_decode_isoc(struct urb *urb, struct uvc_streaming *stream,
548         struct uvc_buffer *buf)
549 {
550         u8 *mem;
551         int ret, i;
552
553         for (i = 0; i < urb->number_of_packets; ++i) {
554                 if (urb->iso_frame_desc[i].status < 0) {
555                         uvc_trace(UVC_TRACE_FRAME, "USB isochronous frame "
556                                 "lost (%d).\n", urb->iso_frame_desc[i].status);
557                         continue;
558                 }
559
560                 /* Decode the payload header. */
561                 mem = urb->transfer_buffer + urb->iso_frame_desc[i].offset;
562                 do {
563                         ret = uvc_video_decode_start(stream, buf, mem,
564                                 urb->iso_frame_desc[i].actual_length);
565                         if (ret == -EAGAIN)
566                                 buf = uvc_queue_next_buffer(&stream->queue,
567                                                             buf);
568                 } while (ret == -EAGAIN);
569
570                 if (ret < 0)
571                         continue;
572
573                 /* Decode the payload data. */
574                 uvc_video_decode_data(stream, buf, mem + ret,
575                         urb->iso_frame_desc[i].actual_length - ret);
576
577                 /* Process the header again. */
578                 uvc_video_decode_end(stream, buf, mem,
579                         urb->iso_frame_desc[i].actual_length);
580
581                 if (buf->state == UVC_BUF_STATE_READY)
582                         buf = uvc_queue_next_buffer(&stream->queue, buf);
583         }
584 }
585
586 static void uvc_video_decode_bulk(struct urb *urb, struct uvc_streaming *stream,
587         struct uvc_buffer *buf)
588 {
589         u8 *mem;
590         int len, ret;
591
592         if (urb->actual_length == 0)
593                 return;
594
595         mem = urb->transfer_buffer;
596         len = urb->actual_length;
597         stream->bulk.payload_size += len;
598
599         /* If the URB is the first of its payload, decode and save the
600          * header.
601          */
602         if (stream->bulk.header_size == 0 && !stream->bulk.skip_payload) {
603                 do {
604                         ret = uvc_video_decode_start(stream, buf, mem, len);
605                         if (ret == -EAGAIN)
606                                 buf = uvc_queue_next_buffer(&stream->queue,
607                                                             buf);
608                 } while (ret == -EAGAIN);
609
610                 /* If an error occured skip the rest of the payload. */
611                 if (ret < 0 || buf == NULL) {
612                         stream->bulk.skip_payload = 1;
613                 } else {
614                         memcpy(stream->bulk.header, mem, ret);
615                         stream->bulk.header_size = ret;
616
617                         mem += ret;
618                         len -= ret;
619                 }
620         }
621
622         /* The buffer queue might have been cancelled while a bulk transfer
623          * was in progress, so we can reach here with buf equal to NULL. Make
624          * sure buf is never dereferenced if NULL.
625          */
626
627         /* Process video data. */
628         if (!stream->bulk.skip_payload && buf != NULL)
629                 uvc_video_decode_data(stream, buf, mem, len);
630
631         /* Detect the payload end by a URB smaller than the maximum size (or
632          * a payload size equal to the maximum) and process the header again.
633          */
634         if (urb->actual_length < urb->transfer_buffer_length ||
635             stream->bulk.payload_size >= stream->bulk.max_payload_size) {
636                 if (!stream->bulk.skip_payload && buf != NULL) {
637                         uvc_video_decode_end(stream, buf, stream->bulk.header,
638                                 stream->bulk.payload_size);
639                         if (buf->state == UVC_BUF_STATE_READY)
640                                 buf = uvc_queue_next_buffer(&stream->queue,
641                                                             buf);
642                 }
643
644                 stream->bulk.header_size = 0;
645                 stream->bulk.skip_payload = 0;
646                 stream->bulk.payload_size = 0;
647         }
648 }
649
650 static void uvc_video_encode_bulk(struct urb *urb, struct uvc_streaming *stream,
651         struct uvc_buffer *buf)
652 {
653         u8 *mem = urb->transfer_buffer;
654         int len = stream->urb_size, ret;
655
656         if (buf == NULL) {
657                 urb->transfer_buffer_length = 0;
658                 return;
659         }
660
661         /* If the URB is the first of its payload, add the header. */
662         if (stream->bulk.header_size == 0) {
663                 ret = uvc_video_encode_header(stream, buf, mem, len);
664                 stream->bulk.header_size = ret;
665                 stream->bulk.payload_size += ret;
666                 mem += ret;
667                 len -= ret;
668         }
669
670         /* Process video data. */
671         ret = uvc_video_encode_data(stream, buf, mem, len);
672
673         stream->bulk.payload_size += ret;
674         len -= ret;
675
676         if (buf->buf.bytesused == stream->queue.buf_used ||
677             stream->bulk.payload_size == stream->bulk.max_payload_size) {
678                 if (buf->buf.bytesused == stream->queue.buf_used) {
679                         stream->queue.buf_used = 0;
680                         buf->state = UVC_BUF_STATE_READY;
681                         uvc_queue_next_buffer(&stream->queue, buf);
682                         stream->last_fid ^= UVC_STREAM_FID;
683                 }
684
685                 stream->bulk.header_size = 0;
686                 stream->bulk.payload_size = 0;
687         }
688
689         urb->transfer_buffer_length = stream->urb_size - len;
690 }
691
692 static void uvc_video_complete(struct urb *urb)
693 {
694         struct uvc_streaming *stream = urb->context;
695         struct uvc_video_queue *queue = &stream->queue;
696         struct uvc_buffer *buf = NULL;
697         unsigned long flags;
698         int ret;
699
700         switch (urb->status) {
701         case 0:
702                 break;
703
704         default:
705                 uvc_printk(KERN_WARNING, "Non-zero status (%d) in video "
706                         "completion handler.\n", urb->status);
707
708         case -ENOENT:           /* usb_kill_urb() called. */
709                 if (stream->frozen)
710                         return;
711
712         case -ECONNRESET:       /* usb_unlink_urb() called. */
713         case -ESHUTDOWN:        /* The endpoint is being disabled. */
714                 uvc_queue_cancel(queue, urb->status == -ESHUTDOWN);
715                 return;
716         }
717
718         spin_lock_irqsave(&queue->irqlock, flags);
719         if (!list_empty(&queue->irqqueue))
720                 buf = list_first_entry(&queue->irqqueue, struct uvc_buffer,
721                                        queue);
722         spin_unlock_irqrestore(&queue->irqlock, flags);
723
724         stream->decode(urb, stream, buf);
725
726         if ((ret = usb_submit_urb(urb, GFP_ATOMIC)) < 0) {
727                 uvc_printk(KERN_ERR, "Failed to resubmit video URB (%d).\n",
728                         ret);
729         }
730 }
731
732 /*
733  * Free transfer buffers.
734  */
735 static void uvc_free_urb_buffers(struct uvc_streaming *stream)
736 {
737         unsigned int i;
738
739         for (i = 0; i < UVC_URBS; ++i) {
740                 if (stream->urb_buffer[i]) {
741                         usb_buffer_free(stream->dev->udev, stream->urb_size,
742                                 stream->urb_buffer[i], stream->urb_dma[i]);
743                         stream->urb_buffer[i] = NULL;
744                 }
745         }
746
747         stream->urb_size = 0;
748 }
749
750 /*
751  * Allocate transfer buffers. This function can be called with buffers
752  * already allocated when resuming from suspend, in which case it will
753  * return without touching the buffers.
754  *
755  * Limit the buffer size to UVC_MAX_PACKETS bulk/isochronous packets. If the
756  * system is too low on memory try successively smaller numbers of packets
757  * until allocation succeeds.
758  *
759  * Return the number of allocated packets on success or 0 when out of memory.
760  */
761 static int uvc_alloc_urb_buffers(struct uvc_streaming *stream,
762         unsigned int size, unsigned int psize, gfp_t gfp_flags)
763 {
764         unsigned int npackets;
765         unsigned int i;
766
767         /* Buffers are already allocated, bail out. */
768         if (stream->urb_size)
769                 return stream->urb_size / psize;
770
771         /* Compute the number of packets. Bulk endpoints might transfer UVC
772          * payloads accross multiple URBs.
773          */
774         npackets = DIV_ROUND_UP(size, psize);
775         if (npackets > UVC_MAX_PACKETS)
776                 npackets = UVC_MAX_PACKETS;
777
778         /* Retry allocations until one succeed. */
779         for (; npackets > 1; npackets /= 2) {
780                 for (i = 0; i < UVC_URBS; ++i) {
781                         stream->urb_size = psize * npackets;
782                         stream->urb_buffer[i] = usb_buffer_alloc(
783                                 stream->dev->udev, stream->urb_size,
784                                 gfp_flags | __GFP_NOWARN, &stream->urb_dma[i]);
785                         if (!stream->urb_buffer[i]) {
786                                 uvc_free_urb_buffers(stream);
787                                 break;
788                         }
789                 }
790
791                 if (i == UVC_URBS) {
792                         uvc_trace(UVC_TRACE_VIDEO, "Allocated %u URB buffers "
793                                 "of %ux%u bytes each.\n", UVC_URBS, npackets,
794                                 psize);
795                         return npackets;
796                 }
797         }
798
799         uvc_trace(UVC_TRACE_VIDEO, "Failed to allocate URB buffers (%u bytes "
800                 "per packet).\n", psize);
801         return 0;
802 }
803
804 /*
805  * Uninitialize isochronous/bulk URBs and free transfer buffers.
806  */
807 static void uvc_uninit_video(struct uvc_streaming *stream, int free_buffers)
808 {
809         struct urb *urb;
810         unsigned int i;
811
812         for (i = 0; i < UVC_URBS; ++i) {
813                 urb = stream->urb[i];
814                 if (urb == NULL)
815                         continue;
816
817                 usb_kill_urb(urb);
818                 usb_free_urb(urb);
819                 stream->urb[i] = NULL;
820         }
821
822         if (free_buffers)
823                 uvc_free_urb_buffers(stream);
824 }
825
826 /*
827  * Initialize isochronous URBs and allocate transfer buffers. The packet size
828  * is given by the endpoint.
829  */
830 static int uvc_init_video_isoc(struct uvc_streaming *stream,
831         struct usb_host_endpoint *ep, gfp_t gfp_flags)
832 {
833         struct urb *urb;
834         unsigned int npackets, i, j;
835         u16 psize;
836         u32 size;
837
838         psize = le16_to_cpu(ep->desc.wMaxPacketSize);
839         psize = (psize & 0x07ff) * (1 + ((psize >> 11) & 3));
840         size = stream->ctrl.dwMaxVideoFrameSize;
841
842         npackets = uvc_alloc_urb_buffers(stream, size, psize, gfp_flags);
843         if (npackets == 0)
844                 return -ENOMEM;
845
846         size = npackets * psize;
847
848         for (i = 0; i < UVC_URBS; ++i) {
849                 urb = usb_alloc_urb(npackets, gfp_flags);
850                 if (urb == NULL) {
851                         uvc_uninit_video(stream, 1);
852                         return -ENOMEM;
853                 }
854
855                 urb->dev = stream->dev->udev;
856                 urb->context = stream;
857                 urb->pipe = usb_rcvisocpipe(stream->dev->udev,
858                                 ep->desc.bEndpointAddress);
859                 urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
860                 urb->interval = ep->desc.bInterval;
861                 urb->transfer_buffer = stream->urb_buffer[i];
862                 urb->transfer_dma = stream->urb_dma[i];
863                 urb->complete = uvc_video_complete;
864                 urb->number_of_packets = npackets;
865                 urb->transfer_buffer_length = size;
866
867                 for (j = 0; j < npackets; ++j) {
868                         urb->iso_frame_desc[j].offset = j * psize;
869                         urb->iso_frame_desc[j].length = psize;
870                 }
871
872                 stream->urb[i] = urb;
873         }
874
875         return 0;
876 }
877
878 /*
879  * Initialize bulk URBs and allocate transfer buffers. The packet size is
880  * given by the endpoint.
881  */
882 static int uvc_init_video_bulk(struct uvc_streaming *stream,
883         struct usb_host_endpoint *ep, gfp_t gfp_flags)
884 {
885         struct urb *urb;
886         unsigned int npackets, pipe, i;
887         u16 psize;
888         u32 size;
889
890         psize = le16_to_cpu(ep->desc.wMaxPacketSize) & 0x07ff;
891         size = stream->ctrl.dwMaxPayloadTransferSize;
892         stream->bulk.max_payload_size = size;
893
894         npackets = uvc_alloc_urb_buffers(stream, size, psize, gfp_flags);
895         if (npackets == 0)
896                 return -ENOMEM;
897
898         size = npackets * psize;
899
900         if (usb_endpoint_dir_in(&ep->desc))
901                 pipe = usb_rcvbulkpipe(stream->dev->udev,
902                                        ep->desc.bEndpointAddress);
903         else
904                 pipe = usb_sndbulkpipe(stream->dev->udev,
905                                        ep->desc.bEndpointAddress);
906
907         if (stream->type == V4L2_BUF_TYPE_VIDEO_OUTPUT)
908                 size = 0;
909
910         for (i = 0; i < UVC_URBS; ++i) {
911                 urb = usb_alloc_urb(0, gfp_flags);
912                 if (urb == NULL) {
913                         uvc_uninit_video(stream, 1);
914                         return -ENOMEM;
915                 }
916
917                 usb_fill_bulk_urb(urb, stream->dev->udev, pipe,
918                         stream->urb_buffer[i], size, uvc_video_complete,
919                         stream);
920                 urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
921                 urb->transfer_dma = stream->urb_dma[i];
922
923                 stream->urb[i] = urb;
924         }
925
926         return 0;
927 }
928
929 /*
930  * Initialize isochronous/bulk URBs and allocate transfer buffers.
931  */
932 static int uvc_init_video(struct uvc_streaming *stream, gfp_t gfp_flags)
933 {
934         struct usb_interface *intf = stream->intf;
935         struct usb_host_endpoint *ep;
936         unsigned int i;
937         int ret;
938
939         stream->last_fid = -1;
940         stream->bulk.header_size = 0;
941         stream->bulk.skip_payload = 0;
942         stream->bulk.payload_size = 0;
943
944         if (intf->num_altsetting > 1) {
945                 struct usb_host_endpoint *best_ep = NULL;
946                 unsigned int best_psize = 3 * 1024;
947                 unsigned int bandwidth;
948                 unsigned int uninitialized_var(altsetting);
949                 int intfnum = stream->intfnum;
950
951                 /* Isochronous endpoint, select the alternate setting. */
952                 bandwidth = stream->ctrl.dwMaxPayloadTransferSize;
953
954                 if (bandwidth == 0) {
955                         uvc_trace(UVC_TRACE_VIDEO, "Device requested null "
956                                 "bandwidth, defaulting to lowest.\n");
957                         bandwidth = 1;
958                 } else {
959                         uvc_trace(UVC_TRACE_VIDEO, "Device requested %u "
960                                 "B/frame bandwidth.\n", bandwidth);
961                 }
962
963                 for (i = 0; i < intf->num_altsetting; ++i) {
964                         struct usb_host_interface *alts;
965                         unsigned int psize;
966
967                         alts = &intf->altsetting[i];
968                         ep = uvc_find_endpoint(alts,
969                                 stream->header.bEndpointAddress);
970                         if (ep == NULL)
971                                 continue;
972
973                         /* Check if the bandwidth is high enough. */
974                         psize = le16_to_cpu(ep->desc.wMaxPacketSize);
975                         psize = (psize & 0x07ff) * (1 + ((psize >> 11) & 3));
976                         if (psize >= bandwidth && psize <= best_psize) {
977                                 altsetting = i;
978                                 best_psize = psize;
979                                 best_ep = ep;
980                         }
981                 }
982
983                 if (best_ep == NULL) {
984                         uvc_trace(UVC_TRACE_VIDEO, "No fast enough alt setting "
985                                 "for requested bandwidth.\n");
986                         return -EIO;
987                 }
988
989                 uvc_trace(UVC_TRACE_VIDEO, "Selecting alternate setting %u "
990                         "(%u B/frame bandwidth).\n", altsetting, best_psize);
991
992                 ret = usb_set_interface(stream->dev->udev, intfnum, altsetting);
993                 if (ret < 0)
994                         return ret;
995
996                 ret = uvc_init_video_isoc(stream, best_ep, gfp_flags);
997         } else {
998                 /* Bulk endpoint, proceed to URB initialization. */
999                 ep = uvc_find_endpoint(&intf->altsetting[0],
1000                                 stream->header.bEndpointAddress);
1001                 if (ep == NULL)
1002                         return -EIO;
1003
1004                 ret = uvc_init_video_bulk(stream, ep, gfp_flags);
1005         }
1006
1007         if (ret < 0)
1008                 return ret;
1009
1010         /* Submit the URBs. */
1011         for (i = 0; i < UVC_URBS; ++i) {
1012                 ret = usb_submit_urb(stream->urb[i], gfp_flags);
1013                 if (ret < 0) {
1014                         uvc_printk(KERN_ERR, "Failed to submit URB %u "
1015                                         "(%d).\n", i, ret);
1016                         uvc_uninit_video(stream, 1);
1017                         return ret;
1018                 }
1019         }
1020
1021         return 0;
1022 }
1023
1024 /* --------------------------------------------------------------------------
1025  * Suspend/resume
1026  */
1027
1028 /*
1029  * Stop streaming without disabling the video queue.
1030  *
1031  * To let userspace applications resume without trouble, we must not touch the
1032  * video buffers in any way. We mark the device as frozen to make sure the URB
1033  * completion handler won't try to cancel the queue when we kill the URBs.
1034  */
1035 int uvc_video_suspend(struct uvc_streaming *stream)
1036 {
1037         if (!uvc_queue_streaming(&stream->queue))
1038                 return 0;
1039
1040         stream->frozen = 1;
1041         uvc_uninit_video(stream, 0);
1042         usb_set_interface(stream->dev->udev, stream->intfnum, 0);
1043         return 0;
1044 }
1045
1046 /*
1047  * Reconfigure the video interface and restart streaming if it was enabled
1048  * before suspend.
1049  *
1050  * If an error occurs, disable the video queue. This will wake all pending
1051  * buffers, making sure userspace applications are notified of the problem
1052  * instead of waiting forever.
1053  */
1054 int uvc_video_resume(struct uvc_streaming *stream)
1055 {
1056         int ret;
1057
1058         stream->frozen = 0;
1059
1060         ret = uvc_commit_video(stream, &stream->ctrl);
1061         if (ret < 0) {
1062                 uvc_queue_enable(&stream->queue, 0);
1063                 return ret;
1064         }
1065
1066         if (!uvc_queue_streaming(&stream->queue))
1067                 return 0;
1068
1069         ret = uvc_init_video(stream, GFP_NOIO);
1070         if (ret < 0)
1071                 uvc_queue_enable(&stream->queue, 0);
1072
1073         return ret;
1074 }
1075
1076 /* ------------------------------------------------------------------------
1077  * Video device
1078  */
1079
1080 /*
1081  * Initialize the UVC video device by switching to alternate setting 0 and
1082  * retrieve the default format.
1083  *
1084  * Some cameras (namely the Fuji Finepix) set the format and frame
1085  * indexes to zero. The UVC standard doesn't clearly make this a spec
1086  * violation, so try to silently fix the values if possible.
1087  *
1088  * This function is called before registering the device with V4L.
1089  */
1090 int uvc_video_init(struct uvc_streaming *stream)
1091 {
1092         struct uvc_streaming_control *probe = &stream->ctrl;
1093         struct uvc_format *format = NULL;
1094         struct uvc_frame *frame = NULL;
1095         unsigned int i;
1096         int ret;
1097
1098         if (stream->nformats == 0) {
1099                 uvc_printk(KERN_INFO, "No supported video formats found.\n");
1100                 return -EINVAL;
1101         }
1102
1103         atomic_set(&stream->active, 0);
1104
1105         /* Initialize the video buffers queue. */
1106         uvc_queue_init(&stream->queue, stream->type);
1107
1108         /* Alternate setting 0 should be the default, yet the XBox Live Vision
1109          * Cam (and possibly other devices) crash or otherwise misbehave if
1110          * they don't receive a SET_INTERFACE request before any other video
1111          * control request.
1112          */
1113         usb_set_interface(stream->dev->udev, stream->intfnum, 0);
1114
1115         /* Set the streaming probe control with default streaming parameters
1116          * retrieved from the device. Webcams that don't suport GET_DEF
1117          * requests on the probe control will just keep their current streaming
1118          * parameters.
1119          */
1120         if (uvc_get_video_ctrl(stream, probe, 1, UVC_GET_DEF) == 0)
1121                 uvc_set_video_ctrl(stream, probe, 1);
1122
1123         /* Initialize the streaming parameters with the probe control current
1124          * value. This makes sure SET_CUR requests on the streaming commit
1125          * control will always use values retrieved from a successful GET_CUR
1126          * request on the probe control, as required by the UVC specification.
1127          */
1128         ret = uvc_get_video_ctrl(stream, probe, 1, UVC_GET_CUR);
1129         if (ret < 0)
1130                 return ret;
1131
1132         /* Check if the default format descriptor exists. Use the first
1133          * available format otherwise.
1134          */
1135         for (i = stream->nformats; i > 0; --i) {
1136                 format = &stream->format[i-1];
1137                 if (format->index == probe->bFormatIndex)
1138                         break;
1139         }
1140
1141         if (format->nframes == 0) {
1142                 uvc_printk(KERN_INFO, "No frame descriptor found for the "
1143                         "default format.\n");
1144                 return -EINVAL;
1145         }
1146
1147         /* Zero bFrameIndex might be correct. Stream-based formats (including
1148          * MPEG-2 TS and DV) do not support frames but have a dummy frame
1149          * descriptor with bFrameIndex set to zero. If the default frame
1150          * descriptor is not found, use the first available frame.
1151          */
1152         for (i = format->nframes; i > 0; --i) {
1153                 frame = &format->frame[i-1];
1154                 if (frame->bFrameIndex == probe->bFrameIndex)
1155                         break;
1156         }
1157
1158         probe->bFormatIndex = format->index;
1159         probe->bFrameIndex = frame->bFrameIndex;
1160
1161         stream->cur_format = format;
1162         stream->cur_frame = frame;
1163
1164         /* Select the video decoding function */
1165         if (stream->type == V4L2_BUF_TYPE_VIDEO_CAPTURE) {
1166                 if (stream->dev->quirks & UVC_QUIRK_BUILTIN_ISIGHT)
1167                         stream->decode = uvc_video_decode_isight;
1168                 else if (stream->intf->num_altsetting > 1)
1169                         stream->decode = uvc_video_decode_isoc;
1170                 else
1171                         stream->decode = uvc_video_decode_bulk;
1172         } else {
1173                 if (stream->intf->num_altsetting == 1)
1174                         stream->decode = uvc_video_encode_bulk;
1175                 else {
1176                         uvc_printk(KERN_INFO, "Isochronous endpoints are not "
1177                                 "supported for video output devices.\n");
1178                         return -EINVAL;
1179                 }
1180         }
1181
1182         return 0;
1183 }
1184
1185 /*
1186  * Enable or disable the video stream.
1187  */
1188 int uvc_video_enable(struct uvc_streaming *stream, int enable)
1189 {
1190         int ret;
1191
1192         if (!enable) {
1193                 uvc_uninit_video(stream, 1);
1194                 usb_set_interface(stream->dev->udev, stream->intfnum, 0);
1195                 uvc_queue_enable(&stream->queue, 0);
1196                 return 0;
1197         }
1198
1199         if ((stream->cur_format->flags & UVC_FMT_FLAG_COMPRESSED) ||
1200             uvc_no_drop_param)
1201                 stream->queue.flags &= ~UVC_QUEUE_DROP_INCOMPLETE;
1202         else
1203                 stream->queue.flags |= UVC_QUEUE_DROP_INCOMPLETE;
1204
1205         ret = uvc_queue_enable(&stream->queue, 1);
1206         if (ret < 0)
1207                 return ret;
1208
1209         /* Commit the streaming parameters. */
1210         ret = uvc_commit_video(stream, &stream->ctrl);
1211         if (ret < 0)
1212                 return ret;
1213
1214         return uvc_init_video(stream, GFP_KERNEL);
1215 }
1216