• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 planes array not provided\n");
64 		return -EINVAL;
65 	}
66 
67 	if (b->length < vb->num_planes || b->length > VB2_MAX_PLANES) {
68 		dprintk(1, "incorrect planes array length, expected %d, got %d\n",
69 			vb->num_planes, b->length);
70 		return -EINVAL;
71 	}
72 
73 	return 0;
74 }
75 
__verify_planes_array_core(struct vb2_buffer * vb,const void * pb)76 static int __verify_planes_array_core(struct vb2_buffer *vb, const void *pb)
77 {
78 	return __verify_planes_array(vb, pb);
79 }
80 
81 /**
82  * __verify_length() - Verify that the bytesused value for each plane fits in
83  * the plane length and that the data offset doesn't exceed the bytesused value.
84  */
__verify_length(struct vb2_buffer * vb,const struct v4l2_buffer * b)85 static int __verify_length(struct vb2_buffer *vb, const struct v4l2_buffer *b)
86 {
87 	unsigned int length;
88 	unsigned int bytesused;
89 	unsigned int plane;
90 
91 	if (!V4L2_TYPE_IS_OUTPUT(b->type))
92 		return 0;
93 
94 	if (V4L2_TYPE_IS_MULTIPLANAR(b->type)) {
95 		for (plane = 0; plane < vb->num_planes; ++plane) {
96 			length = (b->memory == VB2_MEMORY_USERPTR ||
97 				  b->memory == VB2_MEMORY_DMABUF)
98 			       ? b->m.planes[plane].length
99 				: vb->planes[plane].length;
100 			bytesused = b->m.planes[plane].bytesused
101 				  ? b->m.planes[plane].bytesused : length;
102 
103 			if (b->m.planes[plane].bytesused > length)
104 				return -EINVAL;
105 
106 			if (b->m.planes[plane].data_offset > 0 &&
107 			    b->m.planes[plane].data_offset >= bytesused)
108 				return -EINVAL;
109 		}
110 	} else {
111 		length = (b->memory == VB2_MEMORY_USERPTR)
112 			? b->length : vb->planes[0].length;
113 
114 		if (b->bytesused > length)
115 			return -EINVAL;
116 	}
117 
118 	return 0;
119 }
120 
__copy_timestamp(struct vb2_buffer * vb,const void * pb)121 static void __copy_timestamp(struct vb2_buffer *vb, const void *pb)
122 {
123 	const struct v4l2_buffer *b = pb;
124 	struct vb2_v4l2_buffer *vbuf = to_vb2_v4l2_buffer(vb);
125 	struct vb2_queue *q = vb->vb2_queue;
126 
127 	if (q->is_output) {
128 		/*
129 		 * For output buffers copy the timestamp if needed,
130 		 * and the timecode field and flag if needed.
131 		 */
132 		if (q->copy_timestamp)
133 			vb->timestamp = timeval_to_ns(&b->timestamp);
134 		vbuf->flags |= b->flags & V4L2_BUF_FLAG_TIMECODE;
135 		if (b->flags & V4L2_BUF_FLAG_TIMECODE)
136 			vbuf->timecode = b->timecode;
137 	}
138 };
139 
vb2_warn_zero_bytesused(struct vb2_buffer * vb)140 static void vb2_warn_zero_bytesused(struct vb2_buffer *vb)
141 {
142 	static bool check_once;
143 
144 	if (check_once)
145 		return;
146 
147 	check_once = true;
148 
149 	pr_warn("use of bytesused == 0 is deprecated and will be removed in the future,\n");
150 	if (vb->vb2_queue->allow_zero_bytesused)
151 		pr_warn("use VIDIOC_DECODER_CMD(V4L2_DEC_CMD_STOP) instead.\n");
152 	else
153 		pr_warn("use the actual size instead.\n");
154 }
155 
vb2_queue_or_prepare_buf(struct vb2_queue * q,struct v4l2_buffer * b,const char * opname)156 static int vb2_queue_or_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b,
157 				    const char *opname)
158 {
159 	if (b->type != q->type) {
160 		dprintk(1, "%s: invalid buffer type\n", opname);
161 		return -EINVAL;
162 	}
163 
164 	if (b->index >= q->num_buffers) {
165 		dprintk(1, "%s: buffer index out of range\n", opname);
166 		return -EINVAL;
167 	}
168 
169 	if (q->bufs[b->index] == NULL) {
170 		/* Should never happen */
171 		dprintk(1, "%s: buffer is NULL\n", opname);
172 		return -EINVAL;
173 	}
174 
175 	if (b->memory != q->memory) {
176 		dprintk(1, "%s: invalid memory type\n", opname);
177 		return -EINVAL;
178 	}
179 
180 	return __verify_planes_array(q->bufs[b->index], b);
181 }
182 
183 /**
184  * __fill_v4l2_buffer() - fill in a struct v4l2_buffer with information to be
185  * returned to userspace
186  */
__fill_v4l2_buffer(struct vb2_buffer * vb,void * pb)187 static void __fill_v4l2_buffer(struct vb2_buffer *vb, void *pb)
188 {
189 	struct v4l2_buffer *b = pb;
190 	struct vb2_v4l2_buffer *vbuf = to_vb2_v4l2_buffer(vb);
191 	struct vb2_queue *q = vb->vb2_queue;
192 	unsigned int plane;
193 
194 	/* Copy back data such as timestamp, flags, etc. */
195 	b->index = vb->index;
196 	b->type = vb->type;
197 	b->memory = vb->memory;
198 	b->bytesused = 0;
199 
200 	b->flags = vbuf->flags;
201 	b->field = vbuf->field;
202 	b->timestamp = ns_to_timeval(vb->timestamp);
203 	b->timecode = vbuf->timecode;
204 	b->sequence = vbuf->sequence;
205 	b->reserved2 = 0;
206 	b->reserved = 0;
207 
208 	if (q->is_multiplanar) {
209 		/*
210 		 * Fill in plane-related data if userspace provided an array
211 		 * for it. The caller has already verified memory and size.
212 		 */
213 		b->length = vb->num_planes;
214 		for (plane = 0; plane < vb->num_planes; ++plane) {
215 			struct v4l2_plane *pdst = &b->m.planes[plane];
216 			struct vb2_plane *psrc = &vb->planes[plane];
217 
218 			pdst->bytesused = psrc->bytesused;
219 			pdst->length = psrc->length;
220 			if (q->memory == VB2_MEMORY_MMAP)
221 				pdst->m.mem_offset = psrc->m.offset;
222 			else if (q->memory == VB2_MEMORY_USERPTR)
223 				pdst->m.userptr = psrc->m.userptr;
224 			else if (q->memory == VB2_MEMORY_DMABUF)
225 				pdst->m.fd = psrc->m.fd;
226 			pdst->data_offset = psrc->data_offset;
227 			memset(pdst->reserved, 0, sizeof(pdst->reserved));
228 		}
229 	} else {
230 		/*
231 		 * We use length and offset in v4l2_planes array even for
232 		 * single-planar buffers, but userspace does not.
233 		 */
234 		b->length = vb->planes[0].length;
235 		b->bytesused = vb->planes[0].bytesused;
236 		if (q->memory == VB2_MEMORY_MMAP)
237 			b->m.offset = vb->planes[0].m.offset;
238 		else if (q->memory == VB2_MEMORY_USERPTR)
239 			b->m.userptr = vb->planes[0].m.userptr;
240 		else if (q->memory == VB2_MEMORY_DMABUF)
241 			b->m.fd = vb->planes[0].m.fd;
242 	}
243 
244 	/*
245 	 * Clear any buffer state related flags.
246 	 */
247 	b->flags &= ~V4L2_BUFFER_MASK_FLAGS;
248 	b->flags |= q->timestamp_flags & V4L2_BUF_FLAG_TIMESTAMP_MASK;
249 	if (!q->copy_timestamp) {
250 		/*
251 		 * For non-COPY timestamps, drop timestamp source bits
252 		 * and obtain the timestamp source from the queue.
253 		 */
254 		b->flags &= ~V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
255 		b->flags |= q->timestamp_flags & V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
256 	}
257 
258 	switch (vb->state) {
259 	case VB2_BUF_STATE_QUEUED:
260 	case VB2_BUF_STATE_ACTIVE:
261 		b->flags |= V4L2_BUF_FLAG_QUEUED;
262 		break;
263 	case VB2_BUF_STATE_ERROR:
264 		b->flags |= V4L2_BUF_FLAG_ERROR;
265 		/* fall through */
266 	case VB2_BUF_STATE_DONE:
267 		b->flags |= V4L2_BUF_FLAG_DONE;
268 		break;
269 	case VB2_BUF_STATE_PREPARED:
270 		b->flags |= V4L2_BUF_FLAG_PREPARED;
271 		break;
272 	case VB2_BUF_STATE_PREPARING:
273 	case VB2_BUF_STATE_DEQUEUED:
274 	case VB2_BUF_STATE_REQUEUEING:
275 		/* nothing */
276 		break;
277 	}
278 
279 	if (vb2_buffer_in_use(q, vb))
280 		b->flags |= V4L2_BUF_FLAG_MAPPED;
281 
282 	if (!q->is_output &&
283 		b->flags & V4L2_BUF_FLAG_DONE &&
284 		b->flags & V4L2_BUF_FLAG_LAST)
285 		q->last_buffer_dequeued = true;
286 }
287 
288 /**
289  * __fill_vb2_buffer() - fill a vb2_buffer with information provided in a
290  * v4l2_buffer by the userspace. It also verifies that struct
291  * v4l2_buffer has a valid number of planes.
292  */
__fill_vb2_buffer(struct vb2_buffer * vb,const void * pb,struct vb2_plane * planes)293 static int __fill_vb2_buffer(struct vb2_buffer *vb,
294 		const void *pb, struct vb2_plane *planes)
295 {
296 	struct vb2_queue *q = vb->vb2_queue;
297 	const struct v4l2_buffer *b = pb;
298 	struct vb2_v4l2_buffer *vbuf = to_vb2_v4l2_buffer(vb);
299 	unsigned int plane;
300 	int ret;
301 
302 	ret = __verify_length(vb, b);
303 	if (ret < 0) {
304 		dprintk(1, "plane parameters verification failed: %d\n", ret);
305 		return ret;
306 	}
307 	if (b->field == V4L2_FIELD_ALTERNATE && q->is_output) {
308 		/*
309 		 * If the format's field is ALTERNATE, then the buffer's field
310 		 * should be either TOP or BOTTOM, not ALTERNATE since that
311 		 * makes no sense. The driver has to know whether the
312 		 * buffer represents a top or a bottom field in order to
313 		 * program any DMA correctly. Using ALTERNATE is wrong, since
314 		 * that just says that it is either a top or a bottom field,
315 		 * but not which of the two it is.
316 		 */
317 		dprintk(1, "the field is incorrectly set to ALTERNATE for an output buffer\n");
318 		return -EINVAL;
319 	}
320 	vb->timestamp = 0;
321 	vbuf->sequence = 0;
322 
323 	if (V4L2_TYPE_IS_MULTIPLANAR(b->type)) {
324 		if (b->memory == VB2_MEMORY_USERPTR) {
325 			for (plane = 0; plane < vb->num_planes; ++plane) {
326 				planes[plane].m.userptr =
327 					b->m.planes[plane].m.userptr;
328 				planes[plane].length =
329 					b->m.planes[plane].length;
330 			}
331 		}
332 		if (b->memory == VB2_MEMORY_DMABUF) {
333 			for (plane = 0; plane < vb->num_planes; ++plane) {
334 				planes[plane].m.fd =
335 					b->m.planes[plane].m.fd;
336 				planes[plane].length =
337 					b->m.planes[plane].length;
338 			}
339 		}
340 
341 		/* Fill in driver-provided information for OUTPUT types */
342 		if (V4L2_TYPE_IS_OUTPUT(b->type)) {
343 			/*
344 			 * Will have to go up to b->length when API starts
345 			 * accepting variable number of planes.
346 			 *
347 			 * If bytesused == 0 for the output buffer, then fall
348 			 * back to the full buffer size. In that case
349 			 * userspace clearly never bothered to set it and
350 			 * it's a safe assumption that they really meant to
351 			 * use the full plane sizes.
352 			 *
353 			 * Some drivers, e.g. old codec drivers, use bytesused == 0
354 			 * as a way to indicate that streaming is finished.
355 			 * In that case, the driver should use the
356 			 * allow_zero_bytesused flag to keep old userspace
357 			 * applications working.
358 			 */
359 			for (plane = 0; plane < vb->num_planes; ++plane) {
360 				struct vb2_plane *pdst = &planes[plane];
361 				struct v4l2_plane *psrc = &b->m.planes[plane];
362 
363 				if (psrc->bytesused == 0)
364 					vb2_warn_zero_bytesused(vb);
365 
366 				if (vb->vb2_queue->allow_zero_bytesused)
367 					pdst->bytesused = psrc->bytesused;
368 				else
369 					pdst->bytesused = psrc->bytesused ?
370 						psrc->bytesused : pdst->length;
371 				pdst->data_offset = psrc->data_offset;
372 			}
373 		}
374 	} else {
375 		/*
376 		 * Single-planar buffers do not use planes array,
377 		 * so fill in relevant v4l2_buffer struct fields instead.
378 		 * In videobuf we use our internal V4l2_planes struct for
379 		 * single-planar buffers as well, for simplicity.
380 		 *
381 		 * If bytesused == 0 for the output buffer, then fall back
382 		 * to the full buffer size as that's a sensible default.
383 		 *
384 		 * Some drivers, e.g. old codec drivers, use bytesused == 0 as
385 		 * a way to indicate that streaming is finished. In that case,
386 		 * the driver should use the allow_zero_bytesused flag to keep
387 		 * old userspace applications working.
388 		 */
389 		if (b->memory == VB2_MEMORY_USERPTR) {
390 			planes[0].m.userptr = b->m.userptr;
391 			planes[0].length = b->length;
392 		}
393 
394 		if (b->memory == VB2_MEMORY_DMABUF) {
395 			planes[0].m.fd = b->m.fd;
396 			planes[0].length = b->length;
397 		}
398 
399 		if (V4L2_TYPE_IS_OUTPUT(b->type)) {
400 			if (b->bytesused == 0)
401 				vb2_warn_zero_bytesused(vb);
402 
403 			if (vb->vb2_queue->allow_zero_bytesused)
404 				planes[0].bytesused = b->bytesused;
405 			else
406 				planes[0].bytesused = b->bytesused ?
407 					b->bytesused : planes[0].length;
408 		} else
409 			planes[0].bytesused = 0;
410 
411 	}
412 
413 	/* Zero flags that the vb2 core handles */
414 	vbuf->flags = b->flags & ~V4L2_BUFFER_MASK_FLAGS;
415 	if (!vb->vb2_queue->copy_timestamp || !V4L2_TYPE_IS_OUTPUT(b->type)) {
416 		/*
417 		 * Non-COPY timestamps and non-OUTPUT queues will get
418 		 * their timestamp and timestamp source flags from the
419 		 * queue.
420 		 */
421 		vbuf->flags &= ~V4L2_BUF_FLAG_TSTAMP_SRC_MASK;
422 	}
423 
424 	if (V4L2_TYPE_IS_OUTPUT(b->type)) {
425 		/*
426 		 * For output buffers mask out the timecode flag:
427 		 * this will be handled later in vb2_qbuf().
428 		 * The 'field' is valid metadata for this output buffer
429 		 * and so that needs to be copied here.
430 		 */
431 		vbuf->flags &= ~V4L2_BUF_FLAG_TIMECODE;
432 		vbuf->field = b->field;
433 	} else {
434 		/* Zero any output buffer flags as this is a capture buffer */
435 		vbuf->flags &= ~V4L2_BUFFER_OUT_FLAGS;
436 	}
437 
438 	return 0;
439 }
440 
441 static const struct vb2_buf_ops v4l2_buf_ops = {
442 	.verify_planes_array	= __verify_planes_array_core,
443 	.fill_user_buffer	= __fill_v4l2_buffer,
444 	.fill_vb2_buffer	= __fill_vb2_buffer,
445 	.copy_timestamp		= __copy_timestamp,
446 };
447 
448 /**
449  * vb2_querybuf() - query video buffer information
450  * @q:		videobuf queue
451  * @b:		buffer struct passed from userspace to vidioc_querybuf handler
452  *		in driver
453  *
454  * Should be called from vidioc_querybuf ioctl handler in driver.
455  * This function will verify the passed v4l2_buffer structure and fill the
456  * relevant information for the userspace.
457  *
458  * The return values from this function are intended to be directly returned
459  * from vidioc_querybuf handler in driver.
460  */
vb2_querybuf(struct vb2_queue * q,struct v4l2_buffer * b)461 int vb2_querybuf(struct vb2_queue *q, struct v4l2_buffer *b)
462 {
463 	struct vb2_buffer *vb;
464 	int ret;
465 
466 	if (b->type != q->type) {
467 		dprintk(1, "wrong buffer type\n");
468 		return -EINVAL;
469 	}
470 
471 	if (b->index >= q->num_buffers) {
472 		dprintk(1, "buffer index out of range\n");
473 		return -EINVAL;
474 	}
475 	vb = q->bufs[b->index];
476 	ret = __verify_planes_array(vb, b);
477 	if (!ret)
478 		vb2_core_querybuf(q, b->index, b);
479 	return ret;
480 }
481 EXPORT_SYMBOL(vb2_querybuf);
482 
vb2_reqbufs(struct vb2_queue * q,struct v4l2_requestbuffers * req)483 int vb2_reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req)
484 {
485 	int ret = vb2_verify_memory_type(q, req->memory, req->type);
486 
487 	return ret ? ret : vb2_core_reqbufs(q, req->memory, &req->count);
488 }
489 EXPORT_SYMBOL_GPL(vb2_reqbufs);
490 
vb2_prepare_buf(struct vb2_queue * q,struct v4l2_buffer * b)491 int vb2_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b)
492 {
493 	int ret;
494 
495 	if (vb2_fileio_is_active(q)) {
496 		dprintk(1, "file io in progress\n");
497 		return -EBUSY;
498 	}
499 
500 	ret = vb2_queue_or_prepare_buf(q, b, "prepare_buf");
501 
502 	return ret ? ret : vb2_core_prepare_buf(q, b->index, b);
503 }
504 EXPORT_SYMBOL_GPL(vb2_prepare_buf);
505 
vb2_create_bufs(struct vb2_queue * q,struct v4l2_create_buffers * create)506 int vb2_create_bufs(struct vb2_queue *q, struct v4l2_create_buffers *create)
507 {
508 	unsigned requested_planes = 1;
509 	unsigned requested_sizes[VIDEO_MAX_PLANES];
510 	struct v4l2_format *f = &create->format;
511 	int ret = vb2_verify_memory_type(q, create->memory, f->type);
512 	unsigned i;
513 
514 	create->index = q->num_buffers;
515 	if (create->count == 0)
516 		return ret != -EBUSY ? ret : 0;
517 
518 	switch (f->type) {
519 	case V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE:
520 	case V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE:
521 		requested_planes = f->fmt.pix_mp.num_planes;
522 		if (requested_planes == 0 ||
523 		    requested_planes > VIDEO_MAX_PLANES)
524 			return -EINVAL;
525 		for (i = 0; i < requested_planes; i++)
526 			requested_sizes[i] =
527 				f->fmt.pix_mp.plane_fmt[i].sizeimage;
528 		break;
529 	case V4L2_BUF_TYPE_VIDEO_CAPTURE:
530 	case V4L2_BUF_TYPE_VIDEO_OUTPUT:
531 		requested_sizes[0] = f->fmt.pix.sizeimage;
532 		break;
533 	case V4L2_BUF_TYPE_VBI_CAPTURE:
534 	case V4L2_BUF_TYPE_VBI_OUTPUT:
535 		requested_sizes[0] = f->fmt.vbi.samples_per_line *
536 			(f->fmt.vbi.count[0] + f->fmt.vbi.count[1]);
537 		break;
538 	case V4L2_BUF_TYPE_SLICED_VBI_CAPTURE:
539 	case V4L2_BUF_TYPE_SLICED_VBI_OUTPUT:
540 		requested_sizes[0] = f->fmt.sliced.io_size;
541 		break;
542 	case V4L2_BUF_TYPE_SDR_CAPTURE:
543 	case V4L2_BUF_TYPE_SDR_OUTPUT:
544 		requested_sizes[0] = f->fmt.sdr.buffersize;
545 		break;
546 	case V4L2_BUF_TYPE_META_CAPTURE:
547 		requested_sizes[0] = f->fmt.meta.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