blob: 8c6f04bc4d896130fb18eeb999bf1014b3ea9518 [file] [log] [blame]
Pawel Osciake23ccc02010-10-11 10:56:41 -03001/*
2 * videobuf2-core.c - V4L2 driver helper framework
3 *
4 * Copyright (C) 2010 Samsung Electronics
5 *
Pawel Osciak95072082011-03-13 15:23:32 -03006 * Author: Pawel Osciak <pawel@osciak.com>
Pawel Osciake23ccc02010-10-11 10:56:41 -03007 * Marek Szyprowski <m.szyprowski@samsung.com>
8 *
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
22#include <media/videobuf2-core.h>
23
24static int debug;
25module_param(debug, int, 0644);
26
27#define dprintk(level, fmt, arg...) \
28 do { \
29 if (debug >= level) \
30 printk(KERN_DEBUG "vb2: " fmt, ## arg); \
31 } while (0)
32
33#define call_memop(q, plane, op, args...) \
34 (((q)->mem_ops->op) ? \
35 ((q)->mem_ops->op(args)) : 0)
36
37#define call_qop(q, op, args...) \
38 (((q)->ops->op) ? ((q)->ops->op(args)) : 0)
39
40/**
41 * __vb2_buf_mem_alloc() - allocate video memory for the given buffer
42 */
43static int __vb2_buf_mem_alloc(struct vb2_buffer *vb,
44 unsigned long *plane_sizes)
45{
46 struct vb2_queue *q = vb->vb2_queue;
47 void *mem_priv;
48 int plane;
49
50 /* Allocate memory for all planes in this buffer */
51 for (plane = 0; plane < vb->num_planes; ++plane) {
52 mem_priv = call_memop(q, plane, alloc, q->alloc_ctx[plane],
53 plane_sizes[plane]);
54 if (!mem_priv)
55 goto free;
56
57 /* Associate allocator private data with this plane */
58 vb->planes[plane].mem_priv = mem_priv;
59 vb->v4l2_planes[plane].length = plane_sizes[plane];
60 }
61
62 return 0;
63free:
64 /* Free already allocated memory if one of the allocations failed */
65 for (; plane > 0; --plane)
66 call_memop(q, plane, put, vb->planes[plane - 1].mem_priv);
67
68 return -ENOMEM;
69}
70
71/**
72 * __vb2_buf_mem_free() - free memory of the given buffer
73 */
74static void __vb2_buf_mem_free(struct vb2_buffer *vb)
75{
76 struct vb2_queue *q = vb->vb2_queue;
77 unsigned int plane;
78
79 for (plane = 0; plane < vb->num_planes; ++plane) {
80 call_memop(q, plane, put, vb->planes[plane].mem_priv);
81 vb->planes[plane].mem_priv = NULL;
82 dprintk(3, "Freed plane %d of buffer %d\n",
83 plane, vb->v4l2_buf.index);
84 }
85}
86
87/**
88 * __vb2_buf_userptr_put() - release userspace memory associated with
89 * a USERPTR buffer
90 */
91static void __vb2_buf_userptr_put(struct vb2_buffer *vb)
92{
93 struct vb2_queue *q = vb->vb2_queue;
94 unsigned int plane;
95
96 for (plane = 0; plane < vb->num_planes; ++plane) {
97 void *mem_priv = vb->planes[plane].mem_priv;
98
99 if (mem_priv) {
100 call_memop(q, plane, put_userptr, mem_priv);
101 vb->planes[plane].mem_priv = NULL;
102 }
103 }
104}
105
106/**
107 * __setup_offsets() - setup unique offsets ("cookies") for every plane in
108 * every buffer on the queue
109 */
110static void __setup_offsets(struct vb2_queue *q)
111{
112 unsigned int buffer, plane;
113 struct vb2_buffer *vb;
114 unsigned long off = 0;
115
116 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
117 vb = q->bufs[buffer];
118 if (!vb)
119 continue;
120
121 for (plane = 0; plane < vb->num_planes; ++plane) {
122 vb->v4l2_planes[plane].m.mem_offset = off;
123
124 dprintk(3, "Buffer %d, plane %d offset 0x%08lx\n",
125 buffer, plane, off);
126
127 off += vb->v4l2_planes[plane].length;
128 off = PAGE_ALIGN(off);
129 }
130 }
131}
132
133/**
134 * __vb2_queue_alloc() - allocate videobuf buffer structures and (for MMAP type)
135 * video buffer memory for all buffers/planes on the queue and initializes the
136 * queue
137 *
138 * Returns the number of buffers successfully allocated.
139 */
140static int __vb2_queue_alloc(struct vb2_queue *q, enum v4l2_memory memory,
141 unsigned int num_buffers, unsigned int num_planes,
142 unsigned long plane_sizes[])
143{
144 unsigned int buffer;
145 struct vb2_buffer *vb;
146 int ret;
147
148 for (buffer = 0; buffer < num_buffers; ++buffer) {
149 /* Allocate videobuf buffer structures */
150 vb = kzalloc(q->buf_struct_size, GFP_KERNEL);
151 if (!vb) {
152 dprintk(1, "Memory alloc for buffer struct failed\n");
153 break;
154 }
155
156 /* Length stores number of planes for multiplanar buffers */
157 if (V4L2_TYPE_IS_MULTIPLANAR(q->type))
158 vb->v4l2_buf.length = num_planes;
159
160 vb->state = VB2_BUF_STATE_DEQUEUED;
161 vb->vb2_queue = q;
162 vb->num_planes = num_planes;
163 vb->v4l2_buf.index = buffer;
164 vb->v4l2_buf.type = q->type;
165 vb->v4l2_buf.memory = memory;
166
167 /* Allocate video buffer memory for the MMAP type */
168 if (memory == V4L2_MEMORY_MMAP) {
169 ret = __vb2_buf_mem_alloc(vb, plane_sizes);
170 if (ret) {
171 dprintk(1, "Failed allocating memory for "
172 "buffer %d\n", buffer);
173 kfree(vb);
174 break;
175 }
176 /*
177 * Call the driver-provided buffer initialization
178 * callback, if given. An error in initialization
179 * results in queue setup failure.
180 */
181 ret = call_qop(q, buf_init, vb);
182 if (ret) {
183 dprintk(1, "Buffer %d %p initialization"
184 " failed\n", buffer, vb);
185 __vb2_buf_mem_free(vb);
186 kfree(vb);
187 break;
188 }
189 }
190
191 q->bufs[buffer] = vb;
192 }
193
194 q->num_buffers = buffer;
195
196 __setup_offsets(q);
197
198 dprintk(1, "Allocated %d buffers, %d plane(s) each\n",
199 q->num_buffers, num_planes);
200
201 return buffer;
202}
203
204/**
205 * __vb2_free_mem() - release all video buffer memory for a given queue
206 */
207static void __vb2_free_mem(struct vb2_queue *q)
208{
209 unsigned int buffer;
210 struct vb2_buffer *vb;
211
212 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
213 vb = q->bufs[buffer];
214 if (!vb)
215 continue;
216
217 /* Free MMAP buffers or release USERPTR buffers */
218 if (q->memory == V4L2_MEMORY_MMAP)
219 __vb2_buf_mem_free(vb);
220 else
221 __vb2_buf_userptr_put(vb);
222 }
223}
224
225/**
226 * __vb2_queue_free() - free the queue - video memory and related information
227 * and return the queue to an uninitialized state. Might be called even if the
228 * queue has already been freed.
229 */
Marek Szyprowski72f1fc32011-03-10 09:10:49 -0300230static void __vb2_queue_free(struct vb2_queue *q)
Pawel Osciake23ccc02010-10-11 10:56:41 -0300231{
232 unsigned int buffer;
233
234 /* Call driver-provided cleanup function for each buffer, if provided */
235 if (q->ops->buf_cleanup) {
236 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
237 if (NULL == q->bufs[buffer])
238 continue;
239 q->ops->buf_cleanup(q->bufs[buffer]);
240 }
241 }
242
243 /* Release video buffer memory */
244 __vb2_free_mem(q);
245
246 /* Free videobuf buffers */
247 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
248 kfree(q->bufs[buffer]);
249 q->bufs[buffer] = NULL;
250 }
251
252 q->num_buffers = 0;
253 q->memory = 0;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300254}
255
256/**
257 * __verify_planes_array() - verify that the planes array passed in struct
258 * v4l2_buffer from userspace can be safely used
259 */
260static int __verify_planes_array(struct vb2_buffer *vb, struct v4l2_buffer *b)
261{
262 /* Is memory for copying plane information present? */
263 if (NULL == b->m.planes) {
264 dprintk(1, "Multi-planar buffer passed but "
265 "planes array not provided\n");
266 return -EINVAL;
267 }
268
269 if (b->length < vb->num_planes || b->length > VIDEO_MAX_PLANES) {
270 dprintk(1, "Incorrect planes array length, "
271 "expected %d, got %d\n", vb->num_planes, b->length);
272 return -EINVAL;
273 }
274
275 return 0;
276}
277
278/**
279 * __fill_v4l2_buffer() - fill in a struct v4l2_buffer with information to be
280 * returned to userspace
281 */
282static int __fill_v4l2_buffer(struct vb2_buffer *vb, struct v4l2_buffer *b)
283{
284 struct vb2_queue *q = vb->vb2_queue;
285 int ret = 0;
286
287 /* Copy back data such as timestamp, input, etc. */
288 memcpy(b, &vb->v4l2_buf, offsetof(struct v4l2_buffer, m));
289 b->input = vb->v4l2_buf.input;
290 b->reserved = vb->v4l2_buf.reserved;
291
292 if (V4L2_TYPE_IS_MULTIPLANAR(q->type)) {
293 ret = __verify_planes_array(vb, b);
294 if (ret)
295 return ret;
296
297 /*
298 * Fill in plane-related data if userspace provided an array
299 * for it. The memory and size is verified above.
300 */
301 memcpy(b->m.planes, vb->v4l2_planes,
302 b->length * sizeof(struct v4l2_plane));
303 } else {
304 /*
305 * We use length and offset in v4l2_planes array even for
306 * single-planar buffers, but userspace does not.
307 */
308 b->length = vb->v4l2_planes[0].length;
309 b->bytesused = vb->v4l2_planes[0].bytesused;
310 if (q->memory == V4L2_MEMORY_MMAP)
311 b->m.offset = vb->v4l2_planes[0].m.mem_offset;
312 else if (q->memory == V4L2_MEMORY_USERPTR)
313 b->m.userptr = vb->v4l2_planes[0].m.userptr;
314 }
315
316 b->flags = 0;
317
318 switch (vb->state) {
319 case VB2_BUF_STATE_QUEUED:
320 case VB2_BUF_STATE_ACTIVE:
321 b->flags |= V4L2_BUF_FLAG_QUEUED;
322 break;
323 case VB2_BUF_STATE_ERROR:
324 b->flags |= V4L2_BUF_FLAG_ERROR;
325 /* fall through */
326 case VB2_BUF_STATE_DONE:
327 b->flags |= V4L2_BUF_FLAG_DONE;
328 break;
329 case VB2_BUF_STATE_DEQUEUED:
330 /* nothing */
331 break;
332 }
333
334 if (vb->num_planes_mapped == vb->num_planes)
335 b->flags |= V4L2_BUF_FLAG_MAPPED;
336
337 return ret;
338}
339
340/**
341 * vb2_querybuf() - query video buffer information
342 * @q: videobuf queue
343 * @b: buffer struct passed from userspace to vidioc_querybuf handler
344 * in driver
345 *
346 * Should be called from vidioc_querybuf ioctl handler in driver.
347 * This function will verify the passed v4l2_buffer structure and fill the
348 * relevant information for the userspace.
349 *
350 * The return values from this function are intended to be directly returned
351 * from vidioc_querybuf handler in driver.
352 */
353int vb2_querybuf(struct vb2_queue *q, struct v4l2_buffer *b)
354{
355 struct vb2_buffer *vb;
356
357 if (b->type != q->type) {
358 dprintk(1, "querybuf: wrong buffer type\n");
359 return -EINVAL;
360 }
361
362 if (b->index >= q->num_buffers) {
363 dprintk(1, "querybuf: buffer index out of range\n");
364 return -EINVAL;
365 }
366 vb = q->bufs[b->index];
367
368 return __fill_v4l2_buffer(vb, b);
369}
370EXPORT_SYMBOL(vb2_querybuf);
371
372/**
373 * __verify_userptr_ops() - verify that all memory operations required for
374 * USERPTR queue type have been provided
375 */
376static int __verify_userptr_ops(struct vb2_queue *q)
377{
378 if (!(q->io_modes & VB2_USERPTR) || !q->mem_ops->get_userptr ||
379 !q->mem_ops->put_userptr)
380 return -EINVAL;
381
382 return 0;
383}
384
385/**
386 * __verify_mmap_ops() - verify that all memory operations required for
387 * MMAP queue type have been provided
388 */
389static int __verify_mmap_ops(struct vb2_queue *q)
390{
391 if (!(q->io_modes & VB2_MMAP) || !q->mem_ops->alloc ||
392 !q->mem_ops->put || !q->mem_ops->mmap)
393 return -EINVAL;
394
395 return 0;
396}
397
398/**
399 * __buffers_in_use() - return true if any buffers on the queue are in use and
400 * the queue cannot be freed (by the means of REQBUFS(0)) call
401 */
402static bool __buffers_in_use(struct vb2_queue *q)
403{
404 unsigned int buffer, plane;
405 struct vb2_buffer *vb;
406
407 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
408 vb = q->bufs[buffer];
409 for (plane = 0; plane < vb->num_planes; ++plane) {
410 /*
411 * If num_users() has not been provided, call_memop
412 * will return 0, apparently nobody cares about this
413 * case anyway. If num_users() returns more than 1,
414 * we are not the only user of the plane's memory.
415 */
416 if (call_memop(q, plane, num_users,
417 vb->planes[plane].mem_priv) > 1)
418 return true;
419 }
420 }
421
422 return false;
423}
424
425/**
426 * vb2_reqbufs() - Initiate streaming
427 * @q: videobuf2 queue
428 * @req: struct passed from userspace to vidioc_reqbufs handler in driver
429 *
430 * Should be called from vidioc_reqbufs ioctl handler of a driver.
431 * This function:
432 * 1) verifies streaming parameters passed from the userspace,
433 * 2) sets up the queue,
434 * 3) negotiates number of buffers and planes per buffer with the driver
435 * to be used during streaming,
436 * 4) allocates internal buffer structures (struct vb2_buffer), according to
437 * the agreed parameters,
438 * 5) for MMAP memory type, allocates actual video memory, using the
439 * memory handling/allocation routines provided during queue initialization
440 *
441 * If req->count is 0, all the memory will be freed instead.
442 * If the queue has been allocated previously (by a previous vb2_reqbufs) call
443 * and the queue is not busy, memory will be reallocated.
444 *
445 * The return values from this function are intended to be directly returned
446 * from vidioc_reqbufs handler in driver.
447 */
448int vb2_reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req)
449{
450 unsigned int num_buffers, num_planes;
451 unsigned long plane_sizes[VIDEO_MAX_PLANES];
452 int ret = 0;
453
Marek Szyprowskib25748f2010-12-06 05:56:55 -0300454 if (q->fileio) {
455 dprintk(1, "reqbufs: file io in progress\n");
456 return -EBUSY;
457 }
458
Pawel Osciake23ccc02010-10-11 10:56:41 -0300459 if (req->memory != V4L2_MEMORY_MMAP
460 && req->memory != V4L2_MEMORY_USERPTR) {
461 dprintk(1, "reqbufs: unsupported memory type\n");
462 return -EINVAL;
463 }
464
465 if (req->type != q->type) {
466 dprintk(1, "reqbufs: requested type is incorrect\n");
467 return -EINVAL;
468 }
469
470 if (q->streaming) {
471 dprintk(1, "reqbufs: streaming active\n");
472 return -EBUSY;
473 }
474
475 /*
476 * Make sure all the required memory ops for given memory type
477 * are available.
478 */
479 if (req->memory == V4L2_MEMORY_MMAP && __verify_mmap_ops(q)) {
480 dprintk(1, "reqbufs: MMAP for current setup unsupported\n");
481 return -EINVAL;
482 }
483
484 if (req->memory == V4L2_MEMORY_USERPTR && __verify_userptr_ops(q)) {
485 dprintk(1, "reqbufs: USERPTR for current setup unsupported\n");
486 return -EINVAL;
487 }
488
Marek Szyprowski31901a02011-03-11 06:07:27 -0300489 /*
490 * If the same number of buffers and memory access method is requested
491 * then return immediately.
492 */
493 if (q->memory == req->memory && req->count == q->num_buffers)
494 return 0;
495
Marek Szyprowski29e3fbd2011-03-09 14:03:24 -0300496 if (req->count == 0 || q->num_buffers != 0 || q->memory != req->memory) {
Pawel Osciake23ccc02010-10-11 10:56:41 -0300497 /*
498 * We already have buffers allocated, so first check if they
499 * are not in use and can be freed.
500 */
501 if (q->memory == V4L2_MEMORY_MMAP && __buffers_in_use(q)) {
502 dprintk(1, "reqbufs: memory in use, cannot free\n");
503 return -EBUSY;
504 }
505
Marek Szyprowski72f1fc32011-03-10 09:10:49 -0300506 __vb2_queue_free(q);
Marek Szyprowski29e3fbd2011-03-09 14:03:24 -0300507
508 /*
509 * In case of REQBUFS(0) return immediately without calling
510 * driver's queue_setup() callback and allocating resources.
511 */
512 if (req->count == 0)
513 return 0;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300514 }
515
516 /*
517 * Make sure the requested values and current defaults are sane.
518 */
519 num_buffers = min_t(unsigned int, req->count, VIDEO_MAX_FRAME);
520 memset(plane_sizes, 0, sizeof(plane_sizes));
521 memset(q->alloc_ctx, 0, sizeof(q->alloc_ctx));
522
523 /*
524 * Ask the driver how many buffers and planes per buffer it requires.
525 * Driver also sets the size and allocator context for each plane.
526 */
527 ret = call_qop(q, queue_setup, q, &num_buffers, &num_planes,
528 plane_sizes, q->alloc_ctx);
529 if (ret)
530 return ret;
531
532 /* Finally, allocate buffers and video memory */
533 ret = __vb2_queue_alloc(q, req->memory, num_buffers, num_planes,
534 plane_sizes);
535 if (ret < 0) {
536 dprintk(1, "Memory allocation failed with error: %d\n", ret);
537 return ret;
538 }
539
540 /*
541 * Check if driver can handle the allocated number of buffers.
542 */
543 if (ret < num_buffers) {
544 unsigned int orig_num_buffers;
545
546 orig_num_buffers = num_buffers = ret;
547 ret = call_qop(q, queue_setup, q, &num_buffers, &num_planes,
548 plane_sizes, q->alloc_ctx);
549 if (ret)
550 goto free_mem;
551
552 if (orig_num_buffers < num_buffers) {
553 ret = -ENOMEM;
554 goto free_mem;
555 }
556
557 /*
558 * Ok, driver accepted smaller number of buffers.
559 */
560 ret = num_buffers;
561 }
562
563 q->memory = req->memory;
564
565 /*
566 * Return the number of successfully allocated buffers
567 * to the userspace.
568 */
569 req->count = ret;
570
571 return 0;
572
573free_mem:
574 __vb2_queue_free(q);
575 return ret;
576}
577EXPORT_SYMBOL_GPL(vb2_reqbufs);
578
579/**
580 * vb2_plane_vaddr() - Return a kernel virtual address of a given plane
581 * @vb: vb2_buffer to which the plane in question belongs to
582 * @plane_no: plane number for which the address is to be returned
583 *
584 * This function returns a kernel virtual address of a given plane if
585 * such a mapping exist, NULL otherwise.
586 */
587void *vb2_plane_vaddr(struct vb2_buffer *vb, unsigned int plane_no)
588{
589 struct vb2_queue *q = vb->vb2_queue;
590
591 if (plane_no > vb->num_planes)
592 return NULL;
593
594 return call_memop(q, plane_no, vaddr, vb->planes[plane_no].mem_priv);
595
596}
597EXPORT_SYMBOL_GPL(vb2_plane_vaddr);
598
599/**
600 * vb2_plane_cookie() - Return allocator specific cookie for the given plane
601 * @vb: vb2_buffer to which the plane in question belongs to
602 * @plane_no: plane number for which the cookie is to be returned
603 *
604 * This function returns an allocator specific cookie for a given plane if
605 * available, NULL otherwise. The allocator should provide some simple static
606 * inline function, which would convert this cookie to the allocator specific
607 * type that can be used directly by the driver to access the buffer. This can
608 * be for example physical address, pointer to scatter list or IOMMU mapping.
609 */
610void *vb2_plane_cookie(struct vb2_buffer *vb, unsigned int plane_no)
611{
612 struct vb2_queue *q = vb->vb2_queue;
613
614 if (plane_no > vb->num_planes)
615 return NULL;
616
617 return call_memop(q, plane_no, cookie, vb->planes[plane_no].mem_priv);
618}
619EXPORT_SYMBOL_GPL(vb2_plane_cookie);
620
621/**
622 * vb2_buffer_done() - inform videobuf that an operation on a buffer is finished
623 * @vb: vb2_buffer returned from the driver
624 * @state: either VB2_BUF_STATE_DONE if the operation finished successfully
625 * or VB2_BUF_STATE_ERROR if the operation finished with an error
626 *
627 * This function should be called by the driver after a hardware operation on
628 * a buffer is finished and the buffer may be returned to userspace. The driver
629 * cannot use this buffer anymore until it is queued back to it by videobuf
630 * by the means of buf_queue callback. Only buffers previously queued to the
631 * driver by buf_queue can be passed to this function.
632 */
633void vb2_buffer_done(struct vb2_buffer *vb, enum vb2_buffer_state state)
634{
635 struct vb2_queue *q = vb->vb2_queue;
636 unsigned long flags;
637
638 if (vb->state != VB2_BUF_STATE_ACTIVE)
639 return;
640
641 if (state != VB2_BUF_STATE_DONE && state != VB2_BUF_STATE_ERROR)
642 return;
643
644 dprintk(4, "Done processing on buffer %d, state: %d\n",
645 vb->v4l2_buf.index, vb->state);
646
647 /* Add the buffer to the done buffers list */
648 spin_lock_irqsave(&q->done_lock, flags);
649 vb->state = state;
650 list_add_tail(&vb->done_entry, &q->done_list);
651 atomic_dec(&q->queued_count);
652 spin_unlock_irqrestore(&q->done_lock, flags);
653
654 /* Inform any processes that may be waiting for buffers */
655 wake_up(&q->done_wq);
656}
657EXPORT_SYMBOL_GPL(vb2_buffer_done);
658
659/**
660 * __fill_vb2_buffer() - fill a vb2_buffer with information provided in
661 * a v4l2_buffer by the userspace
662 */
663static int __fill_vb2_buffer(struct vb2_buffer *vb, struct v4l2_buffer *b,
664 struct v4l2_plane *v4l2_planes)
665{
666 unsigned int plane;
667 int ret;
668
669 if (V4L2_TYPE_IS_MULTIPLANAR(b->type)) {
670 /*
671 * Verify that the userspace gave us a valid array for
672 * plane information.
673 */
674 ret = __verify_planes_array(vb, b);
675 if (ret)
676 return ret;
677
678 /* Fill in driver-provided information for OUTPUT types */
679 if (V4L2_TYPE_IS_OUTPUT(b->type)) {
680 /*
681 * Will have to go up to b->length when API starts
682 * accepting variable number of planes.
683 */
684 for (plane = 0; plane < vb->num_planes; ++plane) {
685 v4l2_planes[plane].bytesused =
686 b->m.planes[plane].bytesused;
687 v4l2_planes[plane].data_offset =
688 b->m.planes[plane].data_offset;
689 }
690 }
691
692 if (b->memory == V4L2_MEMORY_USERPTR) {
693 for (plane = 0; plane < vb->num_planes; ++plane) {
694 v4l2_planes[plane].m.userptr =
695 b->m.planes[plane].m.userptr;
696 v4l2_planes[plane].length =
697 b->m.planes[plane].length;
698 }
699 }
700 } else {
701 /*
702 * Single-planar buffers do not use planes array,
703 * so fill in relevant v4l2_buffer struct fields instead.
704 * In videobuf we use our internal V4l2_planes struct for
705 * single-planar buffers as well, for simplicity.
706 */
707 if (V4L2_TYPE_IS_OUTPUT(b->type))
708 v4l2_planes[0].bytesused = b->bytesused;
709
710 if (b->memory == V4L2_MEMORY_USERPTR) {
711 v4l2_planes[0].m.userptr = b->m.userptr;
712 v4l2_planes[0].length = b->length;
713 }
714 }
715
716 vb->v4l2_buf.field = b->field;
717 vb->v4l2_buf.timestamp = b->timestamp;
718
719 return 0;
720}
721
722/**
723 * __qbuf_userptr() - handle qbuf of a USERPTR buffer
724 */
725static int __qbuf_userptr(struct vb2_buffer *vb, struct v4l2_buffer *b)
726{
727 struct v4l2_plane planes[VIDEO_MAX_PLANES];
728 struct vb2_queue *q = vb->vb2_queue;
729 void *mem_priv;
730 unsigned int plane;
731 int ret;
732 int write = !V4L2_TYPE_IS_OUTPUT(q->type);
733
734 /* Verify and copy relevant information provided by the userspace */
735 ret = __fill_vb2_buffer(vb, b, planes);
736 if (ret)
737 return ret;
738
739 for (plane = 0; plane < vb->num_planes; ++plane) {
740 /* Skip the plane if already verified */
741 if (vb->v4l2_planes[plane].m.userptr == planes[plane].m.userptr
742 && vb->v4l2_planes[plane].length == planes[plane].length)
743 continue;
744
745 dprintk(3, "qbuf: userspace address for plane %d changed, "
746 "reacquiring memory\n", plane);
747
748 /* Release previously acquired memory if present */
749 if (vb->planes[plane].mem_priv)
750 call_memop(q, plane, put_userptr,
751 vb->planes[plane].mem_priv);
752
753 vb->planes[plane].mem_priv = NULL;
754
755 /* Acquire each plane's memory */
756 if (q->mem_ops->get_userptr) {
757 mem_priv = q->mem_ops->get_userptr(q->alloc_ctx[plane],
758 planes[plane].m.userptr,
759 planes[plane].length,
760 write);
761 if (IS_ERR(mem_priv)) {
762 dprintk(1, "qbuf: failed acquiring userspace "
763 "memory for plane %d\n", plane);
764 ret = PTR_ERR(mem_priv);
765 goto err;
766 }
767 vb->planes[plane].mem_priv = mem_priv;
768 }
769 }
770
771 /*
772 * Call driver-specific initialization on the newly acquired buffer,
773 * if provided.
774 */
775 ret = call_qop(q, buf_init, vb);
776 if (ret) {
777 dprintk(1, "qbuf: buffer initialization failed\n");
778 goto err;
779 }
780
781 /*
782 * Now that everything is in order, copy relevant information
783 * provided by userspace.
784 */
785 for (plane = 0; plane < vb->num_planes; ++plane)
786 vb->v4l2_planes[plane] = planes[plane];
787
788 return 0;
789err:
790 /* In case of errors, release planes that were already acquired */
791 for (; plane > 0; --plane) {
792 call_memop(q, plane, put_userptr,
793 vb->planes[plane - 1].mem_priv);
794 vb->planes[plane - 1].mem_priv = NULL;
795 }
796
797 return ret;
798}
799
800/**
801 * __qbuf_mmap() - handle qbuf of an MMAP buffer
802 */
803static int __qbuf_mmap(struct vb2_buffer *vb, struct v4l2_buffer *b)
804{
805 return __fill_vb2_buffer(vb, b, vb->v4l2_planes);
806}
807
808/**
809 * __enqueue_in_driver() - enqueue a vb2_buffer in driver for processing
810 */
811static void __enqueue_in_driver(struct vb2_buffer *vb)
812{
813 struct vb2_queue *q = vb->vb2_queue;
814
815 vb->state = VB2_BUF_STATE_ACTIVE;
816 atomic_inc(&q->queued_count);
817 q->ops->buf_queue(vb);
818}
819
820/**
821 * vb2_qbuf() - Queue a buffer from userspace
822 * @q: videobuf2 queue
823 * @b: buffer structure passed from userspace to vidioc_qbuf handler
824 * in driver
825 *
826 * Should be called from vidioc_qbuf ioctl handler of a driver.
827 * This function:
828 * 1) verifies the passed buffer,
829 * 2) calls buf_prepare callback in the driver (if provided), in which
830 * driver-specific buffer initialization can be performed,
831 * 3) if streaming is on, queues the buffer in driver by the means of buf_queue
832 * callback for processing.
833 *
834 * The return values from this function are intended to be directly returned
835 * from vidioc_qbuf handler in driver.
836 */
837int vb2_qbuf(struct vb2_queue *q, struct v4l2_buffer *b)
838{
839 struct vb2_buffer *vb;
840 int ret = 0;
841
Marek Szyprowskib25748f2010-12-06 05:56:55 -0300842 if (q->fileio) {
843 dprintk(1, "qbuf: file io in progress\n");
844 return -EBUSY;
845 }
846
Pawel Osciake23ccc02010-10-11 10:56:41 -0300847 if (b->type != q->type) {
848 dprintk(1, "qbuf: invalid buffer type\n");
849 return -EINVAL;
850 }
851
852 if (b->index >= q->num_buffers) {
853 dprintk(1, "qbuf: buffer index out of range\n");
854 return -EINVAL;
855 }
856
857 vb = q->bufs[b->index];
858 if (NULL == vb) {
859 /* Should never happen */
860 dprintk(1, "qbuf: buffer is NULL\n");
861 return -EINVAL;
862 }
863
864 if (b->memory != q->memory) {
865 dprintk(1, "qbuf: invalid memory type\n");
866 return -EINVAL;
867 }
868
869 if (vb->state != VB2_BUF_STATE_DEQUEUED) {
870 dprintk(1, "qbuf: buffer already in use\n");
871 return -EINVAL;
872 }
873
874 if (q->memory == V4L2_MEMORY_MMAP)
875 ret = __qbuf_mmap(vb, b);
876 else if (q->memory == V4L2_MEMORY_USERPTR)
877 ret = __qbuf_userptr(vb, b);
878 else {
879 WARN(1, "Invalid queue type\n");
880 return -EINVAL;
881 }
882
883 if (ret)
884 return ret;
885
886 ret = call_qop(q, buf_prepare, vb);
887 if (ret) {
888 dprintk(1, "qbuf: buffer preparation failed\n");
889 return ret;
890 }
891
892 /*
893 * Add to the queued buffers list, a buffer will stay on it until
894 * dequeued in dqbuf.
895 */
896 list_add_tail(&vb->queued_entry, &q->queued_list);
897 vb->state = VB2_BUF_STATE_QUEUED;
898
899 /*
900 * If already streaming, give the buffer to driver for processing.
901 * If not, the buffer will be given to driver on next streamon.
902 */
903 if (q->streaming)
904 __enqueue_in_driver(vb);
905
906 dprintk(1, "qbuf of buffer %d succeeded\n", vb->v4l2_buf.index);
907 return 0;
908}
909EXPORT_SYMBOL_GPL(vb2_qbuf);
910
911/**
912 * __vb2_wait_for_done_vb() - wait for a buffer to become available
913 * for dequeuing
914 *
915 * Will sleep if required for nonblocking == false.
916 */
917static int __vb2_wait_for_done_vb(struct vb2_queue *q, int nonblocking)
918{
919 /*
920 * All operations on vb_done_list are performed under done_lock
921 * spinlock protection. However, buffers may be removed from
922 * it and returned to userspace only while holding both driver's
923 * lock and the done_lock spinlock. Thus we can be sure that as
924 * long as we hold the driver's lock, the list will remain not
925 * empty if list_empty() check succeeds.
926 */
927
928 for (;;) {
929 int ret;
930
931 if (!q->streaming) {
932 dprintk(1, "Streaming off, will not wait for buffers\n");
933 return -EINVAL;
934 }
935
936 if (!list_empty(&q->done_list)) {
937 /*
938 * Found a buffer that we were waiting for.
939 */
940 break;
941 }
942
943 if (nonblocking) {
944 dprintk(1, "Nonblocking and no buffers to dequeue, "
945 "will not wait\n");
946 return -EAGAIN;
947 }
948
949 /*
950 * We are streaming and blocking, wait for another buffer to
951 * become ready or for streamoff. Driver's lock is released to
952 * allow streamoff or qbuf to be called while waiting.
953 */
954 call_qop(q, wait_prepare, q);
955
956 /*
957 * All locks have been released, it is safe to sleep now.
958 */
959 dprintk(3, "Will sleep waiting for buffers\n");
960 ret = wait_event_interruptible(q->done_wq,
961 !list_empty(&q->done_list) || !q->streaming);
962
963 /*
964 * We need to reevaluate both conditions again after reacquiring
965 * the locks or return an error if one occurred.
966 */
967 call_qop(q, wait_finish, q);
968 if (ret)
969 return ret;
970 }
971 return 0;
972}
973
974/**
975 * __vb2_get_done_vb() - get a buffer ready for dequeuing
976 *
977 * Will sleep if required for nonblocking == false.
978 */
979static int __vb2_get_done_vb(struct vb2_queue *q, struct vb2_buffer **vb,
980 int nonblocking)
981{
982 unsigned long flags;
983 int ret;
984
985 /*
986 * Wait for at least one buffer to become available on the done_list.
987 */
988 ret = __vb2_wait_for_done_vb(q, nonblocking);
989 if (ret)
990 return ret;
991
992 /*
993 * Driver's lock has been held since we last verified that done_list
994 * is not empty, so no need for another list_empty(done_list) check.
995 */
996 spin_lock_irqsave(&q->done_lock, flags);
997 *vb = list_first_entry(&q->done_list, struct vb2_buffer, done_entry);
998 list_del(&(*vb)->done_entry);
999 spin_unlock_irqrestore(&q->done_lock, flags);
1000
1001 return 0;
1002}
1003
1004/**
1005 * vb2_wait_for_all_buffers() - wait until all buffers are given back to vb2
1006 * @q: videobuf2 queue
1007 *
1008 * This function will wait until all buffers that have been given to the driver
1009 * by buf_queue() are given back to vb2 with vb2_buffer_done(). It doesn't call
1010 * wait_prepare, wait_finish pair. It is intended to be called with all locks
1011 * taken, for example from stop_streaming() callback.
1012 */
1013int vb2_wait_for_all_buffers(struct vb2_queue *q)
1014{
1015 if (!q->streaming) {
1016 dprintk(1, "Streaming off, will not wait for buffers\n");
1017 return -EINVAL;
1018 }
1019
1020 wait_event(q->done_wq, !atomic_read(&q->queued_count));
1021 return 0;
1022}
1023EXPORT_SYMBOL_GPL(vb2_wait_for_all_buffers);
1024
1025/**
1026 * vb2_dqbuf() - Dequeue a buffer to the userspace
1027 * @q: videobuf2 queue
1028 * @b: buffer structure passed from userspace to vidioc_dqbuf handler
1029 * in driver
1030 * @nonblocking: if true, this call will not sleep waiting for a buffer if no
1031 * buffers ready for dequeuing are present. Normally the driver
1032 * would be passing (file->f_flags & O_NONBLOCK) here
1033 *
1034 * Should be called from vidioc_dqbuf ioctl handler of a driver.
1035 * This function:
1036 * 1) verifies the passed buffer,
1037 * 2) calls buf_finish callback in the driver (if provided), in which
1038 * driver can perform any additional operations that may be required before
1039 * returning the buffer to userspace, such as cache sync,
1040 * 3) the buffer struct members are filled with relevant information for
1041 * the userspace.
1042 *
1043 * The return values from this function are intended to be directly returned
1044 * from vidioc_dqbuf handler in driver.
1045 */
1046int vb2_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking)
1047{
1048 struct vb2_buffer *vb = NULL;
1049 int ret;
1050
Marek Szyprowskib25748f2010-12-06 05:56:55 -03001051 if (q->fileio) {
1052 dprintk(1, "dqbuf: file io in progress\n");
1053 return -EBUSY;
1054 }
1055
Pawel Osciake23ccc02010-10-11 10:56:41 -03001056 if (b->type != q->type) {
1057 dprintk(1, "dqbuf: invalid buffer type\n");
1058 return -EINVAL;
1059 }
1060
1061 ret = __vb2_get_done_vb(q, &vb, nonblocking);
1062 if (ret < 0) {
1063 dprintk(1, "dqbuf: error getting next done buffer\n");
1064 return ret;
1065 }
1066
1067 ret = call_qop(q, buf_finish, vb);
1068 if (ret) {
1069 dprintk(1, "dqbuf: buffer finish failed\n");
1070 return ret;
1071 }
1072
1073 switch (vb->state) {
1074 case VB2_BUF_STATE_DONE:
1075 dprintk(3, "dqbuf: Returning done buffer\n");
1076 break;
1077 case VB2_BUF_STATE_ERROR:
1078 dprintk(3, "dqbuf: Returning done buffer with errors\n");
1079 break;
1080 default:
1081 dprintk(1, "dqbuf: Invalid buffer state\n");
1082 return -EINVAL;
1083 }
1084
1085 /* Fill buffer information for the userspace */
1086 __fill_v4l2_buffer(vb, b);
1087 /* Remove from videobuf queue */
1088 list_del(&vb->queued_entry);
1089
1090 dprintk(1, "dqbuf of buffer %d, with state %d\n",
1091 vb->v4l2_buf.index, vb->state);
1092
1093 vb->state = VB2_BUF_STATE_DEQUEUED;
1094 return 0;
1095}
1096EXPORT_SYMBOL_GPL(vb2_dqbuf);
1097
1098/**
1099 * vb2_streamon - start streaming
1100 * @q: videobuf2 queue
1101 * @type: type argument passed from userspace to vidioc_streamon handler
1102 *
1103 * Should be called from vidioc_streamon handler of a driver.
1104 * This function:
1105 * 1) verifies current state
1106 * 2) starts streaming and passes any previously queued buffers to the driver
1107 *
1108 * The return values from this function are intended to be directly returned
1109 * from vidioc_streamon handler in the driver.
1110 */
1111int vb2_streamon(struct vb2_queue *q, enum v4l2_buf_type type)
1112{
1113 struct vb2_buffer *vb;
1114
Marek Szyprowskib25748f2010-12-06 05:56:55 -03001115 if (q->fileio) {
1116 dprintk(1, "streamon: file io in progress\n");
1117 return -EBUSY;
1118 }
1119
Pawel Osciake23ccc02010-10-11 10:56:41 -03001120 if (type != q->type) {
1121 dprintk(1, "streamon: invalid stream type\n");
1122 return -EINVAL;
1123 }
1124
1125 if (q->streaming) {
1126 dprintk(1, "streamon: already streaming\n");
1127 return -EBUSY;
1128 }
1129
1130 /*
1131 * Cannot start streaming on an OUTPUT device if no buffers have
1132 * been queued yet.
1133 */
1134 if (V4L2_TYPE_IS_OUTPUT(q->type)) {
1135 if (list_empty(&q->queued_list)) {
1136 dprintk(1, "streamon: no output buffers queued\n");
1137 return -EINVAL;
1138 }
1139 }
1140
1141 q->streaming = 1;
1142
1143 /*
1144 * Let driver notice that streaming state has been enabled.
1145 */
1146 call_qop(q, start_streaming, q);
1147
1148 /*
1149 * If any buffers were queued before streamon,
1150 * we can now pass them to driver for processing.
1151 */
1152 list_for_each_entry(vb, &q->queued_list, queued_entry)
1153 __enqueue_in_driver(vb);
1154
1155 dprintk(3, "Streamon successful\n");
1156 return 0;
1157}
1158EXPORT_SYMBOL_GPL(vb2_streamon);
1159
1160/**
1161 * __vb2_queue_cancel() - cancel and stop (pause) streaming
1162 *
1163 * Removes all queued buffers from driver's queue and all buffers queued by
1164 * userspace from videobuf's queue. Returns to state after reqbufs.
1165 */
1166static void __vb2_queue_cancel(struct vb2_queue *q)
1167{
1168 unsigned int i;
1169
1170 /*
1171 * Tell driver to stop all transactions and release all queued
1172 * buffers.
1173 */
1174 if (q->streaming)
1175 call_qop(q, stop_streaming, q);
1176 q->streaming = 0;
1177
1178 /*
1179 * Remove all buffers from videobuf's list...
1180 */
1181 INIT_LIST_HEAD(&q->queued_list);
1182 /*
1183 * ...and done list; userspace will not receive any buffers it
1184 * has not already dequeued before initiating cancel.
1185 */
1186 INIT_LIST_HEAD(&q->done_list);
1187 wake_up_all(&q->done_wq);
1188
1189 /*
1190 * Reinitialize all buffers for next use.
1191 */
1192 for (i = 0; i < q->num_buffers; ++i)
1193 q->bufs[i]->state = VB2_BUF_STATE_DEQUEUED;
1194}
1195
1196/**
1197 * vb2_streamoff - stop streaming
1198 * @q: videobuf2 queue
1199 * @type: type argument passed from userspace to vidioc_streamoff handler
1200 *
1201 * Should be called from vidioc_streamoff handler of a driver.
1202 * This function:
1203 * 1) verifies current state,
1204 * 2) stop streaming and dequeues any queued buffers, including those previously
1205 * passed to the driver (after waiting for the driver to finish).
1206 *
1207 * This call can be used for pausing playback.
1208 * The return values from this function are intended to be directly returned
1209 * from vidioc_streamoff handler in the driver
1210 */
1211int vb2_streamoff(struct vb2_queue *q, enum v4l2_buf_type type)
1212{
Marek Szyprowskib25748f2010-12-06 05:56:55 -03001213 if (q->fileio) {
1214 dprintk(1, "streamoff: file io in progress\n");
1215 return -EBUSY;
1216 }
1217
Pawel Osciake23ccc02010-10-11 10:56:41 -03001218 if (type != q->type) {
1219 dprintk(1, "streamoff: invalid stream type\n");
1220 return -EINVAL;
1221 }
1222
1223 if (!q->streaming) {
1224 dprintk(1, "streamoff: not streaming\n");
1225 return -EINVAL;
1226 }
1227
1228 /*
1229 * Cancel will pause streaming and remove all buffers from the driver
1230 * and videobuf, effectively returning control over them to userspace.
1231 */
1232 __vb2_queue_cancel(q);
1233
1234 dprintk(3, "Streamoff successful\n");
1235 return 0;
1236}
1237EXPORT_SYMBOL_GPL(vb2_streamoff);
1238
1239/**
1240 * __find_plane_by_offset() - find plane associated with the given offset off
1241 */
1242static int __find_plane_by_offset(struct vb2_queue *q, unsigned long off,
1243 unsigned int *_buffer, unsigned int *_plane)
1244{
1245 struct vb2_buffer *vb;
1246 unsigned int buffer, plane;
1247
1248 /*
1249 * Go over all buffers and their planes, comparing the given offset
1250 * with an offset assigned to each plane. If a match is found,
1251 * return its buffer and plane numbers.
1252 */
1253 for (buffer = 0; buffer < q->num_buffers; ++buffer) {
1254 vb = q->bufs[buffer];
1255
1256 for (plane = 0; plane < vb->num_planes; ++plane) {
1257 if (vb->v4l2_planes[plane].m.mem_offset == off) {
1258 *_buffer = buffer;
1259 *_plane = plane;
1260 return 0;
1261 }
1262 }
1263 }
1264
1265 return -EINVAL;
1266}
1267
1268/**
1269 * vb2_mmap() - map video buffers into application address space
1270 * @q: videobuf2 queue
1271 * @vma: vma passed to the mmap file operation handler in the driver
1272 *
1273 * Should be called from mmap file operation handler of a driver.
1274 * This function maps one plane of one of the available video buffers to
1275 * userspace. To map whole video memory allocated on reqbufs, this function
1276 * has to be called once per each plane per each buffer previously allocated.
1277 *
1278 * When the userspace application calls mmap, it passes to it an offset returned
1279 * to it earlier by the means of vidioc_querybuf handler. That offset acts as
1280 * a "cookie", which is then used to identify the plane to be mapped.
1281 * This function finds a plane with a matching offset and a mapping is performed
1282 * by the means of a provided memory operation.
1283 *
1284 * The return values from this function are intended to be directly returned
1285 * from the mmap handler in driver.
1286 */
1287int vb2_mmap(struct vb2_queue *q, struct vm_area_struct *vma)
1288{
1289 unsigned long off = vma->vm_pgoff << PAGE_SHIFT;
1290 struct vb2_plane *vb_plane;
1291 struct vb2_buffer *vb;
1292 unsigned int buffer, plane;
1293 int ret;
1294
1295 if (q->memory != V4L2_MEMORY_MMAP) {
1296 dprintk(1, "Queue is not currently set up for mmap\n");
1297 return -EINVAL;
1298 }
1299
1300 /*
1301 * Check memory area access mode.
1302 */
1303 if (!(vma->vm_flags & VM_SHARED)) {
1304 dprintk(1, "Invalid vma flags, VM_SHARED needed\n");
1305 return -EINVAL;
1306 }
1307 if (V4L2_TYPE_IS_OUTPUT(q->type)) {
1308 if (!(vma->vm_flags & VM_WRITE)) {
1309 dprintk(1, "Invalid vma flags, VM_WRITE needed\n");
1310 return -EINVAL;
1311 }
1312 } else {
1313 if (!(vma->vm_flags & VM_READ)) {
1314 dprintk(1, "Invalid vma flags, VM_READ needed\n");
1315 return -EINVAL;
1316 }
1317 }
1318
1319 /*
1320 * Find the plane corresponding to the offset passed by userspace.
1321 */
1322 ret = __find_plane_by_offset(q, off, &buffer, &plane);
1323 if (ret)
1324 return ret;
1325
1326 vb = q->bufs[buffer];
1327 vb_plane = &vb->planes[plane];
1328
1329 ret = q->mem_ops->mmap(vb_plane->mem_priv, vma);
1330 if (ret)
1331 return ret;
1332
1333 vb_plane->mapped = 1;
1334 vb->num_planes_mapped++;
1335
1336 dprintk(3, "Buffer %d, plane %d successfully mapped\n", buffer, plane);
1337 return 0;
1338}
1339EXPORT_SYMBOL_GPL(vb2_mmap);
1340
Marek Szyprowskib25748f2010-12-06 05:56:55 -03001341static int __vb2_init_fileio(struct vb2_queue *q, int read);
1342static int __vb2_cleanup_fileio(struct vb2_queue *q);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001343
1344/**
1345 * vb2_poll() - implements poll userspace operation
1346 * @q: videobuf2 queue
1347 * @file: file argument passed to the poll file operation handler
1348 * @wait: wait argument passed to the poll file operation handler
1349 *
1350 * This function implements poll file operation handler for a driver.
1351 * For CAPTURE queues, if a buffer is ready to be dequeued, the userspace will
1352 * be informed that the file descriptor of a video device is available for
1353 * reading.
1354 * For OUTPUT queues, if a buffer is ready to be dequeued, the file descriptor
1355 * will be reported as available for writing.
1356 *
1357 * The return values from this function are intended to be directly returned
1358 * from poll handler in driver.
1359 */
1360unsigned int vb2_poll(struct vb2_queue *q, struct file *file, poll_table *wait)
1361{
1362 unsigned long flags;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03001363 unsigned int ret;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001364 struct vb2_buffer *vb = NULL;
1365
1366 /*
Pawel Osciak4ffabdb2011-03-20 18:17:34 -03001367 * Start file I/O emulator only if streaming API has not been used yet.
Marek Szyprowskib25748f2010-12-06 05:56:55 -03001368 */
1369 if (q->num_buffers == 0 && q->fileio == NULL) {
1370 if (!V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_READ)) {
1371 ret = __vb2_init_fileio(q, 1);
1372 if (ret)
Pawel Osciak4ffabdb2011-03-20 18:17:34 -03001373 return POLLERR;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03001374 }
1375 if (V4L2_TYPE_IS_OUTPUT(q->type) && (q->io_modes & VB2_WRITE)) {
1376 ret = __vb2_init_fileio(q, 0);
1377 if (ret)
Pawel Osciak4ffabdb2011-03-20 18:17:34 -03001378 return POLLERR;
Marek Szyprowskib25748f2010-12-06 05:56:55 -03001379 /*
1380 * Write to OUTPUT queue can be done immediately.
1381 */
1382 return POLLOUT | POLLWRNORM;
1383 }
1384 }
1385
1386 /*
Pawel Osciake23ccc02010-10-11 10:56:41 -03001387 * There is nothing to wait for if no buffers have already been queued.
1388 */
1389 if (list_empty(&q->queued_list))
1390 return POLLERR;
1391
1392 poll_wait(file, &q->done_wq, wait);
1393
1394 /*
1395 * Take first buffer available for dequeuing.
1396 */
1397 spin_lock_irqsave(&q->done_lock, flags);
1398 if (!list_empty(&q->done_list))
1399 vb = list_first_entry(&q->done_list, struct vb2_buffer,
1400 done_entry);
1401 spin_unlock_irqrestore(&q->done_lock, flags);
1402
1403 if (vb && (vb->state == VB2_BUF_STATE_DONE
1404 || vb->state == VB2_BUF_STATE_ERROR)) {
1405 return (V4L2_TYPE_IS_OUTPUT(q->type)) ? POLLOUT | POLLWRNORM :
1406 POLLIN | POLLRDNORM;
1407 }
1408 return 0;
1409}
1410EXPORT_SYMBOL_GPL(vb2_poll);
1411
1412/**
1413 * vb2_queue_init() - initialize a videobuf2 queue
1414 * @q: videobuf2 queue; this structure should be allocated in driver
1415 *
1416 * The vb2_queue structure should be allocated by the driver. The driver is
1417 * responsible of clearing it's content and setting initial values for some
1418 * required entries before calling this function.
1419 * q->ops, q->mem_ops, q->type and q->io_modes are mandatory. Please refer
1420 * to the struct vb2_queue description in include/media/videobuf2-core.h
1421 * for more information.
1422 */
1423int vb2_queue_init(struct vb2_queue *q)
1424{
1425 BUG_ON(!q);
1426 BUG_ON(!q->ops);
1427 BUG_ON(!q->mem_ops);
1428 BUG_ON(!q->type);
1429 BUG_ON(!q->io_modes);
1430
1431 BUG_ON(!q->ops->queue_setup);
1432 BUG_ON(!q->ops->buf_queue);
1433
1434 INIT_LIST_HEAD(&q->queued_list);
1435 INIT_LIST_HEAD(&q->done_list);
1436 spin_lock_init(&q->done_lock);
1437 init_waitqueue_head(&q->done_wq);
1438
1439 if (q->buf_struct_size == 0)
1440 q->buf_struct_size = sizeof(struct vb2_buffer);
1441
1442 return 0;
1443}
1444EXPORT_SYMBOL_GPL(vb2_queue_init);
1445
1446/**
1447 * vb2_queue_release() - stop streaming, release the queue and free memory
1448 * @q: videobuf2 queue
1449 *
1450 * This function stops streaming and performs necessary clean ups, including
1451 * freeing video buffer memory. The driver is responsible for freeing
1452 * the vb2_queue structure itself.
1453 */
1454void vb2_queue_release(struct vb2_queue *q)
1455{
Marek Szyprowskib25748f2010-12-06 05:56:55 -03001456 __vb2_cleanup_fileio(q);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001457 __vb2_queue_cancel(q);
1458 __vb2_queue_free(q);
1459}
1460EXPORT_SYMBOL_GPL(vb2_queue_release);
1461
Marek Szyprowskib25748f2010-12-06 05:56:55 -03001462/**
1463 * struct vb2_fileio_buf - buffer context used by file io emulator
1464 *
1465 * vb2 provides a compatibility layer and emulator of file io (read and
1466 * write) calls on top of streaming API. This structure is used for
1467 * tracking context related to the buffers.
1468 */
1469struct vb2_fileio_buf {
1470 void *vaddr;
1471 unsigned int size;
1472 unsigned int pos;
1473 unsigned int queued:1;
1474};
1475
1476/**
1477 * struct vb2_fileio_data - queue context used by file io emulator
1478 *
1479 * vb2 provides a compatibility layer and emulator of file io (read and
1480 * write) calls on top of streaming API. For proper operation it required
1481 * this structure to save the driver state between each call of the read
1482 * or write function.
1483 */
1484struct vb2_fileio_data {
1485 struct v4l2_requestbuffers req;
1486 struct v4l2_buffer b;
1487 struct vb2_fileio_buf bufs[VIDEO_MAX_FRAME];
1488 unsigned int index;
1489 unsigned int q_count;
1490 unsigned int dq_count;
1491 unsigned int flags;
1492};
1493
1494/**
1495 * __vb2_init_fileio() - initialize file io emulator
1496 * @q: videobuf2 queue
1497 * @read: mode selector (1 means read, 0 means write)
1498 */
1499static int __vb2_init_fileio(struct vb2_queue *q, int read)
1500{
1501 struct vb2_fileio_data *fileio;
1502 int i, ret;
1503 unsigned int count = 0;
1504
1505 /*
1506 * Sanity check
1507 */
1508 if ((read && !(q->io_modes & VB2_READ)) ||
1509 (!read && !(q->io_modes & VB2_WRITE)))
1510 BUG();
1511
1512 /*
1513 * Check if device supports mapping buffers to kernel virtual space.
1514 */
1515 if (!q->mem_ops->vaddr)
1516 return -EBUSY;
1517
1518 /*
1519 * Check if streaming api has not been already activated.
1520 */
1521 if (q->streaming || q->num_buffers > 0)
1522 return -EBUSY;
1523
1524 /*
1525 * Start with count 1, driver can increase it in queue_setup()
1526 */
1527 count = 1;
1528
1529 dprintk(3, "setting up file io: mode %s, count %d, flags %08x\n",
1530 (read) ? "read" : "write", count, q->io_flags);
1531
1532 fileio = kzalloc(sizeof(struct vb2_fileio_data), GFP_KERNEL);
1533 if (fileio == NULL)
1534 return -ENOMEM;
1535
1536 fileio->flags = q->io_flags;
1537
1538 /*
1539 * Request buffers and use MMAP type to force driver
1540 * to allocate buffers by itself.
1541 */
1542 fileio->req.count = count;
1543 fileio->req.memory = V4L2_MEMORY_MMAP;
1544 fileio->req.type = q->type;
1545 ret = vb2_reqbufs(q, &fileio->req);
1546 if (ret)
1547 goto err_kfree;
1548
1549 /*
1550 * Check if plane_count is correct
1551 * (multiplane buffers are not supported).
1552 */
1553 if (q->bufs[0]->num_planes != 1) {
1554 fileio->req.count = 0;
1555 ret = -EBUSY;
1556 goto err_reqbufs;
1557 }
1558
1559 /*
1560 * Get kernel address of each buffer.
1561 */
1562 for (i = 0; i < q->num_buffers; i++) {
1563 fileio->bufs[i].vaddr = vb2_plane_vaddr(q->bufs[i], 0);
1564 if (fileio->bufs[i].vaddr == NULL)
1565 goto err_reqbufs;
1566 fileio->bufs[i].size = vb2_plane_size(q->bufs[i], 0);
1567 }
1568
1569 /*
1570 * Read mode requires pre queuing of all buffers.
1571 */
1572 if (read) {
1573 /*
1574 * Queue all buffers.
1575 */
1576 for (i = 0; i < q->num_buffers; i++) {
1577 struct v4l2_buffer *b = &fileio->b;
1578 memset(b, 0, sizeof(*b));
1579 b->type = q->type;
1580 b->memory = q->memory;
1581 b->index = i;
1582 ret = vb2_qbuf(q, b);
1583 if (ret)
1584 goto err_reqbufs;
1585 fileio->bufs[i].queued = 1;
1586 }
1587
1588 /*
1589 * Start streaming.
1590 */
1591 ret = vb2_streamon(q, q->type);
1592 if (ret)
1593 goto err_reqbufs;
1594 }
1595
1596 q->fileio = fileio;
1597
1598 return ret;
1599
1600err_reqbufs:
1601 vb2_reqbufs(q, &fileio->req);
1602
1603err_kfree:
1604 kfree(fileio);
1605 return ret;
1606}
1607
1608/**
1609 * __vb2_cleanup_fileio() - free resourced used by file io emulator
1610 * @q: videobuf2 queue
1611 */
1612static int __vb2_cleanup_fileio(struct vb2_queue *q)
1613{
1614 struct vb2_fileio_data *fileio = q->fileio;
1615
1616 if (fileio) {
1617 /*
1618 * Hack fileio context to enable direct calls to vb2 ioctl
1619 * interface.
1620 */
1621 q->fileio = NULL;
1622
1623 vb2_streamoff(q, q->type);
1624 fileio->req.count = 0;
1625 vb2_reqbufs(q, &fileio->req);
1626 kfree(fileio);
1627 dprintk(3, "file io emulator closed\n");
1628 }
1629 return 0;
1630}
1631
1632/**
1633 * __vb2_perform_fileio() - perform a single file io (read or write) operation
1634 * @q: videobuf2 queue
1635 * @data: pointed to target userspace buffer
1636 * @count: number of bytes to read or write
1637 * @ppos: file handle position tracking pointer
1638 * @nonblock: mode selector (1 means blocking calls, 0 means nonblocking)
1639 * @read: access mode selector (1 means read, 0 means write)
1640 */
1641static size_t __vb2_perform_fileio(struct vb2_queue *q, char __user *data, size_t count,
1642 loff_t *ppos, int nonblock, int read)
1643{
1644 struct vb2_fileio_data *fileio;
1645 struct vb2_fileio_buf *buf;
1646 int ret, index;
1647
Mauro Carvalho Chehab08b99e22011-01-11 17:12:34 -03001648 dprintk(3, "file io: mode %s, offset %ld, count %zd, %sblocking\n",
Marek Szyprowskib25748f2010-12-06 05:56:55 -03001649 read ? "read" : "write", (long)*ppos, count,
1650 nonblock ? "non" : "");
1651
1652 if (!data)
1653 return -EINVAL;
1654
1655 /*
1656 * Initialize emulator on first call.
1657 */
1658 if (!q->fileio) {
1659 ret = __vb2_init_fileio(q, read);
1660 dprintk(3, "file io: vb2_init_fileio result: %d\n", ret);
1661 if (ret)
1662 return ret;
1663 }
1664 fileio = q->fileio;
1665
1666 /*
1667 * Hack fileio context to enable direct calls to vb2 ioctl interface.
1668 * The pointer will be restored before returning from this function.
1669 */
1670 q->fileio = NULL;
1671
1672 index = fileio->index;
1673 buf = &fileio->bufs[index];
1674
1675 /*
1676 * Check if we need to dequeue the buffer.
1677 */
1678 if (buf->queued) {
1679 struct vb2_buffer *vb;
1680
1681 /*
1682 * Call vb2_dqbuf to get buffer back.
1683 */
1684 memset(&fileio->b, 0, sizeof(fileio->b));
1685 fileio->b.type = q->type;
1686 fileio->b.memory = q->memory;
1687 fileio->b.index = index;
1688 ret = vb2_dqbuf(q, &fileio->b, nonblock);
1689 dprintk(5, "file io: vb2_dqbuf result: %d\n", ret);
1690 if (ret)
1691 goto end;
1692 fileio->dq_count += 1;
1693
1694 /*
1695 * Get number of bytes filled by the driver
1696 */
1697 vb = q->bufs[index];
1698 buf->size = vb2_get_plane_payload(vb, 0);
1699 buf->queued = 0;
1700 }
1701
1702 /*
1703 * Limit count on last few bytes of the buffer.
1704 */
1705 if (buf->pos + count > buf->size) {
1706 count = buf->size - buf->pos;
Mauro Carvalho Chehab08b99e22011-01-11 17:12:34 -03001707 dprintk(5, "reducing read count: %zd\n", count);
Marek Szyprowskib25748f2010-12-06 05:56:55 -03001708 }
1709
1710 /*
1711 * Transfer data to userspace.
1712 */
Mauro Carvalho Chehab08b99e22011-01-11 17:12:34 -03001713 dprintk(3, "file io: copying %zd bytes - buffer %d, offset %u\n",
Marek Szyprowskib25748f2010-12-06 05:56:55 -03001714 count, index, buf->pos);
1715 if (read)
1716 ret = copy_to_user(data, buf->vaddr + buf->pos, count);
1717 else
1718 ret = copy_from_user(buf->vaddr + buf->pos, data, count);
1719 if (ret) {
1720 dprintk(3, "file io: error copying data\n");
1721 ret = -EFAULT;
1722 goto end;
1723 }
1724
1725 /*
1726 * Update counters.
1727 */
1728 buf->pos += count;
1729 *ppos += count;
1730
1731 /*
1732 * Queue next buffer if required.
1733 */
1734 if (buf->pos == buf->size ||
1735 (!read && (fileio->flags & VB2_FILEIO_WRITE_IMMEDIATELY))) {
1736 /*
1737 * Check if this is the last buffer to read.
1738 */
1739 if (read && (fileio->flags & VB2_FILEIO_READ_ONCE) &&
1740 fileio->dq_count == 1) {
1741 dprintk(3, "file io: read limit reached\n");
1742 /*
1743 * Restore fileio pointer and release the context.
1744 */
1745 q->fileio = fileio;
1746 return __vb2_cleanup_fileio(q);
1747 }
1748
1749 /*
1750 * Call vb2_qbuf and give buffer to the driver.
1751 */
1752 memset(&fileio->b, 0, sizeof(fileio->b));
1753 fileio->b.type = q->type;
1754 fileio->b.memory = q->memory;
1755 fileio->b.index = index;
1756 fileio->b.bytesused = buf->pos;
1757 ret = vb2_qbuf(q, &fileio->b);
1758 dprintk(5, "file io: vb2_dbuf result: %d\n", ret);
1759 if (ret)
1760 goto end;
1761
1762 /*
1763 * Buffer has been queued, update the status
1764 */
1765 buf->pos = 0;
1766 buf->queued = 1;
1767 buf->size = q->bufs[0]->v4l2_planes[0].length;
1768 fileio->q_count += 1;
1769
1770 /*
1771 * Switch to the next buffer
1772 */
1773 fileio->index = (index + 1) % q->num_buffers;
1774
1775 /*
1776 * Start streaming if required.
1777 */
1778 if (!read && !q->streaming) {
1779 ret = vb2_streamon(q, q->type);
1780 if (ret)
1781 goto end;
1782 }
1783 }
1784
1785 /*
1786 * Return proper number of bytes processed.
1787 */
1788 if (ret == 0)
1789 ret = count;
1790end:
1791 /*
1792 * Restore the fileio context and block vb2 ioctl interface.
1793 */
1794 q->fileio = fileio;
1795 return ret;
1796}
1797
1798size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count,
1799 loff_t *ppos, int nonblocking)
1800{
1801 return __vb2_perform_fileio(q, data, count, ppos, nonblocking, 1);
1802}
1803EXPORT_SYMBOL_GPL(vb2_read);
1804
1805size_t vb2_write(struct vb2_queue *q, char __user *data, size_t count,
1806 loff_t *ppos, int nonblocking)
1807{
1808 return __vb2_perform_fileio(q, data, count, ppos, nonblocking, 0);
1809}
1810EXPORT_SYMBOL_GPL(vb2_write);
1811
Pawel Osciake23ccc02010-10-11 10:56:41 -03001812MODULE_DESCRIPTION("Driver helper framework for Video for Linux 2");
Pawel Osciak95072082011-03-13 15:23:32 -03001813MODULE_AUTHOR("Pawel Osciak <pawel@osciak.com>, Marek Szyprowski");
Pawel Osciake23ccc02010-10-11 10:56:41 -03001814MODULE_LICENSE("GPL");