blob: 58b97023ae6f24fc3db0f97dbfc77e750aef939f [file] [log] [blame]
Pawel Osciake23ccc02010-10-11 10:56:41 -03001/*
2 * videobuf2-core.c - V4L2 driver helper framework
3 *
4 * Copyright (C) 2010 Samsung Electronics
5 *
Pawel Osciak95072082011-03-13 15:23:32 -03006 * Author: Pawel Osciak <pawel@osciak.com>
Pawel Osciake23ccc02010-10-11 10:56:41 -03007 * Marek Szyprowski <m.szyprowski@samsung.com>
8 *
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.
12 */
13
14#include <linux/err.h>
15#include <linux/kernel.h>
16#include <linux/module.h>
17#include <linux/mm.h>
18#include <linux/poll.h>
19#include <linux/slab.h>
20#include <linux/sched.h>
21
Hans Verkuil95213ce2011-07-13 04:26:52 -030022#include <media/v4l2-dev.h>
23#include <media/v4l2-fh.h>
24#include <media/v4l2-event.h>
Pawel Osciake23ccc02010-10-11 10:56:41 -030025#include <media/videobuf2-core.h>
26
27static int debug;
28module_param(debug, int, 0644);
29
Hans Verkuilfd4354c2014-04-07 09:08:47 -030030#define dprintk(level, fmt, arg...) \
31 do { \
32 if (debug >= level) \
33 pr_debug("vb2: %s: " fmt, __func__, ## arg); \
Pawel Osciake23ccc02010-10-11 10:56:41 -030034 } while (0)
35
Hans Verkuilb5b45412014-01-29 11:53:25 -030036#ifdef CONFIG_VIDEO_ADV_DEBUG
37
38/*
Hans Verkuila1d36d82014-03-17 09:54:21 -030039 * If advanced debugging is on, then count how often each op is called
40 * successfully, which can either be per-buffer or per-queue.
Hans Verkuilb5b45412014-01-29 11:53:25 -030041 *
Hans Verkuila1d36d82014-03-17 09:54:21 -030042 * This makes it easy to check that the 'init' and 'cleanup'
Hans Verkuilb5b45412014-01-29 11:53:25 -030043 * (and variations thereof) stay balanced.
44 */
45
Hans Verkuila1d36d82014-03-17 09:54:21 -030046#define log_memop(vb, op) \
47 dprintk(2, "call_memop(%p, %d, %s)%s\n", \
48 (vb)->vb2_queue, (vb)->v4l2_buf.index, #op, \
49 (vb)->vb2_queue->mem_ops->op ? "" : " (nop)")
50
Hans Verkuilb5b45412014-01-29 11:53:25 -030051#define call_memop(vb, op, args...) \
52({ \
53 struct vb2_queue *_q = (vb)->vb2_queue; \
Hans Verkuila1d36d82014-03-17 09:54:21 -030054 int err; \
55 \
56 log_memop(vb, op); \
57 err = _q->mem_ops->op ? _q->mem_ops->op(args) : 0; \
58 if (!err) \
59 (vb)->cnt_mem_ ## op++; \
60 err; \
Hans Verkuilb5b45412014-01-29 11:53:25 -030061})
Hans Verkuila1d36d82014-03-17 09:54:21 -030062
63#define call_ptr_memop(vb, op, args...) \
64({ \
65 struct vb2_queue *_q = (vb)->vb2_queue; \
66 void *ptr; \
67 \
68 log_memop(vb, op); \
69 ptr = _q->mem_ops->op ? _q->mem_ops->op(args) : NULL; \
70 if (!IS_ERR_OR_NULL(ptr)) \
71 (vb)->cnt_mem_ ## op++; \
72 ptr; \
73})
74
75#define call_void_memop(vb, op, args...) \
76({ \
77 struct vb2_queue *_q = (vb)->vb2_queue; \
78 \
79 log_memop(vb, op); \
80 if (_q->mem_ops->op) \
81 _q->mem_ops->op(args); \
82 (vb)->cnt_mem_ ## op++; \
83})
84
85#define log_qop(q, op) \
86 dprintk(2, "call_qop(%p, %s)%s\n", q, #op, \
87 (q)->ops->op ? "" : " (nop)")
Pawel Osciake23ccc02010-10-11 10:56:41 -030088
89#define call_qop(q, op, args...) \
Hans Verkuilb5b45412014-01-29 11:53:25 -030090({ \
Hans Verkuila1d36d82014-03-17 09:54:21 -030091 int err; \
92 \
93 log_qop(q, op); \
94 err = (q)->ops->op ? (q)->ops->op(args) : 0; \
95 if (!err) \
96 (q)->cnt_ ## op++; \
97 err; \
Hans Verkuilb5b45412014-01-29 11:53:25 -030098})
Hans Verkuila1d36d82014-03-17 09:54:21 -030099
100#define call_void_qop(q, op, args...) \
101({ \
102 log_qop(q, op); \
103 if ((q)->ops->op) \
104 (q)->ops->op(args); \
105 (q)->cnt_ ## op++; \
106})
107
108#define log_vb_qop(vb, op, args...) \
109 dprintk(2, "call_vb_qop(%p, %d, %s)%s\n", \
110 (vb)->vb2_queue, (vb)->v4l2_buf.index, #op, \
111 (vb)->vb2_queue->ops->op ? "" : " (nop)")
Hans Verkuilb5b45412014-01-29 11:53:25 -0300112
113#define call_vb_qop(vb, op, args...) \
114({ \
Hans Verkuila1d36d82014-03-17 09:54:21 -0300115 int err; \
116 \
117 log_vb_qop(vb, op); \
118 err = (vb)->vb2_queue->ops->op ? \
119 (vb)->vb2_queue->ops->op(args) : 0; \
120 if (!err) \
121 (vb)->cnt_ ## op++; \
122 err; \
Hans Verkuilb5b45412014-01-29 11:53:25 -0300123})
Hans Verkuila1d36d82014-03-17 09:54:21 -0300124
125#define call_void_vb_qop(vb, op, args...) \
126({ \
127 log_vb_qop(vb, op); \
128 if ((vb)->vb2_queue->ops->op) \
129 (vb)->vb2_queue->ops->op(args); \
130 (vb)->cnt_ ## op++; \
131})
Hans Verkuilb5b45412014-01-29 11:53:25 -0300132
133#else
134
135#define call_memop(vb, op, args...) \
Hans Verkuila1d36d82014-03-17 09:54:21 -0300136 ((vb)->vb2_queue->mem_ops->op ? \
137 (vb)->vb2_queue->mem_ops->op(args) : 0)
138
139#define call_ptr_memop(vb, op, args...) \
140 ((vb)->vb2_queue->mem_ops->op ? \
141 (vb)->vb2_queue->mem_ops->op(args) : NULL)
142
143#define call_void_memop(vb, op, args...) \
144 do { \
145 if ((vb)->vb2_queue->mem_ops->op) \
146 (vb)->vb2_queue->mem_ops->op(args); \
147 } while (0)
Hans Verkuilb5b45412014-01-29 11:53:25 -0300148
149#define call_qop(q, op, args...) \
150 ((q)->ops->op ? (q)->ops->op(args) : 0)
Hans Verkuila1d36d82014-03-17 09:54:21 -0300151
152#define call_void_qop(q, op, args...) \
153 do { \
154 if ((q)->ops->op) \
155 (q)->ops->op(args); \
156 } while (0)
Hans Verkuilb5b45412014-01-29 11:53:25 -0300157
158#define call_vb_qop(vb, op, args...) \
159 ((vb)->vb2_queue->ops->op ? (vb)->vb2_queue->ops->op(args) : 0)
Hans Verkuila1d36d82014-03-17 09:54:21 -0300160
161#define call_void_vb_qop(vb, op, args...) \
162 do { \
163 if ((vb)->vb2_queue->ops->op) \
164 (vb)->vb2_queue->ops->op(args); \
165 } while (0)
Hans Verkuilb5b45412014-01-29 11:53:25 -0300166
167#endif
Pawel Osciake23ccc02010-10-11 10:56:41 -0300168
Hans Verkuilf1343282014-02-24 14:44:50 -0300169/* Flags that are set by the vb2 core */
Sakari Ailus1b18e7a2012-10-22 17:10:16 -0300170#define V4L2_BUFFER_MASK_FLAGS (V4L2_BUF_FLAG_MAPPED | V4L2_BUF_FLAG_QUEUED | \
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300171 V4L2_BUF_FLAG_DONE | V4L2_BUF_FLAG_ERROR | \
Sakari Ailus1b18e7a2012-10-22 17:10:16 -0300172 V4L2_BUF_FLAG_PREPARED | \
173 V4L2_BUF_FLAG_TIMESTAMP_MASK)
Hans Verkuilf1343282014-02-24 14:44:50 -0300174/* Output buffer flags that should be passed on to the driver */
175#define V4L2_BUFFER_OUT_FLAGS (V4L2_BUF_FLAG_PFRAME | V4L2_BUF_FLAG_BFRAME | \
176 V4L2_BUF_FLAG_KEYFRAME | V4L2_BUF_FLAG_TIMECODE)
Marek Szyprowskiea42c8e2011-04-12 10:14:13 -0300177
Hans Verkuilfb64dca2014-02-28 12:49:18 -0300178static void __vb2_queue_cancel(struct vb2_queue *q);
179
Pawel Osciake23ccc02010-10-11 10:56:41 -0300180/**
181 * __vb2_buf_mem_alloc() - allocate video memory for the given buffer
182 */
Marek Szyprowskic1426bc2011-08-24 06:36:26 -0300183static int __vb2_buf_mem_alloc(struct vb2_buffer *vb)
Pawel Osciake23ccc02010-10-11 10:56:41 -0300184{
185 struct vb2_queue *q = vb->vb2_queue;
186 void *mem_priv;
187 int plane;
188
Mauro Carvalho Chehab7f841452013-04-19 07:18:01 -0300189 /*
190 * Allocate memory for all planes in this buffer
191 * NOTE: mmapped areas should be page aligned
192 */
Pawel Osciake23ccc02010-10-11 10:56:41 -0300193 for (plane = 0; plane < vb->num_planes; ++plane) {
Mauro Carvalho Chehab7f841452013-04-19 07:18:01 -0300194 unsigned long size = PAGE_ALIGN(q->plane_sizes[plane]);
195
Hans Verkuila1d36d82014-03-17 09:54:21 -0300196 mem_priv = call_ptr_memop(vb, alloc, q->alloc_ctx[plane],
Mauro Carvalho Chehab7f841452013-04-19 07:18:01 -0300197 size, q->gfp_flags);
Guennadi Liakhovetski62a79432011-03-22 09:24:58 -0300198 if (IS_ERR_OR_NULL(mem_priv))
Pawel Osciake23ccc02010-10-11 10:56:41 -0300199 goto free;
200
201 /* Associate allocator private data with this plane */
202 vb->planes[plane].mem_priv = mem_priv;
Marek Szyprowskic1426bc2011-08-24 06:36:26 -0300203 vb->v4l2_planes[plane].length = q->plane_sizes[plane];
Pawel Osciake23ccc02010-10-11 10:56:41 -0300204 }
205
206 return 0;
207free:
208 /* Free already allocated memory if one of the allocations failed */
Marek Szyprowskia00d0262011-12-15 05:53:06 -0300209 for (; plane > 0; --plane) {
Hans Verkuila1d36d82014-03-17 09:54:21 -0300210 call_void_memop(vb, put, vb->planes[plane - 1].mem_priv);
Marek Szyprowskia00d0262011-12-15 05:53:06 -0300211 vb->planes[plane - 1].mem_priv = NULL;
212 }
Pawel Osciake23ccc02010-10-11 10:56:41 -0300213
214 return -ENOMEM;
215}
216
217/**
218 * __vb2_buf_mem_free() - free memory of the given buffer
219 */
220static void __vb2_buf_mem_free(struct vb2_buffer *vb)
221{
Pawel Osciake23ccc02010-10-11 10:56:41 -0300222 unsigned int plane;
223
224 for (plane = 0; plane < vb->num_planes; ++plane) {
Hans Verkuila1d36d82014-03-17 09:54:21 -0300225 call_void_memop(vb, put, vb->planes[plane].mem_priv);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300226 vb->planes[plane].mem_priv = NULL;
Marek Szyprowskia00d0262011-12-15 05:53:06 -0300227 dprintk(3, "Freed plane %d of buffer %d\n", plane,
228 vb->v4l2_buf.index);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300229 }
230}
231
232/**
233 * __vb2_buf_userptr_put() - release userspace memory associated with
234 * a USERPTR buffer
235 */
236static void __vb2_buf_userptr_put(struct vb2_buffer *vb)
237{
Pawel Osciake23ccc02010-10-11 10:56:41 -0300238 unsigned int plane;
239
240 for (plane = 0; plane < vb->num_planes; ++plane) {
Marek Szyprowskia00d0262011-12-15 05:53:06 -0300241 if (vb->planes[plane].mem_priv)
Hans Verkuila1d36d82014-03-17 09:54:21 -0300242 call_void_memop(vb, put_userptr, vb->planes[plane].mem_priv);
Marek Szyprowskia00d0262011-12-15 05:53:06 -0300243 vb->planes[plane].mem_priv = NULL;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300244 }
245}
246
247/**
Sumit Semwalc5384042012-06-14 10:37:37 -0300248 * __vb2_plane_dmabuf_put() - release memory associated with
249 * a DMABUF shared plane
250 */
Hans Verkuilb5b45412014-01-29 11:53:25 -0300251static void __vb2_plane_dmabuf_put(struct vb2_buffer *vb, struct vb2_plane *p)
Sumit Semwalc5384042012-06-14 10:37:37 -0300252{
253 if (!p->mem_priv)
254 return;
255
256 if (p->dbuf_mapped)
Hans Verkuila1d36d82014-03-17 09:54:21 -0300257 call_void_memop(vb, unmap_dmabuf, p->mem_priv);
Sumit Semwalc5384042012-06-14 10:37:37 -0300258
Hans Verkuila1d36d82014-03-17 09:54:21 -0300259 call_void_memop(vb, detach_dmabuf, p->mem_priv);
Sumit Semwalc5384042012-06-14 10:37:37 -0300260 dma_buf_put(p->dbuf);
261 memset(p, 0, sizeof(*p));
262}
263
264/**
265 * __vb2_buf_dmabuf_put() - release memory associated with
266 * a DMABUF shared buffer
267 */
268static void __vb2_buf_dmabuf_put(struct vb2_buffer *vb)
269{
Sumit Semwalc5384042012-06-14 10:37:37 -0300270 unsigned int plane;
271
272 for (plane = 0; plane < vb->num_planes; ++plane)
Hans Verkuilb5b45412014-01-29 11:53:25 -0300273 __vb2_plane_dmabuf_put(vb, &vb->planes[plane]);
Sumit Semwalc5384042012-06-14 10:37:37 -0300274}
275
276/**
Hans Verkuila5e3d742013-12-04 15:14:05 +0100277 * __setup_lengths() - setup initial lengths for every plane in
278 * every buffer on the queue
279 */
280static void __setup_lengths(struct vb2_queue *q, unsigned int n)
281{
282 unsigned int buffer, plane;
283 struct vb2_buffer *vb;
284
285 for (buffer = q->num_buffers; buffer < q->num_buffers + n; ++buffer) {
286 vb = q->bufs[buffer];
287 if (!vb)
288 continue;
289
290 for (plane = 0; plane < vb->num_planes; ++plane)
291 vb->v4l2_planes[plane].length = q->plane_sizes[plane];
292 }
293}
294
295/**
Pawel Osciake23ccc02010-10-11 10:56:41 -0300296 * __setup_offsets() - setup unique offsets ("cookies") for every plane in
297 * every buffer on the queue
298 */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300299static void __setup_offsets(struct vb2_queue *q, unsigned int n)
Pawel Osciake23ccc02010-10-11 10:56:41 -0300300{
301 unsigned int buffer, plane;
302 struct vb2_buffer *vb;
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300303 unsigned long off;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300304
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300305 if (q->num_buffers) {
306 struct v4l2_plane *p;
307 vb = q->bufs[q->num_buffers - 1];
308 p = &vb->v4l2_planes[vb->num_planes - 1];
309 off = PAGE_ALIGN(p->m.mem_offset + p->length);
310 } else {
311 off = 0;
312 }
313
314 for (buffer = q->num_buffers; buffer < q->num_buffers + n; ++buffer) {
Pawel Osciake23ccc02010-10-11 10:56:41 -0300315 vb = q->bufs[buffer];
316 if (!vb)
317 continue;
318
319 for (plane = 0; plane < vb->num_planes; ++plane) {
320 vb->v4l2_planes[plane].m.mem_offset = off;
321
322 dprintk(3, "Buffer %d, plane %d offset 0x%08lx\n",
323 buffer, plane, off);
324
325 off += vb->v4l2_planes[plane].length;
326 off = PAGE_ALIGN(off);
327 }
328 }
329}
330
331/**
332 * __vb2_queue_alloc() - allocate videobuf buffer structures and (for MMAP type)
333 * video buffer memory for all buffers/planes on the queue and initializes the
334 * queue
335 *
336 * Returns the number of buffers successfully allocated.
337 */
338static int __vb2_queue_alloc(struct vb2_queue *q, enum v4l2_memory memory,
Marek Szyprowskic1426bc2011-08-24 06:36:26 -0300339 unsigned int num_buffers, unsigned int num_planes)
Pawel Osciake23ccc02010-10-11 10:56:41 -0300340{
341 unsigned int buffer;
342 struct vb2_buffer *vb;
343 int ret;
344
345 for (buffer = 0; buffer < num_buffers; ++buffer) {
346 /* Allocate videobuf buffer structures */
347 vb = kzalloc(q->buf_struct_size, GFP_KERNEL);
348 if (!vb) {
349 dprintk(1, "Memory alloc for buffer struct failed\n");
350 break;
351 }
352
353 /* Length stores number of planes for multiplanar buffers */
354 if (V4L2_TYPE_IS_MULTIPLANAR(q->type))
355 vb->v4l2_buf.length = num_planes;
356
357 vb->state = VB2_BUF_STATE_DEQUEUED;
358 vb->vb2_queue = q;
359 vb->num_planes = num_planes;
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300360 vb->v4l2_buf.index = q->num_buffers + buffer;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300361 vb->v4l2_buf.type = q->type;
362 vb->v4l2_buf.memory = memory;
363
364 /* Allocate video buffer memory for the MMAP type */
365 if (memory == V4L2_MEMORY_MMAP) {
Marek Szyprowskic1426bc2011-08-24 06:36:26 -0300366 ret = __vb2_buf_mem_alloc(vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300367 if (ret) {
368 dprintk(1, "Failed allocating memory for "
369 "buffer %d\n", buffer);
370 kfree(vb);
371 break;
372 }
373 /*
374 * Call the driver-provided buffer initialization
375 * callback, if given. An error in initialization
376 * results in queue setup failure.
377 */
Hans Verkuilb5b45412014-01-29 11:53:25 -0300378 ret = call_vb_qop(vb, buf_init, vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300379 if (ret) {
380 dprintk(1, "Buffer %d %p initialization"
381 " failed\n", buffer, vb);
382 __vb2_buf_mem_free(vb);
383 kfree(vb);
384 break;
385 }
386 }
387
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300388 q->bufs[q->num_buffers + buffer] = vb;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300389 }
390
Hans Verkuila5e3d742013-12-04 15:14:05 +0100391 __setup_lengths(q, buffer);
Philipp Zabeldc775232013-09-19 04:37:29 -0300392 if (memory == V4L2_MEMORY_MMAP)
393 __setup_offsets(q, buffer);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300394
395 dprintk(1, "Allocated %d buffers, %d plane(s) each\n",
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300396 buffer, num_planes);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300397
398 return buffer;
399}
400
401/**
402 * __vb2_free_mem() - release all video buffer memory for a given queue
403 */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300404static void __vb2_free_mem(struct vb2_queue *q, unsigned int buffers)
Pawel Osciake23ccc02010-10-11 10:56:41 -0300405{
406 unsigned int buffer;
407 struct vb2_buffer *vb;
408
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300409 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
410 ++buffer) {
Pawel Osciake23ccc02010-10-11 10:56:41 -0300411 vb = q->bufs[buffer];
412 if (!vb)
413 continue;
414
415 /* Free MMAP buffers or release USERPTR buffers */
416 if (q->memory == V4L2_MEMORY_MMAP)
417 __vb2_buf_mem_free(vb);
Sumit Semwalc5384042012-06-14 10:37:37 -0300418 else if (q->memory == V4L2_MEMORY_DMABUF)
419 __vb2_buf_dmabuf_put(vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300420 else
421 __vb2_buf_userptr_put(vb);
422 }
423}
424
425/**
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300426 * __vb2_queue_free() - free buffers at the end of the queue - video memory and
427 * related information, if no buffers are left return the queue to an
428 * uninitialized state. Might be called even if the queue has already been freed.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300429 */
Hans Verkuil63faabf2013-12-13 13:13:40 -0300430static int __vb2_queue_free(struct vb2_queue *q, unsigned int buffers)
Pawel Osciake23ccc02010-10-11 10:56:41 -0300431{
432 unsigned int buffer;
433
Hans Verkuil63faabf2013-12-13 13:13:40 -0300434 /*
435 * Sanity check: when preparing a buffer the queue lock is released for
436 * a short while (see __buf_prepare for the details), which would allow
437 * a race with a reqbufs which can call this function. Removing the
438 * buffers from underneath __buf_prepare is obviously a bad idea, so we
439 * check if any of the buffers is in the state PREPARING, and if so we
440 * just return -EAGAIN.
441 */
442 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
443 ++buffer) {
444 if (q->bufs[buffer] == NULL)
445 continue;
446 if (q->bufs[buffer]->state == VB2_BUF_STATE_PREPARING) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300447 dprintk(1, "preparing buffers, cannot free\n");
Hans Verkuil63faabf2013-12-13 13:13:40 -0300448 return -EAGAIN;
449 }
450 }
451
Pawel Osciake23ccc02010-10-11 10:56:41 -0300452 /* Call driver-provided cleanup function for each buffer, if provided */
Hans Verkuilb5b45412014-01-29 11:53:25 -0300453 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
454 ++buffer) {
Hans Verkuil256f3162014-01-29 13:36:53 -0300455 struct vb2_buffer *vb = q->bufs[buffer];
456
457 if (vb && vb->planes[0].mem_priv)
Hans Verkuila1d36d82014-03-17 09:54:21 -0300458 call_void_vb_qop(vb, buf_cleanup, vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300459 }
460
461 /* Release video buffer memory */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300462 __vb2_free_mem(q, buffers);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300463
Hans Verkuilb5b45412014-01-29 11:53:25 -0300464#ifdef CONFIG_VIDEO_ADV_DEBUG
465 /*
466 * Check that all the calls were balances during the life-time of this
467 * queue. If not (or if the debug level is 1 or up), then dump the
468 * counters to the kernel log.
469 */
470 if (q->num_buffers) {
471 bool unbalanced = q->cnt_start_streaming != q->cnt_stop_streaming ||
472 q->cnt_wait_prepare != q->cnt_wait_finish;
473
474 if (unbalanced || debug) {
475 pr_info("vb2: counters for queue %p:%s\n", q,
476 unbalanced ? " UNBALANCED!" : "");
477 pr_info("vb2: setup: %u start_streaming: %u stop_streaming: %u\n",
478 q->cnt_queue_setup, q->cnt_start_streaming,
479 q->cnt_stop_streaming);
480 pr_info("vb2: wait_prepare: %u wait_finish: %u\n",
481 q->cnt_wait_prepare, q->cnt_wait_finish);
482 }
483 q->cnt_queue_setup = 0;
484 q->cnt_wait_prepare = 0;
485 q->cnt_wait_finish = 0;
486 q->cnt_start_streaming = 0;
487 q->cnt_stop_streaming = 0;
488 }
489 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
490 struct vb2_buffer *vb = q->bufs[buffer];
491 bool unbalanced = vb->cnt_mem_alloc != vb->cnt_mem_put ||
492 vb->cnt_mem_prepare != vb->cnt_mem_finish ||
493 vb->cnt_mem_get_userptr != vb->cnt_mem_put_userptr ||
494 vb->cnt_mem_attach_dmabuf != vb->cnt_mem_detach_dmabuf ||
495 vb->cnt_mem_map_dmabuf != vb->cnt_mem_unmap_dmabuf ||
496 vb->cnt_buf_queue != vb->cnt_buf_done ||
497 vb->cnt_buf_prepare != vb->cnt_buf_finish ||
498 vb->cnt_buf_init != vb->cnt_buf_cleanup;
499
500 if (unbalanced || debug) {
501 pr_info("vb2: counters for queue %p, buffer %d:%s\n",
502 q, buffer, unbalanced ? " UNBALANCED!" : "");
503 pr_info("vb2: buf_init: %u buf_cleanup: %u buf_prepare: %u buf_finish: %u\n",
504 vb->cnt_buf_init, vb->cnt_buf_cleanup,
505 vb->cnt_buf_prepare, vb->cnt_buf_finish);
506 pr_info("vb2: buf_queue: %u buf_done: %u\n",
507 vb->cnt_buf_queue, vb->cnt_buf_done);
508 pr_info("vb2: alloc: %u put: %u prepare: %u finish: %u mmap: %u\n",
509 vb->cnt_mem_alloc, vb->cnt_mem_put,
510 vb->cnt_mem_prepare, vb->cnt_mem_finish,
511 vb->cnt_mem_mmap);
512 pr_info("vb2: get_userptr: %u put_userptr: %u\n",
513 vb->cnt_mem_get_userptr, vb->cnt_mem_put_userptr);
514 pr_info("vb2: attach_dmabuf: %u detach_dmabuf: %u map_dmabuf: %u unmap_dmabuf: %u\n",
515 vb->cnt_mem_attach_dmabuf, vb->cnt_mem_detach_dmabuf,
516 vb->cnt_mem_map_dmabuf, vb->cnt_mem_unmap_dmabuf);
517 pr_info("vb2: get_dmabuf: %u num_users: %u vaddr: %u cookie: %u\n",
518 vb->cnt_mem_get_dmabuf,
519 vb->cnt_mem_num_users,
520 vb->cnt_mem_vaddr,
521 vb->cnt_mem_cookie);
522 }
523 }
524#endif
525
Pawel Osciake23ccc02010-10-11 10:56:41 -0300526 /* Free videobuf buffers */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300527 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
528 ++buffer) {
Pawel Osciake23ccc02010-10-11 10:56:41 -0300529 kfree(q->bufs[buffer]);
530 q->bufs[buffer] = NULL;
531 }
532
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300533 q->num_buffers -= buffers;
Hans Verkuila7afcac2014-02-24 13:41:20 -0300534 if (!q->num_buffers) {
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300535 q->memory = 0;
Hans Verkuila7afcac2014-02-24 13:41:20 -0300536 INIT_LIST_HEAD(&q->queued_list);
537 }
Hans Verkuil63faabf2013-12-13 13:13:40 -0300538 return 0;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300539}
540
541/**
542 * __verify_planes_array() - verify that the planes array passed in struct
543 * v4l2_buffer from userspace can be safely used
544 */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300545static int __verify_planes_array(struct vb2_buffer *vb, const struct v4l2_buffer *b)
Pawel Osciake23ccc02010-10-11 10:56:41 -0300546{
Hans Verkuil32a77262012-09-28 06:12:53 -0300547 if (!V4L2_TYPE_IS_MULTIPLANAR(b->type))
548 return 0;
549
Pawel Osciake23ccc02010-10-11 10:56:41 -0300550 /* Is memory for copying plane information present? */
551 if (NULL == b->m.planes) {
552 dprintk(1, "Multi-planar buffer passed but "
553 "planes array not provided\n");
554 return -EINVAL;
555 }
556
557 if (b->length < vb->num_planes || b->length > VIDEO_MAX_PLANES) {
558 dprintk(1, "Incorrect planes array length, "
559 "expected %d, got %d\n", vb->num_planes, b->length);
560 return -EINVAL;
561 }
562
563 return 0;
564}
565
566/**
Laurent Pinchart8023ed02012-07-10 10:41:40 -0300567 * __verify_length() - Verify that the bytesused value for each plane fits in
568 * the plane length and that the data offset doesn't exceed the bytesused value.
569 */
570static int __verify_length(struct vb2_buffer *vb, const struct v4l2_buffer *b)
571{
572 unsigned int length;
573 unsigned int plane;
574
575 if (!V4L2_TYPE_IS_OUTPUT(b->type))
576 return 0;
577
578 if (V4L2_TYPE_IS_MULTIPLANAR(b->type)) {
579 for (plane = 0; plane < vb->num_planes; ++plane) {
580 length = (b->memory == V4L2_MEMORY_USERPTR)
581 ? b->m.planes[plane].length
582 : vb->v4l2_planes[plane].length;
583
584 if (b->m.planes[plane].bytesused > length)
585 return -EINVAL;
Sylwester Nawrocki3c5c23c2013-08-26 11:47:09 -0300586
587 if (b->m.planes[plane].data_offset > 0 &&
588 b->m.planes[plane].data_offset >=
Laurent Pinchart8023ed02012-07-10 10:41:40 -0300589 b->m.planes[plane].bytesused)
590 return -EINVAL;
591 }
592 } else {
593 length = (b->memory == V4L2_MEMORY_USERPTR)
594 ? b->length : vb->v4l2_planes[0].length;
595
596 if (b->bytesused > length)
597 return -EINVAL;
598 }
599
600 return 0;
601}
602
603/**
Marek Szyprowski25a27d92011-08-24 06:49:35 -0300604 * __buffer_in_use() - return true if the buffer is in use and
605 * the queue cannot be freed (by the means of REQBUFS(0)) call
606 */
607static bool __buffer_in_use(struct vb2_queue *q, struct vb2_buffer *vb)
608{
609 unsigned int plane;
610 for (plane = 0; plane < vb->num_planes; ++plane) {
Marek Szyprowski2c2dd6ac2011-10-12 13:09:53 -0300611 void *mem_priv = vb->planes[plane].mem_priv;
Marek Szyprowski25a27d92011-08-24 06:49:35 -0300612 /*
613 * If num_users() has not been provided, call_memop
614 * will return 0, apparently nobody cares about this
615 * case anyway. If num_users() returns more than 1,
616 * we are not the only user of the plane's memory.
617 */
Hans Verkuilb5b45412014-01-29 11:53:25 -0300618 if (mem_priv && call_memop(vb, num_users, mem_priv) > 1)
Marek Szyprowski25a27d92011-08-24 06:49:35 -0300619 return true;
620 }
621 return false;
622}
623
624/**
625 * __buffers_in_use() - return true if any buffers on the queue are in use and
626 * the queue cannot be freed (by the means of REQBUFS(0)) call
627 */
628static bool __buffers_in_use(struct vb2_queue *q)
629{
630 unsigned int buffer;
631 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
632 if (__buffer_in_use(q, q->bufs[buffer]))
633 return true;
634 }
635 return false;
636}
637
638/**
Pawel Osciake23ccc02010-10-11 10:56:41 -0300639 * __fill_v4l2_buffer() - fill in a struct v4l2_buffer with information to be
640 * returned to userspace
641 */
Hans Verkuil32a77262012-09-28 06:12:53 -0300642static void __fill_v4l2_buffer(struct vb2_buffer *vb, struct v4l2_buffer *b)
Pawel Osciake23ccc02010-10-11 10:56:41 -0300643{
644 struct vb2_queue *q = vb->vb2_queue;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300645
Sakari Ailus2b719d72012-05-02 09:40:03 -0300646 /* Copy back data such as timestamp, flags, etc. */
Pawel Osciake23ccc02010-10-11 10:56:41 -0300647 memcpy(b, &vb->v4l2_buf, offsetof(struct v4l2_buffer, m));
Sakari Ailus2b719d72012-05-02 09:40:03 -0300648 b->reserved2 = vb->v4l2_buf.reserved2;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300649 b->reserved = vb->v4l2_buf.reserved;
650
651 if (V4L2_TYPE_IS_MULTIPLANAR(q->type)) {
Pawel Osciake23ccc02010-10-11 10:56:41 -0300652 /*
653 * Fill in plane-related data if userspace provided an array
Hans Verkuil32a77262012-09-28 06:12:53 -0300654 * for it. The caller has already verified memory and size.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300655 */
Hans Verkuil3c0b6062012-09-28 06:24:18 -0300656 b->length = vb->num_planes;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300657 memcpy(b->m.planes, vb->v4l2_planes,
658 b->length * sizeof(struct v4l2_plane));
659 } else {
660 /*
661 * We use length and offset in v4l2_planes array even for
662 * single-planar buffers, but userspace does not.
663 */
664 b->length = vb->v4l2_planes[0].length;
665 b->bytesused = vb->v4l2_planes[0].bytesused;
666 if (q->memory == V4L2_MEMORY_MMAP)
667 b->m.offset = vb->v4l2_planes[0].m.mem_offset;
668 else if (q->memory == V4L2_MEMORY_USERPTR)
669 b->m.userptr = vb->v4l2_planes[0].m.userptr;
Sumit Semwalc5384042012-06-14 10:37:37 -0300670 else if (q->memory == V4L2_MEMORY_DMABUF)
671 b->m.fd = vb->v4l2_planes[0].m.fd;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300672 }
673
Marek Szyprowskiea42c8e2011-04-12 10:14:13 -0300674 /*
675 * Clear any buffer state related flags.
676 */
Sakari Ailus1b18e7a2012-10-22 17:10:16 -0300677 b->flags &= ~V4L2_BUFFER_MASK_FLAGS;
Sakari Ailus7ce6fd82014-02-25 19:08:52 -0300678 b->flags |= q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK;
679 if ((q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) !=
680 V4L2_BUF_FLAG_TIMESTAMP_COPY) {
681 /*
682 * For non-COPY timestamps, drop timestamp source bits
683 * and obtain the timestamp source from the queue.
684 */
685 b->flags &= ~V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
686 b->flags |= q->timestamp_flags & V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
687 }
Pawel Osciake23ccc02010-10-11 10:56:41 -0300688
689 switch (vb->state) {
690 case VB2_BUF_STATE_QUEUED:
691 case VB2_BUF_STATE_ACTIVE:
692 b->flags |= V4L2_BUF_FLAG_QUEUED;
693 break;
694 case VB2_BUF_STATE_ERROR:
695 b->flags |= V4L2_BUF_FLAG_ERROR;
696 /* fall through */
697 case VB2_BUF_STATE_DONE:
698 b->flags |= V4L2_BUF_FLAG_DONE;
699 break;
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -0300700 case VB2_BUF_STATE_PREPARED:
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300701 b->flags |= V4L2_BUF_FLAG_PREPARED;
702 break;
Hans Verkuilb18a8ff2013-12-13 13:13:38 -0300703 case VB2_BUF_STATE_PREPARING:
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300704 case VB2_BUF_STATE_DEQUEUED:
Pawel Osciake23ccc02010-10-11 10:56:41 -0300705 /* nothing */
706 break;
707 }
708
Marek Szyprowski25a27d92011-08-24 06:49:35 -0300709 if (__buffer_in_use(q, vb))
Pawel Osciake23ccc02010-10-11 10:56:41 -0300710 b->flags |= V4L2_BUF_FLAG_MAPPED;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300711}
712
713/**
714 * vb2_querybuf() - query video buffer information
715 * @q: videobuf queue
716 * @b: buffer struct passed from userspace to vidioc_querybuf handler
717 * in driver
718 *
719 * Should be called from vidioc_querybuf ioctl handler in driver.
720 * This function will verify the passed v4l2_buffer structure and fill the
721 * relevant information for the userspace.
722 *
723 * The return values from this function are intended to be directly returned
724 * from vidioc_querybuf handler in driver.
725 */
726int vb2_querybuf(struct vb2_queue *q, struct v4l2_buffer *b)
727{
728 struct vb2_buffer *vb;
Hans Verkuil32a77262012-09-28 06:12:53 -0300729 int ret;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300730
731 if (b->type != q->type) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300732 dprintk(1, "wrong buffer type\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -0300733 return -EINVAL;
734 }
735
736 if (b->index >= q->num_buffers) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300737 dprintk(1, "buffer index out of range\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -0300738 return -EINVAL;
739 }
740 vb = q->bufs[b->index];
Hans Verkuil32a77262012-09-28 06:12:53 -0300741 ret = __verify_planes_array(vb, b);
742 if (!ret)
743 __fill_v4l2_buffer(vb, b);
744 return ret;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300745}
746EXPORT_SYMBOL(vb2_querybuf);
747
748/**
749 * __verify_userptr_ops() - verify that all memory operations required for
750 * USERPTR queue type have been provided
751 */
752static int __verify_userptr_ops(struct vb2_queue *q)
753{
754 if (!(q->io_modes & VB2_USERPTR) || !q->mem_ops->get_userptr ||
755 !q->mem_ops->put_userptr)
756 return -EINVAL;
757
758 return 0;
759}
760
761/**
762 * __verify_mmap_ops() - verify that all memory operations required for
763 * MMAP queue type have been provided
764 */
765static int __verify_mmap_ops(struct vb2_queue *q)
766{
767 if (!(q->io_modes & VB2_MMAP) || !q->mem_ops->alloc ||
768 !q->mem_ops->put || !q->mem_ops->mmap)
769 return -EINVAL;
770
771 return 0;
772}
773
774/**
Sumit Semwalc5384042012-06-14 10:37:37 -0300775 * __verify_dmabuf_ops() - verify that all memory operations required for
776 * DMABUF queue type have been provided
777 */
778static int __verify_dmabuf_ops(struct vb2_queue *q)
779{
780 if (!(q->io_modes & VB2_DMABUF) || !q->mem_ops->attach_dmabuf ||
781 !q->mem_ops->detach_dmabuf || !q->mem_ops->map_dmabuf ||
782 !q->mem_ops->unmap_dmabuf)
783 return -EINVAL;
784
785 return 0;
786}
787
788/**
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300789 * __verify_memory_type() - Check whether the memory type and buffer type
790 * passed to a buffer operation are compatible with the queue.
791 */
792static int __verify_memory_type(struct vb2_queue *q,
793 enum v4l2_memory memory, enum v4l2_buf_type type)
794{
Sumit Semwalc5384042012-06-14 10:37:37 -0300795 if (memory != V4L2_MEMORY_MMAP && memory != V4L2_MEMORY_USERPTR &&
796 memory != V4L2_MEMORY_DMABUF) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300797 dprintk(1, "unsupported memory type\n");
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300798 return -EINVAL;
799 }
800
801 if (type != q->type) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300802 dprintk(1, "requested type is incorrect\n");
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300803 return -EINVAL;
804 }
805
806 /*
807 * Make sure all the required memory ops for given memory type
808 * are available.
809 */
810 if (memory == V4L2_MEMORY_MMAP && __verify_mmap_ops(q)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300811 dprintk(1, "MMAP for current setup unsupported\n");
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300812 return -EINVAL;
813 }
814
815 if (memory == V4L2_MEMORY_USERPTR && __verify_userptr_ops(q)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300816 dprintk(1, "USERPTR for current setup unsupported\n");
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300817 return -EINVAL;
818 }
819
Sumit Semwalc5384042012-06-14 10:37:37 -0300820 if (memory == V4L2_MEMORY_DMABUF && __verify_dmabuf_ops(q)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300821 dprintk(1, "DMABUF for current setup unsupported\n");
Sumit Semwalc5384042012-06-14 10:37:37 -0300822 return -EINVAL;
823 }
824
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300825 /*
826 * Place the busy tests at the end: -EBUSY can be ignored when
827 * create_bufs is called with count == 0, but count == 0 should still
828 * do the memory and type validation.
829 */
830 if (q->fileio) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300831 dprintk(1, "file io in progress\n");
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300832 return -EBUSY;
833 }
834 return 0;
835}
836
837/**
838 * __reqbufs() - Initiate streaming
Pawel Osciake23ccc02010-10-11 10:56:41 -0300839 * @q: videobuf2 queue
840 * @req: struct passed from userspace to vidioc_reqbufs handler in driver
841 *
842 * Should be called from vidioc_reqbufs ioctl handler of a driver.
843 * This function:
844 * 1) verifies streaming parameters passed from the userspace,
845 * 2) sets up the queue,
846 * 3) negotiates number of buffers and planes per buffer with the driver
847 * to be used during streaming,
848 * 4) allocates internal buffer structures (struct vb2_buffer), according to
849 * the agreed parameters,
850 * 5) for MMAP memory type, allocates actual video memory, using the
851 * memory handling/allocation routines provided during queue initialization
852 *
853 * If req->count is 0, all the memory will be freed instead.
854 * If the queue has been allocated previously (by a previous vb2_reqbufs) call
855 * and the queue is not busy, memory will be reallocated.
856 *
857 * The return values from this function are intended to be directly returned
858 * from vidioc_reqbufs handler in driver.
859 */
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300860static int __reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req)
Pawel Osciake23ccc02010-10-11 10:56:41 -0300861{
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300862 unsigned int num_buffers, allocated_buffers, num_planes = 0;
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300863 int ret;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300864
865 if (q->streaming) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300866 dprintk(1, "streaming active\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -0300867 return -EBUSY;
868 }
869
Marek Szyprowski29e3fbd2011-03-09 14:03:24 -0300870 if (req->count == 0 || q->num_buffers != 0 || q->memory != req->memory) {
Pawel Osciake23ccc02010-10-11 10:56:41 -0300871 /*
872 * We already have buffers allocated, so first check if they
873 * are not in use and can be freed.
874 */
875 if (q->memory == V4L2_MEMORY_MMAP && __buffers_in_use(q)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300876 dprintk(1, "memory in use, cannot free\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -0300877 return -EBUSY;
878 }
879
Hans Verkuilfb64dca2014-02-28 12:49:18 -0300880 /*
881 * Call queue_cancel to clean up any buffers in the PREPARED or
882 * QUEUED state which is possible if buffers were prepared or
883 * queued without ever calling STREAMON.
884 */
885 __vb2_queue_cancel(q);
Hans Verkuil63faabf2013-12-13 13:13:40 -0300886 ret = __vb2_queue_free(q, q->num_buffers);
887 if (ret)
888 return ret;
Marek Szyprowski29e3fbd2011-03-09 14:03:24 -0300889
890 /*
891 * In case of REQBUFS(0) return immediately without calling
892 * driver's queue_setup() callback and allocating resources.
893 */
894 if (req->count == 0)
895 return 0;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300896 }
897
898 /*
899 * Make sure the requested values and current defaults are sane.
900 */
901 num_buffers = min_t(unsigned int, req->count, VIDEO_MAX_FRAME);
Hans Verkuilb3379c62014-02-24 13:51:03 -0300902 num_buffers = max_t(unsigned int, req->count, q->min_buffers_needed);
Marek Szyprowskic1426bc2011-08-24 06:36:26 -0300903 memset(q->plane_sizes, 0, sizeof(q->plane_sizes));
Pawel Osciake23ccc02010-10-11 10:56:41 -0300904 memset(q->alloc_ctx, 0, sizeof(q->alloc_ctx));
Marek Szyprowski13b14092011-04-14 07:17:44 -0300905 q->memory = req->memory;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300906
907 /*
908 * Ask the driver how many buffers and planes per buffer it requires.
909 * Driver also sets the size and allocator context for each plane.
910 */
Guennadi Liakhovetskifc714e72011-08-24 10:30:21 -0300911 ret = call_qop(q, queue_setup, q, NULL, &num_buffers, &num_planes,
Marek Szyprowskic1426bc2011-08-24 06:36:26 -0300912 q->plane_sizes, q->alloc_ctx);
Hans Verkuila1d36d82014-03-17 09:54:21 -0300913 if (ret)
Pawel Osciake23ccc02010-10-11 10:56:41 -0300914 return ret;
915
916 /* Finally, allocate buffers and video memory */
Hans Verkuila7afcac2014-02-24 13:41:20 -0300917 allocated_buffers = __vb2_queue_alloc(q, req->memory, num_buffers, num_planes);
918 if (allocated_buffers == 0) {
Marek Szyprowski66072d42011-06-28 08:29:02 -0300919 dprintk(1, "Memory allocation failed\n");
920 return -ENOMEM;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300921 }
922
923 /*
Hans Verkuilb3379c62014-02-24 13:51:03 -0300924 * There is no point in continuing if we can't allocate the minimum
925 * number of buffers needed by this vb2_queue.
926 */
927 if (allocated_buffers < q->min_buffers_needed)
928 ret = -ENOMEM;
929
930 /*
Pawel Osciake23ccc02010-10-11 10:56:41 -0300931 * Check if driver can handle the allocated number of buffers.
932 */
Hans Verkuilb3379c62014-02-24 13:51:03 -0300933 if (!ret && allocated_buffers < num_buffers) {
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300934 num_buffers = allocated_buffers;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300935
Guennadi Liakhovetskifc714e72011-08-24 10:30:21 -0300936 ret = call_qop(q, queue_setup, q, NULL, &num_buffers,
937 &num_planes, q->plane_sizes, q->alloc_ctx);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300938
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300939 if (!ret && allocated_buffers < num_buffers)
Pawel Osciake23ccc02010-10-11 10:56:41 -0300940 ret = -ENOMEM;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300941
942 /*
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300943 * Either the driver has accepted a smaller number of buffers,
944 * or .queue_setup() returned an error
Pawel Osciake23ccc02010-10-11 10:56:41 -0300945 */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300946 }
947
948 q->num_buffers = allocated_buffers;
949
950 if (ret < 0) {
Hans Verkuila7afcac2014-02-24 13:41:20 -0300951 /*
952 * Note: __vb2_queue_free() will subtract 'allocated_buffers'
953 * from q->num_buffers.
954 */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300955 __vb2_queue_free(q, allocated_buffers);
956 return ret;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300957 }
958
Pawel Osciake23ccc02010-10-11 10:56:41 -0300959 /*
960 * Return the number of successfully allocated buffers
961 * to the userspace.
962 */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300963 req->count = allocated_buffers;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300964
965 return 0;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300966}
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300967
968/**
969 * vb2_reqbufs() - Wrapper for __reqbufs() that also verifies the memory and
970 * type values.
971 * @q: videobuf2 queue
972 * @req: struct passed from userspace to vidioc_reqbufs handler in driver
973 */
974int vb2_reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req)
975{
976 int ret = __verify_memory_type(q, req->memory, req->type);
977
978 return ret ? ret : __reqbufs(q, req);
979}
Pawel Osciake23ccc02010-10-11 10:56:41 -0300980EXPORT_SYMBOL_GPL(vb2_reqbufs);
981
982/**
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300983 * __create_bufs() - Allocate buffers and any required auxiliary structs
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300984 * @q: videobuf2 queue
985 * @create: creation parameters, passed from userspace to vidioc_create_bufs
986 * handler in driver
987 *
988 * Should be called from vidioc_create_bufs ioctl handler of a driver.
989 * This function:
990 * 1) verifies parameter sanity
991 * 2) calls the .queue_setup() queue operation
992 * 3) performs any necessary memory allocations
993 *
994 * The return values from this function are intended to be directly returned
995 * from vidioc_create_bufs handler in driver.
996 */
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300997static int __create_bufs(struct vb2_queue *q, struct v4l2_create_buffers *create)
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300998{
999 unsigned int num_planes = 0, num_buffers, allocated_buffers;
Hans Verkuil37d9ed92012-06-27 17:10:30 -03001000 int ret;
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001001
1002 if (q->num_buffers == VIDEO_MAX_FRAME) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001003 dprintk(1, "maximum number of buffers already allocated\n");
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001004 return -ENOBUFS;
1005 }
1006
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001007 if (!q->num_buffers) {
1008 memset(q->plane_sizes, 0, sizeof(q->plane_sizes));
1009 memset(q->alloc_ctx, 0, sizeof(q->alloc_ctx));
1010 q->memory = create->memory;
1011 }
1012
1013 num_buffers = min(create->count, VIDEO_MAX_FRAME - q->num_buffers);
1014
1015 /*
1016 * Ask the driver, whether the requested number of buffers, planes per
1017 * buffer and their sizes are acceptable
1018 */
1019 ret = call_qop(q, queue_setup, q, &create->format, &num_buffers,
1020 &num_planes, q->plane_sizes, q->alloc_ctx);
Hans Verkuila1d36d82014-03-17 09:54:21 -03001021 if (ret)
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001022 return ret;
1023
1024 /* Finally, allocate buffers and video memory */
Hans Verkuila7afcac2014-02-24 13:41:20 -03001025 allocated_buffers = __vb2_queue_alloc(q, create->memory, num_buffers,
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001026 num_planes);
Hans Verkuila7afcac2014-02-24 13:41:20 -03001027 if (allocated_buffers == 0) {
Hans Verkuilf05393d22012-06-22 05:44:14 -03001028 dprintk(1, "Memory allocation failed\n");
1029 return -ENOMEM;
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001030 }
1031
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001032 /*
1033 * Check if driver can handle the so far allocated number of buffers.
1034 */
Hans Verkuila7afcac2014-02-24 13:41:20 -03001035 if (allocated_buffers < num_buffers) {
1036 num_buffers = allocated_buffers;
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001037
1038 /*
1039 * q->num_buffers contains the total number of buffers, that the
1040 * queue driver has set up
1041 */
1042 ret = call_qop(q, queue_setup, q, &create->format, &num_buffers,
1043 &num_planes, q->plane_sizes, q->alloc_ctx);
1044
1045 if (!ret && allocated_buffers < num_buffers)
1046 ret = -ENOMEM;
1047
1048 /*
1049 * Either the driver has accepted a smaller number of buffers,
1050 * or .queue_setup() returned an error
1051 */
1052 }
1053
1054 q->num_buffers += allocated_buffers;
1055
1056 if (ret < 0) {
Hans Verkuila7afcac2014-02-24 13:41:20 -03001057 /*
1058 * Note: __vb2_queue_free() will subtract 'allocated_buffers'
1059 * from q->num_buffers.
1060 */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001061 __vb2_queue_free(q, allocated_buffers);
Hans Verkuilf05393d22012-06-22 05:44:14 -03001062 return -ENOMEM;
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001063 }
1064
1065 /*
1066 * Return the number of successfully allocated buffers
1067 * to the userspace.
1068 */
1069 create->count = allocated_buffers;
1070
1071 return 0;
1072}
Hans Verkuil37d9ed92012-06-27 17:10:30 -03001073
1074/**
Nicolas THERY53aa3b12012-07-20 09:25:37 -03001075 * vb2_create_bufs() - Wrapper for __create_bufs() that also verifies the
1076 * memory and type values.
Hans Verkuil37d9ed92012-06-27 17:10:30 -03001077 * @q: videobuf2 queue
1078 * @create: creation parameters, passed from userspace to vidioc_create_bufs
1079 * handler in driver
1080 */
1081int vb2_create_bufs(struct vb2_queue *q, struct v4l2_create_buffers *create)
1082{
1083 int ret = __verify_memory_type(q, create->memory, create->format.type);
1084
1085 create->index = q->num_buffers;
Hans Verkuilf05393d22012-06-22 05:44:14 -03001086 if (create->count == 0)
1087 return ret != -EBUSY ? ret : 0;
Hans Verkuil37d9ed92012-06-27 17:10:30 -03001088 return ret ? ret : __create_bufs(q, create);
1089}
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001090EXPORT_SYMBOL_GPL(vb2_create_bufs);
1091
1092/**
Pawel Osciake23ccc02010-10-11 10:56:41 -03001093 * vb2_plane_vaddr() - Return a kernel virtual address of a given plane
1094 * @vb: vb2_buffer to which the plane in question belongs to
1095 * @plane_no: plane number for which the address is to be returned
1096 *
1097 * This function returns a kernel virtual address of a given plane if
1098 * such a mapping exist, NULL otherwise.
1099 */
1100void *vb2_plane_vaddr(struct vb2_buffer *vb, unsigned int plane_no)
1101{
Marek Szyprowskia00d0262011-12-15 05:53:06 -03001102 if (plane_no > vb->num_planes || !vb->planes[plane_no].mem_priv)
Pawel Osciake23ccc02010-10-11 10:56:41 -03001103 return NULL;
1104
Hans Verkuila1d36d82014-03-17 09:54:21 -03001105 return call_ptr_memop(vb, vaddr, vb->planes[plane_no].mem_priv);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001106
1107}
1108EXPORT_SYMBOL_GPL(vb2_plane_vaddr);
1109
1110/**
1111 * vb2_plane_cookie() - Return allocator specific cookie for the given plane
1112 * @vb: vb2_buffer to which the plane in question belongs to
1113 * @plane_no: plane number for which the cookie is to be returned
1114 *
1115 * This function returns an allocator specific cookie for a given plane if
1116 * available, NULL otherwise. The allocator should provide some simple static
1117 * inline function, which would convert this cookie to the allocator specific
1118 * type that can be used directly by the driver to access the buffer. This can
1119 * be for example physical address, pointer to scatter list or IOMMU mapping.
1120 */
1121void *vb2_plane_cookie(struct vb2_buffer *vb, unsigned int plane_no)
1122{
Marek Szyprowskia00d0262011-12-15 05:53:06 -03001123 if (plane_no > vb->num_planes || !vb->planes[plane_no].mem_priv)
Pawel Osciake23ccc02010-10-11 10:56:41 -03001124 return NULL;
1125
Hans Verkuila1d36d82014-03-17 09:54:21 -03001126 return call_ptr_memop(vb, cookie, vb->planes[plane_no].mem_priv);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001127}
1128EXPORT_SYMBOL_GPL(vb2_plane_cookie);
1129
1130/**
1131 * vb2_buffer_done() - inform videobuf that an operation on a buffer is finished
1132 * @vb: vb2_buffer returned from the driver
1133 * @state: either VB2_BUF_STATE_DONE if the operation finished successfully
Hans Verkuilb3379c62014-02-24 13:51:03 -03001134 * or VB2_BUF_STATE_ERROR if the operation finished with an error.
1135 * If start_streaming fails then it should return buffers with state
1136 * VB2_BUF_STATE_QUEUED to put them back into the queue.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001137 *
1138 * This function should be called by the driver after a hardware operation on
1139 * a buffer is finished and the buffer may be returned to userspace. The driver
1140 * cannot use this buffer anymore until it is queued back to it by videobuf
1141 * by the means of buf_queue callback. Only buffers previously queued to the
1142 * driver by buf_queue can be passed to this function.
Hans Verkuilb3379c62014-02-24 13:51:03 -03001143 *
1144 * While streaming a buffer can only be returned in state DONE or ERROR.
1145 * The start_streaming op can also return them in case the DMA engine cannot
1146 * be started for some reason. In that case the buffers should be returned with
1147 * state QUEUED.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001148 */
1149void vb2_buffer_done(struct vb2_buffer *vb, enum vb2_buffer_state state)
1150{
1151 struct vb2_queue *q = vb->vb2_queue;
1152 unsigned long flags;
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -03001153 unsigned int plane;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001154
Hans Verkuilb3379c62014-02-24 13:51:03 -03001155 if (WARN_ON(vb->state != VB2_BUF_STATE_ACTIVE))
Pawel Osciake23ccc02010-10-11 10:56:41 -03001156 return;
1157
Hans Verkuilb3379c62014-02-24 13:51:03 -03001158 if (!q->start_streaming_called) {
1159 if (WARN_ON(state != VB2_BUF_STATE_QUEUED))
1160 state = VB2_BUF_STATE_QUEUED;
1161 } else if (!WARN_ON(!q->start_streaming_called)) {
1162 if (WARN_ON(state != VB2_BUF_STATE_DONE &&
1163 state != VB2_BUF_STATE_ERROR))
1164 state = VB2_BUF_STATE_ERROR;
1165 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001166
Hans Verkuilb5b45412014-01-29 11:53:25 -03001167#ifdef CONFIG_VIDEO_ADV_DEBUG
1168 /*
1169 * Although this is not a callback, it still does have to balance
1170 * with the buf_queue op. So update this counter manually.
1171 */
1172 vb->cnt_buf_done++;
1173#endif
Pawel Osciake23ccc02010-10-11 10:56:41 -03001174 dprintk(4, "Done processing on buffer %d, state: %d\n",
Tushar Behera9b6f5dc2012-11-12 04:01:29 -03001175 vb->v4l2_buf.index, state);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001176
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -03001177 /* sync buffers */
1178 for (plane = 0; plane < vb->num_planes; ++plane)
Hans Verkuila1d36d82014-03-17 09:54:21 -03001179 call_void_memop(vb, finish, vb->planes[plane].mem_priv);
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -03001180
Pawel Osciake23ccc02010-10-11 10:56:41 -03001181 /* Add the buffer to the done buffers list */
1182 spin_lock_irqsave(&q->done_lock, flags);
1183 vb->state = state;
Hans Verkuilb3379c62014-02-24 13:51:03 -03001184 if (state != VB2_BUF_STATE_QUEUED)
1185 list_add_tail(&vb->done_entry, &q->done_list);
Hans Verkuil6ea3b982014-02-06 05:46:11 -03001186 atomic_dec(&q->owned_by_drv_count);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001187 spin_unlock_irqrestore(&q->done_lock, flags);
1188
Hans Verkuilb3379c62014-02-24 13:51:03 -03001189 if (state == VB2_BUF_STATE_QUEUED)
1190 return;
1191
Pawel Osciake23ccc02010-10-11 10:56:41 -03001192 /* Inform any processes that may be waiting for buffers */
1193 wake_up(&q->done_wq);
1194}
1195EXPORT_SYMBOL_GPL(vb2_buffer_done);
1196
1197/**
Hans Verkuil32a77262012-09-28 06:12:53 -03001198 * __fill_vb2_buffer() - fill a vb2_buffer with information provided in a
1199 * v4l2_buffer by the userspace. The caller has already verified that struct
1200 * v4l2_buffer has a valid number of planes.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001201 */
Hans Verkuil32a77262012-09-28 06:12:53 -03001202static void __fill_vb2_buffer(struct vb2_buffer *vb, const struct v4l2_buffer *b,
Pawel Osciake23ccc02010-10-11 10:56:41 -03001203 struct v4l2_plane *v4l2_planes)
1204{
1205 unsigned int plane;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001206
1207 if (V4L2_TYPE_IS_MULTIPLANAR(b->type)) {
Pawel Osciake23ccc02010-10-11 10:56:41 -03001208 /* Fill in driver-provided information for OUTPUT types */
1209 if (V4L2_TYPE_IS_OUTPUT(b->type)) {
Hans Verkuil61bd8fb2014-04-07 08:57:48 -03001210 bool bytesused_is_used;
1211
1212 /* Check if bytesused == 0 for all planes */
1213 for (plane = 0; plane < vb->num_planes; ++plane)
1214 if (b->m.planes[plane].bytesused)
1215 break;
1216 bytesused_is_used = plane < vb->num_planes;
1217
Pawel Osciake23ccc02010-10-11 10:56:41 -03001218 /*
1219 * Will have to go up to b->length when API starts
1220 * accepting variable number of planes.
Hans Verkuil61bd8fb2014-04-07 08:57:48 -03001221 *
1222 * If bytesused_is_used is false, then fall back to the
1223 * full buffer size. In that case userspace clearly
1224 * never bothered to set it and it's a safe assumption
1225 * that they really meant to use the full plane sizes.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001226 */
1227 for (plane = 0; plane < vb->num_planes; ++plane) {
Hans Verkuil61bd8fb2014-04-07 08:57:48 -03001228 struct v4l2_plane *pdst = &v4l2_planes[plane];
1229 struct v4l2_plane *psrc = &b->m.planes[plane];
1230
1231 pdst->bytesused = bytesused_is_used ?
1232 psrc->bytesused : psrc->length;
1233 pdst->data_offset = psrc->data_offset;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001234 }
1235 }
1236
1237 if (b->memory == V4L2_MEMORY_USERPTR) {
1238 for (plane = 0; plane < vb->num_planes; ++plane) {
1239 v4l2_planes[plane].m.userptr =
1240 b->m.planes[plane].m.userptr;
1241 v4l2_planes[plane].length =
1242 b->m.planes[plane].length;
1243 }
1244 }
Sumit Semwalc5384042012-06-14 10:37:37 -03001245 if (b->memory == V4L2_MEMORY_DMABUF) {
1246 for (plane = 0; plane < vb->num_planes; ++plane) {
1247 v4l2_planes[plane].m.fd =
1248 b->m.planes[plane].m.fd;
1249 v4l2_planes[plane].length =
1250 b->m.planes[plane].length;
Sumit Semwalc5384042012-06-14 10:37:37 -03001251 }
1252 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001253 } else {
1254 /*
1255 * Single-planar buffers do not use planes array,
1256 * so fill in relevant v4l2_buffer struct fields instead.
1257 * In videobuf we use our internal V4l2_planes struct for
1258 * single-planar buffers as well, for simplicity.
Hans Verkuil61bd8fb2014-04-07 08:57:48 -03001259 *
1260 * If bytesused == 0, then fall back to the full buffer size
1261 * as that's a sensible default.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001262 */
Hans Verkuil412376a2014-04-07 08:44:56 -03001263 if (V4L2_TYPE_IS_OUTPUT(b->type))
Hans Verkuil61bd8fb2014-04-07 08:57:48 -03001264 v4l2_planes[0].bytesused =
1265 b->bytesused ? b->bytesused : b->length;
1266 else
1267 v4l2_planes[0].bytesused = 0;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001268
1269 if (b->memory == V4L2_MEMORY_USERPTR) {
1270 v4l2_planes[0].m.userptr = b->m.userptr;
1271 v4l2_planes[0].length = b->length;
1272 }
Sumit Semwalc5384042012-06-14 10:37:37 -03001273
1274 if (b->memory == V4L2_MEMORY_DMABUF) {
1275 v4l2_planes[0].m.fd = b->m.fd;
1276 v4l2_planes[0].length = b->length;
Sumit Semwalc5384042012-06-14 10:37:37 -03001277 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001278 }
1279
Hans Verkuilf1343282014-02-24 14:44:50 -03001280 /* Zero flags that the vb2 core handles */
Sakari Ailus1b18e7a2012-10-22 17:10:16 -03001281 vb->v4l2_buf.flags = b->flags & ~V4L2_BUFFER_MASK_FLAGS;
Sakari Ailus7ce6fd82014-02-25 19:08:52 -03001282 if ((vb->vb2_queue->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) !=
1283 V4L2_BUF_FLAG_TIMESTAMP_COPY || !V4L2_TYPE_IS_OUTPUT(b->type)) {
1284 /*
1285 * Non-COPY timestamps and non-OUTPUT queues will get
1286 * their timestamp and timestamp source flags from the
1287 * queue.
1288 */
1289 vb->v4l2_buf.flags &= ~V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
1290 }
1291
Hans Verkuilf1343282014-02-24 14:44:50 -03001292 if (V4L2_TYPE_IS_OUTPUT(b->type)) {
1293 /*
1294 * For output buffers mask out the timecode flag:
1295 * this will be handled later in vb2_internal_qbuf().
1296 * The 'field' is valid metadata for this output buffer
1297 * and so that needs to be copied here.
1298 */
1299 vb->v4l2_buf.flags &= ~V4L2_BUF_FLAG_TIMECODE;
1300 vb->v4l2_buf.field = b->field;
1301 } else {
1302 /* Zero any output buffer flags as this is a capture buffer */
1303 vb->v4l2_buf.flags &= ~V4L2_BUFFER_OUT_FLAGS;
1304 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001305}
1306
1307/**
1308 * __qbuf_userptr() - handle qbuf of a USERPTR buffer
1309 */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001310static int __qbuf_userptr(struct vb2_buffer *vb, const struct v4l2_buffer *b)
Pawel Osciake23ccc02010-10-11 10:56:41 -03001311{
1312 struct v4l2_plane planes[VIDEO_MAX_PLANES];
1313 struct vb2_queue *q = vb->vb2_queue;
1314 void *mem_priv;
1315 unsigned int plane;
1316 int ret;
1317 int write = !V4L2_TYPE_IS_OUTPUT(q->type);
Hans Verkuil256f3162014-01-29 13:36:53 -03001318 bool reacquired = vb->planes[0].mem_priv == NULL;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001319
Hans Verkuil412376a2014-04-07 08:44:56 -03001320 memset(planes, 0, sizeof(planes[0]) * vb->num_planes);
Hans Verkuil32a77262012-09-28 06:12:53 -03001321 /* Copy relevant information provided by the userspace */
1322 __fill_vb2_buffer(vb, b, planes);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001323
1324 for (plane = 0; plane < vb->num_planes; ++plane) {
1325 /* Skip the plane if already verified */
Marek Szyprowskif0b7c7f2011-11-16 15:09:40 -03001326 if (vb->v4l2_planes[plane].m.userptr &&
1327 vb->v4l2_planes[plane].m.userptr == planes[plane].m.userptr
Pawel Osciake23ccc02010-10-11 10:56:41 -03001328 && vb->v4l2_planes[plane].length == planes[plane].length)
1329 continue;
1330
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001331 dprintk(3, "userspace address for plane %d changed, "
Pawel Osciake23ccc02010-10-11 10:56:41 -03001332 "reacquiring memory\n", plane);
1333
Marek Szyprowskic1426bc2011-08-24 06:36:26 -03001334 /* Check if the provided plane buffer is large enough */
1335 if (planes[plane].length < q->plane_sizes[plane]) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001336 dprintk(1, "provided buffer size %u is less than "
Seung-Woo Kim2484a7e2013-08-20 04:48:06 -03001337 "setup size %u for plane %d\n",
1338 planes[plane].length,
1339 q->plane_sizes[plane], plane);
Marek Szyprowski4c2625d2011-10-03 03:21:45 -03001340 ret = -EINVAL;
Marek Szyprowskic1426bc2011-08-24 06:36:26 -03001341 goto err;
1342 }
1343
Pawel Osciake23ccc02010-10-11 10:56:41 -03001344 /* Release previously acquired memory if present */
Hans Verkuil256f3162014-01-29 13:36:53 -03001345 if (vb->planes[plane].mem_priv) {
1346 if (!reacquired) {
1347 reacquired = true;
Hans Verkuila1d36d82014-03-17 09:54:21 -03001348 call_void_vb_qop(vb, buf_cleanup, vb);
Hans Verkuil256f3162014-01-29 13:36:53 -03001349 }
Hans Verkuila1d36d82014-03-17 09:54:21 -03001350 call_void_memop(vb, put_userptr, vb->planes[plane].mem_priv);
Hans Verkuil256f3162014-01-29 13:36:53 -03001351 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001352
1353 vb->planes[plane].mem_priv = NULL;
Hans Verkuil256f3162014-01-29 13:36:53 -03001354 memset(&vb->v4l2_planes[plane], 0, sizeof(struct v4l2_plane));
Pawel Osciake23ccc02010-10-11 10:56:41 -03001355
1356 /* Acquire each plane's memory */
Hans Verkuila1d36d82014-03-17 09:54:21 -03001357 mem_priv = call_ptr_memop(vb, get_userptr, q->alloc_ctx[plane],
Marek Szyprowskia00d0262011-12-15 05:53:06 -03001358 planes[plane].m.userptr,
1359 planes[plane].length, write);
1360 if (IS_ERR_OR_NULL(mem_priv)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001361 dprintk(1, "failed acquiring userspace "
Pawel Osciake23ccc02010-10-11 10:56:41 -03001362 "memory for plane %d\n", plane);
Marek Szyprowskia00d0262011-12-15 05:53:06 -03001363 ret = mem_priv ? PTR_ERR(mem_priv) : -EINVAL;
1364 goto err;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001365 }
Marek Szyprowskia00d0262011-12-15 05:53:06 -03001366 vb->planes[plane].mem_priv = mem_priv;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001367 }
1368
1369 /*
Pawel Osciake23ccc02010-10-11 10:56:41 -03001370 * Now that everything is in order, copy relevant information
1371 * provided by userspace.
1372 */
1373 for (plane = 0; plane < vb->num_planes; ++plane)
1374 vb->v4l2_planes[plane] = planes[plane];
1375
Hans Verkuil256f3162014-01-29 13:36:53 -03001376 if (reacquired) {
1377 /*
1378 * One or more planes changed, so we must call buf_init to do
1379 * the driver-specific initialization on the newly acquired
1380 * buffer, if provided.
1381 */
1382 ret = call_vb_qop(vb, buf_init, vb);
1383 if (ret) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001384 dprintk(1, "buffer initialization failed\n");
Hans Verkuil256f3162014-01-29 13:36:53 -03001385 goto err;
1386 }
1387 }
1388
1389 ret = call_vb_qop(vb, buf_prepare, vb);
1390 if (ret) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001391 dprintk(1, "buffer preparation failed\n");
Hans Verkuila1d36d82014-03-17 09:54:21 -03001392 call_void_vb_qop(vb, buf_cleanup, vb);
Hans Verkuil256f3162014-01-29 13:36:53 -03001393 goto err;
1394 }
1395
Pawel Osciake23ccc02010-10-11 10:56:41 -03001396 return 0;
1397err:
1398 /* In case of errors, release planes that were already acquired */
Marek Szyprowskic1426bc2011-08-24 06:36:26 -03001399 for (plane = 0; plane < vb->num_planes; ++plane) {
1400 if (vb->planes[plane].mem_priv)
Hans Verkuila1d36d82014-03-17 09:54:21 -03001401 call_void_memop(vb, put_userptr, vb->planes[plane].mem_priv);
Marek Szyprowskic1426bc2011-08-24 06:36:26 -03001402 vb->planes[plane].mem_priv = NULL;
1403 vb->v4l2_planes[plane].m.userptr = 0;
1404 vb->v4l2_planes[plane].length = 0;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001405 }
1406
1407 return ret;
1408}
1409
1410/**
1411 * __qbuf_mmap() - handle qbuf of an MMAP buffer
1412 */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001413static int __qbuf_mmap(struct vb2_buffer *vb, const struct v4l2_buffer *b)
Pawel Osciake23ccc02010-10-11 10:56:41 -03001414{
Hans Verkuil32a77262012-09-28 06:12:53 -03001415 __fill_vb2_buffer(vb, b, vb->v4l2_planes);
Hans Verkuila1d36d82014-03-17 09:54:21 -03001416 return call_vb_qop(vb, buf_prepare, vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001417}
1418
1419/**
Sumit Semwalc5384042012-06-14 10:37:37 -03001420 * __qbuf_dmabuf() - handle qbuf of a DMABUF buffer
1421 */
1422static int __qbuf_dmabuf(struct vb2_buffer *vb, const struct v4l2_buffer *b)
1423{
1424 struct v4l2_plane planes[VIDEO_MAX_PLANES];
1425 struct vb2_queue *q = vb->vb2_queue;
1426 void *mem_priv;
1427 unsigned int plane;
1428 int ret;
1429 int write = !V4L2_TYPE_IS_OUTPUT(q->type);
Hans Verkuil256f3162014-01-29 13:36:53 -03001430 bool reacquired = vb->planes[0].mem_priv == NULL;
Sumit Semwalc5384042012-06-14 10:37:37 -03001431
Hans Verkuil412376a2014-04-07 08:44:56 -03001432 memset(planes, 0, sizeof(planes[0]) * vb->num_planes);
Laurent Pinchart6f546c52014-01-01 09:10:48 -03001433 /* Copy relevant information provided by the userspace */
Sumit Semwalc5384042012-06-14 10:37:37 -03001434 __fill_vb2_buffer(vb, b, planes);
1435
1436 for (plane = 0; plane < vb->num_planes; ++plane) {
1437 struct dma_buf *dbuf = dma_buf_get(planes[plane].m.fd);
1438
1439 if (IS_ERR_OR_NULL(dbuf)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001440 dprintk(1, "invalid dmabuf fd for plane %d\n",
Sumit Semwalc5384042012-06-14 10:37:37 -03001441 plane);
1442 ret = -EINVAL;
1443 goto err;
1444 }
1445
1446 /* use DMABUF size if length is not provided */
1447 if (planes[plane].length == 0)
1448 planes[plane].length = dbuf->size;
1449
Hans Verkuil412376a2014-04-07 08:44:56 -03001450 if (planes[plane].length < q->plane_sizes[plane]) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001451 dprintk(1, "invalid dmabuf length for plane %d\n",
Seung-Woo Kim77c07822013-11-29 04:50:29 -03001452 plane);
Sumit Semwalc5384042012-06-14 10:37:37 -03001453 ret = -EINVAL;
1454 goto err;
1455 }
1456
1457 /* Skip the plane if already verified */
1458 if (dbuf == vb->planes[plane].dbuf &&
1459 vb->v4l2_planes[plane].length == planes[plane].length) {
1460 dma_buf_put(dbuf);
1461 continue;
1462 }
1463
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001464 dprintk(1, "buffer for plane %d changed\n", plane);
Sumit Semwalc5384042012-06-14 10:37:37 -03001465
Hans Verkuil256f3162014-01-29 13:36:53 -03001466 if (!reacquired) {
1467 reacquired = true;
Hans Verkuila1d36d82014-03-17 09:54:21 -03001468 call_void_vb_qop(vb, buf_cleanup, vb);
Hans Verkuil256f3162014-01-29 13:36:53 -03001469 }
1470
Sumit Semwalc5384042012-06-14 10:37:37 -03001471 /* Release previously acquired memory if present */
Hans Verkuilb5b45412014-01-29 11:53:25 -03001472 __vb2_plane_dmabuf_put(vb, &vb->planes[plane]);
Sumit Semwalc5384042012-06-14 10:37:37 -03001473 memset(&vb->v4l2_planes[plane], 0, sizeof(struct v4l2_plane));
1474
1475 /* Acquire each plane's memory */
Hans Verkuila1d36d82014-03-17 09:54:21 -03001476 mem_priv = call_ptr_memop(vb, attach_dmabuf, q->alloc_ctx[plane],
Sumit Semwalc5384042012-06-14 10:37:37 -03001477 dbuf, planes[plane].length, write);
1478 if (IS_ERR(mem_priv)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001479 dprintk(1, "failed to attach dmabuf\n");
Sumit Semwalc5384042012-06-14 10:37:37 -03001480 ret = PTR_ERR(mem_priv);
1481 dma_buf_put(dbuf);
1482 goto err;
1483 }
1484
1485 vb->planes[plane].dbuf = dbuf;
1486 vb->planes[plane].mem_priv = mem_priv;
1487 }
1488
1489 /* TODO: This pins the buffer(s) with dma_buf_map_attachment()).. but
1490 * really we want to do this just before the DMA, not while queueing
1491 * the buffer(s)..
1492 */
1493 for (plane = 0; plane < vb->num_planes; ++plane) {
Hans Verkuilb5b45412014-01-29 11:53:25 -03001494 ret = call_memop(vb, map_dmabuf, vb->planes[plane].mem_priv);
Sumit Semwalc5384042012-06-14 10:37:37 -03001495 if (ret) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001496 dprintk(1, "failed to map dmabuf for plane %d\n",
Sumit Semwalc5384042012-06-14 10:37:37 -03001497 plane);
1498 goto err;
1499 }
1500 vb->planes[plane].dbuf_mapped = 1;
1501 }
1502
1503 /*
Sumit Semwalc5384042012-06-14 10:37:37 -03001504 * Now that everything is in order, copy relevant information
1505 * provided by userspace.
1506 */
1507 for (plane = 0; plane < vb->num_planes; ++plane)
1508 vb->v4l2_planes[plane] = planes[plane];
1509
Hans Verkuil256f3162014-01-29 13:36:53 -03001510 if (reacquired) {
1511 /*
1512 * Call driver-specific initialization on the newly acquired buffer,
1513 * if provided.
1514 */
1515 ret = call_vb_qop(vb, buf_init, vb);
1516 if (ret) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001517 dprintk(1, "buffer initialization failed\n");
Hans Verkuil256f3162014-01-29 13:36:53 -03001518 goto err;
1519 }
1520 }
1521
1522 ret = call_vb_qop(vb, buf_prepare, vb);
1523 if (ret) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001524 dprintk(1, "buffer preparation failed\n");
Hans Verkuila1d36d82014-03-17 09:54:21 -03001525 call_void_vb_qop(vb, buf_cleanup, vb);
Hans Verkuil256f3162014-01-29 13:36:53 -03001526 goto err;
1527 }
1528
Sumit Semwalc5384042012-06-14 10:37:37 -03001529 return 0;
1530err:
1531 /* In case of errors, release planes that were already acquired */
1532 __vb2_buf_dmabuf_put(vb);
1533
1534 return ret;
1535}
1536
1537/**
Pawel Osciake23ccc02010-10-11 10:56:41 -03001538 * __enqueue_in_driver() - enqueue a vb2_buffer in driver for processing
1539 */
1540static void __enqueue_in_driver(struct vb2_buffer *vb)
1541{
1542 struct vb2_queue *q = vb->vb2_queue;
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -03001543 unsigned int plane;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001544
1545 vb->state = VB2_BUF_STATE_ACTIVE;
Hans Verkuil6ea3b982014-02-06 05:46:11 -03001546 atomic_inc(&q->owned_by_drv_count);
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -03001547
1548 /* sync buffers */
1549 for (plane = 0; plane < vb->num_planes; ++plane)
Hans Verkuila1d36d82014-03-17 09:54:21 -03001550 call_void_memop(vb, prepare, vb->planes[plane].mem_priv);
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -03001551
Hans Verkuila1d36d82014-03-17 09:54:21 -03001552 call_void_vb_qop(vb, buf_queue, vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001553}
1554
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001555static int __buf_prepare(struct vb2_buffer *vb, const struct v4l2_buffer *b)
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001556{
1557 struct vb2_queue *q = vb->vb2_queue;
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001558 struct rw_semaphore *mmap_sem;
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001559 int ret;
1560
Laurent Pinchart8023ed02012-07-10 10:41:40 -03001561 ret = __verify_length(vb, b);
Sylwester Nawrocki3a9621b2013-08-26 11:47:53 -03001562 if (ret < 0) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001563 dprintk(1, "plane parameters verification failed: %d\n", ret);
Laurent Pinchart8023ed02012-07-10 10:41:40 -03001564 return ret;
Sylwester Nawrocki3a9621b2013-08-26 11:47:53 -03001565 }
Laurent Pinchart8023ed02012-07-10 10:41:40 -03001566
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001567 vb->state = VB2_BUF_STATE_PREPARING;
Hans Verkuilf1343282014-02-24 14:44:50 -03001568 vb->v4l2_buf.timestamp.tv_sec = 0;
1569 vb->v4l2_buf.timestamp.tv_usec = 0;
1570 vb->v4l2_buf.sequence = 0;
1571
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001572 switch (q->memory) {
1573 case V4L2_MEMORY_MMAP:
1574 ret = __qbuf_mmap(vb, b);
1575 break;
1576 case V4L2_MEMORY_USERPTR:
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001577 /*
Mauro Carvalho Chehabf103b5d2014-01-07 07:03:09 -02001578 * In case of user pointer buffers vb2 allocators need to get
1579 * direct access to userspace pages. This requires getting
1580 * the mmap semaphore for read access in the current process
1581 * structure. The same semaphore is taken before calling mmap
1582 * operation, while both qbuf/prepare_buf and mmap are called
1583 * by the driver or v4l2 core with the driver's lock held.
1584 * To avoid an AB-BA deadlock (mmap_sem then driver's lock in
1585 * mmap and driver's lock then mmap_sem in qbuf/prepare_buf),
1586 * the videobuf2 core releases the driver's lock, takes
1587 * mmap_sem and then takes the driver's lock again.
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001588 */
1589 mmap_sem = &current->mm->mmap_sem;
Hans Verkuila1d36d82014-03-17 09:54:21 -03001590 call_void_qop(q, wait_prepare, q);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001591 down_read(mmap_sem);
Hans Verkuila1d36d82014-03-17 09:54:21 -03001592 call_void_qop(q, wait_finish, q);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001593
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001594 ret = __qbuf_userptr(vb, b);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001595
1596 up_read(mmap_sem);
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001597 break;
Sumit Semwalc5384042012-06-14 10:37:37 -03001598 case V4L2_MEMORY_DMABUF:
1599 ret = __qbuf_dmabuf(vb, b);
1600 break;
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001601 default:
1602 WARN(1, "Invalid queue type\n");
1603 ret = -EINVAL;
1604 }
1605
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001606 if (ret)
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001607 dprintk(1, "buffer preparation failed: %d\n", ret);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001608 vb->state = ret ? VB2_BUF_STATE_DEQUEUED : VB2_BUF_STATE_PREPARED;
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001609
1610 return ret;
1611}
1612
Laurent Pinchart012043b2013-08-09 08:11:26 -03001613static int vb2_queue_or_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b,
Hans Verkuil41381112013-12-13 13:13:39 -03001614 const char *opname)
Laurent Pinchart012043b2013-08-09 08:11:26 -03001615{
Laurent Pinchart012043b2013-08-09 08:11:26 -03001616 if (b->type != q->type) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001617 dprintk(1, "%s: invalid buffer type\n", opname);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001618 return -EINVAL;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001619 }
1620
1621 if (b->index >= q->num_buffers) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001622 dprintk(1, "%s: buffer index out of range\n", opname);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001623 return -EINVAL;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001624 }
1625
Hans Verkuil41381112013-12-13 13:13:39 -03001626 if (q->bufs[b->index] == NULL) {
Laurent Pinchart012043b2013-08-09 08:11:26 -03001627 /* Should never happen */
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001628 dprintk(1, "%s: buffer is NULL\n", opname);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001629 return -EINVAL;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001630 }
1631
1632 if (b->memory != q->memory) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001633 dprintk(1, "%s: invalid memory type\n", opname);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001634 return -EINVAL;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001635 }
1636
Hans Verkuil41381112013-12-13 13:13:39 -03001637 return __verify_planes_array(q->bufs[b->index], b);
Laurent Pinchart012043b2013-08-09 08:11:26 -03001638}
1639
Pawel Osciake23ccc02010-10-11 10:56:41 -03001640/**
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001641 * vb2_prepare_buf() - Pass ownership of a buffer from userspace to the kernel
1642 * @q: videobuf2 queue
1643 * @b: buffer structure passed from userspace to vidioc_prepare_buf
1644 * handler in driver
1645 *
1646 * Should be called from vidioc_prepare_buf ioctl handler of a driver.
1647 * This function:
1648 * 1) verifies the passed buffer,
1649 * 2) calls buf_prepare callback in the driver (if provided), in which
1650 * driver-specific buffer initialization can be performed,
1651 *
1652 * The return values from this function are intended to be directly returned
1653 * from vidioc_prepare_buf handler in driver.
1654 */
1655int vb2_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b)
1656{
Hans Verkuil41381112013-12-13 13:13:39 -03001657 struct vb2_buffer *vb;
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001658 int ret;
Hans Verkuil41381112013-12-13 13:13:39 -03001659
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001660 if (q->fileio) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001661 dprintk(1, "file io in progress\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001662 return -EBUSY;
1663 }
1664
1665 ret = vb2_queue_or_prepare_buf(q, b, "prepare_buf");
Hans Verkuil41381112013-12-13 13:13:39 -03001666 if (ret)
1667 return ret;
1668
1669 vb = q->bufs[b->index];
1670 if (vb->state != VB2_BUF_STATE_DEQUEUED) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001671 dprintk(1, "invalid buffer state %d\n",
Hans Verkuil41381112013-12-13 13:13:39 -03001672 vb->state);
1673 return -EINVAL;
1674 }
1675
1676 ret = __buf_prepare(vb, b);
1677 if (!ret) {
1678 /* Fill buffer information for the userspace */
1679 __fill_v4l2_buffer(vb, b);
1680
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001681 dprintk(1, "prepare of buffer %d succeeded\n", vb->v4l2_buf.index);
Hans Verkuil41381112013-12-13 13:13:39 -03001682 }
1683 return ret;
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001684}
1685EXPORT_SYMBOL_GPL(vb2_prepare_buf);
1686
Hans Verkuil02f142e2013-12-13 13:13:42 -03001687/**
1688 * vb2_start_streaming() - Attempt to start streaming.
1689 * @q: videobuf2 queue
1690 *
Hans Verkuilb3379c62014-02-24 13:51:03 -03001691 * Attempt to start streaming. When this function is called there must be
1692 * at least q->min_buffers_needed buffers queued up (i.e. the minimum
1693 * number of buffers required for the DMA engine to function). If the
1694 * @start_streaming op fails it is supposed to return all the driver-owned
1695 * buffers back to vb2 in state QUEUED. Check if that happened and if
1696 * not warn and reclaim them forcefully.
Hans Verkuil02f142e2013-12-13 13:13:42 -03001697 */
1698static int vb2_start_streaming(struct vb2_queue *q)
1699{
Hans Verkuilb3379c62014-02-24 13:51:03 -03001700 struct vb2_buffer *vb;
Hans Verkuil02f142e2013-12-13 13:13:42 -03001701 int ret;
1702
Hans Verkuil02f142e2013-12-13 13:13:42 -03001703 /*
Hans Verkuilb3379c62014-02-24 13:51:03 -03001704 * If any buffers were queued before streamon,
1705 * we can now pass them to driver for processing.
Hans Verkuil02f142e2013-12-13 13:13:42 -03001706 */
Hans Verkuilb3379c62014-02-24 13:51:03 -03001707 list_for_each_entry(vb, &q->queued_list, queued_entry)
1708 __enqueue_in_driver(vb);
1709
1710 /* Tell the driver to start streaming */
1711 ret = call_qop(q, start_streaming, q,
1712 atomic_read(&q->owned_by_drv_count));
1713 q->start_streaming_called = ret == 0;
1714 if (!ret)
Hans Verkuil02f142e2013-12-13 13:13:42 -03001715 return 0;
Hans Verkuilb3379c62014-02-24 13:51:03 -03001716
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001717 dprintk(1, "driver refused to start streaming\n");
Hans Verkuilb3379c62014-02-24 13:51:03 -03001718 if (WARN_ON(atomic_read(&q->owned_by_drv_count))) {
1719 unsigned i;
1720
1721 /*
1722 * Forcefully reclaim buffers if the driver did not
1723 * correctly return them to vb2.
1724 */
1725 for (i = 0; i < q->num_buffers; ++i) {
1726 vb = q->bufs[i];
1727 if (vb->state == VB2_BUF_STATE_ACTIVE)
1728 vb2_buffer_done(vb, VB2_BUF_STATE_QUEUED);
1729 }
1730 /* Must be zero now */
1731 WARN_ON(atomic_read(&q->owned_by_drv_count));
Hans Verkuil02f142e2013-12-13 13:13:42 -03001732 }
Hans Verkuil02f142e2013-12-13 13:13:42 -03001733 return ret;
1734}
1735
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001736static int vb2_internal_qbuf(struct vb2_queue *q, struct v4l2_buffer *b)
Laurent Pinchart012043b2013-08-09 08:11:26 -03001737{
Hans Verkuil41381112013-12-13 13:13:39 -03001738 int ret = vb2_queue_or_prepare_buf(q, b, "qbuf");
1739 struct vb2_buffer *vb;
1740
1741 if (ret)
1742 return ret;
1743
1744 vb = q->bufs[b->index];
Laurent Pinchart012043b2013-08-09 08:11:26 -03001745
1746 switch (vb->state) {
1747 case VB2_BUF_STATE_DEQUEUED:
1748 ret = __buf_prepare(vb, b);
1749 if (ret)
1750 return ret;
Hans Verkuil41381112013-12-13 13:13:39 -03001751 break;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001752 case VB2_BUF_STATE_PREPARED:
1753 break;
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001754 case VB2_BUF_STATE_PREPARING:
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001755 dprintk(1, "buffer still being prepared\n");
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001756 return -EINVAL;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001757 default:
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001758 dprintk(1, "invalid buffer state %d\n", vb->state);
Laurent Pinchart012043b2013-08-09 08:11:26 -03001759 return -EINVAL;
1760 }
1761
1762 /*
1763 * Add to the queued buffers list, a buffer will stay on it until
1764 * dequeued in dqbuf.
1765 */
1766 list_add_tail(&vb->queued_entry, &q->queued_list);
Hans Verkuilb3379c62014-02-24 13:51:03 -03001767 q->queued_count++;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001768 vb->state = VB2_BUF_STATE_QUEUED;
Hans Verkuilf1343282014-02-24 14:44:50 -03001769 if (V4L2_TYPE_IS_OUTPUT(q->type)) {
1770 /*
1771 * For output buffers copy the timestamp if needed,
1772 * and the timecode field and flag if needed.
1773 */
Sakari Ailusc57ff792014-03-01 10:28:02 -03001774 if ((q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
1775 V4L2_BUF_FLAG_TIMESTAMP_COPY)
Hans Verkuilf1343282014-02-24 14:44:50 -03001776 vb->v4l2_buf.timestamp = b->timestamp;
1777 vb->v4l2_buf.flags |= b->flags & V4L2_BUF_FLAG_TIMECODE;
1778 if (b->flags & V4L2_BUF_FLAG_TIMECODE)
1779 vb->v4l2_buf.timecode = b->timecode;
1780 }
Laurent Pinchart012043b2013-08-09 08:11:26 -03001781
1782 /*
1783 * If already streaming, give the buffer to driver for processing.
1784 * If not, the buffer will be given to driver on next streamon.
1785 */
Hans Verkuilb3379c62014-02-24 13:51:03 -03001786 if (q->start_streaming_called)
Laurent Pinchart012043b2013-08-09 08:11:26 -03001787 __enqueue_in_driver(vb);
1788
Hans Verkuil41381112013-12-13 13:13:39 -03001789 /* Fill buffer information for the userspace */
1790 __fill_v4l2_buffer(vb, b);
Laurent Pinchart012043b2013-08-09 08:11:26 -03001791
Hans Verkuilb3379c62014-02-24 13:51:03 -03001792 /*
1793 * If streamon has been called, and we haven't yet called
1794 * start_streaming() since not enough buffers were queued, and
1795 * we now have reached the minimum number of queued buffers,
1796 * then we can finally call start_streaming().
1797 */
1798 if (q->streaming && !q->start_streaming_called &&
1799 q->queued_count >= q->min_buffers_needed) {
Hans Verkuil02f142e2013-12-13 13:13:42 -03001800 ret = vb2_start_streaming(q);
1801 if (ret)
1802 return ret;
1803 }
1804
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001805 dprintk(1, "qbuf of buffer %d succeeded\n", vb->v4l2_buf.index);
Hans Verkuil41381112013-12-13 13:13:39 -03001806 return 0;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001807}
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001808
1809/**
1810 * vb2_qbuf() - Queue a buffer from userspace
1811 * @q: videobuf2 queue
1812 * @b: buffer structure passed from userspace to vidioc_qbuf handler
1813 * in driver
1814 *
1815 * Should be called from vidioc_qbuf ioctl handler of a driver.
1816 * This function:
1817 * 1) verifies the passed buffer,
1818 * 2) if necessary, calls buf_prepare callback in the driver (if provided), in
1819 * which driver-specific buffer initialization can be performed,
1820 * 3) if streaming is on, queues the buffer in driver by the means of buf_queue
1821 * callback for processing.
1822 *
1823 * The return values from this function are intended to be directly returned
1824 * from vidioc_qbuf handler in driver.
1825 */
1826int vb2_qbuf(struct vb2_queue *q, struct v4l2_buffer *b)
1827{
1828 if (q->fileio) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001829 dprintk(1, "file io in progress\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001830 return -EBUSY;
1831 }
1832
1833 return vb2_internal_qbuf(q, b);
1834}
Pawel Osciake23ccc02010-10-11 10:56:41 -03001835EXPORT_SYMBOL_GPL(vb2_qbuf);
1836
1837/**
1838 * __vb2_wait_for_done_vb() - wait for a buffer to become available
1839 * for dequeuing
1840 *
1841 * Will sleep if required for nonblocking == false.
1842 */
1843static int __vb2_wait_for_done_vb(struct vb2_queue *q, int nonblocking)
1844{
1845 /*
1846 * All operations on vb_done_list are performed under done_lock
1847 * spinlock protection. However, buffers may be removed from
1848 * it and returned to userspace only while holding both driver's
1849 * lock and the done_lock spinlock. Thus we can be sure that as
1850 * long as we hold the driver's lock, the list will remain not
1851 * empty if list_empty() check succeeds.
1852 */
1853
1854 for (;;) {
1855 int ret;
1856
1857 if (!q->streaming) {
1858 dprintk(1, "Streaming off, will not wait for buffers\n");
1859 return -EINVAL;
1860 }
1861
1862 if (!list_empty(&q->done_list)) {
1863 /*
1864 * Found a buffer that we were waiting for.
1865 */
1866 break;
1867 }
1868
1869 if (nonblocking) {
1870 dprintk(1, "Nonblocking and no buffers to dequeue, "
1871 "will not wait\n");
1872 return -EAGAIN;
1873 }
1874
1875 /*
1876 * We are streaming and blocking, wait for another buffer to
1877 * become ready or for streamoff. Driver's lock is released to
1878 * allow streamoff or qbuf to be called while waiting.
1879 */
Hans Verkuila1d36d82014-03-17 09:54:21 -03001880 call_void_qop(q, wait_prepare, q);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001881
1882 /*
1883 * All locks have been released, it is safe to sleep now.
1884 */
1885 dprintk(3, "Will sleep waiting for buffers\n");
1886 ret = wait_event_interruptible(q->done_wq,
1887 !list_empty(&q->done_list) || !q->streaming);
1888
1889 /*
1890 * We need to reevaluate both conditions again after reacquiring
1891 * the locks or return an error if one occurred.
1892 */
Hans Verkuila1d36d82014-03-17 09:54:21 -03001893 call_void_qop(q, wait_finish, q);
Hans Verkuil32a77262012-09-28 06:12:53 -03001894 if (ret) {
1895 dprintk(1, "Sleep was interrupted\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03001896 return ret;
Hans Verkuil32a77262012-09-28 06:12:53 -03001897 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001898 }
1899 return 0;
1900}
1901
1902/**
1903 * __vb2_get_done_vb() - get a buffer ready for dequeuing
1904 *
1905 * Will sleep if required for nonblocking == false.
1906 */
1907static int __vb2_get_done_vb(struct vb2_queue *q, struct vb2_buffer **vb,
Hans Verkuil32a77262012-09-28 06:12:53 -03001908 struct v4l2_buffer *b, int nonblocking)
Pawel Osciake23ccc02010-10-11 10:56:41 -03001909{
1910 unsigned long flags;
1911 int ret;
1912
1913 /*
1914 * Wait for at least one buffer to become available on the done_list.
1915 */
1916 ret = __vb2_wait_for_done_vb(q, nonblocking);
1917 if (ret)
1918 return ret;
1919
1920 /*
1921 * Driver's lock has been held since we last verified that done_list
1922 * is not empty, so no need for another list_empty(done_list) check.
1923 */
1924 spin_lock_irqsave(&q->done_lock, flags);
1925 *vb = list_first_entry(&q->done_list, struct vb2_buffer, done_entry);
Hans Verkuil32a77262012-09-28 06:12:53 -03001926 /*
1927 * Only remove the buffer from done_list if v4l2_buffer can handle all
1928 * the planes.
1929 */
1930 ret = __verify_planes_array(*vb, b);
1931 if (!ret)
1932 list_del(&(*vb)->done_entry);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001933 spin_unlock_irqrestore(&q->done_lock, flags);
1934
Hans Verkuil32a77262012-09-28 06:12:53 -03001935 return ret;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001936}
1937
1938/**
1939 * vb2_wait_for_all_buffers() - wait until all buffers are given back to vb2
1940 * @q: videobuf2 queue
1941 *
1942 * This function will wait until all buffers that have been given to the driver
1943 * by buf_queue() are given back to vb2 with vb2_buffer_done(). It doesn't call
1944 * wait_prepare, wait_finish pair. It is intended to be called with all locks
1945 * taken, for example from stop_streaming() callback.
1946 */
1947int vb2_wait_for_all_buffers(struct vb2_queue *q)
1948{
1949 if (!q->streaming) {
1950 dprintk(1, "Streaming off, will not wait for buffers\n");
1951 return -EINVAL;
1952 }
1953
Hans Verkuilb3379c62014-02-24 13:51:03 -03001954 if (q->start_streaming_called)
Hans Verkuil6ea3b982014-02-06 05:46:11 -03001955 wait_event(q->done_wq, !atomic_read(&q->owned_by_drv_count));
Pawel Osciake23ccc02010-10-11 10:56:41 -03001956 return 0;
1957}
1958EXPORT_SYMBOL_GPL(vb2_wait_for_all_buffers);
1959
1960/**
Sumit Semwalc5384042012-06-14 10:37:37 -03001961 * __vb2_dqbuf() - bring back the buffer to the DEQUEUED state
1962 */
1963static void __vb2_dqbuf(struct vb2_buffer *vb)
1964{
1965 struct vb2_queue *q = vb->vb2_queue;
1966 unsigned int i;
1967
1968 /* nothing to do if the buffer is already dequeued */
1969 if (vb->state == VB2_BUF_STATE_DEQUEUED)
1970 return;
1971
1972 vb->state = VB2_BUF_STATE_DEQUEUED;
1973
1974 /* unmap DMABUF buffer */
1975 if (q->memory == V4L2_MEMORY_DMABUF)
1976 for (i = 0; i < vb->num_planes; ++i) {
1977 if (!vb->planes[i].dbuf_mapped)
1978 continue;
Hans Verkuila1d36d82014-03-17 09:54:21 -03001979 call_void_memop(vb, unmap_dmabuf, vb->planes[i].mem_priv);
Sumit Semwalc5384042012-06-14 10:37:37 -03001980 vb->planes[i].dbuf_mapped = 0;
1981 }
1982}
1983
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001984static int vb2_internal_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking)
Pawel Osciake23ccc02010-10-11 10:56:41 -03001985{
1986 struct vb2_buffer *vb = NULL;
1987 int ret;
1988
1989 if (b->type != q->type) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001990 dprintk(1, "invalid buffer type\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03001991 return -EINVAL;
1992 }
Hans Verkuil32a77262012-09-28 06:12:53 -03001993 ret = __vb2_get_done_vb(q, &vb, b, nonblocking);
1994 if (ret < 0)
Pawel Osciake23ccc02010-10-11 10:56:41 -03001995 return ret;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001996
Pawel Osciake23ccc02010-10-11 10:56:41 -03001997 switch (vb->state) {
1998 case VB2_BUF_STATE_DONE:
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001999 dprintk(3, "Returning done buffer\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03002000 break;
2001 case VB2_BUF_STATE_ERROR:
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002002 dprintk(3, "Returning done buffer with errors\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03002003 break;
2004 default:
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002005 dprintk(1, "Invalid buffer state\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03002006 return -EINVAL;
2007 }
2008
Hans Verkuila1d36d82014-03-17 09:54:21 -03002009 call_void_vb_qop(vb, buf_finish, vb);
Hans Verkuil9cf3c312014-02-28 13:30:48 -03002010
Pawel Osciake23ccc02010-10-11 10:56:41 -03002011 /* Fill buffer information for the userspace */
2012 __fill_v4l2_buffer(vb, b);
2013 /* Remove from videobuf queue */
2014 list_del(&vb->queued_entry);
Hans Verkuilb3379c62014-02-24 13:51:03 -03002015 q->queued_count--;
Sumit Semwalc5384042012-06-14 10:37:37 -03002016 /* go back to dequeued state */
2017 __vb2_dqbuf(vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002018
2019 dprintk(1, "dqbuf of buffer %d, with state %d\n",
2020 vb->v4l2_buf.index, vb->state);
2021
Pawel Osciake23ccc02010-10-11 10:56:41 -03002022 return 0;
2023}
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002024
2025/**
2026 * vb2_dqbuf() - Dequeue a buffer to the userspace
2027 * @q: videobuf2 queue
2028 * @b: buffer structure passed from userspace to vidioc_dqbuf handler
2029 * in driver
2030 * @nonblocking: if true, this call will not sleep waiting for a buffer if no
2031 * buffers ready for dequeuing are present. Normally the driver
2032 * would be passing (file->f_flags & O_NONBLOCK) here
2033 *
2034 * Should be called from vidioc_dqbuf ioctl handler of a driver.
2035 * This function:
2036 * 1) verifies the passed buffer,
2037 * 2) calls buf_finish callback in the driver (if provided), in which
2038 * driver can perform any additional operations that may be required before
2039 * returning the buffer to userspace, such as cache sync,
2040 * 3) the buffer struct members are filled with relevant information for
2041 * the userspace.
2042 *
2043 * The return values from this function are intended to be directly returned
2044 * from vidioc_dqbuf handler in driver.
2045 */
2046int vb2_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking)
2047{
2048 if (q->fileio) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002049 dprintk(1, "file io in progress\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002050 return -EBUSY;
2051 }
2052 return vb2_internal_dqbuf(q, b, nonblocking);
2053}
Pawel Osciake23ccc02010-10-11 10:56:41 -03002054EXPORT_SYMBOL_GPL(vb2_dqbuf);
2055
2056/**
Pawel Osciake23ccc02010-10-11 10:56:41 -03002057 * __vb2_queue_cancel() - cancel and stop (pause) streaming
2058 *
2059 * Removes all queued buffers from driver's queue and all buffers queued by
2060 * userspace from videobuf's queue. Returns to state after reqbufs.
2061 */
2062static void __vb2_queue_cancel(struct vb2_queue *q)
2063{
2064 unsigned int i;
2065
2066 /*
2067 * Tell driver to stop all transactions and release all queued
2068 * buffers.
2069 */
Hans Verkuilb3379c62014-02-24 13:51:03 -03002070 if (q->start_streaming_called)
Pawel Osciake23ccc02010-10-11 10:56:41 -03002071 call_qop(q, stop_streaming, q);
2072 q->streaming = 0;
Hans Verkuilb3379c62014-02-24 13:51:03 -03002073 q->start_streaming_called = 0;
2074 q->queued_count = 0;
2075
2076 if (WARN_ON(atomic_read(&q->owned_by_drv_count))) {
2077 for (i = 0; i < q->num_buffers; ++i)
2078 if (q->bufs[i]->state == VB2_BUF_STATE_ACTIVE)
2079 vb2_buffer_done(q->bufs[i], VB2_BUF_STATE_ERROR);
2080 /* Must be zero now */
2081 WARN_ON(atomic_read(&q->owned_by_drv_count));
2082 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03002083
2084 /*
2085 * Remove all buffers from videobuf's list...
2086 */
2087 INIT_LIST_HEAD(&q->queued_list);
2088 /*
2089 * ...and done list; userspace will not receive any buffers it
2090 * has not already dequeued before initiating cancel.
2091 */
2092 INIT_LIST_HEAD(&q->done_list);
Hans Verkuil6ea3b982014-02-06 05:46:11 -03002093 atomic_set(&q->owned_by_drv_count, 0);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002094 wake_up_all(&q->done_wq);
2095
2096 /*
2097 * Reinitialize all buffers for next use.
Hans Verkuil9c0863b2014-03-04 07:34:49 -03002098 * Make sure to call buf_finish for any queued buffers. Normally
2099 * that's done in dqbuf, but that's not going to happen when we
2100 * cancel the whole queue. Note: this code belongs here, not in
2101 * __vb2_dqbuf() since in vb2_internal_dqbuf() there is a critical
2102 * call to __fill_v4l2_buffer() after buf_finish(). That order can't
2103 * be changed, so we can't move the buf_finish() to __vb2_dqbuf().
Pawel Osciake23ccc02010-10-11 10:56:41 -03002104 */
Hans Verkuil9c0863b2014-03-04 07:34:49 -03002105 for (i = 0; i < q->num_buffers; ++i) {
2106 struct vb2_buffer *vb = q->bufs[i];
2107
2108 if (vb->state != VB2_BUF_STATE_DEQUEUED) {
2109 vb->state = VB2_BUF_STATE_PREPARED;
Hans Verkuila1d36d82014-03-17 09:54:21 -03002110 call_void_vb_qop(vb, buf_finish, vb);
Hans Verkuil9c0863b2014-03-04 07:34:49 -03002111 }
2112 __vb2_dqbuf(vb);
2113 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03002114}
2115
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002116static int vb2_internal_streamon(struct vb2_queue *q, enum v4l2_buf_type type)
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002117{
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002118 int ret;
2119
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002120 if (type != q->type) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002121 dprintk(1, "invalid stream type\n");
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002122 return -EINVAL;
2123 }
2124
2125 if (q->streaming) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002126 dprintk(3, "already streaming\n");
Ricardo Ribaldaf9560352013-11-08 07:08:45 -03002127 return 0;
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002128 }
2129
Ricardo Ribalda548df782014-01-08 05:01:33 -03002130 if (!q->num_buffers) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002131 dprintk(1, "no buffers have been allocated\n");
Ricardo Ribalda548df782014-01-08 05:01:33 -03002132 return -EINVAL;
2133 }
2134
Ricardo Ribalda Delgado249f5a52014-01-08 05:01:33 -03002135 if (!q->num_buffers) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002136 dprintk(1, "no buffers have been allocated\n");
Ricardo Ribalda Delgado249f5a52014-01-08 05:01:33 -03002137 return -EINVAL;
2138 }
Hans Verkuilb3379c62014-02-24 13:51:03 -03002139 if (q->num_buffers < q->min_buffers_needed) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002140 dprintk(1, "need at least %u allocated buffers\n",
Hans Verkuilb3379c62014-02-24 13:51:03 -03002141 q->min_buffers_needed);
2142 return -EINVAL;
2143 }
Ricardo Ribalda Delgado249f5a52014-01-08 05:01:33 -03002144
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002145 /*
Hans Verkuilb3379c62014-02-24 13:51:03 -03002146 * Tell driver to start streaming provided sufficient buffers
2147 * are available.
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002148 */
Hans Verkuilb3379c62014-02-24 13:51:03 -03002149 if (q->queued_count >= q->min_buffers_needed) {
2150 ret = vb2_start_streaming(q);
2151 if (ret) {
2152 __vb2_queue_cancel(q);
2153 return ret;
2154 }
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002155 }
2156
2157 q->streaming = 1;
2158
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002159 dprintk(3, "successful\n");
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002160 return 0;
2161}
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002162
2163/**
2164 * vb2_streamon - start streaming
2165 * @q: videobuf2 queue
2166 * @type: type argument passed from userspace to vidioc_streamon handler
2167 *
2168 * Should be called from vidioc_streamon handler of a driver.
2169 * This function:
2170 * 1) verifies current state
2171 * 2) passes any previously queued buffers to the driver and starts streaming
2172 *
2173 * The return values from this function are intended to be directly returned
2174 * from vidioc_streamon handler in the driver.
2175 */
2176int vb2_streamon(struct vb2_queue *q, enum v4l2_buf_type type)
2177{
2178 if (q->fileio) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002179 dprintk(1, "file io in progress\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002180 return -EBUSY;
2181 }
2182 return vb2_internal_streamon(q, type);
2183}
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002184EXPORT_SYMBOL_GPL(vb2_streamon);
2185
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002186static int vb2_internal_streamoff(struct vb2_queue *q, enum v4l2_buf_type type)
2187{
2188 if (type != q->type) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002189 dprintk(1, "invalid stream type\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002190 return -EINVAL;
2191 }
2192
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002193 /*
2194 * Cancel will pause streaming and remove all buffers from the driver
2195 * and videobuf, effectively returning control over them to userspace.
Hans Verkuil3f1a9a32014-02-25 09:42:45 -03002196 *
2197 * Note that we do this even if q->streaming == 0: if you prepare or
2198 * queue buffers, and then call streamoff without ever having called
2199 * streamon, you would still expect those buffers to be returned to
2200 * their normal dequeued state.
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002201 */
2202 __vb2_queue_cancel(q);
2203
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002204 dprintk(3, "successful\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002205 return 0;
2206}
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002207
2208/**
Pawel Osciake23ccc02010-10-11 10:56:41 -03002209 * vb2_streamoff - stop streaming
2210 * @q: videobuf2 queue
2211 * @type: type argument passed from userspace to vidioc_streamoff handler
2212 *
2213 * Should be called from vidioc_streamoff handler of a driver.
2214 * This function:
2215 * 1) verifies current state,
2216 * 2) stop streaming and dequeues any queued buffers, including those previously
2217 * passed to the driver (after waiting for the driver to finish).
2218 *
2219 * This call can be used for pausing playback.
2220 * The return values from this function are intended to be directly returned
2221 * from vidioc_streamoff handler in the driver
2222 */
2223int vb2_streamoff(struct vb2_queue *q, enum v4l2_buf_type type)
2224{
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002225 if (q->fileio) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002226 dprintk(1, "file io in progress\n");
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002227 return -EBUSY;
2228 }
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002229 return vb2_internal_streamoff(q, type);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002230}
2231EXPORT_SYMBOL_GPL(vb2_streamoff);
2232
2233/**
2234 * __find_plane_by_offset() - find plane associated with the given offset off
2235 */
2236static int __find_plane_by_offset(struct vb2_queue *q, unsigned long off,
2237 unsigned int *_buffer, unsigned int *_plane)
2238{
2239 struct vb2_buffer *vb;
2240 unsigned int buffer, plane;
2241
2242 /*
2243 * Go over all buffers and their planes, comparing the given offset
2244 * with an offset assigned to each plane. If a match is found,
2245 * return its buffer and plane numbers.
2246 */
2247 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
2248 vb = q->bufs[buffer];
2249
2250 for (plane = 0; plane < vb->num_planes; ++plane) {
2251 if (vb->v4l2_planes[plane].m.mem_offset == off) {
2252 *_buffer = buffer;
2253 *_plane = plane;
2254 return 0;
2255 }
2256 }
2257 }
2258
2259 return -EINVAL;
2260}
2261
2262/**
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002263 * vb2_expbuf() - Export a buffer as a file descriptor
2264 * @q: videobuf2 queue
2265 * @eb: export buffer structure passed from userspace to vidioc_expbuf
2266 * handler in driver
2267 *
2268 * The return values from this function are intended to be directly returned
2269 * from vidioc_expbuf handler in driver.
2270 */
2271int vb2_expbuf(struct vb2_queue *q, struct v4l2_exportbuffer *eb)
2272{
2273 struct vb2_buffer *vb = NULL;
2274 struct vb2_plane *vb_plane;
2275 int ret;
2276 struct dma_buf *dbuf;
2277
2278 if (q->memory != V4L2_MEMORY_MMAP) {
2279 dprintk(1, "Queue is not currently set up for mmap\n");
2280 return -EINVAL;
2281 }
2282
2283 if (!q->mem_ops->get_dmabuf) {
2284 dprintk(1, "Queue does not support DMA buffer exporting\n");
2285 return -EINVAL;
2286 }
2287
Philipp Zabelea3aba82013-05-21 05:11:35 -03002288 if (eb->flags & ~(O_CLOEXEC | O_ACCMODE)) {
2289 dprintk(1, "Queue does support only O_CLOEXEC and access mode flags\n");
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002290 return -EINVAL;
2291 }
2292
2293 if (eb->type != q->type) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002294 dprintk(1, "invalid buffer type\n");
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002295 return -EINVAL;
2296 }
2297
2298 if (eb->index >= q->num_buffers) {
2299 dprintk(1, "buffer index out of range\n");
2300 return -EINVAL;
2301 }
2302
2303 vb = q->bufs[eb->index];
2304
2305 if (eb->plane >= vb->num_planes) {
2306 dprintk(1, "buffer plane out of range\n");
2307 return -EINVAL;
2308 }
2309
2310 vb_plane = &vb->planes[eb->plane];
2311
Hans Verkuila1d36d82014-03-17 09:54:21 -03002312 dbuf = call_ptr_memop(vb, get_dmabuf, vb_plane->mem_priv, eb->flags & O_ACCMODE);
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002313 if (IS_ERR_OR_NULL(dbuf)) {
2314 dprintk(1, "Failed to export buffer %d, plane %d\n",
2315 eb->index, eb->plane);
2316 return -EINVAL;
2317 }
2318
Philipp Zabelea3aba82013-05-21 05:11:35 -03002319 ret = dma_buf_fd(dbuf, eb->flags & ~O_ACCMODE);
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002320 if (ret < 0) {
2321 dprintk(3, "buffer %d, plane %d failed to export (%d)\n",
2322 eb->index, eb->plane, ret);
2323 dma_buf_put(dbuf);
2324 return ret;
2325 }
2326
2327 dprintk(3, "buffer %d, plane %d exported as %d descriptor\n",
2328 eb->index, eb->plane, ret);
2329 eb->fd = ret;
2330
2331 return 0;
2332}
2333EXPORT_SYMBOL_GPL(vb2_expbuf);
2334
2335/**
Pawel Osciake23ccc02010-10-11 10:56:41 -03002336 * vb2_mmap() - map video buffers into application address space
2337 * @q: videobuf2 queue
2338 * @vma: vma passed to the mmap file operation handler in the driver
2339 *
2340 * Should be called from mmap file operation handler of a driver.
2341 * This function maps one plane of one of the available video buffers to
2342 * userspace. To map whole video memory allocated on reqbufs, this function
2343 * has to be called once per each plane per each buffer previously allocated.
2344 *
2345 * When the userspace application calls mmap, it passes to it an offset returned
2346 * to it earlier by the means of vidioc_querybuf handler. That offset acts as
2347 * a "cookie", which is then used to identify the plane to be mapped.
2348 * This function finds a plane with a matching offset and a mapping is performed
2349 * by the means of a provided memory operation.
2350 *
2351 * The return values from this function are intended to be directly returned
2352 * from the mmap handler in driver.
2353 */
2354int vb2_mmap(struct vb2_queue *q, struct vm_area_struct *vma)
2355{
2356 unsigned long off = vma->vm_pgoff << PAGE_SHIFT;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002357 struct vb2_buffer *vb;
2358 unsigned int buffer, plane;
2359 int ret;
Mauro Carvalho Chehab7f841452013-04-19 07:18:01 -03002360 unsigned long length;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002361
2362 if (q->memory != V4L2_MEMORY_MMAP) {
2363 dprintk(1, "Queue is not currently set up for mmap\n");
2364 return -EINVAL;
2365 }
2366
2367 /*
2368 * Check memory area access mode.
2369 */
2370 if (!(vma->vm_flags & VM_SHARED)) {
2371 dprintk(1, "Invalid vma flags, VM_SHARED needed\n");
2372 return -EINVAL;
2373 }
2374 if (V4L2_TYPE_IS_OUTPUT(q->type)) {
2375 if (!(vma->vm_flags & VM_WRITE)) {
2376 dprintk(1, "Invalid vma flags, VM_WRITE needed\n");
2377 return -EINVAL;
2378 }
2379 } else {
2380 if (!(vma->vm_flags & VM_READ)) {
2381 dprintk(1, "Invalid vma flags, VM_READ needed\n");
2382 return -EINVAL;
2383 }
2384 }
2385
2386 /*
2387 * Find the plane corresponding to the offset passed by userspace.
2388 */
2389 ret = __find_plane_by_offset(q, off, &buffer, &plane);
2390 if (ret)
2391 return ret;
2392
2393 vb = q->bufs[buffer];
Pawel Osciake23ccc02010-10-11 10:56:41 -03002394
Mauro Carvalho Chehab7f841452013-04-19 07:18:01 -03002395 /*
2396 * MMAP requires page_aligned buffers.
2397 * The buffer length was page_aligned at __vb2_buf_mem_alloc(),
2398 * so, we need to do the same here.
2399 */
2400 length = PAGE_ALIGN(vb->v4l2_planes[plane].length);
2401 if (length < (vma->vm_end - vma->vm_start)) {
2402 dprintk(1,
2403 "MMAP invalid, as it would overflow buffer length\n");
Seung-Woo Kim068a0df2013-04-11 23:57:57 -03002404 return -EINVAL;
2405 }
2406
Hans Verkuilb5b45412014-01-29 11:53:25 -03002407 ret = call_memop(vb, mmap, vb->planes[plane].mem_priv, vma);
Hans Verkuila1d36d82014-03-17 09:54:21 -03002408 if (ret)
Pawel Osciake23ccc02010-10-11 10:56:41 -03002409 return ret;
2410
Pawel Osciake23ccc02010-10-11 10:56:41 -03002411 dprintk(3, "Buffer %d, plane %d successfully mapped\n", buffer, plane);
2412 return 0;
2413}
2414EXPORT_SYMBOL_GPL(vb2_mmap);
2415
Scott Jiang6f524ec2011-09-21 09:25:23 -03002416#ifndef CONFIG_MMU
2417unsigned long vb2_get_unmapped_area(struct vb2_queue *q,
2418 unsigned long addr,
2419 unsigned long len,
2420 unsigned long pgoff,
2421 unsigned long flags)
2422{
2423 unsigned long off = pgoff << PAGE_SHIFT;
2424 struct vb2_buffer *vb;
2425 unsigned int buffer, plane;
2426 int ret;
2427
2428 if (q->memory != V4L2_MEMORY_MMAP) {
2429 dprintk(1, "Queue is not currently set up for mmap\n");
2430 return -EINVAL;
2431 }
2432
2433 /*
2434 * Find the plane corresponding to the offset passed by userspace.
2435 */
2436 ret = __find_plane_by_offset(q, off, &buffer, &plane);
2437 if (ret)
2438 return ret;
2439
2440 vb = q->bufs[buffer];
2441
2442 return (unsigned long)vb2_plane_vaddr(vb, plane);
2443}
2444EXPORT_SYMBOL_GPL(vb2_get_unmapped_area);
2445#endif
2446
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002447static int __vb2_init_fileio(struct vb2_queue *q, int read);
2448static int __vb2_cleanup_fileio(struct vb2_queue *q);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002449
2450/**
2451 * vb2_poll() - implements poll userspace operation
2452 * @q: videobuf2 queue
2453 * @file: file argument passed to the poll file operation handler
2454 * @wait: wait argument passed to the poll file operation handler
2455 *
2456 * This function implements poll file operation handler for a driver.
2457 * For CAPTURE queues, if a buffer is ready to be dequeued, the userspace will
2458 * be informed that the file descriptor of a video device is available for
2459 * reading.
2460 * For OUTPUT queues, if a buffer is ready to be dequeued, the file descriptor
2461 * will be reported as available for writing.
2462 *
Hans Verkuil95213ce2011-07-13 04:26:52 -03002463 * If the driver uses struct v4l2_fh, then vb2_poll() will also check for any
2464 * pending events.
2465 *
Pawel Osciake23ccc02010-10-11 10:56:41 -03002466 * The return values from this function are intended to be directly returned
2467 * from poll handler in driver.
2468 */
2469unsigned int vb2_poll(struct vb2_queue *q, struct file *file, poll_table *wait)
2470{
Hans Verkuil95213ce2011-07-13 04:26:52 -03002471 struct video_device *vfd = video_devdata(file);
Hans Verkuilbf5c7cb2011-07-13 04:01:30 -03002472 unsigned long req_events = poll_requested_events(wait);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002473 struct vb2_buffer *vb = NULL;
Hans Verkuil95213ce2011-07-13 04:26:52 -03002474 unsigned int res = 0;
2475 unsigned long flags;
2476
2477 if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags)) {
2478 struct v4l2_fh *fh = file->private_data;
2479
2480 if (v4l2_event_pending(fh))
2481 res = POLLPRI;
2482 else if (req_events & POLLPRI)
2483 poll_wait(file, &fh->wait, wait);
2484 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03002485
Hans Verkuilcd138232013-01-30 13:29:02 -03002486 if (!V4L2_TYPE_IS_OUTPUT(q->type) && !(req_events & (POLLIN | POLLRDNORM)))
2487 return res;
2488 if (V4L2_TYPE_IS_OUTPUT(q->type) && !(req_events & (POLLOUT | POLLWRNORM)))
2489 return res;
2490
Pawel Osciake23ccc02010-10-11 10:56:41 -03002491 /*
Pawel Osciak4ffabdb2011-03-20 18:17:34 -03002492 * Start file I/O emulator only if streaming API has not been used yet.
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002493 */
2494 if (q->num_buffers == 0 && q->fileio == NULL) {
Hans Verkuilbf5c7cb2011-07-13 04:01:30 -03002495 if (!V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_READ) &&
2496 (req_events & (POLLIN | POLLRDNORM))) {
Hans Verkuil95213ce2011-07-13 04:26:52 -03002497 if (__vb2_init_fileio(q, 1))
2498 return res | POLLERR;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002499 }
Hans Verkuilbf5c7cb2011-07-13 04:01:30 -03002500 if (V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_WRITE) &&
2501 (req_events & (POLLOUT | POLLWRNORM))) {
Hans Verkuil95213ce2011-07-13 04:26:52 -03002502 if (__vb2_init_fileio(q, 0))
2503 return res | POLLERR;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002504 /*
2505 * Write to OUTPUT queue can be done immediately.
2506 */
Hans Verkuil95213ce2011-07-13 04:26:52 -03002507 return res | POLLOUT | POLLWRNORM;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002508 }
2509 }
2510
2511 /*
Pawel Osciake23ccc02010-10-11 10:56:41 -03002512 * There is nothing to wait for if no buffers have already been queued.
2513 */
2514 if (list_empty(&q->queued_list))
Hans Verkuil95213ce2011-07-13 04:26:52 -03002515 return res | POLLERR;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002516
Seung-Woo Kim412cb872013-05-20 23:47:29 -03002517 if (list_empty(&q->done_list))
2518 poll_wait(file, &q->done_wq, wait);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002519
2520 /*
2521 * Take first buffer available for dequeuing.
2522 */
2523 spin_lock_irqsave(&q->done_lock, flags);
2524 if (!list_empty(&q->done_list))
2525 vb = list_first_entry(&q->done_list, struct vb2_buffer,
2526 done_entry);
2527 spin_unlock_irqrestore(&q->done_lock, flags);
2528
2529 if (vb && (vb->state == VB2_BUF_STATE_DONE
2530 || vb->state == VB2_BUF_STATE_ERROR)) {
Hans Verkuil95213ce2011-07-13 04:26:52 -03002531 return (V4L2_TYPE_IS_OUTPUT(q->type)) ?
2532 res | POLLOUT | POLLWRNORM :
2533 res | POLLIN | POLLRDNORM;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002534 }
Hans Verkuil95213ce2011-07-13 04:26:52 -03002535 return res;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002536}
2537EXPORT_SYMBOL_GPL(vb2_poll);
2538
2539/**
2540 * vb2_queue_init() - initialize a videobuf2 queue
2541 * @q: videobuf2 queue; this structure should be allocated in driver
2542 *
2543 * The vb2_queue structure should be allocated by the driver. The driver is
2544 * responsible of clearing it's content and setting initial values for some
2545 * required entries before calling this function.
2546 * q->ops, q->mem_ops, q->type and q->io_modes are mandatory. Please refer
2547 * to the struct vb2_queue description in include/media/videobuf2-core.h
2548 * for more information.
2549 */
2550int vb2_queue_init(struct vb2_queue *q)
2551{
Ezequiel Garcia896f38f2012-09-17 14:59:30 -03002552 /*
2553 * Sanity check
2554 */
2555 if (WARN_ON(!q) ||
2556 WARN_ON(!q->ops) ||
2557 WARN_ON(!q->mem_ops) ||
2558 WARN_ON(!q->type) ||
2559 WARN_ON(!q->io_modes) ||
2560 WARN_ON(!q->ops->queue_setup) ||
Kamil Debski6aa69f92013-01-25 06:29:57 -03002561 WARN_ON(!q->ops->buf_queue) ||
Sakari Ailus872484c2013-08-25 17:57:03 -03002562 WARN_ON(q->timestamp_flags &
2563 ~(V4L2_BUF_FLAG_TIMESTAMP_MASK |
2564 V4L2_BUF_FLAG_TSTAMP_SRC_MASK)))
Ezequiel Garcia896f38f2012-09-17 14:59:30 -03002565 return -EINVAL;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002566
Kamil Debski6aa69f92013-01-25 06:29:57 -03002567 /* Warn that the driver should choose an appropriate timestamp type */
Sakari Ailusc57ff792014-03-01 10:28:02 -03002568 WARN_ON((q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
2569 V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN);
Kamil Debski6aa69f92013-01-25 06:29:57 -03002570
Pawel Osciake23ccc02010-10-11 10:56:41 -03002571 INIT_LIST_HEAD(&q->queued_list);
2572 INIT_LIST_HEAD(&q->done_list);
2573 spin_lock_init(&q->done_lock);
2574 init_waitqueue_head(&q->done_wq);
2575
2576 if (q->buf_struct_size == 0)
2577 q->buf_struct_size = sizeof(struct vb2_buffer);
2578
2579 return 0;
2580}
2581EXPORT_SYMBOL_GPL(vb2_queue_init);
2582
2583/**
2584 * vb2_queue_release() - stop streaming, release the queue and free memory
2585 * @q: videobuf2 queue
2586 *
2587 * This function stops streaming and performs necessary clean ups, including
2588 * freeing video buffer memory. The driver is responsible for freeing
2589 * the vb2_queue structure itself.
2590 */
2591void vb2_queue_release(struct vb2_queue *q)
2592{
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002593 __vb2_cleanup_fileio(q);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002594 __vb2_queue_cancel(q);
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03002595 __vb2_queue_free(q, q->num_buffers);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002596}
2597EXPORT_SYMBOL_GPL(vb2_queue_release);
2598
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002599/**
2600 * struct vb2_fileio_buf - buffer context used by file io emulator
2601 *
2602 * vb2 provides a compatibility layer and emulator of file io (read and
2603 * write) calls on top of streaming API. This structure is used for
2604 * tracking context related to the buffers.
2605 */
2606struct vb2_fileio_buf {
2607 void *vaddr;
2608 unsigned int size;
2609 unsigned int pos;
2610 unsigned int queued:1;
2611};
2612
2613/**
2614 * struct vb2_fileio_data - queue context used by file io emulator
2615 *
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002616 * @cur_index: the index of the buffer currently being read from or
2617 * written to. If equal to q->num_buffers then a new buffer
2618 * must be dequeued.
2619 * @initial_index: in the read() case all buffers are queued up immediately
2620 * in __vb2_init_fileio() and __vb2_perform_fileio() just cycles
2621 * buffers. However, in the write() case no buffers are initially
2622 * queued, instead whenever a buffer is full it is queued up by
2623 * __vb2_perform_fileio(). Only once all available buffers have
2624 * been queued up will __vb2_perform_fileio() start to dequeue
2625 * buffers. This means that initially __vb2_perform_fileio()
2626 * needs to know what buffer index to use when it is queuing up
2627 * the buffers for the first time. That initial index is stored
2628 * in this field. Once it is equal to q->num_buffers all
2629 * available buffers have been queued and __vb2_perform_fileio()
2630 * should start the normal dequeue/queue cycle.
2631 *
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002632 * vb2 provides a compatibility layer and emulator of file io (read and
2633 * write) calls on top of streaming API. For proper operation it required
2634 * this structure to save the driver state between each call of the read
2635 * or write function.
2636 */
2637struct vb2_fileio_data {
2638 struct v4l2_requestbuffers req;
2639 struct v4l2_buffer b;
2640 struct vb2_fileio_buf bufs[VIDEO_MAX_FRAME];
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002641 unsigned int cur_index;
2642 unsigned int initial_index;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002643 unsigned int q_count;
2644 unsigned int dq_count;
2645 unsigned int flags;
2646};
2647
2648/**
2649 * __vb2_init_fileio() - initialize file io emulator
2650 * @q: videobuf2 queue
2651 * @read: mode selector (1 means read, 0 means write)
2652 */
2653static int __vb2_init_fileio(struct vb2_queue *q, int read)
2654{
2655 struct vb2_fileio_data *fileio;
2656 int i, ret;
2657 unsigned int count = 0;
2658
2659 /*
2660 * Sanity check
2661 */
Hans Verkuile4d25812014-02-03 11:22:45 -03002662 if (WARN_ON((read && !(q->io_modes & VB2_READ)) ||
2663 (!read && !(q->io_modes & VB2_WRITE))))
2664 return -EINVAL;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002665
2666 /*
2667 * Check if device supports mapping buffers to kernel virtual space.
2668 */
2669 if (!q->mem_ops->vaddr)
2670 return -EBUSY;
2671
2672 /*
2673 * Check if streaming api has not been already activated.
2674 */
2675 if (q->streaming || q->num_buffers > 0)
2676 return -EBUSY;
2677
2678 /*
2679 * Start with count 1, driver can increase it in queue_setup()
2680 */
2681 count = 1;
2682
2683 dprintk(3, "setting up file io: mode %s, count %d, flags %08x\n",
2684 (read) ? "read" : "write", count, q->io_flags);
2685
2686 fileio = kzalloc(sizeof(struct vb2_fileio_data), GFP_KERNEL);
2687 if (fileio == NULL)
2688 return -ENOMEM;
2689
2690 fileio->flags = q->io_flags;
2691
2692 /*
2693 * Request buffers and use MMAP type to force driver
2694 * to allocate buffers by itself.
2695 */
2696 fileio->req.count = count;
2697 fileio->req.memory = V4L2_MEMORY_MMAP;
2698 fileio->req.type = q->type;
2699 ret = vb2_reqbufs(q, &fileio->req);
2700 if (ret)
2701 goto err_kfree;
2702
2703 /*
2704 * Check if plane_count is correct
2705 * (multiplane buffers are not supported).
2706 */
2707 if (q->bufs[0]->num_planes != 1) {
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002708 ret = -EBUSY;
2709 goto err_reqbufs;
2710 }
2711
2712 /*
2713 * Get kernel address of each buffer.
2714 */
2715 for (i = 0; i < q->num_buffers; i++) {
2716 fileio->bufs[i].vaddr = vb2_plane_vaddr(q->bufs[i], 0);
Wei Yongjun5dd69462013-05-13 01:48:45 -03002717 if (fileio->bufs[i].vaddr == NULL) {
2718 ret = -EINVAL;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002719 goto err_reqbufs;
Wei Yongjun5dd69462013-05-13 01:48:45 -03002720 }
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002721 fileio->bufs[i].size = vb2_plane_size(q->bufs[i], 0);
2722 }
2723
2724 /*
2725 * Read mode requires pre queuing of all buffers.
2726 */
2727 if (read) {
2728 /*
2729 * Queue all buffers.
2730 */
2731 for (i = 0; i < q->num_buffers; i++) {
2732 struct v4l2_buffer *b = &fileio->b;
2733 memset(b, 0, sizeof(*b));
2734 b->type = q->type;
2735 b->memory = q->memory;
2736 b->index = i;
2737 ret = vb2_qbuf(q, b);
2738 if (ret)
2739 goto err_reqbufs;
2740 fileio->bufs[i].queued = 1;
2741 }
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002742 /*
2743 * All buffers have been queued, so mark that by setting
2744 * initial_index to q->num_buffers
2745 */
2746 fileio->initial_index = q->num_buffers;
2747 fileio->cur_index = q->num_buffers;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002748 }
2749
Hans Verkuil02f142e2013-12-13 13:13:42 -03002750 /*
2751 * Start streaming.
2752 */
2753 ret = vb2_streamon(q, q->type);
2754 if (ret)
2755 goto err_reqbufs;
2756
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002757 q->fileio = fileio;
2758
2759 return ret;
2760
2761err_reqbufs:
Hans de Goedea67e1722012-05-08 14:47:39 -03002762 fileio->req.count = 0;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002763 vb2_reqbufs(q, &fileio->req);
2764
2765err_kfree:
2766 kfree(fileio);
2767 return ret;
2768}
2769
2770/**
2771 * __vb2_cleanup_fileio() - free resourced used by file io emulator
2772 * @q: videobuf2 queue
2773 */
2774static int __vb2_cleanup_fileio(struct vb2_queue *q)
2775{
2776 struct vb2_fileio_data *fileio = q->fileio;
2777
2778 if (fileio) {
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002779 vb2_internal_streamoff(q, q->type);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002780 q->fileio = NULL;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002781 fileio->req.count = 0;
2782 vb2_reqbufs(q, &fileio->req);
2783 kfree(fileio);
2784 dprintk(3, "file io emulator closed\n");
2785 }
2786 return 0;
2787}
2788
2789/**
2790 * __vb2_perform_fileio() - perform a single file io (read or write) operation
2791 * @q: videobuf2 queue
2792 * @data: pointed to target userspace buffer
2793 * @count: number of bytes to read or write
2794 * @ppos: file handle position tracking pointer
2795 * @nonblock: mode selector (1 means blocking calls, 0 means nonblocking)
2796 * @read: access mode selector (1 means read, 0 means write)
2797 */
2798static size_t __vb2_perform_fileio(struct vb2_queue *q, char __user *data, size_t count,
2799 loff_t *ppos, int nonblock, int read)
2800{
2801 struct vb2_fileio_data *fileio;
2802 struct vb2_fileio_buf *buf;
2803 int ret, index;
2804
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002805 dprintk(3, "mode %s, offset %ld, count %zd, %sblocking\n",
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002806 read ? "read" : "write", (long)*ppos, count,
2807 nonblock ? "non" : "");
2808
2809 if (!data)
2810 return -EINVAL;
2811
2812 /*
2813 * Initialize emulator on first call.
2814 */
2815 if (!q->fileio) {
2816 ret = __vb2_init_fileio(q, read);
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002817 dprintk(3, "vb2_init_fileio result: %d\n", ret);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002818 if (ret)
2819 return ret;
2820 }
2821 fileio = q->fileio;
2822
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002823 /*
2824 * Check if we need to dequeue the buffer.
2825 */
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002826 index = fileio->cur_index;
Hans Verkuil88e26872013-12-13 13:13:45 -03002827 if (index >= q->num_buffers) {
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002828 /*
2829 * Call vb2_dqbuf to get buffer back.
2830 */
2831 memset(&fileio->b, 0, sizeof(fileio->b));
2832 fileio->b.type = q->type;
2833 fileio->b.memory = q->memory;
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002834 ret = vb2_internal_dqbuf(q, &fileio->b, nonblock);
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002835 dprintk(5, "vb2_dqbuf result: %d\n", ret);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002836 if (ret)
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002837 return ret;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002838 fileio->dq_count += 1;
2839
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002840 fileio->cur_index = index = fileio->b.index;
Hans Verkuil88e26872013-12-13 13:13:45 -03002841 buf = &fileio->bufs[index];
2842
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002843 /*
2844 * Get number of bytes filled by the driver
2845 */
Hans Verkuil88e26872013-12-13 13:13:45 -03002846 buf->pos = 0;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002847 buf->queued = 0;
Hans Verkuil88e26872013-12-13 13:13:45 -03002848 buf->size = read ? vb2_get_plane_payload(q->bufs[index], 0)
2849 : vb2_plane_size(q->bufs[index], 0);
2850 } else {
2851 buf = &fileio->bufs[index];
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002852 }
2853
2854 /*
2855 * Limit count on last few bytes of the buffer.
2856 */
2857 if (buf->pos + count > buf->size) {
2858 count = buf->size - buf->pos;
Mauro Carvalho Chehab08b99e22011-01-11 17:12:34 -03002859 dprintk(5, "reducing read count: %zd\n", count);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002860 }
2861
2862 /*
2863 * Transfer data to userspace.
2864 */
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002865 dprintk(3, "copying %zd bytes - buffer %d, offset %u\n",
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002866 count, index, buf->pos);
2867 if (read)
2868 ret = copy_to_user(data, buf->vaddr + buf->pos, count);
2869 else
2870 ret = copy_from_user(buf->vaddr + buf->pos, data, count);
2871 if (ret) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002872 dprintk(3, "error copying data\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002873 return -EFAULT;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002874 }
2875
2876 /*
2877 * Update counters.
2878 */
2879 buf->pos += count;
2880 *ppos += count;
2881
2882 /*
2883 * Queue next buffer if required.
2884 */
2885 if (buf->pos == buf->size ||
2886 (!read && (fileio->flags & VB2_FILEIO_WRITE_IMMEDIATELY))) {
2887 /*
2888 * Check if this is the last buffer to read.
2889 */
2890 if (read && (fileio->flags & VB2_FILEIO_READ_ONCE) &&
2891 fileio->dq_count == 1) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002892 dprintk(3, "read limit reached\n");
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002893 return __vb2_cleanup_fileio(q);
2894 }
2895
2896 /*
2897 * Call vb2_qbuf and give buffer to the driver.
2898 */
2899 memset(&fileio->b, 0, sizeof(fileio->b));
2900 fileio->b.type = q->type;
2901 fileio->b.memory = q->memory;
2902 fileio->b.index = index;
2903 fileio->b.bytesused = buf->pos;
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002904 ret = vb2_internal_qbuf(q, &fileio->b);
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002905 dprintk(5, "vb2_dbuf result: %d\n", ret);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002906 if (ret)
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002907 return ret;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002908
2909 /*
2910 * Buffer has been queued, update the status
2911 */
2912 buf->pos = 0;
2913 buf->queued = 1;
Hans Verkuil88e26872013-12-13 13:13:45 -03002914 buf->size = vb2_plane_size(q->bufs[index], 0);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002915 fileio->q_count += 1;
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002916 /*
2917 * If we are queuing up buffers for the first time, then
2918 * increase initial_index by one.
2919 */
2920 if (fileio->initial_index < q->num_buffers)
2921 fileio->initial_index++;
2922 /*
2923 * The next buffer to use is either a buffer that's going to be
2924 * queued for the first time (initial_index < q->num_buffers)
2925 * or it is equal to q->num_buffers, meaning that the next
2926 * time we need to dequeue a buffer since we've now queued up
2927 * all the 'first time' buffers.
2928 */
2929 fileio->cur_index = fileio->initial_index;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002930 }
2931
2932 /*
2933 * Return proper number of bytes processed.
2934 */
2935 if (ret == 0)
2936 ret = count;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002937 return ret;
2938}
2939
2940size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count,
2941 loff_t *ppos, int nonblocking)
2942{
2943 return __vb2_perform_fileio(q, data, count, ppos, nonblocking, 1);
2944}
2945EXPORT_SYMBOL_GPL(vb2_read);
2946
Ricardo Ribalda819585b2013-08-28 04:39:29 -03002947size_t vb2_write(struct vb2_queue *q, const char __user *data, size_t count,
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002948 loff_t *ppos, int nonblocking)
2949{
Ricardo Ribalda819585b2013-08-28 04:39:29 -03002950 return __vb2_perform_fileio(q, (char __user *) data, count,
2951 ppos, nonblocking, 0);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002952}
2953EXPORT_SYMBOL_GPL(vb2_write);
2954
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03002955
2956/*
2957 * The following functions are not part of the vb2 core API, but are helper
2958 * functions that plug into struct v4l2_ioctl_ops, struct v4l2_file_operations
2959 * and struct vb2_ops.
2960 * They contain boilerplate code that most if not all drivers have to do
2961 * and so they simplify the driver code.
2962 */
2963
2964/* The queue is busy if there is a owner and you are not that owner. */
2965static inline bool vb2_queue_is_busy(struct video_device *vdev, struct file *file)
2966{
2967 return vdev->queue->owner && vdev->queue->owner != file->private_data;
2968}
2969
2970/* vb2 ioctl helpers */
2971
2972int vb2_ioctl_reqbufs(struct file *file, void *priv,
2973 struct v4l2_requestbuffers *p)
2974{
2975 struct video_device *vdev = video_devdata(file);
2976 int res = __verify_memory_type(vdev->queue, p->memory, p->type);
2977
2978 if (res)
2979 return res;
2980 if (vb2_queue_is_busy(vdev, file))
2981 return -EBUSY;
2982 res = __reqbufs(vdev->queue, p);
2983 /* If count == 0, then the owner has released all buffers and he
2984 is no longer owner of the queue. Otherwise we have a new owner. */
2985 if (res == 0)
2986 vdev->queue->owner = p->count ? file->private_data : NULL;
2987 return res;
2988}
2989EXPORT_SYMBOL_GPL(vb2_ioctl_reqbufs);
2990
2991int vb2_ioctl_create_bufs(struct file *file, void *priv,
2992 struct v4l2_create_buffers *p)
2993{
2994 struct video_device *vdev = video_devdata(file);
2995 int res = __verify_memory_type(vdev->queue, p->memory, p->format.type);
2996
2997 p->index = vdev->queue->num_buffers;
2998 /* If count == 0, then just check if memory and type are valid.
2999 Any -EBUSY result from __verify_memory_type can be mapped to 0. */
3000 if (p->count == 0)
3001 return res != -EBUSY ? res : 0;
3002 if (res)
3003 return res;
3004 if (vb2_queue_is_busy(vdev, file))
3005 return -EBUSY;
3006 res = __create_bufs(vdev->queue, p);
3007 if (res == 0)
3008 vdev->queue->owner = file->private_data;
3009 return res;
3010}
3011EXPORT_SYMBOL_GPL(vb2_ioctl_create_bufs);
3012
3013int vb2_ioctl_prepare_buf(struct file *file, void *priv,
3014 struct v4l2_buffer *p)
3015{
3016 struct video_device *vdev = video_devdata(file);
3017
3018 if (vb2_queue_is_busy(vdev, file))
3019 return -EBUSY;
3020 return vb2_prepare_buf(vdev->queue, p);
3021}
3022EXPORT_SYMBOL_GPL(vb2_ioctl_prepare_buf);
3023
3024int vb2_ioctl_querybuf(struct file *file, void *priv, struct v4l2_buffer *p)
3025{
3026 struct video_device *vdev = video_devdata(file);
3027
3028 /* No need to call vb2_queue_is_busy(), anyone can query buffers. */
3029 return vb2_querybuf(vdev->queue, p);
3030}
3031EXPORT_SYMBOL_GPL(vb2_ioctl_querybuf);
3032
3033int vb2_ioctl_qbuf(struct file *file, void *priv, struct v4l2_buffer *p)
3034{
3035 struct video_device *vdev = video_devdata(file);
3036
3037 if (vb2_queue_is_busy(vdev, file))
3038 return -EBUSY;
3039 return vb2_qbuf(vdev->queue, p);
3040}
3041EXPORT_SYMBOL_GPL(vb2_ioctl_qbuf);
3042
3043int vb2_ioctl_dqbuf(struct file *file, void *priv, struct v4l2_buffer *p)
3044{
3045 struct video_device *vdev = video_devdata(file);
3046
3047 if (vb2_queue_is_busy(vdev, file))
3048 return -EBUSY;
3049 return vb2_dqbuf(vdev->queue, p, file->f_flags & O_NONBLOCK);
3050}
3051EXPORT_SYMBOL_GPL(vb2_ioctl_dqbuf);
3052
3053int vb2_ioctl_streamon(struct file *file, void *priv, enum v4l2_buf_type i)
3054{
3055 struct video_device *vdev = video_devdata(file);
3056
3057 if (vb2_queue_is_busy(vdev, file))
3058 return -EBUSY;
3059 return vb2_streamon(vdev->queue, i);
3060}
3061EXPORT_SYMBOL_GPL(vb2_ioctl_streamon);
3062
3063int vb2_ioctl_streamoff(struct file *file, void *priv, enum v4l2_buf_type i)
3064{
3065 struct video_device *vdev = video_devdata(file);
3066
3067 if (vb2_queue_is_busy(vdev, file))
3068 return -EBUSY;
3069 return vb2_streamoff(vdev->queue, i);
3070}
3071EXPORT_SYMBOL_GPL(vb2_ioctl_streamoff);
3072
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03003073int vb2_ioctl_expbuf(struct file *file, void *priv, struct v4l2_exportbuffer *p)
3074{
3075 struct video_device *vdev = video_devdata(file);
3076
3077 if (vb2_queue_is_busy(vdev, file))
3078 return -EBUSY;
3079 return vb2_expbuf(vdev->queue, p);
3080}
3081EXPORT_SYMBOL_GPL(vb2_ioctl_expbuf);
3082
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003083/* v4l2_file_operations helpers */
3084
3085int vb2_fop_mmap(struct file *file, struct vm_area_struct *vma)
3086{
3087 struct video_device *vdev = video_devdata(file);
Laurent Pinchart8a90f1a2013-08-02 13:55:21 -03003088 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
3089 int err;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003090
Laurent Pinchart8a90f1a2013-08-02 13:55:21 -03003091 if (lock && mutex_lock_interruptible(lock))
3092 return -ERESTARTSYS;
3093 err = vb2_mmap(vdev->queue, vma);
3094 if (lock)
3095 mutex_unlock(lock);
3096 return err;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003097}
3098EXPORT_SYMBOL_GPL(vb2_fop_mmap);
3099
Ricardo Ribalda1380f572013-11-25 05:49:02 -03003100int _vb2_fop_release(struct file *file, struct mutex *lock)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003101{
3102 struct video_device *vdev = video_devdata(file);
3103
3104 if (file->private_data == vdev->queue->owner) {
Ricardo Ribalda1380f572013-11-25 05:49:02 -03003105 if (lock)
3106 mutex_lock(lock);
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003107 vb2_queue_release(vdev->queue);
3108 vdev->queue->owner = NULL;
Ricardo Ribalda1380f572013-11-25 05:49:02 -03003109 if (lock)
3110 mutex_unlock(lock);
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003111 }
3112 return v4l2_fh_release(file);
3113}
Ricardo Ribalda1380f572013-11-25 05:49:02 -03003114EXPORT_SYMBOL_GPL(_vb2_fop_release);
3115
3116int vb2_fop_release(struct file *file)
3117{
3118 struct video_device *vdev = video_devdata(file);
3119 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
3120
3121 return _vb2_fop_release(file, lock);
3122}
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003123EXPORT_SYMBOL_GPL(vb2_fop_release);
3124
Ricardo Ribalda819585b2013-08-28 04:39:29 -03003125ssize_t vb2_fop_write(struct file *file, const char __user *buf,
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003126 size_t count, loff_t *ppos)
3127{
3128 struct video_device *vdev = video_devdata(file);
3129 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003130 int err = -EBUSY;
3131
Hans Verkuilcf533732012-07-31 04:02:25 -03003132 if (lock && mutex_lock_interruptible(lock))
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003133 return -ERESTARTSYS;
3134 if (vb2_queue_is_busy(vdev, file))
3135 goto exit;
3136 err = vb2_write(vdev->queue, buf, count, ppos,
3137 file->f_flags & O_NONBLOCK);
Hans Verkuil8c82c752012-09-07 12:50:02 -03003138 if (vdev->queue->fileio)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003139 vdev->queue->owner = file->private_data;
3140exit:
Hans Verkuilcf533732012-07-31 04:02:25 -03003141 if (lock)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003142 mutex_unlock(lock);
3143 return err;
3144}
3145EXPORT_SYMBOL_GPL(vb2_fop_write);
3146
3147ssize_t vb2_fop_read(struct file *file, char __user *buf,
3148 size_t count, loff_t *ppos)
3149{
3150 struct video_device *vdev = video_devdata(file);
3151 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003152 int err = -EBUSY;
3153
Hans Verkuilcf533732012-07-31 04:02:25 -03003154 if (lock && mutex_lock_interruptible(lock))
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003155 return -ERESTARTSYS;
3156 if (vb2_queue_is_busy(vdev, file))
3157 goto exit;
3158 err = vb2_read(vdev->queue, buf, count, ppos,
3159 file->f_flags & O_NONBLOCK);
Hans Verkuil8c82c752012-09-07 12:50:02 -03003160 if (vdev->queue->fileio)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003161 vdev->queue->owner = file->private_data;
3162exit:
Hans Verkuilcf533732012-07-31 04:02:25 -03003163 if (lock)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003164 mutex_unlock(lock);
3165 return err;
3166}
3167EXPORT_SYMBOL_GPL(vb2_fop_read);
3168
3169unsigned int vb2_fop_poll(struct file *file, poll_table *wait)
3170{
3171 struct video_device *vdev = video_devdata(file);
3172 struct vb2_queue *q = vdev->queue;
3173 struct mutex *lock = q->lock ? q->lock : vdev->lock;
3174 unsigned long req_events = poll_requested_events(wait);
3175 unsigned res;
3176 void *fileio;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003177 bool must_lock = false;
3178
3179 /* Try to be smart: only lock if polling might start fileio,
3180 otherwise locking will only introduce unwanted delays. */
3181 if (q->num_buffers == 0 && q->fileio == NULL) {
3182 if (!V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_READ) &&
3183 (req_events & (POLLIN | POLLRDNORM)))
3184 must_lock = true;
3185 else if (V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_WRITE) &&
3186 (req_events & (POLLOUT | POLLWRNORM)))
3187 must_lock = true;
3188 }
3189
3190 /* If locking is needed, but this helper doesn't know how, then you
3191 shouldn't be using this helper but you should write your own. */
Hans Verkuilcf533732012-07-31 04:02:25 -03003192 WARN_ON(must_lock && !lock);
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003193
Hans Verkuilcf533732012-07-31 04:02:25 -03003194 if (must_lock && lock && mutex_lock_interruptible(lock))
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003195 return POLLERR;
3196
3197 fileio = q->fileio;
3198
3199 res = vb2_poll(vdev->queue, file, wait);
3200
3201 /* If fileio was started, then we have a new queue owner. */
3202 if (must_lock && !fileio && q->fileio)
3203 q->owner = file->private_data;
Hans Verkuilcf533732012-07-31 04:02:25 -03003204 if (must_lock && lock)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003205 mutex_unlock(lock);
3206 return res;
3207}
3208EXPORT_SYMBOL_GPL(vb2_fop_poll);
3209
3210#ifndef CONFIG_MMU
3211unsigned long vb2_fop_get_unmapped_area(struct file *file, unsigned long addr,
3212 unsigned long len, unsigned long pgoff, unsigned long flags)
3213{
3214 struct video_device *vdev = video_devdata(file);
Laurent Pinchart8a90f1a2013-08-02 13:55:21 -03003215 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
3216 int ret;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003217
Laurent Pinchart8a90f1a2013-08-02 13:55:21 -03003218 if (lock && mutex_lock_interruptible(lock))
3219 return -ERESTARTSYS;
3220 ret = vb2_get_unmapped_area(vdev->queue, addr, len, pgoff, flags);
3221 if (lock)
3222 mutex_unlock(lock);
3223 return ret;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003224}
3225EXPORT_SYMBOL_GPL(vb2_fop_get_unmapped_area);
3226#endif
3227
3228/* vb2_ops helpers. Only use if vq->lock is non-NULL. */
3229
3230void vb2_ops_wait_prepare(struct vb2_queue *vq)
3231{
3232 mutex_unlock(vq->lock);
3233}
3234EXPORT_SYMBOL_GPL(vb2_ops_wait_prepare);
3235
3236void vb2_ops_wait_finish(struct vb2_queue *vq)
3237{
3238 mutex_lock(vq->lock);
3239}
3240EXPORT_SYMBOL_GPL(vb2_ops_wait_finish);
3241
Pawel Osciake23ccc02010-10-11 10:56:41 -03003242MODULE_DESCRIPTION("Driver helper framework for Video for Linux 2");
Pawel Osciak95072082011-03-13 15:23:32 -03003243MODULE_AUTHOR("Pawel Osciak <pawel@osciak.com>, Marek Szyprowski");
Pawel Osciake23ccc02010-10-11 10:56:41 -03003244MODULE_LICENSE("GPL");