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(level, fmt, arg...) \
40 pr_info("%s: " fmt, __func__, ## arg); \
43 #ifdef CONFIG_VIDEO_ADV_DEBUG
46 * If advanced debugging is on, then count how often each op is called
47 * successfully, which can either be per-buffer or per-queue.
49 * This makes it easy to check that the 'init' and 'cleanup'
50 * (and variations thereof) stay balanced.
53 #define log_memop(vb, op) \
54 dprintk(2, "call_memop(%p, %d, %s)%s\n", \
55 (vb)->vb2_queue, (vb)->index, #op, \
56 (vb)->vb2_queue->mem_ops->op ? "" : " (nop)")
58 #define call_memop(vb, op, args...) \
60 struct vb2_queue *_q = (vb)->vb2_queue; \
64 err = _q->mem_ops->op ? _q->mem_ops->op(args) : 0; \
66 (vb)->cnt_mem_ ## op++; \
70 #define call_ptr_memop(vb, op, args...) \
72 struct vb2_queue *_q = (vb)->vb2_queue; \
76 ptr = _q->mem_ops->op ? _q->mem_ops->op(args) : NULL; \
77 if (!IS_ERR_OR_NULL(ptr)) \
78 (vb)->cnt_mem_ ## op++; \
82 #define call_void_memop(vb, op, args...) \
84 struct vb2_queue *_q = (vb)->vb2_queue; \
87 if (_q->mem_ops->op) \
88 _q->mem_ops->op(args); \
89 (vb)->cnt_mem_ ## op++; \
92 #define log_qop(q, op) \
93 dprintk(2, "call_qop(%p, %s)%s\n", q, #op, \
94 (q)->ops->op ? "" : " (nop)")
96 #define call_qop(q, op, args...) \
101 err = (q)->ops->op ? (q)->ops->op(args) : 0; \
107 #define call_void_qop(q, op, args...) \
111 (q)->ops->op(args); \
115 #define log_vb_qop(vb, op, args...) \
116 dprintk(2, "call_vb_qop(%p, %d, %s)%s\n", \
117 (vb)->vb2_queue, (vb)->index, #op, \
118 (vb)->vb2_queue->ops->op ? "" : " (nop)")
120 #define call_vb_qop(vb, op, args...) \
124 log_vb_qop(vb, op); \
125 err = (vb)->vb2_queue->ops->op ? \
126 (vb)->vb2_queue->ops->op(args) : 0; \
128 (vb)->cnt_ ## op++; \
132 #define call_void_vb_qop(vb, op, args...) \
134 log_vb_qop(vb, op); \
135 if ((vb)->vb2_queue->ops->op) \
136 (vb)->vb2_queue->ops->op(args); \
137 (vb)->cnt_ ## op++; \
142 #define call_memop(vb, op, args...) \
143 ((vb)->vb2_queue->mem_ops->op ? \
144 (vb)->vb2_queue->mem_ops->op(args) : 0)
146 #define call_ptr_memop(vb, op, args...) \
147 ((vb)->vb2_queue->mem_ops->op ? \
148 (vb)->vb2_queue->mem_ops->op(args) : NULL)
150 #define call_void_memop(vb, op, args...) \
152 if ((vb)->vb2_queue->mem_ops->op) \
153 (vb)->vb2_queue->mem_ops->op(args); \
156 #define call_qop(q, op, args...) \
157 ((q)->ops->op ? (q)->ops->op(args) : 0)
159 #define call_void_qop(q, op, args...) \
162 (q)->ops->op(args); \
165 #define call_vb_qop(vb, op, args...) \
166 ((vb)->vb2_queue->ops->op ? (vb)->vb2_queue->ops->op(args) : 0)
168 #define call_void_vb_qop(vb, op, args...) \
170 if ((vb)->vb2_queue->ops->op) \
171 (vb)->vb2_queue->ops->op(args); \
176 #define call_bufop(q, op, args...) \
179 if (q && q->buf_ops && q->buf_ops->op) \
180 ret = q->buf_ops->op(args); \
184 #define call_void_bufop(q, op, args...) \
186 if (q && q->buf_ops && q->buf_ops->op) \
187 q->buf_ops->op(args); \
190 static void __vb2_queue_cancel(struct vb2_queue *q);
191 static void __enqueue_in_driver(struct vb2_buffer *vb);
194 * __vb2_buf_mem_alloc() - allocate video memory for the given buffer
196 static int __vb2_buf_mem_alloc(struct vb2_buffer *vb)
198 struct vb2_queue *q = vb->vb2_queue;
204 * Allocate memory for all planes in this buffer
205 * NOTE: mmapped areas should be page aligned
207 for (plane = 0; plane < vb->num_planes; ++plane) {
208 unsigned long size = PAGE_ALIGN(vb->planes[plane].length);
210 mem_priv = call_ptr_memop(vb, alloc,
211 q->alloc_devs[plane] ? : q->dev,
212 q->dma_attrs, size, q->dma_dir, q->gfp_flags);
213 if (IS_ERR_OR_NULL(mem_priv)) {
215 ret = PTR_ERR(mem_priv);
219 /* Associate allocator private data with this plane */
220 vb->planes[plane].mem_priv = mem_priv;
225 /* Free already allocated memory if one of the allocations failed */
226 for (; plane > 0; --plane) {
227 call_void_memop(vb, put, vb->planes[plane - 1].mem_priv);
228 vb->planes[plane - 1].mem_priv = NULL;
235 * __vb2_buf_mem_free() - free memory of the given buffer
237 static void __vb2_buf_mem_free(struct vb2_buffer *vb)
241 for (plane = 0; plane < vb->num_planes; ++plane) {
242 call_void_memop(vb, put, vb->planes[plane].mem_priv);
243 vb->planes[plane].mem_priv = NULL;
244 dprintk(3, "freed plane %d of buffer %d\n", plane, vb->index);
249 * __vb2_buf_userptr_put() - release userspace memory associated with
252 static void __vb2_buf_userptr_put(struct vb2_buffer *vb)
256 for (plane = 0; plane < vb->num_planes; ++plane) {
257 if (vb->planes[plane].mem_priv)
258 call_void_memop(vb, put_userptr, vb->planes[plane].mem_priv);
259 vb->planes[plane].mem_priv = NULL;
264 * __vb2_plane_dmabuf_put() - release memory associated with
265 * a DMABUF shared plane
267 static void __vb2_plane_dmabuf_put(struct vb2_buffer *vb, struct vb2_plane *p)
273 call_void_memop(vb, unmap_dmabuf, p->mem_priv);
275 call_void_memop(vb, detach_dmabuf, p->mem_priv);
276 dma_buf_put(p->dbuf);
283 * __vb2_buf_dmabuf_put() - release memory associated with
284 * a DMABUF shared buffer
286 static void __vb2_buf_dmabuf_put(struct vb2_buffer *vb)
290 for (plane = 0; plane < vb->num_planes; ++plane)
291 __vb2_plane_dmabuf_put(vb, &vb->planes[plane]);
295 * __setup_offsets() - setup unique offsets ("cookies") for every plane in
298 static void __setup_offsets(struct vb2_buffer *vb)
300 struct vb2_queue *q = vb->vb2_queue;
302 unsigned long off = 0;
305 struct vb2_buffer *prev = q->bufs[vb->index - 1];
306 struct vb2_plane *p = &prev->planes[prev->num_planes - 1];
308 off = PAGE_ALIGN(p->m.offset + p->length);
311 for (plane = 0; plane < vb->num_planes; ++plane) {
312 vb->planes[plane].m.offset = off;
314 dprintk(3, "buffer %d, plane %d offset 0x%08lx\n",
315 vb->index, plane, off);
317 off += vb->planes[plane].length;
318 off = PAGE_ALIGN(off);
323 * __vb2_queue_alloc() - allocate videobuf buffer structures and (for MMAP type)
324 * video buffer memory for all buffers/planes on the queue and initializes the
327 * Returns the number of buffers successfully allocated.
329 static int __vb2_queue_alloc(struct vb2_queue *q, enum vb2_memory memory,
330 unsigned int num_buffers, unsigned int num_planes,
331 const unsigned plane_sizes[VB2_MAX_PLANES])
333 unsigned int buffer, plane;
334 struct vb2_buffer *vb;
337 /* Ensure that q->num_buffers+num_buffers is below VB2_MAX_FRAME */
338 num_buffers = min_t(unsigned int, num_buffers,
339 VB2_MAX_FRAME - q->num_buffers);
341 for (buffer = 0; buffer < num_buffers; ++buffer) {
342 /* Allocate videobuf buffer structures */
343 vb = kzalloc(q->buf_struct_size, GFP_KERNEL);
345 dprintk(1, "memory alloc for buffer struct failed\n");
349 vb->state = VB2_BUF_STATE_DEQUEUED;
351 vb->num_planes = num_planes;
352 vb->index = q->num_buffers + buffer;
355 for (plane = 0; plane < num_planes; ++plane) {
356 vb->planes[plane].length = plane_sizes[plane];
357 vb->planes[plane].min_length = plane_sizes[plane];
359 call_void_bufop(q, init_buffer, vb);
361 q->bufs[vb->index] = vb;
363 /* Allocate video buffer memory for the MMAP type */
364 if (memory == VB2_MEMORY_MMAP) {
365 ret = __vb2_buf_mem_alloc(vb);
367 dprintk(1, "failed allocating memory for buffer %d\n",
369 q->bufs[vb->index] = NULL;
375 * Call the driver-provided buffer initialization
376 * callback, if given. An error in initialization
377 * results in queue setup failure.
379 ret = call_vb_qop(vb, buf_init, vb);
381 dprintk(1, "buffer %d %p initialization failed\n",
383 __vb2_buf_mem_free(vb);
384 q->bufs[vb->index] = NULL;
391 dprintk(1, "allocated %d buffers, %d plane(s) each\n",
398 * __vb2_free_mem() - release all video buffer memory for a given queue
400 static void __vb2_free_mem(struct vb2_queue *q, unsigned int buffers)
403 struct vb2_buffer *vb;
405 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
407 vb = q->bufs[buffer];
411 /* Free MMAP buffers or release USERPTR buffers */
412 if (q->memory == VB2_MEMORY_MMAP)
413 __vb2_buf_mem_free(vb);
414 else if (q->memory == VB2_MEMORY_DMABUF)
415 __vb2_buf_dmabuf_put(vb);
417 __vb2_buf_userptr_put(vb);
422 * __vb2_queue_free() - free buffers at the end of the queue - video memory and
423 * related information, if no buffers are left return the queue to an
424 * uninitialized state. Might be called even if the queue has already been freed.
426 static int __vb2_queue_free(struct vb2_queue *q, unsigned int buffers)
431 * Sanity check: when preparing a buffer the queue lock is released for
432 * a short while (see __buf_prepare for the details), which would allow
433 * a race with a reqbufs which can call this function. Removing the
434 * buffers from underneath __buf_prepare is obviously a bad idea, so we
435 * check if any of the buffers is in the state PREPARING, and if so we
436 * just return -EAGAIN.
438 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
440 if (q->bufs[buffer] == NULL)
442 if (q->bufs[buffer]->state == VB2_BUF_STATE_PREPARING) {
443 dprintk(1, "preparing buffers, cannot free\n");
448 /* Call driver-provided cleanup function for each buffer, if provided */
449 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
451 struct vb2_buffer *vb = q->bufs[buffer];
453 if (vb && vb->planes[0].mem_priv)
454 call_void_vb_qop(vb, buf_cleanup, vb);
457 /* Release video buffer memory */
458 __vb2_free_mem(q, buffers);
460 #ifdef CONFIG_VIDEO_ADV_DEBUG
462 * Check that all the calls were balances during the life-time of this
463 * queue. If not (or if the debug level is 1 or up), then dump the
464 * counters to the kernel log.
466 if (q->num_buffers) {
467 bool unbalanced = q->cnt_start_streaming != q->cnt_stop_streaming ||
468 q->cnt_wait_prepare != q->cnt_wait_finish;
470 if (unbalanced || debug) {
471 pr_info("counters for queue %p:%s\n", q,
472 unbalanced ? " UNBALANCED!" : "");
473 pr_info(" setup: %u start_streaming: %u stop_streaming: %u\n",
474 q->cnt_queue_setup, q->cnt_start_streaming,
475 q->cnt_stop_streaming);
476 pr_info(" wait_prepare: %u wait_finish: %u\n",
477 q->cnt_wait_prepare, q->cnt_wait_finish);
479 q->cnt_queue_setup = 0;
480 q->cnt_wait_prepare = 0;
481 q->cnt_wait_finish = 0;
482 q->cnt_start_streaming = 0;
483 q->cnt_stop_streaming = 0;
485 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
486 struct vb2_buffer *vb = q->bufs[buffer];
487 bool unbalanced = vb->cnt_mem_alloc != vb->cnt_mem_put ||
488 vb->cnt_mem_prepare != vb->cnt_mem_finish ||
489 vb->cnt_mem_get_userptr != vb->cnt_mem_put_userptr ||
490 vb->cnt_mem_attach_dmabuf != vb->cnt_mem_detach_dmabuf ||
491 vb->cnt_mem_map_dmabuf != vb->cnt_mem_unmap_dmabuf ||
492 vb->cnt_buf_queue != vb->cnt_buf_done ||
493 vb->cnt_buf_prepare != vb->cnt_buf_finish ||
494 vb->cnt_buf_init != vb->cnt_buf_cleanup;
496 if (unbalanced || debug) {
497 pr_info(" counters for queue %p, buffer %d:%s\n",
498 q, buffer, unbalanced ? " UNBALANCED!" : "");
499 pr_info(" buf_init: %u buf_cleanup: %u buf_prepare: %u buf_finish: %u\n",
500 vb->cnt_buf_init, vb->cnt_buf_cleanup,
501 vb->cnt_buf_prepare, vb->cnt_buf_finish);
502 pr_info(" buf_queue: %u buf_done: %u buf_request_complete: %u\n",
503 vb->cnt_buf_queue, vb->cnt_buf_done,
504 vb->cnt_buf_request_complete);
505 pr_info(" alloc: %u put: %u prepare: %u finish: %u mmap: %u\n",
506 vb->cnt_mem_alloc, vb->cnt_mem_put,
507 vb->cnt_mem_prepare, vb->cnt_mem_finish,
509 pr_info(" get_userptr: %u put_userptr: %u\n",
510 vb->cnt_mem_get_userptr, vb->cnt_mem_put_userptr);
511 pr_info(" attach_dmabuf: %u detach_dmabuf: %u map_dmabuf: %u unmap_dmabuf: %u\n",
512 vb->cnt_mem_attach_dmabuf, vb->cnt_mem_detach_dmabuf,
513 vb->cnt_mem_map_dmabuf, vb->cnt_mem_unmap_dmabuf);
514 pr_info(" get_dmabuf: %u num_users: %u vaddr: %u cookie: %u\n",
515 vb->cnt_mem_get_dmabuf,
516 vb->cnt_mem_num_users,
523 /* Free videobuf buffers */
524 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
526 kfree(q->bufs[buffer]);
527 q->bufs[buffer] = NULL;
530 q->num_buffers -= buffers;
531 if (!q->num_buffers) {
532 q->memory = VB2_MEMORY_UNKNOWN;
533 INIT_LIST_HEAD(&q->queued_list);
538 bool vb2_buffer_in_use(struct vb2_queue *q, struct vb2_buffer *vb)
541 for (plane = 0; plane < vb->num_planes; ++plane) {
542 void *mem_priv = vb->planes[plane].mem_priv;
544 * If num_users() has not been provided, call_memop
545 * will return 0, apparently nobody cares about this
546 * case anyway. If num_users() returns more than 1,
547 * we are not the only user of the plane's memory.
549 if (mem_priv && call_memop(vb, num_users, mem_priv) > 1)
554 EXPORT_SYMBOL(vb2_buffer_in_use);
557 * __buffers_in_use() - return true if any buffers on the queue are in use and
558 * the queue cannot be freed (by the means of REQBUFS(0)) call
560 static bool __buffers_in_use(struct vb2_queue *q)
563 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
564 if (vb2_buffer_in_use(q, q->bufs[buffer]))
570 void vb2_core_querybuf(struct vb2_queue *q, unsigned int index, void *pb)
572 call_void_bufop(q, fill_user_buffer, q->bufs[index], pb);
574 EXPORT_SYMBOL_GPL(vb2_core_querybuf);
577 * __verify_userptr_ops() - verify that all memory operations required for
578 * USERPTR queue type have been provided
580 static int __verify_userptr_ops(struct vb2_queue *q)
582 if (!(q->io_modes & VB2_USERPTR) || !q->mem_ops->get_userptr ||
583 !q->mem_ops->put_userptr)
590 * __verify_mmap_ops() - verify that all memory operations required for
591 * MMAP queue type have been provided
593 static int __verify_mmap_ops(struct vb2_queue *q)
595 if (!(q->io_modes & VB2_MMAP) || !q->mem_ops->alloc ||
596 !q->mem_ops->put || !q->mem_ops->mmap)
603 * __verify_dmabuf_ops() - verify that all memory operations required for
604 * DMABUF queue type have been provided
606 static int __verify_dmabuf_ops(struct vb2_queue *q)
608 if (!(q->io_modes & VB2_DMABUF) || !q->mem_ops->attach_dmabuf ||
609 !q->mem_ops->detach_dmabuf || !q->mem_ops->map_dmabuf ||
610 !q->mem_ops->unmap_dmabuf)
616 int vb2_verify_memory_type(struct vb2_queue *q,
617 enum vb2_memory memory, unsigned int type)
619 if (memory != VB2_MEMORY_MMAP && memory != VB2_MEMORY_USERPTR &&
620 memory != VB2_MEMORY_DMABUF) {
621 dprintk(1, "unsupported memory type\n");
625 if (type != q->type) {
626 dprintk(1, "requested type is incorrect\n");
631 * Make sure all the required memory ops for given memory type
634 if (memory == VB2_MEMORY_MMAP && __verify_mmap_ops(q)) {
635 dprintk(1, "MMAP for current setup unsupported\n");
639 if (memory == VB2_MEMORY_USERPTR && __verify_userptr_ops(q)) {
640 dprintk(1, "USERPTR for current setup unsupported\n");
644 if (memory == VB2_MEMORY_DMABUF && __verify_dmabuf_ops(q)) {
645 dprintk(1, "DMABUF for current setup unsupported\n");
650 * Place the busy tests at the end: -EBUSY can be ignored when
651 * create_bufs is called with count == 0, but count == 0 should still
652 * do the memory and type validation.
654 if (vb2_fileio_is_active(q)) {
655 dprintk(1, "file io in progress\n");
660 EXPORT_SYMBOL(vb2_verify_memory_type);
662 int vb2_core_reqbufs(struct vb2_queue *q, enum vb2_memory memory,
665 unsigned int num_buffers, allocated_buffers, num_planes = 0;
666 unsigned plane_sizes[VB2_MAX_PLANES] = { };
671 dprintk(1, "streaming active\n");
675 if (*count == 0 || q->num_buffers != 0 ||
676 (q->memory != VB2_MEMORY_UNKNOWN && q->memory != memory)) {
678 * We already have buffers allocated, so first check if they
679 * are not in use and can be freed.
681 mutex_lock(&q->mmap_lock);
682 if (q->memory == VB2_MEMORY_MMAP && __buffers_in_use(q)) {
683 mutex_unlock(&q->mmap_lock);
684 dprintk(1, "memory in use, cannot free\n");
689 * Call queue_cancel to clean up any buffers in the
690 * QUEUED state which is possible if buffers were prepared or
691 * queued without ever calling STREAMON.
693 __vb2_queue_cancel(q);
694 ret = __vb2_queue_free(q, q->num_buffers);
695 mutex_unlock(&q->mmap_lock);
700 * In case of REQBUFS(0) return immediately without calling
701 * driver's queue_setup() callback and allocating resources.
708 * Make sure the requested values and current defaults are sane.
710 WARN_ON(q->min_buffers_needed > VB2_MAX_FRAME);
711 num_buffers = max_t(unsigned int, *count, q->min_buffers_needed);
712 num_buffers = min_t(unsigned int, num_buffers, VB2_MAX_FRAME);
713 memset(q->alloc_devs, 0, sizeof(q->alloc_devs));
717 * Ask the driver how many buffers and planes per buffer it requires.
718 * Driver also sets the size and allocator context for each plane.
720 ret = call_qop(q, queue_setup, q, &num_buffers, &num_planes,
721 plane_sizes, q->alloc_devs);
725 /* Check that driver has set sane values */
726 if (WARN_ON(!num_planes))
729 for (i = 0; i < num_planes; i++)
730 if (WARN_ON(!plane_sizes[i]))
733 /* Finally, allocate buffers and video memory */
735 __vb2_queue_alloc(q, memory, num_buffers, num_planes, plane_sizes);
736 if (allocated_buffers == 0) {
737 dprintk(1, "memory allocation failed\n");
742 * There is no point in continuing if we can't allocate the minimum
743 * number of buffers needed by this vb2_queue.
745 if (allocated_buffers < q->min_buffers_needed)
749 * Check if driver can handle the allocated number of buffers.
751 if (!ret && allocated_buffers < num_buffers) {
752 num_buffers = allocated_buffers;
754 * num_planes is set by the previous queue_setup(), but since it
755 * signals to queue_setup() whether it is called from create_bufs()
756 * vs reqbufs() we zero it here to signal that queue_setup() is
757 * called for the reqbufs() case.
761 ret = call_qop(q, queue_setup, q, &num_buffers,
762 &num_planes, plane_sizes, q->alloc_devs);
764 if (!ret && allocated_buffers < num_buffers)
768 * Either the driver has accepted a smaller number of buffers,
769 * or .queue_setup() returned an error
773 mutex_lock(&q->mmap_lock);
774 q->num_buffers = allocated_buffers;
778 * Note: __vb2_queue_free() will subtract 'allocated_buffers'
779 * from q->num_buffers.
781 __vb2_queue_free(q, allocated_buffers);
782 mutex_unlock(&q->mmap_lock);
785 mutex_unlock(&q->mmap_lock);
788 * Return the number of successfully allocated buffers
791 *count = allocated_buffers;
792 q->waiting_for_buffers = !q->is_output;
796 EXPORT_SYMBOL_GPL(vb2_core_reqbufs);
798 int vb2_core_create_bufs(struct vb2_queue *q, enum vb2_memory memory,
799 unsigned int *count, unsigned requested_planes,
800 const unsigned requested_sizes[])
802 unsigned int num_planes = 0, num_buffers, allocated_buffers;
803 unsigned plane_sizes[VB2_MAX_PLANES] = { };
806 if (q->num_buffers == VB2_MAX_FRAME) {
807 dprintk(1, "maximum number of buffers already allocated\n");
811 if (!q->num_buffers) {
812 memset(q->alloc_devs, 0, sizeof(q->alloc_devs));
814 q->waiting_for_buffers = !q->is_output;
815 } else if (q->memory != memory) {
816 dprintk(1, "memory model mismatch\n");
820 num_buffers = min(*count, VB2_MAX_FRAME - q->num_buffers);
822 if (requested_planes && requested_sizes) {
823 num_planes = requested_planes;
824 memcpy(plane_sizes, requested_sizes, sizeof(plane_sizes));
828 * Ask the driver, whether the requested number of buffers, planes per
829 * buffer and their sizes are acceptable
831 ret = call_qop(q, queue_setup, q, &num_buffers,
832 &num_planes, plane_sizes, q->alloc_devs);
836 /* Finally, allocate buffers and video memory */
837 allocated_buffers = __vb2_queue_alloc(q, memory, num_buffers,
838 num_planes, plane_sizes);
839 if (allocated_buffers == 0) {
840 dprintk(1, "memory allocation failed\n");
845 * Check if driver can handle the so far allocated number of buffers.
847 if (allocated_buffers < num_buffers) {
848 num_buffers = allocated_buffers;
851 * q->num_buffers contains the total number of buffers, that the
852 * queue driver has set up
854 ret = call_qop(q, queue_setup, q, &num_buffers,
855 &num_planes, plane_sizes, q->alloc_devs);
857 if (!ret && allocated_buffers < num_buffers)
861 * Either the driver has accepted a smaller number of buffers,
862 * or .queue_setup() returned an error
866 mutex_lock(&q->mmap_lock);
867 q->num_buffers += allocated_buffers;
871 * Note: __vb2_queue_free() will subtract 'allocated_buffers'
872 * from q->num_buffers.
874 __vb2_queue_free(q, allocated_buffers);
875 mutex_unlock(&q->mmap_lock);
878 mutex_unlock(&q->mmap_lock);
881 * Return the number of successfully allocated buffers
884 *count = allocated_buffers;
888 EXPORT_SYMBOL_GPL(vb2_core_create_bufs);
890 void *vb2_plane_vaddr(struct vb2_buffer *vb, unsigned int plane_no)
892 if (plane_no >= vb->num_planes || !vb->planes[plane_no].mem_priv)
895 return call_ptr_memop(vb, vaddr, vb->planes[plane_no].mem_priv);
898 EXPORT_SYMBOL_GPL(vb2_plane_vaddr);
900 void *vb2_plane_cookie(struct vb2_buffer *vb, unsigned int plane_no)
902 if (plane_no >= vb->num_planes || !vb->planes[plane_no].mem_priv)
905 return call_ptr_memop(vb, cookie, vb->planes[plane_no].mem_priv);
907 EXPORT_SYMBOL_GPL(vb2_plane_cookie);
909 void vb2_buffer_done(struct vb2_buffer *vb, enum vb2_buffer_state state)
911 struct vb2_queue *q = vb->vb2_queue;
915 if (WARN_ON(vb->state != VB2_BUF_STATE_ACTIVE))
918 if (WARN_ON(state != VB2_BUF_STATE_DONE &&
919 state != VB2_BUF_STATE_ERROR &&
920 state != VB2_BUF_STATE_QUEUED &&
921 state != VB2_BUF_STATE_REQUEUEING))
922 state = VB2_BUF_STATE_ERROR;
924 #ifdef CONFIG_VIDEO_ADV_DEBUG
926 * Although this is not a callback, it still does have to balance
927 * with the buf_queue op. So update this counter manually.
931 dprintk(4, "done processing on buffer %d, state: %d\n",
934 if (state != VB2_BUF_STATE_QUEUED &&
935 state != VB2_BUF_STATE_REQUEUEING) {
937 for (plane = 0; plane < vb->num_planes; ++plane)
938 call_void_memop(vb, finish, vb->planes[plane].mem_priv);
942 spin_lock_irqsave(&q->done_lock, flags);
943 if (state == VB2_BUF_STATE_QUEUED ||
944 state == VB2_BUF_STATE_REQUEUEING) {
945 vb->state = VB2_BUF_STATE_QUEUED;
947 /* Add the buffer to the done buffers list */
948 list_add_tail(&vb->done_entry, &q->done_list);
951 atomic_dec(&q->owned_by_drv_count);
953 if (vb->req_obj.req) {
954 /* This is not supported at the moment */
955 WARN_ON(state == VB2_BUF_STATE_REQUEUEING);
956 media_request_object_unbind(&vb->req_obj);
957 media_request_object_put(&vb->req_obj);
960 spin_unlock_irqrestore(&q->done_lock, flags);
962 trace_vb2_buf_done(q, vb);
965 case VB2_BUF_STATE_QUEUED:
967 case VB2_BUF_STATE_REQUEUEING:
968 if (q->start_streaming_called)
969 __enqueue_in_driver(vb);
972 /* Inform any processes that may be waiting for buffers */
973 wake_up(&q->done_wq);
977 EXPORT_SYMBOL_GPL(vb2_buffer_done);
979 void vb2_discard_done(struct vb2_queue *q)
981 struct vb2_buffer *vb;
984 spin_lock_irqsave(&q->done_lock, flags);
985 list_for_each_entry(vb, &q->done_list, done_entry)
986 vb->state = VB2_BUF_STATE_ERROR;
987 spin_unlock_irqrestore(&q->done_lock, flags);
989 EXPORT_SYMBOL_GPL(vb2_discard_done);
992 * __prepare_mmap() - prepare an MMAP buffer
994 static int __prepare_mmap(struct vb2_buffer *vb)
998 ret = call_bufop(vb->vb2_queue, fill_vb2_buffer,
1000 return ret ? ret : call_vb_qop(vb, buf_prepare, vb);
1004 * __prepare_userptr() - prepare a USERPTR buffer
1006 static int __prepare_userptr(struct vb2_buffer *vb)
1008 struct vb2_plane planes[VB2_MAX_PLANES];
1009 struct vb2_queue *q = vb->vb2_queue;
1013 bool reacquired = vb->planes[0].mem_priv == NULL;
1015 memset(planes, 0, sizeof(planes[0]) * vb->num_planes);
1016 /* Copy relevant information provided by the userspace */
1017 ret = call_bufop(vb->vb2_queue, fill_vb2_buffer,
1022 for (plane = 0; plane < vb->num_planes; ++plane) {
1023 /* Skip the plane if already verified */
1024 if (vb->planes[plane].m.userptr &&
1025 vb->planes[plane].m.userptr == planes[plane].m.userptr
1026 && vb->planes[plane].length == planes[plane].length)
1029 dprintk(3, "userspace address for plane %d changed, reacquiring memory\n",
1032 /* Check if the provided plane buffer is large enough */
1033 if (planes[plane].length < vb->planes[plane].min_length) {
1034 dprintk(1, "provided buffer size %u is less than setup size %u for plane %d\n",
1035 planes[plane].length,
1036 vb->planes[plane].min_length,
1042 /* Release previously acquired memory if present */
1043 if (vb->planes[plane].mem_priv) {
1046 call_void_vb_qop(vb, buf_cleanup, vb);
1048 call_void_memop(vb, put_userptr, vb->planes[plane].mem_priv);
1051 vb->planes[plane].mem_priv = NULL;
1052 vb->planes[plane].bytesused = 0;
1053 vb->planes[plane].length = 0;
1054 vb->planes[plane].m.userptr = 0;
1055 vb->planes[plane].data_offset = 0;
1057 /* Acquire each plane's memory */
1058 mem_priv = call_ptr_memop(vb, get_userptr,
1059 q->alloc_devs[plane] ? : q->dev,
1060 planes[plane].m.userptr,
1061 planes[plane].length, q->dma_dir);
1062 if (IS_ERR(mem_priv)) {
1063 dprintk(1, "failed acquiring userspace memory for plane %d\n",
1065 ret = PTR_ERR(mem_priv);
1068 vb->planes[plane].mem_priv = mem_priv;
1072 * Now that everything is in order, copy relevant information
1073 * provided by userspace.
1075 for (plane = 0; plane < vb->num_planes; ++plane) {
1076 vb->planes[plane].bytesused = planes[plane].bytesused;
1077 vb->planes[plane].length = planes[plane].length;
1078 vb->planes[plane].m.userptr = planes[plane].m.userptr;
1079 vb->planes[plane].data_offset = planes[plane].data_offset;
1084 * One or more planes changed, so we must call buf_init to do
1085 * the driver-specific initialization on the newly acquired
1086 * buffer, if provided.
1088 ret = call_vb_qop(vb, buf_init, vb);
1090 dprintk(1, "buffer initialization failed\n");
1095 ret = call_vb_qop(vb, buf_prepare, vb);
1097 dprintk(1, "buffer preparation failed\n");
1098 call_void_vb_qop(vb, buf_cleanup, vb);
1104 /* In case of errors, release planes that were already acquired */
1105 for (plane = 0; plane < vb->num_planes; ++plane) {
1106 if (vb->planes[plane].mem_priv)
1107 call_void_memop(vb, put_userptr,
1108 vb->planes[plane].mem_priv);
1109 vb->planes[plane].mem_priv = NULL;
1110 vb->planes[plane].m.userptr = 0;
1111 vb->planes[plane].length = 0;
1118 * __prepare_dmabuf() - prepare a DMABUF buffer
1120 static int __prepare_dmabuf(struct vb2_buffer *vb)
1122 struct vb2_plane planes[VB2_MAX_PLANES];
1123 struct vb2_queue *q = vb->vb2_queue;
1127 bool reacquired = vb->planes[0].mem_priv == NULL;
1129 memset(planes, 0, sizeof(planes[0]) * vb->num_planes);
1130 /* Copy relevant information provided by the userspace */
1131 ret = call_bufop(vb->vb2_queue, fill_vb2_buffer,
1136 for (plane = 0; plane < vb->num_planes; ++plane) {
1137 struct dma_buf *dbuf = dma_buf_get(planes[plane].m.fd);
1139 if (IS_ERR_OR_NULL(dbuf)) {
1140 dprintk(1, "invalid dmabuf fd for plane %d\n",
1146 /* use DMABUF size if length is not provided */
1147 if (planes[plane].length == 0)
1148 planes[plane].length = dbuf->size;
1150 if (planes[plane].length < vb->planes[plane].min_length) {
1151 dprintk(1, "invalid dmabuf length %u for plane %d, minimum length %u\n",
1152 planes[plane].length, plane,
1153 vb->planes[plane].min_length);
1159 /* Skip the plane if already verified */
1160 if (dbuf == vb->planes[plane].dbuf &&
1161 vb->planes[plane].length == planes[plane].length) {
1166 dprintk(3, "buffer for plane %d changed\n", plane);
1170 call_void_vb_qop(vb, buf_cleanup, vb);
1173 /* Release previously acquired memory if present */
1174 __vb2_plane_dmabuf_put(vb, &vb->planes[plane]);
1175 vb->planes[plane].bytesused = 0;
1176 vb->planes[plane].length = 0;
1177 vb->planes[plane].m.fd = 0;
1178 vb->planes[plane].data_offset = 0;
1180 /* Acquire each plane's memory */
1181 mem_priv = call_ptr_memop(vb, attach_dmabuf,
1182 q->alloc_devs[plane] ? : q->dev,
1183 dbuf, planes[plane].length, q->dma_dir);
1184 if (IS_ERR(mem_priv)) {
1185 dprintk(1, "failed to attach dmabuf\n");
1186 ret = PTR_ERR(mem_priv);
1191 vb->planes[plane].dbuf = dbuf;
1192 vb->planes[plane].mem_priv = mem_priv;
1196 * This pins the buffer(s) with dma_buf_map_attachment()). It's done
1197 * here instead just before the DMA, while queueing the buffer(s) so
1198 * userspace knows sooner rather than later if the dma-buf map fails.
1200 for (plane = 0; plane < vb->num_planes; ++plane) {
1201 ret = call_memop(vb, map_dmabuf, vb->planes[plane].mem_priv);
1203 dprintk(1, "failed to map dmabuf for plane %d\n",
1207 vb->planes[plane].dbuf_mapped = 1;
1211 * Now that everything is in order, copy relevant information
1212 * provided by userspace.
1214 for (plane = 0; plane < vb->num_planes; ++plane) {
1215 vb->planes[plane].bytesused = planes[plane].bytesused;
1216 vb->planes[plane].length = planes[plane].length;
1217 vb->planes[plane].m.fd = planes[plane].m.fd;
1218 vb->planes[plane].data_offset = planes[plane].data_offset;
1223 * Call driver-specific initialization on the newly acquired buffer,
1226 ret = call_vb_qop(vb, buf_init, vb);
1228 dprintk(1, "buffer initialization failed\n");
1233 ret = call_vb_qop(vb, buf_prepare, vb);
1235 dprintk(1, "buffer preparation failed\n");
1236 call_void_vb_qop(vb, buf_cleanup, vb);
1242 /* In case of errors, release planes that were already acquired */
1243 __vb2_buf_dmabuf_put(vb);
1249 * __enqueue_in_driver() - enqueue a vb2_buffer in driver for processing
1251 static void __enqueue_in_driver(struct vb2_buffer *vb)
1253 struct vb2_queue *q = vb->vb2_queue;
1255 vb->state = VB2_BUF_STATE_ACTIVE;
1256 atomic_inc(&q->owned_by_drv_count);
1258 trace_vb2_buf_queue(q, vb);
1260 call_void_vb_qop(vb, buf_queue, vb);
1263 static int __buf_prepare(struct vb2_buffer *vb)
1265 struct vb2_queue *q = vb->vb2_queue;
1266 enum vb2_buffer_state orig_state = vb->state;
1271 dprintk(1, "fatal error occurred on queue\n");
1277 WARN_ON(vb->synced);
1279 vb->state = VB2_BUF_STATE_PREPARING;
1281 switch (q->memory) {
1282 case VB2_MEMORY_MMAP:
1283 ret = __prepare_mmap(vb);
1285 case VB2_MEMORY_USERPTR:
1286 ret = __prepare_userptr(vb);
1288 case VB2_MEMORY_DMABUF:
1289 ret = __prepare_dmabuf(vb);
1292 WARN(1, "Invalid queue type\n");
1298 dprintk(1, "buffer preparation failed: %d\n", ret);
1299 vb->state = orig_state;
1304 for (plane = 0; plane < vb->num_planes; ++plane)
1305 call_void_memop(vb, prepare, vb->planes[plane].mem_priv);
1308 vb->prepared = true;
1309 vb->state = orig_state;
1314 static int vb2_req_prepare(struct media_request_object *obj)
1316 struct vb2_buffer *vb = container_of(obj, struct vb2_buffer, req_obj);
1319 if (WARN_ON(vb->state != VB2_BUF_STATE_IN_REQUEST))
1322 mutex_lock(vb->vb2_queue->lock);
1323 ret = __buf_prepare(vb);
1324 mutex_unlock(vb->vb2_queue->lock);
1328 static void __vb2_dqbuf(struct vb2_buffer *vb);
1330 static void vb2_req_unprepare(struct media_request_object *obj)
1332 struct vb2_buffer *vb = container_of(obj, struct vb2_buffer, req_obj);
1334 mutex_lock(vb->vb2_queue->lock);
1336 vb->state = VB2_BUF_STATE_IN_REQUEST;
1337 mutex_unlock(vb->vb2_queue->lock);
1338 WARN_ON(!vb->req_obj.req);
1341 int vb2_core_qbuf(struct vb2_queue *q, unsigned int index, void *pb,
1342 struct media_request *req);
1344 static void vb2_req_queue(struct media_request_object *obj)
1346 struct vb2_buffer *vb = container_of(obj, struct vb2_buffer, req_obj);
1348 mutex_lock(vb->vb2_queue->lock);
1349 vb2_core_qbuf(vb->vb2_queue, vb->index, NULL, NULL);
1350 mutex_unlock(vb->vb2_queue->lock);
1353 static void vb2_req_unbind(struct media_request_object *obj)
1355 struct vb2_buffer *vb = container_of(obj, struct vb2_buffer, req_obj);
1357 if (vb->state == VB2_BUF_STATE_IN_REQUEST)
1358 call_void_bufop(vb->vb2_queue, init_buffer, vb);
1361 static void vb2_req_release(struct media_request_object *obj)
1363 struct vb2_buffer *vb = container_of(obj, struct vb2_buffer, req_obj);
1365 if (vb->state == VB2_BUF_STATE_IN_REQUEST)
1366 vb->state = VB2_BUF_STATE_DEQUEUED;
1369 static const struct media_request_object_ops vb2_core_req_ops = {
1370 .prepare = vb2_req_prepare,
1371 .unprepare = vb2_req_unprepare,
1372 .queue = vb2_req_queue,
1373 .unbind = vb2_req_unbind,
1374 .release = vb2_req_release,
1377 bool vb2_request_object_is_buffer(struct media_request_object *obj)
1379 return obj->ops == &vb2_core_req_ops;
1381 EXPORT_SYMBOL_GPL(vb2_request_object_is_buffer);
1383 unsigned int vb2_request_buffer_cnt(struct media_request *req)
1385 struct media_request_object *obj;
1386 unsigned long flags;
1387 unsigned int buffer_cnt = 0;
1389 spin_lock_irqsave(&req->lock, flags);
1390 list_for_each_entry(obj, &req->objects, list)
1391 if (vb2_request_object_is_buffer(obj))
1393 spin_unlock_irqrestore(&req->lock, flags);
1397 EXPORT_SYMBOL_GPL(vb2_request_buffer_cnt);
1399 int vb2_core_prepare_buf(struct vb2_queue *q, unsigned int index, void *pb)
1401 struct vb2_buffer *vb;
1404 vb = q->bufs[index];
1405 if (vb->state != VB2_BUF_STATE_DEQUEUED) {
1406 dprintk(1, "invalid buffer state %d\n",
1411 dprintk(1, "buffer already prepared\n");
1415 ret = __buf_prepare(vb);
1419 /* Fill buffer information for the userspace */
1420 call_void_bufop(q, fill_user_buffer, vb, pb);
1422 dprintk(2, "prepare of buffer %d succeeded\n", vb->index);
1426 EXPORT_SYMBOL_GPL(vb2_core_prepare_buf);
1429 * vb2_start_streaming() - Attempt to start streaming.
1430 * @q: videobuf2 queue
1432 * Attempt to start streaming. When this function is called there must be
1433 * at least q->min_buffers_needed buffers queued up (i.e. the minimum
1434 * number of buffers required for the DMA engine to function). If the
1435 * @start_streaming op fails it is supposed to return all the driver-owned
1436 * buffers back to vb2 in state QUEUED. Check if that happened and if
1437 * not warn and reclaim them forcefully.
1439 static int vb2_start_streaming(struct vb2_queue *q)
1441 struct vb2_buffer *vb;
1445 * If any buffers were queued before streamon,
1446 * we can now pass them to driver for processing.
1448 list_for_each_entry(vb, &q->queued_list, queued_entry)
1449 __enqueue_in_driver(vb);
1451 /* Tell the driver to start streaming */
1452 q->start_streaming_called = 1;
1453 ret = call_qop(q, start_streaming, q,
1454 atomic_read(&q->owned_by_drv_count));
1458 q->start_streaming_called = 0;
1460 dprintk(1, "driver refused to start streaming\n");
1462 * If you see this warning, then the driver isn't cleaning up properly
1463 * after a failed start_streaming(). See the start_streaming()
1464 * documentation in videobuf2-core.h for more information how buffers
1465 * should be returned to vb2 in start_streaming().
1467 if (WARN_ON(atomic_read(&q->owned_by_drv_count))) {
1471 * Forcefully reclaim buffers if the driver did not
1472 * correctly return them to vb2.
1474 for (i = 0; i < q->num_buffers; ++i) {
1476 if (vb->state == VB2_BUF_STATE_ACTIVE)
1477 vb2_buffer_done(vb, VB2_BUF_STATE_QUEUED);
1479 /* Must be zero now */
1480 WARN_ON(atomic_read(&q->owned_by_drv_count));
1483 * If done_list is not empty, then start_streaming() didn't call
1484 * vb2_buffer_done(vb, VB2_BUF_STATE_QUEUED) but STATE_ERROR or
1487 WARN_ON(!list_empty(&q->done_list));
1491 int vb2_core_qbuf(struct vb2_queue *q, unsigned int index, void *pb,
1492 struct media_request *req)
1494 struct vb2_buffer *vb;
1498 dprintk(1, "fatal error occurred on queue\n");
1502 vb = q->bufs[index];
1504 if ((req && q->uses_qbuf) ||
1505 (!req && vb->state != VB2_BUF_STATE_IN_REQUEST &&
1506 q->uses_requests)) {
1507 dprintk(1, "queue in wrong mode (qbuf vs requests)\n");
1514 q->uses_requests = 1;
1515 if (vb->state != VB2_BUF_STATE_DEQUEUED) {
1516 dprintk(1, "buffer %d not in dequeued state\n",
1521 media_request_object_init(&vb->req_obj);
1523 /* Make sure the request is in a safe state for updating. */
1524 ret = media_request_lock_for_update(req);
1527 ret = media_request_object_bind(req, &vb2_core_req_ops,
1528 q, true, &vb->req_obj);
1529 media_request_unlock_for_update(req);
1533 vb->state = VB2_BUF_STATE_IN_REQUEST;
1534 /* Fill buffer information for the userspace */
1536 call_void_bufop(q, copy_timestamp, vb, pb);
1537 call_void_bufop(q, fill_user_buffer, vb, pb);
1540 dprintk(2, "qbuf of buffer %d succeeded\n", vb->index);
1544 if (vb->state != VB2_BUF_STATE_IN_REQUEST)
1547 switch (vb->state) {
1548 case VB2_BUF_STATE_DEQUEUED:
1549 case VB2_BUF_STATE_IN_REQUEST:
1550 if (!vb->prepared) {
1551 ret = __buf_prepare(vb);
1556 case VB2_BUF_STATE_PREPARING:
1557 dprintk(1, "buffer still being prepared\n");
1560 dprintk(1, "invalid buffer state %d\n", vb->state);
1565 * Add to the queued buffers list, a buffer will stay on it until
1566 * dequeued in dqbuf.
1568 list_add_tail(&vb->queued_entry, &q->queued_list);
1570 q->waiting_for_buffers = false;
1571 vb->state = VB2_BUF_STATE_QUEUED;
1574 call_void_bufop(q, copy_timestamp, vb, pb);
1576 trace_vb2_qbuf(q, vb);
1579 * If already streaming, give the buffer to driver for processing.
1580 * If not, the buffer will be given to driver on next streamon.
1582 if (q->start_streaming_called)
1583 __enqueue_in_driver(vb);
1585 /* Fill buffer information for the userspace */
1587 call_void_bufop(q, fill_user_buffer, vb, pb);
1590 * If streamon has been called, and we haven't yet called
1591 * start_streaming() since not enough buffers were queued, and
1592 * we now have reached the minimum number of queued buffers,
1593 * then we can finally call start_streaming().
1595 if (q->streaming && !q->start_streaming_called &&
1596 q->queued_count >= q->min_buffers_needed) {
1597 ret = vb2_start_streaming(q);
1602 dprintk(2, "qbuf of buffer %d succeeded\n", vb->index);
1605 EXPORT_SYMBOL_GPL(vb2_core_qbuf);
1608 * __vb2_wait_for_done_vb() - wait for a buffer to become available
1611 * Will sleep if required for nonblocking == false.
1613 static int __vb2_wait_for_done_vb(struct vb2_queue *q, int nonblocking)
1616 * All operations on vb_done_list are performed under done_lock
1617 * spinlock protection. However, buffers may be removed from
1618 * it and returned to userspace only while holding both driver's
1619 * lock and the done_lock spinlock. Thus we can be sure that as
1620 * long as we hold the driver's lock, the list will remain not
1621 * empty if list_empty() check succeeds.
1627 if (!q->streaming) {
1628 dprintk(1, "streaming off, will not wait for buffers\n");
1633 dprintk(1, "Queue in error state, will not wait for buffers\n");
1637 if (q->last_buffer_dequeued) {
1638 dprintk(3, "last buffer dequeued already, will not wait for buffers\n");
1642 if (!list_empty(&q->done_list)) {
1644 * Found a buffer that we were waiting for.
1650 dprintk(3, "nonblocking and no buffers to dequeue, will not wait\n");
1655 * We are streaming and blocking, wait for another buffer to
1656 * become ready or for streamoff. Driver's lock is released to
1657 * allow streamoff or qbuf to be called while waiting.
1659 call_void_qop(q, wait_prepare, q);
1662 * All locks have been released, it is safe to sleep now.
1664 dprintk(3, "will sleep waiting for buffers\n");
1665 ret = wait_event_interruptible(q->done_wq,
1666 !list_empty(&q->done_list) || !q->streaming ||
1670 * We need to reevaluate both conditions again after reacquiring
1671 * the locks or return an error if one occurred.
1673 call_void_qop(q, wait_finish, q);
1675 dprintk(1, "sleep was interrupted\n");
1683 * __vb2_get_done_vb() - get a buffer ready for dequeuing
1685 * Will sleep if required for nonblocking == false.
1687 static int __vb2_get_done_vb(struct vb2_queue *q, struct vb2_buffer **vb,
1688 void *pb, int nonblocking)
1690 unsigned long flags;
1694 * Wait for at least one buffer to become available on the done_list.
1696 ret = __vb2_wait_for_done_vb(q, nonblocking);
1701 * Driver's lock has been held since we last verified that done_list
1702 * is not empty, so no need for another list_empty(done_list) check.
1704 spin_lock_irqsave(&q->done_lock, flags);
1705 *vb = list_first_entry(&q->done_list, struct vb2_buffer, done_entry);
1707 * Only remove the buffer from done_list if all planes can be
1708 * handled. Some cases such as V4L2 file I/O and DVB have pb
1709 * == NULL; skip the check then as there's nothing to verify.
1712 ret = call_bufop(q, verify_planes_array, *vb, pb);
1714 list_del(&(*vb)->done_entry);
1715 spin_unlock_irqrestore(&q->done_lock, flags);
1720 int vb2_wait_for_all_buffers(struct vb2_queue *q)
1722 if (!q->streaming) {
1723 dprintk(1, "streaming off, will not wait for buffers\n");
1727 if (q->start_streaming_called)
1728 wait_event(q->done_wq, !atomic_read(&q->owned_by_drv_count));
1731 EXPORT_SYMBOL_GPL(vb2_wait_for_all_buffers);
1734 * __vb2_dqbuf() - bring back the buffer to the DEQUEUED state
1736 static void __vb2_dqbuf(struct vb2_buffer *vb)
1738 struct vb2_queue *q = vb->vb2_queue;
1741 /* nothing to do if the buffer is already dequeued */
1742 if (vb->state == VB2_BUF_STATE_DEQUEUED)
1745 vb->state = VB2_BUF_STATE_DEQUEUED;
1747 /* unmap DMABUF buffer */
1748 if (q->memory == VB2_MEMORY_DMABUF)
1749 for (i = 0; i < vb->num_planes; ++i) {
1750 if (!vb->planes[i].dbuf_mapped)
1752 call_void_memop(vb, unmap_dmabuf, vb->planes[i].mem_priv);
1753 vb->planes[i].dbuf_mapped = 0;
1755 if (vb->req_obj.req) {
1756 media_request_object_unbind(&vb->req_obj);
1757 media_request_object_put(&vb->req_obj);
1759 call_void_bufop(q, init_buffer, vb);
1762 int vb2_core_dqbuf(struct vb2_queue *q, unsigned int *pindex, void *pb,
1765 struct vb2_buffer *vb = NULL;
1768 ret = __vb2_get_done_vb(q, &vb, pb, nonblocking);
1772 switch (vb->state) {
1773 case VB2_BUF_STATE_DONE:
1774 dprintk(3, "returning done buffer\n");
1776 case VB2_BUF_STATE_ERROR:
1777 dprintk(3, "returning done buffer with errors\n");
1780 dprintk(1, "invalid buffer state\n");
1784 call_void_vb_qop(vb, buf_finish, vb);
1785 vb->prepared = false;
1788 *pindex = vb->index;
1790 /* Fill buffer information for the userspace */
1792 call_void_bufop(q, fill_user_buffer, vb, pb);
1794 /* Remove from videobuf queue */
1795 list_del(&vb->queued_entry);
1798 trace_vb2_dqbuf(q, vb);
1800 /* go back to dequeued state */
1803 dprintk(2, "dqbuf of buffer %d, with state %d\n",
1804 vb->index, vb->state);
1809 EXPORT_SYMBOL_GPL(vb2_core_dqbuf);
1812 * __vb2_queue_cancel() - cancel and stop (pause) streaming
1814 * Removes all queued buffers from driver's queue and all buffers queued by
1815 * userspace from videobuf's queue. Returns to state after reqbufs.
1817 static void __vb2_queue_cancel(struct vb2_queue *q)
1822 * Tell driver to stop all transactions and release all queued
1825 if (q->start_streaming_called)
1826 call_void_qop(q, stop_streaming, q);
1829 * If you see this warning, then the driver isn't cleaning up properly
1830 * in stop_streaming(). See the stop_streaming() documentation in
1831 * videobuf2-core.h for more information how buffers should be returned
1832 * to vb2 in stop_streaming().
1834 if (WARN_ON(atomic_read(&q->owned_by_drv_count))) {
1835 for (i = 0; i < q->num_buffers; ++i)
1836 if (q->bufs[i]->state == VB2_BUF_STATE_ACTIVE) {
1837 pr_warn("driver bug: stop_streaming operation is leaving buf %p in active state\n",
1839 vb2_buffer_done(q->bufs[i], VB2_BUF_STATE_ERROR);
1841 /* Must be zero now */
1842 WARN_ON(atomic_read(&q->owned_by_drv_count));
1846 q->start_streaming_called = 0;
1847 q->queued_count = 0;
1849 q->uses_requests = 0;
1853 * Remove all buffers from videobuf's list...
1855 INIT_LIST_HEAD(&q->queued_list);
1857 * ...and done list; userspace will not receive any buffers it
1858 * has not already dequeued before initiating cancel.
1860 INIT_LIST_HEAD(&q->done_list);
1861 atomic_set(&q->owned_by_drv_count, 0);
1862 wake_up_all(&q->done_wq);
1865 * Reinitialize all buffers for next use.
1866 * Make sure to call buf_finish for any queued buffers. Normally
1867 * that's done in dqbuf, but that's not going to happen when we
1868 * cancel the whole queue. Note: this code belongs here, not in
1869 * __vb2_dqbuf() since in vb2_core_dqbuf() there is a critical
1870 * call to __fill_user_buffer() after buf_finish(). That order can't
1871 * be changed, so we can't move the buf_finish() to __vb2_dqbuf().
1873 for (i = 0; i < q->num_buffers; ++i) {
1874 struct vb2_buffer *vb = q->bufs[i];
1875 struct media_request *req = vb->req_obj.req;
1878 * If a request is associated with this buffer, then
1879 * call buf_request_cancel() to give the driver to complete()
1880 * related request objects. Otherwise those objects would
1884 enum media_request_state state;
1885 unsigned long flags;
1887 spin_lock_irqsave(&req->lock, flags);
1889 spin_unlock_irqrestore(&req->lock, flags);
1891 if (state == MEDIA_REQUEST_STATE_QUEUED)
1892 call_void_vb_qop(vb, buf_request_complete, vb);
1898 for (plane = 0; plane < vb->num_planes; ++plane)
1899 call_void_memop(vb, finish,
1900 vb->planes[plane].mem_priv);
1905 call_void_vb_qop(vb, buf_finish, vb);
1906 vb->prepared = false;
1912 int vb2_core_streamon(struct vb2_queue *q, unsigned int type)
1916 if (type != q->type) {
1917 dprintk(1, "invalid stream type\n");
1922 dprintk(3, "already streaming\n");
1926 if (!q->num_buffers) {
1927 dprintk(1, "no buffers have been allocated\n");
1931 if (q->num_buffers < q->min_buffers_needed) {
1932 dprintk(1, "need at least %u allocated buffers\n",
1933 q->min_buffers_needed);
1938 * Tell driver to start streaming provided sufficient buffers
1941 if (q->queued_count >= q->min_buffers_needed) {
1942 ret = v4l_vb2q_enable_media_source(q);
1945 ret = vb2_start_streaming(q);
1947 __vb2_queue_cancel(q);
1954 dprintk(3, "successful\n");
1957 EXPORT_SYMBOL_GPL(vb2_core_streamon);
1959 void vb2_queue_error(struct vb2_queue *q)
1963 wake_up_all(&q->done_wq);
1965 EXPORT_SYMBOL_GPL(vb2_queue_error);
1967 int vb2_core_streamoff(struct vb2_queue *q, unsigned int type)
1969 if (type != q->type) {
1970 dprintk(1, "invalid stream type\n");
1975 * Cancel will pause streaming and remove all buffers from the driver
1976 * and videobuf, effectively returning control over them to userspace.
1978 * Note that we do this even if q->streaming == 0: if you prepare or
1979 * queue buffers, and then call streamoff without ever having called
1980 * streamon, you would still expect those buffers to be returned to
1981 * their normal dequeued state.
1983 __vb2_queue_cancel(q);
1984 q->waiting_for_buffers = !q->is_output;
1985 q->last_buffer_dequeued = false;
1987 dprintk(3, "successful\n");
1990 EXPORT_SYMBOL_GPL(vb2_core_streamoff);
1993 * __find_plane_by_offset() - find plane associated with the given offset off
1995 static int __find_plane_by_offset(struct vb2_queue *q, unsigned long off,
1996 unsigned int *_buffer, unsigned int *_plane)
1998 struct vb2_buffer *vb;
1999 unsigned int buffer, plane;
2002 * Go over all buffers and their planes, comparing the given offset
2003 * with an offset assigned to each plane. If a match is found,
2004 * return its buffer and plane numbers.
2006 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
2007 vb = q->bufs[buffer];
2009 for (plane = 0; plane < vb->num_planes; ++plane) {
2010 if (vb->planes[plane].m.offset == off) {
2021 int vb2_core_expbuf(struct vb2_queue *q, int *fd, unsigned int type,
2022 unsigned int index, unsigned int plane, unsigned int flags)
2024 struct vb2_buffer *vb = NULL;
2025 struct vb2_plane *vb_plane;
2027 struct dma_buf *dbuf;
2029 if (q->memory != VB2_MEMORY_MMAP) {
2030 dprintk(1, "queue is not currently set up for mmap\n");
2034 if (!q->mem_ops->get_dmabuf) {
2035 dprintk(1, "queue does not support DMA buffer exporting\n");
2039 if (flags & ~(O_CLOEXEC | O_ACCMODE)) {
2040 dprintk(1, "queue does support only O_CLOEXEC and access mode flags\n");
2044 if (type != q->type) {
2045 dprintk(1, "invalid buffer type\n");
2049 if (index >= q->num_buffers) {
2050 dprintk(1, "buffer index out of range\n");
2054 vb = q->bufs[index];
2056 if (plane >= vb->num_planes) {
2057 dprintk(1, "buffer plane out of range\n");
2061 if (vb2_fileio_is_active(q)) {
2062 dprintk(1, "expbuf: file io in progress\n");
2066 vb_plane = &vb->planes[plane];
2068 dbuf = call_ptr_memop(vb, get_dmabuf, vb_plane->mem_priv,
2070 if (IS_ERR_OR_NULL(dbuf)) {
2071 dprintk(1, "failed to export buffer %d, plane %d\n",
2076 ret = dma_buf_fd(dbuf, flags & ~O_ACCMODE);
2078 dprintk(3, "buffer %d, plane %d failed to export (%d)\n",
2084 dprintk(3, "buffer %d, plane %d exported as %d descriptor\n",
2090 EXPORT_SYMBOL_GPL(vb2_core_expbuf);
2092 int vb2_mmap(struct vb2_queue *q, struct vm_area_struct *vma)
2094 unsigned long off = vma->vm_pgoff << PAGE_SHIFT;
2095 struct vb2_buffer *vb;
2096 unsigned int buffer = 0, plane = 0;
2098 unsigned long length;
2100 if (q->memory != VB2_MEMORY_MMAP) {
2101 dprintk(1, "queue is not currently set up for mmap\n");
2106 * Check memory area access mode.
2108 if (!(vma->vm_flags & VM_SHARED)) {
2109 dprintk(1, "invalid vma flags, VM_SHARED needed\n");
2113 if (!(vma->vm_flags & VM_WRITE)) {
2114 dprintk(1, "invalid vma flags, VM_WRITE needed\n");
2118 if (!(vma->vm_flags & VM_READ)) {
2119 dprintk(1, "invalid vma flags, VM_READ needed\n");
2124 mutex_lock(&q->mmap_lock);
2126 if (vb2_fileio_is_active(q)) {
2127 dprintk(1, "mmap: file io in progress\n");
2133 * Find the plane corresponding to the offset passed by userspace.
2135 ret = __find_plane_by_offset(q, off, &buffer, &plane);
2139 vb = q->bufs[buffer];
2142 * MMAP requires page_aligned buffers.
2143 * The buffer length was page_aligned at __vb2_buf_mem_alloc(),
2144 * so, we need to do the same here.
2146 length = PAGE_ALIGN(vb->planes[plane].length);
2147 if (length < (vma->vm_end - vma->vm_start)) {
2149 "MMAP invalid, as it would overflow buffer length\n");
2153 ret = call_memop(vb, mmap, vb->planes[plane].mem_priv, vma);
2156 mutex_unlock(&q->mmap_lock);
2160 dprintk(3, "buffer %d, plane %d successfully mapped\n", buffer, plane);
2163 EXPORT_SYMBOL_GPL(vb2_mmap);
2166 unsigned long vb2_get_unmapped_area(struct vb2_queue *q,
2169 unsigned long pgoff,
2170 unsigned long flags)
2172 unsigned long off = pgoff << PAGE_SHIFT;
2173 struct vb2_buffer *vb;
2174 unsigned int buffer, plane;
2178 if (q->memory != VB2_MEMORY_MMAP) {
2179 dprintk(1, "queue is not currently set up for mmap\n");
2184 * Find the plane corresponding to the offset passed by userspace.
2186 ret = __find_plane_by_offset(q, off, &buffer, &plane);
2190 vb = q->bufs[buffer];
2192 vaddr = vb2_plane_vaddr(vb, plane);
2193 return vaddr ? (unsigned long)vaddr : -EINVAL;
2195 EXPORT_SYMBOL_GPL(vb2_get_unmapped_area);
2198 int vb2_core_queue_init(struct vb2_queue *q)
2205 WARN_ON(!q->mem_ops) ||
2206 WARN_ON(!q->type) ||
2207 WARN_ON(!q->io_modes) ||
2208 WARN_ON(!q->ops->queue_setup) ||
2209 WARN_ON(!q->ops->buf_queue))
2212 INIT_LIST_HEAD(&q->queued_list);
2213 INIT_LIST_HEAD(&q->done_list);
2214 spin_lock_init(&q->done_lock);
2215 mutex_init(&q->mmap_lock);
2216 init_waitqueue_head(&q->done_wq);
2218 q->memory = VB2_MEMORY_UNKNOWN;
2220 if (q->buf_struct_size == 0)
2221 q->buf_struct_size = sizeof(struct vb2_buffer);
2223 if (q->bidirectional)
2224 q->dma_dir = DMA_BIDIRECTIONAL;
2226 q->dma_dir = q->is_output ? DMA_TO_DEVICE : DMA_FROM_DEVICE;
2230 EXPORT_SYMBOL_GPL(vb2_core_queue_init);
2232 static int __vb2_init_fileio(struct vb2_queue *q, int read);
2233 static int __vb2_cleanup_fileio(struct vb2_queue *q);
2234 void vb2_core_queue_release(struct vb2_queue *q)
2236 __vb2_cleanup_fileio(q);
2237 __vb2_queue_cancel(q);
2238 mutex_lock(&q->mmap_lock);
2239 __vb2_queue_free(q, q->num_buffers);
2240 mutex_unlock(&q->mmap_lock);
2242 EXPORT_SYMBOL_GPL(vb2_core_queue_release);
2244 __poll_t vb2_core_poll(struct vb2_queue *q, struct file *file,
2247 __poll_t req_events = poll_requested_events(wait);
2248 struct vb2_buffer *vb = NULL;
2249 unsigned long flags;
2251 if (!q->is_output && !(req_events & (EPOLLIN | EPOLLRDNORM)))
2253 if (q->is_output && !(req_events & (EPOLLOUT | EPOLLWRNORM)))
2257 * Start file I/O emulator only if streaming API has not been used yet.
2259 if (q->num_buffers == 0 && !vb2_fileio_is_active(q)) {
2260 if (!q->is_output && (q->io_modes & VB2_READ) &&
2261 (req_events & (EPOLLIN | EPOLLRDNORM))) {
2262 if (__vb2_init_fileio(q, 1))
2265 if (q->is_output && (q->io_modes & VB2_WRITE) &&
2266 (req_events & (EPOLLOUT | EPOLLWRNORM))) {
2267 if (__vb2_init_fileio(q, 0))
2270 * Write to OUTPUT queue can be done immediately.
2272 return EPOLLOUT | EPOLLWRNORM;
2277 * There is nothing to wait for if the queue isn't streaming, or if the
2278 * error flag is set.
2280 if (!vb2_is_streaming(q) || q->error)
2284 * If this quirk is set and QBUF hasn't been called yet then
2285 * return EPOLLERR as well. This only affects capture queues, output
2286 * queues will always initialize waiting_for_buffers to false.
2287 * This quirk is set by V4L2 for backwards compatibility reasons.
2289 if (q->quirk_poll_must_check_waiting_for_buffers &&
2290 q->waiting_for_buffers && (req_events & (EPOLLIN | EPOLLRDNORM)))
2294 * For output streams you can call write() as long as there are fewer
2295 * buffers queued than there are buffers available.
2297 if (q->is_output && q->fileio && q->queued_count < q->num_buffers)
2298 return EPOLLOUT | EPOLLWRNORM;
2300 if (list_empty(&q->done_list)) {
2302 * If the last buffer was dequeued from a capture queue,
2303 * return immediately. DQBUF will return -EPIPE.
2305 if (q->last_buffer_dequeued)
2306 return EPOLLIN | EPOLLRDNORM;
2308 poll_wait(file, &q->done_wq, wait);
2312 * Take first buffer available for dequeuing.
2314 spin_lock_irqsave(&q->done_lock, flags);
2315 if (!list_empty(&q->done_list))
2316 vb = list_first_entry(&q->done_list, struct vb2_buffer,
2318 spin_unlock_irqrestore(&q->done_lock, flags);
2320 if (vb && (vb->state == VB2_BUF_STATE_DONE
2321 || vb->state == VB2_BUF_STATE_ERROR)) {
2322 return (q->is_output) ?
2323 EPOLLOUT | EPOLLWRNORM :
2324 EPOLLIN | EPOLLRDNORM;
2328 EXPORT_SYMBOL_GPL(vb2_core_poll);
2331 * struct vb2_fileio_buf - buffer context used by file io emulator
2333 * vb2 provides a compatibility layer and emulator of file io (read and
2334 * write) calls on top of streaming API. This structure is used for
2335 * tracking context related to the buffers.
2337 struct vb2_fileio_buf {
2341 unsigned int queued:1;
2345 * struct vb2_fileio_data - queue context used by file io emulator
2347 * @cur_index: the index of the buffer currently being read from or
2348 * written to. If equal to q->num_buffers then a new buffer
2350 * @initial_index: in the read() case all buffers are queued up immediately
2351 * in __vb2_init_fileio() and __vb2_perform_fileio() just cycles
2352 * buffers. However, in the write() case no buffers are initially
2353 * queued, instead whenever a buffer is full it is queued up by
2354 * __vb2_perform_fileio(). Only once all available buffers have
2355 * been queued up will __vb2_perform_fileio() start to dequeue
2356 * buffers. This means that initially __vb2_perform_fileio()
2357 * needs to know what buffer index to use when it is queuing up
2358 * the buffers for the first time. That initial index is stored
2359 * in this field. Once it is equal to q->num_buffers all
2360 * available buffers have been queued and __vb2_perform_fileio()
2361 * should start the normal dequeue/queue cycle.
2363 * vb2 provides a compatibility layer and emulator of file io (read and
2364 * write) calls on top of streaming API. For proper operation it required
2365 * this structure to save the driver state between each call of the read
2366 * or write function.
2368 struct vb2_fileio_data {
2371 unsigned int memory;
2372 struct vb2_fileio_buf bufs[VB2_MAX_FRAME];
2373 unsigned int cur_index;
2374 unsigned int initial_index;
2375 unsigned int q_count;
2376 unsigned int dq_count;
2377 unsigned read_once:1;
2378 unsigned write_immediately:1;
2382 * __vb2_init_fileio() - initialize file io emulator
2383 * @q: videobuf2 queue
2384 * @read: mode selector (1 means read, 0 means write)
2386 static int __vb2_init_fileio(struct vb2_queue *q, int read)
2388 struct vb2_fileio_data *fileio;
2390 unsigned int count = 0;
2395 if (WARN_ON((read && !(q->io_modes & VB2_READ)) ||
2396 (!read && !(q->io_modes & VB2_WRITE))))
2400 * Check if device supports mapping buffers to kernel virtual space.
2402 if (!q->mem_ops->vaddr)
2406 * Check if streaming api has not been already activated.
2408 if (q->streaming || q->num_buffers > 0)
2412 * Start with count 1, driver can increase it in queue_setup()
2416 dprintk(3, "setting up file io: mode %s, count %d, read_once %d, write_immediately %d\n",
2417 (read) ? "read" : "write", count, q->fileio_read_once,
2418 q->fileio_write_immediately);
2420 fileio = kzalloc(sizeof(*fileio), GFP_KERNEL);
2424 fileio->read_once = q->fileio_read_once;
2425 fileio->write_immediately = q->fileio_write_immediately;
2428 * Request buffers and use MMAP type to force driver
2429 * to allocate buffers by itself.
2431 fileio->count = count;
2432 fileio->memory = VB2_MEMORY_MMAP;
2433 fileio->type = q->type;
2435 ret = vb2_core_reqbufs(q, fileio->memory, &fileio->count);
2440 * Check if plane_count is correct
2441 * (multiplane buffers are not supported).
2443 if (q->bufs[0]->num_planes != 1) {
2449 * Get kernel address of each buffer.
2451 for (i = 0; i < q->num_buffers; i++) {
2452 fileio->bufs[i].vaddr = vb2_plane_vaddr(q->bufs[i], 0);
2453 if (fileio->bufs[i].vaddr == NULL) {
2457 fileio->bufs[i].size = vb2_plane_size(q->bufs[i], 0);
2461 * Read mode requires pre queuing of all buffers.
2465 * Queue all buffers.
2467 for (i = 0; i < q->num_buffers; i++) {
2468 ret = vb2_core_qbuf(q, i, NULL, NULL);
2471 fileio->bufs[i].queued = 1;
2474 * All buffers have been queued, so mark that by setting
2475 * initial_index to q->num_buffers
2477 fileio->initial_index = q->num_buffers;
2478 fileio->cur_index = q->num_buffers;
2484 ret = vb2_core_streamon(q, q->type);
2492 vb2_core_reqbufs(q, fileio->memory, &fileio->count);
2501 * __vb2_cleanup_fileio() - free resourced used by file io emulator
2502 * @q: videobuf2 queue
2504 static int __vb2_cleanup_fileio(struct vb2_queue *q)
2506 struct vb2_fileio_data *fileio = q->fileio;
2509 vb2_core_streamoff(q, q->type);
2512 vb2_core_reqbufs(q, fileio->memory, &fileio->count);
2514 dprintk(3, "file io emulator closed\n");
2520 * __vb2_perform_fileio() - perform a single file io (read or write) operation
2521 * @q: videobuf2 queue
2522 * @data: pointed to target userspace buffer
2523 * @count: number of bytes to read or write
2524 * @ppos: file handle position tracking pointer
2525 * @nonblock: mode selector (1 means blocking calls, 0 means nonblocking)
2526 * @read: access mode selector (1 means read, 0 means write)
2528 static size_t __vb2_perform_fileio(struct vb2_queue *q, char __user *data, size_t count,
2529 loff_t *ppos, int nonblock, int read)
2531 struct vb2_fileio_data *fileio;
2532 struct vb2_fileio_buf *buf;
2533 bool is_multiplanar = q->is_multiplanar;
2535 * When using write() to write data to an output video node the vb2 core
2536 * should copy timestamps if V4L2_BUF_FLAG_TIMESTAMP_COPY is set. Nobody
2537 * else is able to provide this information with the write() operation.
2539 bool copy_timestamp = !read && q->copy_timestamp;
2543 dprintk(3, "mode %s, offset %ld, count %zd, %sblocking\n",
2544 read ? "read" : "write", (long)*ppos, count,
2545 nonblock ? "non" : "");
2551 * Initialize emulator on first call.
2553 if (!vb2_fileio_is_active(q)) {
2554 ret = __vb2_init_fileio(q, read);
2555 dprintk(3, "vb2_init_fileio result: %d\n", ret);
2562 * Check if we need to dequeue the buffer.
2564 index = fileio->cur_index;
2565 if (index >= q->num_buffers) {
2566 struct vb2_buffer *b;
2569 * Call vb2_dqbuf to get buffer back.
2571 ret = vb2_core_dqbuf(q, &index, NULL, nonblock);
2572 dprintk(5, "vb2_dqbuf result: %d\n", ret);
2575 fileio->dq_count += 1;
2577 fileio->cur_index = index;
2578 buf = &fileio->bufs[index];
2582 * Get number of bytes filled by the driver
2586 buf->size = read ? vb2_get_plane_payload(q->bufs[index], 0)
2587 : vb2_plane_size(q->bufs[index], 0);
2588 /* Compensate for data_offset on read in the multiplanar case. */
2589 if (is_multiplanar && read &&
2590 b->planes[0].data_offset < buf->size) {
2591 buf->pos = b->planes[0].data_offset;
2592 buf->size -= buf->pos;
2595 buf = &fileio->bufs[index];
2599 * Limit count on last few bytes of the buffer.
2601 if (buf->pos + count > buf->size) {
2602 count = buf->size - buf->pos;
2603 dprintk(5, "reducing read count: %zd\n", count);
2607 * Transfer data to userspace.
2609 dprintk(3, "copying %zd bytes - buffer %d, offset %u\n",
2610 count, index, buf->pos);
2612 ret = copy_to_user(data, buf->vaddr + buf->pos, count);
2614 ret = copy_from_user(buf->vaddr + buf->pos, data, count);
2616 dprintk(3, "error copying data\n");
2627 * Queue next buffer if required.
2629 if (buf->pos == buf->size || (!read && fileio->write_immediately)) {
2630 struct vb2_buffer *b = q->bufs[index];
2633 * Check if this is the last buffer to read.
2635 if (read && fileio->read_once && fileio->dq_count == 1) {
2636 dprintk(3, "read limit reached\n");
2637 return __vb2_cleanup_fileio(q);
2641 * Call vb2_qbuf and give buffer to the driver.
2643 b->planes[0].bytesused = buf->pos;
2646 b->timestamp = ktime_get_ns();
2647 ret = vb2_core_qbuf(q, index, NULL, NULL);
2648 dprintk(5, "vb2_dbuf result: %d\n", ret);
2653 * Buffer has been queued, update the status
2657 buf->size = vb2_plane_size(q->bufs[index], 0);
2658 fileio->q_count += 1;
2660 * If we are queuing up buffers for the first time, then
2661 * increase initial_index by one.
2663 if (fileio->initial_index < q->num_buffers)
2664 fileio->initial_index++;
2666 * The next buffer to use is either a buffer that's going to be
2667 * queued for the first time (initial_index < q->num_buffers)
2668 * or it is equal to q->num_buffers, meaning that the next
2669 * time we need to dequeue a buffer since we've now queued up
2670 * all the 'first time' buffers.
2672 fileio->cur_index = fileio->initial_index;
2676 * Return proper number of bytes processed.
2683 size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count,
2684 loff_t *ppos, int nonblocking)
2686 return __vb2_perform_fileio(q, data, count, ppos, nonblocking, 1);
2688 EXPORT_SYMBOL_GPL(vb2_read);
2690 size_t vb2_write(struct vb2_queue *q, const char __user *data, size_t count,
2691 loff_t *ppos, int nonblocking)
2693 return __vb2_perform_fileio(q, (char __user *) data, count,
2694 ppos, nonblocking, 0);
2696 EXPORT_SYMBOL_GPL(vb2_write);
2698 struct vb2_threadio_data {
2699 struct task_struct *thread;
2705 static int vb2_thread(void *data)
2707 struct vb2_queue *q = data;
2708 struct vb2_threadio_data *threadio = q->threadio;
2709 bool copy_timestamp = false;
2710 unsigned prequeue = 0;
2715 prequeue = q->num_buffers;
2716 copy_timestamp = q->copy_timestamp;
2722 struct vb2_buffer *vb;
2725 * Call vb2_dqbuf to get buffer back.
2728 vb = q->bufs[index++];
2731 call_void_qop(q, wait_finish, q);
2732 if (!threadio->stop)
2733 ret = vb2_core_dqbuf(q, &index, NULL, 0);
2734 call_void_qop(q, wait_prepare, q);
2735 dprintk(5, "file io: vb2_dqbuf result: %d\n", ret);
2737 vb = q->bufs[index];
2739 if (ret || threadio->stop)
2743 if (vb->state != VB2_BUF_STATE_ERROR)
2744 if (threadio->fnc(vb, threadio->priv))
2746 call_void_qop(q, wait_finish, q);
2748 vb->timestamp = ktime_get_ns();
2749 if (!threadio->stop)
2750 ret = vb2_core_qbuf(q, vb->index, NULL, NULL);
2751 call_void_qop(q, wait_prepare, q);
2752 if (ret || threadio->stop)
2756 /* Hmm, linux becomes *very* unhappy without this ... */
2757 while (!kthread_should_stop()) {
2758 set_current_state(TASK_INTERRUPTIBLE);
2765 * This function should not be used for anything else but the videobuf2-dvb
2766 * support. If you think you have another good use-case for this, then please
2767 * contact the linux-media mailinglist first.
2769 int vb2_thread_start(struct vb2_queue *q, vb2_thread_fnc fnc, void *priv,
2770 const char *thread_name)
2772 struct vb2_threadio_data *threadio;
2779 if (WARN_ON(q->fileio))
2782 threadio = kzalloc(sizeof(*threadio), GFP_KERNEL);
2783 if (threadio == NULL)
2785 threadio->fnc = fnc;
2786 threadio->priv = priv;
2788 ret = __vb2_init_fileio(q, !q->is_output);
2789 dprintk(3, "file io: vb2_init_fileio result: %d\n", ret);
2792 q->threadio = threadio;
2793 threadio->thread = kthread_run(vb2_thread, q, "vb2-%s", thread_name);
2794 if (IS_ERR(threadio->thread)) {
2795 ret = PTR_ERR(threadio->thread);
2796 threadio->thread = NULL;
2802 __vb2_cleanup_fileio(q);
2807 EXPORT_SYMBOL_GPL(vb2_thread_start);
2809 int vb2_thread_stop(struct vb2_queue *q)
2811 struct vb2_threadio_data *threadio = q->threadio;
2814 if (threadio == NULL)
2816 threadio->stop = true;
2817 /* Wake up all pending sleeps in the thread */
2819 err = kthread_stop(threadio->thread);
2820 __vb2_cleanup_fileio(q);
2821 threadio->thread = NULL;
2826 EXPORT_SYMBOL_GPL(vb2_thread_stop);
2828 MODULE_DESCRIPTION("Media buffer core framework");
2829 MODULE_AUTHOR("Pawel Osciak <pawel@osciak.com>, Marek Szyprowski");
2830 MODULE_LICENSE("GPL");