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