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