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