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
;
817 num_buffers
= min(*count
, VB2_MAX_FRAME
- q
->num_buffers
);
819 if (requested_planes
&& requested_sizes
) {
820 num_planes
= requested_planes
;
821 memcpy(plane_sizes
, requested_sizes
, sizeof(plane_sizes
));
825 * Ask the driver, whether the requested number of buffers, planes per
826 * buffer and their sizes are acceptable
828 ret
= call_qop(q
, queue_setup
, q
, &num_buffers
,
829 &num_planes
, plane_sizes
, q
->alloc_devs
);
833 /* Finally, allocate buffers and video memory */
834 allocated_buffers
= __vb2_queue_alloc(q
, memory
, num_buffers
,
835 num_planes
, plane_sizes
);
836 if (allocated_buffers
== 0) {
837 dprintk(1, "memory allocation failed\n");
842 * Check if driver can handle the so far allocated number of buffers.
844 if (allocated_buffers
< num_buffers
) {
845 num_buffers
= allocated_buffers
;
848 * q->num_buffers contains the total number of buffers, that the
849 * queue driver has set up
851 ret
= call_qop(q
, queue_setup
, q
, &num_buffers
,
852 &num_planes
, plane_sizes
, q
->alloc_devs
);
854 if (!ret
&& allocated_buffers
< num_buffers
)
858 * Either the driver has accepted a smaller number of buffers,
859 * or .queue_setup() returned an error
863 mutex_lock(&q
->mmap_lock
);
864 q
->num_buffers
+= allocated_buffers
;
868 * Note: __vb2_queue_free() will subtract 'allocated_buffers'
869 * from q->num_buffers.
871 __vb2_queue_free(q
, allocated_buffers
);
872 mutex_unlock(&q
->mmap_lock
);
875 mutex_unlock(&q
->mmap_lock
);
878 * Return the number of successfully allocated buffers
881 *count
= allocated_buffers
;
885 EXPORT_SYMBOL_GPL(vb2_core_create_bufs
);
887 void *vb2_plane_vaddr(struct vb2_buffer
*vb
, unsigned int plane_no
)
889 if (plane_no
>= vb
->num_planes
|| !vb
->planes
[plane_no
].mem_priv
)
892 return call_ptr_memop(vb
, vaddr
, vb
->planes
[plane_no
].mem_priv
);
895 EXPORT_SYMBOL_GPL(vb2_plane_vaddr
);
897 void *vb2_plane_cookie(struct vb2_buffer
*vb
, unsigned int plane_no
)
899 if (plane_no
>= vb
->num_planes
|| !vb
->planes
[plane_no
].mem_priv
)
902 return call_ptr_memop(vb
, cookie
, vb
->planes
[plane_no
].mem_priv
);
904 EXPORT_SYMBOL_GPL(vb2_plane_cookie
);
906 void vb2_buffer_done(struct vb2_buffer
*vb
, enum vb2_buffer_state state
)
908 struct vb2_queue
*q
= vb
->vb2_queue
;
912 if (WARN_ON(vb
->state
!= VB2_BUF_STATE_ACTIVE
))
915 if (WARN_ON(state
!= VB2_BUF_STATE_DONE
&&
916 state
!= VB2_BUF_STATE_ERROR
&&
917 state
!= VB2_BUF_STATE_QUEUED
&&
918 state
!= VB2_BUF_STATE_REQUEUEING
))
919 state
= VB2_BUF_STATE_ERROR
;
921 #ifdef CONFIG_VIDEO_ADV_DEBUG
923 * Although this is not a callback, it still does have to balance
924 * with the buf_queue op. So update this counter manually.
928 dprintk(4, "done processing on buffer %d, state: %d\n",
931 if (state
!= VB2_BUF_STATE_QUEUED
&&
932 state
!= VB2_BUF_STATE_REQUEUEING
) {
934 for (plane
= 0; plane
< vb
->num_planes
; ++plane
)
935 call_void_memop(vb
, finish
, vb
->planes
[plane
].mem_priv
);
939 spin_lock_irqsave(&q
->done_lock
, flags
);
940 if (state
== VB2_BUF_STATE_QUEUED
||
941 state
== VB2_BUF_STATE_REQUEUEING
) {
942 vb
->state
= VB2_BUF_STATE_QUEUED
;
944 /* Add the buffer to the done buffers list */
945 list_add_tail(&vb
->done_entry
, &q
->done_list
);
948 atomic_dec(&q
->owned_by_drv_count
);
950 if (state
!= VB2_BUF_STATE_QUEUED
&& vb
->req_obj
.req
) {
951 /* This is not supported at the moment */
952 WARN_ON(state
== VB2_BUF_STATE_REQUEUEING
);
953 media_request_object_unbind(&vb
->req_obj
);
954 media_request_object_put(&vb
->req_obj
);
957 spin_unlock_irqrestore(&q
->done_lock
, flags
);
959 trace_vb2_buf_done(q
, vb
);
962 case VB2_BUF_STATE_QUEUED
:
964 case VB2_BUF_STATE_REQUEUEING
:
965 if (q
->start_streaming_called
)
966 __enqueue_in_driver(vb
);
969 /* Inform any processes that may be waiting for buffers */
970 wake_up(&q
->done_wq
);
974 EXPORT_SYMBOL_GPL(vb2_buffer_done
);
976 void vb2_discard_done(struct vb2_queue
*q
)
978 struct vb2_buffer
*vb
;
981 spin_lock_irqsave(&q
->done_lock
, flags
);
982 list_for_each_entry(vb
, &q
->done_list
, done_entry
)
983 vb
->state
= VB2_BUF_STATE_ERROR
;
984 spin_unlock_irqrestore(&q
->done_lock
, flags
);
986 EXPORT_SYMBOL_GPL(vb2_discard_done
);
989 * __prepare_mmap() - prepare an MMAP buffer
991 static int __prepare_mmap(struct vb2_buffer
*vb
)
995 ret
= call_bufop(vb
->vb2_queue
, fill_vb2_buffer
,
997 return ret
? ret
: call_vb_qop(vb
, buf_prepare
, vb
);
1001 * __prepare_userptr() - prepare a USERPTR buffer
1003 static int __prepare_userptr(struct vb2_buffer
*vb
)
1005 struct vb2_plane planes
[VB2_MAX_PLANES
];
1006 struct vb2_queue
*q
= vb
->vb2_queue
;
1010 bool reacquired
= vb
->planes
[0].mem_priv
== NULL
;
1012 memset(planes
, 0, sizeof(planes
[0]) * vb
->num_planes
);
1013 /* Copy relevant information provided by the userspace */
1014 ret
= call_bufop(vb
->vb2_queue
, fill_vb2_buffer
,
1019 for (plane
= 0; plane
< vb
->num_planes
; ++plane
) {
1020 /* Skip the plane if already verified */
1021 if (vb
->planes
[plane
].m
.userptr
&&
1022 vb
->planes
[plane
].m
.userptr
== planes
[plane
].m
.userptr
1023 && vb
->planes
[plane
].length
== planes
[plane
].length
)
1026 dprintk(3, "userspace address for plane %d changed, reacquiring memory\n",
1029 /* Check if the provided plane buffer is large enough */
1030 if (planes
[plane
].length
< vb
->planes
[plane
].min_length
) {
1031 dprintk(1, "provided buffer size %u is less than setup size %u for plane %d\n",
1032 planes
[plane
].length
,
1033 vb
->planes
[plane
].min_length
,
1039 /* Release previously acquired memory if present */
1040 if (vb
->planes
[plane
].mem_priv
) {
1043 call_void_vb_qop(vb
, buf_cleanup
, vb
);
1045 call_void_memop(vb
, put_userptr
, vb
->planes
[plane
].mem_priv
);
1048 vb
->planes
[plane
].mem_priv
= NULL
;
1049 vb
->planes
[plane
].bytesused
= 0;
1050 vb
->planes
[plane
].length
= 0;
1051 vb
->planes
[plane
].m
.userptr
= 0;
1052 vb
->planes
[plane
].data_offset
= 0;
1054 /* Acquire each plane's memory */
1055 mem_priv
= call_ptr_memop(vb
, get_userptr
,
1056 q
->alloc_devs
[plane
] ? : q
->dev
,
1057 planes
[plane
].m
.userptr
,
1058 planes
[plane
].length
, q
->dma_dir
);
1059 if (IS_ERR(mem_priv
)) {
1060 dprintk(1, "failed acquiring userspace memory for plane %d\n",
1062 ret
= PTR_ERR(mem_priv
);
1065 vb
->planes
[plane
].mem_priv
= mem_priv
;
1069 * Now that everything is in order, copy relevant information
1070 * provided by userspace.
1072 for (plane
= 0; plane
< vb
->num_planes
; ++plane
) {
1073 vb
->planes
[plane
].bytesused
= planes
[plane
].bytesused
;
1074 vb
->planes
[plane
].length
= planes
[plane
].length
;
1075 vb
->planes
[plane
].m
.userptr
= planes
[plane
].m
.userptr
;
1076 vb
->planes
[plane
].data_offset
= planes
[plane
].data_offset
;
1081 * One or more planes changed, so we must call buf_init to do
1082 * the driver-specific initialization on the newly acquired
1083 * buffer, if provided.
1085 ret
= call_vb_qop(vb
, buf_init
, vb
);
1087 dprintk(1, "buffer initialization failed\n");
1092 ret
= call_vb_qop(vb
, buf_prepare
, vb
);
1094 dprintk(1, "buffer preparation failed\n");
1095 call_void_vb_qop(vb
, buf_cleanup
, vb
);
1101 /* In case of errors, release planes that were already acquired */
1102 for (plane
= 0; plane
< vb
->num_planes
; ++plane
) {
1103 if (vb
->planes
[plane
].mem_priv
)
1104 call_void_memop(vb
, put_userptr
,
1105 vb
->planes
[plane
].mem_priv
);
1106 vb
->planes
[plane
].mem_priv
= NULL
;
1107 vb
->planes
[plane
].m
.userptr
= 0;
1108 vb
->planes
[plane
].length
= 0;
1115 * __prepare_dmabuf() - prepare a DMABUF buffer
1117 static int __prepare_dmabuf(struct vb2_buffer
*vb
)
1119 struct vb2_plane planes
[VB2_MAX_PLANES
];
1120 struct vb2_queue
*q
= vb
->vb2_queue
;
1124 bool reacquired
= vb
->planes
[0].mem_priv
== NULL
;
1126 memset(planes
, 0, sizeof(planes
[0]) * vb
->num_planes
);
1127 /* Copy relevant information provided by the userspace */
1128 ret
= call_bufop(vb
->vb2_queue
, fill_vb2_buffer
,
1133 for (plane
= 0; plane
< vb
->num_planes
; ++plane
) {
1134 struct dma_buf
*dbuf
= dma_buf_get(planes
[plane
].m
.fd
);
1136 if (IS_ERR_OR_NULL(dbuf
)) {
1137 dprintk(1, "invalid dmabuf fd for plane %d\n",
1143 /* use DMABUF size if length is not provided */
1144 if (planes
[plane
].length
== 0)
1145 planes
[plane
].length
= dbuf
->size
;
1147 if (planes
[plane
].length
< vb
->planes
[plane
].min_length
) {
1148 dprintk(1, "invalid dmabuf length %u for plane %d, minimum length %u\n",
1149 planes
[plane
].length
, plane
,
1150 vb
->planes
[plane
].min_length
);
1156 /* Skip the plane if already verified */
1157 if (dbuf
== vb
->planes
[plane
].dbuf
&&
1158 vb
->planes
[plane
].length
== planes
[plane
].length
) {
1163 dprintk(3, "buffer for plane %d changed\n", plane
);
1167 call_void_vb_qop(vb
, buf_cleanup
, vb
);
1170 /* Release previously acquired memory if present */
1171 __vb2_plane_dmabuf_put(vb
, &vb
->planes
[plane
]);
1172 vb
->planes
[plane
].bytesused
= 0;
1173 vb
->planes
[plane
].length
= 0;
1174 vb
->planes
[plane
].m
.fd
= 0;
1175 vb
->planes
[plane
].data_offset
= 0;
1177 /* Acquire each plane's memory */
1178 mem_priv
= call_ptr_memop(vb
, attach_dmabuf
,
1179 q
->alloc_devs
[plane
] ? : q
->dev
,
1180 dbuf
, planes
[plane
].length
, q
->dma_dir
);
1181 if (IS_ERR(mem_priv
)) {
1182 dprintk(1, "failed to attach dmabuf\n");
1183 ret
= PTR_ERR(mem_priv
);
1188 vb
->planes
[plane
].dbuf
= dbuf
;
1189 vb
->planes
[plane
].mem_priv
= mem_priv
;
1193 * This pins the buffer(s) with dma_buf_map_attachment()). It's done
1194 * here instead just before the DMA, while queueing the buffer(s) so
1195 * userspace knows sooner rather than later if the dma-buf map fails.
1197 for (plane
= 0; plane
< vb
->num_planes
; ++plane
) {
1198 ret
= call_memop(vb
, map_dmabuf
, vb
->planes
[plane
].mem_priv
);
1200 dprintk(1, "failed to map dmabuf for plane %d\n",
1204 vb
->planes
[plane
].dbuf_mapped
= 1;
1208 * Now that everything is in order, copy relevant information
1209 * provided by userspace.
1211 for (plane
= 0; plane
< vb
->num_planes
; ++plane
) {
1212 vb
->planes
[plane
].bytesused
= planes
[plane
].bytesused
;
1213 vb
->planes
[plane
].length
= planes
[plane
].length
;
1214 vb
->planes
[plane
].m
.fd
= planes
[plane
].m
.fd
;
1215 vb
->planes
[plane
].data_offset
= planes
[plane
].data_offset
;
1220 * Call driver-specific initialization on the newly acquired buffer,
1223 ret
= call_vb_qop(vb
, buf_init
, vb
);
1225 dprintk(1, "buffer initialization failed\n");
1230 ret
= call_vb_qop(vb
, buf_prepare
, vb
);
1232 dprintk(1, "buffer preparation failed\n");
1233 call_void_vb_qop(vb
, buf_cleanup
, vb
);
1239 /* In case of errors, release planes that were already acquired */
1240 __vb2_buf_dmabuf_put(vb
);
1246 * __enqueue_in_driver() - enqueue a vb2_buffer in driver for processing
1248 static void __enqueue_in_driver(struct vb2_buffer
*vb
)
1250 struct vb2_queue
*q
= vb
->vb2_queue
;
1252 vb
->state
= VB2_BUF_STATE_ACTIVE
;
1253 atomic_inc(&q
->owned_by_drv_count
);
1255 trace_vb2_buf_queue(q
, vb
);
1257 call_void_vb_qop(vb
, buf_queue
, vb
);
1260 static int __buf_prepare(struct vb2_buffer
*vb
)
1262 struct vb2_queue
*q
= vb
->vb2_queue
;
1263 enum vb2_buffer_state orig_state
= vb
->state
;
1268 dprintk(1, "fatal error occurred on queue\n");
1274 WARN_ON(vb
->synced
);
1276 vb
->state
= VB2_BUF_STATE_PREPARING
;
1278 switch (q
->memory
) {
1279 case VB2_MEMORY_MMAP
:
1280 ret
= __prepare_mmap(vb
);
1282 case VB2_MEMORY_USERPTR
:
1283 ret
= __prepare_userptr(vb
);
1285 case VB2_MEMORY_DMABUF
:
1286 ret
= __prepare_dmabuf(vb
);
1289 WARN(1, "Invalid queue type\n");
1295 dprintk(1, "buffer preparation failed: %d\n", ret
);
1296 vb
->state
= orig_state
;
1301 for (plane
= 0; plane
< vb
->num_planes
; ++plane
)
1302 call_void_memop(vb
, prepare
, vb
->planes
[plane
].mem_priv
);
1305 vb
->prepared
= true;
1306 vb
->state
= orig_state
;
1311 static int vb2_req_prepare(struct media_request_object
*obj
)
1313 struct vb2_buffer
*vb
= container_of(obj
, struct vb2_buffer
, req_obj
);
1316 if (WARN_ON(vb
->state
!= VB2_BUF_STATE_IN_REQUEST
))
1319 mutex_lock(vb
->vb2_queue
->lock
);
1320 ret
= __buf_prepare(vb
);
1321 mutex_unlock(vb
->vb2_queue
->lock
);
1325 static void __vb2_dqbuf(struct vb2_buffer
*vb
);
1327 static void vb2_req_unprepare(struct media_request_object
*obj
)
1329 struct vb2_buffer
*vb
= container_of(obj
, struct vb2_buffer
, req_obj
);
1331 mutex_lock(vb
->vb2_queue
->lock
);
1333 vb
->state
= VB2_BUF_STATE_IN_REQUEST
;
1334 mutex_unlock(vb
->vb2_queue
->lock
);
1335 WARN_ON(!vb
->req_obj
.req
);
1338 int vb2_core_qbuf(struct vb2_queue
*q
, unsigned int index
, void *pb
,
1339 struct media_request
*req
);
1341 static void vb2_req_queue(struct media_request_object
*obj
)
1343 struct vb2_buffer
*vb
= container_of(obj
, struct vb2_buffer
, req_obj
);
1345 mutex_lock(vb
->vb2_queue
->lock
);
1346 vb2_core_qbuf(vb
->vb2_queue
, vb
->index
, NULL
, NULL
);
1347 mutex_unlock(vb
->vb2_queue
->lock
);
1350 static void vb2_req_unbind(struct media_request_object
*obj
)
1352 struct vb2_buffer
*vb
= container_of(obj
, struct vb2_buffer
, req_obj
);
1354 if (vb
->state
== VB2_BUF_STATE_IN_REQUEST
)
1355 call_void_bufop(vb
->vb2_queue
, init_buffer
, vb
);
1358 static void vb2_req_release(struct media_request_object
*obj
)
1360 struct vb2_buffer
*vb
= container_of(obj
, struct vb2_buffer
, req_obj
);
1362 if (vb
->state
== VB2_BUF_STATE_IN_REQUEST
) {
1363 vb
->state
= VB2_BUF_STATE_DEQUEUED
;
1365 media_request_put(vb
->request
);
1370 static const struct media_request_object_ops vb2_core_req_ops
= {
1371 .prepare
= vb2_req_prepare
,
1372 .unprepare
= vb2_req_unprepare
,
1373 .queue
= vb2_req_queue
,
1374 .unbind
= vb2_req_unbind
,
1375 .release
= vb2_req_release
,
1378 bool vb2_request_object_is_buffer(struct media_request_object
*obj
)
1380 return obj
->ops
== &vb2_core_req_ops
;
1382 EXPORT_SYMBOL_GPL(vb2_request_object_is_buffer
);
1384 unsigned int vb2_request_buffer_cnt(struct media_request
*req
)
1386 struct media_request_object
*obj
;
1387 unsigned long flags
;
1388 unsigned int buffer_cnt
= 0;
1390 spin_lock_irqsave(&req
->lock
, flags
);
1391 list_for_each_entry(obj
, &req
->objects
, list
)
1392 if (vb2_request_object_is_buffer(obj
))
1394 spin_unlock_irqrestore(&req
->lock
, flags
);
1398 EXPORT_SYMBOL_GPL(vb2_request_buffer_cnt
);
1400 int vb2_core_prepare_buf(struct vb2_queue
*q
, unsigned int index
, void *pb
)
1402 struct vb2_buffer
*vb
;
1405 vb
= q
->bufs
[index
];
1406 if (vb
->state
!= VB2_BUF_STATE_DEQUEUED
) {
1407 dprintk(1, "invalid buffer state %d\n",
1412 dprintk(1, "buffer already prepared\n");
1416 ret
= __buf_prepare(vb
);
1420 /* Fill buffer information for the userspace */
1421 call_void_bufop(q
, fill_user_buffer
, vb
, pb
);
1423 dprintk(2, "prepare of buffer %d succeeded\n", vb
->index
);
1427 EXPORT_SYMBOL_GPL(vb2_core_prepare_buf
);
1430 * vb2_start_streaming() - Attempt to start streaming.
1431 * @q: videobuf2 queue
1433 * Attempt to start streaming. When this function is called there must be
1434 * at least q->min_buffers_needed buffers queued up (i.e. the minimum
1435 * number of buffers required for the DMA engine to function). If the
1436 * @start_streaming op fails it is supposed to return all the driver-owned
1437 * buffers back to vb2 in state QUEUED. Check if that happened and if
1438 * not warn and reclaim them forcefully.
1440 static int vb2_start_streaming(struct vb2_queue
*q
)
1442 struct vb2_buffer
*vb
;
1446 * If any buffers were queued before streamon,
1447 * we can now pass them to driver for processing.
1449 list_for_each_entry(vb
, &q
->queued_list
, queued_entry
)
1450 __enqueue_in_driver(vb
);
1452 /* Tell the driver to start streaming */
1453 q
->start_streaming_called
= 1;
1454 ret
= call_qop(q
, start_streaming
, q
,
1455 atomic_read(&q
->owned_by_drv_count
));
1459 q
->start_streaming_called
= 0;
1461 dprintk(1, "driver refused to start streaming\n");
1463 * If you see this warning, then the driver isn't cleaning up properly
1464 * after a failed start_streaming(). See the start_streaming()
1465 * documentation in videobuf2-core.h for more information how buffers
1466 * should be returned to vb2 in start_streaming().
1468 if (WARN_ON(atomic_read(&q
->owned_by_drv_count
))) {
1472 * Forcefully reclaim buffers if the driver did not
1473 * correctly return them to vb2.
1475 for (i
= 0; i
< q
->num_buffers
; ++i
) {
1477 if (vb
->state
== VB2_BUF_STATE_ACTIVE
)
1478 vb2_buffer_done(vb
, VB2_BUF_STATE_QUEUED
);
1480 /* Must be zero now */
1481 WARN_ON(atomic_read(&q
->owned_by_drv_count
));
1484 * If done_list is not empty, then start_streaming() didn't call
1485 * vb2_buffer_done(vb, VB2_BUF_STATE_QUEUED) but STATE_ERROR or
1488 WARN_ON(!list_empty(&q
->done_list
));
1492 int vb2_core_qbuf(struct vb2_queue
*q
, unsigned int index
, void *pb
,
1493 struct media_request
*req
)
1495 struct vb2_buffer
*vb
;
1499 dprintk(1, "fatal error occurred on queue\n");
1503 vb
= q
->bufs
[index
];
1505 if ((req
&& q
->uses_qbuf
) ||
1506 (!req
&& vb
->state
!= VB2_BUF_STATE_IN_REQUEST
&&
1507 q
->uses_requests
)) {
1508 dprintk(1, "queue in wrong mode (qbuf vs requests)\n");
1515 q
->uses_requests
= 1;
1516 if (vb
->state
!= VB2_BUF_STATE_DEQUEUED
) {
1517 dprintk(1, "buffer %d not in dequeued state\n",
1522 media_request_object_init(&vb
->req_obj
);
1524 /* Make sure the request is in a safe state for updating. */
1525 ret
= media_request_lock_for_update(req
);
1528 ret
= media_request_object_bind(req
, &vb2_core_req_ops
,
1529 q
, true, &vb
->req_obj
);
1530 media_request_unlock_for_update(req
);
1534 vb
->state
= VB2_BUF_STATE_IN_REQUEST
;
1537 * Increment the refcount and store the request.
1538 * The request refcount is decremented again when the
1539 * buffer is dequeued. This is to prevent vb2_buffer_done()
1540 * from freeing the request from interrupt context, which can
1541 * happen if the application closed the request fd after
1542 * queueing the request.
1544 media_request_get(req
);
1547 /* Fill buffer information for the userspace */
1549 call_void_bufop(q
, copy_timestamp
, vb
, pb
);
1550 call_void_bufop(q
, fill_user_buffer
, vb
, pb
);
1553 dprintk(2, "qbuf of buffer %d succeeded\n", vb
->index
);
1557 if (vb
->state
!= VB2_BUF_STATE_IN_REQUEST
)
1560 switch (vb
->state
) {
1561 case VB2_BUF_STATE_DEQUEUED
:
1562 case VB2_BUF_STATE_IN_REQUEST
:
1563 if (!vb
->prepared
) {
1564 ret
= __buf_prepare(vb
);
1569 case VB2_BUF_STATE_PREPARING
:
1570 dprintk(1, "buffer still being prepared\n");
1573 dprintk(1, "invalid buffer state %d\n", vb
->state
);
1578 * Add to the queued buffers list, a buffer will stay on it until
1579 * dequeued in dqbuf.
1581 list_add_tail(&vb
->queued_entry
, &q
->queued_list
);
1583 q
->waiting_for_buffers
= false;
1584 vb
->state
= VB2_BUF_STATE_QUEUED
;
1587 call_void_bufop(q
, copy_timestamp
, vb
, pb
);
1589 trace_vb2_qbuf(q
, vb
);
1592 * If already streaming, give the buffer to driver for processing.
1593 * If not, the buffer will be given to driver on next streamon.
1595 if (q
->start_streaming_called
)
1596 __enqueue_in_driver(vb
);
1598 /* Fill buffer information for the userspace */
1600 call_void_bufop(q
, fill_user_buffer
, vb
, pb
);
1603 * If streamon has been called, and we haven't yet called
1604 * start_streaming() since not enough buffers were queued, and
1605 * we now have reached the minimum number of queued buffers,
1606 * then we can finally call start_streaming().
1608 if (q
->streaming
&& !q
->start_streaming_called
&&
1609 q
->queued_count
>= q
->min_buffers_needed
) {
1610 ret
= vb2_start_streaming(q
);
1615 dprintk(2, "qbuf of buffer %d succeeded\n", vb
->index
);
1618 EXPORT_SYMBOL_GPL(vb2_core_qbuf
);
1621 * __vb2_wait_for_done_vb() - wait for a buffer to become available
1624 * Will sleep if required for nonblocking == false.
1626 static int __vb2_wait_for_done_vb(struct vb2_queue
*q
, int nonblocking
)
1629 * All operations on vb_done_list are performed under done_lock
1630 * spinlock protection. However, buffers may be removed from
1631 * it and returned to userspace only while holding both driver's
1632 * lock and the done_lock spinlock. Thus we can be sure that as
1633 * long as we hold the driver's lock, the list will remain not
1634 * empty if list_empty() check succeeds.
1640 if (!q
->streaming
) {
1641 dprintk(1, "streaming off, will not wait for buffers\n");
1646 dprintk(1, "Queue in error state, will not wait for buffers\n");
1650 if (q
->last_buffer_dequeued
) {
1651 dprintk(3, "last buffer dequeued already, will not wait for buffers\n");
1655 if (!list_empty(&q
->done_list
)) {
1657 * Found a buffer that we were waiting for.
1663 dprintk(3, "nonblocking and no buffers to dequeue, will not wait\n");
1668 * We are streaming and blocking, wait for another buffer to
1669 * become ready or for streamoff. Driver's lock is released to
1670 * allow streamoff or qbuf to be called while waiting.
1672 call_void_qop(q
, wait_prepare
, q
);
1675 * All locks have been released, it is safe to sleep now.
1677 dprintk(3, "will sleep waiting for buffers\n");
1678 ret
= wait_event_interruptible(q
->done_wq
,
1679 !list_empty(&q
->done_list
) || !q
->streaming
||
1683 * We need to reevaluate both conditions again after reacquiring
1684 * the locks or return an error if one occurred.
1686 call_void_qop(q
, wait_finish
, q
);
1688 dprintk(1, "sleep was interrupted\n");
1696 * __vb2_get_done_vb() - get a buffer ready for dequeuing
1698 * Will sleep if required for nonblocking == false.
1700 static int __vb2_get_done_vb(struct vb2_queue
*q
, struct vb2_buffer
**vb
,
1701 void *pb
, int nonblocking
)
1703 unsigned long flags
;
1707 * Wait for at least one buffer to become available on the done_list.
1709 ret
= __vb2_wait_for_done_vb(q
, nonblocking
);
1714 * Driver's lock has been held since we last verified that done_list
1715 * is not empty, so no need for another list_empty(done_list) check.
1717 spin_lock_irqsave(&q
->done_lock
, flags
);
1718 *vb
= list_first_entry(&q
->done_list
, struct vb2_buffer
, done_entry
);
1720 * Only remove the buffer from done_list if all planes can be
1721 * handled. Some cases such as V4L2 file I/O and DVB have pb
1722 * == NULL; skip the check then as there's nothing to verify.
1725 ret
= call_bufop(q
, verify_planes_array
, *vb
, pb
);
1727 list_del(&(*vb
)->done_entry
);
1728 spin_unlock_irqrestore(&q
->done_lock
, flags
);
1733 int vb2_wait_for_all_buffers(struct vb2_queue
*q
)
1735 if (!q
->streaming
) {
1736 dprintk(1, "streaming off, will not wait for buffers\n");
1740 if (q
->start_streaming_called
)
1741 wait_event(q
->done_wq
, !atomic_read(&q
->owned_by_drv_count
));
1744 EXPORT_SYMBOL_GPL(vb2_wait_for_all_buffers
);
1747 * __vb2_dqbuf() - bring back the buffer to the DEQUEUED state
1749 static void __vb2_dqbuf(struct vb2_buffer
*vb
)
1751 struct vb2_queue
*q
= vb
->vb2_queue
;
1754 /* nothing to do if the buffer is already dequeued */
1755 if (vb
->state
== VB2_BUF_STATE_DEQUEUED
)
1758 vb
->state
= VB2_BUF_STATE_DEQUEUED
;
1760 /* unmap DMABUF buffer */
1761 if (q
->memory
== VB2_MEMORY_DMABUF
)
1762 for (i
= 0; i
< vb
->num_planes
; ++i
) {
1763 if (!vb
->planes
[i
].dbuf_mapped
)
1765 call_void_memop(vb
, unmap_dmabuf
, vb
->planes
[i
].mem_priv
);
1766 vb
->planes
[i
].dbuf_mapped
= 0;
1768 call_void_bufop(q
, init_buffer
, vb
);
1771 int vb2_core_dqbuf(struct vb2_queue
*q
, unsigned int *pindex
, void *pb
,
1774 struct vb2_buffer
*vb
= NULL
;
1777 ret
= __vb2_get_done_vb(q
, &vb
, pb
, nonblocking
);
1781 switch (vb
->state
) {
1782 case VB2_BUF_STATE_DONE
:
1783 dprintk(3, "returning done buffer\n");
1785 case VB2_BUF_STATE_ERROR
:
1786 dprintk(3, "returning done buffer with errors\n");
1789 dprintk(1, "invalid buffer state\n");
1793 call_void_vb_qop(vb
, buf_finish
, vb
);
1794 vb
->prepared
= false;
1797 *pindex
= vb
->index
;
1799 /* Fill buffer information for the userspace */
1801 call_void_bufop(q
, fill_user_buffer
, vb
, pb
);
1803 /* Remove from videobuf queue */
1804 list_del(&vb
->queued_entry
);
1807 trace_vb2_dqbuf(q
, vb
);
1809 /* go back to dequeued state */
1812 if (WARN_ON(vb
->req_obj
.req
)) {
1813 media_request_object_unbind(&vb
->req_obj
);
1814 media_request_object_put(&vb
->req_obj
);
1817 media_request_put(vb
->request
);
1820 dprintk(2, "dqbuf of buffer %d, with state %d\n",
1821 vb
->index
, vb
->state
);
1826 EXPORT_SYMBOL_GPL(vb2_core_dqbuf
);
1829 * __vb2_queue_cancel() - cancel and stop (pause) streaming
1831 * Removes all queued buffers from driver's queue and all buffers queued by
1832 * userspace from videobuf's queue. Returns to state after reqbufs.
1834 static void __vb2_queue_cancel(struct vb2_queue
*q
)
1839 * Tell driver to stop all transactions and release all queued
1842 if (q
->start_streaming_called
)
1843 call_void_qop(q
, stop_streaming
, q
);
1846 * If you see this warning, then the driver isn't cleaning up properly
1847 * in stop_streaming(). See the stop_streaming() documentation in
1848 * videobuf2-core.h for more information how buffers should be returned
1849 * to vb2 in stop_streaming().
1851 if (WARN_ON(atomic_read(&q
->owned_by_drv_count
))) {
1852 for (i
= 0; i
< q
->num_buffers
; ++i
)
1853 if (q
->bufs
[i
]->state
== VB2_BUF_STATE_ACTIVE
) {
1854 pr_warn("driver bug: stop_streaming operation is leaving buf %p in active state\n",
1856 vb2_buffer_done(q
->bufs
[i
], VB2_BUF_STATE_ERROR
);
1858 /* Must be zero now */
1859 WARN_ON(atomic_read(&q
->owned_by_drv_count
));
1863 q
->start_streaming_called
= 0;
1864 q
->queued_count
= 0;
1866 q
->uses_requests
= 0;
1870 * Remove all buffers from videobuf's list...
1872 INIT_LIST_HEAD(&q
->queued_list
);
1874 * ...and done list; userspace will not receive any buffers it
1875 * has not already dequeued before initiating cancel.
1877 INIT_LIST_HEAD(&q
->done_list
);
1878 atomic_set(&q
->owned_by_drv_count
, 0);
1879 wake_up_all(&q
->done_wq
);
1882 * Reinitialize all buffers for next use.
1883 * Make sure to call buf_finish for any queued buffers. Normally
1884 * that's done in dqbuf, but that's not going to happen when we
1885 * cancel the whole queue. Note: this code belongs here, not in
1886 * __vb2_dqbuf() since in vb2_core_dqbuf() there is a critical
1887 * call to __fill_user_buffer() after buf_finish(). That order can't
1888 * be changed, so we can't move the buf_finish() to __vb2_dqbuf().
1890 for (i
= 0; i
< q
->num_buffers
; ++i
) {
1891 struct vb2_buffer
*vb
= q
->bufs
[i
];
1892 struct media_request
*req
= vb
->req_obj
.req
;
1895 * If a request is associated with this buffer, then
1896 * call buf_request_cancel() to give the driver to complete()
1897 * related request objects. Otherwise those objects would
1901 enum media_request_state state
;
1902 unsigned long flags
;
1904 spin_lock_irqsave(&req
->lock
, flags
);
1906 spin_unlock_irqrestore(&req
->lock
, flags
);
1908 if (state
== MEDIA_REQUEST_STATE_QUEUED
)
1909 call_void_vb_qop(vb
, buf_request_complete
, vb
);
1915 for (plane
= 0; plane
< vb
->num_planes
; ++plane
)
1916 call_void_memop(vb
, finish
,
1917 vb
->planes
[plane
].mem_priv
);
1922 call_void_vb_qop(vb
, buf_finish
, vb
);
1923 vb
->prepared
= false;
1927 if (vb
->req_obj
.req
) {
1928 media_request_object_unbind(&vb
->req_obj
);
1929 media_request_object_put(&vb
->req_obj
);
1932 media_request_put(vb
->request
);
1937 int vb2_core_streamon(struct vb2_queue
*q
, unsigned int type
)
1941 if (type
!= q
->type
) {
1942 dprintk(1, "invalid stream type\n");
1947 dprintk(3, "already streaming\n");
1951 if (!q
->num_buffers
) {
1952 dprintk(1, "no buffers have been allocated\n");
1956 if (q
->num_buffers
< q
->min_buffers_needed
) {
1957 dprintk(1, "need at least %u allocated buffers\n",
1958 q
->min_buffers_needed
);
1963 * Tell driver to start streaming provided sufficient buffers
1966 if (q
->queued_count
>= q
->min_buffers_needed
) {
1967 ret
= v4l_vb2q_enable_media_source(q
);
1970 ret
= vb2_start_streaming(q
);
1977 dprintk(3, "successful\n");
1980 EXPORT_SYMBOL_GPL(vb2_core_streamon
);
1982 void vb2_queue_error(struct vb2_queue
*q
)
1986 wake_up_all(&q
->done_wq
);
1988 EXPORT_SYMBOL_GPL(vb2_queue_error
);
1990 int vb2_core_streamoff(struct vb2_queue
*q
, unsigned int type
)
1992 if (type
!= q
->type
) {
1993 dprintk(1, "invalid stream type\n");
1998 * Cancel will pause streaming and remove all buffers from the driver
1999 * and videobuf, effectively returning control over them to userspace.
2001 * Note that we do this even if q->streaming == 0: if you prepare or
2002 * queue buffers, and then call streamoff without ever having called
2003 * streamon, you would still expect those buffers to be returned to
2004 * their normal dequeued state.
2006 __vb2_queue_cancel(q
);
2007 q
->waiting_for_buffers
= !q
->is_output
;
2008 q
->last_buffer_dequeued
= false;
2010 dprintk(3, "successful\n");
2013 EXPORT_SYMBOL_GPL(vb2_core_streamoff
);
2016 * __find_plane_by_offset() - find plane associated with the given offset off
2018 static int __find_plane_by_offset(struct vb2_queue
*q
, unsigned long off
,
2019 unsigned int *_buffer
, unsigned int *_plane
)
2021 struct vb2_buffer
*vb
;
2022 unsigned int buffer
, plane
;
2025 * Go over all buffers and their planes, comparing the given offset
2026 * with an offset assigned to each plane. If a match is found,
2027 * return its buffer and plane numbers.
2029 for (buffer
= 0; buffer
< q
->num_buffers
; ++buffer
) {
2030 vb
= q
->bufs
[buffer
];
2032 for (plane
= 0; plane
< vb
->num_planes
; ++plane
) {
2033 if (vb
->planes
[plane
].m
.offset
== off
) {
2044 int vb2_core_expbuf(struct vb2_queue
*q
, int *fd
, unsigned int type
,
2045 unsigned int index
, unsigned int plane
, unsigned int flags
)
2047 struct vb2_buffer
*vb
= NULL
;
2048 struct vb2_plane
*vb_plane
;
2050 struct dma_buf
*dbuf
;
2052 if (q
->memory
!= VB2_MEMORY_MMAP
) {
2053 dprintk(1, "queue is not currently set up for mmap\n");
2057 if (!q
->mem_ops
->get_dmabuf
) {
2058 dprintk(1, "queue does not support DMA buffer exporting\n");
2062 if (flags
& ~(O_CLOEXEC
| O_ACCMODE
)) {
2063 dprintk(1, "queue does support only O_CLOEXEC and access mode flags\n");
2067 if (type
!= q
->type
) {
2068 dprintk(1, "invalid buffer type\n");
2072 if (index
>= q
->num_buffers
) {
2073 dprintk(1, "buffer index out of range\n");
2077 vb
= q
->bufs
[index
];
2079 if (plane
>= vb
->num_planes
) {
2080 dprintk(1, "buffer plane out of range\n");
2084 if (vb2_fileio_is_active(q
)) {
2085 dprintk(1, "expbuf: file io in progress\n");
2089 vb_plane
= &vb
->planes
[plane
];
2091 dbuf
= call_ptr_memop(vb
, get_dmabuf
, vb_plane
->mem_priv
,
2093 if (IS_ERR_OR_NULL(dbuf
)) {
2094 dprintk(1, "failed to export buffer %d, plane %d\n",
2099 ret
= dma_buf_fd(dbuf
, flags
& ~O_ACCMODE
);
2101 dprintk(3, "buffer %d, plane %d failed to export (%d)\n",
2107 dprintk(3, "buffer %d, plane %d exported as %d descriptor\n",
2113 EXPORT_SYMBOL_GPL(vb2_core_expbuf
);
2115 int vb2_mmap(struct vb2_queue
*q
, struct vm_area_struct
*vma
)
2117 unsigned long off
= vma
->vm_pgoff
<< PAGE_SHIFT
;
2118 struct vb2_buffer
*vb
;
2119 unsigned int buffer
= 0, plane
= 0;
2121 unsigned long length
;
2123 if (q
->memory
!= VB2_MEMORY_MMAP
) {
2124 dprintk(1, "queue is not currently set up for mmap\n");
2129 * Check memory area access mode.
2131 if (!(vma
->vm_flags
& VM_SHARED
)) {
2132 dprintk(1, "invalid vma flags, VM_SHARED needed\n");
2136 if (!(vma
->vm_flags
& VM_WRITE
)) {
2137 dprintk(1, "invalid vma flags, VM_WRITE needed\n");
2141 if (!(vma
->vm_flags
& VM_READ
)) {
2142 dprintk(1, "invalid vma flags, VM_READ needed\n");
2146 if (vb2_fileio_is_active(q
)) {
2147 dprintk(1, "mmap: file io in progress\n");
2152 * Find the plane corresponding to the offset passed by userspace.
2154 ret
= __find_plane_by_offset(q
, off
, &buffer
, &plane
);
2158 vb
= q
->bufs
[buffer
];
2161 * MMAP requires page_aligned buffers.
2162 * The buffer length was page_aligned at __vb2_buf_mem_alloc(),
2163 * so, we need to do the same here.
2165 length
= PAGE_ALIGN(vb
->planes
[plane
].length
);
2166 if (length
< (vma
->vm_end
- vma
->vm_start
)) {
2168 "MMAP invalid, as it would overflow buffer length\n");
2172 mutex_lock(&q
->mmap_lock
);
2173 ret
= call_memop(vb
, mmap
, vb
->planes
[plane
].mem_priv
, vma
);
2174 mutex_unlock(&q
->mmap_lock
);
2178 dprintk(3, "buffer %d, plane %d successfully mapped\n", buffer
, plane
);
2181 EXPORT_SYMBOL_GPL(vb2_mmap
);
2184 unsigned long vb2_get_unmapped_area(struct vb2_queue
*q
,
2187 unsigned long pgoff
,
2188 unsigned long flags
)
2190 unsigned long off
= pgoff
<< PAGE_SHIFT
;
2191 struct vb2_buffer
*vb
;
2192 unsigned int buffer
, plane
;
2196 if (q
->memory
!= VB2_MEMORY_MMAP
) {
2197 dprintk(1, "queue is not currently set up for mmap\n");
2202 * Find the plane corresponding to the offset passed by userspace.
2204 ret
= __find_plane_by_offset(q
, off
, &buffer
, &plane
);
2208 vb
= q
->bufs
[buffer
];
2210 vaddr
= vb2_plane_vaddr(vb
, plane
);
2211 return vaddr
? (unsigned long)vaddr
: -EINVAL
;
2213 EXPORT_SYMBOL_GPL(vb2_get_unmapped_area
);
2216 int vb2_core_queue_init(struct vb2_queue
*q
)
2223 WARN_ON(!q
->mem_ops
) ||
2224 WARN_ON(!q
->type
) ||
2225 WARN_ON(!q
->io_modes
) ||
2226 WARN_ON(!q
->ops
->queue_setup
) ||
2227 WARN_ON(!q
->ops
->buf_queue
))
2230 INIT_LIST_HEAD(&q
->queued_list
);
2231 INIT_LIST_HEAD(&q
->done_list
);
2232 spin_lock_init(&q
->done_lock
);
2233 mutex_init(&q
->mmap_lock
);
2234 init_waitqueue_head(&q
->done_wq
);
2236 q
->memory
= VB2_MEMORY_UNKNOWN
;
2238 if (q
->buf_struct_size
== 0)
2239 q
->buf_struct_size
= sizeof(struct vb2_buffer
);
2241 if (q
->bidirectional
)
2242 q
->dma_dir
= DMA_BIDIRECTIONAL
;
2244 q
->dma_dir
= q
->is_output
? DMA_TO_DEVICE
: DMA_FROM_DEVICE
;
2248 EXPORT_SYMBOL_GPL(vb2_core_queue_init
);
2250 static int __vb2_init_fileio(struct vb2_queue
*q
, int read
);
2251 static int __vb2_cleanup_fileio(struct vb2_queue
*q
);
2252 void vb2_core_queue_release(struct vb2_queue
*q
)
2254 __vb2_cleanup_fileio(q
);
2255 __vb2_queue_cancel(q
);
2256 mutex_lock(&q
->mmap_lock
);
2257 __vb2_queue_free(q
, q
->num_buffers
);
2258 mutex_unlock(&q
->mmap_lock
);
2260 EXPORT_SYMBOL_GPL(vb2_core_queue_release
);
2262 __poll_t
vb2_core_poll(struct vb2_queue
*q
, struct file
*file
,
2265 __poll_t req_events
= poll_requested_events(wait
);
2266 struct vb2_buffer
*vb
= NULL
;
2267 unsigned long flags
;
2269 if (!q
->is_output
&& !(req_events
& (EPOLLIN
| EPOLLRDNORM
)))
2271 if (q
->is_output
&& !(req_events
& (EPOLLOUT
| EPOLLWRNORM
)))
2275 * Start file I/O emulator only if streaming API has not been used yet.
2277 if (q
->num_buffers
== 0 && !vb2_fileio_is_active(q
)) {
2278 if (!q
->is_output
&& (q
->io_modes
& VB2_READ
) &&
2279 (req_events
& (EPOLLIN
| EPOLLRDNORM
))) {
2280 if (__vb2_init_fileio(q
, 1))
2283 if (q
->is_output
&& (q
->io_modes
& VB2_WRITE
) &&
2284 (req_events
& (EPOLLOUT
| EPOLLWRNORM
))) {
2285 if (__vb2_init_fileio(q
, 0))
2288 * Write to OUTPUT queue can be done immediately.
2290 return EPOLLOUT
| EPOLLWRNORM
;
2295 * There is nothing to wait for if the queue isn't streaming, or if the
2296 * error flag is set.
2298 if (!vb2_is_streaming(q
) || q
->error
)
2302 * If this quirk is set and QBUF hasn't been called yet then
2303 * return EPOLLERR as well. This only affects capture queues, output
2304 * queues will always initialize waiting_for_buffers to false.
2305 * This quirk is set by V4L2 for backwards compatibility reasons.
2307 if (q
->quirk_poll_must_check_waiting_for_buffers
&&
2308 q
->waiting_for_buffers
&& (req_events
& (EPOLLIN
| EPOLLRDNORM
)))
2312 * For output streams you can call write() as long as there are fewer
2313 * buffers queued than there are buffers available.
2315 if (q
->is_output
&& q
->fileio
&& q
->queued_count
< q
->num_buffers
)
2316 return EPOLLOUT
| EPOLLWRNORM
;
2318 if (list_empty(&q
->done_list
)) {
2320 * If the last buffer was dequeued from a capture queue,
2321 * return immediately. DQBUF will return -EPIPE.
2323 if (q
->last_buffer_dequeued
)
2324 return EPOLLIN
| EPOLLRDNORM
;
2326 poll_wait(file
, &q
->done_wq
, wait
);
2330 * Take first buffer available for dequeuing.
2332 spin_lock_irqsave(&q
->done_lock
, flags
);
2333 if (!list_empty(&q
->done_list
))
2334 vb
= list_first_entry(&q
->done_list
, struct vb2_buffer
,
2336 spin_unlock_irqrestore(&q
->done_lock
, flags
);
2338 if (vb
&& (vb
->state
== VB2_BUF_STATE_DONE
2339 || vb
->state
== VB2_BUF_STATE_ERROR
)) {
2340 return (q
->is_output
) ?
2341 EPOLLOUT
| EPOLLWRNORM
:
2342 EPOLLIN
| EPOLLRDNORM
;
2346 EXPORT_SYMBOL_GPL(vb2_core_poll
);
2349 * struct vb2_fileio_buf - buffer context used by file io emulator
2351 * vb2 provides a compatibility layer and emulator of file io (read and
2352 * write) calls on top of streaming API. This structure is used for
2353 * tracking context related to the buffers.
2355 struct vb2_fileio_buf
{
2359 unsigned int queued
:1;
2363 * struct vb2_fileio_data - queue context used by file io emulator
2365 * @cur_index: the index of the buffer currently being read from or
2366 * written to. If equal to q->num_buffers then a new buffer
2368 * @initial_index: in the read() case all buffers are queued up immediately
2369 * in __vb2_init_fileio() and __vb2_perform_fileio() just cycles
2370 * buffers. However, in the write() case no buffers are initially
2371 * queued, instead whenever a buffer is full it is queued up by
2372 * __vb2_perform_fileio(). Only once all available buffers have
2373 * been queued up will __vb2_perform_fileio() start to dequeue
2374 * buffers. This means that initially __vb2_perform_fileio()
2375 * needs to know what buffer index to use when it is queuing up
2376 * the buffers for the first time. That initial index is stored
2377 * in this field. Once it is equal to q->num_buffers all
2378 * available buffers have been queued and __vb2_perform_fileio()
2379 * should start the normal dequeue/queue cycle.
2381 * vb2 provides a compatibility layer and emulator of file io (read and
2382 * write) calls on top of streaming API. For proper operation it required
2383 * this structure to save the driver state between each call of the read
2384 * or write function.
2386 struct vb2_fileio_data
{
2389 unsigned int memory
;
2390 struct vb2_fileio_buf bufs
[VB2_MAX_FRAME
];
2391 unsigned int cur_index
;
2392 unsigned int initial_index
;
2393 unsigned int q_count
;
2394 unsigned int dq_count
;
2395 unsigned read_once
:1;
2396 unsigned write_immediately
:1;
2400 * __vb2_init_fileio() - initialize file io emulator
2401 * @q: videobuf2 queue
2402 * @read: mode selector (1 means read, 0 means write)
2404 static int __vb2_init_fileio(struct vb2_queue
*q
, int read
)
2406 struct vb2_fileio_data
*fileio
;
2408 unsigned int count
= 0;
2413 if (WARN_ON((read
&& !(q
->io_modes
& VB2_READ
)) ||
2414 (!read
&& !(q
->io_modes
& VB2_WRITE
))))
2418 * Check if device supports mapping buffers to kernel virtual space.
2420 if (!q
->mem_ops
->vaddr
)
2424 * Check if streaming api has not been already activated.
2426 if (q
->streaming
|| q
->num_buffers
> 0)
2430 * Start with count 1, driver can increase it in queue_setup()
2434 dprintk(3, "setting up file io: mode %s, count %d, read_once %d, write_immediately %d\n",
2435 (read
) ? "read" : "write", count
, q
->fileio_read_once
,
2436 q
->fileio_write_immediately
);
2438 fileio
= kzalloc(sizeof(*fileio
), GFP_KERNEL
);
2442 fileio
->read_once
= q
->fileio_read_once
;
2443 fileio
->write_immediately
= q
->fileio_write_immediately
;
2446 * Request buffers and use MMAP type to force driver
2447 * to allocate buffers by itself.
2449 fileio
->count
= count
;
2450 fileio
->memory
= VB2_MEMORY_MMAP
;
2451 fileio
->type
= q
->type
;
2453 ret
= vb2_core_reqbufs(q
, fileio
->memory
, &fileio
->count
);
2458 * Check if plane_count is correct
2459 * (multiplane buffers are not supported).
2461 if (q
->bufs
[0]->num_planes
!= 1) {
2467 * Get kernel address of each buffer.
2469 for (i
= 0; i
< q
->num_buffers
; i
++) {
2470 fileio
->bufs
[i
].vaddr
= vb2_plane_vaddr(q
->bufs
[i
], 0);
2471 if (fileio
->bufs
[i
].vaddr
== NULL
) {
2475 fileio
->bufs
[i
].size
= vb2_plane_size(q
->bufs
[i
], 0);
2479 * Read mode requires pre queuing of all buffers.
2483 * Queue all buffers.
2485 for (i
= 0; i
< q
->num_buffers
; i
++) {
2486 ret
= vb2_core_qbuf(q
, i
, NULL
, NULL
);
2489 fileio
->bufs
[i
].queued
= 1;
2492 * All buffers have been queued, so mark that by setting
2493 * initial_index to q->num_buffers
2495 fileio
->initial_index
= q
->num_buffers
;
2496 fileio
->cur_index
= q
->num_buffers
;
2502 ret
= vb2_core_streamon(q
, q
->type
);
2510 vb2_core_reqbufs(q
, fileio
->memory
, &fileio
->count
);
2519 * __vb2_cleanup_fileio() - free resourced used by file io emulator
2520 * @q: videobuf2 queue
2522 static int __vb2_cleanup_fileio(struct vb2_queue
*q
)
2524 struct vb2_fileio_data
*fileio
= q
->fileio
;
2527 vb2_core_streamoff(q
, q
->type
);
2530 vb2_core_reqbufs(q
, fileio
->memory
, &fileio
->count
);
2532 dprintk(3, "file io emulator closed\n");
2538 * __vb2_perform_fileio() - perform a single file io (read or write) operation
2539 * @q: videobuf2 queue
2540 * @data: pointed to target userspace buffer
2541 * @count: number of bytes to read or write
2542 * @ppos: file handle position tracking pointer
2543 * @nonblock: mode selector (1 means blocking calls, 0 means nonblocking)
2544 * @read: access mode selector (1 means read, 0 means write)
2546 static size_t __vb2_perform_fileio(struct vb2_queue
*q
, char __user
*data
, size_t count
,
2547 loff_t
*ppos
, int nonblock
, int read
)
2549 struct vb2_fileio_data
*fileio
;
2550 struct vb2_fileio_buf
*buf
;
2551 bool is_multiplanar
= q
->is_multiplanar
;
2553 * When using write() to write data to an output video node the vb2 core
2554 * should copy timestamps if V4L2_BUF_FLAG_TIMESTAMP_COPY is set. Nobody
2555 * else is able to provide this information with the write() operation.
2557 bool copy_timestamp
= !read
&& q
->copy_timestamp
;
2561 dprintk(3, "mode %s, offset %ld, count %zd, %sblocking\n",
2562 read
? "read" : "write", (long)*ppos
, count
,
2563 nonblock
? "non" : "");
2569 * Initialize emulator on first call.
2571 if (!vb2_fileio_is_active(q
)) {
2572 ret
= __vb2_init_fileio(q
, read
);
2573 dprintk(3, "vb2_init_fileio result: %d\n", ret
);
2580 * Check if we need to dequeue the buffer.
2582 index
= fileio
->cur_index
;
2583 if (index
>= q
->num_buffers
) {
2584 struct vb2_buffer
*b
;
2587 * Call vb2_dqbuf to get buffer back.
2589 ret
= vb2_core_dqbuf(q
, &index
, NULL
, nonblock
);
2590 dprintk(5, "vb2_dqbuf result: %d\n", ret
);
2593 fileio
->dq_count
+= 1;
2595 fileio
->cur_index
= index
;
2596 buf
= &fileio
->bufs
[index
];
2600 * Get number of bytes filled by the driver
2604 buf
->size
= read
? vb2_get_plane_payload(q
->bufs
[index
], 0)
2605 : vb2_plane_size(q
->bufs
[index
], 0);
2606 /* Compensate for data_offset on read in the multiplanar case. */
2607 if (is_multiplanar
&& read
&&
2608 b
->planes
[0].data_offset
< buf
->size
) {
2609 buf
->pos
= b
->planes
[0].data_offset
;
2610 buf
->size
-= buf
->pos
;
2613 buf
= &fileio
->bufs
[index
];
2617 * Limit count on last few bytes of the buffer.
2619 if (buf
->pos
+ count
> buf
->size
) {
2620 count
= buf
->size
- buf
->pos
;
2621 dprintk(5, "reducing read count: %zd\n", count
);
2625 * Transfer data to userspace.
2627 dprintk(3, "copying %zd bytes - buffer %d, offset %u\n",
2628 count
, index
, buf
->pos
);
2630 ret
= copy_to_user(data
, buf
->vaddr
+ buf
->pos
, count
);
2632 ret
= copy_from_user(buf
->vaddr
+ buf
->pos
, data
, count
);
2634 dprintk(3, "error copying data\n");
2645 * Queue next buffer if required.
2647 if (buf
->pos
== buf
->size
|| (!read
&& fileio
->write_immediately
)) {
2648 struct vb2_buffer
*b
= q
->bufs
[index
];
2651 * Check if this is the last buffer to read.
2653 if (read
&& fileio
->read_once
&& fileio
->dq_count
== 1) {
2654 dprintk(3, "read limit reached\n");
2655 return __vb2_cleanup_fileio(q
);
2659 * Call vb2_qbuf and give buffer to the driver.
2661 b
->planes
[0].bytesused
= buf
->pos
;
2664 b
->timestamp
= ktime_get_ns();
2665 ret
= vb2_core_qbuf(q
, index
, NULL
, NULL
);
2666 dprintk(5, "vb2_dbuf result: %d\n", ret
);
2671 * Buffer has been queued, update the status
2675 buf
->size
= vb2_plane_size(q
->bufs
[index
], 0);
2676 fileio
->q_count
+= 1;
2678 * If we are queuing up buffers for the first time, then
2679 * increase initial_index by one.
2681 if (fileio
->initial_index
< q
->num_buffers
)
2682 fileio
->initial_index
++;
2684 * The next buffer to use is either a buffer that's going to be
2685 * queued for the first time (initial_index < q->num_buffers)
2686 * or it is equal to q->num_buffers, meaning that the next
2687 * time we need to dequeue a buffer since we've now queued up
2688 * all the 'first time' buffers.
2690 fileio
->cur_index
= fileio
->initial_index
;
2694 * Return proper number of bytes processed.
2701 size_t vb2_read(struct vb2_queue
*q
, char __user
*data
, size_t count
,
2702 loff_t
*ppos
, int nonblocking
)
2704 return __vb2_perform_fileio(q
, data
, count
, ppos
, nonblocking
, 1);
2706 EXPORT_SYMBOL_GPL(vb2_read
);
2708 size_t vb2_write(struct vb2_queue
*q
, const char __user
*data
, size_t count
,
2709 loff_t
*ppos
, int nonblocking
)
2711 return __vb2_perform_fileio(q
, (char __user
*) data
, count
,
2712 ppos
, nonblocking
, 0);
2714 EXPORT_SYMBOL_GPL(vb2_write
);
2716 struct vb2_threadio_data
{
2717 struct task_struct
*thread
;
2723 static int vb2_thread(void *data
)
2725 struct vb2_queue
*q
= data
;
2726 struct vb2_threadio_data
*threadio
= q
->threadio
;
2727 bool copy_timestamp
= false;
2728 unsigned prequeue
= 0;
2733 prequeue
= q
->num_buffers
;
2734 copy_timestamp
= q
->copy_timestamp
;
2740 struct vb2_buffer
*vb
;
2743 * Call vb2_dqbuf to get buffer back.
2746 vb
= q
->bufs
[index
++];
2749 call_void_qop(q
, wait_finish
, q
);
2750 if (!threadio
->stop
)
2751 ret
= vb2_core_dqbuf(q
, &index
, NULL
, 0);
2752 call_void_qop(q
, wait_prepare
, q
);
2753 dprintk(5, "file io: vb2_dqbuf result: %d\n", ret
);
2755 vb
= q
->bufs
[index
];
2757 if (ret
|| threadio
->stop
)
2761 if (vb
->state
!= VB2_BUF_STATE_ERROR
)
2762 if (threadio
->fnc(vb
, threadio
->priv
))
2764 call_void_qop(q
, wait_finish
, q
);
2766 vb
->timestamp
= ktime_get_ns();
2767 if (!threadio
->stop
)
2768 ret
= vb2_core_qbuf(q
, vb
->index
, NULL
, NULL
);
2769 call_void_qop(q
, wait_prepare
, q
);
2770 if (ret
|| threadio
->stop
)
2774 /* Hmm, linux becomes *very* unhappy without this ... */
2775 while (!kthread_should_stop()) {
2776 set_current_state(TASK_INTERRUPTIBLE
);
2783 * This function should not be used for anything else but the videobuf2-dvb
2784 * support. If you think you have another good use-case for this, then please
2785 * contact the linux-media mailinglist first.
2787 int vb2_thread_start(struct vb2_queue
*q
, vb2_thread_fnc fnc
, void *priv
,
2788 const char *thread_name
)
2790 struct vb2_threadio_data
*threadio
;
2797 if (WARN_ON(q
->fileio
))
2800 threadio
= kzalloc(sizeof(*threadio
), GFP_KERNEL
);
2801 if (threadio
== NULL
)
2803 threadio
->fnc
= fnc
;
2804 threadio
->priv
= priv
;
2806 ret
= __vb2_init_fileio(q
, !q
->is_output
);
2807 dprintk(3, "file io: vb2_init_fileio result: %d\n", ret
);
2810 q
->threadio
= threadio
;
2811 threadio
->thread
= kthread_run(vb2_thread
, q
, "vb2-%s", thread_name
);
2812 if (IS_ERR(threadio
->thread
)) {
2813 ret
= PTR_ERR(threadio
->thread
);
2814 threadio
->thread
= NULL
;
2820 __vb2_cleanup_fileio(q
);
2825 EXPORT_SYMBOL_GPL(vb2_thread_start
);
2827 int vb2_thread_stop(struct vb2_queue
*q
)
2829 struct vb2_threadio_data
*threadio
= q
->threadio
;
2832 if (threadio
== NULL
)
2834 threadio
->stop
= true;
2835 /* Wake up all pending sleeps in the thread */
2837 err
= kthread_stop(threadio
->thread
);
2838 __vb2_cleanup_fileio(q
);
2839 threadio
->thread
= NULL
;
2844 EXPORT_SYMBOL_GPL(vb2_thread_stop
);
2846 MODULE_DESCRIPTION("Media buffer core framework");
2847 MODULE_AUTHOR("Pawel Osciak <pawel@osciak.com>, Marek Szyprowski");
2848 MODULE_LICENSE("GPL");