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