[media] adv7842: Make output format configurable through pad format operations
[deliverable/linux.git] / drivers / media / v4l2-core / videobuf2-core.c
CommitLineData
e23ccc0a
PO
1/*
2 * videobuf2-core.c - V4L2 driver helper framework
3 *
4 * Copyright (C) 2010 Samsung Electronics
5 *
95072084 6 * Author: Pawel Osciak <pawel@osciak.com>
e23ccc0a
PO
7 * Marek Szyprowski <m.szyprowski@samsung.com>
8 *
3415a89f
HV
9 * The vb2_thread implementation was based on code from videobuf-dvb.c:
10 * (c) 2004 Gerd Knorr <kraxel@bytesex.org> [SUSE Labs]
11 *
e23ccc0a
PO
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation.
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>
3415a89f
HV
24#include <linux/freezer.h>
25#include <linux/kthread.h>
e23ccc0a 26
95213ceb
HV
27#include <media/v4l2-dev.h>
28#include <media/v4l2-fh.h>
29#include <media/v4l2-event.h>
ebd7c505 30#include <media/v4l2-common.h>
e23ccc0a
PO
31#include <media/videobuf2-core.h>
32
33static int debug;
34module_param(debug, int, 0644);
35
fd4354cf
HV
36#define dprintk(level, fmt, arg...) \
37 do { \
38 if (debug >= level) \
0821344d 39 pr_info("vb2: %s: " fmt, __func__, ## arg); \
e23ccc0a
PO
40 } while (0)
41
b5b4541e
HV
42#ifdef CONFIG_VIDEO_ADV_DEBUG
43
44/*
a1d36d8c
HV
45 * If advanced debugging is on, then count how often each op is called
46 * successfully, which can either be per-buffer or per-queue.
b5b4541e 47 *
a1d36d8c 48 * This makes it easy to check that the 'init' and 'cleanup'
b5b4541e
HV
49 * (and variations thereof) stay balanced.
50 */
51
a1d36d8c
HV
52#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
b5b4541e
HV
57#define call_memop(vb, op, args...) \
58({ \
59 struct vb2_queue *_q = (vb)->vb2_queue; \
a1d36d8c
HV
60 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; \
67})
68
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); \
b5b4541e 88 (vb)->cnt_mem_ ## op++; \
b5b4541e 89})
a1d36d8c
HV
90
91#define log_qop(q, op) \
92 dprintk(2, "call_qop(%p, %s)%s\n", q, #op, \
93 (q)->ops->op ? "" : " (nop)")
b5b4541e
HV
94
95#define call_qop(q, op, args...) \
96({ \
a1d36d8c
HV
97 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; \
104})
105
106#define call_void_qop(q, op, args...) \
107({ \
108 log_qop(q, op); \
109 if ((q)->ops->op) \
110 (q)->ops->op(args); \
b5b4541e 111 (q)->cnt_ ## op++; \
b5b4541e 112})
a1d36d8c
HV
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)")
b5b4541e
HV
118
119#define call_vb_qop(vb, op, args...) \
120({ \
a1d36d8c
HV
121 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; \
129})
130
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); \
b5b4541e 136 (vb)->cnt_ ## op++; \
b5b4541e 137})
b5b4541e
HV
138
139#else
140
141#define call_memop(vb, op, args...) \
a1d36d8c
HV
142 ((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)
e23ccc0a
PO
154
155#define call_qop(q, op, args...) \
b5b4541e 156 ((q)->ops->op ? (q)->ops->op(args) : 0)
a1d36d8c
HV
157
158#define call_void_qop(q, op, args...) \
159 do { \
160 if ((q)->ops->op) \
161 (q)->ops->op(args); \
162 } while (0)
b5b4541e
HV
163
164#define call_vb_qop(vb, op, args...) \
165 ((vb)->vb2_queue->ops->op ? (vb)->vb2_queue->ops->op(args) : 0)
a1d36d8c
HV
166
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)
b5b4541e
HV
172
173#endif
e23ccc0a 174
f1343281 175/* Flags that are set by the vb2 core */
1b18e7a0 176#define V4L2_BUFFER_MASK_FLAGS (V4L2_BUF_FLAG_MAPPED | V4L2_BUF_FLAG_QUEUED | \
2d86401c 177 V4L2_BUF_FLAG_DONE | V4L2_BUF_FLAG_ERROR | \
1b18e7a0
SA
178 V4L2_BUF_FLAG_PREPARED | \
179 V4L2_BUF_FLAG_TIMESTAMP_MASK)
f1343281
HV
180/* 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)
ea42c8ec 183
fb64dca8
HV
184static void __vb2_queue_cancel(struct vb2_queue *q);
185
e23ccc0a
PO
186/**
187 * __vb2_buf_mem_alloc() - allocate video memory for the given buffer
188 */
c1426bc7 189static int __vb2_buf_mem_alloc(struct vb2_buffer *vb)
e23ccc0a
PO
190{
191 struct vb2_queue *q = vb->vb2_queue;
d935c57e
HV
192 enum dma_data_direction dma_dir =
193 V4L2_TYPE_IS_OUTPUT(q->type) ? DMA_TO_DEVICE : DMA_FROM_DEVICE;
e23ccc0a
PO
194 void *mem_priv;
195 int plane;
196
7f841459
MCC
197 /*
198 * Allocate memory for all planes in this buffer
199 * NOTE: mmapped areas should be page aligned
200 */
e23ccc0a 201 for (plane = 0; plane < vb->num_planes; ++plane) {
7f841459
MCC
202 unsigned long size = PAGE_ALIGN(q->plane_sizes[plane]);
203
a1d36d8c 204 mem_priv = call_ptr_memop(vb, alloc, q->alloc_ctx[plane],
d935c57e 205 size, dma_dir, q->gfp_flags);
62a79436 206 if (IS_ERR_OR_NULL(mem_priv))
e23ccc0a
PO
207 goto free;
208
209 /* Associate allocator private data with this plane */
210 vb->planes[plane].mem_priv = mem_priv;
c1426bc7 211 vb->v4l2_planes[plane].length = q->plane_sizes[plane];
e23ccc0a
PO
212 }
213
214 return 0;
215free:
216 /* Free already allocated memory if one of the allocations failed */
a00d0266 217 for (; plane > 0; --plane) {
a1d36d8c 218 call_void_memop(vb, put, vb->planes[plane - 1].mem_priv);
a00d0266
MS
219 vb->planes[plane - 1].mem_priv = NULL;
220 }
e23ccc0a
PO
221
222 return -ENOMEM;
223}
224
225/**
226 * __vb2_buf_mem_free() - free memory of the given buffer
227 */
228static void __vb2_buf_mem_free(struct vb2_buffer *vb)
229{
e23ccc0a
PO
230 unsigned int plane;
231
232 for (plane = 0; plane < vb->num_planes; ++plane) {
a1d36d8c 233 call_void_memop(vb, put, vb->planes[plane].mem_priv);
e23ccc0a 234 vb->planes[plane].mem_priv = NULL;
3050040b 235 dprintk(3, "freed plane %d of buffer %d\n", plane,
a00d0266 236 vb->v4l2_buf.index);
e23ccc0a
PO
237 }
238}
239
240/**
241 * __vb2_buf_userptr_put() - release userspace memory associated with
242 * a USERPTR buffer
243 */
244static void __vb2_buf_userptr_put(struct vb2_buffer *vb)
245{
e23ccc0a
PO
246 unsigned int plane;
247
248 for (plane = 0; plane < vb->num_planes; ++plane) {
a00d0266 249 if (vb->planes[plane].mem_priv)
a1d36d8c 250 call_void_memop(vb, put_userptr, vb->planes[plane].mem_priv);
a00d0266 251 vb->planes[plane].mem_priv = NULL;
e23ccc0a
PO
252 }
253}
254
c5384048
SS
255/**
256 * __vb2_plane_dmabuf_put() - release memory associated with
257 * a DMABUF shared plane
258 */
b5b4541e 259static void __vb2_plane_dmabuf_put(struct vb2_buffer *vb, struct vb2_plane *p)
c5384048
SS
260{
261 if (!p->mem_priv)
262 return;
263
264 if (p->dbuf_mapped)
a1d36d8c 265 call_void_memop(vb, unmap_dmabuf, p->mem_priv);
c5384048 266
a1d36d8c 267 call_void_memop(vb, detach_dmabuf, p->mem_priv);
c5384048
SS
268 dma_buf_put(p->dbuf);
269 memset(p, 0, sizeof(*p));
270}
271
272/**
273 * __vb2_buf_dmabuf_put() - release memory associated with
274 * a DMABUF shared buffer
275 */
276static void __vb2_buf_dmabuf_put(struct vb2_buffer *vb)
277{
c5384048
SS
278 unsigned int plane;
279
280 for (plane = 0; plane < vb->num_planes; ++plane)
b5b4541e 281 __vb2_plane_dmabuf_put(vb, &vb->planes[plane]);
c5384048
SS
282}
283
a5e3d743
HV
284/**
285 * __setup_lengths() - setup initial lengths for every plane in
286 * every buffer on the queue
287 */
288static void __setup_lengths(struct vb2_queue *q, unsigned int n)
289{
290 unsigned int buffer, plane;
291 struct vb2_buffer *vb;
292
293 for (buffer = q->num_buffers; buffer < q->num_buffers + n; ++buffer) {
294 vb = q->bufs[buffer];
295 if (!vb)
296 continue;
297
298 for (plane = 0; plane < vb->num_planes; ++plane)
299 vb->v4l2_planes[plane].length = q->plane_sizes[plane];
300 }
301}
302
e23ccc0a
PO
303/**
304 * __setup_offsets() - setup unique offsets ("cookies") for every plane in
305 * every buffer on the queue
306 */
2d86401c 307static void __setup_offsets(struct vb2_queue *q, unsigned int n)
e23ccc0a
PO
308{
309 unsigned int buffer, plane;
310 struct vb2_buffer *vb;
2d86401c 311 unsigned long off;
e23ccc0a 312
2d86401c
GL
313 if (q->num_buffers) {
314 struct v4l2_plane *p;
315 vb = q->bufs[q->num_buffers - 1];
316 p = &vb->v4l2_planes[vb->num_planes - 1];
317 off = PAGE_ALIGN(p->m.mem_offset + p->length);
318 } else {
319 off = 0;
320 }
321
322 for (buffer = q->num_buffers; buffer < q->num_buffers + n; ++buffer) {
e23ccc0a
PO
323 vb = q->bufs[buffer];
324 if (!vb)
325 continue;
326
327 for (plane = 0; plane < vb->num_planes; ++plane) {
328 vb->v4l2_planes[plane].m.mem_offset = off;
329
3050040b 330 dprintk(3, "buffer %d, plane %d offset 0x%08lx\n",
e23ccc0a
PO
331 buffer, plane, off);
332
333 off += vb->v4l2_planes[plane].length;
334 off = PAGE_ALIGN(off);
335 }
336 }
337}
338
339/**
340 * __vb2_queue_alloc() - allocate videobuf buffer structures and (for MMAP type)
341 * video buffer memory for all buffers/planes on the queue and initializes the
342 * queue
343 *
344 * Returns the number of buffers successfully allocated.
345 */
346static int __vb2_queue_alloc(struct vb2_queue *q, enum v4l2_memory memory,
c1426bc7 347 unsigned int num_buffers, unsigned int num_planes)
e23ccc0a
PO
348{
349 unsigned int buffer;
350 struct vb2_buffer *vb;
351 int ret;
352
353 for (buffer = 0; buffer < num_buffers; ++buffer) {
354 /* Allocate videobuf buffer structures */
355 vb = kzalloc(q->buf_struct_size, GFP_KERNEL);
356 if (!vb) {
3050040b 357 dprintk(1, "memory alloc for buffer struct failed\n");
e23ccc0a
PO
358 break;
359 }
360
361 /* Length stores number of planes for multiplanar buffers */
362 if (V4L2_TYPE_IS_MULTIPLANAR(q->type))
363 vb->v4l2_buf.length = num_planes;
364
365 vb->state = VB2_BUF_STATE_DEQUEUED;
366 vb->vb2_queue = q;
367 vb->num_planes = num_planes;
2d86401c 368 vb->v4l2_buf.index = q->num_buffers + buffer;
e23ccc0a
PO
369 vb->v4l2_buf.type = q->type;
370 vb->v4l2_buf.memory = memory;
371
372 /* Allocate video buffer memory for the MMAP type */
373 if (memory == V4L2_MEMORY_MMAP) {
c1426bc7 374 ret = __vb2_buf_mem_alloc(vb);
e23ccc0a 375 if (ret) {
3050040b 376 dprintk(1, "failed allocating memory for "
e23ccc0a
PO
377 "buffer %d\n", buffer);
378 kfree(vb);
379 break;
380 }
381 /*
382 * Call the driver-provided buffer initialization
383 * callback, if given. An error in initialization
384 * results in queue setup failure.
385 */
b5b4541e 386 ret = call_vb_qop(vb, buf_init, vb);
e23ccc0a 387 if (ret) {
3050040b 388 dprintk(1, "buffer %d %p initialization"
e23ccc0a
PO
389 " failed\n", buffer, vb);
390 __vb2_buf_mem_free(vb);
391 kfree(vb);
392 break;
393 }
394 }
395
2d86401c 396 q->bufs[q->num_buffers + buffer] = vb;
e23ccc0a
PO
397 }
398
a5e3d743 399 __setup_lengths(q, buffer);
dc77523c
PZ
400 if (memory == V4L2_MEMORY_MMAP)
401 __setup_offsets(q, buffer);
e23ccc0a 402
3050040b 403 dprintk(1, "allocated %d buffers, %d plane(s) each\n",
2d86401c 404 buffer, num_planes);
e23ccc0a
PO
405
406 return buffer;
407}
408
409/**
410 * __vb2_free_mem() - release all video buffer memory for a given queue
411 */
2d86401c 412static void __vb2_free_mem(struct vb2_queue *q, unsigned int buffers)
e23ccc0a
PO
413{
414 unsigned int buffer;
415 struct vb2_buffer *vb;
416
2d86401c
GL
417 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
418 ++buffer) {
e23ccc0a
PO
419 vb = q->bufs[buffer];
420 if (!vb)
421 continue;
422
423 /* Free MMAP buffers or release USERPTR buffers */
424 if (q->memory == V4L2_MEMORY_MMAP)
425 __vb2_buf_mem_free(vb);
c5384048
SS
426 else if (q->memory == V4L2_MEMORY_DMABUF)
427 __vb2_buf_dmabuf_put(vb);
e23ccc0a
PO
428 else
429 __vb2_buf_userptr_put(vb);
430 }
431}
432
433/**
2d86401c
GL
434 * __vb2_queue_free() - free buffers at the end of the queue - video memory and
435 * related information, if no buffers are left return the queue to an
436 * uninitialized state. Might be called even if the queue has already been freed.
e23ccc0a 437 */
63faabfd 438static int __vb2_queue_free(struct vb2_queue *q, unsigned int buffers)
e23ccc0a
PO
439{
440 unsigned int buffer;
441
63faabfd
HV
442 /*
443 * Sanity check: when preparing a buffer the queue lock is released for
444 * a short while (see __buf_prepare for the details), which would allow
445 * a race with a reqbufs which can call this function. Removing the
446 * buffers from underneath __buf_prepare is obviously a bad idea, so we
447 * check if any of the buffers is in the state PREPARING, and if so we
448 * just return -EAGAIN.
449 */
450 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
451 ++buffer) {
452 if (q->bufs[buffer] == NULL)
453 continue;
454 if (q->bufs[buffer]->state == VB2_BUF_STATE_PREPARING) {
fd4354cf 455 dprintk(1, "preparing buffers, cannot free\n");
63faabfd
HV
456 return -EAGAIN;
457 }
458 }
459
e23ccc0a 460 /* Call driver-provided cleanup function for each buffer, if provided */
b5b4541e
HV
461 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
462 ++buffer) {
256f3162
HV
463 struct vb2_buffer *vb = q->bufs[buffer];
464
465 if (vb && vb->planes[0].mem_priv)
a1d36d8c 466 call_void_vb_qop(vb, buf_cleanup, vb);
e23ccc0a
PO
467 }
468
469 /* Release video buffer memory */
2d86401c 470 __vb2_free_mem(q, buffers);
e23ccc0a 471
b5b4541e
HV
472#ifdef CONFIG_VIDEO_ADV_DEBUG
473 /*
474 * Check that all the calls were balances during the life-time of this
475 * queue. If not (or if the debug level is 1 or up), then dump the
476 * counters to the kernel log.
477 */
478 if (q->num_buffers) {
479 bool unbalanced = q->cnt_start_streaming != q->cnt_stop_streaming ||
480 q->cnt_wait_prepare != q->cnt_wait_finish;
481
482 if (unbalanced || debug) {
483 pr_info("vb2: counters for queue %p:%s\n", q,
484 unbalanced ? " UNBALANCED!" : "");
485 pr_info("vb2: setup: %u start_streaming: %u stop_streaming: %u\n",
486 q->cnt_queue_setup, q->cnt_start_streaming,
487 q->cnt_stop_streaming);
488 pr_info("vb2: wait_prepare: %u wait_finish: %u\n",
489 q->cnt_wait_prepare, q->cnt_wait_finish);
490 }
491 q->cnt_queue_setup = 0;
492 q->cnt_wait_prepare = 0;
493 q->cnt_wait_finish = 0;
494 q->cnt_start_streaming = 0;
495 q->cnt_stop_streaming = 0;
496 }
497 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
498 struct vb2_buffer *vb = q->bufs[buffer];
499 bool unbalanced = vb->cnt_mem_alloc != vb->cnt_mem_put ||
500 vb->cnt_mem_prepare != vb->cnt_mem_finish ||
501 vb->cnt_mem_get_userptr != vb->cnt_mem_put_userptr ||
502 vb->cnt_mem_attach_dmabuf != vb->cnt_mem_detach_dmabuf ||
503 vb->cnt_mem_map_dmabuf != vb->cnt_mem_unmap_dmabuf ||
504 vb->cnt_buf_queue != vb->cnt_buf_done ||
505 vb->cnt_buf_prepare != vb->cnt_buf_finish ||
506 vb->cnt_buf_init != vb->cnt_buf_cleanup;
507
508 if (unbalanced || debug) {
509 pr_info("vb2: counters for queue %p, buffer %d:%s\n",
510 q, buffer, unbalanced ? " UNBALANCED!" : "");
511 pr_info("vb2: buf_init: %u buf_cleanup: %u buf_prepare: %u buf_finish: %u\n",
512 vb->cnt_buf_init, vb->cnt_buf_cleanup,
513 vb->cnt_buf_prepare, vb->cnt_buf_finish);
514 pr_info("vb2: buf_queue: %u buf_done: %u\n",
515 vb->cnt_buf_queue, vb->cnt_buf_done);
516 pr_info("vb2: alloc: %u put: %u prepare: %u finish: %u mmap: %u\n",
517 vb->cnt_mem_alloc, vb->cnt_mem_put,
518 vb->cnt_mem_prepare, vb->cnt_mem_finish,
519 vb->cnt_mem_mmap);
520 pr_info("vb2: get_userptr: %u put_userptr: %u\n",
521 vb->cnt_mem_get_userptr, vb->cnt_mem_put_userptr);
522 pr_info("vb2: attach_dmabuf: %u detach_dmabuf: %u map_dmabuf: %u unmap_dmabuf: %u\n",
523 vb->cnt_mem_attach_dmabuf, vb->cnt_mem_detach_dmabuf,
524 vb->cnt_mem_map_dmabuf, vb->cnt_mem_unmap_dmabuf);
525 pr_info("vb2: get_dmabuf: %u num_users: %u vaddr: %u cookie: %u\n",
526 vb->cnt_mem_get_dmabuf,
527 vb->cnt_mem_num_users,
528 vb->cnt_mem_vaddr,
529 vb->cnt_mem_cookie);
530 }
531 }
532#endif
533
e23ccc0a 534 /* Free videobuf buffers */
2d86401c
GL
535 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
536 ++buffer) {
e23ccc0a
PO
537 kfree(q->bufs[buffer]);
538 q->bufs[buffer] = NULL;
539 }
540
2d86401c 541 q->num_buffers -= buffers;
a7afcacc 542 if (!q->num_buffers) {
2d86401c 543 q->memory = 0;
a7afcacc
HV
544 INIT_LIST_HEAD(&q->queued_list);
545 }
63faabfd 546 return 0;
e23ccc0a
PO
547}
548
549/**
550 * __verify_planes_array() - verify that the planes array passed in struct
551 * v4l2_buffer from userspace can be safely used
552 */
2d86401c 553static int __verify_planes_array(struct vb2_buffer *vb, const struct v4l2_buffer *b)
e23ccc0a 554{
32a77260
HV
555 if (!V4L2_TYPE_IS_MULTIPLANAR(b->type))
556 return 0;
557
e23ccc0a
PO
558 /* Is memory for copying plane information present? */
559 if (NULL == b->m.planes) {
3050040b 560 dprintk(1, "multi-planar buffer passed but "
e23ccc0a
PO
561 "planes array not provided\n");
562 return -EINVAL;
563 }
564
565 if (b->length < vb->num_planes || b->length > VIDEO_MAX_PLANES) {
3050040b 566 dprintk(1, "incorrect planes array length, "
e23ccc0a
PO
567 "expected %d, got %d\n", vb->num_planes, b->length);
568 return -EINVAL;
569 }
570
571 return 0;
572}
573
8023ed09
LP
574/**
575 * __verify_length() - Verify that the bytesused value for each plane fits in
576 * the plane length and that the data offset doesn't exceed the bytesused value.
577 */
578static int __verify_length(struct vb2_buffer *vb, const struct v4l2_buffer *b)
579{
580 unsigned int length;
8a75ffb8 581 unsigned int bytesused;
8023ed09
LP
582 unsigned int plane;
583
584 if (!V4L2_TYPE_IS_OUTPUT(b->type))
585 return 0;
586
587 if (V4L2_TYPE_IS_MULTIPLANAR(b->type)) {
588 for (plane = 0; plane < vb->num_planes; ++plane) {
8a75ffb8
HV
589 length = (b->memory == V4L2_MEMORY_USERPTR ||
590 b->memory == V4L2_MEMORY_DMABUF)
8023ed09
LP
591 ? b->m.planes[plane].length
592 : vb->v4l2_planes[plane].length;
8a75ffb8
HV
593 bytesused = b->m.planes[plane].bytesused
594 ? b->m.planes[plane].bytesused : length;
8023ed09
LP
595
596 if (b->m.planes[plane].bytesused > length)
597 return -EINVAL;
3c5c23c5
SN
598
599 if (b->m.planes[plane].data_offset > 0 &&
8a75ffb8 600 b->m.planes[plane].data_offset >= bytesused)
8023ed09
LP
601 return -EINVAL;
602 }
603 } else {
604 length = (b->memory == V4L2_MEMORY_USERPTR)
605 ? b->length : vb->v4l2_planes[0].length;
8a75ffb8 606 bytesused = b->bytesused ? b->bytesused : length;
8023ed09
LP
607
608 if (b->bytesused > length)
609 return -EINVAL;
610 }
611
612 return 0;
613}
614
25a27d91
MS
615/**
616 * __buffer_in_use() - return true if the buffer is in use and
617 * the queue cannot be freed (by the means of REQBUFS(0)) call
618 */
619static bool __buffer_in_use(struct vb2_queue *q, struct vb2_buffer *vb)
620{
621 unsigned int plane;
622 for (plane = 0; plane < vb->num_planes; ++plane) {
2c2dd6ac 623 void *mem_priv = vb->planes[plane].mem_priv;
25a27d91
MS
624 /*
625 * If num_users() has not been provided, call_memop
626 * will return 0, apparently nobody cares about this
627 * case anyway. If num_users() returns more than 1,
628 * we are not the only user of the plane's memory.
629 */
b5b4541e 630 if (mem_priv && call_memop(vb, num_users, mem_priv) > 1)
25a27d91
MS
631 return true;
632 }
633 return false;
634}
635
636/**
637 * __buffers_in_use() - return true if any buffers on the queue are in use and
638 * the queue cannot be freed (by the means of REQBUFS(0)) call
639 */
640static bool __buffers_in_use(struct vb2_queue *q)
641{
642 unsigned int buffer;
643 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
644 if (__buffer_in_use(q, q->bufs[buffer]))
645 return true;
646 }
647 return false;
648}
649
e23ccc0a
PO
650/**
651 * __fill_v4l2_buffer() - fill in a struct v4l2_buffer with information to be
652 * returned to userspace
653 */
32a77260 654static void __fill_v4l2_buffer(struct vb2_buffer *vb, struct v4l2_buffer *b)
e23ccc0a
PO
655{
656 struct vb2_queue *q = vb->vb2_queue;
e23ccc0a 657
2b719d7b 658 /* Copy back data such as timestamp, flags, etc. */
e23ccc0a 659 memcpy(b, &vb->v4l2_buf, offsetof(struct v4l2_buffer, m));
2b719d7b 660 b->reserved2 = vb->v4l2_buf.reserved2;
e23ccc0a
PO
661 b->reserved = vb->v4l2_buf.reserved;
662
663 if (V4L2_TYPE_IS_MULTIPLANAR(q->type)) {
e23ccc0a
PO
664 /*
665 * Fill in plane-related data if userspace provided an array
32a77260 666 * for it. The caller has already verified memory and size.
e23ccc0a 667 */
3c0b6061 668 b->length = vb->num_planes;
e23ccc0a
PO
669 memcpy(b->m.planes, vb->v4l2_planes,
670 b->length * sizeof(struct v4l2_plane));
671 } else {
672 /*
673 * We use length and offset in v4l2_planes array even for
674 * single-planar buffers, but userspace does not.
675 */
676 b->length = vb->v4l2_planes[0].length;
677 b->bytesused = vb->v4l2_planes[0].bytesused;
678 if (q->memory == V4L2_MEMORY_MMAP)
679 b->m.offset = vb->v4l2_planes[0].m.mem_offset;
680 else if (q->memory == V4L2_MEMORY_USERPTR)
681 b->m.userptr = vb->v4l2_planes[0].m.userptr;
c5384048
SS
682 else if (q->memory == V4L2_MEMORY_DMABUF)
683 b->m.fd = vb->v4l2_planes[0].m.fd;
e23ccc0a
PO
684 }
685
ea42c8ec
MS
686 /*
687 * Clear any buffer state related flags.
688 */
1b18e7a0 689 b->flags &= ~V4L2_BUFFER_MASK_FLAGS;
7ce6fd8f
SA
690 b->flags |= q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK;
691 if ((q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) !=
692 V4L2_BUF_FLAG_TIMESTAMP_COPY) {
693 /*
694 * For non-COPY timestamps, drop timestamp source bits
695 * and obtain the timestamp source from the queue.
696 */
697 b->flags &= ~V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
698 b->flags |= q->timestamp_flags & V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
699 }
e23ccc0a
PO
700
701 switch (vb->state) {
702 case VB2_BUF_STATE_QUEUED:
703 case VB2_BUF_STATE_ACTIVE:
704 b->flags |= V4L2_BUF_FLAG_QUEUED;
705 break;
706 case VB2_BUF_STATE_ERROR:
707 b->flags |= V4L2_BUF_FLAG_ERROR;
708 /* fall through */
709 case VB2_BUF_STATE_DONE:
710 b->flags |= V4L2_BUF_FLAG_DONE;
711 break;
ebc087d0 712 case VB2_BUF_STATE_PREPARED:
2d86401c
GL
713 b->flags |= V4L2_BUF_FLAG_PREPARED;
714 break;
b18a8ff2 715 case VB2_BUF_STATE_PREPARING:
2d86401c 716 case VB2_BUF_STATE_DEQUEUED:
e23ccc0a
PO
717 /* nothing */
718 break;
719 }
720
25a27d91 721 if (__buffer_in_use(q, vb))
e23ccc0a 722 b->flags |= V4L2_BUF_FLAG_MAPPED;
e23ccc0a
PO
723}
724
725/**
726 * vb2_querybuf() - query video buffer information
727 * @q: videobuf queue
728 * @b: buffer struct passed from userspace to vidioc_querybuf handler
729 * in driver
730 *
731 * Should be called from vidioc_querybuf ioctl handler in driver.
732 * This function will verify the passed v4l2_buffer structure and fill the
733 * relevant information for the userspace.
734 *
735 * The return values from this function are intended to be directly returned
736 * from vidioc_querybuf handler in driver.
737 */
738int vb2_querybuf(struct vb2_queue *q, struct v4l2_buffer *b)
739{
740 struct vb2_buffer *vb;
32a77260 741 int ret;
e23ccc0a
PO
742
743 if (b->type != q->type) {
fd4354cf 744 dprintk(1, "wrong buffer type\n");
e23ccc0a
PO
745 return -EINVAL;
746 }
747
748 if (b->index >= q->num_buffers) {
fd4354cf 749 dprintk(1, "buffer index out of range\n");
e23ccc0a
PO
750 return -EINVAL;
751 }
752 vb = q->bufs[b->index];
32a77260
HV
753 ret = __verify_planes_array(vb, b);
754 if (!ret)
755 __fill_v4l2_buffer(vb, b);
756 return ret;
e23ccc0a
PO
757}
758EXPORT_SYMBOL(vb2_querybuf);
759
760/**
761 * __verify_userptr_ops() - verify that all memory operations required for
762 * USERPTR queue type have been provided
763 */
764static int __verify_userptr_ops(struct vb2_queue *q)
765{
766 if (!(q->io_modes & VB2_USERPTR) || !q->mem_ops->get_userptr ||
767 !q->mem_ops->put_userptr)
768 return -EINVAL;
769
770 return 0;
771}
772
773/**
774 * __verify_mmap_ops() - verify that all memory operations required for
775 * MMAP queue type have been provided
776 */
777static int __verify_mmap_ops(struct vb2_queue *q)
778{
779 if (!(q->io_modes & VB2_MMAP) || !q->mem_ops->alloc ||
780 !q->mem_ops->put || !q->mem_ops->mmap)
781 return -EINVAL;
782
783 return 0;
784}
785
c5384048
SS
786/**
787 * __verify_dmabuf_ops() - verify that all memory operations required for
788 * DMABUF queue type have been provided
789 */
790static int __verify_dmabuf_ops(struct vb2_queue *q)
791{
792 if (!(q->io_modes & VB2_DMABUF) || !q->mem_ops->attach_dmabuf ||
793 !q->mem_ops->detach_dmabuf || !q->mem_ops->map_dmabuf ||
794 !q->mem_ops->unmap_dmabuf)
795 return -EINVAL;
796
797 return 0;
798}
799
e23ccc0a 800/**
37d9ed94
HV
801 * __verify_memory_type() - Check whether the memory type and buffer type
802 * passed to a buffer operation are compatible with the queue.
803 */
804static int __verify_memory_type(struct vb2_queue *q,
805 enum v4l2_memory memory, enum v4l2_buf_type type)
806{
c5384048
SS
807 if (memory != V4L2_MEMORY_MMAP && memory != V4L2_MEMORY_USERPTR &&
808 memory != V4L2_MEMORY_DMABUF) {
fd4354cf 809 dprintk(1, "unsupported memory type\n");
37d9ed94
HV
810 return -EINVAL;
811 }
812
813 if (type != q->type) {
fd4354cf 814 dprintk(1, "requested type is incorrect\n");
37d9ed94
HV
815 return -EINVAL;
816 }
817
818 /*
819 * Make sure all the required memory ops for given memory type
820 * are available.
821 */
822 if (memory == V4L2_MEMORY_MMAP && __verify_mmap_ops(q)) {
fd4354cf 823 dprintk(1, "MMAP for current setup unsupported\n");
37d9ed94
HV
824 return -EINVAL;
825 }
826
827 if (memory == V4L2_MEMORY_USERPTR && __verify_userptr_ops(q)) {
fd4354cf 828 dprintk(1, "USERPTR for current setup unsupported\n");
37d9ed94
HV
829 return -EINVAL;
830 }
831
c5384048 832 if (memory == V4L2_MEMORY_DMABUF && __verify_dmabuf_ops(q)) {
fd4354cf 833 dprintk(1, "DMABUF for current setup unsupported\n");
c5384048
SS
834 return -EINVAL;
835 }
836
37d9ed94
HV
837 /*
838 * Place the busy tests at the end: -EBUSY can be ignored when
839 * create_bufs is called with count == 0, but count == 0 should still
840 * do the memory and type validation.
841 */
74753cff 842 if (vb2_fileio_is_active(q)) {
fd4354cf 843 dprintk(1, "file io in progress\n");
37d9ed94
HV
844 return -EBUSY;
845 }
846 return 0;
847}
848
849/**
850 * __reqbufs() - Initiate streaming
e23ccc0a
PO
851 * @q: videobuf2 queue
852 * @req: struct passed from userspace to vidioc_reqbufs handler in driver
853 *
854 * Should be called from vidioc_reqbufs ioctl handler of a driver.
855 * This function:
856 * 1) verifies streaming parameters passed from the userspace,
857 * 2) sets up the queue,
858 * 3) negotiates number of buffers and planes per buffer with the driver
859 * to be used during streaming,
860 * 4) allocates internal buffer structures (struct vb2_buffer), according to
861 * the agreed parameters,
862 * 5) for MMAP memory type, allocates actual video memory, using the
863 * memory handling/allocation routines provided during queue initialization
864 *
865 * If req->count is 0, all the memory will be freed instead.
866 * If the queue has been allocated previously (by a previous vb2_reqbufs) call
867 * and the queue is not busy, memory will be reallocated.
868 *
869 * The return values from this function are intended to be directly returned
870 * from vidioc_reqbufs handler in driver.
871 */
37d9ed94 872static int __reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req)
e23ccc0a 873{
2d86401c 874 unsigned int num_buffers, allocated_buffers, num_planes = 0;
37d9ed94 875 int ret;
e23ccc0a
PO
876
877 if (q->streaming) {
fd4354cf 878 dprintk(1, "streaming active\n");
e23ccc0a
PO
879 return -EBUSY;
880 }
881
29e3fbd8 882 if (req->count == 0 || q->num_buffers != 0 || q->memory != req->memory) {
e23ccc0a
PO
883 /*
884 * We already have buffers allocated, so first check if they
885 * are not in use and can be freed.
886 */
f035eb4e 887 mutex_lock(&q->mmap_lock);
e23ccc0a 888 if (q->memory == V4L2_MEMORY_MMAP && __buffers_in_use(q)) {
f035eb4e 889 mutex_unlock(&q->mmap_lock);
fd4354cf 890 dprintk(1, "memory in use, cannot free\n");
e23ccc0a
PO
891 return -EBUSY;
892 }
893
fb64dca8
HV
894 /*
895 * Call queue_cancel to clean up any buffers in the PREPARED or
896 * QUEUED state which is possible if buffers were prepared or
897 * queued without ever calling STREAMON.
898 */
899 __vb2_queue_cancel(q);
63faabfd 900 ret = __vb2_queue_free(q, q->num_buffers);
f035eb4e 901 mutex_unlock(&q->mmap_lock);
63faabfd
HV
902 if (ret)
903 return ret;
29e3fbd8
MS
904
905 /*
906 * In case of REQBUFS(0) return immediately without calling
907 * driver's queue_setup() callback and allocating resources.
908 */
909 if (req->count == 0)
910 return 0;
e23ccc0a
PO
911 }
912
913 /*
914 * Make sure the requested values and current defaults are sane.
915 */
916 num_buffers = min_t(unsigned int, req->count, VIDEO_MAX_FRAME);
4cf743de 917 num_buffers = max_t(unsigned int, num_buffers, q->min_buffers_needed);
c1426bc7 918 memset(q->plane_sizes, 0, sizeof(q->plane_sizes));
e23ccc0a 919 memset(q->alloc_ctx, 0, sizeof(q->alloc_ctx));
13b14095 920 q->memory = req->memory;
e23ccc0a
PO
921
922 /*
923 * Ask the driver how many buffers and planes per buffer it requires.
924 * Driver also sets the size and allocator context for each plane.
925 */
fc714e70 926 ret = call_qop(q, queue_setup, q, NULL, &num_buffers, &num_planes,
c1426bc7 927 q->plane_sizes, q->alloc_ctx);
a1d36d8c 928 if (ret)
e23ccc0a
PO
929 return ret;
930
931 /* Finally, allocate buffers and video memory */
a7afcacc
HV
932 allocated_buffers = __vb2_queue_alloc(q, req->memory, num_buffers, num_planes);
933 if (allocated_buffers == 0) {
3050040b 934 dprintk(1, "memory allocation failed\n");
66072d4f 935 return -ENOMEM;
e23ccc0a
PO
936 }
937
b3379c62
HV
938 /*
939 * There is no point in continuing if we can't allocate the minimum
940 * number of buffers needed by this vb2_queue.
941 */
942 if (allocated_buffers < q->min_buffers_needed)
943 ret = -ENOMEM;
944
e23ccc0a
PO
945 /*
946 * Check if driver can handle the allocated number of buffers.
947 */
b3379c62 948 if (!ret && allocated_buffers < num_buffers) {
2d86401c 949 num_buffers = allocated_buffers;
e23ccc0a 950
fc714e70
GL
951 ret = call_qop(q, queue_setup, q, NULL, &num_buffers,
952 &num_planes, q->plane_sizes, q->alloc_ctx);
e23ccc0a 953
2d86401c 954 if (!ret && allocated_buffers < num_buffers)
e23ccc0a 955 ret = -ENOMEM;
e23ccc0a
PO
956
957 /*
2d86401c
GL
958 * Either the driver has accepted a smaller number of buffers,
959 * or .queue_setup() returned an error
e23ccc0a 960 */
2d86401c
GL
961 }
962
f035eb4e 963 mutex_lock(&q->mmap_lock);
2d86401c
GL
964 q->num_buffers = allocated_buffers;
965
966 if (ret < 0) {
a7afcacc
HV
967 /*
968 * Note: __vb2_queue_free() will subtract 'allocated_buffers'
969 * from q->num_buffers.
970 */
2d86401c 971 __vb2_queue_free(q, allocated_buffers);
f035eb4e 972 mutex_unlock(&q->mmap_lock);
2d86401c 973 return ret;
e23ccc0a 974 }
f035eb4e 975 mutex_unlock(&q->mmap_lock);
e23ccc0a 976
e23ccc0a
PO
977 /*
978 * Return the number of successfully allocated buffers
979 * to the userspace.
980 */
2d86401c 981 req->count = allocated_buffers;
58d75f4b 982 q->waiting_for_buffers = !V4L2_TYPE_IS_OUTPUT(q->type);
e23ccc0a
PO
983
984 return 0;
e23ccc0a 985}
37d9ed94
HV
986
987/**
988 * vb2_reqbufs() - Wrapper for __reqbufs() that also verifies the memory and
989 * type values.
990 * @q: videobuf2 queue
991 * @req: struct passed from userspace to vidioc_reqbufs handler in driver
992 */
993int vb2_reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req)
994{
995 int ret = __verify_memory_type(q, req->memory, req->type);
996
997 return ret ? ret : __reqbufs(q, req);
998}
e23ccc0a
PO
999EXPORT_SYMBOL_GPL(vb2_reqbufs);
1000
2d86401c 1001/**
37d9ed94 1002 * __create_bufs() - Allocate buffers and any required auxiliary structs
2d86401c
GL
1003 * @q: videobuf2 queue
1004 * @create: creation parameters, passed from userspace to vidioc_create_bufs
1005 * handler in driver
1006 *
1007 * Should be called from vidioc_create_bufs ioctl handler of a driver.
1008 * This function:
1009 * 1) verifies parameter sanity
1010 * 2) calls the .queue_setup() queue operation
1011 * 3) performs any necessary memory allocations
1012 *
1013 * The return values from this function are intended to be directly returned
1014 * from vidioc_create_bufs handler in driver.
1015 */
37d9ed94 1016static int __create_bufs(struct vb2_queue *q, struct v4l2_create_buffers *create)
2d86401c
GL
1017{
1018 unsigned int num_planes = 0, num_buffers, allocated_buffers;
37d9ed94 1019 int ret;
2d86401c
GL
1020
1021 if (q->num_buffers == VIDEO_MAX_FRAME) {
fd4354cf 1022 dprintk(1, "maximum number of buffers already allocated\n");
2d86401c
GL
1023 return -ENOBUFS;
1024 }
1025
2d86401c
GL
1026 if (!q->num_buffers) {
1027 memset(q->plane_sizes, 0, sizeof(q->plane_sizes));
1028 memset(q->alloc_ctx, 0, sizeof(q->alloc_ctx));
1029 q->memory = create->memory;
58d75f4b 1030 q->waiting_for_buffers = !V4L2_TYPE_IS_OUTPUT(q->type);
2d86401c
GL
1031 }
1032
1033 num_buffers = min(create->count, VIDEO_MAX_FRAME - q->num_buffers);
1034
1035 /*
1036 * Ask the driver, whether the requested number of buffers, planes per
1037 * buffer and their sizes are acceptable
1038 */
1039 ret = call_qop(q, queue_setup, q, &create->format, &num_buffers,
1040 &num_planes, q->plane_sizes, q->alloc_ctx);
a1d36d8c 1041 if (ret)
2d86401c
GL
1042 return ret;
1043
1044 /* Finally, allocate buffers and video memory */
a7afcacc 1045 allocated_buffers = __vb2_queue_alloc(q, create->memory, num_buffers,
2d86401c 1046 num_planes);
a7afcacc 1047 if (allocated_buffers == 0) {
3050040b 1048 dprintk(1, "memory allocation failed\n");
f05393d2 1049 return -ENOMEM;
2d86401c
GL
1050 }
1051
2d86401c
GL
1052 /*
1053 * Check if driver can handle the so far allocated number of buffers.
1054 */
a7afcacc
HV
1055 if (allocated_buffers < num_buffers) {
1056 num_buffers = allocated_buffers;
2d86401c
GL
1057
1058 /*
1059 * q->num_buffers contains the total number of buffers, that the
1060 * queue driver has set up
1061 */
1062 ret = call_qop(q, queue_setup, q, &create->format, &num_buffers,
1063 &num_planes, q->plane_sizes, q->alloc_ctx);
1064
1065 if (!ret && allocated_buffers < num_buffers)
1066 ret = -ENOMEM;
1067
1068 /*
1069 * Either the driver has accepted a smaller number of buffers,
1070 * or .queue_setup() returned an error
1071 */
1072 }
1073
f035eb4e 1074 mutex_lock(&q->mmap_lock);
2d86401c
GL
1075 q->num_buffers += allocated_buffers;
1076
1077 if (ret < 0) {
a7afcacc
HV
1078 /*
1079 * Note: __vb2_queue_free() will subtract 'allocated_buffers'
1080 * from q->num_buffers.
1081 */
2d86401c 1082 __vb2_queue_free(q, allocated_buffers);
f035eb4e 1083 mutex_unlock(&q->mmap_lock);
f05393d2 1084 return -ENOMEM;
2d86401c 1085 }
f035eb4e 1086 mutex_unlock(&q->mmap_lock);
2d86401c
GL
1087
1088 /*
1089 * Return the number of successfully allocated buffers
1090 * to the userspace.
1091 */
1092 create->count = allocated_buffers;
1093
1094 return 0;
1095}
37d9ed94
HV
1096
1097/**
53aa3b19
NT
1098 * vb2_create_bufs() - Wrapper for __create_bufs() that also verifies the
1099 * memory and type values.
37d9ed94
HV
1100 * @q: videobuf2 queue
1101 * @create: creation parameters, passed from userspace to vidioc_create_bufs
1102 * handler in driver
1103 */
1104int vb2_create_bufs(struct vb2_queue *q, struct v4l2_create_buffers *create)
1105{
1106 int ret = __verify_memory_type(q, create->memory, create->format.type);
1107
1108 create->index = q->num_buffers;
f05393d2
HV
1109 if (create->count == 0)
1110 return ret != -EBUSY ? ret : 0;
37d9ed94
HV
1111 return ret ? ret : __create_bufs(q, create);
1112}
2d86401c
GL
1113EXPORT_SYMBOL_GPL(vb2_create_bufs);
1114
e23ccc0a
PO
1115/**
1116 * vb2_plane_vaddr() - Return a kernel virtual address of a given plane
1117 * @vb: vb2_buffer to which the plane in question belongs to
1118 * @plane_no: plane number for which the address is to be returned
1119 *
1120 * This function returns a kernel virtual address of a given plane if
1121 * such a mapping exist, NULL otherwise.
1122 */
1123void *vb2_plane_vaddr(struct vb2_buffer *vb, unsigned int plane_no)
1124{
a00d0266 1125 if (plane_no > vb->num_planes || !vb->planes[plane_no].mem_priv)
e23ccc0a
PO
1126 return NULL;
1127
a1d36d8c 1128 return call_ptr_memop(vb, vaddr, vb->planes[plane_no].mem_priv);
e23ccc0a
PO
1129
1130}
1131EXPORT_SYMBOL_GPL(vb2_plane_vaddr);
1132
1133/**
1134 * vb2_plane_cookie() - Return allocator specific cookie for the given plane
1135 * @vb: vb2_buffer to which the plane in question belongs to
1136 * @plane_no: plane number for which the cookie is to be returned
1137 *
1138 * This function returns an allocator specific cookie for a given plane if
1139 * available, NULL otherwise. The allocator should provide some simple static
1140 * inline function, which would convert this cookie to the allocator specific
1141 * type that can be used directly by the driver to access the buffer. This can
1142 * be for example physical address, pointer to scatter list or IOMMU mapping.
1143 */
1144void *vb2_plane_cookie(struct vb2_buffer *vb, unsigned int plane_no)
1145{
a9ae4692 1146 if (plane_no >= vb->num_planes || !vb->planes[plane_no].mem_priv)
e23ccc0a
PO
1147 return NULL;
1148
a1d36d8c 1149 return call_ptr_memop(vb, cookie, vb->planes[plane_no].mem_priv);
e23ccc0a
PO
1150}
1151EXPORT_SYMBOL_GPL(vb2_plane_cookie);
1152
1153/**
1154 * vb2_buffer_done() - inform videobuf that an operation on a buffer is finished
1155 * @vb: vb2_buffer returned from the driver
1156 * @state: either VB2_BUF_STATE_DONE if the operation finished successfully
b3379c62
HV
1157 * or VB2_BUF_STATE_ERROR if the operation finished with an error.
1158 * If start_streaming fails then it should return buffers with state
1159 * VB2_BUF_STATE_QUEUED to put them back into the queue.
e23ccc0a
PO
1160 *
1161 * This function should be called by the driver after a hardware operation on
1162 * a buffer is finished and the buffer may be returned to userspace. The driver
1163 * cannot use this buffer anymore until it is queued back to it by videobuf
1164 * by the means of buf_queue callback. Only buffers previously queued to the
1165 * driver by buf_queue can be passed to this function.
b3379c62
HV
1166 *
1167 * While streaming a buffer can only be returned in state DONE or ERROR.
1168 * The start_streaming op can also return them in case the DMA engine cannot
1169 * be started for some reason. In that case the buffers should be returned with
1170 * state QUEUED.
e23ccc0a
PO
1171 */
1172void vb2_buffer_done(struct vb2_buffer *vb, enum vb2_buffer_state state)
1173{
1174 struct vb2_queue *q = vb->vb2_queue;
1175 unsigned long flags;
3e0c2f20 1176 unsigned int plane;
e23ccc0a 1177
b3379c62 1178 if (WARN_ON(vb->state != VB2_BUF_STATE_ACTIVE))
e23ccc0a
PO
1179 return;
1180
bf3593d9
HV
1181 if (WARN_ON(state != VB2_BUF_STATE_DONE &&
1182 state != VB2_BUF_STATE_ERROR &&
1183 state != VB2_BUF_STATE_QUEUED))
1184 state = VB2_BUF_STATE_ERROR;
e23ccc0a 1185
b5b4541e
HV
1186#ifdef CONFIG_VIDEO_ADV_DEBUG
1187 /*
1188 * Although this is not a callback, it still does have to balance
1189 * with the buf_queue op. So update this counter manually.
1190 */
1191 vb->cnt_buf_done++;
1192#endif
3050040b 1193 dprintk(4, "done processing on buffer %d, state: %d\n",
9b6f5dc0 1194 vb->v4l2_buf.index, state);
e23ccc0a 1195
3e0c2f20
MS
1196 /* sync buffers */
1197 for (plane = 0; plane < vb->num_planes; ++plane)
a1d36d8c 1198 call_void_memop(vb, finish, vb->planes[plane].mem_priv);
3e0c2f20 1199
e23ccc0a
PO
1200 /* Add the buffer to the done buffers list */
1201 spin_lock_irqsave(&q->done_lock, flags);
1202 vb->state = state;
b3379c62
HV
1203 if (state != VB2_BUF_STATE_QUEUED)
1204 list_add_tail(&vb->done_entry, &q->done_list);
6ea3b980 1205 atomic_dec(&q->owned_by_drv_count);
e23ccc0a
PO
1206 spin_unlock_irqrestore(&q->done_lock, flags);
1207
b3379c62
HV
1208 if (state == VB2_BUF_STATE_QUEUED)
1209 return;
1210
e23ccc0a
PO
1211 /* Inform any processes that may be waiting for buffers */
1212 wake_up(&q->done_wq);
1213}
1214EXPORT_SYMBOL_GPL(vb2_buffer_done);
1215
34ea4d44
LP
1216/**
1217 * vb2_discard_done() - discard all buffers marked as DONE
1218 * @q: videobuf2 queue
1219 *
1220 * This function is intended to be used with suspend/resume operations. It
1221 * discards all 'done' buffers as they would be too old to be requested after
1222 * resume.
1223 *
1224 * Drivers must stop the hardware and synchronize with interrupt handlers and/or
1225 * delayed works before calling this function to make sure no buffer will be
1226 * touched by the driver and/or hardware.
1227 */
1228void vb2_discard_done(struct vb2_queue *q)
1229{
1230 struct vb2_buffer *vb;
1231 unsigned long flags;
1232
1233 spin_lock_irqsave(&q->done_lock, flags);
1234 list_for_each_entry(vb, &q->done_list, done_entry)
1235 vb->state = VB2_BUF_STATE_ERROR;
1236 spin_unlock_irqrestore(&q->done_lock, flags);
1237}
1238EXPORT_SYMBOL_GPL(vb2_discard_done);
1239
e23ccc0a 1240/**
32a77260
HV
1241 * __fill_vb2_buffer() - fill a vb2_buffer with information provided in a
1242 * v4l2_buffer by the userspace. The caller has already verified that struct
1243 * v4l2_buffer has a valid number of planes.
e23ccc0a 1244 */
32a77260 1245static void __fill_vb2_buffer(struct vb2_buffer *vb, const struct v4l2_buffer *b,
e23ccc0a
PO
1246 struct v4l2_plane *v4l2_planes)
1247{
1248 unsigned int plane;
e23ccc0a 1249
f61bf13b
KD
1250 if (V4L2_TYPE_IS_OUTPUT(b->type)) {
1251 if (WARN_ON_ONCE(b->bytesused == 0)) {
1252 pr_warn_once("use of bytesused == 0 is deprecated and will be removed in the future,\n");
1253 if (vb->vb2_queue->allow_zero_bytesused)
1254 pr_warn_once("use VIDIOC_DECODER_CMD(V4L2_DEC_CMD_STOP) instead.\n");
1255 else
1256 pr_warn_once("use the actual size instead.\n");
1257 }
1258 }
1259
e23ccc0a 1260 if (V4L2_TYPE_IS_MULTIPLANAR(b->type)) {
e23ccc0a
PO
1261 if (b->memory == V4L2_MEMORY_USERPTR) {
1262 for (plane = 0; plane < vb->num_planes; ++plane) {
1263 v4l2_planes[plane].m.userptr =
1264 b->m.planes[plane].m.userptr;
1265 v4l2_planes[plane].length =
1266 b->m.planes[plane].length;
1267 }
1268 }
c5384048
SS
1269 if (b->memory == V4L2_MEMORY_DMABUF) {
1270 for (plane = 0; plane < vb->num_planes; ++plane) {
1271 v4l2_planes[plane].m.fd =
1272 b->m.planes[plane].m.fd;
1273 v4l2_planes[plane].length =
1274 b->m.planes[plane].length;
c5384048
SS
1275 }
1276 }
8a75ffb8
HV
1277
1278 /* Fill in driver-provided information for OUTPUT types */
1279 if (V4L2_TYPE_IS_OUTPUT(b->type)) {
1280 /*
1281 * Will have to go up to b->length when API starts
1282 * accepting variable number of planes.
1283 *
1284 * If bytesused == 0 for the output buffer, then fall
1285 * back to the full buffer size. In that case
1286 * userspace clearly never bothered to set it and
1287 * it's a safe assumption that they really meant to
1288 * use the full plane sizes.
f61bf13b
KD
1289 *
1290 * Some drivers, e.g. old codec drivers, use bytesused == 0
1291 * as a way to indicate that streaming is finished.
1292 * In that case, the driver should use the
1293 * allow_zero_bytesused flag to keep old userspace
1294 * applications working.
8a75ffb8
HV
1295 */
1296 for (plane = 0; plane < vb->num_planes; ++plane) {
1297 struct v4l2_plane *pdst = &v4l2_planes[plane];
1298 struct v4l2_plane *psrc = &b->m.planes[plane];
1299
f61bf13b
KD
1300 if (vb->vb2_queue->allow_zero_bytesused)
1301 pdst->bytesused = psrc->bytesused;
1302 else
1303 pdst->bytesused = psrc->bytesused ?
1304 psrc->bytesused : pdst->length;
8a75ffb8
HV
1305 pdst->data_offset = psrc->data_offset;
1306 }
1307 }
e23ccc0a
PO
1308 } else {
1309 /*
1310 * Single-planar buffers do not use planes array,
1311 * so fill in relevant v4l2_buffer struct fields instead.
1312 * In videobuf we use our internal V4l2_planes struct for
1313 * single-planar buffers as well, for simplicity.
61bd8fb3 1314 *
8a75ffb8
HV
1315 * If bytesused == 0 for the output buffer, then fall back
1316 * to the full buffer size as that's a sensible default.
f61bf13b
KD
1317 *
1318 * Some drivers, e.g. old codec drivers, use bytesused == 0 as
1319 * a way to indicate that streaming is finished. In that case,
1320 * the driver should use the allow_zero_bytesused flag to keep
1321 * old userspace applications working.
e23ccc0a 1322 */
e23ccc0a
PO
1323 if (b->memory == V4L2_MEMORY_USERPTR) {
1324 v4l2_planes[0].m.userptr = b->m.userptr;
1325 v4l2_planes[0].length = b->length;
1326 }
c5384048
SS
1327
1328 if (b->memory == V4L2_MEMORY_DMABUF) {
1329 v4l2_planes[0].m.fd = b->m.fd;
1330 v4l2_planes[0].length = b->length;
c5384048 1331 }
8a75ffb8 1332
f61bf13b
KD
1333 if (V4L2_TYPE_IS_OUTPUT(b->type)) {
1334 if (vb->vb2_queue->allow_zero_bytesused)
1335 v4l2_planes[0].bytesused = b->bytesused;
1336 else
1337 v4l2_planes[0].bytesused = b->bytesused ?
1338 b->bytesused : v4l2_planes[0].length;
1339 } else
8a75ffb8
HV
1340 v4l2_planes[0].bytesused = 0;
1341
e23ccc0a
PO
1342 }
1343
f1343281 1344 /* Zero flags that the vb2 core handles */
1b18e7a0 1345 vb->v4l2_buf.flags = b->flags & ~V4L2_BUFFER_MASK_FLAGS;
7ce6fd8f
SA
1346 if ((vb->vb2_queue->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) !=
1347 V4L2_BUF_FLAG_TIMESTAMP_COPY || !V4L2_TYPE_IS_OUTPUT(b->type)) {
1348 /*
1349 * Non-COPY timestamps and non-OUTPUT queues will get
1350 * their timestamp and timestamp source flags from the
1351 * queue.
1352 */
1353 vb->v4l2_buf.flags &= ~V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
1354 }
1355
f1343281
HV
1356 if (V4L2_TYPE_IS_OUTPUT(b->type)) {
1357 /*
1358 * For output buffers mask out the timecode flag:
1359 * this will be handled later in vb2_internal_qbuf().
1360 * The 'field' is valid metadata for this output buffer
1361 * and so that needs to be copied here.
1362 */
1363 vb->v4l2_buf.flags &= ~V4L2_BUF_FLAG_TIMECODE;
1364 vb->v4l2_buf.field = b->field;
1365 } else {
1366 /* Zero any output buffer flags as this is a capture buffer */
1367 vb->v4l2_buf.flags &= ~V4L2_BUFFER_OUT_FLAGS;
1368 }
e23ccc0a
PO
1369}
1370
dcc2428a
HV
1371/**
1372 * __qbuf_mmap() - handle qbuf of an MMAP buffer
1373 */
1374static int __qbuf_mmap(struct vb2_buffer *vb, const struct v4l2_buffer *b)
1375{
1376 __fill_vb2_buffer(vb, b, vb->v4l2_planes);
1377 return call_vb_qop(vb, buf_prepare, vb);
1378}
1379
e23ccc0a
PO
1380/**
1381 * __qbuf_userptr() - handle qbuf of a USERPTR buffer
1382 */
2d86401c 1383static int __qbuf_userptr(struct vb2_buffer *vb, const struct v4l2_buffer *b)
e23ccc0a
PO
1384{
1385 struct v4l2_plane planes[VIDEO_MAX_PLANES];
1386 struct vb2_queue *q = vb->vb2_queue;
1387 void *mem_priv;
1388 unsigned int plane;
1389 int ret;
cd474037
HV
1390 enum dma_data_direction dma_dir =
1391 V4L2_TYPE_IS_OUTPUT(q->type) ? DMA_TO_DEVICE : DMA_FROM_DEVICE;
256f3162 1392 bool reacquired = vb->planes[0].mem_priv == NULL;
e23ccc0a 1393
412376a1 1394 memset(planes, 0, sizeof(planes[0]) * vb->num_planes);
32a77260
HV
1395 /* Copy relevant information provided by the userspace */
1396 __fill_vb2_buffer(vb, b, planes);
e23ccc0a
PO
1397
1398 for (plane = 0; plane < vb->num_planes; ++plane) {
1399 /* Skip the plane if already verified */
f0b7c7fc
MS
1400 if (vb->v4l2_planes[plane].m.userptr &&
1401 vb->v4l2_planes[plane].m.userptr == planes[plane].m.userptr
e23ccc0a
PO
1402 && vb->v4l2_planes[plane].length == planes[plane].length)
1403 continue;
1404
fd4354cf 1405 dprintk(3, "userspace address for plane %d changed, "
e23ccc0a
PO
1406 "reacquiring memory\n", plane);
1407
c1426bc7
MS
1408 /* Check if the provided plane buffer is large enough */
1409 if (planes[plane].length < q->plane_sizes[plane]) {
fd4354cf 1410 dprintk(1, "provided buffer size %u is less than "
2484a7e2
SWK
1411 "setup size %u for plane %d\n",
1412 planes[plane].length,
1413 q->plane_sizes[plane], plane);
4c2625db 1414 ret = -EINVAL;
c1426bc7
MS
1415 goto err;
1416 }
1417
e23ccc0a 1418 /* Release previously acquired memory if present */
256f3162
HV
1419 if (vb->planes[plane].mem_priv) {
1420 if (!reacquired) {
1421 reacquired = true;
a1d36d8c 1422 call_void_vb_qop(vb, buf_cleanup, vb);
256f3162 1423 }
a1d36d8c 1424 call_void_memop(vb, put_userptr, vb->planes[plane].mem_priv);
256f3162 1425 }
e23ccc0a
PO
1426
1427 vb->planes[plane].mem_priv = NULL;
256f3162 1428 memset(&vb->v4l2_planes[plane], 0, sizeof(struct v4l2_plane));
e23ccc0a
PO
1429
1430 /* Acquire each plane's memory */
a1d36d8c 1431 mem_priv = call_ptr_memop(vb, get_userptr, q->alloc_ctx[plane],
a00d0266 1432 planes[plane].m.userptr,
cd474037 1433 planes[plane].length, dma_dir);
a00d0266 1434 if (IS_ERR_OR_NULL(mem_priv)) {
fd4354cf 1435 dprintk(1, "failed acquiring userspace "
e23ccc0a 1436 "memory for plane %d\n", plane);
a00d0266
MS
1437 ret = mem_priv ? PTR_ERR(mem_priv) : -EINVAL;
1438 goto err;
e23ccc0a 1439 }
a00d0266 1440 vb->planes[plane].mem_priv = mem_priv;
e23ccc0a
PO
1441 }
1442
e23ccc0a
PO
1443 /*
1444 * Now that everything is in order, copy relevant information
1445 * provided by userspace.
1446 */
1447 for (plane = 0; plane < vb->num_planes; ++plane)
1448 vb->v4l2_planes[plane] = planes[plane];
1449
256f3162
HV
1450 if (reacquired) {
1451 /*
1452 * One or more planes changed, so we must call buf_init to do
1453 * the driver-specific initialization on the newly acquired
1454 * buffer, if provided.
1455 */
1456 ret = call_vb_qop(vb, buf_init, vb);
1457 if (ret) {
fd4354cf 1458 dprintk(1, "buffer initialization failed\n");
256f3162
HV
1459 goto err;
1460 }
1461 }
1462
1463 ret = call_vb_qop(vb, buf_prepare, vb);
1464 if (ret) {
fd4354cf 1465 dprintk(1, "buffer preparation failed\n");
a1d36d8c 1466 call_void_vb_qop(vb, buf_cleanup, vb);
256f3162
HV
1467 goto err;
1468 }
1469
e23ccc0a
PO
1470 return 0;
1471err:
1472 /* In case of errors, release planes that were already acquired */
c1426bc7
MS
1473 for (plane = 0; plane < vb->num_planes; ++plane) {
1474 if (vb->planes[plane].mem_priv)
a1d36d8c 1475 call_void_memop(vb, put_userptr, vb->planes[plane].mem_priv);
c1426bc7
MS
1476 vb->planes[plane].mem_priv = NULL;
1477 vb->v4l2_planes[plane].m.userptr = 0;
1478 vb->v4l2_planes[plane].length = 0;
e23ccc0a
PO
1479 }
1480
1481 return ret;
1482}
1483
c5384048
SS
1484/**
1485 * __qbuf_dmabuf() - handle qbuf of a DMABUF buffer
1486 */
1487static int __qbuf_dmabuf(struct vb2_buffer *vb, const struct v4l2_buffer *b)
1488{
1489 struct v4l2_plane planes[VIDEO_MAX_PLANES];
1490 struct vb2_queue *q = vb->vb2_queue;
1491 void *mem_priv;
1492 unsigned int plane;
1493 int ret;
cd474037
HV
1494 enum dma_data_direction dma_dir =
1495 V4L2_TYPE_IS_OUTPUT(q->type) ? DMA_TO_DEVICE : DMA_FROM_DEVICE;
256f3162 1496 bool reacquired = vb->planes[0].mem_priv == NULL;
c5384048 1497
412376a1 1498 memset(planes, 0, sizeof(planes[0]) * vb->num_planes);
6f546c5f 1499 /* Copy relevant information provided by the userspace */
c5384048
SS
1500 __fill_vb2_buffer(vb, b, planes);
1501
1502 for (plane = 0; plane < vb->num_planes; ++plane) {
1503 struct dma_buf *dbuf = dma_buf_get(planes[plane].m.fd);
1504
1505 if (IS_ERR_OR_NULL(dbuf)) {
fd4354cf 1506 dprintk(1, "invalid dmabuf fd for plane %d\n",
c5384048
SS
1507 plane);
1508 ret = -EINVAL;
1509 goto err;
1510 }
1511
1512 /* use DMABUF size if length is not provided */
1513 if (planes[plane].length == 0)
1514 planes[plane].length = dbuf->size;
1515
412376a1 1516 if (planes[plane].length < q->plane_sizes[plane]) {
fd4354cf 1517 dprintk(1, "invalid dmabuf length for plane %d\n",
77c0782e 1518 plane);
c5384048
SS
1519 ret = -EINVAL;
1520 goto err;
1521 }
1522
1523 /* Skip the plane if already verified */
1524 if (dbuf == vb->planes[plane].dbuf &&
1525 vb->v4l2_planes[plane].length == planes[plane].length) {
1526 dma_buf_put(dbuf);
1527 continue;
1528 }
1529
fd4354cf 1530 dprintk(1, "buffer for plane %d changed\n", plane);
c5384048 1531
256f3162
HV
1532 if (!reacquired) {
1533 reacquired = true;
a1d36d8c 1534 call_void_vb_qop(vb, buf_cleanup, vb);
256f3162
HV
1535 }
1536
c5384048 1537 /* Release previously acquired memory if present */
b5b4541e 1538 __vb2_plane_dmabuf_put(vb, &vb->planes[plane]);
c5384048
SS
1539 memset(&vb->v4l2_planes[plane], 0, sizeof(struct v4l2_plane));
1540
1541 /* Acquire each plane's memory */
a1d36d8c 1542 mem_priv = call_ptr_memop(vb, attach_dmabuf, q->alloc_ctx[plane],
cd474037 1543 dbuf, planes[plane].length, dma_dir);
c5384048 1544 if (IS_ERR(mem_priv)) {
fd4354cf 1545 dprintk(1, "failed to attach dmabuf\n");
c5384048
SS
1546 ret = PTR_ERR(mem_priv);
1547 dma_buf_put(dbuf);
1548 goto err;
1549 }
1550
1551 vb->planes[plane].dbuf = dbuf;
1552 vb->planes[plane].mem_priv = mem_priv;
1553 }
1554
1555 /* TODO: This pins the buffer(s) with dma_buf_map_attachment()).. but
1556 * really we want to do this just before the DMA, not while queueing
1557 * the buffer(s)..
1558 */
1559 for (plane = 0; plane < vb->num_planes; ++plane) {
b5b4541e 1560 ret = call_memop(vb, map_dmabuf, vb->planes[plane].mem_priv);
c5384048 1561 if (ret) {
fd4354cf 1562 dprintk(1, "failed to map dmabuf for plane %d\n",
c5384048
SS
1563 plane);
1564 goto err;
1565 }
1566 vb->planes[plane].dbuf_mapped = 1;
1567 }
1568
c5384048
SS
1569 /*
1570 * Now that everything is in order, copy relevant information
1571 * provided by userspace.
1572 */
1573 for (plane = 0; plane < vb->num_planes; ++plane)
1574 vb->v4l2_planes[plane] = planes[plane];
1575
256f3162
HV
1576 if (reacquired) {
1577 /*
1578 * Call driver-specific initialization on the newly acquired buffer,
1579 * if provided.
1580 */
1581 ret = call_vb_qop(vb, buf_init, vb);
1582 if (ret) {
fd4354cf 1583 dprintk(1, "buffer initialization failed\n");
256f3162
HV
1584 goto err;
1585 }
1586 }
1587
1588 ret = call_vb_qop(vb, buf_prepare, vb);
1589 if (ret) {
fd4354cf 1590 dprintk(1, "buffer preparation failed\n");
a1d36d8c 1591 call_void_vb_qop(vb, buf_cleanup, vb);
256f3162
HV
1592 goto err;
1593 }
1594
c5384048
SS
1595 return 0;
1596err:
1597 /* In case of errors, release planes that were already acquired */
1598 __vb2_buf_dmabuf_put(vb);
1599
1600 return ret;
1601}
1602
e23ccc0a
PO
1603/**
1604 * __enqueue_in_driver() - enqueue a vb2_buffer in driver for processing
1605 */
1606static void __enqueue_in_driver(struct vb2_buffer *vb)
1607{
1608 struct vb2_queue *q = vb->vb2_queue;
3e0c2f20 1609 unsigned int plane;
e23ccc0a
PO
1610
1611 vb->state = VB2_BUF_STATE_ACTIVE;
6ea3b980 1612 atomic_inc(&q->owned_by_drv_count);
3e0c2f20
MS
1613
1614 /* sync buffers */
1615 for (plane = 0; plane < vb->num_planes; ++plane)
a1d36d8c 1616 call_void_memop(vb, prepare, vb->planes[plane].mem_priv);
3e0c2f20 1617
a1d36d8c 1618 call_void_vb_qop(vb, buf_queue, vb);
e23ccc0a
PO
1619}
1620
2d86401c 1621static int __buf_prepare(struct vb2_buffer *vb, const struct v4l2_buffer *b)
ebc087d0
GL
1622{
1623 struct vb2_queue *q = vb->vb2_queue;
1624 int ret;
1625
8023ed09 1626 ret = __verify_length(vb, b);
3a9621b0 1627 if (ret < 0) {
fd4354cf 1628 dprintk(1, "plane parameters verification failed: %d\n", ret);
8023ed09 1629 return ret;
3a9621b0 1630 }
e35e41b5
HV
1631 if (b->field == V4L2_FIELD_ALTERNATE && V4L2_TYPE_IS_OUTPUT(q->type)) {
1632 /*
1633 * If the format's field is ALTERNATE, then the buffer's field
1634 * should be either TOP or BOTTOM, not ALTERNATE since that
1635 * makes no sense. The driver has to know whether the
1636 * buffer represents a top or a bottom field in order to
1637 * program any DMA correctly. Using ALTERNATE is wrong, since
1638 * that just says that it is either a top or a bottom field,
1639 * but not which of the two it is.
1640 */
1641 dprintk(1, "the field is incorrectly set to ALTERNATE for an output buffer\n");
1642 return -EINVAL;
1643 }
8023ed09 1644
4bb7267d
LP
1645 if (q->error) {
1646 dprintk(1, "fatal error occurred on queue\n");
1647 return -EIO;
1648 }
1649
b18a8ff2 1650 vb->state = VB2_BUF_STATE_PREPARING;
f1343281
HV
1651 vb->v4l2_buf.timestamp.tv_sec = 0;
1652 vb->v4l2_buf.timestamp.tv_usec = 0;
1653 vb->v4l2_buf.sequence = 0;
1654
ebc087d0
GL
1655 switch (q->memory) {
1656 case V4L2_MEMORY_MMAP:
1657 ret = __qbuf_mmap(vb, b);
1658 break;
1659 case V4L2_MEMORY_USERPTR:
1660 ret = __qbuf_userptr(vb, b);
1661 break;
c5384048
SS
1662 case V4L2_MEMORY_DMABUF:
1663 ret = __qbuf_dmabuf(vb, b);
1664 break;
ebc087d0
GL
1665 default:
1666 WARN(1, "Invalid queue type\n");
1667 ret = -EINVAL;
1668 }
1669
ebc087d0 1670 if (ret)
fd4354cf 1671 dprintk(1, "buffer preparation failed: %d\n", ret);
b18a8ff2 1672 vb->state = ret ? VB2_BUF_STATE_DEQUEUED : VB2_BUF_STATE_PREPARED;
ebc087d0
GL
1673
1674 return ret;
1675}
1676
012043b8 1677static int vb2_queue_or_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b,
4138111a 1678 const char *opname)
2d86401c 1679{
2d86401c 1680 if (b->type != q->type) {
fd4354cf 1681 dprintk(1, "%s: invalid buffer type\n", opname);
b18a8ff2 1682 return -EINVAL;
2d86401c
GL
1683 }
1684
1685 if (b->index >= q->num_buffers) {
fd4354cf 1686 dprintk(1, "%s: buffer index out of range\n", opname);
b18a8ff2 1687 return -EINVAL;
2d86401c
GL
1688 }
1689
4138111a 1690 if (q->bufs[b->index] == NULL) {
2d86401c 1691 /* Should never happen */
fd4354cf 1692 dprintk(1, "%s: buffer is NULL\n", opname);
b18a8ff2 1693 return -EINVAL;
2d86401c
GL
1694 }
1695
1696 if (b->memory != q->memory) {
fd4354cf 1697 dprintk(1, "%s: invalid memory type\n", opname);
b18a8ff2 1698 return -EINVAL;
2d86401c
GL
1699 }
1700
4138111a 1701 return __verify_planes_array(q->bufs[b->index], b);
012043b8 1702}
2d86401c 1703
e23ccc0a 1704/**
012043b8 1705 * vb2_prepare_buf() - Pass ownership of a buffer from userspace to the kernel
e23ccc0a 1706 * @q: videobuf2 queue
012043b8
LP
1707 * @b: buffer structure passed from userspace to vidioc_prepare_buf
1708 * handler in driver
e23ccc0a 1709 *
012043b8 1710 * Should be called from vidioc_prepare_buf ioctl handler of a driver.
e23ccc0a
PO
1711 * This function:
1712 * 1) verifies the passed buffer,
012043b8
LP
1713 * 2) calls buf_prepare callback in the driver (if provided), in which
1714 * driver-specific buffer initialization can be performed,
e23ccc0a
PO
1715 *
1716 * The return values from this function are intended to be directly returned
012043b8 1717 * from vidioc_prepare_buf handler in driver.
e23ccc0a 1718 */
012043b8 1719int vb2_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b)
e23ccc0a 1720{
4138111a 1721 struct vb2_buffer *vb;
b2f2f047
HV
1722 int ret;
1723
74753cff 1724 if (vb2_fileio_is_active(q)) {
fd4354cf 1725 dprintk(1, "file io in progress\n");
b2f2f047
HV
1726 return -EBUSY;
1727 }
4138111a 1728
b2f2f047 1729 ret = vb2_queue_or_prepare_buf(q, b, "prepare_buf");
4138111a
HV
1730 if (ret)
1731 return ret;
1732
1733 vb = q->bufs[b->index];
1734 if (vb->state != VB2_BUF_STATE_DEQUEUED) {
fd4354cf 1735 dprintk(1, "invalid buffer state %d\n",
4138111a
HV
1736 vb->state);
1737 return -EINVAL;
1738 }
1739
1740 ret = __buf_prepare(vb, b);
1741 if (!ret) {
1742 /* Fill buffer information for the userspace */
1743 __fill_v4l2_buffer(vb, b);
1744
fd4354cf 1745 dprintk(1, "prepare of buffer %d succeeded\n", vb->v4l2_buf.index);
4138111a
HV
1746 }
1747 return ret;
012043b8
LP
1748}
1749EXPORT_SYMBOL_GPL(vb2_prepare_buf);
e23ccc0a 1750
02f142ec
HV
1751/**
1752 * vb2_start_streaming() - Attempt to start streaming.
1753 * @q: videobuf2 queue
1754 *
b3379c62
HV
1755 * Attempt to start streaming. When this function is called there must be
1756 * at least q->min_buffers_needed buffers queued up (i.e. the minimum
1757 * number of buffers required for the DMA engine to function). If the
1758 * @start_streaming op fails it is supposed to return all the driver-owned
1759 * buffers back to vb2 in state QUEUED. Check if that happened and if
1760 * not warn and reclaim them forcefully.
02f142ec
HV
1761 */
1762static int vb2_start_streaming(struct vb2_queue *q)
1763{
b3379c62 1764 struct vb2_buffer *vb;
02f142ec
HV
1765 int ret;
1766
02f142ec 1767 /*
b3379c62
HV
1768 * If any buffers were queued before streamon,
1769 * we can now pass them to driver for processing.
02f142ec 1770 */
b3379c62
HV
1771 list_for_each_entry(vb, &q->queued_list, queued_entry)
1772 __enqueue_in_driver(vb);
1773
1774 /* Tell the driver to start streaming */
bd994ddb 1775 q->start_streaming_called = 1;
b3379c62
HV
1776 ret = call_qop(q, start_streaming, q,
1777 atomic_read(&q->owned_by_drv_count));
b3379c62 1778 if (!ret)
02f142ec 1779 return 0;
b3379c62 1780
bd994ddb
LP
1781 q->start_streaming_called = 0;
1782
fd4354cf 1783 dprintk(1, "driver refused to start streaming\n");
23cd08c8
HV
1784 /*
1785 * If you see this warning, then the driver isn't cleaning up properly
1786 * after a failed start_streaming(). See the start_streaming()
1787 * documentation in videobuf2-core.h for more information how buffers
1788 * should be returned to vb2 in start_streaming().
1789 */
b3379c62
HV
1790 if (WARN_ON(atomic_read(&q->owned_by_drv_count))) {
1791 unsigned i;
1792
1793 /*
1794 * Forcefully reclaim buffers if the driver did not
1795 * correctly return them to vb2.
1796 */
1797 for (i = 0; i < q->num_buffers; ++i) {
1798 vb = q->bufs[i];
1799 if (vb->state == VB2_BUF_STATE_ACTIVE)
1800 vb2_buffer_done(vb, VB2_BUF_STATE_QUEUED);
1801 }
1802 /* Must be zero now */
1803 WARN_ON(atomic_read(&q->owned_by_drv_count));
02f142ec 1804 }
bf3593d9
HV
1805 /*
1806 * If done_list is not empty, then start_streaming() didn't call
1807 * vb2_buffer_done(vb, VB2_BUF_STATE_QUEUED) but STATE_ERROR or
1808 * STATE_DONE.
1809 */
1810 WARN_ON(!list_empty(&q->done_list));
02f142ec
HV
1811 return ret;
1812}
1813
b2f2f047 1814static int vb2_internal_qbuf(struct vb2_queue *q, struct v4l2_buffer *b)
012043b8 1815{
4138111a
HV
1816 int ret = vb2_queue_or_prepare_buf(q, b, "qbuf");
1817 struct vb2_buffer *vb;
1818
1819 if (ret)
1820 return ret;
1821
1822 vb = q->bufs[b->index];
e23ccc0a 1823
ebc087d0
GL
1824 switch (vb->state) {
1825 case VB2_BUF_STATE_DEQUEUED:
1826 ret = __buf_prepare(vb, b);
1827 if (ret)
012043b8 1828 return ret;
4138111a 1829 break;
ebc087d0
GL
1830 case VB2_BUF_STATE_PREPARED:
1831 break;
b18a8ff2 1832 case VB2_BUF_STATE_PREPARING:
fd4354cf 1833 dprintk(1, "buffer still being prepared\n");
b18a8ff2 1834 return -EINVAL;
ebc087d0 1835 default:
fd4354cf 1836 dprintk(1, "invalid buffer state %d\n", vb->state);
012043b8 1837 return -EINVAL;
e23ccc0a
PO
1838 }
1839
e23ccc0a
PO
1840 /*
1841 * Add to the queued buffers list, a buffer will stay on it until
1842 * dequeued in dqbuf.
1843 */
1844 list_add_tail(&vb->queued_entry, &q->queued_list);
b3379c62 1845 q->queued_count++;
58d75f4b 1846 q->waiting_for_buffers = false;
e23ccc0a 1847 vb->state = VB2_BUF_STATE_QUEUED;
f1343281
HV
1848 if (V4L2_TYPE_IS_OUTPUT(q->type)) {
1849 /*
1850 * For output buffers copy the timestamp if needed,
1851 * and the timecode field and flag if needed.
1852 */
c57ff792
SA
1853 if ((q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
1854 V4L2_BUF_FLAG_TIMESTAMP_COPY)
f1343281
HV
1855 vb->v4l2_buf.timestamp = b->timestamp;
1856 vb->v4l2_buf.flags |= b->flags & V4L2_BUF_FLAG_TIMECODE;
1857 if (b->flags & V4L2_BUF_FLAG_TIMECODE)
1858 vb->v4l2_buf.timecode = b->timecode;
1859 }
e23ccc0a
PO
1860
1861 /*
1862 * If already streaming, give the buffer to driver for processing.
1863 * If not, the buffer will be given to driver on next streamon.
1864 */
b3379c62 1865 if (q->start_streaming_called)
e23ccc0a
PO
1866 __enqueue_in_driver(vb);
1867
4138111a
HV
1868 /* Fill buffer information for the userspace */
1869 __fill_v4l2_buffer(vb, b);
21db3e07 1870
b3379c62
HV
1871 /*
1872 * If streamon has been called, and we haven't yet called
1873 * start_streaming() since not enough buffers were queued, and
1874 * we now have reached the minimum number of queued buffers,
1875 * then we can finally call start_streaming().
1876 */
1877 if (q->streaming && !q->start_streaming_called &&
1878 q->queued_count >= q->min_buffers_needed) {
02f142ec
HV
1879 ret = vb2_start_streaming(q);
1880 if (ret)
1881 return ret;
1882 }
1883
fd4354cf 1884 dprintk(1, "qbuf of buffer %d succeeded\n", vb->v4l2_buf.index);
4138111a 1885 return 0;
e23ccc0a 1886}
b2f2f047
HV
1887
1888/**
1889 * vb2_qbuf() - Queue a buffer from userspace
1890 * @q: videobuf2 queue
1891 * @b: buffer structure passed from userspace to vidioc_qbuf handler
1892 * in driver
1893 *
1894 * Should be called from vidioc_qbuf ioctl handler of a driver.
1895 * This function:
1896 * 1) verifies the passed buffer,
1897 * 2) if necessary, calls buf_prepare callback in the driver (if provided), in
1898 * which driver-specific buffer initialization can be performed,
1899 * 3) if streaming is on, queues the buffer in driver by the means of buf_queue
1900 * callback for processing.
1901 *
1902 * The return values from this function are intended to be directly returned
1903 * from vidioc_qbuf handler in driver.
1904 */
1905int vb2_qbuf(struct vb2_queue *q, struct v4l2_buffer *b)
1906{
74753cff 1907 if (vb2_fileio_is_active(q)) {
fd4354cf 1908 dprintk(1, "file io in progress\n");
b2f2f047
HV
1909 return -EBUSY;
1910 }
1911
1912 return vb2_internal_qbuf(q, b);
1913}
e23ccc0a
PO
1914EXPORT_SYMBOL_GPL(vb2_qbuf);
1915
1916/**
1917 * __vb2_wait_for_done_vb() - wait for a buffer to become available
1918 * for dequeuing
1919 *
1920 * Will sleep if required for nonblocking == false.
1921 */
1922static int __vb2_wait_for_done_vb(struct vb2_queue *q, int nonblocking)
1923{
1924 /*
1925 * All operations on vb_done_list are performed under done_lock
1926 * spinlock protection. However, buffers may be removed from
1927 * it and returned to userspace only while holding both driver's
1928 * lock and the done_lock spinlock. Thus we can be sure that as
1929 * long as we hold the driver's lock, the list will remain not
1930 * empty if list_empty() check succeeds.
1931 */
1932
1933 for (;;) {
1934 int ret;
1935
1936 if (!q->streaming) {
3050040b 1937 dprintk(1, "streaming off, will not wait for buffers\n");
e23ccc0a
PO
1938 return -EINVAL;
1939 }
1940
4bb7267d
LP
1941 if (q->error) {
1942 dprintk(1, "Queue in error state, will not wait for buffers\n");
1943 return -EIO;
1944 }
1945
c1621840
PZ
1946 if (q->last_buffer_dequeued) {
1947 dprintk(3, "last buffer dequeued already, will not wait for buffers\n");
1948 return -EPIPE;
1949 }
1950
e23ccc0a
PO
1951 if (!list_empty(&q->done_list)) {
1952 /*
1953 * Found a buffer that we were waiting for.
1954 */
1955 break;
1956 }
1957
1958 if (nonblocking) {
3050040b 1959 dprintk(1, "nonblocking and no buffers to dequeue, "
e23ccc0a
PO
1960 "will not wait\n");
1961 return -EAGAIN;
1962 }
1963
1964 /*
1965 * We are streaming and blocking, wait for another buffer to
1966 * become ready or for streamoff. Driver's lock is released to
1967 * allow streamoff or qbuf to be called while waiting.
1968 */
a1d36d8c 1969 call_void_qop(q, wait_prepare, q);
e23ccc0a
PO
1970
1971 /*
1972 * All locks have been released, it is safe to sleep now.
1973 */
3050040b 1974 dprintk(3, "will sleep waiting for buffers\n");
e23ccc0a 1975 ret = wait_event_interruptible(q->done_wq,
4bb7267d
LP
1976 !list_empty(&q->done_list) || !q->streaming ||
1977 q->error);
e23ccc0a
PO
1978
1979 /*
1980 * We need to reevaluate both conditions again after reacquiring
1981 * the locks or return an error if one occurred.
1982 */
a1d36d8c 1983 call_void_qop(q, wait_finish, q);
32a77260 1984 if (ret) {
3050040b 1985 dprintk(1, "sleep was interrupted\n");
e23ccc0a 1986 return ret;
32a77260 1987 }
e23ccc0a
PO
1988 }
1989 return 0;
1990}
1991
1992/**
1993 * __vb2_get_done_vb() - get a buffer ready for dequeuing
1994 *
1995 * Will sleep if required for nonblocking == false.
1996 */
1997static int __vb2_get_done_vb(struct vb2_queue *q, struct vb2_buffer **vb,
32a77260 1998 struct v4l2_buffer *b, int nonblocking)
e23ccc0a
PO
1999{
2000 unsigned long flags;
2001 int ret;
2002
2003 /*
2004 * Wait for at least one buffer to become available on the done_list.
2005 */
2006 ret = __vb2_wait_for_done_vb(q, nonblocking);
2007 if (ret)
2008 return ret;
2009
2010 /*
2011 * Driver's lock has been held since we last verified that done_list
2012 * is not empty, so no need for another list_empty(done_list) check.
2013 */
2014 spin_lock_irqsave(&q->done_lock, flags);
2015 *vb = list_first_entry(&q->done_list, struct vb2_buffer, done_entry);
32a77260
HV
2016 /*
2017 * Only remove the buffer from done_list if v4l2_buffer can handle all
2018 * the planes.
2019 */
2020 ret = __verify_planes_array(*vb, b);
2021 if (!ret)
2022 list_del(&(*vb)->done_entry);
e23ccc0a
PO
2023 spin_unlock_irqrestore(&q->done_lock, flags);
2024
32a77260 2025 return ret;
e23ccc0a
PO
2026}
2027
2028/**
2029 * vb2_wait_for_all_buffers() - wait until all buffers are given back to vb2
2030 * @q: videobuf2 queue
2031 *
2032 * This function will wait until all buffers that have been given to the driver
2033 * by buf_queue() are given back to vb2 with vb2_buffer_done(). It doesn't call
2034 * wait_prepare, wait_finish pair. It is intended to be called with all locks
2035 * taken, for example from stop_streaming() callback.
2036 */
2037int vb2_wait_for_all_buffers(struct vb2_queue *q)
2038{
2039 if (!q->streaming) {
3050040b 2040 dprintk(1, "streaming off, will not wait for buffers\n");
e23ccc0a
PO
2041 return -EINVAL;
2042 }
2043
b3379c62 2044 if (q->start_streaming_called)
6ea3b980 2045 wait_event(q->done_wq, !atomic_read(&q->owned_by_drv_count));
e23ccc0a
PO
2046 return 0;
2047}
2048EXPORT_SYMBOL_GPL(vb2_wait_for_all_buffers);
2049
c5384048
SS
2050/**
2051 * __vb2_dqbuf() - bring back the buffer to the DEQUEUED state
2052 */
2053static void __vb2_dqbuf(struct vb2_buffer *vb)
2054{
2055 struct vb2_queue *q = vb->vb2_queue;
2056 unsigned int i;
2057
2058 /* nothing to do if the buffer is already dequeued */
2059 if (vb->state == VB2_BUF_STATE_DEQUEUED)
2060 return;
2061
2062 vb->state = VB2_BUF_STATE_DEQUEUED;
2063
2064 /* unmap DMABUF buffer */
2065 if (q->memory == V4L2_MEMORY_DMABUF)
2066 for (i = 0; i < vb->num_planes; ++i) {
2067 if (!vb->planes[i].dbuf_mapped)
2068 continue;
a1d36d8c 2069 call_void_memop(vb, unmap_dmabuf, vb->planes[i].mem_priv);
c5384048
SS
2070 vb->planes[i].dbuf_mapped = 0;
2071 }
2072}
2073
b2f2f047 2074static int vb2_internal_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking)
e23ccc0a
PO
2075{
2076 struct vb2_buffer *vb = NULL;
2077 int ret;
2078
2079 if (b->type != q->type) {
fd4354cf 2080 dprintk(1, "invalid buffer type\n");
e23ccc0a
PO
2081 return -EINVAL;
2082 }
32a77260
HV
2083 ret = __vb2_get_done_vb(q, &vb, b, nonblocking);
2084 if (ret < 0)
e23ccc0a 2085 return ret;
e23ccc0a 2086
e23ccc0a
PO
2087 switch (vb->state) {
2088 case VB2_BUF_STATE_DONE:
3050040b 2089 dprintk(3, "returning done buffer\n");
e23ccc0a
PO
2090 break;
2091 case VB2_BUF_STATE_ERROR:
3050040b 2092 dprintk(3, "returning done buffer with errors\n");
e23ccc0a
PO
2093 break;
2094 default:
3050040b 2095 dprintk(1, "invalid buffer state\n");
e23ccc0a
PO
2096 return -EINVAL;
2097 }
2098
a1d36d8c 2099 call_void_vb_qop(vb, buf_finish, vb);
9cf3c31a 2100
e23ccc0a
PO
2101 /* Fill buffer information for the userspace */
2102 __fill_v4l2_buffer(vb, b);
2103 /* Remove from videobuf queue */
2104 list_del(&vb->queued_entry);
b3379c62 2105 q->queued_count--;
c1621840
PZ
2106 if (!V4L2_TYPE_IS_OUTPUT(q->type) &&
2107 vb->v4l2_buf.flags & V4L2_BUF_FLAG_LAST)
2108 q->last_buffer_dequeued = true;
c5384048
SS
2109 /* go back to dequeued state */
2110 __vb2_dqbuf(vb);
e23ccc0a
PO
2111
2112 dprintk(1, "dqbuf of buffer %d, with state %d\n",
2113 vb->v4l2_buf.index, vb->state);
2114
e23ccc0a
PO
2115 return 0;
2116}
b2f2f047
HV
2117
2118/**
2119 * vb2_dqbuf() - Dequeue a buffer to the userspace
2120 * @q: videobuf2 queue
2121 * @b: buffer structure passed from userspace to vidioc_dqbuf handler
2122 * in driver
2123 * @nonblocking: if true, this call will not sleep waiting for a buffer if no
2124 * buffers ready for dequeuing are present. Normally the driver
2125 * would be passing (file->f_flags & O_NONBLOCK) here
2126 *
2127 * Should be called from vidioc_dqbuf ioctl handler of a driver.
2128 * This function:
2129 * 1) verifies the passed buffer,
2130 * 2) calls buf_finish callback in the driver (if provided), in which
2131 * driver can perform any additional operations that may be required before
2132 * returning the buffer to userspace, such as cache sync,
2133 * 3) the buffer struct members are filled with relevant information for
2134 * the userspace.
2135 *
2136 * The return values from this function are intended to be directly returned
2137 * from vidioc_dqbuf handler in driver.
2138 */
2139int vb2_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking)
2140{
74753cff 2141 if (vb2_fileio_is_active(q)) {
fd4354cf 2142 dprintk(1, "file io in progress\n");
b2f2f047
HV
2143 return -EBUSY;
2144 }
2145 return vb2_internal_dqbuf(q, b, nonblocking);
2146}
e23ccc0a
PO
2147EXPORT_SYMBOL_GPL(vb2_dqbuf);
2148
bd323e28
MS
2149/**
2150 * __vb2_queue_cancel() - cancel and stop (pause) streaming
2151 *
2152 * Removes all queued buffers from driver's queue and all buffers queued by
2153 * userspace from videobuf's queue. Returns to state after reqbufs.
2154 */
2155static void __vb2_queue_cancel(struct vb2_queue *q)
2156{
2157 unsigned int i;
2158
2159 /*
2160 * Tell driver to stop all transactions and release all queued
2161 * buffers.
2162 */
b3379c62 2163 if (q->start_streaming_called)
e37559b2 2164 call_void_qop(q, stop_streaming, q);
b3379c62 2165
23cd08c8
HV
2166 /*
2167 * If you see this warning, then the driver isn't cleaning up properly
2168 * in stop_streaming(). See the stop_streaming() documentation in
2169 * videobuf2-core.h for more information how buffers should be returned
2170 * to vb2 in stop_streaming().
2171 */
b3379c62
HV
2172 if (WARN_ON(atomic_read(&q->owned_by_drv_count))) {
2173 for (i = 0; i < q->num_buffers; ++i)
2174 if (q->bufs[i]->state == VB2_BUF_STATE_ACTIVE)
2175 vb2_buffer_done(q->bufs[i], VB2_BUF_STATE_ERROR);
2176 /* Must be zero now */
2177 WARN_ON(atomic_read(&q->owned_by_drv_count));
2178 }
bd323e28 2179
b646f0b7
LP
2180 q->streaming = 0;
2181 q->start_streaming_called = 0;
2182 q->queued_count = 0;
4bb7267d 2183 q->error = 0;
b646f0b7 2184
bd323e28
MS
2185 /*
2186 * Remove all buffers from videobuf's list...
2187 */
2188 INIT_LIST_HEAD(&q->queued_list);
2189 /*
2190 * ...and done list; userspace will not receive any buffers it
2191 * has not already dequeued before initiating cancel.
2192 */
2193 INIT_LIST_HEAD(&q->done_list);
6ea3b980 2194 atomic_set(&q->owned_by_drv_count, 0);
bd323e28
MS
2195 wake_up_all(&q->done_wq);
2196
2197 /*
2198 * Reinitialize all buffers for next use.
9c0863b1
HV
2199 * Make sure to call buf_finish for any queued buffers. Normally
2200 * that's done in dqbuf, but that's not going to happen when we
2201 * cancel the whole queue. Note: this code belongs here, not in
2202 * __vb2_dqbuf() since in vb2_internal_dqbuf() there is a critical
2203 * call to __fill_v4l2_buffer() after buf_finish(). That order can't
2204 * be changed, so we can't move the buf_finish() to __vb2_dqbuf().
bd323e28 2205 */
9c0863b1
HV
2206 for (i = 0; i < q->num_buffers; ++i) {
2207 struct vb2_buffer *vb = q->bufs[i];
2208
2209 if (vb->state != VB2_BUF_STATE_DEQUEUED) {
2210 vb->state = VB2_BUF_STATE_PREPARED;
a1d36d8c 2211 call_void_vb_qop(vb, buf_finish, vb);
9c0863b1
HV
2212 }
2213 __vb2_dqbuf(vb);
2214 }
bd323e28
MS
2215}
2216
b2f2f047 2217static int vb2_internal_streamon(struct vb2_queue *q, enum v4l2_buf_type type)
e23ccc0a 2218{
5db2c3ba 2219 int ret;
e23ccc0a
PO
2220
2221 if (type != q->type) {
fd4354cf 2222 dprintk(1, "invalid stream type\n");
e23ccc0a
PO
2223 return -EINVAL;
2224 }
2225
2226 if (q->streaming) {
fd4354cf 2227 dprintk(3, "already streaming\n");
f956035c 2228 return 0;
e23ccc0a
PO
2229 }
2230
548df783 2231 if (!q->num_buffers) {
fd4354cf 2232 dprintk(1, "no buffers have been allocated\n");
548df783
RR
2233 return -EINVAL;
2234 }
2235
b3379c62 2236 if (q->num_buffers < q->min_buffers_needed) {
fd4354cf 2237 dprintk(1, "need at least %u allocated buffers\n",
b3379c62
HV
2238 q->min_buffers_needed);
2239 return -EINVAL;
2240 }
249f5a58 2241
e23ccc0a 2242 /*
b3379c62
HV
2243 * Tell driver to start streaming provided sufficient buffers
2244 * are available.
e23ccc0a 2245 */
b3379c62
HV
2246 if (q->queued_count >= q->min_buffers_needed) {
2247 ret = vb2_start_streaming(q);
2248 if (ret) {
2249 __vb2_queue_cancel(q);
2250 return ret;
2251 }
5db2c3ba
PO
2252 }
2253
2254 q->streaming = 1;
e23ccc0a 2255
fd4354cf 2256 dprintk(3, "successful\n");
e23ccc0a
PO
2257 return 0;
2258}
e23ccc0a 2259
4bb7267d
LP
2260/**
2261 * vb2_queue_error() - signal a fatal error on the queue
2262 * @q: videobuf2 queue
2263 *
2264 * Flag that a fatal unrecoverable error has occurred and wake up all processes
2265 * waiting on the queue. Polling will now set POLLERR and queuing and dequeuing
2266 * buffers will return -EIO.
2267 *
2268 * The error flag will be cleared when cancelling the queue, either from
2269 * vb2_streamoff or vb2_queue_release. Drivers should thus not call this
2270 * function before starting the stream, otherwise the error flag will remain set
2271 * until the queue is released when closing the device node.
2272 */
2273void vb2_queue_error(struct vb2_queue *q)
2274{
2275 q->error = 1;
2276
2277 wake_up_all(&q->done_wq);
2278}
2279EXPORT_SYMBOL_GPL(vb2_queue_error);
2280
e23ccc0a 2281/**
b2f2f047 2282 * vb2_streamon - start streaming
e23ccc0a 2283 * @q: videobuf2 queue
b2f2f047 2284 * @type: type argument passed from userspace to vidioc_streamon handler
e23ccc0a 2285 *
b2f2f047 2286 * Should be called from vidioc_streamon handler of a driver.
e23ccc0a 2287 * This function:
b2f2f047
HV
2288 * 1) verifies current state
2289 * 2) passes any previously queued buffers to the driver and starts streaming
e23ccc0a 2290 *
e23ccc0a 2291 * The return values from this function are intended to be directly returned
b2f2f047 2292 * from vidioc_streamon handler in the driver.
e23ccc0a 2293 */
b2f2f047 2294int vb2_streamon(struct vb2_queue *q, enum v4l2_buf_type type)
e23ccc0a 2295{
74753cff 2296 if (vb2_fileio_is_active(q)) {
fd4354cf 2297 dprintk(1, "file io in progress\n");
b25748fe
MS
2298 return -EBUSY;
2299 }
b2f2f047
HV
2300 return vb2_internal_streamon(q, type);
2301}
2302EXPORT_SYMBOL_GPL(vb2_streamon);
b25748fe 2303
b2f2f047
HV
2304static int vb2_internal_streamoff(struct vb2_queue *q, enum v4l2_buf_type type)
2305{
e23ccc0a 2306 if (type != q->type) {
fd4354cf 2307 dprintk(1, "invalid stream type\n");
e23ccc0a
PO
2308 return -EINVAL;
2309 }
2310
e23ccc0a
PO
2311 /*
2312 * Cancel will pause streaming and remove all buffers from the driver
2313 * and videobuf, effectively returning control over them to userspace.
3f1a9a33
HV
2314 *
2315 * Note that we do this even if q->streaming == 0: if you prepare or
2316 * queue buffers, and then call streamoff without ever having called
2317 * streamon, you would still expect those buffers to be returned to
2318 * their normal dequeued state.
e23ccc0a
PO
2319 */
2320 __vb2_queue_cancel(q);
58d75f4b 2321 q->waiting_for_buffers = !V4L2_TYPE_IS_OUTPUT(q->type);
c1621840 2322 q->last_buffer_dequeued = false;
e23ccc0a 2323
fd4354cf 2324 dprintk(3, "successful\n");
e23ccc0a
PO
2325 return 0;
2326}
b2f2f047
HV
2327
2328/**
2329 * vb2_streamoff - stop streaming
2330 * @q: videobuf2 queue
2331 * @type: type argument passed from userspace to vidioc_streamoff handler
2332 *
2333 * Should be called from vidioc_streamoff handler of a driver.
2334 * This function:
2335 * 1) verifies current state,
2336 * 2) stop streaming and dequeues any queued buffers, including those previously
2337 * passed to the driver (after waiting for the driver to finish).
2338 *
2339 * This call can be used for pausing playback.
2340 * The return values from this function are intended to be directly returned
2341 * from vidioc_streamoff handler in the driver
2342 */
2343int vb2_streamoff(struct vb2_queue *q, enum v4l2_buf_type type)
2344{
74753cff 2345 if (vb2_fileio_is_active(q)) {
fd4354cf 2346 dprintk(1, "file io in progress\n");
b2f2f047
HV
2347 return -EBUSY;
2348 }
2349 return vb2_internal_streamoff(q, type);
2350}
e23ccc0a
PO
2351EXPORT_SYMBOL_GPL(vb2_streamoff);
2352
2353/**
2354 * __find_plane_by_offset() - find plane associated with the given offset off
2355 */
2356static int __find_plane_by_offset(struct vb2_queue *q, unsigned long off,
2357 unsigned int *_buffer, unsigned int *_plane)
2358{
2359 struct vb2_buffer *vb;
2360 unsigned int buffer, plane;
2361
2362 /*
2363 * Go over all buffers and their planes, comparing the given offset
2364 * with an offset assigned to each plane. If a match is found,
2365 * return its buffer and plane numbers.
2366 */
2367 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
2368 vb = q->bufs[buffer];
2369
2370 for (plane = 0; plane < vb->num_planes; ++plane) {
2371 if (vb->v4l2_planes[plane].m.mem_offset == off) {
2372 *_buffer = buffer;
2373 *_plane = plane;
2374 return 0;
2375 }
2376 }
2377 }
2378
2379 return -EINVAL;
2380}
2381
83ae7c5a
TS
2382/**
2383 * vb2_expbuf() - Export a buffer as a file descriptor
2384 * @q: videobuf2 queue
2385 * @eb: export buffer structure passed from userspace to vidioc_expbuf
2386 * handler in driver
2387 *
2388 * The return values from this function are intended to be directly returned
2389 * from vidioc_expbuf handler in driver.
2390 */
2391int vb2_expbuf(struct vb2_queue *q, struct v4l2_exportbuffer *eb)
2392{
2393 struct vb2_buffer *vb = NULL;
2394 struct vb2_plane *vb_plane;
2395 int ret;
2396 struct dma_buf *dbuf;
2397
2398 if (q->memory != V4L2_MEMORY_MMAP) {
3050040b 2399 dprintk(1, "queue is not currently set up for mmap\n");
83ae7c5a
TS
2400 return -EINVAL;
2401 }
2402
2403 if (!q->mem_ops->get_dmabuf) {
3050040b 2404 dprintk(1, "queue does not support DMA buffer exporting\n");
83ae7c5a
TS
2405 return -EINVAL;
2406 }
2407
ea3aba84 2408 if (eb->flags & ~(O_CLOEXEC | O_ACCMODE)) {
3050040b 2409 dprintk(1, "queue does support only O_CLOEXEC and access mode flags\n");
83ae7c5a
TS
2410 return -EINVAL;
2411 }
2412
2413 if (eb->type != q->type) {
fd4354cf 2414 dprintk(1, "invalid buffer type\n");
83ae7c5a
TS
2415 return -EINVAL;
2416 }
2417
2418 if (eb->index >= q->num_buffers) {
2419 dprintk(1, "buffer index out of range\n");
2420 return -EINVAL;
2421 }
2422
2423 vb = q->bufs[eb->index];
2424
2425 if (eb->plane >= vb->num_planes) {
2426 dprintk(1, "buffer plane out of range\n");
2427 return -EINVAL;
2428 }
2429
74753cff
HV
2430 if (vb2_fileio_is_active(q)) {
2431 dprintk(1, "expbuf: file io in progress\n");
2432 return -EBUSY;
2433 }
2434
83ae7c5a
TS
2435 vb_plane = &vb->planes[eb->plane];
2436
a1d36d8c 2437 dbuf = call_ptr_memop(vb, get_dmabuf, vb_plane->mem_priv, eb->flags & O_ACCMODE);
83ae7c5a 2438 if (IS_ERR_OR_NULL(dbuf)) {
3050040b 2439 dprintk(1, "failed to export buffer %d, plane %d\n",
83ae7c5a
TS
2440 eb->index, eb->plane);
2441 return -EINVAL;
2442 }
2443
ea3aba84 2444 ret = dma_buf_fd(dbuf, eb->flags & ~O_ACCMODE);
83ae7c5a
TS
2445 if (ret < 0) {
2446 dprintk(3, "buffer %d, plane %d failed to export (%d)\n",
2447 eb->index, eb->plane, ret);
2448 dma_buf_put(dbuf);
2449 return ret;
2450 }
2451
2452 dprintk(3, "buffer %d, plane %d exported as %d descriptor\n",
2453 eb->index, eb->plane, ret);
2454 eb->fd = ret;
2455
2456 return 0;
2457}
2458EXPORT_SYMBOL_GPL(vb2_expbuf);
2459
e23ccc0a
PO
2460/**
2461 * vb2_mmap() - map video buffers into application address space
2462 * @q: videobuf2 queue
2463 * @vma: vma passed to the mmap file operation handler in the driver
2464 *
2465 * Should be called from mmap file operation handler of a driver.
2466 * This function maps one plane of one of the available video buffers to
2467 * userspace. To map whole video memory allocated on reqbufs, this function
2468 * has to be called once per each plane per each buffer previously allocated.
2469 *
2470 * When the userspace application calls mmap, it passes to it an offset returned
2471 * to it earlier by the means of vidioc_querybuf handler. That offset acts as
2472 * a "cookie", which is then used to identify the plane to be mapped.
2473 * This function finds a plane with a matching offset and a mapping is performed
2474 * by the means of a provided memory operation.
2475 *
2476 * The return values from this function are intended to be directly returned
2477 * from the mmap handler in driver.
2478 */
2479int vb2_mmap(struct vb2_queue *q, struct vm_area_struct *vma)
2480{
2481 unsigned long off = vma->vm_pgoff << PAGE_SHIFT;
e23ccc0a 2482 struct vb2_buffer *vb;
ce9c2244 2483 unsigned int buffer = 0, plane = 0;
e23ccc0a 2484 int ret;
7f841459 2485 unsigned long length;
e23ccc0a
PO
2486
2487 if (q->memory != V4L2_MEMORY_MMAP) {
3050040b 2488 dprintk(1, "queue is not currently set up for mmap\n");
e23ccc0a
PO
2489 return -EINVAL;
2490 }
2491
2492 /*
2493 * Check memory area access mode.
2494 */
2495 if (!(vma->vm_flags & VM_SHARED)) {
3050040b 2496 dprintk(1, "invalid vma flags, VM_SHARED needed\n");
e23ccc0a
PO
2497 return -EINVAL;
2498 }
2499 if (V4L2_TYPE_IS_OUTPUT(q->type)) {
2500 if (!(vma->vm_flags & VM_WRITE)) {
3050040b 2501 dprintk(1, "invalid vma flags, VM_WRITE needed\n");
e23ccc0a
PO
2502 return -EINVAL;
2503 }
2504 } else {
2505 if (!(vma->vm_flags & VM_READ)) {
3050040b 2506 dprintk(1, "invalid vma flags, VM_READ needed\n");
e23ccc0a
PO
2507 return -EINVAL;
2508 }
2509 }
74753cff
HV
2510 if (vb2_fileio_is_active(q)) {
2511 dprintk(1, "mmap: file io in progress\n");
2512 return -EBUSY;
2513 }
e23ccc0a
PO
2514
2515 /*
2516 * Find the plane corresponding to the offset passed by userspace.
2517 */
2518 ret = __find_plane_by_offset(q, off, &buffer, &plane);
2519 if (ret)
2520 return ret;
2521
2522 vb = q->bufs[buffer];
e23ccc0a 2523
7f841459
MCC
2524 /*
2525 * MMAP requires page_aligned buffers.
2526 * The buffer length was page_aligned at __vb2_buf_mem_alloc(),
2527 * so, we need to do the same here.
2528 */
2529 length = PAGE_ALIGN(vb->v4l2_planes[plane].length);
2530 if (length < (vma->vm_end - vma->vm_start)) {
2531 dprintk(1,
2532 "MMAP invalid, as it would overflow buffer length\n");
068a0df7
SWK
2533 return -EINVAL;
2534 }
2535
f035eb4e 2536 mutex_lock(&q->mmap_lock);
b5b4541e 2537 ret = call_memop(vb, mmap, vb->planes[plane].mem_priv, vma);
f035eb4e 2538 mutex_unlock(&q->mmap_lock);
a1d36d8c 2539 if (ret)
e23ccc0a
PO
2540 return ret;
2541
3050040b 2542 dprintk(3, "buffer %d, plane %d successfully mapped\n", buffer, plane);
e23ccc0a
PO
2543 return 0;
2544}
2545EXPORT_SYMBOL_GPL(vb2_mmap);
2546
6f524ec1
SJ
2547#ifndef CONFIG_MMU
2548unsigned long vb2_get_unmapped_area(struct vb2_queue *q,
2549 unsigned long addr,
2550 unsigned long len,
2551 unsigned long pgoff,
2552 unsigned long flags)
2553{
2554 unsigned long off = pgoff << PAGE_SHIFT;
2555 struct vb2_buffer *vb;
2556 unsigned int buffer, plane;
f035eb4e 2557 void *vaddr;
6f524ec1
SJ
2558 int ret;
2559
2560 if (q->memory != V4L2_MEMORY_MMAP) {
3050040b 2561 dprintk(1, "queue is not currently set up for mmap\n");
6f524ec1
SJ
2562 return -EINVAL;
2563 }
2564
2565 /*
2566 * Find the plane corresponding to the offset passed by userspace.
2567 */
2568 ret = __find_plane_by_offset(q, off, &buffer, &plane);
2569 if (ret)
2570 return ret;
2571
2572 vb = q->bufs[buffer];
2573
f035eb4e
HV
2574 vaddr = vb2_plane_vaddr(vb, plane);
2575 return vaddr ? (unsigned long)vaddr : -EINVAL;
6f524ec1
SJ
2576}
2577EXPORT_SYMBOL_GPL(vb2_get_unmapped_area);
2578#endif
2579
b25748fe
MS
2580static int __vb2_init_fileio(struct vb2_queue *q, int read);
2581static int __vb2_cleanup_fileio(struct vb2_queue *q);
e23ccc0a
PO
2582
2583/**
2584 * vb2_poll() - implements poll userspace operation
2585 * @q: videobuf2 queue
2586 * @file: file argument passed to the poll file operation handler
2587 * @wait: wait argument passed to the poll file operation handler
2588 *
2589 * This function implements poll file operation handler for a driver.
2590 * For CAPTURE queues, if a buffer is ready to be dequeued, the userspace will
2591 * be informed that the file descriptor of a video device is available for
2592 * reading.
2593 * For OUTPUT queues, if a buffer is ready to be dequeued, the file descriptor
2594 * will be reported as available for writing.
2595 *
95213ceb
HV
2596 * If the driver uses struct v4l2_fh, then vb2_poll() will also check for any
2597 * pending events.
2598 *
e23ccc0a
PO
2599 * The return values from this function are intended to be directly returned
2600 * from poll handler in driver.
2601 */
2602unsigned int vb2_poll(struct vb2_queue *q, struct file *file, poll_table *wait)
2603{
95213ceb 2604 struct video_device *vfd = video_devdata(file);
bf5c7cbb 2605 unsigned long req_events = poll_requested_events(wait);
e23ccc0a 2606 struct vb2_buffer *vb = NULL;
95213ceb
HV
2607 unsigned int res = 0;
2608 unsigned long flags;
2609
2610 if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags)) {
2611 struct v4l2_fh *fh = file->private_data;
2612
2613 if (v4l2_event_pending(fh))
2614 res = POLLPRI;
2615 else if (req_events & POLLPRI)
2616 poll_wait(file, &fh->wait, wait);
2617 }
e23ccc0a 2618
cd13823f
HV
2619 if (!V4L2_TYPE_IS_OUTPUT(q->type) && !(req_events & (POLLIN | POLLRDNORM)))
2620 return res;
2621 if (V4L2_TYPE_IS_OUTPUT(q->type) && !(req_events & (POLLOUT | POLLWRNORM)))
2622 return res;
2623
b25748fe 2624 /*
4ffabdb3 2625 * Start file I/O emulator only if streaming API has not been used yet.
b25748fe 2626 */
74753cff 2627 if (q->num_buffers == 0 && !vb2_fileio_is_active(q)) {
bf5c7cbb
HV
2628 if (!V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_READ) &&
2629 (req_events & (POLLIN | POLLRDNORM))) {
95213ceb
HV
2630 if (__vb2_init_fileio(q, 1))
2631 return res | POLLERR;
b25748fe 2632 }
bf5c7cbb
HV
2633 if (V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_WRITE) &&
2634 (req_events & (POLLOUT | POLLWRNORM))) {
95213ceb
HV
2635 if (__vb2_init_fileio(q, 0))
2636 return res | POLLERR;
b25748fe
MS
2637 /*
2638 * Write to OUTPUT queue can be done immediately.
2639 */
95213ceb 2640 return res | POLLOUT | POLLWRNORM;
b25748fe
MS
2641 }
2642 }
2643
e23ccc0a 2644 /*
58d75f4b
HV
2645 * There is nothing to wait for if the queue isn't streaming, or if the
2646 * error flag is set.
e23ccc0a 2647 */
58d75f4b
HV
2648 if (!vb2_is_streaming(q) || q->error)
2649 return res | POLLERR;
2650 /*
2651 * For compatibility with vb1: if QBUF hasn't been called yet, then
2652 * return POLLERR as well. This only affects capture queues, output
2653 * queues will always initialize waiting_for_buffers to false.
2654 */
2655 if (q->waiting_for_buffers)
95213ceb 2656 return res | POLLERR;
e23ccc0a 2657
1612f20e
HV
2658 /*
2659 * For output streams you can write as long as there are fewer buffers
2660 * queued than there are buffers available.
2661 */
2662 if (V4L2_TYPE_IS_OUTPUT(q->type) && q->queued_count < q->num_buffers)
2663 return res | POLLOUT | POLLWRNORM;
2664
c1621840
PZ
2665 if (list_empty(&q->done_list)) {
2666 /*
2667 * If the last buffer was dequeued from a capture queue,
2668 * return immediately. DQBUF will return -EPIPE.
2669 */
2670 if (q->last_buffer_dequeued)
2671 return res | POLLIN | POLLRDNORM;
2672
412cb87d 2673 poll_wait(file, &q->done_wq, wait);
c1621840 2674 }
e23ccc0a
PO
2675
2676 /*
2677 * Take first buffer available for dequeuing.
2678 */
2679 spin_lock_irqsave(&q->done_lock, flags);
2680 if (!list_empty(&q->done_list))
2681 vb = list_first_entry(&q->done_list, struct vb2_buffer,
2682 done_entry);
2683 spin_unlock_irqrestore(&q->done_lock, flags);
2684
2685 if (vb && (vb->state == VB2_BUF_STATE_DONE
2686 || vb->state == VB2_BUF_STATE_ERROR)) {
95213ceb
HV
2687 return (V4L2_TYPE_IS_OUTPUT(q->type)) ?
2688 res | POLLOUT | POLLWRNORM :
2689 res | POLLIN | POLLRDNORM;
e23ccc0a 2690 }
95213ceb 2691 return res;
e23ccc0a
PO
2692}
2693EXPORT_SYMBOL_GPL(vb2_poll);
2694
2695/**
2696 * vb2_queue_init() - initialize a videobuf2 queue
2697 * @q: videobuf2 queue; this structure should be allocated in driver
2698 *
2699 * The vb2_queue structure should be allocated by the driver. The driver is
2700 * responsible of clearing it's content and setting initial values for some
2701 * required entries before calling this function.
2702 * q->ops, q->mem_ops, q->type and q->io_modes are mandatory. Please refer
2703 * to the struct vb2_queue description in include/media/videobuf2-core.h
2704 * for more information.
2705 */
2706int vb2_queue_init(struct vb2_queue *q)
2707{
896f38f5
EG
2708 /*
2709 * Sanity check
2710 */
2711 if (WARN_ON(!q) ||
2712 WARN_ON(!q->ops) ||
2713 WARN_ON(!q->mem_ops) ||
2714 WARN_ON(!q->type) ||
2715 WARN_ON(!q->io_modes) ||
2716 WARN_ON(!q->ops->queue_setup) ||
6aa69f99 2717 WARN_ON(!q->ops->buf_queue) ||
872484ce
SA
2718 WARN_ON(q->timestamp_flags &
2719 ~(V4L2_BUF_FLAG_TIMESTAMP_MASK |
2720 V4L2_BUF_FLAG_TSTAMP_SRC_MASK)))
896f38f5 2721 return -EINVAL;
e23ccc0a 2722
6aa69f99 2723 /* Warn that the driver should choose an appropriate timestamp type */
c57ff792
SA
2724 WARN_ON((q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
2725 V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN);
6aa69f99 2726
e23ccc0a
PO
2727 INIT_LIST_HEAD(&q->queued_list);
2728 INIT_LIST_HEAD(&q->done_list);
2729 spin_lock_init(&q->done_lock);
f035eb4e 2730 mutex_init(&q->mmap_lock);
e23ccc0a
PO
2731 init_waitqueue_head(&q->done_wq);
2732
2733 if (q->buf_struct_size == 0)
2734 q->buf_struct_size = sizeof(struct vb2_buffer);
2735
2736 return 0;
2737}
2738EXPORT_SYMBOL_GPL(vb2_queue_init);
2739
2740/**
2741 * vb2_queue_release() - stop streaming, release the queue and free memory
2742 * @q: videobuf2 queue
2743 *
2744 * This function stops streaming and performs necessary clean ups, including
2745 * freeing video buffer memory. The driver is responsible for freeing
2746 * the vb2_queue structure itself.
2747 */
2748void vb2_queue_release(struct vb2_queue *q)
2749{
b25748fe 2750 __vb2_cleanup_fileio(q);
e23ccc0a 2751 __vb2_queue_cancel(q);
f035eb4e 2752 mutex_lock(&q->mmap_lock);
2d86401c 2753 __vb2_queue_free(q, q->num_buffers);
f035eb4e 2754 mutex_unlock(&q->mmap_lock);
e23ccc0a
PO
2755}
2756EXPORT_SYMBOL_GPL(vb2_queue_release);
2757
b25748fe
MS
2758/**
2759 * struct vb2_fileio_buf - buffer context used by file io emulator
2760 *
2761 * vb2 provides a compatibility layer and emulator of file io (read and
2762 * write) calls on top of streaming API. This structure is used for
2763 * tracking context related to the buffers.
2764 */
2765struct vb2_fileio_buf {
2766 void *vaddr;
2767 unsigned int size;
2768 unsigned int pos;
2769 unsigned int queued:1;
2770};
2771
2772/**
2773 * struct vb2_fileio_data - queue context used by file io emulator
2774 *
4e5a4d8a
HV
2775 * @cur_index: the index of the buffer currently being read from or
2776 * written to. If equal to q->num_buffers then a new buffer
2777 * must be dequeued.
2778 * @initial_index: in the read() case all buffers are queued up immediately
2779 * in __vb2_init_fileio() and __vb2_perform_fileio() just cycles
2780 * buffers. However, in the write() case no buffers are initially
2781 * queued, instead whenever a buffer is full it is queued up by
2782 * __vb2_perform_fileio(). Only once all available buffers have
2783 * been queued up will __vb2_perform_fileio() start to dequeue
2784 * buffers. This means that initially __vb2_perform_fileio()
2785 * needs to know what buffer index to use when it is queuing up
2786 * the buffers for the first time. That initial index is stored
2787 * in this field. Once it is equal to q->num_buffers all
2788 * available buffers have been queued and __vb2_perform_fileio()
2789 * should start the normal dequeue/queue cycle.
2790 *
b25748fe
MS
2791 * vb2 provides a compatibility layer and emulator of file io (read and
2792 * write) calls on top of streaming API. For proper operation it required
2793 * this structure to save the driver state between each call of the read
2794 * or write function.
2795 */
2796struct vb2_fileio_data {
2797 struct v4l2_requestbuffers req;
7bb6edd3 2798 struct v4l2_plane p;
b25748fe
MS
2799 struct v4l2_buffer b;
2800 struct vb2_fileio_buf bufs[VIDEO_MAX_FRAME];
4e5a4d8a
HV
2801 unsigned int cur_index;
2802 unsigned int initial_index;
b25748fe
MS
2803 unsigned int q_count;
2804 unsigned int dq_count;
06e7a9b6
KD
2805 unsigned read_once:1;
2806 unsigned write_immediately:1;
b25748fe
MS
2807};
2808
2809/**
2810 * __vb2_init_fileio() - initialize file io emulator
2811 * @q: videobuf2 queue
2812 * @read: mode selector (1 means read, 0 means write)
2813 */
2814static int __vb2_init_fileio(struct vb2_queue *q, int read)
2815{
2816 struct vb2_fileio_data *fileio;
2817 int i, ret;
2818 unsigned int count = 0;
2819
2820 /*
2821 * Sanity check
2822 */
e4d25816
HV
2823 if (WARN_ON((read && !(q->io_modes & VB2_READ)) ||
2824 (!read && !(q->io_modes & VB2_WRITE))))
2825 return -EINVAL;
b25748fe
MS
2826
2827 /*
2828 * Check if device supports mapping buffers to kernel virtual space.
2829 */
2830 if (!q->mem_ops->vaddr)
2831 return -EBUSY;
2832
2833 /*
2834 * Check if streaming api has not been already activated.
2835 */
2836 if (q->streaming || q->num_buffers > 0)
2837 return -EBUSY;
2838
2839 /*
2840 * Start with count 1, driver can increase it in queue_setup()
2841 */
2842 count = 1;
2843
06e7a9b6
KD
2844 dprintk(3, "setting up file io: mode %s, count %d, read_once %d, write_immediately %d\n",
2845 (read) ? "read" : "write", count, q->fileio_read_once,
2846 q->fileio_write_immediately);
b25748fe
MS
2847
2848 fileio = kzalloc(sizeof(struct vb2_fileio_data), GFP_KERNEL);
2849 if (fileio == NULL)
2850 return -ENOMEM;
2851
06e7a9b6
KD
2852 fileio->read_once = q->fileio_read_once;
2853 fileio->write_immediately = q->fileio_write_immediately;
b25748fe
MS
2854
2855 /*
2856 * Request buffers and use MMAP type to force driver
2857 * to allocate buffers by itself.
2858 */
2859 fileio->req.count = count;
2860 fileio->req.memory = V4L2_MEMORY_MMAP;
2861 fileio->req.type = q->type;
74753cff
HV
2862 q->fileio = fileio;
2863 ret = __reqbufs(q, &fileio->req);
b25748fe
MS
2864 if (ret)
2865 goto err_kfree;
2866
2867 /*
2868 * Check if plane_count is correct
2869 * (multiplane buffers are not supported).
2870 */
2871 if (q->bufs[0]->num_planes != 1) {
b25748fe
MS
2872 ret = -EBUSY;
2873 goto err_reqbufs;
2874 }
2875
2876 /*
2877 * Get kernel address of each buffer.
2878 */
2879 for (i = 0; i < q->num_buffers; i++) {
2880 fileio->bufs[i].vaddr = vb2_plane_vaddr(q->bufs[i], 0);
5dd6946c
WY
2881 if (fileio->bufs[i].vaddr == NULL) {
2882 ret = -EINVAL;
b25748fe 2883 goto err_reqbufs;
5dd6946c 2884 }
b25748fe
MS
2885 fileio->bufs[i].size = vb2_plane_size(q->bufs[i], 0);
2886 }
2887
2888 /*
2889 * Read mode requires pre queuing of all buffers.
2890 */
2891 if (read) {
7bb6edd3
HV
2892 bool is_multiplanar = V4L2_TYPE_IS_MULTIPLANAR(q->type);
2893
b25748fe
MS
2894 /*
2895 * Queue all buffers.
2896 */
2897 for (i = 0; i < q->num_buffers; i++) {
2898 struct v4l2_buffer *b = &fileio->b;
7bb6edd3 2899
b25748fe
MS
2900 memset(b, 0, sizeof(*b));
2901 b->type = q->type;
7bb6edd3
HV
2902 if (is_multiplanar) {
2903 memset(&fileio->p, 0, sizeof(fileio->p));
2904 b->m.planes = &fileio->p;
2905 b->length = 1;
2906 }
b25748fe
MS
2907 b->memory = q->memory;
2908 b->index = i;
74753cff 2909 ret = vb2_internal_qbuf(q, b);
b25748fe
MS
2910 if (ret)
2911 goto err_reqbufs;
2912 fileio->bufs[i].queued = 1;
2913 }
4e5a4d8a
HV
2914 /*
2915 * All buffers have been queued, so mark that by setting
2916 * initial_index to q->num_buffers
2917 */
2918 fileio->initial_index = q->num_buffers;
2919 fileio->cur_index = q->num_buffers;
b25748fe
MS
2920 }
2921
02f142ec
HV
2922 /*
2923 * Start streaming.
2924 */
74753cff 2925 ret = vb2_internal_streamon(q, q->type);
02f142ec
HV
2926 if (ret)
2927 goto err_reqbufs;
2928
b25748fe
MS
2929 return ret;
2930
2931err_reqbufs:
a67e1722 2932 fileio->req.count = 0;
74753cff 2933 __reqbufs(q, &fileio->req);
b25748fe
MS
2934
2935err_kfree:
74753cff 2936 q->fileio = NULL;
b25748fe
MS
2937 kfree(fileio);
2938 return ret;
2939}
2940
2941/**
2942 * __vb2_cleanup_fileio() - free resourced used by file io emulator
2943 * @q: videobuf2 queue
2944 */
2945static int __vb2_cleanup_fileio(struct vb2_queue *q)
2946{
2947 struct vb2_fileio_data *fileio = q->fileio;
2948
2949 if (fileio) {
b2f2f047 2950 vb2_internal_streamoff(q, q->type);
b25748fe 2951 q->fileio = NULL;
b25748fe
MS
2952 fileio->req.count = 0;
2953 vb2_reqbufs(q, &fileio->req);
2954 kfree(fileio);
2955 dprintk(3, "file io emulator closed\n");
2956 }
2957 return 0;
2958}
2959
2960/**
2961 * __vb2_perform_fileio() - perform a single file io (read or write) operation
2962 * @q: videobuf2 queue
2963 * @data: pointed to target userspace buffer
2964 * @count: number of bytes to read or write
2965 * @ppos: file handle position tracking pointer
2966 * @nonblock: mode selector (1 means blocking calls, 0 means nonblocking)
2967 * @read: access mode selector (1 means read, 0 means write)
2968 */
2969static size_t __vb2_perform_fileio(struct vb2_queue *q, char __user *data, size_t count,
2970 loff_t *ppos, int nonblock, int read)
2971{
2972 struct vb2_fileio_data *fileio;
2973 struct vb2_fileio_buf *buf;
7bb6edd3 2974 bool is_multiplanar = V4L2_TYPE_IS_MULTIPLANAR(q->type);
ebd7c505
HV
2975 /*
2976 * When using write() to write data to an output video node the vb2 core
2977 * should set timestamps if V4L2_BUF_FLAG_TIMESTAMP_COPY is set. Nobody
2978 * else is able to provide this information with the write() operation.
2979 */
2980 bool set_timestamp = !read &&
2981 (q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
2982 V4L2_BUF_FLAG_TIMESTAMP_COPY;
b25748fe
MS
2983 int ret, index;
2984
fd4354cf 2985 dprintk(3, "mode %s, offset %ld, count %zd, %sblocking\n",
b25748fe
MS
2986 read ? "read" : "write", (long)*ppos, count,
2987 nonblock ? "non" : "");
2988
2989 if (!data)
2990 return -EINVAL;
2991
2992 /*
2993 * Initialize emulator on first call.
2994 */
74753cff 2995 if (!vb2_fileio_is_active(q)) {
b25748fe 2996 ret = __vb2_init_fileio(q, read);
fd4354cf 2997 dprintk(3, "vb2_init_fileio result: %d\n", ret);
b25748fe
MS
2998 if (ret)
2999 return ret;
3000 }
3001 fileio = q->fileio;
3002
b25748fe
MS
3003 /*
3004 * Check if we need to dequeue the buffer.
3005 */
4e5a4d8a 3006 index = fileio->cur_index;
88e26870 3007 if (index >= q->num_buffers) {
b25748fe
MS
3008 /*
3009 * Call vb2_dqbuf to get buffer back.
3010 */
3011 memset(&fileio->b, 0, sizeof(fileio->b));
3012 fileio->b.type = q->type;
3013 fileio->b.memory = q->memory;
7bb6edd3
HV
3014 if (is_multiplanar) {
3015 memset(&fileio->p, 0, sizeof(fileio->p));
3016 fileio->b.m.planes = &fileio->p;
3017 fileio->b.length = 1;
3018 }
b2f2f047 3019 ret = vb2_internal_dqbuf(q, &fileio->b, nonblock);
fd4354cf 3020 dprintk(5, "vb2_dqbuf result: %d\n", ret);
b25748fe 3021 if (ret)
b2f2f047 3022 return ret;
b25748fe
MS
3023 fileio->dq_count += 1;
3024
4e5a4d8a 3025 fileio->cur_index = index = fileio->b.index;
88e26870
HV
3026 buf = &fileio->bufs[index];
3027
b25748fe
MS
3028 /*
3029 * Get number of bytes filled by the driver
3030 */
88e26870 3031 buf->pos = 0;
b25748fe 3032 buf->queued = 0;
88e26870
HV
3033 buf->size = read ? vb2_get_plane_payload(q->bufs[index], 0)
3034 : vb2_plane_size(q->bufs[index], 0);
529a53c6
HV
3035 /* Compensate for data_offset on read in the multiplanar case. */
3036 if (is_multiplanar && read &&
3037 fileio->b.m.planes[0].data_offset < buf->size) {
3038 buf->pos = fileio->b.m.planes[0].data_offset;
3039 buf->size -= buf->pos;
3040 }
88e26870
HV
3041 } else {
3042 buf = &fileio->bufs[index];
b25748fe
MS
3043 }
3044
3045 /*
3046 * Limit count on last few bytes of the buffer.
3047 */
3048 if (buf->pos + count > buf->size) {
3049 count = buf->size - buf->pos;
08b99e26 3050 dprintk(5, "reducing read count: %zd\n", count);
b25748fe
MS
3051 }
3052
3053 /*
3054 * Transfer data to userspace.
3055 */
fd4354cf 3056 dprintk(3, "copying %zd bytes - buffer %d, offset %u\n",
b25748fe
MS
3057 count, index, buf->pos);
3058 if (read)
3059 ret = copy_to_user(data, buf->vaddr + buf->pos, count);
3060 else
3061 ret = copy_from_user(buf->vaddr + buf->pos, data, count);
3062 if (ret) {
fd4354cf 3063 dprintk(3, "error copying data\n");
b2f2f047 3064 return -EFAULT;
b25748fe
MS
3065 }
3066
3067 /*
3068 * Update counters.
3069 */
3070 buf->pos += count;
3071 *ppos += count;
3072
3073 /*
3074 * Queue next buffer if required.
3075 */
06e7a9b6 3076 if (buf->pos == buf->size || (!read && fileio->write_immediately)) {
b25748fe
MS
3077 /*
3078 * Check if this is the last buffer to read.
3079 */
06e7a9b6 3080 if (read && fileio->read_once && fileio->dq_count == 1) {
fd4354cf 3081 dprintk(3, "read limit reached\n");
b25748fe
MS
3082 return __vb2_cleanup_fileio(q);
3083 }
3084
3085 /*
3086 * Call vb2_qbuf and give buffer to the driver.
3087 */
3088 memset(&fileio->b, 0, sizeof(fileio->b));
3089 fileio->b.type = q->type;
3090 fileio->b.memory = q->memory;
3091 fileio->b.index = index;
3092 fileio->b.bytesused = buf->pos;
7bb6edd3
HV
3093 if (is_multiplanar) {
3094 memset(&fileio->p, 0, sizeof(fileio->p));
3095 fileio->p.bytesused = buf->pos;
3096 fileio->b.m.planes = &fileio->p;
3097 fileio->b.length = 1;
3098 }
ebd7c505
HV
3099 if (set_timestamp)
3100 v4l2_get_timestamp(&fileio->b.timestamp);
b2f2f047 3101 ret = vb2_internal_qbuf(q, &fileio->b);
fd4354cf 3102 dprintk(5, "vb2_dbuf result: %d\n", ret);
b25748fe 3103 if (ret)
b2f2f047 3104 return ret;
b25748fe
MS
3105
3106 /*
3107 * Buffer has been queued, update the status
3108 */
3109 buf->pos = 0;
3110 buf->queued = 1;
88e26870 3111 buf->size = vb2_plane_size(q->bufs[index], 0);
b25748fe 3112 fileio->q_count += 1;
4e5a4d8a
HV
3113 /*
3114 * If we are queuing up buffers for the first time, then
3115 * increase initial_index by one.
3116 */
3117 if (fileio->initial_index < q->num_buffers)
3118 fileio->initial_index++;
3119 /*
3120 * The next buffer to use is either a buffer that's going to be
3121 * queued for the first time (initial_index < q->num_buffers)
3122 * or it is equal to q->num_buffers, meaning that the next
3123 * time we need to dequeue a buffer since we've now queued up
3124 * all the 'first time' buffers.
3125 */
3126 fileio->cur_index = fileio->initial_index;
b25748fe
MS
3127 }
3128
3129 /*
3130 * Return proper number of bytes processed.
3131 */
3132 if (ret == 0)
3133 ret = count;
b25748fe
MS
3134 return ret;
3135}
3136
3137size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count,
3138 loff_t *ppos, int nonblocking)
3139{
3140 return __vb2_perform_fileio(q, data, count, ppos, nonblocking, 1);
3141}
3142EXPORT_SYMBOL_GPL(vb2_read);
3143
819585bc 3144size_t vb2_write(struct vb2_queue *q, const char __user *data, size_t count,
b25748fe
MS
3145 loff_t *ppos, int nonblocking)
3146{
819585bc
RR
3147 return __vb2_perform_fileio(q, (char __user *) data, count,
3148 ppos, nonblocking, 0);
b25748fe
MS
3149}
3150EXPORT_SYMBOL_GPL(vb2_write);
3151
3415a89f
HV
3152struct vb2_threadio_data {
3153 struct task_struct *thread;
3154 vb2_thread_fnc fnc;
3155 void *priv;
3156 bool stop;
3157};
3158
3159static int vb2_thread(void *data)
3160{
3161 struct vb2_queue *q = data;
3162 struct vb2_threadio_data *threadio = q->threadio;
3163 struct vb2_fileio_data *fileio = q->fileio;
3164 bool set_timestamp = false;
3165 int prequeue = 0;
3166 int index = 0;
3167 int ret = 0;
3168
3169 if (V4L2_TYPE_IS_OUTPUT(q->type)) {
3170 prequeue = q->num_buffers;
3171 set_timestamp =
3172 (q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
3173 V4L2_BUF_FLAG_TIMESTAMP_COPY;
3174 }
3175
3176 set_freezable();
3177
3178 for (;;) {
3179 struct vb2_buffer *vb;
3180
3181 /*
3182 * Call vb2_dqbuf to get buffer back.
3183 */
3184 memset(&fileio->b, 0, sizeof(fileio->b));
3185 fileio->b.type = q->type;
3186 fileio->b.memory = q->memory;
3187 if (prequeue) {
3188 fileio->b.index = index++;
3189 prequeue--;
3190 } else {
3191 call_void_qop(q, wait_finish, q);
6cf11ee6
HV
3192 if (!threadio->stop)
3193 ret = vb2_internal_dqbuf(q, &fileio->b, 0);
3415a89f
HV
3194 call_void_qop(q, wait_prepare, q);
3195 dprintk(5, "file io: vb2_dqbuf result: %d\n", ret);
3196 }
6cf11ee6 3197 if (ret || threadio->stop)
3415a89f
HV
3198 break;
3199 try_to_freeze();
3200
3201 vb = q->bufs[fileio->b.index];
3202 if (!(fileio->b.flags & V4L2_BUF_FLAG_ERROR))
6cf11ee6
HV
3203 if (threadio->fnc(vb, threadio->priv))
3204 break;
3415a89f
HV
3205 call_void_qop(q, wait_finish, q);
3206 if (set_timestamp)
3207 v4l2_get_timestamp(&fileio->b.timestamp);
6cf11ee6
HV
3208 if (!threadio->stop)
3209 ret = vb2_internal_qbuf(q, &fileio->b);
3415a89f 3210 call_void_qop(q, wait_prepare, q);
6cf11ee6 3211 if (ret || threadio->stop)
3415a89f
HV
3212 break;
3213 }
3214
3215 /* Hmm, linux becomes *very* unhappy without this ... */
3216 while (!kthread_should_stop()) {
3217 set_current_state(TASK_INTERRUPTIBLE);
3218 schedule();
3219 }
3220 return 0;
3221}
3222
3223/*
3224 * This function should not be used for anything else but the videobuf2-dvb
3225 * support. If you think you have another good use-case for this, then please
3226 * contact the linux-media mailinglist first.
3227 */
3228int vb2_thread_start(struct vb2_queue *q, vb2_thread_fnc fnc, void *priv,
3229 const char *thread_name)
3230{
3231 struct vb2_threadio_data *threadio;
3232 int ret = 0;
3233
3234 if (q->threadio)
3235 return -EBUSY;
3236 if (vb2_is_busy(q))
3237 return -EBUSY;
3238 if (WARN_ON(q->fileio))
3239 return -EBUSY;
3240
3241 threadio = kzalloc(sizeof(*threadio), GFP_KERNEL);
3242 if (threadio == NULL)
3243 return -ENOMEM;
3244 threadio->fnc = fnc;
3245 threadio->priv = priv;
3246
3247 ret = __vb2_init_fileio(q, !V4L2_TYPE_IS_OUTPUT(q->type));
3248 dprintk(3, "file io: vb2_init_fileio result: %d\n", ret);
3249 if (ret)
3250 goto nomem;
3251 q->threadio = threadio;
3252 threadio->thread = kthread_run(vb2_thread, q, "vb2-%s", thread_name);
3253 if (IS_ERR(threadio->thread)) {
3254 ret = PTR_ERR(threadio->thread);
3255 threadio->thread = NULL;
3256 goto nothread;
3257 }
3258 return 0;
3259
3260nothread:
3261 __vb2_cleanup_fileio(q);
3262nomem:
3263 kfree(threadio);
3264 return ret;
3265}
3266EXPORT_SYMBOL_GPL(vb2_thread_start);
3267
3268int vb2_thread_stop(struct vb2_queue *q)
3269{
3270 struct vb2_threadio_data *threadio = q->threadio;
3415a89f
HV
3271 int err;
3272
3273 if (threadio == NULL)
3274 return 0;
3415a89f 3275 threadio->stop = true;
0e661006
HV
3276 /* Wake up all pending sleeps in the thread */
3277 vb2_queue_error(q);
6cf11ee6 3278 err = kthread_stop(threadio->thread);
0e661006 3279 __vb2_cleanup_fileio(q);
3415a89f
HV
3280 threadio->thread = NULL;
3281 kfree(threadio);
3415a89f
HV
3282 q->threadio = NULL;
3283 return err;
3284}
3285EXPORT_SYMBOL_GPL(vb2_thread_stop);
4c1ffcaa
HV
3286
3287/*
3288 * The following functions are not part of the vb2 core API, but are helper
3289 * functions that plug into struct v4l2_ioctl_ops, struct v4l2_file_operations
3290 * and struct vb2_ops.
3291 * They contain boilerplate code that most if not all drivers have to do
3292 * and so they simplify the driver code.
3293 */
3294
3295/* The queue is busy if there is a owner and you are not that owner. */
3296static inline bool vb2_queue_is_busy(struct video_device *vdev, struct file *file)
3297{
3298 return vdev->queue->owner && vdev->queue->owner != file->private_data;
3299}
3300
3301/* vb2 ioctl helpers */
3302
3303int vb2_ioctl_reqbufs(struct file *file, void *priv,
3304 struct v4l2_requestbuffers *p)
3305{
3306 struct video_device *vdev = video_devdata(file);
3307 int res = __verify_memory_type(vdev->queue, p->memory, p->type);
3308
3309 if (res)
3310 return res;
3311 if (vb2_queue_is_busy(vdev, file))
3312 return -EBUSY;
3313 res = __reqbufs(vdev->queue, p);
3314 /* If count == 0, then the owner has released all buffers and he
3315 is no longer owner of the queue. Otherwise we have a new owner. */
3316 if (res == 0)
3317 vdev->queue->owner = p->count ? file->private_data : NULL;
3318 return res;
3319}
3320EXPORT_SYMBOL_GPL(vb2_ioctl_reqbufs);
3321
3322int vb2_ioctl_create_bufs(struct file *file, void *priv,
3323 struct v4l2_create_buffers *p)
3324{
3325 struct video_device *vdev = video_devdata(file);
3326 int res = __verify_memory_type(vdev->queue, p->memory, p->format.type);
3327
3328 p->index = vdev->queue->num_buffers;
3329 /* If count == 0, then just check if memory and type are valid.
3330 Any -EBUSY result from __verify_memory_type can be mapped to 0. */
3331 if (p->count == 0)
3332 return res != -EBUSY ? res : 0;
3333 if (res)
3334 return res;
3335 if (vb2_queue_is_busy(vdev, file))
3336 return -EBUSY;
3337 res = __create_bufs(vdev->queue, p);
3338 if (res == 0)
3339 vdev->queue->owner = file->private_data;
3340 return res;
3341}
3342EXPORT_SYMBOL_GPL(vb2_ioctl_create_bufs);
3343
3344int vb2_ioctl_prepare_buf(struct file *file, void *priv,
3345 struct v4l2_buffer *p)
3346{
3347 struct video_device *vdev = video_devdata(file);
3348
3349 if (vb2_queue_is_busy(vdev, file))
3350 return -EBUSY;
3351 return vb2_prepare_buf(vdev->queue, p);
3352}
3353EXPORT_SYMBOL_GPL(vb2_ioctl_prepare_buf);
3354
3355int vb2_ioctl_querybuf(struct file *file, void *priv, struct v4l2_buffer *p)
3356{
3357 struct video_device *vdev = video_devdata(file);
3358
3359 /* No need to call vb2_queue_is_busy(), anyone can query buffers. */
3360 return vb2_querybuf(vdev->queue, p);
3361}
3362EXPORT_SYMBOL_GPL(vb2_ioctl_querybuf);
3363
3364int vb2_ioctl_qbuf(struct file *file, void *priv, struct v4l2_buffer *p)
3365{
3366 struct video_device *vdev = video_devdata(file);
3367
3368 if (vb2_queue_is_busy(vdev, file))
3369 return -EBUSY;
3370 return vb2_qbuf(vdev->queue, p);
3371}
3372EXPORT_SYMBOL_GPL(vb2_ioctl_qbuf);
3373
3374int vb2_ioctl_dqbuf(struct file *file, void *priv, struct v4l2_buffer *p)
3375{
3376 struct video_device *vdev = video_devdata(file);
3377
3378 if (vb2_queue_is_busy(vdev, file))
3379 return -EBUSY;
3380 return vb2_dqbuf(vdev->queue, p, file->f_flags & O_NONBLOCK);
3381}
3382EXPORT_SYMBOL_GPL(vb2_ioctl_dqbuf);
3383
3384int vb2_ioctl_streamon(struct file *file, void *priv, enum v4l2_buf_type i)
3385{
3386 struct video_device *vdev = video_devdata(file);
3387
3388 if (vb2_queue_is_busy(vdev, file))
3389 return -EBUSY;
3390 return vb2_streamon(vdev->queue, i);
3391}
3392EXPORT_SYMBOL_GPL(vb2_ioctl_streamon);
3393
3394int vb2_ioctl_streamoff(struct file *file, void *priv, enum v4l2_buf_type i)
3395{
3396 struct video_device *vdev = video_devdata(file);
3397
3398 if (vb2_queue_is_busy(vdev, file))
3399 return -EBUSY;
3400 return vb2_streamoff(vdev->queue, i);
3401}
3402EXPORT_SYMBOL_GPL(vb2_ioctl_streamoff);
3403
83ae7c5a
TS
3404int vb2_ioctl_expbuf(struct file *file, void *priv, struct v4l2_exportbuffer *p)
3405{
3406 struct video_device *vdev = video_devdata(file);
3407
3408 if (vb2_queue_is_busy(vdev, file))
3409 return -EBUSY;
3410 return vb2_expbuf(vdev->queue, p);
3411}
3412EXPORT_SYMBOL_GPL(vb2_ioctl_expbuf);
3413
4c1ffcaa
HV
3414/* v4l2_file_operations helpers */
3415
3416int vb2_fop_mmap(struct file *file, struct vm_area_struct *vma)
3417{
3418 struct video_device *vdev = video_devdata(file);
3419
f035eb4e 3420 return vb2_mmap(vdev->queue, vma);
4c1ffcaa
HV
3421}
3422EXPORT_SYMBOL_GPL(vb2_fop_mmap);
3423
1380f575 3424int _vb2_fop_release(struct file *file, struct mutex *lock)
4c1ffcaa
HV
3425{
3426 struct video_device *vdev = video_devdata(file);
3427
69c0e9c5
LP
3428 if (lock)
3429 mutex_lock(lock);
4c1ffcaa
HV
3430 if (file->private_data == vdev->queue->owner) {
3431 vb2_queue_release(vdev->queue);
3432 vdev->queue->owner = NULL;
3433 }
69c0e9c5
LP
3434 if (lock)
3435 mutex_unlock(lock);
4c1ffcaa
HV
3436 return v4l2_fh_release(file);
3437}
1380f575
RR
3438EXPORT_SYMBOL_GPL(_vb2_fop_release);
3439
3440int vb2_fop_release(struct file *file)
3441{
3442 struct video_device *vdev = video_devdata(file);
3443 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
3444
3445 return _vb2_fop_release(file, lock);
3446}
4c1ffcaa
HV
3447EXPORT_SYMBOL_GPL(vb2_fop_release);
3448
819585bc 3449ssize_t vb2_fop_write(struct file *file, const char __user *buf,
4c1ffcaa
HV
3450 size_t count, loff_t *ppos)
3451{
3452 struct video_device *vdev = video_devdata(file);
3453 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
4c1ffcaa
HV
3454 int err = -EBUSY;
3455
ff05cb4b
HV
3456 if (!(vdev->queue->io_modes & VB2_WRITE))
3457 return -EINVAL;
cf533735 3458 if (lock && mutex_lock_interruptible(lock))
4c1ffcaa
HV
3459 return -ERESTARTSYS;
3460 if (vb2_queue_is_busy(vdev, file))
3461 goto exit;
3462 err = vb2_write(vdev->queue, buf, count, ppos,
3463 file->f_flags & O_NONBLOCK);
8c82c75c 3464 if (vdev->queue->fileio)
4c1ffcaa
HV
3465 vdev->queue->owner = file->private_data;
3466exit:
cf533735 3467 if (lock)
4c1ffcaa
HV
3468 mutex_unlock(lock);
3469 return err;
3470}
3471EXPORT_SYMBOL_GPL(vb2_fop_write);
3472
3473ssize_t vb2_fop_read(struct file *file, char __user *buf,
3474 size_t count, loff_t *ppos)
3475{
3476 struct video_device *vdev = video_devdata(file);
3477 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
4c1ffcaa
HV
3478 int err = -EBUSY;
3479
ff05cb4b
HV
3480 if (!(vdev->queue->io_modes & VB2_READ))
3481 return -EINVAL;
cf533735 3482 if (lock && mutex_lock_interruptible(lock))
4c1ffcaa
HV
3483 return -ERESTARTSYS;
3484 if (vb2_queue_is_busy(vdev, file))
3485 goto exit;
3486 err = vb2_read(vdev->queue, buf, count, ppos,
3487 file->f_flags & O_NONBLOCK);
8c82c75c 3488 if (vdev->queue->fileio)
4c1ffcaa
HV
3489 vdev->queue->owner = file->private_data;
3490exit:
cf533735 3491 if (lock)
4c1ffcaa
HV
3492 mutex_unlock(lock);
3493 return err;
3494}
3495EXPORT_SYMBOL_GPL(vb2_fop_read);
3496
3497unsigned int vb2_fop_poll(struct file *file, poll_table *wait)
3498{
3499 struct video_device *vdev = video_devdata(file);
3500 struct vb2_queue *q = vdev->queue;
3501 struct mutex *lock = q->lock ? q->lock : vdev->lock;
4c1ffcaa
HV
3502 unsigned res;
3503 void *fileio;
4c1ffcaa 3504
f6cee188
LP
3505 /*
3506 * If this helper doesn't know how to lock, then you shouldn't be using
3507 * it but you should write your own.
3508 */
3509 WARN_ON(!lock);
4c1ffcaa 3510
f6cee188 3511 if (lock && mutex_lock_interruptible(lock))
4c1ffcaa
HV
3512 return POLLERR;
3513
3514 fileio = q->fileio;
3515
3516 res = vb2_poll(vdev->queue, file, wait);
3517
3518 /* If fileio was started, then we have a new queue owner. */
f6cee188 3519 if (!fileio && q->fileio)
4c1ffcaa 3520 q->owner = file->private_data;
f6cee188 3521 if (lock)
4c1ffcaa
HV
3522 mutex_unlock(lock);
3523 return res;
3524}
3525EXPORT_SYMBOL_GPL(vb2_fop_poll);
3526
3527#ifndef CONFIG_MMU
3528unsigned long vb2_fop_get_unmapped_area(struct file *file, unsigned long addr,
3529 unsigned long len, unsigned long pgoff, unsigned long flags)
3530{
3531 struct video_device *vdev = video_devdata(file);
3532
f035eb4e 3533 return vb2_get_unmapped_area(vdev->queue, addr, len, pgoff, flags);
4c1ffcaa
HV
3534}
3535EXPORT_SYMBOL_GPL(vb2_fop_get_unmapped_area);
3536#endif
3537
3538/* vb2_ops helpers. Only use if vq->lock is non-NULL. */
3539
3540void vb2_ops_wait_prepare(struct vb2_queue *vq)
3541{
3542 mutex_unlock(vq->lock);
3543}
3544EXPORT_SYMBOL_GPL(vb2_ops_wait_prepare);
3545
3546void vb2_ops_wait_finish(struct vb2_queue *vq)
3547{
3548 mutex_lock(vq->lock);
3549}
3550EXPORT_SYMBOL_GPL(vb2_ops_wait_finish);
3551
e23ccc0a 3552MODULE_DESCRIPTION("Driver helper framework for Video for Linux 2");
95072084 3553MODULE_AUTHOR("Pawel Osciak <pawel@osciak.com>, Marek Szyprowski");
e23ccc0a 3554MODULE_LICENSE("GPL");
This page took 0.467345 seconds and 5 git commands to generate.