2 * videobuf2-v4l2.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 * 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 #include <linux/err.h>
18 #include <linux/kernel.h>
19 #include <linux/module.h>
21 #include <linux/poll.h>
22 #include <linux/slab.h>
23 #include <linux/sched.h>
24 #include <linux/freezer.h>
25 #include <linux/kthread.h>
27 #include <media/v4l2-dev.h>
28 #include <media/v4l2-fh.h>
29 #include <media/v4l2-event.h>
30 #include <media/v4l2-common.h>
32 #include <media/videobuf2-v4l2.h>
35 module_param(debug, int, 0644);
37 #define dprintk(level, fmt, arg...) \
40 pr_info("vb2-v4l2: %s: " fmt, __func__, ## arg); \
43 /* Flags that are set by the vb2 core */
44 #define V4L2_BUFFER_MASK_FLAGS (V4L2_BUF_FLAG_MAPPED | V4L2_BUF_FLAG_QUEUED | \
45 V4L2_BUF_FLAG_DONE | V4L2_BUF_FLAG_ERROR | \
46 V4L2_BUF_FLAG_PREPARED | \
47 V4L2_BUF_FLAG_TIMESTAMP_MASK)
48 /* Output buffer flags that should be passed on to the driver */
49 #define V4L2_BUFFER_OUT_FLAGS (V4L2_BUF_FLAG_PFRAME | V4L2_BUF_FLAG_BFRAME | \
50 V4L2_BUF_FLAG_KEYFRAME | V4L2_BUF_FLAG_TIMECODE)
53 * __verify_planes_array() - verify that the planes array passed in struct
54 * v4l2_buffer from userspace can be safely used
56 static int __verify_planes_array(struct vb2_buffer *vb, const struct v4l2_buffer *b)
58 if (!V4L2_TYPE_IS_MULTIPLANAR(b->type))
61 /* Is memory for copying plane information present? */
62 if (b->m.planes == NULL) {
63 dprintk(1, "multi-planar buffer passed but planes array not provided\n");
67 if (b->length < vb->num_planes || b->length > VB2_MAX_PLANES) {
68 dprintk(1, "incorrect planes array length, expected %d, got %d\n",
69 vb->num_planes, b->length);
76 static int __verify_planes_array_core(struct vb2_buffer *vb, const void *pb)
78 return __verify_planes_array(vb, pb);
82 * __verify_length() - Verify that the bytesused value for each plane fits in
83 * the plane length and that the data offset doesn't exceed the bytesused value.
85 static int __verify_length(struct vb2_buffer *vb, const struct v4l2_buffer *b)
88 unsigned int bytesused;
91 if (!V4L2_TYPE_IS_OUTPUT(b->type))
94 if (V4L2_TYPE_IS_MULTIPLANAR(b->type)) {
95 for (plane = 0; plane < vb->num_planes; ++plane) {
96 length = (b->memory == VB2_MEMORY_USERPTR ||
97 b->memory == VB2_MEMORY_DMABUF)
98 ? b->m.planes[plane].length
99 : vb->planes[plane].length;
100 bytesused = b->m.planes[plane].bytesused
101 ? b->m.planes[plane].bytesused : length;
103 if (b->m.planes[plane].bytesused > length)
106 if (b->m.planes[plane].data_offset > 0 &&
107 b->m.planes[plane].data_offset >= bytesused)
111 length = (b->memory == VB2_MEMORY_USERPTR)
112 ? b->length : vb->planes[0].length;
114 if (b->bytesused > length)
121 static void __copy_timestamp(struct vb2_buffer *vb, const void *pb)
123 const struct v4l2_buffer *b = pb;
124 struct vb2_v4l2_buffer *vbuf = to_vb2_v4l2_buffer(vb);
125 struct vb2_queue *q = vb->vb2_queue;
129 * For output buffers copy the timestamp if needed,
130 * and the timecode field and flag if needed.
132 if (q->copy_timestamp)
133 vb->timestamp = timeval_to_ns(&b->timestamp);
134 vbuf->flags |= b->flags & V4L2_BUF_FLAG_TIMECODE;
135 if (b->flags & V4L2_BUF_FLAG_TIMECODE)
136 vbuf->timecode = b->timecode;
140 static void vb2_warn_zero_bytesused(struct vb2_buffer *vb)
142 static bool check_once;
149 pr_warn("use of bytesused == 0 is deprecated and will be removed in the future,\n");
150 if (vb->vb2_queue->allow_zero_bytesused)
151 pr_warn("use VIDIOC_DECODER_CMD(V4L2_DEC_CMD_STOP) instead.\n");
153 pr_warn("use the actual size instead.\n");
156 static int vb2_queue_or_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b,
159 if (b->type != q->type) {
160 dprintk(1, "%s: invalid buffer type\n", opname);
164 if (b->index >= q->num_buffers) {
165 dprintk(1, "%s: buffer index out of range\n", opname);
169 if (q->bufs[b->index] == NULL) {
170 /* Should never happen */
171 dprintk(1, "%s: buffer is NULL\n", opname);
175 if (b->memory != q->memory) {
176 dprintk(1, "%s: invalid memory type\n", opname);
180 return __verify_planes_array(q->bufs[b->index], b);
184 * __fill_v4l2_buffer() - fill in a struct v4l2_buffer with information to be
185 * returned to userspace
187 static void __fill_v4l2_buffer(struct vb2_buffer *vb, void *pb)
189 struct v4l2_buffer *b = pb;
190 struct vb2_v4l2_buffer *vbuf = to_vb2_v4l2_buffer(vb);
191 struct vb2_queue *q = vb->vb2_queue;
194 /* Copy back data such as timestamp, flags, etc. */
195 b->index = vb->index;
197 b->memory = vb->memory;
200 b->flags = vbuf->flags;
201 b->field = vbuf->field;
202 b->timestamp = ns_to_timeval(vb->timestamp);
203 b->timecode = vbuf->timecode;
204 b->sequence = vbuf->sequence;
208 if (q->is_multiplanar) {
210 * Fill in plane-related data if userspace provided an array
211 * for it. The caller has already verified memory and size.
213 b->length = vb->num_planes;
214 for (plane = 0; plane < vb->num_planes; ++plane) {
215 struct v4l2_plane *pdst = &b->m.planes[plane];
216 struct vb2_plane *psrc = &vb->planes[plane];
218 pdst->bytesused = psrc->bytesused;
219 pdst->length = psrc->length;
220 if (q->memory == VB2_MEMORY_MMAP)
221 pdst->m.mem_offset = psrc->m.offset;
222 else if (q->memory == VB2_MEMORY_USERPTR)
223 pdst->m.userptr = psrc->m.userptr;
224 else if (q->memory == VB2_MEMORY_DMABUF)
225 pdst->m.fd = psrc->m.fd;
226 pdst->data_offset = psrc->data_offset;
227 memset(pdst->reserved, 0, sizeof(pdst->reserved));
231 * We use length and offset in v4l2_planes array even for
232 * single-planar buffers, but userspace does not.
234 b->length = vb->planes[0].length;
235 b->bytesused = vb->planes[0].bytesused;
236 if (q->memory == VB2_MEMORY_MMAP)
237 b->m.offset = vb->planes[0].m.offset;
238 else if (q->memory == VB2_MEMORY_USERPTR)
239 b->m.userptr = vb->planes[0].m.userptr;
240 else if (q->memory == VB2_MEMORY_DMABUF)
241 b->m.fd = vb->planes[0].m.fd;
245 * Clear any buffer state related flags.
247 b->flags &= ~V4L2_BUFFER_MASK_FLAGS;
248 b->flags |= q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK;
249 if (!q->copy_timestamp) {
251 * For non-COPY timestamps, drop timestamp source bits
252 * and obtain the timestamp source from the queue.
254 b->flags &= ~V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
255 b->flags |= q->timestamp_flags & V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
259 case VB2_BUF_STATE_QUEUED:
260 case VB2_BUF_STATE_ACTIVE:
261 b->flags |= V4L2_BUF_FLAG_QUEUED;
263 case VB2_BUF_STATE_ERROR:
264 b->flags |= V4L2_BUF_FLAG_ERROR;
266 case VB2_BUF_STATE_DONE:
267 b->flags |= V4L2_BUF_FLAG_DONE;
269 case VB2_BUF_STATE_PREPARED:
270 b->flags |= V4L2_BUF_FLAG_PREPARED;
272 case VB2_BUF_STATE_PREPARING:
273 case VB2_BUF_STATE_DEQUEUED:
274 case VB2_BUF_STATE_REQUEUEING:
279 if (vb2_buffer_in_use(q, vb))
280 b->flags |= V4L2_BUF_FLAG_MAPPED;
283 b->flags & V4L2_BUF_FLAG_DONE &&
284 b->flags & V4L2_BUF_FLAG_LAST)
285 q->last_buffer_dequeued = true;
289 * __fill_vb2_buffer() - fill a vb2_buffer with information provided in a
290 * v4l2_buffer by the userspace. It also verifies that struct
291 * v4l2_buffer has a valid number of planes.
293 static int __fill_vb2_buffer(struct vb2_buffer *vb,
294 const void *pb, struct vb2_plane *planes)
296 struct vb2_queue *q = vb->vb2_queue;
297 const struct v4l2_buffer *b = pb;
298 struct vb2_v4l2_buffer *vbuf = to_vb2_v4l2_buffer(vb);
302 ret = __verify_length(vb, b);
304 dprintk(1, "plane parameters verification failed: %d\n", ret);
307 if (b->field == V4L2_FIELD_ALTERNATE && q->is_output) {
309 * If the format's field is ALTERNATE, then the buffer's field
310 * should be either TOP or BOTTOM, not ALTERNATE since that
311 * makes no sense. The driver has to know whether the
312 * buffer represents a top or a bottom field in order to
313 * program any DMA correctly. Using ALTERNATE is wrong, since
314 * that just says that it is either a top or a bottom field,
315 * but not which of the two it is.
317 dprintk(1, "the field is incorrectly set to ALTERNATE for an output buffer\n");
323 if (V4L2_TYPE_IS_MULTIPLANAR(b->type)) {
324 if (b->memory == VB2_MEMORY_USERPTR) {
325 for (plane = 0; plane < vb->num_planes; ++plane) {
326 planes[plane].m.userptr =
327 b->m.planes[plane].m.userptr;
328 planes[plane].length =
329 b->m.planes[plane].length;
332 if (b->memory == VB2_MEMORY_DMABUF) {
333 for (plane = 0; plane < vb->num_planes; ++plane) {
335 b->m.planes[plane].m.fd;
336 planes[plane].length =
337 b->m.planes[plane].length;
341 /* Fill in driver-provided information for OUTPUT types */
342 if (V4L2_TYPE_IS_OUTPUT(b->type)) {
344 * Will have to go up to b->length when API starts
345 * accepting variable number of planes.
347 * If bytesused == 0 for the output buffer, then fall
348 * back to the full buffer size. In that case
349 * userspace clearly never bothered to set it and
350 * it's a safe assumption that they really meant to
351 * use the full plane sizes.
353 * Some drivers, e.g. old codec drivers, use bytesused == 0
354 * as a way to indicate that streaming is finished.
355 * In that case, the driver should use the
356 * allow_zero_bytesused flag to keep old userspace
357 * applications working.
359 for (plane = 0; plane < vb->num_planes; ++plane) {
360 struct vb2_plane *pdst = &planes[plane];
361 struct v4l2_plane *psrc = &b->m.planes[plane];
363 if (psrc->bytesused == 0)
364 vb2_warn_zero_bytesused(vb);
366 if (vb->vb2_queue->allow_zero_bytesused)
367 pdst->bytesused = psrc->bytesused;
369 pdst->bytesused = psrc->bytesused ?
370 psrc->bytesused : pdst->length;
371 pdst->data_offset = psrc->data_offset;
376 * Single-planar buffers do not use planes array,
377 * so fill in relevant v4l2_buffer struct fields instead.
378 * In videobuf we use our internal V4l2_planes struct for
379 * single-planar buffers as well, for simplicity.
381 * If bytesused == 0 for the output buffer, then fall back
382 * to the full buffer size as that's a sensible default.
384 * Some drivers, e.g. old codec drivers, use bytesused == 0 as
385 * a way to indicate that streaming is finished. In that case,
386 * the driver should use the allow_zero_bytesused flag to keep
387 * old userspace applications working.
389 if (b->memory == VB2_MEMORY_USERPTR) {
390 planes[0].m.userptr = b->m.userptr;
391 planes[0].length = b->length;
394 if (b->memory == VB2_MEMORY_DMABUF) {
395 planes[0].m.fd = b->m.fd;
396 planes[0].length = b->length;
399 if (V4L2_TYPE_IS_OUTPUT(b->type)) {
400 if (b->bytesused == 0)
401 vb2_warn_zero_bytesused(vb);
403 if (vb->vb2_queue->allow_zero_bytesused)
404 planes[0].bytesused = b->bytesused;
406 planes[0].bytesused = b->bytesused ?
407 b->bytesused : planes[0].length;
409 planes[0].bytesused = 0;
413 /* Zero flags that the vb2 core handles */
414 vbuf->flags = b->flags & ~V4L2_BUFFER_MASK_FLAGS;
415 if (!vb->vb2_queue->copy_timestamp || !V4L2_TYPE_IS_OUTPUT(b->type)) {
417 * Non-COPY timestamps and non-OUTPUT queues will get
418 * their timestamp and timestamp source flags from the
421 vbuf->flags &= ~V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
424 if (V4L2_TYPE_IS_OUTPUT(b->type)) {
426 * For output buffers mask out the timecode flag:
427 * this will be handled later in vb2_qbuf().
428 * The 'field' is valid metadata for this output buffer
429 * and so that needs to be copied here.
431 vbuf->flags &= ~V4L2_BUF_FLAG_TIMECODE;
432 vbuf->field = b->field;
434 /* Zero any output buffer flags as this is a capture buffer */
435 vbuf->flags &= ~V4L2_BUFFER_OUT_FLAGS;
441 static const struct vb2_buf_ops v4l2_buf_ops = {
442 .verify_planes_array = __verify_planes_array_core,
443 .fill_user_buffer = __fill_v4l2_buffer,
444 .fill_vb2_buffer = __fill_vb2_buffer,
445 .copy_timestamp = __copy_timestamp,
449 * vb2_querybuf() - query video buffer information
451 * @b: buffer struct passed from userspace to vidioc_querybuf handler
454 * Should be called from vidioc_querybuf ioctl handler in driver.
455 * This function will verify the passed v4l2_buffer structure and fill the
456 * relevant information for the userspace.
458 * The return values from this function are intended to be directly returned
459 * from vidioc_querybuf handler in driver.
461 int vb2_querybuf(struct vb2_queue *q, struct v4l2_buffer *b)
463 struct vb2_buffer *vb;
466 if (b->type != q->type) {
467 dprintk(1, "wrong buffer type\n");
471 if (b->index >= q->num_buffers) {
472 dprintk(1, "buffer index out of range\n");
475 vb = q->bufs[b->index];
476 ret = __verify_planes_array(vb, b);
478 vb2_core_querybuf(q, b->index, b);
481 EXPORT_SYMBOL(vb2_querybuf);
483 int vb2_reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req)
485 int ret = vb2_verify_memory_type(q, req->memory, req->type);
487 return ret ? ret : vb2_core_reqbufs(q, req->memory, &req->count);
489 EXPORT_SYMBOL_GPL(vb2_reqbufs);
491 int vb2_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b)
495 if (vb2_fileio_is_active(q)) {
496 dprintk(1, "file io in progress\n");
500 ret = vb2_queue_or_prepare_buf(q, b, "prepare_buf");
502 return ret ? ret : vb2_core_prepare_buf(q, b->index, b);
504 EXPORT_SYMBOL_GPL(vb2_prepare_buf);
506 int vb2_create_bufs(struct vb2_queue *q, struct v4l2_create_buffers *create)
508 unsigned requested_planes = 1;
509 unsigned requested_sizes[VIDEO_MAX_PLANES];
510 struct v4l2_format *f = &create->format;
511 int ret = vb2_verify_memory_type(q, create->memory, f->type);
514 create->index = q->num_buffers;
515 if (create->count == 0)
516 return ret != -EBUSY ? ret : 0;
519 case V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE:
520 case V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE:
521 requested_planes = f->fmt.pix_mp.num_planes;
522 if (requested_planes == 0 ||
523 requested_planes > VIDEO_MAX_PLANES)
525 for (i = 0; i < requested_planes; i++)
527 f->fmt.pix_mp.plane_fmt[i].sizeimage;
529 case V4L2_BUF_TYPE_VIDEO_CAPTURE:
530 case V4L2_BUF_TYPE_VIDEO_OUTPUT:
531 requested_sizes[0] = f->fmt.pix.sizeimage;
533 case V4L2_BUF_TYPE_VBI_CAPTURE:
534 case V4L2_BUF_TYPE_VBI_OUTPUT:
535 requested_sizes[0] = f->fmt.vbi.samples_per_line *
536 (f->fmt.vbi.count[0] + f->fmt.vbi.count[1]);
538 case V4L2_BUF_TYPE_SLICED_VBI_CAPTURE:
539 case V4L2_BUF_TYPE_SLICED_VBI_OUTPUT:
540 requested_sizes[0] = f->fmt.sliced.io_size;
542 case V4L2_BUF_TYPE_SDR_CAPTURE:
543 case V4L2_BUF_TYPE_SDR_OUTPUT:
544 requested_sizes[0] = f->fmt.sdr.buffersize;
546 case V4L2_BUF_TYPE_META_CAPTURE:
547 requested_sizes[0] = f->fmt.meta.buffersize;
552 for (i = 0; i < requested_planes; i++)
553 if (requested_sizes[i] == 0)
555 return ret ? ret : vb2_core_create_bufs(q, create->memory,
556 &create->count, requested_planes, requested_sizes);
558 EXPORT_SYMBOL_GPL(vb2_create_bufs);
560 int vb2_qbuf(struct vb2_queue *q, struct v4l2_buffer *b)
564 if (vb2_fileio_is_active(q)) {
565 dprintk(1, "file io in progress\n");
569 ret = vb2_queue_or_prepare_buf(q, b, "qbuf");
570 return ret ? ret : vb2_core_qbuf(q, b->index, b);
572 EXPORT_SYMBOL_GPL(vb2_qbuf);
574 int vb2_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking)
578 if (vb2_fileio_is_active(q)) {
579 dprintk(1, "file io in progress\n");
583 if (b->type != q->type) {
584 dprintk(1, "invalid buffer type\n");
588 ret = vb2_core_dqbuf(q, NULL, b, nonblocking);
591 * After calling the VIDIOC_DQBUF V4L2_BUF_FLAG_DONE must be
594 b->flags &= ~V4L2_BUF_FLAG_DONE;
598 EXPORT_SYMBOL_GPL(vb2_dqbuf);
600 int vb2_streamon(struct vb2_queue *q, enum v4l2_buf_type type)
602 if (vb2_fileio_is_active(q)) {
603 dprintk(1, "file io in progress\n");
606 return vb2_core_streamon(q, type);
608 EXPORT_SYMBOL_GPL(vb2_streamon);
610 int vb2_streamoff(struct vb2_queue *q, enum v4l2_buf_type type)
612 if (vb2_fileio_is_active(q)) {
613 dprintk(1, "file io in progress\n");
616 return vb2_core_streamoff(q, type);
618 EXPORT_SYMBOL_GPL(vb2_streamoff);
620 int vb2_expbuf(struct vb2_queue *q, struct v4l2_exportbuffer *eb)
622 return vb2_core_expbuf(q, &eb->fd, eb->type, eb->index,
623 eb->plane, eb->flags);
625 EXPORT_SYMBOL_GPL(vb2_expbuf);
627 int vb2_queue_init(struct vb2_queue *q)
633 WARN_ON(q->timestamp_flags &
634 ~(V4L2_BUF_FLAG_TIMESTAMP_MASK |
635 V4L2_BUF_FLAG_TSTAMP_SRC_MASK)))
638 /* Warn that the driver should choose an appropriate timestamp type */
639 WARN_ON((q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
640 V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN);
642 /* Warn that vb2_memory should match with v4l2_memory */
643 if (WARN_ON(VB2_MEMORY_MMAP != (int)V4L2_MEMORY_MMAP)
644 || WARN_ON(VB2_MEMORY_USERPTR != (int)V4L2_MEMORY_USERPTR)
645 || WARN_ON(VB2_MEMORY_DMABUF != (int)V4L2_MEMORY_DMABUF))
648 if (q->buf_struct_size == 0)
649 q->buf_struct_size = sizeof(struct vb2_v4l2_buffer);
651 q->buf_ops = &v4l2_buf_ops;
652 q->is_multiplanar = V4L2_TYPE_IS_MULTIPLANAR(q->type);
653 q->is_output = V4L2_TYPE_IS_OUTPUT(q->type);
654 q->copy_timestamp = (q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK)
655 == V4L2_BUF_FLAG_TIMESTAMP_COPY;
657 * For compatibility with vb1: if QBUF hasn't been called yet, then
658 * return POLLERR as well. This only affects capture queues, output
659 * queues will always initialize waiting_for_buffers to false.
661 q->quirk_poll_must_check_waiting_for_buffers = true;
663 return vb2_core_queue_init(q);
665 EXPORT_SYMBOL_GPL(vb2_queue_init);
667 void vb2_queue_release(struct vb2_queue *q)
669 vb2_core_queue_release(q);
671 EXPORT_SYMBOL_GPL(vb2_queue_release);
673 unsigned int vb2_poll(struct vb2_queue *q, struct file *file, poll_table *wait)
675 struct video_device *vfd = video_devdata(file);
676 unsigned long req_events = poll_requested_events(wait);
677 unsigned int res = 0;
679 if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags)) {
680 struct v4l2_fh *fh = file->private_data;
682 if (v4l2_event_pending(fh))
684 else if (req_events & POLLPRI)
685 poll_wait(file, &fh->wait, wait);
688 return res | vb2_core_poll(q, file, wait);
690 EXPORT_SYMBOL_GPL(vb2_poll);
693 * The following functions are not part of the vb2 core API, but are helper
694 * functions that plug into struct v4l2_ioctl_ops, struct v4l2_file_operations
695 * and struct vb2_ops.
696 * They contain boilerplate code that most if not all drivers have to do
697 * and so they simplify the driver code.
700 /* The queue is busy if there is a owner and you are not that owner. */
701 static inline bool vb2_queue_is_busy(struct video_device *vdev, struct file *file)
703 return vdev->queue->owner && vdev->queue->owner != file->private_data;
706 /* vb2 ioctl helpers */
708 int vb2_ioctl_reqbufs(struct file *file, void *priv,
709 struct v4l2_requestbuffers *p)
711 struct video_device *vdev = video_devdata(file);
712 int res = vb2_verify_memory_type(vdev->queue, p->memory, p->type);
716 if (vb2_queue_is_busy(vdev, file))
718 res = vb2_core_reqbufs(vdev->queue, p->memory, &p->count);
719 /* If count == 0, then the owner has released all buffers and he
720 is no longer owner of the queue. Otherwise we have a new owner. */
722 vdev->queue->owner = p->count ? file->private_data : NULL;
725 EXPORT_SYMBOL_GPL(vb2_ioctl_reqbufs);
727 int vb2_ioctl_create_bufs(struct file *file, void *priv,
728 struct v4l2_create_buffers *p)
730 struct video_device *vdev = video_devdata(file);
731 int res = vb2_verify_memory_type(vdev->queue, p->memory,
734 p->index = vdev->queue->num_buffers;
736 * If count == 0, then just check if memory and type are valid.
737 * Any -EBUSY result from vb2_verify_memory_type can be mapped to 0.
740 return res != -EBUSY ? res : 0;
743 if (vb2_queue_is_busy(vdev, file))
746 res = vb2_create_bufs(vdev->queue, p);
748 vdev->queue->owner = file->private_data;
751 EXPORT_SYMBOL_GPL(vb2_ioctl_create_bufs);
753 int vb2_ioctl_prepare_buf(struct file *file, void *priv,
754 struct v4l2_buffer *p)
756 struct video_device *vdev = video_devdata(file);
758 if (vb2_queue_is_busy(vdev, file))
760 return vb2_prepare_buf(vdev->queue, p);
762 EXPORT_SYMBOL_GPL(vb2_ioctl_prepare_buf);
764 int vb2_ioctl_querybuf(struct file *file, void *priv, struct v4l2_buffer *p)
766 struct video_device *vdev = video_devdata(file);
768 /* No need to call vb2_queue_is_busy(), anyone can query buffers. */
769 return vb2_querybuf(vdev->queue, p);
771 EXPORT_SYMBOL_GPL(vb2_ioctl_querybuf);
773 int vb2_ioctl_qbuf(struct file *file, void *priv, struct v4l2_buffer *p)
775 struct video_device *vdev = video_devdata(file);
777 if (vb2_queue_is_busy(vdev, file))
779 return vb2_qbuf(vdev->queue, p);
781 EXPORT_SYMBOL_GPL(vb2_ioctl_qbuf);
783 int vb2_ioctl_dqbuf(struct file *file, void *priv, struct v4l2_buffer *p)
785 struct video_device *vdev = video_devdata(file);
787 if (vb2_queue_is_busy(vdev, file))
789 return vb2_dqbuf(vdev->queue, p, file->f_flags & O_NONBLOCK);
791 EXPORT_SYMBOL_GPL(vb2_ioctl_dqbuf);
793 int vb2_ioctl_streamon(struct file *file, void *priv, enum v4l2_buf_type i)
795 struct video_device *vdev = video_devdata(file);
797 if (vb2_queue_is_busy(vdev, file))
799 return vb2_streamon(vdev->queue, i);
801 EXPORT_SYMBOL_GPL(vb2_ioctl_streamon);
803 int vb2_ioctl_streamoff(struct file *file, void *priv, enum v4l2_buf_type i)
805 struct video_device *vdev = video_devdata(file);
807 if (vb2_queue_is_busy(vdev, file))
809 return vb2_streamoff(vdev->queue, i);
811 EXPORT_SYMBOL_GPL(vb2_ioctl_streamoff);
813 int vb2_ioctl_expbuf(struct file *file, void *priv, struct v4l2_exportbuffer *p)
815 struct video_device *vdev = video_devdata(file);
817 if (vb2_queue_is_busy(vdev, file))
819 return vb2_expbuf(vdev->queue, p);
821 EXPORT_SYMBOL_GPL(vb2_ioctl_expbuf);
823 /* v4l2_file_operations helpers */
825 int vb2_fop_mmap(struct file *file, struct vm_area_struct *vma)
827 struct video_device *vdev = video_devdata(file);
829 return vb2_mmap(vdev->queue, vma);
831 EXPORT_SYMBOL_GPL(vb2_fop_mmap);
833 int _vb2_fop_release(struct file *file, struct mutex *lock)
835 struct video_device *vdev = video_devdata(file);
839 if (file->private_data == vdev->queue->owner) {
840 vb2_queue_release(vdev->queue);
841 vdev->queue->owner = NULL;
845 return v4l2_fh_release(file);
847 EXPORT_SYMBOL_GPL(_vb2_fop_release);
849 int vb2_fop_release(struct file *file)
851 struct video_device *vdev = video_devdata(file);
852 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
854 return _vb2_fop_release(file, lock);
856 EXPORT_SYMBOL_GPL(vb2_fop_release);
858 ssize_t vb2_fop_write(struct file *file, const char __user *buf,
859 size_t count, loff_t *ppos)
861 struct video_device *vdev = video_devdata(file);
862 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
865 if (!(vdev->queue->io_modes & VB2_WRITE))
867 if (lock && mutex_lock_interruptible(lock))
869 if (vb2_queue_is_busy(vdev, file))
871 err = vb2_write(vdev->queue, buf, count, ppos,
872 file->f_flags & O_NONBLOCK);
873 if (vdev->queue->fileio)
874 vdev->queue->owner = file->private_data;
880 EXPORT_SYMBOL_GPL(vb2_fop_write);
882 ssize_t vb2_fop_read(struct file *file, char __user *buf,
883 size_t count, loff_t *ppos)
885 struct video_device *vdev = video_devdata(file);
886 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
889 if (!(vdev->queue->io_modes & VB2_READ))
891 if (lock && mutex_lock_interruptible(lock))
893 if (vb2_queue_is_busy(vdev, file))
895 err = vb2_read(vdev->queue, buf, count, ppos,
896 file->f_flags & O_NONBLOCK);
897 if (vdev->queue->fileio)
898 vdev->queue->owner = file->private_data;
904 EXPORT_SYMBOL_GPL(vb2_fop_read);
906 unsigned int vb2_fop_poll(struct file *file, poll_table *wait)
908 struct video_device *vdev = video_devdata(file);
909 struct vb2_queue *q = vdev->queue;
910 struct mutex *lock = q->lock ? q->lock : vdev->lock;
915 * If this helper doesn't know how to lock, then you shouldn't be using
916 * it but you should write your own.
920 if (lock && mutex_lock_interruptible(lock))
925 res = vb2_poll(vdev->queue, file, wait);
927 /* If fileio was started, then we have a new queue owner. */
928 if (!fileio && q->fileio)
929 q->owner = file->private_data;
934 EXPORT_SYMBOL_GPL(vb2_fop_poll);
937 unsigned long vb2_fop_get_unmapped_area(struct file *file, unsigned long addr,
938 unsigned long len, unsigned long pgoff, unsigned long flags)
940 struct video_device *vdev = video_devdata(file);
942 return vb2_get_unmapped_area(vdev->queue, addr, len, pgoff, flags);
944 EXPORT_SYMBOL_GPL(vb2_fop_get_unmapped_area);
947 /* vb2_ops helpers. Only use if vq->lock is non-NULL. */
949 void vb2_ops_wait_prepare(struct vb2_queue *vq)
951 mutex_unlock(vq->lock);
953 EXPORT_SYMBOL_GPL(vb2_ops_wait_prepare);
955 void vb2_ops_wait_finish(struct vb2_queue *vq)
957 mutex_lock(vq->lock);
959 EXPORT_SYMBOL_GPL(vb2_ops_wait_finish);
961 MODULE_DESCRIPTION("Driver helper framework for Video for Linux 2");
962 MODULE_AUTHOR("Pawel Osciak <pawel@osciak.com>, Marek Szyprowski");
963 MODULE_LICENSE("GPL");