2 * videobuf2-core.c - V4L2 driver helper framework
4 * Copyright (C) 2010 Samsung Electronics
6 * Author: Pawel Osciak <pawel@osciak.com>
7 * Marek Szyprowski <m.szyprowski@samsung.com>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation.
14 #include <linux/err.h>
15 #include <linux/kernel.h>
16 #include <linux/module.h>
18 #include <linux/poll.h>
19 #include <linux/slab.h>
20 #include <linux/sched.h>
22 #include <media/videobuf2-core.h>
25 module_param(debug
, int, 0644);
27 #define dprintk(level, fmt, arg...) \
30 printk(KERN_DEBUG "vb2: " fmt, ## arg); \
33 #define call_memop(q, plane, op, args...) \
34 (((q)->mem_ops->op) ? \
35 ((q)->mem_ops->op(args)) : 0)
37 #define call_qop(q, op, args...) \
38 (((q)->ops->op) ? ((q)->ops->op(args)) : 0)
40 #define V4L2_BUFFER_STATE_FLAGS (V4L2_BUF_FLAG_MAPPED | V4L2_BUF_FLAG_QUEUED | \
41 V4L2_BUF_FLAG_DONE | V4L2_BUF_FLAG_ERROR)
44 * __vb2_buf_mem_alloc() - allocate video memory for the given buffer
46 static int __vb2_buf_mem_alloc(struct vb2_buffer
*vb
,
47 unsigned long *plane_sizes
)
49 struct vb2_queue
*q
= vb
->vb2_queue
;
53 /* Allocate memory for all planes in this buffer */
54 for (plane
= 0; plane
< vb
->num_planes
; ++plane
) {
55 mem_priv
= call_memop(q
, plane
, alloc
, q
->alloc_ctx
[plane
],
57 if (IS_ERR_OR_NULL(mem_priv
))
60 /* Associate allocator private data with this plane */
61 vb
->planes
[plane
].mem_priv
= mem_priv
;
62 vb
->v4l2_planes
[plane
].length
= plane_sizes
[plane
];
67 /* Free already allocated memory if one of the allocations failed */
68 for (; plane
> 0; --plane
)
69 call_memop(q
, plane
, put
, vb
->planes
[plane
- 1].mem_priv
);
75 * __vb2_buf_mem_free() - free memory of the given buffer
77 static void __vb2_buf_mem_free(struct vb2_buffer
*vb
)
79 struct vb2_queue
*q
= vb
->vb2_queue
;
82 for (plane
= 0; plane
< vb
->num_planes
; ++plane
) {
83 call_memop(q
, plane
, put
, vb
->planes
[plane
].mem_priv
);
84 vb
->planes
[plane
].mem_priv
= NULL
;
85 dprintk(3, "Freed plane %d of buffer %d\n",
86 plane
, vb
->v4l2_buf
.index
);
91 * __vb2_buf_userptr_put() - release userspace memory associated with
94 static void __vb2_buf_userptr_put(struct vb2_buffer
*vb
)
96 struct vb2_queue
*q
= vb
->vb2_queue
;
99 for (plane
= 0; plane
< vb
->num_planes
; ++plane
) {
100 void *mem_priv
= vb
->planes
[plane
].mem_priv
;
103 call_memop(q
, plane
, put_userptr
, mem_priv
);
104 vb
->planes
[plane
].mem_priv
= NULL
;
110 * __setup_offsets() - setup unique offsets ("cookies") for every plane in
111 * every buffer on the queue
113 static void __setup_offsets(struct vb2_queue
*q
)
115 unsigned int buffer
, plane
;
116 struct vb2_buffer
*vb
;
117 unsigned long off
= 0;
119 for (buffer
= 0; buffer
< q
->num_buffers
; ++buffer
) {
120 vb
= q
->bufs
[buffer
];
124 for (plane
= 0; plane
< vb
->num_planes
; ++plane
) {
125 vb
->v4l2_planes
[plane
].m
.mem_offset
= off
;
127 dprintk(3, "Buffer %d, plane %d offset 0x%08lx\n",
130 off
+= vb
->v4l2_planes
[plane
].length
;
131 off
= PAGE_ALIGN(off
);
137 * __vb2_queue_alloc() - allocate videobuf buffer structures and (for MMAP type)
138 * video buffer memory for all buffers/planes on the queue and initializes the
141 * Returns the number of buffers successfully allocated.
143 static int __vb2_queue_alloc(struct vb2_queue
*q
, enum v4l2_memory memory
,
144 unsigned int num_buffers
, unsigned int num_planes
,
145 unsigned long plane_sizes
[])
148 struct vb2_buffer
*vb
;
151 for (buffer
= 0; buffer
< num_buffers
; ++buffer
) {
152 /* Allocate videobuf buffer structures */
153 vb
= kzalloc(q
->buf_struct_size
, GFP_KERNEL
);
155 dprintk(1, "Memory alloc for buffer struct failed\n");
159 /* Length stores number of planes for multiplanar buffers */
160 if (V4L2_TYPE_IS_MULTIPLANAR(q
->type
))
161 vb
->v4l2_buf
.length
= num_planes
;
163 vb
->state
= VB2_BUF_STATE_DEQUEUED
;
165 vb
->num_planes
= num_planes
;
166 vb
->v4l2_buf
.index
= buffer
;
167 vb
->v4l2_buf
.type
= q
->type
;
168 vb
->v4l2_buf
.memory
= memory
;
170 /* Allocate video buffer memory for the MMAP type */
171 if (memory
== V4L2_MEMORY_MMAP
) {
172 ret
= __vb2_buf_mem_alloc(vb
, plane_sizes
);
174 dprintk(1, "Failed allocating memory for "
175 "buffer %d\n", buffer
);
180 * Call the driver-provided buffer initialization
181 * callback, if given. An error in initialization
182 * results in queue setup failure.
184 ret
= call_qop(q
, buf_init
, vb
);
186 dprintk(1, "Buffer %d %p initialization"
187 " failed\n", buffer
, vb
);
188 __vb2_buf_mem_free(vb
);
194 q
->bufs
[buffer
] = vb
;
197 q
->num_buffers
= buffer
;
201 dprintk(1, "Allocated %d buffers, %d plane(s) each\n",
202 q
->num_buffers
, num_planes
);
208 * __vb2_free_mem() - release all video buffer memory for a given queue
210 static void __vb2_free_mem(struct vb2_queue
*q
)
213 struct vb2_buffer
*vb
;
215 for (buffer
= 0; buffer
< q
->num_buffers
; ++buffer
) {
216 vb
= q
->bufs
[buffer
];
220 /* Free MMAP buffers or release USERPTR buffers */
221 if (q
->memory
== V4L2_MEMORY_MMAP
)
222 __vb2_buf_mem_free(vb
);
224 __vb2_buf_userptr_put(vb
);
229 * __vb2_queue_free() - free the queue - video memory and related information
230 * and return the queue to an uninitialized state. Might be called even if the
231 * queue has already been freed.
233 static void __vb2_queue_free(struct vb2_queue
*q
)
237 /* Call driver-provided cleanup function for each buffer, if provided */
238 if (q
->ops
->buf_cleanup
) {
239 for (buffer
= 0; buffer
< q
->num_buffers
; ++buffer
) {
240 if (NULL
== q
->bufs
[buffer
])
242 q
->ops
->buf_cleanup(q
->bufs
[buffer
]);
246 /* Release video buffer memory */
249 /* Free videobuf buffers */
250 for (buffer
= 0; buffer
< q
->num_buffers
; ++buffer
) {
251 kfree(q
->bufs
[buffer
]);
252 q
->bufs
[buffer
] = NULL
;
260 * __verify_planes_array() - verify that the planes array passed in struct
261 * v4l2_buffer from userspace can be safely used
263 static int __verify_planes_array(struct vb2_buffer
*vb
, struct v4l2_buffer
*b
)
265 /* Is memory for copying plane information present? */
266 if (NULL
== b
->m
.planes
) {
267 dprintk(1, "Multi-planar buffer passed but "
268 "planes array not provided\n");
272 if (b
->length
< vb
->num_planes
|| b
->length
> VIDEO_MAX_PLANES
) {
273 dprintk(1, "Incorrect planes array length, "
274 "expected %d, got %d\n", vb
->num_planes
, b
->length
);
282 * __fill_v4l2_buffer() - fill in a struct v4l2_buffer with information to be
283 * returned to userspace
285 static int __fill_v4l2_buffer(struct vb2_buffer
*vb
, struct v4l2_buffer
*b
)
287 struct vb2_queue
*q
= vb
->vb2_queue
;
290 /* Copy back data such as timestamp, flags, input, etc. */
291 memcpy(b
, &vb
->v4l2_buf
, offsetof(struct v4l2_buffer
, m
));
292 b
->input
= vb
->v4l2_buf
.input
;
293 b
->reserved
= vb
->v4l2_buf
.reserved
;
295 if (V4L2_TYPE_IS_MULTIPLANAR(q
->type
)) {
296 ret
= __verify_planes_array(vb
, b
);
301 * Fill in plane-related data if userspace provided an array
302 * for it. The memory and size is verified above.
304 memcpy(b
->m
.planes
, vb
->v4l2_planes
,
305 b
->length
* sizeof(struct v4l2_plane
));
308 * We use length and offset in v4l2_planes array even for
309 * single-planar buffers, but userspace does not.
311 b
->length
= vb
->v4l2_planes
[0].length
;
312 b
->bytesused
= vb
->v4l2_planes
[0].bytesused
;
313 if (q
->memory
== V4L2_MEMORY_MMAP
)
314 b
->m
.offset
= vb
->v4l2_planes
[0].m
.mem_offset
;
315 else if (q
->memory
== V4L2_MEMORY_USERPTR
)
316 b
->m
.userptr
= vb
->v4l2_planes
[0].m
.userptr
;
320 * Clear any buffer state related flags.
322 b
->flags
&= ~V4L2_BUFFER_STATE_FLAGS
;
325 case VB2_BUF_STATE_QUEUED
:
326 case VB2_BUF_STATE_ACTIVE
:
327 b
->flags
|= V4L2_BUF_FLAG_QUEUED
;
329 case VB2_BUF_STATE_ERROR
:
330 b
->flags
|= V4L2_BUF_FLAG_ERROR
;
332 case VB2_BUF_STATE_DONE
:
333 b
->flags
|= V4L2_BUF_FLAG_DONE
;
335 case VB2_BUF_STATE_DEQUEUED
:
340 if (vb
->num_planes_mapped
== vb
->num_planes
)
341 b
->flags
|= V4L2_BUF_FLAG_MAPPED
;
347 * vb2_querybuf() - query video buffer information
349 * @b: buffer struct passed from userspace to vidioc_querybuf handler
352 * Should be called from vidioc_querybuf ioctl handler in driver.
353 * This function will verify the passed v4l2_buffer structure and fill the
354 * relevant information for the userspace.
356 * The return values from this function are intended to be directly returned
357 * from vidioc_querybuf handler in driver.
359 int vb2_querybuf(struct vb2_queue
*q
, struct v4l2_buffer
*b
)
361 struct vb2_buffer
*vb
;
363 if (b
->type
!= q
->type
) {
364 dprintk(1, "querybuf: wrong buffer type\n");
368 if (b
->index
>= q
->num_buffers
) {
369 dprintk(1, "querybuf: buffer index out of range\n");
372 vb
= q
->bufs
[b
->index
];
374 return __fill_v4l2_buffer(vb
, b
);
376 EXPORT_SYMBOL(vb2_querybuf
);
379 * __verify_userptr_ops() - verify that all memory operations required for
380 * USERPTR queue type have been provided
382 static int __verify_userptr_ops(struct vb2_queue
*q
)
384 if (!(q
->io_modes
& VB2_USERPTR
) || !q
->mem_ops
->get_userptr
||
385 !q
->mem_ops
->put_userptr
)
392 * __verify_mmap_ops() - verify that all memory operations required for
393 * MMAP queue type have been provided
395 static int __verify_mmap_ops(struct vb2_queue
*q
)
397 if (!(q
->io_modes
& VB2_MMAP
) || !q
->mem_ops
->alloc
||
398 !q
->mem_ops
->put
|| !q
->mem_ops
->mmap
)
405 * __buffers_in_use() - return true if any buffers on the queue are in use and
406 * the queue cannot be freed (by the means of REQBUFS(0)) call
408 static bool __buffers_in_use(struct vb2_queue
*q
)
410 unsigned int buffer
, plane
;
411 struct vb2_buffer
*vb
;
413 for (buffer
= 0; buffer
< q
->num_buffers
; ++buffer
) {
414 vb
= q
->bufs
[buffer
];
415 for (plane
= 0; plane
< vb
->num_planes
; ++plane
) {
417 * If num_users() has not been provided, call_memop
418 * will return 0, apparently nobody cares about this
419 * case anyway. If num_users() returns more than 1,
420 * we are not the only user of the plane's memory.
422 if (call_memop(q
, plane
, num_users
,
423 vb
->planes
[plane
].mem_priv
) > 1)
432 * vb2_reqbufs() - Initiate streaming
433 * @q: videobuf2 queue
434 * @req: struct passed from userspace to vidioc_reqbufs handler in driver
436 * Should be called from vidioc_reqbufs ioctl handler of a driver.
438 * 1) verifies streaming parameters passed from the userspace,
439 * 2) sets up the queue,
440 * 3) negotiates number of buffers and planes per buffer with the driver
441 * to be used during streaming,
442 * 4) allocates internal buffer structures (struct vb2_buffer), according to
443 * the agreed parameters,
444 * 5) for MMAP memory type, allocates actual video memory, using the
445 * memory handling/allocation routines provided during queue initialization
447 * If req->count is 0, all the memory will be freed instead.
448 * If the queue has been allocated previously (by a previous vb2_reqbufs) call
449 * and the queue is not busy, memory will be reallocated.
451 * The return values from this function are intended to be directly returned
452 * from vidioc_reqbufs handler in driver.
454 int vb2_reqbufs(struct vb2_queue
*q
, struct v4l2_requestbuffers
*req
)
456 unsigned int num_buffers
, num_planes
;
457 unsigned long plane_sizes
[VIDEO_MAX_PLANES
];
461 dprintk(1, "reqbufs: file io in progress\n");
465 if (req
->memory
!= V4L2_MEMORY_MMAP
466 && req
->memory
!= V4L2_MEMORY_USERPTR
) {
467 dprintk(1, "reqbufs: unsupported memory type\n");
471 if (req
->type
!= q
->type
) {
472 dprintk(1, "reqbufs: requested type is incorrect\n");
477 dprintk(1, "reqbufs: streaming active\n");
482 * Make sure all the required memory ops for given memory type
485 if (req
->memory
== V4L2_MEMORY_MMAP
&& __verify_mmap_ops(q
)) {
486 dprintk(1, "reqbufs: MMAP for current setup unsupported\n");
490 if (req
->memory
== V4L2_MEMORY_USERPTR
&& __verify_userptr_ops(q
)) {
491 dprintk(1, "reqbufs: USERPTR for current setup unsupported\n");
496 * If the same number of buffers and memory access method is requested
497 * then return immediately.
499 if (q
->memory
== req
->memory
&& req
->count
== q
->num_buffers
)
502 if (req
->count
== 0 || q
->num_buffers
!= 0 || q
->memory
!= req
->memory
) {
504 * We already have buffers allocated, so first check if they
505 * are not in use and can be freed.
507 if (q
->memory
== V4L2_MEMORY_MMAP
&& __buffers_in_use(q
)) {
508 dprintk(1, "reqbufs: memory in use, cannot free\n");
515 * In case of REQBUFS(0) return immediately without calling
516 * driver's queue_setup() callback and allocating resources.
523 * Make sure the requested values and current defaults are sane.
525 num_buffers
= min_t(unsigned int, req
->count
, VIDEO_MAX_FRAME
);
526 memset(plane_sizes
, 0, sizeof(plane_sizes
));
527 memset(q
->alloc_ctx
, 0, sizeof(q
->alloc_ctx
));
528 q
->memory
= req
->memory
;
531 * Ask the driver how many buffers and planes per buffer it requires.
532 * Driver also sets the size and allocator context for each plane.
534 ret
= call_qop(q
, queue_setup
, q
, &num_buffers
, &num_planes
,
535 plane_sizes
, q
->alloc_ctx
);
539 /* Finally, allocate buffers and video memory */
540 ret
= __vb2_queue_alloc(q
, req
->memory
, num_buffers
, num_planes
,
543 dprintk(1, "Memory allocation failed with error: %d\n", ret
);
548 * Check if driver can handle the allocated number of buffers.
550 if (ret
< num_buffers
) {
551 unsigned int orig_num_buffers
;
553 orig_num_buffers
= num_buffers
= ret
;
554 ret
= call_qop(q
, queue_setup
, q
, &num_buffers
, &num_planes
,
555 plane_sizes
, q
->alloc_ctx
);
559 if (orig_num_buffers
< num_buffers
) {
565 * Ok, driver accepted smaller number of buffers.
571 * Return the number of successfully allocated buffers
582 EXPORT_SYMBOL_GPL(vb2_reqbufs
);
585 * vb2_plane_vaddr() - Return a kernel virtual address of a given plane
586 * @vb: vb2_buffer to which the plane in question belongs to
587 * @plane_no: plane number for which the address is to be returned
589 * This function returns a kernel virtual address of a given plane if
590 * such a mapping exist, NULL otherwise.
592 void *vb2_plane_vaddr(struct vb2_buffer
*vb
, unsigned int plane_no
)
594 struct vb2_queue
*q
= vb
->vb2_queue
;
596 if (plane_no
> vb
->num_planes
)
599 return call_memop(q
, plane_no
, vaddr
, vb
->planes
[plane_no
].mem_priv
);
602 EXPORT_SYMBOL_GPL(vb2_plane_vaddr
);
605 * vb2_plane_cookie() - Return allocator specific cookie for the given plane
606 * @vb: vb2_buffer to which the plane in question belongs to
607 * @plane_no: plane number for which the cookie is to be returned
609 * This function returns an allocator specific cookie for a given plane if
610 * available, NULL otherwise. The allocator should provide some simple static
611 * inline function, which would convert this cookie to the allocator specific
612 * type that can be used directly by the driver to access the buffer. This can
613 * be for example physical address, pointer to scatter list or IOMMU mapping.
615 void *vb2_plane_cookie(struct vb2_buffer
*vb
, unsigned int plane_no
)
617 struct vb2_queue
*q
= vb
->vb2_queue
;
619 if (plane_no
> vb
->num_planes
)
622 return call_memop(q
, plane_no
, cookie
, vb
->planes
[plane_no
].mem_priv
);
624 EXPORT_SYMBOL_GPL(vb2_plane_cookie
);
627 * vb2_buffer_done() - inform videobuf that an operation on a buffer is finished
628 * @vb: vb2_buffer returned from the driver
629 * @state: either VB2_BUF_STATE_DONE if the operation finished successfully
630 * or VB2_BUF_STATE_ERROR if the operation finished with an error
632 * This function should be called by the driver after a hardware operation on
633 * a buffer is finished and the buffer may be returned to userspace. The driver
634 * cannot use this buffer anymore until it is queued back to it by videobuf
635 * by the means of buf_queue callback. Only buffers previously queued to the
636 * driver by buf_queue can be passed to this function.
638 void vb2_buffer_done(struct vb2_buffer
*vb
, enum vb2_buffer_state state
)
640 struct vb2_queue
*q
= vb
->vb2_queue
;
643 if (vb
->state
!= VB2_BUF_STATE_ACTIVE
)
646 if (state
!= VB2_BUF_STATE_DONE
&& state
!= VB2_BUF_STATE_ERROR
)
649 dprintk(4, "Done processing on buffer %d, state: %d\n",
650 vb
->v4l2_buf
.index
, vb
->state
);
652 /* Add the buffer to the done buffers list */
653 spin_lock_irqsave(&q
->done_lock
, flags
);
655 list_add_tail(&vb
->done_entry
, &q
->done_list
);
656 atomic_dec(&q
->queued_count
);
657 spin_unlock_irqrestore(&q
->done_lock
, flags
);
659 /* Inform any processes that may be waiting for buffers */
660 wake_up(&q
->done_wq
);
662 EXPORT_SYMBOL_GPL(vb2_buffer_done
);
665 * __fill_vb2_buffer() - fill a vb2_buffer with information provided in
666 * a v4l2_buffer by the userspace
668 static int __fill_vb2_buffer(struct vb2_buffer
*vb
, struct v4l2_buffer
*b
,
669 struct v4l2_plane
*v4l2_planes
)
674 if (V4L2_TYPE_IS_MULTIPLANAR(b
->type
)) {
676 * Verify that the userspace gave us a valid array for
679 ret
= __verify_planes_array(vb
, b
);
683 /* Fill in driver-provided information for OUTPUT types */
684 if (V4L2_TYPE_IS_OUTPUT(b
->type
)) {
686 * Will have to go up to b->length when API starts
687 * accepting variable number of planes.
689 for (plane
= 0; plane
< vb
->num_planes
; ++plane
) {
690 v4l2_planes
[plane
].bytesused
=
691 b
->m
.planes
[plane
].bytesused
;
692 v4l2_planes
[plane
].data_offset
=
693 b
->m
.planes
[plane
].data_offset
;
697 if (b
->memory
== V4L2_MEMORY_USERPTR
) {
698 for (plane
= 0; plane
< vb
->num_planes
; ++plane
) {
699 v4l2_planes
[plane
].m
.userptr
=
700 b
->m
.planes
[plane
].m
.userptr
;
701 v4l2_planes
[plane
].length
=
702 b
->m
.planes
[plane
].length
;
707 * Single-planar buffers do not use planes array,
708 * so fill in relevant v4l2_buffer struct fields instead.
709 * In videobuf we use our internal V4l2_planes struct for
710 * single-planar buffers as well, for simplicity.
712 if (V4L2_TYPE_IS_OUTPUT(b
->type
))
713 v4l2_planes
[0].bytesused
= b
->bytesused
;
715 if (b
->memory
== V4L2_MEMORY_USERPTR
) {
716 v4l2_planes
[0].m
.userptr
= b
->m
.userptr
;
717 v4l2_planes
[0].length
= b
->length
;
721 vb
->v4l2_buf
.field
= b
->field
;
722 vb
->v4l2_buf
.timestamp
= b
->timestamp
;
723 vb
->v4l2_buf
.input
= b
->input
;
724 vb
->v4l2_buf
.flags
= b
->flags
& ~V4L2_BUFFER_STATE_FLAGS
;
730 * __qbuf_userptr() - handle qbuf of a USERPTR buffer
732 static int __qbuf_userptr(struct vb2_buffer
*vb
, struct v4l2_buffer
*b
)
734 struct v4l2_plane planes
[VIDEO_MAX_PLANES
];
735 struct vb2_queue
*q
= vb
->vb2_queue
;
739 int write
= !V4L2_TYPE_IS_OUTPUT(q
->type
);
741 /* Verify and copy relevant information provided by the userspace */
742 ret
= __fill_vb2_buffer(vb
, b
, planes
);
746 for (plane
= 0; plane
< vb
->num_planes
; ++plane
) {
747 /* Skip the plane if already verified */
748 if (vb
->v4l2_planes
[plane
].m
.userptr
== planes
[plane
].m
.userptr
749 && vb
->v4l2_planes
[plane
].length
== planes
[plane
].length
)
752 dprintk(3, "qbuf: userspace address for plane %d changed, "
753 "reacquiring memory\n", plane
);
755 /* Release previously acquired memory if present */
756 if (vb
->planes
[plane
].mem_priv
)
757 call_memop(q
, plane
, put_userptr
,
758 vb
->planes
[plane
].mem_priv
);
760 vb
->planes
[plane
].mem_priv
= NULL
;
762 /* Acquire each plane's memory */
763 if (q
->mem_ops
->get_userptr
) {
764 mem_priv
= q
->mem_ops
->get_userptr(q
->alloc_ctx
[plane
],
765 planes
[plane
].m
.userptr
,
766 planes
[plane
].length
,
768 if (IS_ERR(mem_priv
)) {
769 dprintk(1, "qbuf: failed acquiring userspace "
770 "memory for plane %d\n", plane
);
771 ret
= PTR_ERR(mem_priv
);
774 vb
->planes
[plane
].mem_priv
= mem_priv
;
779 * Call driver-specific initialization on the newly acquired buffer,
782 ret
= call_qop(q
, buf_init
, vb
);
784 dprintk(1, "qbuf: buffer initialization failed\n");
789 * Now that everything is in order, copy relevant information
790 * provided by userspace.
792 for (plane
= 0; plane
< vb
->num_planes
; ++plane
)
793 vb
->v4l2_planes
[plane
] = planes
[plane
];
797 /* In case of errors, release planes that were already acquired */
798 for (; plane
> 0; --plane
) {
799 call_memop(q
, plane
, put_userptr
,
800 vb
->planes
[plane
- 1].mem_priv
);
801 vb
->planes
[plane
- 1].mem_priv
= NULL
;
808 * __qbuf_mmap() - handle qbuf of an MMAP buffer
810 static int __qbuf_mmap(struct vb2_buffer
*vb
, struct v4l2_buffer
*b
)
812 return __fill_vb2_buffer(vb
, b
, vb
->v4l2_planes
);
816 * __enqueue_in_driver() - enqueue a vb2_buffer in driver for processing
818 static void __enqueue_in_driver(struct vb2_buffer
*vb
)
820 struct vb2_queue
*q
= vb
->vb2_queue
;
822 vb
->state
= VB2_BUF_STATE_ACTIVE
;
823 atomic_inc(&q
->queued_count
);
824 q
->ops
->buf_queue(vb
);
828 * vb2_qbuf() - Queue a buffer from userspace
829 * @q: videobuf2 queue
830 * @b: buffer structure passed from userspace to vidioc_qbuf handler
833 * Should be called from vidioc_qbuf ioctl handler of a driver.
835 * 1) verifies the passed buffer,
836 * 2) calls buf_prepare callback in the driver (if provided), in which
837 * driver-specific buffer initialization can be performed,
838 * 3) if streaming is on, queues the buffer in driver by the means of buf_queue
839 * callback for processing.
841 * The return values from this function are intended to be directly returned
842 * from vidioc_qbuf handler in driver.
844 int vb2_qbuf(struct vb2_queue
*q
, struct v4l2_buffer
*b
)
846 struct vb2_buffer
*vb
;
850 dprintk(1, "qbuf: file io in progress\n");
854 if (b
->type
!= q
->type
) {
855 dprintk(1, "qbuf: invalid buffer type\n");
859 if (b
->index
>= q
->num_buffers
) {
860 dprintk(1, "qbuf: buffer index out of range\n");
864 vb
= q
->bufs
[b
->index
];
866 /* Should never happen */
867 dprintk(1, "qbuf: buffer is NULL\n");
871 if (b
->memory
!= q
->memory
) {
872 dprintk(1, "qbuf: invalid memory type\n");
876 if (vb
->state
!= VB2_BUF_STATE_DEQUEUED
) {
877 dprintk(1, "qbuf: buffer already in use\n");
881 if (q
->memory
== V4L2_MEMORY_MMAP
)
882 ret
= __qbuf_mmap(vb
, b
);
883 else if (q
->memory
== V4L2_MEMORY_USERPTR
)
884 ret
= __qbuf_userptr(vb
, b
);
886 WARN(1, "Invalid queue type\n");
893 ret
= call_qop(q
, buf_prepare
, vb
);
895 dprintk(1, "qbuf: buffer preparation failed\n");
900 * Add to the queued buffers list, a buffer will stay on it until
903 list_add_tail(&vb
->queued_entry
, &q
->queued_list
);
904 vb
->state
= VB2_BUF_STATE_QUEUED
;
907 * If already streaming, give the buffer to driver for processing.
908 * If not, the buffer will be given to driver on next streamon.
911 __enqueue_in_driver(vb
);
913 dprintk(1, "qbuf of buffer %d succeeded\n", vb
->v4l2_buf
.index
);
916 EXPORT_SYMBOL_GPL(vb2_qbuf
);
919 * __vb2_wait_for_done_vb() - wait for a buffer to become available
922 * Will sleep if required for nonblocking == false.
924 static int __vb2_wait_for_done_vb(struct vb2_queue
*q
, int nonblocking
)
927 * All operations on vb_done_list are performed under done_lock
928 * spinlock protection. However, buffers may be removed from
929 * it and returned to userspace only while holding both driver's
930 * lock and the done_lock spinlock. Thus we can be sure that as
931 * long as we hold the driver's lock, the list will remain not
932 * empty if list_empty() check succeeds.
939 dprintk(1, "Streaming off, will not wait for buffers\n");
943 if (!list_empty(&q
->done_list
)) {
945 * Found a buffer that we were waiting for.
951 dprintk(1, "Nonblocking and no buffers to dequeue, "
957 * We are streaming and blocking, wait for another buffer to
958 * become ready or for streamoff. Driver's lock is released to
959 * allow streamoff or qbuf to be called while waiting.
961 call_qop(q
, wait_prepare
, q
);
964 * All locks have been released, it is safe to sleep now.
966 dprintk(3, "Will sleep waiting for buffers\n");
967 ret
= wait_event_interruptible(q
->done_wq
,
968 !list_empty(&q
->done_list
) || !q
->streaming
);
971 * We need to reevaluate both conditions again after reacquiring
972 * the locks or return an error if one occurred.
974 call_qop(q
, wait_finish
, q
);
982 * __vb2_get_done_vb() - get a buffer ready for dequeuing
984 * Will sleep if required for nonblocking == false.
986 static int __vb2_get_done_vb(struct vb2_queue
*q
, struct vb2_buffer
**vb
,
993 * Wait for at least one buffer to become available on the done_list.
995 ret
= __vb2_wait_for_done_vb(q
, nonblocking
);
1000 * Driver's lock has been held since we last verified that done_list
1001 * is not empty, so no need for another list_empty(done_list) check.
1003 spin_lock_irqsave(&q
->done_lock
, flags
);
1004 *vb
= list_first_entry(&q
->done_list
, struct vb2_buffer
, done_entry
);
1005 list_del(&(*vb
)->done_entry
);
1006 spin_unlock_irqrestore(&q
->done_lock
, flags
);
1012 * vb2_wait_for_all_buffers() - wait until all buffers are given back to vb2
1013 * @q: videobuf2 queue
1015 * This function will wait until all buffers that have been given to the driver
1016 * by buf_queue() are given back to vb2 with vb2_buffer_done(). It doesn't call
1017 * wait_prepare, wait_finish pair. It is intended to be called with all locks
1018 * taken, for example from stop_streaming() callback.
1020 int vb2_wait_for_all_buffers(struct vb2_queue
*q
)
1022 if (!q
->streaming
) {
1023 dprintk(1, "Streaming off, will not wait for buffers\n");
1027 wait_event(q
->done_wq
, !atomic_read(&q
->queued_count
));
1030 EXPORT_SYMBOL_GPL(vb2_wait_for_all_buffers
);
1033 * vb2_dqbuf() - Dequeue a buffer to the userspace
1034 * @q: videobuf2 queue
1035 * @b: buffer structure passed from userspace to vidioc_dqbuf handler
1037 * @nonblocking: if true, this call will not sleep waiting for a buffer if no
1038 * buffers ready for dequeuing are present. Normally the driver
1039 * would be passing (file->f_flags & O_NONBLOCK) here
1041 * Should be called from vidioc_dqbuf ioctl handler of a driver.
1043 * 1) verifies the passed buffer,
1044 * 2) calls buf_finish callback in the driver (if provided), in which
1045 * driver can perform any additional operations that may be required before
1046 * returning the buffer to userspace, such as cache sync,
1047 * 3) the buffer struct members are filled with relevant information for
1050 * The return values from this function are intended to be directly returned
1051 * from vidioc_dqbuf handler in driver.
1053 int vb2_dqbuf(struct vb2_queue
*q
, struct v4l2_buffer
*b
, bool nonblocking
)
1055 struct vb2_buffer
*vb
= NULL
;
1059 dprintk(1, "dqbuf: file io in progress\n");
1063 if (b
->type
!= q
->type
) {
1064 dprintk(1, "dqbuf: invalid buffer type\n");
1068 ret
= __vb2_get_done_vb(q
, &vb
, nonblocking
);
1070 dprintk(1, "dqbuf: error getting next done buffer\n");
1074 ret
= call_qop(q
, buf_finish
, vb
);
1076 dprintk(1, "dqbuf: buffer finish failed\n");
1080 switch (vb
->state
) {
1081 case VB2_BUF_STATE_DONE
:
1082 dprintk(3, "dqbuf: Returning done buffer\n");
1084 case VB2_BUF_STATE_ERROR
:
1085 dprintk(3, "dqbuf: Returning done buffer with errors\n");
1088 dprintk(1, "dqbuf: Invalid buffer state\n");
1092 /* Fill buffer information for the userspace */
1093 __fill_v4l2_buffer(vb
, b
);
1094 /* Remove from videobuf queue */
1095 list_del(&vb
->queued_entry
);
1097 dprintk(1, "dqbuf of buffer %d, with state %d\n",
1098 vb
->v4l2_buf
.index
, vb
->state
);
1100 vb
->state
= VB2_BUF_STATE_DEQUEUED
;
1103 EXPORT_SYMBOL_GPL(vb2_dqbuf
);
1106 * vb2_streamon - start streaming
1107 * @q: videobuf2 queue
1108 * @type: type argument passed from userspace to vidioc_streamon handler
1110 * Should be called from vidioc_streamon handler of a driver.
1112 * 1) verifies current state
1113 * 2) starts streaming and passes any previously queued buffers to the driver
1115 * The return values from this function are intended to be directly returned
1116 * from vidioc_streamon handler in the driver.
1118 int vb2_streamon(struct vb2_queue
*q
, enum v4l2_buf_type type
)
1120 struct vb2_buffer
*vb
;
1124 dprintk(1, "streamon: file io in progress\n");
1128 if (type
!= q
->type
) {
1129 dprintk(1, "streamon: invalid stream type\n");
1134 dprintk(1, "streamon: already streaming\n");
1139 * Cannot start streaming on an OUTPUT device if no buffers have
1142 if (V4L2_TYPE_IS_OUTPUT(q
->type
)) {
1143 if (list_empty(&q
->queued_list
)) {
1144 dprintk(1, "streamon: no output buffers queued\n");
1150 * Let driver notice that streaming state has been enabled.
1152 ret
= call_qop(q
, start_streaming
, q
);
1154 dprintk(1, "streamon: driver refused to start streaming\n");
1161 * If any buffers were queued before streamon,
1162 * we can now pass them to driver for processing.
1164 list_for_each_entry(vb
, &q
->queued_list
, queued_entry
)
1165 __enqueue_in_driver(vb
);
1167 dprintk(3, "Streamon successful\n");
1170 EXPORT_SYMBOL_GPL(vb2_streamon
);
1173 * __vb2_queue_cancel() - cancel and stop (pause) streaming
1175 * Removes all queued buffers from driver's queue and all buffers queued by
1176 * userspace from videobuf's queue. Returns to state after reqbufs.
1178 static void __vb2_queue_cancel(struct vb2_queue
*q
)
1183 * Tell driver to stop all transactions and release all queued
1187 call_qop(q
, stop_streaming
, q
);
1191 * Remove all buffers from videobuf's list...
1193 INIT_LIST_HEAD(&q
->queued_list
);
1195 * ...and done list; userspace will not receive any buffers it
1196 * has not already dequeued before initiating cancel.
1198 INIT_LIST_HEAD(&q
->done_list
);
1199 wake_up_all(&q
->done_wq
);
1202 * Reinitialize all buffers for next use.
1204 for (i
= 0; i
< q
->num_buffers
; ++i
)
1205 q
->bufs
[i
]->state
= VB2_BUF_STATE_DEQUEUED
;
1209 * vb2_streamoff - stop streaming
1210 * @q: videobuf2 queue
1211 * @type: type argument passed from userspace to vidioc_streamoff handler
1213 * Should be called from vidioc_streamoff handler of a driver.
1215 * 1) verifies current state,
1216 * 2) stop streaming and dequeues any queued buffers, including those previously
1217 * passed to the driver (after waiting for the driver to finish).
1219 * This call can be used for pausing playback.
1220 * The return values from this function are intended to be directly returned
1221 * from vidioc_streamoff handler in the driver
1223 int vb2_streamoff(struct vb2_queue
*q
, enum v4l2_buf_type type
)
1226 dprintk(1, "streamoff: file io in progress\n");
1230 if (type
!= q
->type
) {
1231 dprintk(1, "streamoff: invalid stream type\n");
1235 if (!q
->streaming
) {
1236 dprintk(1, "streamoff: not streaming\n");
1241 * Cancel will pause streaming and remove all buffers from the driver
1242 * and videobuf, effectively returning control over them to userspace.
1244 __vb2_queue_cancel(q
);
1246 dprintk(3, "Streamoff successful\n");
1249 EXPORT_SYMBOL_GPL(vb2_streamoff
);
1252 * __find_plane_by_offset() - find plane associated with the given offset off
1254 static int __find_plane_by_offset(struct vb2_queue
*q
, unsigned long off
,
1255 unsigned int *_buffer
, unsigned int *_plane
)
1257 struct vb2_buffer
*vb
;
1258 unsigned int buffer
, plane
;
1261 * Go over all buffers and their planes, comparing the given offset
1262 * with an offset assigned to each plane. If a match is found,
1263 * return its buffer and plane numbers.
1265 for (buffer
= 0; buffer
< q
->num_buffers
; ++buffer
) {
1266 vb
= q
->bufs
[buffer
];
1268 for (plane
= 0; plane
< vb
->num_planes
; ++plane
) {
1269 if (vb
->v4l2_planes
[plane
].m
.mem_offset
== off
) {
1281 * vb2_mmap() - map video buffers into application address space
1282 * @q: videobuf2 queue
1283 * @vma: vma passed to the mmap file operation handler in the driver
1285 * Should be called from mmap file operation handler of a driver.
1286 * This function maps one plane of one of the available video buffers to
1287 * userspace. To map whole video memory allocated on reqbufs, this function
1288 * has to be called once per each plane per each buffer previously allocated.
1290 * When the userspace application calls mmap, it passes to it an offset returned
1291 * to it earlier by the means of vidioc_querybuf handler. That offset acts as
1292 * a "cookie", which is then used to identify the plane to be mapped.
1293 * This function finds a plane with a matching offset and a mapping is performed
1294 * by the means of a provided memory operation.
1296 * The return values from this function are intended to be directly returned
1297 * from the mmap handler in driver.
1299 int vb2_mmap(struct vb2_queue
*q
, struct vm_area_struct
*vma
)
1301 unsigned long off
= vma
->vm_pgoff
<< PAGE_SHIFT
;
1302 struct vb2_plane
*vb_plane
;
1303 struct vb2_buffer
*vb
;
1304 unsigned int buffer
, plane
;
1307 if (q
->memory
!= V4L2_MEMORY_MMAP
) {
1308 dprintk(1, "Queue is not currently set up for mmap\n");
1313 * Check memory area access mode.
1315 if (!(vma
->vm_flags
& VM_SHARED
)) {
1316 dprintk(1, "Invalid vma flags, VM_SHARED needed\n");
1319 if (V4L2_TYPE_IS_OUTPUT(q
->type
)) {
1320 if (!(vma
->vm_flags
& VM_WRITE
)) {
1321 dprintk(1, "Invalid vma flags, VM_WRITE needed\n");
1325 if (!(vma
->vm_flags
& VM_READ
)) {
1326 dprintk(1, "Invalid vma flags, VM_READ needed\n");
1332 * Find the plane corresponding to the offset passed by userspace.
1334 ret
= __find_plane_by_offset(q
, off
, &buffer
, &plane
);
1338 vb
= q
->bufs
[buffer
];
1339 vb_plane
= &vb
->planes
[plane
];
1341 ret
= q
->mem_ops
->mmap(vb_plane
->mem_priv
, vma
);
1345 vb_plane
->mapped
= 1;
1346 vb
->num_planes_mapped
++;
1348 dprintk(3, "Buffer %d, plane %d successfully mapped\n", buffer
, plane
);
1351 EXPORT_SYMBOL_GPL(vb2_mmap
);
1353 static int __vb2_init_fileio(struct vb2_queue
*q
, int read
);
1354 static int __vb2_cleanup_fileio(struct vb2_queue
*q
);
1357 * vb2_poll() - implements poll userspace operation
1358 * @q: videobuf2 queue
1359 * @file: file argument passed to the poll file operation handler
1360 * @wait: wait argument passed to the poll file operation handler
1362 * This function implements poll file operation handler for a driver.
1363 * For CAPTURE queues, if a buffer is ready to be dequeued, the userspace will
1364 * be informed that the file descriptor of a video device is available for
1366 * For OUTPUT queues, if a buffer is ready to be dequeued, the file descriptor
1367 * will be reported as available for writing.
1369 * The return values from this function are intended to be directly returned
1370 * from poll handler in driver.
1372 unsigned int vb2_poll(struct vb2_queue
*q
, struct file
*file
, poll_table
*wait
)
1374 unsigned long flags
;
1376 struct vb2_buffer
*vb
= NULL
;
1379 * Start file I/O emulator only if streaming API has not been used yet.
1381 if (q
->num_buffers
== 0 && q
->fileio
== NULL
) {
1382 if (!V4L2_TYPE_IS_OUTPUT(q
->type
) && (q
->io_modes
& VB2_READ
)) {
1383 ret
= __vb2_init_fileio(q
, 1);
1387 if (V4L2_TYPE_IS_OUTPUT(q
->type
) && (q
->io_modes
& VB2_WRITE
)) {
1388 ret
= __vb2_init_fileio(q
, 0);
1392 * Write to OUTPUT queue can be done immediately.
1394 return POLLOUT
| POLLWRNORM
;
1399 * There is nothing to wait for if no buffers have already been queued.
1401 if (list_empty(&q
->queued_list
))
1404 poll_wait(file
, &q
->done_wq
, wait
);
1407 * Take first buffer available for dequeuing.
1409 spin_lock_irqsave(&q
->done_lock
, flags
);
1410 if (!list_empty(&q
->done_list
))
1411 vb
= list_first_entry(&q
->done_list
, struct vb2_buffer
,
1413 spin_unlock_irqrestore(&q
->done_lock
, flags
);
1415 if (vb
&& (vb
->state
== VB2_BUF_STATE_DONE
1416 || vb
->state
== VB2_BUF_STATE_ERROR
)) {
1417 return (V4L2_TYPE_IS_OUTPUT(q
->type
)) ? POLLOUT
| POLLWRNORM
:
1418 POLLIN
| POLLRDNORM
;
1422 EXPORT_SYMBOL_GPL(vb2_poll
);
1425 * vb2_queue_init() - initialize a videobuf2 queue
1426 * @q: videobuf2 queue; this structure should be allocated in driver
1428 * The vb2_queue structure should be allocated by the driver. The driver is
1429 * responsible of clearing it's content and setting initial values for some
1430 * required entries before calling this function.
1431 * q->ops, q->mem_ops, q->type and q->io_modes are mandatory. Please refer
1432 * to the struct vb2_queue description in include/media/videobuf2-core.h
1433 * for more information.
1435 int vb2_queue_init(struct vb2_queue
*q
)
1439 BUG_ON(!q
->mem_ops
);
1441 BUG_ON(!q
->io_modes
);
1443 BUG_ON(!q
->ops
->queue_setup
);
1444 BUG_ON(!q
->ops
->buf_queue
);
1446 INIT_LIST_HEAD(&q
->queued_list
);
1447 INIT_LIST_HEAD(&q
->done_list
);
1448 spin_lock_init(&q
->done_lock
);
1449 init_waitqueue_head(&q
->done_wq
);
1451 if (q
->buf_struct_size
== 0)
1452 q
->buf_struct_size
= sizeof(struct vb2_buffer
);
1456 EXPORT_SYMBOL_GPL(vb2_queue_init
);
1459 * vb2_queue_release() - stop streaming, release the queue and free memory
1460 * @q: videobuf2 queue
1462 * This function stops streaming and performs necessary clean ups, including
1463 * freeing video buffer memory. The driver is responsible for freeing
1464 * the vb2_queue structure itself.
1466 void vb2_queue_release(struct vb2_queue
*q
)
1468 __vb2_cleanup_fileio(q
);
1469 __vb2_queue_cancel(q
);
1470 __vb2_queue_free(q
);
1472 EXPORT_SYMBOL_GPL(vb2_queue_release
);
1475 * struct vb2_fileio_buf - buffer context used by file io emulator
1477 * vb2 provides a compatibility layer and emulator of file io (read and
1478 * write) calls on top of streaming API. This structure is used for
1479 * tracking context related to the buffers.
1481 struct vb2_fileio_buf
{
1485 unsigned int queued
:1;
1489 * struct vb2_fileio_data - queue context used by file io emulator
1491 * vb2 provides a compatibility layer and emulator of file io (read and
1492 * write) calls on top of streaming API. For proper operation it required
1493 * this structure to save the driver state between each call of the read
1494 * or write function.
1496 struct vb2_fileio_data
{
1497 struct v4l2_requestbuffers req
;
1498 struct v4l2_buffer b
;
1499 struct vb2_fileio_buf bufs
[VIDEO_MAX_FRAME
];
1501 unsigned int q_count
;
1502 unsigned int dq_count
;
1507 * __vb2_init_fileio() - initialize file io emulator
1508 * @q: videobuf2 queue
1509 * @read: mode selector (1 means read, 0 means write)
1511 static int __vb2_init_fileio(struct vb2_queue
*q
, int read
)
1513 struct vb2_fileio_data
*fileio
;
1515 unsigned int count
= 0;
1520 if ((read
&& !(q
->io_modes
& VB2_READ
)) ||
1521 (!read
&& !(q
->io_modes
& VB2_WRITE
)))
1525 * Check if device supports mapping buffers to kernel virtual space.
1527 if (!q
->mem_ops
->vaddr
)
1531 * Check if streaming api has not been already activated.
1533 if (q
->streaming
|| q
->num_buffers
> 0)
1537 * Start with count 1, driver can increase it in queue_setup()
1541 dprintk(3, "setting up file io: mode %s, count %d, flags %08x\n",
1542 (read
) ? "read" : "write", count
, q
->io_flags
);
1544 fileio
= kzalloc(sizeof(struct vb2_fileio_data
), GFP_KERNEL
);
1548 fileio
->flags
= q
->io_flags
;
1551 * Request buffers and use MMAP type to force driver
1552 * to allocate buffers by itself.
1554 fileio
->req
.count
= count
;
1555 fileio
->req
.memory
= V4L2_MEMORY_MMAP
;
1556 fileio
->req
.type
= q
->type
;
1557 ret
= vb2_reqbufs(q
, &fileio
->req
);
1562 * Check if plane_count is correct
1563 * (multiplane buffers are not supported).
1565 if (q
->bufs
[0]->num_planes
!= 1) {
1566 fileio
->req
.count
= 0;
1572 * Get kernel address of each buffer.
1574 for (i
= 0; i
< q
->num_buffers
; i
++) {
1575 fileio
->bufs
[i
].vaddr
= vb2_plane_vaddr(q
->bufs
[i
], 0);
1576 if (fileio
->bufs
[i
].vaddr
== NULL
)
1578 fileio
->bufs
[i
].size
= vb2_plane_size(q
->bufs
[i
], 0);
1582 * Read mode requires pre queuing of all buffers.
1586 * Queue all buffers.
1588 for (i
= 0; i
< q
->num_buffers
; i
++) {
1589 struct v4l2_buffer
*b
= &fileio
->b
;
1590 memset(b
, 0, sizeof(*b
));
1592 b
->memory
= q
->memory
;
1594 ret
= vb2_qbuf(q
, b
);
1597 fileio
->bufs
[i
].queued
= 1;
1603 ret
= vb2_streamon(q
, q
->type
);
1613 vb2_reqbufs(q
, &fileio
->req
);
1621 * __vb2_cleanup_fileio() - free resourced used by file io emulator
1622 * @q: videobuf2 queue
1624 static int __vb2_cleanup_fileio(struct vb2_queue
*q
)
1626 struct vb2_fileio_data
*fileio
= q
->fileio
;
1630 * Hack fileio context to enable direct calls to vb2 ioctl
1635 vb2_streamoff(q
, q
->type
);
1636 fileio
->req
.count
= 0;
1637 vb2_reqbufs(q
, &fileio
->req
);
1639 dprintk(3, "file io emulator closed\n");
1645 * __vb2_perform_fileio() - perform a single file io (read or write) operation
1646 * @q: videobuf2 queue
1647 * @data: pointed to target userspace buffer
1648 * @count: number of bytes to read or write
1649 * @ppos: file handle position tracking pointer
1650 * @nonblock: mode selector (1 means blocking calls, 0 means nonblocking)
1651 * @read: access mode selector (1 means read, 0 means write)
1653 static size_t __vb2_perform_fileio(struct vb2_queue
*q
, char __user
*data
, size_t count
,
1654 loff_t
*ppos
, int nonblock
, int read
)
1656 struct vb2_fileio_data
*fileio
;
1657 struct vb2_fileio_buf
*buf
;
1660 dprintk(3, "file io: mode %s, offset %ld, count %zd, %sblocking\n",
1661 read
? "read" : "write", (long)*ppos
, count
,
1662 nonblock
? "non" : "");
1668 * Initialize emulator on first call.
1671 ret
= __vb2_init_fileio(q
, read
);
1672 dprintk(3, "file io: vb2_init_fileio result: %d\n", ret
);
1679 * Hack fileio context to enable direct calls to vb2 ioctl interface.
1680 * The pointer will be restored before returning from this function.
1684 index
= fileio
->index
;
1685 buf
= &fileio
->bufs
[index
];
1688 * Check if we need to dequeue the buffer.
1691 struct vb2_buffer
*vb
;
1694 * Call vb2_dqbuf to get buffer back.
1696 memset(&fileio
->b
, 0, sizeof(fileio
->b
));
1697 fileio
->b
.type
= q
->type
;
1698 fileio
->b
.memory
= q
->memory
;
1699 fileio
->b
.index
= index
;
1700 ret
= vb2_dqbuf(q
, &fileio
->b
, nonblock
);
1701 dprintk(5, "file io: vb2_dqbuf result: %d\n", ret
);
1704 fileio
->dq_count
+= 1;
1707 * Get number of bytes filled by the driver
1709 vb
= q
->bufs
[index
];
1710 buf
->size
= vb2_get_plane_payload(vb
, 0);
1715 * Limit count on last few bytes of the buffer.
1717 if (buf
->pos
+ count
> buf
->size
) {
1718 count
= buf
->size
- buf
->pos
;
1719 dprintk(5, "reducing read count: %zd\n", count
);
1723 * Transfer data to userspace.
1725 dprintk(3, "file io: copying %zd bytes - buffer %d, offset %u\n",
1726 count
, index
, buf
->pos
);
1728 ret
= copy_to_user(data
, buf
->vaddr
+ buf
->pos
, count
);
1730 ret
= copy_from_user(buf
->vaddr
+ buf
->pos
, data
, count
);
1732 dprintk(3, "file io: error copying data\n");
1744 * Queue next buffer if required.
1746 if (buf
->pos
== buf
->size
||
1747 (!read
&& (fileio
->flags
& VB2_FILEIO_WRITE_IMMEDIATELY
))) {
1749 * Check if this is the last buffer to read.
1751 if (read
&& (fileio
->flags
& VB2_FILEIO_READ_ONCE
) &&
1752 fileio
->dq_count
== 1) {
1753 dprintk(3, "file io: read limit reached\n");
1755 * Restore fileio pointer and release the context.
1758 return __vb2_cleanup_fileio(q
);
1762 * Call vb2_qbuf and give buffer to the driver.
1764 memset(&fileio
->b
, 0, sizeof(fileio
->b
));
1765 fileio
->b
.type
= q
->type
;
1766 fileio
->b
.memory
= q
->memory
;
1767 fileio
->b
.index
= index
;
1768 fileio
->b
.bytesused
= buf
->pos
;
1769 ret
= vb2_qbuf(q
, &fileio
->b
);
1770 dprintk(5, "file io: vb2_dbuf result: %d\n", ret
);
1775 * Buffer has been queued, update the status
1779 buf
->size
= q
->bufs
[0]->v4l2_planes
[0].length
;
1780 fileio
->q_count
+= 1;
1783 * Switch to the next buffer
1785 fileio
->index
= (index
+ 1) % q
->num_buffers
;
1788 * Start streaming if required.
1790 if (!read
&& !q
->streaming
) {
1791 ret
= vb2_streamon(q
, q
->type
);
1798 * Return proper number of bytes processed.
1804 * Restore the fileio context and block vb2 ioctl interface.
1810 size_t vb2_read(struct vb2_queue
*q
, char __user
*data
, size_t count
,
1811 loff_t
*ppos
, int nonblocking
)
1813 return __vb2_perform_fileio(q
, data
, count
, ppos
, nonblocking
, 1);
1815 EXPORT_SYMBOL_GPL(vb2_read
);
1817 size_t vb2_write(struct vb2_queue
*q
, char __user
*data
, size_t count
,
1818 loff_t
*ppos
, int nonblocking
)
1820 return __vb2_perform_fileio(q
, data
, count
, ppos
, nonblocking
, 0);
1822 EXPORT_SYMBOL_GPL(vb2_write
);
1824 MODULE_DESCRIPTION("Driver helper framework for Video for Linux 2");
1825 MODULE_AUTHOR("Pawel Osciak <pawel@osciak.com>, Marek Szyprowski");
1826 MODULE_LICENSE("GPL");