drivers/usb/gadget/function/uvc_video.c

   1 /*
   2  *      uvc_video.c  --  USB Video Class Gadget driver
   3  *
   4  *      Copyright (C) 2009-2010
   5  *          Laurent Pinchart (laurent.pinchart@ideasonboard.com)
   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 #include <linux/kernel.h>
  14 #include <linux/device.h>
  15 #include <linux/errno.h>
  16 #include <linux/usb/ch9.h>
  17 #include <linux/usb/gadget.h>
  18
  19 #include <media/v4l2-dev.h>
  20
  21 #include "uvc.h"
  22 #include "uvc_queue.h"
  23
  24 /* --------------------------------------------------------------------------
  25  * Video codecs
  26  */
  27
  28 static int
  29 uvc_video_encode_header(struct uvc_video *video, struct uvc_buffer *buf,
  30                 u8 *data, int len)
  31 {
  32         data[0] = 2;
  33         data[1] = UVC_STREAM_EOH | video->fid;
  34
  35         if (buf->bytesused - video->queue.buf_used <= len - 2)
  36                 data[1] |= UVC_STREAM_EOF;
  37
  38         return 2;
  39 }
  40
  41 static int
  42 uvc_video_encode_data(struct uvc_video *video, struct uvc_buffer *buf,
  43                 u8 *data, int len)
  44 {
  45         struct uvc_video_queue *queue = &video->queue;
  46         unsigned int nbytes;
  47         void *mem;
  48
  49         /* Copy video data to the USB buffer. */
  50         mem = buf->mem + queue->buf_used;
  51         nbytes = min((unsigned int)len, buf->bytesused - queue->buf_used);
  52
  53         memcpy(data, mem, nbytes);
  54         queue->buf_used += nbytes;
  55
  56         return nbytes;
  57 }
  58
  59 static void
  60 uvc_video_encode_bulk(struct usb_request *req, struct uvc_video *video,
  61                 struct uvc_buffer *buf)
  62 {
  63         void *mem = req->buf;
  64         int len = video->req_size;
  65         int ret;
  66
  67         /* Add a header at the beginning of the payload. */
  68         if (video->payload_size == 0) {
  69                 ret = uvc_video_encode_header(video, buf, mem, len);
  70                 video->payload_size += ret;
  71                 mem += ret;
  72                 len -= ret;
  73         }
  74
  75         /* Process video data. */
  76         len = min((int)(video->max_payload_size - video->payload_size), len);
  77         ret = uvc_video_encode_data(video, buf, mem, len);
  78
  79         video->payload_size += ret;
  80         len -= ret;
  81
  82         req->length = video->req_size - len;
  83         req->zero = video->payload_size == video->max_payload_size;
  84
  85         if (buf->bytesused == video->queue.buf_used) {
  86                 video->queue.buf_used = 0;
  87                 buf->state = UVC_BUF_STATE_DONE;
  88                 uvc_queue_next_buffer(&video->queue, buf);
  89                 video->fid ^= UVC_STREAM_FID;
  90
  91                 video->payload_size = 0;
  92         }
  93
  94         if (video->payload_size == video->max_payload_size ||
  95             buf->bytesused == video->queue.buf_used)
  96                 video->payload_size = 0;
  97 }
  98
  99 static void
 100 uvc_video_encode_isoc(struct usb_request *req, struct uvc_video *video,
 101                 struct uvc_buffer *buf)
 102 {
 103         void *mem = req->buf;
 104         int len = video->req_size;
 105         int ret;
 106
 107         /* Add the header. */
 108         ret = uvc_video_encode_header(video, buf, mem, len);
 109         mem += ret;
 110         len -= ret;
 111
 112         /* Process video data. */
 113         ret = uvc_video_encode_data(video, buf, mem, len);
 114         len -= ret;
 115
 116         req->length = video->req_size - len;
 117
 118         if (buf->bytesused == video->queue.buf_used) {
 119                 video->queue.buf_used = 0;
 120                 buf->state = UVC_BUF_STATE_DONE;
 121                 uvc_queue_next_buffer(&video->queue, buf);
 122                 video->fid ^= UVC_STREAM_FID;
 123         }
 124 }
 125
 126 /* --------------------------------------------------------------------------
 127  * Request handling
 128  */
 129
 130 /*
 131  * I somehow feel that synchronisation won't be easy to achieve here. We have
 132  * three events that control USB requests submission:
 133  *
 134  * - USB request completion: the completion handler will resubmit the request
 135  *   if a video buffer is available.
 136  *
 137  * - USB interface setting selection: in response to a SET_INTERFACE request,
 138  *   the handler will start streaming if a video buffer is available and if
 139  *   video is not currently streaming.
 140  *
 141  * - V4L2 buffer queueing: the driver will start streaming if video is not
 142  *   currently streaming.
 143  *
 144  * Race conditions between those 3 events might lead to deadlocks or other
 145  * nasty side effects.
 146  *
 147  * The "video currently streaming" condition can't be detected by the irqqueue
 148  * being empty, as a request can still be in flight. A separate "queue paused"
 149  * flag is thus needed.
 150  *
 151  * The paused flag will be set when we try to retrieve the irqqueue head if the
 152  * queue is empty, and cleared when we queue a buffer.
 153  *
 154  * The USB request completion handler will get the buffer at the irqqueue head
 155  * under protection of the queue spinlock. If the queue is empty, the streaming
 156  * paused flag will be set. Right after releasing the spinlock a userspace
 157  * application can queue a buffer. The flag will then cleared, and the ioctl
 158  * handler will restart the video stream.
 159  */
 160 static void
 161 uvc_video_complete(struct usb_ep *ep, struct usb_request *req)
 162 {
 163         struct uvc_video *video = req->context;
 164         struct uvc_video_queue *queue = &video->queue;
 165         struct uvc_buffer *buf;
 166         unsigned long flags;
 167         int ret;
 168
 169         switch (req->status) {
 170         case 0:
 171                 break;
 172
 173         case -ESHUTDOWN:        /* disconnect from host. */
 174                 printk(KERN_DEBUG "VS request cancelled.\n");
 175                 uvc_queue_cancel(queue, 1);
 176                 goto requeue;
 177
 178         default:
 179                 printk(KERN_INFO "VS request completed with status %d.\n",
 180                         req->status);
 181                 uvc_queue_cancel(queue, 0);
 182                 goto requeue;
 183         }
 184
 185         spin_lock_irqsave(&video->queue.irqlock, flags);
 186         buf = uvc_queue_head(&video->queue);
 187         if (buf == NULL) {
 188                 spin_unlock_irqrestore(&video->queue.irqlock, flags);
 189                 goto requeue;
 190         }
 191
 192         video->encode(req, video, buf);
 193
 194         if ((ret = usb_ep_queue(ep, req, GFP_ATOMIC)) < 0) {
 195                 printk(KERN_INFO "Failed to queue request (%d).\n", ret);
 196                 usb_ep_set_halt(ep);
 197                 spin_unlock_irqrestore(&video->queue.irqlock, flags);
 198                 uvc_queue_cancel(queue, 0);
 199                 goto requeue;
 200         }
 201         spin_unlock_irqrestore(&video->queue.irqlock, flags);
 202
 203         return;
 204
 205 requeue:
 206         spin_lock_irqsave(&video->req_lock, flags);
 207         list_add_tail(&req->list, &video->req_free);
 208         spin_unlock_irqrestore(&video->req_lock, flags);
 209 }
 210
 211 static int
 212 uvc_video_free_requests(struct uvc_video *video)
 213 {
 214         unsigned int i;
 215
 216         for (i = 0; i < UVC_NUM_REQUESTS; ++i) {
 217                 if (video->req[i]) {
 218                         usb_ep_free_request(video->ep, video->req[i]);
 219                         video->req[i] = NULL;
 220                 }
 221
 222                 if (video->req_buffer[i]) {
 223                         kfree(video->req_buffer[i]);
 224                         video->req_buffer[i] = NULL;
 225                 }
 226         }
 227
 228         INIT_LIST_HEAD(&video->req_free);
 229         video->req_size = 0;
 230         return 0;
 231 }
 232
 233 static int
 234 uvc_video_alloc_requests(struct uvc_video *video)
 235 {
 236         unsigned int req_size;
 237         unsigned int i;
 238         int ret = -ENOMEM;
 239
 240         BUG_ON(video->req_size);
 241
 242         req_size = video->ep->maxpacket
 243                  * max_t(unsigned int, video->ep->maxburst, 1)
 244                  * (video->ep->mult + 1);
 245
 246         for (i = 0; i < UVC_NUM_REQUESTS; ++i) {
 247                 video->req_buffer[i] = kmalloc(req_size, GFP_KERNEL);
 248                 if (video->req_buffer[i] == NULL)
 249                         goto error;
 250
 251                 video->req[i] = usb_ep_alloc_request(video->ep, GFP_KERNEL);
 252                 if (video->req[i] == NULL)
 253                         goto error;
 254
 255                 video->req[i]->buf = video->req_buffer[i];
 256                 video->req[i]->length = 0;
 257                 video->req[i]->complete = uvc_video_complete;
 258                 video->req[i]->context = video;
 259
 260                 list_add_tail(&video->req[i]->list, &video->req_free);
 261         }
 262
 263         video->req_size = req_size;
 264
 265         return 0;
 266
 267 error:
 268         uvc_video_free_requests(video);
 269         return ret;
 270 }
 271
 272 /* --------------------------------------------------------------------------
 273  * Video streaming
 274  */
 275
 276 /*
 277  * uvc_video_pump - Pump video data into the USB requests
 278  *
 279  * This function fills the available USB requests (listed in req_free) with
 280  * video data from the queued buffers.
 281  */
 282 static int
 283 uvc_video_pump(struct uvc_video *video)
 284 {
 285         struct uvc_video_queue *queue = &video->queue;
 286         struct usb_request *req;
 287         struct uvc_buffer *buf;
 288         unsigned long flags;
 289         int ret;
 290
 291         /* FIXME TODO Race between uvc_video_pump and requests completion
 292          * handler ???
 293          */
 294
 295         while (1) {
 296                 /* Retrieve the first available USB request, protected by the
 297                  * request lock.
 298                  */
 299                 spin_lock_irqsave(&video->req_lock, flags);
 300                 if (list_empty(&video->req_free)) {
 301                         spin_unlock_irqrestore(&video->req_lock, flags);
 302                         return 0;
 303                 }
 304                 req = list_first_entry(&video->req_free, struct usb_request,
 305                                         list);
 306                 list_del(&req->list);
 307                 spin_unlock_irqrestore(&video->req_lock, flags);
 308
 309                 /* Retrieve the first available video buffer and fill the
 310                  * request, protected by the video queue irqlock.
 311                  */
 312                 spin_lock_irqsave(&video->queue.irqlock, flags);
 313                 buf = uvc_queue_head(&video->queue);
 314                 if (buf == NULL) {
 315                         spin_unlock_irqrestore(&video->queue.irqlock, flags);
 316                         break;
 317                 }
 318
 319                 video->encode(req, video, buf);
 320
 321                 /* Queue the USB request */
 322                 ret = usb_ep_queue(video->ep, req, GFP_ATOMIC);
 323                 if (ret < 0) {
 324                         printk(KERN_INFO "Failed to queue request (%d)\n", ret);
 325                         usb_ep_set_halt(video->ep);
 326                         spin_unlock_irqrestore(&video->queue.irqlock, flags);
 327                         uvc_queue_cancel(queue, 0);
 328                         break;
 329                 }
 330                 spin_unlock_irqrestore(&video->queue.irqlock, flags);
 331         }
 332
 333         spin_lock_irqsave(&video->req_lock, flags);
 334         list_add_tail(&req->list, &video->req_free);
 335         spin_unlock_irqrestore(&video->req_lock, flags);
 336         return 0;
 337 }
 338
 339 /*
 340  * Enable or disable the video stream.
 341  */
 342 static int
 343 uvc_video_enable(struct uvc_video *video, int enable)
 344 {
 345         unsigned int i;
 346         int ret;
 347
 348         if (video->ep == NULL) {
 349                 printk(KERN_INFO "Video enable failed, device is "
 350                         "uninitialized.\n");
 351                 return -ENODEV;
 352         }
 353
 354         if (!enable) {
 355                 for (i = 0; i < UVC_NUM_REQUESTS; ++i)
 356                         usb_ep_dequeue(video->ep, video->req[i]);
 357
 358                 uvc_video_free_requests(video);
 359                 uvc_queue_enable(&video->queue, 0);
 360                 return 0;
 361         }
 362
 363         if ((ret = uvc_queue_enable(&video->queue, 1)) < 0)
 364                 return ret;
 365
 366         if ((ret = uvc_video_alloc_requests(video)) < 0)
 367                 return ret;
 368
 369         if (video->max_payload_size) {
 370                 video->encode = uvc_video_encode_bulk;
 371                 video->payload_size = 0;
 372         } else
 373                 video->encode = uvc_video_encode_isoc;
 374
 375         return uvc_video_pump(video);
 376 }
 377
 378 /*
 379  * Initialize the UVC video stream.
 380  */
 381 static int
 382 uvc_video_init(struct uvc_video *video)
 383 {
 384         INIT_LIST_HEAD(&video->req_free);
 385         spin_lock_init(&video->req_lock);
 386
 387         video->fcc = V4L2_PIX_FMT_YUYV;
 388         video->bpp = 16;
 389         video->width = 320;
 390         video->height = 240;
 391         video->imagesize = 320 * 240 * 2;
 392
 393         /* Initialize the video buffers queue. */
 394         uvc_queue_init(&video->queue, V4L2_BUF_TYPE_VIDEO_OUTPUT);
 395         return 0;
 396 }
 397