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