blob: 6489c991700a9c651e719ce61e32b9ca013bcd54 [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/**
Hans Verkuil32a77262012-09-28 06:12:53 -03001203 * __fill_vb2_buffer() - fill a vb2_buffer with information provided in a
1204 * v4l2_buffer by the userspace. The caller has already verified that struct
1205 * v4l2_buffer has a valid number of planes.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001206 */
Hans Verkuil32a77262012-09-28 06:12:53 -03001207static void __fill_vb2_buffer(struct vb2_buffer *vb, const struct v4l2_buffer *b,
Pawel Osciake23ccc02010-10-11 10:56:41 -03001208 struct v4l2_plane *v4l2_planes)
1209{
1210 unsigned int plane;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001211
1212 if (V4L2_TYPE_IS_MULTIPLANAR(b->type)) {
Pawel Osciake23ccc02010-10-11 10:56:41 -03001213 /* Fill in driver-provided information for OUTPUT types */
1214 if (V4L2_TYPE_IS_OUTPUT(b->type)) {
Hans Verkuil61bd8fb2014-04-07 08:57:48 -03001215 bool bytesused_is_used;
1216
1217 /* Check if bytesused == 0 for all planes */
1218 for (plane = 0; plane < vb->num_planes; ++plane)
1219 if (b->m.planes[plane].bytesused)
1220 break;
1221 bytesused_is_used = plane < vb->num_planes;
1222
Pawel Osciake23ccc02010-10-11 10:56:41 -03001223 /*
1224 * Will have to go up to b->length when API starts
1225 * accepting variable number of planes.
Hans Verkuil61bd8fb2014-04-07 08:57:48 -03001226 *
1227 * If bytesused_is_used is false, then fall back to the
1228 * full buffer size. In that case userspace clearly
1229 * never bothered to set it and it's a safe assumption
1230 * that they really meant to use the full plane sizes.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001231 */
1232 for (plane = 0; plane < vb->num_planes; ++plane) {
Hans Verkuil61bd8fb2014-04-07 08:57:48 -03001233 struct v4l2_plane *pdst = &v4l2_planes[plane];
1234 struct v4l2_plane *psrc = &b->m.planes[plane];
1235
1236 pdst->bytesused = bytesused_is_used ?
1237 psrc->bytesused : psrc->length;
1238 pdst->data_offset = psrc->data_offset;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001239 }
1240 }
1241
1242 if (b->memory == V4L2_MEMORY_USERPTR) {
1243 for (plane = 0; plane < vb->num_planes; ++plane) {
1244 v4l2_planes[plane].m.userptr =
1245 b->m.planes[plane].m.userptr;
1246 v4l2_planes[plane].length =
1247 b->m.planes[plane].length;
1248 }
1249 }
Sumit Semwalc5384042012-06-14 10:37:37 -03001250 if (b->memory == V4L2_MEMORY_DMABUF) {
1251 for (plane = 0; plane < vb->num_planes; ++plane) {
1252 v4l2_planes[plane].m.fd =
1253 b->m.planes[plane].m.fd;
1254 v4l2_planes[plane].length =
1255 b->m.planes[plane].length;
Sumit Semwalc5384042012-06-14 10:37:37 -03001256 }
1257 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001258 } else {
1259 /*
1260 * Single-planar buffers do not use planes array,
1261 * so fill in relevant v4l2_buffer struct fields instead.
1262 * In videobuf we use our internal V4l2_planes struct for
1263 * single-planar buffers as well, for simplicity.
Hans Verkuil61bd8fb2014-04-07 08:57:48 -03001264 *
1265 * If bytesused == 0, then fall back to the full buffer size
1266 * as that's a sensible default.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001267 */
Hans Verkuil412376a2014-04-07 08:44:56 -03001268 if (V4L2_TYPE_IS_OUTPUT(b->type))
Hans Verkuil61bd8fb2014-04-07 08:57:48 -03001269 v4l2_planes[0].bytesused =
1270 b->bytesused ? b->bytesused : b->length;
1271 else
1272 v4l2_planes[0].bytesused = 0;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001273
1274 if (b->memory == V4L2_MEMORY_USERPTR) {
1275 v4l2_planes[0].m.userptr = b->m.userptr;
1276 v4l2_planes[0].length = b->length;
1277 }
Sumit Semwalc5384042012-06-14 10:37:37 -03001278
1279 if (b->memory == V4L2_MEMORY_DMABUF) {
1280 v4l2_planes[0].m.fd = b->m.fd;
1281 v4l2_planes[0].length = b->length;
Sumit Semwalc5384042012-06-14 10:37:37 -03001282 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001283 }
1284
Hans Verkuilf1343282014-02-24 14:44:50 -03001285 /* Zero flags that the vb2 core handles */
Sakari Ailus1b18e7a2012-10-22 17:10:16 -03001286 vb->v4l2_buf.flags = b->flags & ~V4L2_BUFFER_MASK_FLAGS;
Sakari Ailus7ce6fd82014-02-25 19:08:52 -03001287 if ((vb->vb2_queue->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) !=
1288 V4L2_BUF_FLAG_TIMESTAMP_COPY || !V4L2_TYPE_IS_OUTPUT(b->type)) {
1289 /*
1290 * Non-COPY timestamps and non-OUTPUT queues will get
1291 * their timestamp and timestamp source flags from the
1292 * queue.
1293 */
1294 vb->v4l2_buf.flags &= ~V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
1295 }
1296
Hans Verkuilf1343282014-02-24 14:44:50 -03001297 if (V4L2_TYPE_IS_OUTPUT(b->type)) {
1298 /*
1299 * For output buffers mask out the timecode flag:
1300 * this will be handled later in vb2_internal_qbuf().
1301 * The 'field' is valid metadata for this output buffer
1302 * and so that needs to be copied here.
1303 */
1304 vb->v4l2_buf.flags &= ~V4L2_BUF_FLAG_TIMECODE;
1305 vb->v4l2_buf.field = b->field;
1306 } else {
1307 /* Zero any output buffer flags as this is a capture buffer */
1308 vb->v4l2_buf.flags &= ~V4L2_BUFFER_OUT_FLAGS;
1309 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001310}
1311
1312/**
Hans Verkuildcc24282014-03-10 12:23:13 -03001313 * __qbuf_mmap() - handle qbuf of an MMAP buffer
1314 */
1315static int __qbuf_mmap(struct vb2_buffer *vb, const struct v4l2_buffer *b)
1316{
1317 __fill_vb2_buffer(vb, b, vb->v4l2_planes);
1318 return call_vb_qop(vb, buf_prepare, vb);
1319}
1320
1321/**
Pawel Osciake23ccc02010-10-11 10:56:41 -03001322 * __qbuf_userptr() - handle qbuf of a USERPTR buffer
1323 */
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001324static int __qbuf_userptr(struct vb2_buffer *vb, const struct v4l2_buffer *b)
Pawel Osciake23ccc02010-10-11 10:56:41 -03001325{
1326 struct v4l2_plane planes[VIDEO_MAX_PLANES];
1327 struct vb2_queue *q = vb->vb2_queue;
1328 void *mem_priv;
1329 unsigned int plane;
1330 int ret;
1331 int write = !V4L2_TYPE_IS_OUTPUT(q->type);
Hans Verkuil256f3162014-01-29 13:36:53 -03001332 bool reacquired = vb->planes[0].mem_priv == NULL;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001333
Hans Verkuil412376a2014-04-07 08:44:56 -03001334 memset(planes, 0, sizeof(planes[0]) * vb->num_planes);
Hans Verkuil32a77262012-09-28 06:12:53 -03001335 /* Copy relevant information provided by the userspace */
1336 __fill_vb2_buffer(vb, b, planes);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001337
1338 for (plane = 0; plane < vb->num_planes; ++plane) {
1339 /* Skip the plane if already verified */
Marek Szyprowskif0b7c7f2011-11-16 15:09:40 -03001340 if (vb->v4l2_planes[plane].m.userptr &&
1341 vb->v4l2_planes[plane].m.userptr == planes[plane].m.userptr
Pawel Osciake23ccc02010-10-11 10:56:41 -03001342 && vb->v4l2_planes[plane].length == planes[plane].length)
1343 continue;
1344
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001345 dprintk(3, "userspace address for plane %d changed, "
Pawel Osciake23ccc02010-10-11 10:56:41 -03001346 "reacquiring memory\n", plane);
1347
Marek Szyprowskic1426bc2011-08-24 06:36:26 -03001348 /* Check if the provided plane buffer is large enough */
1349 if (planes[plane].length < q->plane_sizes[plane]) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001350 dprintk(1, "provided buffer size %u is less than "
Seung-Woo Kim2484a7e2013-08-20 04:48:06 -03001351 "setup size %u for plane %d\n",
1352 planes[plane].length,
1353 q->plane_sizes[plane], plane);
Marek Szyprowski4c2625d2011-10-03 03:21:45 -03001354 ret = -EINVAL;
Marek Szyprowskic1426bc2011-08-24 06:36:26 -03001355 goto err;
1356 }
1357
Pawel Osciake23ccc02010-10-11 10:56:41 -03001358 /* Release previously acquired memory if present */
Hans Verkuil256f3162014-01-29 13:36:53 -03001359 if (vb->planes[plane].mem_priv) {
1360 if (!reacquired) {
1361 reacquired = true;
Hans Verkuila1d36d82014-03-17 09:54:21 -03001362 call_void_vb_qop(vb, buf_cleanup, vb);
Hans Verkuil256f3162014-01-29 13:36:53 -03001363 }
Hans Verkuila1d36d82014-03-17 09:54:21 -03001364 call_void_memop(vb, put_userptr, vb->planes[plane].mem_priv);
Hans Verkuil256f3162014-01-29 13:36:53 -03001365 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001366
1367 vb->planes[plane].mem_priv = NULL;
Hans Verkuil256f3162014-01-29 13:36:53 -03001368 memset(&vb->v4l2_planes[plane], 0, sizeof(struct v4l2_plane));
Pawel Osciake23ccc02010-10-11 10:56:41 -03001369
1370 /* Acquire each plane's memory */
Hans Verkuila1d36d82014-03-17 09:54:21 -03001371 mem_priv = call_ptr_memop(vb, get_userptr, q->alloc_ctx[plane],
Marek Szyprowskia00d0262011-12-15 05:53:06 -03001372 planes[plane].m.userptr,
1373 planes[plane].length, write);
1374 if (IS_ERR_OR_NULL(mem_priv)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001375 dprintk(1, "failed acquiring userspace "
Pawel Osciake23ccc02010-10-11 10:56:41 -03001376 "memory for plane %d\n", plane);
Marek Szyprowskia00d0262011-12-15 05:53:06 -03001377 ret = mem_priv ? PTR_ERR(mem_priv) : -EINVAL;
1378 goto err;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001379 }
Marek Szyprowskia00d0262011-12-15 05:53:06 -03001380 vb->planes[plane].mem_priv = mem_priv;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001381 }
1382
1383 /*
Pawel Osciake23ccc02010-10-11 10:56:41 -03001384 * Now that everything is in order, copy relevant information
1385 * provided by userspace.
1386 */
1387 for (plane = 0; plane < vb->num_planes; ++plane)
1388 vb->v4l2_planes[plane] = planes[plane];
1389
Hans Verkuil256f3162014-01-29 13:36:53 -03001390 if (reacquired) {
1391 /*
1392 * One or more planes changed, so we must call buf_init to do
1393 * the driver-specific initialization on the newly acquired
1394 * buffer, if provided.
1395 */
1396 ret = call_vb_qop(vb, buf_init, vb);
1397 if (ret) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001398 dprintk(1, "buffer initialization failed\n");
Hans Verkuil256f3162014-01-29 13:36:53 -03001399 goto err;
1400 }
1401 }
1402
1403 ret = call_vb_qop(vb, buf_prepare, vb);
1404 if (ret) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001405 dprintk(1, "buffer preparation failed\n");
Hans Verkuila1d36d82014-03-17 09:54:21 -03001406 call_void_vb_qop(vb, buf_cleanup, vb);
Hans Verkuil256f3162014-01-29 13:36:53 -03001407 goto err;
1408 }
1409
Pawel Osciake23ccc02010-10-11 10:56:41 -03001410 return 0;
1411err:
1412 /* In case of errors, release planes that were already acquired */
Marek Szyprowskic1426bc2011-08-24 06:36:26 -03001413 for (plane = 0; plane < vb->num_planes; ++plane) {
1414 if (vb->planes[plane].mem_priv)
Hans Verkuila1d36d82014-03-17 09:54:21 -03001415 call_void_memop(vb, put_userptr, vb->planes[plane].mem_priv);
Marek Szyprowskic1426bc2011-08-24 06:36:26 -03001416 vb->planes[plane].mem_priv = NULL;
1417 vb->v4l2_planes[plane].m.userptr = 0;
1418 vb->v4l2_planes[plane].length = 0;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001419 }
1420
1421 return ret;
1422}
1423
1424/**
Sumit Semwalc5384042012-06-14 10:37:37 -03001425 * __qbuf_dmabuf() - handle qbuf of a DMABUF buffer
1426 */
1427static int __qbuf_dmabuf(struct vb2_buffer *vb, const struct v4l2_buffer *b)
1428{
1429 struct v4l2_plane planes[VIDEO_MAX_PLANES];
1430 struct vb2_queue *q = vb->vb2_queue;
1431 void *mem_priv;
1432 unsigned int plane;
1433 int ret;
1434 int write = !V4L2_TYPE_IS_OUTPUT(q->type);
Hans Verkuil256f3162014-01-29 13:36:53 -03001435 bool reacquired = vb->planes[0].mem_priv == NULL;
Sumit Semwalc5384042012-06-14 10:37:37 -03001436
Hans Verkuil412376a2014-04-07 08:44:56 -03001437 memset(planes, 0, sizeof(planes[0]) * vb->num_planes);
Laurent Pinchart6f546c52014-01-01 09:10:48 -03001438 /* Copy relevant information provided by the userspace */
Sumit Semwalc5384042012-06-14 10:37:37 -03001439 __fill_vb2_buffer(vb, b, planes);
1440
1441 for (plane = 0; plane < vb->num_planes; ++plane) {
1442 struct dma_buf *dbuf = dma_buf_get(planes[plane].m.fd);
1443
1444 if (IS_ERR_OR_NULL(dbuf)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001445 dprintk(1, "invalid dmabuf fd for plane %d\n",
Sumit Semwalc5384042012-06-14 10:37:37 -03001446 plane);
1447 ret = -EINVAL;
1448 goto err;
1449 }
1450
1451 /* use DMABUF size if length is not provided */
1452 if (planes[plane].length == 0)
1453 planes[plane].length = dbuf->size;
1454
Hans Verkuil412376a2014-04-07 08:44:56 -03001455 if (planes[plane].length < q->plane_sizes[plane]) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001456 dprintk(1, "invalid dmabuf length for plane %d\n",
Seung-Woo Kim77c07822013-11-29 04:50:29 -03001457 plane);
Sumit Semwalc5384042012-06-14 10:37:37 -03001458 ret = -EINVAL;
1459 goto err;
1460 }
1461
1462 /* Skip the plane if already verified */
1463 if (dbuf == vb->planes[plane].dbuf &&
1464 vb->v4l2_planes[plane].length == planes[plane].length) {
1465 dma_buf_put(dbuf);
1466 continue;
1467 }
1468
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001469 dprintk(1, "buffer for plane %d changed\n", plane);
Sumit Semwalc5384042012-06-14 10:37:37 -03001470
Hans Verkuil256f3162014-01-29 13:36:53 -03001471 if (!reacquired) {
1472 reacquired = true;
Hans Verkuila1d36d82014-03-17 09:54:21 -03001473 call_void_vb_qop(vb, buf_cleanup, vb);
Hans Verkuil256f3162014-01-29 13:36:53 -03001474 }
1475
Sumit Semwalc5384042012-06-14 10:37:37 -03001476 /* Release previously acquired memory if present */
Hans Verkuilb5b45412014-01-29 11:53:25 -03001477 __vb2_plane_dmabuf_put(vb, &vb->planes[plane]);
Sumit Semwalc5384042012-06-14 10:37:37 -03001478 memset(&vb->v4l2_planes[plane], 0, sizeof(struct v4l2_plane));
1479
1480 /* Acquire each plane's memory */
Hans Verkuila1d36d82014-03-17 09:54:21 -03001481 mem_priv = call_ptr_memop(vb, attach_dmabuf, q->alloc_ctx[plane],
Sumit Semwalc5384042012-06-14 10:37:37 -03001482 dbuf, planes[plane].length, write);
1483 if (IS_ERR(mem_priv)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001484 dprintk(1, "failed to attach dmabuf\n");
Sumit Semwalc5384042012-06-14 10:37:37 -03001485 ret = PTR_ERR(mem_priv);
1486 dma_buf_put(dbuf);
1487 goto err;
1488 }
1489
1490 vb->planes[plane].dbuf = dbuf;
1491 vb->planes[plane].mem_priv = mem_priv;
1492 }
1493
1494 /* TODO: This pins the buffer(s) with dma_buf_map_attachment()).. but
1495 * really we want to do this just before the DMA, not while queueing
1496 * the buffer(s)..
1497 */
1498 for (plane = 0; plane < vb->num_planes; ++plane) {
Hans Verkuilb5b45412014-01-29 11:53:25 -03001499 ret = call_memop(vb, map_dmabuf, vb->planes[plane].mem_priv);
Sumit Semwalc5384042012-06-14 10:37:37 -03001500 if (ret) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001501 dprintk(1, "failed to map dmabuf for plane %d\n",
Sumit Semwalc5384042012-06-14 10:37:37 -03001502 plane);
1503 goto err;
1504 }
1505 vb->planes[plane].dbuf_mapped = 1;
1506 }
1507
1508 /*
Sumit Semwalc5384042012-06-14 10:37:37 -03001509 * Now that everything is in order, copy relevant information
1510 * provided by userspace.
1511 */
1512 for (plane = 0; plane < vb->num_planes; ++plane)
1513 vb->v4l2_planes[plane] = planes[plane];
1514
Hans Verkuil256f3162014-01-29 13:36:53 -03001515 if (reacquired) {
1516 /*
1517 * Call driver-specific initialization on the newly acquired buffer,
1518 * if provided.
1519 */
1520 ret = call_vb_qop(vb, buf_init, vb);
1521 if (ret) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001522 dprintk(1, "buffer initialization failed\n");
Hans Verkuil256f3162014-01-29 13:36:53 -03001523 goto err;
1524 }
1525 }
1526
1527 ret = call_vb_qop(vb, buf_prepare, vb);
1528 if (ret) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001529 dprintk(1, "buffer preparation failed\n");
Hans Verkuila1d36d82014-03-17 09:54:21 -03001530 call_void_vb_qop(vb, buf_cleanup, vb);
Hans Verkuil256f3162014-01-29 13:36:53 -03001531 goto err;
1532 }
1533
Sumit Semwalc5384042012-06-14 10:37:37 -03001534 return 0;
1535err:
1536 /* In case of errors, release planes that were already acquired */
1537 __vb2_buf_dmabuf_put(vb);
1538
1539 return ret;
1540}
1541
1542/**
Pawel Osciake23ccc02010-10-11 10:56:41 -03001543 * __enqueue_in_driver() - enqueue a vb2_buffer in driver for processing
1544 */
1545static void __enqueue_in_driver(struct vb2_buffer *vb)
1546{
1547 struct vb2_queue *q = vb->vb2_queue;
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -03001548 unsigned int plane;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001549
1550 vb->state = VB2_BUF_STATE_ACTIVE;
Hans Verkuil6ea3b982014-02-06 05:46:11 -03001551 atomic_inc(&q->owned_by_drv_count);
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -03001552
1553 /* sync buffers */
1554 for (plane = 0; plane < vb->num_planes; ++plane)
Hans Verkuila1d36d82014-03-17 09:54:21 -03001555 call_void_memop(vb, prepare, vb->planes[plane].mem_priv);
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -03001556
Hans Verkuila1d36d82014-03-17 09:54:21 -03001557 call_void_vb_qop(vb, buf_queue, vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001558}
1559
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001560static int __buf_prepare(struct vb2_buffer *vb, const struct v4l2_buffer *b)
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001561{
1562 struct vb2_queue *q = vb->vb2_queue;
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001563 struct rw_semaphore *mmap_sem;
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001564 int ret;
1565
Laurent Pinchart8023ed02012-07-10 10:41:40 -03001566 ret = __verify_length(vb, b);
Sylwester Nawrocki3a9621b2013-08-26 11:47:53 -03001567 if (ret < 0) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001568 dprintk(1, "plane parameters verification failed: %d\n", ret);
Laurent Pinchart8023ed02012-07-10 10:41:40 -03001569 return ret;
Sylwester Nawrocki3a9621b2013-08-26 11:47:53 -03001570 }
Hans Verkuile35e41b2014-04-07 09:20:39 -03001571 if (b->field == V4L2_FIELD_ALTERNATE && V4L2_TYPE_IS_OUTPUT(q->type)) {
1572 /*
1573 * If the format's field is ALTERNATE, then the buffer's field
1574 * should be either TOP or BOTTOM, not ALTERNATE since that
1575 * makes no sense. The driver has to know whether the
1576 * buffer represents a top or a bottom field in order to
1577 * program any DMA correctly. Using ALTERNATE is wrong, since
1578 * that just says that it is either a top or a bottom field,
1579 * but not which of the two it is.
1580 */
1581 dprintk(1, "the field is incorrectly set to ALTERNATE for an output buffer\n");
1582 return -EINVAL;
1583 }
Laurent Pinchart8023ed02012-07-10 10:41:40 -03001584
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001585 vb->state = VB2_BUF_STATE_PREPARING;
Hans Verkuilf1343282014-02-24 14:44:50 -03001586 vb->v4l2_buf.timestamp.tv_sec = 0;
1587 vb->v4l2_buf.timestamp.tv_usec = 0;
1588 vb->v4l2_buf.sequence = 0;
1589
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001590 switch (q->memory) {
1591 case V4L2_MEMORY_MMAP:
1592 ret = __qbuf_mmap(vb, b);
1593 break;
1594 case V4L2_MEMORY_USERPTR:
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001595 /*
Mauro Carvalho Chehabf103b5d2014-01-07 07:03:09 -02001596 * In case of user pointer buffers vb2 allocators need to get
1597 * direct access to userspace pages. This requires getting
1598 * the mmap semaphore for read access in the current process
1599 * structure. The same semaphore is taken before calling mmap
1600 * operation, while both qbuf/prepare_buf and mmap are called
1601 * by the driver or v4l2 core with the driver's lock held.
1602 * To avoid an AB-BA deadlock (mmap_sem then driver's lock in
1603 * mmap and driver's lock then mmap_sem in qbuf/prepare_buf),
1604 * the videobuf2 core releases the driver's lock, takes
1605 * mmap_sem and then takes the driver's lock again.
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001606 */
1607 mmap_sem = &current->mm->mmap_sem;
Hans Verkuila1d36d82014-03-17 09:54:21 -03001608 call_void_qop(q, wait_prepare, q);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001609 down_read(mmap_sem);
Hans Verkuila1d36d82014-03-17 09:54:21 -03001610 call_void_qop(q, wait_finish, q);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001611
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001612 ret = __qbuf_userptr(vb, b);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001613
1614 up_read(mmap_sem);
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001615 break;
Sumit Semwalc5384042012-06-14 10:37:37 -03001616 case V4L2_MEMORY_DMABUF:
1617 ret = __qbuf_dmabuf(vb, b);
1618 break;
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001619 default:
1620 WARN(1, "Invalid queue type\n");
1621 ret = -EINVAL;
1622 }
1623
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001624 if (ret)
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001625 dprintk(1, "buffer preparation failed: %d\n", ret);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001626 vb->state = ret ? VB2_BUF_STATE_DEQUEUED : VB2_BUF_STATE_PREPARED;
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -03001627
1628 return ret;
1629}
1630
Laurent Pinchart012043b2013-08-09 08:11:26 -03001631static int vb2_queue_or_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b,
Hans Verkuil41381112013-12-13 13:13:39 -03001632 const char *opname)
Laurent Pinchart012043b2013-08-09 08:11:26 -03001633{
Laurent Pinchart012043b2013-08-09 08:11:26 -03001634 if (b->type != q->type) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001635 dprintk(1, "%s: invalid buffer type\n", opname);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001636 return -EINVAL;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001637 }
1638
1639 if (b->index >= q->num_buffers) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001640 dprintk(1, "%s: buffer index out of range\n", opname);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001641 return -EINVAL;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001642 }
1643
Hans Verkuil41381112013-12-13 13:13:39 -03001644 if (q->bufs[b->index] == NULL) {
Laurent Pinchart012043b2013-08-09 08:11:26 -03001645 /* Should never happen */
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001646 dprintk(1, "%s: buffer is NULL\n", opname);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001647 return -EINVAL;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001648 }
1649
1650 if (b->memory != q->memory) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001651 dprintk(1, "%s: invalid memory type\n", opname);
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001652 return -EINVAL;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001653 }
1654
Hans Verkuil41381112013-12-13 13:13:39 -03001655 return __verify_planes_array(q->bufs[b->index], b);
Laurent Pinchart012043b2013-08-09 08:11:26 -03001656}
1657
Pawel Osciake23ccc02010-10-11 10:56:41 -03001658/**
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001659 * vb2_prepare_buf() - Pass ownership of a buffer from userspace to the kernel
1660 * @q: videobuf2 queue
1661 * @b: buffer structure passed from userspace to vidioc_prepare_buf
1662 * handler in driver
1663 *
1664 * Should be called from vidioc_prepare_buf ioctl handler of a driver.
1665 * This function:
1666 * 1) verifies the passed buffer,
1667 * 2) calls buf_prepare callback in the driver (if provided), in which
1668 * driver-specific buffer initialization can be performed,
1669 *
1670 * The return values from this function are intended to be directly returned
1671 * from vidioc_prepare_buf handler in driver.
1672 */
1673int vb2_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b)
1674{
Hans Verkuil41381112013-12-13 13:13:39 -03001675 struct vb2_buffer *vb;
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001676 int ret;
Hans Verkuil41381112013-12-13 13:13:39 -03001677
Hans Verkuil74753cffa2014-04-07 09:23:50 -03001678 if (vb2_fileio_is_active(q)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001679 dprintk(1, "file io in progress\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001680 return -EBUSY;
1681 }
1682
1683 ret = vb2_queue_or_prepare_buf(q, b, "prepare_buf");
Hans Verkuil41381112013-12-13 13:13:39 -03001684 if (ret)
1685 return ret;
1686
1687 vb = q->bufs[b->index];
1688 if (vb->state != VB2_BUF_STATE_DEQUEUED) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001689 dprintk(1, "invalid buffer state %d\n",
Hans Verkuil41381112013-12-13 13:13:39 -03001690 vb->state);
1691 return -EINVAL;
1692 }
1693
1694 ret = __buf_prepare(vb, b);
1695 if (!ret) {
1696 /* Fill buffer information for the userspace */
1697 __fill_v4l2_buffer(vb, b);
1698
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001699 dprintk(1, "prepare of buffer %d succeeded\n", vb->v4l2_buf.index);
Hans Verkuil41381112013-12-13 13:13:39 -03001700 }
1701 return ret;
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03001702}
1703EXPORT_SYMBOL_GPL(vb2_prepare_buf);
1704
Hans Verkuil02f142e2013-12-13 13:13:42 -03001705/**
1706 * vb2_start_streaming() - Attempt to start streaming.
1707 * @q: videobuf2 queue
1708 *
Hans Verkuilb3379c62014-02-24 13:51:03 -03001709 * Attempt to start streaming. When this function is called there must be
1710 * at least q->min_buffers_needed buffers queued up (i.e. the minimum
1711 * number of buffers required for the DMA engine to function). If the
1712 * @start_streaming op fails it is supposed to return all the driver-owned
1713 * buffers back to vb2 in state QUEUED. Check if that happened and if
1714 * not warn and reclaim them forcefully.
Hans Verkuil02f142e2013-12-13 13:13:42 -03001715 */
1716static int vb2_start_streaming(struct vb2_queue *q)
1717{
Hans Verkuilb3379c62014-02-24 13:51:03 -03001718 struct vb2_buffer *vb;
Hans Verkuil02f142e2013-12-13 13:13:42 -03001719 int ret;
1720
Hans Verkuil02f142e2013-12-13 13:13:42 -03001721 /*
Hans Verkuilb3379c62014-02-24 13:51:03 -03001722 * If any buffers were queued before streamon,
1723 * we can now pass them to driver for processing.
Hans Verkuil02f142e2013-12-13 13:13:42 -03001724 */
Hans Verkuilb3379c62014-02-24 13:51:03 -03001725 list_for_each_entry(vb, &q->queued_list, queued_entry)
1726 __enqueue_in_driver(vb);
1727
1728 /* Tell the driver to start streaming */
1729 ret = call_qop(q, start_streaming, q,
1730 atomic_read(&q->owned_by_drv_count));
1731 q->start_streaming_called = ret == 0;
1732 if (!ret)
Hans Verkuil02f142e2013-12-13 13:13:42 -03001733 return 0;
Hans Verkuilb3379c62014-02-24 13:51:03 -03001734
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001735 dprintk(1, "driver refused to start streaming\n");
Hans Verkuilb3379c62014-02-24 13:51:03 -03001736 if (WARN_ON(atomic_read(&q->owned_by_drv_count))) {
1737 unsigned i;
1738
1739 /*
1740 * Forcefully reclaim buffers if the driver did not
1741 * correctly return them to vb2.
1742 */
1743 for (i = 0; i < q->num_buffers; ++i) {
1744 vb = q->bufs[i];
1745 if (vb->state == VB2_BUF_STATE_ACTIVE)
1746 vb2_buffer_done(vb, VB2_BUF_STATE_QUEUED);
1747 }
1748 /* Must be zero now */
1749 WARN_ON(atomic_read(&q->owned_by_drv_count));
Hans Verkuil02f142e2013-12-13 13:13:42 -03001750 }
Hans Verkuil02f142e2013-12-13 13:13:42 -03001751 return ret;
1752}
1753
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001754static int vb2_internal_qbuf(struct vb2_queue *q, struct v4l2_buffer *b)
Laurent Pinchart012043b2013-08-09 08:11:26 -03001755{
Hans Verkuil41381112013-12-13 13:13:39 -03001756 int ret = vb2_queue_or_prepare_buf(q, b, "qbuf");
1757 struct vb2_buffer *vb;
1758
1759 if (ret)
1760 return ret;
1761
1762 vb = q->bufs[b->index];
Laurent Pinchart012043b2013-08-09 08:11:26 -03001763
1764 switch (vb->state) {
1765 case VB2_BUF_STATE_DEQUEUED:
1766 ret = __buf_prepare(vb, b);
1767 if (ret)
1768 return ret;
Hans Verkuil41381112013-12-13 13:13:39 -03001769 break;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001770 case VB2_BUF_STATE_PREPARED:
1771 break;
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001772 case VB2_BUF_STATE_PREPARING:
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001773 dprintk(1, "buffer still being prepared\n");
Hans Verkuilb18a8ff2013-12-13 13:13:38 -03001774 return -EINVAL;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001775 default:
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001776 dprintk(1, "invalid buffer state %d\n", vb->state);
Laurent Pinchart012043b2013-08-09 08:11:26 -03001777 return -EINVAL;
1778 }
1779
1780 /*
1781 * Add to the queued buffers list, a buffer will stay on it until
1782 * dequeued in dqbuf.
1783 */
1784 list_add_tail(&vb->queued_entry, &q->queued_list);
Hans Verkuilb3379c62014-02-24 13:51:03 -03001785 q->queued_count++;
Laurent Pinchart012043b2013-08-09 08:11:26 -03001786 vb->state = VB2_BUF_STATE_QUEUED;
Hans Verkuilf1343282014-02-24 14:44:50 -03001787 if (V4L2_TYPE_IS_OUTPUT(q->type)) {
1788 /*
1789 * For output buffers copy the timestamp if needed,
1790 * and the timecode field and flag if needed.
1791 */
Sakari Ailusc57ff792014-03-01 10:28:02 -03001792 if ((q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
1793 V4L2_BUF_FLAG_TIMESTAMP_COPY)
Hans Verkuilf1343282014-02-24 14:44:50 -03001794 vb->v4l2_buf.timestamp = b->timestamp;
1795 vb->v4l2_buf.flags |= b->flags & V4L2_BUF_FLAG_TIMECODE;
1796 if (b->flags & V4L2_BUF_FLAG_TIMECODE)
1797 vb->v4l2_buf.timecode = b->timecode;
1798 }
Laurent Pinchart012043b2013-08-09 08:11:26 -03001799
1800 /*
1801 * If already streaming, give the buffer to driver for processing.
1802 * If not, the buffer will be given to driver on next streamon.
1803 */
Hans Verkuilb3379c62014-02-24 13:51:03 -03001804 if (q->start_streaming_called)
Laurent Pinchart012043b2013-08-09 08:11:26 -03001805 __enqueue_in_driver(vb);
1806
Hans Verkuil41381112013-12-13 13:13:39 -03001807 /* Fill buffer information for the userspace */
1808 __fill_v4l2_buffer(vb, b);
Laurent Pinchart012043b2013-08-09 08:11:26 -03001809
Hans Verkuilb3379c62014-02-24 13:51:03 -03001810 /*
1811 * If streamon has been called, and we haven't yet called
1812 * start_streaming() since not enough buffers were queued, and
1813 * we now have reached the minimum number of queued buffers,
1814 * then we can finally call start_streaming().
1815 */
1816 if (q->streaming && !q->start_streaming_called &&
1817 q->queued_count >= q->min_buffers_needed) {
Hans Verkuil02f142e2013-12-13 13:13:42 -03001818 ret = vb2_start_streaming(q);
1819 if (ret)
1820 return ret;
1821 }
1822
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001823 dprintk(1, "qbuf of buffer %d succeeded\n", vb->v4l2_buf.index);
Hans Verkuil41381112013-12-13 13:13:39 -03001824 return 0;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001825}
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001826
1827/**
1828 * vb2_qbuf() - Queue a buffer from userspace
1829 * @q: videobuf2 queue
1830 * @b: buffer structure passed from userspace to vidioc_qbuf handler
1831 * in driver
1832 *
1833 * Should be called from vidioc_qbuf ioctl handler of a driver.
1834 * This function:
1835 * 1) verifies the passed buffer,
1836 * 2) if necessary, calls buf_prepare callback in the driver (if provided), in
1837 * which driver-specific buffer initialization can be performed,
1838 * 3) if streaming is on, queues the buffer in driver by the means of buf_queue
1839 * callback for processing.
1840 *
1841 * The return values from this function are intended to be directly returned
1842 * from vidioc_qbuf handler in driver.
1843 */
1844int vb2_qbuf(struct vb2_queue *q, struct v4l2_buffer *b)
1845{
Hans Verkuil74753cffa2014-04-07 09:23:50 -03001846 if (vb2_fileio_is_active(q)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03001847 dprintk(1, "file io in progress\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03001848 return -EBUSY;
1849 }
1850
1851 return vb2_internal_qbuf(q, b);
1852}
Pawel Osciake23ccc02010-10-11 10:56:41 -03001853EXPORT_SYMBOL_GPL(vb2_qbuf);
1854
1855/**
1856 * __vb2_wait_for_done_vb() - wait for a buffer to become available
1857 * for dequeuing
1858 *
1859 * Will sleep if required for nonblocking == false.
1860 */
1861static int __vb2_wait_for_done_vb(struct vb2_queue *q, int nonblocking)
1862{
1863 /*
1864 * All operations on vb_done_list are performed under done_lock
1865 * spinlock protection. However, buffers may be removed from
1866 * it and returned to userspace only while holding both driver's
1867 * lock and the done_lock spinlock. Thus we can be sure that as
1868 * long as we hold the driver's lock, the list will remain not
1869 * empty if list_empty() check succeeds.
1870 */
1871
1872 for (;;) {
1873 int ret;
1874
1875 if (!q->streaming) {
Hans Verkuil30500402014-04-07 09:13:22 -03001876 dprintk(1, "streaming off, will not wait for buffers\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03001877 return -EINVAL;
1878 }
1879
1880 if (!list_empty(&q->done_list)) {
1881 /*
1882 * Found a buffer that we were waiting for.
1883 */
1884 break;
1885 }
1886
1887 if (nonblocking) {
Hans Verkuil30500402014-04-07 09:13:22 -03001888 dprintk(1, "nonblocking and no buffers to dequeue, "
Pawel Osciake23ccc02010-10-11 10:56:41 -03001889 "will not wait\n");
1890 return -EAGAIN;
1891 }
1892
1893 /*
1894 * We are streaming and blocking, wait for another buffer to
1895 * become ready or for streamoff. Driver's lock is released to
1896 * allow streamoff or qbuf to be called while waiting.
1897 */
Hans Verkuila1d36d82014-03-17 09:54:21 -03001898 call_void_qop(q, wait_prepare, q);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001899
1900 /*
1901 * All locks have been released, it is safe to sleep now.
1902 */
Hans Verkuil30500402014-04-07 09:13:22 -03001903 dprintk(3, "will sleep waiting for buffers\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03001904 ret = wait_event_interruptible(q->done_wq,
1905 !list_empty(&q->done_list) || !q->streaming);
1906
1907 /*
1908 * We need to reevaluate both conditions again after reacquiring
1909 * the locks or return an error if one occurred.
1910 */
Hans Verkuila1d36d82014-03-17 09:54:21 -03001911 call_void_qop(q, wait_finish, q);
Hans Verkuil32a77262012-09-28 06:12:53 -03001912 if (ret) {
Hans Verkuil30500402014-04-07 09:13:22 -03001913 dprintk(1, "sleep was interrupted\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03001914 return ret;
Hans Verkuil32a77262012-09-28 06:12:53 -03001915 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03001916 }
1917 return 0;
1918}
1919
1920/**
1921 * __vb2_get_done_vb() - get a buffer ready for dequeuing
1922 *
1923 * Will sleep if required for nonblocking == false.
1924 */
1925static int __vb2_get_done_vb(struct vb2_queue *q, struct vb2_buffer **vb,
Hans Verkuil32a77262012-09-28 06:12:53 -03001926 struct v4l2_buffer *b, int nonblocking)
Pawel Osciake23ccc02010-10-11 10:56:41 -03001927{
1928 unsigned long flags;
1929 int ret;
1930
1931 /*
1932 * Wait for at least one buffer to become available on the done_list.
1933 */
1934 ret = __vb2_wait_for_done_vb(q, nonblocking);
1935 if (ret)
1936 return ret;
1937
1938 /*
1939 * Driver's lock has been held since we last verified that done_list
1940 * is not empty, so no need for another list_empty(done_list) check.
1941 */
1942 spin_lock_irqsave(&q->done_lock, flags);
1943 *vb = list_first_entry(&q->done_list, struct vb2_buffer, done_entry);
Hans Verkuil32a77262012-09-28 06:12:53 -03001944 /*
1945 * Only remove the buffer from done_list if v4l2_buffer can handle all
1946 * the planes.
1947 */
1948 ret = __verify_planes_array(*vb, b);
1949 if (!ret)
1950 list_del(&(*vb)->done_entry);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001951 spin_unlock_irqrestore(&q->done_lock, flags);
1952
Hans Verkuil32a77262012-09-28 06:12:53 -03001953 return ret;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001954}
1955
1956/**
1957 * vb2_wait_for_all_buffers() - wait until all buffers are given back to vb2
1958 * @q: videobuf2 queue
1959 *
1960 * This function will wait until all buffers that have been given to the driver
1961 * by buf_queue() are given back to vb2 with vb2_buffer_done(). It doesn't call
1962 * wait_prepare, wait_finish pair. It is intended to be called with all locks
1963 * taken, for example from stop_streaming() callback.
1964 */
1965int vb2_wait_for_all_buffers(struct vb2_queue *q)
1966{
1967 if (!q->streaming) {
Hans Verkuil30500402014-04-07 09:13:22 -03001968 dprintk(1, "streaming off, will not wait for buffers\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03001969 return -EINVAL;
1970 }
1971
Hans Verkuilb3379c62014-02-24 13:51:03 -03001972 if (q->start_streaming_called)
Hans Verkuil6ea3b982014-02-06 05:46:11 -03001973 wait_event(q->done_wq, !atomic_read(&q->owned_by_drv_count));
Pawel Osciake23ccc02010-10-11 10:56:41 -03001974 return 0;
1975}
1976EXPORT_SYMBOL_GPL(vb2_wait_for_all_buffers);
1977
1978/**
Sumit Semwalc5384042012-06-14 10:37:37 -03001979 * __vb2_dqbuf() - bring back the buffer to the DEQUEUED state
1980 */
1981static void __vb2_dqbuf(struct vb2_buffer *vb)
1982{
1983 struct vb2_queue *q = vb->vb2_queue;
1984 unsigned int i;
1985
1986 /* nothing to do if the buffer is already dequeued */
1987 if (vb->state == VB2_BUF_STATE_DEQUEUED)
1988 return;
1989
1990 vb->state = VB2_BUF_STATE_DEQUEUED;
1991
1992 /* unmap DMABUF buffer */
1993 if (q->memory == V4L2_MEMORY_DMABUF)
1994 for (i = 0; i < vb->num_planes; ++i) {
1995 if (!vb->planes[i].dbuf_mapped)
1996 continue;
Hans Verkuila1d36d82014-03-17 09:54:21 -03001997 call_void_memop(vb, unmap_dmabuf, vb->planes[i].mem_priv);
Sumit Semwalc5384042012-06-14 10:37:37 -03001998 vb->planes[i].dbuf_mapped = 0;
1999 }
2000}
2001
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002002static int vb2_internal_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking)
Pawel Osciake23ccc02010-10-11 10:56:41 -03002003{
2004 struct vb2_buffer *vb = NULL;
2005 int ret;
2006
2007 if (b->type != q->type) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002008 dprintk(1, "invalid buffer type\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03002009 return -EINVAL;
2010 }
Hans Verkuil32a77262012-09-28 06:12:53 -03002011 ret = __vb2_get_done_vb(q, &vb, b, nonblocking);
2012 if (ret < 0)
Pawel Osciake23ccc02010-10-11 10:56:41 -03002013 return ret;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002014
Pawel Osciake23ccc02010-10-11 10:56:41 -03002015 switch (vb->state) {
2016 case VB2_BUF_STATE_DONE:
Hans Verkuil30500402014-04-07 09:13:22 -03002017 dprintk(3, "returning done buffer\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03002018 break;
2019 case VB2_BUF_STATE_ERROR:
Hans Verkuil30500402014-04-07 09:13:22 -03002020 dprintk(3, "returning done buffer with errors\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03002021 break;
2022 default:
Hans Verkuil30500402014-04-07 09:13:22 -03002023 dprintk(1, "invalid buffer state\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03002024 return -EINVAL;
2025 }
2026
Hans Verkuila1d36d82014-03-17 09:54:21 -03002027 call_void_vb_qop(vb, buf_finish, vb);
Hans Verkuil9cf3c312014-02-28 13:30:48 -03002028
Pawel Osciake23ccc02010-10-11 10:56:41 -03002029 /* Fill buffer information for the userspace */
2030 __fill_v4l2_buffer(vb, b);
2031 /* Remove from videobuf queue */
2032 list_del(&vb->queued_entry);
Hans Verkuilb3379c62014-02-24 13:51:03 -03002033 q->queued_count--;
Sumit Semwalc5384042012-06-14 10:37:37 -03002034 /* go back to dequeued state */
2035 __vb2_dqbuf(vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002036
2037 dprintk(1, "dqbuf of buffer %d, with state %d\n",
2038 vb->v4l2_buf.index, vb->state);
2039
Pawel Osciake23ccc02010-10-11 10:56:41 -03002040 return 0;
2041}
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002042
2043/**
2044 * vb2_dqbuf() - Dequeue a buffer to the userspace
2045 * @q: videobuf2 queue
2046 * @b: buffer structure passed from userspace to vidioc_dqbuf handler
2047 * in driver
2048 * @nonblocking: if true, this call will not sleep waiting for a buffer if no
2049 * buffers ready for dequeuing are present. Normally the driver
2050 * would be passing (file->f_flags & O_NONBLOCK) here
2051 *
2052 * Should be called from vidioc_dqbuf ioctl handler of a driver.
2053 * This function:
2054 * 1) verifies the passed buffer,
2055 * 2) calls buf_finish callback in the driver (if provided), in which
2056 * driver can perform any additional operations that may be required before
2057 * returning the buffer to userspace, such as cache sync,
2058 * 3) the buffer struct members are filled with relevant information for
2059 * the userspace.
2060 *
2061 * The return values from this function are intended to be directly returned
2062 * from vidioc_dqbuf handler in driver.
2063 */
2064int vb2_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking)
2065{
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002066 if (vb2_fileio_is_active(q)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002067 dprintk(1, "file io in progress\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002068 return -EBUSY;
2069 }
2070 return vb2_internal_dqbuf(q, b, nonblocking);
2071}
Pawel Osciake23ccc02010-10-11 10:56:41 -03002072EXPORT_SYMBOL_GPL(vb2_dqbuf);
2073
2074/**
Pawel Osciake23ccc02010-10-11 10:56:41 -03002075 * __vb2_queue_cancel() - cancel and stop (pause) streaming
2076 *
2077 * Removes all queued buffers from driver's queue and all buffers queued by
2078 * userspace from videobuf's queue. Returns to state after reqbufs.
2079 */
2080static void __vb2_queue_cancel(struct vb2_queue *q)
2081{
2082 unsigned int i;
2083
2084 /*
2085 * Tell driver to stop all transactions and release all queued
2086 * buffers.
2087 */
Hans Verkuilb3379c62014-02-24 13:51:03 -03002088 if (q->start_streaming_called)
Hans Verkuile37559b2014-04-17 02:47:21 -03002089 call_void_qop(q, stop_streaming, q);
Hans Verkuilb3379c62014-02-24 13:51:03 -03002090
2091 if (WARN_ON(atomic_read(&q->owned_by_drv_count))) {
2092 for (i = 0; i < q->num_buffers; ++i)
2093 if (q->bufs[i]->state == VB2_BUF_STATE_ACTIVE)
2094 vb2_buffer_done(q->bufs[i], VB2_BUF_STATE_ERROR);
2095 /* Must be zero now */
2096 WARN_ON(atomic_read(&q->owned_by_drv_count));
2097 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03002098
Laurent Pinchartb646f0b2014-04-20 20:55:41 -03002099 q->streaming = 0;
2100 q->start_streaming_called = 0;
2101 q->queued_count = 0;
2102
Pawel Osciake23ccc02010-10-11 10:56:41 -03002103 /*
2104 * Remove all buffers from videobuf's list...
2105 */
2106 INIT_LIST_HEAD(&q->queued_list);
2107 /*
2108 * ...and done list; userspace will not receive any buffers it
2109 * has not already dequeued before initiating cancel.
2110 */
2111 INIT_LIST_HEAD(&q->done_list);
Hans Verkuil6ea3b982014-02-06 05:46:11 -03002112 atomic_set(&q->owned_by_drv_count, 0);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002113 wake_up_all(&q->done_wq);
2114
2115 /*
2116 * Reinitialize all buffers for next use.
Hans Verkuil9c0863b2014-03-04 07:34:49 -03002117 * Make sure to call buf_finish for any queued buffers. Normally
2118 * that's done in dqbuf, but that's not going to happen when we
2119 * cancel the whole queue. Note: this code belongs here, not in
2120 * __vb2_dqbuf() since in vb2_internal_dqbuf() there is a critical
2121 * call to __fill_v4l2_buffer() after buf_finish(). That order can't
2122 * be changed, so we can't move the buf_finish() to __vb2_dqbuf().
Pawel Osciake23ccc02010-10-11 10:56:41 -03002123 */
Hans Verkuil9c0863b2014-03-04 07:34:49 -03002124 for (i = 0; i < q->num_buffers; ++i) {
2125 struct vb2_buffer *vb = q->bufs[i];
2126
2127 if (vb->state != VB2_BUF_STATE_DEQUEUED) {
2128 vb->state = VB2_BUF_STATE_PREPARED;
Hans Verkuila1d36d82014-03-17 09:54:21 -03002129 call_void_vb_qop(vb, buf_finish, vb);
Hans Verkuil9c0863b2014-03-04 07:34:49 -03002130 }
2131 __vb2_dqbuf(vb);
2132 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03002133}
2134
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002135static int vb2_internal_streamon(struct vb2_queue *q, enum v4l2_buf_type type)
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002136{
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002137 int ret;
2138
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002139 if (type != q->type) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002140 dprintk(1, "invalid stream type\n");
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002141 return -EINVAL;
2142 }
2143
2144 if (q->streaming) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002145 dprintk(3, "already streaming\n");
Ricardo Ribaldaf9560352013-11-08 07:08:45 -03002146 return 0;
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002147 }
2148
Ricardo Ribalda548df782014-01-08 05:01:33 -03002149 if (!q->num_buffers) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002150 dprintk(1, "no buffers have been allocated\n");
Ricardo Ribalda548df782014-01-08 05:01:33 -03002151 return -EINVAL;
2152 }
2153
Ricardo Ribalda Delgado249f5a52014-01-08 05:01:33 -03002154 if (!q->num_buffers) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002155 dprintk(1, "no buffers have been allocated\n");
Ricardo Ribalda Delgado249f5a52014-01-08 05:01:33 -03002156 return -EINVAL;
2157 }
Hans Verkuilb3379c62014-02-24 13:51:03 -03002158 if (q->num_buffers < q->min_buffers_needed) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002159 dprintk(1, "need at least %u allocated buffers\n",
Hans Verkuilb3379c62014-02-24 13:51:03 -03002160 q->min_buffers_needed);
2161 return -EINVAL;
2162 }
Ricardo Ribalda Delgado249f5a52014-01-08 05:01:33 -03002163
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002164 /*
Hans Verkuilb3379c62014-02-24 13:51:03 -03002165 * Tell driver to start streaming provided sufficient buffers
2166 * are available.
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002167 */
Hans Verkuilb3379c62014-02-24 13:51:03 -03002168 if (q->queued_count >= q->min_buffers_needed) {
2169 ret = vb2_start_streaming(q);
2170 if (ret) {
2171 __vb2_queue_cancel(q);
2172 return ret;
2173 }
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002174 }
2175
2176 q->streaming = 1;
2177
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002178 dprintk(3, "successful\n");
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002179 return 0;
2180}
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002181
2182/**
2183 * vb2_streamon - start streaming
2184 * @q: videobuf2 queue
2185 * @type: type argument passed from userspace to vidioc_streamon handler
2186 *
2187 * Should be called from vidioc_streamon handler of a driver.
2188 * This function:
2189 * 1) verifies current state
2190 * 2) passes any previously queued buffers to the driver and starts streaming
2191 *
2192 * The return values from this function are intended to be directly returned
2193 * from vidioc_streamon handler in the driver.
2194 */
2195int vb2_streamon(struct vb2_queue *q, enum v4l2_buf_type type)
2196{
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002197 if (vb2_fileio_is_active(q)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002198 dprintk(1, "file io in progress\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002199 return -EBUSY;
2200 }
2201 return vb2_internal_streamon(q, type);
2202}
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002203EXPORT_SYMBOL_GPL(vb2_streamon);
2204
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002205static int vb2_internal_streamoff(struct vb2_queue *q, enum v4l2_buf_type type)
2206{
2207 if (type != q->type) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002208 dprintk(1, "invalid stream type\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002209 return -EINVAL;
2210 }
2211
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002212 /*
2213 * Cancel will pause streaming and remove all buffers from the driver
2214 * and videobuf, effectively returning control over them to userspace.
Hans Verkuil3f1a9a32014-02-25 09:42:45 -03002215 *
2216 * Note that we do this even if q->streaming == 0: if you prepare or
2217 * queue buffers, and then call streamoff without ever having called
2218 * streamon, you would still expect those buffers to be returned to
2219 * their normal dequeued state.
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002220 */
2221 __vb2_queue_cancel(q);
2222
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002223 dprintk(3, "successful\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002224 return 0;
2225}
Marek Szyprowskibd323e22011-08-29 08:51:49 -03002226
2227/**
Pawel Osciake23ccc02010-10-11 10:56:41 -03002228 * vb2_streamoff - stop streaming
2229 * @q: videobuf2 queue
2230 * @type: type argument passed from userspace to vidioc_streamoff handler
2231 *
2232 * Should be called from vidioc_streamoff handler of a driver.
2233 * This function:
2234 * 1) verifies current state,
2235 * 2) stop streaming and dequeues any queued buffers, including those previously
2236 * passed to the driver (after waiting for the driver to finish).
2237 *
2238 * This call can be used for pausing playback.
2239 * The return values from this function are intended to be directly returned
2240 * from vidioc_streamoff handler in the driver
2241 */
2242int vb2_streamoff(struct vb2_queue *q, enum v4l2_buf_type type)
2243{
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002244 if (vb2_fileio_is_active(q)) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002245 dprintk(1, "file io in progress\n");
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002246 return -EBUSY;
2247 }
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002248 return vb2_internal_streamoff(q, type);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002249}
2250EXPORT_SYMBOL_GPL(vb2_streamoff);
2251
2252/**
2253 * __find_plane_by_offset() - find plane associated with the given offset off
2254 */
2255static int __find_plane_by_offset(struct vb2_queue *q, unsigned long off,
2256 unsigned int *_buffer, unsigned int *_plane)
2257{
2258 struct vb2_buffer *vb;
2259 unsigned int buffer, plane;
2260
2261 /*
2262 * Go over all buffers and their planes, comparing the given offset
2263 * with an offset assigned to each plane. If a match is found,
2264 * return its buffer and plane numbers.
2265 */
2266 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
2267 vb = q->bufs[buffer];
2268
2269 for (plane = 0; plane < vb->num_planes; ++plane) {
2270 if (vb->v4l2_planes[plane].m.mem_offset == off) {
2271 *_buffer = buffer;
2272 *_plane = plane;
2273 return 0;
2274 }
2275 }
2276 }
2277
2278 return -EINVAL;
2279}
2280
2281/**
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002282 * vb2_expbuf() - Export a buffer as a file descriptor
2283 * @q: videobuf2 queue
2284 * @eb: export buffer structure passed from userspace to vidioc_expbuf
2285 * handler in driver
2286 *
2287 * The return values from this function are intended to be directly returned
2288 * from vidioc_expbuf handler in driver.
2289 */
2290int vb2_expbuf(struct vb2_queue *q, struct v4l2_exportbuffer *eb)
2291{
2292 struct vb2_buffer *vb = NULL;
2293 struct vb2_plane *vb_plane;
2294 int ret;
2295 struct dma_buf *dbuf;
2296
2297 if (q->memory != V4L2_MEMORY_MMAP) {
Hans Verkuil30500402014-04-07 09:13:22 -03002298 dprintk(1, "queue is not currently set up for mmap\n");
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002299 return -EINVAL;
2300 }
2301
2302 if (!q->mem_ops->get_dmabuf) {
Hans Verkuil30500402014-04-07 09:13:22 -03002303 dprintk(1, "queue does not support DMA buffer exporting\n");
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002304 return -EINVAL;
2305 }
2306
Philipp Zabelea3aba82013-05-21 05:11:35 -03002307 if (eb->flags & ~(O_CLOEXEC | O_ACCMODE)) {
Hans Verkuil30500402014-04-07 09:13:22 -03002308 dprintk(1, "queue does support only O_CLOEXEC and access mode flags\n");
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002309 return -EINVAL;
2310 }
2311
2312 if (eb->type != q->type) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002313 dprintk(1, "invalid buffer type\n");
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002314 return -EINVAL;
2315 }
2316
2317 if (eb->index >= q->num_buffers) {
2318 dprintk(1, "buffer index out of range\n");
2319 return -EINVAL;
2320 }
2321
2322 vb = q->bufs[eb->index];
2323
2324 if (eb->plane >= vb->num_planes) {
2325 dprintk(1, "buffer plane out of range\n");
2326 return -EINVAL;
2327 }
2328
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002329 if (vb2_fileio_is_active(q)) {
2330 dprintk(1, "expbuf: file io in progress\n");
2331 return -EBUSY;
2332 }
2333
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002334 vb_plane = &vb->planes[eb->plane];
2335
Hans Verkuila1d36d82014-03-17 09:54:21 -03002336 dbuf = call_ptr_memop(vb, get_dmabuf, vb_plane->mem_priv, eb->flags & O_ACCMODE);
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002337 if (IS_ERR_OR_NULL(dbuf)) {
Hans Verkuil30500402014-04-07 09:13:22 -03002338 dprintk(1, "failed to export buffer %d, plane %d\n",
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002339 eb->index, eb->plane);
2340 return -EINVAL;
2341 }
2342
Philipp Zabelea3aba82013-05-21 05:11:35 -03002343 ret = dma_buf_fd(dbuf, eb->flags & ~O_ACCMODE);
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03002344 if (ret < 0) {
2345 dprintk(3, "buffer %d, plane %d failed to export (%d)\n",
2346 eb->index, eb->plane, ret);
2347 dma_buf_put(dbuf);
2348 return ret;
2349 }
2350
2351 dprintk(3, "buffer %d, plane %d exported as %d descriptor\n",
2352 eb->index, eb->plane, ret);
2353 eb->fd = ret;
2354
2355 return 0;
2356}
2357EXPORT_SYMBOL_GPL(vb2_expbuf);
2358
2359/**
Pawel Osciake23ccc02010-10-11 10:56:41 -03002360 * vb2_mmap() - map video buffers into application address space
2361 * @q: videobuf2 queue
2362 * @vma: vma passed to the mmap file operation handler in the driver
2363 *
2364 * Should be called from mmap file operation handler of a driver.
2365 * This function maps one plane of one of the available video buffers to
2366 * userspace. To map whole video memory allocated on reqbufs, this function
2367 * has to be called once per each plane per each buffer previously allocated.
2368 *
2369 * When the userspace application calls mmap, it passes to it an offset returned
2370 * to it earlier by the means of vidioc_querybuf handler. That offset acts as
2371 * a "cookie", which is then used to identify the plane to be mapped.
2372 * This function finds a plane with a matching offset and a mapping is performed
2373 * by the means of a provided memory operation.
2374 *
2375 * The return values from this function are intended to be directly returned
2376 * from the mmap handler in driver.
2377 */
2378int vb2_mmap(struct vb2_queue *q, struct vm_area_struct *vma)
2379{
2380 unsigned long off = vma->vm_pgoff << PAGE_SHIFT;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002381 struct vb2_buffer *vb;
Hans Verkuilce9c2242014-04-17 03:17:08 -03002382 unsigned int buffer = 0, plane = 0;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002383 int ret;
Mauro Carvalho Chehab7f841452013-04-19 07:18:01 -03002384 unsigned long length;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002385
2386 if (q->memory != V4L2_MEMORY_MMAP) {
Hans Verkuil30500402014-04-07 09:13:22 -03002387 dprintk(1, "queue is not currently set up for mmap\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03002388 return -EINVAL;
2389 }
2390
2391 /*
2392 * Check memory area access mode.
2393 */
2394 if (!(vma->vm_flags & VM_SHARED)) {
Hans Verkuil30500402014-04-07 09:13:22 -03002395 dprintk(1, "invalid vma flags, VM_SHARED needed\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03002396 return -EINVAL;
2397 }
2398 if (V4L2_TYPE_IS_OUTPUT(q->type)) {
2399 if (!(vma->vm_flags & VM_WRITE)) {
Hans Verkuil30500402014-04-07 09:13:22 -03002400 dprintk(1, "invalid vma flags, VM_WRITE needed\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03002401 return -EINVAL;
2402 }
2403 } else {
2404 if (!(vma->vm_flags & VM_READ)) {
Hans Verkuil30500402014-04-07 09:13:22 -03002405 dprintk(1, "invalid vma flags, VM_READ needed\n");
Pawel Osciake23ccc02010-10-11 10:56:41 -03002406 return -EINVAL;
2407 }
2408 }
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002409 if (vb2_fileio_is_active(q)) {
2410 dprintk(1, "mmap: file io in progress\n");
2411 return -EBUSY;
2412 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03002413
2414 /*
2415 * Find the plane corresponding to the offset passed by userspace.
2416 */
2417 ret = __find_plane_by_offset(q, off, &buffer, &plane);
2418 if (ret)
2419 return ret;
2420
2421 vb = q->bufs[buffer];
Pawel Osciake23ccc02010-10-11 10:56:41 -03002422
Mauro Carvalho Chehab7f841452013-04-19 07:18:01 -03002423 /*
2424 * MMAP requires page_aligned buffers.
2425 * The buffer length was page_aligned at __vb2_buf_mem_alloc(),
2426 * so, we need to do the same here.
2427 */
2428 length = PAGE_ALIGN(vb->v4l2_planes[plane].length);
2429 if (length < (vma->vm_end - vma->vm_start)) {
2430 dprintk(1,
2431 "MMAP invalid, as it would overflow buffer length\n");
Seung-Woo Kim068a0df2013-04-11 23:57:57 -03002432 return -EINVAL;
2433 }
2434
Hans Verkuilb5b45412014-01-29 11:53:25 -03002435 ret = call_memop(vb, mmap, vb->planes[plane].mem_priv, vma);
Hans Verkuila1d36d82014-03-17 09:54:21 -03002436 if (ret)
Pawel Osciake23ccc02010-10-11 10:56:41 -03002437 return ret;
2438
Hans Verkuil30500402014-04-07 09:13:22 -03002439 dprintk(3, "buffer %d, plane %d successfully mapped\n", buffer, plane);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002440 return 0;
2441}
2442EXPORT_SYMBOL_GPL(vb2_mmap);
2443
Scott Jiang6f524ec2011-09-21 09:25:23 -03002444#ifndef CONFIG_MMU
2445unsigned long vb2_get_unmapped_area(struct vb2_queue *q,
2446 unsigned long addr,
2447 unsigned long len,
2448 unsigned long pgoff,
2449 unsigned long flags)
2450{
2451 unsigned long off = pgoff << PAGE_SHIFT;
2452 struct vb2_buffer *vb;
2453 unsigned int buffer, plane;
2454 int ret;
2455
2456 if (q->memory != V4L2_MEMORY_MMAP) {
Hans Verkuil30500402014-04-07 09:13:22 -03002457 dprintk(1, "queue is not currently set up for mmap\n");
Scott Jiang6f524ec2011-09-21 09:25:23 -03002458 return -EINVAL;
2459 }
2460
2461 /*
2462 * Find the plane corresponding to the offset passed by userspace.
2463 */
2464 ret = __find_plane_by_offset(q, off, &buffer, &plane);
2465 if (ret)
2466 return ret;
2467
2468 vb = q->bufs[buffer];
2469
2470 return (unsigned long)vb2_plane_vaddr(vb, plane);
2471}
2472EXPORT_SYMBOL_GPL(vb2_get_unmapped_area);
2473#endif
2474
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002475static int __vb2_init_fileio(struct vb2_queue *q, int read);
2476static int __vb2_cleanup_fileio(struct vb2_queue *q);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002477
2478/**
2479 * vb2_poll() - implements poll userspace operation
2480 * @q: videobuf2 queue
2481 * @file: file argument passed to the poll file operation handler
2482 * @wait: wait argument passed to the poll file operation handler
2483 *
2484 * This function implements poll file operation handler for a driver.
2485 * For CAPTURE queues, if a buffer is ready to be dequeued, the userspace will
2486 * be informed that the file descriptor of a video device is available for
2487 * reading.
2488 * For OUTPUT queues, if a buffer is ready to be dequeued, the file descriptor
2489 * will be reported as available for writing.
2490 *
Hans Verkuil95213ce2011-07-13 04:26:52 -03002491 * If the driver uses struct v4l2_fh, then vb2_poll() will also check for any
2492 * pending events.
2493 *
Pawel Osciake23ccc02010-10-11 10:56:41 -03002494 * The return values from this function are intended to be directly returned
2495 * from poll handler in driver.
2496 */
2497unsigned int vb2_poll(struct vb2_queue *q, struct file *file, poll_table *wait)
2498{
Hans Verkuil95213ce2011-07-13 04:26:52 -03002499 struct video_device *vfd = video_devdata(file);
Hans Verkuilbf5c7cb2011-07-13 04:01:30 -03002500 unsigned long req_events = poll_requested_events(wait);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002501 struct vb2_buffer *vb = NULL;
Hans Verkuil95213ce2011-07-13 04:26:52 -03002502 unsigned int res = 0;
2503 unsigned long flags;
2504
2505 if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags)) {
2506 struct v4l2_fh *fh = file->private_data;
2507
2508 if (v4l2_event_pending(fh))
2509 res = POLLPRI;
2510 else if (req_events & POLLPRI)
2511 poll_wait(file, &fh->wait, wait);
2512 }
Pawel Osciake23ccc02010-10-11 10:56:41 -03002513
Hans Verkuilcd138232013-01-30 13:29:02 -03002514 if (!V4L2_TYPE_IS_OUTPUT(q->type) && !(req_events & (POLLIN | POLLRDNORM)))
2515 return res;
2516 if (V4L2_TYPE_IS_OUTPUT(q->type) && !(req_events & (POLLOUT | POLLWRNORM)))
2517 return res;
2518
Pawel Osciake23ccc02010-10-11 10:56:41 -03002519 /*
Pawel Osciak4ffabdb2011-03-20 18:17:34 -03002520 * Start file I/O emulator only if streaming API has not been used yet.
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002521 */
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002522 if (q->num_buffers == 0 && !vb2_fileio_is_active(q)) {
Hans Verkuilbf5c7cb2011-07-13 04:01:30 -03002523 if (!V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_READ) &&
2524 (req_events & (POLLIN | POLLRDNORM))) {
Hans Verkuil95213ce2011-07-13 04:26:52 -03002525 if (__vb2_init_fileio(q, 1))
2526 return res | POLLERR;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002527 }
Hans Verkuilbf5c7cb2011-07-13 04:01:30 -03002528 if (V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_WRITE) &&
2529 (req_events & (POLLOUT | POLLWRNORM))) {
Hans Verkuil95213ce2011-07-13 04:26:52 -03002530 if (__vb2_init_fileio(q, 0))
2531 return res | POLLERR;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002532 /*
2533 * Write to OUTPUT queue can be done immediately.
2534 */
Hans Verkuil95213ce2011-07-13 04:26:52 -03002535 return res | POLLOUT | POLLWRNORM;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002536 }
2537 }
2538
2539 /*
Pawel Osciake23ccc02010-10-11 10:56:41 -03002540 * There is nothing to wait for if no buffers have already been queued.
2541 */
2542 if (list_empty(&q->queued_list))
Hans Verkuil95213ce2011-07-13 04:26:52 -03002543 return res | POLLERR;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002544
Seung-Woo Kim412cb872013-05-20 23:47:29 -03002545 if (list_empty(&q->done_list))
2546 poll_wait(file, &q->done_wq, wait);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002547
2548 /*
2549 * Take first buffer available for dequeuing.
2550 */
2551 spin_lock_irqsave(&q->done_lock, flags);
2552 if (!list_empty(&q->done_list))
2553 vb = list_first_entry(&q->done_list, struct vb2_buffer,
2554 done_entry);
2555 spin_unlock_irqrestore(&q->done_lock, flags);
2556
2557 if (vb && (vb->state == VB2_BUF_STATE_DONE
2558 || vb->state == VB2_BUF_STATE_ERROR)) {
Hans Verkuil95213ce2011-07-13 04:26:52 -03002559 return (V4L2_TYPE_IS_OUTPUT(q->type)) ?
2560 res | POLLOUT | POLLWRNORM :
2561 res | POLLIN | POLLRDNORM;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002562 }
Hans Verkuil95213ce2011-07-13 04:26:52 -03002563 return res;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002564}
2565EXPORT_SYMBOL_GPL(vb2_poll);
2566
2567/**
2568 * vb2_queue_init() - initialize a videobuf2 queue
2569 * @q: videobuf2 queue; this structure should be allocated in driver
2570 *
2571 * The vb2_queue structure should be allocated by the driver. The driver is
2572 * responsible of clearing it's content and setting initial values for some
2573 * required entries before calling this function.
2574 * q->ops, q->mem_ops, q->type and q->io_modes are mandatory. Please refer
2575 * to the struct vb2_queue description in include/media/videobuf2-core.h
2576 * for more information.
2577 */
2578int vb2_queue_init(struct vb2_queue *q)
2579{
Ezequiel Garcia896f38f2012-09-17 14:59:30 -03002580 /*
2581 * Sanity check
2582 */
2583 if (WARN_ON(!q) ||
2584 WARN_ON(!q->ops) ||
2585 WARN_ON(!q->mem_ops) ||
2586 WARN_ON(!q->type) ||
2587 WARN_ON(!q->io_modes) ||
2588 WARN_ON(!q->ops->queue_setup) ||
Kamil Debski6aa69f92013-01-25 06:29:57 -03002589 WARN_ON(!q->ops->buf_queue) ||
Sakari Ailus872484c2013-08-25 17:57:03 -03002590 WARN_ON(q->timestamp_flags &
2591 ~(V4L2_BUF_FLAG_TIMESTAMP_MASK |
2592 V4L2_BUF_FLAG_TSTAMP_SRC_MASK)))
Ezequiel Garcia896f38f2012-09-17 14:59:30 -03002593 return -EINVAL;
Pawel Osciake23ccc02010-10-11 10:56:41 -03002594
Kamil Debski6aa69f92013-01-25 06:29:57 -03002595 /* Warn that the driver should choose an appropriate timestamp type */
Sakari Ailusc57ff792014-03-01 10:28:02 -03002596 WARN_ON((q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
2597 V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN);
Kamil Debski6aa69f92013-01-25 06:29:57 -03002598
Pawel Osciake23ccc02010-10-11 10:56:41 -03002599 INIT_LIST_HEAD(&q->queued_list);
2600 INIT_LIST_HEAD(&q->done_list);
2601 spin_lock_init(&q->done_lock);
2602 init_waitqueue_head(&q->done_wq);
2603
2604 if (q->buf_struct_size == 0)
2605 q->buf_struct_size = sizeof(struct vb2_buffer);
2606
2607 return 0;
2608}
2609EXPORT_SYMBOL_GPL(vb2_queue_init);
2610
2611/**
2612 * vb2_queue_release() - stop streaming, release the queue and free memory
2613 * @q: videobuf2 queue
2614 *
2615 * This function stops streaming and performs necessary clean ups, including
2616 * freeing video buffer memory. The driver is responsible for freeing
2617 * the vb2_queue structure itself.
2618 */
2619void vb2_queue_release(struct vb2_queue *q)
2620{
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002621 __vb2_cleanup_fileio(q);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002622 __vb2_queue_cancel(q);
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -03002623 __vb2_queue_free(q, q->num_buffers);
Pawel Osciake23ccc02010-10-11 10:56:41 -03002624}
2625EXPORT_SYMBOL_GPL(vb2_queue_release);
2626
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002627/**
2628 * struct vb2_fileio_buf - buffer context used by file io emulator
2629 *
2630 * vb2 provides a compatibility layer and emulator of file io (read and
2631 * write) calls on top of streaming API. This structure is used for
2632 * tracking context related to the buffers.
2633 */
2634struct vb2_fileio_buf {
2635 void *vaddr;
2636 unsigned int size;
2637 unsigned int pos;
2638 unsigned int queued:1;
2639};
2640
2641/**
2642 * struct vb2_fileio_data - queue context used by file io emulator
2643 *
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002644 * @cur_index: the index of the buffer currently being read from or
2645 * written to. If equal to q->num_buffers then a new buffer
2646 * must be dequeued.
2647 * @initial_index: in the read() case all buffers are queued up immediately
2648 * in __vb2_init_fileio() and __vb2_perform_fileio() just cycles
2649 * buffers. However, in the write() case no buffers are initially
2650 * queued, instead whenever a buffer is full it is queued up by
2651 * __vb2_perform_fileio(). Only once all available buffers have
2652 * been queued up will __vb2_perform_fileio() start to dequeue
2653 * buffers. This means that initially __vb2_perform_fileio()
2654 * needs to know what buffer index to use when it is queuing up
2655 * the buffers for the first time. That initial index is stored
2656 * in this field. Once it is equal to q->num_buffers all
2657 * available buffers have been queued and __vb2_perform_fileio()
2658 * should start the normal dequeue/queue cycle.
2659 *
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002660 * vb2 provides a compatibility layer and emulator of file io (read and
2661 * write) calls on top of streaming API. For proper operation it required
2662 * this structure to save the driver state between each call of the read
2663 * or write function.
2664 */
2665struct vb2_fileio_data {
2666 struct v4l2_requestbuffers req;
Hans Verkuil7bb6edd2014-04-11 04:40:03 -03002667 struct v4l2_plane p;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002668 struct v4l2_buffer b;
2669 struct vb2_fileio_buf bufs[VIDEO_MAX_FRAME];
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002670 unsigned int cur_index;
2671 unsigned int initial_index;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002672 unsigned int q_count;
2673 unsigned int dq_count;
2674 unsigned int flags;
2675};
2676
2677/**
2678 * __vb2_init_fileio() - initialize file io emulator
2679 * @q: videobuf2 queue
2680 * @read: mode selector (1 means read, 0 means write)
2681 */
2682static int __vb2_init_fileio(struct vb2_queue *q, int read)
2683{
2684 struct vb2_fileio_data *fileio;
2685 int i, ret;
2686 unsigned int count = 0;
2687
2688 /*
2689 * Sanity check
2690 */
Hans Verkuile4d25812014-02-03 11:22:45 -03002691 if (WARN_ON((read && !(q->io_modes & VB2_READ)) ||
2692 (!read && !(q->io_modes & VB2_WRITE))))
2693 return -EINVAL;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002694
2695 /*
2696 * Check if device supports mapping buffers to kernel virtual space.
2697 */
2698 if (!q->mem_ops->vaddr)
2699 return -EBUSY;
2700
2701 /*
2702 * Check if streaming api has not been already activated.
2703 */
2704 if (q->streaming || q->num_buffers > 0)
2705 return -EBUSY;
2706
2707 /*
2708 * Start with count 1, driver can increase it in queue_setup()
2709 */
2710 count = 1;
2711
2712 dprintk(3, "setting up file io: mode %s, count %d, flags %08x\n",
2713 (read) ? "read" : "write", count, q->io_flags);
2714
2715 fileio = kzalloc(sizeof(struct vb2_fileio_data), GFP_KERNEL);
2716 if (fileio == NULL)
2717 return -ENOMEM;
2718
2719 fileio->flags = q->io_flags;
2720
2721 /*
2722 * Request buffers and use MMAP type to force driver
2723 * to allocate buffers by itself.
2724 */
2725 fileio->req.count = count;
2726 fileio->req.memory = V4L2_MEMORY_MMAP;
2727 fileio->req.type = q->type;
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002728 q->fileio = fileio;
2729 ret = __reqbufs(q, &fileio->req);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002730 if (ret)
2731 goto err_kfree;
2732
2733 /*
2734 * Check if plane_count is correct
2735 * (multiplane buffers are not supported).
2736 */
2737 if (q->bufs[0]->num_planes != 1) {
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002738 ret = -EBUSY;
2739 goto err_reqbufs;
2740 }
2741
2742 /*
2743 * Get kernel address of each buffer.
2744 */
2745 for (i = 0; i < q->num_buffers; i++) {
2746 fileio->bufs[i].vaddr = vb2_plane_vaddr(q->bufs[i], 0);
Wei Yongjun5dd69462013-05-13 01:48:45 -03002747 if (fileio->bufs[i].vaddr == NULL) {
2748 ret = -EINVAL;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002749 goto err_reqbufs;
Wei Yongjun5dd69462013-05-13 01:48:45 -03002750 }
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002751 fileio->bufs[i].size = vb2_plane_size(q->bufs[i], 0);
2752 }
2753
2754 /*
2755 * Read mode requires pre queuing of all buffers.
2756 */
2757 if (read) {
Hans Verkuil7bb6edd2014-04-11 04:40:03 -03002758 bool is_multiplanar = V4L2_TYPE_IS_MULTIPLANAR(q->type);
2759
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002760 /*
2761 * Queue all buffers.
2762 */
2763 for (i = 0; i < q->num_buffers; i++) {
2764 struct v4l2_buffer *b = &fileio->b;
Hans Verkuil7bb6edd2014-04-11 04:40:03 -03002765
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002766 memset(b, 0, sizeof(*b));
2767 b->type = q->type;
Hans Verkuil7bb6edd2014-04-11 04:40:03 -03002768 if (is_multiplanar) {
2769 memset(&fileio->p, 0, sizeof(fileio->p));
2770 b->m.planes = &fileio->p;
2771 b->length = 1;
2772 }
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002773 b->memory = q->memory;
2774 b->index = i;
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002775 ret = vb2_internal_qbuf(q, b);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002776 if (ret)
2777 goto err_reqbufs;
2778 fileio->bufs[i].queued = 1;
2779 }
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002780 /*
2781 * All buffers have been queued, so mark that by setting
2782 * initial_index to q->num_buffers
2783 */
2784 fileio->initial_index = q->num_buffers;
2785 fileio->cur_index = q->num_buffers;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002786 }
2787
Hans Verkuil02f142e2013-12-13 13:13:42 -03002788 /*
2789 * Start streaming.
2790 */
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002791 ret = vb2_internal_streamon(q, q->type);
Hans Verkuil02f142e2013-12-13 13:13:42 -03002792 if (ret)
2793 goto err_reqbufs;
2794
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002795 return ret;
2796
2797err_reqbufs:
Hans de Goedea67e1722012-05-08 14:47:39 -03002798 fileio->req.count = 0;
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002799 __reqbufs(q, &fileio->req);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002800
2801err_kfree:
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002802 q->fileio = NULL;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002803 kfree(fileio);
2804 return ret;
2805}
2806
2807/**
2808 * __vb2_cleanup_fileio() - free resourced used by file io emulator
2809 * @q: videobuf2 queue
2810 */
2811static int __vb2_cleanup_fileio(struct vb2_queue *q)
2812{
2813 struct vb2_fileio_data *fileio = q->fileio;
2814
2815 if (fileio) {
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002816 vb2_internal_streamoff(q, q->type);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002817 q->fileio = NULL;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002818 fileio->req.count = 0;
2819 vb2_reqbufs(q, &fileio->req);
2820 kfree(fileio);
2821 dprintk(3, "file io emulator closed\n");
2822 }
2823 return 0;
2824}
2825
2826/**
2827 * __vb2_perform_fileio() - perform a single file io (read or write) operation
2828 * @q: videobuf2 queue
2829 * @data: pointed to target userspace buffer
2830 * @count: number of bytes to read or write
2831 * @ppos: file handle position tracking pointer
2832 * @nonblock: mode selector (1 means blocking calls, 0 means nonblocking)
2833 * @read: access mode selector (1 means read, 0 means write)
2834 */
2835static size_t __vb2_perform_fileio(struct vb2_queue *q, char __user *data, size_t count,
2836 loff_t *ppos, int nonblock, int read)
2837{
2838 struct vb2_fileio_data *fileio;
2839 struct vb2_fileio_buf *buf;
Hans Verkuil7bb6edd2014-04-11 04:40:03 -03002840 bool is_multiplanar = V4L2_TYPE_IS_MULTIPLANAR(q->type);
Hans Verkuilebd7c502014-04-11 04:36:57 -03002841 /*
2842 * When using write() to write data to an output video node the vb2 core
2843 * should set timestamps if V4L2_BUF_FLAG_TIMESTAMP_COPY is set. Nobody
2844 * else is able to provide this information with the write() operation.
2845 */
2846 bool set_timestamp = !read &&
2847 (q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
2848 V4L2_BUF_FLAG_TIMESTAMP_COPY;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002849 int ret, index;
2850
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002851 dprintk(3, "mode %s, offset %ld, count %zd, %sblocking\n",
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002852 read ? "read" : "write", (long)*ppos, count,
2853 nonblock ? "non" : "");
2854
2855 if (!data)
2856 return -EINVAL;
2857
2858 /*
2859 * Initialize emulator on first call.
2860 */
Hans Verkuil74753cffa2014-04-07 09:23:50 -03002861 if (!vb2_fileio_is_active(q)) {
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002862 ret = __vb2_init_fileio(q, read);
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002863 dprintk(3, "vb2_init_fileio result: %d\n", ret);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002864 if (ret)
2865 return ret;
2866 }
2867 fileio = q->fileio;
2868
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002869 /*
2870 * Check if we need to dequeue the buffer.
2871 */
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002872 index = fileio->cur_index;
Hans Verkuil88e26872013-12-13 13:13:45 -03002873 if (index >= q->num_buffers) {
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002874 /*
2875 * Call vb2_dqbuf to get buffer back.
2876 */
2877 memset(&fileio->b, 0, sizeof(fileio->b));
2878 fileio->b.type = q->type;
2879 fileio->b.memory = q->memory;
Hans Verkuil7bb6edd2014-04-11 04:40:03 -03002880 if (is_multiplanar) {
2881 memset(&fileio->p, 0, sizeof(fileio->p));
2882 fileio->b.m.planes = &fileio->p;
2883 fileio->b.length = 1;
2884 }
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002885 ret = vb2_internal_dqbuf(q, &fileio->b, nonblock);
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002886 dprintk(5, "vb2_dqbuf result: %d\n", ret);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002887 if (ret)
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002888 return ret;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002889 fileio->dq_count += 1;
2890
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002891 fileio->cur_index = index = fileio->b.index;
Hans Verkuil88e26872013-12-13 13:13:45 -03002892 buf = &fileio->bufs[index];
2893
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002894 /*
2895 * Get number of bytes filled by the driver
2896 */
Hans Verkuil88e26872013-12-13 13:13:45 -03002897 buf->pos = 0;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002898 buf->queued = 0;
Hans Verkuil88e26872013-12-13 13:13:45 -03002899 buf->size = read ? vb2_get_plane_payload(q->bufs[index], 0)
2900 : vb2_plane_size(q->bufs[index], 0);
2901 } else {
2902 buf = &fileio->bufs[index];
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002903 }
2904
2905 /*
2906 * Limit count on last few bytes of the buffer.
2907 */
2908 if (buf->pos + count > buf->size) {
2909 count = buf->size - buf->pos;
Mauro Carvalho Chehab08b99e22011-01-11 17:12:34 -03002910 dprintk(5, "reducing read count: %zd\n", count);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002911 }
2912
2913 /*
2914 * Transfer data to userspace.
2915 */
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002916 dprintk(3, "copying %zd bytes - buffer %d, offset %u\n",
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002917 count, index, buf->pos);
2918 if (read)
2919 ret = copy_to_user(data, buf->vaddr + buf->pos, count);
2920 else
2921 ret = copy_from_user(buf->vaddr + buf->pos, data, count);
2922 if (ret) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002923 dprintk(3, "error copying data\n");
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002924 return -EFAULT;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002925 }
2926
2927 /*
2928 * Update counters.
2929 */
2930 buf->pos += count;
2931 *ppos += count;
2932
2933 /*
2934 * Queue next buffer if required.
2935 */
2936 if (buf->pos == buf->size ||
2937 (!read && (fileio->flags & VB2_FILEIO_WRITE_IMMEDIATELY))) {
2938 /*
2939 * Check if this is the last buffer to read.
2940 */
2941 if (read && (fileio->flags & VB2_FILEIO_READ_ONCE) &&
2942 fileio->dq_count == 1) {
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002943 dprintk(3, "read limit reached\n");
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002944 return __vb2_cleanup_fileio(q);
2945 }
2946
2947 /*
2948 * Call vb2_qbuf and give buffer to the driver.
2949 */
2950 memset(&fileio->b, 0, sizeof(fileio->b));
2951 fileio->b.type = q->type;
2952 fileio->b.memory = q->memory;
2953 fileio->b.index = index;
2954 fileio->b.bytesused = buf->pos;
Hans Verkuil7bb6edd2014-04-11 04:40:03 -03002955 if (is_multiplanar) {
2956 memset(&fileio->p, 0, sizeof(fileio->p));
2957 fileio->p.bytesused = buf->pos;
2958 fileio->b.m.planes = &fileio->p;
2959 fileio->b.length = 1;
2960 }
Hans Verkuilebd7c502014-04-11 04:36:57 -03002961 if (set_timestamp)
2962 v4l2_get_timestamp(&fileio->b.timestamp);
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002963 ret = vb2_internal_qbuf(q, &fileio->b);
Hans Verkuilfd4354c2014-04-07 09:08:47 -03002964 dprintk(5, "vb2_dbuf result: %d\n", ret);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002965 if (ret)
Hans Verkuilb2f2f042013-12-13 13:13:41 -03002966 return ret;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002967
2968 /*
2969 * Buffer has been queued, update the status
2970 */
2971 buf->pos = 0;
2972 buf->queued = 1;
Hans Verkuil88e26872013-12-13 13:13:45 -03002973 buf->size = vb2_plane_size(q->bufs[index], 0);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002974 fileio->q_count += 1;
Hans Verkuil4e5a4d82014-02-14 06:46:50 -03002975 /*
2976 * If we are queuing up buffers for the first time, then
2977 * increase initial_index by one.
2978 */
2979 if (fileio->initial_index < q->num_buffers)
2980 fileio->initial_index++;
2981 /*
2982 * The next buffer to use is either a buffer that's going to be
2983 * queued for the first time (initial_index < q->num_buffers)
2984 * or it is equal to q->num_buffers, meaning that the next
2985 * time we need to dequeue a buffer since we've now queued up
2986 * all the 'first time' buffers.
2987 */
2988 fileio->cur_index = fileio->initial_index;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002989 }
2990
2991 /*
2992 * Return proper number of bytes processed.
2993 */
2994 if (ret == 0)
2995 ret = count;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03002996 return ret;
2997}
2998
2999size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count,
3000 loff_t *ppos, int nonblocking)
3001{
3002 return __vb2_perform_fileio(q, data, count, ppos, nonblocking, 1);
3003}
3004EXPORT_SYMBOL_GPL(vb2_read);
3005
Ricardo Ribalda819585b2013-08-28 04:39:29 -03003006size_t vb2_write(struct vb2_queue *q, const char __user *data, size_t count,
Marek Szyprowskib25748f2010-12-06 05:56:55 -03003007 loff_t *ppos, int nonblocking)
3008{
Ricardo Ribalda819585b2013-08-28 04:39:29 -03003009 return __vb2_perform_fileio(q, (char __user *) data, count,
3010 ppos, nonblocking, 0);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03003011}
3012EXPORT_SYMBOL_GPL(vb2_write);
3013
Hans Verkuil3415a892014-04-14 07:33:00 -03003014struct vb2_threadio_data {
3015 struct task_struct *thread;
3016 vb2_thread_fnc fnc;
3017 void *priv;
3018 bool stop;
3019};
3020
3021static int vb2_thread(void *data)
3022{
3023 struct vb2_queue *q = data;
3024 struct vb2_threadio_data *threadio = q->threadio;
3025 struct vb2_fileio_data *fileio = q->fileio;
3026 bool set_timestamp = false;
3027 int prequeue = 0;
3028 int index = 0;
3029 int ret = 0;
3030
3031 if (V4L2_TYPE_IS_OUTPUT(q->type)) {
3032 prequeue = q->num_buffers;
3033 set_timestamp =
3034 (q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
3035 V4L2_BUF_FLAG_TIMESTAMP_COPY;
3036 }
3037
3038 set_freezable();
3039
3040 for (;;) {
3041 struct vb2_buffer *vb;
3042
3043 /*
3044 * Call vb2_dqbuf to get buffer back.
3045 */
3046 memset(&fileio->b, 0, sizeof(fileio->b));
3047 fileio->b.type = q->type;
3048 fileio->b.memory = q->memory;
3049 if (prequeue) {
3050 fileio->b.index = index++;
3051 prequeue--;
3052 } else {
3053 call_void_qop(q, wait_finish, q);
3054 ret = vb2_internal_dqbuf(q, &fileio->b, 0);
3055 call_void_qop(q, wait_prepare, q);
3056 dprintk(5, "file io: vb2_dqbuf result: %d\n", ret);
3057 }
3058 if (threadio->stop)
3059 break;
3060 if (ret)
3061 break;
3062 try_to_freeze();
3063
3064 vb = q->bufs[fileio->b.index];
3065 if (!(fileio->b.flags & V4L2_BUF_FLAG_ERROR))
3066 ret = threadio->fnc(vb, threadio->priv);
3067 if (ret)
3068 break;
3069 call_void_qop(q, wait_finish, q);
3070 if (set_timestamp)
3071 v4l2_get_timestamp(&fileio->b.timestamp);
3072 ret = vb2_internal_qbuf(q, &fileio->b);
3073 call_void_qop(q, wait_prepare, q);
3074 if (ret)
3075 break;
3076 }
3077
3078 /* Hmm, linux becomes *very* unhappy without this ... */
3079 while (!kthread_should_stop()) {
3080 set_current_state(TASK_INTERRUPTIBLE);
3081 schedule();
3082 }
3083 return 0;
3084}
3085
3086/*
3087 * This function should not be used for anything else but the videobuf2-dvb
3088 * support. If you think you have another good use-case for this, then please
3089 * contact the linux-media mailinglist first.
3090 */
3091int vb2_thread_start(struct vb2_queue *q, vb2_thread_fnc fnc, void *priv,
3092 const char *thread_name)
3093{
3094 struct vb2_threadio_data *threadio;
3095 int ret = 0;
3096
3097 if (q->threadio)
3098 return -EBUSY;
3099 if (vb2_is_busy(q))
3100 return -EBUSY;
3101 if (WARN_ON(q->fileio))
3102 return -EBUSY;
3103
3104 threadio = kzalloc(sizeof(*threadio), GFP_KERNEL);
3105 if (threadio == NULL)
3106 return -ENOMEM;
3107 threadio->fnc = fnc;
3108 threadio->priv = priv;
3109
3110 ret = __vb2_init_fileio(q, !V4L2_TYPE_IS_OUTPUT(q->type));
3111 dprintk(3, "file io: vb2_init_fileio result: %d\n", ret);
3112 if (ret)
3113 goto nomem;
3114 q->threadio = threadio;
3115 threadio->thread = kthread_run(vb2_thread, q, "vb2-%s", thread_name);
3116 if (IS_ERR(threadio->thread)) {
3117 ret = PTR_ERR(threadio->thread);
3118 threadio->thread = NULL;
3119 goto nothread;
3120 }
3121 return 0;
3122
3123nothread:
3124 __vb2_cleanup_fileio(q);
3125nomem:
3126 kfree(threadio);
3127 return ret;
3128}
3129EXPORT_SYMBOL_GPL(vb2_thread_start);
3130
3131int vb2_thread_stop(struct vb2_queue *q)
3132{
3133 struct vb2_threadio_data *threadio = q->threadio;
3134 struct vb2_fileio_data *fileio = q->fileio;
3135 int err;
3136
3137 if (threadio == NULL)
3138 return 0;
3139 call_void_qop(q, wait_finish, q);
3140 threadio->stop = true;
3141 vb2_internal_streamoff(q, q->type);
3142 call_void_qop(q, wait_prepare, q);
3143 q->fileio = NULL;
3144 fileio->req.count = 0;
3145 vb2_reqbufs(q, &fileio->req);
3146 kfree(fileio);
3147 err = kthread_stop(threadio->thread);
3148 threadio->thread = NULL;
3149 kfree(threadio);
3150 q->fileio = NULL;
3151 q->threadio = NULL;
3152 return err;
3153}
3154EXPORT_SYMBOL_GPL(vb2_thread_stop);
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003155
3156/*
3157 * The following functions are not part of the vb2 core API, but are helper
3158 * functions that plug into struct v4l2_ioctl_ops, struct v4l2_file_operations
3159 * and struct vb2_ops.
3160 * They contain boilerplate code that most if not all drivers have to do
3161 * and so they simplify the driver code.
3162 */
3163
3164/* The queue is busy if there is a owner and you are not that owner. */
3165static inline bool vb2_queue_is_busy(struct video_device *vdev, struct file *file)
3166{
3167 return vdev->queue->owner && vdev->queue->owner != file->private_data;
3168}
3169
3170/* vb2 ioctl helpers */
3171
3172int vb2_ioctl_reqbufs(struct file *file, void *priv,
3173 struct v4l2_requestbuffers *p)
3174{
3175 struct video_device *vdev = video_devdata(file);
3176 int res = __verify_memory_type(vdev->queue, p->memory, p->type);
3177
3178 if (res)
3179 return res;
3180 if (vb2_queue_is_busy(vdev, file))
3181 return -EBUSY;
3182 res = __reqbufs(vdev->queue, p);
3183 /* If count == 0, then the owner has released all buffers and he
3184 is no longer owner of the queue. Otherwise we have a new owner. */
3185 if (res == 0)
3186 vdev->queue->owner = p->count ? file->private_data : NULL;
3187 return res;
3188}
3189EXPORT_SYMBOL_GPL(vb2_ioctl_reqbufs);
3190
3191int vb2_ioctl_create_bufs(struct file *file, void *priv,
3192 struct v4l2_create_buffers *p)
3193{
3194 struct video_device *vdev = video_devdata(file);
3195 int res = __verify_memory_type(vdev->queue, p->memory, p->format.type);
3196
3197 p->index = vdev->queue->num_buffers;
3198 /* If count == 0, then just check if memory and type are valid.
3199 Any -EBUSY result from __verify_memory_type can be mapped to 0. */
3200 if (p->count == 0)
3201 return res != -EBUSY ? res : 0;
3202 if (res)
3203 return res;
3204 if (vb2_queue_is_busy(vdev, file))
3205 return -EBUSY;
3206 res = __create_bufs(vdev->queue, p);
3207 if (res == 0)
3208 vdev->queue->owner = file->private_data;
3209 return res;
3210}
3211EXPORT_SYMBOL_GPL(vb2_ioctl_create_bufs);
3212
3213int vb2_ioctl_prepare_buf(struct file *file, void *priv,
3214 struct v4l2_buffer *p)
3215{
3216 struct video_device *vdev = video_devdata(file);
3217
3218 if (vb2_queue_is_busy(vdev, file))
3219 return -EBUSY;
3220 return vb2_prepare_buf(vdev->queue, p);
3221}
3222EXPORT_SYMBOL_GPL(vb2_ioctl_prepare_buf);
3223
3224int vb2_ioctl_querybuf(struct file *file, void *priv, struct v4l2_buffer *p)
3225{
3226 struct video_device *vdev = video_devdata(file);
3227
3228 /* No need to call vb2_queue_is_busy(), anyone can query buffers. */
3229 return vb2_querybuf(vdev->queue, p);
3230}
3231EXPORT_SYMBOL_GPL(vb2_ioctl_querybuf);
3232
3233int vb2_ioctl_qbuf(struct file *file, void *priv, struct v4l2_buffer *p)
3234{
3235 struct video_device *vdev = video_devdata(file);
3236
3237 if (vb2_queue_is_busy(vdev, file))
3238 return -EBUSY;
3239 return vb2_qbuf(vdev->queue, p);
3240}
3241EXPORT_SYMBOL_GPL(vb2_ioctl_qbuf);
3242
3243int vb2_ioctl_dqbuf(struct file *file, void *priv, struct v4l2_buffer *p)
3244{
3245 struct video_device *vdev = video_devdata(file);
3246
3247 if (vb2_queue_is_busy(vdev, file))
3248 return -EBUSY;
3249 return vb2_dqbuf(vdev->queue, p, file->f_flags & O_NONBLOCK);
3250}
3251EXPORT_SYMBOL_GPL(vb2_ioctl_dqbuf);
3252
3253int vb2_ioctl_streamon(struct file *file, void *priv, enum v4l2_buf_type i)
3254{
3255 struct video_device *vdev = video_devdata(file);
3256
3257 if (vb2_queue_is_busy(vdev, file))
3258 return -EBUSY;
3259 return vb2_streamon(vdev->queue, i);
3260}
3261EXPORT_SYMBOL_GPL(vb2_ioctl_streamon);
3262
3263int vb2_ioctl_streamoff(struct file *file, void *priv, enum v4l2_buf_type i)
3264{
3265 struct video_device *vdev = video_devdata(file);
3266
3267 if (vb2_queue_is_busy(vdev, file))
3268 return -EBUSY;
3269 return vb2_streamoff(vdev->queue, i);
3270}
3271EXPORT_SYMBOL_GPL(vb2_ioctl_streamoff);
3272
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -03003273int vb2_ioctl_expbuf(struct file *file, void *priv, struct v4l2_exportbuffer *p)
3274{
3275 struct video_device *vdev = video_devdata(file);
3276
3277 if (vb2_queue_is_busy(vdev, file))
3278 return -EBUSY;
3279 return vb2_expbuf(vdev->queue, p);
3280}
3281EXPORT_SYMBOL_GPL(vb2_ioctl_expbuf);
3282
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003283/* v4l2_file_operations helpers */
3284
3285int vb2_fop_mmap(struct file *file, struct vm_area_struct *vma)
3286{
3287 struct video_device *vdev = video_devdata(file);
Laurent Pinchart8a90f1a2013-08-02 13:55:21 -03003288 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
3289 int err;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003290
Laurent Pinchart8a90f1a2013-08-02 13:55:21 -03003291 if (lock && mutex_lock_interruptible(lock))
3292 return -ERESTARTSYS;
3293 err = vb2_mmap(vdev->queue, vma);
3294 if (lock)
3295 mutex_unlock(lock);
3296 return err;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003297}
3298EXPORT_SYMBOL_GPL(vb2_fop_mmap);
3299
Ricardo Ribalda1380f572013-11-25 05:49:02 -03003300int _vb2_fop_release(struct file *file, struct mutex *lock)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003301{
3302 struct video_device *vdev = video_devdata(file);
3303
3304 if (file->private_data == vdev->queue->owner) {
Ricardo Ribalda1380f572013-11-25 05:49:02 -03003305 if (lock)
3306 mutex_lock(lock);
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003307 vb2_queue_release(vdev->queue);
3308 vdev->queue->owner = NULL;
Ricardo Ribalda1380f572013-11-25 05:49:02 -03003309 if (lock)
3310 mutex_unlock(lock);
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003311 }
3312 return v4l2_fh_release(file);
3313}
Ricardo Ribalda1380f572013-11-25 05:49:02 -03003314EXPORT_SYMBOL_GPL(_vb2_fop_release);
3315
3316int vb2_fop_release(struct file *file)
3317{
3318 struct video_device *vdev = video_devdata(file);
3319 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
3320
3321 return _vb2_fop_release(file, lock);
3322}
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003323EXPORT_SYMBOL_GPL(vb2_fop_release);
3324
Ricardo Ribalda819585b2013-08-28 04:39:29 -03003325ssize_t vb2_fop_write(struct file *file, const char __user *buf,
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003326 size_t count, loff_t *ppos)
3327{
3328 struct video_device *vdev = video_devdata(file);
3329 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003330 int err = -EBUSY;
3331
Hans Verkuilcf533732012-07-31 04:02:25 -03003332 if (lock && mutex_lock_interruptible(lock))
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003333 return -ERESTARTSYS;
3334 if (vb2_queue_is_busy(vdev, file))
3335 goto exit;
3336 err = vb2_write(vdev->queue, buf, count, ppos,
3337 file->f_flags & O_NONBLOCK);
Hans Verkuil8c82c752012-09-07 12:50:02 -03003338 if (vdev->queue->fileio)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003339 vdev->queue->owner = file->private_data;
3340exit:
Hans Verkuilcf533732012-07-31 04:02:25 -03003341 if (lock)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003342 mutex_unlock(lock);
3343 return err;
3344}
3345EXPORT_SYMBOL_GPL(vb2_fop_write);
3346
3347ssize_t vb2_fop_read(struct file *file, char __user *buf,
3348 size_t count, loff_t *ppos)
3349{
3350 struct video_device *vdev = video_devdata(file);
3351 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003352 int err = -EBUSY;
3353
Hans Verkuilcf533732012-07-31 04:02:25 -03003354 if (lock && mutex_lock_interruptible(lock))
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003355 return -ERESTARTSYS;
3356 if (vb2_queue_is_busy(vdev, file))
3357 goto exit;
3358 err = vb2_read(vdev->queue, buf, count, ppos,
3359 file->f_flags & O_NONBLOCK);
Hans Verkuil8c82c752012-09-07 12:50:02 -03003360 if (vdev->queue->fileio)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003361 vdev->queue->owner = file->private_data;
3362exit:
Hans Verkuilcf533732012-07-31 04:02:25 -03003363 if (lock)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003364 mutex_unlock(lock);
3365 return err;
3366}
3367EXPORT_SYMBOL_GPL(vb2_fop_read);
3368
3369unsigned int vb2_fop_poll(struct file *file, poll_table *wait)
3370{
3371 struct video_device *vdev = video_devdata(file);
3372 struct vb2_queue *q = vdev->queue;
3373 struct mutex *lock = q->lock ? q->lock : vdev->lock;
3374 unsigned long req_events = poll_requested_events(wait);
3375 unsigned res;
3376 void *fileio;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003377 bool must_lock = false;
3378
3379 /* Try to be smart: only lock if polling might start fileio,
3380 otherwise locking will only introduce unwanted delays. */
Hans Verkuil74753cffa2014-04-07 09:23:50 -03003381 if (q->num_buffers == 0 && !vb2_fileio_is_active(q)) {
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003382 if (!V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_READ) &&
3383 (req_events & (POLLIN | POLLRDNORM)))
3384 must_lock = true;
3385 else if (V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_WRITE) &&
3386 (req_events & (POLLOUT | POLLWRNORM)))
3387 must_lock = true;
3388 }
3389
3390 /* If locking is needed, but this helper doesn't know how, then you
3391 shouldn't be using this helper but you should write your own. */
Hans Verkuilcf533732012-07-31 04:02:25 -03003392 WARN_ON(must_lock && !lock);
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003393
Hans Verkuilcf533732012-07-31 04:02:25 -03003394 if (must_lock && lock && mutex_lock_interruptible(lock))
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003395 return POLLERR;
3396
3397 fileio = q->fileio;
3398
3399 res = vb2_poll(vdev->queue, file, wait);
3400
3401 /* If fileio was started, then we have a new queue owner. */
3402 if (must_lock && !fileio && q->fileio)
3403 q->owner = file->private_data;
Hans Verkuilcf533732012-07-31 04:02:25 -03003404 if (must_lock && lock)
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003405 mutex_unlock(lock);
3406 return res;
3407}
3408EXPORT_SYMBOL_GPL(vb2_fop_poll);
3409
3410#ifndef CONFIG_MMU
3411unsigned long vb2_fop_get_unmapped_area(struct file *file, unsigned long addr,
3412 unsigned long len, unsigned long pgoff, unsigned long flags)
3413{
3414 struct video_device *vdev = video_devdata(file);
Laurent Pinchart8a90f1a2013-08-02 13:55:21 -03003415 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
3416 int ret;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003417
Laurent Pinchart8a90f1a2013-08-02 13:55:21 -03003418 if (lock && mutex_lock_interruptible(lock))
3419 return -ERESTARTSYS;
3420 ret = vb2_get_unmapped_area(vdev->queue, addr, len, pgoff, flags);
3421 if (lock)
3422 mutex_unlock(lock);
3423 return ret;
Hans Verkuil4c1ffca2012-07-02 05:59:18 -03003424}
3425EXPORT_SYMBOL_GPL(vb2_fop_get_unmapped_area);
3426#endif
3427
3428/* vb2_ops helpers. Only use if vq->lock is non-NULL. */
3429
3430void vb2_ops_wait_prepare(struct vb2_queue *vq)
3431{
3432 mutex_unlock(vq->lock);
3433}
3434EXPORT_SYMBOL_GPL(vb2_ops_wait_prepare);
3435
3436void vb2_ops_wait_finish(struct vb2_queue *vq)
3437{
3438 mutex_lock(vq->lock);
3439}
3440EXPORT_SYMBOL_GPL(vb2_ops_wait_finish);
3441
Pawel Osciake23ccc02010-10-11 10:56:41 -03003442MODULE_DESCRIPTION("Driver helper framework for Video for Linux 2");
Pawel Osciak95072082011-03-13 15:23:32 -03003443MODULE_AUTHOR("Pawel Osciak <pawel@osciak.com>, Marek Szyprowski");
Pawel Osciake23ccc02010-10-11 10:56:41 -03003444MODULE_LICENSE("GPL");