2 * videobuf2-core.c - video buffer 2 core framework
4 * Copyright (C) 2010 Samsung Electronics
6 * Author: Pawel Osciak <pawel@osciak.com>
7 * Marek Szyprowski <m.szyprowski@samsung.com>
9 * The vb2_thread implementation was based on code from videobuf-dvb.c:
10 * (c) 2004 Gerd Knorr <kraxel@bytesex.org> [SUSE Labs]
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.
17 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
19 #include <linux/err.h>
20 #include <linux/kernel.h>
21 #include <linux/module.h>
23 #include <linux/poll.h>
24 #include <linux/slab.h>
25 #include <linux/sched.h>
26 #include <linux/freezer.h>
27 #include <linux/kthread.h>
29 #include <media/videobuf2-core.h>
30 #include <media/v4l2-mc.h>
32 #include <trace/events/vb2.h>
35 module_param(debug, int, 0644);
37 #define dprintk(q, level, fmt, arg...) \
40 pr_info("[%s] %s: " fmt, (q)->name, __func__, \
44 #ifdef CONFIG_VIDEO_ADV_DEBUG
47 * If advanced debugging is on, then count how often each op is called
48 * successfully, which can either be per-buffer or per-queue.
50 * This makes it easy to check that the 'init' and 'cleanup'
51 * (and variations thereof) stay balanced.
54 #define log_memop(vb, op) \
55 dprintk((vb)->vb2_queue, 2, "call_memop(%d, %s)%s\n", \
57 (vb)->vb2_queue->mem_ops->op ? "" : " (nop)")
59 #define call_memop(vb, op, args...) \
61 struct vb2_queue *_q = (vb)->vb2_queue; \
65 err = _q->mem_ops->op ? _q->mem_ops->op(args) : 0; \
67 (vb)->cnt_mem_ ## op++; \
71 #define call_ptr_memop(op, vb, args...) \
73 struct vb2_queue *_q = (vb)->vb2_queue; \
77 ptr = _q->mem_ops->op ? _q->mem_ops->op(vb, args) : NULL; \
78 if (!IS_ERR_OR_NULL(ptr)) \
79 (vb)->cnt_mem_ ## op++; \
83 #define call_void_memop(vb, op, args...) \
85 struct vb2_queue *_q = (vb)->vb2_queue; \
88 if (_q->mem_ops->op) \
89 _q->mem_ops->op(args); \
90 (vb)->cnt_mem_ ## op++; \
93 #define log_qop(q, op) \
94 dprintk(q, 2, "call_qop(%s)%s\n", #op, \
95 (q)->ops->op ? "" : " (nop)")
97 #define call_qop(q, op, args...) \
102 err = (q)->ops->op ? (q)->ops->op(args) : 0; \
108 #define call_void_qop(q, op, args...) \
112 (q)->ops->op(args); \
116 #define log_vb_qop(vb, op, args...) \
117 dprintk((vb)->vb2_queue, 2, "call_vb_qop(%d, %s)%s\n", \
119 (vb)->vb2_queue->ops->op ? "" : " (nop)")
121 #define call_vb_qop(vb, op, args...) \
125 log_vb_qop(vb, op); \
126 err = (vb)->vb2_queue->ops->op ? \
127 (vb)->vb2_queue->ops->op(args) : 0; \
129 (vb)->cnt_ ## op++; \
133 #define call_void_vb_qop(vb, op, args...) \
135 log_vb_qop(vb, op); \
136 if ((vb)->vb2_queue->ops->op) \
137 (vb)->vb2_queue->ops->op(args); \
138 (vb)->cnt_ ## op++; \
143 #define call_memop(vb, op, args...) \
144 ((vb)->vb2_queue->mem_ops->op ? \
145 (vb)->vb2_queue->mem_ops->op(args) : 0)
147 #define call_ptr_memop(op, vb, args...) \
148 ((vb)->vb2_queue->mem_ops->op ? \
149 (vb)->vb2_queue->mem_ops->op(vb, args) : NULL)
151 #define call_void_memop(vb, op, args...) \
153 if ((vb)->vb2_queue->mem_ops->op) \
154 (vb)->vb2_queue->mem_ops->op(args); \
157 #define call_qop(q, op, args...) \
158 ((q)->ops->op ? (q)->ops->op(args) : 0)
160 #define call_void_qop(q, op, args...) \
163 (q)->ops->op(args); \
166 #define call_vb_qop(vb, op, args...) \
167 ((vb)->vb2_queue->ops->op ? (vb)->vb2_queue->ops->op(args) : 0)
169 #define call_void_vb_qop(vb, op, args...) \
171 if ((vb)->vb2_queue->ops->op) \
172 (vb)->vb2_queue->ops->op(args); \
177 #define call_bufop(q, op, args...) \
180 if (q && q->buf_ops && q->buf_ops->op) \
181 ret = q->buf_ops->op(args); \
185 #define call_void_bufop(q, op, args...) \
187 if (q && q->buf_ops && q->buf_ops->op) \
188 q->buf_ops->op(args); \
191 static void __vb2_queue_cancel(struct vb2_queue *q);
192 static void __enqueue_in_driver(struct vb2_buffer *vb);
194 static const char *vb2_state_name(enum vb2_buffer_state s)
196 static const char * const state_names[] = {
197 [VB2_BUF_STATE_DEQUEUED] = "dequeued",
198 [VB2_BUF_STATE_IN_REQUEST] = "in request",
199 [VB2_BUF_STATE_PREPARING] = "preparing",
200 [VB2_BUF_STATE_QUEUED] = "queued",
201 [VB2_BUF_STATE_ACTIVE] = "active",
202 [VB2_BUF_STATE_DONE] = "done",
203 [VB2_BUF_STATE_ERROR] = "error",
206 if ((unsigned int)(s) < ARRAY_SIZE(state_names))
207 return state_names[s];
212 * __vb2_buf_mem_alloc() - allocate video memory for the given buffer
214 static int __vb2_buf_mem_alloc(struct vb2_buffer *vb)
216 struct vb2_queue *q = vb->vb2_queue;
222 * Allocate memory for all planes in this buffer
223 * NOTE: mmapped areas should be page aligned
225 for (plane = 0; plane < vb->num_planes; ++plane) {
226 /* Memops alloc requires size to be page aligned. */
227 unsigned long size = PAGE_ALIGN(vb->planes[plane].length);
229 /* Did it wrap around? */
230 if (size < vb->planes[plane].length)
233 mem_priv = call_ptr_memop(alloc,
235 q->alloc_devs[plane] ? : q->dev,
237 if (IS_ERR_OR_NULL(mem_priv)) {
239 ret = PTR_ERR(mem_priv);
243 /* Associate allocator private data with this plane */
244 vb->planes[plane].mem_priv = mem_priv;
249 /* Free already allocated memory if one of the allocations failed */
250 for (; plane > 0; --plane) {
251 call_void_memop(vb, put, vb->planes[plane - 1].mem_priv);
252 vb->planes[plane - 1].mem_priv = NULL;
259 * __vb2_buf_mem_free() - free memory of the given buffer
261 static void __vb2_buf_mem_free(struct vb2_buffer *vb)
265 for (plane = 0; plane < vb->num_planes; ++plane) {
266 call_void_memop(vb, put, vb->planes[plane].mem_priv);
267 vb->planes[plane].mem_priv = NULL;
268 dprintk(vb->vb2_queue, 3, "freed plane %d of buffer %d\n",
274 * __vb2_buf_userptr_put() - release userspace memory associated with
277 static void __vb2_buf_userptr_put(struct vb2_buffer *vb)
281 for (plane = 0; plane < vb->num_planes; ++plane) {
282 if (vb->planes[plane].mem_priv)
283 call_void_memop(vb, put_userptr, vb->planes[plane].mem_priv);
284 vb->planes[plane].mem_priv = NULL;
289 * __vb2_plane_dmabuf_put() - release memory associated with
290 * a DMABUF shared plane
292 static void __vb2_plane_dmabuf_put(struct vb2_buffer *vb, struct vb2_plane *p)
298 call_void_memop(vb, unmap_dmabuf, p->mem_priv);
300 call_void_memop(vb, detach_dmabuf, p->mem_priv);
301 dma_buf_put(p->dbuf);
308 * __vb2_buf_dmabuf_put() - release memory associated with
309 * a DMABUF shared buffer
311 static void __vb2_buf_dmabuf_put(struct vb2_buffer *vb)
315 for (plane = 0; plane < vb->num_planes; ++plane)
316 __vb2_plane_dmabuf_put(vb, &vb->planes[plane]);
320 * __vb2_buf_mem_prepare() - call ->prepare() on buffer's private memory
323 static void __vb2_buf_mem_prepare(struct vb2_buffer *vb)
331 for (plane = 0; plane < vb->num_planes; ++plane)
332 call_void_memop(vb, prepare, vb->planes[plane].mem_priv);
336 * __vb2_buf_mem_finish() - call ->finish on buffer's private memory
339 static void __vb2_buf_mem_finish(struct vb2_buffer *vb)
347 for (plane = 0; plane < vb->num_planes; ++plane)
348 call_void_memop(vb, finish, vb->planes[plane].mem_priv);
352 * __setup_offsets() - setup unique offsets ("cookies") for every plane in
355 static void __setup_offsets(struct vb2_buffer *vb)
357 struct vb2_queue *q = vb->vb2_queue;
359 unsigned long off = 0;
362 struct vb2_buffer *prev = q->bufs[vb->index - 1];
363 struct vb2_plane *p = &prev->planes[prev->num_planes - 1];
365 off = PAGE_ALIGN(p->m.offset + p->length);
368 for (plane = 0; plane < vb->num_planes; ++plane) {
369 vb->planes[plane].m.offset = off;
371 dprintk(q, 3, "buffer %d, plane %d offset 0x%08lx\n",
372 vb->index, plane, off);
374 off += vb->planes[plane].length;
375 off = PAGE_ALIGN(off);
379 static void init_buffer_cache_hints(struct vb2_queue *q, struct vb2_buffer *vb)
382 * DMA exporter should take care of cache syncs, so we can avoid
383 * explicit ->prepare()/->finish() syncs. For other ->memory types
384 * we always need ->prepare() or/and ->finish() cache sync.
386 if (q->memory == VB2_MEMORY_DMABUF) {
387 vb->skip_cache_sync_on_finish = 1;
388 vb->skip_cache_sync_on_prepare = 1;
393 * ->finish() cache sync can be avoided when queue direction is
396 if (q->dma_dir == DMA_TO_DEVICE)
397 vb->skip_cache_sync_on_finish = 1;
401 * __vb2_queue_alloc() - allocate vb2 buffer structures and (for MMAP type)
402 * video buffer memory for all buffers/planes on the queue and initializes the
405 * Returns the number of buffers successfully allocated.
407 static int __vb2_queue_alloc(struct vb2_queue *q, enum vb2_memory memory,
408 unsigned int num_buffers, unsigned int num_planes,
409 const unsigned plane_sizes[VB2_MAX_PLANES])
411 unsigned int buffer, plane;
412 struct vb2_buffer *vb;
415 /* Ensure that q->num_buffers+num_buffers is below VB2_MAX_FRAME */
416 num_buffers = min_t(unsigned int, num_buffers,
417 VB2_MAX_FRAME - q->num_buffers);
419 for (buffer = 0; buffer < num_buffers; ++buffer) {
420 /* Allocate vb2 buffer structures */
421 vb = kzalloc(q->buf_struct_size, GFP_KERNEL);
423 dprintk(q, 1, "memory alloc for buffer struct failed\n");
427 vb->state = VB2_BUF_STATE_DEQUEUED;
429 vb->num_planes = num_planes;
430 vb->index = q->num_buffers + buffer;
433 init_buffer_cache_hints(q, vb);
434 for (plane = 0; plane < num_planes; ++plane) {
435 vb->planes[plane].length = plane_sizes[plane];
436 vb->planes[plane].min_length = plane_sizes[plane];
438 call_void_bufop(q, init_buffer, vb);
440 q->bufs[vb->index] = vb;
442 /* Allocate video buffer memory for the MMAP type */
443 if (memory == VB2_MEMORY_MMAP) {
444 ret = __vb2_buf_mem_alloc(vb);
446 dprintk(q, 1, "failed allocating memory for buffer %d\n",
448 q->bufs[vb->index] = NULL;
454 * Call the driver-provided buffer initialization
455 * callback, if given. An error in initialization
456 * results in queue setup failure.
458 ret = call_vb_qop(vb, buf_init, vb);
460 dprintk(q, 1, "buffer %d %p initialization failed\n",
462 __vb2_buf_mem_free(vb);
463 q->bufs[vb->index] = NULL;
470 dprintk(q, 3, "allocated %d buffers, %d plane(s) each\n",
477 * __vb2_free_mem() - release all video buffer memory for a given queue
479 static void __vb2_free_mem(struct vb2_queue *q, unsigned int buffers)
482 struct vb2_buffer *vb;
484 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
486 vb = q->bufs[buffer];
490 /* Free MMAP buffers or release USERPTR buffers */
491 if (q->memory == VB2_MEMORY_MMAP)
492 __vb2_buf_mem_free(vb);
493 else if (q->memory == VB2_MEMORY_DMABUF)
494 __vb2_buf_dmabuf_put(vb);
496 __vb2_buf_userptr_put(vb);
501 * __vb2_queue_free() - free buffers at the end of the queue - video memory and
502 * related information, if no buffers are left return the queue to an
503 * uninitialized state. Might be called even if the queue has already been freed.
505 static int __vb2_queue_free(struct vb2_queue *q, unsigned int buffers)
510 * Sanity check: when preparing a buffer the queue lock is released for
511 * a short while (see __buf_prepare for the details), which would allow
512 * a race with a reqbufs which can call this function. Removing the
513 * buffers from underneath __buf_prepare is obviously a bad idea, so we
514 * check if any of the buffers is in the state PREPARING, and if so we
515 * just return -EAGAIN.
517 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
519 if (q->bufs[buffer] == NULL)
521 if (q->bufs[buffer]->state == VB2_BUF_STATE_PREPARING) {
522 dprintk(q, 1, "preparing buffers, cannot free\n");
527 /* Call driver-provided cleanup function for each buffer, if provided */
528 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
530 struct vb2_buffer *vb = q->bufs[buffer];
532 if (vb && vb->planes[0].mem_priv)
533 call_void_vb_qop(vb, buf_cleanup, vb);
536 /* Release video buffer memory */
537 __vb2_free_mem(q, buffers);
539 #ifdef CONFIG_VIDEO_ADV_DEBUG
541 * Check that all the calls were balances during the life-time of this
542 * queue. If not (or if the debug level is 1 or up), then dump the
543 * counters to the kernel log.
545 if (q->num_buffers) {
546 bool unbalanced = q->cnt_start_streaming != q->cnt_stop_streaming ||
547 q->cnt_prepare_streaming != q->cnt_unprepare_streaming ||
548 q->cnt_wait_prepare != q->cnt_wait_finish;
550 if (unbalanced || debug) {
551 pr_info("counters for queue %p:%s\n", q,
552 unbalanced ? " UNBALANCED!" : "");
553 pr_info(" setup: %u start_streaming: %u stop_streaming: %u\n",
554 q->cnt_queue_setup, q->cnt_start_streaming,
555 q->cnt_stop_streaming);
556 pr_info(" prepare_streaming: %u unprepare_streaming: %u\n",
557 q->cnt_prepare_streaming, q->cnt_unprepare_streaming);
558 pr_info(" wait_prepare: %u wait_finish: %u\n",
559 q->cnt_wait_prepare, q->cnt_wait_finish);
561 q->cnt_queue_setup = 0;
562 q->cnt_wait_prepare = 0;
563 q->cnt_wait_finish = 0;
564 q->cnt_prepare_streaming = 0;
565 q->cnt_start_streaming = 0;
566 q->cnt_stop_streaming = 0;
567 q->cnt_unprepare_streaming = 0;
569 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
570 struct vb2_buffer *vb = q->bufs[buffer];
571 bool unbalanced = vb->cnt_mem_alloc != vb->cnt_mem_put ||
572 vb->cnt_mem_prepare != vb->cnt_mem_finish ||
573 vb->cnt_mem_get_userptr != vb->cnt_mem_put_userptr ||
574 vb->cnt_mem_attach_dmabuf != vb->cnt_mem_detach_dmabuf ||
575 vb->cnt_mem_map_dmabuf != vb->cnt_mem_unmap_dmabuf ||
576 vb->cnt_buf_queue != vb->cnt_buf_done ||
577 vb->cnt_buf_prepare != vb->cnt_buf_finish ||
578 vb->cnt_buf_init != vb->cnt_buf_cleanup;
580 if (unbalanced || debug) {
581 pr_info(" counters for queue %p, buffer %d:%s\n",
582 q, buffer, unbalanced ? " UNBALANCED!" : "");
583 pr_info(" buf_init: %u buf_cleanup: %u buf_prepare: %u buf_finish: %u\n",
584 vb->cnt_buf_init, vb->cnt_buf_cleanup,
585 vb->cnt_buf_prepare, vb->cnt_buf_finish);
586 pr_info(" buf_out_validate: %u buf_queue: %u buf_done: %u buf_request_complete: %u\n",
587 vb->cnt_buf_out_validate, vb->cnt_buf_queue,
588 vb->cnt_buf_done, vb->cnt_buf_request_complete);
589 pr_info(" alloc: %u put: %u prepare: %u finish: %u mmap: %u\n",
590 vb->cnt_mem_alloc, vb->cnt_mem_put,
591 vb->cnt_mem_prepare, vb->cnt_mem_finish,
593 pr_info(" get_userptr: %u put_userptr: %u\n",
594 vb->cnt_mem_get_userptr, vb->cnt_mem_put_userptr);
595 pr_info(" attach_dmabuf: %u detach_dmabuf: %u map_dmabuf: %u unmap_dmabuf: %u\n",
596 vb->cnt_mem_attach_dmabuf, vb->cnt_mem_detach_dmabuf,
597 vb->cnt_mem_map_dmabuf, vb->cnt_mem_unmap_dmabuf);
598 pr_info(" get_dmabuf: %u num_users: %u vaddr: %u cookie: %u\n",
599 vb->cnt_mem_get_dmabuf,
600 vb->cnt_mem_num_users,
607 /* Free vb2 buffers */
608 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
610 kfree(q->bufs[buffer]);
611 q->bufs[buffer] = NULL;
614 q->num_buffers -= buffers;
615 if (!q->num_buffers) {
616 q->memory = VB2_MEMORY_UNKNOWN;
617 INIT_LIST_HEAD(&q->queued_list);
622 bool vb2_buffer_in_use(struct vb2_queue *q, struct vb2_buffer *vb)
625 for (plane = 0; plane < vb->num_planes; ++plane) {
626 void *mem_priv = vb->planes[plane].mem_priv;
628 * If num_users() has not been provided, call_memop
629 * will return 0, apparently nobody cares about this
630 * case anyway. If num_users() returns more than 1,
631 * we are not the only user of the plane's memory.
633 if (mem_priv && call_memop(vb, num_users, mem_priv) > 1)
638 EXPORT_SYMBOL(vb2_buffer_in_use);
641 * __buffers_in_use() - return true if any buffers on the queue are in use and
642 * the queue cannot be freed (by the means of REQBUFS(0)) call
644 static bool __buffers_in_use(struct vb2_queue *q)
647 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
648 if (vb2_buffer_in_use(q, q->bufs[buffer]))
654 void vb2_core_querybuf(struct vb2_queue *q, unsigned int index, void *pb)
656 call_void_bufop(q, fill_user_buffer, q->bufs[index], pb);
658 EXPORT_SYMBOL_GPL(vb2_core_querybuf);
661 * __verify_userptr_ops() - verify that all memory operations required for
662 * USERPTR queue type have been provided
664 static int __verify_userptr_ops(struct vb2_queue *q)
666 if (!(q->io_modes & VB2_USERPTR) || !q->mem_ops->get_userptr ||
667 !q->mem_ops->put_userptr)
674 * __verify_mmap_ops() - verify that all memory operations required for
675 * MMAP queue type have been provided
677 static int __verify_mmap_ops(struct vb2_queue *q)
679 if (!(q->io_modes & VB2_MMAP) || !q->mem_ops->alloc ||
680 !q->mem_ops->put || !q->mem_ops->mmap)
687 * __verify_dmabuf_ops() - verify that all memory operations required for
688 * DMABUF queue type have been provided
690 static int __verify_dmabuf_ops(struct vb2_queue *q)
692 if (!(q->io_modes & VB2_DMABUF) || !q->mem_ops->attach_dmabuf ||
693 !q->mem_ops->detach_dmabuf || !q->mem_ops->map_dmabuf ||
694 !q->mem_ops->unmap_dmabuf)
700 int vb2_verify_memory_type(struct vb2_queue *q,
701 enum vb2_memory memory, unsigned int type)
703 if (memory != VB2_MEMORY_MMAP && memory != VB2_MEMORY_USERPTR &&
704 memory != VB2_MEMORY_DMABUF) {
705 dprintk(q, 1, "unsupported memory type\n");
709 if (type != q->type) {
710 dprintk(q, 1, "requested type is incorrect\n");
715 * Make sure all the required memory ops for given memory type
718 if (memory == VB2_MEMORY_MMAP && __verify_mmap_ops(q)) {
719 dprintk(q, 1, "MMAP for current setup unsupported\n");
723 if (memory == VB2_MEMORY_USERPTR && __verify_userptr_ops(q)) {
724 dprintk(q, 1, "USERPTR for current setup unsupported\n");
728 if (memory == VB2_MEMORY_DMABUF && __verify_dmabuf_ops(q)) {
729 dprintk(q, 1, "DMABUF for current setup unsupported\n");
734 * Place the busy tests at the end: -EBUSY can be ignored when
735 * create_bufs is called with count == 0, but count == 0 should still
736 * do the memory and type validation.
738 if (vb2_fileio_is_active(q)) {
739 dprintk(q, 1, "file io in progress\n");
744 EXPORT_SYMBOL(vb2_verify_memory_type);
746 static void set_queue_coherency(struct vb2_queue *q, bool non_coherent_mem)
748 q->non_coherent_mem = 0;
750 if (!vb2_queue_allows_cache_hints(q))
752 q->non_coherent_mem = non_coherent_mem;
755 static bool verify_coherency_flags(struct vb2_queue *q, bool non_coherent_mem)
757 if (non_coherent_mem != q->non_coherent_mem) {
758 dprintk(q, 1, "memory coherency model mismatch\n");
764 int vb2_core_reqbufs(struct vb2_queue *q, enum vb2_memory memory,
765 unsigned int flags, unsigned int *count)
767 unsigned int num_buffers, allocated_buffers, num_planes = 0;
768 unsigned plane_sizes[VB2_MAX_PLANES] = { };
769 bool non_coherent_mem = flags & V4L2_MEMORY_FLAG_NON_COHERENT;
774 dprintk(q, 1, "streaming active\n");
778 if (q->waiting_in_dqbuf && *count) {
779 dprintk(q, 1, "another dup()ped fd is waiting for a buffer\n");
783 if (*count == 0 || q->num_buffers != 0 ||
784 (q->memory != VB2_MEMORY_UNKNOWN && q->memory != memory) ||
785 !verify_coherency_flags(q, non_coherent_mem)) {
787 * We already have buffers allocated, so first check if they
788 * are not in use and can be freed.
790 mutex_lock(&q->mmap_lock);
791 if (debug && q->memory == VB2_MEMORY_MMAP &&
793 dprintk(q, 1, "memory in use, orphaning buffers\n");
796 * Call queue_cancel to clean up any buffers in the
797 * QUEUED state which is possible if buffers were prepared or
798 * queued without ever calling STREAMON.
800 __vb2_queue_cancel(q);
801 ret = __vb2_queue_free(q, q->num_buffers);
802 mutex_unlock(&q->mmap_lock);
807 * In case of REQBUFS(0) return immediately without calling
808 * driver's queue_setup() callback and allocating resources.
815 * Make sure the requested values and current defaults are sane.
817 WARN_ON(q->min_buffers_needed > VB2_MAX_FRAME);
818 num_buffers = max_t(unsigned int, *count, q->min_buffers_needed);
819 num_buffers = min_t(unsigned int, num_buffers, VB2_MAX_FRAME);
820 memset(q->alloc_devs, 0, sizeof(q->alloc_devs));
822 * Set this now to ensure that drivers see the correct q->memory value
823 * in the queue_setup op.
825 mutex_lock(&q->mmap_lock);
827 mutex_unlock(&q->mmap_lock);
828 set_queue_coherency(q, non_coherent_mem);
831 * Ask the driver how many buffers and planes per buffer it requires.
832 * Driver also sets the size and allocator context for each plane.
834 ret = call_qop(q, queue_setup, q, &num_buffers, &num_planes,
835 plane_sizes, q->alloc_devs);
839 /* Check that driver has set sane values */
840 if (WARN_ON(!num_planes)) {
845 for (i = 0; i < num_planes; i++)
846 if (WARN_ON(!plane_sizes[i])) {
851 /* Finally, allocate buffers and video memory */
853 __vb2_queue_alloc(q, memory, num_buffers, num_planes, plane_sizes);
854 if (allocated_buffers == 0) {
855 dprintk(q, 1, "memory allocation failed\n");
861 * There is no point in continuing if we can't allocate the minimum
862 * number of buffers needed by this vb2_queue.
864 if (allocated_buffers < q->min_buffers_needed)
868 * Check if driver can handle the allocated number of buffers.
870 if (!ret && allocated_buffers < num_buffers) {
871 num_buffers = allocated_buffers;
873 * num_planes is set by the previous queue_setup(), but since it
874 * signals to queue_setup() whether it is called from create_bufs()
875 * vs reqbufs() we zero it here to signal that queue_setup() is
876 * called for the reqbufs() case.
880 ret = call_qop(q, queue_setup, q, &num_buffers,
881 &num_planes, plane_sizes, q->alloc_devs);
883 if (!ret && allocated_buffers < num_buffers)
887 * Either the driver has accepted a smaller number of buffers,
888 * or .queue_setup() returned an error
892 mutex_lock(&q->mmap_lock);
893 q->num_buffers = allocated_buffers;
897 * Note: __vb2_queue_free() will subtract 'allocated_buffers'
898 * from q->num_buffers and it will reset q->memory to
899 * VB2_MEMORY_UNKNOWN.
901 __vb2_queue_free(q, allocated_buffers);
902 mutex_unlock(&q->mmap_lock);
905 mutex_unlock(&q->mmap_lock);
908 * Return the number of successfully allocated buffers
911 *count = allocated_buffers;
912 q->waiting_for_buffers = !q->is_output;
917 mutex_lock(&q->mmap_lock);
918 q->memory = VB2_MEMORY_UNKNOWN;
919 mutex_unlock(&q->mmap_lock);
922 EXPORT_SYMBOL_GPL(vb2_core_reqbufs);
924 int vb2_core_create_bufs(struct vb2_queue *q, enum vb2_memory memory,
925 unsigned int flags, unsigned int *count,
926 unsigned int requested_planes,
927 const unsigned int requested_sizes[])
929 unsigned int num_planes = 0, num_buffers, allocated_buffers;
930 unsigned plane_sizes[VB2_MAX_PLANES] = { };
931 bool non_coherent_mem = flags & V4L2_MEMORY_FLAG_NON_COHERENT;
932 bool no_previous_buffers = !q->num_buffers;
935 if (q->num_buffers == VB2_MAX_FRAME) {
936 dprintk(q, 1, "maximum number of buffers already allocated\n");
940 if (no_previous_buffers) {
941 if (q->waiting_in_dqbuf && *count) {
942 dprintk(q, 1, "another dup()ped fd is waiting for a buffer\n");
945 memset(q->alloc_devs, 0, sizeof(q->alloc_devs));
947 * Set this now to ensure that drivers see the correct q->memory
948 * value in the queue_setup op.
950 mutex_lock(&q->mmap_lock);
952 mutex_unlock(&q->mmap_lock);
953 q->waiting_for_buffers = !q->is_output;
954 set_queue_coherency(q, non_coherent_mem);
956 if (q->memory != memory) {
957 dprintk(q, 1, "memory model mismatch\n");
960 if (!verify_coherency_flags(q, non_coherent_mem))
964 num_buffers = min(*count, VB2_MAX_FRAME - q->num_buffers);
966 if (requested_planes && requested_sizes) {
967 num_planes = requested_planes;
968 memcpy(plane_sizes, requested_sizes, sizeof(plane_sizes));
972 * Ask the driver, whether the requested number of buffers, planes per
973 * buffer and their sizes are acceptable
975 ret = call_qop(q, queue_setup, q, &num_buffers,
976 &num_planes, plane_sizes, q->alloc_devs);
980 /* Finally, allocate buffers and video memory */
981 allocated_buffers = __vb2_queue_alloc(q, memory, num_buffers,
982 num_planes, plane_sizes);
983 if (allocated_buffers == 0) {
984 dprintk(q, 1, "memory allocation failed\n");
990 * Check if driver can handle the so far allocated number of buffers.
992 if (allocated_buffers < num_buffers) {
993 num_buffers = allocated_buffers;
996 * q->num_buffers contains the total number of buffers, that the
997 * queue driver has set up
999 ret = call_qop(q, queue_setup, q, &num_buffers,
1000 &num_planes, plane_sizes, q->alloc_devs);
1002 if (!ret && allocated_buffers < num_buffers)
1006 * Either the driver has accepted a smaller number of buffers,
1007 * or .queue_setup() returned an error
1011 mutex_lock(&q->mmap_lock);
1012 q->num_buffers += allocated_buffers;
1016 * Note: __vb2_queue_free() will subtract 'allocated_buffers'
1017 * from q->num_buffers and it will reset q->memory to
1018 * VB2_MEMORY_UNKNOWN.
1020 __vb2_queue_free(q, allocated_buffers);
1021 mutex_unlock(&q->mmap_lock);
1024 mutex_unlock(&q->mmap_lock);
1027 * Return the number of successfully allocated buffers
1030 *count = allocated_buffers;
1035 if (no_previous_buffers) {
1036 mutex_lock(&q->mmap_lock);
1037 q->memory = VB2_MEMORY_UNKNOWN;
1038 mutex_unlock(&q->mmap_lock);
1042 EXPORT_SYMBOL_GPL(vb2_core_create_bufs);
1044 void *vb2_plane_vaddr(struct vb2_buffer *vb, unsigned int plane_no)
1046 if (plane_no >= vb->num_planes || !vb->planes[plane_no].mem_priv)
1049 return call_ptr_memop(vaddr, vb, vb->planes[plane_no].mem_priv);
1052 EXPORT_SYMBOL_GPL(vb2_plane_vaddr);
1054 void *vb2_plane_cookie(struct vb2_buffer *vb, unsigned int plane_no)
1056 if (plane_no >= vb->num_planes || !vb->planes[plane_no].mem_priv)
1059 return call_ptr_memop(cookie, vb, vb->planes[plane_no].mem_priv);
1061 EXPORT_SYMBOL_GPL(vb2_plane_cookie);
1063 void vb2_buffer_done(struct vb2_buffer *vb, enum vb2_buffer_state state)
1065 struct vb2_queue *q = vb->vb2_queue;
1066 unsigned long flags;
1068 if (WARN_ON(vb->state != VB2_BUF_STATE_ACTIVE))
1071 if (WARN_ON(state != VB2_BUF_STATE_DONE &&
1072 state != VB2_BUF_STATE_ERROR &&
1073 state != VB2_BUF_STATE_QUEUED))
1074 state = VB2_BUF_STATE_ERROR;
1076 #ifdef CONFIG_VIDEO_ADV_DEBUG
1078 * Although this is not a callback, it still does have to balance
1079 * with the buf_queue op. So update this counter manually.
1083 dprintk(q, 4, "done processing on buffer %d, state: %s\n",
1084 vb->index, vb2_state_name(state));
1086 if (state != VB2_BUF_STATE_QUEUED)
1087 __vb2_buf_mem_finish(vb);
1089 spin_lock_irqsave(&q->done_lock, flags);
1090 if (state == VB2_BUF_STATE_QUEUED) {
1091 vb->state = VB2_BUF_STATE_QUEUED;
1093 /* Add the buffer to the done buffers list */
1094 list_add_tail(&vb->done_entry, &q->done_list);
1097 atomic_dec(&q->owned_by_drv_count);
1099 if (state != VB2_BUF_STATE_QUEUED && vb->req_obj.req) {
1100 media_request_object_unbind(&vb->req_obj);
1101 media_request_object_put(&vb->req_obj);
1104 spin_unlock_irqrestore(&q->done_lock, flags);
1106 trace_vb2_buf_done(q, vb);
1109 case VB2_BUF_STATE_QUEUED:
1112 /* Inform any processes that may be waiting for buffers */
1113 wake_up(&q->done_wq);
1117 EXPORT_SYMBOL_GPL(vb2_buffer_done);
1119 void vb2_discard_done(struct vb2_queue *q)
1121 struct vb2_buffer *vb;
1122 unsigned long flags;
1124 spin_lock_irqsave(&q->done_lock, flags);
1125 list_for_each_entry(vb, &q->done_list, done_entry)
1126 vb->state = VB2_BUF_STATE_ERROR;
1127 spin_unlock_irqrestore(&q->done_lock, flags);
1129 EXPORT_SYMBOL_GPL(vb2_discard_done);
1132 * __prepare_mmap() - prepare an MMAP buffer
1134 static int __prepare_mmap(struct vb2_buffer *vb)
1138 ret = call_bufop(vb->vb2_queue, fill_vb2_buffer,
1140 return ret ? ret : call_vb_qop(vb, buf_prepare, vb);
1144 * __prepare_userptr() - prepare a USERPTR buffer
1146 static int __prepare_userptr(struct vb2_buffer *vb)
1148 struct vb2_plane planes[VB2_MAX_PLANES];
1149 struct vb2_queue *q = vb->vb2_queue;
1153 bool reacquired = vb->planes[0].mem_priv == NULL;
1155 memset(planes, 0, sizeof(planes[0]) * vb->num_planes);
1156 /* Copy relevant information provided by the userspace */
1157 ret = call_bufop(vb->vb2_queue, fill_vb2_buffer,
1162 for (plane = 0; plane < vb->num_planes; ++plane) {
1163 /* Skip the plane if already verified */
1164 if (vb->planes[plane].m.userptr &&
1165 vb->planes[plane].m.userptr == planes[plane].m.userptr
1166 && vb->planes[plane].length == planes[plane].length)
1169 dprintk(q, 3, "userspace address for plane %d changed, reacquiring memory\n",
1172 /* Check if the provided plane buffer is large enough */
1173 if (planes[plane].length < vb->planes[plane].min_length) {
1174 dprintk(q, 1, "provided buffer size %u is less than setup size %u for plane %d\n",
1175 planes[plane].length,
1176 vb->planes[plane].min_length,
1182 /* Release previously acquired memory if present */
1183 if (vb->planes[plane].mem_priv) {
1186 vb->copied_timestamp = 0;
1187 call_void_vb_qop(vb, buf_cleanup, vb);
1189 call_void_memop(vb, put_userptr, vb->planes[plane].mem_priv);
1192 vb->planes[plane].mem_priv = NULL;
1193 vb->planes[plane].bytesused = 0;
1194 vb->planes[plane].length = 0;
1195 vb->planes[plane].m.userptr = 0;
1196 vb->planes[plane].data_offset = 0;
1198 /* Acquire each plane's memory */
1199 mem_priv = call_ptr_memop(get_userptr,
1201 q->alloc_devs[plane] ? : q->dev,
1202 planes[plane].m.userptr,
1203 planes[plane].length);
1204 if (IS_ERR(mem_priv)) {
1205 dprintk(q, 1, "failed acquiring userspace memory for plane %d\n",
1207 ret = PTR_ERR(mem_priv);
1210 vb->planes[plane].mem_priv = mem_priv;
1214 * Now that everything is in order, copy relevant information
1215 * provided by userspace.
1217 for (plane = 0; plane < vb->num_planes; ++plane) {
1218 vb->planes[plane].bytesused = planes[plane].bytesused;
1219 vb->planes[plane].length = planes[plane].length;
1220 vb->planes[plane].m.userptr = planes[plane].m.userptr;
1221 vb->planes[plane].data_offset = planes[plane].data_offset;
1226 * One or more planes changed, so we must call buf_init to do
1227 * the driver-specific initialization on the newly acquired
1228 * buffer, if provided.
1230 ret = call_vb_qop(vb, buf_init, vb);
1232 dprintk(q, 1, "buffer initialization failed\n");
1237 ret = call_vb_qop(vb, buf_prepare, vb);
1239 dprintk(q, 1, "buffer preparation failed\n");
1240 call_void_vb_qop(vb, buf_cleanup, vb);
1246 /* In case of errors, release planes that were already acquired */
1247 for (plane = 0; plane < vb->num_planes; ++plane) {
1248 if (vb->planes[plane].mem_priv)
1249 call_void_memop(vb, put_userptr,
1250 vb->planes[plane].mem_priv);
1251 vb->planes[plane].mem_priv = NULL;
1252 vb->planes[plane].m.userptr = 0;
1253 vb->planes[plane].length = 0;
1260 * __prepare_dmabuf() - prepare a DMABUF buffer
1262 static int __prepare_dmabuf(struct vb2_buffer *vb)
1264 struct vb2_plane planes[VB2_MAX_PLANES];
1265 struct vb2_queue *q = vb->vb2_queue;
1269 bool reacquired = vb->planes[0].mem_priv == NULL;
1271 memset(planes, 0, sizeof(planes[0]) * vb->num_planes);
1272 /* Copy relevant information provided by the userspace */
1273 ret = call_bufop(vb->vb2_queue, fill_vb2_buffer,
1278 for (plane = 0; plane < vb->num_planes; ++plane) {
1279 struct dma_buf *dbuf = dma_buf_get(planes[plane].m.fd);
1281 if (IS_ERR_OR_NULL(dbuf)) {
1282 dprintk(q, 1, "invalid dmabuf fd for plane %d\n",
1288 /* use DMABUF size if length is not provided */
1289 if (planes[plane].length == 0)
1290 planes[plane].length = dbuf->size;
1292 if (planes[plane].length < vb->planes[plane].min_length) {
1293 dprintk(q, 1, "invalid dmabuf length %u for plane %d, minimum length %u\n",
1294 planes[plane].length, plane,
1295 vb->planes[plane].min_length);
1301 /* Skip the plane if already verified */
1302 if (dbuf == vb->planes[plane].dbuf &&
1303 vb->planes[plane].length == planes[plane].length) {
1308 dprintk(q, 3, "buffer for plane %d changed\n", plane);
1312 vb->copied_timestamp = 0;
1313 call_void_vb_qop(vb, buf_cleanup, vb);
1316 /* Release previously acquired memory if present */
1317 __vb2_plane_dmabuf_put(vb, &vb->planes[plane]);
1318 vb->planes[plane].bytesused = 0;
1319 vb->planes[plane].length = 0;
1320 vb->planes[plane].m.fd = 0;
1321 vb->planes[plane].data_offset = 0;
1323 /* Acquire each plane's memory */
1324 mem_priv = call_ptr_memop(attach_dmabuf,
1326 q->alloc_devs[plane] ? : q->dev,
1328 planes[plane].length);
1329 if (IS_ERR(mem_priv)) {
1330 dprintk(q, 1, "failed to attach dmabuf\n");
1331 ret = PTR_ERR(mem_priv);
1336 vb->planes[plane].dbuf = dbuf;
1337 vb->planes[plane].mem_priv = mem_priv;
1341 * This pins the buffer(s) with dma_buf_map_attachment()). It's done
1342 * here instead just before the DMA, while queueing the buffer(s) so
1343 * userspace knows sooner rather than later if the dma-buf map fails.
1345 for (plane = 0; plane < vb->num_planes; ++plane) {
1346 if (vb->planes[plane].dbuf_mapped)
1349 ret = call_memop(vb, map_dmabuf, vb->planes[plane].mem_priv);
1351 dprintk(q, 1, "failed to map dmabuf for plane %d\n",
1355 vb->planes[plane].dbuf_mapped = 1;
1359 * Now that everything is in order, copy relevant information
1360 * provided by userspace.
1362 for (plane = 0; plane < vb->num_planes; ++plane) {
1363 vb->planes[plane].bytesused = planes[plane].bytesused;
1364 vb->planes[plane].length = planes[plane].length;
1365 vb->planes[plane].m.fd = planes[plane].m.fd;
1366 vb->planes[plane].data_offset = planes[plane].data_offset;
1371 * Call driver-specific initialization on the newly acquired buffer,
1374 ret = call_vb_qop(vb, buf_init, vb);
1376 dprintk(q, 1, "buffer initialization failed\n");
1381 ret = call_vb_qop(vb, buf_prepare, vb);
1383 dprintk(q, 1, "buffer preparation failed\n");
1384 call_void_vb_qop(vb, buf_cleanup, vb);
1390 /* In case of errors, release planes that were already acquired */
1391 __vb2_buf_dmabuf_put(vb);
1397 * __enqueue_in_driver() - enqueue a vb2_buffer in driver for processing
1399 static void __enqueue_in_driver(struct vb2_buffer *vb)
1401 struct vb2_queue *q = vb->vb2_queue;
1403 vb->state = VB2_BUF_STATE_ACTIVE;
1404 atomic_inc(&q->owned_by_drv_count);
1406 trace_vb2_buf_queue(q, vb);
1408 call_void_vb_qop(vb, buf_queue, vb);
1411 static int __buf_prepare(struct vb2_buffer *vb)
1413 struct vb2_queue *q = vb->vb2_queue;
1414 enum vb2_buffer_state orig_state = vb->state;
1418 dprintk(q, 1, "fatal error occurred on queue\n");
1424 WARN_ON(vb->synced);
1427 ret = call_vb_qop(vb, buf_out_validate, vb);
1429 dprintk(q, 1, "buffer validation failed\n");
1434 vb->state = VB2_BUF_STATE_PREPARING;
1436 switch (q->memory) {
1437 case VB2_MEMORY_MMAP:
1438 ret = __prepare_mmap(vb);
1440 case VB2_MEMORY_USERPTR:
1441 ret = __prepare_userptr(vb);
1443 case VB2_MEMORY_DMABUF:
1444 ret = __prepare_dmabuf(vb);
1447 WARN(1, "Invalid queue type\n");
1453 dprintk(q, 1, "buffer preparation failed: %d\n", ret);
1454 vb->state = orig_state;
1458 __vb2_buf_mem_prepare(vb);
1460 vb->state = orig_state;
1465 static int vb2_req_prepare(struct media_request_object *obj)
1467 struct vb2_buffer *vb = container_of(obj, struct vb2_buffer, req_obj);
1470 if (WARN_ON(vb->state != VB2_BUF_STATE_IN_REQUEST))
1473 mutex_lock(vb->vb2_queue->lock);
1474 ret = __buf_prepare(vb);
1475 mutex_unlock(vb->vb2_queue->lock);
1479 static void __vb2_dqbuf(struct vb2_buffer *vb);
1481 static void vb2_req_unprepare(struct media_request_object *obj)
1483 struct vb2_buffer *vb = container_of(obj, struct vb2_buffer, req_obj);
1485 mutex_lock(vb->vb2_queue->lock);
1487 vb->state = VB2_BUF_STATE_IN_REQUEST;
1488 mutex_unlock(vb->vb2_queue->lock);
1489 WARN_ON(!vb->req_obj.req);
1492 int vb2_core_qbuf(struct vb2_queue *q, unsigned int index, void *pb,
1493 struct media_request *req);
1495 static void vb2_req_queue(struct media_request_object *obj)
1497 struct vb2_buffer *vb = container_of(obj, struct vb2_buffer, req_obj);
1500 mutex_lock(vb->vb2_queue->lock);
1502 * There is no method to propagate an error from vb2_core_qbuf(),
1503 * so if this returns a non-0 value, then WARN.
1505 * The only exception is -EIO which is returned if q->error is
1506 * set. We just ignore that, and expect this will be caught the
1507 * next time vb2_req_prepare() is called.
1509 err = vb2_core_qbuf(vb->vb2_queue, vb->index, NULL, NULL);
1510 WARN_ON_ONCE(err && err != -EIO);
1511 mutex_unlock(vb->vb2_queue->lock);
1514 static void vb2_req_unbind(struct media_request_object *obj)
1516 struct vb2_buffer *vb = container_of(obj, struct vb2_buffer, req_obj);
1518 if (vb->state == VB2_BUF_STATE_IN_REQUEST)
1519 call_void_bufop(vb->vb2_queue, init_buffer, vb);
1522 static void vb2_req_release(struct media_request_object *obj)
1524 struct vb2_buffer *vb = container_of(obj, struct vb2_buffer, req_obj);
1526 if (vb->state == VB2_BUF_STATE_IN_REQUEST) {
1527 vb->state = VB2_BUF_STATE_DEQUEUED;
1529 media_request_put(vb->request);
1534 static const struct media_request_object_ops vb2_core_req_ops = {
1535 .prepare = vb2_req_prepare,
1536 .unprepare = vb2_req_unprepare,
1537 .queue = vb2_req_queue,
1538 .unbind = vb2_req_unbind,
1539 .release = vb2_req_release,
1542 bool vb2_request_object_is_buffer(struct media_request_object *obj)
1544 return obj->ops == &vb2_core_req_ops;
1546 EXPORT_SYMBOL_GPL(vb2_request_object_is_buffer);
1548 unsigned int vb2_request_buffer_cnt(struct media_request *req)
1550 struct media_request_object *obj;
1551 unsigned long flags;
1552 unsigned int buffer_cnt = 0;
1554 spin_lock_irqsave(&req->lock, flags);
1555 list_for_each_entry(obj, &req->objects, list)
1556 if (vb2_request_object_is_buffer(obj))
1558 spin_unlock_irqrestore(&req->lock, flags);
1562 EXPORT_SYMBOL_GPL(vb2_request_buffer_cnt);
1564 int vb2_core_prepare_buf(struct vb2_queue *q, unsigned int index, void *pb)
1566 struct vb2_buffer *vb;
1569 vb = q->bufs[index];
1570 if (vb->state != VB2_BUF_STATE_DEQUEUED) {
1571 dprintk(q, 1, "invalid buffer state %s\n",
1572 vb2_state_name(vb->state));
1576 dprintk(q, 1, "buffer already prepared\n");
1580 ret = __buf_prepare(vb);
1584 /* Fill buffer information for the userspace */
1585 call_void_bufop(q, fill_user_buffer, vb, pb);
1587 dprintk(q, 2, "prepare of buffer %d succeeded\n", vb->index);
1591 EXPORT_SYMBOL_GPL(vb2_core_prepare_buf);
1594 * vb2_start_streaming() - Attempt to start streaming.
1595 * @q: videobuf2 queue
1597 * Attempt to start streaming. When this function is called there must be
1598 * at least q->min_buffers_needed buffers queued up (i.e. the minimum
1599 * number of buffers required for the DMA engine to function). If the
1600 * @start_streaming op fails it is supposed to return all the driver-owned
1601 * buffers back to vb2 in state QUEUED. Check if that happened and if
1602 * not warn and reclaim them forcefully.
1604 static int vb2_start_streaming(struct vb2_queue *q)
1606 struct vb2_buffer *vb;
1610 * If any buffers were queued before streamon,
1611 * we can now pass them to driver for processing.
1613 list_for_each_entry(vb, &q->queued_list, queued_entry)
1614 __enqueue_in_driver(vb);
1616 /* Tell the driver to start streaming */
1617 q->start_streaming_called = 1;
1618 ret = call_qop(q, start_streaming, q,
1619 atomic_read(&q->owned_by_drv_count));
1623 q->start_streaming_called = 0;
1625 dprintk(q, 1, "driver refused to start streaming\n");
1627 * If you see this warning, then the driver isn't cleaning up properly
1628 * after a failed start_streaming(). See the start_streaming()
1629 * documentation in videobuf2-core.h for more information how buffers
1630 * should be returned to vb2 in start_streaming().
1632 if (WARN_ON(atomic_read(&q->owned_by_drv_count))) {
1636 * Forcefully reclaim buffers if the driver did not
1637 * correctly return them to vb2.
1639 for (i = 0; i < q->num_buffers; ++i) {
1641 if (vb->state == VB2_BUF_STATE_ACTIVE)
1642 vb2_buffer_done(vb, VB2_BUF_STATE_QUEUED);
1644 /* Must be zero now */
1645 WARN_ON(atomic_read(&q->owned_by_drv_count));
1648 * If done_list is not empty, then start_streaming() didn't call
1649 * vb2_buffer_done(vb, VB2_BUF_STATE_QUEUED) but STATE_ERROR or
1652 WARN_ON(!list_empty(&q->done_list));
1656 int vb2_core_qbuf(struct vb2_queue *q, unsigned int index, void *pb,
1657 struct media_request *req)
1659 struct vb2_buffer *vb;
1660 enum vb2_buffer_state orig_state;
1664 dprintk(q, 1, "fatal error occurred on queue\n");
1668 vb = q->bufs[index];
1670 if (!req && vb->state != VB2_BUF_STATE_IN_REQUEST &&
1671 q->requires_requests) {
1672 dprintk(q, 1, "qbuf requires a request\n");
1676 if ((req && q->uses_qbuf) ||
1677 (!req && vb->state != VB2_BUF_STATE_IN_REQUEST &&
1678 q->uses_requests)) {
1679 dprintk(q, 1, "queue in wrong mode (qbuf vs requests)\n");
1686 q->uses_requests = 1;
1687 if (vb->state != VB2_BUF_STATE_DEQUEUED) {
1688 dprintk(q, 1, "buffer %d not in dequeued state\n",
1693 if (q->is_output && !vb->prepared) {
1694 ret = call_vb_qop(vb, buf_out_validate, vb);
1696 dprintk(q, 1, "buffer validation failed\n");
1701 media_request_object_init(&vb->req_obj);
1703 /* Make sure the request is in a safe state for updating. */
1704 ret = media_request_lock_for_update(req);
1707 ret = media_request_object_bind(req, &vb2_core_req_ops,
1708 q, true, &vb->req_obj);
1709 media_request_unlock_for_update(req);
1713 vb->state = VB2_BUF_STATE_IN_REQUEST;
1716 * Increment the refcount and store the request.
1717 * The request refcount is decremented again when the
1718 * buffer is dequeued. This is to prevent vb2_buffer_done()
1719 * from freeing the request from interrupt context, which can
1720 * happen if the application closed the request fd after
1721 * queueing the request.
1723 media_request_get(req);
1726 /* Fill buffer information for the userspace */
1728 call_void_bufop(q, copy_timestamp, vb, pb);
1729 call_void_bufop(q, fill_user_buffer, vb, pb);
1732 dprintk(q, 2, "qbuf of buffer %d succeeded\n", vb->index);
1736 if (vb->state != VB2_BUF_STATE_IN_REQUEST)
1739 switch (vb->state) {
1740 case VB2_BUF_STATE_DEQUEUED:
1741 case VB2_BUF_STATE_IN_REQUEST:
1742 if (!vb->prepared) {
1743 ret = __buf_prepare(vb);
1748 case VB2_BUF_STATE_PREPARING:
1749 dprintk(q, 1, "buffer still being prepared\n");
1752 dprintk(q, 1, "invalid buffer state %s\n",
1753 vb2_state_name(vb->state));
1758 * Add to the queued buffers list, a buffer will stay on it until
1759 * dequeued in dqbuf.
1761 orig_state = vb->state;
1762 list_add_tail(&vb->queued_entry, &q->queued_list);
1764 q->waiting_for_buffers = false;
1765 vb->state = VB2_BUF_STATE_QUEUED;
1768 call_void_bufop(q, copy_timestamp, vb, pb);
1770 trace_vb2_qbuf(q, vb);
1773 * If already streaming, give the buffer to driver for processing.
1774 * If not, the buffer will be given to driver on next streamon.
1776 if (q->start_streaming_called)
1777 __enqueue_in_driver(vb);
1779 /* Fill buffer information for the userspace */
1781 call_void_bufop(q, fill_user_buffer, vb, pb);
1784 * If streamon has been called, and we haven't yet called
1785 * start_streaming() since not enough buffers were queued, and
1786 * we now have reached the minimum number of queued buffers,
1787 * then we can finally call start_streaming().
1789 if (q->streaming && !q->start_streaming_called &&
1790 q->queued_count >= q->min_buffers_needed) {
1791 ret = vb2_start_streaming(q);
1794 * Since vb2_core_qbuf will return with an error,
1795 * we should return it to state DEQUEUED since
1796 * the error indicates that the buffer wasn't queued.
1798 list_del(&vb->queued_entry);
1800 vb->state = orig_state;
1805 dprintk(q, 2, "qbuf of buffer %d succeeded\n", vb->index);
1808 EXPORT_SYMBOL_GPL(vb2_core_qbuf);
1811 * __vb2_wait_for_done_vb() - wait for a buffer to become available
1814 * Will sleep if required for nonblocking == false.
1816 static int __vb2_wait_for_done_vb(struct vb2_queue *q, int nonblocking)
1819 * All operations on vb_done_list are performed under done_lock
1820 * spinlock protection. However, buffers may be removed from
1821 * it and returned to userspace only while holding both driver's
1822 * lock and the done_lock spinlock. Thus we can be sure that as
1823 * long as we hold the driver's lock, the list will remain not
1824 * empty if list_empty() check succeeds.
1830 if (q->waiting_in_dqbuf) {
1831 dprintk(q, 1, "another dup()ped fd is waiting for a buffer\n");
1835 if (!q->streaming) {
1836 dprintk(q, 1, "streaming off, will not wait for buffers\n");
1841 dprintk(q, 1, "Queue in error state, will not wait for buffers\n");
1845 if (q->last_buffer_dequeued) {
1846 dprintk(q, 3, "last buffer dequeued already, will not wait for buffers\n");
1850 if (!list_empty(&q->done_list)) {
1852 * Found a buffer that we were waiting for.
1858 dprintk(q, 3, "nonblocking and no buffers to dequeue, will not wait\n");
1862 q->waiting_in_dqbuf = 1;
1864 * We are streaming and blocking, wait for another buffer to
1865 * become ready or for streamoff. Driver's lock is released to
1866 * allow streamoff or qbuf to be called while waiting.
1868 call_void_qop(q, wait_prepare, q);
1871 * All locks have been released, it is safe to sleep now.
1873 dprintk(q, 3, "will sleep waiting for buffers\n");
1874 ret = wait_event_interruptible(q->done_wq,
1875 !list_empty(&q->done_list) || !q->streaming ||
1879 * We need to reevaluate both conditions again after reacquiring
1880 * the locks or return an error if one occurred.
1882 call_void_qop(q, wait_finish, q);
1883 q->waiting_in_dqbuf = 0;
1885 dprintk(q, 1, "sleep was interrupted\n");
1893 * __vb2_get_done_vb() - get a buffer ready for dequeuing
1895 * Will sleep if required for nonblocking == false.
1897 static int __vb2_get_done_vb(struct vb2_queue *q, struct vb2_buffer **vb,
1898 void *pb, int nonblocking)
1900 unsigned long flags;
1904 * Wait for at least one buffer to become available on the done_list.
1906 ret = __vb2_wait_for_done_vb(q, nonblocking);
1911 * Driver's lock has been held since we last verified that done_list
1912 * is not empty, so no need for another list_empty(done_list) check.
1914 spin_lock_irqsave(&q->done_lock, flags);
1915 *vb = list_first_entry(&q->done_list, struct vb2_buffer, done_entry);
1917 * Only remove the buffer from done_list if all planes can be
1918 * handled. Some cases such as V4L2 file I/O and DVB have pb
1919 * == NULL; skip the check then as there's nothing to verify.
1922 ret = call_bufop(q, verify_planes_array, *vb, pb);
1924 list_del(&(*vb)->done_entry);
1925 spin_unlock_irqrestore(&q->done_lock, flags);
1930 int vb2_wait_for_all_buffers(struct vb2_queue *q)
1932 if (!q->streaming) {
1933 dprintk(q, 1, "streaming off, will not wait for buffers\n");
1937 if (q->start_streaming_called)
1938 wait_event(q->done_wq, !atomic_read(&q->owned_by_drv_count));
1941 EXPORT_SYMBOL_GPL(vb2_wait_for_all_buffers);
1944 * __vb2_dqbuf() - bring back the buffer to the DEQUEUED state
1946 static void __vb2_dqbuf(struct vb2_buffer *vb)
1948 struct vb2_queue *q = vb->vb2_queue;
1950 /* nothing to do if the buffer is already dequeued */
1951 if (vb->state == VB2_BUF_STATE_DEQUEUED)
1954 vb->state = VB2_BUF_STATE_DEQUEUED;
1956 call_void_bufop(q, init_buffer, vb);
1959 int vb2_core_dqbuf(struct vb2_queue *q, unsigned int *pindex, void *pb,
1962 struct vb2_buffer *vb = NULL;
1965 ret = __vb2_get_done_vb(q, &vb, pb, nonblocking);
1969 switch (vb->state) {
1970 case VB2_BUF_STATE_DONE:
1971 dprintk(q, 3, "returning done buffer\n");
1973 case VB2_BUF_STATE_ERROR:
1974 dprintk(q, 3, "returning done buffer with errors\n");
1977 dprintk(q, 1, "invalid buffer state %s\n",
1978 vb2_state_name(vb->state));
1982 call_void_vb_qop(vb, buf_finish, vb);
1986 *pindex = vb->index;
1988 /* Fill buffer information for the userspace */
1990 call_void_bufop(q, fill_user_buffer, vb, pb);
1992 /* Remove from vb2 queue */
1993 list_del(&vb->queued_entry);
1996 trace_vb2_dqbuf(q, vb);
1998 /* go back to dequeued state */
2001 if (WARN_ON(vb->req_obj.req)) {
2002 media_request_object_unbind(&vb->req_obj);
2003 media_request_object_put(&vb->req_obj);
2006 media_request_put(vb->request);
2009 dprintk(q, 2, "dqbuf of buffer %d, state: %s\n",
2010 vb->index, vb2_state_name(vb->state));
2015 EXPORT_SYMBOL_GPL(vb2_core_dqbuf);
2018 * __vb2_queue_cancel() - cancel and stop (pause) streaming
2020 * Removes all queued buffers from driver's queue and all buffers queued by
2021 * userspace from vb2's queue. Returns to state after reqbufs.
2023 static void __vb2_queue_cancel(struct vb2_queue *q)
2028 * Tell driver to stop all transactions and release all queued
2031 if (q->start_streaming_called)
2032 call_void_qop(q, stop_streaming, q);
2035 call_void_qop(q, unprepare_streaming, q);
2038 * If you see this warning, then the driver isn't cleaning up properly
2039 * in stop_streaming(). See the stop_streaming() documentation in
2040 * videobuf2-core.h for more information how buffers should be returned
2041 * to vb2 in stop_streaming().
2043 if (WARN_ON(atomic_read(&q->owned_by_drv_count))) {
2044 for (i = 0; i < q->num_buffers; ++i)
2045 if (q->bufs[i]->state == VB2_BUF_STATE_ACTIVE) {
2046 pr_warn("driver bug: stop_streaming operation is leaving buf %p in active state\n",
2048 vb2_buffer_done(q->bufs[i], VB2_BUF_STATE_ERROR);
2050 /* Must be zero now */
2051 WARN_ON(atomic_read(&q->owned_by_drv_count));
2055 q->start_streaming_called = 0;
2056 q->queued_count = 0;
2058 q->uses_requests = 0;
2062 * Remove all buffers from vb2's list...
2064 INIT_LIST_HEAD(&q->queued_list);
2066 * ...and done list; userspace will not receive any buffers it
2067 * has not already dequeued before initiating cancel.
2069 INIT_LIST_HEAD(&q->done_list);
2070 atomic_set(&q->owned_by_drv_count, 0);
2071 wake_up_all(&q->done_wq);
2074 * Reinitialize all buffers for next use.
2075 * Make sure to call buf_finish for any queued buffers. Normally
2076 * that's done in dqbuf, but that's not going to happen when we
2077 * cancel the whole queue. Note: this code belongs here, not in
2078 * __vb2_dqbuf() since in vb2_core_dqbuf() there is a critical
2079 * call to __fill_user_buffer() after buf_finish(). That order can't
2080 * be changed, so we can't move the buf_finish() to __vb2_dqbuf().
2082 for (i = 0; i < q->num_buffers; ++i) {
2083 struct vb2_buffer *vb = q->bufs[i];
2084 struct media_request *req = vb->req_obj.req;
2087 * If a request is associated with this buffer, then
2088 * call buf_request_cancel() to give the driver to complete()
2089 * related request objects. Otherwise those objects would
2093 enum media_request_state state;
2094 unsigned long flags;
2096 spin_lock_irqsave(&req->lock, flags);
2098 spin_unlock_irqrestore(&req->lock, flags);
2100 if (state == MEDIA_REQUEST_STATE_QUEUED)
2101 call_void_vb_qop(vb, buf_request_complete, vb);
2104 __vb2_buf_mem_finish(vb);
2107 call_void_vb_qop(vb, buf_finish, vb);
2112 if (vb->req_obj.req) {
2113 media_request_object_unbind(&vb->req_obj);
2114 media_request_object_put(&vb->req_obj);
2117 media_request_put(vb->request);
2119 vb->copied_timestamp = 0;
2123 int vb2_core_streamon(struct vb2_queue *q, unsigned int type)
2127 if (type != q->type) {
2128 dprintk(q, 1, "invalid stream type\n");
2133 dprintk(q, 3, "already streaming\n");
2137 if (!q->num_buffers) {
2138 dprintk(q, 1, "no buffers have been allocated\n");
2142 if (q->num_buffers < q->min_buffers_needed) {
2143 dprintk(q, 1, "need at least %u allocated buffers\n",
2144 q->min_buffers_needed);
2148 ret = call_qop(q, prepare_streaming, q);
2153 * Tell driver to start streaming provided sufficient buffers
2156 if (q->queued_count >= q->min_buffers_needed) {
2157 ret = vb2_start_streaming(q);
2164 dprintk(q, 3, "successful\n");
2168 call_void_qop(q, unprepare_streaming, q);
2171 EXPORT_SYMBOL_GPL(vb2_core_streamon);
2173 void vb2_queue_error(struct vb2_queue *q)
2177 wake_up_all(&q->done_wq);
2179 EXPORT_SYMBOL_GPL(vb2_queue_error);
2181 int vb2_core_streamoff(struct vb2_queue *q, unsigned int type)
2183 if (type != q->type) {
2184 dprintk(q, 1, "invalid stream type\n");
2189 * Cancel will pause streaming and remove all buffers from the driver
2190 * and vb2, effectively returning control over them to userspace.
2192 * Note that we do this even if q->streaming == 0: if you prepare or
2193 * queue buffers, and then call streamoff without ever having called
2194 * streamon, you would still expect those buffers to be returned to
2195 * their normal dequeued state.
2197 __vb2_queue_cancel(q);
2198 q->waiting_for_buffers = !q->is_output;
2199 q->last_buffer_dequeued = false;
2201 dprintk(q, 3, "successful\n");
2204 EXPORT_SYMBOL_GPL(vb2_core_streamoff);
2207 * __find_plane_by_offset() - find plane associated with the given offset off
2209 static int __find_plane_by_offset(struct vb2_queue *q, unsigned long off,
2210 unsigned int *_buffer, unsigned int *_plane)
2212 struct vb2_buffer *vb;
2213 unsigned int buffer, plane;
2216 * Sanity checks to ensure the lock is held, MEMORY_MMAP is
2217 * used and fileio isn't active.
2219 lockdep_assert_held(&q->mmap_lock);
2221 if (q->memory != VB2_MEMORY_MMAP) {
2222 dprintk(q, 1, "queue is not currently set up for mmap\n");
2226 if (vb2_fileio_is_active(q)) {
2227 dprintk(q, 1, "file io in progress\n");
2232 * Go over all buffers and their planes, comparing the given offset
2233 * with an offset assigned to each plane. If a match is found,
2234 * return its buffer and plane numbers.
2236 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
2237 vb = q->bufs[buffer];
2239 for (plane = 0; plane < vb->num_planes; ++plane) {
2240 if (vb->planes[plane].m.offset == off) {
2251 int vb2_core_expbuf(struct vb2_queue *q, int *fd, unsigned int type,
2252 unsigned int index, unsigned int plane, unsigned int flags)
2254 struct vb2_buffer *vb = NULL;
2255 struct vb2_plane *vb_plane;
2257 struct dma_buf *dbuf;
2259 if (q->memory != VB2_MEMORY_MMAP) {
2260 dprintk(q, 1, "queue is not currently set up for mmap\n");
2264 if (!q->mem_ops->get_dmabuf) {
2265 dprintk(q, 1, "queue does not support DMA buffer exporting\n");
2269 if (flags & ~(O_CLOEXEC | O_ACCMODE)) {
2270 dprintk(q, 1, "queue does support only O_CLOEXEC and access mode flags\n");
2274 if (type != q->type) {
2275 dprintk(q, 1, "invalid buffer type\n");
2279 if (index >= q->num_buffers) {
2280 dprintk(q, 1, "buffer index out of range\n");
2284 vb = q->bufs[index];
2286 if (plane >= vb->num_planes) {
2287 dprintk(q, 1, "buffer plane out of range\n");
2291 if (vb2_fileio_is_active(q)) {
2292 dprintk(q, 1, "expbuf: file io in progress\n");
2296 vb_plane = &vb->planes[plane];
2298 dbuf = call_ptr_memop(get_dmabuf,
2302 if (IS_ERR_OR_NULL(dbuf)) {
2303 dprintk(q, 1, "failed to export buffer %d, plane %d\n",
2308 ret = dma_buf_fd(dbuf, flags & ~O_ACCMODE);
2310 dprintk(q, 3, "buffer %d, plane %d failed to export (%d)\n",
2316 dprintk(q, 3, "buffer %d, plane %d exported as %d descriptor\n",
2322 EXPORT_SYMBOL_GPL(vb2_core_expbuf);
2324 int vb2_mmap(struct vb2_queue *q, struct vm_area_struct *vma)
2326 unsigned long off = vma->vm_pgoff << PAGE_SHIFT;
2327 struct vb2_buffer *vb;
2328 unsigned int buffer = 0, plane = 0;
2330 unsigned long length;
2333 * Check memory area access mode.
2335 if (!(vma->vm_flags & VM_SHARED)) {
2336 dprintk(q, 1, "invalid vma flags, VM_SHARED needed\n");
2340 if (!(vma->vm_flags & VM_WRITE)) {
2341 dprintk(q, 1, "invalid vma flags, VM_WRITE needed\n");
2345 if (!(vma->vm_flags & VM_READ)) {
2346 dprintk(q, 1, "invalid vma flags, VM_READ needed\n");
2351 mutex_lock(&q->mmap_lock);
2354 * Find the plane corresponding to the offset passed by userspace. This
2355 * will return an error if not MEMORY_MMAP or file I/O is in progress.
2357 ret = __find_plane_by_offset(q, off, &buffer, &plane);
2361 vb = q->bufs[buffer];
2364 * MMAP requires page_aligned buffers.
2365 * The buffer length was page_aligned at __vb2_buf_mem_alloc(),
2366 * so, we need to do the same here.
2368 length = PAGE_ALIGN(vb->planes[plane].length);
2369 if (length < (vma->vm_end - vma->vm_start)) {
2371 "MMAP invalid, as it would overflow buffer length\n");
2377 * vm_pgoff is treated in V4L2 API as a 'cookie' to select a buffer,
2378 * not as a in-buffer offset. We always want to mmap a whole buffer
2379 * from its beginning.
2383 ret = call_memop(vb, mmap, vb->planes[plane].mem_priv, vma);
2386 mutex_unlock(&q->mmap_lock);
2390 dprintk(q, 3, "buffer %d, plane %d successfully mapped\n", buffer, plane);
2393 EXPORT_SYMBOL_GPL(vb2_mmap);
2396 unsigned long vb2_get_unmapped_area(struct vb2_queue *q,
2399 unsigned long pgoff,
2400 unsigned long flags)
2402 unsigned long off = pgoff << PAGE_SHIFT;
2403 struct vb2_buffer *vb;
2404 unsigned int buffer, plane;
2408 mutex_lock(&q->mmap_lock);
2411 * Find the plane corresponding to the offset passed by userspace. This
2412 * will return an error if not MEMORY_MMAP or file I/O is in progress.
2414 ret = __find_plane_by_offset(q, off, &buffer, &plane);
2418 vb = q->bufs[buffer];
2420 vaddr = vb2_plane_vaddr(vb, plane);
2421 mutex_unlock(&q->mmap_lock);
2422 return vaddr ? (unsigned long)vaddr : -EINVAL;
2425 mutex_unlock(&q->mmap_lock);
2428 EXPORT_SYMBOL_GPL(vb2_get_unmapped_area);
2431 int vb2_core_queue_init(struct vb2_queue *q)
2438 WARN_ON(!q->mem_ops) ||
2439 WARN_ON(!q->type) ||
2440 WARN_ON(!q->io_modes) ||
2441 WARN_ON(!q->ops->queue_setup) ||
2442 WARN_ON(!q->ops->buf_queue))
2445 if (WARN_ON(q->requires_requests && !q->supports_requests))
2449 * This combination is not allowed since a non-zero value of
2450 * q->min_buffers_needed can cause vb2_core_qbuf() to fail if
2451 * it has to call start_streaming(), and the Request API expects
2452 * that queueing a request (and thus queueing a buffer contained
2453 * in that request) will always succeed. There is no method of
2454 * propagating an error back to userspace.
2456 if (WARN_ON(q->supports_requests && q->min_buffers_needed))
2459 INIT_LIST_HEAD(&q->queued_list);
2460 INIT_LIST_HEAD(&q->done_list);
2461 spin_lock_init(&q->done_lock);
2462 mutex_init(&q->mmap_lock);
2463 init_waitqueue_head(&q->done_wq);
2465 q->memory = VB2_MEMORY_UNKNOWN;
2467 if (q->buf_struct_size == 0)
2468 q->buf_struct_size = sizeof(struct vb2_buffer);
2470 if (q->bidirectional)
2471 q->dma_dir = DMA_BIDIRECTIONAL;
2473 q->dma_dir = q->is_output ? DMA_TO_DEVICE : DMA_FROM_DEVICE;
2475 if (q->name[0] == '\0')
2476 snprintf(q->name, sizeof(q->name), "%s-%p",
2477 q->is_output ? "out" : "cap", q);
2481 EXPORT_SYMBOL_GPL(vb2_core_queue_init);
2483 static int __vb2_init_fileio(struct vb2_queue *q, int read);
2484 static int __vb2_cleanup_fileio(struct vb2_queue *q);
2485 void vb2_core_queue_release(struct vb2_queue *q)
2487 __vb2_cleanup_fileio(q);
2488 __vb2_queue_cancel(q);
2489 mutex_lock(&q->mmap_lock);
2490 __vb2_queue_free(q, q->num_buffers);
2491 mutex_unlock(&q->mmap_lock);
2493 EXPORT_SYMBOL_GPL(vb2_core_queue_release);
2495 __poll_t vb2_core_poll(struct vb2_queue *q, struct file *file,
2498 __poll_t req_events = poll_requested_events(wait);
2499 struct vb2_buffer *vb = NULL;
2500 unsigned long flags;
2503 * poll_wait() MUST be called on the first invocation on all the
2504 * potential queues of interest, even if we are not interested in their
2505 * events during this first call. Failure to do so will result in
2506 * queue's events to be ignored because the poll_table won't be capable
2507 * of adding new wait queues thereafter.
2509 poll_wait(file, &q->done_wq, wait);
2511 if (!q->is_output && !(req_events & (EPOLLIN | EPOLLRDNORM)))
2513 if (q->is_output && !(req_events & (EPOLLOUT | EPOLLWRNORM)))
2517 * Start file I/O emulator only if streaming API has not been used yet.
2519 if (q->num_buffers == 0 && !vb2_fileio_is_active(q)) {
2520 if (!q->is_output && (q->io_modes & VB2_READ) &&
2521 (req_events & (EPOLLIN | EPOLLRDNORM))) {
2522 if (__vb2_init_fileio(q, 1))
2525 if (q->is_output && (q->io_modes & VB2_WRITE) &&
2526 (req_events & (EPOLLOUT | EPOLLWRNORM))) {
2527 if (__vb2_init_fileio(q, 0))
2530 * Write to OUTPUT queue can be done immediately.
2532 return EPOLLOUT | EPOLLWRNORM;
2537 * There is nothing to wait for if the queue isn't streaming, or if the
2538 * error flag is set.
2540 if (!vb2_is_streaming(q) || q->error)
2544 * If this quirk is set and QBUF hasn't been called yet then
2545 * return EPOLLERR as well. This only affects capture queues, output
2546 * queues will always initialize waiting_for_buffers to false.
2547 * This quirk is set by V4L2 for backwards compatibility reasons.
2549 if (q->quirk_poll_must_check_waiting_for_buffers &&
2550 q->waiting_for_buffers && (req_events & (EPOLLIN | EPOLLRDNORM)))
2554 * For output streams you can call write() as long as there are fewer
2555 * buffers queued than there are buffers available.
2557 if (q->is_output && q->fileio && q->queued_count < q->num_buffers)
2558 return EPOLLOUT | EPOLLWRNORM;
2560 if (list_empty(&q->done_list)) {
2562 * If the last buffer was dequeued from a capture queue,
2563 * return immediately. DQBUF will return -EPIPE.
2565 if (q->last_buffer_dequeued)
2566 return EPOLLIN | EPOLLRDNORM;
2570 * Take first buffer available for dequeuing.
2572 spin_lock_irqsave(&q->done_lock, flags);
2573 if (!list_empty(&q->done_list))
2574 vb = list_first_entry(&q->done_list, struct vb2_buffer,
2576 spin_unlock_irqrestore(&q->done_lock, flags);
2578 if (vb && (vb->state == VB2_BUF_STATE_DONE
2579 || vb->state == VB2_BUF_STATE_ERROR)) {
2580 return (q->is_output) ?
2581 EPOLLOUT | EPOLLWRNORM :
2582 EPOLLIN | EPOLLRDNORM;
2586 EXPORT_SYMBOL_GPL(vb2_core_poll);
2589 * struct vb2_fileio_buf - buffer context used by file io emulator
2591 * vb2 provides a compatibility layer and emulator of file io (read and
2592 * write) calls on top of streaming API. This structure is used for
2593 * tracking context related to the buffers.
2595 struct vb2_fileio_buf {
2599 unsigned int queued:1;
2603 * struct vb2_fileio_data - queue context used by file io emulator
2605 * @cur_index: the index of the buffer currently being read from or
2606 * written to. If equal to q->num_buffers then a new buffer
2608 * @initial_index: in the read() case all buffers are queued up immediately
2609 * in __vb2_init_fileio() and __vb2_perform_fileio() just cycles
2610 * buffers. However, in the write() case no buffers are initially
2611 * queued, instead whenever a buffer is full it is queued up by
2612 * __vb2_perform_fileio(). Only once all available buffers have
2613 * been queued up will __vb2_perform_fileio() start to dequeue
2614 * buffers. This means that initially __vb2_perform_fileio()
2615 * needs to know what buffer index to use when it is queuing up
2616 * the buffers for the first time. That initial index is stored
2617 * in this field. Once it is equal to q->num_buffers all
2618 * available buffers have been queued and __vb2_perform_fileio()
2619 * should start the normal dequeue/queue cycle.
2621 * vb2 provides a compatibility layer and emulator of file io (read and
2622 * write) calls on top of streaming API. For proper operation it required
2623 * this structure to save the driver state between each call of the read
2624 * or write function.
2626 struct vb2_fileio_data {
2629 unsigned int memory;
2630 struct vb2_fileio_buf bufs[VB2_MAX_FRAME];
2631 unsigned int cur_index;
2632 unsigned int initial_index;
2633 unsigned int q_count;
2634 unsigned int dq_count;
2635 unsigned read_once:1;
2636 unsigned write_immediately:1;
2640 * __vb2_init_fileio() - initialize file io emulator
2641 * @q: videobuf2 queue
2642 * @read: mode selector (1 means read, 0 means write)
2644 static int __vb2_init_fileio(struct vb2_queue *q, int read)
2646 struct vb2_fileio_data *fileio;
2648 unsigned int count = 0;
2653 if (WARN_ON((read && !(q->io_modes & VB2_READ)) ||
2654 (!read && !(q->io_modes & VB2_WRITE))))
2658 * Check if device supports mapping buffers to kernel virtual space.
2660 if (!q->mem_ops->vaddr)
2664 * Check if streaming api has not been already activated.
2666 if (q->streaming || q->num_buffers > 0)
2670 * Start with count 1, driver can increase it in queue_setup()
2674 dprintk(q, 3, "setting up file io: mode %s, count %d, read_once %d, write_immediately %d\n",
2675 (read) ? "read" : "write", count, q->fileio_read_once,
2676 q->fileio_write_immediately);
2678 fileio = kzalloc(sizeof(*fileio), GFP_KERNEL);
2682 fileio->read_once = q->fileio_read_once;
2683 fileio->write_immediately = q->fileio_write_immediately;
2686 * Request buffers and use MMAP type to force driver
2687 * to allocate buffers by itself.
2689 fileio->count = count;
2690 fileio->memory = VB2_MEMORY_MMAP;
2691 fileio->type = q->type;
2693 ret = vb2_core_reqbufs(q, fileio->memory, 0, &fileio->count);
2698 * Check if plane_count is correct
2699 * (multiplane buffers are not supported).
2701 if (q->bufs[0]->num_planes != 1) {
2707 * Get kernel address of each buffer.
2709 for (i = 0; i < q->num_buffers; i++) {
2710 fileio->bufs[i].vaddr = vb2_plane_vaddr(q->bufs[i], 0);
2711 if (fileio->bufs[i].vaddr == NULL) {
2715 fileio->bufs[i].size = vb2_plane_size(q->bufs[i], 0);
2719 * Read mode requires pre queuing of all buffers.
2723 * Queue all buffers.
2725 for (i = 0; i < q->num_buffers; i++) {
2726 ret = vb2_core_qbuf(q, i, NULL, NULL);
2729 fileio->bufs[i].queued = 1;
2732 * All buffers have been queued, so mark that by setting
2733 * initial_index to q->num_buffers
2735 fileio->initial_index = q->num_buffers;
2736 fileio->cur_index = q->num_buffers;
2742 ret = vb2_core_streamon(q, q->type);
2750 vb2_core_reqbufs(q, fileio->memory, 0, &fileio->count);
2759 * __vb2_cleanup_fileio() - free resourced used by file io emulator
2760 * @q: videobuf2 queue
2762 static int __vb2_cleanup_fileio(struct vb2_queue *q)
2764 struct vb2_fileio_data *fileio = q->fileio;
2767 vb2_core_streamoff(q, q->type);
2770 vb2_core_reqbufs(q, fileio->memory, 0, &fileio->count);
2772 dprintk(q, 3, "file io emulator closed\n");
2778 * __vb2_perform_fileio() - perform a single file io (read or write) operation
2779 * @q: videobuf2 queue
2780 * @data: pointed to target userspace buffer
2781 * @count: number of bytes to read or write
2782 * @ppos: file handle position tracking pointer
2783 * @nonblock: mode selector (1 means blocking calls, 0 means nonblocking)
2784 * @read: access mode selector (1 means read, 0 means write)
2786 static size_t __vb2_perform_fileio(struct vb2_queue *q, char __user *data, size_t count,
2787 loff_t *ppos, int nonblock, int read)
2789 struct vb2_fileio_data *fileio;
2790 struct vb2_fileio_buf *buf;
2791 bool is_multiplanar = q->is_multiplanar;
2793 * When using write() to write data to an output video node the vb2 core
2794 * should copy timestamps if V4L2_BUF_FLAG_TIMESTAMP_COPY is set. Nobody
2795 * else is able to provide this information with the write() operation.
2797 bool copy_timestamp = !read && q->copy_timestamp;
2801 dprintk(q, 3, "mode %s, offset %ld, count %zd, %sblocking\n",
2802 read ? "read" : "write", (long)*ppos, count,
2803 nonblock ? "non" : "");
2808 if (q->waiting_in_dqbuf) {
2809 dprintk(q, 3, "another dup()ped fd is %s\n",
2810 read ? "reading" : "writing");
2815 * Initialize emulator on first call.
2817 if (!vb2_fileio_is_active(q)) {
2818 ret = __vb2_init_fileio(q, read);
2819 dprintk(q, 3, "vb2_init_fileio result: %d\n", ret);
2826 * Check if we need to dequeue the buffer.
2828 index = fileio->cur_index;
2829 if (index >= q->num_buffers) {
2830 struct vb2_buffer *b;
2833 * Call vb2_dqbuf to get buffer back.
2835 ret = vb2_core_dqbuf(q, &index, NULL, nonblock);
2836 dprintk(q, 5, "vb2_dqbuf result: %d\n", ret);
2839 fileio->dq_count += 1;
2841 fileio->cur_index = index;
2842 buf = &fileio->bufs[index];
2846 * Get number of bytes filled by the driver
2850 buf->size = read ? vb2_get_plane_payload(q->bufs[index], 0)
2851 : vb2_plane_size(q->bufs[index], 0);
2852 /* Compensate for data_offset on read in the multiplanar case. */
2853 if (is_multiplanar && read &&
2854 b->planes[0].data_offset < buf->size) {
2855 buf->pos = b->planes[0].data_offset;
2856 buf->size -= buf->pos;
2859 buf = &fileio->bufs[index];
2863 * Limit count on last few bytes of the buffer.
2865 if (buf->pos + count > buf->size) {
2866 count = buf->size - buf->pos;
2867 dprintk(q, 5, "reducing read count: %zd\n", count);
2871 * Transfer data to userspace.
2873 dprintk(q, 3, "copying %zd bytes - buffer %d, offset %u\n",
2874 count, index, buf->pos);
2876 ret = copy_to_user(data, buf->vaddr + buf->pos, count);
2878 ret = copy_from_user(buf->vaddr + buf->pos, data, count);
2880 dprintk(q, 3, "error copying data\n");
2891 * Queue next buffer if required.
2893 if (buf->pos == buf->size || (!read && fileio->write_immediately)) {
2894 struct vb2_buffer *b = q->bufs[index];
2897 * Check if this is the last buffer to read.
2899 if (read && fileio->read_once && fileio->dq_count == 1) {
2900 dprintk(q, 3, "read limit reached\n");
2901 return __vb2_cleanup_fileio(q);
2905 * Call vb2_qbuf and give buffer to the driver.
2907 b->planes[0].bytesused = buf->pos;
2910 b->timestamp = ktime_get_ns();
2911 ret = vb2_core_qbuf(q, index, NULL, NULL);
2912 dprintk(q, 5, "vb2_dbuf result: %d\n", ret);
2917 * Buffer has been queued, update the status
2921 buf->size = vb2_plane_size(q->bufs[index], 0);
2922 fileio->q_count += 1;
2924 * If we are queuing up buffers for the first time, then
2925 * increase initial_index by one.
2927 if (fileio->initial_index < q->num_buffers)
2928 fileio->initial_index++;
2930 * The next buffer to use is either a buffer that's going to be
2931 * queued for the first time (initial_index < q->num_buffers)
2932 * or it is equal to q->num_buffers, meaning that the next
2933 * time we need to dequeue a buffer since we've now queued up
2934 * all the 'first time' buffers.
2936 fileio->cur_index = fileio->initial_index;
2940 * Return proper number of bytes processed.
2947 size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count,
2948 loff_t *ppos, int nonblocking)
2950 return __vb2_perform_fileio(q, data, count, ppos, nonblocking, 1);
2952 EXPORT_SYMBOL_GPL(vb2_read);
2954 size_t vb2_write(struct vb2_queue *q, const char __user *data, size_t count,
2955 loff_t *ppos, int nonblocking)
2957 return __vb2_perform_fileio(q, (char __user *) data, count,
2958 ppos, nonblocking, 0);
2960 EXPORT_SYMBOL_GPL(vb2_write);
2962 struct vb2_threadio_data {
2963 struct task_struct *thread;
2969 static int vb2_thread(void *data)
2971 struct vb2_queue *q = data;
2972 struct vb2_threadio_data *threadio = q->threadio;
2973 bool copy_timestamp = false;
2974 unsigned prequeue = 0;
2979 prequeue = q->num_buffers;
2980 copy_timestamp = q->copy_timestamp;
2986 struct vb2_buffer *vb;
2989 * Call vb2_dqbuf to get buffer back.
2992 vb = q->bufs[index++];
2995 call_void_qop(q, wait_finish, q);
2996 if (!threadio->stop)
2997 ret = vb2_core_dqbuf(q, &index, NULL, 0);
2998 call_void_qop(q, wait_prepare, q);
2999 dprintk(q, 5, "file io: vb2_dqbuf result: %d\n", ret);
3001 vb = q->bufs[index];
3003 if (ret || threadio->stop)
3007 if (vb->state != VB2_BUF_STATE_ERROR)
3008 if (threadio->fnc(vb, threadio->priv))
3010 call_void_qop(q, wait_finish, q);
3012 vb->timestamp = ktime_get_ns();
3013 if (!threadio->stop)
3014 ret = vb2_core_qbuf(q, vb->index, NULL, NULL);
3015 call_void_qop(q, wait_prepare, q);
3016 if (ret || threadio->stop)
3020 /* Hmm, linux becomes *very* unhappy without this ... */
3021 while (!kthread_should_stop()) {
3022 set_current_state(TASK_INTERRUPTIBLE);
3029 * This function should not be used for anything else but the videobuf2-dvb
3030 * support. If you think you have another good use-case for this, then please
3031 * contact the linux-media mailinglist first.
3033 int vb2_thread_start(struct vb2_queue *q, vb2_thread_fnc fnc, void *priv,
3034 const char *thread_name)
3036 struct vb2_threadio_data *threadio;
3043 if (WARN_ON(q->fileio))
3046 threadio = kzalloc(sizeof(*threadio), GFP_KERNEL);
3047 if (threadio == NULL)
3049 threadio->fnc = fnc;
3050 threadio->priv = priv;
3052 ret = __vb2_init_fileio(q, !q->is_output);
3053 dprintk(q, 3, "file io: vb2_init_fileio result: %d\n", ret);
3056 q->threadio = threadio;
3057 threadio->thread = kthread_run(vb2_thread, q, "vb2-%s", thread_name);
3058 if (IS_ERR(threadio->thread)) {
3059 ret = PTR_ERR(threadio->thread);
3060 threadio->thread = NULL;
3066 __vb2_cleanup_fileio(q);
3071 EXPORT_SYMBOL_GPL(vb2_thread_start);
3073 int vb2_thread_stop(struct vb2_queue *q)
3075 struct vb2_threadio_data *threadio = q->threadio;
3078 if (threadio == NULL)
3080 threadio->stop = true;
3081 /* Wake up all pending sleeps in the thread */
3083 err = kthread_stop(threadio->thread);
3084 __vb2_cleanup_fileio(q);
3085 threadio->thread = NULL;
3090 EXPORT_SYMBOL_GPL(vb2_thread_stop);
3092 MODULE_DESCRIPTION("Media buffer core framework");
3093 MODULE_AUTHOR("Pawel Osciak <pawel@osciak.com>, Marek Szyprowski");
3094 MODULE_LICENSE("GPL");
3095 MODULE_IMPORT_NS(DMA_BUF);