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