linux/drivers/media/v4l2-core/videobuf2-core.c
<<
>>
Prefs
   1/*
   2 * videobuf2-core.c - V4L2 driver helper framework
   3 *
   4 * Copyright (C) 2010 Samsung Electronics
   5 *
   6 * Author: Pawel Osciak <pawel@osciak.com>
   7 *         Marek Szyprowski <m.szyprowski@samsung.com>
   8 *
   9 * The vb2_thread implementation was based on code from videobuf-dvb.c:
  10 *      (c) 2004 Gerd Knorr <kraxel@bytesex.org> [SUSE Labs]
  11 *
  12 * This program is free software; you can redistribute it and/or modify
  13 * it under the terms of the GNU General Public License as published by
  14 * the Free Software Foundation.
  15 */
  16
  17#include <linux/err.h>
  18#include <linux/kernel.h>
  19#include <linux/module.h>
  20#include <linux/mm.h>
  21#include <linux/poll.h>
  22#include <linux/slab.h>
  23#include <linux/sched.h>
  24#include <linux/freezer.h>
  25#include <linux/kthread.h>
  26
  27#include <media/v4l2-dev.h>
  28#include <media/v4l2-fh.h>
  29#include <media/v4l2-event.h>
  30#include <media/v4l2-common.h>
  31#include <media/videobuf2-core.h>
  32
  33static int debug;
  34module_param(debug, int, 0644);
  35
  36#define dprintk(level, fmt, arg...)                                           \
  37        do {                                                                  \
  38                if (debug >= level)                                           \
  39                        pr_debug("vb2: %s: " fmt, __func__, ## arg); \
  40        } while (0)
  41
  42#ifdef CONFIG_VIDEO_ADV_DEBUG
  43
  44/*
  45 * If advanced debugging is on, then count how often each op is called
  46 * successfully, which can either be per-buffer or per-queue.
  47 *
  48 * This makes it easy to check that the 'init' and 'cleanup'
  49 * (and variations thereof) stay balanced.
  50 */
  51
  52#define log_memop(vb, op)                                               \
  53        dprintk(2, "call_memop(%p, %d, %s)%s\n",                        \
  54                (vb)->vb2_queue, (vb)->v4l2_buf.index, #op,             \
  55                (vb)->vb2_queue->mem_ops->op ? "" : " (nop)")
  56
  57#define call_memop(vb, op, args...)                                     \
  58({                                                                      \
  59        struct vb2_queue *_q = (vb)->vb2_queue;                         \
  60        int err;                                                        \
  61                                                                        \
  62        log_memop(vb, op);                                              \
  63        err = _q->mem_ops->op ? _q->mem_ops->op(args) : 0;              \
  64        if (!err)                                                       \
  65                (vb)->cnt_mem_ ## op++;                                 \
  66        err;                                                            \
  67})
  68
  69#define call_ptr_memop(vb, op, args...)                                 \
  70({                                                                      \
  71        struct vb2_queue *_q = (vb)->vb2_queue;                         \
  72        void *ptr;                                                      \
  73                                                                        \
  74        log_memop(vb, op);                                              \
  75        ptr = _q->mem_ops->op ? _q->mem_ops->op(args) : NULL;           \
  76        if (!IS_ERR_OR_NULL(ptr))                                       \
  77                (vb)->cnt_mem_ ## op++;                                 \
  78        ptr;                                                            \
  79})
  80
  81#define call_void_memop(vb, op, args...)                                \
  82({                                                                      \
  83        struct vb2_queue *_q = (vb)->vb2_queue;                         \
  84                                                                        \
  85        log_memop(vb, op);                                              \
  86        if (_q->mem_ops->op)                                            \
  87                _q->mem_ops->op(args);                                  \
  88        (vb)->cnt_mem_ ## op++;                                         \
  89})
  90
  91#define log_qop(q, op)                                                  \
  92        dprintk(2, "call_qop(%p, %s)%s\n", q, #op,                      \
  93                (q)->ops->op ? "" : " (nop)")
  94
  95#define call_qop(q, op, args...)                                        \
  96({                                                                      \
  97        int err;                                                        \
  98                                                                        \
  99        log_qop(q, op);                                                 \
 100        err = (q)->ops->op ? (q)->ops->op(args) : 0;                    \
 101        if (!err)                                                       \
 102                (q)->cnt_ ## op++;                                      \
 103        err;                                                            \
 104})
 105
 106#define call_void_qop(q, op, args...)                                   \
 107({                                                                      \
 108        log_qop(q, op);                                                 \
 109        if ((q)->ops->op)                                               \
 110                (q)->ops->op(args);                                     \
 111        (q)->cnt_ ## op++;                                              \
 112})
 113
 114#define log_vb_qop(vb, op, args...)                                     \
 115        dprintk(2, "call_vb_qop(%p, %d, %s)%s\n",                       \
 116                (vb)->vb2_queue, (vb)->v4l2_buf.index, #op,             \
 117                (vb)->vb2_queue->ops->op ? "" : " (nop)")
 118
 119#define call_vb_qop(vb, op, args...)                                    \
 120({                                                                      \
 121        int err;                                                        \
 122                                                                        \
 123        log_vb_qop(vb, op);                                             \
 124        err = (vb)->vb2_queue->ops->op ?                                \
 125                (vb)->vb2_queue->ops->op(args) : 0;                     \
 126        if (!err)                                                       \
 127                (vb)->cnt_ ## op++;                                     \
 128        err;                                                            \
 129})
 130
 131#define call_void_vb_qop(vb, op, args...)                               \
 132({                                                                      \
 133        log_vb_qop(vb, op);                                             \
 134        if ((vb)->vb2_queue->ops->op)                                   \
 135                (vb)->vb2_queue->ops->op(args);                         \
 136        (vb)->cnt_ ## op++;                                             \
 137})
 138
 139#else
 140
 141#define call_memop(vb, op, args...)                                     \
 142        ((vb)->vb2_queue->mem_ops->op ?                                 \
 143                (vb)->vb2_queue->mem_ops->op(args) : 0)
 144
 145#define call_ptr_memop(vb, op, args...)                                 \
 146        ((vb)->vb2_queue->mem_ops->op ?                                 \
 147                (vb)->vb2_queue->mem_ops->op(args) : NULL)
 148
 149#define call_void_memop(vb, op, args...)                                \
 150        do {                                                            \
 151                if ((vb)->vb2_queue->mem_ops->op)                       \
 152                        (vb)->vb2_queue->mem_ops->op(args);             \
 153        } while (0)
 154
 155#define call_qop(q, op, args...)                                        \
 156        ((q)->ops->op ? (q)->ops->op(args) : 0)
 157
 158#define call_void_qop(q, op, args...)                                   \
 159        do {                                                            \
 160                if ((q)->ops->op)                                       \
 161                        (q)->ops->op(args);                             \
 162        } while (0)
 163
 164#define call_vb_qop(vb, op, args...)                                    \
 165        ((vb)->vb2_queue->ops->op ? (vb)->vb2_queue->ops->op(args) : 0)
 166
 167#define call_void_vb_qop(vb, op, args...)                               \
 168        do {                                                            \
 169                if ((vb)->vb2_queue->ops->op)                           \
 170                        (vb)->vb2_queue->ops->op(args);                 \
 171        } while (0)
 172
 173#endif
 174
 175/* Flags that are set by the vb2 core */
 176#define V4L2_BUFFER_MASK_FLAGS  (V4L2_BUF_FLAG_MAPPED | V4L2_BUF_FLAG_QUEUED | \
 177                                 V4L2_BUF_FLAG_DONE | V4L2_BUF_FLAG_ERROR | \
 178                                 V4L2_BUF_FLAG_PREPARED | \
 179                                 V4L2_BUF_FLAG_TIMESTAMP_MASK)
 180/* Output buffer flags that should be passed on to the driver */
 181#define V4L2_BUFFER_OUT_FLAGS   (V4L2_BUF_FLAG_PFRAME | V4L2_BUF_FLAG_BFRAME | \
 182                                 V4L2_BUF_FLAG_KEYFRAME | V4L2_BUF_FLAG_TIMECODE)
 183
 184static void __vb2_queue_cancel(struct vb2_queue *q);
 185
 186/**
 187 * __vb2_buf_mem_alloc() - allocate video memory for the given buffer
 188 */
 189static int __vb2_buf_mem_alloc(struct vb2_buffer *vb)
 190{
 191        struct vb2_queue *q = vb->vb2_queue;
 192        void *mem_priv;
 193        int plane;
 194
 195        /*
 196         * Allocate memory for all planes in this buffer
 197         * NOTE: mmapped areas should be page aligned
 198         */
 199        for (plane = 0; plane < vb->num_planes; ++plane) {
 200                unsigned long size = PAGE_ALIGN(q->plane_sizes[plane]);
 201
 202                mem_priv = call_ptr_memop(vb, alloc, q->alloc_ctx[plane],
 203                                      size, q->gfp_flags);
 204                if (IS_ERR_OR_NULL(mem_priv))
 205                        goto free;
 206
 207                /* Associate allocator private data with this plane */
 208                vb->planes[plane].mem_priv = mem_priv;
 209                vb->v4l2_planes[plane].length = q->plane_sizes[plane];
 210        }
 211
 212        return 0;
 213free:
 214        /* Free already allocated memory if one of the allocations failed */
 215        for (; plane > 0; --plane) {
 216                call_void_memop(vb, put, vb->planes[plane - 1].mem_priv);
 217                vb->planes[plane - 1].mem_priv = NULL;
 218        }
 219
 220        return -ENOMEM;
 221}
 222
 223/**
 224 * __vb2_buf_mem_free() - free memory of the given buffer
 225 */
 226static void __vb2_buf_mem_free(struct vb2_buffer *vb)
 227{
 228        unsigned int plane;
 229
 230        for (plane = 0; plane < vb->num_planes; ++plane) {
 231                call_void_memop(vb, put, vb->planes[plane].mem_priv);
 232                vb->planes[plane].mem_priv = NULL;
 233                dprintk(3, "freed plane %d of buffer %d\n", plane,
 234                        vb->v4l2_buf.index);
 235        }
 236}
 237
 238/**
 239 * __vb2_buf_userptr_put() - release userspace memory associated with
 240 * a USERPTR buffer
 241 */
 242static void __vb2_buf_userptr_put(struct vb2_buffer *vb)
 243{
 244        unsigned int plane;
 245
 246        for (plane = 0; plane < vb->num_planes; ++plane) {
 247                if (vb->planes[plane].mem_priv)
 248                        call_void_memop(vb, put_userptr, vb->planes[plane].mem_priv);
 249                vb->planes[plane].mem_priv = NULL;
 250        }
 251}
 252
 253/**
 254 * __vb2_plane_dmabuf_put() - release memory associated with
 255 * a DMABUF shared plane
 256 */
 257static void __vb2_plane_dmabuf_put(struct vb2_buffer *vb, struct vb2_plane *p)
 258{
 259        if (!p->mem_priv)
 260                return;
 261
 262        if (p->dbuf_mapped)
 263                call_void_memop(vb, unmap_dmabuf, p->mem_priv);
 264
 265        call_void_memop(vb, detach_dmabuf, p->mem_priv);
 266        dma_buf_put(p->dbuf);
 267        memset(p, 0, sizeof(*p));
 268}
 269
 270/**
 271 * __vb2_buf_dmabuf_put() - release memory associated with
 272 * a DMABUF shared buffer
 273 */
 274static void __vb2_buf_dmabuf_put(struct vb2_buffer *vb)
 275{
 276        unsigned int plane;
 277
 278        for (plane = 0; plane < vb->num_planes; ++plane)
 279                __vb2_plane_dmabuf_put(vb, &vb->planes[plane]);
 280}
 281
 282/**
 283 * __setup_lengths() - setup initial lengths for every plane in
 284 * every buffer on the queue
 285 */
 286static void __setup_lengths(struct vb2_queue *q, unsigned int n)
 287{
 288        unsigned int buffer, plane;
 289        struct vb2_buffer *vb;
 290
 291        for (buffer = q->num_buffers; buffer < q->num_buffers + n; ++buffer) {
 292                vb = q->bufs[buffer];
 293                if (!vb)
 294                        continue;
 295
 296                for (plane = 0; plane < vb->num_planes; ++plane)
 297                        vb->v4l2_planes[plane].length = q->plane_sizes[plane];
 298        }
 299}
 300
 301/**
 302 * __setup_offsets() - setup unique offsets ("cookies") for every plane in
 303 * every buffer on the queue
 304 */
 305static void __setup_offsets(struct vb2_queue *q, unsigned int n)
 306{
 307        unsigned int buffer, plane;
 308        struct vb2_buffer *vb;
 309        unsigned long off;
 310
 311        if (q->num_buffers) {
 312                struct v4l2_plane *p;
 313                vb = q->bufs[q->num_buffers - 1];
 314                p = &vb->v4l2_planes[vb->num_planes - 1];
 315                off = PAGE_ALIGN(p->m.mem_offset + p->length);
 316        } else {
 317                off = 0;
 318        }
 319
 320        for (buffer = q->num_buffers; buffer < q->num_buffers + n; ++buffer) {
 321                vb = q->bufs[buffer];
 322                if (!vb)
 323                        continue;
 324
 325                for (plane = 0; plane < vb->num_planes; ++plane) {
 326                        vb->v4l2_planes[plane].m.mem_offset = off;
 327
 328                        dprintk(3, "buffer %d, plane %d offset 0x%08lx\n",
 329                                        buffer, plane, off);
 330
 331                        off += vb->v4l2_planes[plane].length;
 332                        off = PAGE_ALIGN(off);
 333                }
 334        }
 335}
 336
 337/**
 338 * __vb2_queue_alloc() - allocate videobuf buffer structures and (for MMAP type)
 339 * video buffer memory for all buffers/planes on the queue and initializes the
 340 * queue
 341 *
 342 * Returns the number of buffers successfully allocated.
 343 */
 344static int __vb2_queue_alloc(struct vb2_queue *q, enum v4l2_memory memory,
 345                             unsigned int num_buffers, unsigned int num_planes)
 346{
 347        unsigned int buffer;
 348        struct vb2_buffer *vb;
 349        int ret;
 350
 351        for (buffer = 0; buffer < num_buffers; ++buffer) {
 352                /* Allocate videobuf buffer structures */
 353                vb = kzalloc(q->buf_struct_size, GFP_KERNEL);
 354                if (!vb) {
 355                        dprintk(1, "memory alloc for buffer struct failed\n");
 356                        break;
 357                }
 358
 359                /* Length stores number of planes for multiplanar buffers */
 360                if (V4L2_TYPE_IS_MULTIPLANAR(q->type))
 361                        vb->v4l2_buf.length = num_planes;
 362
 363                vb->state = VB2_BUF_STATE_DEQUEUED;
 364                vb->vb2_queue = q;
 365                vb->num_planes = num_planes;
 366                vb->v4l2_buf.index = q->num_buffers + buffer;
 367                vb->v4l2_buf.type = q->type;
 368                vb->v4l2_buf.memory = memory;
 369
 370                /* Allocate video buffer memory for the MMAP type */
 371                if (memory == V4L2_MEMORY_MMAP) {
 372                        ret = __vb2_buf_mem_alloc(vb);
 373                        if (ret) {
 374                                dprintk(1, "failed allocating memory for "
 375                                                "buffer %d\n", buffer);
 376                                kfree(vb);
 377                                break;
 378                        }
 379                        /*
 380                         * Call the driver-provided buffer initialization
 381                         * callback, if given. An error in initialization
 382                         * results in queue setup failure.
 383                         */
 384                        ret = call_vb_qop(vb, buf_init, vb);
 385                        if (ret) {
 386                                dprintk(1, "buffer %d %p initialization"
 387                                        " failed\n", buffer, vb);
 388                                __vb2_buf_mem_free(vb);
 389                                kfree(vb);
 390                                break;
 391                        }
 392                }
 393
 394                q->bufs[q->num_buffers + buffer] = vb;
 395        }
 396
 397        __setup_lengths(q, buffer);
 398        if (memory == V4L2_MEMORY_MMAP)
 399                __setup_offsets(q, buffer);
 400
 401        dprintk(1, "allocated %d buffers, %d plane(s) each\n",
 402                        buffer, num_planes);
 403
 404        return buffer;
 405}
 406
 407/**
 408 * __vb2_free_mem() - release all video buffer memory for a given queue
 409 */
 410static void __vb2_free_mem(struct vb2_queue *q, unsigned int buffers)
 411{
 412        unsigned int buffer;
 413        struct vb2_buffer *vb;
 414
 415        for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
 416             ++buffer) {
 417                vb = q->bufs[buffer];
 418                if (!vb)
 419                        continue;
 420
 421                /* Free MMAP buffers or release USERPTR buffers */
 422                if (q->memory == V4L2_MEMORY_MMAP)
 423                        __vb2_buf_mem_free(vb);
 424                else if (q->memory == V4L2_MEMORY_DMABUF)
 425                        __vb2_buf_dmabuf_put(vb);
 426                else
 427                        __vb2_buf_userptr_put(vb);
 428        }
 429}
 430
 431/**
 432 * __vb2_queue_free() - free buffers at the end of the queue - video memory and
 433 * related information, if no buffers are left return the queue to an
 434 * uninitialized state. Might be called even if the queue has already been freed.
 435 */
 436static int __vb2_queue_free(struct vb2_queue *q, unsigned int buffers)
 437{
 438        unsigned int buffer;
 439
 440        /*
 441         * Sanity check: when preparing a buffer the queue lock is released for
 442         * a short while (see __buf_prepare for the details), which would allow
 443         * a race with a reqbufs which can call this function. Removing the
 444         * buffers from underneath __buf_prepare is obviously a bad idea, so we
 445         * check if any of the buffers is in the state PREPARING, and if so we
 446         * just return -EAGAIN.
 447         */
 448        for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
 449             ++buffer) {
 450                if (q->bufs[buffer] == NULL)
 451                        continue;
 452                if (q->bufs[buffer]->state == VB2_BUF_STATE_PREPARING) {
 453                        dprintk(1, "preparing buffers, cannot free\n");
 454                        return -EAGAIN;
 455                }
 456        }
 457
 458        /* Call driver-provided cleanup function for each buffer, if provided */
 459        for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
 460             ++buffer) {
 461                struct vb2_buffer *vb = q->bufs[buffer];
 462
 463                if (vb && vb->planes[0].mem_priv)
 464                        call_void_vb_qop(vb, buf_cleanup, vb);
 465        }
 466
 467        /* Release video buffer memory */
 468        __vb2_free_mem(q, buffers);
 469
 470#ifdef CONFIG_VIDEO_ADV_DEBUG
 471        /*
 472         * Check that all the calls were balances during the life-time of this
 473         * queue. If not (or if the debug level is 1 or up), then dump the
 474         * counters to the kernel log.
 475         */
 476        if (q->num_buffers) {
 477                bool unbalanced = q->cnt_start_streaming != q->cnt_stop_streaming ||
 478                                  q->cnt_wait_prepare != q->cnt_wait_finish;
 479
 480                if (unbalanced || debug) {
 481                        pr_info("vb2: counters for queue %p:%s\n", q,
 482                                unbalanced ? " UNBALANCED!" : "");
 483                        pr_info("vb2:     setup: %u start_streaming: %u stop_streaming: %u\n",
 484                                q->cnt_queue_setup, q->cnt_start_streaming,
 485                                q->cnt_stop_streaming);
 486                        pr_info("vb2:     wait_prepare: %u wait_finish: %u\n",
 487                                q->cnt_wait_prepare, q->cnt_wait_finish);
 488                }
 489                q->cnt_queue_setup = 0;
 490                q->cnt_wait_prepare = 0;
 491                q->cnt_wait_finish = 0;
 492                q->cnt_start_streaming = 0;
 493                q->cnt_stop_streaming = 0;
 494        }
 495        for (buffer = 0; buffer < q->num_buffers; ++buffer) {
 496                struct vb2_buffer *vb = q->bufs[buffer];
 497                bool unbalanced = vb->cnt_mem_alloc != vb->cnt_mem_put ||
 498                                  vb->cnt_mem_prepare != vb->cnt_mem_finish ||
 499                                  vb->cnt_mem_get_userptr != vb->cnt_mem_put_userptr ||
 500                                  vb->cnt_mem_attach_dmabuf != vb->cnt_mem_detach_dmabuf ||
 501                                  vb->cnt_mem_map_dmabuf != vb->cnt_mem_unmap_dmabuf ||
 502                                  vb->cnt_buf_queue != vb->cnt_buf_done ||
 503                                  vb->cnt_buf_prepare != vb->cnt_buf_finish ||
 504                                  vb->cnt_buf_init != vb->cnt_buf_cleanup;
 505
 506                if (unbalanced || debug) {
 507                        pr_info("vb2:   counters for queue %p, buffer %d:%s\n",
 508                                q, buffer, unbalanced ? " UNBALANCED!" : "");
 509                        pr_info("vb2:     buf_init: %u buf_cleanup: %u buf_prepare: %u buf_finish: %u\n",
 510                                vb->cnt_buf_init, vb->cnt_buf_cleanup,
 511                                vb->cnt_buf_prepare, vb->cnt_buf_finish);
 512                        pr_info("vb2:     buf_queue: %u buf_done: %u\n",
 513                                vb->cnt_buf_queue, vb->cnt_buf_done);
 514                        pr_info("vb2:     alloc: %u put: %u prepare: %u finish: %u mmap: %u\n",
 515                                vb->cnt_mem_alloc, vb->cnt_mem_put,
 516                                vb->cnt_mem_prepare, vb->cnt_mem_finish,
 517                                vb->cnt_mem_mmap);
 518                        pr_info("vb2:     get_userptr: %u put_userptr: %u\n",
 519                                vb->cnt_mem_get_userptr, vb->cnt_mem_put_userptr);
 520                        pr_info("vb2:     attach_dmabuf: %u detach_dmabuf: %u map_dmabuf: %u unmap_dmabuf: %u\n",
 521                                vb->cnt_mem_attach_dmabuf, vb->cnt_mem_detach_dmabuf,
 522                                vb->cnt_mem_map_dmabuf, vb->cnt_mem_unmap_dmabuf);
 523                        pr_info("vb2:     get_dmabuf: %u num_users: %u vaddr: %u cookie: %u\n",
 524                                vb->cnt_mem_get_dmabuf,
 525                                vb->cnt_mem_num_users,
 526                                vb->cnt_mem_vaddr,
 527                                vb->cnt_mem_cookie);
 528                }
 529        }
 530#endif
 531
 532        /* Free videobuf buffers */
 533        for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
 534             ++buffer) {
 535                kfree(q->bufs[buffer]);
 536                q->bufs[buffer] = NULL;
 537        }
 538
 539        q->num_buffers -= buffers;
 540        if (!q->num_buffers) {
 541                q->memory = 0;
 542                INIT_LIST_HEAD(&q->queued_list);
 543        }
 544        return 0;
 545}
 546
 547/**
 548 * __verify_planes_array() - verify that the planes array passed in struct
 549 * v4l2_buffer from userspace can be safely used
 550 */
 551static int __verify_planes_array(struct vb2_buffer *vb, const struct v4l2_buffer *b)
 552{
 553        if (!V4L2_TYPE_IS_MULTIPLANAR(b->type))
 554                return 0;
 555
 556        /* Is memory for copying plane information present? */
 557        if (NULL == b->m.planes) {
 558                dprintk(1, "multi-planar buffer passed but "
 559                           "planes array not provided\n");
 560                return -EINVAL;
 561        }
 562
 563        if (b->length < vb->num_planes || b->length > VIDEO_MAX_PLANES) {
 564                dprintk(1, "incorrect planes array length, "
 565                           "expected %d, got %d\n", vb->num_planes, b->length);
 566                return -EINVAL;
 567        }
 568
 569        return 0;
 570}
 571
 572/**
 573 * __verify_length() - Verify that the bytesused value for each plane fits in
 574 * the plane length and that the data offset doesn't exceed the bytesused value.
 575 */
 576static int __verify_length(struct vb2_buffer *vb, const struct v4l2_buffer *b)
 577{
 578        unsigned int length;
 579        unsigned int bytesused;
 580        unsigned int plane;
 581
 582        if (!V4L2_TYPE_IS_OUTPUT(b->type))
 583                return 0;
 584
 585        if (V4L2_TYPE_IS_MULTIPLANAR(b->type)) {
 586                for (plane = 0; plane < vb->num_planes; ++plane) {
 587                        length = (b->memory == V4L2_MEMORY_USERPTR ||
 588                                  b->memory == V4L2_MEMORY_DMABUF)
 589                               ? b->m.planes[plane].length
 590                               : vb->v4l2_planes[plane].length;
 591                        bytesused = b->m.planes[plane].bytesused
 592                                  ? b->m.planes[plane].bytesused : length;
 593
 594                        if (b->m.planes[plane].bytesused > length)
 595                                return -EINVAL;
 596
 597                        if (b->m.planes[plane].data_offset > 0 &&
 598                            b->m.planes[plane].data_offset >= bytesused)
 599                                return -EINVAL;
 600                }
 601        } else {
 602                length = (b->memory == V4L2_MEMORY_USERPTR)
 603                       ? b->length : vb->v4l2_planes[0].length;
 604                bytesused = b->bytesused ? b->bytesused : length;
 605
 606                if (b->bytesused > length)
 607                        return -EINVAL;
 608        }
 609
 610        return 0;
 611}
 612
 613/**
 614 * __buffer_in_use() - return true if the buffer is in use and
 615 * the queue cannot be freed (by the means of REQBUFS(0)) call
 616 */
 617static bool __buffer_in_use(struct vb2_queue *q, struct vb2_buffer *vb)
 618{
 619        unsigned int plane;
 620        for (plane = 0; plane < vb->num_planes; ++plane) {
 621                void *mem_priv = vb->planes[plane].mem_priv;
 622                /*
 623                 * If num_users() has not been provided, call_memop
 624                 * will return 0, apparently nobody cares about this
 625                 * case anyway. If num_users() returns more than 1,
 626                 * we are not the only user of the plane's memory.
 627                 */
 628                if (mem_priv && call_memop(vb, num_users, mem_priv) > 1)
 629                        return true;
 630        }
 631        return false;
 632}
 633
 634/**
 635 * __buffers_in_use() - return true if any buffers on the queue are in use and
 636 * the queue cannot be freed (by the means of REQBUFS(0)) call
 637 */
 638static bool __buffers_in_use(struct vb2_queue *q)
 639{
 640        unsigned int buffer;
 641        for (buffer = 0; buffer < q->num_buffers; ++buffer) {
 642                if (__buffer_in_use(q, q->bufs[buffer]))
 643                        return true;
 644        }
 645        return false;
 646}
 647
 648/**
 649 * __fill_v4l2_buffer() - fill in a struct v4l2_buffer with information to be
 650 * returned to userspace
 651 */
 652static void __fill_v4l2_buffer(struct vb2_buffer *vb, struct v4l2_buffer *b)
 653{
 654        struct vb2_queue *q = vb->vb2_queue;
 655
 656        /* Copy back data such as timestamp, flags, etc. */
 657        memcpy(b, &vb->v4l2_buf, offsetof(struct v4l2_buffer, m));
 658        b->reserved2 = vb->v4l2_buf.reserved2;
 659        b->reserved = vb->v4l2_buf.reserved;
 660
 661        if (V4L2_TYPE_IS_MULTIPLANAR(q->type)) {
 662                /*
 663                 * Fill in plane-related data if userspace provided an array
 664                 * for it. The caller has already verified memory and size.
 665                 */
 666                b->length = vb->num_planes;
 667                memcpy(b->m.planes, vb->v4l2_planes,
 668                        b->length * sizeof(struct v4l2_plane));
 669        } else {
 670                /*
 671                 * We use length and offset in v4l2_planes array even for
 672                 * single-planar buffers, but userspace does not.
 673                 */
 674                b->length = vb->v4l2_planes[0].length;
 675                b->bytesused = vb->v4l2_planes[0].bytesused;
 676                if (q->memory == V4L2_MEMORY_MMAP)
 677                        b->m.offset = vb->v4l2_planes[0].m.mem_offset;
 678                else if (q->memory == V4L2_MEMORY_USERPTR)
 679                        b->m.userptr = vb->v4l2_planes[0].m.userptr;
 680                else if (q->memory == V4L2_MEMORY_DMABUF)
 681                        b->m.fd = vb->v4l2_planes[0].m.fd;
 682        }
 683
 684        /*
 685         * Clear any buffer state related flags.
 686         */
 687        b->flags &= ~V4L2_BUFFER_MASK_FLAGS;
 688        b->flags |= q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK;
 689        if ((q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) !=
 690            V4L2_BUF_FLAG_TIMESTAMP_COPY) {
 691                /*
 692                 * For non-COPY timestamps, drop timestamp source bits
 693                 * and obtain the timestamp source from the queue.
 694                 */
 695                b->flags &= ~V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
 696                b->flags |= q->timestamp_flags & V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
 697        }
 698
 699        switch (vb->state) {
 700        case VB2_BUF_STATE_QUEUED:
 701        case VB2_BUF_STATE_ACTIVE:
 702                b->flags |= V4L2_BUF_FLAG_QUEUED;
 703                break;
 704        case VB2_BUF_STATE_ERROR:
 705                b->flags |= V4L2_BUF_FLAG_ERROR;
 706                /* fall through */
 707        case VB2_BUF_STATE_DONE:
 708                b->flags |= V4L2_BUF_FLAG_DONE;
 709                break;
 710        case VB2_BUF_STATE_PREPARED:
 711                b->flags |= V4L2_BUF_FLAG_PREPARED;
 712                break;
 713        case VB2_BUF_STATE_PREPARING:
 714        case VB2_BUF_STATE_DEQUEUED:
 715                /* nothing */
 716                break;
 717        }
 718
 719        if (__buffer_in_use(q, vb))
 720                b->flags |= V4L2_BUF_FLAG_MAPPED;
 721}
 722
 723/**
 724 * vb2_querybuf() - query video buffer information
 725 * @q:          videobuf queue
 726 * @b:          buffer struct passed from userspace to vidioc_querybuf handler
 727 *              in driver
 728 *
 729 * Should be called from vidioc_querybuf ioctl handler in driver.
 730 * This function will verify the passed v4l2_buffer structure and fill the
 731 * relevant information for the userspace.
 732 *
 733 * The return values from this function are intended to be directly returned
 734 * from vidioc_querybuf handler in driver.
 735 */
 736int vb2_querybuf(struct vb2_queue *q, struct v4l2_buffer *b)
 737{
 738        struct vb2_buffer *vb;
 739        int ret;
 740
 741        if (b->type != q->type) {
 742                dprintk(1, "wrong buffer type\n");
 743                return -EINVAL;
 744        }
 745
 746        if (b->index >= q->num_buffers) {
 747                dprintk(1, "buffer index out of range\n");
 748                return -EINVAL;
 749        }
 750        vb = q->bufs[b->index];
 751        ret = __verify_planes_array(vb, b);
 752        if (!ret)
 753                __fill_v4l2_buffer(vb, b);
 754        return ret;
 755}
 756EXPORT_SYMBOL(vb2_querybuf);
 757
 758/**
 759 * __verify_userptr_ops() - verify that all memory operations required for
 760 * USERPTR queue type have been provided
 761 */
 762static int __verify_userptr_ops(struct vb2_queue *q)
 763{
 764        if (!(q->io_modes & VB2_USERPTR) || !q->mem_ops->get_userptr ||
 765            !q->mem_ops->put_userptr)
 766                return -EINVAL;
 767
 768        return 0;
 769}
 770
 771/**
 772 * __verify_mmap_ops() - verify that all memory operations required for
 773 * MMAP queue type have been provided
 774 */
 775static int __verify_mmap_ops(struct vb2_queue *q)
 776{
 777        if (!(q->io_modes & VB2_MMAP) || !q->mem_ops->alloc ||
 778            !q->mem_ops->put || !q->mem_ops->mmap)
 779                return -EINVAL;
 780
 781        return 0;
 782}
 783
 784/**
 785 * __verify_dmabuf_ops() - verify that all memory operations required for
 786 * DMABUF queue type have been provided
 787 */
 788static int __verify_dmabuf_ops(struct vb2_queue *q)
 789{
 790        if (!(q->io_modes & VB2_DMABUF) || !q->mem_ops->attach_dmabuf ||
 791            !q->mem_ops->detach_dmabuf  || !q->mem_ops->map_dmabuf ||
 792            !q->mem_ops->unmap_dmabuf)
 793                return -EINVAL;
 794
 795        return 0;
 796}
 797
 798/**
 799 * __verify_memory_type() - Check whether the memory type and buffer type
 800 * passed to a buffer operation are compatible with the queue.
 801 */
 802static int __verify_memory_type(struct vb2_queue *q,
 803                enum v4l2_memory memory, enum v4l2_buf_type type)
 804{
 805        if (memory != V4L2_MEMORY_MMAP && memory != V4L2_MEMORY_USERPTR &&
 806            memory != V4L2_MEMORY_DMABUF) {
 807                dprintk(1, "unsupported memory type\n");
 808                return -EINVAL;
 809        }
 810
 811        if (type != q->type) {
 812                dprintk(1, "requested type is incorrect\n");
 813                return -EINVAL;
 814        }
 815
 816        /*
 817         * Make sure all the required memory ops for given memory type
 818         * are available.
 819         */
 820        if (memory == V4L2_MEMORY_MMAP && __verify_mmap_ops(q)) {
 821                dprintk(1, "MMAP for current setup unsupported\n");
 822                return -EINVAL;
 823        }
 824
 825        if (memory == V4L2_MEMORY_USERPTR && __verify_userptr_ops(q)) {
 826                dprintk(1, "USERPTR for current setup unsupported\n");
 827                return -EINVAL;
 828        }
 829
 830        if (memory == V4L2_MEMORY_DMABUF && __verify_dmabuf_ops(q)) {
 831                dprintk(1, "DMABUF for current setup unsupported\n");
 832                return -EINVAL;
 833        }
 834
 835        /*
 836         * Place the busy tests at the end: -EBUSY can be ignored when
 837         * create_bufs is called with count == 0, but count == 0 should still
 838         * do the memory and type validation.
 839         */
 840        if (vb2_fileio_is_active(q)) {
 841                dprintk(1, "file io in progress\n");
 842                return -EBUSY;
 843        }
 844        return 0;
 845}
 846
 847/**
 848 * __reqbufs() - Initiate streaming
 849 * @q:          videobuf2 queue
 850 * @req:        struct passed from userspace to vidioc_reqbufs handler in driver
 851 *
 852 * Should be called from vidioc_reqbufs ioctl handler of a driver.
 853 * This function:
 854 * 1) verifies streaming parameters passed from the userspace,
 855 * 2) sets up the queue,
 856 * 3) negotiates number of buffers and planes per buffer with the driver
 857 *    to be used during streaming,
 858 * 4) allocates internal buffer structures (struct vb2_buffer), according to
 859 *    the agreed parameters,
 860 * 5) for MMAP memory type, allocates actual video memory, using the
 861 *    memory handling/allocation routines provided during queue initialization
 862 *
 863 * If req->count is 0, all the memory will be freed instead.
 864 * If the queue has been allocated previously (by a previous vb2_reqbufs) call
 865 * and the queue is not busy, memory will be reallocated.
 866 *
 867 * The return values from this function are intended to be directly returned
 868 * from vidioc_reqbufs handler in driver.
 869 */
 870static int __reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req)
 871{
 872        unsigned int num_buffers, allocated_buffers, num_planes = 0;
 873        int ret;
 874
 875        if (q->streaming) {
 876                dprintk(1, "streaming active\n");
 877                return -EBUSY;
 878        }
 879
 880        if (req->count == 0 || q->num_buffers != 0 || q->memory != req->memory) {
 881                /*
 882                 * We already have buffers allocated, so first check if they
 883                 * are not in use and can be freed.
 884                 */
 885                if (q->memory == V4L2_MEMORY_MMAP && __buffers_in_use(q)) {
 886                        dprintk(1, "memory in use, cannot free\n");
 887                        return -EBUSY;
 888                }
 889
 890                /*
 891                 * Call queue_cancel to clean up any buffers in the PREPARED or
 892                 * QUEUED state which is possible if buffers were prepared or
 893                 * queued without ever calling STREAMON.
 894                 */
 895                __vb2_queue_cancel(q);
 896                ret = __vb2_queue_free(q, q->num_buffers);
 897                if (ret)
 898                        return ret;
 899
 900                /*
 901                 * In case of REQBUFS(0) return immediately without calling
 902                 * driver's queue_setup() callback and allocating resources.
 903                 */
 904                if (req->count == 0)
 905                        return 0;
 906        }
 907
 908        /*
 909         * Make sure the requested values and current defaults are sane.
 910         */
 911        num_buffers = min_t(unsigned int, req->count, VIDEO_MAX_FRAME);
 912        num_buffers = max_t(unsigned int, num_buffers, q->min_buffers_needed);
 913        memset(q->plane_sizes, 0, sizeof(q->plane_sizes));
 914        memset(q->alloc_ctx, 0, sizeof(q->alloc_ctx));
 915        q->memory = req->memory;
 916
 917        /*
 918         * Ask the driver how many buffers and planes per buffer it requires.
 919         * Driver also sets the size and allocator context for each plane.
 920         */
 921        ret = call_qop(q, queue_setup, q, NULL, &num_buffers, &num_planes,
 922                       q->plane_sizes, q->alloc_ctx);
 923        if (ret)
 924                return ret;
 925
 926        /* Finally, allocate buffers and video memory */
 927        allocated_buffers = __vb2_queue_alloc(q, req->memory, num_buffers, num_planes);
 928        if (allocated_buffers == 0) {
 929                dprintk(1, "memory allocation failed\n");
 930                return -ENOMEM;
 931        }
 932
 933        /*
 934         * There is no point in continuing if we can't allocate the minimum
 935         * number of buffers needed by this vb2_queue.
 936         */
 937        if (allocated_buffers < q->min_buffers_needed)
 938                ret = -ENOMEM;
 939
 940        /*
 941         * Check if driver can handle the allocated number of buffers.
 942         */
 943        if (!ret && allocated_buffers < num_buffers) {
 944                num_buffers = allocated_buffers;
 945
 946                ret = call_qop(q, queue_setup, q, NULL, &num_buffers,
 947                               &num_planes, q->plane_sizes, q->alloc_ctx);
 948
 949                if (!ret && allocated_buffers < num_buffers)
 950                        ret = -ENOMEM;
 951
 952                /*
 953                 * Either the driver has accepted a smaller number of buffers,
 954                 * or .queue_setup() returned an error
 955                 */
 956        }
 957
 958        q->num_buffers = allocated_buffers;
 959
 960        if (ret < 0) {
 961                /*
 962                 * Note: __vb2_queue_free() will subtract 'allocated_buffers'
 963                 * from q->num_buffers.
 964                 */
 965                __vb2_queue_free(q, allocated_buffers);
 966                return ret;
 967        }
 968
 969        /*
 970         * Return the number of successfully allocated buffers
 971         * to the userspace.
 972         */
 973        req->count = allocated_buffers;
 974        q->waiting_for_buffers = !V4L2_TYPE_IS_OUTPUT(q->type);
 975
 976        return 0;
 977}
 978
 979/**
 980 * vb2_reqbufs() - Wrapper for __reqbufs() that also verifies the memory and
 981 * type values.
 982 * @q:          videobuf2 queue
 983 * @req:        struct passed from userspace to vidioc_reqbufs handler in driver
 984 */
 985int vb2_reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req)
 986{
 987        int ret = __verify_memory_type(q, req->memory, req->type);
 988
 989        return ret ? ret : __reqbufs(q, req);
 990}
 991EXPORT_SYMBOL_GPL(vb2_reqbufs);
 992
 993/**
 994 * __create_bufs() - Allocate buffers and any required auxiliary structs
 995 * @q:          videobuf2 queue
 996 * @create:     creation parameters, passed from userspace to vidioc_create_bufs
 997 *              handler in driver
 998 *
 999 * Should be called from vidioc_create_bufs ioctl handler of a driver.
1000 * This function:
1001 * 1) verifies parameter sanity
1002 * 2) calls the .queue_setup() queue operation
1003 * 3) performs any necessary memory allocations
1004 *
1005 * The return values from this function are intended to be directly returned
1006 * from vidioc_create_bufs handler in driver.
1007 */
1008static int __create_bufs(struct vb2_queue *q, struct v4l2_create_buffers *create)
1009{
1010        unsigned int num_planes = 0, num_buffers, allocated_buffers;
1011        int ret;
1012
1013        if (q->num_buffers == VIDEO_MAX_FRAME) {
1014                dprintk(1, "maximum number of buffers already allocated\n");
1015                return -ENOBUFS;
1016        }
1017
1018        if (!q->num_buffers) {
1019                memset(q->plane_sizes, 0, sizeof(q->plane_sizes));
1020                memset(q->alloc_ctx, 0, sizeof(q->alloc_ctx));
1021                q->memory = create->memory;
1022                q->waiting_for_buffers = !V4L2_TYPE_IS_OUTPUT(q->type);
1023        }
1024
1025        num_buffers = min(create->count, VIDEO_MAX_FRAME - q->num_buffers);
1026
1027        /*
1028         * Ask the driver, whether the requested number of buffers, planes per
1029         * buffer and their sizes are acceptable
1030         */
1031        ret = call_qop(q, queue_setup, q, &create->format, &num_buffers,
1032                       &num_planes, q->plane_sizes, q->alloc_ctx);
1033        if (ret)
1034                return ret;
1035
1036        /* Finally, allocate buffers and video memory */
1037        allocated_buffers = __vb2_queue_alloc(q, create->memory, num_buffers,
1038                                num_planes);
1039        if (allocated_buffers == 0) {
1040                dprintk(1, "memory allocation failed\n");
1041                return -ENOMEM;
1042        }
1043
1044        /*
1045         * Check if driver can handle the so far allocated number of buffers.
1046         */
1047        if (allocated_buffers < num_buffers) {
1048                num_buffers = allocated_buffers;
1049
1050                /*
1051                 * q->num_buffers contains the total number of buffers, that the
1052                 * queue driver has set up
1053                 */
1054                ret = call_qop(q, queue_setup, q, &create->format, &num_buffers,
1055                               &num_planes, q->plane_sizes, q->alloc_ctx);
1056
1057                if (!ret && allocated_buffers < num_buffers)
1058                        ret = -ENOMEM;
1059
1060                /*
1061                 * Either the driver has accepted a smaller number of buffers,
1062                 * or .queue_setup() returned an error
1063                 */
1064        }
1065
1066        q->num_buffers += allocated_buffers;
1067
1068        if (ret < 0) {
1069                /*
1070                 * Note: __vb2_queue_free() will subtract 'allocated_buffers'
1071                 * from q->num_buffers.
1072                 */
1073                __vb2_queue_free(q, allocated_buffers);
1074                return -ENOMEM;
1075        }
1076
1077        /*
1078         * Return the number of successfully allocated buffers
1079         * to the userspace.
1080         */
1081        create->count = allocated_buffers;
1082
1083        return 0;
1084}
1085
1086/**
1087 * vb2_create_bufs() - Wrapper for __create_bufs() that also verifies the
1088 * memory and type values.
1089 * @q:          videobuf2 queue
1090 * @create:     creation parameters, passed from userspace to vidioc_create_bufs
1091 *              handler in driver
1092 */
1093int vb2_create_bufs(struct vb2_queue *q, struct v4l2_create_buffers *create)
1094{
1095        int ret = __verify_memory_type(q, create->memory, create->format.type);
1096
1097        create->index = q->num_buffers;
1098        if (create->count == 0)
1099                return ret != -EBUSY ? ret : 0;
1100        return ret ? ret : __create_bufs(q, create);
1101}
1102EXPORT_SYMBOL_GPL(vb2_create_bufs);
1103
1104/**
1105 * vb2_plane_vaddr() - Return a kernel virtual address of a given plane
1106 * @vb:         vb2_buffer to which the plane in question belongs to
1107 * @plane_no:   plane number for which the address is to be returned
1108 *
1109 * This function returns a kernel virtual address of a given plane if
1110 * such a mapping exist, NULL otherwise.
1111 */
1112void *vb2_plane_vaddr(struct vb2_buffer *vb, unsigned int plane_no)
1113{
1114        if (plane_no > vb->num_planes || !vb->planes[plane_no].mem_priv)
1115                return NULL;
1116
1117        return call_ptr_memop(vb, vaddr, vb->planes[plane_no].mem_priv);
1118
1119}
1120EXPORT_SYMBOL_GPL(vb2_plane_vaddr);
1121
1122/**
1123 * vb2_plane_cookie() - Return allocator specific cookie for the given plane
1124 * @vb:         vb2_buffer to which the plane in question belongs to
1125 * @plane_no:   plane number for which the cookie is to be returned
1126 *
1127 * This function returns an allocator specific cookie for a given plane if
1128 * available, NULL otherwise. The allocator should provide some simple static
1129 * inline function, which would convert this cookie to the allocator specific
1130 * type that can be used directly by the driver to access the buffer. This can
1131 * be for example physical address, pointer to scatter list or IOMMU mapping.
1132 */
1133void *vb2_plane_cookie(struct vb2_buffer *vb, unsigned int plane_no)
1134{
1135        if (plane_no >= vb->num_planes || !vb->planes[plane_no].mem_priv)
1136                return NULL;
1137
1138        return call_ptr_memop(vb, cookie, vb->planes[plane_no].mem_priv);
1139}
1140EXPORT_SYMBOL_GPL(vb2_plane_cookie);
1141
1142/**
1143 * vb2_buffer_done() - inform videobuf that an operation on a buffer is finished
1144 * @vb:         vb2_buffer returned from the driver
1145 * @state:      either VB2_BUF_STATE_DONE if the operation finished successfully
1146 *              or VB2_BUF_STATE_ERROR if the operation finished with an error.
1147 *              If start_streaming fails then it should return buffers with state
1148 *              VB2_BUF_STATE_QUEUED to put them back into the queue.
1149 *
1150 * This function should be called by the driver after a hardware operation on
1151 * a buffer is finished and the buffer may be returned to userspace. The driver
1152 * cannot use this buffer anymore until it is queued back to it by videobuf
1153 * by the means of buf_queue callback. Only buffers previously queued to the
1154 * driver by buf_queue can be passed to this function.
1155 *
1156 * While streaming a buffer can only be returned in state DONE or ERROR.
1157 * The start_streaming op can also return them in case the DMA engine cannot
1158 * be started for some reason. In that case the buffers should be returned with
1159 * state QUEUED.
1160 */
1161void vb2_buffer_done(struct vb2_buffer *vb, enum vb2_buffer_state state)
1162{
1163        struct vb2_queue *q = vb->vb2_queue;
1164        unsigned long flags;
1165        unsigned int plane;
1166
1167        if (WARN_ON(vb->state != VB2_BUF_STATE_ACTIVE))
1168                return;
1169
1170        if (WARN_ON(state != VB2_BUF_STATE_DONE &&
1171                    state != VB2_BUF_STATE_ERROR &&
1172                    state != VB2_BUF_STATE_QUEUED))
1173                state = VB2_BUF_STATE_ERROR;
1174
1175#ifdef CONFIG_VIDEO_ADV_DEBUG
1176        /*
1177         * Although this is not a callback, it still does have to balance
1178         * with the buf_queue op. So update this counter manually.
1179         */
1180        vb->cnt_buf_done++;
1181#endif
1182        dprintk(4, "done processing on buffer %d, state: %d\n",
1183                        vb->v4l2_buf.index, state);
1184
1185        /* sync buffers */
1186        for (plane = 0; plane < vb->num_planes; ++plane)
1187                call_void_memop(vb, finish, vb->planes[plane].mem_priv);
1188
1189        /* Add the buffer to the done buffers list */
1190        spin_lock_irqsave(&q->done_lock, flags);
1191        vb->state = state;
1192        if (state != VB2_BUF_STATE_QUEUED)
1193                list_add_tail(&vb->done_entry, &q->done_list);
1194        atomic_dec(&q->owned_by_drv_count);
1195        spin_unlock_irqrestore(&q->done_lock, flags);
1196
1197        if (state == VB2_BUF_STATE_QUEUED)
1198                return;
1199
1200        /* Inform any processes that may be waiting for buffers */
1201        wake_up(&q->done_wq);
1202}
1203EXPORT_SYMBOL_GPL(vb2_buffer_done);
1204
1205/**
1206 * vb2_discard_done() - discard all buffers marked as DONE
1207 * @q:          videobuf2 queue
1208 *
1209 * This function is intended to be used with suspend/resume operations. It
1210 * discards all 'done' buffers as they would be too old to be requested after
1211 * resume.
1212 *
1213 * Drivers must stop the hardware and synchronize with interrupt handlers and/or
1214 * delayed works before calling this function to make sure no buffer will be
1215 * touched by the driver and/or hardware.
1216 */
1217void vb2_discard_done(struct vb2_queue *q)
1218{
1219        struct vb2_buffer *vb;
1220        unsigned long flags;
1221
1222        spin_lock_irqsave(&q->done_lock, flags);
1223        list_for_each_entry(vb, &q->done_list, done_entry)
1224                vb->state = VB2_BUF_STATE_ERROR;
1225        spin_unlock_irqrestore(&q->done_lock, flags);
1226}
1227EXPORT_SYMBOL_GPL(vb2_discard_done);
1228
1229/**
1230 * __fill_vb2_buffer() - fill a vb2_buffer with information provided in a
1231 * v4l2_buffer by the userspace. The caller has already verified that struct
1232 * v4l2_buffer has a valid number of planes.
1233 */
1234static void __fill_vb2_buffer(struct vb2_buffer *vb, const struct v4l2_buffer *b,
1235                                struct v4l2_plane *v4l2_planes)
1236{
1237        unsigned int plane;
1238
1239        if (V4L2_TYPE_IS_MULTIPLANAR(b->type)) {
1240                if (b->memory == V4L2_MEMORY_USERPTR) {
1241                        for (plane = 0; plane < vb->num_planes; ++plane) {
1242                                v4l2_planes[plane].m.userptr =
1243                                        b->m.planes[plane].m.userptr;
1244                                v4l2_planes[plane].length =
1245                                        b->m.planes[plane].length;
1246                        }
1247                }
1248                if (b->memory == V4L2_MEMORY_DMABUF) {
1249                        for (plane = 0; plane < vb->num_planes; ++plane) {
1250                                v4l2_planes[plane].m.fd =
1251                                        b->m.planes[plane].m.fd;
1252                                v4l2_planes[plane].length =
1253                                        b->m.planes[plane].length;
1254                        }
1255                }
1256
1257                /* Fill in driver-provided information for OUTPUT types */
1258                if (V4L2_TYPE_IS_OUTPUT(b->type)) {
1259                        /*
1260                         * Will have to go up to b->length when API starts
1261                         * accepting variable number of planes.
1262                         *
1263                         * If bytesused == 0 for the output buffer, then fall
1264                         * back to the full buffer size. In that case
1265                         * userspace clearly never bothered to set it and
1266                         * it's a safe assumption that they really meant to
1267                         * use the full plane sizes.
1268                         */
1269                        for (plane = 0; plane < vb->num_planes; ++plane) {
1270                                struct v4l2_plane *pdst = &v4l2_planes[plane];
1271                                struct v4l2_plane *psrc = &b->m.planes[plane];
1272
1273                                pdst->bytesused = psrc->bytesused ?
1274                                        psrc->bytesused : pdst->length;
1275                                pdst->data_offset = psrc->data_offset;
1276                        }
1277                }
1278        } else {
1279                /*
1280                 * Single-planar buffers do not use planes array,
1281                 * so fill in relevant v4l2_buffer struct fields instead.
1282                 * In videobuf we use our internal V4l2_planes struct for
1283                 * single-planar buffers as well, for simplicity.
1284                 *
1285                 * If bytesused == 0 for the output buffer, then fall back
1286                 * to the full buffer size as that's a sensible default.
1287                 */
1288                if (b->memory == V4L2_MEMORY_USERPTR) {
1289                        v4l2_planes[0].m.userptr = b->m.userptr;
1290                        v4l2_planes[0].length = b->length;
1291                }
1292
1293                if (b->memory == V4L2_MEMORY_DMABUF) {
1294                        v4l2_planes[0].m.fd = b->m.fd;
1295                        v4l2_planes[0].length = b->length;
1296                }
1297
1298                if (V4L2_TYPE_IS_OUTPUT(b->type))
1299                        v4l2_planes[0].bytesused = b->bytesused ?
1300                                b->bytesused : v4l2_planes[0].length;
1301                else
1302                        v4l2_planes[0].bytesused = 0;
1303
1304        }
1305
1306        /* Zero flags that the vb2 core handles */
1307        vb->v4l2_buf.flags = b->flags & ~V4L2_BUFFER_MASK_FLAGS;
1308        if ((vb->vb2_queue->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) !=
1309            V4L2_BUF_FLAG_TIMESTAMP_COPY || !V4L2_TYPE_IS_OUTPUT(b->type)) {
1310                /*
1311                 * Non-COPY timestamps and non-OUTPUT queues will get
1312                 * their timestamp and timestamp source flags from the
1313                 * queue.
1314                 */
1315                vb->v4l2_buf.flags &= ~V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
1316        }
1317
1318        if (V4L2_TYPE_IS_OUTPUT(b->type)) {
1319                /*
1320                 * For output buffers mask out the timecode flag:
1321                 * this will be handled later in vb2_internal_qbuf().
1322                 * The 'field' is valid metadata for this output buffer
1323                 * and so that needs to be copied here.
1324                 */
1325                vb->v4l2_buf.flags &= ~V4L2_BUF_FLAG_TIMECODE;
1326                vb->v4l2_buf.field = b->field;
1327        } else {
1328                /* Zero any output buffer flags as this is a capture buffer */
1329                vb->v4l2_buf.flags &= ~V4L2_BUFFER_OUT_FLAGS;
1330        }
1331}
1332
1333/**
1334 * __qbuf_mmap() - handle qbuf of an MMAP buffer
1335 */
1336static int __qbuf_mmap(struct vb2_buffer *vb, const struct v4l2_buffer *b)
1337{
1338        __fill_vb2_buffer(vb, b, vb->v4l2_planes);
1339        return call_vb_qop(vb, buf_prepare, vb);
1340}
1341
1342/**
1343 * __qbuf_userptr() - handle qbuf of a USERPTR buffer
1344 */
1345static int __qbuf_userptr(struct vb2_buffer *vb, const struct v4l2_buffer *b)
1346{
1347        struct v4l2_plane planes[VIDEO_MAX_PLANES];
1348        struct vb2_queue *q = vb->vb2_queue;
1349        void *mem_priv;
1350        unsigned int plane;
1351        int ret;
1352        int write = !V4L2_TYPE_IS_OUTPUT(q->type);
1353        bool reacquired = vb->planes[0].mem_priv == NULL;
1354
1355        memset(planes, 0, sizeof(planes[0]) * vb->num_planes);
1356        /* Copy relevant information provided by the userspace */
1357        __fill_vb2_buffer(vb, b, planes);
1358
1359        for (plane = 0; plane < vb->num_planes; ++plane) {
1360                /* Skip the plane if already verified */
1361                if (vb->v4l2_planes[plane].m.userptr &&
1362                    vb->v4l2_planes[plane].m.userptr == planes[plane].m.userptr
1363                    && vb->v4l2_planes[plane].length == planes[plane].length)
1364                        continue;
1365
1366                dprintk(3, "userspace address for plane %d changed, "
1367                                "reacquiring memory\n", plane);
1368
1369                /* Check if the provided plane buffer is large enough */
1370                if (planes[plane].length < q->plane_sizes[plane]) {
1371                        dprintk(1, "provided buffer size %u is less than "
1372                                                "setup size %u for plane %d\n",
1373                                                planes[plane].length,
1374                                                q->plane_sizes[plane], plane);
1375                        ret = -EINVAL;
1376                        goto err;
1377                }
1378
1379                /* Release previously acquired memory if present */
1380                if (vb->planes[plane].mem_priv) {
1381                        if (!reacquired) {
1382                                reacquired = true;
1383                                call_void_vb_qop(vb, buf_cleanup, vb);
1384                        }
1385                        call_void_memop(vb, put_userptr, vb->planes[plane].mem_priv);
1386                }
1387
1388                vb->planes[plane].mem_priv = NULL;
1389                memset(&vb->v4l2_planes[plane], 0, sizeof(struct v4l2_plane));
1390
1391                /* Acquire each plane's memory */
1392                mem_priv = call_ptr_memop(vb, get_userptr, q->alloc_ctx[plane],
1393                                      planes[plane].m.userptr,
1394                                      planes[plane].length, write);
1395                if (IS_ERR_OR_NULL(mem_priv)) {
1396                        dprintk(1, "failed acquiring userspace "
1397                                                "memory for plane %d\n", plane);
1398                        ret = mem_priv ? PTR_ERR(mem_priv) : -EINVAL;
1399                        goto err;
1400                }
1401                vb->planes[plane].mem_priv = mem_priv;
1402        }
1403
1404        /*
1405         * Now that everything is in order, copy relevant information
1406         * provided by userspace.
1407         */
1408        for (plane = 0; plane < vb->num_planes; ++plane)
1409                vb->v4l2_planes[plane] = planes[plane];
1410
1411        if (reacquired) {
1412                /*
1413                 * One or more planes changed, so we must call buf_init to do
1414                 * the driver-specific initialization on the newly acquired
1415                 * buffer, if provided.
1416                 */
1417                ret = call_vb_qop(vb, buf_init, vb);
1418                if (ret) {
1419                        dprintk(1, "buffer initialization failed\n");
1420                        goto err;
1421                }
1422        }
1423
1424        ret = call_vb_qop(vb, buf_prepare, vb);
1425        if (ret) {
1426                dprintk(1, "buffer preparation failed\n");
1427                call_void_vb_qop(vb, buf_cleanup, vb);
1428                goto err;
1429        }
1430
1431        return 0;
1432err:
1433        /* In case of errors, release planes that were already acquired */
1434        for (plane = 0; plane < vb->num_planes; ++plane) {
1435                if (vb->planes[plane].mem_priv)
1436                        call_void_memop(vb, put_userptr, vb->planes[plane].mem_priv);
1437                vb->planes[plane].mem_priv = NULL;
1438                vb->v4l2_planes[plane].m.userptr = 0;
1439                vb->v4l2_planes[plane].length = 0;
1440        }
1441
1442        return ret;
1443}
1444
1445/**
1446 * __qbuf_dmabuf() - handle qbuf of a DMABUF buffer
1447 */
1448static int __qbuf_dmabuf(struct vb2_buffer *vb, const struct v4l2_buffer *b)
1449{
1450        struct v4l2_plane planes[VIDEO_MAX_PLANES];
1451        struct vb2_queue *q = vb->vb2_queue;
1452        void *mem_priv;
1453        unsigned int plane;
1454        int ret;
1455        int write = !V4L2_TYPE_IS_OUTPUT(q->type);
1456        bool reacquired = vb->planes[0].mem_priv == NULL;
1457
1458        memset(planes, 0, sizeof(planes[0]) * vb->num_planes);
1459        /* Copy relevant information provided by the userspace */
1460        __fill_vb2_buffer(vb, b, planes);
1461
1462        for (plane = 0; plane < vb->num_planes; ++plane) {
1463                struct dma_buf *dbuf = dma_buf_get(planes[plane].m.fd);
1464
1465                if (IS_ERR_OR_NULL(dbuf)) {
1466                        dprintk(1, "invalid dmabuf fd for plane %d\n",
1467                                plane);
1468                        ret = -EINVAL;
1469                        goto err;
1470                }
1471
1472                /* use DMABUF size if length is not provided */
1473                if (planes[plane].length == 0)
1474                        planes[plane].length = dbuf->size;
1475
1476                if (planes[plane].length < q->plane_sizes[plane]) {
1477                        dprintk(1, "invalid dmabuf length for plane %d\n",
1478                                plane);
1479                        ret = -EINVAL;
1480                        goto err;
1481                }
1482
1483                /* Skip the plane if already verified */
1484                if (dbuf == vb->planes[plane].dbuf &&
1485                    vb->v4l2_planes[plane].length == planes[plane].length) {
1486                        dma_buf_put(dbuf);
1487                        continue;
1488                }
1489
1490                dprintk(1, "buffer for plane %d changed\n", plane);
1491
1492                if (!reacquired) {
1493                        reacquired = true;
1494                        call_void_vb_qop(vb, buf_cleanup, vb);
1495                }
1496
1497                /* Release previously acquired memory if present */
1498                __vb2_plane_dmabuf_put(vb, &vb->planes[plane]);
1499                memset(&vb->v4l2_planes[plane], 0, sizeof(struct v4l2_plane));
1500
1501                /* Acquire each plane's memory */
1502                mem_priv = call_ptr_memop(vb, attach_dmabuf, q->alloc_ctx[plane],
1503                        dbuf, planes[plane].length, write);
1504                if (IS_ERR(mem_priv)) {
1505                        dprintk(1, "failed to attach dmabuf\n");
1506                        ret = PTR_ERR(mem_priv);
1507                        dma_buf_put(dbuf);
1508                        goto err;
1509                }
1510
1511                vb->planes[plane].dbuf = dbuf;
1512                vb->planes[plane].mem_priv = mem_priv;
1513        }
1514
1515        /* TODO: This pins the buffer(s) with  dma_buf_map_attachment()).. but
1516         * really we want to do this just before the DMA, not while queueing
1517         * the buffer(s)..
1518         */
1519        for (plane = 0; plane < vb->num_planes; ++plane) {
1520                ret = call_memop(vb, map_dmabuf, vb->planes[plane].mem_priv);
1521                if (ret) {
1522                        dprintk(1, "failed to map dmabuf for plane %d\n",
1523                                plane);
1524                        goto err;
1525                }
1526                vb->planes[plane].dbuf_mapped = 1;
1527        }
1528
1529        /*
1530         * Now that everything is in order, copy relevant information
1531         * provided by userspace.
1532         */
1533        for (plane = 0; plane < vb->num_planes; ++plane)
1534                vb->v4l2_planes[plane] = planes[plane];
1535
1536        if (reacquired) {
1537                /*
1538                 * Call driver-specific initialization on the newly acquired buffer,
1539                 * if provided.
1540                 */
1541                ret = call_vb_qop(vb, buf_init, vb);
1542                if (ret) {
1543                        dprintk(1, "buffer initialization failed\n");
1544                        goto err;
1545                }
1546        }
1547
1548        ret = call_vb_qop(vb, buf_prepare, vb);
1549        if (ret) {
1550                dprintk(1, "buffer preparation failed\n");
1551                call_void_vb_qop(vb, buf_cleanup, vb);
1552                goto err;
1553        }
1554
1555        return 0;
1556err:
1557        /* In case of errors, release planes that were already acquired */
1558        __vb2_buf_dmabuf_put(vb);
1559
1560        return ret;
1561}
1562
1563/**
1564 * __enqueue_in_driver() - enqueue a vb2_buffer in driver for processing
1565 */
1566static void __enqueue_in_driver(struct vb2_buffer *vb)
1567{
1568        struct vb2_queue *q = vb->vb2_queue;
1569        unsigned int plane;
1570
1571        vb->state = VB2_BUF_STATE_ACTIVE;
1572        atomic_inc(&q->owned_by_drv_count);
1573
1574        /* sync buffers */
1575        for (plane = 0; plane < vb->num_planes; ++plane)
1576                call_void_memop(vb, prepare, vb->planes[plane].mem_priv);
1577
1578        call_void_vb_qop(vb, buf_queue, vb);
1579}
1580
1581static int __buf_prepare(struct vb2_buffer *vb, const struct v4l2_buffer *b)
1582{
1583        struct vb2_queue *q = vb->vb2_queue;
1584        struct rw_semaphore *mmap_sem;
1585        int ret;
1586
1587        ret = __verify_length(vb, b);
1588        if (ret < 0) {
1589                dprintk(1, "plane parameters verification failed: %d\n", ret);
1590                return ret;
1591        }
1592        if (b->field == V4L2_FIELD_ALTERNATE && V4L2_TYPE_IS_OUTPUT(q->type)) {
1593                /*
1594                 * If the format's field is ALTERNATE, then the buffer's field
1595                 * should be either TOP or BOTTOM, not ALTERNATE since that
1596                 * makes no sense. The driver has to know whether the
1597                 * buffer represents a top or a bottom field in order to
1598                 * program any DMA correctly. Using ALTERNATE is wrong, since
1599                 * that just says that it is either a top or a bottom field,
1600                 * but not which of the two it is.
1601                 */
1602                dprintk(1, "the field is incorrectly set to ALTERNATE for an output buffer\n");
1603                return -EINVAL;
1604        }
1605
1606        if (q->error) {
1607                dprintk(1, "fatal error occurred on queue\n");
1608                return -EIO;
1609        }
1610
1611        vb->state = VB2_BUF_STATE_PREPARING;
1612        vb->v4l2_buf.timestamp.tv_sec = 0;
1613        vb->v4l2_buf.timestamp.tv_usec = 0;
1614        vb->v4l2_buf.sequence = 0;
1615
1616        switch (q->memory) {
1617        case V4L2_MEMORY_MMAP:
1618                ret = __qbuf_mmap(vb, b);
1619                break;
1620        case V4L2_MEMORY_USERPTR:
1621                /*
1622                 * In case of user pointer buffers vb2 allocators need to get
1623                 * direct access to userspace pages. This requires getting
1624                 * the mmap semaphore for read access in the current process
1625                 * structure. The same semaphore is taken before calling mmap
1626                 * operation, while both qbuf/prepare_buf and mmap are called
1627                 * by the driver or v4l2 core with the driver's lock held.
1628                 * To avoid an AB-BA deadlock (mmap_sem then driver's lock in
1629                 * mmap and driver's lock then mmap_sem in qbuf/prepare_buf),
1630                 * the videobuf2 core releases the driver's lock, takes
1631                 * mmap_sem and then takes the driver's lock again.
1632                 */
1633                mmap_sem = &current->mm->mmap_sem;
1634                call_void_qop(q, wait_prepare, q);
1635                down_read(mmap_sem);
1636                call_void_qop(q, wait_finish, q);
1637
1638                ret = __qbuf_userptr(vb, b);
1639
1640                up_read(mmap_sem);
1641                break;
1642        case V4L2_MEMORY_DMABUF:
1643                ret = __qbuf_dmabuf(vb, b);
1644                break;
1645        default:
1646                WARN(1, "Invalid queue type\n");
1647                ret = -EINVAL;
1648        }
1649
1650        if (ret)
1651                dprintk(1, "buffer preparation failed: %d\n", ret);
1652        vb->state = ret ? VB2_BUF_STATE_DEQUEUED : VB2_BUF_STATE_PREPARED;
1653
1654        return ret;
1655}
1656
1657static int vb2_queue_or_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b,
1658                                    const char *opname)
1659{
1660        if (b->type != q->type) {
1661                dprintk(1, "%s: invalid buffer type\n", opname);
1662                return -EINVAL;
1663        }
1664
1665        if (b->index >= q->num_buffers) {
1666                dprintk(1, "%s: buffer index out of range\n", opname);
1667                return -EINVAL;
1668        }
1669
1670        if (q->bufs[b->index] == NULL) {
1671                /* Should never happen */
1672                dprintk(1, "%s: buffer is NULL\n", opname);
1673                return -EINVAL;
1674        }
1675
1676        if (b->memory != q->memory) {
1677                dprintk(1, "%s: invalid memory type\n", opname);
1678                return -EINVAL;
1679        }
1680
1681        return __verify_planes_array(q->bufs[b->index], b);
1682}
1683
1684/**
1685 * vb2_prepare_buf() - Pass ownership of a buffer from userspace to the kernel
1686 * @q:          videobuf2 queue
1687 * @b:          buffer structure passed from userspace to vidioc_prepare_buf
1688 *              handler in driver
1689 *
1690 * Should be called from vidioc_prepare_buf ioctl handler of a driver.
1691 * This function:
1692 * 1) verifies the passed buffer,
1693 * 2) calls buf_prepare callback in the driver (if provided), in which
1694 *    driver-specific buffer initialization can be performed,
1695 *
1696 * The return values from this function are intended to be directly returned
1697 * from vidioc_prepare_buf handler in driver.
1698 */
1699int vb2_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b)
1700{
1701        struct vb2_buffer *vb;
1702        int ret;
1703
1704        if (vb2_fileio_is_active(q)) {
1705                dprintk(1, "file io in progress\n");
1706                return -EBUSY;
1707        }
1708
1709        ret = vb2_queue_or_prepare_buf(q, b, "prepare_buf");
1710        if (ret)
1711                return ret;
1712
1713        vb = q->bufs[b->index];
1714        if (vb->state != VB2_BUF_STATE_DEQUEUED) {
1715                dprintk(1, "invalid buffer state %d\n",
1716                        vb->state);
1717                return -EINVAL;
1718        }
1719
1720        ret = __buf_prepare(vb, b);
1721        if (!ret) {
1722                /* Fill buffer information for the userspace */
1723                __fill_v4l2_buffer(vb, b);
1724
1725                dprintk(1, "prepare of buffer %d succeeded\n", vb->v4l2_buf.index);
1726        }
1727        return ret;
1728}
1729EXPORT_SYMBOL_GPL(vb2_prepare_buf);
1730
1731/**
1732 * vb2_start_streaming() - Attempt to start streaming.
1733 * @q:          videobuf2 queue
1734 *
1735 * Attempt to start streaming. When this function is called there must be
1736 * at least q->min_buffers_needed buffers queued up (i.e. the minimum
1737 * number of buffers required for the DMA engine to function). If the
1738 * @start_streaming op fails it is supposed to return all the driver-owned
1739 * buffers back to vb2 in state QUEUED. Check if that happened and if
1740 * not warn and reclaim them forcefully.
1741 */
1742static int vb2_start_streaming(struct vb2_queue *q)
1743{
1744        struct vb2_buffer *vb;
1745        int ret;
1746
1747        /*
1748         * If any buffers were queued before streamon,
1749         * we can now pass them to driver for processing.
1750         */
1751        list_for_each_entry(vb, &q->queued_list, queued_entry)
1752                __enqueue_in_driver(vb);
1753
1754        /* Tell the driver to start streaming */
1755        q->start_streaming_called = 1;
1756        ret = call_qop(q, start_streaming, q,
1757                       atomic_read(&q->owned_by_drv_count));
1758        if (!ret)
1759                return 0;
1760
1761        q->start_streaming_called = 0;
1762
1763        dprintk(1, "driver refused to start streaming\n");
1764        /*
1765         * If you see this warning, then the driver isn't cleaning up properly
1766         * after a failed start_streaming(). See the start_streaming()
1767         * documentation in videobuf2-core.h for more information how buffers
1768         * should be returned to vb2 in start_streaming().
1769         */
1770        if (WARN_ON(atomic_read(&q->owned_by_drv_count))) {
1771                unsigned i;
1772
1773                /*
1774                 * Forcefully reclaim buffers if the driver did not
1775                 * correctly return them to vb2.
1776                 */
1777                for (i = 0; i < q->num_buffers; ++i) {
1778                        vb = q->bufs[i];
1779                        if (vb->state == VB2_BUF_STATE_ACTIVE)
1780                                vb2_buffer_done(vb, VB2_BUF_STATE_QUEUED);
1781                }
1782                /* Must be zero now */
1783                WARN_ON(atomic_read(&q->owned_by_drv_count));
1784        }
1785        /*
1786         * If done_list is not empty, then start_streaming() didn't call
1787         * vb2_buffer_done(vb, VB2_BUF_STATE_QUEUED) but STATE_ERROR or
1788         * STATE_DONE.
1789         */
1790        WARN_ON(!list_empty(&q->done_list));
1791        return ret;
1792}
1793
1794static int vb2_internal_qbuf(struct vb2_queue *q, struct v4l2_buffer *b)
1795{
1796        int ret = vb2_queue_or_prepare_buf(q, b, "qbuf");
1797        struct vb2_buffer *vb;
1798
1799        if (ret)
1800                return ret;
1801
1802        vb = q->bufs[b->index];
1803
1804        switch (vb->state) {
1805        case VB2_BUF_STATE_DEQUEUED:
1806                ret = __buf_prepare(vb, b);
1807                if (ret)
1808                        return ret;
1809                break;
1810        case VB2_BUF_STATE_PREPARED:
1811                break;
1812        case VB2_BUF_STATE_PREPARING:
1813                dprintk(1, "buffer still being prepared\n");
1814                return -EINVAL;
1815        default:
1816                dprintk(1, "invalid buffer state %d\n", vb->state);
1817                return -EINVAL;
1818        }
1819
1820        /*
1821         * Add to the queued buffers list, a buffer will stay on it until
1822         * dequeued in dqbuf.
1823         */
1824        list_add_tail(&vb->queued_entry, &q->queued_list);
1825        q->queued_count++;
1826        q->waiting_for_buffers = false;
1827        vb->state = VB2_BUF_STATE_QUEUED;
1828        if (V4L2_TYPE_IS_OUTPUT(q->type)) {
1829                /*
1830                 * For output buffers copy the timestamp if needed,
1831                 * and the timecode field and flag if needed.
1832                 */
1833                if ((q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
1834                    V4L2_BUF_FLAG_TIMESTAMP_COPY)
1835                        vb->v4l2_buf.timestamp = b->timestamp;
1836                vb->v4l2_buf.flags |= b->flags & V4L2_BUF_FLAG_TIMECODE;
1837                if (b->flags & V4L2_BUF_FLAG_TIMECODE)
1838                        vb->v4l2_buf.timecode = b->timecode;
1839        }
1840
1841        /*
1842         * If already streaming, give the buffer to driver for processing.
1843         * If not, the buffer will be given to driver on next streamon.
1844         */
1845        if (q->start_streaming_called)
1846                __enqueue_in_driver(vb);
1847
1848        /* Fill buffer information for the userspace */
1849        __fill_v4l2_buffer(vb, b);
1850
1851        /*
1852         * If streamon has been called, and we haven't yet called
1853         * start_streaming() since not enough buffers were queued, and
1854         * we now have reached the minimum number of queued buffers,
1855         * then we can finally call start_streaming().
1856         */
1857        if (q->streaming && !q->start_streaming_called &&
1858            q->queued_count >= q->min_buffers_needed) {
1859                ret = vb2_start_streaming(q);
1860                if (ret)
1861                        return ret;
1862        }
1863
1864        dprintk(1, "qbuf of buffer %d succeeded\n", vb->v4l2_buf.index);
1865        return 0;
1866}
1867
1868/**
1869 * vb2_qbuf() - Queue a buffer from userspace
1870 * @q:          videobuf2 queue
1871 * @b:          buffer structure passed from userspace to vidioc_qbuf handler
1872 *              in driver
1873 *
1874 * Should be called from vidioc_qbuf ioctl handler of a driver.
1875 * This function:
1876 * 1) verifies the passed buffer,
1877 * 2) if necessary, calls buf_prepare callback in the driver (if provided), in
1878 *    which driver-specific buffer initialization can be performed,
1879 * 3) if streaming is on, queues the buffer in driver by the means of buf_queue
1880 *    callback for processing.
1881 *
1882 * The return values from this function are intended to be directly returned
1883 * from vidioc_qbuf handler in driver.
1884 */
1885int vb2_qbuf(struct vb2_queue *q, struct v4l2_buffer *b)
1886{
1887        if (vb2_fileio_is_active(q)) {
1888                dprintk(1, "file io in progress\n");
1889                return -EBUSY;
1890        }
1891
1892        return vb2_internal_qbuf(q, b);
1893}
1894EXPORT_SYMBOL_GPL(vb2_qbuf);
1895
1896/**
1897 * __vb2_wait_for_done_vb() - wait for a buffer to become available
1898 * for dequeuing
1899 *
1900 * Will sleep if required for nonblocking == false.
1901 */
1902static int __vb2_wait_for_done_vb(struct vb2_queue *q, int nonblocking)
1903{
1904        /*
1905         * All operations on vb_done_list are performed under done_lock
1906         * spinlock protection. However, buffers may be removed from
1907         * it and returned to userspace only while holding both driver's
1908         * lock and the done_lock spinlock. Thus we can be sure that as
1909         * long as we hold the driver's lock, the list will remain not
1910         * empty if list_empty() check succeeds.
1911         */
1912
1913        for (;;) {
1914                int ret;
1915
1916                if (!q->streaming) {
1917                        dprintk(1, "streaming off, will not wait for buffers\n");
1918                        return -EINVAL;
1919                }
1920
1921                if (q->error) {
1922                        dprintk(1, "Queue in error state, will not wait for buffers\n");
1923                        return -EIO;
1924                }
1925
1926                if (!list_empty(&q->done_list)) {
1927                        /*
1928                         * Found a buffer that we were waiting for.
1929                         */
1930                        break;
1931                }
1932
1933                if (nonblocking) {
1934                        dprintk(1, "nonblocking and no buffers to dequeue, "
1935                                                                "will not wait\n");
1936                        return -EAGAIN;
1937                }
1938
1939                /*
1940                 * We are streaming and blocking, wait for another buffer to
1941                 * become ready or for streamoff. Driver's lock is released to
1942                 * allow streamoff or qbuf to be called while waiting.
1943                 */
1944                call_void_qop(q, wait_prepare, q);
1945
1946                /*
1947                 * All locks have been released, it is safe to sleep now.
1948                 */
1949                dprintk(3, "will sleep waiting for buffers\n");
1950                ret = wait_event_interruptible(q->done_wq,
1951                                !list_empty(&q->done_list) || !q->streaming ||
1952                                q->error);
1953
1954                /*
1955                 * We need to reevaluate both conditions again after reacquiring
1956                 * the locks or return an error if one occurred.
1957                 */
1958                call_void_qop(q, wait_finish, q);
1959                if (ret) {
1960                        dprintk(1, "sleep was interrupted\n");
1961                        return ret;
1962                }
1963        }
1964        return 0;
1965}
1966
1967/**
1968 * __vb2_get_done_vb() - get a buffer ready for dequeuing
1969 *
1970 * Will sleep if required for nonblocking == false.
1971 */
1972static int __vb2_get_done_vb(struct vb2_queue *q, struct vb2_buffer **vb,
1973                                struct v4l2_buffer *b, int nonblocking)
1974{
1975        unsigned long flags;
1976        int ret;
1977
1978        /*
1979         * Wait for at least one buffer to become available on the done_list.
1980         */
1981        ret = __vb2_wait_for_done_vb(q, nonblocking);
1982        if (ret)
1983                return ret;
1984
1985        /*
1986         * Driver's lock has been held since we last verified that done_list
1987         * is not empty, so no need for another list_empty(done_list) check.
1988         */
1989        spin_lock_irqsave(&q->done_lock, flags);
1990        *vb = list_first_entry(&q->done_list, struct vb2_buffer, done_entry);
1991        /*
1992         * Only remove the buffer from done_list if v4l2_buffer can handle all
1993         * the planes.
1994         */
1995        ret = __verify_planes_array(*vb, b);
1996        if (!ret)
1997                list_del(&(*vb)->done_entry);
1998        spin_unlock_irqrestore(&q->done_lock, flags);
1999
2000        return ret;
2001}
2002
2003/**
2004 * vb2_wait_for_all_buffers() - wait until all buffers are given back to vb2
2005 * @q:          videobuf2 queue
2006 *
2007 * This function will wait until all buffers that have been given to the driver
2008 * by buf_queue() are given back to vb2 with vb2_buffer_done(). It doesn't call
2009 * wait_prepare, wait_finish pair. It is intended to be called with all locks
2010 * taken, for example from stop_streaming() callback.
2011 */
2012int vb2_wait_for_all_buffers(struct vb2_queue *q)
2013{
2014        if (!q->streaming) {
2015                dprintk(1, "streaming off, will not wait for buffers\n");
2016                return -EINVAL;
2017        }
2018
2019        if (q->start_streaming_called)
2020                wait_event(q->done_wq, !atomic_read(&q->owned_by_drv_count));
2021        return 0;
2022}
2023EXPORT_SYMBOL_GPL(vb2_wait_for_all_buffers);
2024
2025/**
2026 * __vb2_dqbuf() - bring back the buffer to the DEQUEUED state
2027 */
2028static void __vb2_dqbuf(struct vb2_buffer *vb)
2029{
2030        struct vb2_queue *q = vb->vb2_queue;
2031        unsigned int i;
2032
2033        /* nothing to do if the buffer is already dequeued */
2034        if (vb->state == VB2_BUF_STATE_DEQUEUED)
2035                return;
2036
2037        vb->state = VB2_BUF_STATE_DEQUEUED;
2038
2039        /* unmap DMABUF buffer */
2040        if (q->memory == V4L2_MEMORY_DMABUF)
2041                for (i = 0; i < vb->num_planes; ++i) {
2042                        if (!vb->planes[i].dbuf_mapped)
2043                                continue;
2044                        call_void_memop(vb, unmap_dmabuf, vb->planes[i].mem_priv);
2045                        vb->planes[i].dbuf_mapped = 0;
2046                }
2047}
2048
2049static int vb2_internal_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking)
2050{
2051        struct vb2_buffer *vb = NULL;
2052        int ret;
2053
2054        if (b->type != q->type) {
2055                dprintk(1, "invalid buffer type\n");
2056                return -EINVAL;
2057        }
2058        ret = __vb2_get_done_vb(q, &vb, b, nonblocking);
2059        if (ret < 0)
2060                return ret;
2061
2062        switch (vb->state) {
2063        case VB2_BUF_STATE_DONE:
2064                dprintk(3, "returning done buffer\n");
2065                break;
2066        case VB2_BUF_STATE_ERROR:
2067                dprintk(3, "returning done buffer with errors\n");
2068                break;
2069        default:
2070                dprintk(1, "invalid buffer state\n");
2071                return -EINVAL;
2072        }
2073
2074        call_void_vb_qop(vb, buf_finish, vb);
2075
2076        /* Fill buffer information for the userspace */
2077        __fill_v4l2_buffer(vb, b);
2078        /* Remove from videobuf queue */
2079        list_del(&vb->queued_entry);
2080        q->queued_count--;
2081        /* go back to dequeued state */
2082        __vb2_dqbuf(vb);
2083
2084        dprintk(1, "dqbuf of buffer %d, with state %d\n",
2085                        vb->v4l2_buf.index, vb->state);
2086
2087        return 0;
2088}
2089
2090/**
2091 * vb2_dqbuf() - Dequeue a buffer to the userspace
2092 * @q:          videobuf2 queue
2093 * @b:          buffer structure passed from userspace to vidioc_dqbuf handler
2094 *              in driver
2095 * @nonblocking: if true, this call will not sleep waiting for a buffer if no
2096 *               buffers ready for dequeuing are present. Normally the driver
2097 *               would be passing (file->f_flags & O_NONBLOCK) here
2098 *
2099 * Should be called from vidioc_dqbuf ioctl handler of a driver.
2100 * This function:
2101 * 1) verifies the passed buffer,
2102 * 2) calls buf_finish callback in the driver (if provided), in which
2103 *    driver can perform any additional operations that may be required before
2104 *    returning the buffer to userspace, such as cache sync,
2105 * 3) the buffer struct members are filled with relevant information for
2106 *    the userspace.
2107 *
2108 * The return values from this function are intended to be directly returned
2109 * from vidioc_dqbuf handler in driver.
2110 */
2111int vb2_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking)
2112{
2113        if (vb2_fileio_is_active(q)) {
2114                dprintk(1, "file io in progress\n");
2115                return -EBUSY;
2116        }
2117        return vb2_internal_dqbuf(q, b, nonblocking);
2118}
2119EXPORT_SYMBOL_GPL(vb2_dqbuf);
2120
2121/**
2122 * __vb2_queue_cancel() - cancel and stop (pause) streaming
2123 *
2124 * Removes all queued buffers from driver's queue and all buffers queued by
2125 * userspace from videobuf's queue. Returns to state after reqbufs.
2126 */
2127static void __vb2_queue_cancel(struct vb2_queue *q)
2128{
2129        unsigned int i;
2130
2131        /*
2132         * Tell driver to stop all transactions and release all queued
2133         * buffers.
2134         */
2135        if (q->start_streaming_called)
2136                call_void_qop(q, stop_streaming, q);
2137
2138        /*
2139         * If you see this warning, then the driver isn't cleaning up properly
2140         * in stop_streaming(). See the stop_streaming() documentation in
2141         * videobuf2-core.h for more information how buffers should be returned
2142         * to vb2 in stop_streaming().
2143         */
2144        if (WARN_ON(atomic_read(&q->owned_by_drv_count))) {
2145                for (i = 0; i < q->num_buffers; ++i)
2146                        if (q->bufs[i]->state == VB2_BUF_STATE_ACTIVE)
2147                                vb2_buffer_done(q->bufs[i], VB2_BUF_STATE_ERROR);
2148                /* Must be zero now */
2149                WARN_ON(atomic_read(&q->owned_by_drv_count));
2150        }
2151
2152        q->streaming = 0;
2153        q->start_streaming_called = 0;
2154        q->queued_count = 0;
2155        q->error = 0;
2156
2157        /*
2158         * Remove all buffers from videobuf's list...
2159         */
2160        INIT_LIST_HEAD(&q->queued_list);
2161        /*
2162         * ...and done list; userspace will not receive any buffers it
2163         * has not already dequeued before initiating cancel.
2164         */
2165        INIT_LIST_HEAD(&q->done_list);
2166        atomic_set(&q->owned_by_drv_count, 0);
2167        wake_up_all(&q->done_wq);
2168
2169        /*
2170         * Reinitialize all buffers for next use.
2171         * Make sure to call buf_finish for any queued buffers. Normally
2172         * that's done in dqbuf, but that's not going to happen when we
2173         * cancel the whole queue. Note: this code belongs here, not in
2174         * __vb2_dqbuf() since in vb2_internal_dqbuf() there is a critical
2175         * call to __fill_v4l2_buffer() after buf_finish(). That order can't
2176         * be changed, so we can't move the buf_finish() to __vb2_dqbuf().
2177         */
2178        for (i = 0; i < q->num_buffers; ++i) {
2179                struct vb2_buffer *vb = q->bufs[i];
2180
2181                if (vb->state != VB2_BUF_STATE_DEQUEUED) {
2182                        vb->state = VB2_BUF_STATE_PREPARED;
2183                        call_void_vb_qop(vb, buf_finish, vb);
2184                }
2185                __vb2_dqbuf(vb);
2186        }
2187}
2188
2189static int vb2_internal_streamon(struct vb2_queue *q, enum v4l2_buf_type type)
2190{
2191        int ret;
2192
2193        if (type != q->type) {
2194                dprintk(1, "invalid stream type\n");
2195                return -EINVAL;
2196        }
2197
2198        if (q->streaming) {
2199                dprintk(3, "already streaming\n");
2200                return 0;
2201        }
2202
2203        if (!q->num_buffers) {
2204                dprintk(1, "no buffers have been allocated\n");
2205                return -EINVAL;
2206        }
2207
2208        if (q->num_buffers < q->min_buffers_needed) {
2209                dprintk(1, "need at least %u allocated buffers\n",
2210                                q->min_buffers_needed);
2211                return -EINVAL;
2212        }
2213
2214        /*
2215         * Tell driver to start streaming provided sufficient buffers
2216         * are available.
2217         */
2218        if (q->queued_count >= q->min_buffers_needed) {
2219                ret = vb2_start_streaming(q);
2220                if (ret) {
2221                        __vb2_queue_cancel(q);
2222                        return ret;
2223                }
2224        }
2225
2226        q->streaming = 1;
2227
2228        dprintk(3, "successful\n");
2229        return 0;
2230}
2231
2232/**
2233 * vb2_queue_error() - signal a fatal error on the queue
2234 * @q:          videobuf2 queue
2235 *
2236 * Flag that a fatal unrecoverable error has occurred and wake up all processes
2237 * waiting on the queue. Polling will now set POLLERR and queuing and dequeuing
2238 * buffers will return -EIO.
2239 *
2240 * The error flag will be cleared when cancelling the queue, either from
2241 * vb2_streamoff or vb2_queue_release. Drivers should thus not call this
2242 * function before starting the stream, otherwise the error flag will remain set
2243 * until the queue is released when closing the device node.
2244 */
2245void vb2_queue_error(struct vb2_queue *q)
2246{
2247        q->error = 1;
2248
2249        wake_up_all(&q->done_wq);
2250}
2251EXPORT_SYMBOL_GPL(vb2_queue_error);
2252
2253/**
2254 * vb2_streamon - start streaming
2255 * @q:          videobuf2 queue
2256 * @type:       type argument passed from userspace to vidioc_streamon handler
2257 *
2258 * Should be called from vidioc_streamon handler of a driver.
2259 * This function:
2260 * 1) verifies current state
2261 * 2) passes any previously queued buffers to the driver and starts streaming
2262 *
2263 * The return values from this function are intended to be directly returned
2264 * from vidioc_streamon handler in the driver.
2265 */
2266int vb2_streamon(struct vb2_queue *q, enum v4l2_buf_type type)
2267{
2268        if (vb2_fileio_is_active(q)) {
2269                dprintk(1, "file io in progress\n");
2270                return -EBUSY;
2271        }
2272        return vb2_internal_streamon(q, type);
2273}
2274EXPORT_SYMBOL_GPL(vb2_streamon);
2275
2276static int vb2_internal_streamoff(struct vb2_queue *q, enum v4l2_buf_type type)
2277{
2278        if (type != q->type) {
2279                dprintk(1, "invalid stream type\n");
2280                return -EINVAL;
2281        }
2282
2283        /*
2284         * Cancel will pause streaming and remove all buffers from the driver
2285         * and videobuf, effectively returning control over them to userspace.
2286         *
2287         * Note that we do this even if q->streaming == 0: if you prepare or
2288         * queue buffers, and then call streamoff without ever having called
2289         * streamon, you would still expect those buffers to be returned to
2290         * their normal dequeued state.
2291         */
2292        __vb2_queue_cancel(q);
2293        q->waiting_for_buffers = !V4L2_TYPE_IS_OUTPUT(q->type);
2294
2295        dprintk(3, "successful\n");
2296        return 0;
2297}
2298
2299/**
2300 * vb2_streamoff - stop streaming
2301 * @q:          videobuf2 queue
2302 * @type:       type argument passed from userspace to vidioc_streamoff handler
2303 *
2304 * Should be called from vidioc_streamoff handler of a driver.
2305 * This function:
2306 * 1) verifies current state,
2307 * 2) stop streaming and dequeues any queued buffers, including those previously
2308 *    passed to the driver (after waiting for the driver to finish).
2309 *
2310 * This call can be used for pausing playback.
2311 * The return values from this function are intended to be directly returned
2312 * from vidioc_streamoff handler in the driver
2313 */
2314int vb2_streamoff(struct vb2_queue *q, enum v4l2_buf_type type)
2315{
2316        if (vb2_fileio_is_active(q)) {
2317                dprintk(1, "file io in progress\n");
2318                return -EBUSY;
2319        }
2320        return vb2_internal_streamoff(q, type);
2321}
2322EXPORT_SYMBOL_GPL(vb2_streamoff);
2323
2324/**
2325 * __find_plane_by_offset() - find plane associated with the given offset off
2326 */
2327static int __find_plane_by_offset(struct vb2_queue *q, unsigned long off,
2328                        unsigned int *_buffer, unsigned int *_plane)
2329{
2330        struct vb2_buffer *vb;
2331        unsigned int buffer, plane;
2332
2333        /*
2334         * Go over all buffers and their planes, comparing the given offset
2335         * with an offset assigned to each plane. If a match is found,
2336         * return its buffer and plane numbers.
2337         */
2338        for (buffer = 0; buffer < q->num_buffers; ++buffer) {
2339                vb = q->bufs[buffer];
2340
2341                for (plane = 0; plane < vb->num_planes; ++plane) {
2342                        if (vb->v4l2_planes[plane].m.mem_offset == off) {
2343                                *_buffer = buffer;
2344                                *_plane = plane;
2345                                return 0;
2346                        }
2347                }
2348        }
2349
2350        return -EINVAL;
2351}
2352
2353/**
2354 * vb2_expbuf() - Export a buffer as a file descriptor
2355 * @q:          videobuf2 queue
2356 * @eb:         export buffer structure passed from userspace to vidioc_expbuf
2357 *              handler in driver
2358 *
2359 * The return values from this function are intended to be directly returned
2360 * from vidioc_expbuf handler in driver.
2361 */
2362int vb2_expbuf(struct vb2_queue *q, struct v4l2_exportbuffer *eb)
2363{
2364        struct vb2_buffer *vb = NULL;
2365        struct vb2_plane *vb_plane;
2366        int ret;
2367        struct dma_buf *dbuf;
2368
2369        if (q->memory != V4L2_MEMORY_MMAP) {
2370                dprintk(1, "queue is not currently set up for mmap\n");
2371                return -EINVAL;
2372        }
2373
2374        if (!q->mem_ops->get_dmabuf) {
2375                dprintk(1, "queue does not support DMA buffer exporting\n");
2376                return -EINVAL;
2377        }
2378
2379        if (eb->flags & ~(O_CLOEXEC | O_ACCMODE)) {
2380                dprintk(1, "queue does support only O_CLOEXEC and access mode flags\n");
2381                return -EINVAL;
2382        }
2383
2384        if (eb->type != q->type) {
2385                dprintk(1, "invalid buffer type\n");
2386                return -EINVAL;
2387        }
2388
2389        if (eb->index >= q->num_buffers) {
2390                dprintk(1, "buffer index out of range\n");
2391                return -EINVAL;
2392        }
2393
2394        vb = q->bufs[eb->index];
2395
2396        if (eb->plane >= vb->num_planes) {
2397                dprintk(1, "buffer plane out of range\n");
2398                return -EINVAL;
2399        }
2400
2401        if (vb2_fileio_is_active(q)) {
2402                dprintk(1, "expbuf: file io in progress\n");
2403                return -EBUSY;
2404        }
2405
2406        vb_plane = &vb->planes[eb->plane];
2407
2408        dbuf = call_ptr_memop(vb, get_dmabuf, vb_plane->mem_priv, eb->flags & O_ACCMODE);
2409        if (IS_ERR_OR_NULL(dbuf)) {
2410                dprintk(1, "failed to export buffer %d, plane %d\n",
2411                        eb->index, eb->plane);
2412                return -EINVAL;
2413        }
2414
2415        ret = dma_buf_fd(dbuf, eb->flags & ~O_ACCMODE);
2416        if (ret < 0) {
2417                dprintk(3, "buffer %d, plane %d failed to export (%d)\n",
2418                        eb->index, eb->plane, ret);
2419                dma_buf_put(dbuf);
2420                return ret;
2421        }
2422
2423        dprintk(3, "buffer %d, plane %d exported as %d descriptor\n",
2424                eb->index, eb->plane, ret);
2425        eb->fd = ret;
2426
2427        return 0;
2428}
2429EXPORT_SYMBOL_GPL(vb2_expbuf);
2430
2431/**
2432 * vb2_mmap() - map video buffers into application address space
2433 * @q:          videobuf2 queue
2434 * @vma:        vma passed to the mmap file operation handler in the driver
2435 *
2436 * Should be called from mmap file operation handler of a driver.
2437 * This function maps one plane of one of the available video buffers to
2438 * userspace. To map whole video memory allocated on reqbufs, this function
2439 * has to be called once per each plane per each buffer previously allocated.
2440 *
2441 * When the userspace application calls mmap, it passes to it an offset returned
2442 * to it earlier by the means of vidioc_querybuf handler. That offset acts as
2443 * a "cookie", which is then used to identify the plane to be mapped.
2444 * This function finds a plane with a matching offset and a mapping is performed
2445 * by the means of a provided memory operation.
2446 *
2447 * The return values from this function are intended to be directly returned
2448 * from the mmap handler in driver.
2449 */
2450int vb2_mmap(struct vb2_queue *q, struct vm_area_struct *vma)
2451{
2452        unsigned long off = vma->vm_pgoff << PAGE_SHIFT;
2453        struct vb2_buffer *vb;
2454        unsigned int buffer = 0, plane = 0;
2455        int ret;
2456        unsigned long length;
2457
2458        if (q->memory != V4L2_MEMORY_MMAP) {
2459                dprintk(1, "queue is not currently set up for mmap\n");
2460                return -EINVAL;
2461        }
2462
2463        /*
2464         * Check memory area access mode.
2465         */
2466        if (!(vma->vm_flags & VM_SHARED)) {
2467                dprintk(1, "invalid vma flags, VM_SHARED needed\n");
2468                return -EINVAL;
2469        }
2470        if (V4L2_TYPE_IS_OUTPUT(q->type)) {
2471                if (!(vma->vm_flags & VM_WRITE)) {
2472                        dprintk(1, "invalid vma flags, VM_WRITE needed\n");
2473                        return -EINVAL;
2474                }
2475        } else {
2476                if (!(vma->vm_flags & VM_READ)) {
2477                        dprintk(1, "invalid vma flags, VM_READ needed\n");
2478                        return -EINVAL;
2479                }
2480        }
2481        if (vb2_fileio_is_active(q)) {
2482                dprintk(1, "mmap: file io in progress\n");
2483                return -EBUSY;
2484        }
2485
2486        /*
2487         * Find the plane corresponding to the offset passed by userspace.
2488         */
2489        ret = __find_plane_by_offset(q, off, &buffer, &plane);
2490        if (ret)
2491                return ret;
2492
2493        vb = q->bufs[buffer];
2494
2495        /*
2496         * MMAP requires page_aligned buffers.
2497         * The buffer length was page_aligned at __vb2_buf_mem_alloc(),
2498         * so, we need to do the same here.
2499         */
2500        length = PAGE_ALIGN(vb->v4l2_planes[plane].length);
2501        if (length < (vma->vm_end - vma->vm_start)) {
2502                dprintk(1,
2503                        "MMAP invalid, as it would overflow buffer length\n");
2504                return -EINVAL;
2505        }
2506
2507        ret = call_memop(vb, mmap, vb->planes[plane].mem_priv, vma);
2508        if (ret)
2509                return ret;
2510
2511        dprintk(3, "buffer %d, plane %d successfully mapped\n", buffer, plane);
2512        return 0;
2513}
2514EXPORT_SYMBOL_GPL(vb2_mmap);
2515
2516#ifndef CONFIG_MMU
2517unsigned long vb2_get_unmapped_area(struct vb2_queue *q,
2518                                    unsigned long addr,
2519                                    unsigned long len,
2520                                    unsigned long pgoff,
2521                                    unsigned long flags)
2522{
2523        unsigned long off = pgoff << PAGE_SHIFT;
2524        struct vb2_buffer *vb;
2525        unsigned int buffer, plane;
2526        int ret;
2527
2528        if (q->memory != V4L2_MEMORY_MMAP) {
2529                dprintk(1, "queue is not currently set up for mmap\n");
2530                return -EINVAL;
2531        }
2532
2533        /*
2534         * Find the plane corresponding to the offset passed by userspace.
2535         */
2536        ret = __find_plane_by_offset(q, off, &buffer, &plane);
2537        if (ret)
2538                return ret;
2539
2540        vb = q->bufs[buffer];
2541
2542        return (unsigned long)vb2_plane_vaddr(vb, plane);
2543}
2544EXPORT_SYMBOL_GPL(vb2_get_unmapped_area);
2545#endif
2546
2547static int __vb2_init_fileio(struct vb2_queue *q, int read);
2548static int __vb2_cleanup_fileio(struct vb2_queue *q);
2549
2550/**
2551 * vb2_poll() - implements poll userspace operation
2552 * @q:          videobuf2 queue
2553 * @file:       file argument passed to the poll file operation handler
2554 * @wait:       wait argument passed to the poll file operation handler
2555 *
2556 * This function implements poll file operation handler for a driver.
2557 * For CAPTURE queues, if a buffer is ready to be dequeued, the userspace will
2558 * be informed that the file descriptor of a video device is available for
2559 * reading.
2560 * For OUTPUT queues, if a buffer is ready to be dequeued, the file descriptor
2561 * will be reported as available for writing.
2562 *
2563 * If the driver uses struct v4l2_fh, then vb2_poll() will also check for any
2564 * pending events.
2565 *
2566 * The return values from this function are intended to be directly returned
2567 * from poll handler in driver.
2568 */
2569unsigned int vb2_poll(struct vb2_queue *q, struct file *file, poll_table *wait)
2570{
2571        struct video_device *vfd = video_devdata(file);
2572        unsigned long req_events = poll_requested_events(wait);
2573        struct vb2_buffer *vb = NULL;
2574        unsigned int res = 0;
2575        unsigned long flags;
2576
2577        if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags)) {
2578                struct v4l2_fh *fh = file->private_data;
2579
2580                if (v4l2_event_pending(fh))
2581                        res = POLLPRI;
2582                else if (req_events & POLLPRI)
2583                        poll_wait(file, &fh->wait, wait);
2584        }
2585
2586        if (!V4L2_TYPE_IS_OUTPUT(q->type) && !(req_events & (POLLIN | POLLRDNORM)))
2587                return res;
2588        if (V4L2_TYPE_IS_OUTPUT(q->type) && !(req_events & (POLLOUT | POLLWRNORM)))
2589                return res;
2590
2591        /*
2592         * Start file I/O emulator only if streaming API has not been used yet.
2593         */
2594        if (q->num_buffers == 0 && !vb2_fileio_is_active(q)) {
2595                if (!V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_READ) &&
2596                                (req_events & (POLLIN | POLLRDNORM))) {
2597                        if (__vb2_init_fileio(q, 1))
2598                                return res | POLLERR;
2599                }
2600                if (V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_WRITE) &&
2601                                (req_events & (POLLOUT | POLLWRNORM))) {
2602                        if (__vb2_init_fileio(q, 0))
2603                                return res | POLLERR;
2604                        /*
2605                         * Write to OUTPUT queue can be done immediately.
2606                         */
2607                        return res | POLLOUT | POLLWRNORM;
2608                }
2609        }
2610
2611        /*
2612         * There is nothing to wait for if the queue isn't streaming, or if the
2613         * error flag is set.
2614         */
2615        if (!vb2_is_streaming(q) || q->error)
2616                return res | POLLERR;
2617        /*
2618         * For compatibility with vb1: if QBUF hasn't been called yet, then
2619         * return POLLERR as well. This only affects capture queues, output
2620         * queues will always initialize waiting_for_buffers to false.
2621         */
2622        if (q->waiting_for_buffers)
2623                return res | POLLERR;
2624
2625        /*
2626         * For output streams you can write as long as there are fewer buffers
2627         * queued than there are buffers available.
2628         */
2629        if (V4L2_TYPE_IS_OUTPUT(q->type) && q->queued_count < q->num_buffers)
2630                return res | POLLOUT | POLLWRNORM;
2631
2632        if (list_empty(&q->done_list))
2633                poll_wait(file, &q->done_wq, wait);
2634
2635        /*
2636         * Take first buffer available for dequeuing.
2637         */
2638        spin_lock_irqsave(&q->done_lock, flags);
2639        if (!list_empty(&q->done_list))
2640                vb = list_first_entry(&q->done_list, struct vb2_buffer,
2641                                        done_entry);
2642        spin_unlock_irqrestore(&q->done_lock, flags);
2643
2644        if (vb && (vb->state == VB2_BUF_STATE_DONE
2645                        || vb->state == VB2_BUF_STATE_ERROR)) {
2646                return (V4L2_TYPE_IS_OUTPUT(q->type)) ?
2647                                res | POLLOUT | POLLWRNORM :
2648                                res | POLLIN | POLLRDNORM;
2649        }
2650        return res;
2651}
2652EXPORT_SYMBOL_GPL(vb2_poll);
2653
2654/**
2655 * vb2_queue_init() - initialize a videobuf2 queue
2656 * @q:          videobuf2 queue; this structure should be allocated in driver
2657 *
2658 * The vb2_queue structure should be allocated by the driver. The driver is
2659 * responsible of clearing it's content and setting initial values for some
2660 * required entries before calling this function.
2661 * q->ops, q->mem_ops, q->type and q->io_modes are mandatory. Please refer
2662 * to the struct vb2_queue description in include/media/videobuf2-core.h
2663 * for more information.
2664 */
2665int vb2_queue_init(struct vb2_queue *q)
2666{
2667        /*
2668         * Sanity check
2669         */
2670        if (WARN_ON(!q)                   ||
2671            WARN_ON(!q->ops)              ||
2672            WARN_ON(!q->mem_ops)          ||
2673            WARN_ON(!q->type)             ||
2674            WARN_ON(!q->io_modes)         ||
2675            WARN_ON(!q->ops->queue_setup) ||
2676            WARN_ON(!q->ops->buf_queue)   ||
2677            WARN_ON(q->timestamp_flags &
2678                    ~(V4L2_BUF_FLAG_TIMESTAMP_MASK |
2679                      V4L2_BUF_FLAG_TSTAMP_SRC_MASK)))
2680                return -EINVAL;
2681
2682        /* Warn that the driver should choose an appropriate timestamp type */
2683        WARN_ON((q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
2684                V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN);
2685
2686        INIT_LIST_HEAD(&q->queued_list);
2687        INIT_LIST_HEAD(&q->done_list);
2688        spin_lock_init(&q->done_lock);
2689        init_waitqueue_head(&q->done_wq);
2690
2691        if (q->buf_struct_size == 0)
2692                q->buf_struct_size = sizeof(struct vb2_buffer);
2693
2694        return 0;
2695}
2696EXPORT_SYMBOL_GPL(vb2_queue_init);
2697
2698/**
2699 * vb2_queue_release() - stop streaming, release the queue and free memory
2700 * @q:          videobuf2 queue
2701 *
2702 * This function stops streaming and performs necessary clean ups, including
2703 * freeing video buffer memory. The driver is responsible for freeing
2704 * the vb2_queue structure itself.
2705 */
2706void vb2_queue_release(struct vb2_queue *q)
2707{
2708        __vb2_cleanup_fileio(q);
2709        __vb2_queue_cancel(q);
2710        __vb2_queue_free(q, q->num_buffers);
2711}
2712EXPORT_SYMBOL_GPL(vb2_queue_release);
2713
2714/**
2715 * struct vb2_fileio_buf - buffer context used by file io emulator
2716 *
2717 * vb2 provides a compatibility layer and emulator of file io (read and
2718 * write) calls on top of streaming API. This structure is used for
2719 * tracking context related to the buffers.
2720 */
2721struct vb2_fileio_buf {
2722        void *vaddr;
2723        unsigned int size;
2724        unsigned int pos;
2725        unsigned int queued:1;
2726};
2727
2728/**
2729 * struct vb2_fileio_data - queue context used by file io emulator
2730 *
2731 * @cur_index:  the index of the buffer currently being read from or
2732 *              written to. If equal to q->num_buffers then a new buffer
2733 *              must be dequeued.
2734 * @initial_index: in the read() case all buffers are queued up immediately
2735 *              in __vb2_init_fileio() and __vb2_perform_fileio() just cycles
2736 *              buffers. However, in the write() case no buffers are initially
2737 *              queued, instead whenever a buffer is full it is queued up by
2738 *              __vb2_perform_fileio(). Only once all available buffers have
2739 *              been queued up will __vb2_perform_fileio() start to dequeue
2740 *              buffers. This means that initially __vb2_perform_fileio()
2741 *              needs to know what buffer index to use when it is queuing up
2742 *              the buffers for the first time. That initial index is stored
2743 *              in this field. Once it is equal to q->num_buffers all
2744 *              available buffers have been queued and __vb2_perform_fileio()
2745 *              should start the normal dequeue/queue cycle.
2746 *
2747 * vb2 provides a compatibility layer and emulator of file io (read and
2748 * write) calls on top of streaming API. For proper operation it required
2749 * this structure to save the driver state between each call of the read
2750 * or write function.
2751 */
2752struct vb2_fileio_data {
2753        struct v4l2_requestbuffers req;
2754        struct v4l2_plane p;
2755        struct v4l2_buffer b;
2756        struct vb2_fileio_buf bufs[VIDEO_MAX_FRAME];
2757        unsigned int cur_index;
2758        unsigned int initial_index;
2759        unsigned int q_count;
2760        unsigned int dq_count;
2761        unsigned int flags;
2762};
2763
2764/**
2765 * __vb2_init_fileio() - initialize file io emulator
2766 * @q:          videobuf2 queue
2767 * @read:       mode selector (1 means read, 0 means write)
2768 */
2769static int __vb2_init_fileio(struct vb2_queue *q, int read)
2770{
2771        struct vb2_fileio_data *fileio;
2772        int i, ret;
2773        unsigned int count = 0;
2774
2775        /*
2776         * Sanity check
2777         */
2778        if (WARN_ON((read && !(q->io_modes & VB2_READ)) ||
2779                    (!read && !(q->io_modes & VB2_WRITE))))
2780                return -EINVAL;
2781
2782        /*
2783         * Check if device supports mapping buffers to kernel virtual space.
2784         */
2785        if (!q->mem_ops->vaddr)
2786                return -EBUSY;
2787
2788        /*
2789         * Check if streaming api has not been already activated.
2790         */
2791        if (q->streaming || q->num_buffers > 0)
2792                return -EBUSY;
2793
2794        /*
2795         * Start with count 1, driver can increase it in queue_setup()
2796         */
2797        count = 1;
2798
2799        dprintk(3, "setting up file io: mode %s, count %d, flags %08x\n",
2800                (read) ? "read" : "write", count, q->io_flags);
2801
2802        fileio = kzalloc(sizeof(struct vb2_fileio_data), GFP_KERNEL);
2803        if (fileio == NULL)
2804                return -ENOMEM;
2805
2806        fileio->flags = q->io_flags;
2807
2808        /*
2809         * Request buffers and use MMAP type to force driver
2810         * to allocate buffers by itself.
2811         */
2812        fileio->req.count = count;
2813        fileio->req.memory = V4L2_MEMORY_MMAP;
2814        fileio->req.type = q->type;
2815        q->fileio = fileio;
2816        ret = __reqbufs(q, &fileio->req);
2817        if (ret)
2818                goto err_kfree;
2819
2820        /*
2821         * Check if plane_count is correct
2822         * (multiplane buffers are not supported).
2823         */
2824        if (q->bufs[0]->num_planes != 1) {
2825                ret = -EBUSY;
2826                goto err_reqbufs;
2827        }
2828
2829        /*
2830         * Get kernel address of each buffer.
2831         */
2832        for (i = 0; i < q->num_buffers; i++) {
2833                fileio->bufs[i].vaddr = vb2_plane_vaddr(q->bufs[i], 0);
2834                if (fileio->bufs[i].vaddr == NULL) {
2835                        ret = -EINVAL;
2836                        goto err_reqbufs;
2837                }
2838                fileio->bufs[i].size = vb2_plane_size(q->bufs[i], 0);
2839        }
2840
2841        /*
2842         * Read mode requires pre queuing of all buffers.
2843         */
2844        if (read) {
2845                bool is_multiplanar = V4L2_TYPE_IS_MULTIPLANAR(q->type);
2846
2847                /*
2848                 * Queue all buffers.
2849                 */
2850                for (i = 0; i < q->num_buffers; i++) {
2851                        struct v4l2_buffer *b = &fileio->b;
2852
2853                        memset(b, 0, sizeof(*b));
2854                        b->type = q->type;
2855                        if (is_multiplanar) {
2856                                memset(&fileio->p, 0, sizeof(fileio->p));
2857                                b->m.planes = &fileio->p;
2858                                b->length = 1;
2859                        }
2860                        b->memory = q->memory;
2861                        b->index = i;
2862                        ret = vb2_internal_qbuf(q, b);
2863                        if (ret)
2864                                goto err_reqbufs;
2865                        fileio->bufs[i].queued = 1;
2866                }
2867                /*
2868                 * All buffers have been queued, so mark that by setting
2869                 * initial_index to q->num_buffers
2870                 */
2871                fileio->initial_index = q->num_buffers;
2872                fileio->cur_index = q->num_buffers;
2873        }
2874
2875        /*
2876         * Start streaming.
2877         */
2878        ret = vb2_internal_streamon(q, q->type);
2879        if (ret)
2880                goto err_reqbufs;
2881
2882        return ret;
2883
2884err_reqbufs:
2885        fileio->req.count = 0;
2886        __reqbufs(q, &fileio->req);
2887
2888err_kfree:
2889        q->fileio = NULL;
2890        kfree(fileio);
2891        return ret;
2892}
2893
2894/**
2895 * __vb2_cleanup_fileio() - free resourced used by file io emulator
2896 * @q:          videobuf2 queue
2897 */
2898static int __vb2_cleanup_fileio(struct vb2_queue *q)
2899{
2900        struct vb2_fileio_data *fileio = q->fileio;
2901
2902        if (fileio) {
2903                vb2_internal_streamoff(q, q->type);
2904                q->fileio = NULL;
2905                fileio->req.count = 0;
2906                vb2_reqbufs(q, &fileio->req);
2907                kfree(fileio);
2908                dprintk(3, "file io emulator closed\n");
2909        }
2910        return 0;
2911}
2912
2913/**
2914 * __vb2_perform_fileio() - perform a single file io (read or write) operation
2915 * @q:          videobuf2 queue
2916 * @data:       pointed to target userspace buffer
2917 * @count:      number of bytes to read or write
2918 * @ppos:       file handle position tracking pointer
2919 * @nonblock:   mode selector (1 means blocking calls, 0 means nonblocking)
2920 * @read:       access mode selector (1 means read, 0 means write)
2921 */
2922static size_t __vb2_perform_fileio(struct vb2_queue *q, char __user *data, size_t count,
2923                loff_t *ppos, int nonblock, int read)
2924{
2925        struct vb2_fileio_data *fileio;
2926        struct vb2_fileio_buf *buf;
2927        bool is_multiplanar = V4L2_TYPE_IS_MULTIPLANAR(q->type);
2928        /*
2929         * When using write() to write data to an output video node the vb2 core
2930         * should set timestamps if V4L2_BUF_FLAG_TIMESTAMP_COPY is set. Nobody
2931         * else is able to provide this information with the write() operation.
2932         */
2933        bool set_timestamp = !read &&
2934                (q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
2935                V4L2_BUF_FLAG_TIMESTAMP_COPY;
2936        int ret, index;
2937
2938        dprintk(3, "mode %s, offset %ld, count %zd, %sblocking\n",
2939                read ? "read" : "write", (long)*ppos, count,
2940                nonblock ? "non" : "");
2941
2942        if (!data)
2943                return -EINVAL;
2944
2945        /*
2946         * Initialize emulator on first call.
2947         */
2948        if (!vb2_fileio_is_active(q)) {
2949                ret = __vb2_init_fileio(q, read);
2950                dprintk(3, "vb2_init_fileio result: %d\n", ret);
2951                if (ret)
2952                        return ret;
2953        }
2954        fileio = q->fileio;
2955
2956        /*
2957         * Check if we need to dequeue the buffer.
2958         */
2959        index = fileio->cur_index;
2960        if (index >= q->num_buffers) {
2961                /*
2962                 * Call vb2_dqbuf to get buffer back.
2963                 */
2964                memset(&fileio->b, 0, sizeof(fileio->b));
2965                fileio->b.type = q->type;
2966                fileio->b.memory = q->memory;
2967                if (is_multiplanar) {
2968                        memset(&fileio->p, 0, sizeof(fileio->p));
2969                        fileio->b.m.planes = &fileio->p;
2970                        fileio->b.length = 1;
2971                }
2972                ret = vb2_internal_dqbuf(q, &fileio->b, nonblock);
2973                dprintk(5, "vb2_dqbuf result: %d\n", ret);
2974                if (ret)
2975                        return ret;
2976                fileio->dq_count += 1;
2977
2978                fileio->cur_index = index = fileio->b.index;
2979                buf = &fileio->bufs[index];
2980
2981                /*
2982                 * Get number of bytes filled by the driver
2983                 */
2984                buf->pos = 0;
2985                buf->queued = 0;
2986                buf->size = read ? vb2_get_plane_payload(q->bufs[index], 0)
2987                                 : vb2_plane_size(q->bufs[index], 0);
2988        } else {
2989                buf = &fileio->bufs[index];
2990        }
2991
2992        /*
2993         * Limit count on last few bytes of the buffer.
2994         */
2995        if (buf->pos + count > buf->size) {
2996                count = buf->size - buf->pos;
2997                dprintk(5, "reducing read count: %zd\n", count);
2998        }
2999
3000        /*
3001         * Transfer data to userspace.
3002         */
3003        dprintk(3, "copying %zd bytes - buffer %d, offset %u\n",
3004                count, index, buf->pos);
3005        if (read)
3006                ret = copy_to_user(data, buf->vaddr + buf->pos, count);
3007        else
3008                ret = copy_from_user(buf->vaddr + buf->pos, data, count);
3009        if (ret) {
3010                dprintk(3, "error copying data\n");
3011                return -EFAULT;
3012        }
3013
3014        /*
3015         * Update counters.
3016         */
3017        buf->pos += count;
3018        *ppos += count;
3019
3020        /*
3021         * Queue next buffer if required.
3022         */
3023        if (buf->pos == buf->size ||
3024           (!read && (fileio->flags & VB2_FILEIO_WRITE_IMMEDIATELY))) {
3025                /*
3026                 * Check if this is the last buffer to read.
3027                 */
3028                if (read && (fileio->flags & VB2_FILEIO_READ_ONCE) &&
3029                    fileio->dq_count == 1) {
3030                        dprintk(3, "read limit reached\n");
3031                        return __vb2_cleanup_fileio(q);
3032                }
3033
3034                /*
3035                 * Call vb2_qbuf and give buffer to the driver.
3036                 */
3037                memset(&fileio->b, 0, sizeof(fileio->b));
3038                fileio->b.type = q->type;
3039                fileio->b.memory = q->memory;
3040                fileio->b.index = index;
3041                fileio->b.bytesused = buf->pos;
3042                if (is_multiplanar) {
3043                        memset(&fileio->p, 0, sizeof(fileio->p));
3044                        fileio->p.bytesused = buf->pos;
3045                        fileio->b.m.planes = &fileio->p;
3046                        fileio->b.length = 1;
3047                }
3048                if (set_timestamp)
3049                        v4l2_get_timestamp(&fileio->b.timestamp);
3050                ret = vb2_internal_qbuf(q, &fileio->b);
3051                dprintk(5, "vb2_dbuf result: %d\n", ret);
3052                if (ret)
3053                        return ret;
3054
3055                /*
3056                 * Buffer has been queued, update the status
3057                 */
3058                buf->pos = 0;
3059                buf->queued = 1;
3060                buf->size = vb2_plane_size(q->bufs[index], 0);
3061                fileio->q_count += 1;
3062                /*
3063                 * If we are queuing up buffers for the first time, then
3064                 * increase initial_index by one.
3065                 */
3066                if (fileio->initial_index < q->num_buffers)
3067                        fileio->initial_index++;
3068                /*
3069                 * The next buffer to use is either a buffer that's going to be
3070                 * queued for the first time (initial_index < q->num_buffers)
3071                 * or it is equal to q->num_buffers, meaning that the next
3072                 * time we need to dequeue a buffer since we've now queued up
3073                 * all the 'first time' buffers.
3074                 */
3075                fileio->cur_index = fileio->initial_index;
3076        }
3077
3078        /*
3079         * Return proper number of bytes processed.
3080         */
3081        if (ret == 0)
3082                ret = count;
3083        return ret;
3084}
3085
3086size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count,
3087                loff_t *ppos, int nonblocking)
3088{
3089        return __vb2_perform_fileio(q, data, count, ppos, nonblocking, 1);
3090}
3091EXPORT_SYMBOL_GPL(vb2_read);
3092
3093size_t vb2_write(struct vb2_queue *q, const char __user *data, size_t count,
3094                loff_t *ppos, int nonblocking)
3095{
3096        return __vb2_perform_fileio(q, (char __user *) data, count,
3097                                                        ppos, nonblocking, 0);
3098}
3099EXPORT_SYMBOL_GPL(vb2_write);
3100
3101struct vb2_threadio_data {
3102        struct task_struct *thread;
3103        vb2_thread_fnc fnc;
3104        void *priv;
3105        bool stop;
3106};
3107
3108static int vb2_thread(void *data)
3109{
3110        struct vb2_queue *q = data;
3111        struct vb2_threadio_data *threadio = q->threadio;
3112        struct vb2_fileio_data *fileio = q->fileio;
3113        bool set_timestamp = false;
3114        int prequeue = 0;
3115        int index = 0;
3116        int ret = 0;
3117
3118        if (V4L2_TYPE_IS_OUTPUT(q->type)) {
3119                prequeue = q->num_buffers;
3120                set_timestamp =
3121                        (q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
3122                        V4L2_BUF_FLAG_TIMESTAMP_COPY;
3123        }
3124
3125        set_freezable();
3126
3127        for (;;) {
3128                struct vb2_buffer *vb;
3129
3130                /*
3131                 * Call vb2_dqbuf to get buffer back.
3132                 */
3133                memset(&fileio->b, 0, sizeof(fileio->b));
3134                fileio->b.type = q->type;
3135                fileio->b.memory = q->memory;
3136                if (prequeue) {
3137                        fileio->b.index = index++;
3138                        prequeue--;
3139                } else {
3140                        call_void_qop(q, wait_finish, q);
3141                        ret = vb2_internal_dqbuf(q, &fileio->b, 0);
3142                        call_void_qop(q, wait_prepare, q);
3143                        dprintk(5, "file io: vb2_dqbuf result: %d\n", ret);
3144                }
3145                if (threadio->stop)
3146                        break;
3147                if (ret)
3148                        break;
3149                try_to_freeze();
3150
3151                vb = q->bufs[fileio->b.index];
3152                if (!(fileio->b.flags & V4L2_BUF_FLAG_ERROR))
3153                        ret = threadio->fnc(vb, threadio->priv);
3154                if (ret)
3155                        break;
3156                call_void_qop(q, wait_finish, q);
3157                if (set_timestamp)
3158                        v4l2_get_timestamp(&fileio->b.timestamp);
3159                ret = vb2_internal_qbuf(q, &fileio->b);
3160                call_void_qop(q, wait_prepare, q);
3161                if (ret)
3162                        break;
3163        }
3164
3165        /* Hmm, linux becomes *very* unhappy without this ... */
3166        while (!kthread_should_stop()) {
3167                set_current_state(TASK_INTERRUPTIBLE);
3168                schedule();
3169        }
3170        return 0;
3171}
3172
3173/*
3174 * This function should not be used for anything else but the videobuf2-dvb
3175 * support. If you think you have another good use-case for this, then please
3176 * contact the linux-media mailinglist first.
3177 */
3178int vb2_thread_start(struct vb2_queue *q, vb2_thread_fnc fnc, void *priv,
3179                     const char *thread_name)
3180{
3181        struct vb2_threadio_data *threadio;
3182        int ret = 0;
3183
3184        if (q->threadio)
3185                return -EBUSY;
3186        if (vb2_is_busy(q))
3187                return -EBUSY;
3188        if (WARN_ON(q->fileio))
3189                return -EBUSY;
3190
3191        threadio = kzalloc(sizeof(*threadio), GFP_KERNEL);
3192        if (threadio == NULL)
3193                return -ENOMEM;
3194        threadio->fnc = fnc;
3195        threadio->priv = priv;
3196
3197        ret = __vb2_init_fileio(q, !V4L2_TYPE_IS_OUTPUT(q->type));
3198        dprintk(3, "file io: vb2_init_fileio result: %d\n", ret);
3199        if (ret)
3200                goto nomem;
3201        q->threadio = threadio;
3202        threadio->thread = kthread_run(vb2_thread, q, "vb2-%s", thread_name);
3203        if (IS_ERR(threadio->thread)) {
3204                ret = PTR_ERR(threadio->thread);
3205                threadio->thread = NULL;
3206                goto nothread;
3207        }
3208        return 0;
3209
3210nothread:
3211        __vb2_cleanup_fileio(q);
3212nomem:
3213        kfree(threadio);
3214        return ret;
3215}
3216EXPORT_SYMBOL_GPL(vb2_thread_start);
3217
3218int vb2_thread_stop(struct vb2_queue *q)
3219{
3220        struct vb2_threadio_data *threadio = q->threadio;
3221        struct vb2_fileio_data *fileio = q->fileio;
3222        int err;
3223
3224        if (threadio == NULL)
3225                return 0;
3226        call_void_qop(q, wait_finish, q);
3227        threadio->stop = true;
3228        vb2_internal_streamoff(q, q->type);
3229        call_void_qop(q, wait_prepare, q);
3230        q->fileio = NULL;
3231        fileio->req.count = 0;
3232        vb2_reqbufs(q, &fileio->req);
3233        kfree(fileio);
3234        err = kthread_stop(threadio->thread);
3235        threadio->thread = NULL;
3236        kfree(threadio);
3237        q->fileio = NULL;
3238        q->threadio = NULL;
3239        return err;
3240}
3241EXPORT_SYMBOL_GPL(vb2_thread_stop);
3242
3243/*
3244 * The following functions are not part of the vb2 core API, but are helper
3245 * functions that plug into struct v4l2_ioctl_ops, struct v4l2_file_operations
3246 * and struct vb2_ops.
3247 * They contain boilerplate code that most if not all drivers have to do
3248 * and so they simplify the driver code.
3249 */
3250
3251/* The queue is busy if there is a owner and you are not that owner. */
3252static inline bool vb2_queue_is_busy(struct video_device *vdev, struct file *file)
3253{
3254        return vdev->queue->owner && vdev->queue->owner != file->private_data;
3255}
3256
3257/* vb2 ioctl helpers */
3258
3259int vb2_ioctl_reqbufs(struct file *file, void *priv,
3260                          struct v4l2_requestbuffers *p)
3261{
3262        struct video_device *vdev = video_devdata(file);
3263        int res = __verify_memory_type(vdev->queue, p->memory, p->type);
3264
3265        if (res)
3266                return res;
3267        if (vb2_queue_is_busy(vdev, file))
3268                return -EBUSY;
3269        res = __reqbufs(vdev->queue, p);
3270        /* If count == 0, then the owner has released all buffers and he
3271           is no longer owner of the queue. Otherwise we have a new owner. */
3272        if (res == 0)
3273                vdev->queue->owner = p->count ? file->private_data : NULL;
3274        return res;
3275}
3276EXPORT_SYMBOL_GPL(vb2_ioctl_reqbufs);
3277
3278int vb2_ioctl_create_bufs(struct file *file, void *priv,
3279                          struct v4l2_create_buffers *p)
3280{
3281        struct video_device *vdev = video_devdata(file);
3282        int res = __verify_memory_type(vdev->queue, p->memory, p->format.type);
3283
3284        p->index = vdev->queue->num_buffers;
3285        /* If count == 0, then just check if memory and type are valid.
3286           Any -EBUSY result from __verify_memory_type can be mapped to 0. */
3287        if (p->count == 0)
3288                return res != -EBUSY ? res : 0;
3289        if (res)
3290                return res;
3291        if (vb2_queue_is_busy(vdev, file))
3292                return -EBUSY;
3293        res = __create_bufs(vdev->queue, p);
3294        if (res == 0)
3295                vdev->queue->owner = file->private_data;
3296        return res;
3297}
3298EXPORT_SYMBOL_GPL(vb2_ioctl_create_bufs);
3299
3300int vb2_ioctl_prepare_buf(struct file *file, void *priv,
3301                          struct v4l2_buffer *p)
3302{
3303        struct video_device *vdev = video_devdata(file);
3304
3305        if (vb2_queue_is_busy(vdev, file))
3306                return -EBUSY;
3307        return vb2_prepare_buf(vdev->queue, p);
3308}
3309EXPORT_SYMBOL_GPL(vb2_ioctl_prepare_buf);
3310
3311int vb2_ioctl_querybuf(struct file *file, void *priv, struct v4l2_buffer *p)
3312{
3313        struct video_device *vdev = video_devdata(file);
3314
3315        /* No need to call vb2_queue_is_busy(), anyone can query buffers. */
3316        return vb2_querybuf(vdev->queue, p);
3317}
3318EXPORT_SYMBOL_GPL(vb2_ioctl_querybuf);
3319
3320int vb2_ioctl_qbuf(struct file *file, void *priv, struct v4l2_buffer *p)
3321{
3322        struct video_device *vdev = video_devdata(file);
3323
3324        if (vb2_queue_is_busy(vdev, file))
3325                return -EBUSY;
3326        return vb2_qbuf(vdev->queue, p);
3327}
3328EXPORT_SYMBOL_GPL(vb2_ioctl_qbuf);
3329
3330int vb2_ioctl_dqbuf(struct file *file, void *priv, struct v4l2_buffer *p)
3331{
3332        struct video_device *vdev = video_devdata(file);
3333
3334        if (vb2_queue_is_busy(vdev, file))
3335                return -EBUSY;
3336        return vb2_dqbuf(vdev->queue, p, file->f_flags & O_NONBLOCK);
3337}
3338EXPORT_SYMBOL_GPL(vb2_ioctl_dqbuf);
3339
3340int vb2_ioctl_streamon(struct file *file, void *priv, enum v4l2_buf_type i)
3341{
3342        struct video_device *vdev = video_devdata(file);
3343
3344        if (vb2_queue_is_busy(vdev, file))
3345                return -EBUSY;
3346        return vb2_streamon(vdev->queue, i);
3347}
3348EXPORT_SYMBOL_GPL(vb2_ioctl_streamon);
3349
3350int vb2_ioctl_streamoff(struct file *file, void *priv, enum v4l2_buf_type i)
3351{
3352        struct video_device *vdev = video_devdata(file);
3353
3354        if (vb2_queue_is_busy(vdev, file))
3355                return -EBUSY;
3356        return vb2_streamoff(vdev->queue, i);
3357}
3358EXPORT_SYMBOL_GPL(vb2_ioctl_streamoff);
3359
3360int vb2_ioctl_expbuf(struct file *file, void *priv, struct v4l2_exportbuffer *p)
3361{
3362        struct video_device *vdev = video_devdata(file);
3363
3364        if (vb2_queue_is_busy(vdev, file))
3365                return -EBUSY;
3366        return vb2_expbuf(vdev->queue, p);
3367}
3368EXPORT_SYMBOL_GPL(vb2_ioctl_expbuf);
3369
3370/* v4l2_file_operations helpers */
3371
3372int vb2_fop_mmap(struct file *file, struct vm_area_struct *vma)
3373{
3374        struct video_device *vdev = video_devdata(file);
3375        struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
3376        int err;
3377
3378        if (lock && mutex_lock_interruptible(lock))
3379                return -ERESTARTSYS;
3380        err = vb2_mmap(vdev->queue, vma);
3381        if (lock)
3382                mutex_unlock(lock);
3383        return err;
3384}
3385EXPORT_SYMBOL_GPL(vb2_fop_mmap);
3386
3387int _vb2_fop_release(struct file *file, struct mutex *lock)
3388{
3389        struct video_device *vdev = video_devdata(file);
3390
3391        if (file->private_data == vdev->queue->owner) {
3392                if (lock)
3393                        mutex_lock(lock);
3394                vb2_queue_release(vdev->queue);
3395                vdev->queue->owner = NULL;
3396                if (lock)
3397                        mutex_unlock(lock);
3398        }
3399        return v4l2_fh_release(file);
3400}
3401EXPORT_SYMBOL_GPL(_vb2_fop_release);
3402
3403int vb2_fop_release(struct file *file)
3404{
3405        struct video_device *vdev = video_devdata(file);
3406        struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
3407
3408        return _vb2_fop_release(file, lock);
3409}
3410EXPORT_SYMBOL_GPL(vb2_fop_release);
3411
3412ssize_t vb2_fop_write(struct file *file, const char __user *buf,
3413                size_t count, loff_t *ppos)
3414{
3415        struct video_device *vdev = video_devdata(file);
3416        struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
3417        int err = -EBUSY;
3418
3419        if (lock && mutex_lock_interruptible(lock))
3420                return -ERESTARTSYS;
3421        if (vb2_queue_is_busy(vdev, file))
3422                goto exit;
3423        err = vb2_write(vdev->queue, buf, count, ppos,
3424                       file->f_flags & O_NONBLOCK);
3425        if (vdev->queue->fileio)
3426                vdev->queue->owner = file->private_data;
3427exit:
3428        if (lock)
3429                mutex_unlock(lock);
3430        return err;
3431}
3432EXPORT_SYMBOL_GPL(vb2_fop_write);
3433
3434ssize_t vb2_fop_read(struct file *file, char __user *buf,
3435                size_t count, loff_t *ppos)
3436{
3437        struct video_device *vdev = video_devdata(file);
3438        struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
3439        int err = -EBUSY;
3440
3441        if (lock && mutex_lock_interruptible(lock))
3442                return -ERESTARTSYS;
3443        if (vb2_queue_is_busy(vdev, file))
3444                goto exit;
3445        err = vb2_read(vdev->queue, buf, count, ppos,
3446                       file->f_flags & O_NONBLOCK);
3447        if (vdev->queue->fileio)
3448                vdev->queue->owner = file->private_data;
3449exit:
3450        if (lock)
3451                mutex_unlock(lock);
3452        return err;
3453}
3454EXPORT_SYMBOL_GPL(vb2_fop_read);
3455
3456unsigned int vb2_fop_poll(struct file *file, poll_table *wait)
3457{
3458        struct video_device *vdev = video_devdata(file);
3459        struct vb2_queue *q = vdev->queue;
3460        struct mutex *lock = q->lock ? q->lock : vdev->lock;
3461        unsigned long req_events = poll_requested_events(wait);
3462        unsigned res;
3463        void *fileio;
3464        bool must_lock = false;
3465
3466        /* Try to be smart: only lock if polling might start fileio,
3467           otherwise locking will only introduce unwanted delays. */
3468        if (q->num_buffers == 0 && !vb2_fileio_is_active(q)) {
3469                if (!V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_READ) &&
3470                                (req_events & (POLLIN | POLLRDNORM)))
3471                        must_lock = true;
3472                else if (V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_WRITE) &&
3473                                (req_events & (POLLOUT | POLLWRNORM)))
3474                        must_lock = true;
3475        }
3476
3477        /* If locking is needed, but this helper doesn't know how, then you
3478           shouldn't be using this helper but you should write your own. */
3479        WARN_ON(must_lock && !lock);
3480
3481        if (must_lock && lock && mutex_lock_interruptible(lock))
3482                return POLLERR;
3483
3484        fileio = q->fileio;
3485
3486        res = vb2_poll(vdev->queue, file, wait);
3487
3488        /* If fileio was started, then we have a new queue owner. */
3489        if (must_lock && !fileio && q->fileio)
3490                q->owner = file->private_data;
3491        if (must_lock && lock)
3492                mutex_unlock(lock);
3493        return res;
3494}
3495EXPORT_SYMBOL_GPL(vb2_fop_poll);
3496
3497#ifndef CONFIG_MMU
3498unsigned long vb2_fop_get_unmapped_area(struct file *file, unsigned long addr,
3499                unsigned long len, unsigned long pgoff, unsigned long flags)
3500{
3501        struct video_device *vdev = video_devdata(file);
3502        struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
3503        int ret;
3504
3505        if (lock && mutex_lock_interruptible(lock))
3506                return -ERESTARTSYS;
3507        ret = vb2_get_unmapped_area(vdev->queue, addr, len, pgoff, flags);
3508        if (lock)
3509                mutex_unlock(lock);
3510        return ret;
3511}
3512EXPORT_SYMBOL_GPL(vb2_fop_get_unmapped_area);
3513#endif
3514
3515/* vb2_ops helpers. Only use if vq->lock is non-NULL. */
3516
3517void vb2_ops_wait_prepare(struct vb2_queue *vq)
3518{
3519        mutex_unlock(vq->lock);
3520}
3521EXPORT_SYMBOL_GPL(vb2_ops_wait_prepare);
3522
3523void vb2_ops_wait_finish(struct vb2_queue *vq)
3524{
3525        mutex_lock(vq->lock);
3526}
3527EXPORT_SYMBOL_GPL(vb2_ops_wait_finish);
3528
3529MODULE_DESCRIPTION("Driver helper framework for Video for Linux 2");
3530MODULE_AUTHOR("Pawel Osciak <pawel@osciak.com>, Marek Szyprowski");
3531MODULE_LICENSE("GPL");
3532