1 /*
2 * videobuf2-v4l2.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
32 #include <media/videobuf2-v4l2.h>
33
34 static int debug;
35 module_param(debug, int, 0644);
36
37 #define dprintk(level, fmt, arg...) \
38 do { \
39 if (debug >= level) \
40 pr_info("vb2-v4l2: %s: " fmt, __func__, ## arg); \
41 } while (0)
42
43 /* Flags that are set by the vb2 core */
44 #define V4L2_BUFFER_MASK_FLAGS (V4L2_BUF_FLAG_MAPPED | V4L2_BUF_FLAG_QUEUED | \
45 V4L2_BUF_FLAG_DONE | V4L2_BUF_FLAG_ERROR | \
46 V4L2_BUF_FLAG_PREPARED | \
47 V4L2_BUF_FLAG_TIMESTAMP_MASK)
48 /* Output buffer flags that should be passed on to the driver */
49 #define V4L2_BUFFER_OUT_FLAGS (V4L2_BUF_FLAG_PFRAME | V4L2_BUF_FLAG_BFRAME | \
50 V4L2_BUF_FLAG_KEYFRAME | V4L2_BUF_FLAG_TIMECODE)
51
52 /**
53 * __verify_planes_array() - verify that the planes array passed in struct
54 * v4l2_buffer from userspace can be safely used
55 */
__verify_planes_array(struct vb2_buffer * vb,const struct v4l2_buffer * b)56 static int __verify_planes_array(struct vb2_buffer *vb, const struct v4l2_buffer *b)
57 {
58 if (!V4L2_TYPE_IS_MULTIPLANAR(b->type))
59 return 0;
60
61 /* Is memory for copying plane information present? */
62 if (b->m.planes == NULL) {
63 dprintk(1, "multi-planar buffer passed but "
64 "planes array not provided\n");
65 return -EINVAL;
66 }
67
68 if (b->length < vb->num_planes || b->length > VB2_MAX_PLANES) {
69 dprintk(1, "incorrect planes array length, "
70 "expected %d, got %d\n", vb->num_planes, b->length);
71 return -EINVAL;
72 }
73
74 return 0;
75 }
76
__verify_planes_array_core(struct vb2_buffer * vb,const void * pb)77 static int __verify_planes_array_core(struct vb2_buffer *vb, const void *pb)
78 {
79 return __verify_planes_array(vb, pb);
80 }
81
82 /**
83 * __verify_length() - Verify that the bytesused value for each plane fits in
84 * the plane length and that the data offset doesn't exceed the bytesused value.
85 */
__verify_length(struct vb2_buffer * vb,const struct v4l2_buffer * b)86 static int __verify_length(struct vb2_buffer *vb, const struct v4l2_buffer *b)
87 {
88 unsigned int length;
89 unsigned int bytesused;
90 unsigned int plane;
91
92 if (!V4L2_TYPE_IS_OUTPUT(b->type))
93 return 0;
94
95 if (V4L2_TYPE_IS_MULTIPLANAR(b->type)) {
96 for (plane = 0; plane < vb->num_planes; ++plane) {
97 length = (b->memory == VB2_MEMORY_USERPTR ||
98 b->memory == VB2_MEMORY_DMABUF)
99 ? b->m.planes[plane].length
100 : vb->planes[plane].length;
101 bytesused = b->m.planes[plane].bytesused
102 ? b->m.planes[plane].bytesused : length;
103
104 if (b->m.planes[plane].bytesused > length)
105 return -EINVAL;
106
107 if (b->m.planes[plane].data_offset > 0 &&
108 b->m.planes[plane].data_offset >= bytesused)
109 return -EINVAL;
110 }
111 } else {
112 length = (b->memory == VB2_MEMORY_USERPTR)
113 ? b->length : vb->planes[0].length;
114
115 if (b->bytesused > length)
116 return -EINVAL;
117 }
118
119 return 0;
120 }
121
__copy_timestamp(struct vb2_buffer * vb,const void * pb)122 static void __copy_timestamp(struct vb2_buffer *vb, const void *pb)
123 {
124 const struct v4l2_buffer *b = pb;
125 struct vb2_v4l2_buffer *vbuf = to_vb2_v4l2_buffer(vb);
126 struct vb2_queue *q = vb->vb2_queue;
127
128 if (q->is_output) {
129 /*
130 * For output buffers copy the timestamp if needed,
131 * and the timecode field and flag if needed.
132 */
133 if (q->copy_timestamp)
134 vb->timestamp = timeval_to_ns(&b->timestamp);
135 vbuf->flags |= b->flags & V4L2_BUF_FLAG_TIMECODE;
136 if (b->flags & V4L2_BUF_FLAG_TIMECODE)
137 vbuf->timecode = b->timecode;
138 }
139 };
140
vb2_warn_zero_bytesused(struct vb2_buffer * vb)141 static void vb2_warn_zero_bytesused(struct vb2_buffer *vb)
142 {
143 static bool check_once;
144
145 if (check_once)
146 return;
147
148 check_once = true;
149 WARN_ON(1);
150
151 pr_warn("use of bytesused == 0 is deprecated and will be removed in the future,\n");
152 if (vb->vb2_queue->allow_zero_bytesused)
153 pr_warn("use VIDIOC_DECODER_CMD(V4L2_DEC_CMD_STOP) instead.\n");
154 else
155 pr_warn("use the actual size instead.\n");
156 }
157
vb2_queue_or_prepare_buf(struct vb2_queue * q,struct v4l2_buffer * b,const char * opname)158 static int vb2_queue_or_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b,
159 const char *opname)
160 {
161 if (b->type != q->type) {
162 dprintk(1, "%s: invalid buffer type\n", opname);
163 return -EINVAL;
164 }
165
166 if (b->index >= q->num_buffers) {
167 dprintk(1, "%s: buffer index out of range\n", opname);
168 return -EINVAL;
169 }
170
171 if (q->bufs[b->index] == NULL) {
172 /* Should never happen */
173 dprintk(1, "%s: buffer is NULL\n", opname);
174 return -EINVAL;
175 }
176
177 if (b->memory != q->memory) {
178 dprintk(1, "%s: invalid memory type\n", opname);
179 return -EINVAL;
180 }
181
182 return __verify_planes_array(q->bufs[b->index], b);
183 }
184
185 /**
186 * __fill_v4l2_buffer() - fill in a struct v4l2_buffer with information to be
187 * returned to userspace
188 */
__fill_v4l2_buffer(struct vb2_buffer * vb,void * pb)189 static void __fill_v4l2_buffer(struct vb2_buffer *vb, void *pb)
190 {
191 struct v4l2_buffer *b = pb;
192 struct vb2_v4l2_buffer *vbuf = to_vb2_v4l2_buffer(vb);
193 struct vb2_queue *q = vb->vb2_queue;
194 unsigned int plane;
195
196 /* Copy back data such as timestamp, flags, etc. */
197 b->index = vb->index;
198 b->type = vb->type;
199 b->memory = vb->memory;
200 b->bytesused = 0;
201
202 b->flags = vbuf->flags;
203 b->field = vbuf->field;
204 b->timestamp = ns_to_timeval(vb->timestamp);
205 b->timecode = vbuf->timecode;
206 b->sequence = vbuf->sequence;
207 b->reserved2 = 0;
208 b->reserved = 0;
209
210 if (q->is_multiplanar) {
211 /*
212 * Fill in plane-related data if userspace provided an array
213 * for it. The caller has already verified memory and size.
214 */
215 b->length = vb->num_planes;
216 for (plane = 0; plane < vb->num_planes; ++plane) {
217 struct v4l2_plane *pdst = &b->m.planes[plane];
218 struct vb2_plane *psrc = &vb->planes[plane];
219
220 pdst->bytesused = psrc->bytesused;
221 pdst->length = psrc->length;
222 if (q->memory == VB2_MEMORY_MMAP)
223 pdst->m.mem_offset = psrc->m.offset;
224 else if (q->memory == VB2_MEMORY_USERPTR)
225 pdst->m.userptr = psrc->m.userptr;
226 else if (q->memory == VB2_MEMORY_DMABUF)
227 pdst->m.fd = psrc->m.fd;
228 pdst->data_offset = psrc->data_offset;
229 memset(pdst->reserved, 0, sizeof(pdst->reserved));
230 }
231 } else {
232 /*
233 * We use length and offset in v4l2_planes array even for
234 * single-planar buffers, but userspace does not.
235 */
236 b->length = vb->planes[0].length;
237 b->bytesused = vb->planes[0].bytesused;
238 if (q->memory == VB2_MEMORY_MMAP)
239 b->m.offset = vb->planes[0].m.offset;
240 else if (q->memory == VB2_MEMORY_USERPTR)
241 b->m.userptr = vb->planes[0].m.userptr;
242 else if (q->memory == VB2_MEMORY_DMABUF)
243 b->m.fd = vb->planes[0].m.fd;
244 }
245
246 /*
247 * Clear any buffer state related flags.
248 */
249 b->flags &= ~V4L2_BUFFER_MASK_FLAGS;
250 b->flags |= q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK;
251 if (!q->copy_timestamp) {
252 /*
253 * For non-COPY timestamps, drop timestamp source bits
254 * and obtain the timestamp source from the queue.
255 */
256 b->flags &= ~V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
257 b->flags |= q->timestamp_flags & V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
258 }
259
260 switch (vb->state) {
261 case VB2_BUF_STATE_QUEUED:
262 case VB2_BUF_STATE_ACTIVE:
263 b->flags |= V4L2_BUF_FLAG_QUEUED;
264 break;
265 case VB2_BUF_STATE_ERROR:
266 b->flags |= V4L2_BUF_FLAG_ERROR;
267 /* fall through */
268 case VB2_BUF_STATE_DONE:
269 b->flags |= V4L2_BUF_FLAG_DONE;
270 break;
271 case VB2_BUF_STATE_PREPARED:
272 b->flags |= V4L2_BUF_FLAG_PREPARED;
273 break;
274 case VB2_BUF_STATE_PREPARING:
275 case VB2_BUF_STATE_DEQUEUED:
276 case VB2_BUF_STATE_REQUEUEING:
277 /* nothing */
278 break;
279 }
280
281 if (vb2_buffer_in_use(q, vb))
282 b->flags |= V4L2_BUF_FLAG_MAPPED;
283
284 if (!q->is_output &&
285 b->flags & V4L2_BUF_FLAG_DONE &&
286 b->flags & V4L2_BUF_FLAG_LAST)
287 q->last_buffer_dequeued = true;
288 }
289
290 /**
291 * __fill_vb2_buffer() - fill a vb2_buffer with information provided in a
292 * v4l2_buffer by the userspace. It also verifies that struct
293 * v4l2_buffer has a valid number of planes.
294 */
__fill_vb2_buffer(struct vb2_buffer * vb,const void * pb,struct vb2_plane * planes)295 static int __fill_vb2_buffer(struct vb2_buffer *vb,
296 const void *pb, struct vb2_plane *planes)
297 {
298 struct vb2_queue *q = vb->vb2_queue;
299 const struct v4l2_buffer *b = pb;
300 struct vb2_v4l2_buffer *vbuf = to_vb2_v4l2_buffer(vb);
301 unsigned int plane;
302 int ret;
303
304 ret = __verify_length(vb, b);
305 if (ret < 0) {
306 dprintk(1, "plane parameters verification failed: %d\n", ret);
307 return ret;
308 }
309 if (b->field == V4L2_FIELD_ALTERNATE && q->is_output) {
310 /*
311 * If the format's field is ALTERNATE, then the buffer's field
312 * should be either TOP or BOTTOM, not ALTERNATE since that
313 * makes no sense. The driver has to know whether the
314 * buffer represents a top or a bottom field in order to
315 * program any DMA correctly. Using ALTERNATE is wrong, since
316 * that just says that it is either a top or a bottom field,
317 * but not which of the two it is.
318 */
319 dprintk(1, "the field is incorrectly set to ALTERNATE "
320 "for an output buffer\n");
321 return -EINVAL;
322 }
323 vb->timestamp = 0;
324 vbuf->sequence = 0;
325
326 if (V4L2_TYPE_IS_MULTIPLANAR(b->type)) {
327 if (b->memory == VB2_MEMORY_USERPTR) {
328 for (plane = 0; plane < vb->num_planes; ++plane) {
329 planes[plane].m.userptr =
330 b->m.planes[plane].m.userptr;
331 planes[plane].length =
332 b->m.planes[plane].length;
333 }
334 }
335 if (b->memory == VB2_MEMORY_DMABUF) {
336 for (plane = 0; plane < vb->num_planes; ++plane) {
337 planes[plane].m.fd =
338 b->m.planes[plane].m.fd;
339 planes[plane].length =
340 b->m.planes[plane].length;
341 }
342 }
343
344 /* Fill in driver-provided information for OUTPUT types */
345 if (V4L2_TYPE_IS_OUTPUT(b->type)) {
346 /*
347 * Will have to go up to b->length when API starts
348 * accepting variable number of planes.
349 *
350 * If bytesused == 0 for the output buffer, then fall
351 * back to the full buffer size. In that case
352 * userspace clearly never bothered to set it and
353 * it's a safe assumption that they really meant to
354 * use the full plane sizes.
355 *
356 * Some drivers, e.g. old codec drivers, use bytesused == 0
357 * as a way to indicate that streaming is finished.
358 * In that case, the driver should use the
359 * allow_zero_bytesused flag to keep old userspace
360 * applications working.
361 */
362 for (plane = 0; plane < vb->num_planes; ++plane) {
363 struct vb2_plane *pdst = &planes[plane];
364 struct v4l2_plane *psrc = &b->m.planes[plane];
365
366 if (psrc->bytesused == 0)
367 vb2_warn_zero_bytesused(vb);
368
369 if (vb->vb2_queue->allow_zero_bytesused)
370 pdst->bytesused = psrc->bytesused;
371 else
372 pdst->bytesused = psrc->bytesused ?
373 psrc->bytesused : pdst->length;
374 pdst->data_offset = psrc->data_offset;
375 }
376 }
377 } else {
378 /*
379 * Single-planar buffers do not use planes array,
380 * so fill in relevant v4l2_buffer struct fields instead.
381 * In videobuf we use our internal V4l2_planes struct for
382 * single-planar buffers as well, for simplicity.
383 *
384 * If bytesused == 0 for the output buffer, then fall back
385 * to the full buffer size as that's a sensible default.
386 *
387 * Some drivers, e.g. old codec drivers, use bytesused == 0 as
388 * a way to indicate that streaming is finished. In that case,
389 * the driver should use the allow_zero_bytesused flag to keep
390 * old userspace applications working.
391 */
392 if (b->memory == VB2_MEMORY_USERPTR) {
393 planes[0].m.userptr = b->m.userptr;
394 planes[0].length = b->length;
395 }
396
397 if (b->memory == VB2_MEMORY_DMABUF) {
398 planes[0].m.fd = b->m.fd;
399 planes[0].length = b->length;
400 }
401
402 if (V4L2_TYPE_IS_OUTPUT(b->type)) {
403 if (b->bytesused == 0)
404 vb2_warn_zero_bytesused(vb);
405
406 if (vb->vb2_queue->allow_zero_bytesused)
407 planes[0].bytesused = b->bytesused;
408 else
409 planes[0].bytesused = b->bytesused ?
410 b->bytesused : planes[0].length;
411 } else
412 planes[0].bytesused = 0;
413
414 }
415
416 /* Zero flags that the vb2 core handles */
417 vbuf->flags = b->flags & ~V4L2_BUFFER_MASK_FLAGS;
418 if (!vb->vb2_queue->copy_timestamp || !V4L2_TYPE_IS_OUTPUT(b->type)) {
419 /*
420 * Non-COPY timestamps and non-OUTPUT queues will get
421 * their timestamp and timestamp source flags from the
422 * queue.
423 */
424 vbuf->flags &= ~V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
425 }
426
427 if (V4L2_TYPE_IS_OUTPUT(b->type)) {
428 /*
429 * For output buffers mask out the timecode flag:
430 * this will be handled later in vb2_qbuf().
431 * The 'field' is valid metadata for this output buffer
432 * and so that needs to be copied here.
433 */
434 vbuf->flags &= ~V4L2_BUF_FLAG_TIMECODE;
435 vbuf->field = b->field;
436 } else {
437 /* Zero any output buffer flags as this is a capture buffer */
438 vbuf->flags &= ~V4L2_BUFFER_OUT_FLAGS;
439 }
440
441 return 0;
442 }
443
444 static const struct vb2_buf_ops v4l2_buf_ops = {
445 .verify_planes_array = __verify_planes_array_core,
446 .fill_user_buffer = __fill_v4l2_buffer,
447 .fill_vb2_buffer = __fill_vb2_buffer,
448 .copy_timestamp = __copy_timestamp,
449 };
450
451 /**
452 * vb2_querybuf() - query video buffer information
453 * @q: videobuf queue
454 * @b: buffer struct passed from userspace to vidioc_querybuf handler
455 * in driver
456 *
457 * Should be called from vidioc_querybuf ioctl handler in driver.
458 * This function will verify the passed v4l2_buffer structure and fill the
459 * relevant information for the userspace.
460 *
461 * The return values from this function are intended to be directly returned
462 * from vidioc_querybuf handler in driver.
463 */
vb2_querybuf(struct vb2_queue * q,struct v4l2_buffer * b)464 int vb2_querybuf(struct vb2_queue *q, struct v4l2_buffer *b)
465 {
466 struct vb2_buffer *vb;
467 int ret;
468
469 if (b->type != q->type) {
470 dprintk(1, "wrong buffer type\n");
471 return -EINVAL;
472 }
473
474 if (b->index >= q->num_buffers) {
475 dprintk(1, "buffer index out of range\n");
476 return -EINVAL;
477 }
478 vb = q->bufs[b->index];
479 ret = __verify_planes_array(vb, b);
480 if (!ret)
481 vb2_core_querybuf(q, b->index, b);
482 return ret;
483 }
484 EXPORT_SYMBOL(vb2_querybuf);
485
vb2_reqbufs(struct vb2_queue * q,struct v4l2_requestbuffers * req)486 int vb2_reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req)
487 {
488 int ret = vb2_verify_memory_type(q, req->memory, req->type);
489
490 return ret ? ret : vb2_core_reqbufs(q, req->memory, &req->count);
491 }
492 EXPORT_SYMBOL_GPL(vb2_reqbufs);
493
vb2_prepare_buf(struct vb2_queue * q,struct v4l2_buffer * b)494 int vb2_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b)
495 {
496 int ret;
497
498 if (vb2_fileio_is_active(q)) {
499 dprintk(1, "file io in progress\n");
500 return -EBUSY;
501 }
502
503 ret = vb2_queue_or_prepare_buf(q, b, "prepare_buf");
504
505 return ret ? ret : vb2_core_prepare_buf(q, b->index, b);
506 }
507 EXPORT_SYMBOL_GPL(vb2_prepare_buf);
508
vb2_create_bufs(struct vb2_queue * q,struct v4l2_create_buffers * create)509 int vb2_create_bufs(struct vb2_queue *q, struct v4l2_create_buffers *create)
510 {
511 unsigned requested_planes = 1;
512 unsigned requested_sizes[VIDEO_MAX_PLANES];
513 struct v4l2_format *f = &create->format;
514 int ret = vb2_verify_memory_type(q, create->memory, f->type);
515 unsigned i;
516
517 create->index = q->num_buffers;
518 if (create->count == 0)
519 return ret != -EBUSY ? ret : 0;
520
521 switch (f->type) {
522 case V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE:
523 case V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE:
524 requested_planes = f->fmt.pix_mp.num_planes;
525 if (requested_planes == 0 ||
526 requested_planes > VIDEO_MAX_PLANES)
527 return -EINVAL;
528 for (i = 0; i < requested_planes; i++)
529 requested_sizes[i] =
530 f->fmt.pix_mp.plane_fmt[i].sizeimage;
531 break;
532 case V4L2_BUF_TYPE_VIDEO_CAPTURE:
533 case V4L2_BUF_TYPE_VIDEO_OUTPUT:
534 requested_sizes[0] = f->fmt.pix.sizeimage;
535 break;
536 case V4L2_BUF_TYPE_VBI_CAPTURE:
537 case V4L2_BUF_TYPE_VBI_OUTPUT:
538 requested_sizes[0] = f->fmt.vbi.samples_per_line *
539 (f->fmt.vbi.count[0] + f->fmt.vbi.count[1]);
540 break;
541 case V4L2_BUF_TYPE_SLICED_VBI_CAPTURE:
542 case V4L2_BUF_TYPE_SLICED_VBI_OUTPUT:
543 requested_sizes[0] = f->fmt.sliced.io_size;
544 break;
545 case V4L2_BUF_TYPE_SDR_CAPTURE:
546 case V4L2_BUF_TYPE_SDR_OUTPUT:
547 requested_sizes[0] = f->fmt.sdr.buffersize;
548 break;
549 default:
550 return -EINVAL;
551 }
552 for (i = 0; i < requested_planes; i++)
553 if (requested_sizes[i] == 0)
554 return -EINVAL;
555 return ret ? ret : vb2_core_create_bufs(q, create->memory,
556 &create->count, requested_planes, requested_sizes);
557 }
558 EXPORT_SYMBOL_GPL(vb2_create_bufs);
559
vb2_qbuf(struct vb2_queue * q,struct v4l2_buffer * b)560 int vb2_qbuf(struct vb2_queue *q, struct v4l2_buffer *b)
561 {
562 int ret;
563
564 if (vb2_fileio_is_active(q)) {
565 dprintk(1, "file io in progress\n");
566 return -EBUSY;
567 }
568
569 ret = vb2_queue_or_prepare_buf(q, b, "qbuf");
570 return ret ? ret : vb2_core_qbuf(q, b->index, b);
571 }
572 EXPORT_SYMBOL_GPL(vb2_qbuf);
573
vb2_dqbuf(struct vb2_queue * q,struct v4l2_buffer * b,bool nonblocking)574 int vb2_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking)
575 {
576 int ret;
577
578 if (vb2_fileio_is_active(q)) {
579 dprintk(1, "file io in progress\n");
580 return -EBUSY;
581 }
582
583 if (b->type != q->type) {
584 dprintk(1, "invalid buffer type\n");
585 return -EINVAL;
586 }
587
588 ret = vb2_core_dqbuf(q, NULL, b, nonblocking);
589
590 /*
591 * After calling the VIDIOC_DQBUF V4L2_BUF_FLAG_DONE must be
592 * cleared.
593 */
594 b->flags &= ~V4L2_BUF_FLAG_DONE;
595
596 return ret;
597 }
598 EXPORT_SYMBOL_GPL(vb2_dqbuf);
599
vb2_streamon(struct vb2_queue * q,enum v4l2_buf_type type)600 int vb2_streamon(struct vb2_queue *q, enum v4l2_buf_type type)
601 {
602 if (vb2_fileio_is_active(q)) {
603 dprintk(1, "file io in progress\n");
604 return -EBUSY;
605 }
606 return vb2_core_streamon(q, type);
607 }
608 EXPORT_SYMBOL_GPL(vb2_streamon);
609
vb2_streamoff(struct vb2_queue * q,enum v4l2_buf_type type)610 int vb2_streamoff(struct vb2_queue *q, enum v4l2_buf_type type)
611 {
612 if (vb2_fileio_is_active(q)) {
613 dprintk(1, "file io in progress\n");
614 return -EBUSY;
615 }
616 return vb2_core_streamoff(q, type);
617 }
618 EXPORT_SYMBOL_GPL(vb2_streamoff);
619
vb2_expbuf(struct vb2_queue * q,struct v4l2_exportbuffer * eb)620 int vb2_expbuf(struct vb2_queue *q, struct v4l2_exportbuffer *eb)
621 {
622 return vb2_core_expbuf(q, &eb->fd, eb->type, eb->index,
623 eb->plane, eb->flags);
624 }
625 EXPORT_SYMBOL_GPL(vb2_expbuf);
626
vb2_queue_init(struct vb2_queue * q)627 int vb2_queue_init(struct vb2_queue *q)
628 {
629 /*
630 * Sanity check
631 */
632 if (WARN_ON(!q) ||
633 WARN_ON(q->timestamp_flags &
634 ~(V4L2_BUF_FLAG_TIMESTAMP_MASK |
635 V4L2_BUF_FLAG_TSTAMP_SRC_MASK)))
636 return -EINVAL;
637
638 /* Warn that the driver should choose an appropriate timestamp type */
639 WARN_ON((q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK) ==
640 V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN);
641
642 /* Warn that vb2_memory should match with v4l2_memory */
643 if (WARN_ON(VB2_MEMORY_MMAP != (int)V4L2_MEMORY_MMAP)
644 || WARN_ON(VB2_MEMORY_USERPTR != (int)V4L2_MEMORY_USERPTR)
645 || WARN_ON(VB2_MEMORY_DMABUF != (int)V4L2_MEMORY_DMABUF))
646 return -EINVAL;
647
648 if (q->buf_struct_size == 0)
649 q->buf_struct_size = sizeof(struct vb2_v4l2_buffer);
650
651 q->buf_ops = &v4l2_buf_ops;
652 q->is_multiplanar = V4L2_TYPE_IS_MULTIPLANAR(q->type);
653 q->is_output = V4L2_TYPE_IS_OUTPUT(q->type);
654 q->copy_timestamp = (q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK)
655 == V4L2_BUF_FLAG_TIMESTAMP_COPY;
656 /*
657 * For compatibility with vb1: if QBUF hasn't been called yet, then
658 * return POLLERR as well. This only affects capture queues, output
659 * queues will always initialize waiting_for_buffers to false.
660 */
661 q->quirk_poll_must_check_waiting_for_buffers = true;
662
663 return vb2_core_queue_init(q);
664 }
665 EXPORT_SYMBOL_GPL(vb2_queue_init);
666
vb2_queue_release(struct vb2_queue * q)667 void vb2_queue_release(struct vb2_queue *q)
668 {
669 vb2_core_queue_release(q);
670 }
671 EXPORT_SYMBOL_GPL(vb2_queue_release);
672
vb2_poll(struct vb2_queue * q,struct file * file,poll_table * wait)673 unsigned int vb2_poll(struct vb2_queue *q, struct file *file, poll_table *wait)
674 {
675 struct video_device *vfd = video_devdata(file);
676 unsigned long req_events = poll_requested_events(wait);
677 unsigned int res = 0;
678
679 if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags)) {
680 struct v4l2_fh *fh = file->private_data;
681
682 if (v4l2_event_pending(fh))
683 res = POLLPRI;
684 else if (req_events & POLLPRI)
685 poll_wait(file, &fh->wait, wait);
686 }
687
688 return res | vb2_core_poll(q, file, wait);
689 }
690 EXPORT_SYMBOL_GPL(vb2_poll);
691
692 /*
693 * The following functions are not part of the vb2 core API, but are helper
694 * functions that plug into struct v4l2_ioctl_ops, struct v4l2_file_operations
695 * and struct vb2_ops.
696 * They contain boilerplate code that most if not all drivers have to do
697 * and so they simplify the driver code.
698 */
699
700 /* The queue is busy if there is a owner and you are not that owner. */
vb2_queue_is_busy(struct video_device * vdev,struct file * file)701 static inline bool vb2_queue_is_busy(struct video_device *vdev, struct file *file)
702 {
703 return vdev->queue->owner && vdev->queue->owner != file->private_data;
704 }
705
706 /* vb2 ioctl helpers */
707
vb2_ioctl_reqbufs(struct file * file,void * priv,struct v4l2_requestbuffers * p)708 int vb2_ioctl_reqbufs(struct file *file, void *priv,
709 struct v4l2_requestbuffers *p)
710 {
711 struct video_device *vdev = video_devdata(file);
712 int res = vb2_verify_memory_type(vdev->queue, p->memory, p->type);
713
714 if (res)
715 return res;
716 if (vb2_queue_is_busy(vdev, file))
717 return -EBUSY;
718 res = vb2_core_reqbufs(vdev->queue, p->memory, &p->count);
719 /* If count == 0, then the owner has released all buffers and he
720 is no longer owner of the queue. Otherwise we have a new owner. */
721 if (res == 0)
722 vdev->queue->owner = p->count ? file->private_data : NULL;
723 return res;
724 }
725 EXPORT_SYMBOL_GPL(vb2_ioctl_reqbufs);
726
vb2_ioctl_create_bufs(struct file * file,void * priv,struct v4l2_create_buffers * p)727 int vb2_ioctl_create_bufs(struct file *file, void *priv,
728 struct v4l2_create_buffers *p)
729 {
730 struct video_device *vdev = video_devdata(file);
731 int res = vb2_verify_memory_type(vdev->queue, p->memory,
732 p->format.type);
733
734 p->index = vdev->queue->num_buffers;
735 /*
736 * If count == 0, then just check if memory and type are valid.
737 * Any -EBUSY result from vb2_verify_memory_type can be mapped to 0.
738 */
739 if (p->count == 0)
740 return res != -EBUSY ? res : 0;
741 if (res)
742 return res;
743 if (vb2_queue_is_busy(vdev, file))
744 return -EBUSY;
745
746 res = vb2_create_bufs(vdev->queue, p);
747 if (res == 0)
748 vdev->queue->owner = file->private_data;
749 return res;
750 }
751 EXPORT_SYMBOL_GPL(vb2_ioctl_create_bufs);
752
vb2_ioctl_prepare_buf(struct file * file,void * priv,struct v4l2_buffer * p)753 int vb2_ioctl_prepare_buf(struct file *file, void *priv,
754 struct v4l2_buffer *p)
755 {
756 struct video_device *vdev = video_devdata(file);
757
758 if (vb2_queue_is_busy(vdev, file))
759 return -EBUSY;
760 return vb2_prepare_buf(vdev->queue, p);
761 }
762 EXPORT_SYMBOL_GPL(vb2_ioctl_prepare_buf);
763
vb2_ioctl_querybuf(struct file * file,void * priv,struct v4l2_buffer * p)764 int vb2_ioctl_querybuf(struct file *file, void *priv, struct v4l2_buffer *p)
765 {
766 struct video_device *vdev = video_devdata(file);
767
768 /* No need to call vb2_queue_is_busy(), anyone can query buffers. */
769 return vb2_querybuf(vdev->queue, p);
770 }
771 EXPORT_SYMBOL_GPL(vb2_ioctl_querybuf);
772
vb2_ioctl_qbuf(struct file * file,void * priv,struct v4l2_buffer * p)773 int vb2_ioctl_qbuf(struct file *file, void *priv, struct v4l2_buffer *p)
774 {
775 struct video_device *vdev = video_devdata(file);
776
777 if (vb2_queue_is_busy(vdev, file))
778 return -EBUSY;
779 return vb2_qbuf(vdev->queue, p);
780 }
781 EXPORT_SYMBOL_GPL(vb2_ioctl_qbuf);
782
vb2_ioctl_dqbuf(struct file * file,void * priv,struct v4l2_buffer * p)783 int vb2_ioctl_dqbuf(struct file *file, void *priv, struct v4l2_buffer *p)
784 {
785 struct video_device *vdev = video_devdata(file);
786
787 if (vb2_queue_is_busy(vdev, file))
788 return -EBUSY;
789 return vb2_dqbuf(vdev->queue, p, file->f_flags & O_NONBLOCK);
790 }
791 EXPORT_SYMBOL_GPL(vb2_ioctl_dqbuf);
792
vb2_ioctl_streamon(struct file * file,void * priv,enum v4l2_buf_type i)793 int vb2_ioctl_streamon(struct file *file, void *priv, enum v4l2_buf_type i)
794 {
795 struct video_device *vdev = video_devdata(file);
796
797 if (vb2_queue_is_busy(vdev, file))
798 return -EBUSY;
799 return vb2_streamon(vdev->queue, i);
800 }
801 EXPORT_SYMBOL_GPL(vb2_ioctl_streamon);
802
vb2_ioctl_streamoff(struct file * file,void * priv,enum v4l2_buf_type i)803 int vb2_ioctl_streamoff(struct file *file, void *priv, enum v4l2_buf_type i)
804 {
805 struct video_device *vdev = video_devdata(file);
806
807 if (vb2_queue_is_busy(vdev, file))
808 return -EBUSY;
809 return vb2_streamoff(vdev->queue, i);
810 }
811 EXPORT_SYMBOL_GPL(vb2_ioctl_streamoff);
812
vb2_ioctl_expbuf(struct file * file,void * priv,struct v4l2_exportbuffer * p)813 int vb2_ioctl_expbuf(struct file *file, void *priv, struct v4l2_exportbuffer *p)
814 {
815 struct video_device *vdev = video_devdata(file);
816
817 if (vb2_queue_is_busy(vdev, file))
818 return -EBUSY;
819 return vb2_expbuf(vdev->queue, p);
820 }
821 EXPORT_SYMBOL_GPL(vb2_ioctl_expbuf);
822
823 /* v4l2_file_operations helpers */
824
vb2_fop_mmap(struct file * file,struct vm_area_struct * vma)825 int vb2_fop_mmap(struct file *file, struct vm_area_struct *vma)
826 {
827 struct video_device *vdev = video_devdata(file);
828
829 return vb2_mmap(vdev->queue, vma);
830 }
831 EXPORT_SYMBOL_GPL(vb2_fop_mmap);
832
_vb2_fop_release(struct file * file,struct mutex * lock)833 int _vb2_fop_release(struct file *file, struct mutex *lock)
834 {
835 struct video_device *vdev = video_devdata(file);
836
837 if (lock)
838 mutex_lock(lock);
839 if (file->private_data == vdev->queue->owner) {
840 vb2_queue_release(vdev->queue);
841 vdev->queue->owner = NULL;
842 }
843 if (lock)
844 mutex_unlock(lock);
845 return v4l2_fh_release(file);
846 }
847 EXPORT_SYMBOL_GPL(_vb2_fop_release);
848
vb2_fop_release(struct file * file)849 int vb2_fop_release(struct file *file)
850 {
851 struct video_device *vdev = video_devdata(file);
852 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
853
854 return _vb2_fop_release(file, lock);
855 }
856 EXPORT_SYMBOL_GPL(vb2_fop_release);
857
vb2_fop_write(struct file * file,const char __user * buf,size_t count,loff_t * ppos)858 ssize_t vb2_fop_write(struct file *file, const char __user *buf,
859 size_t count, loff_t *ppos)
860 {
861 struct video_device *vdev = video_devdata(file);
862 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
863 int err = -EBUSY;
864
865 if (!(vdev->queue->io_modes & VB2_WRITE))
866 return -EINVAL;
867 if (lock && mutex_lock_interruptible(lock))
868 return -ERESTARTSYS;
869 if (vb2_queue_is_busy(vdev, file))
870 goto exit;
871 err = vb2_write(vdev->queue, buf, count, ppos,
872 file->f_flags & O_NONBLOCK);
873 if (vdev->queue->fileio)
874 vdev->queue->owner = file->private_data;
875 exit:
876 if (lock)
877 mutex_unlock(lock);
878 return err;
879 }
880 EXPORT_SYMBOL_GPL(vb2_fop_write);
881
vb2_fop_read(struct file * file,char __user * buf,size_t count,loff_t * ppos)882 ssize_t vb2_fop_read(struct file *file, char __user *buf,
883 size_t count, loff_t *ppos)
884 {
885 struct video_device *vdev = video_devdata(file);
886 struct mutex *lock = vdev->queue->lock ? vdev->queue->lock : vdev->lock;
887 int err = -EBUSY;
888
889 if (!(vdev->queue->io_modes & VB2_READ))
890 return -EINVAL;
891 if (lock && mutex_lock_interruptible(lock))
892 return -ERESTARTSYS;
893 if (vb2_queue_is_busy(vdev, file))
894 goto exit;
895 err = vb2_read(vdev->queue, buf, count, ppos,
896 file->f_flags & O_NONBLOCK);
897 if (vdev->queue->fileio)
898 vdev->queue->owner = file->private_data;
899 exit:
900 if (lock)
901 mutex_unlock(lock);
902 return err;
903 }
904 EXPORT_SYMBOL_GPL(vb2_fop_read);
905
vb2_fop_poll(struct file * file,poll_table * wait)906 unsigned int vb2_fop_poll(struct file *file, poll_table *wait)
907 {
908 struct video_device *vdev = video_devdata(file);
909 struct vb2_queue *q = vdev->queue;
910 struct mutex *lock = q->lock ? q->lock : vdev->lock;
911 unsigned res;
912 void *fileio;
913
914 /*
915 * If this helper doesn't know how to lock, then you shouldn't be using
916 * it but you should write your own.
917 */
918 WARN_ON(!lock);
919
920 if (lock && mutex_lock_interruptible(lock))
921 return POLLERR;
922
923 fileio = q->fileio;
924
925 res = vb2_poll(vdev->queue, file, wait);
926
927 /* If fileio was started, then we have a new queue owner. */
928 if (!fileio && q->fileio)
929 q->owner = file->private_data;
930 if (lock)
931 mutex_unlock(lock);
932 return res;
933 }
934 EXPORT_SYMBOL_GPL(vb2_fop_poll);
935
936 #ifndef CONFIG_MMU
vb2_fop_get_unmapped_area(struct file * file,unsigned long addr,unsigned long len,unsigned long pgoff,unsigned long flags)937 unsigned long vb2_fop_get_unmapped_area(struct file *file, unsigned long addr,
938 unsigned long len, unsigned long pgoff, unsigned long flags)
939 {
940 struct video_device *vdev = video_devdata(file);
941
942 return vb2_get_unmapped_area(vdev->queue, addr, len, pgoff, flags);
943 }
944 EXPORT_SYMBOL_GPL(vb2_fop_get_unmapped_area);
945 #endif
946
947 /* vb2_ops helpers. Only use if vq->lock is non-NULL. */
948
vb2_ops_wait_prepare(struct vb2_queue * vq)949 void vb2_ops_wait_prepare(struct vb2_queue *vq)
950 {
951 mutex_unlock(vq->lock);
952 }
953 EXPORT_SYMBOL_GPL(vb2_ops_wait_prepare);
954
vb2_ops_wait_finish(struct vb2_queue * vq)955 void vb2_ops_wait_finish(struct vb2_queue *vq)
956 {
957 mutex_lock(vq->lock);
958 }
959 EXPORT_SYMBOL_GPL(vb2_ops_wait_finish);
960
961 MODULE_DESCRIPTION("Driver helper framework for Video for Linux 2");
962 MODULE_AUTHOR("Pawel Osciak <pawel@osciak.com>, Marek Szyprowski");
963 MODULE_LICENSE("GPL");
964