drivers/media/usb/uvc/uvc_queue.c

   1 /*
   2  *      uvc_queue.c  --  USB Video Class driver - Buffers management
   3  *
   4  *      Copyright (C) 2005-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
  14 #include <linux/atomic.h>
  15 #include <linux/kernel.h>
  16 #include <linux/mm.h>
  17 #include <linux/list.h>
  18 #include <linux/module.h>
  19 #include <linux/usb.h>
  20 #include <linux/videodev2.h>
  21 #include <linux/vmalloc.h>
  22 #include <linux/wait.h>
  23 #include <media/videobuf2-vmalloc.h>
  24
  25 #include "uvcvideo.h"
  26
  27 /* ------------------------------------------------------------------------
  28  * Video buffers queue management.
  29  *
  30  * Video queues is initialized by uvc_queue_init(). The function performs
  31  * basic initialization of the uvc_video_queue struct and never fails.
  32  *
  33  * Video buffers are managed by videobuf2. The driver uses a mutex to protect
  34  * the videobuf2 queue operations by serializing calls to videobuf2 and a
  35  * spinlock to protect the IRQ queue that holds the buffers to be processed by
  36  * the driver.
  37  */
  38
  39 /* -----------------------------------------------------------------------------
  40  * videobuf2 queue operations
  41  */
  42
  43 static int uvc_queue_setup(struct vb2_queue *vq, const struct v4l2_format *fmt,
  44                            unsigned int *nbuffers, unsigned int *nplanes,
  45                            unsigned int sizes[], void *alloc_ctxs[])
  46 {
  47         struct uvc_video_queue *queue = vb2_get_drv_priv(vq);
  48         struct uvc_streaming *stream =
  49                         container_of(queue, struct uvc_streaming, queue);
  50
  51         /* Make sure the image size is large enough. */
  52         if (fmt && fmt->fmt.pix.sizeimage < stream->ctrl.dwMaxVideoFrameSize)
  53                 return -EINVAL;
  54
  55         *nplanes = 1;
  56
  57         sizes[0] = fmt ? fmt->fmt.pix.sizeimage
  58                  : stream->ctrl.dwMaxVideoFrameSize;
  59
  60         return 0;
  61 }
  62
  63 static int uvc_buffer_prepare(struct vb2_buffer *vb)
  64 {
  65         struct uvc_video_queue *queue = vb2_get_drv_priv(vb->vb2_queue);
  66         struct uvc_buffer *buf = container_of(vb, struct uvc_buffer, buf);
  67
  68         if (vb->v4l2_buf.type == V4L2_BUF_TYPE_VIDEO_OUTPUT &&
  69             vb2_get_plane_payload(vb, 0) > vb2_plane_size(vb, 0)) {
  70                 uvc_trace(UVC_TRACE_CAPTURE, "[E] Bytes used out of bounds.\n");
  71                 return -EINVAL;
  72         }
  73
  74         if (unlikely(queue->flags & UVC_QUEUE_DISCONNECTED))
  75                 return -ENODEV;
  76
  77         buf->state = UVC_BUF_STATE_QUEUED;
  78         buf->error = 0;
  79         buf->mem = vb2_plane_vaddr(vb, 0);
  80         buf->length = vb2_plane_size(vb, 0);
  81         if (vb->v4l2_buf.type == V4L2_BUF_TYPE_VIDEO_CAPTURE)
  82                 buf->bytesused = 0;
  83         else
  84                 buf->bytesused = vb2_get_plane_payload(vb, 0);
  85
  86         return 0;
  87 }
  88
  89 static void uvc_buffer_queue(struct vb2_buffer *vb)
  90 {
  91         struct uvc_video_queue *queue = vb2_get_drv_priv(vb->vb2_queue);
  92         struct uvc_buffer *buf = container_of(vb, struct uvc_buffer, buf);
  93         unsigned long flags;
  94
  95         spin_lock_irqsave(&queue->irqlock, flags);
  96         if (likely(!(queue->flags & UVC_QUEUE_DISCONNECTED))) {
  97                 list_add_tail(&buf->queue, &queue->irqqueue);
  98         } else {
  99                 /* If the device is disconnected return the buffer to userspace
 100                  * directly. The next QBUF call will fail with -ENODEV.
 101                  */
 102                 buf->state = UVC_BUF_STATE_ERROR;
 103                 vb2_buffer_done(&buf->buf, VB2_BUF_STATE_ERROR);
 104         }
 105
 106         spin_unlock_irqrestore(&queue->irqlock, flags);
 107 }
 108
 109 static void uvc_buffer_finish(struct vb2_buffer *vb)
 110 {
 111         struct uvc_video_queue *queue = vb2_get_drv_priv(vb->vb2_queue);
 112         struct uvc_streaming *stream =
 113                         container_of(queue, struct uvc_streaming, queue);
 114         struct uvc_buffer *buf = container_of(vb, struct uvc_buffer, buf);
 115
 116         uvc_video_clock_update(stream, &vb->v4l2_buf, buf);
 117 }
 118
 119 static void uvc_wait_prepare(struct vb2_queue *vq)
 120 {
 121         struct uvc_video_queue *queue = vb2_get_drv_priv(vq);
 122
 123         mutex_unlock(&queue->mutex);
 124 }
 125
 126 static void uvc_wait_finish(struct vb2_queue *vq)
 127 {
 128         struct uvc_video_queue *queue = vb2_get_drv_priv(vq);
 129
 130         mutex_lock(&queue->mutex);
 131 }
 132
 133 static struct vb2_ops uvc_queue_qops = {
 134         .queue_setup = uvc_queue_setup,
 135         .buf_prepare = uvc_buffer_prepare,
 136         .buf_queue = uvc_buffer_queue,
 137         .buf_finish = uvc_buffer_finish,
 138         .wait_prepare = uvc_wait_prepare,
 139         .wait_finish = uvc_wait_finish,
 140 };
 141
 142 int uvc_queue_init(struct uvc_video_queue *queue, enum v4l2_buf_type type,
 143                     int drop_corrupted)
 144 {
 145         int ret;
 146
 147         queue->queue.type = type;
 148         queue->queue.io_modes = VB2_MMAP | VB2_USERPTR | VB2_DMABUF;
 149         queue->queue.drv_priv = queue;
 150         queue->queue.buf_struct_size = sizeof(struct uvc_buffer);
 151         queue->queue.ops = &uvc_queue_qops;
 152         queue->queue.mem_ops = &vb2_vmalloc_memops;
 153         queue->queue.timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC
 154                 | V4L2_BUF_FLAG_TSTAMP_SRC_SOE;
 155         ret = vb2_queue_init(&queue->queue);
 156         if (ret)
 157                 return ret;
 158
 159         mutex_init(&queue->mutex);
 160         spin_lock_init(&queue->irqlock);
 161         INIT_LIST_HEAD(&queue->irqqueue);
 162         queue->flags = drop_corrupted ? UVC_QUEUE_DROP_CORRUPTED : 0;
 163
 164         return 0;
 165 }
 166
 167 /* -----------------------------------------------------------------------------
 168  * V4L2 queue operations
 169  */
 170
 171 int uvc_alloc_buffers(struct uvc_video_queue *queue,
 172                       struct v4l2_requestbuffers *rb)
 173 {
 174         int ret;
 175
 176         mutex_lock(&queue->mutex);
 177         ret = vb2_reqbufs(&queue->queue, rb);
 178         mutex_unlock(&queue->mutex);
 179
 180         return ret ? ret : rb->count;
 181 }
 182
 183 void uvc_free_buffers(struct uvc_video_queue *queue)
 184 {
 185         mutex_lock(&queue->mutex);
 186         vb2_queue_release(&queue->queue);
 187         mutex_unlock(&queue->mutex);
 188 }
 189
 190 int uvc_query_buffer(struct uvc_video_queue *queue, struct v4l2_buffer *buf)
 191 {
 192         int ret;
 193
 194         mutex_lock(&queue->mutex);
 195         ret = vb2_querybuf(&queue->queue, buf);
 196         mutex_unlock(&queue->mutex);
 197
 198         return ret;
 199 }
 200
 201 int uvc_create_buffers(struct uvc_video_queue *queue,
 202                        struct v4l2_create_buffers *cb)
 203 {
 204         int ret;
 205
 206         mutex_lock(&queue->mutex);
 207         ret = vb2_create_bufs(&queue->queue, cb);
 208         mutex_unlock(&queue->mutex);
 209
 210         return ret;
 211 }
 212
 213 int uvc_queue_buffer(struct uvc_video_queue *queue, struct v4l2_buffer *buf)
 214 {
 215         int ret;
 216
 217         mutex_lock(&queue->mutex);
 218         ret = vb2_qbuf(&queue->queue, buf);
 219         mutex_unlock(&queue->mutex);
 220
 221         return ret;
 222 }
 223
 224 int uvc_dequeue_buffer(struct uvc_video_queue *queue, struct v4l2_buffer *buf,
 225                        int nonblocking)
 226 {
 227         int ret;
 228
 229         mutex_lock(&queue->mutex);
 230         ret = vb2_dqbuf(&queue->queue, buf, nonblocking);
 231         mutex_unlock(&queue->mutex);
 232
 233         return ret;
 234 }
 235
 236 int uvc_queue_mmap(struct uvc_video_queue *queue, struct vm_area_struct *vma)
 237 {
 238         int ret;
 239
 240         mutex_lock(&queue->mutex);
 241         ret = vb2_mmap(&queue->queue, vma);
 242         mutex_unlock(&queue->mutex);
 243
 244         return ret;
 245 }
 246
 247 #ifndef CONFIG_MMU
 248 unsigned long uvc_queue_get_unmapped_area(struct uvc_video_queue *queue,
 249                 unsigned long pgoff)
 250 {
 251         unsigned long ret;
 252
 253         mutex_lock(&queue->mutex);
 254         ret = vb2_get_unmapped_area(&queue->queue, 0, 0, pgoff, 0);
 255         mutex_unlock(&queue->mutex);
 256         return ret;
 257 }
 258 #endif
 259
 260 unsigned int uvc_queue_poll(struct uvc_video_queue *queue, struct file *file,
 261                             poll_table *wait)
 262 {
 263         unsigned int ret;
 264
 265         mutex_lock(&queue->mutex);
 266         ret = vb2_poll(&queue->queue, file, wait);
 267         mutex_unlock(&queue->mutex);
 268
 269         return ret;
 270 }
 271
 272 /* -----------------------------------------------------------------------------
 273  *
 274  */
 275
 276 /*
 277  * Check if buffers have been allocated.
 278  */
 279 int uvc_queue_allocated(struct uvc_video_queue *queue)
 280 {
 281         int allocated;
 282
 283         mutex_lock(&queue->mutex);
 284         allocated = vb2_is_busy(&queue->queue);
 285         mutex_unlock(&queue->mutex);
 286
 287         return allocated;
 288 }
 289
 290 /*
 291  * Enable or disable the video buffers queue.
 292  *
 293  * The queue must be enabled before starting video acquisition and must be
 294  * disabled after stopping it. This ensures that the video buffers queue
 295  * state can be properly initialized before buffers are accessed from the
 296  * interrupt handler.
 297  *
 298  * Enabling the video queue returns -EBUSY if the queue is already enabled.
 299  *
 300  * Disabling the video queue cancels the queue and removes all buffers from
 301  * the main queue.
 302  *
 303  * This function can't be called from interrupt context. Use
 304  * uvc_queue_cancel() instead.
 305  */
 306 int uvc_queue_enable(struct uvc_video_queue *queue, int enable)
 307 {
 308         unsigned long flags;
 309         int ret;
 310
 311         mutex_lock(&queue->mutex);
 312         if (enable) {
 313                 ret = vb2_streamon(&queue->queue, queue->queue.type);
 314                 if (ret < 0)
 315                         goto done;
 316
 317                 queue->buf_used = 0;
 318         } else {
 319                 ret = vb2_streamoff(&queue->queue, queue->queue.type);
 320                 if (ret < 0)
 321                         goto done;
 322
 323                 spin_lock_irqsave(&queue->irqlock, flags);
 324                 INIT_LIST_HEAD(&queue->irqqueue);
 325                 spin_unlock_irqrestore(&queue->irqlock, flags);
 326         }
 327
 328 done:
 329         mutex_unlock(&queue->mutex);
 330         return ret;
 331 }
 332
 333 /*
 334  * Cancel the video buffers queue.
 335  *
 336  * Cancelling the queue marks all buffers on the irq queue as erroneous,
 337  * wakes them up and removes them from the queue.
 338  *
 339  * If the disconnect parameter is set, further calls to uvc_queue_buffer will
 340  * fail with -ENODEV.
 341  *
 342  * This function acquires the irq spinlock and can be called from interrupt
 343  * context.
 344  */
 345 void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect)
 346 {
 347         struct uvc_buffer *buf;
 348         unsigned long flags;
 349
 350         spin_lock_irqsave(&queue->irqlock, flags);
 351         while (!list_empty(&queue->irqqueue)) {
 352                 buf = list_first_entry(&queue->irqqueue, struct uvc_buffer,
 353                                        queue);
 354                 list_del(&buf->queue);
 355                 buf->state = UVC_BUF_STATE_ERROR;
 356                 vb2_buffer_done(&buf->buf, VB2_BUF_STATE_ERROR);
 357         }
 358         /* This must be protected by the irqlock spinlock to avoid race
 359          * conditions between uvc_buffer_queue and the disconnection event that
 360          * could result in an interruptible wait in uvc_dequeue_buffer. Do not
 361          * blindly replace this logic by checking for the UVC_QUEUE_DISCONNECTED
 362          * state outside the queue code.
 363          */
 364         if (disconnect)
 365                 queue->flags |= UVC_QUEUE_DISCONNECTED;
 366         spin_unlock_irqrestore(&queue->irqlock, flags);
 367 }
 368
 369 struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue,
 370                 struct uvc_buffer *buf)
 371 {
 372         struct uvc_buffer *nextbuf;
 373         unsigned long flags;
 374
 375         if ((queue->flags & UVC_QUEUE_DROP_CORRUPTED) && buf->error) {
 376                 buf->error = 0;
 377                 buf->state = UVC_BUF_STATE_QUEUED;
 378                 buf->bytesused = 0;
 379                 vb2_set_plane_payload(&buf->buf, 0, 0);
 380                 return buf;
 381         }
 382
 383         spin_lock_irqsave(&queue->irqlock, flags);
 384         list_del(&buf->queue);
 385         if (!list_empty(&queue->irqqueue))
 386                 nextbuf = list_first_entry(&queue->irqqueue, struct uvc_buffer,
 387                                            queue);
 388         else
 389                 nextbuf = NULL;
 390         spin_unlock_irqrestore(&queue->irqlock, flags);
 391
 392         buf->state = buf->error ? VB2_BUF_STATE_ERROR : UVC_BUF_STATE_DONE;
 393         vb2_set_plane_payload(&buf->buf, 0, buf->bytesused);
 394         vb2_buffer_done(&buf->buf, VB2_BUF_STATE_DONE);
 395
 396         return nextbuf;
 397 }