[media] bw-qcam: remove unnecessary qc_reset and qc_setscanmode calls
[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>
e23ccc0a
PO
25#include <media/videobuf2-core.h>
26
27static int debug;
28module_param(debug, int, 0644);
29
30#define dprintk(level, fmt, arg...) \
31 do { \
32 if (debug >= level) \
33 printk(KERN_DEBUG "vb2: " fmt, ## arg); \
34 } while (0)
35
5931ffe3 36#define call_memop(q, op, args...) \
e23ccc0a
PO
37 (((q)->mem_ops->op) ? \
38 ((q)->mem_ops->op(args)) : 0)
39
40#define call_qop(q, op, args...) \
41 (((q)->ops->op) ? ((q)->ops->op(args)) : 0)
42
1b18e7a0 43#define V4L2_BUFFER_MASK_FLAGS (V4L2_BUF_FLAG_MAPPED | V4L2_BUF_FLAG_QUEUED | \
2d86401c 44 V4L2_BUF_FLAG_DONE | V4L2_BUF_FLAG_ERROR | \
1b18e7a0
SA
45 V4L2_BUF_FLAG_PREPARED | \
46 V4L2_BUF_FLAG_TIMESTAMP_MASK)
ea42c8ec 47
e23ccc0a
PO
48/**
49 * __vb2_buf_mem_alloc() - allocate video memory for the given buffer
50 */
c1426bc7 51static int __vb2_buf_mem_alloc(struct vb2_buffer *vb)
e23ccc0a
PO
52{
53 struct vb2_queue *q = vb->vb2_queue;
54 void *mem_priv;
55 int plane;
56
57 /* Allocate memory for all planes in this buffer */
58 for (plane = 0; plane < vb->num_planes; ++plane) {
5931ffe3 59 mem_priv = call_memop(q, alloc, q->alloc_ctx[plane],
c1426bc7 60 q->plane_sizes[plane]);
62a79436 61 if (IS_ERR_OR_NULL(mem_priv))
e23ccc0a
PO
62 goto free;
63
64 /* Associate allocator private data with this plane */
65 vb->planes[plane].mem_priv = mem_priv;
c1426bc7 66 vb->v4l2_planes[plane].length = q->plane_sizes[plane];
e23ccc0a
PO
67 }
68
69 return 0;
70free:
71 /* Free already allocated memory if one of the allocations failed */
a00d0266 72 for (; plane > 0; --plane) {
5931ffe3 73 call_memop(q, put, vb->planes[plane - 1].mem_priv);
a00d0266
MS
74 vb->planes[plane - 1].mem_priv = NULL;
75 }
e23ccc0a
PO
76
77 return -ENOMEM;
78}
79
80/**
81 * __vb2_buf_mem_free() - free memory of the given buffer
82 */
83static void __vb2_buf_mem_free(struct vb2_buffer *vb)
84{
85 struct vb2_queue *q = vb->vb2_queue;
86 unsigned int plane;
87
88 for (plane = 0; plane < vb->num_planes; ++plane) {
5931ffe3 89 call_memop(q, put, vb->planes[plane].mem_priv);
e23ccc0a 90 vb->planes[plane].mem_priv = NULL;
a00d0266
MS
91 dprintk(3, "Freed plane %d of buffer %d\n", plane,
92 vb->v4l2_buf.index);
e23ccc0a
PO
93 }
94}
95
96/**
97 * __vb2_buf_userptr_put() - release userspace memory associated with
98 * a USERPTR buffer
99 */
100static void __vb2_buf_userptr_put(struct vb2_buffer *vb)
101{
102 struct vb2_queue *q = vb->vb2_queue;
103 unsigned int plane;
104
105 for (plane = 0; plane < vb->num_planes; ++plane) {
a00d0266
MS
106 if (vb->planes[plane].mem_priv)
107 call_memop(q, put_userptr, vb->planes[plane].mem_priv);
108 vb->planes[plane].mem_priv = NULL;
e23ccc0a
PO
109 }
110}
111
c5384048
SS
112/**
113 * __vb2_plane_dmabuf_put() - release memory associated with
114 * a DMABUF shared plane
115 */
116static void __vb2_plane_dmabuf_put(struct vb2_queue *q, struct vb2_plane *p)
117{
118 if (!p->mem_priv)
119 return;
120
121 if (p->dbuf_mapped)
122 call_memop(q, unmap_dmabuf, p->mem_priv);
123
124 call_memop(q, detach_dmabuf, p->mem_priv);
125 dma_buf_put(p->dbuf);
126 memset(p, 0, sizeof(*p));
127}
128
129/**
130 * __vb2_buf_dmabuf_put() - release memory associated with
131 * a DMABUF shared buffer
132 */
133static void __vb2_buf_dmabuf_put(struct vb2_buffer *vb)
134{
135 struct vb2_queue *q = vb->vb2_queue;
136 unsigned int plane;
137
138 for (plane = 0; plane < vb->num_planes; ++plane)
139 __vb2_plane_dmabuf_put(q, &vb->planes[plane]);
140}
141
e23ccc0a
PO
142/**
143 * __setup_offsets() - setup unique offsets ("cookies") for every plane in
144 * every buffer on the queue
145 */
2d86401c 146static void __setup_offsets(struct vb2_queue *q, unsigned int n)
e23ccc0a
PO
147{
148 unsigned int buffer, plane;
149 struct vb2_buffer *vb;
2d86401c 150 unsigned long off;
e23ccc0a 151
2d86401c
GL
152 if (q->num_buffers) {
153 struct v4l2_plane *p;
154 vb = q->bufs[q->num_buffers - 1];
155 p = &vb->v4l2_planes[vb->num_planes - 1];
156 off = PAGE_ALIGN(p->m.mem_offset + p->length);
157 } else {
158 off = 0;
159 }
160
161 for (buffer = q->num_buffers; buffer < q->num_buffers + n; ++buffer) {
e23ccc0a
PO
162 vb = q->bufs[buffer];
163 if (!vb)
164 continue;
165
166 for (plane = 0; plane < vb->num_planes; ++plane) {
4907602f 167 vb->v4l2_planes[plane].length = q->plane_sizes[plane];
e23ccc0a
PO
168 vb->v4l2_planes[plane].m.mem_offset = off;
169
170 dprintk(3, "Buffer %d, plane %d offset 0x%08lx\n",
171 buffer, plane, off);
172
173 off += vb->v4l2_planes[plane].length;
174 off = PAGE_ALIGN(off);
175 }
176 }
177}
178
179/**
180 * __vb2_queue_alloc() - allocate videobuf buffer structures and (for MMAP type)
181 * video buffer memory for all buffers/planes on the queue and initializes the
182 * queue
183 *
184 * Returns the number of buffers successfully allocated.
185 */
186static int __vb2_queue_alloc(struct vb2_queue *q, enum v4l2_memory memory,
c1426bc7 187 unsigned int num_buffers, unsigned int num_planes)
e23ccc0a
PO
188{
189 unsigned int buffer;
190 struct vb2_buffer *vb;
191 int ret;
192
193 for (buffer = 0; buffer < num_buffers; ++buffer) {
194 /* Allocate videobuf buffer structures */
195 vb = kzalloc(q->buf_struct_size, GFP_KERNEL);
196 if (!vb) {
197 dprintk(1, "Memory alloc for buffer struct failed\n");
198 break;
199 }
200
201 /* Length stores number of planes for multiplanar buffers */
202 if (V4L2_TYPE_IS_MULTIPLANAR(q->type))
203 vb->v4l2_buf.length = num_planes;
204
205 vb->state = VB2_BUF_STATE_DEQUEUED;
206 vb->vb2_queue = q;
207 vb->num_planes = num_planes;
2d86401c 208 vb->v4l2_buf.index = q->num_buffers + buffer;
e23ccc0a
PO
209 vb->v4l2_buf.type = q->type;
210 vb->v4l2_buf.memory = memory;
211
212 /* Allocate video buffer memory for the MMAP type */
213 if (memory == V4L2_MEMORY_MMAP) {
c1426bc7 214 ret = __vb2_buf_mem_alloc(vb);
e23ccc0a
PO
215 if (ret) {
216 dprintk(1, "Failed allocating memory for "
217 "buffer %d\n", buffer);
218 kfree(vb);
219 break;
220 }
221 /*
222 * Call the driver-provided buffer initialization
223 * callback, if given. An error in initialization
224 * results in queue setup failure.
225 */
226 ret = call_qop(q, buf_init, vb);
227 if (ret) {
228 dprintk(1, "Buffer %d %p initialization"
229 " failed\n", buffer, vb);
230 __vb2_buf_mem_free(vb);
231 kfree(vb);
232 break;
233 }
234 }
235
2d86401c 236 q->bufs[q->num_buffers + buffer] = vb;
e23ccc0a
PO
237 }
238
2d86401c 239 __setup_offsets(q, buffer);
e23ccc0a
PO
240
241 dprintk(1, "Allocated %d buffers, %d plane(s) each\n",
2d86401c 242 buffer, num_planes);
e23ccc0a
PO
243
244 return buffer;
245}
246
247/**
248 * __vb2_free_mem() - release all video buffer memory for a given queue
249 */
2d86401c 250static void __vb2_free_mem(struct vb2_queue *q, unsigned int buffers)
e23ccc0a
PO
251{
252 unsigned int buffer;
253 struct vb2_buffer *vb;
254
2d86401c
GL
255 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
256 ++buffer) {
e23ccc0a
PO
257 vb = q->bufs[buffer];
258 if (!vb)
259 continue;
260
261 /* Free MMAP buffers or release USERPTR buffers */
262 if (q->memory == V4L2_MEMORY_MMAP)
263 __vb2_buf_mem_free(vb);
c5384048
SS
264 else if (q->memory == V4L2_MEMORY_DMABUF)
265 __vb2_buf_dmabuf_put(vb);
e23ccc0a
PO
266 else
267 __vb2_buf_userptr_put(vb);
268 }
269}
270
271/**
2d86401c
GL
272 * __vb2_queue_free() - free buffers at the end of the queue - video memory and
273 * related information, if no buffers are left return the queue to an
274 * uninitialized state. Might be called even if the queue has already been freed.
e23ccc0a 275 */
2d86401c 276static void __vb2_queue_free(struct vb2_queue *q, unsigned int buffers)
e23ccc0a
PO
277{
278 unsigned int buffer;
279
280 /* Call driver-provided cleanup function for each buffer, if provided */
281 if (q->ops->buf_cleanup) {
2d86401c
GL
282 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
283 ++buffer) {
e23ccc0a
PO
284 if (NULL == q->bufs[buffer])
285 continue;
286 q->ops->buf_cleanup(q->bufs[buffer]);
287 }
288 }
289
290 /* Release video buffer memory */
2d86401c 291 __vb2_free_mem(q, buffers);
e23ccc0a
PO
292
293 /* Free videobuf buffers */
2d86401c
GL
294 for (buffer = q->num_buffers - buffers; buffer < q->num_buffers;
295 ++buffer) {
e23ccc0a
PO
296 kfree(q->bufs[buffer]);
297 q->bufs[buffer] = NULL;
298 }
299
2d86401c
GL
300 q->num_buffers -= buffers;
301 if (!q->num_buffers)
302 q->memory = 0;
bd50d999 303 INIT_LIST_HEAD(&q->queued_list);
e23ccc0a
PO
304}
305
306/**
307 * __verify_planes_array() - verify that the planes array passed in struct
308 * v4l2_buffer from userspace can be safely used
309 */
2d86401c 310static int __verify_planes_array(struct vb2_buffer *vb, const struct v4l2_buffer *b)
e23ccc0a 311{
32a77260
HV
312 if (!V4L2_TYPE_IS_MULTIPLANAR(b->type))
313 return 0;
314
e23ccc0a
PO
315 /* Is memory for copying plane information present? */
316 if (NULL == b->m.planes) {
317 dprintk(1, "Multi-planar buffer passed but "
318 "planes array not provided\n");
319 return -EINVAL;
320 }
321
322 if (b->length < vb->num_planes || b->length > VIDEO_MAX_PLANES) {
323 dprintk(1, "Incorrect planes array length, "
324 "expected %d, got %d\n", vb->num_planes, b->length);
325 return -EINVAL;
326 }
327
328 return 0;
329}
330
25a27d91
MS
331/**
332 * __buffer_in_use() - return true if the buffer is in use and
333 * the queue cannot be freed (by the means of REQBUFS(0)) call
334 */
335static bool __buffer_in_use(struct vb2_queue *q, struct vb2_buffer *vb)
336{
337 unsigned int plane;
338 for (plane = 0; plane < vb->num_planes; ++plane) {
2c2dd6ac 339 void *mem_priv = vb->planes[plane].mem_priv;
25a27d91
MS
340 /*
341 * If num_users() has not been provided, call_memop
342 * will return 0, apparently nobody cares about this
343 * case anyway. If num_users() returns more than 1,
344 * we are not the only user of the plane's memory.
345 */
5931ffe3 346 if (mem_priv && call_memop(q, num_users, mem_priv) > 1)
25a27d91
MS
347 return true;
348 }
349 return false;
350}
351
352/**
353 * __buffers_in_use() - return true if any buffers on the queue are in use and
354 * the queue cannot be freed (by the means of REQBUFS(0)) call
355 */
356static bool __buffers_in_use(struct vb2_queue *q)
357{
358 unsigned int buffer;
359 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
360 if (__buffer_in_use(q, q->bufs[buffer]))
361 return true;
362 }
363 return false;
364}
365
e23ccc0a
PO
366/**
367 * __fill_v4l2_buffer() - fill in a struct v4l2_buffer with information to be
368 * returned to userspace
369 */
32a77260 370static void __fill_v4l2_buffer(struct vb2_buffer *vb, struct v4l2_buffer *b)
e23ccc0a
PO
371{
372 struct vb2_queue *q = vb->vb2_queue;
e23ccc0a 373
2b719d7b 374 /* Copy back data such as timestamp, flags, etc. */
e23ccc0a 375 memcpy(b, &vb->v4l2_buf, offsetof(struct v4l2_buffer, m));
2b719d7b 376 b->reserved2 = vb->v4l2_buf.reserved2;
e23ccc0a
PO
377 b->reserved = vb->v4l2_buf.reserved;
378
379 if (V4L2_TYPE_IS_MULTIPLANAR(q->type)) {
e23ccc0a
PO
380 /*
381 * Fill in plane-related data if userspace provided an array
32a77260 382 * for it. The caller has already verified memory and size.
e23ccc0a 383 */
3c0b6061 384 b->length = vb->num_planes;
e23ccc0a
PO
385 memcpy(b->m.planes, vb->v4l2_planes,
386 b->length * sizeof(struct v4l2_plane));
387 } else {
388 /*
389 * We use length and offset in v4l2_planes array even for
390 * single-planar buffers, but userspace does not.
391 */
392 b->length = vb->v4l2_planes[0].length;
393 b->bytesused = vb->v4l2_planes[0].bytesused;
394 if (q->memory == V4L2_MEMORY_MMAP)
395 b->m.offset = vb->v4l2_planes[0].m.mem_offset;
396 else if (q->memory == V4L2_MEMORY_USERPTR)
397 b->m.userptr = vb->v4l2_planes[0].m.userptr;
c5384048
SS
398 else if (q->memory == V4L2_MEMORY_DMABUF)
399 b->m.fd = vb->v4l2_planes[0].m.fd;
e23ccc0a
PO
400 }
401
ea42c8ec
MS
402 /*
403 * Clear any buffer state related flags.
404 */
1b18e7a0
SA
405 b->flags &= ~V4L2_BUFFER_MASK_FLAGS;
406 b->flags |= V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC;
e23ccc0a
PO
407
408 switch (vb->state) {
409 case VB2_BUF_STATE_QUEUED:
410 case VB2_BUF_STATE_ACTIVE:
411 b->flags |= V4L2_BUF_FLAG_QUEUED;
412 break;
413 case VB2_BUF_STATE_ERROR:
414 b->flags |= V4L2_BUF_FLAG_ERROR;
415 /* fall through */
416 case VB2_BUF_STATE_DONE:
417 b->flags |= V4L2_BUF_FLAG_DONE;
418 break;
ebc087d0 419 case VB2_BUF_STATE_PREPARED:
2d86401c
GL
420 b->flags |= V4L2_BUF_FLAG_PREPARED;
421 break;
422 case VB2_BUF_STATE_DEQUEUED:
e23ccc0a
PO
423 /* nothing */
424 break;
425 }
426
25a27d91 427 if (__buffer_in_use(q, vb))
e23ccc0a 428 b->flags |= V4L2_BUF_FLAG_MAPPED;
e23ccc0a
PO
429}
430
431/**
432 * vb2_querybuf() - query video buffer information
433 * @q: videobuf queue
434 * @b: buffer struct passed from userspace to vidioc_querybuf handler
435 * in driver
436 *
437 * Should be called from vidioc_querybuf ioctl handler in driver.
438 * This function will verify the passed v4l2_buffer structure and fill the
439 * relevant information for the userspace.
440 *
441 * The return values from this function are intended to be directly returned
442 * from vidioc_querybuf handler in driver.
443 */
444int vb2_querybuf(struct vb2_queue *q, struct v4l2_buffer *b)
445{
446 struct vb2_buffer *vb;
32a77260 447 int ret;
e23ccc0a
PO
448
449 if (b->type != q->type) {
450 dprintk(1, "querybuf: wrong buffer type\n");
451 return -EINVAL;
452 }
453
454 if (b->index >= q->num_buffers) {
455 dprintk(1, "querybuf: buffer index out of range\n");
456 return -EINVAL;
457 }
458 vb = q->bufs[b->index];
32a77260
HV
459 ret = __verify_planes_array(vb, b);
460 if (!ret)
461 __fill_v4l2_buffer(vb, b);
462 return ret;
e23ccc0a
PO
463}
464EXPORT_SYMBOL(vb2_querybuf);
465
466/**
467 * __verify_userptr_ops() - verify that all memory operations required for
468 * USERPTR queue type have been provided
469 */
470static int __verify_userptr_ops(struct vb2_queue *q)
471{
472 if (!(q->io_modes & VB2_USERPTR) || !q->mem_ops->get_userptr ||
473 !q->mem_ops->put_userptr)
474 return -EINVAL;
475
476 return 0;
477}
478
479/**
480 * __verify_mmap_ops() - verify that all memory operations required for
481 * MMAP queue type have been provided
482 */
483static int __verify_mmap_ops(struct vb2_queue *q)
484{
485 if (!(q->io_modes & VB2_MMAP) || !q->mem_ops->alloc ||
486 !q->mem_ops->put || !q->mem_ops->mmap)
487 return -EINVAL;
488
489 return 0;
490}
491
c5384048
SS
492/**
493 * __verify_dmabuf_ops() - verify that all memory operations required for
494 * DMABUF queue type have been provided
495 */
496static int __verify_dmabuf_ops(struct vb2_queue *q)
497{
498 if (!(q->io_modes & VB2_DMABUF) || !q->mem_ops->attach_dmabuf ||
499 !q->mem_ops->detach_dmabuf || !q->mem_ops->map_dmabuf ||
500 !q->mem_ops->unmap_dmabuf)
501 return -EINVAL;
502
503 return 0;
504}
505
e23ccc0a 506/**
37d9ed94
HV
507 * __verify_memory_type() - Check whether the memory type and buffer type
508 * passed to a buffer operation are compatible with the queue.
509 */
510static int __verify_memory_type(struct vb2_queue *q,
511 enum v4l2_memory memory, enum v4l2_buf_type type)
512{
c5384048
SS
513 if (memory != V4L2_MEMORY_MMAP && memory != V4L2_MEMORY_USERPTR &&
514 memory != V4L2_MEMORY_DMABUF) {
37d9ed94
HV
515 dprintk(1, "reqbufs: unsupported memory type\n");
516 return -EINVAL;
517 }
518
519 if (type != q->type) {
520 dprintk(1, "reqbufs: requested type is incorrect\n");
521 return -EINVAL;
522 }
523
524 /*
525 * Make sure all the required memory ops for given memory type
526 * are available.
527 */
528 if (memory == V4L2_MEMORY_MMAP && __verify_mmap_ops(q)) {
529 dprintk(1, "reqbufs: MMAP for current setup unsupported\n");
530 return -EINVAL;
531 }
532
533 if (memory == V4L2_MEMORY_USERPTR && __verify_userptr_ops(q)) {
534 dprintk(1, "reqbufs: USERPTR for current setup unsupported\n");
535 return -EINVAL;
536 }
537
c5384048
SS
538 if (memory == V4L2_MEMORY_DMABUF && __verify_dmabuf_ops(q)) {
539 dprintk(1, "reqbufs: DMABUF for current setup unsupported\n");
540 return -EINVAL;
541 }
542
37d9ed94
HV
543 /*
544 * Place the busy tests at the end: -EBUSY can be ignored when
545 * create_bufs is called with count == 0, but count == 0 should still
546 * do the memory and type validation.
547 */
548 if (q->fileio) {
549 dprintk(1, "reqbufs: file io in progress\n");
550 return -EBUSY;
551 }
552 return 0;
553}
554
555/**
556 * __reqbufs() - Initiate streaming
e23ccc0a
PO
557 * @q: videobuf2 queue
558 * @req: struct passed from userspace to vidioc_reqbufs handler in driver
559 *
560 * Should be called from vidioc_reqbufs ioctl handler of a driver.
561 * This function:
562 * 1) verifies streaming parameters passed from the userspace,
563 * 2) sets up the queue,
564 * 3) negotiates number of buffers and planes per buffer with the driver
565 * to be used during streaming,
566 * 4) allocates internal buffer structures (struct vb2_buffer), according to
567 * the agreed parameters,
568 * 5) for MMAP memory type, allocates actual video memory, using the
569 * memory handling/allocation routines provided during queue initialization
570 *
571 * If req->count is 0, all the memory will be freed instead.
572 * If the queue has been allocated previously (by a previous vb2_reqbufs) call
573 * and the queue is not busy, memory will be reallocated.
574 *
575 * The return values from this function are intended to be directly returned
576 * from vidioc_reqbufs handler in driver.
577 */
37d9ed94 578static int __reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req)
e23ccc0a 579{
2d86401c 580 unsigned int num_buffers, allocated_buffers, num_planes = 0;
37d9ed94 581 int ret;
e23ccc0a
PO
582
583 if (q->streaming) {
584 dprintk(1, "reqbufs: streaming active\n");
585 return -EBUSY;
586 }
587
29e3fbd8 588 if (req->count == 0 || q->num_buffers != 0 || q->memory != req->memory) {
e23ccc0a
PO
589 /*
590 * We already have buffers allocated, so first check if they
591 * are not in use and can be freed.
592 */
593 if (q->memory == V4L2_MEMORY_MMAP && __buffers_in_use(q)) {
594 dprintk(1, "reqbufs: memory in use, cannot free\n");
595 return -EBUSY;
596 }
597
2d86401c 598 __vb2_queue_free(q, q->num_buffers);
29e3fbd8
MS
599
600 /*
601 * In case of REQBUFS(0) return immediately without calling
602 * driver's queue_setup() callback and allocating resources.
603 */
604 if (req->count == 0)
605 return 0;
e23ccc0a
PO
606 }
607
608 /*
609 * Make sure the requested values and current defaults are sane.
610 */
611 num_buffers = min_t(unsigned int, req->count, VIDEO_MAX_FRAME);
c1426bc7 612 memset(q->plane_sizes, 0, sizeof(q->plane_sizes));
e23ccc0a 613 memset(q->alloc_ctx, 0, sizeof(q->alloc_ctx));
13b14095 614 q->memory = req->memory;
e23ccc0a
PO
615
616 /*
617 * Ask the driver how many buffers and planes per buffer it requires.
618 * Driver also sets the size and allocator context for each plane.
619 */
fc714e70 620 ret = call_qop(q, queue_setup, q, NULL, &num_buffers, &num_planes,
c1426bc7 621 q->plane_sizes, q->alloc_ctx);
e23ccc0a
PO
622 if (ret)
623 return ret;
624
625 /* Finally, allocate buffers and video memory */
c1426bc7 626 ret = __vb2_queue_alloc(q, req->memory, num_buffers, num_planes);
66072d4f
MS
627 if (ret == 0) {
628 dprintk(1, "Memory allocation failed\n");
629 return -ENOMEM;
e23ccc0a
PO
630 }
631
2d86401c
GL
632 allocated_buffers = ret;
633
e23ccc0a
PO
634 /*
635 * Check if driver can handle the allocated number of buffers.
636 */
2d86401c
GL
637 if (allocated_buffers < num_buffers) {
638 num_buffers = allocated_buffers;
e23ccc0a 639
fc714e70
GL
640 ret = call_qop(q, queue_setup, q, NULL, &num_buffers,
641 &num_planes, q->plane_sizes, q->alloc_ctx);
e23ccc0a 642
2d86401c 643 if (!ret && allocated_buffers < num_buffers)
e23ccc0a 644 ret = -ENOMEM;
e23ccc0a
PO
645
646 /*
2d86401c
GL
647 * Either the driver has accepted a smaller number of buffers,
648 * or .queue_setup() returned an error
e23ccc0a 649 */
2d86401c
GL
650 }
651
652 q->num_buffers = allocated_buffers;
653
654 if (ret < 0) {
655 __vb2_queue_free(q, allocated_buffers);
656 return ret;
e23ccc0a
PO
657 }
658
e23ccc0a
PO
659 /*
660 * Return the number of successfully allocated buffers
661 * to the userspace.
662 */
2d86401c 663 req->count = allocated_buffers;
e23ccc0a
PO
664
665 return 0;
e23ccc0a 666}
37d9ed94
HV
667
668/**
669 * vb2_reqbufs() - Wrapper for __reqbufs() that also verifies the memory and
670 * type values.
671 * @q: videobuf2 queue
672 * @req: struct passed from userspace to vidioc_reqbufs handler in driver
673 */
674int vb2_reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req)
675{
676 int ret = __verify_memory_type(q, req->memory, req->type);
677
678 return ret ? ret : __reqbufs(q, req);
679}
e23ccc0a
PO
680EXPORT_SYMBOL_GPL(vb2_reqbufs);
681
2d86401c 682/**
37d9ed94 683 * __create_bufs() - Allocate buffers and any required auxiliary structs
2d86401c
GL
684 * @q: videobuf2 queue
685 * @create: creation parameters, passed from userspace to vidioc_create_bufs
686 * handler in driver
687 *
688 * Should be called from vidioc_create_bufs ioctl handler of a driver.
689 * This function:
690 * 1) verifies parameter sanity
691 * 2) calls the .queue_setup() queue operation
692 * 3) performs any necessary memory allocations
693 *
694 * The return values from this function are intended to be directly returned
695 * from vidioc_create_bufs handler in driver.
696 */
37d9ed94 697static int __create_bufs(struct vb2_queue *q, struct v4l2_create_buffers *create)
2d86401c
GL
698{
699 unsigned int num_planes = 0, num_buffers, allocated_buffers;
37d9ed94 700 int ret;
2d86401c
GL
701
702 if (q->num_buffers == VIDEO_MAX_FRAME) {
703 dprintk(1, "%s(): maximum number of buffers already allocated\n",
704 __func__);
705 return -ENOBUFS;
706 }
707
2d86401c
GL
708 if (!q->num_buffers) {
709 memset(q->plane_sizes, 0, sizeof(q->plane_sizes));
710 memset(q->alloc_ctx, 0, sizeof(q->alloc_ctx));
711 q->memory = create->memory;
712 }
713
714 num_buffers = min(create->count, VIDEO_MAX_FRAME - q->num_buffers);
715
716 /*
717 * Ask the driver, whether the requested number of buffers, planes per
718 * buffer and their sizes are acceptable
719 */
720 ret = call_qop(q, queue_setup, q, &create->format, &num_buffers,
721 &num_planes, q->plane_sizes, q->alloc_ctx);
722 if (ret)
723 return ret;
724
725 /* Finally, allocate buffers and video memory */
726 ret = __vb2_queue_alloc(q, create->memory, num_buffers,
727 num_planes);
f05393d2
HV
728 if (ret == 0) {
729 dprintk(1, "Memory allocation failed\n");
730 return -ENOMEM;
2d86401c
GL
731 }
732
733 allocated_buffers = ret;
734
735 /*
736 * Check if driver can handle the so far allocated number of buffers.
737 */
738 if (ret < num_buffers) {
739 num_buffers = ret;
740
741 /*
742 * q->num_buffers contains the total number of buffers, that the
743 * queue driver has set up
744 */
745 ret = call_qop(q, queue_setup, q, &create->format, &num_buffers,
746 &num_planes, q->plane_sizes, q->alloc_ctx);
747
748 if (!ret && allocated_buffers < num_buffers)
749 ret = -ENOMEM;
750
751 /*
752 * Either the driver has accepted a smaller number of buffers,
753 * or .queue_setup() returned an error
754 */
755 }
756
757 q->num_buffers += allocated_buffers;
758
759 if (ret < 0) {
760 __vb2_queue_free(q, allocated_buffers);
f05393d2 761 return -ENOMEM;
2d86401c
GL
762 }
763
764 /*
765 * Return the number of successfully allocated buffers
766 * to the userspace.
767 */
768 create->count = allocated_buffers;
769
770 return 0;
771}
37d9ed94
HV
772
773/**
53aa3b19
NT
774 * vb2_create_bufs() - Wrapper for __create_bufs() that also verifies the
775 * memory and type values.
37d9ed94
HV
776 * @q: videobuf2 queue
777 * @create: creation parameters, passed from userspace to vidioc_create_bufs
778 * handler in driver
779 */
780int vb2_create_bufs(struct vb2_queue *q, struct v4l2_create_buffers *create)
781{
782 int ret = __verify_memory_type(q, create->memory, create->format.type);
783
784 create->index = q->num_buffers;
f05393d2
HV
785 if (create->count == 0)
786 return ret != -EBUSY ? ret : 0;
37d9ed94
HV
787 return ret ? ret : __create_bufs(q, create);
788}
2d86401c
GL
789EXPORT_SYMBOL_GPL(vb2_create_bufs);
790
e23ccc0a
PO
791/**
792 * vb2_plane_vaddr() - Return a kernel virtual address of a given plane
793 * @vb: vb2_buffer to which the plane in question belongs to
794 * @plane_no: plane number for which the address is to be returned
795 *
796 * This function returns a kernel virtual address of a given plane if
797 * such a mapping exist, NULL otherwise.
798 */
799void *vb2_plane_vaddr(struct vb2_buffer *vb, unsigned int plane_no)
800{
801 struct vb2_queue *q = vb->vb2_queue;
802
a00d0266 803 if (plane_no > vb->num_planes || !vb->planes[plane_no].mem_priv)
e23ccc0a
PO
804 return NULL;
805
5931ffe3 806 return call_memop(q, vaddr, vb->planes[plane_no].mem_priv);
e23ccc0a
PO
807
808}
809EXPORT_SYMBOL_GPL(vb2_plane_vaddr);
810
811/**
812 * vb2_plane_cookie() - Return allocator specific cookie for the given plane
813 * @vb: vb2_buffer to which the plane in question belongs to
814 * @plane_no: plane number for which the cookie is to be returned
815 *
816 * This function returns an allocator specific cookie for a given plane if
817 * available, NULL otherwise. The allocator should provide some simple static
818 * inline function, which would convert this cookie to the allocator specific
819 * type that can be used directly by the driver to access the buffer. This can
820 * be for example physical address, pointer to scatter list or IOMMU mapping.
821 */
822void *vb2_plane_cookie(struct vb2_buffer *vb, unsigned int plane_no)
823{
824 struct vb2_queue *q = vb->vb2_queue;
825
a00d0266 826 if (plane_no > vb->num_planes || !vb->planes[plane_no].mem_priv)
e23ccc0a
PO
827 return NULL;
828
5931ffe3 829 return call_memop(q, cookie, vb->planes[plane_no].mem_priv);
e23ccc0a
PO
830}
831EXPORT_SYMBOL_GPL(vb2_plane_cookie);
832
833/**
834 * vb2_buffer_done() - inform videobuf that an operation on a buffer is finished
835 * @vb: vb2_buffer returned from the driver
836 * @state: either VB2_BUF_STATE_DONE if the operation finished successfully
837 * or VB2_BUF_STATE_ERROR if the operation finished with an error
838 *
839 * This function should be called by the driver after a hardware operation on
840 * a buffer is finished and the buffer may be returned to userspace. The driver
841 * cannot use this buffer anymore until it is queued back to it by videobuf
842 * by the means of buf_queue callback. Only buffers previously queued to the
843 * driver by buf_queue can be passed to this function.
844 */
845void vb2_buffer_done(struct vb2_buffer *vb, enum vb2_buffer_state state)
846{
847 struct vb2_queue *q = vb->vb2_queue;
848 unsigned long flags;
3e0c2f20 849 unsigned int plane;
e23ccc0a
PO
850
851 if (vb->state != VB2_BUF_STATE_ACTIVE)
852 return;
853
854 if (state != VB2_BUF_STATE_DONE && state != VB2_BUF_STATE_ERROR)
855 return;
856
857 dprintk(4, "Done processing on buffer %d, state: %d\n",
858 vb->v4l2_buf.index, vb->state);
859
3e0c2f20
MS
860 /* sync buffers */
861 for (plane = 0; plane < vb->num_planes; ++plane)
862 call_memop(q, finish, vb->planes[plane].mem_priv);
863
e23ccc0a
PO
864 /* Add the buffer to the done buffers list */
865 spin_lock_irqsave(&q->done_lock, flags);
866 vb->state = state;
867 list_add_tail(&vb->done_entry, &q->done_list);
868 atomic_dec(&q->queued_count);
869 spin_unlock_irqrestore(&q->done_lock, flags);
870
871 /* Inform any processes that may be waiting for buffers */
872 wake_up(&q->done_wq);
873}
874EXPORT_SYMBOL_GPL(vb2_buffer_done);
875
876/**
32a77260
HV
877 * __fill_vb2_buffer() - fill a vb2_buffer with information provided in a
878 * v4l2_buffer by the userspace. The caller has already verified that struct
879 * v4l2_buffer has a valid number of planes.
e23ccc0a 880 */
32a77260 881static void __fill_vb2_buffer(struct vb2_buffer *vb, const struct v4l2_buffer *b,
e23ccc0a
PO
882 struct v4l2_plane *v4l2_planes)
883{
884 unsigned int plane;
e23ccc0a
PO
885
886 if (V4L2_TYPE_IS_MULTIPLANAR(b->type)) {
e23ccc0a
PO
887 /* Fill in driver-provided information for OUTPUT types */
888 if (V4L2_TYPE_IS_OUTPUT(b->type)) {
889 /*
890 * Will have to go up to b->length when API starts
891 * accepting variable number of planes.
892 */
893 for (plane = 0; plane < vb->num_planes; ++plane) {
894 v4l2_planes[plane].bytesused =
895 b->m.planes[plane].bytesused;
896 v4l2_planes[plane].data_offset =
897 b->m.planes[plane].data_offset;
898 }
899 }
900
901 if (b->memory == V4L2_MEMORY_USERPTR) {
902 for (plane = 0; plane < vb->num_planes; ++plane) {
903 v4l2_planes[plane].m.userptr =
904 b->m.planes[plane].m.userptr;
905 v4l2_planes[plane].length =
906 b->m.planes[plane].length;
907 }
908 }
c5384048
SS
909 if (b->memory == V4L2_MEMORY_DMABUF) {
910 for (plane = 0; plane < vb->num_planes; ++plane) {
911 v4l2_planes[plane].m.fd =
912 b->m.planes[plane].m.fd;
913 v4l2_planes[plane].length =
914 b->m.planes[plane].length;
915 v4l2_planes[plane].data_offset =
916 b->m.planes[plane].data_offset;
917 }
918 }
e23ccc0a
PO
919 } else {
920 /*
921 * Single-planar buffers do not use planes array,
922 * so fill in relevant v4l2_buffer struct fields instead.
923 * In videobuf we use our internal V4l2_planes struct for
924 * single-planar buffers as well, for simplicity.
925 */
ac706bf7 926 if (V4L2_TYPE_IS_OUTPUT(b->type)) {
e23ccc0a 927 v4l2_planes[0].bytesused = b->bytesused;
ac706bf7
LP
928 v4l2_planes[0].data_offset = 0;
929 }
e23ccc0a
PO
930
931 if (b->memory == V4L2_MEMORY_USERPTR) {
932 v4l2_planes[0].m.userptr = b->m.userptr;
933 v4l2_planes[0].length = b->length;
934 }
c5384048
SS
935
936 if (b->memory == V4L2_MEMORY_DMABUF) {
937 v4l2_planes[0].m.fd = b->m.fd;
938 v4l2_planes[0].length = b->length;
939 v4l2_planes[0].data_offset = 0;
940 }
941
e23ccc0a
PO
942 }
943
944 vb->v4l2_buf.field = b->field;
945 vb->v4l2_buf.timestamp = b->timestamp;
1b18e7a0 946 vb->v4l2_buf.flags = b->flags & ~V4L2_BUFFER_MASK_FLAGS;
e23ccc0a
PO
947}
948
949/**
950 * __qbuf_userptr() - handle qbuf of a USERPTR buffer
951 */
2d86401c 952static int __qbuf_userptr(struct vb2_buffer *vb, const struct v4l2_buffer *b)
e23ccc0a
PO
953{
954 struct v4l2_plane planes[VIDEO_MAX_PLANES];
955 struct vb2_queue *q = vb->vb2_queue;
956 void *mem_priv;
957 unsigned int plane;
958 int ret;
959 int write = !V4L2_TYPE_IS_OUTPUT(q->type);
960
32a77260
HV
961 /* Copy relevant information provided by the userspace */
962 __fill_vb2_buffer(vb, b, planes);
e23ccc0a
PO
963
964 for (plane = 0; plane < vb->num_planes; ++plane) {
965 /* Skip the plane if already verified */
f0b7c7fc
MS
966 if (vb->v4l2_planes[plane].m.userptr &&
967 vb->v4l2_planes[plane].m.userptr == planes[plane].m.userptr
e23ccc0a
PO
968 && vb->v4l2_planes[plane].length == planes[plane].length)
969 continue;
970
971 dprintk(3, "qbuf: userspace address for plane %d changed, "
972 "reacquiring memory\n", plane);
973
c1426bc7
MS
974 /* Check if the provided plane buffer is large enough */
975 if (planes[plane].length < q->plane_sizes[plane]) {
4c2625db 976 ret = -EINVAL;
c1426bc7
MS
977 goto err;
978 }
979
e23ccc0a
PO
980 /* Release previously acquired memory if present */
981 if (vb->planes[plane].mem_priv)
5931ffe3 982 call_memop(q, put_userptr, vb->planes[plane].mem_priv);
e23ccc0a
PO
983
984 vb->planes[plane].mem_priv = NULL;
c1426bc7
MS
985 vb->v4l2_planes[plane].m.userptr = 0;
986 vb->v4l2_planes[plane].length = 0;
e23ccc0a
PO
987
988 /* Acquire each plane's memory */
a00d0266
MS
989 mem_priv = call_memop(q, get_userptr, q->alloc_ctx[plane],
990 planes[plane].m.userptr,
991 planes[plane].length, write);
992 if (IS_ERR_OR_NULL(mem_priv)) {
993 dprintk(1, "qbuf: failed acquiring userspace "
e23ccc0a 994 "memory for plane %d\n", plane);
a00d0266
MS
995 ret = mem_priv ? PTR_ERR(mem_priv) : -EINVAL;
996 goto err;
e23ccc0a 997 }
a00d0266 998 vb->planes[plane].mem_priv = mem_priv;
e23ccc0a
PO
999 }
1000
1001 /*
1002 * Call driver-specific initialization on the newly acquired buffer,
1003 * if provided.
1004 */
1005 ret = call_qop(q, buf_init, vb);
1006 if (ret) {
1007 dprintk(1, "qbuf: buffer initialization failed\n");
1008 goto err;
1009 }
1010
1011 /*
1012 * Now that everything is in order, copy relevant information
1013 * provided by userspace.
1014 */
1015 for (plane = 0; plane < vb->num_planes; ++plane)
1016 vb->v4l2_planes[plane] = planes[plane];
1017
1018 return 0;
1019err:
1020 /* In case of errors, release planes that were already acquired */
c1426bc7
MS
1021 for (plane = 0; plane < vb->num_planes; ++plane) {
1022 if (vb->planes[plane].mem_priv)
5931ffe3 1023 call_memop(q, put_userptr, vb->planes[plane].mem_priv);
c1426bc7
MS
1024 vb->planes[plane].mem_priv = NULL;
1025 vb->v4l2_planes[plane].m.userptr = 0;
1026 vb->v4l2_planes[plane].length = 0;
e23ccc0a
PO
1027 }
1028
1029 return ret;
1030}
1031
1032/**
1033 * __qbuf_mmap() - handle qbuf of an MMAP buffer
1034 */
2d86401c 1035static int __qbuf_mmap(struct vb2_buffer *vb, const struct v4l2_buffer *b)
e23ccc0a 1036{
32a77260
HV
1037 __fill_vb2_buffer(vb, b, vb->v4l2_planes);
1038 return 0;
e23ccc0a
PO
1039}
1040
c5384048
SS
1041/**
1042 * __qbuf_dmabuf() - handle qbuf of a DMABUF buffer
1043 */
1044static int __qbuf_dmabuf(struct vb2_buffer *vb, const struct v4l2_buffer *b)
1045{
1046 struct v4l2_plane planes[VIDEO_MAX_PLANES];
1047 struct vb2_queue *q = vb->vb2_queue;
1048 void *mem_priv;
1049 unsigned int plane;
1050 int ret;
1051 int write = !V4L2_TYPE_IS_OUTPUT(q->type);
1052
1053 /* Verify and copy relevant information provided by the userspace */
1054 __fill_vb2_buffer(vb, b, planes);
1055
1056 for (plane = 0; plane < vb->num_planes; ++plane) {
1057 struct dma_buf *dbuf = dma_buf_get(planes[plane].m.fd);
1058
1059 if (IS_ERR_OR_NULL(dbuf)) {
1060 dprintk(1, "qbuf: invalid dmabuf fd for plane %d\n",
1061 plane);
1062 ret = -EINVAL;
1063 goto err;
1064 }
1065
1066 /* use DMABUF size if length is not provided */
1067 if (planes[plane].length == 0)
1068 planes[plane].length = dbuf->size;
1069
1070 if (planes[plane].length < planes[plane].data_offset +
1071 q->plane_sizes[plane]) {
1072 ret = -EINVAL;
1073 goto err;
1074 }
1075
1076 /* Skip the plane if already verified */
1077 if (dbuf == vb->planes[plane].dbuf &&
1078 vb->v4l2_planes[plane].length == planes[plane].length) {
1079 dma_buf_put(dbuf);
1080 continue;
1081 }
1082
1083 dprintk(1, "qbuf: buffer for plane %d changed\n", plane);
1084
1085 /* Release previously acquired memory if present */
1086 __vb2_plane_dmabuf_put(q, &vb->planes[plane]);
1087 memset(&vb->v4l2_planes[plane], 0, sizeof(struct v4l2_plane));
1088
1089 /* Acquire each plane's memory */
1090 mem_priv = call_memop(q, attach_dmabuf, q->alloc_ctx[plane],
1091 dbuf, planes[plane].length, write);
1092 if (IS_ERR(mem_priv)) {
1093 dprintk(1, "qbuf: failed to attach dmabuf\n");
1094 ret = PTR_ERR(mem_priv);
1095 dma_buf_put(dbuf);
1096 goto err;
1097 }
1098
1099 vb->planes[plane].dbuf = dbuf;
1100 vb->planes[plane].mem_priv = mem_priv;
1101 }
1102
1103 /* TODO: This pins the buffer(s) with dma_buf_map_attachment()).. but
1104 * really we want to do this just before the DMA, not while queueing
1105 * the buffer(s)..
1106 */
1107 for (plane = 0; plane < vb->num_planes; ++plane) {
1108 ret = call_memop(q, map_dmabuf, vb->planes[plane].mem_priv);
1109 if (ret) {
1110 dprintk(1, "qbuf: failed to map dmabuf for plane %d\n",
1111 plane);
1112 goto err;
1113 }
1114 vb->planes[plane].dbuf_mapped = 1;
1115 }
1116
1117 /*
1118 * Call driver-specific initialization on the newly acquired buffer,
1119 * if provided.
1120 */
1121 ret = call_qop(q, buf_init, vb);
1122 if (ret) {
1123 dprintk(1, "qbuf: buffer initialization failed\n");
1124 goto err;
1125 }
1126
1127 /*
1128 * Now that everything is in order, copy relevant information
1129 * provided by userspace.
1130 */
1131 for (plane = 0; plane < vb->num_planes; ++plane)
1132 vb->v4l2_planes[plane] = planes[plane];
1133
1134 return 0;
1135err:
1136 /* In case of errors, release planes that were already acquired */
1137 __vb2_buf_dmabuf_put(vb);
1138
1139 return ret;
1140}
1141
e23ccc0a
PO
1142/**
1143 * __enqueue_in_driver() - enqueue a vb2_buffer in driver for processing
1144 */
1145static void __enqueue_in_driver(struct vb2_buffer *vb)
1146{
1147 struct vb2_queue *q = vb->vb2_queue;
3e0c2f20 1148 unsigned int plane;
e23ccc0a
PO
1149
1150 vb->state = VB2_BUF_STATE_ACTIVE;
1151 atomic_inc(&q->queued_count);
3e0c2f20
MS
1152
1153 /* sync buffers */
1154 for (plane = 0; plane < vb->num_planes; ++plane)
1155 call_memop(q, prepare, vb->planes[plane].mem_priv);
1156
e23ccc0a
PO
1157 q->ops->buf_queue(vb);
1158}
1159
2d86401c 1160static int __buf_prepare(struct vb2_buffer *vb, const struct v4l2_buffer *b)
ebc087d0
GL
1161{
1162 struct vb2_queue *q = vb->vb2_queue;
1163 int ret;
1164
1165 switch (q->memory) {
1166 case V4L2_MEMORY_MMAP:
1167 ret = __qbuf_mmap(vb, b);
1168 break;
1169 case V4L2_MEMORY_USERPTR:
1170 ret = __qbuf_userptr(vb, b);
1171 break;
c5384048
SS
1172 case V4L2_MEMORY_DMABUF:
1173 ret = __qbuf_dmabuf(vb, b);
1174 break;
ebc087d0
GL
1175 default:
1176 WARN(1, "Invalid queue type\n");
1177 ret = -EINVAL;
1178 }
1179
1180 if (!ret)
1181 ret = call_qop(q, buf_prepare, vb);
1182 if (ret)
1183 dprintk(1, "qbuf: buffer preparation failed: %d\n", ret);
1184 else
1185 vb->state = VB2_BUF_STATE_PREPARED;
1186
1187 return ret;
1188}
1189
2d86401c
GL
1190/**
1191 * vb2_prepare_buf() - Pass ownership of a buffer from userspace to the kernel
1192 * @q: videobuf2 queue
1193 * @b: buffer structure passed from userspace to vidioc_prepare_buf
1194 * handler in driver
1195 *
1196 * Should be called from vidioc_prepare_buf ioctl handler of a driver.
1197 * This function:
1198 * 1) verifies the passed buffer,
1199 * 2) calls buf_prepare callback in the driver (if provided), in which
1200 * driver-specific buffer initialization can be performed,
1201 *
1202 * The return values from this function are intended to be directly returned
1203 * from vidioc_prepare_buf handler in driver.
1204 */
1205int vb2_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b)
1206{
1207 struct vb2_buffer *vb;
1208 int ret;
1209
1210 if (q->fileio) {
1211 dprintk(1, "%s(): file io in progress\n", __func__);
1212 return -EBUSY;
1213 }
1214
1215 if (b->type != q->type) {
1216 dprintk(1, "%s(): invalid buffer type\n", __func__);
1217 return -EINVAL;
1218 }
1219
1220 if (b->index >= q->num_buffers) {
1221 dprintk(1, "%s(): buffer index out of range\n", __func__);
1222 return -EINVAL;
1223 }
1224
1225 vb = q->bufs[b->index];
1226 if (NULL == vb) {
1227 /* Should never happen */
1228 dprintk(1, "%s(): buffer is NULL\n", __func__);
1229 return -EINVAL;
1230 }
1231
1232 if (b->memory != q->memory) {
1233 dprintk(1, "%s(): invalid memory type\n", __func__);
1234 return -EINVAL;
1235 }
1236
1237 if (vb->state != VB2_BUF_STATE_DEQUEUED) {
1238 dprintk(1, "%s(): invalid buffer state %d\n", __func__, vb->state);
1239 return -EINVAL;
1240 }
32a77260
HV
1241 ret = __verify_planes_array(vb, b);
1242 if (ret < 0)
1243 return ret;
2d86401c
GL
1244 ret = __buf_prepare(vb, b);
1245 if (ret < 0)
1246 return ret;
1247
1248 __fill_v4l2_buffer(vb, b);
1249
1250 return 0;
1251}
1252EXPORT_SYMBOL_GPL(vb2_prepare_buf);
1253
e23ccc0a
PO
1254/**
1255 * vb2_qbuf() - Queue a buffer from userspace
1256 * @q: videobuf2 queue
1257 * @b: buffer structure passed from userspace to vidioc_qbuf handler
1258 * in driver
1259 *
1260 * Should be called from vidioc_qbuf ioctl handler of a driver.
1261 * This function:
1262 * 1) verifies the passed buffer,
ebc087d0
GL
1263 * 2) if necessary, calls buf_prepare callback in the driver (if provided), in
1264 * which driver-specific buffer initialization can be performed,
e23ccc0a
PO
1265 * 3) if streaming is on, queues the buffer in driver by the means of buf_queue
1266 * callback for processing.
1267 *
1268 * The return values from this function are intended to be directly returned
1269 * from vidioc_qbuf handler in driver.
1270 */
1271int vb2_qbuf(struct vb2_queue *q, struct v4l2_buffer *b)
1272{
b037c0fd 1273 struct rw_semaphore *mmap_sem = NULL;
e23ccc0a 1274 struct vb2_buffer *vb;
b037c0fd
MS
1275 int ret = 0;
1276
1277 /*
1278 * In case of user pointer buffers vb2 allocator needs to get direct
1279 * access to userspace pages. This requires getting read access on
1280 * mmap semaphore in the current process structure. The same
1281 * semaphore is taken before calling mmap operation, while both mmap
1282 * and qbuf are called by the driver or v4l2 core with driver's lock
1283 * held. To avoid a AB-BA deadlock (mmap_sem then driver's lock in
1284 * mmap and driver's lock then mmap_sem in qbuf) the videobuf2 core
1285 * release driver's lock, takes mmap_sem and then takes again driver's
1286 * lock.
1287 *
1288 * To avoid race with other vb2 calls, which might be called after
1289 * releasing driver's lock, this operation is performed at the
1290 * beggining of qbuf processing. This way the queue status is
1291 * consistent after getting driver's lock back.
1292 */
57e43cfb 1293 if (q->memory == V4L2_MEMORY_USERPTR) {
b037c0fd
MS
1294 mmap_sem = &current->mm->mmap_sem;
1295 call_qop(q, wait_prepare, q);
1296 down_read(mmap_sem);
1297 call_qop(q, wait_finish, q);
1298 }
e23ccc0a 1299
b25748fe
MS
1300 if (q->fileio) {
1301 dprintk(1, "qbuf: file io in progress\n");
b037c0fd
MS
1302 ret = -EBUSY;
1303 goto unlock;
b25748fe
MS
1304 }
1305
e23ccc0a
PO
1306 if (b->type != q->type) {
1307 dprintk(1, "qbuf: invalid buffer type\n");
b037c0fd
MS
1308 ret = -EINVAL;
1309 goto unlock;
e23ccc0a
PO
1310 }
1311
1312 if (b->index >= q->num_buffers) {
1313 dprintk(1, "qbuf: buffer index out of range\n");
b037c0fd
MS
1314 ret = -EINVAL;
1315 goto unlock;
e23ccc0a
PO
1316 }
1317
1318 vb = q->bufs[b->index];
1319 if (NULL == vb) {
1320 /* Should never happen */
1321 dprintk(1, "qbuf: buffer is NULL\n");
b037c0fd
MS
1322 ret = -EINVAL;
1323 goto unlock;
e23ccc0a
PO
1324 }
1325
1326 if (b->memory != q->memory) {
1327 dprintk(1, "qbuf: invalid memory type\n");
b037c0fd
MS
1328 ret = -EINVAL;
1329 goto unlock;
e23ccc0a 1330 }
32a77260
HV
1331 ret = __verify_planes_array(vb, b);
1332 if (ret)
1333 goto unlock;
e23ccc0a 1334
ebc087d0
GL
1335 switch (vb->state) {
1336 case VB2_BUF_STATE_DEQUEUED:
1337 ret = __buf_prepare(vb, b);
1338 if (ret)
b037c0fd 1339 goto unlock;
ebc087d0
GL
1340 case VB2_BUF_STATE_PREPARED:
1341 break;
1342 default:
e23ccc0a 1343 dprintk(1, "qbuf: buffer already in use\n");
b037c0fd
MS
1344 ret = -EINVAL;
1345 goto unlock;
e23ccc0a
PO
1346 }
1347
e23ccc0a
PO
1348 /*
1349 * Add to the queued buffers list, a buffer will stay on it until
1350 * dequeued in dqbuf.
1351 */
1352 list_add_tail(&vb->queued_entry, &q->queued_list);
1353 vb->state = VB2_BUF_STATE_QUEUED;
1354
1355 /*
1356 * If already streaming, give the buffer to driver for processing.
1357 * If not, the buffer will be given to driver on next streamon.
1358 */
1359 if (q->streaming)
1360 __enqueue_in_driver(vb);
1361
21db3e07
GL
1362 /* Fill buffer information for the userspace */
1363 __fill_v4l2_buffer(vb, b);
1364
e23ccc0a 1365 dprintk(1, "qbuf of buffer %d succeeded\n", vb->v4l2_buf.index);
b037c0fd
MS
1366unlock:
1367 if (mmap_sem)
1368 up_read(mmap_sem);
1369 return ret;
e23ccc0a
PO
1370}
1371EXPORT_SYMBOL_GPL(vb2_qbuf);
1372
1373/**
1374 * __vb2_wait_for_done_vb() - wait for a buffer to become available
1375 * for dequeuing
1376 *
1377 * Will sleep if required for nonblocking == false.
1378 */
1379static int __vb2_wait_for_done_vb(struct vb2_queue *q, int nonblocking)
1380{
1381 /*
1382 * All operations on vb_done_list are performed under done_lock
1383 * spinlock protection. However, buffers may be removed from
1384 * it and returned to userspace only while holding both driver's
1385 * lock and the done_lock spinlock. Thus we can be sure that as
1386 * long as we hold the driver's lock, the list will remain not
1387 * empty if list_empty() check succeeds.
1388 */
1389
1390 for (;;) {
1391 int ret;
1392
1393 if (!q->streaming) {
1394 dprintk(1, "Streaming off, will not wait for buffers\n");
1395 return -EINVAL;
1396 }
1397
1398 if (!list_empty(&q->done_list)) {
1399 /*
1400 * Found a buffer that we were waiting for.
1401 */
1402 break;
1403 }
1404
1405 if (nonblocking) {
1406 dprintk(1, "Nonblocking and no buffers to dequeue, "
1407 "will not wait\n");
1408 return -EAGAIN;
1409 }
1410
1411 /*
1412 * We are streaming and blocking, wait for another buffer to
1413 * become ready or for streamoff. Driver's lock is released to
1414 * allow streamoff or qbuf to be called while waiting.
1415 */
1416 call_qop(q, wait_prepare, q);
1417
1418 /*
1419 * All locks have been released, it is safe to sleep now.
1420 */
1421 dprintk(3, "Will sleep waiting for buffers\n");
1422 ret = wait_event_interruptible(q->done_wq,
1423 !list_empty(&q->done_list) || !q->streaming);
1424
1425 /*
1426 * We need to reevaluate both conditions again after reacquiring
1427 * the locks or return an error if one occurred.
1428 */
1429 call_qop(q, wait_finish, q);
32a77260
HV
1430 if (ret) {
1431 dprintk(1, "Sleep was interrupted\n");
e23ccc0a 1432 return ret;
32a77260 1433 }
e23ccc0a
PO
1434 }
1435 return 0;
1436}
1437
1438/**
1439 * __vb2_get_done_vb() - get a buffer ready for dequeuing
1440 *
1441 * Will sleep if required for nonblocking == false.
1442 */
1443static int __vb2_get_done_vb(struct vb2_queue *q, struct vb2_buffer **vb,
32a77260 1444 struct v4l2_buffer *b, int nonblocking)
e23ccc0a
PO
1445{
1446 unsigned long flags;
1447 int ret;
1448
1449 /*
1450 * Wait for at least one buffer to become available on the done_list.
1451 */
1452 ret = __vb2_wait_for_done_vb(q, nonblocking);
1453 if (ret)
1454 return ret;
1455
1456 /*
1457 * Driver's lock has been held since we last verified that done_list
1458 * is not empty, so no need for another list_empty(done_list) check.
1459 */
1460 spin_lock_irqsave(&q->done_lock, flags);
1461 *vb = list_first_entry(&q->done_list, struct vb2_buffer, done_entry);
32a77260
HV
1462 /*
1463 * Only remove the buffer from done_list if v4l2_buffer can handle all
1464 * the planes.
1465 */
1466 ret = __verify_planes_array(*vb, b);
1467 if (!ret)
1468 list_del(&(*vb)->done_entry);
e23ccc0a
PO
1469 spin_unlock_irqrestore(&q->done_lock, flags);
1470
32a77260 1471 return ret;
e23ccc0a
PO
1472}
1473
1474/**
1475 * vb2_wait_for_all_buffers() - wait until all buffers are given back to vb2
1476 * @q: videobuf2 queue
1477 *
1478 * This function will wait until all buffers that have been given to the driver
1479 * by buf_queue() are given back to vb2 with vb2_buffer_done(). It doesn't call
1480 * wait_prepare, wait_finish pair. It is intended to be called with all locks
1481 * taken, for example from stop_streaming() callback.
1482 */
1483int vb2_wait_for_all_buffers(struct vb2_queue *q)
1484{
1485 if (!q->streaming) {
1486 dprintk(1, "Streaming off, will not wait for buffers\n");
1487 return -EINVAL;
1488 }
1489
1490 wait_event(q->done_wq, !atomic_read(&q->queued_count));
1491 return 0;
1492}
1493EXPORT_SYMBOL_GPL(vb2_wait_for_all_buffers);
1494
c5384048
SS
1495/**
1496 * __vb2_dqbuf() - bring back the buffer to the DEQUEUED state
1497 */
1498static void __vb2_dqbuf(struct vb2_buffer *vb)
1499{
1500 struct vb2_queue *q = vb->vb2_queue;
1501 unsigned int i;
1502
1503 /* nothing to do if the buffer is already dequeued */
1504 if (vb->state == VB2_BUF_STATE_DEQUEUED)
1505 return;
1506
1507 vb->state = VB2_BUF_STATE_DEQUEUED;
1508
1509 /* unmap DMABUF buffer */
1510 if (q->memory == V4L2_MEMORY_DMABUF)
1511 for (i = 0; i < vb->num_planes; ++i) {
1512 if (!vb->planes[i].dbuf_mapped)
1513 continue;
1514 call_memop(q, unmap_dmabuf, vb->planes[i].mem_priv);
1515 vb->planes[i].dbuf_mapped = 0;
1516 }
1517}
1518
e23ccc0a
PO
1519/**
1520 * vb2_dqbuf() - Dequeue a buffer to the userspace
1521 * @q: videobuf2 queue
1522 * @b: buffer structure passed from userspace to vidioc_dqbuf handler
1523 * in driver
1524 * @nonblocking: if true, this call will not sleep waiting for a buffer if no
1525 * buffers ready for dequeuing are present. Normally the driver
1526 * would be passing (file->f_flags & O_NONBLOCK) here
1527 *
1528 * Should be called from vidioc_dqbuf ioctl handler of a driver.
1529 * This function:
1530 * 1) verifies the passed buffer,
1531 * 2) calls buf_finish callback in the driver (if provided), in which
1532 * driver can perform any additional operations that may be required before
1533 * returning the buffer to userspace, such as cache sync,
1534 * 3) the buffer struct members are filled with relevant information for
1535 * the userspace.
1536 *
1537 * The return values from this function are intended to be directly returned
1538 * from vidioc_dqbuf handler in driver.
1539 */
1540int vb2_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking)
1541{
1542 struct vb2_buffer *vb = NULL;
1543 int ret;
1544
b25748fe
MS
1545 if (q->fileio) {
1546 dprintk(1, "dqbuf: file io in progress\n");
1547 return -EBUSY;
1548 }
1549
e23ccc0a
PO
1550 if (b->type != q->type) {
1551 dprintk(1, "dqbuf: invalid buffer type\n");
1552 return -EINVAL;
1553 }
32a77260
HV
1554 ret = __vb2_get_done_vb(q, &vb, b, nonblocking);
1555 if (ret < 0)
e23ccc0a 1556 return ret;
e23ccc0a
PO
1557
1558 ret = call_qop(q, buf_finish, vb);
1559 if (ret) {
1560 dprintk(1, "dqbuf: buffer finish failed\n");
1561 return ret;
1562 }
1563
1564 switch (vb->state) {
1565 case VB2_BUF_STATE_DONE:
1566 dprintk(3, "dqbuf: Returning done buffer\n");
1567 break;
1568 case VB2_BUF_STATE_ERROR:
1569 dprintk(3, "dqbuf: Returning done buffer with errors\n");
1570 break;
1571 default:
1572 dprintk(1, "dqbuf: Invalid buffer state\n");
1573 return -EINVAL;
1574 }
1575
1576 /* Fill buffer information for the userspace */
1577 __fill_v4l2_buffer(vb, b);
1578 /* Remove from videobuf queue */
1579 list_del(&vb->queued_entry);
c5384048
SS
1580 /* go back to dequeued state */
1581 __vb2_dqbuf(vb);
e23ccc0a
PO
1582
1583 dprintk(1, "dqbuf of buffer %d, with state %d\n",
1584 vb->v4l2_buf.index, vb->state);
1585
e23ccc0a
PO
1586 return 0;
1587}
1588EXPORT_SYMBOL_GPL(vb2_dqbuf);
1589
bd323e28
MS
1590/**
1591 * __vb2_queue_cancel() - cancel and stop (pause) streaming
1592 *
1593 * Removes all queued buffers from driver's queue and all buffers queued by
1594 * userspace from videobuf's queue. Returns to state after reqbufs.
1595 */
1596static void __vb2_queue_cancel(struct vb2_queue *q)
1597{
1598 unsigned int i;
1599
1600 /*
1601 * Tell driver to stop all transactions and release all queued
1602 * buffers.
1603 */
1604 if (q->streaming)
1605 call_qop(q, stop_streaming, q);
1606 q->streaming = 0;
1607
1608 /*
1609 * Remove all buffers from videobuf's list...
1610 */
1611 INIT_LIST_HEAD(&q->queued_list);
1612 /*
1613 * ...and done list; userspace will not receive any buffers it
1614 * has not already dequeued before initiating cancel.
1615 */
1616 INIT_LIST_HEAD(&q->done_list);
1617 atomic_set(&q->queued_count, 0);
1618 wake_up_all(&q->done_wq);
1619
1620 /*
1621 * Reinitialize all buffers for next use.
1622 */
1623 for (i = 0; i < q->num_buffers; ++i)
c5384048 1624 __vb2_dqbuf(q->bufs[i]);
bd323e28
MS
1625}
1626
e23ccc0a
PO
1627/**
1628 * vb2_streamon - start streaming
1629 * @q: videobuf2 queue
1630 * @type: type argument passed from userspace to vidioc_streamon handler
1631 *
1632 * Should be called from vidioc_streamon handler of a driver.
1633 * This function:
1634 * 1) verifies current state
bd323e28 1635 * 2) passes any previously queued buffers to the driver and starts streaming
e23ccc0a
PO
1636 *
1637 * The return values from this function are intended to be directly returned
1638 * from vidioc_streamon handler in the driver.
1639 */
1640int vb2_streamon(struct vb2_queue *q, enum v4l2_buf_type type)
1641{
1642 struct vb2_buffer *vb;
5db2c3ba 1643 int ret;
e23ccc0a 1644
b25748fe
MS
1645 if (q->fileio) {
1646 dprintk(1, "streamon: file io in progress\n");
1647 return -EBUSY;
1648 }
1649
e23ccc0a
PO
1650 if (type != q->type) {
1651 dprintk(1, "streamon: invalid stream type\n");
1652 return -EINVAL;
1653 }
1654
1655 if (q->streaming) {
1656 dprintk(1, "streamon: already streaming\n");
1657 return -EBUSY;
1658 }
1659
1660 /*
bd323e28
MS
1661 * If any buffers were queued before streamon,
1662 * we can now pass them to driver for processing.
e23ccc0a 1663 */
bd323e28
MS
1664 list_for_each_entry(vb, &q->queued_list, queued_entry)
1665 __enqueue_in_driver(vb);
e23ccc0a 1666
e23ccc0a
PO
1667 /*
1668 * Let driver notice that streaming state has been enabled.
1669 */
bd323e28 1670 ret = call_qop(q, start_streaming, q, atomic_read(&q->queued_count));
5db2c3ba
PO
1671 if (ret) {
1672 dprintk(1, "streamon: driver refused to start streaming\n");
bd323e28 1673 __vb2_queue_cancel(q);
5db2c3ba
PO
1674 return ret;
1675 }
1676
1677 q->streaming = 1;
e23ccc0a 1678
e23ccc0a
PO
1679 dprintk(3, "Streamon successful\n");
1680 return 0;
1681}
1682EXPORT_SYMBOL_GPL(vb2_streamon);
1683
e23ccc0a
PO
1684
1685/**
1686 * vb2_streamoff - stop streaming
1687 * @q: videobuf2 queue
1688 * @type: type argument passed from userspace to vidioc_streamoff handler
1689 *
1690 * Should be called from vidioc_streamoff handler of a driver.
1691 * This function:
1692 * 1) verifies current state,
1693 * 2) stop streaming and dequeues any queued buffers, including those previously
1694 * passed to the driver (after waiting for the driver to finish).
1695 *
1696 * This call can be used for pausing playback.
1697 * The return values from this function are intended to be directly returned
1698 * from vidioc_streamoff handler in the driver
1699 */
1700int vb2_streamoff(struct vb2_queue *q, enum v4l2_buf_type type)
1701{
b25748fe
MS
1702 if (q->fileio) {
1703 dprintk(1, "streamoff: file io in progress\n");
1704 return -EBUSY;
1705 }
1706
e23ccc0a
PO
1707 if (type != q->type) {
1708 dprintk(1, "streamoff: invalid stream type\n");
1709 return -EINVAL;
1710 }
1711
1712 if (!q->streaming) {
1713 dprintk(1, "streamoff: not streaming\n");
1714 return -EINVAL;
1715 }
1716
1717 /*
1718 * Cancel will pause streaming and remove all buffers from the driver
1719 * and videobuf, effectively returning control over them to userspace.
1720 */
1721 __vb2_queue_cancel(q);
1722
1723 dprintk(3, "Streamoff successful\n");
1724 return 0;
1725}
1726EXPORT_SYMBOL_GPL(vb2_streamoff);
1727
1728/**
1729 * __find_plane_by_offset() - find plane associated with the given offset off
1730 */
1731static int __find_plane_by_offset(struct vb2_queue *q, unsigned long off,
1732 unsigned int *_buffer, unsigned int *_plane)
1733{
1734 struct vb2_buffer *vb;
1735 unsigned int buffer, plane;
1736
1737 /*
1738 * Go over all buffers and their planes, comparing the given offset
1739 * with an offset assigned to each plane. If a match is found,
1740 * return its buffer and plane numbers.
1741 */
1742 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
1743 vb = q->bufs[buffer];
1744
1745 for (plane = 0; plane < vb->num_planes; ++plane) {
1746 if (vb->v4l2_planes[plane].m.mem_offset == off) {
1747 *_buffer = buffer;
1748 *_plane = plane;
1749 return 0;
1750 }
1751 }
1752 }
1753
1754 return -EINVAL;
1755}
1756
83ae7c5a
TS
1757/**
1758 * vb2_expbuf() - Export a buffer as a file descriptor
1759 * @q: videobuf2 queue
1760 * @eb: export buffer structure passed from userspace to vidioc_expbuf
1761 * handler in driver
1762 *
1763 * The return values from this function are intended to be directly returned
1764 * from vidioc_expbuf handler in driver.
1765 */
1766int vb2_expbuf(struct vb2_queue *q, struct v4l2_exportbuffer *eb)
1767{
1768 struct vb2_buffer *vb = NULL;
1769 struct vb2_plane *vb_plane;
1770 int ret;
1771 struct dma_buf *dbuf;
1772
1773 if (q->memory != V4L2_MEMORY_MMAP) {
1774 dprintk(1, "Queue is not currently set up for mmap\n");
1775 return -EINVAL;
1776 }
1777
1778 if (!q->mem_ops->get_dmabuf) {
1779 dprintk(1, "Queue does not support DMA buffer exporting\n");
1780 return -EINVAL;
1781 }
1782
1783 if (eb->flags & ~O_CLOEXEC) {
1784 dprintk(1, "Queue does support only O_CLOEXEC flag\n");
1785 return -EINVAL;
1786 }
1787
1788 if (eb->type != q->type) {
1789 dprintk(1, "qbuf: invalid buffer type\n");
1790 return -EINVAL;
1791 }
1792
1793 if (eb->index >= q->num_buffers) {
1794 dprintk(1, "buffer index out of range\n");
1795 return -EINVAL;
1796 }
1797
1798 vb = q->bufs[eb->index];
1799
1800 if (eb->plane >= vb->num_planes) {
1801 dprintk(1, "buffer plane out of range\n");
1802 return -EINVAL;
1803 }
1804
1805 vb_plane = &vb->planes[eb->plane];
1806
1807 dbuf = call_memop(q, get_dmabuf, vb_plane->mem_priv);
1808 if (IS_ERR_OR_NULL(dbuf)) {
1809 dprintk(1, "Failed to export buffer %d, plane %d\n",
1810 eb->index, eb->plane);
1811 return -EINVAL;
1812 }
1813
1814 ret = dma_buf_fd(dbuf, eb->flags);
1815 if (ret < 0) {
1816 dprintk(3, "buffer %d, plane %d failed to export (%d)\n",
1817 eb->index, eb->plane, ret);
1818 dma_buf_put(dbuf);
1819 return ret;
1820 }
1821
1822 dprintk(3, "buffer %d, plane %d exported as %d descriptor\n",
1823 eb->index, eb->plane, ret);
1824 eb->fd = ret;
1825
1826 return 0;
1827}
1828EXPORT_SYMBOL_GPL(vb2_expbuf);
1829
e23ccc0a
PO
1830/**
1831 * vb2_mmap() - map video buffers into application address space
1832 * @q: videobuf2 queue
1833 * @vma: vma passed to the mmap file operation handler in the driver
1834 *
1835 * Should be called from mmap file operation handler of a driver.
1836 * This function maps one plane of one of the available video buffers to
1837 * userspace. To map whole video memory allocated on reqbufs, this function
1838 * has to be called once per each plane per each buffer previously allocated.
1839 *
1840 * When the userspace application calls mmap, it passes to it an offset returned
1841 * to it earlier by the means of vidioc_querybuf handler. That offset acts as
1842 * a "cookie", which is then used to identify the plane to be mapped.
1843 * This function finds a plane with a matching offset and a mapping is performed
1844 * by the means of a provided memory operation.
1845 *
1846 * The return values from this function are intended to be directly returned
1847 * from the mmap handler in driver.
1848 */
1849int vb2_mmap(struct vb2_queue *q, struct vm_area_struct *vma)
1850{
1851 unsigned long off = vma->vm_pgoff << PAGE_SHIFT;
e23ccc0a
PO
1852 struct vb2_buffer *vb;
1853 unsigned int buffer, plane;
1854 int ret;
1855
1856 if (q->memory != V4L2_MEMORY_MMAP) {
1857 dprintk(1, "Queue is not currently set up for mmap\n");
1858 return -EINVAL;
1859 }
1860
1861 /*
1862 * Check memory area access mode.
1863 */
1864 if (!(vma->vm_flags & VM_SHARED)) {
1865 dprintk(1, "Invalid vma flags, VM_SHARED needed\n");
1866 return -EINVAL;
1867 }
1868 if (V4L2_TYPE_IS_OUTPUT(q->type)) {
1869 if (!(vma->vm_flags & VM_WRITE)) {
1870 dprintk(1, "Invalid vma flags, VM_WRITE needed\n");
1871 return -EINVAL;
1872 }
1873 } else {
1874 if (!(vma->vm_flags & VM_READ)) {
1875 dprintk(1, "Invalid vma flags, VM_READ needed\n");
1876 return -EINVAL;
1877 }
1878 }
1879
1880 /*
1881 * Find the plane corresponding to the offset passed by userspace.
1882 */
1883 ret = __find_plane_by_offset(q, off, &buffer, &plane);
1884 if (ret)
1885 return ret;
1886
1887 vb = q->bufs[buffer];
e23ccc0a 1888
a00d0266 1889 ret = call_memop(q, mmap, vb->planes[plane].mem_priv, vma);
e23ccc0a
PO
1890 if (ret)
1891 return ret;
1892
e23ccc0a
PO
1893 dprintk(3, "Buffer %d, plane %d successfully mapped\n", buffer, plane);
1894 return 0;
1895}
1896EXPORT_SYMBOL_GPL(vb2_mmap);
1897
6f524ec1
SJ
1898#ifndef CONFIG_MMU
1899unsigned long vb2_get_unmapped_area(struct vb2_queue *q,
1900 unsigned long addr,
1901 unsigned long len,
1902 unsigned long pgoff,
1903 unsigned long flags)
1904{
1905 unsigned long off = pgoff << PAGE_SHIFT;
1906 struct vb2_buffer *vb;
1907 unsigned int buffer, plane;
1908 int ret;
1909
1910 if (q->memory != V4L2_MEMORY_MMAP) {
1911 dprintk(1, "Queue is not currently set up for mmap\n");
1912 return -EINVAL;
1913 }
1914
1915 /*
1916 * Find the plane corresponding to the offset passed by userspace.
1917 */
1918 ret = __find_plane_by_offset(q, off, &buffer, &plane);
1919 if (ret)
1920 return ret;
1921
1922 vb = q->bufs[buffer];
1923
1924 return (unsigned long)vb2_plane_vaddr(vb, plane);
1925}
1926EXPORT_SYMBOL_GPL(vb2_get_unmapped_area);
1927#endif
1928
b25748fe
MS
1929static int __vb2_init_fileio(struct vb2_queue *q, int read);
1930static int __vb2_cleanup_fileio(struct vb2_queue *q);
e23ccc0a
PO
1931
1932/**
1933 * vb2_poll() - implements poll userspace operation
1934 * @q: videobuf2 queue
1935 * @file: file argument passed to the poll file operation handler
1936 * @wait: wait argument passed to the poll file operation handler
1937 *
1938 * This function implements poll file operation handler for a driver.
1939 * For CAPTURE queues, if a buffer is ready to be dequeued, the userspace will
1940 * be informed that the file descriptor of a video device is available for
1941 * reading.
1942 * For OUTPUT queues, if a buffer is ready to be dequeued, the file descriptor
1943 * will be reported as available for writing.
1944 *
95213ceb
HV
1945 * If the driver uses struct v4l2_fh, then vb2_poll() will also check for any
1946 * pending events.
1947 *
e23ccc0a
PO
1948 * The return values from this function are intended to be directly returned
1949 * from poll handler in driver.
1950 */
1951unsigned int vb2_poll(struct vb2_queue *q, struct file *file, poll_table *wait)
1952{
95213ceb 1953 struct video_device *vfd = video_devdata(file);
bf5c7cbb 1954 unsigned long req_events = poll_requested_events(wait);
e23ccc0a 1955 struct vb2_buffer *vb = NULL;
95213ceb
HV
1956 unsigned int res = 0;
1957 unsigned long flags;
1958
1959 if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags)) {
1960 struct v4l2_fh *fh = file->private_data;
1961
1962 if (v4l2_event_pending(fh))
1963 res = POLLPRI;
1964 else if (req_events & POLLPRI)
1965 poll_wait(file, &fh->wait, wait);
1966 }
e23ccc0a 1967
b25748fe 1968 /*
4ffabdb3 1969 * Start file I/O emulator only if streaming API has not been used yet.
b25748fe
MS
1970 */
1971 if (q->num_buffers == 0 && q->fileio == NULL) {
bf5c7cbb
HV
1972 if (!V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_READ) &&
1973 (req_events & (POLLIN | POLLRDNORM))) {
95213ceb
HV
1974 if (__vb2_init_fileio(q, 1))
1975 return res | POLLERR;
b25748fe 1976 }
bf5c7cbb
HV
1977 if (V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_WRITE) &&
1978 (req_events & (POLLOUT | POLLWRNORM))) {
95213ceb
HV
1979 if (__vb2_init_fileio(q, 0))
1980 return res | POLLERR;
b25748fe
MS
1981 /*
1982 * Write to OUTPUT queue can be done immediately.
1983 */
95213ceb 1984 return res | POLLOUT | POLLWRNORM;
b25748fe
MS
1985 }
1986 }
1987
e23ccc0a
PO
1988 /*
1989 * There is nothing to wait for if no buffers have already been queued.
1990 */
1991 if (list_empty(&q->queued_list))
95213ceb 1992 return res | POLLERR;
e23ccc0a
PO
1993
1994 poll_wait(file, &q->done_wq, wait);
1995
1996 /*
1997 * Take first buffer available for dequeuing.
1998 */
1999 spin_lock_irqsave(&q->done_lock, flags);
2000 if (!list_empty(&q->done_list))
2001 vb = list_first_entry(&q->done_list, struct vb2_buffer,
2002 done_entry);
2003 spin_unlock_irqrestore(&q->done_lock, flags);
2004
2005 if (vb && (vb->state == VB2_BUF_STATE_DONE
2006 || vb->state == VB2_BUF_STATE_ERROR)) {
95213ceb
HV
2007 return (V4L2_TYPE_IS_OUTPUT(q->type)) ?
2008 res | POLLOUT | POLLWRNORM :
2009 res | POLLIN | POLLRDNORM;
e23ccc0a 2010 }
95213ceb 2011 return res;
e23ccc0a
PO
2012}
2013EXPORT_SYMBOL_GPL(vb2_poll);
2014
2015/**
2016 * vb2_queue_init() - initialize a videobuf2 queue
2017 * @q: videobuf2 queue; this structure should be allocated in driver
2018 *
2019 * The vb2_queue structure should be allocated by the driver. The driver is
2020 * responsible of clearing it's content and setting initial values for some
2021 * required entries before calling this function.
2022 * q->ops, q->mem_ops, q->type and q->io_modes are mandatory. Please refer
2023 * to the struct vb2_queue description in include/media/videobuf2-core.h
2024 * for more information.
2025 */
2026int vb2_queue_init(struct vb2_queue *q)
2027{
896f38f5
EG
2028 /*
2029 * Sanity check
2030 */
2031 if (WARN_ON(!q) ||
2032 WARN_ON(!q->ops) ||
2033 WARN_ON(!q->mem_ops) ||
2034 WARN_ON(!q->type) ||
2035 WARN_ON(!q->io_modes) ||
2036 WARN_ON(!q->ops->queue_setup) ||
2037 WARN_ON(!q->ops->buf_queue))
2038 return -EINVAL;
e23ccc0a
PO
2039
2040 INIT_LIST_HEAD(&q->queued_list);
2041 INIT_LIST_HEAD(&q->done_list);
2042 spin_lock_init(&q->done_lock);
2043 init_waitqueue_head(&q->done_wq);
2044
2045 if (q->buf_struct_size == 0)
2046 q->buf_struct_size = sizeof(struct vb2_buffer);
2047
2048 return 0;
2049}
2050EXPORT_SYMBOL_GPL(vb2_queue_init);
2051
2052/**
2053 * vb2_queue_release() - stop streaming, release the queue and free memory
2054 * @q: videobuf2 queue
2055 *
2056 * This function stops streaming and performs necessary clean ups, including
2057 * freeing video buffer memory. The driver is responsible for freeing
2058 * the vb2_queue structure itself.
2059 */
2060void vb2_queue_release(struct vb2_queue *q)
2061{
b25748fe 2062 __vb2_cleanup_fileio(q);
e23ccc0a 2063 __vb2_queue_cancel(q);
2d86401c 2064 __vb2_queue_free(q, q->num_buffers);
e23ccc0a
PO
2065}
2066EXPORT_SYMBOL_GPL(vb2_queue_release);
2067
b25748fe
MS
2068/**
2069 * struct vb2_fileio_buf - buffer context used by file io emulator
2070 *
2071 * vb2 provides a compatibility layer and emulator of file io (read and
2072 * write) calls on top of streaming API. This structure is used for
2073 * tracking context related to the buffers.
2074 */
2075struct vb2_fileio_buf {
2076 void *vaddr;
2077 unsigned int size;
2078 unsigned int pos;
2079 unsigned int queued:1;
2080};
2081
2082/**
2083 * struct vb2_fileio_data - queue context used by file io emulator
2084 *
2085 * vb2 provides a compatibility layer and emulator of file io (read and
2086 * write) calls on top of streaming API. For proper operation it required
2087 * this structure to save the driver state between each call of the read
2088 * or write function.
2089 */
2090struct vb2_fileio_data {
2091 struct v4l2_requestbuffers req;
2092 struct v4l2_buffer b;
2093 struct vb2_fileio_buf bufs[VIDEO_MAX_FRAME];
2094 unsigned int index;
2095 unsigned int q_count;
2096 unsigned int dq_count;
2097 unsigned int flags;
2098};
2099
2100/**
2101 * __vb2_init_fileio() - initialize file io emulator
2102 * @q: videobuf2 queue
2103 * @read: mode selector (1 means read, 0 means write)
2104 */
2105static int __vb2_init_fileio(struct vb2_queue *q, int read)
2106{
2107 struct vb2_fileio_data *fileio;
2108 int i, ret;
2109 unsigned int count = 0;
2110
2111 /*
2112 * Sanity check
2113 */
2114 if ((read && !(q->io_modes & VB2_READ)) ||
2115 (!read && !(q->io_modes & VB2_WRITE)))
2116 BUG();
2117
2118 /*
2119 * Check if device supports mapping buffers to kernel virtual space.
2120 */
2121 if (!q->mem_ops->vaddr)
2122 return -EBUSY;
2123
2124 /*
2125 * Check if streaming api has not been already activated.
2126 */
2127 if (q->streaming || q->num_buffers > 0)
2128 return -EBUSY;
2129
2130 /*
2131 * Start with count 1, driver can increase it in queue_setup()
2132 */
2133 count = 1;
2134
2135 dprintk(3, "setting up file io: mode %s, count %d, flags %08x\n",
2136 (read) ? "read" : "write", count, q->io_flags);
2137
2138 fileio = kzalloc(sizeof(struct vb2_fileio_data), GFP_KERNEL);
2139 if (fileio == NULL)
2140 return -ENOMEM;
2141
2142 fileio->flags = q->io_flags;
2143
2144 /*
2145 * Request buffers and use MMAP type to force driver
2146 * to allocate buffers by itself.
2147 */
2148 fileio->req.count = count;
2149 fileio->req.memory = V4L2_MEMORY_MMAP;
2150 fileio->req.type = q->type;
2151 ret = vb2_reqbufs(q, &fileio->req);
2152 if (ret)
2153 goto err_kfree;
2154
2155 /*
2156 * Check if plane_count is correct
2157 * (multiplane buffers are not supported).
2158 */
2159 if (q->bufs[0]->num_planes != 1) {
b25748fe
MS
2160 ret = -EBUSY;
2161 goto err_reqbufs;
2162 }
2163
2164 /*
2165 * Get kernel address of each buffer.
2166 */
2167 for (i = 0; i < q->num_buffers; i++) {
2168 fileio->bufs[i].vaddr = vb2_plane_vaddr(q->bufs[i], 0);
2169 if (fileio->bufs[i].vaddr == NULL)
2170 goto err_reqbufs;
2171 fileio->bufs[i].size = vb2_plane_size(q->bufs[i], 0);
2172 }
2173
2174 /*
2175 * Read mode requires pre queuing of all buffers.
2176 */
2177 if (read) {
2178 /*
2179 * Queue all buffers.
2180 */
2181 for (i = 0; i < q->num_buffers; i++) {
2182 struct v4l2_buffer *b = &fileio->b;
2183 memset(b, 0, sizeof(*b));
2184 b->type = q->type;
2185 b->memory = q->memory;
2186 b->index = i;
2187 ret = vb2_qbuf(q, b);
2188 if (ret)
2189 goto err_reqbufs;
2190 fileio->bufs[i].queued = 1;
2191 }
2192
2193 /*
2194 * Start streaming.
2195 */
2196 ret = vb2_streamon(q, q->type);
2197 if (ret)
2198 goto err_reqbufs;
2199 }
2200
2201 q->fileio = fileio;
2202
2203 return ret;
2204
2205err_reqbufs:
a67e1722 2206 fileio->req.count = 0;
b25748fe
MS
2207 vb2_reqbufs(q, &fileio->req);
2208
2209err_kfree:
2210 kfree(fileio);
2211 return ret;
2212}
2213
2214/**
2215 * __vb2_cleanup_fileio() - free resourced used by file io emulator
2216 * @q: videobuf2 queue
2217 */
2218static int __vb2_cleanup_fileio(struct vb2_queue *q)
2219{
2220 struct vb2_fileio_data *fileio = q->fileio;
2221
2222 if (fileio) {
2223 /*
2224 * Hack fileio context to enable direct calls to vb2 ioctl
2225 * interface.
2226 */
2227 q->fileio = NULL;
2228
2229 vb2_streamoff(q, q->type);
2230 fileio->req.count = 0;
2231 vb2_reqbufs(q, &fileio->req);
2232 kfree(fileio);
2233 dprintk(3, "file io emulator closed\n");
2234 }
2235 return 0;
2236}
2237
2238/**
2239 * __vb2_perform_fileio() - perform a single file io (read or write) operation
2240 * @q: videobuf2 queue
2241 * @data: pointed to target userspace buffer
2242 * @count: number of bytes to read or write
2243 * @ppos: file handle position tracking pointer
2244 * @nonblock: mode selector (1 means blocking calls, 0 means nonblocking)
2245 * @read: access mode selector (1 means read, 0 means write)
2246 */
2247static size_t __vb2_perform_fileio(struct vb2_queue *q, char __user *data, size_t count,
2248 loff_t *ppos, int nonblock, int read)
2249{
2250 struct vb2_fileio_data *fileio;
2251 struct vb2_fileio_buf *buf;
2252 int ret, index;
2253
08b99e26 2254 dprintk(3, "file io: mode %s, offset %ld, count %zd, %sblocking\n",
b25748fe
MS
2255 read ? "read" : "write", (long)*ppos, count,
2256 nonblock ? "non" : "");
2257
2258 if (!data)
2259 return -EINVAL;
2260
2261 /*
2262 * Initialize emulator on first call.
2263 */
2264 if (!q->fileio) {
2265 ret = __vb2_init_fileio(q, read);
2266 dprintk(3, "file io: vb2_init_fileio result: %d\n", ret);
2267 if (ret)
2268 return ret;
2269 }
2270 fileio = q->fileio;
2271
2272 /*
2273 * Hack fileio context to enable direct calls to vb2 ioctl interface.
2274 * The pointer will be restored before returning from this function.
2275 */
2276 q->fileio = NULL;
2277
2278 index = fileio->index;
2279 buf = &fileio->bufs[index];
2280
2281 /*
2282 * Check if we need to dequeue the buffer.
2283 */
2284 if (buf->queued) {
2285 struct vb2_buffer *vb;
2286
2287 /*
2288 * Call vb2_dqbuf to get buffer back.
2289 */
2290 memset(&fileio->b, 0, sizeof(fileio->b));
2291 fileio->b.type = q->type;
2292 fileio->b.memory = q->memory;
2293 fileio->b.index = index;
2294 ret = vb2_dqbuf(q, &fileio->b, nonblock);
2295 dprintk(5, "file io: vb2_dqbuf result: %d\n", ret);
2296 if (ret)
2297 goto end;
2298 fileio->dq_count += 1;
2299
2300 /*
2301 * Get number of bytes filled by the driver
2302 */
2303 vb = q->bufs[index];
2304 buf->size = vb2_get_plane_payload(vb, 0);
2305 buf->queued = 0;
2306 }
2307
2308 /*
2309 * Limit count on last few bytes of the buffer.
2310 */
2311 if (buf->pos + count > buf->size) {
2312 count = buf->size - buf->pos;
08b99e26 2313 dprintk(5, "reducing read count: %zd\n", count);
b25748fe
MS
2314 }
2315
2316 /*
2317 * Transfer data to userspace.
2318 */
08b99e26 2319 dprintk(3, "file io: copying %zd bytes - buffer %d, offset %u\n",
b25748fe
MS
2320 count, index, buf->pos);
2321 if (read)
2322 ret = copy_to_user(data, buf->vaddr + buf->pos, count);
2323 else
2324 ret = copy_from_user(buf->vaddr + buf->pos, data, count);
2325 if (ret) {
2326 dprintk(3, "file io: error copying data\n");
2327 ret = -EFAULT;
2328 goto end;
2329 }
2330
2331 /*
2332 * Update counters.
2333 */
2334 buf->pos += count;
2335 *ppos += count;
2336
2337 /*
2338 * Queue next buffer if required.
2339 */
2340 if (buf->pos == buf->size ||
2341 (!read && (fileio->flags & VB2_FILEIO_WRITE_IMMEDIATELY))) {
2342 /*
2343 * Check if this is the last buffer to read.
2344 */
2345 if (read && (fileio->flags & VB2_FILEIO_READ_ONCE) &&
2346 fileio->dq_count == 1) {
2347 dprintk(3, "file io: read limit reached\n");
2348 /*
2349 * Restore fileio pointer and release the context.
2350 */
2351 q->fileio = fileio;
2352 return __vb2_cleanup_fileio(q);
2353 }
2354
2355 /*
2356 * Call vb2_qbuf and give buffer to the driver.
2357 */
2358 memset(&fileio->b, 0, sizeof(fileio->b));
2359 fileio->b.type = q->type;
2360 fileio->b.memory = q->memory;
2361 fileio->b.index = index;
2362 fileio->b.bytesused = buf->pos;
2363 ret = vb2_qbuf(q, &fileio->b);
2364 dprintk(5, "file io: vb2_dbuf result: %d\n", ret);
2365 if (ret)
2366 goto end;
2367
2368 /*
2369 * Buffer has been queued, update the status
2370 */
2371 buf->pos = 0;
2372 buf->queued = 1;
2373 buf->size = q->bufs[0]->v4l2_planes[0].length;
2374 fileio->q_count += 1;
2375
2376 /*
2377 * Switch to the next buffer
2378 */
2379 fileio->index = (index + 1) % q->num_buffers;
2380
2381 /*
2382 * Start streaming if required.
2383 */
2384 if (!read && !q->streaming) {
2385 ret = vb2_streamon(q, q->type);
2386 if (ret)
2387 goto end;
2388 }
2389 }
2390
2391 /*
2392 * Return proper number of bytes processed.
2393 */
2394 if (ret == 0)
2395 ret = count;
2396end:
2397 /*
2398 * Restore the fileio context and block vb2 ioctl interface.
2399 */
2400 q->fileio = fileio;
2401 return ret;
2402}
2403
2404size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count,
2405 loff_t *ppos, int nonblocking)
2406{
2407 return __vb2_perform_fileio(q, data, count, ppos, nonblocking, 1);
2408}
2409EXPORT_SYMBOL_GPL(vb2_read);
2410
2411size_t vb2_write(struct vb2_queue *q, char __user *data, size_t count,
2412 loff_t *ppos, int nonblocking)
2413{
2414 return __vb2_perform_fileio(q, data, count, ppos, nonblocking, 0);
2415}
2416EXPORT_SYMBOL_GPL(vb2_write);
2417
4c1ffcaa
HV
2418
2419/*
2420 * The following functions are not part of the vb2 core API, but are helper
2421 * functions that plug into struct v4l2_ioctl_ops, struct v4l2_file_operations
2422 * and struct vb2_ops.
2423 * They contain boilerplate code that most if not all drivers have to do
2424 * and so they simplify the driver code.
2425 */
2426
2427/* The queue is busy if there is a owner and you are not that owner. */
2428static inline bool vb2_queue_is_busy(struct video_device *vdev, struct file *file)
2429{
2430 return vdev->queue->owner && vdev->queue->owner != file->private_data;
2431}
2432
2433/* vb2 ioctl helpers */
2434
2435int vb2_ioctl_reqbufs(struct file *file, void *priv,
2436 struct v4l2_requestbuffers *p)
2437{
2438 struct video_device *vdev = video_devdata(file);
2439 int res = __verify_memory_type(vdev->queue, p->memory, p->type);
2440
2441 if (res)
2442 return res;
2443 if (vb2_queue_is_busy(vdev, file))
2444 return -EBUSY;
2445 res = __reqbufs(vdev->queue, p);
2446 /* If count == 0, then the owner has released all buffers and he
2447 is no longer owner of the queue. Otherwise we have a new owner. */
2448 if (res == 0)
2449 vdev->queue->owner = p->count ? file->private_data : NULL;
2450 return res;
2451}
2452EXPORT_SYMBOL_GPL(vb2_ioctl_reqbufs);
2453
2454int vb2_ioctl_create_bufs(struct file *file, void *priv,
2455 struct v4l2_create_buffers *p)
2456{
2457 struct video_device *vdev = video_devdata(file);
2458 int res = __verify_memory_type(vdev->queue, p->memory, p->format.type);
2459
2460 p->index = vdev->queue->num_buffers;
2461 /* If count == 0, then just check if memory and type are valid.
2462 Any -EBUSY result from __verify_memory_type can be mapped to 0. */
2463 if (p->count == 0)
2464 return res != -EBUSY ? res : 0;
2465 if (res)
2466 return res;
2467 if (vb2_queue_is_busy(vdev, file))
2468 return -EBUSY;
2469 res = __create_bufs(vdev->queue, p);
2470 if (res == 0)
2471 vdev->queue->owner = file->private_data;
2472 return res;
2473}
2474EXPORT_SYMBOL_GPL(vb2_ioctl_create_bufs);
2475
2476int vb2_ioctl_prepare_buf(struct file *file, void *priv,
2477 struct v4l2_buffer *p)
2478{
2479 struct video_device *vdev = video_devdata(file);
2480
2481 if (vb2_queue_is_busy(vdev, file))
2482 return -EBUSY;
2483 return vb2_prepare_buf(vdev->queue, p);
2484}
2485EXPORT_SYMBOL_GPL(vb2_ioctl_prepare_buf);
2486
2487int vb2_ioctl_querybuf(struct file *file, void *priv, struct v4l2_buffer *p)
2488{
2489 struct video_device *vdev = video_devdata(file);
2490
2491 /* No need to call vb2_queue_is_busy(), anyone can query buffers. */
2492 return vb2_querybuf(vdev->queue, p);
2493}
2494EXPORT_SYMBOL_GPL(vb2_ioctl_querybuf);
2495
2496int vb2_ioctl_qbuf(struct file *file, void *priv, struct v4l2_buffer *p)
2497{
2498 struct video_device *vdev = video_devdata(file);
2499
2500 if (vb2_queue_is_busy(vdev, file))
2501 return -EBUSY;
2502 return vb2_qbuf(vdev->queue, p);
2503}
2504EXPORT_SYMBOL_GPL(vb2_ioctl_qbuf);
2505
2506int vb2_ioctl_dqbuf(struct file *file, void *priv, struct v4l2_buffer *p)
2507{
2508 struct video_device *vdev = video_devdata(file);
2509
2510 if (vb2_queue_is_busy(vdev, file))
2511 return -EBUSY;
2512 return vb2_dqbuf(vdev->queue, p, file->f_flags & O_NONBLOCK);
2513}
2514EXPORT_SYMBOL_GPL(vb2_ioctl_dqbuf);
2515
2516int vb2_ioctl_streamon(struct file *file, void *priv, enum v4l2_buf_type i)
2517{
2518 struct video_device *vdev = video_devdata(file);
2519
2520 if (vb2_queue_is_busy(vdev, file))
2521 return -EBUSY;
2522 return vb2_streamon(vdev->queue, i);
2523}
2524EXPORT_SYMBOL_GPL(vb2_ioctl_streamon);
2525
2526int vb2_ioctl_streamoff(struct file *file, void *priv, enum v4l2_buf_type i)
2527{
2528 struct video_device *vdev = video_devdata(file);
2529
2530 if (vb2_queue_is_busy(vdev, file))
2531 return -EBUSY;
2532 return vb2_streamoff(vdev->queue, i);
2533}
2534EXPORT_SYMBOL_GPL(vb2_ioctl_streamoff);
2535
83ae7c5a
TS
2536int vb2_ioctl_expbuf(struct file *file, void *priv, struct v4l2_exportbuffer *p)
2537{
2538 struct video_device *vdev = video_devdata(file);
2539
2540 if (vb2_queue_is_busy(vdev, file))
2541 return -EBUSY;
2542 return vb2_expbuf(vdev->queue, p);
2543}
2544EXPORT_SYMBOL_GPL(vb2_ioctl_expbuf);
2545
4c1ffcaa
HV
2546/* v4l2_file_operations helpers */
2547
2548int vb2_fop_mmap(struct file *file, struct vm_area_struct *vma)
2549{
2550 struct video_device *vdev = video_devdata(file);
2551
2552 return vb2_mmap(vdev->queue, vma);
2553}
2554EXPORT_SYMBOL_GPL(vb2_fop_mmap);
2555
2556int vb2_fop_release(struct file *file)
2557{
2558 struct video_device *vdev = video_devdata(file);
2559
2560 if (file->private_data == vdev->queue->owner) {
2561 vb2_queue_release(vdev->queue);
2562 vdev->queue->owner = NULL;
2563 }
2564 return v4l2_fh_release(file);
2565}
2566EXPORT_SYMBOL_GPL(vb2_fop_release);
2567
2568ssize_t vb2_fop_write(struct file *file, char __user *buf,
2569 size_t count, loff_t *ppos)
2570{
2571 struct video_device *vdev = video_devdata(file);
2572 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
4c1ffcaa
HV
2573 int err = -EBUSY;
2574
cf533735 2575 if (lock && mutex_lock_interruptible(lock))
4c1ffcaa
HV
2576 return -ERESTARTSYS;
2577 if (vb2_queue_is_busy(vdev, file))
2578 goto exit;
2579 err = vb2_write(vdev->queue, buf, count, ppos,
2580 file->f_flags & O_NONBLOCK);
8c82c75c 2581 if (vdev->queue->fileio)
4c1ffcaa
HV
2582 vdev->queue->owner = file->private_data;
2583exit:
cf533735 2584 if (lock)
4c1ffcaa
HV
2585 mutex_unlock(lock);
2586 return err;
2587}
2588EXPORT_SYMBOL_GPL(vb2_fop_write);
2589
2590ssize_t vb2_fop_read(struct file *file, char __user *buf,
2591 size_t count, loff_t *ppos)
2592{
2593 struct video_device *vdev = video_devdata(file);
2594 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
4c1ffcaa
HV
2595 int err = -EBUSY;
2596
cf533735 2597 if (lock && mutex_lock_interruptible(lock))
4c1ffcaa
HV
2598 return -ERESTARTSYS;
2599 if (vb2_queue_is_busy(vdev, file))
2600 goto exit;
2601 err = vb2_read(vdev->queue, buf, count, ppos,
2602 file->f_flags & O_NONBLOCK);
8c82c75c 2603 if (vdev->queue->fileio)
4c1ffcaa
HV
2604 vdev->queue->owner = file->private_data;
2605exit:
cf533735 2606 if (lock)
4c1ffcaa
HV
2607 mutex_unlock(lock);
2608 return err;
2609}
2610EXPORT_SYMBOL_GPL(vb2_fop_read);
2611
2612unsigned int vb2_fop_poll(struct file *file, poll_table *wait)
2613{
2614 struct video_device *vdev = video_devdata(file);
2615 struct vb2_queue *q = vdev->queue;
2616 struct mutex *lock = q->lock ? q->lock : vdev->lock;
2617 unsigned long req_events = poll_requested_events(wait);
2618 unsigned res;
2619 void *fileio;
4c1ffcaa
HV
2620 bool must_lock = false;
2621
2622 /* Try to be smart: only lock if polling might start fileio,
2623 otherwise locking will only introduce unwanted delays. */
2624 if (q->num_buffers == 0 && q->fileio == NULL) {
2625 if (!V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_READ) &&
2626 (req_events & (POLLIN | POLLRDNORM)))
2627 must_lock = true;
2628 else if (V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_WRITE) &&
2629 (req_events & (POLLOUT | POLLWRNORM)))
2630 must_lock = true;
2631 }
2632
2633 /* If locking is needed, but this helper doesn't know how, then you
2634 shouldn't be using this helper but you should write your own. */
cf533735 2635 WARN_ON(must_lock && !lock);
4c1ffcaa 2636
cf533735 2637 if (must_lock && lock && mutex_lock_interruptible(lock))
4c1ffcaa
HV
2638 return POLLERR;
2639
2640 fileio = q->fileio;
2641
2642 res = vb2_poll(vdev->queue, file, wait);
2643
2644 /* If fileio was started, then we have a new queue owner. */
2645 if (must_lock && !fileio && q->fileio)
2646 q->owner = file->private_data;
cf533735 2647 if (must_lock && lock)
4c1ffcaa
HV
2648 mutex_unlock(lock);
2649 return res;
2650}
2651EXPORT_SYMBOL_GPL(vb2_fop_poll);
2652
2653#ifndef CONFIG_MMU
2654unsigned long vb2_fop_get_unmapped_area(struct file *file, unsigned long addr,
2655 unsigned long len, unsigned long pgoff, unsigned long flags)
2656{
2657 struct video_device *vdev = video_devdata(file);
2658
2659 return vb2_get_unmapped_area(vdev->queue, addr, len, pgoff, flags);
2660}
2661EXPORT_SYMBOL_GPL(vb2_fop_get_unmapped_area);
2662#endif
2663
2664/* vb2_ops helpers. Only use if vq->lock is non-NULL. */
2665
2666void vb2_ops_wait_prepare(struct vb2_queue *vq)
2667{
2668 mutex_unlock(vq->lock);
2669}
2670EXPORT_SYMBOL_GPL(vb2_ops_wait_prepare);
2671
2672void vb2_ops_wait_finish(struct vb2_queue *vq)
2673{
2674 mutex_lock(vq->lock);
2675}
2676EXPORT_SYMBOL_GPL(vb2_ops_wait_finish);
2677
e23ccc0a 2678MODULE_DESCRIPTION("Driver helper framework for Video for Linux 2");
95072084 2679MODULE_AUTHOR("Pawel Osciak <pawel@osciak.com>, Marek Szyprowski");
e23ccc0a 2680MODULE_LICENSE("GPL");
This page took 0.265235 seconds and 5 git commands to generate.