blob: 8a0f55b6c2ba80e25c67caf89e2050fa58ae322f [file] [log] [blame]
Pawel Osciake23ccc02010-10-11 10:56:41 -03001/*
Junghak Sungc1399902015-09-22 10:30:29 -03002 * videobuf2-core.h - Video Buffer 2 Core Framework
Pawel Osciake23ccc02010-10-11 10:56:41 -03003 *
4 * Copyright (C) 2010 Samsung Electronics
5 *
Pawel Osciak95072082011-03-13 15:23:32 -03006 * Author: Pawel Osciak <pawel@osciak.com>
Pawel Osciake23ccc02010-10-11 10:56:41 -03007 *
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>
Sumit Semwalc5384042012-06-14 10:37:37 -030018#include <linux/dma-buf.h>
Pawel Osciake23ccc02010-10-11 10:56:41 -030019
Junghak Sungbed04f92015-10-06 06:37:47 -030020#define VB2_MAX_FRAME (32)
21#define VB2_MAX_PLANES (8)
22
23enum vb2_memory {
24 VB2_MEMORY_UNKNOWN = 0,
25 VB2_MEMORY_MMAP = 1,
26 VB2_MEMORY_USERPTR = 2,
27 VB2_MEMORY_DMABUF = 4,
28};
29
Pawel Osciake23ccc02010-10-11 10:56:41 -030030struct vb2_alloc_ctx;
Marek Szyprowskib25748f2010-12-06 05:56:55 -030031struct vb2_fileio_data;
Hans Verkuil3415a892014-04-14 07:33:00 -030032struct vb2_threadio_data;
Pawel Osciake23ccc02010-10-11 10:56:41 -030033
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
Hans Verkuilb6ba2052013-03-01 15:44:20 -030040 * 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.
Pawel Osciake23ccc02010-10-11 10:56:41 -030043 * @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
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030047 * previously returned from the alloc callback.
Mauro Carvalho Chehab32d81b42015-10-01 13:59:29 -030048 * @get_dmabuf: acquire userspace memory for a hardware operation; used for
49 * DMABUF memory types.
Pawel Osciake23ccc02010-10-11 10:56:41 -030050 * @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
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030056 * argument to other ops in this structure.
Pawel Osciake23ccc02010-10-11 10:56:41 -030057 * @put_userptr: inform the allocator that a USERPTR buffer will no longer
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030058 * be used.
Sumit Semwalc5384042012-06-14 10:37:37 -030059 * @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;
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030063 * this needs to be used for further accesses to the buffer.
Sumit Semwalc5384042012-06-14 10:37:37 -030064 * @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
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030067 * from the attach_dmabuf callback.
Sumit Semwalc5384042012-06-14 10:37:37 -030068 * @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
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030070 * dmabuf.
Sumit Semwalc5384042012-06-14 10:37:37 -030071 * @unmap_dmabuf: releases access control to the dmabuf - allocator is notified
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030072 * that this driver is done using the dmabuf for now.
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -030073 * @prepare: called every time the buffer is passed from userspace to the
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030074 * driver, useful for cache synchronisation, optional.
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -030075 * @finish: called every time the buffer is passed back from the driver
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030076 * to the userspace, also optional.
Pawel Osciake23ccc02010-10-11 10:56:41 -030077 * @vaddr: return a kernel virtual address to a given memory buffer
78 * associated with the passed private structure or NULL if no
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030079 * such mapping exists.
Pawel Osciake23ccc02010-10-11 10:56:41 -030080 * @cookie: return allocator specific cookie for a given memory buffer
81 * associated with the passed private structure or NULL if not
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030082 * available.
Pawel Osciake23ccc02010-10-11 10:56:41 -030083 * @num_users: return the current number of users of a memory buffer;
84 * return 1 if the videobuf layer (or actually the driver using
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030085 * it) is the only user.
Pawel Osciake23ccc02010-10-11 10:56:41 -030086 * @mmap: setup a userspace mapping for a given memory buffer under
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030087 * the provided virtual memory region.
Pawel Osciake23ccc02010-10-11 10:56:41 -030088 *
89 * Required ops for USERPTR types: get_userptr, put_userptr.
90 * Required ops for MMAP types: alloc, put, num_users, mmap.
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030091 * Required ops for read/write access types: alloc, put, num_users, vaddr.
Sumit Semwalc5384042012-06-14 10:37:37 -030092 * Required ops for DMABUF types: attach_dmabuf, detach_dmabuf, map_dmabuf,
93 * unmap_dmabuf.
Pawel Osciake23ccc02010-10-11 10:56:41 -030094 */
95struct vb2_mem_ops {
Hans Verkuild935c572014-11-18 09:50:59 -030096 void *(*alloc)(void *alloc_ctx, unsigned long size,
97 enum dma_data_direction dma_dir,
98 gfp_t gfp_flags);
Pawel Osciake23ccc02010-10-11 10:56:41 -030099 void (*put)(void *buf_priv);
Philipp Zabelea3aba82013-05-21 05:11:35 -0300100 struct dma_buf *(*get_dmabuf)(void *buf_priv, unsigned long flags);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300101
102 void *(*get_userptr)(void *alloc_ctx, unsigned long vaddr,
Hans Verkuilcd474032014-11-18 09:50:58 -0300103 unsigned long size,
104 enum dma_data_direction dma_dir);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300105 void (*put_userptr)(void *buf_priv);
106
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -0300107 void (*prepare)(void *buf_priv);
108 void (*finish)(void *buf_priv);
109
Sumit Semwalc5384042012-06-14 10:37:37 -0300110 void *(*attach_dmabuf)(void *alloc_ctx, struct dma_buf *dbuf,
Hans Verkuilcd474032014-11-18 09:50:58 -0300111 unsigned long size,
112 enum dma_data_direction dma_dir);
Sumit Semwalc5384042012-06-14 10:37:37 -0300113 void (*detach_dmabuf)(void *buf_priv);
114 int (*map_dmabuf)(void *buf_priv);
115 void (*unmap_dmabuf)(void *buf_priv);
116
Pawel Osciake23ccc02010-10-11 10:56:41 -0300117 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
Junghak Sung2d700712015-09-22 10:30:30 -0300125/**
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
Hans Verkuil58e1ba32015-11-20 09:40:14 -0200132 * @min_length: minimum required size of this plane (NOT the payload) in bytes.
133 * @length is always greater or equal to @min_length.
Mauro Carvalho Chehab32d81b42015-10-01 13:59:29 -0300134 * @offset: when memory in the associated struct vb2_buffer is
Junghak Sung2d700712015-09-22 10:30:30 -0300135 * 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
Mauro Carvalho Chehab32d81b42015-10-01 13:59:29 -0300142 * @m: Union with memtype-specific data (@offset, @userptr or
143 * @fd).
Junghak Sung2d700712015-09-22 10:30:30 -0300144 * @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 */
Pawel Osciake23ccc02010-10-11 10:56:41 -0300149struct vb2_plane {
150 void *mem_priv;
Sumit Semwalc5384042012-06-14 10:37:37 -0300151 struct dma_buf *dbuf;
152 unsigned int dbuf_mapped;
Junghak Sung2d700712015-09-22 10:30:30 -0300153 unsigned int bytesused;
154 unsigned int length;
Hans Verkuil58e1ba32015-11-20 09:40:14 -0200155 unsigned int min_length;
Junghak Sung2d700712015-09-22 10:30:30 -0300156 union {
157 unsigned int offset;
158 unsigned long userptr;
159 int fd;
160 } m;
161 unsigned int data_offset;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300162};
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
Sumit Semwalc5384042012-06-14 10:37:37 -0300170 * @VB2_DMABUF: driver supports DMABUF with streaming API
Pawel Osciake23ccc02010-10-11 10:56:41 -0300171 */
172enum vb2_io_modes {
173 VB2_MMAP = (1 << 0),
174 VB2_USERPTR = (1 << 1),
175 VB2_READ = (1 << 2),
176 VB2_WRITE = (1 << 3),
Sumit Semwalc5384042012-06-14 10:37:37 -0300177 VB2_DMABUF = (1 << 4),
Pawel Osciake23ccc02010-10-11 10:56:41 -0300178};
179
180/**
Pawel Osciake23ccc02010-10-11 10:56:41 -0300181 * enum vb2_buffer_state - current video buffer state
182 * @VB2_BUF_STATE_DEQUEUED: buffer under userspace control
Hans Verkuilb18a8ff2013-12-13 13:13:38 -0300183 * @VB2_BUF_STATE_PREPARING: buffer is being prepared in videobuf
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -0300184 * @VB2_BUF_STATE_PREPARED: buffer prepared in videobuf and by the driver
Pawel Osciake23ccc02010-10-11 10:56:41 -0300185 * @VB2_BUF_STATE_QUEUED: buffer queued in videobuf, but not in driver
Sakari Ailus6d058c52015-07-03 04:37:07 -0300186 * @VB2_BUF_STATE_REQUEUEING: re-queue a buffer to the driver
Pawel Osciake23ccc02010-10-11 10:56:41 -0300187 * @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 */
195enum vb2_buffer_state {
196 VB2_BUF_STATE_DEQUEUED,
Hans Verkuilb18a8ff2013-12-13 13:13:38 -0300197 VB2_BUF_STATE_PREPARING,
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -0300198 VB2_BUF_STATE_PREPARED,
Pawel Osciake23ccc02010-10-11 10:56:41 -0300199 VB2_BUF_STATE_QUEUED,
Sakari Ailus6d058c52015-07-03 04:37:07 -0300200 VB2_BUF_STATE_REQUEUEING,
Pawel Osciake23ccc02010-10-11 10:56:41 -0300201 VB2_BUF_STATE_ACTIVE,
202 VB2_BUF_STATE_DONE,
203 VB2_BUF_STATE_ERROR,
204};
205
206struct vb2_queue;
207
208/**
209 * struct vb2_buffer - represents a video buffer
Pawel Osciake23ccc02010-10-11 10:56:41 -0300210 * @vb2_queue: the queue to which this driver belongs
Junghak Sung2d700712015-09-22 10:30:30 -0300211 * @index: id number of the buffer
212 * @type: buffer type
213 * @memory: the method, in which the actual data is passed
Pawel Osciake23ccc02010-10-11 10:56:41 -0300214 * @num_planes: number of planes in the buffer
215 * on an internal driver queue
Junghak Sung2d700712015-09-22 10:30:30 -0300216 * @planes: private per-plane information; do not change
Junghak Sungd6dd6452015-11-03 08:16:37 -0200217 * @timestamp: frame timestamp in ns
Pawel Osciake23ccc02010-10-11 10:56:41 -0300218 */
219struct vb2_buffer {
Pawel Osciake23ccc02010-10-11 10:56:41 -0300220 struct vb2_queue *vb2_queue;
Junghak Sung2d700712015-09-22 10:30:30 -0300221 unsigned int index;
222 unsigned int type;
223 unsigned int memory;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300224 unsigned int num_planes;
Junghak Sungbed04f92015-10-06 06:37:47 -0300225 struct vb2_plane planes[VB2_MAX_PLANES];
Junghak Sungd6dd6452015-11-03 08:16:37 -0200226 u64 timestamp;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300227
Mauro Carvalho Chehabefe98012015-10-05 09:12:56 -0300228 /* 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 */
Pawel Osciake23ccc02010-10-11 10:56:41 -0300236 enum vb2_buffer_state state;
237
238 struct list_head queued_entry;
239 struct list_head done_entry;
Hans Verkuilb5b45412014-01-29 11:53:25 -0300240#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
Pawel Osciake23ccc02010-10-11 10:56:41 -0300270};
271
272/**
273 * struct vb2_ops - driver-specific callbacks
274 *
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300275 * @queue_setup: called from VIDIOC_REQBUFS and VIDIOC_CREATE_BUFS
Hans Verkuildf9ecb02015-10-28 00:50:37 -0200276 * 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.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300296 * @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
Hans Verkuil3f12e6b2014-02-28 12:25:28 -0300299 * blocking access type.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300300 * @wait_finish: reacquire all locks released in the previous callback;
301 * required to continue operation after sleeping while
Hans Verkuil3f12e6b2014-02-28 12:25:28 -0300302 * waiting for a new buffer to arrive.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300303 * @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
Hans Verkuil3f12e6b2014-02-28 12:25:28 -0300307 * queue setup from completing successfully; optional.
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300308 * @buf_prepare: called every time the buffer is queued from userspace
309 * and from the VIDIOC_PREPARE_BUF ioctl; drivers may
Hans Verkuilcf227422014-11-18 09:50:57 -0300310 * 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.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300316 * @buf_finish: called before every dequeue of the buffer back to
Hans Verkuilcf227422014-11-18 09:50:57 -0300317 * 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.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300328 * @buf_cleanup: called once before the buffer is freed; drivers may
Hans Verkuil3f12e6b2014-02-28 12:25:28 -0300329 * perform any additional cleanup; optional.
Marek Szyprowskibd323e22011-08-29 08:51:49 -0300330 * @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
Hans Verkuil02f142e2013-12-13 13:13:42 -0300334 * can return an error if hardware fails, in that case all
335 * buffers that have been already given by the @buf_queue
Hans Verkuilccf58cb2014-07-23 03:17:06 -0300336 * callback are to be returned by the driver by calling
Hans Verkuil44e8e692014-08-04 07:12:32 -0300337 * @vb2_buffer_done(VB2_BUF_STATE_QUEUED).
Hans Verkuilccf58cb2014-07-23 03:17:06 -0300338 * 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.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300343 * @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()
Hans Verkuilccf58cb2014-07-23 03:17:06 -0300346 * 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
Pawel Osciake23ccc02010-10-11 10:56:41 -0300349 * @buf_queue: passes buffer vb to the driver; driver may start
350 * hardware operation on this buffer; driver should give
Marek Szyprowskibd323e22011-08-29 08:51:49 -0300351 * 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
Hans Verkuil3f12e6b2014-02-28 12:25:28 -0300354 * pre-queued buffers before calling STREAMON.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300355 */
356struct vb2_ops {
Hans Verkuildf9ecb02015-10-28 00:50:37 -0200357 int (*queue_setup)(struct vb2_queue *q,
Guennadi Liakhovetskifc714e72011-08-24 10:30:21 -0300358 unsigned int *num_buffers, unsigned int *num_planes,
359 unsigned int sizes[], void *alloc_ctxs[]);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300360
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);
Hans Verkuil06470642014-03-04 07:27:13 -0300366 void (*buf_finish)(struct vb2_buffer *vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300367 void (*buf_cleanup)(struct vb2_buffer *vb);
368
Marek Szyprowskibd323e22011-08-29 08:51:49 -0300369 int (*start_streaming)(struct vb2_queue *q, unsigned int count);
Hans Verkuile37559b2014-04-17 02:47:21 -0300370 void (*stop_streaming)(struct vb2_queue *q);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300371
372 void (*buf_queue)(struct vb2_buffer *vb);
373};
374
Hans Verkuil10cc3b12015-11-20 08:32:00 -0200375/**
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 */
Junghak Sungb0e0e1f2015-10-06 06:37:48 -0300386struct vb2_buf_ops {
Hans Verkuil10cc3b12015-11-20 08:32:00 -0200387 void (*fill_user_buffer)(struct vb2_buffer *vb, void *pb);
Junghak Sungb0e0e1f2015-10-06 06:37:48 -0300388 int (*fill_vb2_buffer)(struct vb2_buffer *vb, const void *pb,
389 struct vb2_plane *planes);
Hans Verkuil10cc3b12015-11-20 08:32:00 -0200390 void (*copy_timestamp)(struct vb2_buffer *vb, const void *pb);
Junghak Sungb0e0e1f2015-10-06 06:37:48 -0300391};
Hans Verkuil5a5adf62012-06-22 07:29:35 -0300392
Pawel Osciake23ccc02010-10-11 10:56:41 -0300393/**
394 * struct vb2_queue - a videobuf queue
395 *
Junghak Sungbed04f92015-10-06 06:37:47 -0300396 * @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
Pawel Osciake23ccc02010-10-11 10:56:41 -0300399 * @io_modes: supported io methods (see vb2_io_modes enum)
Kamil Debski06e7a9b62015-02-23 09:26:16 -0300400 * @fileio_read_once: report EOF after reading the first buffer
401 * @fileio_write_immediately: queue buffer after each write() call
Kamil Debskif61bf132015-02-23 09:26:17 -0300402 * @allow_zero_bytesused: allow bytesused == 0 to be passed to the driver
Hans Verkuil5a5adf62012-06-22 07:29:35 -0300403 * @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.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300412 * @ops: driver-specific callbacks
413 * @mem_ops: memory allocator specific callbacks
Junghak Sungb0e0e1f2015-10-06 06:37:48 -0300414 * @buf_ops: callbacks to deliver buffer information
415 * between user-space and kernel-space
Pawel Osciake23ccc02010-10-11 10:56:41 -0300416 * @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
Junghak Sung2d700712015-09-22 10:30:30 -0300419 * structure type. for example, sizeof(struct vb2_v4l2_buffer)
420 * will be used for v4l2.
Laurent Pinchart072f1a42014-09-11 19:43:46 -0300421 * @timestamp_flags: Timestamp flags; V4L2_BUF_FLAG_TIMESTAMP_* and
422 * V4L2_BUF_FLAG_TSTAMP_SRC_*
Hans Verkuilb6ba2052013-03-01 15:44:20 -0300423 * @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.
Hans Verkuilb3379c62014-02-24 13:51:03 -0300426 * @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.
Mauro Carvalho Chehabd78757e2015-08-22 08:57:02 -0300430 */
431/*
432 * Private elements (won't appear at the DocBook):
Hans Verkuilf035eb42014-08-07 03:47:14 -0300433 * @mmap_lock: private mutex used when buffers are allocated/freed/mmapped
Pawel Osciake23ccc02010-10-11 10:56:41 -0300434 * @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
Hans Verkuilb3379c62014-02-24 13:51:03 -0300438 * @queued_count: number of buffers queued and ready for streaming.
Hans Verkuil6ea3b982014-02-06 05:46:11 -0300439 * @owned_by_drv_count: number of buffers owned by the driver
Pawel Osciake23ccc02010-10-11 10:56:41 -0300440 * @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
Hans Verkuilb3379c62014-02-24 13:51:03 -0300445 * @start_streaming_called: start_streaming() was called successfully and we
446 * started streaming.
Laurent Pinchart4bb72672014-06-03 18:53:25 -0300447 * @error: a fatal error occurred on the queue
Hans Verkuil58d75f42014-09-20 16:16:35 -0300448 * @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.
Junghak Sungbed04f92015-10-06 06:37:47 -0300451 * @is_multiplanar: set if buffer type is multiplanar
452 * @is_output: set if buffer type is output
Junghak Sung959c3ef2015-11-03 08:16:38 -0200453 * @copy_timestamp: set if vb2-core should set timestamps
Philipp Zabelc1621842015-05-04 07:51:06 -0300454 * @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.
Marek Szyprowskib25748f2010-12-06 05:56:55 -0300457 * @fileio: file io emulator internal data, used only if emulator is active
Hans Verkuil3415a892014-04-14 07:33:00 -0300458 * @threadio: thread io internal data, used only if thread is active
Pawel Osciake23ccc02010-10-11 10:56:41 -0300459 */
460struct vb2_queue {
Junghak Sungbed04f92015-10-06 06:37:47 -0300461 unsigned int type;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300462 unsigned int io_modes;
Kamil Debski06e7a9b62015-02-23 09:26:16 -0300463 unsigned fileio_read_once:1;
464 unsigned fileio_write_immediately:1;
Kamil Debskif61bf132015-02-23 09:26:17 -0300465 unsigned allow_zero_bytesused:1;
Kamil Debski06e7a9b62015-02-23 09:26:16 -0300466
Hans Verkuil5a5adf62012-06-22 07:29:35 -0300467 struct mutex *lock;
Junghak Sungbed04f92015-10-06 06:37:47 -0300468 void *owner;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300469
470 const struct vb2_ops *ops;
471 const struct vb2_mem_ops *mem_ops;
Junghak Sungb0e0e1f2015-10-06 06:37:48 -0300472 const struct vb2_buf_ops *buf_ops;
473
Pawel Osciake23ccc02010-10-11 10:56:41 -0300474 void *drv_priv;
475 unsigned int buf_struct_size;
Sakari Ailusade48682014-02-25 19:12:19 -0300476 u32 timestamp_flags;
Hans Verkuilb6ba2052013-03-01 15:44:20 -0300477 gfp_t gfp_flags;
Hans Verkuilb3379c62014-02-24 13:51:03 -0300478 u32 min_buffers_needed;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300479
Mauro Carvalho Chehabd78757e2015-08-22 08:57:02 -0300480 /* private: internal use only */
Hans Verkuilf035eb42014-08-07 03:47:14 -0300481 struct mutex mmap_lock;
Junghak Sungbed04f92015-10-06 06:37:47 -0300482 unsigned int memory;
483 struct vb2_buffer *bufs[VB2_MAX_FRAME];
Pawel Osciake23ccc02010-10-11 10:56:41 -0300484 unsigned int num_buffers;
485
486 struct list_head queued_list;
Hans Verkuilb3379c62014-02-24 13:51:03 -0300487 unsigned int queued_count;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300488
Hans Verkuil6ea3b982014-02-06 05:46:11 -0300489 atomic_t owned_by_drv_count;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300490 struct list_head done_list;
491 spinlock_t done_lock;
492 wait_queue_head_t done_wq;
493
Junghak Sungbed04f92015-10-06 06:37:47 -0300494 void *alloc_ctx[VB2_MAX_PLANES];
Pawel Osciake23ccc02010-10-11 10:56:41 -0300495
496 unsigned int streaming:1;
Hans Verkuilb3379c62014-02-24 13:51:03 -0300497 unsigned int start_streaming_called:1;
Laurent Pinchart4bb72672014-06-03 18:53:25 -0300498 unsigned int error:1;
Hans Verkuil58d75f42014-09-20 16:16:35 -0300499 unsigned int waiting_for_buffers:1;
Junghak Sungbed04f92015-10-06 06:37:47 -0300500 unsigned int is_multiplanar:1;
501 unsigned int is_output:1;
Junghak Sung959c3ef2015-11-03 08:16:38 -0200502 unsigned int copy_timestamp:1;
Philipp Zabelc1621842015-05-04 07:51:06 -0300503 unsigned int last_buffer_dequeued:1;
Marek Szyprowskib25748f2010-12-06 05:56:55 -0300504
505 struct vb2_fileio_data *fileio;
Hans Verkuil3415a892014-04-14 07:33:00 -0300506 struct vb2_threadio_data *threadio;
Hans Verkuilb5b45412014-01-29 11:53:25 -0300507
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
Pawel Osciake23ccc02010-10-11 10:56:41 -0300519};
520
521void *vb2_plane_vaddr(struct vb2_buffer *vb, unsigned int plane_no);
522void *vb2_plane_cookie(struct vb2_buffer *vb, unsigned int plane_no);
523
524void vb2_buffer_done(struct vb2_buffer *vb, enum vb2_buffer_state state);
Laurent Pinchart34ea4d42014-03-09 21:42:52 -0300525void vb2_discard_done(struct vb2_queue *q);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300526int vb2_wait_for_all_buffers(struct vb2_queue *q);
527
Hans Verkuil10cc3b12015-11-20 08:32:00 -0200528void vb2_core_querybuf(struct vb2_queue *q, unsigned int index, void *pb);
Junghak Sung3c5be982015-10-06 06:37:49 -0300529int vb2_core_reqbufs(struct vb2_queue *q, enum vb2_memory memory,
530 unsigned int *count);
531int vb2_core_create_bufs(struct vb2_queue *q, enum vb2_memory memory,
Hans Verkuildf9ecb02015-10-28 00:50:37 -0200532 unsigned int *count, unsigned requested_planes,
533 const unsigned int requested_sizes[]);
Junghak Sung3c5be982015-10-06 06:37:49 -0300534int vb2_core_prepare_buf(struct vb2_queue *q, unsigned int index, void *pb);
535int vb2_core_qbuf(struct vb2_queue *q, unsigned int index, void *pb);
Hans Verkuilfac710e2016-01-27 10:08:42 -0200536int vb2_core_dqbuf(struct vb2_queue *q, unsigned int *pindex, void *pb,
537 bool nonblocking);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300538
Junghak Sung3c5be982015-10-06 06:37:49 -0300539int vb2_core_streamon(struct vb2_queue *q, unsigned int type);
540int vb2_core_streamoff(struct vb2_queue *q, unsigned int type);
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300541
Junghak Sung3c5be982015-10-06 06:37:49 -0300542int vb2_core_expbuf(struct vb2_queue *q, int *fd, unsigned int type,
543 unsigned int index, unsigned int plane, unsigned int flags);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300544
Junghak Sung3c5be982015-10-06 06:37:49 -0300545int vb2_core_queue_init(struct vb2_queue *q);
546void vb2_core_queue_release(struct vb2_queue *q);
547
Laurent Pinchart4bb72672014-06-03 18:53:25 -0300548void vb2_queue_error(struct vb2_queue *q);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300549
Pawel Osciake23ccc02010-10-11 10:56:41 -0300550int vb2_mmap(struct vb2_queue *q, struct vm_area_struct *vma);
Scott Jiang6f524ec2011-09-21 09:25:23 -0300551#ifndef CONFIG_MMU
552unsigned long vb2_get_unmapped_area(struct vb2_queue *q,
553 unsigned long addr,
554 unsigned long len,
555 unsigned long pgoff,
556 unsigned long flags);
557#endif
Junghak Sungaf3bac12015-11-03 08:16:42 -0200558unsigned int vb2_core_poll(struct vb2_queue *q, struct file *file,
559 poll_table *wait);
560size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count,
561 loff_t *ppos, int nonblock);
562size_t vb2_write(struct vb2_queue *q, const char __user *data, size_t count,
563 loff_t *ppos, int nonblock);
564
565/*
566 * vb2_thread_fnc - callback function for use with vb2_thread
567 *
568 * This is called whenever a buffer is dequeued in the thread.
569 */
570typedef int (*vb2_thread_fnc)(struct vb2_buffer *vb, void *priv);
571
572/**
573 * vb2_thread_start() - start a thread for the given queue.
574 * @q: videobuf queue
575 * @fnc: callback function
576 * @priv: priv pointer passed to the callback function
577 * @thread_name:the name of the thread. This will be prefixed with "vb2-".
578 *
579 * This starts a thread that will queue and dequeue until an error occurs
580 * or @vb2_thread_stop is called.
581 *
582 * This function should not be used for anything else but the videobuf2-dvb
583 * support. If you think you have another good use-case for this, then please
584 * contact the linux-media mailinglist first.
585 */
586int vb2_thread_start(struct vb2_queue *q, vb2_thread_fnc fnc, void *priv,
587 const char *thread_name);
588
589/**
590 * vb2_thread_stop() - stop the thread for the given queue.
591 * @q: videobuf queue
592 */
593int vb2_thread_stop(struct vb2_queue *q);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300594
595/**
596 * vb2_is_streaming() - return streaming status of the queue
597 * @q: videobuf queue
598 */
599static inline bool vb2_is_streaming(struct vb2_queue *q)
600{
601 return q->streaming;
602}
603
604/**
Hans Verkuil74753cffa2014-04-07 09:23:50 -0300605 * vb2_fileio_is_active() - return true if fileio is active.
606 * @q: videobuf queue
607 *
608 * This returns true if read() or write() is used to stream the data
609 * as opposed to stream I/O. This is almost never an important distinction,
610 * except in rare cases. One such case is that using read() or write() to
611 * stream a format using V4L2_FIELD_ALTERNATE is not allowed since there
612 * is no way you can pass the field information of each buffer to/from
613 * userspace. A driver that supports this field format should check for
614 * this in the queue_setup op and reject it if this function returns true.
615 */
616static inline bool vb2_fileio_is_active(struct vb2_queue *q)
617{
618 return q->fileio;
619}
620
621/**
Pawel Osciake23ccc02010-10-11 10:56:41 -0300622 * vb2_is_busy() - return busy status of the queue
623 * @q: videobuf queue
624 *
625 * This function checks if queue has any buffers allocated.
626 */
627static inline bool vb2_is_busy(struct vb2_queue *q)
628{
629 return (q->num_buffers > 0);
630}
631
632/**
633 * vb2_get_drv_priv() - return driver private data associated with the queue
634 * @q: videobuf queue
635 */
636static inline void *vb2_get_drv_priv(struct vb2_queue *q)
637{
638 return q->drv_priv;
639}
640
641/**
642 * vb2_set_plane_payload() - set bytesused for the plane plane_no
643 * @vb: buffer for which plane payload should be set
644 * @plane_no: plane number for which payload should be set
645 * @size: payload in bytes
646 */
647static inline void vb2_set_plane_payload(struct vb2_buffer *vb,
648 unsigned int plane_no, unsigned long size)
649{
650 if (plane_no < vb->num_planes)
Junghak Sung2d700712015-09-22 10:30:30 -0300651 vb->planes[plane_no].bytesused = size;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300652}
653
654/**
Laurent Pinchart9f00eda2011-02-27 14:38:19 -0300655 * vb2_get_plane_payload() - get bytesused for the plane plane_no
Pawel Osciake23ccc02010-10-11 10:56:41 -0300656 * @vb: buffer for which plane payload should be set
657 * @plane_no: plane number for which payload should be set
Pawel Osciake23ccc02010-10-11 10:56:41 -0300658 */
659static inline unsigned long vb2_get_plane_payload(struct vb2_buffer *vb,
660 unsigned int plane_no)
661{
662 if (plane_no < vb->num_planes)
Junghak Sung2d700712015-09-22 10:30:30 -0300663 return vb->planes[plane_no].bytesused;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300664 return 0;
665}
666
667/**
668 * vb2_plane_size() - return plane size in bytes
669 * @vb: buffer for which plane size should be returned
670 * @plane_no: plane number for which size should be returned
671 */
672static inline unsigned long
673vb2_plane_size(struct vb2_buffer *vb, unsigned int plane_no)
674{
675 if (plane_no < vb->num_planes)
Junghak Sung2d700712015-09-22 10:30:30 -0300676 return vb->planes[plane_no].length;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300677 return 0;
678}
679
Prabhakar Ladead13032014-09-06 12:26:49 -0300680/**
681 * vb2_start_streaming_called() - return streaming status of driver
682 * @q: videobuf queue
683 */
684static inline bool vb2_start_streaming_called(struct vb2_queue *q)
685{
686 return q->start_streaming_called;
687}
688
Philipp Zabelc1621842015-05-04 07:51:06 -0300689/**
690 * vb2_clear_last_buffer_dequeued() - clear last buffer dequeued flag of queue
691 * @q: videobuf queue
692 */
693static inline void vb2_clear_last_buffer_dequeued(struct vb2_queue *q)
694{
695 q->last_buffer_dequeued = false;
696}
697
Junghak Sungaf3bac12015-11-03 08:16:42 -0200698/*
699 * The following functions are not part of the vb2 core API, but are useful
700 * functions for videobuf2-*.
701 */
702bool vb2_buffer_in_use(struct vb2_queue *q, struct vb2_buffer *vb);
703int vb2_verify_memory_type(struct vb2_queue *q,
704 enum vb2_memory memory, unsigned int type);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300705#endif /* _MEDIA_VIDEOBUF2_CORE_H */