blob: 4f7f7aed91574e716310f9a8bd9850d516874c95 [file] [log] [blame]
Pawel Osciake23ccc02010-10-11 10:56:41 -03001/*
2 * videobuf2-core.h - V4L2 driver helper framework
3 *
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>
18#include <linux/videodev2.h>
Sumit Semwalc5384042012-06-14 10:37:37 -030019#include <linux/dma-buf.h>
Pawel Osciake23ccc02010-10-11 10:56:41 -030020
21struct vb2_alloc_ctx;
Marek Szyprowskib25748f2010-12-06 05:56:55 -030022struct vb2_fileio_data;
Hans Verkuil3415a892014-04-14 07:33:00 -030023struct vb2_threadio_data;
Pawel Osciake23ccc02010-10-11 10:56:41 -030024
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
Hans Verkuilb6ba2052013-03-01 15:44:20 -030031 * 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.
Pawel Osciake23ccc02010-10-11 10:56:41 -030034 * @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
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030038 * previously returned from the alloc callback.
Pawel Osciake23ccc02010-10-11 10:56:41 -030039 * @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
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030045 * argument to other ops in this structure.
Pawel Osciake23ccc02010-10-11 10:56:41 -030046 * @put_userptr: inform the allocator that a USERPTR buffer will no longer
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030047 * be used.
Sumit Semwalc5384042012-06-14 10:37:37 -030048 * @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;
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030052 * this needs to be used for further accesses to the buffer.
Sumit Semwalc5384042012-06-14 10:37:37 -030053 * @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
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030056 * from the attach_dmabuf callback.
Sumit Semwalc5384042012-06-14 10:37:37 -030057 * @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
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030059 * dmabuf.
Sumit Semwalc5384042012-06-14 10:37:37 -030060 * @unmap_dmabuf: releases access control to the dmabuf - allocator is notified
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030061 * that this driver is done using the dmabuf for now.
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -030062 * @prepare: called every time the buffer is passed from userspace to the
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030063 * driver, useful for cache synchronisation, optional.
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -030064 * @finish: called every time the buffer is passed back from the driver
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030065 * to the userspace, also optional.
Pawel Osciake23ccc02010-10-11 10:56:41 -030066 * @vaddr: return a kernel virtual address to a given memory buffer
67 * associated with the passed private structure or NULL if no
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030068 * such mapping exists.
Pawel Osciake23ccc02010-10-11 10:56:41 -030069 * @cookie: return allocator specific cookie for a given memory buffer
70 * associated with the passed private structure or NULL if not
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030071 * available.
Pawel Osciake23ccc02010-10-11 10:56:41 -030072 * @num_users: return the current number of users of a memory buffer;
73 * return 1 if the videobuf layer (or actually the driver using
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030074 * it) is the only user.
Pawel Osciake23ccc02010-10-11 10:56:41 -030075 * @mmap: setup a userspace mapping for a given memory buffer under
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030076 * the provided virtual memory region.
Pawel Osciake23ccc02010-10-11 10:56:41 -030077 *
78 * Required ops for USERPTR types: get_userptr, put_userptr.
79 * Required ops for MMAP types: alloc, put, num_users, mmap.
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030080 * Required ops for read/write access types: alloc, put, num_users, vaddr.
Sumit Semwalc5384042012-06-14 10:37:37 -030081 * Required ops for DMABUF types: attach_dmabuf, detach_dmabuf, map_dmabuf,
82 * unmap_dmabuf.
Pawel Osciake23ccc02010-10-11 10:56:41 -030083 */
84struct vb2_mem_ops {
Hans Verkuild935c572014-11-18 09:50:59 -030085 void *(*alloc)(void *alloc_ctx, unsigned long size,
86 enum dma_data_direction dma_dir,
87 gfp_t gfp_flags);
Pawel Osciake23ccc02010-10-11 10:56:41 -030088 void (*put)(void *buf_priv);
Philipp Zabelea3aba82013-05-21 05:11:35 -030089 struct dma_buf *(*get_dmabuf)(void *buf_priv, unsigned long flags);
Pawel Osciake23ccc02010-10-11 10:56:41 -030090
91 void *(*get_userptr)(void *alloc_ctx, unsigned long vaddr,
Hans Verkuilcd474032014-11-18 09:50:58 -030092 unsigned long size,
93 enum dma_data_direction dma_dir);
Pawel Osciake23ccc02010-10-11 10:56:41 -030094 void (*put_userptr)(void *buf_priv);
95
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -030096 void (*prepare)(void *buf_priv);
97 void (*finish)(void *buf_priv);
98
Sumit Semwalc5384042012-06-14 10:37:37 -030099 void *(*attach_dmabuf)(void *alloc_ctx, struct dma_buf *dbuf,
Hans Verkuilcd474032014-11-18 09:50:58 -0300100 unsigned long size,
101 enum dma_data_direction dma_dir);
Sumit Semwalc5384042012-06-14 10:37:37 -0300102 void (*detach_dmabuf)(void *buf_priv);
103 int (*map_dmabuf)(void *buf_priv);
104 void (*unmap_dmabuf)(void *buf_priv);
105
Pawel Osciake23ccc02010-10-11 10:56:41 -0300106 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
114struct vb2_plane {
115 void *mem_priv;
Sumit Semwalc5384042012-06-14 10:37:37 -0300116 struct dma_buf *dbuf;
117 unsigned int dbuf_mapped;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300118};
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
Sumit Semwalc5384042012-06-14 10:37:37 -0300126 * @VB2_DMABUF: driver supports DMABUF with streaming API
Pawel Osciake23ccc02010-10-11 10:56:41 -0300127 */
128enum vb2_io_modes {
129 VB2_MMAP = (1 << 0),
130 VB2_USERPTR = (1 << 1),
131 VB2_READ = (1 << 2),
132 VB2_WRITE = (1 << 3),
Sumit Semwalc5384042012-06-14 10:37:37 -0300133 VB2_DMABUF = (1 << 4),
Pawel Osciake23ccc02010-10-11 10:56:41 -0300134};
135
136/**
Pawel Osciake23ccc02010-10-11 10:56:41 -0300137 * enum vb2_buffer_state - current video buffer state
138 * @VB2_BUF_STATE_DEQUEUED: buffer under userspace control
Hans Verkuilb18a8ff2013-12-13 13:13:38 -0300139 * @VB2_BUF_STATE_PREPARING: buffer is being prepared in videobuf
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -0300140 * @VB2_BUF_STATE_PREPARED: buffer prepared in videobuf and by the driver
Pawel Osciake23ccc02010-10-11 10:56:41 -0300141 * @VB2_BUF_STATE_QUEUED: buffer queued in videobuf, but not in driver
142 * @VB2_BUF_STATE_ACTIVE: buffer queued in driver and possibly used
143 * in a hardware operation
144 * @VB2_BUF_STATE_DONE: buffer returned from driver to videobuf, but
145 * not yet dequeued to userspace
146 * @VB2_BUF_STATE_ERROR: same as above, but the operation on the buffer
147 * has ended with an error, which will be reported
148 * to the userspace when it is dequeued
149 */
150enum vb2_buffer_state {
151 VB2_BUF_STATE_DEQUEUED,
Hans Verkuilb18a8ff2013-12-13 13:13:38 -0300152 VB2_BUF_STATE_PREPARING,
Guennadi Liakhovetskiebc087d2011-08-31 06:51:10 -0300153 VB2_BUF_STATE_PREPARED,
Pawel Osciake23ccc02010-10-11 10:56:41 -0300154 VB2_BUF_STATE_QUEUED,
155 VB2_BUF_STATE_ACTIVE,
156 VB2_BUF_STATE_DONE,
157 VB2_BUF_STATE_ERROR,
158};
159
160struct vb2_queue;
161
162/**
163 * struct vb2_buffer - represents a video buffer
164 * @v4l2_buf: struct v4l2_buffer associated with this buffer; can
165 * be read by the driver and relevant entries can be
166 * changed by the driver in case of CAPTURE types
167 * (such as timestamp)
168 * @v4l2_planes: struct v4l2_planes associated with this buffer; can
169 * be read by the driver and relevant entries can be
170 * changed by the driver in case of CAPTURE types
171 * (such as bytesused); NOTE that even for single-planar
172 * types, the v4l2_planes[0] struct should be used
173 * instead of v4l2_buf for filling bytesused - drivers
174 * should use the vb2_set_plane_payload() function for that
175 * @vb2_queue: the queue to which this driver belongs
176 * @num_planes: number of planes in the buffer
177 * on an internal driver queue
178 * @state: current buffer state; do not change
179 * @queued_entry: entry on the queued buffers list, which holds all
180 * buffers queued from userspace
181 * @done_entry: entry on the list that stores all buffers ready to
182 * be dequeued to userspace
183 * @planes: private per-plane information; do not change
Pawel Osciake23ccc02010-10-11 10:56:41 -0300184 */
185struct vb2_buffer {
186 struct v4l2_buffer v4l2_buf;
187 struct v4l2_plane v4l2_planes[VIDEO_MAX_PLANES];
188
189 struct vb2_queue *vb2_queue;
190
191 unsigned int num_planes;
192
193/* Private: internal use only */
194 enum vb2_buffer_state state;
195
196 struct list_head queued_entry;
197 struct list_head done_entry;
198
199 struct vb2_plane planes[VIDEO_MAX_PLANES];
Hans Verkuilb5b45412014-01-29 11:53:25 -0300200
201#ifdef CONFIG_VIDEO_ADV_DEBUG
202 /*
203 * Counters for how often these buffer-related ops are
204 * called. Used to check for unbalanced ops.
205 */
206 u32 cnt_mem_alloc;
207 u32 cnt_mem_put;
208 u32 cnt_mem_get_dmabuf;
209 u32 cnt_mem_get_userptr;
210 u32 cnt_mem_put_userptr;
211 u32 cnt_mem_prepare;
212 u32 cnt_mem_finish;
213 u32 cnt_mem_attach_dmabuf;
214 u32 cnt_mem_detach_dmabuf;
215 u32 cnt_mem_map_dmabuf;
216 u32 cnt_mem_unmap_dmabuf;
217 u32 cnt_mem_vaddr;
218 u32 cnt_mem_cookie;
219 u32 cnt_mem_num_users;
220 u32 cnt_mem_mmap;
221
222 u32 cnt_buf_init;
223 u32 cnt_buf_prepare;
224 u32 cnt_buf_finish;
225 u32 cnt_buf_cleanup;
226 u32 cnt_buf_queue;
227
228 /* This counts the number of calls to vb2_buffer_done() */
229 u32 cnt_buf_done;
230#endif
Pawel Osciake23ccc02010-10-11 10:56:41 -0300231};
232
233/**
234 * struct vb2_ops - driver-specific callbacks
235 *
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300236 * @queue_setup: called from VIDIOC_REQBUFS and VIDIOC_CREATE_BUFS
237 * handlers before memory allocation, or, if
238 * *num_planes != 0, after the allocation to verify a
239 * smaller number of buffers. Driver should return
240 * the required number of buffers in *num_buffers, the
241 * required number of planes per buffer in *num_planes; the
242 * size of each plane should be set in the sizes[] array
243 * and optional per-plane allocator specific context in the
244 * alloc_ctxs[] array. When called from VIDIOC_REQBUFS,
245 * fmt == NULL, the driver has to use the currently
246 * configured format and *num_buffers is the total number
247 * of buffers, that are being allocated. When called from
248 * VIDIOC_CREATE_BUFS, fmt != NULL and it describes the
Laurent Pinchart5548a382013-08-01 21:44:38 -0300249 * target frame format (if the format isn't valid the
250 * callback must return -EINVAL). In this case *num_buffers
251 * are being allocated additionally to q->num_buffers.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300252 * @wait_prepare: release any locks taken while calling vb2 functions;
253 * it is called before an ioctl needs to wait for a new
254 * buffer to arrive; required to avoid a deadlock in
Hans Verkuil3f12e6b2014-02-28 12:25:28 -0300255 * blocking access type.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300256 * @wait_finish: reacquire all locks released in the previous callback;
257 * required to continue operation after sleeping while
Hans Verkuil3f12e6b2014-02-28 12:25:28 -0300258 * waiting for a new buffer to arrive.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300259 * @buf_init: called once after allocating a buffer (in MMAP case)
260 * or after acquiring a new USERPTR buffer; drivers may
261 * perform additional buffer-related initialization;
262 * initialization failure (return != 0) will prevent
Hans Verkuil3f12e6b2014-02-28 12:25:28 -0300263 * queue setup from completing successfully; optional.
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300264 * @buf_prepare: called every time the buffer is queued from userspace
265 * and from the VIDIOC_PREPARE_BUF ioctl; drivers may
Hans Verkuilcf227422014-11-18 09:50:57 -0300266 * perform any initialization required before each
267 * hardware operation in this callback; drivers can
268 * access/modify the buffer here as it is still synced for
269 * the CPU; drivers that support VIDIOC_CREATE_BUFS must
270 * also validate the buffer size; if an error is returned,
271 * the buffer will not be queued in driver; optional.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300272 * @buf_finish: called before every dequeue of the buffer back to
Hans Verkuilcf227422014-11-18 09:50:57 -0300273 * userspace; the buffer is synced for the CPU, so drivers
274 * can access/modify the buffer contents; drivers may
275 * perform any operations required before userspace
276 * accesses the buffer; optional. The buffer state can be
277 * one of the following: DONE and ERROR occur while
278 * streaming is in progress, and the PREPARED state occurs
279 * when the queue has been canceled and all pending
280 * buffers are being returned to their default DEQUEUED
281 * state. Typically you only have to do something if the
282 * state is VB2_BUF_STATE_DONE, since in all other cases
283 * the buffer contents will be ignored anyway.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300284 * @buf_cleanup: called once before the buffer is freed; drivers may
Hans Verkuil3f12e6b2014-02-28 12:25:28 -0300285 * perform any additional cleanup; optional.
Marek Szyprowskibd323e22011-08-29 08:51:49 -0300286 * @start_streaming: called once to enter 'streaming' state; the driver may
287 * receive buffers with @buf_queue callback before
288 * @start_streaming is called; the driver gets the number
289 * of already queued buffers in count parameter; driver
Hans Verkuil02f142e2013-12-13 13:13:42 -0300290 * can return an error if hardware fails, in that case all
291 * buffers that have been already given by the @buf_queue
Hans Verkuilccf58cb2014-07-23 03:17:06 -0300292 * callback are to be returned by the driver by calling
Hans Verkuil44e8e692014-08-04 07:12:32 -0300293 * @vb2_buffer_done(VB2_BUF_STATE_QUEUED).
Hans Verkuilccf58cb2014-07-23 03:17:06 -0300294 * If you need a minimum number of buffers before you can
295 * start streaming, then set @min_buffers_needed in the
296 * vb2_queue structure. If that is non-zero then
297 * start_streaming won't be called until at least that
298 * many buffers have been queued up by userspace.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300299 * @stop_streaming: called when 'streaming' state must be disabled; driver
300 * should stop any DMA transactions or wait until they
301 * finish and give back all buffers it got from buf_queue()
Hans Verkuilccf58cb2014-07-23 03:17:06 -0300302 * callback by calling @vb2_buffer_done() with either
303 * VB2_BUF_STATE_DONE or VB2_BUF_STATE_ERROR; may use
304 * vb2_wait_for_all_buffers() function
Pawel Osciake23ccc02010-10-11 10:56:41 -0300305 * @buf_queue: passes buffer vb to the driver; driver may start
306 * hardware operation on this buffer; driver should give
Marek Szyprowskibd323e22011-08-29 08:51:49 -0300307 * the buffer back by calling vb2_buffer_done() function;
308 * it is allways called after calling STREAMON ioctl;
309 * might be called before start_streaming callback if user
Hans Verkuil3f12e6b2014-02-28 12:25:28 -0300310 * pre-queued buffers before calling STREAMON.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300311 */
312struct vb2_ops {
Guennadi Liakhovetskifc714e702011-08-24 10:30:21 -0300313 int (*queue_setup)(struct vb2_queue *q, const struct v4l2_format *fmt,
314 unsigned int *num_buffers, unsigned int *num_planes,
315 unsigned int sizes[], void *alloc_ctxs[]);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300316
317 void (*wait_prepare)(struct vb2_queue *q);
318 void (*wait_finish)(struct vb2_queue *q);
319
320 int (*buf_init)(struct vb2_buffer *vb);
321 int (*buf_prepare)(struct vb2_buffer *vb);
Hans Verkuil06470642014-03-04 07:27:13 -0300322 void (*buf_finish)(struct vb2_buffer *vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300323 void (*buf_cleanup)(struct vb2_buffer *vb);
324
Marek Szyprowskibd323e22011-08-29 08:51:49 -0300325 int (*start_streaming)(struct vb2_queue *q, unsigned int count);
Hans Verkuile37559b2014-04-17 02:47:21 -0300326 void (*stop_streaming)(struct vb2_queue *q);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300327
328 void (*buf_queue)(struct vb2_buffer *vb);
329};
330
Hans Verkuil5a5adf62012-06-22 07:29:35 -0300331struct v4l2_fh;
332
Pawel Osciake23ccc02010-10-11 10:56:41 -0300333/**
334 * struct vb2_queue - a videobuf queue
335 *
336 * @type: queue type (see V4L2_BUF_TYPE_* in linux/videodev2.h
337 * @io_modes: supported io methods (see vb2_io_modes enum)
Kamil Debski06e7a9b62015-02-23 09:26:16 -0300338 * @fileio_read_once: report EOF after reading the first buffer
339 * @fileio_write_immediately: queue buffer after each write() call
Kamil Debskif61bf132015-02-23 09:26:17 -0300340 * @allow_zero_bytesused: allow bytesused == 0 to be passed to the driver
Hans Verkuil5a5adf62012-06-22 07:29:35 -0300341 * @lock: pointer to a mutex that protects the vb2_queue struct. The
342 * driver can set this to a mutex to let the v4l2 core serialize
343 * the queuing ioctls. If the driver wants to handle locking
344 * itself, then this should be set to NULL. This lock is not used
345 * by the videobuf2 core API.
346 * @owner: The filehandle that 'owns' the buffers, i.e. the filehandle
347 * that called reqbufs, create_buffers or started fileio.
348 * This field is not used by the videobuf2 core API, but it allows
349 * drivers to easily associate an owner filehandle with the queue.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300350 * @ops: driver-specific callbacks
351 * @mem_ops: memory allocator specific callbacks
352 * @drv_priv: driver private data
353 * @buf_struct_size: size of the driver-specific buffer structure;
354 * "0" indicates the driver doesn't want to use a custom buffer
355 * structure type, so sizeof(struct vb2_buffer) will is used
Laurent Pinchart072f1a42014-09-11 19:43:46 -0300356 * @timestamp_flags: Timestamp flags; V4L2_BUF_FLAG_TIMESTAMP_* and
357 * V4L2_BUF_FLAG_TSTAMP_SRC_*
Hans Verkuilb6ba2052013-03-01 15:44:20 -0300358 * @gfp_flags: additional gfp flags used when allocating the buffers.
359 * Typically this is 0, but it may be e.g. GFP_DMA or __GFP_DMA32
360 * to force the buffer allocation to a specific memory zone.
Hans Verkuilb3379c62014-02-24 13:51:03 -0300361 * @min_buffers_needed: the minimum number of buffers needed before
362 * start_streaming() can be called. Used when a DMA engine
363 * cannot be started unless at least this number of buffers
364 * have been queued into the driver.
Mauro Carvalho Chehabd78757e2015-08-22 08:57:02 -0300365 */
366/*
367 * Private elements (won't appear at the DocBook):
Hans Verkuilf035eb42014-08-07 03:47:14 -0300368 * @mmap_lock: private mutex used when buffers are allocated/freed/mmapped
Pawel Osciake23ccc02010-10-11 10:56:41 -0300369 * @memory: current memory type used
370 * @bufs: videobuf buffer structures
371 * @num_buffers: number of allocated/used buffers
372 * @queued_list: list of buffers currently queued from userspace
Hans Verkuilb3379c62014-02-24 13:51:03 -0300373 * @queued_count: number of buffers queued and ready for streaming.
Hans Verkuil6ea3b982014-02-06 05:46:11 -0300374 * @owned_by_drv_count: number of buffers owned by the driver
Pawel Osciake23ccc02010-10-11 10:56:41 -0300375 * @done_list: list of buffers ready to be dequeued to userspace
376 * @done_lock: lock to protect done_list list
377 * @done_wq: waitqueue for processes waiting for buffers ready to be dequeued
378 * @alloc_ctx: memory type/allocator-specific contexts for each plane
379 * @streaming: current streaming state
Hans Verkuilb3379c62014-02-24 13:51:03 -0300380 * @start_streaming_called: start_streaming() was called successfully and we
381 * started streaming.
Laurent Pinchart4bb72672014-06-03 18:53:25 -0300382 * @error: a fatal error occurred on the queue
Hans Verkuil58d75f42014-09-20 16:16:35 -0300383 * @waiting_for_buffers: used in poll() to check if vb2 is still waiting for
384 * buffers. Only set for capture queues if qbuf has not yet been
385 * called since poll() needs to return POLLERR in that situation.
Philipp Zabelc1621842015-05-04 07:51:06 -0300386 * @last_buffer_dequeued: used in poll() and DQBUF to immediately return if the
387 * last decoded buffer was already dequeued. Set for capture queues
388 * when a buffer with the V4L2_BUF_FLAG_LAST is dequeued.
Marek Szyprowskib25748f2010-12-06 05:56:55 -0300389 * @fileio: file io emulator internal data, used only if emulator is active
Hans Verkuil3415a892014-04-14 07:33:00 -0300390 * @threadio: thread io internal data, used only if thread is active
Pawel Osciake23ccc02010-10-11 10:56:41 -0300391 */
392struct vb2_queue {
393 enum v4l2_buf_type type;
394 unsigned int io_modes;
Kamil Debski06e7a9b62015-02-23 09:26:16 -0300395 unsigned fileio_read_once:1;
396 unsigned fileio_write_immediately:1;
Kamil Debskif61bf132015-02-23 09:26:17 -0300397 unsigned allow_zero_bytesused:1;
Kamil Debski06e7a9b62015-02-23 09:26:16 -0300398
Hans Verkuil5a5adf62012-06-22 07:29:35 -0300399 struct mutex *lock;
400 struct v4l2_fh *owner;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300401
402 const struct vb2_ops *ops;
403 const struct vb2_mem_ops *mem_ops;
404 void *drv_priv;
405 unsigned int buf_struct_size;
Sakari Ailusade48682014-02-25 19:12:19 -0300406 u32 timestamp_flags;
Hans Verkuilb6ba2052013-03-01 15:44:20 -0300407 gfp_t gfp_flags;
Hans Verkuilb3379c62014-02-24 13:51:03 -0300408 u32 min_buffers_needed;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300409
Mauro Carvalho Chehabd78757e2015-08-22 08:57:02 -0300410 /* private: internal use only */
Hans Verkuilf035eb42014-08-07 03:47:14 -0300411 struct mutex mmap_lock;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300412 enum v4l2_memory memory;
413 struct vb2_buffer *bufs[VIDEO_MAX_FRAME];
414 unsigned int num_buffers;
415
416 struct list_head queued_list;
Hans Verkuilb3379c62014-02-24 13:51:03 -0300417 unsigned int queued_count;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300418
Hans Verkuil6ea3b982014-02-06 05:46:11 -0300419 atomic_t owned_by_drv_count;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300420 struct list_head done_list;
421 spinlock_t done_lock;
422 wait_queue_head_t done_wq;
423
424 void *alloc_ctx[VIDEO_MAX_PLANES];
Marek Szyprowski035aa142011-08-24 06:43:36 -0300425 unsigned int plane_sizes[VIDEO_MAX_PLANES];
Pawel Osciake23ccc02010-10-11 10:56:41 -0300426
427 unsigned int streaming:1;
Hans Verkuilb3379c62014-02-24 13:51:03 -0300428 unsigned int start_streaming_called:1;
Laurent Pinchart4bb72672014-06-03 18:53:25 -0300429 unsigned int error:1;
Hans Verkuil58d75f42014-09-20 16:16:35 -0300430 unsigned int waiting_for_buffers:1;
Philipp Zabelc1621842015-05-04 07:51:06 -0300431 unsigned int last_buffer_dequeued:1;
Marek Szyprowskib25748f2010-12-06 05:56:55 -0300432
433 struct vb2_fileio_data *fileio;
Hans Verkuil3415a892014-04-14 07:33:00 -0300434 struct vb2_threadio_data *threadio;
Hans Verkuilb5b45412014-01-29 11:53:25 -0300435
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
Pawel Osciake23ccc02010-10-11 10:56:41 -0300447};
448
449void *vb2_plane_vaddr(struct vb2_buffer *vb, unsigned int plane_no);
450void *vb2_plane_cookie(struct vb2_buffer *vb, unsigned int plane_no);
451
452void vb2_buffer_done(struct vb2_buffer *vb, enum vb2_buffer_state state);
Laurent Pinchart34ea4d42014-03-09 21:42:52 -0300453void vb2_discard_done(struct vb2_queue *q);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300454int vb2_wait_for_all_buffers(struct vb2_queue *q);
455
456int vb2_querybuf(struct vb2_queue *q, struct v4l2_buffer *b);
457int vb2_reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req);
458
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300459int vb2_create_bufs(struct vb2_queue *q, struct v4l2_create_buffers *create);
460int vb2_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b);
461
Ezequiel Garcia896f38f2012-09-17 14:59:30 -0300462int __must_check vb2_queue_init(struct vb2_queue *q);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300463
464void vb2_queue_release(struct vb2_queue *q);
Laurent Pinchart4bb72672014-06-03 18:53:25 -0300465void vb2_queue_error(struct vb2_queue *q);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300466
467int vb2_qbuf(struct vb2_queue *q, struct v4l2_buffer *b);
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -0300468int vb2_expbuf(struct vb2_queue *q, struct v4l2_exportbuffer *eb);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300469int vb2_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking);
470
471int vb2_streamon(struct vb2_queue *q, enum v4l2_buf_type type);
472int vb2_streamoff(struct vb2_queue *q, enum v4l2_buf_type type);
473
474int vb2_mmap(struct vb2_queue *q, struct vm_area_struct *vma);
Scott Jiang6f524ec2011-09-21 09:25:23 -0300475#ifndef CONFIG_MMU
476unsigned 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
Pawel Osciake23ccc02010-10-11 10:56:41 -0300482unsigned int vb2_poll(struct vb2_queue *q, struct file *file, poll_table *wait);
Marek Szyprowskib25748f2010-12-06 05:56:55 -0300483size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count,
484 loff_t *ppos, int nonblock);
Ricardo Ribalda819585b2013-08-28 04:39:29 -0300485size_t vb2_write(struct vb2_queue *q, const char __user *data, size_t count,
Marek Szyprowskib25748f2010-12-06 05:56:55 -0300486 loff_t *ppos, int nonblock);
Mauro Carvalho Chehabd78757e2015-08-22 08:57:02 -0300487
488/*
Hans Verkuil3415a892014-04-14 07:33:00 -0300489 * vb2_thread_fnc - callback function for use with vb2_thread
490 *
491 * This is called whenever a buffer is dequeued in the thread.
492 */
493typedef int (*vb2_thread_fnc)(struct vb2_buffer *vb, void *priv);
494
495/**
496 * vb2_thread_start() - start a thread for the given queue.
497 * @q: videobuf queue
498 * @fnc: callback function
499 * @priv: priv pointer passed to the callback function
500 * @thread_name:the name of the thread. This will be prefixed with "vb2-".
501 *
502 * This starts a thread that will queue and dequeue until an error occurs
503 * or @vb2_thread_stop is called.
504 *
505 * This function should not be used for anything else but the videobuf2-dvb
506 * support. If you think you have another good use-case for this, then please
507 * contact the linux-media mailinglist first.
508 */
509int vb2_thread_start(struct vb2_queue *q, vb2_thread_fnc fnc, void *priv,
510 const char *thread_name);
511
512/**
513 * vb2_thread_stop() - stop the thread for the given queue.
514 * @q: videobuf queue
515 */
516int vb2_thread_stop(struct vb2_queue *q);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300517
518/**
519 * vb2_is_streaming() - return streaming status of the queue
520 * @q: videobuf queue
521 */
522static inline bool vb2_is_streaming(struct vb2_queue *q)
523{
524 return q->streaming;
525}
526
527/**
Hans Verkuil74753cf2014-04-07 09:23:50 -0300528 * vb2_fileio_is_active() - return true if fileio is active.
529 * @q: videobuf queue
530 *
531 * This returns true if read() or write() is used to stream the data
532 * as opposed to stream I/O. This is almost never an important distinction,
533 * except in rare cases. One such case is that using read() or write() to
534 * stream a format using V4L2_FIELD_ALTERNATE is not allowed since there
535 * is no way you can pass the field information of each buffer to/from
536 * userspace. A driver that supports this field format should check for
537 * this in the queue_setup op and reject it if this function returns true.
538 */
539static inline bool vb2_fileio_is_active(struct vb2_queue *q)
540{
541 return q->fileio;
542}
543
544/**
Pawel Osciake23ccc02010-10-11 10:56:41 -0300545 * vb2_is_busy() - return busy status of the queue
546 * @q: videobuf queue
547 *
548 * This function checks if queue has any buffers allocated.
549 */
550static inline bool vb2_is_busy(struct vb2_queue *q)
551{
552 return (q->num_buffers > 0);
553}
554
555/**
556 * vb2_get_drv_priv() - return driver private data associated with the queue
557 * @q: videobuf queue
558 */
559static inline void *vb2_get_drv_priv(struct vb2_queue *q)
560{
561 return q->drv_priv;
562}
563
564/**
565 * vb2_set_plane_payload() - set bytesused for the plane plane_no
566 * @vb: buffer for which plane payload should be set
567 * @plane_no: plane number for which payload should be set
568 * @size: payload in bytes
569 */
570static inline void vb2_set_plane_payload(struct vb2_buffer *vb,
571 unsigned int plane_no, unsigned long size)
572{
573 if (plane_no < vb->num_planes)
574 vb->v4l2_planes[plane_no].bytesused = size;
575}
576
577/**
Laurent Pinchart9f00eda2011-02-27 14:38:19 -0300578 * vb2_get_plane_payload() - get bytesused for the plane plane_no
Pawel Osciake23ccc02010-10-11 10:56:41 -0300579 * @vb: buffer for which plane payload should be set
580 * @plane_no: plane number for which payload should be set
Pawel Osciake23ccc02010-10-11 10:56:41 -0300581 */
582static 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 */
595static inline unsigned long
596vb2_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
Prabhakar Ladead13032014-09-06 12:26:49 -0300603/**
604 * vb2_start_streaming_called() - return streaming status of driver
605 * @q: videobuf queue
606 */
607static inline bool vb2_start_streaming_called(struct vb2_queue *q)
608{
609 return q->start_streaming_called;
610}
611
Philipp Zabelc1621842015-05-04 07:51:06 -0300612/**
613 * vb2_clear_last_buffer_dequeued() - clear last buffer dequeued flag of queue
614 * @q: videobuf queue
615 */
616static inline void vb2_clear_last_buffer_dequeued(struct vb2_queue *q)
617{
618 q->last_buffer_dequeued = false;
619}
620
Hans Verkuil4c1ffca2012-07-02 05:59:18 -0300621/*
622 * The following functions are not part of the vb2 core API, but are simple
623 * helper functions that you can use in your struct v4l2_file_operations,
624 * struct v4l2_ioctl_ops and struct vb2_ops. They will serialize if vb2_queue->lock
625 * or video_device->lock is set, and they will set and test vb2_queue->owner
626 * to check if the calling filehandle is permitted to do the queuing operation.
627 */
628
629/* struct v4l2_ioctl_ops helpers */
630
631int vb2_ioctl_reqbufs(struct file *file, void *priv,
632 struct v4l2_requestbuffers *p);
633int vb2_ioctl_create_bufs(struct file *file, void *priv,
634 struct v4l2_create_buffers *p);
635int vb2_ioctl_prepare_buf(struct file *file, void *priv,
636 struct v4l2_buffer *p);
637int vb2_ioctl_querybuf(struct file *file, void *priv, struct v4l2_buffer *p);
638int vb2_ioctl_qbuf(struct file *file, void *priv, struct v4l2_buffer *p);
639int vb2_ioctl_dqbuf(struct file *file, void *priv, struct v4l2_buffer *p);
640int vb2_ioctl_streamon(struct file *file, void *priv, enum v4l2_buf_type i);
641int vb2_ioctl_streamoff(struct file *file, void *priv, enum v4l2_buf_type i);
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -0300642int vb2_ioctl_expbuf(struct file *file, void *priv,
643 struct v4l2_exportbuffer *p);
Hans Verkuil4c1ffca2012-07-02 05:59:18 -0300644
645/* struct v4l2_file_operations helpers */
646
647int vb2_fop_mmap(struct file *file, struct vm_area_struct *vma);
648int vb2_fop_release(struct file *file);
Ricardo Ribalda1380f572013-11-25 05:49:02 -0300649int _vb2_fop_release(struct file *file, struct mutex *lock);
Ricardo Ribalda819585b2013-08-28 04:39:29 -0300650ssize_t vb2_fop_write(struct file *file, const char __user *buf,
Hans Verkuil4c1ffca2012-07-02 05:59:18 -0300651 size_t count, loff_t *ppos);
652ssize_t vb2_fop_read(struct file *file, char __user *buf,
653 size_t count, loff_t *ppos);
654unsigned int vb2_fop_poll(struct file *file, poll_table *wait);
655#ifndef CONFIG_MMU
656unsigned long vb2_fop_get_unmapped_area(struct file *file, unsigned long addr,
657 unsigned long len, unsigned long pgoff, unsigned long flags);
658#endif
659
660/* struct vb2_ops helpers, only use if vq->lock is non-NULL. */
661
662void vb2_ops_wait_prepare(struct vb2_queue *vq);
663void vb2_ops_wait_finish(struct vb2_queue *vq);
664
Pawel Osciake23ccc02010-10-11 10:56:41 -0300665#endif /* _MEDIA_VIDEOBUF2_CORE_H */