Commit | Line | Data |
---|---|---|
e23ccc0a | 1 | /* |
c139990e | 2 | * videobuf2-core.h - Video Buffer 2 Core Framework |
e23ccc0a PO |
3 | * |
4 | * Copyright (C) 2010 Samsung Electronics | |
5 | * | |
95072084 | 6 | * Author: Pawel Osciak <pawel@osciak.com> |
e23ccc0a PO |
7 | * |
8 | * This program is free software; you can redistribute it and/or modify | |
9 | * it under the terms of the GNU General Public License as published by | |
10 | * the Free Software Foundation. | |
11 | */ | |
12 | #ifndef _MEDIA_VIDEOBUF2_CORE_H | |
13 | #define _MEDIA_VIDEOBUF2_CORE_H | |
14 | ||
15 | #include <linux/mm_types.h> | |
16 | #include <linux/mutex.h> | |
17 | #include <linux/poll.h> | |
c5384048 | 18 | #include <linux/dma-buf.h> |
e23ccc0a | 19 | |
bed04f93 JS |
20 | #define VB2_MAX_FRAME (32) |
21 | #define VB2_MAX_PLANES (8) | |
22 | ||
23 | enum vb2_memory { | |
24 | VB2_MEMORY_UNKNOWN = 0, | |
25 | VB2_MEMORY_MMAP = 1, | |
26 | VB2_MEMORY_USERPTR = 2, | |
27 | VB2_MEMORY_DMABUF = 4, | |
28 | }; | |
29 | ||
e23ccc0a | 30 | struct vb2_alloc_ctx; |
b25748fe | 31 | struct vb2_fileio_data; |
3415a89f | 32 | struct vb2_threadio_data; |
e23ccc0a PO |
33 | |
34 | /** | |
35 | * struct vb2_mem_ops - memory handling/memory allocator operations | |
36 | * @alloc: allocate video memory and, optionally, allocator private data, | |
37 | * return NULL on failure or a pointer to allocator private, | |
38 | * per-buffer data on success; the returned private structure | |
39 | * will then be passed as buf_priv argument to other ops in this | |
b6ba2057 HV |
40 | * structure. Additional gfp_flags to use when allocating the |
41 | * are also passed to this operation. These flags are from the | |
42 | * gfp_flags field of vb2_queue. | |
e23ccc0a PO |
43 | * @put: inform the allocator that the buffer will no longer be used; |
44 | * usually will result in the allocator freeing the buffer (if | |
45 | * no other users of this buffer are present); the buf_priv | |
46 | * argument is the allocator private per-buffer structure | |
3f12e6b0 | 47 | * previously returned from the alloc callback. |
32d81b41 MCC |
48 | * @get_dmabuf: acquire userspace memory for a hardware operation; used for |
49 | * DMABUF memory types. | |
e23ccc0a PO |
50 | * @get_userptr: acquire userspace memory for a hardware operation; used for |
51 | * USERPTR memory types; vaddr is the address passed to the | |
52 | * videobuf layer when queuing a video buffer of USERPTR type; | |
53 | * should return an allocator private per-buffer structure | |
54 | * associated with the buffer on success, NULL on failure; | |
55 | * the returned private structure will then be passed as buf_priv | |
3f12e6b0 | 56 | * argument to other ops in this structure. |
e23ccc0a | 57 | * @put_userptr: inform the allocator that a USERPTR buffer will no longer |
3f12e6b0 | 58 | * be used. |
c5384048 SS |
59 | * @attach_dmabuf: attach a shared struct dma_buf for a hardware operation; |
60 | * used for DMABUF memory types; alloc_ctx is the alloc context | |
61 | * dbuf is the shared dma_buf; returns NULL on failure; | |
62 | * allocator private per-buffer structure on success; | |
3f12e6b0 | 63 | * this needs to be used for further accesses to the buffer. |
c5384048 SS |
64 | * @detach_dmabuf: inform the exporter of the buffer that the current DMABUF |
65 | * buffer is no longer used; the buf_priv argument is the | |
66 | * allocator private per-buffer structure previously returned | |
3f12e6b0 | 67 | * from the attach_dmabuf callback. |
c5384048 SS |
68 | * @map_dmabuf: request for access to the dmabuf from allocator; the allocator |
69 | * of dmabuf is informed that this driver is going to use the | |
3f12e6b0 | 70 | * dmabuf. |
c5384048 | 71 | * @unmap_dmabuf: releases access control to the dmabuf - allocator is notified |
3f12e6b0 | 72 | * that this driver is done using the dmabuf for now. |
3e0c2f20 | 73 | * @prepare: called every time the buffer is passed from userspace to the |
3f12e6b0 | 74 | * driver, useful for cache synchronisation, optional. |
3e0c2f20 | 75 | * @finish: called every time the buffer is passed back from the driver |
3f12e6b0 | 76 | * to the userspace, also optional. |
e23ccc0a PO |
77 | * @vaddr: return a kernel virtual address to a given memory buffer |
78 | * associated with the passed private structure or NULL if no | |
3f12e6b0 | 79 | * such mapping exists. |
e23ccc0a PO |
80 | * @cookie: return allocator specific cookie for a given memory buffer |
81 | * associated with the passed private structure or NULL if not | |
3f12e6b0 | 82 | * available. |
e23ccc0a PO |
83 | * @num_users: return the current number of users of a memory buffer; |
84 | * return 1 if the videobuf layer (or actually the driver using | |
3f12e6b0 | 85 | * it) is the only user. |
e23ccc0a | 86 | * @mmap: setup a userspace mapping for a given memory buffer under |
3f12e6b0 | 87 | * the provided virtual memory region. |
e23ccc0a PO |
88 | * |
89 | * Required ops for USERPTR types: get_userptr, put_userptr. | |
90 | * Required ops for MMAP types: alloc, put, num_users, mmap. | |
3f12e6b0 | 91 | * Required ops for read/write access types: alloc, put, num_users, vaddr. |
c5384048 SS |
92 | * Required ops for DMABUF types: attach_dmabuf, detach_dmabuf, map_dmabuf, |
93 | * unmap_dmabuf. | |
e23ccc0a PO |
94 | */ |
95 | struct vb2_mem_ops { | |
d935c57e HV |
96 | void *(*alloc)(void *alloc_ctx, unsigned long size, |
97 | enum dma_data_direction dma_dir, | |
98 | gfp_t gfp_flags); | |
e23ccc0a | 99 | void (*put)(void *buf_priv); |
ea3aba84 | 100 | struct dma_buf *(*get_dmabuf)(void *buf_priv, unsigned long flags); |
e23ccc0a PO |
101 | |
102 | void *(*get_userptr)(void *alloc_ctx, unsigned long vaddr, | |
cd474037 HV |
103 | unsigned long size, |
104 | enum dma_data_direction dma_dir); | |
e23ccc0a PO |
105 | void (*put_userptr)(void *buf_priv); |
106 | ||
3e0c2f20 MS |
107 | void (*prepare)(void *buf_priv); |
108 | void (*finish)(void *buf_priv); | |
109 | ||
c5384048 | 110 | void *(*attach_dmabuf)(void *alloc_ctx, struct dma_buf *dbuf, |
cd474037 HV |
111 | unsigned long size, |
112 | enum dma_data_direction dma_dir); | |
c5384048 SS |
113 | void (*detach_dmabuf)(void *buf_priv); |
114 | int (*map_dmabuf)(void *buf_priv); | |
115 | void (*unmap_dmabuf)(void *buf_priv); | |
116 | ||
e23ccc0a PO |
117 | void *(*vaddr)(void *buf_priv); |
118 | void *(*cookie)(void *buf_priv); | |
119 | ||
120 | unsigned int (*num_users)(void *buf_priv); | |
121 | ||
122 | int (*mmap)(void *buf_priv, struct vm_area_struct *vma); | |
123 | }; | |
124 | ||
2d700715 JS |
125 | /** |
126 | * struct vb2_plane - plane information | |
127 | * @mem_priv: private data with this plane | |
128 | * @dbuf: dma_buf - shared buffer object | |
129 | * @dbuf_mapped: flag to show whether dbuf is mapped or not | |
130 | * @bytesused: number of bytes occupied by data in the plane (payload) | |
131 | * @length: size of this plane (NOT the payload) in bytes | |
58e1ba3c HV |
132 | * @min_length: minimum required size of this plane (NOT the payload) in bytes. |
133 | * @length is always greater or equal to @min_length. | |
32d81b41 | 134 | * @offset: when memory in the associated struct vb2_buffer is |
2d700715 JS |
135 | * VB2_MEMORY_MMAP, equals the offset from the start of |
136 | * the device memory for this plane (or is a "cookie" that | |
137 | * should be passed to mmap() called on the video node) | |
138 | * @userptr: when memory is VB2_MEMORY_USERPTR, a userspace pointer | |
139 | * pointing to this plane | |
140 | * @fd: when memory is VB2_MEMORY_DMABUF, a userspace file | |
141 | * descriptor associated with this plane | |
32d81b41 MCC |
142 | * @m: Union with memtype-specific data (@offset, @userptr or |
143 | * @fd). | |
2d700715 JS |
144 | * @data_offset: offset in the plane to the start of data; usually 0, |
145 | * unless there is a header in front of the data | |
146 | * Should contain enough information to be able to cover all the fields | |
147 | * of struct v4l2_plane at videodev2.h | |
148 | */ | |
e23ccc0a PO |
149 | struct vb2_plane { |
150 | void *mem_priv; | |
c5384048 SS |
151 | struct dma_buf *dbuf; |
152 | unsigned int dbuf_mapped; | |
2d700715 JS |
153 | unsigned int bytesused; |
154 | unsigned int length; | |
58e1ba3c | 155 | unsigned int min_length; |
2d700715 JS |
156 | union { |
157 | unsigned int offset; | |
158 | unsigned long userptr; | |
159 | int fd; | |
160 | } m; | |
161 | unsigned int data_offset; | |
e23ccc0a PO |
162 | }; |
163 | ||
164 | /** | |
165 | * enum vb2_io_modes - queue access methods | |
166 | * @VB2_MMAP: driver supports MMAP with streaming API | |
167 | * @VB2_USERPTR: driver supports USERPTR with streaming API | |
168 | * @VB2_READ: driver supports read() style access | |
169 | * @VB2_WRITE: driver supports write() style access | |
c5384048 | 170 | * @VB2_DMABUF: driver supports DMABUF with streaming API |
e23ccc0a PO |
171 | */ |
172 | enum vb2_io_modes { | |
173 | VB2_MMAP = (1 << 0), | |
174 | VB2_USERPTR = (1 << 1), | |
175 | VB2_READ = (1 << 2), | |
176 | VB2_WRITE = (1 << 3), | |
c5384048 | 177 | VB2_DMABUF = (1 << 4), |
e23ccc0a PO |
178 | }; |
179 | ||
e23ccc0a PO |
180 | /** |
181 | * enum vb2_buffer_state - current video buffer state | |
182 | * @VB2_BUF_STATE_DEQUEUED: buffer under userspace control | |
b18a8ff2 | 183 | * @VB2_BUF_STATE_PREPARING: buffer is being prepared in videobuf |
ebc087d0 | 184 | * @VB2_BUF_STATE_PREPARED: buffer prepared in videobuf and by the driver |
e23ccc0a | 185 | * @VB2_BUF_STATE_QUEUED: buffer queued in videobuf, but not in driver |
6d058c56 | 186 | * @VB2_BUF_STATE_REQUEUEING: re-queue a buffer to the driver |
e23ccc0a PO |
187 | * @VB2_BUF_STATE_ACTIVE: buffer queued in driver and possibly used |
188 | * in a hardware operation | |
189 | * @VB2_BUF_STATE_DONE: buffer returned from driver to videobuf, but | |
190 | * not yet dequeued to userspace | |
191 | * @VB2_BUF_STATE_ERROR: same as above, but the operation on the buffer | |
192 | * has ended with an error, which will be reported | |
193 | * to the userspace when it is dequeued | |
194 | */ | |
195 | enum vb2_buffer_state { | |
196 | VB2_BUF_STATE_DEQUEUED, | |
b18a8ff2 | 197 | VB2_BUF_STATE_PREPARING, |
ebc087d0 | 198 | VB2_BUF_STATE_PREPARED, |
e23ccc0a | 199 | VB2_BUF_STATE_QUEUED, |
6d058c56 | 200 | VB2_BUF_STATE_REQUEUEING, |
e23ccc0a PO |
201 | VB2_BUF_STATE_ACTIVE, |
202 | VB2_BUF_STATE_DONE, | |
203 | VB2_BUF_STATE_ERROR, | |
204 | }; | |
205 | ||
206 | struct vb2_queue; | |
207 | ||
208 | /** | |
209 | * struct vb2_buffer - represents a video buffer | |
e23ccc0a | 210 | * @vb2_queue: the queue to which this driver belongs |
2d700715 JS |
211 | * @index: id number of the buffer |
212 | * @type: buffer type | |
213 | * @memory: the method, in which the actual data is passed | |
e23ccc0a PO |
214 | * @num_planes: number of planes in the buffer |
215 | * on an internal driver queue | |
2d700715 | 216 | * @planes: private per-plane information; do not change |
d6dd645e | 217 | * @timestamp: frame timestamp in ns |
e23ccc0a PO |
218 | */ |
219 | struct vb2_buffer { | |
e23ccc0a | 220 | struct vb2_queue *vb2_queue; |
2d700715 JS |
221 | unsigned int index; |
222 | unsigned int type; | |
223 | unsigned int memory; | |
e23ccc0a | 224 | unsigned int num_planes; |
bed04f93 | 225 | struct vb2_plane planes[VB2_MAX_PLANES]; |
d6dd645e | 226 | u64 timestamp; |
e23ccc0a | 227 | |
efe98010 MCC |
228 | /* private: internal use only |
229 | * | |
230 | * state: current buffer state; do not change | |
231 | * queued_entry: entry on the queued buffers list, which holds | |
232 | * all buffers queued from userspace | |
233 | * done_entry: entry on the list that stores all buffers ready | |
234 | * to be dequeued to userspace | |
235 | */ | |
e23ccc0a PO |
236 | enum vb2_buffer_state state; |
237 | ||
238 | struct list_head queued_entry; | |
239 | struct list_head done_entry; | |
b5b4541e HV |
240 | #ifdef CONFIG_VIDEO_ADV_DEBUG |
241 | /* | |
242 | * Counters for how often these buffer-related ops are | |
243 | * called. Used to check for unbalanced ops. | |
244 | */ | |
245 | u32 cnt_mem_alloc; | |
246 | u32 cnt_mem_put; | |
247 | u32 cnt_mem_get_dmabuf; | |
248 | u32 cnt_mem_get_userptr; | |
249 | u32 cnt_mem_put_userptr; | |
250 | u32 cnt_mem_prepare; | |
251 | u32 cnt_mem_finish; | |
252 | u32 cnt_mem_attach_dmabuf; | |
253 | u32 cnt_mem_detach_dmabuf; | |
254 | u32 cnt_mem_map_dmabuf; | |
255 | u32 cnt_mem_unmap_dmabuf; | |
256 | u32 cnt_mem_vaddr; | |
257 | u32 cnt_mem_cookie; | |
258 | u32 cnt_mem_num_users; | |
259 | u32 cnt_mem_mmap; | |
260 | ||
261 | u32 cnt_buf_init; | |
262 | u32 cnt_buf_prepare; | |
263 | u32 cnt_buf_finish; | |
264 | u32 cnt_buf_cleanup; | |
265 | u32 cnt_buf_queue; | |
266 | ||
267 | /* This counts the number of calls to vb2_buffer_done() */ | |
268 | u32 cnt_buf_done; | |
269 | #endif | |
e23ccc0a PO |
270 | }; |
271 | ||
272 | /** | |
273 | * struct vb2_ops - driver-specific callbacks | |
274 | * | |
2d86401c | 275 | * @queue_setup: called from VIDIOC_REQBUFS and VIDIOC_CREATE_BUFS |
df9ecb0c HV |
276 | * handlers before memory allocation. It can be called |
277 | * twice: if the original number of requested buffers | |
278 | * could not be allocated, then it will be called a | |
279 | * second time with the actually allocated number of | |
280 | * buffers to verify if that is OK. | |
281 | * The driver should return the required number of buffers | |
282 | * in *num_buffers, the required number of planes per | |
283 | * buffer in *num_planes, the size of each plane should be | |
284 | * set in the sizes[] array and optional per-plane | |
285 | * allocator specific context in the alloc_ctxs[] array. | |
286 | * When called from VIDIOC_REQBUFS, *num_planes == 0, the | |
287 | * driver has to use the currently configured format to | |
288 | * determine the plane sizes and *num_buffers is the total | |
289 | * number of buffers that are being allocated. When called | |
290 | * from VIDIOC_CREATE_BUFS, *num_planes != 0 and it | |
291 | * describes the requested number of planes and sizes[] | |
292 | * contains the requested plane sizes. If either | |
293 | * *num_planes or the requested sizes are invalid callback | |
294 | * must return -EINVAL. In this case *num_buffers are | |
295 | * being allocated additionally to q->num_buffers. | |
e23ccc0a PO |
296 | * @wait_prepare: release any locks taken while calling vb2 functions; |
297 | * it is called before an ioctl needs to wait for a new | |
298 | * buffer to arrive; required to avoid a deadlock in | |
3f12e6b0 | 299 | * blocking access type. |
e23ccc0a PO |
300 | * @wait_finish: reacquire all locks released in the previous callback; |
301 | * required to continue operation after sleeping while | |
3f12e6b0 | 302 | * waiting for a new buffer to arrive. |
e23ccc0a PO |
303 | * @buf_init: called once after allocating a buffer (in MMAP case) |
304 | * or after acquiring a new USERPTR buffer; drivers may | |
305 | * perform additional buffer-related initialization; | |
306 | * initialization failure (return != 0) will prevent | |
3f12e6b0 | 307 | * queue setup from completing successfully; optional. |
2d86401c GL |
308 | * @buf_prepare: called every time the buffer is queued from userspace |
309 | * and from the VIDIOC_PREPARE_BUF ioctl; drivers may | |
cf227429 HV |
310 | * perform any initialization required before each |
311 | * hardware operation in this callback; drivers can | |
312 | * access/modify the buffer here as it is still synced for | |
313 | * the CPU; drivers that support VIDIOC_CREATE_BUFS must | |
314 | * also validate the buffer size; if an error is returned, | |
315 | * the buffer will not be queued in driver; optional. | |
e23ccc0a | 316 | * @buf_finish: called before every dequeue of the buffer back to |
cf227429 HV |
317 | * userspace; the buffer is synced for the CPU, so drivers |
318 | * can access/modify the buffer contents; drivers may | |
319 | * perform any operations required before userspace | |
320 | * accesses the buffer; optional. The buffer state can be | |
321 | * one of the following: DONE and ERROR occur while | |
322 | * streaming is in progress, and the PREPARED state occurs | |
323 | * when the queue has been canceled and all pending | |
324 | * buffers are being returned to their default DEQUEUED | |
325 | * state. Typically you only have to do something if the | |
326 | * state is VB2_BUF_STATE_DONE, since in all other cases | |
327 | * the buffer contents will be ignored anyway. | |
e23ccc0a | 328 | * @buf_cleanup: called once before the buffer is freed; drivers may |
3f12e6b0 | 329 | * perform any additional cleanup; optional. |
bd323e28 MS |
330 | * @start_streaming: called once to enter 'streaming' state; the driver may |
331 | * receive buffers with @buf_queue callback before | |
332 | * @start_streaming is called; the driver gets the number | |
333 | * of already queued buffers in count parameter; driver | |
02f142ec HV |
334 | * can return an error if hardware fails, in that case all |
335 | * buffers that have been already given by the @buf_queue | |
ccf58cb4 | 336 | * callback are to be returned by the driver by calling |
44e8e69d | 337 | * @vb2_buffer_done(VB2_BUF_STATE_QUEUED). |
ccf58cb4 HV |
338 | * If you need a minimum number of buffers before you can |
339 | * start streaming, then set @min_buffers_needed in the | |
340 | * vb2_queue structure. If that is non-zero then | |
341 | * start_streaming won't be called until at least that | |
342 | * many buffers have been queued up by userspace. | |
e23ccc0a PO |
343 | * @stop_streaming: called when 'streaming' state must be disabled; driver |
344 | * should stop any DMA transactions or wait until they | |
345 | * finish and give back all buffers it got from buf_queue() | |
ccf58cb4 HV |
346 | * callback by calling @vb2_buffer_done() with either |
347 | * VB2_BUF_STATE_DONE or VB2_BUF_STATE_ERROR; may use | |
348 | * vb2_wait_for_all_buffers() function | |
e23ccc0a PO |
349 | * @buf_queue: passes buffer vb to the driver; driver may start |
350 | * hardware operation on this buffer; driver should give | |
bd323e28 MS |
351 | * the buffer back by calling vb2_buffer_done() function; |
352 | * it is allways called after calling STREAMON ioctl; | |
353 | * might be called before start_streaming callback if user | |
3f12e6b0 | 354 | * pre-queued buffers before calling STREAMON. |
e23ccc0a PO |
355 | */ |
356 | struct vb2_ops { | |
df9ecb0c | 357 | int (*queue_setup)(struct vb2_queue *q, |
fc714e70 GL |
358 | unsigned int *num_buffers, unsigned int *num_planes, |
359 | unsigned int sizes[], void *alloc_ctxs[]); | |
e23ccc0a PO |
360 | |
361 | void (*wait_prepare)(struct vb2_queue *q); | |
362 | void (*wait_finish)(struct vb2_queue *q); | |
363 | ||
364 | int (*buf_init)(struct vb2_buffer *vb); | |
365 | int (*buf_prepare)(struct vb2_buffer *vb); | |
06470642 | 366 | void (*buf_finish)(struct vb2_buffer *vb); |
e23ccc0a PO |
367 | void (*buf_cleanup)(struct vb2_buffer *vb); |
368 | ||
bd323e28 | 369 | int (*start_streaming)(struct vb2_queue *q, unsigned int count); |
e37559b2 | 370 | void (*stop_streaming)(struct vb2_queue *q); |
e23ccc0a PO |
371 | |
372 | void (*buf_queue)(struct vb2_buffer *vb); | |
373 | }; | |
374 | ||
10cc3b1e HV |
375 | /** |
376 | * struct vb2_ops - driver-specific callbacks | |
377 | * | |
378 | * @fill_user_buffer: given a vb2_buffer fill in the userspace structure. | |
379 | * For V4L2 this is a struct v4l2_buffer. | |
380 | * @fill_vb2_buffer: given a userspace structure, fill in the vb2_buffer. | |
381 | * If the userspace structure is invalid, then this op | |
382 | * will return an error. | |
383 | * @copy_timestamp: copy the timestamp from a userspace structure to | |
384 | * the vb2_buffer struct. | |
385 | */ | |
b0e0e1f8 | 386 | struct vb2_buf_ops { |
10cc3b1e | 387 | void (*fill_user_buffer)(struct vb2_buffer *vb, void *pb); |
b0e0e1f8 JS |
388 | int (*fill_vb2_buffer)(struct vb2_buffer *vb, const void *pb, |
389 | struct vb2_plane *planes); | |
10cc3b1e | 390 | void (*copy_timestamp)(struct vb2_buffer *vb, const void *pb); |
b0e0e1f8 | 391 | }; |
5a5adf6b | 392 | |
e23ccc0a PO |
393 | /** |
394 | * struct vb2_queue - a videobuf queue | |
395 | * | |
bed04f93 JS |
396 | * @type: private buffer type whose content is defined by the vb2-core |
397 | * caller. For example, for V4L2, it should match | |
398 | * the V4L2_BUF_TYPE_* in include/uapi/linux/videodev2.h | |
e23ccc0a | 399 | * @io_modes: supported io methods (see vb2_io_modes enum) |
06e7a9b6 KD |
400 | * @fileio_read_once: report EOF after reading the first buffer |
401 | * @fileio_write_immediately: queue buffer after each write() call | |
f61bf13b | 402 | * @allow_zero_bytesused: allow bytesused == 0 to be passed to the driver |
5a5adf6b HV |
403 | * @lock: pointer to a mutex that protects the vb2_queue struct. The |
404 | * driver can set this to a mutex to let the v4l2 core serialize | |
405 | * the queuing ioctls. If the driver wants to handle locking | |
406 | * itself, then this should be set to NULL. This lock is not used | |
407 | * by the videobuf2 core API. | |
408 | * @owner: The filehandle that 'owns' the buffers, i.e. the filehandle | |
409 | * that called reqbufs, create_buffers or started fileio. | |
410 | * This field is not used by the videobuf2 core API, but it allows | |
411 | * drivers to easily associate an owner filehandle with the queue. | |
e23ccc0a PO |
412 | * @ops: driver-specific callbacks |
413 | * @mem_ops: memory allocator specific callbacks | |
b0e0e1f8 JS |
414 | * @buf_ops: callbacks to deliver buffer information |
415 | * between user-space and kernel-space | |
e23ccc0a PO |
416 | * @drv_priv: driver private data |
417 | * @buf_struct_size: size of the driver-specific buffer structure; | |
418 | * "0" indicates the driver doesn't want to use a custom buffer | |
2d700715 JS |
419 | * structure type. for example, sizeof(struct vb2_v4l2_buffer) |
420 | * will be used for v4l2. | |
072f1a48 LP |
421 | * @timestamp_flags: Timestamp flags; V4L2_BUF_FLAG_TIMESTAMP_* and |
422 | * V4L2_BUF_FLAG_TSTAMP_SRC_* | |
b6ba2057 HV |
423 | * @gfp_flags: additional gfp flags used when allocating the buffers. |
424 | * Typically this is 0, but it may be e.g. GFP_DMA or __GFP_DMA32 | |
425 | * to force the buffer allocation to a specific memory zone. | |
b3379c62 HV |
426 | * @min_buffers_needed: the minimum number of buffers needed before |
427 | * start_streaming() can be called. Used when a DMA engine | |
428 | * cannot be started unless at least this number of buffers | |
429 | * have been queued into the driver. | |
d78757e7 MCC |
430 | */ |
431 | /* | |
432 | * Private elements (won't appear at the DocBook): | |
f035eb4e | 433 | * @mmap_lock: private mutex used when buffers are allocated/freed/mmapped |
e23ccc0a PO |
434 | * @memory: current memory type used |
435 | * @bufs: videobuf buffer structures | |
436 | * @num_buffers: number of allocated/used buffers | |
437 | * @queued_list: list of buffers currently queued from userspace | |
b3379c62 | 438 | * @queued_count: number of buffers queued and ready for streaming. |
6ea3b980 | 439 | * @owned_by_drv_count: number of buffers owned by the driver |
e23ccc0a PO |
440 | * @done_list: list of buffers ready to be dequeued to userspace |
441 | * @done_lock: lock to protect done_list list | |
442 | * @done_wq: waitqueue for processes waiting for buffers ready to be dequeued | |
443 | * @alloc_ctx: memory type/allocator-specific contexts for each plane | |
444 | * @streaming: current streaming state | |
b3379c62 HV |
445 | * @start_streaming_called: start_streaming() was called successfully and we |
446 | * started streaming. | |
4bb7267d | 447 | * @error: a fatal error occurred on the queue |
58d75f4b HV |
448 | * @waiting_for_buffers: used in poll() to check if vb2 is still waiting for |
449 | * buffers. Only set for capture queues if qbuf has not yet been | |
450 | * called since poll() needs to return POLLERR in that situation. | |
bed04f93 JS |
451 | * @is_multiplanar: set if buffer type is multiplanar |
452 | * @is_output: set if buffer type is output | |
959c3ef3 | 453 | * @copy_timestamp: set if vb2-core should set timestamps |
c1621840 PZ |
454 | * @last_buffer_dequeued: used in poll() and DQBUF to immediately return if the |
455 | * last decoded buffer was already dequeued. Set for capture queues | |
456 | * when a buffer with the V4L2_BUF_FLAG_LAST is dequeued. | |
b25748fe | 457 | * @fileio: file io emulator internal data, used only if emulator is active |
3415a89f | 458 | * @threadio: thread io internal data, used only if thread is active |
e23ccc0a PO |
459 | */ |
460 | struct vb2_queue { | |
bed04f93 | 461 | unsigned int type; |
e23ccc0a | 462 | unsigned int io_modes; |
06e7a9b6 KD |
463 | unsigned fileio_read_once:1; |
464 | unsigned fileio_write_immediately:1; | |
f61bf13b | 465 | unsigned allow_zero_bytesused:1; |
06e7a9b6 | 466 | |
5a5adf6b | 467 | struct mutex *lock; |
bed04f93 | 468 | void *owner; |
e23ccc0a PO |
469 | |
470 | const struct vb2_ops *ops; | |
471 | const struct vb2_mem_ops *mem_ops; | |
b0e0e1f8 JS |
472 | const struct vb2_buf_ops *buf_ops; |
473 | ||
e23ccc0a PO |
474 | void *drv_priv; |
475 | unsigned int buf_struct_size; | |
ade48681 | 476 | u32 timestamp_flags; |
b6ba2057 | 477 | gfp_t gfp_flags; |
b3379c62 | 478 | u32 min_buffers_needed; |
e23ccc0a | 479 | |
d78757e7 | 480 | /* private: internal use only */ |
f035eb4e | 481 | struct mutex mmap_lock; |
bed04f93 JS |
482 | unsigned int memory; |
483 | struct vb2_buffer *bufs[VB2_MAX_FRAME]; | |
e23ccc0a PO |
484 | unsigned int num_buffers; |
485 | ||
486 | struct list_head queued_list; | |
b3379c62 | 487 | unsigned int queued_count; |
e23ccc0a | 488 | |
6ea3b980 | 489 | atomic_t owned_by_drv_count; |
e23ccc0a PO |
490 | struct list_head done_list; |
491 | spinlock_t done_lock; | |
492 | wait_queue_head_t done_wq; | |
493 | ||
bed04f93 | 494 | void *alloc_ctx[VB2_MAX_PLANES]; |
e23ccc0a PO |
495 | |
496 | unsigned int streaming:1; | |
b3379c62 | 497 | unsigned int start_streaming_called:1; |
4bb7267d | 498 | unsigned int error:1; |
58d75f4b | 499 | unsigned int waiting_for_buffers:1; |
bed04f93 JS |
500 | unsigned int is_multiplanar:1; |
501 | unsigned int is_output:1; | |
959c3ef3 | 502 | unsigned int copy_timestamp:1; |
c1621840 | 503 | unsigned int last_buffer_dequeued:1; |
b25748fe MS |
504 | |
505 | struct vb2_fileio_data *fileio; | |
3415a89f | 506 | struct vb2_threadio_data *threadio; |
b5b4541e HV |
507 | |
508 | #ifdef CONFIG_VIDEO_ADV_DEBUG | |
509 | /* | |
510 | * Counters for how often these queue-related ops are | |
511 | * called. Used to check for unbalanced ops. | |
512 | */ | |
513 | u32 cnt_queue_setup; | |
514 | u32 cnt_wait_prepare; | |
515 | u32 cnt_wait_finish; | |
516 | u32 cnt_start_streaming; | |
517 | u32 cnt_stop_streaming; | |
518 | #endif | |
e23ccc0a PO |
519 | }; |
520 | ||
521 | void *vb2_plane_vaddr(struct vb2_buffer *vb, unsigned int plane_no); | |
522 | void *vb2_plane_cookie(struct vb2_buffer *vb, unsigned int plane_no); | |
523 | ||
524 | void vb2_buffer_done(struct vb2_buffer *vb, enum vb2_buffer_state state); | |
34ea4d44 | 525 | void vb2_discard_done(struct vb2_queue *q); |
e23ccc0a PO |
526 | int vb2_wait_for_all_buffers(struct vb2_queue *q); |
527 | ||
10cc3b1e | 528 | void vb2_core_querybuf(struct vb2_queue *q, unsigned int index, void *pb); |
3c5be988 JS |
529 | int vb2_core_reqbufs(struct vb2_queue *q, enum vb2_memory memory, |
530 | unsigned int *count); | |
531 | int vb2_core_create_bufs(struct vb2_queue *q, enum vb2_memory memory, | |
df9ecb0c HV |
532 | unsigned int *count, unsigned requested_planes, |
533 | const unsigned int requested_sizes[]); | |
3c5be988 JS |
534 | int vb2_core_prepare_buf(struct vb2_queue *q, unsigned int index, void *pb); |
535 | int vb2_core_qbuf(struct vb2_queue *q, unsigned int index, void *pb); | |
536 | int vb2_core_dqbuf(struct vb2_queue *q, void *pb, bool nonblocking); | |
e23ccc0a | 537 | |
3c5be988 JS |
538 | int vb2_core_streamon(struct vb2_queue *q, unsigned int type); |
539 | int vb2_core_streamoff(struct vb2_queue *q, unsigned int type); | |
2d86401c | 540 | |
3c5be988 JS |
541 | int vb2_core_expbuf(struct vb2_queue *q, int *fd, unsigned int type, |
542 | unsigned int index, unsigned int plane, unsigned int flags); | |
e23ccc0a | 543 | |
3c5be988 JS |
544 | int vb2_core_queue_init(struct vb2_queue *q); |
545 | void vb2_core_queue_release(struct vb2_queue *q); | |
e23ccc0a | 546 | |
3c5be988 | 547 | void vb2_queue_error(struct vb2_queue *q); |
e23ccc0a PO |
548 | |
549 | int vb2_mmap(struct vb2_queue *q, struct vm_area_struct *vma); | |
6f524ec1 SJ |
550 | #ifndef CONFIG_MMU |
551 | unsigned long vb2_get_unmapped_area(struct vb2_queue *q, | |
552 | unsigned long addr, | |
553 | unsigned long len, | |
554 | unsigned long pgoff, | |
555 | unsigned long flags); | |
556 | #endif | |
af3bac1a JS |
557 | unsigned int vb2_core_poll(struct vb2_queue *q, struct file *file, |
558 | poll_table *wait); | |
559 | size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count, | |
560 | loff_t *ppos, int nonblock); | |
561 | size_t vb2_write(struct vb2_queue *q, const char __user *data, size_t count, | |
562 | loff_t *ppos, int nonblock); | |
563 | ||
564 | /* | |
565 | * vb2_thread_fnc - callback function for use with vb2_thread | |
566 | * | |
567 | * This is called whenever a buffer is dequeued in the thread. | |
568 | */ | |
569 | typedef int (*vb2_thread_fnc)(struct vb2_buffer *vb, void *priv); | |
570 | ||
571 | /** | |
572 | * vb2_thread_start() - start a thread for the given queue. | |
573 | * @q: videobuf queue | |
574 | * @fnc: callback function | |
575 | * @priv: priv pointer passed to the callback function | |
576 | * @thread_name:the name of the thread. This will be prefixed with "vb2-". | |
577 | * | |
578 | * This starts a thread that will queue and dequeue until an error occurs | |
579 | * or @vb2_thread_stop is called. | |
580 | * | |
581 | * This function should not be used for anything else but the videobuf2-dvb | |
582 | * support. If you think you have another good use-case for this, then please | |
583 | * contact the linux-media mailinglist first. | |
584 | */ | |
585 | int vb2_thread_start(struct vb2_queue *q, vb2_thread_fnc fnc, void *priv, | |
586 | const char *thread_name); | |
587 | ||
588 | /** | |
589 | * vb2_thread_stop() - stop the thread for the given queue. | |
590 | * @q: videobuf queue | |
591 | */ | |
592 | int vb2_thread_stop(struct vb2_queue *q); | |
e23ccc0a PO |
593 | |
594 | /** | |
595 | * vb2_is_streaming() - return streaming status of the queue | |
596 | * @q: videobuf queue | |
597 | */ | |
598 | static inline bool vb2_is_streaming(struct vb2_queue *q) | |
599 | { | |
600 | return q->streaming; | |
601 | } | |
602 | ||
74753cff HV |
603 | /** |
604 | * vb2_fileio_is_active() - return true if fileio is active. | |
605 | * @q: videobuf queue | |
606 | * | |
607 | * This returns true if read() or write() is used to stream the data | |
608 | * as opposed to stream I/O. This is almost never an important distinction, | |
609 | * except in rare cases. One such case is that using read() or write() to | |
610 | * stream a format using V4L2_FIELD_ALTERNATE is not allowed since there | |
611 | * is no way you can pass the field information of each buffer to/from | |
612 | * userspace. A driver that supports this field format should check for | |
613 | * this in the queue_setup op and reject it if this function returns true. | |
614 | */ | |
615 | static inline bool vb2_fileio_is_active(struct vb2_queue *q) | |
616 | { | |
617 | return q->fileio; | |
618 | } | |
619 | ||
e23ccc0a PO |
620 | /** |
621 | * vb2_is_busy() - return busy status of the queue | |
622 | * @q: videobuf queue | |
623 | * | |
624 | * This function checks if queue has any buffers allocated. | |
625 | */ | |
626 | static inline bool vb2_is_busy(struct vb2_queue *q) | |
627 | { | |
628 | return (q->num_buffers > 0); | |
629 | } | |
630 | ||
631 | /** | |
632 | * vb2_get_drv_priv() - return driver private data associated with the queue | |
633 | * @q: videobuf queue | |
634 | */ | |
635 | static inline void *vb2_get_drv_priv(struct vb2_queue *q) | |
636 | { | |
637 | return q->drv_priv; | |
638 | } | |
639 | ||
640 | /** | |
641 | * vb2_set_plane_payload() - set bytesused for the plane plane_no | |
642 | * @vb: buffer for which plane payload should be set | |
643 | * @plane_no: plane number for which payload should be set | |
644 | * @size: payload in bytes | |
645 | */ | |
646 | static inline void vb2_set_plane_payload(struct vb2_buffer *vb, | |
647 | unsigned int plane_no, unsigned long size) | |
648 | { | |
649 | if (plane_no < vb->num_planes) | |
2d700715 | 650 | vb->planes[plane_no].bytesused = size; |
e23ccc0a PO |
651 | } |
652 | ||
653 | /** | |
9f00edae | 654 | * vb2_get_plane_payload() - get bytesused for the plane plane_no |
e23ccc0a PO |
655 | * @vb: buffer for which plane payload should be set |
656 | * @plane_no: plane number for which payload should be set | |
e23ccc0a PO |
657 | */ |
658 | static inline unsigned long vb2_get_plane_payload(struct vb2_buffer *vb, | |
659 | unsigned int plane_no) | |
660 | { | |
661 | if (plane_no < vb->num_planes) | |
2d700715 | 662 | return vb->planes[plane_no].bytesused; |
e23ccc0a PO |
663 | return 0; |
664 | } | |
665 | ||
666 | /** | |
667 | * vb2_plane_size() - return plane size in bytes | |
668 | * @vb: buffer for which plane size should be returned | |
669 | * @plane_no: plane number for which size should be returned | |
670 | */ | |
671 | static inline unsigned long | |
672 | vb2_plane_size(struct vb2_buffer *vb, unsigned int plane_no) | |
673 | { | |
674 | if (plane_no < vb->num_planes) | |
2d700715 | 675 | return vb->planes[plane_no].length; |
e23ccc0a PO |
676 | return 0; |
677 | } | |
678 | ||
ead13033 PL |
679 | /** |
680 | * vb2_start_streaming_called() - return streaming status of driver | |
681 | * @q: videobuf queue | |
682 | */ | |
683 | static inline bool vb2_start_streaming_called(struct vb2_queue *q) | |
684 | { | |
685 | return q->start_streaming_called; | |
686 | } | |
687 | ||
c1621840 PZ |
688 | /** |
689 | * vb2_clear_last_buffer_dequeued() - clear last buffer dequeued flag of queue | |
690 | * @q: videobuf queue | |
691 | */ | |
692 | static inline void vb2_clear_last_buffer_dequeued(struct vb2_queue *q) | |
693 | { | |
694 | q->last_buffer_dequeued = false; | |
695 | } | |
696 | ||
af3bac1a JS |
697 | /* |
698 | * The following functions are not part of the vb2 core API, but are useful | |
699 | * functions for videobuf2-*. | |
700 | */ | |
701 | bool vb2_buffer_in_use(struct vb2_queue *q, struct vb2_buffer *vb); | |
702 | int vb2_verify_memory_type(struct vb2_queue *q, | |
703 | enum vb2_memory memory, unsigned int type); | |
e23ccc0a | 704 | #endif /* _MEDIA_VIDEOBUF2_CORE_H */ |