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