blob: a5c41cc65d1c7024d28e5a5b35c6caa93abaeab4 [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 *
Hans Verkuil3415a892014-04-14 07:33:00 -03009 * The vb2_thread implementation was based on code from videobuf-dvb.c:
10 * (c) 2004 Gerd Knorr <kraxel@bytesex.org> [SUSE Labs]
11 *
Pawel Osciake23ccc02010-10-11 10:56:41 -030012 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation.
15 */
16
17#include <linux/err.h>
18#include <linux/kernel.h>
19#include <linux/module.h>
20#include <linux/mm.h>
21#include <linux/poll.h>
22#include <linux/slab.h>
23#include <linux/sched.h>
Hans Verkuil3415a892014-04-14 07:33:00 -030024#include <linux/freezer.h>
25#include <linux/kthread.h>
Pawel Osciake23ccc02010-10-11 10:56:41 -030026
Hans Verkuil95213ce2011-07-13 04:26:52 -030027#include <media/v4l2-dev.h>
28#include <media/v4l2-fh.h>
29#include <media/v4l2-event.h>
Hans Verkuilebd7c502014-04-11 04:36:57 -030030#include <media/v4l2-common.h>
Pawel Osciake23ccc02010-10-11 10:56:41 -030031#include <media/videobuf2-core.h>
32
33static int debug;
34module_param(debug, int, 0644);
35
Hans Verkuilfd4354c2014-04-07 09:08:47 -030036#define dprintk(level, fmt, arg...) \
37 do { \
38 if (debug >= level) \
39 pr_debug("vb2: %s: " fmt, __func__, ## arg); \
Pawel Osciake23ccc02010-10-11 10:56:41 -030040 } while (0)
41
Hans Verkuilb5b45412014-01-29 11:53:25 -030042#ifdef CONFIG_VIDEO_ADV_DEBUG
43
44/*
Hans Verkuila1d36d82014-03-17 09:54:21 -030045 * If advanced debugging is on, then count how often each op is called
46 * successfully, which can either be per-buffer or per-queue.
Hans Verkuilb5b45412014-01-29 11:53:25 -030047 *
Hans Verkuila1d36d82014-03-17 09:54:21 -030048 * This makes it easy to check that the 'init' and 'cleanup'
Hans Verkuilb5b45412014-01-29 11:53:25 -030049 * (and variations thereof) stay balanced.
50 */
51
Hans Verkuila1d36d82014-03-17 09:54:21 -030052#define log_memop(vb, op) \
53 dprintk(2, "call_memop(%p, %d, %s)%s\n", \
54 (vb)->vb2_queue, (vb)->v4l2_buf.index, #op, \
55 (vb)->vb2_queue->mem_ops->op ? "" : " (nop)")
56
Hans Verkuilb5b45412014-01-29 11:53:25 -030057#define call_memop(vb, op, args...) \
58({ \
59 struct vb2_queue *_q = (vb)->vb2_queue; \
Hans Verkuila1d36d82014-03-17 09:54:21 -030060 int err; \
61 \
62 log_memop(vb, op); \
63 err = _q->mem_ops->op ? _q->mem_ops->op(args) : 0; \
64 if (!err) \
65 (vb)->cnt_mem_ ## op++; \
66 err; \
Hans Verkuilb5b45412014-01-29 11:53:25 -030067})
Hans Verkuila1d36d82014-03-17 09:54:21 -030068
69#define call_ptr_memop(vb, op, args...) \
70({ \
71 struct vb2_queue *_q = (vb)->vb2_queue; \
72 void *ptr; \
73 \
74 log_memop(vb, op); \
75 ptr = _q->mem_ops->op ? _q->mem_ops->op(args) : NULL; \
76 if (!IS_ERR_OR_NULL(ptr)) \
77 (vb)->cnt_mem_ ## op++; \
78 ptr; \
79})
80
81#define call_void_memop(vb, op, args...) \
82({ \
83 struct vb2_queue *_q = (vb)->vb2_queue; \
84 \
85 log_memop(vb, op); \
86 if (_q->mem_ops->op) \
87 _q->mem_ops->op(args); \
88 (vb)->cnt_mem_ ## op++; \
89})
90
91#define log_qop(q, op) \
92 dprintk(2, "call_qop(%p, %s)%s\n", q, #op, \
93 (q)->ops->op ? "" : " (nop)")
Pawel Osciake23ccc02010-10-11 10:56:41 -030094
95#define call_qop(q, op, args...) \
Hans Verkuilb5b45412014-01-29 11:53:25 -030096({ \
Hans Verkuila1d36d82014-03-17 09:54:21 -030097 int err; \
98 \
99 log_qop(q, op); \
100 err = (q)->ops->op ? (q)->ops->op(args) : 0; \
101 if (!err) \
102 (q)->cnt_ ## op++; \
103 err; \
Hans Verkuilb5b45412014-01-29 11:53:25 -0300104})
Hans Verkuila1d36d82014-03-17 09:54:21 -0300105
106#define call_void_qop(q, op, args...) \
107({ \
108 log_qop(q, op); \
109 if ((q)->ops->op) \
110 (q)->ops->op(args); \
111 (q)->cnt_ ## op++; \
112})
113
114#define log_vb_qop(vb, op, args...) \
115 dprintk(2, "call_vb_qop(%p, %d, %s)%s\n", \
116 (vb)->vb2_queue, (vb)->v4l2_buf.index, #op, \
117 (vb)->vb2_queue->ops->op ? "" : " (nop)")
Hans Verkuilb5b45412014-01-29 11:53:25 -0300118
119#define call_vb_qop(vb, op, args...) \
120({ \
Hans Verkuila1d36d82014-03-17 09:54:21 -0300121 int err; \
122 \
123 log_vb_qop(vb, op); \
124 err = (vb)->vb2_queue->ops->op ? \
125 (vb)->vb2_queue->ops->op(args) : 0; \
126 if (!err) \
127 (vb)->cnt_ ## op++; \
128 err; \
Hans Verkuilb5b45412014-01-29 11:53:25 -0300129})
Hans Verkuila1d36d82014-03-17 09:54:21 -0300130
131#define call_void_vb_qop(vb, op, args...) \
132({ \
133 log_vb_qop(vb, op); \
134 if ((vb)->vb2_queue->ops->op) \
135 (vb)->vb2_queue->ops->op(args); \
136 (vb)->cnt_ ## op++; \
137})
Hans Verkuilb5b45412014-01-29 11:53:25 -0300138
139#else
140
141#define call_memop(vb, op, args...) \
Hans Verkuila1d36d82014-03-17 09:54:21 -0300142 ((vb)->vb2_queue->mem_ops->op ? \
143 (vb)->vb2_queue->mem_ops->op(args) : 0)
144
145#define call_ptr_memop(vb, op, args...) \
146 ((vb)->vb2_queue->mem_ops->op ? \
147 (vb)->vb2_queue->mem_ops->op(args) : NULL)
148
149#define call_void_memop(vb, op, args...) \
150 do { \
151 if ((vb)->vb2_queue->mem_ops->op) \
152 (vb)->vb2_queue->mem_ops->op(args); \
153 } while (0)
Hans Verkuilb5b45412014-01-29 11:53:25 -0300154
155#define call_qop(q, op, args...) \
156 ((q)->ops->op ? (q)->ops->op(args) : 0)
Hans Verkuila1d36d82014-03-17 09:54:21 -0300157
158#define call_void_qop(q, op, args...) \
159 do { \
160 if ((q)->ops->op) \
161 (q)->ops->op(args); \
162 } while (0)
Hans Verkuilb5b45412014-01-29 11:53:25 -0300163
164#define call_vb_qop(vb, op, args...) \
165 ((vb)->vb2_queue->ops->op ? (vb)->vb2_queue->ops->op(args) : 0)
Hans Verkuila1d36d82014-03-17 09:54:21 -0300166
167#define call_void_vb_qop(vb, op, args...) \
168 do { \
169 if ((vb)->vb2_queue->ops->op) \
170 (vb)->vb2_queue->ops->op(args); \
171 } while (0)
Hans Verkuilb5b45412014-01-29 11:53:25 -0300172
173#endif
Pawel Osciake23ccc02010-10-11 10:56:41 -0300174
Hans Verkuilf1343282014-02-24 14:44:50 -0300175/* Flags that are set by the vb2 core */
Sakari Ailus1b18e7a2012-10-22 17:10:16 -0300176#define V4L2_BUFFER_MASK_FLAGS (V4L2_BUF_FLAG_MAPPED | V4L2_BUF_FLAG_QUEUED | \
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300177 V4L2_BUF_FLAG_DONE | V4L2_BUF_FLAG_ERROR | \
Sakari Ailus1b18e7a2012-10-22 17:10:16 -0300178 V4L2_BUF_FLAG_PREPARED | \
179 V4L2_BUF_FLAG_TIMESTAMP_MASK)
Hans Verkuilf1343282014-02-24 14:44:50 -0300180/* Output buffer flags that should be passed on to the driver */
181#define V4L2_BUFFER_OUT_FLAGS (V4L2_BUF_FLAG_PFRAME | V4L2_BUF_FLAG_BFRAME | \
182 V4L2_BUF_FLAG_KEYFRAME | V4L2_BUF_FLAG_TIMECODE)
Marek Szyprowskiea42c8e2011-04-12 10:14:13 -0300183
Hans Verkuilfb64dca2014-02-28 12:49:18 -0300184static void __vb2_queue_cancel(struct vb2_queue *q);
185
Pawel Osciake23ccc02010-10-11 10:56:41 -0300186/**
187 * __vb2_buf_mem_alloc() - allocate video memory for the given buffer
188 */
Marek Szyprowskic1426bc2011-08-24 06:36:26 -0300189static int __vb2_buf_mem_alloc(struct vb2_buffer *vb)
Pawel Osciake23ccc02010-10-11 10:56:41 -0300190{
191 struct vb2_queue *q = vb->vb2_queue;
192 void *mem_priv;
193 int plane;
194
Mauro Carvalho Chehab7f841452013-04-19 07:18:01 -0300195 /*
196 * Allocate memory for all planes in this buffer
197 * NOTE: mmapped areas should be page aligned
198 */
Pawel Osciake23ccc02010-10-11 10:56:41 -0300199 for (plane = 0; plane < vb->num_planes; ++plane) {
Mauro Carvalho Chehab7f841452013-04-19 07:18:01 -0300200 unsigned long size = PAGE_ALIGN(q->plane_sizes[plane]);
201
Hans Verkuila1d36d82014-03-17 09:54:21 -0300202 mem_priv = call_ptr_memop(vb, alloc, q->alloc_ctx[plane],
Mauro Carvalho Chehab7f841452013-04-19 07:18:01 -0300203 size, q->gfp_flags);
Guennadi Liakhovetski62a79432011-03-22 09:24:58 -0300204 if (IS_ERR_OR_NULL(mem_priv))
Pawel Osciake23ccc02010-10-11 10:56:41 -0300205 goto free;
206
207 /* Associate allocator private data with this plane */
208 vb->planes[plane].mem_priv = mem_priv;
Marek Szyprowskic1426bc2011-08-24 06:36:26 -0300209 vb->v4l2_planes[plane].length = q->plane_sizes[plane];
Pawel Osciake23ccc02010-10-11 10:56:41 -0300210 }
211
212 return 0;
213free:
214 /* Free already allocated memory if one of the allocations failed */
Marek Szyprowskia00d0262011-12-15 05:53:06 -0300215 for (; plane > 0; --plane) {
Hans Verkuila1d36d82014-03-17 09:54:21 -0300216 call_void_memop(vb, put, vb->planes[plane - 1].mem_priv);
Marek Szyprowskia00d0262011-12-15 05:53:06 -0300217 vb->planes[plane - 1].mem_priv = NULL;
218 }
Pawel Osciake23ccc02010-10-11 10:56:41 -0300219
220 return -ENOMEM;
221}
222
223/**
224 * __vb2_buf_mem_free() - free memory of the given buffer
225 */
226static void __vb2_buf_mem_free(struct vb2_buffer *vb)
227{
Pawel Osciake23ccc02010-10-11 10:56:41 -0300228 unsigned int plane;
229
230 for (plane = 0; plane < vb->num_planes; ++plane) {
Hans Verkuila1d36d82014-03-17 09:54:21 -0300231 call_void_memop(vb, put, vb->planes[plane].mem_priv);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300232 vb->planes[plane].mem_priv = NULL;
Hans Verkuil30500402014-04-07 09:13:22 -0300233 dprintk(3, "freed plane %d of buffer %d\n", plane,
Marek Szyprowskia00d0262011-12-15 05:53:06 -0300234 vb->v4l2_buf.index);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300235 }
236}
237
238/**
239 * __vb2_buf_userptr_put() - release userspace memory associated with
240 * a USERPTR buffer
241 */
242static void __vb2_buf_userptr_put(struct vb2_buffer *vb)
243{
Pawel Osciake23ccc02010-10-11 10:56:41 -0300244 unsigned int plane;
245
246 for (plane = 0; plane < vb->num_planes; ++plane) {
Marek Szyprowskia00d0262011-12-15 05:53:06 -0300247 if (vb->planes[plane].mem_priv)
Hans Verkuila1d36d82014-03-17 09:54:21 -0300248 call_void_memop(vb, put_userptr, vb->planes[plane].mem_priv);
Marek Szyprowskia00d0262011-12-15 05:53:06 -0300249 vb->planes[plane].mem_priv = NULL;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300250 }
251}
252
253/**
Sumit Semwalc5384042012-06-14 10:37:37 -0300254 * __vb2_plane_dmabuf_put() - release memory associated with
255 * a DMABUF shared plane
256 */
Hans Verkuilb5b45412014-01-29 11:53:25 -0300257static void __vb2_plane_dmabuf_put(struct vb2_buffer *vb, struct vb2_plane *p)
Sumit Semwalc5384042012-06-14 10:37:37 -0300258{
259 if (!p->mem_priv)
260 return;
261
262 if (p->dbuf_mapped)
Hans Verkuila1d36d82014-03-17 09:54:21 -0300263 call_void_memop(vb, unmap_dmabuf, p->mem_priv);
Sumit Semwalc5384042012-06-14 10:37:37 -0300264
Hans Verkuila1d36d82014-03-17 09:54:21 -0300265 call_void_memop(vb, detach_dmabuf, p->mem_priv);
Sumit Semwalc5384042012-06-14 10:37:37 -0300266 dma_buf_put(p->dbuf);
267 memset(p, 0, sizeof(*p));
268}
269
270/**
271 * __vb2_buf_dmabuf_put() - release memory associated with
272 * a DMABUF shared buffer
273 */
274static void __vb2_buf_dmabuf_put(struct vb2_buffer *vb)
275{
Sumit Semwalc5384042012-06-14 10:37:37 -0300276 unsigned int plane;
277
278 for (plane = 0; plane < vb->num_planes; ++plane)
Hans Verkuilb5b45412014-01-29 11:53:25 -0300279 __vb2_plane_dmabuf_put(vb, &vb->planes[plane]);
Sumit Semwalc5384042012-06-14 10:37:37 -0300280}
281
282/**
Hans Verkuila5e3d742013-12-04 15:14:05 +0100283 * __setup_lengths() - setup initial lengths for every plane in
284 * every buffer on the queue
285 */
286static void __setup_lengths(struct vb2_queue *q, unsigned int n)
287{
288 unsigned int buffer, plane;
289 struct vb2_buffer *vb;
290
291 for (buffer = q->num_buffers; buffer < q->num_buffers + n; ++buffer) {
292 vb = q->bufs[buffer];
293 if (!vb)
294 continue;
295
296 for (plane = 0; plane < vb->num_planes; ++plane)
297 vb->v4l2_planes[plane].length = q->plane_sizes[plane];
298 }
299}
300
301/**
Pawel Osciake23ccc02010-10-11 10:56:41 -0300302 * __setup_offsets() - setup unique offsets ("cookies") for every plane in
303 * every buffer on the queue
304 */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300305static void __setup_offsets(struct vb2_queue *q, unsigned int n)
Pawel Osciake23ccc02010-10-11 10:56:41 -0300306{
307 unsigned int buffer, plane;
308 struct vb2_buffer *vb;
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300309 unsigned long off;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300310
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300311 if (q->num_buffers) {
312 struct v4l2_plane *p;
313 vb = q->bufs[q->num_buffers - 1];
314 p = &vb->v4l2_planes[vb->num_planes - 1];
315 off = PAGE_ALIGN(p->m.mem_offset + p->length);
316 } else {
317 off = 0;
318 }
319
320 for (buffer = q->num_buffers; buffer < q->num_buffers + n; ++buffer) {
Pawel Osciake23ccc02010-10-11 10:56:41 -0300321 vb = q->bufs[buffer];
322 if (!vb)
323 continue;
324
325 for (plane = 0; plane < vb->num_planes; ++plane) {
326 vb->v4l2_planes[plane].m.mem_offset = off;
327
Hans Verkuil30500402014-04-07 09:13:22 -0300328 dprintk(3, "buffer %d, plane %d offset 0x%08lx\n",
Pawel Osciake23ccc02010-10-11 10:56:41 -0300329 buffer, plane, off);
330
331 off += vb->v4l2_planes[plane].length;
332 off = PAGE_ALIGN(off);
333 }
334 }
335}
336
337/**
338 * __vb2_queue_alloc() - allocate videobuf buffer structures and (for MMAP type)
339 * video buffer memory for all buffers/planes on the queue and initializes the
340 * queue
341 *
342 * Returns the number of buffers successfully allocated.
343 */
344static int __vb2_queue_alloc(struct vb2_queue *q, enum v4l2_memory memory,
Marek Szyprowskic1426bc2011-08-24 06:36:26 -0300345 unsigned int num_buffers, unsigned int num_planes)
Pawel Osciake23ccc02010-10-11 10:56:41 -0300346{
347 unsigned int buffer;
348 struct vb2_buffer *vb;
349 int ret;
350
351 for (buffer = 0; buffer < num_buffers; ++buffer) {
352 /* Allocate videobuf buffer structures */
353 vb = kzalloc(q->buf_struct_size, GFP_KERNEL);
354 if (!vb) {
Hans Verkuil30500402014-04-07 09:13:22 -0300355 dprintk(1, "memory alloc for buffer struct failed\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -0300356 break;
357 }
358
359 /* Length stores number of planes for multiplanar buffers */
360 if (V4L2_TYPE_IS_MULTIPLANAR(q->type))
361 vb->v4l2_buf.length = num_planes;
362
363 vb->state = VB2_BUF_STATE_DEQUEUED;
364 vb->vb2_queue = q;
365 vb->num_planes = num_planes;
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300366 vb->v4l2_buf.index = q->num_buffers + buffer;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300367 vb->v4l2_buf.type = q->type;
368 vb->v4l2_buf.memory = memory;
369
370 /* Allocate video buffer memory for the MMAP type */
371 if (memory == V4L2_MEMORY_MMAP) {
Marek Szyprowskic1426bc2011-08-24 06:36:26 -0300372 ret = __vb2_buf_mem_alloc(vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300373 if (ret) {
Hans Verkuil30500402014-04-07 09:13:22 -0300374 dprintk(1, "failed allocating memory for "
Pawel Osciake23ccc02010-10-11 10:56:41 -0300375 "buffer %d\n", buffer);
376 kfree(vb);
377 break;
378 }
379 /*
380 * Call the driver-provided buffer initialization
381 * callback, if given. An error in initialization
382 * results in queue setup failure.
383 */
Hans Verkuilb5b45412014-01-29 11:53:25 -0300384 ret = call_vb_qop(vb, buf_init, vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300385 if (ret) {
Hans Verkuil30500402014-04-07 09:13:22 -0300386 dprintk(1, "buffer %d %p initialization"
Pawel Osciake23ccc02010-10-11 10:56:41 -0300387 " failed\n", buffer, vb);
388 __vb2_buf_mem_free(vb);
389 kfree(vb);
390 break;
391 }
392 }
393
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300394 q->bufs[q->num_buffers + buffer] = vb;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300395 }
396
Hans Verkuila5e3d742013-12-04 15:14:05 +0100397 __setup_lengths(q, buffer);
Philipp Zabeldc775232013-09-19 04:37:29 -0300398 if (memory == V4L2_MEMORY_MMAP)
399 __setup_offsets(q, buffer);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300400
Hans Verkuil30500402014-04-07 09:13:22 -0300401 dprintk(1, "allocated %d buffers, %d plane(s) each\n",
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300402 buffer, num_planes);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300403
404 return buffer;
405}
406
407/**
408 * __vb2_free_mem() - release all video buffer memory for a given queue
409 */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300410static void __vb2_free_mem(struct vb2_queue *q, unsigned int buffers)
Pawel Osciake23ccc02010-10-11 10:56:41 -0300411{
412 unsigned int buffer;
413 struct vb2_buffer *vb;
414
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300415 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
416 ++buffer) {
Pawel Osciake23ccc02010-10-11 10:56:41 -0300417 vb = q->bufs[buffer];
418 if (!vb)
419 continue;
420
421 /* Free MMAP buffers or release USERPTR buffers */
422 if (q->memory == V4L2_MEMORY_MMAP)
423 __vb2_buf_mem_free(vb);
Sumit Semwalc5384042012-06-14 10:37:37 -0300424 else if (q->memory == V4L2_MEMORY_DMABUF)
425 __vb2_buf_dmabuf_put(vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300426 else
427 __vb2_buf_userptr_put(vb);
428 }
429}
430
431/**
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300432 * __vb2_queue_free() - free buffers at the end of the queue - video memory and
433 * related information, if no buffers are left return the queue to an
434 * uninitialized state. Might be called even if the queue has already been freed.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300435 */
Hans Verkuil63faabf2013-12-13 13:13:40 -0300436static int __vb2_queue_free(struct vb2_queue *q, unsigned int buffers)
Pawel Osciake23ccc02010-10-11 10:56:41 -0300437{
438 unsigned int buffer;
439
Hans Verkuil63faabf2013-12-13 13:13:40 -0300440 /*
441 * Sanity check: when preparing a buffer the queue lock is released for
442 * a short while (see __buf_prepare for the details), which would allow
443 * a race with a reqbufs which can call this function. Removing the
444 * buffers from underneath __buf_prepare is obviously a bad idea, so we
445 * check if any of the buffers is in the state PREPARING, and if so we
446 * just return -EAGAIN.
447 */
448 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
449 ++buffer) {
450 if (q->bufs[buffer] == NULL)
451 continue;
452 if (q->bufs[buffer]->state == VB2_BUF_STATE_PREPARING) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300453 dprintk(1, "preparing buffers, cannot free\n");
Hans Verkuil63faabf2013-12-13 13:13:40 -0300454 return -EAGAIN;
455 }
456 }
457
Pawel Osciake23ccc02010-10-11 10:56:41 -0300458 /* Call driver-provided cleanup function for each buffer, if provided */
Hans Verkuilb5b45412014-01-29 11:53:25 -0300459 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
460 ++buffer) {
Hans Verkuil256f3162014-01-29 13:36:53 -0300461 struct vb2_buffer *vb = q->bufs[buffer];
462
463 if (vb && vb->planes[0].mem_priv)
Hans Verkuila1d36d82014-03-17 09:54:21 -0300464 call_void_vb_qop(vb, buf_cleanup, vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300465 }
466
467 /* Release video buffer memory */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300468 __vb2_free_mem(q, buffers);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300469
Hans Verkuilb5b45412014-01-29 11:53:25 -0300470#ifdef CONFIG_VIDEO_ADV_DEBUG
471 /*
472 * Check that all the calls were balances during the life-time of this
473 * queue. If not (or if the debug level is 1 or up), then dump the
474 * counters to the kernel log.
475 */
476 if (q->num_buffers) {
477 bool unbalanced = q->cnt_start_streaming != q->cnt_stop_streaming ||
478 q->cnt_wait_prepare != q->cnt_wait_finish;
479
480 if (unbalanced || debug) {
481 pr_info("vb2: counters for queue %p:%s\n", q,
482 unbalanced ? " UNBALANCED!" : "");
483 pr_info("vb2: setup: %u start_streaming: %u stop_streaming: %u\n",
484 q->cnt_queue_setup, q->cnt_start_streaming,
485 q->cnt_stop_streaming);
486 pr_info("vb2: wait_prepare: %u wait_finish: %u\n",
487 q->cnt_wait_prepare, q->cnt_wait_finish);
488 }
489 q->cnt_queue_setup = 0;
490 q->cnt_wait_prepare = 0;
491 q->cnt_wait_finish = 0;
492 q->cnt_start_streaming = 0;
493 q->cnt_stop_streaming = 0;
494 }
495 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
496 struct vb2_buffer *vb = q->bufs[buffer];
497 bool unbalanced = vb->cnt_mem_alloc != vb->cnt_mem_put ||
498 vb->cnt_mem_prepare != vb->cnt_mem_finish ||
499 vb->cnt_mem_get_userptr != vb->cnt_mem_put_userptr ||
500 vb->cnt_mem_attach_dmabuf != vb->cnt_mem_detach_dmabuf ||
501 vb->cnt_mem_map_dmabuf != vb->cnt_mem_unmap_dmabuf ||
502 vb->cnt_buf_queue != vb->cnt_buf_done ||
503 vb->cnt_buf_prepare != vb->cnt_buf_finish ||
504 vb->cnt_buf_init != vb->cnt_buf_cleanup;
505
506 if (unbalanced || debug) {
507 pr_info("vb2: counters for queue %p, buffer %d:%s\n",
508 q, buffer, unbalanced ? " UNBALANCED!" : "");
509 pr_info("vb2: buf_init: %u buf_cleanup: %u buf_prepare: %u buf_finish: %u\n",
510 vb->cnt_buf_init, vb->cnt_buf_cleanup,
511 vb->cnt_buf_prepare, vb->cnt_buf_finish);
512 pr_info("vb2: buf_queue: %u buf_done: %u\n",
513 vb->cnt_buf_queue, vb->cnt_buf_done);
514 pr_info("vb2: alloc: %u put: %u prepare: %u finish: %u mmap: %u\n",
515 vb->cnt_mem_alloc, vb->cnt_mem_put,
516 vb->cnt_mem_prepare, vb->cnt_mem_finish,
517 vb->cnt_mem_mmap);
518 pr_info("vb2: get_userptr: %u put_userptr: %u\n",
519 vb->cnt_mem_get_userptr, vb->cnt_mem_put_userptr);
520 pr_info("vb2: attach_dmabuf: %u detach_dmabuf: %u map_dmabuf: %u unmap_dmabuf: %u\n",
521 vb->cnt_mem_attach_dmabuf, vb->cnt_mem_detach_dmabuf,
522 vb->cnt_mem_map_dmabuf, vb->cnt_mem_unmap_dmabuf);
523 pr_info("vb2: get_dmabuf: %u num_users: %u vaddr: %u cookie: %u\n",
524 vb->cnt_mem_get_dmabuf,
525 vb->cnt_mem_num_users,
526 vb->cnt_mem_vaddr,
527 vb->cnt_mem_cookie);
528 }
529 }
530#endif
531
Pawel Osciake23ccc02010-10-11 10:56:41 -0300532 /* Free videobuf buffers */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300533 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
534 ++buffer) {
Pawel Osciake23ccc02010-10-11 10:56:41 -0300535 kfree(q->bufs[buffer]);
536 q->bufs[buffer] = NULL;
537 }
538
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300539 q->num_buffers -= buffers;
Hans Verkuila7afcac2014-02-24 13:41:20 -0300540 if (!q->num_buffers) {
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300541 q->memory = 0;
Hans Verkuila7afcac2014-02-24 13:41:20 -0300542 INIT_LIST_HEAD(&q->queued_list);
543 }
Hans Verkuil63faabf2013-12-13 13:13:40 -0300544 return 0;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300545}
546
547/**
548 * __verify_planes_array() - verify that the planes array passed in struct
549 * v4l2_buffer from userspace can be safely used
550 */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300551static int __verify_planes_array(struct vb2_buffer *vb, const struct v4l2_buffer *b)
Pawel Osciake23ccc02010-10-11 10:56:41 -0300552{
Hans Verkuil32a77262012-09-28 06:12:53 -0300553 if (!V4L2_TYPE_IS_MULTIPLANAR(b->type))
554 return 0;
555
Pawel Osciake23ccc02010-10-11 10:56:41 -0300556 /* Is memory for copying plane information present? */
557 if (NULL == b->m.planes) {
Hans Verkuil30500402014-04-07 09:13:22 -0300558 dprintk(1, "multi-planar buffer passed but "
Pawel Osciake23ccc02010-10-11 10:56:41 -0300559 "planes array not provided\n");
560 return -EINVAL;
561 }
562
563 if (b->length < vb->num_planes || b->length > VIDEO_MAX_PLANES) {
Hans Verkuil30500402014-04-07 09:13:22 -0300564 dprintk(1, "incorrect planes array length, "
Pawel Osciake23ccc02010-10-11 10:56:41 -0300565 "expected %d, got %d\n", vb->num_planes, b->length);
566 return -EINVAL;
567 }
568
569 return 0;
570}
571
572/**
Laurent Pinchart8023ed02012-07-10 10:41:40 -0300573 * __verify_length() - Verify that the bytesused value for each plane fits in
574 * the plane length and that the data offset doesn't exceed the bytesused value.
575 */
576static int __verify_length(struct vb2_buffer *vb, const struct v4l2_buffer *b)
577{
578 unsigned int length;
579 unsigned int plane;
580
581 if (!V4L2_TYPE_IS_OUTPUT(b->type))
582 return 0;
583
584 if (V4L2_TYPE_IS_MULTIPLANAR(b->type)) {
585 for (plane = 0; plane < vb->num_planes; ++plane) {
586 length = (b->memory == V4L2_MEMORY_USERPTR)
587 ? b->m.planes[plane].length
588 : vb->v4l2_planes[plane].length;
589
590 if (b->m.planes[plane].bytesused > length)
591 return -EINVAL;
Sylwester Nawrocki3c5c23c2013-08-26 11:47:09 -0300592
593 if (b->m.planes[plane].data_offset > 0 &&
594 b->m.planes[plane].data_offset >=
Laurent Pinchart8023ed02012-07-10 10:41:40 -0300595 b->m.planes[plane].bytesused)
596 return -EINVAL;
597 }
598 } else {
599 length = (b->memory == V4L2_MEMORY_USERPTR)
600 ? b->length : vb->v4l2_planes[0].length;
601
602 if (b->bytesused > length)
603 return -EINVAL;
604 }
605
606 return 0;
607}
608
609/**
Marek Szyprowski25a27d92011-08-24 06:49:35 -0300610 * __buffer_in_use() - return true if the buffer is in use and
611 * the queue cannot be freed (by the means of REQBUFS(0)) call
612 */
613static bool __buffer_in_use(struct vb2_queue *q, struct vb2_buffer *vb)
614{
615 unsigned int plane;
616 for (plane = 0; plane < vb->num_planes; ++plane) {
Marek Szyprowski2c2dd6ac2011-10-12 13:09:53 -0300617 void *mem_priv = vb->planes[plane].mem_priv;
Marek Szyprowski25a27d92011-08-24 06:49:35 -0300618 /*
619 * If num_users() has not been provided, call_memop
620 * will return 0, apparently nobody cares about this
621 * case anyway. If num_users() returns more than 1,
622 * we are not the only user of the plane's memory.
623 */
Hans Verkuilb5b45412014-01-29 11:53:25 -0300624 if (mem_priv && call_memop(vb, num_users, mem_priv) > 1)
Marek Szyprowski25a27d92011-08-24 06:49:35 -0300625 return true;
626 }
627 return false;
628}
629
630/**
631 * __buffers_in_use() - return true if any buffers on the queue are in use and
632 * the queue cannot be freed (by the means of REQBUFS(0)) call
633 */
634static bool __buffers_in_use(struct vb2_queue *q)
635{
636 unsigned int buffer;
637 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
638 if (__buffer_in_use(q, q->bufs[buffer]))
639 return true;
640 }
641 return false;
642}
643
644/**
Pawel Osciake23ccc02010-10-11 10:56:41 -0300645 * __fill_v4l2_buffer() - fill in a struct v4l2_buffer with information to be
646 * returned to userspace
647 */
Hans Verkuil32a77262012-09-28 06:12:53 -0300648static void __fill_v4l2_buffer(struct vb2_buffer *vb, struct v4l2_buffer *b)
Pawel Osciake23ccc02010-10-11 10:56:41 -0300649{
650 struct vb2_queue *q = vb->vb2_queue;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300651
Sakari Ailus2b719d72012-05-02 09:40:03 -0300652 /* Copy back data such as timestamp, flags, etc. */
Pawel Osciake23ccc02010-10-11 10:56:41 -0300653 memcpy(b, &vb->v4l2_buf, offsetof(struct v4l2_buffer, m));
Sakari Ailus2b719d72012-05-02 09:40:03 -0300654 b->reserved2 = vb->v4l2_buf.reserved2;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300655 b->reserved = vb->v4l2_buf.reserved;
656
657 if (V4L2_TYPE_IS_MULTIPLANAR(q->type)) {
Pawel Osciake23ccc02010-10-11 10:56:41 -0300658 /*
659 * Fill in plane-related data if userspace provided an array
Hans Verkuil32a77262012-09-28 06:12:53 -0300660 * for it. The caller has already verified memory and size.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300661 */
Hans Verkuil3c0b6062012-09-28 06:24:18 -0300662 b->length = vb->num_planes;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300663 memcpy(b->m.planes, vb->v4l2_planes,
664 b->length * sizeof(struct v4l2_plane));
665 } else {
666 /*
667 * We use length and offset in v4l2_planes array even for
668 * single-planar buffers, but userspace does not.
669 */
670 b->length = vb->v4l2_planes[0].length;
671 b->bytesused = vb->v4l2_planes[0].bytesused;
672 if (q->memory == V4L2_MEMORY_MMAP)
673 b->m.offset = vb->v4l2_planes[0].m.mem_offset;
674 else if (q->memory == V4L2_MEMORY_USERPTR)
675 b->m.userptr = vb->v4l2_planes[0].m.userptr;
Sumit Semwalc5384042012-06-14 10:37:37 -0300676 else if (q->memory == V4L2_MEMORY_DMABUF)
677 b->m.fd = vb->v4l2_planes[0].m.fd;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300678 }
679
Marek Szyprowskiea42c8e2011-04-12 10:14:13 -0300680 /*
681 * Clear any buffer state related flags.
682 */
Sakari Ailus1b18e7a2012-10-22 17:10:16 -0300683 b->flags &= ~V4L2_BUFFER_MASK_FLAGS;
Sakari Ailus7ce6fd82014-02-25 19:08:52 -0300684 b->flags |= q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK;
685 if ((q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) !=
686 V4L2_BUF_FLAG_TIMESTAMP_COPY) {
687 /*
688 * For non-COPY timestamps, drop timestamp source bits
689 * and obtain the timestamp source from the queue.
690 */
691 b->flags &= ~V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
692 b->flags |= q->timestamp_flags & V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
693 }
Pawel Osciake23ccc02010-10-11 10:56:41 -0300694
695 switch (vb->state) {
696 case VB2_BUF_STATE_QUEUED:
697 case VB2_BUF_STATE_ACTIVE:
698 b->flags |= V4L2_BUF_FLAG_QUEUED;
699 break;
700 case VB2_BUF_STATE_ERROR:
701 b->flags |= V4L2_BUF_FLAG_ERROR;
702 /* fall through */
703 case VB2_BUF_STATE_DONE:
704 b->flags |= V4L2_BUF_FLAG_DONE;
705 break;
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -0300706 case VB2_BUF_STATE_PREPARED:
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300707 b->flags |= V4L2_BUF_FLAG_PREPARED;
708 break;
Hans Verkuilb18a8ff2013-12-13 13:13:38 -0300709 case VB2_BUF_STATE_PREPARING:
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300710 case VB2_BUF_STATE_DEQUEUED:
Pawel Osciake23ccc02010-10-11 10:56:41 -0300711 /* nothing */
712 break;
713 }
714
Marek Szyprowski25a27d92011-08-24 06:49:35 -0300715 if (__buffer_in_use(q, vb))
Pawel Osciake23ccc02010-10-11 10:56:41 -0300716 b->flags |= V4L2_BUF_FLAG_MAPPED;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300717}
718
719/**
720 * vb2_querybuf() - query video buffer information
721 * @q: videobuf queue
722 * @b: buffer struct passed from userspace to vidioc_querybuf handler
723 * in driver
724 *
725 * Should be called from vidioc_querybuf ioctl handler in driver.
726 * This function will verify the passed v4l2_buffer structure and fill the
727 * relevant information for the userspace.
728 *
729 * The return values from this function are intended to be directly returned
730 * from vidioc_querybuf handler in driver.
731 */
732int vb2_querybuf(struct vb2_queue *q, struct v4l2_buffer *b)
733{
734 struct vb2_buffer *vb;
Hans Verkuil32a77262012-09-28 06:12:53 -0300735 int ret;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300736
737 if (b->type != q->type) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300738 dprintk(1, "wrong buffer type\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -0300739 return -EINVAL;
740 }
741
742 if (b->index >= q->num_buffers) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300743 dprintk(1, "buffer index out of range\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -0300744 return -EINVAL;
745 }
746 vb = q->bufs[b->index];
Hans Verkuil32a77262012-09-28 06:12:53 -0300747 ret = __verify_planes_array(vb, b);
748 if (!ret)
749 __fill_v4l2_buffer(vb, b);
750 return ret;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300751}
752EXPORT_SYMBOL(vb2_querybuf);
753
754/**
755 * __verify_userptr_ops() - verify that all memory operations required for
756 * USERPTR queue type have been provided
757 */
758static int __verify_userptr_ops(struct vb2_queue *q)
759{
760 if (!(q->io_modes & VB2_USERPTR) || !q->mem_ops->get_userptr ||
761 !q->mem_ops->put_userptr)
762 return -EINVAL;
763
764 return 0;
765}
766
767/**
768 * __verify_mmap_ops() - verify that all memory operations required for
769 * MMAP queue type have been provided
770 */
771static int __verify_mmap_ops(struct vb2_queue *q)
772{
773 if (!(q->io_modes & VB2_MMAP) || !q->mem_ops->alloc ||
774 !q->mem_ops->put || !q->mem_ops->mmap)
775 return -EINVAL;
776
777 return 0;
778}
779
780/**
Sumit Semwalc5384042012-06-14 10:37:37 -0300781 * __verify_dmabuf_ops() - verify that all memory operations required for
782 * DMABUF queue type have been provided
783 */
784static int __verify_dmabuf_ops(struct vb2_queue *q)
785{
786 if (!(q->io_modes & VB2_DMABUF) || !q->mem_ops->attach_dmabuf ||
787 !q->mem_ops->detach_dmabuf || !q->mem_ops->map_dmabuf ||
788 !q->mem_ops->unmap_dmabuf)
789 return -EINVAL;
790
791 return 0;
792}
793
794/**
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300795 * __verify_memory_type() - Check whether the memory type and buffer type
796 * passed to a buffer operation are compatible with the queue.
797 */
798static int __verify_memory_type(struct vb2_queue *q,
799 enum v4l2_memory memory, enum v4l2_buf_type type)
800{
Sumit Semwalc5384042012-06-14 10:37:37 -0300801 if (memory != V4L2_MEMORY_MMAP && memory != V4L2_MEMORY_USERPTR &&
802 memory != V4L2_MEMORY_DMABUF) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300803 dprintk(1, "unsupported memory type\n");
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300804 return -EINVAL;
805 }
806
807 if (type != q->type) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300808 dprintk(1, "requested type is incorrect\n");
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300809 return -EINVAL;
810 }
811
812 /*
813 * Make sure all the required memory ops for given memory type
814 * are available.
815 */
816 if (memory == V4L2_MEMORY_MMAP && __verify_mmap_ops(q)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300817 dprintk(1, "MMAP for current setup unsupported\n");
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300818 return -EINVAL;
819 }
820
821 if (memory == V4L2_MEMORY_USERPTR && __verify_userptr_ops(q)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300822 dprintk(1, "USERPTR for current setup unsupported\n");
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300823 return -EINVAL;
824 }
825
Sumit Semwalc5384042012-06-14 10:37:37 -0300826 if (memory == V4L2_MEMORY_DMABUF && __verify_dmabuf_ops(q)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300827 dprintk(1, "DMABUF for current setup unsupported\n");
Sumit Semwalc5384042012-06-14 10:37:37 -0300828 return -EINVAL;
829 }
830
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300831 /*
832 * Place the busy tests at the end: -EBUSY can be ignored when
833 * create_bufs is called with count == 0, but count == 0 should still
834 * do the memory and type validation.
835 */
Hans Verkuil74753cffa2014-04-07 09:23:50 -0300836 if (vb2_fileio_is_active(q)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300837 dprintk(1, "file io in progress\n");
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300838 return -EBUSY;
839 }
840 return 0;
841}
842
843/**
844 * __reqbufs() - Initiate streaming
Pawel Osciake23ccc02010-10-11 10:56:41 -0300845 * @q: videobuf2 queue
846 * @req: struct passed from userspace to vidioc_reqbufs handler in driver
847 *
848 * Should be called from vidioc_reqbufs ioctl handler of a driver.
849 * This function:
850 * 1) verifies streaming parameters passed from the userspace,
851 * 2) sets up the queue,
852 * 3) negotiates number of buffers and planes per buffer with the driver
853 * to be used during streaming,
854 * 4) allocates internal buffer structures (struct vb2_buffer), according to
855 * the agreed parameters,
856 * 5) for MMAP memory type, allocates actual video memory, using the
857 * memory handling/allocation routines provided during queue initialization
858 *
859 * If req->count is 0, all the memory will be freed instead.
860 * If the queue has been allocated previously (by a previous vb2_reqbufs) call
861 * and the queue is not busy, memory will be reallocated.
862 *
863 * The return values from this function are intended to be directly returned
864 * from vidioc_reqbufs handler in driver.
865 */
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300866static int __reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req)
Pawel Osciake23ccc02010-10-11 10:56:41 -0300867{
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300868 unsigned int num_buffers, allocated_buffers, num_planes = 0;
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300869 int ret;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300870
871 if (q->streaming) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300872 dprintk(1, "streaming active\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -0300873 return -EBUSY;
874 }
875
Marek Szyprowski29e3fbd2011-03-09 14:03:24 -0300876 if (req->count == 0 || q->num_buffers != 0 || q->memory != req->memory) {
Pawel Osciake23ccc02010-10-11 10:56:41 -0300877 /*
878 * We already have buffers allocated, so first check if they
879 * are not in use and can be freed.
880 */
881 if (q->memory == V4L2_MEMORY_MMAP && __buffers_in_use(q)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -0300882 dprintk(1, "memory in use, cannot free\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -0300883 return -EBUSY;
884 }
885
Hans Verkuilfb64dca2014-02-28 12:49:18 -0300886 /*
887 * Call queue_cancel to clean up any buffers in the PREPARED or
888 * QUEUED state which is possible if buffers were prepared or
889 * queued without ever calling STREAMON.
890 */
891 __vb2_queue_cancel(q);
Hans Verkuil63faabf2013-12-13 13:13:40 -0300892 ret = __vb2_queue_free(q, q->num_buffers);
893 if (ret)
894 return ret;
Marek Szyprowski29e3fbd2011-03-09 14:03:24 -0300895
896 /*
897 * In case of REQBUFS(0) return immediately without calling
898 * driver's queue_setup() callback and allocating resources.
899 */
900 if (req->count == 0)
901 return 0;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300902 }
903
904 /*
905 * Make sure the requested values and current defaults are sane.
906 */
907 num_buffers = min_t(unsigned int, req->count, VIDEO_MAX_FRAME);
Philipp Zabel4cf743d2014-05-09 12:32:10 -0300908 num_buffers = max_t(unsigned int, num_buffers, q->min_buffers_needed);
Marek Szyprowskic1426bc2011-08-24 06:36:26 -0300909 memset(q->plane_sizes, 0, sizeof(q->plane_sizes));
Pawel Osciake23ccc02010-10-11 10:56:41 -0300910 memset(q->alloc_ctx, 0, sizeof(q->alloc_ctx));
Marek Szyprowski13b14092011-04-14 07:17:44 -0300911 q->memory = req->memory;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300912
913 /*
914 * Ask the driver how many buffers and planes per buffer it requires.
915 * Driver also sets the size and allocator context for each plane.
916 */
Guennadi Liakhovetskifc714e72011-08-24 10:30:21 -0300917 ret = call_qop(q, queue_setup, q, NULL, &num_buffers, &num_planes,
Marek Szyprowskic1426bc2011-08-24 06:36:26 -0300918 q->plane_sizes, q->alloc_ctx);
Hans Verkuila1d36d82014-03-17 09:54:21 -0300919 if (ret)
Pawel Osciake23ccc02010-10-11 10:56:41 -0300920 return ret;
921
922 /* Finally, allocate buffers and video memory */
Hans Verkuila7afcac2014-02-24 13:41:20 -0300923 allocated_buffers = __vb2_queue_alloc(q, req->memory, num_buffers, num_planes);
924 if (allocated_buffers == 0) {
Hans Verkuil30500402014-04-07 09:13:22 -0300925 dprintk(1, "memory allocation failed\n");
Marek Szyprowski66072d42011-06-28 08:29:02 -0300926 return -ENOMEM;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300927 }
928
929 /*
Hans Verkuilb3379c62014-02-24 13:51:03 -0300930 * There is no point in continuing if we can't allocate the minimum
931 * number of buffers needed by this vb2_queue.
932 */
933 if (allocated_buffers < q->min_buffers_needed)
934 ret = -ENOMEM;
935
936 /*
Pawel Osciake23ccc02010-10-11 10:56:41 -0300937 * Check if driver can handle the allocated number of buffers.
938 */
Hans Verkuilb3379c62014-02-24 13:51:03 -0300939 if (!ret && allocated_buffers < num_buffers) {
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300940 num_buffers = allocated_buffers;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300941
Guennadi Liakhovetskifc714e72011-08-24 10:30:21 -0300942 ret = call_qop(q, queue_setup, q, NULL, &num_buffers,
943 &num_planes, q->plane_sizes, q->alloc_ctx);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300944
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300945 if (!ret && allocated_buffers < num_buffers)
Pawel Osciake23ccc02010-10-11 10:56:41 -0300946 ret = -ENOMEM;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300947
948 /*
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300949 * Either the driver has accepted a smaller number of buffers,
950 * or .queue_setup() returned an error
Pawel Osciake23ccc02010-10-11 10:56:41 -0300951 */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300952 }
953
954 q->num_buffers = allocated_buffers;
955
956 if (ret < 0) {
Hans Verkuila7afcac2014-02-24 13:41:20 -0300957 /*
958 * Note: __vb2_queue_free() will subtract 'allocated_buffers'
959 * from q->num_buffers.
960 */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300961 __vb2_queue_free(q, allocated_buffers);
962 return ret;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300963 }
964
Pawel Osciake23ccc02010-10-11 10:56:41 -0300965 /*
966 * Return the number of successfully allocated buffers
967 * to the userspace.
968 */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300969 req->count = allocated_buffers;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300970
971 return 0;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300972}
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300973
974/**
975 * vb2_reqbufs() - Wrapper for __reqbufs() that also verifies the memory and
976 * type values.
977 * @q: videobuf2 queue
978 * @req: struct passed from userspace to vidioc_reqbufs handler in driver
979 */
980int vb2_reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req)
981{
982 int ret = __verify_memory_type(q, req->memory, req->type);
983
984 return ret ? ret : __reqbufs(q, req);
985}
Pawel Osciake23ccc02010-10-11 10:56:41 -0300986EXPORT_SYMBOL_GPL(vb2_reqbufs);
987
988/**
Hans Verkuil37d9ed92012-06-27 17:10:30 -0300989 * __create_bufs() - Allocate buffers and any required auxiliary structs
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300990 * @q: videobuf2 queue
991 * @create: creation parameters, passed from userspace to vidioc_create_bufs
992 * handler in driver
993 *
994 * Should be called from vidioc_create_bufs ioctl handler of a driver.
995 * This function:
996 * 1) verifies parameter sanity
997 * 2) calls the .queue_setup() queue operation
998 * 3) performs any necessary memory allocations
999 *
1000 * The return values from this function are intended to be directly returned
1001 * from vidioc_create_bufs handler in driver.
1002 */
Hans Verkuil37d9ed92012-06-27 17:10:30 -03001003static int __create_bufs(struct vb2_queue *q, struct v4l2_create_buffers *create)
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001004{
1005 unsigned int num_planes = 0, num_buffers, allocated_buffers;
Hans Verkuil37d9ed92012-06-27 17:10:30 -03001006 int ret;
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001007
1008 if (q->num_buffers == VIDEO_MAX_FRAME) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001009 dprintk(1, "maximum number of buffers already allocated\n");
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001010 return -ENOBUFS;
1011 }
1012
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001013 if (!q->num_buffers) {
1014 memset(q->plane_sizes, 0, sizeof(q->plane_sizes));
1015 memset(q->alloc_ctx, 0, sizeof(q->alloc_ctx));
1016 q->memory = create->memory;
1017 }
1018
1019 num_buffers = min(create->count, VIDEO_MAX_FRAME - q->num_buffers);
1020
1021 /*
1022 * Ask the driver, whether the requested number of buffers, planes per
1023 * buffer and their sizes are acceptable
1024 */
1025 ret = call_qop(q, queue_setup, q, &create->format, &num_buffers,
1026 &num_planes, q->plane_sizes, q->alloc_ctx);
Hans Verkuila1d36d82014-03-17 09:54:21 -03001027 if (ret)
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001028 return ret;
1029
1030 /* Finally, allocate buffers and video memory */
Hans Verkuila7afcac2014-02-24 13:41:20 -03001031 allocated_buffers = __vb2_queue_alloc(q, create->memory, num_buffers,
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001032 num_planes);
Hans Verkuila7afcac2014-02-24 13:41:20 -03001033 if (allocated_buffers == 0) {
Hans Verkuil30500402014-04-07 09:13:22 -03001034 dprintk(1, "memory allocation failed\n");
Hans Verkuilf05393d22012-06-22 05:44:14 -03001035 return -ENOMEM;
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001036 }
1037
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001038 /*
1039 * Check if driver can handle the so far allocated number of buffers.
1040 */
Hans Verkuila7afcac2014-02-24 13:41:20 -03001041 if (allocated_buffers < num_buffers) {
1042 num_buffers = allocated_buffers;
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001043
1044 /*
1045 * q->num_buffers contains the total number of buffers, that the
1046 * queue driver has set up
1047 */
1048 ret = call_qop(q, queue_setup, q, &create->format, &num_buffers,
1049 &num_planes, q->plane_sizes, q->alloc_ctx);
1050
1051 if (!ret && allocated_buffers < num_buffers)
1052 ret = -ENOMEM;
1053
1054 /*
1055 * Either the driver has accepted a smaller number of buffers,
1056 * or .queue_setup() returned an error
1057 */
1058 }
1059
1060 q->num_buffers += allocated_buffers;
1061
1062 if (ret < 0) {
Hans Verkuila7afcac2014-02-24 13:41:20 -03001063 /*
1064 * Note: __vb2_queue_free() will subtract 'allocated_buffers'
1065 * from q->num_buffers.
1066 */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001067 __vb2_queue_free(q, allocated_buffers);
Hans Verkuilf05393d22012-06-22 05:44:14 -03001068 return -ENOMEM;
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001069 }
1070
1071 /*
1072 * Return the number of successfully allocated buffers
1073 * to the userspace.
1074 */
1075 create->count = allocated_buffers;
1076
1077 return 0;
1078}
Hans Verkuil37d9ed92012-06-27 17:10:30 -03001079
1080/**
Nicolas THERY53aa3b12012-07-20 09:25:37 -03001081 * vb2_create_bufs() - Wrapper for __create_bufs() that also verifies the
1082 * memory and type values.
Hans Verkuil37d9ed92012-06-27 17:10:30 -03001083 * @q: videobuf2 queue
1084 * @create: creation parameters, passed from userspace to vidioc_create_bufs
1085 * handler in driver
1086 */
1087int vb2_create_bufs(struct vb2_queue *q, struct v4l2_create_buffers *create)
1088{
1089 int ret = __verify_memory_type(q, create->memory, create->format.type);
1090
1091 create->index = q->num_buffers;
Hans Verkuilf05393d22012-06-22 05:44:14 -03001092 if (create->count == 0)
1093 return ret != -EBUSY ? ret : 0;
Hans Verkuil37d9ed92012-06-27 17:10:30 -03001094 return ret ? ret : __create_bufs(q, create);
1095}
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001096EXPORT_SYMBOL_GPL(vb2_create_bufs);
1097
1098/**
Pawel Osciake23ccc02010-10-11 10:56:41 -03001099 * vb2_plane_vaddr() - Return a kernel virtual address of a given plane
1100 * @vb: vb2_buffer to which the plane in question belongs to
1101 * @plane_no: plane number for which the address is to be returned
1102 *
1103 * This function returns a kernel virtual address of a given plane if
1104 * such a mapping exist, NULL otherwise.
1105 */
1106void *vb2_plane_vaddr(struct vb2_buffer *vb, unsigned int plane_no)
1107{
Marek Szyprowskia00d0262011-12-15 05:53:06 -03001108 if (plane_no > vb->num_planes || !vb->planes[plane_no].mem_priv)
Pawel Osciake23ccc02010-10-11 10:56:41 -03001109 return NULL;
1110
Hans Verkuila1d36d82014-03-17 09:54:21 -03001111 return call_ptr_memop(vb, vaddr, vb->planes[plane_no].mem_priv);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001112
1113}
1114EXPORT_SYMBOL_GPL(vb2_plane_vaddr);
1115
1116/**
1117 * vb2_plane_cookie() - Return allocator specific cookie for the given plane
1118 * @vb: vb2_buffer to which the plane in question belongs to
1119 * @plane_no: plane number for which the cookie is to be returned
1120 *
1121 * This function returns an allocator specific cookie for a given plane if
1122 * available, NULL otherwise. The allocator should provide some simple static
1123 * inline function, which would convert this cookie to the allocator specific
1124 * type that can be used directly by the driver to access the buffer. This can
1125 * be for example physical address, pointer to scatter list or IOMMU mapping.
1126 */
1127void *vb2_plane_cookie(struct vb2_buffer *vb, unsigned int plane_no)
1128{
Marek Szyprowskia00d0262011-12-15 05:53:06 -03001129 if (plane_no > vb->num_planes || !vb->planes[plane_no].mem_priv)
Pawel Osciake23ccc02010-10-11 10:56:41 -03001130 return NULL;
1131
Hans Verkuila1d36d82014-03-17 09:54:21 -03001132 return call_ptr_memop(vb, cookie, vb->planes[plane_no].mem_priv);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001133}
1134EXPORT_SYMBOL_GPL(vb2_plane_cookie);
1135
1136/**
1137 * vb2_buffer_done() - inform videobuf that an operation on a buffer is finished
1138 * @vb: vb2_buffer returned from the driver
1139 * @state: either VB2_BUF_STATE_DONE if the operation finished successfully
Hans Verkuilb3379c62014-02-24 13:51:03 -03001140 * or VB2_BUF_STATE_ERROR if the operation finished with an error.
1141 * If start_streaming fails then it should return buffers with state
1142 * VB2_BUF_STATE_QUEUED to put them back into the queue.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001143 *
1144 * This function should be called by the driver after a hardware operation on
1145 * a buffer is finished and the buffer may be returned to userspace. The driver
1146 * cannot use this buffer anymore until it is queued back to it by videobuf
1147 * by the means of buf_queue callback. Only buffers previously queued to the
1148 * driver by buf_queue can be passed to this function.
Hans Verkuilb3379c62014-02-24 13:51:03 -03001149 *
1150 * While streaming a buffer can only be returned in state DONE or ERROR.
1151 * The start_streaming op can also return them in case the DMA engine cannot
1152 * be started for some reason. In that case the buffers should be returned with
1153 * state QUEUED.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001154 */
1155void vb2_buffer_done(struct vb2_buffer *vb, enum vb2_buffer_state state)
1156{
1157 struct vb2_queue *q = vb->vb2_queue;
1158 unsigned long flags;
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -03001159 unsigned int plane;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001160
Hans Verkuilb3379c62014-02-24 13:51:03 -03001161 if (WARN_ON(vb->state != VB2_BUF_STATE_ACTIVE))
Pawel Osciake23ccc02010-10-11 10:56:41 -03001162 return;
1163
Hans Verkuilb3379c62014-02-24 13:51:03 -03001164 if (!q->start_streaming_called) {
1165 if (WARN_ON(state != VB2_BUF_STATE_QUEUED))
1166 state = VB2_BUF_STATE_QUEUED;
Hans Verkuil57394b72014-02-24 15:52:04 -03001167 } else if (WARN_ON(state != VB2_BUF_STATE_DONE &&
1168 state != VB2_BUF_STATE_ERROR)) {
Hans Verkuilb3379c62014-02-24 13:51:03 -03001169 state = VB2_BUF_STATE_ERROR;
1170 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001171
Hans Verkuilb5b45412014-01-29 11:53:25 -03001172#ifdef CONFIG_VIDEO_ADV_DEBUG
1173 /*
1174 * Although this is not a callback, it still does have to balance
1175 * with the buf_queue op. So update this counter manually.
1176 */
1177 vb->cnt_buf_done++;
1178#endif
Hans Verkuil30500402014-04-07 09:13:22 -03001179 dprintk(4, "done processing on buffer %d, state: %d\n",
Tushar Behera9b6f5dc2012-11-12 04:01:29 -03001180 vb->v4l2_buf.index, state);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001181
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -03001182 /* sync buffers */
1183 for (plane = 0; plane < vb->num_planes; ++plane)
Hans Verkuila1d36d82014-03-17 09:54:21 -03001184 call_void_memop(vb, finish, vb->planes[plane].mem_priv);
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -03001185
Pawel Osciake23ccc02010-10-11 10:56:41 -03001186 /* Add the buffer to the done buffers list */
1187 spin_lock_irqsave(&q->done_lock, flags);
1188 vb->state = state;
Hans Verkuilb3379c62014-02-24 13:51:03 -03001189 if (state != VB2_BUF_STATE_QUEUED)
1190 list_add_tail(&vb->done_entry, &q->done_list);
Hans Verkuil6ea3b982014-02-06 05:46:11 -03001191 atomic_dec(&q->owned_by_drv_count);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001192 spin_unlock_irqrestore(&q->done_lock, flags);
1193
Hans Verkuilb3379c62014-02-24 13:51:03 -03001194 if (state == VB2_BUF_STATE_QUEUED)
1195 return;
1196
Pawel Osciake23ccc02010-10-11 10:56:41 -03001197 /* Inform any processes that may be waiting for buffers */
1198 wake_up(&q->done_wq);
1199}
1200EXPORT_SYMBOL_GPL(vb2_buffer_done);
1201
1202/**
Laurent Pinchart34ea4d42014-03-09 21:42:52 -03001203 * vb2_discard_done() - discard all buffers marked as DONE
1204 * @q: videobuf2 queue
1205 *
1206 * This function is intended to be used with suspend/resume operations. It
1207 * discards all 'done' buffers as they would be too old to be requested after
1208 * resume.
1209 *
1210 * Drivers must stop the hardware and synchronize with interrupt handlers and/or
1211 * delayed works before calling this function to make sure no buffer will be
1212 * touched by the driver and/or hardware.
1213 */
1214void vb2_discard_done(struct vb2_queue *q)
1215{
1216 struct vb2_buffer *vb;
1217 unsigned long flags;
1218
1219 spin_lock_irqsave(&q->done_lock, flags);
1220 list_for_each_entry(vb, &q->done_list, done_entry)
1221 vb->state = VB2_BUF_STATE_ERROR;
1222 spin_unlock_irqrestore(&q->done_lock, flags);
1223}
1224EXPORT_SYMBOL_GPL(vb2_discard_done);
1225
1226/**
Hans Verkuil32a77262012-09-28 06:12:53 -03001227 * __fill_vb2_buffer() - fill a vb2_buffer with information provided in a
1228 * v4l2_buffer by the userspace. The caller has already verified that struct
1229 * v4l2_buffer has a valid number of planes.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001230 */
Hans Verkuil32a77262012-09-28 06:12:53 -03001231static void __fill_vb2_buffer(struct vb2_buffer *vb, const struct v4l2_buffer *b,
Pawel Osciake23ccc02010-10-11 10:56:41 -03001232 struct v4l2_plane *v4l2_planes)
1233{
1234 unsigned int plane;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001235
1236 if (V4L2_TYPE_IS_MULTIPLANAR(b->type)) {
Pawel Osciake23ccc02010-10-11 10:56:41 -03001237 /* Fill in driver-provided information for OUTPUT types */
1238 if (V4L2_TYPE_IS_OUTPUT(b->type)) {
Hans Verkuil61bd8fb2014-04-07 08:57:48 -03001239 bool bytesused_is_used;
1240
1241 /* Check if bytesused == 0 for all planes */
1242 for (plane = 0; plane < vb->num_planes; ++plane)
1243 if (b->m.planes[plane].bytesused)
1244 break;
1245 bytesused_is_used = plane < vb->num_planes;
1246
Pawel Osciake23ccc02010-10-11 10:56:41 -03001247 /*
1248 * Will have to go up to b->length when API starts
1249 * accepting variable number of planes.
Hans Verkuil61bd8fb2014-04-07 08:57:48 -03001250 *
1251 * If bytesused_is_used is false, then fall back to the
1252 * full buffer size. In that case userspace clearly
1253 * never bothered to set it and it's a safe assumption
1254 * that they really meant to use the full plane sizes.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001255 */
1256 for (plane = 0; plane < vb->num_planes; ++plane) {
Hans Verkuil61bd8fb2014-04-07 08:57:48 -03001257 struct v4l2_plane *pdst = &v4l2_planes[plane];
1258 struct v4l2_plane *psrc = &b->m.planes[plane];
1259
1260 pdst->bytesused = bytesused_is_used ?
1261 psrc->bytesused : psrc->length;
1262 pdst->data_offset = psrc->data_offset;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001263 }
1264 }
1265
1266 if (b->memory == V4L2_MEMORY_USERPTR) {
1267 for (plane = 0; plane < vb->num_planes; ++plane) {
1268 v4l2_planes[plane].m.userptr =
1269 b->m.planes[plane].m.userptr;
1270 v4l2_planes[plane].length =
1271 b->m.planes[plane].length;
1272 }
1273 }
Sumit Semwalc5384042012-06-14 10:37:37 -03001274 if (b->memory == V4L2_MEMORY_DMABUF) {
1275 for (plane = 0; plane < vb->num_planes; ++plane) {
1276 v4l2_planes[plane].m.fd =
1277 b->m.planes[plane].m.fd;
1278 v4l2_planes[plane].length =
1279 b->m.planes[plane].length;
Sumit Semwalc5384042012-06-14 10:37:37 -03001280 }
1281 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001282 } else {
1283 /*
1284 * Single-planar buffers do not use planes array,
1285 * so fill in relevant v4l2_buffer struct fields instead.
1286 * In videobuf we use our internal V4l2_planes struct for
1287 * single-planar buffers as well, for simplicity.
Hans Verkuil61bd8fb2014-04-07 08:57:48 -03001288 *
1289 * If bytesused == 0, then fall back to the full buffer size
1290 * as that's a sensible default.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001291 */
Hans Verkuil412376a2014-04-07 08:44:56 -03001292 if (V4L2_TYPE_IS_OUTPUT(b->type))
Hans Verkuil61bd8fb2014-04-07 08:57:48 -03001293 v4l2_planes[0].bytesused =
1294 b->bytesused ? b->bytesused : b->length;
1295 else
1296 v4l2_planes[0].bytesused = 0;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001297
1298 if (b->memory == V4L2_MEMORY_USERPTR) {
1299 v4l2_planes[0].m.userptr = b->m.userptr;
1300 v4l2_planes[0].length = b->length;
1301 }
Sumit Semwalc5384042012-06-14 10:37:37 -03001302
1303 if (b->memory == V4L2_MEMORY_DMABUF) {
1304 v4l2_planes[0].m.fd = b->m.fd;
1305 v4l2_planes[0].length = b->length;
Sumit Semwalc5384042012-06-14 10:37:37 -03001306 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001307 }
1308
Hans Verkuilf1343282014-02-24 14:44:50 -03001309 /* Zero flags that the vb2 core handles */
Sakari Ailus1b18e7a2012-10-22 17:10:16 -03001310 vb->v4l2_buf.flags = b->flags & ~V4L2_BUFFER_MASK_FLAGS;
Sakari Ailus7ce6fd82014-02-25 19:08:52 -03001311 if ((vb->vb2_queue->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) !=
1312 V4L2_BUF_FLAG_TIMESTAMP_COPY || !V4L2_TYPE_IS_OUTPUT(b->type)) {
1313 /*
1314 * Non-COPY timestamps and non-OUTPUT queues will get
1315 * their timestamp and timestamp source flags from the
1316 * queue.
1317 */
1318 vb->v4l2_buf.flags &= ~V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
1319 }
1320
Hans Verkuilf1343282014-02-24 14:44:50 -03001321 if (V4L2_TYPE_IS_OUTPUT(b->type)) {
1322 /*
1323 * For output buffers mask out the timecode flag:
1324 * this will be handled later in vb2_internal_qbuf().
1325 * The 'field' is valid metadata for this output buffer
1326 * and so that needs to be copied here.
1327 */
1328 vb->v4l2_buf.flags &= ~V4L2_BUF_FLAG_TIMECODE;
1329 vb->v4l2_buf.field = b->field;
1330 } else {
1331 /* Zero any output buffer flags as this is a capture buffer */
1332 vb->v4l2_buf.flags &= ~V4L2_BUFFER_OUT_FLAGS;
1333 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001334}
1335
1336/**
Hans Verkuildcc24282014-03-10 12:23:13 -03001337 * __qbuf_mmap() - handle qbuf of an MMAP buffer
1338 */
1339static int __qbuf_mmap(struct vb2_buffer *vb, const struct v4l2_buffer *b)
1340{
1341 __fill_vb2_buffer(vb, b, vb->v4l2_planes);
1342 return call_vb_qop(vb, buf_prepare, vb);
1343}
1344
1345/**
Pawel Osciake23ccc02010-10-11 10:56:41 -03001346 * __qbuf_userptr() - handle qbuf of a USERPTR buffer
1347 */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001348static int __qbuf_userptr(struct vb2_buffer *vb, const struct v4l2_buffer *b)
Pawel Osciake23ccc02010-10-11 10:56:41 -03001349{
1350 struct v4l2_plane planes[VIDEO_MAX_PLANES];
1351 struct vb2_queue *q = vb->vb2_queue;
1352 void *mem_priv;
1353 unsigned int plane;
1354 int ret;
1355 int write = !V4L2_TYPE_IS_OUTPUT(q->type);
Hans Verkuil256f3162014-01-29 13:36:53 -03001356 bool reacquired = vb->planes[0].mem_priv == NULL;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001357
Hans Verkuil412376a2014-04-07 08:44:56 -03001358 memset(planes, 0, sizeof(planes[0]) * vb->num_planes);
Hans Verkuil32a77262012-09-28 06:12:53 -03001359 /* Copy relevant information provided by the userspace */
1360 __fill_vb2_buffer(vb, b, planes);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001361
1362 for (plane = 0; plane < vb->num_planes; ++plane) {
1363 /* Skip the plane if already verified */
Marek Szyprowskif0b7c7f2011-11-16 15:09:40 -03001364 if (vb->v4l2_planes[plane].m.userptr &&
1365 vb->v4l2_planes[plane].m.userptr == planes[plane].m.userptr
Pawel Osciake23ccc02010-10-11 10:56:41 -03001366 && vb->v4l2_planes[plane].length == planes[plane].length)
1367 continue;
1368
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001369 dprintk(3, "userspace address for plane %d changed, "
Pawel Osciake23ccc02010-10-11 10:56:41 -03001370 "reacquiring memory\n", plane);
1371
Marek Szyprowskic1426bc2011-08-24 06:36:26 -03001372 /* Check if the provided plane buffer is large enough */
1373 if (planes[plane].length < q->plane_sizes[plane]) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001374 dprintk(1, "provided buffer size %u is less than "
Seung-Woo Kim2484a7e2013-08-20 04:48:06 -03001375 "setup size %u for plane %d\n",
1376 planes[plane].length,
1377 q->plane_sizes[plane], plane);
Marek Szyprowski4c2625d2011-10-03 03:21:45 -03001378 ret = -EINVAL;
Marek Szyprowskic1426bc2011-08-24 06:36:26 -03001379 goto err;
1380 }
1381
Pawel Osciake23ccc02010-10-11 10:56:41 -03001382 /* Release previously acquired memory if present */
Hans Verkuil256f3162014-01-29 13:36:53 -03001383 if (vb->planes[plane].mem_priv) {
1384 if (!reacquired) {
1385 reacquired = true;
Hans Verkuila1d36d82014-03-17 09:54:21 -03001386 call_void_vb_qop(vb, buf_cleanup, vb);
Hans Verkuil256f3162014-01-29 13:36:53 -03001387 }
Hans Verkuila1d36d82014-03-17 09:54:21 -03001388 call_void_memop(vb, put_userptr, vb->planes[plane].mem_priv);
Hans Verkuil256f3162014-01-29 13:36:53 -03001389 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001390
1391 vb->planes[plane].mem_priv = NULL;
Hans Verkuil256f3162014-01-29 13:36:53 -03001392 memset(&vb->v4l2_planes[plane], 0, sizeof(struct v4l2_plane));
Pawel Osciake23ccc02010-10-11 10:56:41 -03001393
1394 /* Acquire each plane's memory */
Hans Verkuila1d36d82014-03-17 09:54:21 -03001395 mem_priv = call_ptr_memop(vb, get_userptr, q->alloc_ctx[plane],
Marek Szyprowskia00d0262011-12-15 05:53:06 -03001396 planes[plane].m.userptr,
1397 planes[plane].length, write);
1398 if (IS_ERR_OR_NULL(mem_priv)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001399 dprintk(1, "failed acquiring userspace "
Pawel Osciake23ccc02010-10-11 10:56:41 -03001400 "memory for plane %d\n", plane);
Marek Szyprowskia00d0262011-12-15 05:53:06 -03001401 ret = mem_priv ? PTR_ERR(mem_priv) : -EINVAL;
1402 goto err;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001403 }
Marek Szyprowskia00d0262011-12-15 05:53:06 -03001404 vb->planes[plane].mem_priv = mem_priv;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001405 }
1406
1407 /*
Pawel Osciake23ccc02010-10-11 10:56:41 -03001408 * Now that everything is in order, copy relevant information
1409 * provided by userspace.
1410 */
1411 for (plane = 0; plane < vb->num_planes; ++plane)
1412 vb->v4l2_planes[plane] = planes[plane];
1413
Hans Verkuil256f3162014-01-29 13:36:53 -03001414 if (reacquired) {
1415 /*
1416 * One or more planes changed, so we must call buf_init to do
1417 * the driver-specific initialization on the newly acquired
1418 * buffer, if provided.
1419 */
1420 ret = call_vb_qop(vb, buf_init, vb);
1421 if (ret) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001422 dprintk(1, "buffer initialization failed\n");
Hans Verkuil256f3162014-01-29 13:36:53 -03001423 goto err;
1424 }
1425 }
1426
1427 ret = call_vb_qop(vb, buf_prepare, vb);
1428 if (ret) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001429 dprintk(1, "buffer preparation failed\n");
Hans Verkuila1d36d82014-03-17 09:54:21 -03001430 call_void_vb_qop(vb, buf_cleanup, vb);
Hans Verkuil256f3162014-01-29 13:36:53 -03001431 goto err;
1432 }
1433
Pawel Osciake23ccc02010-10-11 10:56:41 -03001434 return 0;
1435err:
1436 /* In case of errors, release planes that were already acquired */
Marek Szyprowskic1426bc2011-08-24 06:36:26 -03001437 for (plane = 0; plane < vb->num_planes; ++plane) {
1438 if (vb->planes[plane].mem_priv)
Hans Verkuila1d36d82014-03-17 09:54:21 -03001439 call_void_memop(vb, put_userptr, vb->planes[plane].mem_priv);
Marek Szyprowskic1426bc2011-08-24 06:36:26 -03001440 vb->planes[plane].mem_priv = NULL;
1441 vb->v4l2_planes[plane].m.userptr = 0;
1442 vb->v4l2_planes[plane].length = 0;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001443 }
1444
1445 return ret;
1446}
1447
1448/**
Sumit Semwalc5384042012-06-14 10:37:37 -03001449 * __qbuf_dmabuf() - handle qbuf of a DMABUF buffer
1450 */
1451static int __qbuf_dmabuf(struct vb2_buffer *vb, const struct v4l2_buffer *b)
1452{
1453 struct v4l2_plane planes[VIDEO_MAX_PLANES];
1454 struct vb2_queue *q = vb->vb2_queue;
1455 void *mem_priv;
1456 unsigned int plane;
1457 int ret;
1458 int write = !V4L2_TYPE_IS_OUTPUT(q->type);
Hans Verkuil256f3162014-01-29 13:36:53 -03001459 bool reacquired = vb->planes[0].mem_priv == NULL;
Sumit Semwalc5384042012-06-14 10:37:37 -03001460
Hans Verkuil412376a2014-04-07 08:44:56 -03001461 memset(planes, 0, sizeof(planes[0]) * vb->num_planes);
Laurent Pinchart6f546c52014-01-01 09:10:48 -03001462 /* Copy relevant information provided by the userspace */
Sumit Semwalc5384042012-06-14 10:37:37 -03001463 __fill_vb2_buffer(vb, b, planes);
1464
1465 for (plane = 0; plane < vb->num_planes; ++plane) {
1466 struct dma_buf *dbuf = dma_buf_get(planes[plane].m.fd);
1467
1468 if (IS_ERR_OR_NULL(dbuf)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001469 dprintk(1, "invalid dmabuf fd for plane %d\n",
Sumit Semwalc5384042012-06-14 10:37:37 -03001470 plane);
1471 ret = -EINVAL;
1472 goto err;
1473 }
1474
1475 /* use DMABUF size if length is not provided */
1476 if (planes[plane].length == 0)
1477 planes[plane].length = dbuf->size;
1478
Hans Verkuil412376a2014-04-07 08:44:56 -03001479 if (planes[plane].length < q->plane_sizes[plane]) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001480 dprintk(1, "invalid dmabuf length for plane %d\n",
Seung-Woo Kim77c07822013-11-29 04:50:29 -03001481 plane);
Sumit Semwalc5384042012-06-14 10:37:37 -03001482 ret = -EINVAL;
1483 goto err;
1484 }
1485
1486 /* Skip the plane if already verified */
1487 if (dbuf == vb->planes[plane].dbuf &&
1488 vb->v4l2_planes[plane].length == planes[plane].length) {
1489 dma_buf_put(dbuf);
1490 continue;
1491 }
1492
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001493 dprintk(1, "buffer for plane %d changed\n", plane);
Sumit Semwalc5384042012-06-14 10:37:37 -03001494
Hans Verkuil256f3162014-01-29 13:36:53 -03001495 if (!reacquired) {
1496 reacquired = true;
Hans Verkuila1d36d82014-03-17 09:54:21 -03001497 call_void_vb_qop(vb, buf_cleanup, vb);
Hans Verkuil256f3162014-01-29 13:36:53 -03001498 }
1499
Sumit Semwalc5384042012-06-14 10:37:37 -03001500 /* Release previously acquired memory if present */
Hans Verkuilb5b45412014-01-29 11:53:25 -03001501 __vb2_plane_dmabuf_put(vb, &vb->planes[plane]);
Sumit Semwalc5384042012-06-14 10:37:37 -03001502 memset(&vb->v4l2_planes[plane], 0, sizeof(struct v4l2_plane));
1503
1504 /* Acquire each plane's memory */
Hans Verkuila1d36d82014-03-17 09:54:21 -03001505 mem_priv = call_ptr_memop(vb, attach_dmabuf, q->alloc_ctx[plane],
Sumit Semwalc5384042012-06-14 10:37:37 -03001506 dbuf, planes[plane].length, write);
1507 if (IS_ERR(mem_priv)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001508 dprintk(1, "failed to attach dmabuf\n");
Sumit Semwalc5384042012-06-14 10:37:37 -03001509 ret = PTR_ERR(mem_priv);
1510 dma_buf_put(dbuf);
1511 goto err;
1512 }
1513
1514 vb->planes[plane].dbuf = dbuf;
1515 vb->planes[plane].mem_priv = mem_priv;
1516 }
1517
1518 /* TODO: This pins the buffer(s) with dma_buf_map_attachment()).. but
1519 * really we want to do this just before the DMA, not while queueing
1520 * the buffer(s)..
1521 */
1522 for (plane = 0; plane < vb->num_planes; ++plane) {
Hans Verkuilb5b45412014-01-29 11:53:25 -03001523 ret = call_memop(vb, map_dmabuf, vb->planes[plane].mem_priv);
Sumit Semwalc5384042012-06-14 10:37:37 -03001524 if (ret) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001525 dprintk(1, "failed to map dmabuf for plane %d\n",
Sumit Semwalc5384042012-06-14 10:37:37 -03001526 plane);
1527 goto err;
1528 }
1529 vb->planes[plane].dbuf_mapped = 1;
1530 }
1531
1532 /*
Sumit Semwalc5384042012-06-14 10:37:37 -03001533 * Now that everything is in order, copy relevant information
1534 * provided by userspace.
1535 */
1536 for (plane = 0; plane < vb->num_planes; ++plane)
1537 vb->v4l2_planes[plane] = planes[plane];
1538
Hans Verkuil256f3162014-01-29 13:36:53 -03001539 if (reacquired) {
1540 /*
1541 * Call driver-specific initialization on the newly acquired buffer,
1542 * if provided.
1543 */
1544 ret = call_vb_qop(vb, buf_init, vb);
1545 if (ret) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001546 dprintk(1, "buffer initialization failed\n");
Hans Verkuil256f3162014-01-29 13:36:53 -03001547 goto err;
1548 }
1549 }
1550
1551 ret = call_vb_qop(vb, buf_prepare, vb);
1552 if (ret) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001553 dprintk(1, "buffer preparation failed\n");
Hans Verkuila1d36d82014-03-17 09:54:21 -03001554 call_void_vb_qop(vb, buf_cleanup, vb);
Hans Verkuil256f3162014-01-29 13:36:53 -03001555 goto err;
1556 }
1557
Sumit Semwalc5384042012-06-14 10:37:37 -03001558 return 0;
1559err:
1560 /* In case of errors, release planes that were already acquired */
1561 __vb2_buf_dmabuf_put(vb);
1562
1563 return ret;
1564}
1565
1566/**
Pawel Osciake23ccc02010-10-11 10:56:41 -03001567 * __enqueue_in_driver() - enqueue a vb2_buffer in driver for processing
1568 */
1569static void __enqueue_in_driver(struct vb2_buffer *vb)
1570{
1571 struct vb2_queue *q = vb->vb2_queue;
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -03001572 unsigned int plane;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001573
1574 vb->state = VB2_BUF_STATE_ACTIVE;
Hans Verkuil6ea3b982014-02-06 05:46:11 -03001575 atomic_inc(&q->owned_by_drv_count);
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -03001576
1577 /* sync buffers */
1578 for (plane = 0; plane < vb->num_planes; ++plane)
Hans Verkuila1d36d82014-03-17 09:54:21 -03001579 call_void_memop(vb, prepare, vb->planes[plane].mem_priv);
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -03001580
Hans Verkuila1d36d82014-03-17 09:54:21 -03001581 call_void_vb_qop(vb, buf_queue, vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001582}
1583
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001584static int __buf_prepare(struct vb2_buffer *vb, const struct v4l2_buffer *b)
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001585{
1586 struct vb2_queue *q = vb->vb2_queue;
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001587 struct rw_semaphore *mmap_sem;
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001588 int ret;
1589
Laurent Pinchart8023ed02012-07-10 10:41:40 -03001590 ret = __verify_length(vb, b);
Sylwester Nawrocki3a9621b2013-08-26 11:47:53 -03001591 if (ret < 0) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001592 dprintk(1, "plane parameters verification failed: %d\n", ret);
Laurent Pinchart8023ed02012-07-10 10:41:40 -03001593 return ret;
Sylwester Nawrocki3a9621b2013-08-26 11:47:53 -03001594 }
Hans Verkuile35e41b2014-04-07 09:20:39 -03001595 if (b->field == V4L2_FIELD_ALTERNATE && V4L2_TYPE_IS_OUTPUT(q->type)) {
1596 /*
1597 * If the format's field is ALTERNATE, then the buffer's field
1598 * should be either TOP or BOTTOM, not ALTERNATE since that
1599 * makes no sense. The driver has to know whether the
1600 * buffer represents a top or a bottom field in order to
1601 * program any DMA correctly. Using ALTERNATE is wrong, since
1602 * that just says that it is either a top or a bottom field,
1603 * but not which of the two it is.
1604 */
1605 dprintk(1, "the field is incorrectly set to ALTERNATE for an output buffer\n");
1606 return -EINVAL;
1607 }
Laurent Pinchart8023ed02012-07-10 10:41:40 -03001608
Laurent Pinchart4bb72672014-06-03 18:53:25 -03001609 if (q->error) {
1610 dprintk(1, "fatal error occurred on queue\n");
1611 return -EIO;
1612 }
1613
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001614 vb->state = VB2_BUF_STATE_PREPARING;
Hans Verkuilf1343282014-02-24 14:44:50 -03001615 vb->v4l2_buf.timestamp.tv_sec = 0;
1616 vb->v4l2_buf.timestamp.tv_usec = 0;
1617 vb->v4l2_buf.sequence = 0;
1618
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001619 switch (q->memory) {
1620 case V4L2_MEMORY_MMAP:
1621 ret = __qbuf_mmap(vb, b);
1622 break;
1623 case V4L2_MEMORY_USERPTR:
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001624 /*
Mauro Carvalho Chehabf103b5d2014-01-07 07:03:09 -02001625 * In case of user pointer buffers vb2 allocators need to get
1626 * direct access to userspace pages. This requires getting
1627 * the mmap semaphore for read access in the current process
1628 * structure. The same semaphore is taken before calling mmap
1629 * operation, while both qbuf/prepare_buf and mmap are called
1630 * by the driver or v4l2 core with the driver's lock held.
1631 * To avoid an AB-BA deadlock (mmap_sem then driver's lock in
1632 * mmap and driver's lock then mmap_sem in qbuf/prepare_buf),
1633 * the videobuf2 core releases the driver's lock, takes
1634 * mmap_sem and then takes the driver's lock again.
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001635 */
1636 mmap_sem = &current->mm->mmap_sem;
Hans Verkuila1d36d82014-03-17 09:54:21 -03001637 call_void_qop(q, wait_prepare, q);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001638 down_read(mmap_sem);
Hans Verkuila1d36d82014-03-17 09:54:21 -03001639 call_void_qop(q, wait_finish, q);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001640
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001641 ret = __qbuf_userptr(vb, b);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001642
1643 up_read(mmap_sem);
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001644 break;
Sumit Semwalc5384042012-06-14 10:37:37 -03001645 case V4L2_MEMORY_DMABUF:
1646 ret = __qbuf_dmabuf(vb, b);
1647 break;
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001648 default:
1649 WARN(1, "Invalid queue type\n");
1650 ret = -EINVAL;
1651 }
1652
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001653 if (ret)
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001654 dprintk(1, "buffer preparation failed: %d\n", ret);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001655 vb->state = ret ? VB2_BUF_STATE_DEQUEUED : VB2_BUF_STATE_PREPARED;
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001656
1657 return ret;
1658}
1659
Laurent Pinchart012043b2013-08-09 08:11:26 -03001660static int vb2_queue_or_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b,
Hans Verkuil41381112013-12-13 13:13:39 -03001661 const char *opname)
Laurent Pinchart012043b2013-08-09 08:11:26 -03001662{
Laurent Pinchart012043b2013-08-09 08:11:26 -03001663 if (b->type != q->type) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001664 dprintk(1, "%s: invalid buffer type\n", opname);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001665 return -EINVAL;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001666 }
1667
1668 if (b->index >= q->num_buffers) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001669 dprintk(1, "%s: buffer index out of range\n", opname);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001670 return -EINVAL;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001671 }
1672
Hans Verkuil41381112013-12-13 13:13:39 -03001673 if (q->bufs[b->index] == NULL) {
Laurent Pinchart012043b2013-08-09 08:11:26 -03001674 /* Should never happen */
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001675 dprintk(1, "%s: buffer is NULL\n", opname);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001676 return -EINVAL;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001677 }
1678
1679 if (b->memory != q->memory) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001680 dprintk(1, "%s: invalid memory type\n", opname);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001681 return -EINVAL;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001682 }
1683
Hans Verkuil41381112013-12-13 13:13:39 -03001684 return __verify_planes_array(q->bufs[b->index], b);
Laurent Pinchart012043b2013-08-09 08:11:26 -03001685}
1686
Pawel Osciake23ccc02010-10-11 10:56:41 -03001687/**
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001688 * vb2_prepare_buf() - Pass ownership of a buffer from userspace to the kernel
1689 * @q: videobuf2 queue
1690 * @b: buffer structure passed from userspace to vidioc_prepare_buf
1691 * handler in driver
1692 *
1693 * Should be called from vidioc_prepare_buf ioctl handler of a driver.
1694 * This function:
1695 * 1) verifies the passed buffer,
1696 * 2) calls buf_prepare callback in the driver (if provided), in which
1697 * driver-specific buffer initialization can be performed,
1698 *
1699 * The return values from this function are intended to be directly returned
1700 * from vidioc_prepare_buf handler in driver.
1701 */
1702int vb2_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b)
1703{
Hans Verkuil41381112013-12-13 13:13:39 -03001704 struct vb2_buffer *vb;
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001705 int ret;
Hans Verkuil41381112013-12-13 13:13:39 -03001706
Hans Verkuil74753cffa2014-04-07 09:23:50 -03001707 if (vb2_fileio_is_active(q)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001708 dprintk(1, "file io in progress\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001709 return -EBUSY;
1710 }
1711
1712 ret = vb2_queue_or_prepare_buf(q, b, "prepare_buf");
Hans Verkuil41381112013-12-13 13:13:39 -03001713 if (ret)
1714 return ret;
1715
1716 vb = q->bufs[b->index];
1717 if (vb->state != VB2_BUF_STATE_DEQUEUED) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001718 dprintk(1, "invalid buffer state %d\n",
Hans Verkuil41381112013-12-13 13:13:39 -03001719 vb->state);
1720 return -EINVAL;
1721 }
1722
1723 ret = __buf_prepare(vb, b);
1724 if (!ret) {
1725 /* Fill buffer information for the userspace */
1726 __fill_v4l2_buffer(vb, b);
1727
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001728 dprintk(1, "prepare of buffer %d succeeded\n", vb->v4l2_buf.index);
Hans Verkuil41381112013-12-13 13:13:39 -03001729 }
1730 return ret;
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001731}
1732EXPORT_SYMBOL_GPL(vb2_prepare_buf);
1733
Hans Verkuil02f142e2013-12-13 13:13:42 -03001734/**
1735 * vb2_start_streaming() - Attempt to start streaming.
1736 * @q: videobuf2 queue
1737 *
Hans Verkuilb3379c62014-02-24 13:51:03 -03001738 * Attempt to start streaming. When this function is called there must be
1739 * at least q->min_buffers_needed buffers queued up (i.e. the minimum
1740 * number of buffers required for the DMA engine to function). If the
1741 * @start_streaming op fails it is supposed to return all the driver-owned
1742 * buffers back to vb2 in state QUEUED. Check if that happened and if
1743 * not warn and reclaim them forcefully.
Hans Verkuil02f142e2013-12-13 13:13:42 -03001744 */
1745static int vb2_start_streaming(struct vb2_queue *q)
1746{
Hans Verkuilb3379c62014-02-24 13:51:03 -03001747 struct vb2_buffer *vb;
Hans Verkuil02f142e2013-12-13 13:13:42 -03001748 int ret;
1749
Hans Verkuil02f142e2013-12-13 13:13:42 -03001750 /*
Hans Verkuilb3379c62014-02-24 13:51:03 -03001751 * If any buffers were queued before streamon,
1752 * we can now pass them to driver for processing.
Hans Verkuil02f142e2013-12-13 13:13:42 -03001753 */
Hans Verkuilb3379c62014-02-24 13:51:03 -03001754 list_for_each_entry(vb, &q->queued_list, queued_entry)
1755 __enqueue_in_driver(vb);
1756
1757 /* Tell the driver to start streaming */
Laurent Pinchartbd994dd2014-06-23 18:00:22 -03001758 q->start_streaming_called = 1;
Hans Verkuilb3379c62014-02-24 13:51:03 -03001759 ret = call_qop(q, start_streaming, q,
1760 atomic_read(&q->owned_by_drv_count));
Hans Verkuilb3379c62014-02-24 13:51:03 -03001761 if (!ret)
Hans Verkuil02f142e2013-12-13 13:13:42 -03001762 return 0;
Hans Verkuilb3379c62014-02-24 13:51:03 -03001763
Laurent Pinchartbd994dd2014-06-23 18:00:22 -03001764 q->start_streaming_called = 0;
1765
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001766 dprintk(1, "driver refused to start streaming\n");
Hans Verkuilb3379c62014-02-24 13:51:03 -03001767 if (WARN_ON(atomic_read(&q->owned_by_drv_count))) {
1768 unsigned i;
1769
1770 /*
1771 * Forcefully reclaim buffers if the driver did not
1772 * correctly return them to vb2.
1773 */
1774 for (i = 0; i < q->num_buffers; ++i) {
1775 vb = q->bufs[i];
1776 if (vb->state == VB2_BUF_STATE_ACTIVE)
1777 vb2_buffer_done(vb, VB2_BUF_STATE_QUEUED);
1778 }
1779 /* Must be zero now */
1780 WARN_ON(atomic_read(&q->owned_by_drv_count));
Hans Verkuil02f142e2013-12-13 13:13:42 -03001781 }
Hans Verkuil02f142e2013-12-13 13:13:42 -03001782 return ret;
1783}
1784
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001785static int vb2_internal_qbuf(struct vb2_queue *q, struct v4l2_buffer *b)
Laurent Pinchart012043b2013-08-09 08:11:26 -03001786{
Hans Verkuil41381112013-12-13 13:13:39 -03001787 int ret = vb2_queue_or_prepare_buf(q, b, "qbuf");
1788 struct vb2_buffer *vb;
1789
1790 if (ret)
1791 return ret;
1792
1793 vb = q->bufs[b->index];
Laurent Pinchart012043b2013-08-09 08:11:26 -03001794
1795 switch (vb->state) {
1796 case VB2_BUF_STATE_DEQUEUED:
1797 ret = __buf_prepare(vb, b);
1798 if (ret)
1799 return ret;
Hans Verkuil41381112013-12-13 13:13:39 -03001800 break;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001801 case VB2_BUF_STATE_PREPARED:
1802 break;
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001803 case VB2_BUF_STATE_PREPARING:
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001804 dprintk(1, "buffer still being prepared\n");
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001805 return -EINVAL;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001806 default:
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001807 dprintk(1, "invalid buffer state %d\n", vb->state);
Laurent Pinchart012043b2013-08-09 08:11:26 -03001808 return -EINVAL;
1809 }
1810
1811 /*
1812 * Add to the queued buffers list, a buffer will stay on it until
1813 * dequeued in dqbuf.
1814 */
1815 list_add_tail(&vb->queued_entry, &q->queued_list);
Hans Verkuilb3379c62014-02-24 13:51:03 -03001816 q->queued_count++;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001817 vb->state = VB2_BUF_STATE_QUEUED;
Hans Verkuilf1343282014-02-24 14:44:50 -03001818 if (V4L2_TYPE_IS_OUTPUT(q->type)) {
1819 /*
1820 * For output buffers copy the timestamp if needed,
1821 * and the timecode field and flag if needed.
1822 */
Sakari Ailusc57ff792014-03-01 10:28:02 -03001823 if ((q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
1824 V4L2_BUF_FLAG_TIMESTAMP_COPY)
Hans Verkuilf1343282014-02-24 14:44:50 -03001825 vb->v4l2_buf.timestamp = b->timestamp;
1826 vb->v4l2_buf.flags |= b->flags & V4L2_BUF_FLAG_TIMECODE;
1827 if (b->flags & V4L2_BUF_FLAG_TIMECODE)
1828 vb->v4l2_buf.timecode = b->timecode;
1829 }
Laurent Pinchart012043b2013-08-09 08:11:26 -03001830
1831 /*
1832 * If already streaming, give the buffer to driver for processing.
1833 * If not, the buffer will be given to driver on next streamon.
1834 */
Hans Verkuilb3379c62014-02-24 13:51:03 -03001835 if (q->start_streaming_called)
Laurent Pinchart012043b2013-08-09 08:11:26 -03001836 __enqueue_in_driver(vb);
1837
Hans Verkuil41381112013-12-13 13:13:39 -03001838 /* Fill buffer information for the userspace */
1839 __fill_v4l2_buffer(vb, b);
Laurent Pinchart012043b2013-08-09 08:11:26 -03001840
Hans Verkuilb3379c62014-02-24 13:51:03 -03001841 /*
1842 * If streamon has been called, and we haven't yet called
1843 * start_streaming() since not enough buffers were queued, and
1844 * we now have reached the minimum number of queued buffers,
1845 * then we can finally call start_streaming().
1846 */
1847 if (q->streaming && !q->start_streaming_called &&
1848 q->queued_count >= q->min_buffers_needed) {
Hans Verkuil02f142e2013-12-13 13:13:42 -03001849 ret = vb2_start_streaming(q);
1850 if (ret)
1851 return ret;
1852 }
1853
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001854 dprintk(1, "qbuf of buffer %d succeeded\n", vb->v4l2_buf.index);
Hans Verkuil41381112013-12-13 13:13:39 -03001855 return 0;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001856}
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001857
1858/**
1859 * vb2_qbuf() - Queue a buffer from userspace
1860 * @q: videobuf2 queue
1861 * @b: buffer structure passed from userspace to vidioc_qbuf handler
1862 * in driver
1863 *
1864 * Should be called from vidioc_qbuf ioctl handler of a driver.
1865 * This function:
1866 * 1) verifies the passed buffer,
1867 * 2) if necessary, calls buf_prepare callback in the driver (if provided), in
1868 * which driver-specific buffer initialization can be performed,
1869 * 3) if streaming is on, queues the buffer in driver by the means of buf_queue
1870 * callback for processing.
1871 *
1872 * The return values from this function are intended to be directly returned
1873 * from vidioc_qbuf handler in driver.
1874 */
1875int vb2_qbuf(struct vb2_queue *q, struct v4l2_buffer *b)
1876{
Hans Verkuil74753cffa2014-04-07 09:23:50 -03001877 if (vb2_fileio_is_active(q)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001878 dprintk(1, "file io in progress\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001879 return -EBUSY;
1880 }
1881
1882 return vb2_internal_qbuf(q, b);
1883}
Pawel Osciake23ccc02010-10-11 10:56:41 -03001884EXPORT_SYMBOL_GPL(vb2_qbuf);
1885
1886/**
1887 * __vb2_wait_for_done_vb() - wait for a buffer to become available
1888 * for dequeuing
1889 *
1890 * Will sleep if required for nonblocking == false.
1891 */
1892static int __vb2_wait_for_done_vb(struct vb2_queue *q, int nonblocking)
1893{
1894 /*
1895 * All operations on vb_done_list are performed under done_lock
1896 * spinlock protection. However, buffers may be removed from
1897 * it and returned to userspace only while holding both driver's
1898 * lock and the done_lock spinlock. Thus we can be sure that as
1899 * long as we hold the driver's lock, the list will remain not
1900 * empty if list_empty() check succeeds.
1901 */
1902
1903 for (;;) {
1904 int ret;
1905
1906 if (!q->streaming) {
Hans Verkuil30500402014-04-07 09:13:22 -03001907 dprintk(1, "streaming off, will not wait for buffers\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03001908 return -EINVAL;
1909 }
1910
Laurent Pinchart4bb72672014-06-03 18:53:25 -03001911 if (q->error) {
1912 dprintk(1, "Queue in error state, will not wait for buffers\n");
1913 return -EIO;
1914 }
1915
Pawel Osciake23ccc02010-10-11 10:56:41 -03001916 if (!list_empty(&q->done_list)) {
1917 /*
1918 * Found a buffer that we were waiting for.
1919 */
1920 break;
1921 }
1922
1923 if (nonblocking) {
Hans Verkuil30500402014-04-07 09:13:22 -03001924 dprintk(1, "nonblocking and no buffers to dequeue, "
Pawel Osciake23ccc02010-10-11 10:56:41 -03001925 "will not wait\n");
1926 return -EAGAIN;
1927 }
1928
1929 /*
1930 * We are streaming and blocking, wait for another buffer to
1931 * become ready or for streamoff. Driver's lock is released to
1932 * allow streamoff or qbuf to be called while waiting.
1933 */
Hans Verkuila1d36d82014-03-17 09:54:21 -03001934 call_void_qop(q, wait_prepare, q);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001935
1936 /*
1937 * All locks have been released, it is safe to sleep now.
1938 */
Hans Verkuil30500402014-04-07 09:13:22 -03001939 dprintk(3, "will sleep waiting for buffers\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03001940 ret = wait_event_interruptible(q->done_wq,
Laurent Pinchart4bb72672014-06-03 18:53:25 -03001941 !list_empty(&q->done_list) || !q->streaming ||
1942 q->error);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001943
1944 /*
1945 * We need to reevaluate both conditions again after reacquiring
1946 * the locks or return an error if one occurred.
1947 */
Hans Verkuila1d36d82014-03-17 09:54:21 -03001948 call_void_qop(q, wait_finish, q);
Hans Verkuil32a77262012-09-28 06:12:53 -03001949 if (ret) {
Hans Verkuil30500402014-04-07 09:13:22 -03001950 dprintk(1, "sleep was interrupted\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03001951 return ret;
Hans Verkuil32a77262012-09-28 06:12:53 -03001952 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001953 }
1954 return 0;
1955}
1956
1957/**
1958 * __vb2_get_done_vb() - get a buffer ready for dequeuing
1959 *
1960 * Will sleep if required for nonblocking == false.
1961 */
1962static int __vb2_get_done_vb(struct vb2_queue *q, struct vb2_buffer **vb,
Hans Verkuil32a77262012-09-28 06:12:53 -03001963 struct v4l2_buffer *b, int nonblocking)
Pawel Osciake23ccc02010-10-11 10:56:41 -03001964{
1965 unsigned long flags;
1966 int ret;
1967
1968 /*
1969 * Wait for at least one buffer to become available on the done_list.
1970 */
1971 ret = __vb2_wait_for_done_vb(q, nonblocking);
1972 if (ret)
1973 return ret;
1974
1975 /*
1976 * Driver's lock has been held since we last verified that done_list
1977 * is not empty, so no need for another list_empty(done_list) check.
1978 */
1979 spin_lock_irqsave(&q->done_lock, flags);
1980 *vb = list_first_entry(&q->done_list, struct vb2_buffer, done_entry);
Hans Verkuil32a77262012-09-28 06:12:53 -03001981 /*
1982 * Only remove the buffer from done_list if v4l2_buffer can handle all
1983 * the planes.
1984 */
1985 ret = __verify_planes_array(*vb, b);
1986 if (!ret)
1987 list_del(&(*vb)->done_entry);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001988 spin_unlock_irqrestore(&q->done_lock, flags);
1989
Hans Verkuil32a77262012-09-28 06:12:53 -03001990 return ret;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001991}
1992
1993/**
1994 * vb2_wait_for_all_buffers() - wait until all buffers are given back to vb2
1995 * @q: videobuf2 queue
1996 *
1997 * This function will wait until all buffers that have been given to the driver
1998 * by buf_queue() are given back to vb2 with vb2_buffer_done(). It doesn't call
1999 * wait_prepare, wait_finish pair. It is intended to be called with all locks
2000 * taken, for example from stop_streaming() callback.
2001 */
2002int vb2_wait_for_all_buffers(struct vb2_queue *q)
2003{
2004 if (!q->streaming) {
Hans Verkuil30500402014-04-07 09:13:22 -03002005 dprintk(1, "streaming off, will not wait for buffers\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03002006 return -EINVAL;
2007 }
2008
Hans Verkuilb3379c62014-02-24 13:51:03 -03002009 if (q->start_streaming_called)
Hans Verkuil6ea3b982014-02-06 05:46:11 -03002010 wait_event(q->done_wq, !atomic_read(&q->owned_by_drv_count));
Pawel Osciake23ccc02010-10-11 10:56:41 -03002011 return 0;
2012}
2013EXPORT_SYMBOL_GPL(vb2_wait_for_all_buffers);
2014
2015/**
Sumit Semwalc5384042012-06-14 10:37:37 -03002016 * __vb2_dqbuf() - bring back the buffer to the DEQUEUED state
2017 */
2018static void __vb2_dqbuf(struct vb2_buffer *vb)
2019{
2020 struct vb2_queue *q = vb->vb2_queue;
2021 unsigned int i;
2022
2023 /* nothing to do if the buffer is already dequeued */
2024 if (vb->state == VB2_BUF_STATE_DEQUEUED)
2025 return;
2026
2027 vb->state = VB2_BUF_STATE_DEQUEUED;
2028
2029 /* unmap DMABUF buffer */
2030 if (q->memory == V4L2_MEMORY_DMABUF)
2031 for (i = 0; i < vb->num_planes; ++i) {
2032 if (!vb->planes[i].dbuf_mapped)
2033 continue;
Hans Verkuila1d36d82014-03-17 09:54:21 -03002034 call_void_memop(vb, unmap_dmabuf, vb->planes[i].mem_priv);
Sumit Semwalc5384042012-06-14 10:37:37 -03002035 vb->planes[i].dbuf_mapped = 0;
2036 }
2037}
2038
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002039static int vb2_internal_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking)
Pawel Osciake23ccc02010-10-11 10:56:41 -03002040{
2041 struct vb2_buffer *vb = NULL;
2042 int ret;
2043
2044 if (b->type != q->type) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002045 dprintk(1, "invalid buffer type\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03002046 return -EINVAL;
2047 }
Hans Verkuil32a77262012-09-28 06:12:53 -03002048 ret = __vb2_get_done_vb(q, &vb, b, nonblocking);
2049 if (ret < 0)
Pawel Osciake23ccc02010-10-11 10:56:41 -03002050 return ret;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002051
Pawel Osciake23ccc02010-10-11 10:56:41 -03002052 switch (vb->state) {
2053 case VB2_BUF_STATE_DONE:
Hans Verkuil30500402014-04-07 09:13:22 -03002054 dprintk(3, "returning done buffer\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03002055 break;
2056 case VB2_BUF_STATE_ERROR:
Hans Verkuil30500402014-04-07 09:13:22 -03002057 dprintk(3, "returning done buffer with errors\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03002058 break;
2059 default:
Hans Verkuil30500402014-04-07 09:13:22 -03002060 dprintk(1, "invalid buffer state\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03002061 return -EINVAL;
2062 }
2063
Hans Verkuila1d36d82014-03-17 09:54:21 -03002064 call_void_vb_qop(vb, buf_finish, vb);
Hans Verkuil9cf3c312014-02-28 13:30:48 -03002065
Pawel Osciake23ccc02010-10-11 10:56:41 -03002066 /* Fill buffer information for the userspace */
2067 __fill_v4l2_buffer(vb, b);
2068 /* Remove from videobuf queue */
2069 list_del(&vb->queued_entry);
Hans Verkuilb3379c62014-02-24 13:51:03 -03002070 q->queued_count--;
Sumit Semwalc5384042012-06-14 10:37:37 -03002071 /* go back to dequeued state */
2072 __vb2_dqbuf(vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002073
2074 dprintk(1, "dqbuf of buffer %d, with state %d\n",
2075 vb->v4l2_buf.index, vb->state);
2076
Pawel Osciake23ccc02010-10-11 10:56:41 -03002077 return 0;
2078}
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002079
2080/**
2081 * vb2_dqbuf() - Dequeue a buffer to the userspace
2082 * @q: videobuf2 queue
2083 * @b: buffer structure passed from userspace to vidioc_dqbuf handler
2084 * in driver
2085 * @nonblocking: if true, this call will not sleep waiting for a buffer if no
2086 * buffers ready for dequeuing are present. Normally the driver
2087 * would be passing (file->f_flags & O_NONBLOCK) here
2088 *
2089 * Should be called from vidioc_dqbuf ioctl handler of a driver.
2090 * This function:
2091 * 1) verifies the passed buffer,
2092 * 2) calls buf_finish callback in the driver (if provided), in which
2093 * driver can perform any additional operations that may be required before
2094 * returning the buffer to userspace, such as cache sync,
2095 * 3) the buffer struct members are filled with relevant information for
2096 * the userspace.
2097 *
2098 * The return values from this function are intended to be directly returned
2099 * from vidioc_dqbuf handler in driver.
2100 */
2101int vb2_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking)
2102{
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002103 if (vb2_fileio_is_active(q)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002104 dprintk(1, "file io in progress\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002105 return -EBUSY;
2106 }
2107 return vb2_internal_dqbuf(q, b, nonblocking);
2108}
Pawel Osciake23ccc02010-10-11 10:56:41 -03002109EXPORT_SYMBOL_GPL(vb2_dqbuf);
2110
2111/**
Pawel Osciake23ccc02010-10-11 10:56:41 -03002112 * __vb2_queue_cancel() - cancel and stop (pause) streaming
2113 *
2114 * Removes all queued buffers from driver's queue and all buffers queued by
2115 * userspace from videobuf's queue. Returns to state after reqbufs.
2116 */
2117static void __vb2_queue_cancel(struct vb2_queue *q)
2118{
2119 unsigned int i;
2120
2121 /*
2122 * Tell driver to stop all transactions and release all queued
2123 * buffers.
2124 */
Hans Verkuilb3379c62014-02-24 13:51:03 -03002125 if (q->start_streaming_called)
Hans Verkuile37559b2014-04-17 02:47:21 -03002126 call_void_qop(q, stop_streaming, q);
Hans Verkuilb3379c62014-02-24 13:51:03 -03002127
2128 if (WARN_ON(atomic_read(&q->owned_by_drv_count))) {
2129 for (i = 0; i < q->num_buffers; ++i)
2130 if (q->bufs[i]->state == VB2_BUF_STATE_ACTIVE)
2131 vb2_buffer_done(q->bufs[i], VB2_BUF_STATE_ERROR);
2132 /* Must be zero now */
2133 WARN_ON(atomic_read(&q->owned_by_drv_count));
2134 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03002135
Laurent Pinchartb646f0b2014-04-20 20:55:41 -03002136 q->streaming = 0;
2137 q->start_streaming_called = 0;
2138 q->queued_count = 0;
Laurent Pinchart4bb72672014-06-03 18:53:25 -03002139 q->error = 0;
Laurent Pinchartb646f0b2014-04-20 20:55:41 -03002140
Pawel Osciake23ccc02010-10-11 10:56:41 -03002141 /*
2142 * Remove all buffers from videobuf's list...
2143 */
2144 INIT_LIST_HEAD(&q->queued_list);
2145 /*
2146 * ...and done list; userspace will not receive any buffers it
2147 * has not already dequeued before initiating cancel.
2148 */
2149 INIT_LIST_HEAD(&q->done_list);
Hans Verkuil6ea3b982014-02-06 05:46:11 -03002150 atomic_set(&q->owned_by_drv_count, 0);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002151 wake_up_all(&q->done_wq);
2152
2153 /*
2154 * Reinitialize all buffers for next use.
Hans Verkuil9c0863b2014-03-04 07:34:49 -03002155 * Make sure to call buf_finish for any queued buffers. Normally
2156 * that's done in dqbuf, but that's not going to happen when we
2157 * cancel the whole queue. Note: this code belongs here, not in
2158 * __vb2_dqbuf() since in vb2_internal_dqbuf() there is a critical
2159 * call to __fill_v4l2_buffer() after buf_finish(). That order can't
2160 * be changed, so we can't move the buf_finish() to __vb2_dqbuf().
Pawel Osciake23ccc02010-10-11 10:56:41 -03002161 */
Hans Verkuil9c0863b2014-03-04 07:34:49 -03002162 for (i = 0; i < q->num_buffers; ++i) {
2163 struct vb2_buffer *vb = q->bufs[i];
2164
2165 if (vb->state != VB2_BUF_STATE_DEQUEUED) {
2166 vb->state = VB2_BUF_STATE_PREPARED;
Hans Verkuila1d36d82014-03-17 09:54:21 -03002167 call_void_vb_qop(vb, buf_finish, vb);
Hans Verkuil9c0863b2014-03-04 07:34:49 -03002168 }
2169 __vb2_dqbuf(vb);
2170 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03002171}
2172
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002173static int vb2_internal_streamon(struct vb2_queue *q, enum v4l2_buf_type type)
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002174{
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002175 int ret;
2176
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002177 if (type != q->type) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002178 dprintk(1, "invalid stream type\n");
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002179 return -EINVAL;
2180 }
2181
2182 if (q->streaming) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002183 dprintk(3, "already streaming\n");
Ricardo Ribaldaf9560352013-11-08 07:08:45 -03002184 return 0;
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002185 }
2186
Ricardo Ribalda548df782014-01-08 05:01:33 -03002187 if (!q->num_buffers) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002188 dprintk(1, "no buffers have been allocated\n");
Ricardo Ribalda548df782014-01-08 05:01:33 -03002189 return -EINVAL;
2190 }
2191
Hans Verkuilb3379c62014-02-24 13:51:03 -03002192 if (q->num_buffers < q->min_buffers_needed) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002193 dprintk(1, "need at least %u allocated buffers\n",
Hans Verkuilb3379c62014-02-24 13:51:03 -03002194 q->min_buffers_needed);
2195 return -EINVAL;
2196 }
Ricardo Ribalda Delgado249f5a52014-01-08 05:01:33 -03002197
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002198 /*
Hans Verkuilb3379c62014-02-24 13:51:03 -03002199 * Tell driver to start streaming provided sufficient buffers
2200 * are available.
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002201 */
Hans Verkuilb3379c62014-02-24 13:51:03 -03002202 if (q->queued_count >= q->min_buffers_needed) {
2203 ret = vb2_start_streaming(q);
2204 if (ret) {
2205 __vb2_queue_cancel(q);
2206 return ret;
2207 }
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002208 }
2209
2210 q->streaming = 1;
2211
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002212 dprintk(3, "successful\n");
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002213 return 0;
2214}
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002215
2216/**
Laurent Pinchart4bb72672014-06-03 18:53:25 -03002217 * vb2_queue_error() - signal a fatal error on the queue
2218 * @q: videobuf2 queue
2219 *
2220 * Flag that a fatal unrecoverable error has occurred and wake up all processes
2221 * waiting on the queue. Polling will now set POLLERR and queuing and dequeuing
2222 * buffers will return -EIO.
2223 *
2224 * The error flag will be cleared when cancelling the queue, either from
2225 * vb2_streamoff or vb2_queue_release. Drivers should thus not call this
2226 * function before starting the stream, otherwise the error flag will remain set
2227 * until the queue is released when closing the device node.
2228 */
2229void vb2_queue_error(struct vb2_queue *q)
2230{
2231 q->error = 1;
2232
2233 wake_up_all(&q->done_wq);
2234}
2235EXPORT_SYMBOL_GPL(vb2_queue_error);
2236
2237/**
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002238 * vb2_streamon - start streaming
2239 * @q: videobuf2 queue
2240 * @type: type argument passed from userspace to vidioc_streamon handler
2241 *
2242 * Should be called from vidioc_streamon handler of a driver.
2243 * This function:
2244 * 1) verifies current state
2245 * 2) passes any previously queued buffers to the driver and starts streaming
2246 *
2247 * The return values from this function are intended to be directly returned
2248 * from vidioc_streamon handler in the driver.
2249 */
2250int vb2_streamon(struct vb2_queue *q, enum v4l2_buf_type type)
2251{
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002252 if (vb2_fileio_is_active(q)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002253 dprintk(1, "file io in progress\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002254 return -EBUSY;
2255 }
2256 return vb2_internal_streamon(q, type);
2257}
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002258EXPORT_SYMBOL_GPL(vb2_streamon);
2259
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002260static int vb2_internal_streamoff(struct vb2_queue *q, enum v4l2_buf_type type)
2261{
2262 if (type != q->type) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002263 dprintk(1, "invalid stream type\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002264 return -EINVAL;
2265 }
2266
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002267 /*
2268 * Cancel will pause streaming and remove all buffers from the driver
2269 * and videobuf, effectively returning control over them to userspace.
Hans Verkuil3f1a9a32014-02-25 09:42:45 -03002270 *
2271 * Note that we do this even if q->streaming == 0: if you prepare or
2272 * queue buffers, and then call streamoff without ever having called
2273 * streamon, you would still expect those buffers to be returned to
2274 * their normal dequeued state.
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002275 */
2276 __vb2_queue_cancel(q);
2277
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002278 dprintk(3, "successful\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002279 return 0;
2280}
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002281
2282/**
Pawel Osciake23ccc02010-10-11 10:56:41 -03002283 * vb2_streamoff - stop streaming
2284 * @q: videobuf2 queue
2285 * @type: type argument passed from userspace to vidioc_streamoff handler
2286 *
2287 * Should be called from vidioc_streamoff handler of a driver.
2288 * This function:
2289 * 1) verifies current state,
2290 * 2) stop streaming and dequeues any queued buffers, including those previously
2291 * passed to the driver (after waiting for the driver to finish).
2292 *
2293 * This call can be used for pausing playback.
2294 * The return values from this function are intended to be directly returned
2295 * from vidioc_streamoff handler in the driver
2296 */
2297int vb2_streamoff(struct vb2_queue *q, enum v4l2_buf_type type)
2298{
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002299 if (vb2_fileio_is_active(q)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002300 dprintk(1, "file io in progress\n");
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002301 return -EBUSY;
2302 }
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002303 return vb2_internal_streamoff(q, type);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002304}
2305EXPORT_SYMBOL_GPL(vb2_streamoff);
2306
2307/**
2308 * __find_plane_by_offset() - find plane associated with the given offset off
2309 */
2310static int __find_plane_by_offset(struct vb2_queue *q, unsigned long off,
2311 unsigned int *_buffer, unsigned int *_plane)
2312{
2313 struct vb2_buffer *vb;
2314 unsigned int buffer, plane;
2315
2316 /*
2317 * Go over all buffers and their planes, comparing the given offset
2318 * with an offset assigned to each plane. If a match is found,
2319 * return its buffer and plane numbers.
2320 */
2321 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
2322 vb = q->bufs[buffer];
2323
2324 for (plane = 0; plane < vb->num_planes; ++plane) {
2325 if (vb->v4l2_planes[plane].m.mem_offset == off) {
2326 *_buffer = buffer;
2327 *_plane = plane;
2328 return 0;
2329 }
2330 }
2331 }
2332
2333 return -EINVAL;
2334}
2335
2336/**
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002337 * vb2_expbuf() - Export a buffer as a file descriptor
2338 * @q: videobuf2 queue
2339 * @eb: export buffer structure passed from userspace to vidioc_expbuf
2340 * handler in driver
2341 *
2342 * The return values from this function are intended to be directly returned
2343 * from vidioc_expbuf handler in driver.
2344 */
2345int vb2_expbuf(struct vb2_queue *q, struct v4l2_exportbuffer *eb)
2346{
2347 struct vb2_buffer *vb = NULL;
2348 struct vb2_plane *vb_plane;
2349 int ret;
2350 struct dma_buf *dbuf;
2351
2352 if (q->memory != V4L2_MEMORY_MMAP) {
Hans Verkuil30500402014-04-07 09:13:22 -03002353 dprintk(1, "queue is not currently set up for mmap\n");
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002354 return -EINVAL;
2355 }
2356
2357 if (!q->mem_ops->get_dmabuf) {
Hans Verkuil30500402014-04-07 09:13:22 -03002358 dprintk(1, "queue does not support DMA buffer exporting\n");
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002359 return -EINVAL;
2360 }
2361
Philipp Zabelea3aba82013-05-21 05:11:35 -03002362 if (eb->flags & ~(O_CLOEXEC | O_ACCMODE)) {
Hans Verkuil30500402014-04-07 09:13:22 -03002363 dprintk(1, "queue does support only O_CLOEXEC and access mode flags\n");
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002364 return -EINVAL;
2365 }
2366
2367 if (eb->type != q->type) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002368 dprintk(1, "invalid buffer type\n");
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002369 return -EINVAL;
2370 }
2371
2372 if (eb->index >= q->num_buffers) {
2373 dprintk(1, "buffer index out of range\n");
2374 return -EINVAL;
2375 }
2376
2377 vb = q->bufs[eb->index];
2378
2379 if (eb->plane >= vb->num_planes) {
2380 dprintk(1, "buffer plane out of range\n");
2381 return -EINVAL;
2382 }
2383
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002384 if (vb2_fileio_is_active(q)) {
2385 dprintk(1, "expbuf: file io in progress\n");
2386 return -EBUSY;
2387 }
2388
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002389 vb_plane = &vb->planes[eb->plane];
2390
Hans Verkuila1d36d82014-03-17 09:54:21 -03002391 dbuf = call_ptr_memop(vb, get_dmabuf, vb_plane->mem_priv, eb->flags & O_ACCMODE);
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002392 if (IS_ERR_OR_NULL(dbuf)) {
Hans Verkuil30500402014-04-07 09:13:22 -03002393 dprintk(1, "failed to export buffer %d, plane %d\n",
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002394 eb->index, eb->plane);
2395 return -EINVAL;
2396 }
2397
Philipp Zabelea3aba82013-05-21 05:11:35 -03002398 ret = dma_buf_fd(dbuf, eb->flags & ~O_ACCMODE);
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002399 if (ret < 0) {
2400 dprintk(3, "buffer %d, plane %d failed to export (%d)\n",
2401 eb->index, eb->plane, ret);
2402 dma_buf_put(dbuf);
2403 return ret;
2404 }
2405
2406 dprintk(3, "buffer %d, plane %d exported as %d descriptor\n",
2407 eb->index, eb->plane, ret);
2408 eb->fd = ret;
2409
2410 return 0;
2411}
2412EXPORT_SYMBOL_GPL(vb2_expbuf);
2413
2414/**
Pawel Osciake23ccc02010-10-11 10:56:41 -03002415 * vb2_mmap() - map video buffers into application address space
2416 * @q: videobuf2 queue
2417 * @vma: vma passed to the mmap file operation handler in the driver
2418 *
2419 * Should be called from mmap file operation handler of a driver.
2420 * This function maps one plane of one of the available video buffers to
2421 * userspace. To map whole video memory allocated on reqbufs, this function
2422 * has to be called once per each plane per each buffer previously allocated.
2423 *
2424 * When the userspace application calls mmap, it passes to it an offset returned
2425 * to it earlier by the means of vidioc_querybuf handler. That offset acts as
2426 * a "cookie", which is then used to identify the plane to be mapped.
2427 * This function finds a plane with a matching offset and a mapping is performed
2428 * by the means of a provided memory operation.
2429 *
2430 * The return values from this function are intended to be directly returned
2431 * from the mmap handler in driver.
2432 */
2433int vb2_mmap(struct vb2_queue *q, struct vm_area_struct *vma)
2434{
2435 unsigned long off = vma->vm_pgoff << PAGE_SHIFT;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002436 struct vb2_buffer *vb;
Hans Verkuilce9c2242014-04-17 03:17:08 -03002437 unsigned int buffer = 0, plane = 0;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002438 int ret;
Mauro Carvalho Chehab7f841452013-04-19 07:18:01 -03002439 unsigned long length;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002440
2441 if (q->memory != V4L2_MEMORY_MMAP) {
Hans Verkuil30500402014-04-07 09:13:22 -03002442 dprintk(1, "queue is not currently set up for mmap\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03002443 return -EINVAL;
2444 }
2445
2446 /*
2447 * Check memory area access mode.
2448 */
2449 if (!(vma->vm_flags & VM_SHARED)) {
Hans Verkuil30500402014-04-07 09:13:22 -03002450 dprintk(1, "invalid vma flags, VM_SHARED needed\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03002451 return -EINVAL;
2452 }
2453 if (V4L2_TYPE_IS_OUTPUT(q->type)) {
2454 if (!(vma->vm_flags & VM_WRITE)) {
Hans Verkuil30500402014-04-07 09:13:22 -03002455 dprintk(1, "invalid vma flags, VM_WRITE needed\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03002456 return -EINVAL;
2457 }
2458 } else {
2459 if (!(vma->vm_flags & VM_READ)) {
Hans Verkuil30500402014-04-07 09:13:22 -03002460 dprintk(1, "invalid vma flags, VM_READ needed\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03002461 return -EINVAL;
2462 }
2463 }
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002464 if (vb2_fileio_is_active(q)) {
2465 dprintk(1, "mmap: file io in progress\n");
2466 return -EBUSY;
2467 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03002468
2469 /*
2470 * Find the plane corresponding to the offset passed by userspace.
2471 */
2472 ret = __find_plane_by_offset(q, off, &buffer, &plane);
2473 if (ret)
2474 return ret;
2475
2476 vb = q->bufs[buffer];
Pawel Osciake23ccc02010-10-11 10:56:41 -03002477
Mauro Carvalho Chehab7f841452013-04-19 07:18:01 -03002478 /*
2479 * MMAP requires page_aligned buffers.
2480 * The buffer length was page_aligned at __vb2_buf_mem_alloc(),
2481 * so, we need to do the same here.
2482 */
2483 length = PAGE_ALIGN(vb->v4l2_planes[plane].length);
2484 if (length < (vma->vm_end - vma->vm_start)) {
2485 dprintk(1,
2486 "MMAP invalid, as it would overflow buffer length\n");
Seung-Woo Kim068a0df2013-04-11 23:57:57 -03002487 return -EINVAL;
2488 }
2489
Hans Verkuilb5b45412014-01-29 11:53:25 -03002490 ret = call_memop(vb, mmap, vb->planes[plane].mem_priv, vma);
Hans Verkuila1d36d82014-03-17 09:54:21 -03002491 if (ret)
Pawel Osciake23ccc02010-10-11 10:56:41 -03002492 return ret;
2493
Hans Verkuil30500402014-04-07 09:13:22 -03002494 dprintk(3, "buffer %d, plane %d successfully mapped\n", buffer, plane);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002495 return 0;
2496}
2497EXPORT_SYMBOL_GPL(vb2_mmap);
2498
Scott Jiang6f524ec2011-09-21 09:25:23 -03002499#ifndef CONFIG_MMU
2500unsigned long vb2_get_unmapped_area(struct vb2_queue *q,
2501 unsigned long addr,
2502 unsigned long len,
2503 unsigned long pgoff,
2504 unsigned long flags)
2505{
2506 unsigned long off = pgoff << PAGE_SHIFT;
2507 struct vb2_buffer *vb;
2508 unsigned int buffer, plane;
2509 int ret;
2510
2511 if (q->memory != V4L2_MEMORY_MMAP) {
Hans Verkuil30500402014-04-07 09:13:22 -03002512 dprintk(1, "queue is not currently set up for mmap\n");
Scott Jiang6f524ec2011-09-21 09:25:23 -03002513 return -EINVAL;
2514 }
2515
2516 /*
2517 * Find the plane corresponding to the offset passed by userspace.
2518 */
2519 ret = __find_plane_by_offset(q, off, &buffer, &plane);
2520 if (ret)
2521 return ret;
2522
2523 vb = q->bufs[buffer];
2524
2525 return (unsigned long)vb2_plane_vaddr(vb, plane);
2526}
2527EXPORT_SYMBOL_GPL(vb2_get_unmapped_area);
2528#endif
2529
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002530static int __vb2_init_fileio(struct vb2_queue *q, int read);
2531static int __vb2_cleanup_fileio(struct vb2_queue *q);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002532
2533/**
2534 * vb2_poll() - implements poll userspace operation
2535 * @q: videobuf2 queue
2536 * @file: file argument passed to the poll file operation handler
2537 * @wait: wait argument passed to the poll file operation handler
2538 *
2539 * This function implements poll file operation handler for a driver.
2540 * For CAPTURE queues, if a buffer is ready to be dequeued, the userspace will
2541 * be informed that the file descriptor of a video device is available for
2542 * reading.
2543 * For OUTPUT queues, if a buffer is ready to be dequeued, the file descriptor
2544 * will be reported as available for writing.
2545 *
Hans Verkuil95213ce2011-07-13 04:26:52 -03002546 * If the driver uses struct v4l2_fh, then vb2_poll() will also check for any
2547 * pending events.
2548 *
Pawel Osciake23ccc02010-10-11 10:56:41 -03002549 * The return values from this function are intended to be directly returned
2550 * from poll handler in driver.
2551 */
2552unsigned int vb2_poll(struct vb2_queue *q, struct file *file, poll_table *wait)
2553{
Hans Verkuil95213ce2011-07-13 04:26:52 -03002554 struct video_device *vfd = video_devdata(file);
Hans Verkuilbf5c7cb2011-07-13 04:01:30 -03002555 unsigned long req_events = poll_requested_events(wait);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002556 struct vb2_buffer *vb = NULL;
Hans Verkuil95213ce2011-07-13 04:26:52 -03002557 unsigned int res = 0;
2558 unsigned long flags;
2559
2560 if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags)) {
2561 struct v4l2_fh *fh = file->private_data;
2562
2563 if (v4l2_event_pending(fh))
2564 res = POLLPRI;
2565 else if (req_events & POLLPRI)
2566 poll_wait(file, &fh->wait, wait);
2567 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03002568
Hans Verkuilcd138232013-01-30 13:29:02 -03002569 if (!V4L2_TYPE_IS_OUTPUT(q->type) && !(req_events & (POLLIN | POLLRDNORM)))
2570 return res;
2571 if (V4L2_TYPE_IS_OUTPUT(q->type) && !(req_events & (POLLOUT | POLLWRNORM)))
2572 return res;
2573
Pawel Osciake23ccc02010-10-11 10:56:41 -03002574 /*
Pawel Osciak4ffabdb2011-03-20 18:17:34 -03002575 * Start file I/O emulator only if streaming API has not been used yet.
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002576 */
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002577 if (q->num_buffers == 0 && !vb2_fileio_is_active(q)) {
Hans Verkuilbf5c7cb2011-07-13 04:01:30 -03002578 if (!V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_READ) &&
2579 (req_events & (POLLIN | POLLRDNORM))) {
Hans Verkuil95213ce2011-07-13 04:26:52 -03002580 if (__vb2_init_fileio(q, 1))
2581 return res | POLLERR;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002582 }
Hans Verkuilbf5c7cb2011-07-13 04:01:30 -03002583 if (V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_WRITE) &&
2584 (req_events & (POLLOUT | POLLWRNORM))) {
Hans Verkuil95213ce2011-07-13 04:26:52 -03002585 if (__vb2_init_fileio(q, 0))
2586 return res | POLLERR;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002587 /*
2588 * Write to OUTPUT queue can be done immediately.
2589 */
Hans Verkuil95213ce2011-07-13 04:26:52 -03002590 return res | POLLOUT | POLLWRNORM;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002591 }
2592 }
2593
2594 /*
Laurent Pinchart92416502014-06-03 17:41:06 -03002595 * There is nothing to wait for if no buffer has been queued and the
Laurent Pinchart4bb72672014-06-03 18:53:25 -03002596 * queue isn't streaming, or if the error flag is set.
Pawel Osciake23ccc02010-10-11 10:56:41 -03002597 */
Laurent Pinchart4bb72672014-06-03 18:53:25 -03002598 if ((list_empty(&q->queued_list) && !vb2_is_streaming(q)) || q->error)
Hans Verkuil95213ce2011-07-13 04:26:52 -03002599 return res | POLLERR;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002600
Seung-Woo Kim412cb872013-05-20 23:47:29 -03002601 if (list_empty(&q->done_list))
2602 poll_wait(file, &q->done_wq, wait);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002603
2604 /*
2605 * Take first buffer available for dequeuing.
2606 */
2607 spin_lock_irqsave(&q->done_lock, flags);
2608 if (!list_empty(&q->done_list))
2609 vb = list_first_entry(&q->done_list, struct vb2_buffer,
2610 done_entry);
2611 spin_unlock_irqrestore(&q->done_lock, flags);
2612
2613 if (vb && (vb->state == VB2_BUF_STATE_DONE
2614 || vb->state == VB2_BUF_STATE_ERROR)) {
Hans Verkuil95213ce2011-07-13 04:26:52 -03002615 return (V4L2_TYPE_IS_OUTPUT(q->type)) ?
2616 res | POLLOUT | POLLWRNORM :
2617 res | POLLIN | POLLRDNORM;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002618 }
Hans Verkuil95213ce2011-07-13 04:26:52 -03002619 return res;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002620}
2621EXPORT_SYMBOL_GPL(vb2_poll);
2622
2623/**
2624 * vb2_queue_init() - initialize a videobuf2 queue
2625 * @q: videobuf2 queue; this structure should be allocated in driver
2626 *
2627 * The vb2_queue structure should be allocated by the driver. The driver is
2628 * responsible of clearing it's content and setting initial values for some
2629 * required entries before calling this function.
2630 * q->ops, q->mem_ops, q->type and q->io_modes are mandatory. Please refer
2631 * to the struct vb2_queue description in include/media/videobuf2-core.h
2632 * for more information.
2633 */
2634int vb2_queue_init(struct vb2_queue *q)
2635{
Ezequiel Garcia896f38f2012-09-17 14:59:30 -03002636 /*
2637 * Sanity check
2638 */
2639 if (WARN_ON(!q) ||
2640 WARN_ON(!q->ops) ||
2641 WARN_ON(!q->mem_ops) ||
2642 WARN_ON(!q->type) ||
2643 WARN_ON(!q->io_modes) ||
2644 WARN_ON(!q->ops->queue_setup) ||
Kamil Debski6aa69f92013-01-25 06:29:57 -03002645 WARN_ON(!q->ops->buf_queue) ||
Sakari Ailus872484c2013-08-25 17:57:03 -03002646 WARN_ON(q->timestamp_flags &
2647 ~(V4L2_BUF_FLAG_TIMESTAMP_MASK |
2648 V4L2_BUF_FLAG_TSTAMP_SRC_MASK)))
Ezequiel Garcia896f38f2012-09-17 14:59:30 -03002649 return -EINVAL;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002650
Kamil Debski6aa69f92013-01-25 06:29:57 -03002651 /* Warn that the driver should choose an appropriate timestamp type */
Sakari Ailusc57ff792014-03-01 10:28:02 -03002652 WARN_ON((q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
2653 V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN);
Kamil Debski6aa69f92013-01-25 06:29:57 -03002654
Pawel Osciake23ccc02010-10-11 10:56:41 -03002655 INIT_LIST_HEAD(&q->queued_list);
2656 INIT_LIST_HEAD(&q->done_list);
2657 spin_lock_init(&q->done_lock);
2658 init_waitqueue_head(&q->done_wq);
2659
2660 if (q->buf_struct_size == 0)
2661 q->buf_struct_size = sizeof(struct vb2_buffer);
2662
2663 return 0;
2664}
2665EXPORT_SYMBOL_GPL(vb2_queue_init);
2666
2667/**
2668 * vb2_queue_release() - stop streaming, release the queue and free memory
2669 * @q: videobuf2 queue
2670 *
2671 * This function stops streaming and performs necessary clean ups, including
2672 * freeing video buffer memory. The driver is responsible for freeing
2673 * the vb2_queue structure itself.
2674 */
2675void vb2_queue_release(struct vb2_queue *q)
2676{
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002677 __vb2_cleanup_fileio(q);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002678 __vb2_queue_cancel(q);
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03002679 __vb2_queue_free(q, q->num_buffers);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002680}
2681EXPORT_SYMBOL_GPL(vb2_queue_release);
2682
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002683/**
2684 * struct vb2_fileio_buf - buffer context used by file io emulator
2685 *
2686 * vb2 provides a compatibility layer and emulator of file io (read and
2687 * write) calls on top of streaming API. This structure is used for
2688 * tracking context related to the buffers.
2689 */
2690struct vb2_fileio_buf {
2691 void *vaddr;
2692 unsigned int size;
2693 unsigned int pos;
2694 unsigned int queued:1;
2695};
2696
2697/**
2698 * struct vb2_fileio_data - queue context used by file io emulator
2699 *
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002700 * @cur_index: the index of the buffer currently being read from or
2701 * written to. If equal to q->num_buffers then a new buffer
2702 * must be dequeued.
2703 * @initial_index: in the read() case all buffers are queued up immediately
2704 * in __vb2_init_fileio() and __vb2_perform_fileio() just cycles
2705 * buffers. However, in the write() case no buffers are initially
2706 * queued, instead whenever a buffer is full it is queued up by
2707 * __vb2_perform_fileio(). Only once all available buffers have
2708 * been queued up will __vb2_perform_fileio() start to dequeue
2709 * buffers. This means that initially __vb2_perform_fileio()
2710 * needs to know what buffer index to use when it is queuing up
2711 * the buffers for the first time. That initial index is stored
2712 * in this field. Once it is equal to q->num_buffers all
2713 * available buffers have been queued and __vb2_perform_fileio()
2714 * should start the normal dequeue/queue cycle.
2715 *
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002716 * vb2 provides a compatibility layer and emulator of file io (read and
2717 * write) calls on top of streaming API. For proper operation it required
2718 * this structure to save the driver state between each call of the read
2719 * or write function.
2720 */
2721struct vb2_fileio_data {
2722 struct v4l2_requestbuffers req;
Hans Verkuil7bb6edd2014-04-11 04:40:03 -03002723 struct v4l2_plane p;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002724 struct v4l2_buffer b;
2725 struct vb2_fileio_buf bufs[VIDEO_MAX_FRAME];
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002726 unsigned int cur_index;
2727 unsigned int initial_index;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002728 unsigned int q_count;
2729 unsigned int dq_count;
2730 unsigned int flags;
2731};
2732
2733/**
2734 * __vb2_init_fileio() - initialize file io emulator
2735 * @q: videobuf2 queue
2736 * @read: mode selector (1 means read, 0 means write)
2737 */
2738static int __vb2_init_fileio(struct vb2_queue *q, int read)
2739{
2740 struct vb2_fileio_data *fileio;
2741 int i, ret;
2742 unsigned int count = 0;
2743
2744 /*
2745 * Sanity check
2746 */
Hans Verkuile4d25812014-02-03 11:22:45 -03002747 if (WARN_ON((read && !(q->io_modes & VB2_READ)) ||
2748 (!read && !(q->io_modes & VB2_WRITE))))
2749 return -EINVAL;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002750
2751 /*
2752 * Check if device supports mapping buffers to kernel virtual space.
2753 */
2754 if (!q->mem_ops->vaddr)
2755 return -EBUSY;
2756
2757 /*
2758 * Check if streaming api has not been already activated.
2759 */
2760 if (q->streaming || q->num_buffers > 0)
2761 return -EBUSY;
2762
2763 /*
2764 * Start with count 1, driver can increase it in queue_setup()
2765 */
2766 count = 1;
2767
2768 dprintk(3, "setting up file io: mode %s, count %d, flags %08x\n",
2769 (read) ? "read" : "write", count, q->io_flags);
2770
2771 fileio = kzalloc(sizeof(struct vb2_fileio_data), GFP_KERNEL);
2772 if (fileio == NULL)
2773 return -ENOMEM;
2774
2775 fileio->flags = q->io_flags;
2776
2777 /*
2778 * Request buffers and use MMAP type to force driver
2779 * to allocate buffers by itself.
2780 */
2781 fileio->req.count = count;
2782 fileio->req.memory = V4L2_MEMORY_MMAP;
2783 fileio->req.type = q->type;
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002784 q->fileio = fileio;
2785 ret = __reqbufs(q, &fileio->req);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002786 if (ret)
2787 goto err_kfree;
2788
2789 /*
2790 * Check if plane_count is correct
2791 * (multiplane buffers are not supported).
2792 */
2793 if (q->bufs[0]->num_planes != 1) {
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002794 ret = -EBUSY;
2795 goto err_reqbufs;
2796 }
2797
2798 /*
2799 * Get kernel address of each buffer.
2800 */
2801 for (i = 0; i < q->num_buffers; i++) {
2802 fileio->bufs[i].vaddr = vb2_plane_vaddr(q->bufs[i], 0);
Wei Yongjun5dd69462013-05-13 01:48:45 -03002803 if (fileio->bufs[i].vaddr == NULL) {
2804 ret = -EINVAL;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002805 goto err_reqbufs;
Wei Yongjun5dd69462013-05-13 01:48:45 -03002806 }
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002807 fileio->bufs[i].size = vb2_plane_size(q->bufs[i], 0);
2808 }
2809
2810 /*
2811 * Read mode requires pre queuing of all buffers.
2812 */
2813 if (read) {
Hans Verkuil7bb6edd2014-04-11 04:40:03 -03002814 bool is_multiplanar = V4L2_TYPE_IS_MULTIPLANAR(q->type);
2815
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002816 /*
2817 * Queue all buffers.
2818 */
2819 for (i = 0; i < q->num_buffers; i++) {
2820 struct v4l2_buffer *b = &fileio->b;
Hans Verkuil7bb6edd2014-04-11 04:40:03 -03002821
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002822 memset(b, 0, sizeof(*b));
2823 b->type = q->type;
Hans Verkuil7bb6edd2014-04-11 04:40:03 -03002824 if (is_multiplanar) {
2825 memset(&fileio->p, 0, sizeof(fileio->p));
2826 b->m.planes = &fileio->p;
2827 b->length = 1;
2828 }
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002829 b->memory = q->memory;
2830 b->index = i;
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002831 ret = vb2_internal_qbuf(q, b);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002832 if (ret)
2833 goto err_reqbufs;
2834 fileio->bufs[i].queued = 1;
2835 }
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002836 /*
2837 * All buffers have been queued, so mark that by setting
2838 * initial_index to q->num_buffers
2839 */
2840 fileio->initial_index = q->num_buffers;
2841 fileio->cur_index = q->num_buffers;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002842 }
2843
Hans Verkuil02f142e2013-12-13 13:13:42 -03002844 /*
2845 * Start streaming.
2846 */
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002847 ret = vb2_internal_streamon(q, q->type);
Hans Verkuil02f142e2013-12-13 13:13:42 -03002848 if (ret)
2849 goto err_reqbufs;
2850
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002851 return ret;
2852
2853err_reqbufs:
Hans de Goedea67e1722012-05-08 14:47:39 -03002854 fileio->req.count = 0;
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002855 __reqbufs(q, &fileio->req);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002856
2857err_kfree:
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002858 q->fileio = NULL;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002859 kfree(fileio);
2860 return ret;
2861}
2862
2863/**
2864 * __vb2_cleanup_fileio() - free resourced used by file io emulator
2865 * @q: videobuf2 queue
2866 */
2867static int __vb2_cleanup_fileio(struct vb2_queue *q)
2868{
2869 struct vb2_fileio_data *fileio = q->fileio;
2870
2871 if (fileio) {
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002872 vb2_internal_streamoff(q, q->type);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002873 q->fileio = NULL;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002874 fileio->req.count = 0;
2875 vb2_reqbufs(q, &fileio->req);
2876 kfree(fileio);
2877 dprintk(3, "file io emulator closed\n");
2878 }
2879 return 0;
2880}
2881
2882/**
2883 * __vb2_perform_fileio() - perform a single file io (read or write) operation
2884 * @q: videobuf2 queue
2885 * @data: pointed to target userspace buffer
2886 * @count: number of bytes to read or write
2887 * @ppos: file handle position tracking pointer
2888 * @nonblock: mode selector (1 means blocking calls, 0 means nonblocking)
2889 * @read: access mode selector (1 means read, 0 means write)
2890 */
2891static size_t __vb2_perform_fileio(struct vb2_queue *q, char __user *data, size_t count,
2892 loff_t *ppos, int nonblock, int read)
2893{
2894 struct vb2_fileio_data *fileio;
2895 struct vb2_fileio_buf *buf;
Hans Verkuil7bb6edd2014-04-11 04:40:03 -03002896 bool is_multiplanar = V4L2_TYPE_IS_MULTIPLANAR(q->type);
Hans Verkuilebd7c502014-04-11 04:36:57 -03002897 /*
2898 * When using write() to write data to an output video node the vb2 core
2899 * should set timestamps if V4L2_BUF_FLAG_TIMESTAMP_COPY is set. Nobody
2900 * else is able to provide this information with the write() operation.
2901 */
2902 bool set_timestamp = !read &&
2903 (q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
2904 V4L2_BUF_FLAG_TIMESTAMP_COPY;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002905 int ret, index;
2906
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002907 dprintk(3, "mode %s, offset %ld, count %zd, %sblocking\n",
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002908 read ? "read" : "write", (long)*ppos, count,
2909 nonblock ? "non" : "");
2910
2911 if (!data)
2912 return -EINVAL;
2913
2914 /*
2915 * Initialize emulator on first call.
2916 */
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002917 if (!vb2_fileio_is_active(q)) {
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002918 ret = __vb2_init_fileio(q, read);
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002919 dprintk(3, "vb2_init_fileio result: %d\n", ret);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002920 if (ret)
2921 return ret;
2922 }
2923 fileio = q->fileio;
2924
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002925 /*
2926 * Check if we need to dequeue the buffer.
2927 */
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002928 index = fileio->cur_index;
Hans Verkuil88e26872013-12-13 13:13:45 -03002929 if (index >= q->num_buffers) {
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002930 /*
2931 * Call vb2_dqbuf to get buffer back.
2932 */
2933 memset(&fileio->b, 0, sizeof(fileio->b));
2934 fileio->b.type = q->type;
2935 fileio->b.memory = q->memory;
Hans Verkuil7bb6edd2014-04-11 04:40:03 -03002936 if (is_multiplanar) {
2937 memset(&fileio->p, 0, sizeof(fileio->p));
2938 fileio->b.m.planes = &fileio->p;
2939 fileio->b.length = 1;
2940 }
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002941 ret = vb2_internal_dqbuf(q, &fileio->b, nonblock);
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002942 dprintk(5, "vb2_dqbuf result: %d\n", ret);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002943 if (ret)
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002944 return ret;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002945 fileio->dq_count += 1;
2946
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002947 fileio->cur_index = index = fileio->b.index;
Hans Verkuil88e26872013-12-13 13:13:45 -03002948 buf = &fileio->bufs[index];
2949
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002950 /*
2951 * Get number of bytes filled by the driver
2952 */
Hans Verkuil88e26872013-12-13 13:13:45 -03002953 buf->pos = 0;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002954 buf->queued = 0;
Hans Verkuil88e26872013-12-13 13:13:45 -03002955 buf->size = read ? vb2_get_plane_payload(q->bufs[index], 0)
2956 : vb2_plane_size(q->bufs[index], 0);
2957 } else {
2958 buf = &fileio->bufs[index];
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002959 }
2960
2961 /*
2962 * Limit count on last few bytes of the buffer.
2963 */
2964 if (buf->pos + count > buf->size) {
2965 count = buf->size - buf->pos;
Mauro Carvalho Chehab08b99e22011-01-11 17:12:34 -03002966 dprintk(5, "reducing read count: %zd\n", count);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002967 }
2968
2969 /*
2970 * Transfer data to userspace.
2971 */
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002972 dprintk(3, "copying %zd bytes - buffer %d, offset %u\n",
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002973 count, index, buf->pos);
2974 if (read)
2975 ret = copy_to_user(data, buf->vaddr + buf->pos, count);
2976 else
2977 ret = copy_from_user(buf->vaddr + buf->pos, data, count);
2978 if (ret) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002979 dprintk(3, "error copying data\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002980 return -EFAULT;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002981 }
2982
2983 /*
2984 * Update counters.
2985 */
2986 buf->pos += count;
2987 *ppos += count;
2988
2989 /*
2990 * Queue next buffer if required.
2991 */
2992 if (buf->pos == buf->size ||
2993 (!read && (fileio->flags & VB2_FILEIO_WRITE_IMMEDIATELY))) {
2994 /*
2995 * Check if this is the last buffer to read.
2996 */
2997 if (read && (fileio->flags & VB2_FILEIO_READ_ONCE) &&
2998 fileio->dq_count == 1) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002999 dprintk(3, "read limit reached\n");
Marek Szyprowskib25748f2010-12-06 05:56:55 -03003000 return __vb2_cleanup_fileio(q);
3001 }
3002
3003 /*
3004 * Call vb2_qbuf and give buffer to the driver.
3005 */
3006 memset(&fileio->b, 0, sizeof(fileio->b));
3007 fileio->b.type = q->type;
3008 fileio->b.memory = q->memory;
3009 fileio->b.index = index;
3010 fileio->b.bytesused = buf->pos;
Hans Verkuil7bb6edd2014-04-11 04:40:03 -03003011 if (is_multiplanar) {
3012 memset(&fileio->p, 0, sizeof(fileio->p));
3013 fileio->p.bytesused = buf->pos;
3014 fileio->b.m.planes = &fileio->p;
3015 fileio->b.length = 1;
3016 }
Hans Verkuilebd7c502014-04-11 04:36:57 -03003017 if (set_timestamp)
3018 v4l2_get_timestamp(&fileio->b.timestamp);
Hans Verkuilb2f2f042013-12-13 13:13:41 -03003019 ret = vb2_internal_qbuf(q, &fileio->b);
Hans Verkuilfd4354c2014-04-07 09:08:47 -03003020 dprintk(5, "vb2_dbuf result: %d\n", ret);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03003021 if (ret)
Hans Verkuilb2f2f042013-12-13 13:13:41 -03003022 return ret;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03003023
3024 /*
3025 * Buffer has been queued, update the status
3026 */
3027 buf->pos = 0;
3028 buf->queued = 1;
Hans Verkuil88e26872013-12-13 13:13:45 -03003029 buf->size = vb2_plane_size(q->bufs[index], 0);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03003030 fileio->q_count += 1;
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03003031 /*
3032 * If we are queuing up buffers for the first time, then
3033 * increase initial_index by one.
3034 */
3035 if (fileio->initial_index < q->num_buffers)
3036 fileio->initial_index++;
3037 /*
3038 * The next buffer to use is either a buffer that's going to be
3039 * queued for the first time (initial_index < q->num_buffers)
3040 * or it is equal to q->num_buffers, meaning that the next
3041 * time we need to dequeue a buffer since we've now queued up
3042 * all the 'first time' buffers.
3043 */
3044 fileio->cur_index = fileio->initial_index;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03003045 }
3046
3047 /*
3048 * Return proper number of bytes processed.
3049 */
3050 if (ret == 0)
3051 ret = count;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03003052 return ret;
3053}
3054
3055size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count,
3056 loff_t *ppos, int nonblocking)
3057{
3058 return __vb2_perform_fileio(q, data, count, ppos, nonblocking, 1);
3059}
3060EXPORT_SYMBOL_GPL(vb2_read);
3061
Ricardo Ribalda819585b2013-08-28 04:39:29 -03003062size_t vb2_write(struct vb2_queue *q, const char __user *data, size_t count,
Marek Szyprowskib25748f2010-12-06 05:56:55 -03003063 loff_t *ppos, int nonblocking)
3064{
Ricardo Ribalda819585b2013-08-28 04:39:29 -03003065 return __vb2_perform_fileio(q, (char __user *) data, count,
3066 ppos, nonblocking, 0);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03003067}
3068EXPORT_SYMBOL_GPL(vb2_write);
3069
Hans Verkuil3415a892014-04-14 07:33:00 -03003070struct vb2_threadio_data {
3071 struct task_struct *thread;
3072 vb2_thread_fnc fnc;
3073 void *priv;
3074 bool stop;
3075};
3076
3077static int vb2_thread(void *data)
3078{
3079 struct vb2_queue *q = data;
3080 struct vb2_threadio_data *threadio = q->threadio;
3081 struct vb2_fileio_data *fileio = q->fileio;
3082 bool set_timestamp = false;
3083 int prequeue = 0;
3084 int index = 0;
3085 int ret = 0;
3086
3087 if (V4L2_TYPE_IS_OUTPUT(q->type)) {
3088 prequeue = q->num_buffers;
3089 set_timestamp =
3090 (q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
3091 V4L2_BUF_FLAG_TIMESTAMP_COPY;
3092 }
3093
3094 set_freezable();
3095
3096 for (;;) {
3097 struct vb2_buffer *vb;
3098
3099 /*
3100 * Call vb2_dqbuf to get buffer back.
3101 */
3102 memset(&fileio->b, 0, sizeof(fileio->b));
3103 fileio->b.type = q->type;
3104 fileio->b.memory = q->memory;
3105 if (prequeue) {
3106 fileio->b.index = index++;
3107 prequeue--;
3108 } else {
3109 call_void_qop(q, wait_finish, q);
3110 ret = vb2_internal_dqbuf(q, &fileio->b, 0);
3111 call_void_qop(q, wait_prepare, q);
3112 dprintk(5, "file io: vb2_dqbuf result: %d\n", ret);
3113 }
3114 if (threadio->stop)
3115 break;
3116 if (ret)
3117 break;
3118 try_to_freeze();
3119
3120 vb = q->bufs[fileio->b.index];
3121 if (!(fileio->b.flags & V4L2_BUF_FLAG_ERROR))
3122 ret = threadio->fnc(vb, threadio->priv);
3123 if (ret)
3124 break;
3125 call_void_qop(q, wait_finish, q);
3126 if (set_timestamp)
3127 v4l2_get_timestamp(&fileio->b.timestamp);
3128 ret = vb2_internal_qbuf(q, &fileio->b);
3129 call_void_qop(q, wait_prepare, q);
3130 if (ret)
3131 break;
3132 }
3133
3134 /* Hmm, linux becomes *very* unhappy without this ... */
3135 while (!kthread_should_stop()) {
3136 set_current_state(TASK_INTERRUPTIBLE);
3137 schedule();
3138 }
3139 return 0;
3140}
3141
3142/*
3143 * This function should not be used for anything else but the videobuf2-dvb
3144 * support. If you think you have another good use-case for this, then please
3145 * contact the linux-media mailinglist first.
3146 */
3147int vb2_thread_start(struct vb2_queue *q, vb2_thread_fnc fnc, void *priv,
3148 const char *thread_name)
3149{
3150 struct vb2_threadio_data *threadio;
3151 int ret = 0;
3152
3153 if (q->threadio)
3154 return -EBUSY;
3155 if (vb2_is_busy(q))
3156 return -EBUSY;
3157 if (WARN_ON(q->fileio))
3158 return -EBUSY;
3159
3160 threadio = kzalloc(sizeof(*threadio), GFP_KERNEL);
3161 if (threadio == NULL)
3162 return -ENOMEM;
3163 threadio->fnc = fnc;
3164 threadio->priv = priv;
3165
3166 ret = __vb2_init_fileio(q, !V4L2_TYPE_IS_OUTPUT(q->type));
3167 dprintk(3, "file io: vb2_init_fileio result: %d\n", ret);
3168 if (ret)
3169 goto nomem;
3170 q->threadio = threadio;
3171 threadio->thread = kthread_run(vb2_thread, q, "vb2-%s", thread_name);
3172 if (IS_ERR(threadio->thread)) {
3173 ret = PTR_ERR(threadio->thread);
3174 threadio->thread = NULL;
3175 goto nothread;
3176 }
3177 return 0;
3178
3179nothread:
3180 __vb2_cleanup_fileio(q);
3181nomem:
3182 kfree(threadio);
3183 return ret;
3184}
3185EXPORT_SYMBOL_GPL(vb2_thread_start);
3186
3187int vb2_thread_stop(struct vb2_queue *q)
3188{
3189 struct vb2_threadio_data *threadio = q->threadio;
3190 struct vb2_fileio_data *fileio = q->fileio;
3191 int err;
3192
3193 if (threadio == NULL)
3194 return 0;
3195 call_void_qop(q, wait_finish, q);
3196 threadio->stop = true;
3197 vb2_internal_streamoff(q, q->type);
3198 call_void_qop(q, wait_prepare, q);
3199 q->fileio = NULL;
3200 fileio->req.count = 0;
3201 vb2_reqbufs(q, &fileio->req);
3202 kfree(fileio);
3203 err = kthread_stop(threadio->thread);
3204 threadio->thread = NULL;
3205 kfree(threadio);
3206 q->fileio = NULL;
3207 q->threadio = NULL;
3208 return err;
3209}
3210EXPORT_SYMBOL_GPL(vb2_thread_stop);
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003211
3212/*
3213 * The following functions are not part of the vb2 core API, but are helper
3214 * functions that plug into struct v4l2_ioctl_ops, struct v4l2_file_operations
3215 * and struct vb2_ops.
3216 * They contain boilerplate code that most if not all drivers have to do
3217 * and so they simplify the driver code.
3218 */
3219
3220/* The queue is busy if there is a owner and you are not that owner. */
3221static inline bool vb2_queue_is_busy(struct video_device *vdev, struct file *file)
3222{
3223 return vdev->queue->owner && vdev->queue->owner != file->private_data;
3224}
3225
3226/* vb2 ioctl helpers */
3227
3228int vb2_ioctl_reqbufs(struct file *file, void *priv,
3229 struct v4l2_requestbuffers *p)
3230{
3231 struct video_device *vdev = video_devdata(file);
3232 int res = __verify_memory_type(vdev->queue, p->memory, p->type);
3233
3234 if (res)
3235 return res;
3236 if (vb2_queue_is_busy(vdev, file))
3237 return -EBUSY;
3238 res = __reqbufs(vdev->queue, p);
3239 /* If count == 0, then the owner has released all buffers and he
3240 is no longer owner of the queue. Otherwise we have a new owner. */
3241 if (res == 0)
3242 vdev->queue->owner = p->count ? file->private_data : NULL;
3243 return res;
3244}
3245EXPORT_SYMBOL_GPL(vb2_ioctl_reqbufs);
3246
3247int vb2_ioctl_create_bufs(struct file *file, void *priv,
3248 struct v4l2_create_buffers *p)
3249{
3250 struct video_device *vdev = video_devdata(file);
3251 int res = __verify_memory_type(vdev->queue, p->memory, p->format.type);
3252
3253 p->index = vdev->queue->num_buffers;
3254 /* If count == 0, then just check if memory and type are valid.
3255 Any -EBUSY result from __verify_memory_type can be mapped to 0. */
3256 if (p->count == 0)
3257 return res != -EBUSY ? res : 0;
3258 if (res)
3259 return res;
3260 if (vb2_queue_is_busy(vdev, file))
3261 return -EBUSY;
3262 res = __create_bufs(vdev->queue, p);
3263 if (res == 0)
3264 vdev->queue->owner = file->private_data;
3265 return res;
3266}
3267EXPORT_SYMBOL_GPL(vb2_ioctl_create_bufs);
3268
3269int vb2_ioctl_prepare_buf(struct file *file, void *priv,
3270 struct v4l2_buffer *p)
3271{
3272 struct video_device *vdev = video_devdata(file);
3273
3274 if (vb2_queue_is_busy(vdev, file))
3275 return -EBUSY;
3276 return vb2_prepare_buf(vdev->queue, p);
3277}
3278EXPORT_SYMBOL_GPL(vb2_ioctl_prepare_buf);
3279
3280int vb2_ioctl_querybuf(struct file *file, void *priv, struct v4l2_buffer *p)
3281{
3282 struct video_device *vdev = video_devdata(file);
3283
3284 /* No need to call vb2_queue_is_busy(), anyone can query buffers. */
3285 return vb2_querybuf(vdev->queue, p);
3286}
3287EXPORT_SYMBOL_GPL(vb2_ioctl_querybuf);
3288
3289int vb2_ioctl_qbuf(struct file *file, void *priv, struct v4l2_buffer *p)
3290{
3291 struct video_device *vdev = video_devdata(file);
3292
3293 if (vb2_queue_is_busy(vdev, file))
3294 return -EBUSY;
3295 return vb2_qbuf(vdev->queue, p);
3296}
3297EXPORT_SYMBOL_GPL(vb2_ioctl_qbuf);
3298
3299int vb2_ioctl_dqbuf(struct file *file, void *priv, struct v4l2_buffer *p)
3300{
3301 struct video_device *vdev = video_devdata(file);
3302
3303 if (vb2_queue_is_busy(vdev, file))
3304 return -EBUSY;
3305 return vb2_dqbuf(vdev->queue, p, file->f_flags & O_NONBLOCK);
3306}
3307EXPORT_SYMBOL_GPL(vb2_ioctl_dqbuf);
3308
3309int vb2_ioctl_streamon(struct file *file, void *priv, enum v4l2_buf_type i)
3310{
3311 struct video_device *vdev = video_devdata(file);
3312
3313 if (vb2_queue_is_busy(vdev, file))
3314 return -EBUSY;
3315 return vb2_streamon(vdev->queue, i);
3316}
3317EXPORT_SYMBOL_GPL(vb2_ioctl_streamon);
3318
3319int vb2_ioctl_streamoff(struct file *file, void *priv, enum v4l2_buf_type i)
3320{
3321 struct video_device *vdev = video_devdata(file);
3322
3323 if (vb2_queue_is_busy(vdev, file))
3324 return -EBUSY;
3325 return vb2_streamoff(vdev->queue, i);
3326}
3327EXPORT_SYMBOL_GPL(vb2_ioctl_streamoff);
3328
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03003329int vb2_ioctl_expbuf(struct file *file, void *priv, struct v4l2_exportbuffer *p)
3330{
3331 struct video_device *vdev = video_devdata(file);
3332
3333 if (vb2_queue_is_busy(vdev, file))
3334 return -EBUSY;
3335 return vb2_expbuf(vdev->queue, p);
3336}
3337EXPORT_SYMBOL_GPL(vb2_ioctl_expbuf);
3338
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003339/* v4l2_file_operations helpers */
3340
3341int vb2_fop_mmap(struct file *file, struct vm_area_struct *vma)
3342{
3343 struct video_device *vdev = video_devdata(file);
Laurent Pinchart8a90f1a2013-08-02 13:55:21 -03003344 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
3345 int err;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003346
Laurent Pinchart8a90f1a2013-08-02 13:55:21 -03003347 if (lock && mutex_lock_interruptible(lock))
3348 return -ERESTARTSYS;
3349 err = vb2_mmap(vdev->queue, vma);
3350 if (lock)
3351 mutex_unlock(lock);
3352 return err;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003353}
3354EXPORT_SYMBOL_GPL(vb2_fop_mmap);
3355
Ricardo Ribalda1380f572013-11-25 05:49:02 -03003356int _vb2_fop_release(struct file *file, struct mutex *lock)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003357{
3358 struct video_device *vdev = video_devdata(file);
3359
3360 if (file->private_data == vdev->queue->owner) {
Ricardo Ribalda1380f572013-11-25 05:49:02 -03003361 if (lock)
3362 mutex_lock(lock);
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003363 vb2_queue_release(vdev->queue);
3364 vdev->queue->owner = NULL;
Ricardo Ribalda1380f572013-11-25 05:49:02 -03003365 if (lock)
3366 mutex_unlock(lock);
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003367 }
3368 return v4l2_fh_release(file);
3369}
Ricardo Ribalda1380f572013-11-25 05:49:02 -03003370EXPORT_SYMBOL_GPL(_vb2_fop_release);
3371
3372int vb2_fop_release(struct file *file)
3373{
3374 struct video_device *vdev = video_devdata(file);
3375 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
3376
3377 return _vb2_fop_release(file, lock);
3378}
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003379EXPORT_SYMBOL_GPL(vb2_fop_release);
3380
Ricardo Ribalda819585b2013-08-28 04:39:29 -03003381ssize_t vb2_fop_write(struct file *file, const char __user *buf,
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003382 size_t count, loff_t *ppos)
3383{
3384 struct video_device *vdev = video_devdata(file);
3385 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003386 int err = -EBUSY;
3387
Hans Verkuilcf533732012-07-31 04:02:25 -03003388 if (lock && mutex_lock_interruptible(lock))
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003389 return -ERESTARTSYS;
3390 if (vb2_queue_is_busy(vdev, file))
3391 goto exit;
3392 err = vb2_write(vdev->queue, buf, count, ppos,
3393 file->f_flags & O_NONBLOCK);
Hans Verkuil8c82c752012-09-07 12:50:02 -03003394 if (vdev->queue->fileio)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003395 vdev->queue->owner = file->private_data;
3396exit:
Hans Verkuilcf533732012-07-31 04:02:25 -03003397 if (lock)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003398 mutex_unlock(lock);
3399 return err;
3400}
3401EXPORT_SYMBOL_GPL(vb2_fop_write);
3402
3403ssize_t vb2_fop_read(struct file *file, char __user *buf,
3404 size_t count, loff_t *ppos)
3405{
3406 struct video_device *vdev = video_devdata(file);
3407 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003408 int err = -EBUSY;
3409
Hans Verkuilcf533732012-07-31 04:02:25 -03003410 if (lock && mutex_lock_interruptible(lock))
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003411 return -ERESTARTSYS;
3412 if (vb2_queue_is_busy(vdev, file))
3413 goto exit;
3414 err = vb2_read(vdev->queue, buf, count, ppos,
3415 file->f_flags & O_NONBLOCK);
Hans Verkuil8c82c752012-09-07 12:50:02 -03003416 if (vdev->queue->fileio)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003417 vdev->queue->owner = file->private_data;
3418exit:
Hans Verkuilcf533732012-07-31 04:02:25 -03003419 if (lock)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003420 mutex_unlock(lock);
3421 return err;
3422}
3423EXPORT_SYMBOL_GPL(vb2_fop_read);
3424
3425unsigned int vb2_fop_poll(struct file *file, poll_table *wait)
3426{
3427 struct video_device *vdev = video_devdata(file);
3428 struct vb2_queue *q = vdev->queue;
3429 struct mutex *lock = q->lock ? q->lock : vdev->lock;
3430 unsigned long req_events = poll_requested_events(wait);
3431 unsigned res;
3432 void *fileio;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003433 bool must_lock = false;
3434
3435 /* Try to be smart: only lock if polling might start fileio,
3436 otherwise locking will only introduce unwanted delays. */
Hans Verkuil74753cffa2014-04-07 09:23:50 -03003437 if (q->num_buffers == 0 && !vb2_fileio_is_active(q)) {
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003438 if (!V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_READ) &&
3439 (req_events & (POLLIN | POLLRDNORM)))
3440 must_lock = true;
3441 else if (V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_WRITE) &&
3442 (req_events & (POLLOUT | POLLWRNORM)))
3443 must_lock = true;
3444 }
3445
3446 /* If locking is needed, but this helper doesn't know how, then you
3447 shouldn't be using this helper but you should write your own. */
Hans Verkuilcf533732012-07-31 04:02:25 -03003448 WARN_ON(must_lock && !lock);
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003449
Hans Verkuilcf533732012-07-31 04:02:25 -03003450 if (must_lock && lock && mutex_lock_interruptible(lock))
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003451 return POLLERR;
3452
3453 fileio = q->fileio;
3454
3455 res = vb2_poll(vdev->queue, file, wait);
3456
3457 /* If fileio was started, then we have a new queue owner. */
3458 if (must_lock && !fileio && q->fileio)
3459 q->owner = file->private_data;
Hans Verkuilcf533732012-07-31 04:02:25 -03003460 if (must_lock && lock)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003461 mutex_unlock(lock);
3462 return res;
3463}
3464EXPORT_SYMBOL_GPL(vb2_fop_poll);
3465
3466#ifndef CONFIG_MMU
3467unsigned long vb2_fop_get_unmapped_area(struct file *file, unsigned long addr,
3468 unsigned long len, unsigned long pgoff, unsigned long flags)
3469{
3470 struct video_device *vdev = video_devdata(file);
Laurent Pinchart8a90f1a2013-08-02 13:55:21 -03003471 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
3472 int ret;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003473
Laurent Pinchart8a90f1a2013-08-02 13:55:21 -03003474 if (lock && mutex_lock_interruptible(lock))
3475 return -ERESTARTSYS;
3476 ret = vb2_get_unmapped_area(vdev->queue, addr, len, pgoff, flags);
3477 if (lock)
3478 mutex_unlock(lock);
3479 return ret;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003480}
3481EXPORT_SYMBOL_GPL(vb2_fop_get_unmapped_area);
3482#endif
3483
3484/* vb2_ops helpers. Only use if vq->lock is non-NULL. */
3485
3486void vb2_ops_wait_prepare(struct vb2_queue *vq)
3487{
3488 mutex_unlock(vq->lock);
3489}
3490EXPORT_SYMBOL_GPL(vb2_ops_wait_prepare);
3491
3492void vb2_ops_wait_finish(struct vb2_queue *vq)
3493{
3494 mutex_lock(vq->lock);
3495}
3496EXPORT_SYMBOL_GPL(vb2_ops_wait_finish);
3497
Pawel Osciake23ccc02010-10-11 10:56:41 -03003498MODULE_DESCRIPTION("Driver helper framework for Video for Linux 2");
Pawel Osciak95072082011-03-13 15:23:32 -03003499MODULE_AUTHOR("Pawel Osciak <pawel@osciak.com>, Marek Szyprowski");
Pawel Osciake23ccc02010-10-11 10:56:41 -03003500MODULE_LICENSE("GPL");