blob: b20e0fbc762a9d26b6a1103aa116f41cbbd2c4df [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
30#define dprintk(level, fmt, arg...) \
31 do { \
32 if (debug >= level) \
33 printk(KERN_DEBUG "vb2: " fmt, ## arg); \
34 } 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) {
447 dprintk(1, "reqbufs: preparing buffers, cannot free\n");
448 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) {
732 dprintk(1, "querybuf: wrong buffer type\n");
733 return -EINVAL;
734 }
735
736 if (b->index >= q->num_buffers) {
737 dprintk(1, "querybuf: buffer index out of range\n");
738 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 Verkuil37d9ed92012-06-27 17:10:30 -0300797 dprintk(1, "reqbufs: unsupported memory type\n");
798 return -EINVAL;
799 }
800
801 if (type != q->type) {
802 dprintk(1, "reqbufs: requested type is incorrect\n");
803 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)) {
811 dprintk(1, "reqbufs: MMAP for current setup unsupported\n");
812 return -EINVAL;
813 }
814
815 if (memory == V4L2_MEMORY_USERPTR && __verify_userptr_ops(q)) {
816 dprintk(1, "reqbufs: USERPTR for current setup unsupported\n");
817 return -EINVAL;
818 }
819
Sumit Semwalc5384042012-06-14 10:37:37 -0300820 if (memory == V4L2_MEMORY_DMABUF && __verify_dmabuf_ops(q)) {
821 dprintk(1, "reqbufs: DMABUF for current setup unsupported\n");
822 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) {
831 dprintk(1, "reqbufs: file io in progress\n");
832 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) {
866 dprintk(1, "reqbufs: streaming active\n");
867 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)) {
876 dprintk(1, "reqbufs: memory in use, cannot free\n");
877 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) {
1003 dprintk(1, "%s(): maximum number of buffers already allocated\n",
1004 __func__);
1005 return -ENOBUFS;
1006 }
1007
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001008 if (!q->num_buffers) {
1009 memset(q->plane_sizes, 0, sizeof(q->plane_sizes));
1010 memset(q->alloc_ctx, 0, sizeof(q->alloc_ctx));
1011 q->memory = create->memory;
1012 }
1013
1014 num_buffers = min(create->count, VIDEO_MAX_FRAME - q->num_buffers);
1015
1016 /*
1017 * Ask the driver, whether the requested number of buffers, planes per
1018 * buffer and their sizes are acceptable
1019 */
1020 ret = call_qop(q, queue_setup, q, &create->format, &num_buffers,
1021 &num_planes, q->plane_sizes, q->alloc_ctx);
Hans Verkuila1d36d82014-03-17 09:54:21 -03001022 if (ret)
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001023 return ret;
1024
1025 /* Finally, allocate buffers and video memory */
Hans Verkuila7afcac2014-02-24 13:41:20 -03001026 allocated_buffers = __vb2_queue_alloc(q, create->memory, num_buffers,
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001027 num_planes);
Hans Verkuila7afcac2014-02-24 13:41:20 -03001028 if (allocated_buffers == 0) {
Hans Verkuilf05393d22012-06-22 05:44:14 -03001029 dprintk(1, "Memory allocation failed\n");
1030 return -ENOMEM;
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001031 }
1032
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001033 /*
1034 * Check if driver can handle the so far allocated number of buffers.
1035 */
Hans Verkuila7afcac2014-02-24 13:41:20 -03001036 if (allocated_buffers < num_buffers) {
1037 num_buffers = allocated_buffers;
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001038
1039 /*
1040 * q->num_buffers contains the total number of buffers, that the
1041 * queue driver has set up
1042 */
1043 ret = call_qop(q, queue_setup, q, &create->format, &num_buffers,
1044 &num_planes, q->plane_sizes, q->alloc_ctx);
1045
1046 if (!ret && allocated_buffers < num_buffers)
1047 ret = -ENOMEM;
1048
1049 /*
1050 * Either the driver has accepted a smaller number of buffers,
1051 * or .queue_setup() returned an error
1052 */
1053 }
1054
1055 q->num_buffers += allocated_buffers;
1056
1057 if (ret < 0) {
Hans Verkuila7afcac2014-02-24 13:41:20 -03001058 /*
1059 * Note: __vb2_queue_free() will subtract 'allocated_buffers'
1060 * from q->num_buffers.
1061 */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001062 __vb2_queue_free(q, allocated_buffers);
Hans Verkuilf05393d22012-06-22 05:44:14 -03001063 return -ENOMEM;
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001064 }
1065
1066 /*
1067 * Return the number of successfully allocated buffers
1068 * to the userspace.
1069 */
1070 create->count = allocated_buffers;
1071
1072 return 0;
1073}
Hans Verkuil37d9ed92012-06-27 17:10:30 -03001074
1075/**
Nicolas THERY53aa3b12012-07-20 09:25:37 -03001076 * vb2_create_bufs() - Wrapper for __create_bufs() that also verifies the
1077 * memory and type values.
Hans Verkuil37d9ed92012-06-27 17:10:30 -03001078 * @q: videobuf2 queue
1079 * @create: creation parameters, passed from userspace to vidioc_create_bufs
1080 * handler in driver
1081 */
1082int vb2_create_bufs(struct vb2_queue *q, struct v4l2_create_buffers *create)
1083{
1084 int ret = __verify_memory_type(q, create->memory, create->format.type);
1085
1086 create->index = q->num_buffers;
Hans Verkuilf05393d22012-06-22 05:44:14 -03001087 if (create->count == 0)
1088 return ret != -EBUSY ? ret : 0;
Hans Verkuil37d9ed92012-06-27 17:10:30 -03001089 return ret ? ret : __create_bufs(q, create);
1090}
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001091EXPORT_SYMBOL_GPL(vb2_create_bufs);
1092
1093/**
Pawel Osciake23ccc02010-10-11 10:56:41 -03001094 * vb2_plane_vaddr() - Return a kernel virtual address of a given plane
1095 * @vb: vb2_buffer to which the plane in question belongs to
1096 * @plane_no: plane number for which the address is to be returned
1097 *
1098 * This function returns a kernel virtual address of a given plane if
1099 * such a mapping exist, NULL otherwise.
1100 */
1101void *vb2_plane_vaddr(struct vb2_buffer *vb, unsigned int plane_no)
1102{
Marek Szyprowskia00d0262011-12-15 05:53:06 -03001103 if (plane_no > vb->num_planes || !vb->planes[plane_no].mem_priv)
Pawel Osciake23ccc02010-10-11 10:56:41 -03001104 return NULL;
1105
Hans Verkuila1d36d82014-03-17 09:54:21 -03001106 return call_ptr_memop(vb, vaddr, vb->planes[plane_no].mem_priv);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001107
1108}
1109EXPORT_SYMBOL_GPL(vb2_plane_vaddr);
1110
1111/**
1112 * vb2_plane_cookie() - Return allocator specific cookie for the given plane
1113 * @vb: vb2_buffer to which the plane in question belongs to
1114 * @plane_no: plane number for which the cookie is to be returned
1115 *
1116 * This function returns an allocator specific cookie for a given plane if
1117 * available, NULL otherwise. The allocator should provide some simple static
1118 * inline function, which would convert this cookie to the allocator specific
1119 * type that can be used directly by the driver to access the buffer. This can
1120 * be for example physical address, pointer to scatter list or IOMMU mapping.
1121 */
1122void *vb2_plane_cookie(struct vb2_buffer *vb, unsigned int plane_no)
1123{
Marek Szyprowskia00d0262011-12-15 05:53:06 -03001124 if (plane_no > vb->num_planes || !vb->planes[plane_no].mem_priv)
Pawel Osciake23ccc02010-10-11 10:56:41 -03001125 return NULL;
1126
Hans Verkuila1d36d82014-03-17 09:54:21 -03001127 return call_ptr_memop(vb, cookie, vb->planes[plane_no].mem_priv);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001128}
1129EXPORT_SYMBOL_GPL(vb2_plane_cookie);
1130
1131/**
1132 * vb2_buffer_done() - inform videobuf that an operation on a buffer is finished
1133 * @vb: vb2_buffer returned from the driver
1134 * @state: either VB2_BUF_STATE_DONE if the operation finished successfully
Hans Verkuilb3379c62014-02-24 13:51:03 -03001135 * or VB2_BUF_STATE_ERROR if the operation finished with an error.
1136 * If start_streaming fails then it should return buffers with state
1137 * VB2_BUF_STATE_QUEUED to put them back into the queue.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001138 *
1139 * This function should be called by the driver after a hardware operation on
1140 * a buffer is finished and the buffer may be returned to userspace. The driver
1141 * cannot use this buffer anymore until it is queued back to it by videobuf
1142 * by the means of buf_queue callback. Only buffers previously queued to the
1143 * driver by buf_queue can be passed to this function.
Hans Verkuilb3379c62014-02-24 13:51:03 -03001144 *
1145 * While streaming a buffer can only be returned in state DONE or ERROR.
1146 * The start_streaming op can also return them in case the DMA engine cannot
1147 * be started for some reason. In that case the buffers should be returned with
1148 * state QUEUED.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001149 */
1150void vb2_buffer_done(struct vb2_buffer *vb, enum vb2_buffer_state state)
1151{
1152 struct vb2_queue *q = vb->vb2_queue;
1153 unsigned long flags;
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -03001154 unsigned int plane;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001155
Hans Verkuilb3379c62014-02-24 13:51:03 -03001156 if (WARN_ON(vb->state != VB2_BUF_STATE_ACTIVE))
Pawel Osciake23ccc02010-10-11 10:56:41 -03001157 return;
1158
Hans Verkuilb3379c62014-02-24 13:51:03 -03001159 if (!q->start_streaming_called) {
1160 if (WARN_ON(state != VB2_BUF_STATE_QUEUED))
1161 state = VB2_BUF_STATE_QUEUED;
1162 } else if (!WARN_ON(!q->start_streaming_called)) {
1163 if (WARN_ON(state != VB2_BUF_STATE_DONE &&
1164 state != VB2_BUF_STATE_ERROR))
1165 state = VB2_BUF_STATE_ERROR;
1166 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001167
Hans Verkuilb5b45412014-01-29 11:53:25 -03001168#ifdef CONFIG_VIDEO_ADV_DEBUG
1169 /*
1170 * Although this is not a callback, it still does have to balance
1171 * with the buf_queue op. So update this counter manually.
1172 */
1173 vb->cnt_buf_done++;
1174#endif
Pawel Osciake23ccc02010-10-11 10:56:41 -03001175 dprintk(4, "Done processing on buffer %d, state: %d\n",
Tushar Behera9b6f5dc2012-11-12 04:01:29 -03001176 vb->v4l2_buf.index, state);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001177
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -03001178 /* sync buffers */
1179 for (plane = 0; plane < vb->num_planes; ++plane)
Hans Verkuila1d36d82014-03-17 09:54:21 -03001180 call_void_memop(vb, finish, vb->planes[plane].mem_priv);
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -03001181
Pawel Osciake23ccc02010-10-11 10:56:41 -03001182 /* Add the buffer to the done buffers list */
1183 spin_lock_irqsave(&q->done_lock, flags);
1184 vb->state = state;
Hans Verkuilb3379c62014-02-24 13:51:03 -03001185 if (state != VB2_BUF_STATE_QUEUED)
1186 list_add_tail(&vb->done_entry, &q->done_list);
Hans Verkuil6ea3b982014-02-06 05:46:11 -03001187 atomic_dec(&q->owned_by_drv_count);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001188 spin_unlock_irqrestore(&q->done_lock, flags);
1189
Hans Verkuilb3379c62014-02-24 13:51:03 -03001190 if (state == VB2_BUF_STATE_QUEUED)
1191 return;
1192
Pawel Osciake23ccc02010-10-11 10:56:41 -03001193 /* Inform any processes that may be waiting for buffers */
1194 wake_up(&q->done_wq);
1195}
1196EXPORT_SYMBOL_GPL(vb2_buffer_done);
1197
1198/**
Hans Verkuil32a77262012-09-28 06:12:53 -03001199 * __fill_vb2_buffer() - fill a vb2_buffer with information provided in a
1200 * v4l2_buffer by the userspace. The caller has already verified that struct
1201 * v4l2_buffer has a valid number of planes.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001202 */
Hans Verkuil32a77262012-09-28 06:12:53 -03001203static void __fill_vb2_buffer(struct vb2_buffer *vb, const struct v4l2_buffer *b,
Pawel Osciake23ccc02010-10-11 10:56:41 -03001204 struct v4l2_plane *v4l2_planes)
1205{
1206 unsigned int plane;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001207
1208 if (V4L2_TYPE_IS_MULTIPLANAR(b->type)) {
Pawel Osciake23ccc02010-10-11 10:56:41 -03001209 /* Fill in driver-provided information for OUTPUT types */
1210 if (V4L2_TYPE_IS_OUTPUT(b->type)) {
1211 /*
1212 * Will have to go up to b->length when API starts
1213 * accepting variable number of planes.
1214 */
1215 for (plane = 0; plane < vb->num_planes; ++plane) {
1216 v4l2_planes[plane].bytesused =
1217 b->m.planes[plane].bytesused;
1218 v4l2_planes[plane].data_offset =
1219 b->m.planes[plane].data_offset;
1220 }
1221 }
1222
1223 if (b->memory == V4L2_MEMORY_USERPTR) {
1224 for (plane = 0; plane < vb->num_planes; ++plane) {
1225 v4l2_planes[plane].m.userptr =
1226 b->m.planes[plane].m.userptr;
1227 v4l2_planes[plane].length =
1228 b->m.planes[plane].length;
1229 }
1230 }
Sumit Semwalc5384042012-06-14 10:37:37 -03001231 if (b->memory == V4L2_MEMORY_DMABUF) {
1232 for (plane = 0; plane < vb->num_planes; ++plane) {
1233 v4l2_planes[plane].m.fd =
1234 b->m.planes[plane].m.fd;
1235 v4l2_planes[plane].length =
1236 b->m.planes[plane].length;
Sumit Semwalc5384042012-06-14 10:37:37 -03001237 }
1238 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001239 } else {
1240 /*
1241 * Single-planar buffers do not use planes array,
1242 * so fill in relevant v4l2_buffer struct fields instead.
1243 * In videobuf we use our internal V4l2_planes struct for
1244 * single-planar buffers as well, for simplicity.
1245 */
Hans Verkuil412376a2014-04-07 08:44:56 -03001246 if (V4L2_TYPE_IS_OUTPUT(b->type))
Pawel Osciake23ccc02010-10-11 10:56:41 -03001247 v4l2_planes[0].bytesused = b->bytesused;
1248
1249 if (b->memory == V4L2_MEMORY_USERPTR) {
1250 v4l2_planes[0].m.userptr = b->m.userptr;
1251 v4l2_planes[0].length = b->length;
1252 }
Sumit Semwalc5384042012-06-14 10:37:37 -03001253
1254 if (b->memory == V4L2_MEMORY_DMABUF) {
1255 v4l2_planes[0].m.fd = b->m.fd;
1256 v4l2_planes[0].length = b->length;
Sumit Semwalc5384042012-06-14 10:37:37 -03001257 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001258 }
1259
Hans Verkuilf1343282014-02-24 14:44:50 -03001260 /* Zero flags that the vb2 core handles */
Sakari Ailus1b18e7a2012-10-22 17:10:16 -03001261 vb->v4l2_buf.flags = b->flags & ~V4L2_BUFFER_MASK_FLAGS;
Sakari Ailus7ce6fd82014-02-25 19:08:52 -03001262 if ((vb->vb2_queue->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) !=
1263 V4L2_BUF_FLAG_TIMESTAMP_COPY || !V4L2_TYPE_IS_OUTPUT(b->type)) {
1264 /*
1265 * Non-COPY timestamps and non-OUTPUT queues will get
1266 * their timestamp and timestamp source flags from the
1267 * queue.
1268 */
1269 vb->v4l2_buf.flags &= ~V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
1270 }
1271
Hans Verkuilf1343282014-02-24 14:44:50 -03001272 if (V4L2_TYPE_IS_OUTPUT(b->type)) {
1273 /*
1274 * For output buffers mask out the timecode flag:
1275 * this will be handled later in vb2_internal_qbuf().
1276 * The 'field' is valid metadata for this output buffer
1277 * and so that needs to be copied here.
1278 */
1279 vb->v4l2_buf.flags &= ~V4L2_BUF_FLAG_TIMECODE;
1280 vb->v4l2_buf.field = b->field;
1281 } else {
1282 /* Zero any output buffer flags as this is a capture buffer */
1283 vb->v4l2_buf.flags &= ~V4L2_BUFFER_OUT_FLAGS;
1284 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001285}
1286
1287/**
1288 * __qbuf_userptr() - handle qbuf of a USERPTR buffer
1289 */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001290static int __qbuf_userptr(struct vb2_buffer *vb, const struct v4l2_buffer *b)
Pawel Osciake23ccc02010-10-11 10:56:41 -03001291{
1292 struct v4l2_plane planes[VIDEO_MAX_PLANES];
1293 struct vb2_queue *q = vb->vb2_queue;
1294 void *mem_priv;
1295 unsigned int plane;
1296 int ret;
1297 int write = !V4L2_TYPE_IS_OUTPUT(q->type);
Hans Verkuil256f3162014-01-29 13:36:53 -03001298 bool reacquired = vb->planes[0].mem_priv == NULL;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001299
Hans Verkuil412376a2014-04-07 08:44:56 -03001300 memset(planes, 0, sizeof(planes[0]) * vb->num_planes);
Hans Verkuil32a77262012-09-28 06:12:53 -03001301 /* Copy relevant information provided by the userspace */
1302 __fill_vb2_buffer(vb, b, planes);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001303
1304 for (plane = 0; plane < vb->num_planes; ++plane) {
1305 /* Skip the plane if already verified */
Marek Szyprowskif0b7c7f2011-11-16 15:09:40 -03001306 if (vb->v4l2_planes[plane].m.userptr &&
1307 vb->v4l2_planes[plane].m.userptr == planes[plane].m.userptr
Pawel Osciake23ccc02010-10-11 10:56:41 -03001308 && vb->v4l2_planes[plane].length == planes[plane].length)
1309 continue;
1310
1311 dprintk(3, "qbuf: userspace address for plane %d changed, "
1312 "reacquiring memory\n", plane);
1313
Marek Szyprowskic1426bc2011-08-24 06:36:26 -03001314 /* Check if the provided plane buffer is large enough */
1315 if (planes[plane].length < q->plane_sizes[plane]) {
Seung-Woo Kim2484a7e2013-08-20 04:48:06 -03001316 dprintk(1, "qbuf: provided buffer size %u is less than "
1317 "setup size %u for plane %d\n",
1318 planes[plane].length,
1319 q->plane_sizes[plane], plane);
Marek Szyprowski4c2625d2011-10-03 03:21:45 -03001320 ret = -EINVAL;
Marek Szyprowskic1426bc2011-08-24 06:36:26 -03001321 goto err;
1322 }
1323
Pawel Osciake23ccc02010-10-11 10:56:41 -03001324 /* Release previously acquired memory if present */
Hans Verkuil256f3162014-01-29 13:36:53 -03001325 if (vb->planes[plane].mem_priv) {
1326 if (!reacquired) {
1327 reacquired = true;
Hans Verkuila1d36d82014-03-17 09:54:21 -03001328 call_void_vb_qop(vb, buf_cleanup, vb);
Hans Verkuil256f3162014-01-29 13:36:53 -03001329 }
Hans Verkuila1d36d82014-03-17 09:54:21 -03001330 call_void_memop(vb, put_userptr, vb->planes[plane].mem_priv);
Hans Verkuil256f3162014-01-29 13:36:53 -03001331 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001332
1333 vb->planes[plane].mem_priv = NULL;
Hans Verkuil256f3162014-01-29 13:36:53 -03001334 memset(&vb->v4l2_planes[plane], 0, sizeof(struct v4l2_plane));
Pawel Osciake23ccc02010-10-11 10:56:41 -03001335
1336 /* Acquire each plane's memory */
Hans Verkuila1d36d82014-03-17 09:54:21 -03001337 mem_priv = call_ptr_memop(vb, get_userptr, q->alloc_ctx[plane],
Marek Szyprowskia00d0262011-12-15 05:53:06 -03001338 planes[plane].m.userptr,
1339 planes[plane].length, write);
1340 if (IS_ERR_OR_NULL(mem_priv)) {
1341 dprintk(1, "qbuf: failed acquiring userspace "
Pawel Osciake23ccc02010-10-11 10:56:41 -03001342 "memory for plane %d\n", plane);
Marek Szyprowskia00d0262011-12-15 05:53:06 -03001343 ret = mem_priv ? PTR_ERR(mem_priv) : -EINVAL;
1344 goto err;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001345 }
Marek Szyprowskia00d0262011-12-15 05:53:06 -03001346 vb->planes[plane].mem_priv = mem_priv;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001347 }
1348
1349 /*
Pawel Osciake23ccc02010-10-11 10:56:41 -03001350 * Now that everything is in order, copy relevant information
1351 * provided by userspace.
1352 */
1353 for (plane = 0; plane < vb->num_planes; ++plane)
1354 vb->v4l2_planes[plane] = planes[plane];
1355
Hans Verkuil256f3162014-01-29 13:36:53 -03001356 if (reacquired) {
1357 /*
1358 * One or more planes changed, so we must call buf_init to do
1359 * the driver-specific initialization on the newly acquired
1360 * buffer, if provided.
1361 */
1362 ret = call_vb_qop(vb, buf_init, vb);
1363 if (ret) {
1364 dprintk(1, "qbuf: buffer initialization failed\n");
Hans Verkuil256f3162014-01-29 13:36:53 -03001365 goto err;
1366 }
1367 }
1368
1369 ret = call_vb_qop(vb, buf_prepare, vb);
1370 if (ret) {
1371 dprintk(1, "qbuf: buffer preparation failed\n");
Hans Verkuila1d36d82014-03-17 09:54:21 -03001372 call_void_vb_qop(vb, buf_cleanup, vb);
Hans Verkuil256f3162014-01-29 13:36:53 -03001373 goto err;
1374 }
1375
Pawel Osciake23ccc02010-10-11 10:56:41 -03001376 return 0;
1377err:
1378 /* In case of errors, release planes that were already acquired */
Marek Szyprowskic1426bc2011-08-24 06:36:26 -03001379 for (plane = 0; plane < vb->num_planes; ++plane) {
1380 if (vb->planes[plane].mem_priv)
Hans Verkuila1d36d82014-03-17 09:54:21 -03001381 call_void_memop(vb, put_userptr, vb->planes[plane].mem_priv);
Marek Szyprowskic1426bc2011-08-24 06:36:26 -03001382 vb->planes[plane].mem_priv = NULL;
1383 vb->v4l2_planes[plane].m.userptr = 0;
1384 vb->v4l2_planes[plane].length = 0;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001385 }
1386
1387 return ret;
1388}
1389
1390/**
1391 * __qbuf_mmap() - handle qbuf of an MMAP buffer
1392 */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001393static int __qbuf_mmap(struct vb2_buffer *vb, const struct v4l2_buffer *b)
Pawel Osciake23ccc02010-10-11 10:56:41 -03001394{
Hans Verkuil32a77262012-09-28 06:12:53 -03001395 __fill_vb2_buffer(vb, b, vb->v4l2_planes);
Hans Verkuila1d36d82014-03-17 09:54:21 -03001396 return call_vb_qop(vb, buf_prepare, vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001397}
1398
1399/**
Sumit Semwalc5384042012-06-14 10:37:37 -03001400 * __qbuf_dmabuf() - handle qbuf of a DMABUF buffer
1401 */
1402static int __qbuf_dmabuf(struct vb2_buffer *vb, const struct v4l2_buffer *b)
1403{
1404 struct v4l2_plane planes[VIDEO_MAX_PLANES];
1405 struct vb2_queue *q = vb->vb2_queue;
1406 void *mem_priv;
1407 unsigned int plane;
1408 int ret;
1409 int write = !V4L2_TYPE_IS_OUTPUT(q->type);
Hans Verkuil256f3162014-01-29 13:36:53 -03001410 bool reacquired = vb->planes[0].mem_priv == NULL;
Sumit Semwalc5384042012-06-14 10:37:37 -03001411
Hans Verkuil412376a2014-04-07 08:44:56 -03001412 memset(planes, 0, sizeof(planes[0]) * vb->num_planes);
Laurent Pinchart6f546c52014-01-01 09:10:48 -03001413 /* Copy relevant information provided by the userspace */
Sumit Semwalc5384042012-06-14 10:37:37 -03001414 __fill_vb2_buffer(vb, b, planes);
1415
1416 for (plane = 0; plane < vb->num_planes; ++plane) {
1417 struct dma_buf *dbuf = dma_buf_get(planes[plane].m.fd);
1418
1419 if (IS_ERR_OR_NULL(dbuf)) {
1420 dprintk(1, "qbuf: invalid dmabuf fd for plane %d\n",
1421 plane);
1422 ret = -EINVAL;
1423 goto err;
1424 }
1425
1426 /* use DMABUF size if length is not provided */
1427 if (planes[plane].length == 0)
1428 planes[plane].length = dbuf->size;
1429
Hans Verkuil412376a2014-04-07 08:44:56 -03001430 if (planes[plane].length < q->plane_sizes[plane]) {
Seung-Woo Kim77c07822013-11-29 04:50:29 -03001431 dprintk(1, "qbuf: invalid dmabuf length for plane %d\n",
1432 plane);
Sumit Semwalc5384042012-06-14 10:37:37 -03001433 ret = -EINVAL;
1434 goto err;
1435 }
1436
1437 /* Skip the plane if already verified */
1438 if (dbuf == vb->planes[plane].dbuf &&
1439 vb->v4l2_planes[plane].length == planes[plane].length) {
1440 dma_buf_put(dbuf);
1441 continue;
1442 }
1443
1444 dprintk(1, "qbuf: buffer for plane %d changed\n", plane);
1445
Hans Verkuil256f3162014-01-29 13:36:53 -03001446 if (!reacquired) {
1447 reacquired = true;
Hans Verkuila1d36d82014-03-17 09:54:21 -03001448 call_void_vb_qop(vb, buf_cleanup, vb);
Hans Verkuil256f3162014-01-29 13:36:53 -03001449 }
1450
Sumit Semwalc5384042012-06-14 10:37:37 -03001451 /* Release previously acquired memory if present */
Hans Verkuilb5b45412014-01-29 11:53:25 -03001452 __vb2_plane_dmabuf_put(vb, &vb->planes[plane]);
Sumit Semwalc5384042012-06-14 10:37:37 -03001453 memset(&vb->v4l2_planes[plane], 0, sizeof(struct v4l2_plane));
1454
1455 /* Acquire each plane's memory */
Hans Verkuila1d36d82014-03-17 09:54:21 -03001456 mem_priv = call_ptr_memop(vb, attach_dmabuf, q->alloc_ctx[plane],
Sumit Semwalc5384042012-06-14 10:37:37 -03001457 dbuf, planes[plane].length, write);
1458 if (IS_ERR(mem_priv)) {
1459 dprintk(1, "qbuf: failed to attach dmabuf\n");
1460 ret = PTR_ERR(mem_priv);
1461 dma_buf_put(dbuf);
1462 goto err;
1463 }
1464
1465 vb->planes[plane].dbuf = dbuf;
1466 vb->planes[plane].mem_priv = mem_priv;
1467 }
1468
1469 /* TODO: This pins the buffer(s) with dma_buf_map_attachment()).. but
1470 * really we want to do this just before the DMA, not while queueing
1471 * the buffer(s)..
1472 */
1473 for (plane = 0; plane < vb->num_planes; ++plane) {
Hans Verkuilb5b45412014-01-29 11:53:25 -03001474 ret = call_memop(vb, map_dmabuf, vb->planes[plane].mem_priv);
Sumit Semwalc5384042012-06-14 10:37:37 -03001475 if (ret) {
1476 dprintk(1, "qbuf: failed to map dmabuf for plane %d\n",
1477 plane);
1478 goto err;
1479 }
1480 vb->planes[plane].dbuf_mapped = 1;
1481 }
1482
1483 /*
Sumit Semwalc5384042012-06-14 10:37:37 -03001484 * Now that everything is in order, copy relevant information
1485 * provided by userspace.
1486 */
1487 for (plane = 0; plane < vb->num_planes; ++plane)
1488 vb->v4l2_planes[plane] = planes[plane];
1489
Hans Verkuil256f3162014-01-29 13:36:53 -03001490 if (reacquired) {
1491 /*
1492 * Call driver-specific initialization on the newly acquired buffer,
1493 * if provided.
1494 */
1495 ret = call_vb_qop(vb, buf_init, vb);
1496 if (ret) {
1497 dprintk(1, "qbuf: buffer initialization failed\n");
Hans Verkuil256f3162014-01-29 13:36:53 -03001498 goto err;
1499 }
1500 }
1501
1502 ret = call_vb_qop(vb, buf_prepare, vb);
1503 if (ret) {
1504 dprintk(1, "qbuf: buffer preparation failed\n");
Hans Verkuila1d36d82014-03-17 09:54:21 -03001505 call_void_vb_qop(vb, buf_cleanup, vb);
Hans Verkuil256f3162014-01-29 13:36:53 -03001506 goto err;
1507 }
1508
Sumit Semwalc5384042012-06-14 10:37:37 -03001509 return 0;
1510err:
1511 /* In case of errors, release planes that were already acquired */
1512 __vb2_buf_dmabuf_put(vb);
1513
1514 return ret;
1515}
1516
1517/**
Pawel Osciake23ccc02010-10-11 10:56:41 -03001518 * __enqueue_in_driver() - enqueue a vb2_buffer in driver for processing
1519 */
1520static void __enqueue_in_driver(struct vb2_buffer *vb)
1521{
1522 struct vb2_queue *q = vb->vb2_queue;
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -03001523 unsigned int plane;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001524
1525 vb->state = VB2_BUF_STATE_ACTIVE;
Hans Verkuil6ea3b982014-02-06 05:46:11 -03001526 atomic_inc(&q->owned_by_drv_count);
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -03001527
1528 /* sync buffers */
1529 for (plane = 0; plane < vb->num_planes; ++plane)
Hans Verkuila1d36d82014-03-17 09:54:21 -03001530 call_void_memop(vb, prepare, vb->planes[plane].mem_priv);
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -03001531
Hans Verkuila1d36d82014-03-17 09:54:21 -03001532 call_void_vb_qop(vb, buf_queue, vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001533}
1534
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001535static int __buf_prepare(struct vb2_buffer *vb, const struct v4l2_buffer *b)
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001536{
1537 struct vb2_queue *q = vb->vb2_queue;
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001538 struct rw_semaphore *mmap_sem;
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001539 int ret;
1540
Laurent Pinchart8023ed02012-07-10 10:41:40 -03001541 ret = __verify_length(vb, b);
Sylwester Nawrocki3a9621b2013-08-26 11:47:53 -03001542 if (ret < 0) {
1543 dprintk(1, "%s(): plane parameters verification failed: %d\n",
1544 __func__, ret);
Laurent Pinchart8023ed02012-07-10 10:41:40 -03001545 return ret;
Sylwester Nawrocki3a9621b2013-08-26 11:47:53 -03001546 }
Laurent Pinchart8023ed02012-07-10 10:41:40 -03001547
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001548 vb->state = VB2_BUF_STATE_PREPARING;
Hans Verkuilf1343282014-02-24 14:44:50 -03001549 vb->v4l2_buf.timestamp.tv_sec = 0;
1550 vb->v4l2_buf.timestamp.tv_usec = 0;
1551 vb->v4l2_buf.sequence = 0;
1552
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001553 switch (q->memory) {
1554 case V4L2_MEMORY_MMAP:
1555 ret = __qbuf_mmap(vb, b);
1556 break;
1557 case V4L2_MEMORY_USERPTR:
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001558 /*
Mauro Carvalho Chehabf103b5d2014-01-07 07:03:09 -02001559 * In case of user pointer buffers vb2 allocators need to get
1560 * direct access to userspace pages. This requires getting
1561 * the mmap semaphore for read access in the current process
1562 * structure. The same semaphore is taken before calling mmap
1563 * operation, while both qbuf/prepare_buf and mmap are called
1564 * by the driver or v4l2 core with the driver's lock held.
1565 * To avoid an AB-BA deadlock (mmap_sem then driver's lock in
1566 * mmap and driver's lock then mmap_sem in qbuf/prepare_buf),
1567 * the videobuf2 core releases the driver's lock, takes
1568 * mmap_sem and then takes the driver's lock again.
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001569 */
1570 mmap_sem = &current->mm->mmap_sem;
Hans Verkuila1d36d82014-03-17 09:54:21 -03001571 call_void_qop(q, wait_prepare, q);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001572 down_read(mmap_sem);
Hans Verkuila1d36d82014-03-17 09:54:21 -03001573 call_void_qop(q, wait_finish, q);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001574
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001575 ret = __qbuf_userptr(vb, b);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001576
1577 up_read(mmap_sem);
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001578 break;
Sumit Semwalc5384042012-06-14 10:37:37 -03001579 case V4L2_MEMORY_DMABUF:
1580 ret = __qbuf_dmabuf(vb, b);
1581 break;
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001582 default:
1583 WARN(1, "Invalid queue type\n");
1584 ret = -EINVAL;
1585 }
1586
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001587 if (ret)
1588 dprintk(1, "qbuf: buffer preparation failed: %d\n", ret);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001589 vb->state = ret ? VB2_BUF_STATE_DEQUEUED : VB2_BUF_STATE_PREPARED;
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001590
1591 return ret;
1592}
1593
Laurent Pinchart012043b2013-08-09 08:11:26 -03001594static int vb2_queue_or_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b,
Hans Verkuil41381112013-12-13 13:13:39 -03001595 const char *opname)
Laurent Pinchart012043b2013-08-09 08:11:26 -03001596{
Laurent Pinchart012043b2013-08-09 08:11:26 -03001597 if (b->type != q->type) {
1598 dprintk(1, "%s(): invalid buffer type\n", opname);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001599 return -EINVAL;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001600 }
1601
1602 if (b->index >= q->num_buffers) {
1603 dprintk(1, "%s(): buffer index out of range\n", opname);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001604 return -EINVAL;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001605 }
1606
Hans Verkuil41381112013-12-13 13:13:39 -03001607 if (q->bufs[b->index] == NULL) {
Laurent Pinchart012043b2013-08-09 08:11:26 -03001608 /* Should never happen */
1609 dprintk(1, "%s(): buffer is NULL\n", opname);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001610 return -EINVAL;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001611 }
1612
1613 if (b->memory != q->memory) {
1614 dprintk(1, "%s(): invalid memory type\n", opname);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001615 return -EINVAL;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001616 }
1617
Hans Verkuil41381112013-12-13 13:13:39 -03001618 return __verify_planes_array(q->bufs[b->index], b);
Laurent Pinchart012043b2013-08-09 08:11:26 -03001619}
1620
Pawel Osciake23ccc02010-10-11 10:56:41 -03001621/**
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001622 * vb2_prepare_buf() - Pass ownership of a buffer from userspace to the kernel
1623 * @q: videobuf2 queue
1624 * @b: buffer structure passed from userspace to vidioc_prepare_buf
1625 * handler in driver
1626 *
1627 * Should be called from vidioc_prepare_buf ioctl handler of a driver.
1628 * This function:
1629 * 1) verifies the passed buffer,
1630 * 2) calls buf_prepare callback in the driver (if provided), in which
1631 * driver-specific buffer initialization can be performed,
1632 *
1633 * The return values from this function are intended to be directly returned
1634 * from vidioc_prepare_buf handler in driver.
1635 */
1636int vb2_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b)
1637{
Hans Verkuil41381112013-12-13 13:13:39 -03001638 struct vb2_buffer *vb;
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001639 int ret;
Hans Verkuil41381112013-12-13 13:13:39 -03001640
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001641 if (q->fileio) {
1642 dprintk(1, "%s(): file io in progress\n", __func__);
1643 return -EBUSY;
1644 }
1645
1646 ret = vb2_queue_or_prepare_buf(q, b, "prepare_buf");
Hans Verkuil41381112013-12-13 13:13:39 -03001647 if (ret)
1648 return ret;
1649
1650 vb = q->bufs[b->index];
1651 if (vb->state != VB2_BUF_STATE_DEQUEUED) {
1652 dprintk(1, "%s(): invalid buffer state %d\n", __func__,
1653 vb->state);
1654 return -EINVAL;
1655 }
1656
1657 ret = __buf_prepare(vb, b);
1658 if (!ret) {
1659 /* Fill buffer information for the userspace */
1660 __fill_v4l2_buffer(vb, b);
1661
1662 dprintk(1, "%s() of buffer %d succeeded\n", __func__, vb->v4l2_buf.index);
1663 }
1664 return ret;
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001665}
1666EXPORT_SYMBOL_GPL(vb2_prepare_buf);
1667
Hans Verkuil02f142e2013-12-13 13:13:42 -03001668/**
1669 * vb2_start_streaming() - Attempt to start streaming.
1670 * @q: videobuf2 queue
1671 *
Hans Verkuilb3379c62014-02-24 13:51:03 -03001672 * Attempt to start streaming. When this function is called there must be
1673 * at least q->min_buffers_needed buffers queued up (i.e. the minimum
1674 * number of buffers required for the DMA engine to function). If the
1675 * @start_streaming op fails it is supposed to return all the driver-owned
1676 * buffers back to vb2 in state QUEUED. Check if that happened and if
1677 * not warn and reclaim them forcefully.
Hans Verkuil02f142e2013-12-13 13:13:42 -03001678 */
1679static int vb2_start_streaming(struct vb2_queue *q)
1680{
Hans Verkuilb3379c62014-02-24 13:51:03 -03001681 struct vb2_buffer *vb;
Hans Verkuil02f142e2013-12-13 13:13:42 -03001682 int ret;
1683
Hans Verkuil02f142e2013-12-13 13:13:42 -03001684 /*
Hans Verkuilb3379c62014-02-24 13:51:03 -03001685 * If any buffers were queued before streamon,
1686 * we can now pass them to driver for processing.
Hans Verkuil02f142e2013-12-13 13:13:42 -03001687 */
Hans Verkuilb3379c62014-02-24 13:51:03 -03001688 list_for_each_entry(vb, &q->queued_list, queued_entry)
1689 __enqueue_in_driver(vb);
1690
1691 /* Tell the driver to start streaming */
1692 ret = call_qop(q, start_streaming, q,
1693 atomic_read(&q->owned_by_drv_count));
1694 q->start_streaming_called = ret == 0;
1695 if (!ret)
Hans Verkuil02f142e2013-12-13 13:13:42 -03001696 return 0;
Hans Verkuilb3379c62014-02-24 13:51:03 -03001697
Hans Verkuilb3379c62014-02-24 13:51:03 -03001698 dprintk(1, "qbuf: driver refused to start streaming\n");
1699 if (WARN_ON(atomic_read(&q->owned_by_drv_count))) {
1700 unsigned i;
1701
1702 /*
1703 * Forcefully reclaim buffers if the driver did not
1704 * correctly return them to vb2.
1705 */
1706 for (i = 0; i < q->num_buffers; ++i) {
1707 vb = q->bufs[i];
1708 if (vb->state == VB2_BUF_STATE_ACTIVE)
1709 vb2_buffer_done(vb, VB2_BUF_STATE_QUEUED);
1710 }
1711 /* Must be zero now */
1712 WARN_ON(atomic_read(&q->owned_by_drv_count));
Hans Verkuil02f142e2013-12-13 13:13:42 -03001713 }
Hans Verkuil02f142e2013-12-13 13:13:42 -03001714 return ret;
1715}
1716
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001717static int vb2_internal_qbuf(struct vb2_queue *q, struct v4l2_buffer *b)
Laurent Pinchart012043b2013-08-09 08:11:26 -03001718{
Hans Verkuil41381112013-12-13 13:13:39 -03001719 int ret = vb2_queue_or_prepare_buf(q, b, "qbuf");
1720 struct vb2_buffer *vb;
1721
1722 if (ret)
1723 return ret;
1724
1725 vb = q->bufs[b->index];
Laurent Pinchart012043b2013-08-09 08:11:26 -03001726
1727 switch (vb->state) {
1728 case VB2_BUF_STATE_DEQUEUED:
1729 ret = __buf_prepare(vb, b);
1730 if (ret)
1731 return ret;
Hans Verkuil41381112013-12-13 13:13:39 -03001732 break;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001733 case VB2_BUF_STATE_PREPARED:
1734 break;
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001735 case VB2_BUF_STATE_PREPARING:
1736 dprintk(1, "qbuf: buffer still being prepared\n");
1737 return -EINVAL;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001738 default:
Hans Verkuil952c9ee2014-02-10 13:12:00 -03001739 dprintk(1, "%s(): invalid buffer state %d\n", __func__,
1740 vb->state);
Laurent Pinchart012043b2013-08-09 08:11:26 -03001741 return -EINVAL;
1742 }
1743
1744 /*
1745 * Add to the queued buffers list, a buffer will stay on it until
1746 * dequeued in dqbuf.
1747 */
1748 list_add_tail(&vb->queued_entry, &q->queued_list);
Hans Verkuilb3379c62014-02-24 13:51:03 -03001749 q->queued_count++;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001750 vb->state = VB2_BUF_STATE_QUEUED;
Hans Verkuilf1343282014-02-24 14:44:50 -03001751 if (V4L2_TYPE_IS_OUTPUT(q->type)) {
1752 /*
1753 * For output buffers copy the timestamp if needed,
1754 * and the timecode field and flag if needed.
1755 */
Sakari Ailusc57ff792014-03-01 10:28:02 -03001756 if ((q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
1757 V4L2_BUF_FLAG_TIMESTAMP_COPY)
Hans Verkuilf1343282014-02-24 14:44:50 -03001758 vb->v4l2_buf.timestamp = b->timestamp;
1759 vb->v4l2_buf.flags |= b->flags & V4L2_BUF_FLAG_TIMECODE;
1760 if (b->flags & V4L2_BUF_FLAG_TIMECODE)
1761 vb->v4l2_buf.timecode = b->timecode;
1762 }
Laurent Pinchart012043b2013-08-09 08:11:26 -03001763
1764 /*
1765 * If already streaming, give the buffer to driver for processing.
1766 * If not, the buffer will be given to driver on next streamon.
1767 */
Hans Verkuilb3379c62014-02-24 13:51:03 -03001768 if (q->start_streaming_called)
Laurent Pinchart012043b2013-08-09 08:11:26 -03001769 __enqueue_in_driver(vb);
1770
Hans Verkuil41381112013-12-13 13:13:39 -03001771 /* Fill buffer information for the userspace */
1772 __fill_v4l2_buffer(vb, b);
Laurent Pinchart012043b2013-08-09 08:11:26 -03001773
Hans Verkuilb3379c62014-02-24 13:51:03 -03001774 /*
1775 * If streamon has been called, and we haven't yet called
1776 * start_streaming() since not enough buffers were queued, and
1777 * we now have reached the minimum number of queued buffers,
1778 * then we can finally call start_streaming().
1779 */
1780 if (q->streaming && !q->start_streaming_called &&
1781 q->queued_count >= q->min_buffers_needed) {
Hans Verkuil02f142e2013-12-13 13:13:42 -03001782 ret = vb2_start_streaming(q);
1783 if (ret)
1784 return ret;
1785 }
1786
Hans Verkuil41381112013-12-13 13:13:39 -03001787 dprintk(1, "%s() of buffer %d succeeded\n", __func__, vb->v4l2_buf.index);
1788 return 0;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001789}
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001790
1791/**
1792 * vb2_qbuf() - Queue a buffer from userspace
1793 * @q: videobuf2 queue
1794 * @b: buffer structure passed from userspace to vidioc_qbuf handler
1795 * in driver
1796 *
1797 * Should be called from vidioc_qbuf ioctl handler of a driver.
1798 * This function:
1799 * 1) verifies the passed buffer,
1800 * 2) if necessary, calls buf_prepare callback in the driver (if provided), in
1801 * which driver-specific buffer initialization can be performed,
1802 * 3) if streaming is on, queues the buffer in driver by the means of buf_queue
1803 * callback for processing.
1804 *
1805 * The return values from this function are intended to be directly returned
1806 * from vidioc_qbuf handler in driver.
1807 */
1808int vb2_qbuf(struct vb2_queue *q, struct v4l2_buffer *b)
1809{
1810 if (q->fileio) {
1811 dprintk(1, "%s(): file io in progress\n", __func__);
1812 return -EBUSY;
1813 }
1814
1815 return vb2_internal_qbuf(q, b);
1816}
Pawel Osciake23ccc02010-10-11 10:56:41 -03001817EXPORT_SYMBOL_GPL(vb2_qbuf);
1818
1819/**
1820 * __vb2_wait_for_done_vb() - wait for a buffer to become available
1821 * for dequeuing
1822 *
1823 * Will sleep if required for nonblocking == false.
1824 */
1825static int __vb2_wait_for_done_vb(struct vb2_queue *q, int nonblocking)
1826{
1827 /*
1828 * All operations on vb_done_list are performed under done_lock
1829 * spinlock protection. However, buffers may be removed from
1830 * it and returned to userspace only while holding both driver's
1831 * lock and the done_lock spinlock. Thus we can be sure that as
1832 * long as we hold the driver's lock, the list will remain not
1833 * empty if list_empty() check succeeds.
1834 */
1835
1836 for (;;) {
1837 int ret;
1838
1839 if (!q->streaming) {
1840 dprintk(1, "Streaming off, will not wait for buffers\n");
1841 return -EINVAL;
1842 }
1843
1844 if (!list_empty(&q->done_list)) {
1845 /*
1846 * Found a buffer that we were waiting for.
1847 */
1848 break;
1849 }
1850
1851 if (nonblocking) {
1852 dprintk(1, "Nonblocking and no buffers to dequeue, "
1853 "will not wait\n");
1854 return -EAGAIN;
1855 }
1856
1857 /*
1858 * We are streaming and blocking, wait for another buffer to
1859 * become ready or for streamoff. Driver's lock is released to
1860 * allow streamoff or qbuf to be called while waiting.
1861 */
Hans Verkuila1d36d82014-03-17 09:54:21 -03001862 call_void_qop(q, wait_prepare, q);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001863
1864 /*
1865 * All locks have been released, it is safe to sleep now.
1866 */
1867 dprintk(3, "Will sleep waiting for buffers\n");
1868 ret = wait_event_interruptible(q->done_wq,
1869 !list_empty(&q->done_list) || !q->streaming);
1870
1871 /*
1872 * We need to reevaluate both conditions again after reacquiring
1873 * the locks or return an error if one occurred.
1874 */
Hans Verkuila1d36d82014-03-17 09:54:21 -03001875 call_void_qop(q, wait_finish, q);
Hans Verkuil32a77262012-09-28 06:12:53 -03001876 if (ret) {
1877 dprintk(1, "Sleep was interrupted\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03001878 return ret;
Hans Verkuil32a77262012-09-28 06:12:53 -03001879 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001880 }
1881 return 0;
1882}
1883
1884/**
1885 * __vb2_get_done_vb() - get a buffer ready for dequeuing
1886 *
1887 * Will sleep if required for nonblocking == false.
1888 */
1889static int __vb2_get_done_vb(struct vb2_queue *q, struct vb2_buffer **vb,
Hans Verkuil32a77262012-09-28 06:12:53 -03001890 struct v4l2_buffer *b, int nonblocking)
Pawel Osciake23ccc02010-10-11 10:56:41 -03001891{
1892 unsigned long flags;
1893 int ret;
1894
1895 /*
1896 * Wait for at least one buffer to become available on the done_list.
1897 */
1898 ret = __vb2_wait_for_done_vb(q, nonblocking);
1899 if (ret)
1900 return ret;
1901
1902 /*
1903 * Driver's lock has been held since we last verified that done_list
1904 * is not empty, so no need for another list_empty(done_list) check.
1905 */
1906 spin_lock_irqsave(&q->done_lock, flags);
1907 *vb = list_first_entry(&q->done_list, struct vb2_buffer, done_entry);
Hans Verkuil32a77262012-09-28 06:12:53 -03001908 /*
1909 * Only remove the buffer from done_list if v4l2_buffer can handle all
1910 * the planes.
1911 */
1912 ret = __verify_planes_array(*vb, b);
1913 if (!ret)
1914 list_del(&(*vb)->done_entry);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001915 spin_unlock_irqrestore(&q->done_lock, flags);
1916
Hans Verkuil32a77262012-09-28 06:12:53 -03001917 return ret;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001918}
1919
1920/**
1921 * vb2_wait_for_all_buffers() - wait until all buffers are given back to vb2
1922 * @q: videobuf2 queue
1923 *
1924 * This function will wait until all buffers that have been given to the driver
1925 * by buf_queue() are given back to vb2 with vb2_buffer_done(). It doesn't call
1926 * wait_prepare, wait_finish pair. It is intended to be called with all locks
1927 * taken, for example from stop_streaming() callback.
1928 */
1929int vb2_wait_for_all_buffers(struct vb2_queue *q)
1930{
1931 if (!q->streaming) {
1932 dprintk(1, "Streaming off, will not wait for buffers\n");
1933 return -EINVAL;
1934 }
1935
Hans Verkuilb3379c62014-02-24 13:51:03 -03001936 if (q->start_streaming_called)
Hans Verkuil6ea3b982014-02-06 05:46:11 -03001937 wait_event(q->done_wq, !atomic_read(&q->owned_by_drv_count));
Pawel Osciake23ccc02010-10-11 10:56:41 -03001938 return 0;
1939}
1940EXPORT_SYMBOL_GPL(vb2_wait_for_all_buffers);
1941
1942/**
Sumit Semwalc5384042012-06-14 10:37:37 -03001943 * __vb2_dqbuf() - bring back the buffer to the DEQUEUED state
1944 */
1945static void __vb2_dqbuf(struct vb2_buffer *vb)
1946{
1947 struct vb2_queue *q = vb->vb2_queue;
1948 unsigned int i;
1949
1950 /* nothing to do if the buffer is already dequeued */
1951 if (vb->state == VB2_BUF_STATE_DEQUEUED)
1952 return;
1953
1954 vb->state = VB2_BUF_STATE_DEQUEUED;
1955
1956 /* unmap DMABUF buffer */
1957 if (q->memory == V4L2_MEMORY_DMABUF)
1958 for (i = 0; i < vb->num_planes; ++i) {
1959 if (!vb->planes[i].dbuf_mapped)
1960 continue;
Hans Verkuila1d36d82014-03-17 09:54:21 -03001961 call_void_memop(vb, unmap_dmabuf, vb->planes[i].mem_priv);
Sumit Semwalc5384042012-06-14 10:37:37 -03001962 vb->planes[i].dbuf_mapped = 0;
1963 }
1964}
1965
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001966static int vb2_internal_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking)
Pawel Osciake23ccc02010-10-11 10:56:41 -03001967{
1968 struct vb2_buffer *vb = NULL;
1969 int ret;
1970
1971 if (b->type != q->type) {
1972 dprintk(1, "dqbuf: invalid buffer type\n");
1973 return -EINVAL;
1974 }
Hans Verkuil32a77262012-09-28 06:12:53 -03001975 ret = __vb2_get_done_vb(q, &vb, b, nonblocking);
1976 if (ret < 0)
Pawel Osciake23ccc02010-10-11 10:56:41 -03001977 return ret;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001978
Pawel Osciake23ccc02010-10-11 10:56:41 -03001979 switch (vb->state) {
1980 case VB2_BUF_STATE_DONE:
1981 dprintk(3, "dqbuf: Returning done buffer\n");
1982 break;
1983 case VB2_BUF_STATE_ERROR:
1984 dprintk(3, "dqbuf: Returning done buffer with errors\n");
1985 break;
1986 default:
1987 dprintk(1, "dqbuf: Invalid buffer state\n");
1988 return -EINVAL;
1989 }
1990
Hans Verkuila1d36d82014-03-17 09:54:21 -03001991 call_void_vb_qop(vb, buf_finish, vb);
Hans Verkuil9cf3c312014-02-28 13:30:48 -03001992
Pawel Osciake23ccc02010-10-11 10:56:41 -03001993 /* Fill buffer information for the userspace */
1994 __fill_v4l2_buffer(vb, b);
1995 /* Remove from videobuf queue */
1996 list_del(&vb->queued_entry);
Hans Verkuilb3379c62014-02-24 13:51:03 -03001997 q->queued_count--;
Sumit Semwalc5384042012-06-14 10:37:37 -03001998 /* go back to dequeued state */
1999 __vb2_dqbuf(vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002000
2001 dprintk(1, "dqbuf of buffer %d, with state %d\n",
2002 vb->v4l2_buf.index, vb->state);
2003
Pawel Osciake23ccc02010-10-11 10:56:41 -03002004 return 0;
2005}
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002006
2007/**
2008 * vb2_dqbuf() - Dequeue a buffer to the userspace
2009 * @q: videobuf2 queue
2010 * @b: buffer structure passed from userspace to vidioc_dqbuf handler
2011 * in driver
2012 * @nonblocking: if true, this call will not sleep waiting for a buffer if no
2013 * buffers ready for dequeuing are present. Normally the driver
2014 * would be passing (file->f_flags & O_NONBLOCK) here
2015 *
2016 * Should be called from vidioc_dqbuf ioctl handler of a driver.
2017 * This function:
2018 * 1) verifies the passed buffer,
2019 * 2) calls buf_finish callback in the driver (if provided), in which
2020 * driver can perform any additional operations that may be required before
2021 * returning the buffer to userspace, such as cache sync,
2022 * 3) the buffer struct members are filled with relevant information for
2023 * the userspace.
2024 *
2025 * The return values from this function are intended to be directly returned
2026 * from vidioc_dqbuf handler in driver.
2027 */
2028int vb2_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking)
2029{
2030 if (q->fileio) {
2031 dprintk(1, "dqbuf: file io in progress\n");
2032 return -EBUSY;
2033 }
2034 return vb2_internal_dqbuf(q, b, nonblocking);
2035}
Pawel Osciake23ccc02010-10-11 10:56:41 -03002036EXPORT_SYMBOL_GPL(vb2_dqbuf);
2037
2038/**
Pawel Osciake23ccc02010-10-11 10:56:41 -03002039 * __vb2_queue_cancel() - cancel and stop (pause) streaming
2040 *
2041 * Removes all queued buffers from driver's queue and all buffers queued by
2042 * userspace from videobuf's queue. Returns to state after reqbufs.
2043 */
2044static void __vb2_queue_cancel(struct vb2_queue *q)
2045{
2046 unsigned int i;
2047
2048 /*
2049 * Tell driver to stop all transactions and release all queued
2050 * buffers.
2051 */
Hans Verkuilb3379c62014-02-24 13:51:03 -03002052 if (q->start_streaming_called)
Pawel Osciake23ccc02010-10-11 10:56:41 -03002053 call_qop(q, stop_streaming, q);
2054 q->streaming = 0;
Hans Verkuilb3379c62014-02-24 13:51:03 -03002055 q->start_streaming_called = 0;
2056 q->queued_count = 0;
2057
2058 if (WARN_ON(atomic_read(&q->owned_by_drv_count))) {
2059 for (i = 0; i < q->num_buffers; ++i)
2060 if (q->bufs[i]->state == VB2_BUF_STATE_ACTIVE)
2061 vb2_buffer_done(q->bufs[i], VB2_BUF_STATE_ERROR);
2062 /* Must be zero now */
2063 WARN_ON(atomic_read(&q->owned_by_drv_count));
2064 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03002065
2066 /*
2067 * Remove all buffers from videobuf's list...
2068 */
2069 INIT_LIST_HEAD(&q->queued_list);
2070 /*
2071 * ...and done list; userspace will not receive any buffers it
2072 * has not already dequeued before initiating cancel.
2073 */
2074 INIT_LIST_HEAD(&q->done_list);
Hans Verkuil6ea3b982014-02-06 05:46:11 -03002075 atomic_set(&q->owned_by_drv_count, 0);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002076 wake_up_all(&q->done_wq);
2077
2078 /*
2079 * Reinitialize all buffers for next use.
Hans Verkuil9c0863b2014-03-04 07:34:49 -03002080 * Make sure to call buf_finish for any queued buffers. Normally
2081 * that's done in dqbuf, but that's not going to happen when we
2082 * cancel the whole queue. Note: this code belongs here, not in
2083 * __vb2_dqbuf() since in vb2_internal_dqbuf() there is a critical
2084 * call to __fill_v4l2_buffer() after buf_finish(). That order can't
2085 * be changed, so we can't move the buf_finish() to __vb2_dqbuf().
Pawel Osciake23ccc02010-10-11 10:56:41 -03002086 */
Hans Verkuil9c0863b2014-03-04 07:34:49 -03002087 for (i = 0; i < q->num_buffers; ++i) {
2088 struct vb2_buffer *vb = q->bufs[i];
2089
2090 if (vb->state != VB2_BUF_STATE_DEQUEUED) {
2091 vb->state = VB2_BUF_STATE_PREPARED;
Hans Verkuila1d36d82014-03-17 09:54:21 -03002092 call_void_vb_qop(vb, buf_finish, vb);
Hans Verkuil9c0863b2014-03-04 07:34:49 -03002093 }
2094 __vb2_dqbuf(vb);
2095 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03002096}
2097
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002098static int vb2_internal_streamon(struct vb2_queue *q, enum v4l2_buf_type type)
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002099{
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002100 int ret;
2101
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002102 if (type != q->type) {
2103 dprintk(1, "streamon: invalid stream type\n");
2104 return -EINVAL;
2105 }
2106
2107 if (q->streaming) {
Ricardo Ribaldaf9560352013-11-08 07:08:45 -03002108 dprintk(3, "streamon successful: already streaming\n");
2109 return 0;
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002110 }
2111
Ricardo Ribalda548df782014-01-08 05:01:33 -03002112 if (!q->num_buffers) {
2113 dprintk(1, "streamon: no buffers have been allocated\n");
2114 return -EINVAL;
2115 }
2116
Ricardo Ribalda Delgado249f5a52014-01-08 05:01:33 -03002117 if (!q->num_buffers) {
2118 dprintk(1, "streamon: no buffers have been allocated\n");
2119 return -EINVAL;
2120 }
Hans Verkuilb3379c62014-02-24 13:51:03 -03002121 if (q->num_buffers < q->min_buffers_needed) {
2122 dprintk(1, "streamon: need at least %u allocated buffers\n",
2123 q->min_buffers_needed);
2124 return -EINVAL;
2125 }
Ricardo Ribalda Delgado249f5a52014-01-08 05:01:33 -03002126
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002127 /*
Hans Verkuilb3379c62014-02-24 13:51:03 -03002128 * Tell driver to start streaming provided sufficient buffers
2129 * are available.
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002130 */
Hans Verkuilb3379c62014-02-24 13:51:03 -03002131 if (q->queued_count >= q->min_buffers_needed) {
2132 ret = vb2_start_streaming(q);
2133 if (ret) {
2134 __vb2_queue_cancel(q);
2135 return ret;
2136 }
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002137 }
2138
2139 q->streaming = 1;
2140
2141 dprintk(3, "Streamon successful\n");
2142 return 0;
2143}
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002144
2145/**
2146 * vb2_streamon - start streaming
2147 * @q: videobuf2 queue
2148 * @type: type argument passed from userspace to vidioc_streamon handler
2149 *
2150 * Should be called from vidioc_streamon handler of a driver.
2151 * This function:
2152 * 1) verifies current state
2153 * 2) passes any previously queued buffers to the driver and starts streaming
2154 *
2155 * The return values from this function are intended to be directly returned
2156 * from vidioc_streamon handler in the driver.
2157 */
2158int vb2_streamon(struct vb2_queue *q, enum v4l2_buf_type type)
2159{
2160 if (q->fileio) {
2161 dprintk(1, "streamon: file io in progress\n");
2162 return -EBUSY;
2163 }
2164 return vb2_internal_streamon(q, type);
2165}
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002166EXPORT_SYMBOL_GPL(vb2_streamon);
2167
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002168static int vb2_internal_streamoff(struct vb2_queue *q, enum v4l2_buf_type type)
2169{
2170 if (type != q->type) {
2171 dprintk(1, "streamoff: invalid stream type\n");
2172 return -EINVAL;
2173 }
2174
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002175 /*
2176 * Cancel will pause streaming and remove all buffers from the driver
2177 * and videobuf, effectively returning control over them to userspace.
Hans Verkuil3f1a9a32014-02-25 09:42:45 -03002178 *
2179 * Note that we do this even if q->streaming == 0: if you prepare or
2180 * queue buffers, and then call streamoff without ever having called
2181 * streamon, you would still expect those buffers to be returned to
2182 * their normal dequeued state.
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002183 */
2184 __vb2_queue_cancel(q);
2185
2186 dprintk(3, "Streamoff successful\n");
2187 return 0;
2188}
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002189
2190/**
Pawel Osciake23ccc02010-10-11 10:56:41 -03002191 * vb2_streamoff - stop streaming
2192 * @q: videobuf2 queue
2193 * @type: type argument passed from userspace to vidioc_streamoff handler
2194 *
2195 * Should be called from vidioc_streamoff handler of a driver.
2196 * This function:
2197 * 1) verifies current state,
2198 * 2) stop streaming and dequeues any queued buffers, including those previously
2199 * passed to the driver (after waiting for the driver to finish).
2200 *
2201 * This call can be used for pausing playback.
2202 * The return values from this function are intended to be directly returned
2203 * from vidioc_streamoff handler in the driver
2204 */
2205int vb2_streamoff(struct vb2_queue *q, enum v4l2_buf_type type)
2206{
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002207 if (q->fileio) {
2208 dprintk(1, "streamoff: file io in progress\n");
2209 return -EBUSY;
2210 }
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002211 return vb2_internal_streamoff(q, type);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002212}
2213EXPORT_SYMBOL_GPL(vb2_streamoff);
2214
2215/**
2216 * __find_plane_by_offset() - find plane associated with the given offset off
2217 */
2218static int __find_plane_by_offset(struct vb2_queue *q, unsigned long off,
2219 unsigned int *_buffer, unsigned int *_plane)
2220{
2221 struct vb2_buffer *vb;
2222 unsigned int buffer, plane;
2223
2224 /*
2225 * Go over all buffers and their planes, comparing the given offset
2226 * with an offset assigned to each plane. If a match is found,
2227 * return its buffer and plane numbers.
2228 */
2229 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
2230 vb = q->bufs[buffer];
2231
2232 for (plane = 0; plane < vb->num_planes; ++plane) {
2233 if (vb->v4l2_planes[plane].m.mem_offset == off) {
2234 *_buffer = buffer;
2235 *_plane = plane;
2236 return 0;
2237 }
2238 }
2239 }
2240
2241 return -EINVAL;
2242}
2243
2244/**
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002245 * vb2_expbuf() - Export a buffer as a file descriptor
2246 * @q: videobuf2 queue
2247 * @eb: export buffer structure passed from userspace to vidioc_expbuf
2248 * handler in driver
2249 *
2250 * The return values from this function are intended to be directly returned
2251 * from vidioc_expbuf handler in driver.
2252 */
2253int vb2_expbuf(struct vb2_queue *q, struct v4l2_exportbuffer *eb)
2254{
2255 struct vb2_buffer *vb = NULL;
2256 struct vb2_plane *vb_plane;
2257 int ret;
2258 struct dma_buf *dbuf;
2259
2260 if (q->memory != V4L2_MEMORY_MMAP) {
2261 dprintk(1, "Queue is not currently set up for mmap\n");
2262 return -EINVAL;
2263 }
2264
2265 if (!q->mem_ops->get_dmabuf) {
2266 dprintk(1, "Queue does not support DMA buffer exporting\n");
2267 return -EINVAL;
2268 }
2269
Philipp Zabelea3aba82013-05-21 05:11:35 -03002270 if (eb->flags & ~(O_CLOEXEC | O_ACCMODE)) {
2271 dprintk(1, "Queue does support only O_CLOEXEC and access mode flags\n");
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002272 return -EINVAL;
2273 }
2274
2275 if (eb->type != q->type) {
2276 dprintk(1, "qbuf: invalid buffer type\n");
2277 return -EINVAL;
2278 }
2279
2280 if (eb->index >= q->num_buffers) {
2281 dprintk(1, "buffer index out of range\n");
2282 return -EINVAL;
2283 }
2284
2285 vb = q->bufs[eb->index];
2286
2287 if (eb->plane >= vb->num_planes) {
2288 dprintk(1, "buffer plane out of range\n");
2289 return -EINVAL;
2290 }
2291
2292 vb_plane = &vb->planes[eb->plane];
2293
Hans Verkuila1d36d82014-03-17 09:54:21 -03002294 dbuf = call_ptr_memop(vb, get_dmabuf, vb_plane->mem_priv, eb->flags & O_ACCMODE);
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002295 if (IS_ERR_OR_NULL(dbuf)) {
2296 dprintk(1, "Failed to export buffer %d, plane %d\n",
2297 eb->index, eb->plane);
2298 return -EINVAL;
2299 }
2300
Philipp Zabelea3aba82013-05-21 05:11:35 -03002301 ret = dma_buf_fd(dbuf, eb->flags & ~O_ACCMODE);
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002302 if (ret < 0) {
2303 dprintk(3, "buffer %d, plane %d failed to export (%d)\n",
2304 eb->index, eb->plane, ret);
2305 dma_buf_put(dbuf);
2306 return ret;
2307 }
2308
2309 dprintk(3, "buffer %d, plane %d exported as %d descriptor\n",
2310 eb->index, eb->plane, ret);
2311 eb->fd = ret;
2312
2313 return 0;
2314}
2315EXPORT_SYMBOL_GPL(vb2_expbuf);
2316
2317/**
Pawel Osciake23ccc02010-10-11 10:56:41 -03002318 * vb2_mmap() - map video buffers into application address space
2319 * @q: videobuf2 queue
2320 * @vma: vma passed to the mmap file operation handler in the driver
2321 *
2322 * Should be called from mmap file operation handler of a driver.
2323 * This function maps one plane of one of the available video buffers to
2324 * userspace. To map whole video memory allocated on reqbufs, this function
2325 * has to be called once per each plane per each buffer previously allocated.
2326 *
2327 * When the userspace application calls mmap, it passes to it an offset returned
2328 * to it earlier by the means of vidioc_querybuf handler. That offset acts as
2329 * a "cookie", which is then used to identify the plane to be mapped.
2330 * This function finds a plane with a matching offset and a mapping is performed
2331 * by the means of a provided memory operation.
2332 *
2333 * The return values from this function are intended to be directly returned
2334 * from the mmap handler in driver.
2335 */
2336int vb2_mmap(struct vb2_queue *q, struct vm_area_struct *vma)
2337{
2338 unsigned long off = vma->vm_pgoff << PAGE_SHIFT;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002339 struct vb2_buffer *vb;
2340 unsigned int buffer, plane;
2341 int ret;
Mauro Carvalho Chehab7f841452013-04-19 07:18:01 -03002342 unsigned long length;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002343
2344 if (q->memory != V4L2_MEMORY_MMAP) {
2345 dprintk(1, "Queue is not currently set up for mmap\n");
2346 return -EINVAL;
2347 }
2348
2349 /*
2350 * Check memory area access mode.
2351 */
2352 if (!(vma->vm_flags & VM_SHARED)) {
2353 dprintk(1, "Invalid vma flags, VM_SHARED needed\n");
2354 return -EINVAL;
2355 }
2356 if (V4L2_TYPE_IS_OUTPUT(q->type)) {
2357 if (!(vma->vm_flags & VM_WRITE)) {
2358 dprintk(1, "Invalid vma flags, VM_WRITE needed\n");
2359 return -EINVAL;
2360 }
2361 } else {
2362 if (!(vma->vm_flags & VM_READ)) {
2363 dprintk(1, "Invalid vma flags, VM_READ needed\n");
2364 return -EINVAL;
2365 }
2366 }
2367
2368 /*
2369 * Find the plane corresponding to the offset passed by userspace.
2370 */
2371 ret = __find_plane_by_offset(q, off, &buffer, &plane);
2372 if (ret)
2373 return ret;
2374
2375 vb = q->bufs[buffer];
Pawel Osciake23ccc02010-10-11 10:56:41 -03002376
Mauro Carvalho Chehab7f841452013-04-19 07:18:01 -03002377 /*
2378 * MMAP requires page_aligned buffers.
2379 * The buffer length was page_aligned at __vb2_buf_mem_alloc(),
2380 * so, we need to do the same here.
2381 */
2382 length = PAGE_ALIGN(vb->v4l2_planes[plane].length);
2383 if (length < (vma->vm_end - vma->vm_start)) {
2384 dprintk(1,
2385 "MMAP invalid, as it would overflow buffer length\n");
Seung-Woo Kim068a0df2013-04-11 23:57:57 -03002386 return -EINVAL;
2387 }
2388
Hans Verkuilb5b45412014-01-29 11:53:25 -03002389 ret = call_memop(vb, mmap, vb->planes[plane].mem_priv, vma);
Hans Verkuila1d36d82014-03-17 09:54:21 -03002390 if (ret)
Pawel Osciake23ccc02010-10-11 10:56:41 -03002391 return ret;
2392
Pawel Osciake23ccc02010-10-11 10:56:41 -03002393 dprintk(3, "Buffer %d, plane %d successfully mapped\n", buffer, plane);
2394 return 0;
2395}
2396EXPORT_SYMBOL_GPL(vb2_mmap);
2397
Scott Jiang6f524ec2011-09-21 09:25:23 -03002398#ifndef CONFIG_MMU
2399unsigned long vb2_get_unmapped_area(struct vb2_queue *q,
2400 unsigned long addr,
2401 unsigned long len,
2402 unsigned long pgoff,
2403 unsigned long flags)
2404{
2405 unsigned long off = pgoff << PAGE_SHIFT;
2406 struct vb2_buffer *vb;
2407 unsigned int buffer, plane;
2408 int ret;
2409
2410 if (q->memory != V4L2_MEMORY_MMAP) {
2411 dprintk(1, "Queue is not currently set up for mmap\n");
2412 return -EINVAL;
2413 }
2414
2415 /*
2416 * Find the plane corresponding to the offset passed by userspace.
2417 */
2418 ret = __find_plane_by_offset(q, off, &buffer, &plane);
2419 if (ret)
2420 return ret;
2421
2422 vb = q->bufs[buffer];
2423
2424 return (unsigned long)vb2_plane_vaddr(vb, plane);
2425}
2426EXPORT_SYMBOL_GPL(vb2_get_unmapped_area);
2427#endif
2428
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002429static int __vb2_init_fileio(struct vb2_queue *q, int read);
2430static int __vb2_cleanup_fileio(struct vb2_queue *q);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002431
2432/**
2433 * vb2_poll() - implements poll userspace operation
2434 * @q: videobuf2 queue
2435 * @file: file argument passed to the poll file operation handler
2436 * @wait: wait argument passed to the poll file operation handler
2437 *
2438 * This function implements poll file operation handler for a driver.
2439 * For CAPTURE queues, if a buffer is ready to be dequeued, the userspace will
2440 * be informed that the file descriptor of a video device is available for
2441 * reading.
2442 * For OUTPUT queues, if a buffer is ready to be dequeued, the file descriptor
2443 * will be reported as available for writing.
2444 *
Hans Verkuil95213ce2011-07-13 04:26:52 -03002445 * If the driver uses struct v4l2_fh, then vb2_poll() will also check for any
2446 * pending events.
2447 *
Pawel Osciake23ccc02010-10-11 10:56:41 -03002448 * The return values from this function are intended to be directly returned
2449 * from poll handler in driver.
2450 */
2451unsigned int vb2_poll(struct vb2_queue *q, struct file *file, poll_table *wait)
2452{
Hans Verkuil95213ce2011-07-13 04:26:52 -03002453 struct video_device *vfd = video_devdata(file);
Hans Verkuilbf5c7cb2011-07-13 04:01:30 -03002454 unsigned long req_events = poll_requested_events(wait);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002455 struct vb2_buffer *vb = NULL;
Hans Verkuil95213ce2011-07-13 04:26:52 -03002456 unsigned int res = 0;
2457 unsigned long flags;
2458
2459 if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags)) {
2460 struct v4l2_fh *fh = file->private_data;
2461
2462 if (v4l2_event_pending(fh))
2463 res = POLLPRI;
2464 else if (req_events & POLLPRI)
2465 poll_wait(file, &fh->wait, wait);
2466 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03002467
Hans Verkuilcd138232013-01-30 13:29:02 -03002468 if (!V4L2_TYPE_IS_OUTPUT(q->type) && !(req_events & (POLLIN | POLLRDNORM)))
2469 return res;
2470 if (V4L2_TYPE_IS_OUTPUT(q->type) && !(req_events & (POLLOUT | POLLWRNORM)))
2471 return res;
2472
Pawel Osciake23ccc02010-10-11 10:56:41 -03002473 /*
Pawel Osciak4ffabdb2011-03-20 18:17:34 -03002474 * Start file I/O emulator only if streaming API has not been used yet.
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002475 */
2476 if (q->num_buffers == 0 && q->fileio == NULL) {
Hans Verkuilbf5c7cb2011-07-13 04:01:30 -03002477 if (!V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_READ) &&
2478 (req_events & (POLLIN | POLLRDNORM))) {
Hans Verkuil95213ce2011-07-13 04:26:52 -03002479 if (__vb2_init_fileio(q, 1))
2480 return res | POLLERR;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002481 }
Hans Verkuilbf5c7cb2011-07-13 04:01:30 -03002482 if (V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_WRITE) &&
2483 (req_events & (POLLOUT | POLLWRNORM))) {
Hans Verkuil95213ce2011-07-13 04:26:52 -03002484 if (__vb2_init_fileio(q, 0))
2485 return res | POLLERR;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002486 /*
2487 * Write to OUTPUT queue can be done immediately.
2488 */
Hans Verkuil95213ce2011-07-13 04:26:52 -03002489 return res | POLLOUT | POLLWRNORM;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002490 }
2491 }
2492
2493 /*
Pawel Osciake23ccc02010-10-11 10:56:41 -03002494 * There is nothing to wait for if no buffers have already been queued.
2495 */
2496 if (list_empty(&q->queued_list))
Hans Verkuil95213ce2011-07-13 04:26:52 -03002497 return res | POLLERR;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002498
Seung-Woo Kim412cb872013-05-20 23:47:29 -03002499 if (list_empty(&q->done_list))
2500 poll_wait(file, &q->done_wq, wait);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002501
2502 /*
2503 * Take first buffer available for dequeuing.
2504 */
2505 spin_lock_irqsave(&q->done_lock, flags);
2506 if (!list_empty(&q->done_list))
2507 vb = list_first_entry(&q->done_list, struct vb2_buffer,
2508 done_entry);
2509 spin_unlock_irqrestore(&q->done_lock, flags);
2510
2511 if (vb && (vb->state == VB2_BUF_STATE_DONE
2512 || vb->state == VB2_BUF_STATE_ERROR)) {
Hans Verkuil95213ce2011-07-13 04:26:52 -03002513 return (V4L2_TYPE_IS_OUTPUT(q->type)) ?
2514 res | POLLOUT | POLLWRNORM :
2515 res | POLLIN | POLLRDNORM;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002516 }
Hans Verkuil95213ce2011-07-13 04:26:52 -03002517 return res;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002518}
2519EXPORT_SYMBOL_GPL(vb2_poll);
2520
2521/**
2522 * vb2_queue_init() - initialize a videobuf2 queue
2523 * @q: videobuf2 queue; this structure should be allocated in driver
2524 *
2525 * The vb2_queue structure should be allocated by the driver. The driver is
2526 * responsible of clearing it's content and setting initial values for some
2527 * required entries before calling this function.
2528 * q->ops, q->mem_ops, q->type and q->io_modes are mandatory. Please refer
2529 * to the struct vb2_queue description in include/media/videobuf2-core.h
2530 * for more information.
2531 */
2532int vb2_queue_init(struct vb2_queue *q)
2533{
Ezequiel Garcia896f38f2012-09-17 14:59:30 -03002534 /*
2535 * Sanity check
2536 */
2537 if (WARN_ON(!q) ||
2538 WARN_ON(!q->ops) ||
2539 WARN_ON(!q->mem_ops) ||
2540 WARN_ON(!q->type) ||
2541 WARN_ON(!q->io_modes) ||
2542 WARN_ON(!q->ops->queue_setup) ||
Kamil Debski6aa69f92013-01-25 06:29:57 -03002543 WARN_ON(!q->ops->buf_queue) ||
Sakari Ailus872484c2013-08-25 17:57:03 -03002544 WARN_ON(q->timestamp_flags &
2545 ~(V4L2_BUF_FLAG_TIMESTAMP_MASK |
2546 V4L2_BUF_FLAG_TSTAMP_SRC_MASK)))
Ezequiel Garcia896f38f2012-09-17 14:59:30 -03002547 return -EINVAL;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002548
Kamil Debski6aa69f92013-01-25 06:29:57 -03002549 /* Warn that the driver should choose an appropriate timestamp type */
Sakari Ailusc57ff792014-03-01 10:28:02 -03002550 WARN_ON((q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
2551 V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN);
Kamil Debski6aa69f92013-01-25 06:29:57 -03002552
Pawel Osciake23ccc02010-10-11 10:56:41 -03002553 INIT_LIST_HEAD(&q->queued_list);
2554 INIT_LIST_HEAD(&q->done_list);
2555 spin_lock_init(&q->done_lock);
2556 init_waitqueue_head(&q->done_wq);
2557
2558 if (q->buf_struct_size == 0)
2559 q->buf_struct_size = sizeof(struct vb2_buffer);
2560
2561 return 0;
2562}
2563EXPORT_SYMBOL_GPL(vb2_queue_init);
2564
2565/**
2566 * vb2_queue_release() - stop streaming, release the queue and free memory
2567 * @q: videobuf2 queue
2568 *
2569 * This function stops streaming and performs necessary clean ups, including
2570 * freeing video buffer memory. The driver is responsible for freeing
2571 * the vb2_queue structure itself.
2572 */
2573void vb2_queue_release(struct vb2_queue *q)
2574{
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002575 __vb2_cleanup_fileio(q);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002576 __vb2_queue_cancel(q);
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03002577 __vb2_queue_free(q, q->num_buffers);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002578}
2579EXPORT_SYMBOL_GPL(vb2_queue_release);
2580
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002581/**
2582 * struct vb2_fileio_buf - buffer context used by file io emulator
2583 *
2584 * vb2 provides a compatibility layer and emulator of file io (read and
2585 * write) calls on top of streaming API. This structure is used for
2586 * tracking context related to the buffers.
2587 */
2588struct vb2_fileio_buf {
2589 void *vaddr;
2590 unsigned int size;
2591 unsigned int pos;
2592 unsigned int queued:1;
2593};
2594
2595/**
2596 * struct vb2_fileio_data - queue context used by file io emulator
2597 *
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002598 * @cur_index: the index of the buffer currently being read from or
2599 * written to. If equal to q->num_buffers then a new buffer
2600 * must be dequeued.
2601 * @initial_index: in the read() case all buffers are queued up immediately
2602 * in __vb2_init_fileio() and __vb2_perform_fileio() just cycles
2603 * buffers. However, in the write() case no buffers are initially
2604 * queued, instead whenever a buffer is full it is queued up by
2605 * __vb2_perform_fileio(). Only once all available buffers have
2606 * been queued up will __vb2_perform_fileio() start to dequeue
2607 * buffers. This means that initially __vb2_perform_fileio()
2608 * needs to know what buffer index to use when it is queuing up
2609 * the buffers for the first time. That initial index is stored
2610 * in this field. Once it is equal to q->num_buffers all
2611 * available buffers have been queued and __vb2_perform_fileio()
2612 * should start the normal dequeue/queue cycle.
2613 *
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002614 * vb2 provides a compatibility layer and emulator of file io (read and
2615 * write) calls on top of streaming API. For proper operation it required
2616 * this structure to save the driver state between each call of the read
2617 * or write function.
2618 */
2619struct vb2_fileio_data {
2620 struct v4l2_requestbuffers req;
2621 struct v4l2_buffer b;
2622 struct vb2_fileio_buf bufs[VIDEO_MAX_FRAME];
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002623 unsigned int cur_index;
2624 unsigned int initial_index;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002625 unsigned int q_count;
2626 unsigned int dq_count;
2627 unsigned int flags;
2628};
2629
2630/**
2631 * __vb2_init_fileio() - initialize file io emulator
2632 * @q: videobuf2 queue
2633 * @read: mode selector (1 means read, 0 means write)
2634 */
2635static int __vb2_init_fileio(struct vb2_queue *q, int read)
2636{
2637 struct vb2_fileio_data *fileio;
2638 int i, ret;
2639 unsigned int count = 0;
2640
2641 /*
2642 * Sanity check
2643 */
Hans Verkuile4d25812014-02-03 11:22:45 -03002644 if (WARN_ON((read && !(q->io_modes & VB2_READ)) ||
2645 (!read && !(q->io_modes & VB2_WRITE))))
2646 return -EINVAL;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002647
2648 /*
2649 * Check if device supports mapping buffers to kernel virtual space.
2650 */
2651 if (!q->mem_ops->vaddr)
2652 return -EBUSY;
2653
2654 /*
2655 * Check if streaming api has not been already activated.
2656 */
2657 if (q->streaming || q->num_buffers > 0)
2658 return -EBUSY;
2659
2660 /*
2661 * Start with count 1, driver can increase it in queue_setup()
2662 */
2663 count = 1;
2664
2665 dprintk(3, "setting up file io: mode %s, count %d, flags %08x\n",
2666 (read) ? "read" : "write", count, q->io_flags);
2667
2668 fileio = kzalloc(sizeof(struct vb2_fileio_data), GFP_KERNEL);
2669 if (fileio == NULL)
2670 return -ENOMEM;
2671
2672 fileio->flags = q->io_flags;
2673
2674 /*
2675 * Request buffers and use MMAP type to force driver
2676 * to allocate buffers by itself.
2677 */
2678 fileio->req.count = count;
2679 fileio->req.memory = V4L2_MEMORY_MMAP;
2680 fileio->req.type = q->type;
2681 ret = vb2_reqbufs(q, &fileio->req);
2682 if (ret)
2683 goto err_kfree;
2684
2685 /*
2686 * Check if plane_count is correct
2687 * (multiplane buffers are not supported).
2688 */
2689 if (q->bufs[0]->num_planes != 1) {
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002690 ret = -EBUSY;
2691 goto err_reqbufs;
2692 }
2693
2694 /*
2695 * Get kernel address of each buffer.
2696 */
2697 for (i = 0; i < q->num_buffers; i++) {
2698 fileio->bufs[i].vaddr = vb2_plane_vaddr(q->bufs[i], 0);
Wei Yongjun5dd69462013-05-13 01:48:45 -03002699 if (fileio->bufs[i].vaddr == NULL) {
2700 ret = -EINVAL;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002701 goto err_reqbufs;
Wei Yongjun5dd69462013-05-13 01:48:45 -03002702 }
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002703 fileio->bufs[i].size = vb2_plane_size(q->bufs[i], 0);
2704 }
2705
2706 /*
2707 * Read mode requires pre queuing of all buffers.
2708 */
2709 if (read) {
2710 /*
2711 * Queue all buffers.
2712 */
2713 for (i = 0; i < q->num_buffers; i++) {
2714 struct v4l2_buffer *b = &fileio->b;
2715 memset(b, 0, sizeof(*b));
2716 b->type = q->type;
2717 b->memory = q->memory;
2718 b->index = i;
2719 ret = vb2_qbuf(q, b);
2720 if (ret)
2721 goto err_reqbufs;
2722 fileio->bufs[i].queued = 1;
2723 }
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002724 /*
2725 * All buffers have been queued, so mark that by setting
2726 * initial_index to q->num_buffers
2727 */
2728 fileio->initial_index = q->num_buffers;
2729 fileio->cur_index = q->num_buffers;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002730 }
2731
Hans Verkuil02f142e2013-12-13 13:13:42 -03002732 /*
2733 * Start streaming.
2734 */
2735 ret = vb2_streamon(q, q->type);
2736 if (ret)
2737 goto err_reqbufs;
2738
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002739 q->fileio = fileio;
2740
2741 return ret;
2742
2743err_reqbufs:
Hans de Goedea67e1722012-05-08 14:47:39 -03002744 fileio->req.count = 0;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002745 vb2_reqbufs(q, &fileio->req);
2746
2747err_kfree:
2748 kfree(fileio);
2749 return ret;
2750}
2751
2752/**
2753 * __vb2_cleanup_fileio() - free resourced used by file io emulator
2754 * @q: videobuf2 queue
2755 */
2756static int __vb2_cleanup_fileio(struct vb2_queue *q)
2757{
2758 struct vb2_fileio_data *fileio = q->fileio;
2759
2760 if (fileio) {
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002761 vb2_internal_streamoff(q, q->type);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002762 q->fileio = NULL;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002763 fileio->req.count = 0;
2764 vb2_reqbufs(q, &fileio->req);
2765 kfree(fileio);
2766 dprintk(3, "file io emulator closed\n");
2767 }
2768 return 0;
2769}
2770
2771/**
2772 * __vb2_perform_fileio() - perform a single file io (read or write) operation
2773 * @q: videobuf2 queue
2774 * @data: pointed to target userspace buffer
2775 * @count: number of bytes to read or write
2776 * @ppos: file handle position tracking pointer
2777 * @nonblock: mode selector (1 means blocking calls, 0 means nonblocking)
2778 * @read: access mode selector (1 means read, 0 means write)
2779 */
2780static size_t __vb2_perform_fileio(struct vb2_queue *q, char __user *data, size_t count,
2781 loff_t *ppos, int nonblock, int read)
2782{
2783 struct vb2_fileio_data *fileio;
2784 struct vb2_fileio_buf *buf;
2785 int ret, index;
2786
Mauro Carvalho Chehab08b99e22011-01-11 17:12:34 -03002787 dprintk(3, "file io: mode %s, offset %ld, count %zd, %sblocking\n",
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002788 read ? "read" : "write", (long)*ppos, count,
2789 nonblock ? "non" : "");
2790
2791 if (!data)
2792 return -EINVAL;
2793
2794 /*
2795 * Initialize emulator on first call.
2796 */
2797 if (!q->fileio) {
2798 ret = __vb2_init_fileio(q, read);
2799 dprintk(3, "file io: vb2_init_fileio result: %d\n", ret);
2800 if (ret)
2801 return ret;
2802 }
2803 fileio = q->fileio;
2804
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002805 /*
2806 * Check if we need to dequeue the buffer.
2807 */
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002808 index = fileio->cur_index;
Hans Verkuil88e26872013-12-13 13:13:45 -03002809 if (index >= q->num_buffers) {
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002810 /*
2811 * Call vb2_dqbuf to get buffer back.
2812 */
2813 memset(&fileio->b, 0, sizeof(fileio->b));
2814 fileio->b.type = q->type;
2815 fileio->b.memory = q->memory;
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002816 ret = vb2_internal_dqbuf(q, &fileio->b, nonblock);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002817 dprintk(5, "file io: vb2_dqbuf result: %d\n", ret);
2818 if (ret)
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002819 return ret;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002820 fileio->dq_count += 1;
2821
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002822 fileio->cur_index = index = fileio->b.index;
Hans Verkuil88e26872013-12-13 13:13:45 -03002823 buf = &fileio->bufs[index];
2824
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002825 /*
2826 * Get number of bytes filled by the driver
2827 */
Hans Verkuil88e26872013-12-13 13:13:45 -03002828 buf->pos = 0;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002829 buf->queued = 0;
Hans Verkuil88e26872013-12-13 13:13:45 -03002830 buf->size = read ? vb2_get_plane_payload(q->bufs[index], 0)
2831 : vb2_plane_size(q->bufs[index], 0);
2832 } else {
2833 buf = &fileio->bufs[index];
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002834 }
2835
2836 /*
2837 * Limit count on last few bytes of the buffer.
2838 */
2839 if (buf->pos + count > buf->size) {
2840 count = buf->size - buf->pos;
Mauro Carvalho Chehab08b99e22011-01-11 17:12:34 -03002841 dprintk(5, "reducing read count: %zd\n", count);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002842 }
2843
2844 /*
2845 * Transfer data to userspace.
2846 */
Mauro Carvalho Chehab08b99e22011-01-11 17:12:34 -03002847 dprintk(3, "file io: copying %zd bytes - buffer %d, offset %u\n",
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002848 count, index, buf->pos);
2849 if (read)
2850 ret = copy_to_user(data, buf->vaddr + buf->pos, count);
2851 else
2852 ret = copy_from_user(buf->vaddr + buf->pos, data, count);
2853 if (ret) {
2854 dprintk(3, "file io: error copying data\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002855 return -EFAULT;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002856 }
2857
2858 /*
2859 * Update counters.
2860 */
2861 buf->pos += count;
2862 *ppos += count;
2863
2864 /*
2865 * Queue next buffer if required.
2866 */
2867 if (buf->pos == buf->size ||
2868 (!read && (fileio->flags & VB2_FILEIO_WRITE_IMMEDIATELY))) {
2869 /*
2870 * Check if this is the last buffer to read.
2871 */
2872 if (read && (fileio->flags & VB2_FILEIO_READ_ONCE) &&
2873 fileio->dq_count == 1) {
2874 dprintk(3, "file io: read limit reached\n");
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002875 return __vb2_cleanup_fileio(q);
2876 }
2877
2878 /*
2879 * Call vb2_qbuf and give buffer to the driver.
2880 */
2881 memset(&fileio->b, 0, sizeof(fileio->b));
2882 fileio->b.type = q->type;
2883 fileio->b.memory = q->memory;
2884 fileio->b.index = index;
2885 fileio->b.bytesused = buf->pos;
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002886 ret = vb2_internal_qbuf(q, &fileio->b);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002887 dprintk(5, "file io: vb2_dbuf result: %d\n", ret);
2888 if (ret)
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002889 return ret;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002890
2891 /*
2892 * Buffer has been queued, update the status
2893 */
2894 buf->pos = 0;
2895 buf->queued = 1;
Hans Verkuil88e26872013-12-13 13:13:45 -03002896 buf->size = vb2_plane_size(q->bufs[index], 0);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002897 fileio->q_count += 1;
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002898 /*
2899 * If we are queuing up buffers for the first time, then
2900 * increase initial_index by one.
2901 */
2902 if (fileio->initial_index < q->num_buffers)
2903 fileio->initial_index++;
2904 /*
2905 * The next buffer to use is either a buffer that's going to be
2906 * queued for the first time (initial_index < q->num_buffers)
2907 * or it is equal to q->num_buffers, meaning that the next
2908 * time we need to dequeue a buffer since we've now queued up
2909 * all the 'first time' buffers.
2910 */
2911 fileio->cur_index = fileio->initial_index;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002912 }
2913
2914 /*
2915 * Return proper number of bytes processed.
2916 */
2917 if (ret == 0)
2918 ret = count;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002919 return ret;
2920}
2921
2922size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count,
2923 loff_t *ppos, int nonblocking)
2924{
2925 return __vb2_perform_fileio(q, data, count, ppos, nonblocking, 1);
2926}
2927EXPORT_SYMBOL_GPL(vb2_read);
2928
Ricardo Ribalda819585b2013-08-28 04:39:29 -03002929size_t vb2_write(struct vb2_queue *q, const char __user *data, size_t count,
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002930 loff_t *ppos, int nonblocking)
2931{
Ricardo Ribalda819585b2013-08-28 04:39:29 -03002932 return __vb2_perform_fileio(q, (char __user *) data, count,
2933 ppos, nonblocking, 0);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002934}
2935EXPORT_SYMBOL_GPL(vb2_write);
2936
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03002937
2938/*
2939 * The following functions are not part of the vb2 core API, but are helper
2940 * functions that plug into struct v4l2_ioctl_ops, struct v4l2_file_operations
2941 * and struct vb2_ops.
2942 * They contain boilerplate code that most if not all drivers have to do
2943 * and so they simplify the driver code.
2944 */
2945
2946/* The queue is busy if there is a owner and you are not that owner. */
2947static inline bool vb2_queue_is_busy(struct video_device *vdev, struct file *file)
2948{
2949 return vdev->queue->owner && vdev->queue->owner != file->private_data;
2950}
2951
2952/* vb2 ioctl helpers */
2953
2954int vb2_ioctl_reqbufs(struct file *file, void *priv,
2955 struct v4l2_requestbuffers *p)
2956{
2957 struct video_device *vdev = video_devdata(file);
2958 int res = __verify_memory_type(vdev->queue, p->memory, p->type);
2959
2960 if (res)
2961 return res;
2962 if (vb2_queue_is_busy(vdev, file))
2963 return -EBUSY;
2964 res = __reqbufs(vdev->queue, p);
2965 /* If count == 0, then the owner has released all buffers and he
2966 is no longer owner of the queue. Otherwise we have a new owner. */
2967 if (res == 0)
2968 vdev->queue->owner = p->count ? file->private_data : NULL;
2969 return res;
2970}
2971EXPORT_SYMBOL_GPL(vb2_ioctl_reqbufs);
2972
2973int vb2_ioctl_create_bufs(struct file *file, void *priv,
2974 struct v4l2_create_buffers *p)
2975{
2976 struct video_device *vdev = video_devdata(file);
2977 int res = __verify_memory_type(vdev->queue, p->memory, p->format.type);
2978
2979 p->index = vdev->queue->num_buffers;
2980 /* If count == 0, then just check if memory and type are valid.
2981 Any -EBUSY result from __verify_memory_type can be mapped to 0. */
2982 if (p->count == 0)
2983 return res != -EBUSY ? res : 0;
2984 if (res)
2985 return res;
2986 if (vb2_queue_is_busy(vdev, file))
2987 return -EBUSY;
2988 res = __create_bufs(vdev->queue, p);
2989 if (res == 0)
2990 vdev->queue->owner = file->private_data;
2991 return res;
2992}
2993EXPORT_SYMBOL_GPL(vb2_ioctl_create_bufs);
2994
2995int vb2_ioctl_prepare_buf(struct file *file, void *priv,
2996 struct v4l2_buffer *p)
2997{
2998 struct video_device *vdev = video_devdata(file);
2999
3000 if (vb2_queue_is_busy(vdev, file))
3001 return -EBUSY;
3002 return vb2_prepare_buf(vdev->queue, p);
3003}
3004EXPORT_SYMBOL_GPL(vb2_ioctl_prepare_buf);
3005
3006int vb2_ioctl_querybuf(struct file *file, void *priv, struct v4l2_buffer *p)
3007{
3008 struct video_device *vdev = video_devdata(file);
3009
3010 /* No need to call vb2_queue_is_busy(), anyone can query buffers. */
3011 return vb2_querybuf(vdev->queue, p);
3012}
3013EXPORT_SYMBOL_GPL(vb2_ioctl_querybuf);
3014
3015int vb2_ioctl_qbuf(struct file *file, void *priv, struct v4l2_buffer *p)
3016{
3017 struct video_device *vdev = video_devdata(file);
3018
3019 if (vb2_queue_is_busy(vdev, file))
3020 return -EBUSY;
3021 return vb2_qbuf(vdev->queue, p);
3022}
3023EXPORT_SYMBOL_GPL(vb2_ioctl_qbuf);
3024
3025int vb2_ioctl_dqbuf(struct file *file, void *priv, struct v4l2_buffer *p)
3026{
3027 struct video_device *vdev = video_devdata(file);
3028
3029 if (vb2_queue_is_busy(vdev, file))
3030 return -EBUSY;
3031 return vb2_dqbuf(vdev->queue, p, file->f_flags & O_NONBLOCK);
3032}
3033EXPORT_SYMBOL_GPL(vb2_ioctl_dqbuf);
3034
3035int vb2_ioctl_streamon(struct file *file, void *priv, enum v4l2_buf_type i)
3036{
3037 struct video_device *vdev = video_devdata(file);
3038
3039 if (vb2_queue_is_busy(vdev, file))
3040 return -EBUSY;
3041 return vb2_streamon(vdev->queue, i);
3042}
3043EXPORT_SYMBOL_GPL(vb2_ioctl_streamon);
3044
3045int vb2_ioctl_streamoff(struct file *file, void *priv, enum v4l2_buf_type i)
3046{
3047 struct video_device *vdev = video_devdata(file);
3048
3049 if (vb2_queue_is_busy(vdev, file))
3050 return -EBUSY;
3051 return vb2_streamoff(vdev->queue, i);
3052}
3053EXPORT_SYMBOL_GPL(vb2_ioctl_streamoff);
3054
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03003055int vb2_ioctl_expbuf(struct file *file, void *priv, struct v4l2_exportbuffer *p)
3056{
3057 struct video_device *vdev = video_devdata(file);
3058
3059 if (vb2_queue_is_busy(vdev, file))
3060 return -EBUSY;
3061 return vb2_expbuf(vdev->queue, p);
3062}
3063EXPORT_SYMBOL_GPL(vb2_ioctl_expbuf);
3064
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003065/* v4l2_file_operations helpers */
3066
3067int vb2_fop_mmap(struct file *file, struct vm_area_struct *vma)
3068{
3069 struct video_device *vdev = video_devdata(file);
Laurent Pinchart8a90f1a2013-08-02 13:55:21 -03003070 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
3071 int err;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003072
Laurent Pinchart8a90f1a2013-08-02 13:55:21 -03003073 if (lock && mutex_lock_interruptible(lock))
3074 return -ERESTARTSYS;
3075 err = vb2_mmap(vdev->queue, vma);
3076 if (lock)
3077 mutex_unlock(lock);
3078 return err;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003079}
3080EXPORT_SYMBOL_GPL(vb2_fop_mmap);
3081
Ricardo Ribalda1380f572013-11-25 05:49:02 -03003082int _vb2_fop_release(struct file *file, struct mutex *lock)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003083{
3084 struct video_device *vdev = video_devdata(file);
3085
3086 if (file->private_data == vdev->queue->owner) {
Ricardo Ribalda1380f572013-11-25 05:49:02 -03003087 if (lock)
3088 mutex_lock(lock);
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003089 vb2_queue_release(vdev->queue);
3090 vdev->queue->owner = NULL;
Ricardo Ribalda1380f572013-11-25 05:49:02 -03003091 if (lock)
3092 mutex_unlock(lock);
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003093 }
3094 return v4l2_fh_release(file);
3095}
Ricardo Ribalda1380f572013-11-25 05:49:02 -03003096EXPORT_SYMBOL_GPL(_vb2_fop_release);
3097
3098int vb2_fop_release(struct file *file)
3099{
3100 struct video_device *vdev = video_devdata(file);
3101 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
3102
3103 return _vb2_fop_release(file, lock);
3104}
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003105EXPORT_SYMBOL_GPL(vb2_fop_release);
3106
Ricardo Ribalda819585b2013-08-28 04:39:29 -03003107ssize_t vb2_fop_write(struct file *file, const char __user *buf,
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003108 size_t count, loff_t *ppos)
3109{
3110 struct video_device *vdev = video_devdata(file);
3111 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003112 int err = -EBUSY;
3113
Hans Verkuilcf533732012-07-31 04:02:25 -03003114 if (lock && mutex_lock_interruptible(lock))
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003115 return -ERESTARTSYS;
3116 if (vb2_queue_is_busy(vdev, file))
3117 goto exit;
3118 err = vb2_write(vdev->queue, buf, count, ppos,
3119 file->f_flags & O_NONBLOCK);
Hans Verkuil8c82c752012-09-07 12:50:02 -03003120 if (vdev->queue->fileio)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003121 vdev->queue->owner = file->private_data;
3122exit:
Hans Verkuilcf533732012-07-31 04:02:25 -03003123 if (lock)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003124 mutex_unlock(lock);
3125 return err;
3126}
3127EXPORT_SYMBOL_GPL(vb2_fop_write);
3128
3129ssize_t vb2_fop_read(struct file *file, char __user *buf,
3130 size_t count, loff_t *ppos)
3131{
3132 struct video_device *vdev = video_devdata(file);
3133 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003134 int err = -EBUSY;
3135
Hans Verkuilcf533732012-07-31 04:02:25 -03003136 if (lock && mutex_lock_interruptible(lock))
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003137 return -ERESTARTSYS;
3138 if (vb2_queue_is_busy(vdev, file))
3139 goto exit;
3140 err = vb2_read(vdev->queue, buf, count, ppos,
3141 file->f_flags & O_NONBLOCK);
Hans Verkuil8c82c752012-09-07 12:50:02 -03003142 if (vdev->queue->fileio)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003143 vdev->queue->owner = file->private_data;
3144exit:
Hans Verkuilcf533732012-07-31 04:02:25 -03003145 if (lock)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003146 mutex_unlock(lock);
3147 return err;
3148}
3149EXPORT_SYMBOL_GPL(vb2_fop_read);
3150
3151unsigned int vb2_fop_poll(struct file *file, poll_table *wait)
3152{
3153 struct video_device *vdev = video_devdata(file);
3154 struct vb2_queue *q = vdev->queue;
3155 struct mutex *lock = q->lock ? q->lock : vdev->lock;
3156 unsigned long req_events = poll_requested_events(wait);
3157 unsigned res;
3158 void *fileio;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003159 bool must_lock = false;
3160
3161 /* Try to be smart: only lock if polling might start fileio,
3162 otherwise locking will only introduce unwanted delays. */
3163 if (q->num_buffers == 0 && q->fileio == NULL) {
3164 if (!V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_READ) &&
3165 (req_events & (POLLIN | POLLRDNORM)))
3166 must_lock = true;
3167 else if (V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_WRITE) &&
3168 (req_events & (POLLOUT | POLLWRNORM)))
3169 must_lock = true;
3170 }
3171
3172 /* If locking is needed, but this helper doesn't know how, then you
3173 shouldn't be using this helper but you should write your own. */
Hans Verkuilcf533732012-07-31 04:02:25 -03003174 WARN_ON(must_lock && !lock);
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003175
Hans Verkuilcf533732012-07-31 04:02:25 -03003176 if (must_lock && lock && mutex_lock_interruptible(lock))
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003177 return POLLERR;
3178
3179 fileio = q->fileio;
3180
3181 res = vb2_poll(vdev->queue, file, wait);
3182
3183 /* If fileio was started, then we have a new queue owner. */
3184 if (must_lock && !fileio && q->fileio)
3185 q->owner = file->private_data;
Hans Verkuilcf533732012-07-31 04:02:25 -03003186 if (must_lock && lock)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003187 mutex_unlock(lock);
3188 return res;
3189}
3190EXPORT_SYMBOL_GPL(vb2_fop_poll);
3191
3192#ifndef CONFIG_MMU
3193unsigned long vb2_fop_get_unmapped_area(struct file *file, unsigned long addr,
3194 unsigned long len, unsigned long pgoff, unsigned long flags)
3195{
3196 struct video_device *vdev = video_devdata(file);
Laurent Pinchart8a90f1a2013-08-02 13:55:21 -03003197 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
3198 int ret;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003199
Laurent Pinchart8a90f1a2013-08-02 13:55:21 -03003200 if (lock && mutex_lock_interruptible(lock))
3201 return -ERESTARTSYS;
3202 ret = vb2_get_unmapped_area(vdev->queue, addr, len, pgoff, flags);
3203 if (lock)
3204 mutex_unlock(lock);
3205 return ret;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003206}
3207EXPORT_SYMBOL_GPL(vb2_fop_get_unmapped_area);
3208#endif
3209
3210/* vb2_ops helpers. Only use if vq->lock is non-NULL. */
3211
3212void vb2_ops_wait_prepare(struct vb2_queue *vq)
3213{
3214 mutex_unlock(vq->lock);
3215}
3216EXPORT_SYMBOL_GPL(vb2_ops_wait_prepare);
3217
3218void vb2_ops_wait_finish(struct vb2_queue *vq)
3219{
3220 mutex_lock(vq->lock);
3221}
3222EXPORT_SYMBOL_GPL(vb2_ops_wait_finish);
3223
Pawel Osciake23ccc02010-10-11 10:56:41 -03003224MODULE_DESCRIPTION("Driver helper framework for Video for Linux 2");
Pawel Osciak95072082011-03-13 15:23:32 -03003225MODULE_AUTHOR("Pawel Osciak <pawel@osciak.com>, Marek Szyprowski");
Pawel Osciake23ccc02010-10-11 10:56:41 -03003226MODULE_LICENSE("GPL");