blob: e86981d615ae4930968cb22b0c85c28f38dfb74f [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>
Mauro Carvalho Chehab37bc2d82017-10-06 12:20:52 -040019#include <linux/bitops.h>
Hans Verkuil1cf96dc2018-05-21 04:54:46 -040020#include <media/media-request.h>
Pawel Osciake23ccc02010-10-11 10:56:41 -030021
Junghak Sungbed04f92015-10-06 06:37:47 -030022#define VB2_MAX_FRAME (32)
23#define VB2_MAX_PLANES (8)
24
Mauro Carvalho Chehab52839f62016-09-08 14:08:00 -030025/**
26 * enum vb2_memory - type of memory model used to make the buffers visible
27 * on userspace.
28 *
29 * @VB2_MEMORY_UNKNOWN: Buffer status is unknown or it is not used yet on
30 * userspace.
31 * @VB2_MEMORY_MMAP: The buffers are allocated by the Kernel and it is
32 * memory mapped via mmap() ioctl. This model is
33 * also used when the user is using the buffers via
34 * read() or write() system calls.
35 * @VB2_MEMORY_USERPTR: The buffers was allocated in userspace and it is
36 * memory mapped via mmap() ioctl.
37 * @VB2_MEMORY_DMABUF: The buffers are passed to userspace via DMA buffer.
38 */
Junghak Sungbed04f92015-10-06 06:37:47 -030039enum vb2_memory {
40 VB2_MEMORY_UNKNOWN = 0,
41 VB2_MEMORY_MMAP = 1,
42 VB2_MEMORY_USERPTR = 2,
43 VB2_MEMORY_DMABUF = 4,
44};
45
Marek Szyprowskib25748f2010-12-06 05:56:55 -030046struct vb2_fileio_data;
Hans Verkuil3415a892014-04-14 07:33:00 -030047struct vb2_threadio_data;
Pawel Osciake23ccc02010-10-11 10:56:41 -030048
49/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -040050 * struct vb2_mem_ops - memory handling/memory allocator operations.
Pawel Osciake23ccc02010-10-11 10:56:41 -030051 * @alloc: allocate video memory and, optionally, allocator private data,
Hans Verkuil0ff657b2016-07-21 09:14:02 -030052 * return ERR_PTR() on failure or a pointer to allocator private,
Pawel Osciake23ccc02010-10-11 10:56:41 -030053 * per-buffer data on success; the returned private structure
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -030054 * will then be passed as @buf_priv argument to other ops in this
Hans Verkuilb6ba2052013-03-01 15:44:20 -030055 * structure. Additional gfp_flags to use when allocating the
56 * are also passed to this operation. These flags are from the
57 * gfp_flags field of vb2_queue.
Pawel Osciake23ccc02010-10-11 10:56:41 -030058 * @put: inform the allocator that the buffer will no longer be used;
59 * usually will result in the allocator freeing the buffer (if
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -030060 * no other users of this buffer are present); the @buf_priv
Pawel Osciake23ccc02010-10-11 10:56:41 -030061 * argument is the allocator private per-buffer structure
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030062 * previously returned from the alloc callback.
Mauro Carvalho Chehab32d81b42015-10-01 13:59:29 -030063 * @get_dmabuf: acquire userspace memory for a hardware operation; used for
64 * DMABUF memory types.
Pawel Osciake23ccc02010-10-11 10:56:41 -030065 * @get_userptr: acquire userspace memory for a hardware operation; used for
66 * USERPTR memory types; vaddr is the address passed to the
67 * videobuf layer when queuing a video buffer of USERPTR type;
68 * should return an allocator private per-buffer structure
Hans Verkuil0ff657b2016-07-21 09:14:02 -030069 * associated with the buffer on success, ERR_PTR() on failure;
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -030070 * the returned private structure will then be passed as @buf_priv
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030071 * argument to other ops in this structure.
Pawel Osciake23ccc02010-10-11 10:56:41 -030072 * @put_userptr: inform the allocator that a USERPTR buffer will no longer
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030073 * be used.
Mauro Carvalho Chehab60e79262017-09-27 15:49:45 -040074 * @attach_dmabuf: attach a shared &struct dma_buf for a hardware operation;
Hans Verkuil36c0f8b2016-04-15 09:15:05 -030075 * used for DMABUF memory types; dev is the alloc device
Hans Verkuil0ff657b2016-07-21 09:14:02 -030076 * dbuf is the shared dma_buf; returns ERR_PTR() on failure;
Sumit Semwalc5384042012-06-14 10:37:37 -030077 * allocator private per-buffer structure on success;
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030078 * this needs to be used for further accesses to the buffer.
Sumit Semwalc5384042012-06-14 10:37:37 -030079 * @detach_dmabuf: inform the exporter of the buffer that the current DMABUF
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -030080 * buffer is no longer used; the @buf_priv argument is the
Sumit Semwalc5384042012-06-14 10:37:37 -030081 * allocator private per-buffer structure previously returned
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030082 * from the attach_dmabuf callback.
Sumit Semwalc5384042012-06-14 10:37:37 -030083 * @map_dmabuf: request for access to the dmabuf from allocator; the allocator
84 * of dmabuf is informed that this driver is going to use the
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030085 * dmabuf.
Sumit Semwalc5384042012-06-14 10:37:37 -030086 * @unmap_dmabuf: releases access control to the dmabuf - allocator is notified
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030087 * that this driver is done using the dmabuf for now.
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -030088 * @prepare: called every time the buffer is passed from userspace to the
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030089 * driver, useful for cache synchronisation, optional.
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -030090 * @finish: called every time the buffer is passed back from the driver
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030091 * to the userspace, also optional.
Pawel Osciake23ccc02010-10-11 10:56:41 -030092 * @vaddr: return a kernel virtual address to a given memory buffer
93 * associated with the passed private structure or NULL if no
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030094 * such mapping exists.
Pawel Osciake23ccc02010-10-11 10:56:41 -030095 * @cookie: return allocator specific cookie for a given memory buffer
96 * associated with the passed private structure or NULL if not
Hans Verkuil3f12e6b2014-02-28 12:25:28 -030097 * available.
Pawel Osciake23ccc02010-10-11 10:56:41 -030098 * @num_users: return the current number of users of a memory buffer;
99 * return 1 if the videobuf layer (or actually the driver using
Hans Verkuil3f12e6b2014-02-28 12:25:28 -0300100 * it) is the only user.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300101 * @mmap: setup a userspace mapping for a given memory buffer under
Hans Verkuil3f12e6b2014-02-28 12:25:28 -0300102 * the provided virtual memory region.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300103 *
Mauro Carvalho Chehab89cb3dd2016-07-17 08:44:08 -0300104 * Those operations are used by the videobuf2 core to implement the memory
105 * handling/memory allocators for each type of supported streaming I/O method.
106 *
107 * .. note::
108 * #) Required ops for USERPTR types: get_userptr, put_userptr.
109 *
110 * #) Required ops for MMAP types: alloc, put, num_users, mmap.
111 *
112 * #) Required ops for read/write access types: alloc, put, num_users, vaddr.
113 *
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300114 * #) Required ops for DMABUF types: attach_dmabuf, detach_dmabuf,
115 * map_dmabuf, unmap_dmabuf.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300116 */
117struct vb2_mem_ops {
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700118 void *(*alloc)(struct device *dev, unsigned long attrs,
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300119 unsigned long size,
120 enum dma_data_direction dma_dir,
Hans Verkuild935c572014-11-18 09:50:59 -0300121 gfp_t gfp_flags);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300122 void (*put)(void *buf_priv);
Philipp Zabelea3aba82013-05-21 05:11:35 -0300123 struct dma_buf *(*get_dmabuf)(void *buf_priv, unsigned long flags);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300124
Hans Verkuil36c0f8b2016-04-15 09:15:05 -0300125 void *(*get_userptr)(struct device *dev, unsigned long vaddr,
Hans Verkuilcd474032014-11-18 09:50:58 -0300126 unsigned long size,
127 enum dma_data_direction dma_dir);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300128 void (*put_userptr)(void *buf_priv);
129
Marek Szyprowski3e0c2f22012-06-14 10:37:43 -0300130 void (*prepare)(void *buf_priv);
131 void (*finish)(void *buf_priv);
132
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300133 void *(*attach_dmabuf)(struct device *dev,
134 struct dma_buf *dbuf,
Hans Verkuilcd474032014-11-18 09:50:58 -0300135 unsigned long size,
136 enum dma_data_direction dma_dir);
Sumit Semwalc5384042012-06-14 10:37:37 -0300137 void (*detach_dmabuf)(void *buf_priv);
138 int (*map_dmabuf)(void *buf_priv);
139 void (*unmap_dmabuf)(void *buf_priv);
140
Pawel Osciake23ccc02010-10-11 10:56:41 -0300141 void *(*vaddr)(void *buf_priv);
142 void *(*cookie)(void *buf_priv);
143
144 unsigned int (*num_users)(void *buf_priv);
145
146 int (*mmap)(void *buf_priv, struct vm_area_struct *vma);
147};
148
Junghak Sung2d700712015-09-22 10:30:30 -0300149/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400150 * struct vb2_plane - plane information.
151 * @mem_priv: private data with this plane.
152 * @dbuf: dma_buf - shared buffer object.
Junghak Sung2d700712015-09-22 10:30:30 -0300153 * @dbuf_mapped: flag to show whether dbuf is mapped or not
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400154 * @bytesused: number of bytes occupied by data in the plane (payload).
155 * @length: size of this plane (NOT the payload) in bytes.
Hans Verkuil58e1ba32015-11-20 09:40:14 -0200156 * @min_length: minimum required size of this plane (NOT the payload) in bytes.
157 * @length is always greater or equal to @min_length.
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400158 * @m: Union with memtype-specific data.
Mauro Carvalho Chehab60e79262017-09-27 15:49:45 -0400159 * @m.offset: when memory in the associated struct vb2_buffer is
160 * %VB2_MEMORY_MMAP, equals the offset from the start of
Junghak Sung2d700712015-09-22 10:30:30 -0300161 * the device memory for this plane (or is a "cookie" that
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400162 * should be passed to mmap() called on the video node).
Mauro Carvalho Chehab60e79262017-09-27 15:49:45 -0400163 * @m.userptr: when memory is %VB2_MEMORY_USERPTR, a userspace pointer
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400164 * pointing to this plane.
Mauro Carvalho Chehab60e79262017-09-27 15:49:45 -0400165 * @m.fd: when memory is %VB2_MEMORY_DMABUF, a userspace file
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400166 * descriptor associated with this plane.
Junghak Sung2d700712015-09-22 10:30:30 -0300167 * @data_offset: offset in the plane to the start of data; usually 0,
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400168 * unless there is a header in front of the data.
169 *
Junghak Sung2d700712015-09-22 10:30:30 -0300170 * Should contain enough information to be able to cover all the fields
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400171 * of &struct v4l2_plane at videodev2.h.
Junghak Sung2d700712015-09-22 10:30:30 -0300172 */
Pawel Osciake23ccc02010-10-11 10:56:41 -0300173struct vb2_plane {
174 void *mem_priv;
Sumit Semwalc5384042012-06-14 10:37:37 -0300175 struct dma_buf *dbuf;
176 unsigned int dbuf_mapped;
Junghak Sung2d700712015-09-22 10:30:30 -0300177 unsigned int bytesused;
178 unsigned int length;
Hans Verkuil58e1ba32015-11-20 09:40:14 -0200179 unsigned int min_length;
Junghak Sung2d700712015-09-22 10:30:30 -0300180 union {
181 unsigned int offset;
182 unsigned long userptr;
183 int fd;
184 } m;
185 unsigned int data_offset;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300186};
187
188/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400189 * enum vb2_io_modes - queue access methods.
190 * @VB2_MMAP: driver supports MMAP with streaming API.
191 * @VB2_USERPTR: driver supports USERPTR with streaming API.
192 * @VB2_READ: driver supports read() style access.
193 * @VB2_WRITE: driver supports write() style access.
194 * @VB2_DMABUF: driver supports DMABUF with streaming API.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300195 */
196enum vb2_io_modes {
Mauro Carvalho Chehab37bc2d82017-10-06 12:20:52 -0400197 VB2_MMAP = BIT(0),
198 VB2_USERPTR = BIT(1),
199 VB2_READ = BIT(2),
200 VB2_WRITE = BIT(3),
201 VB2_DMABUF = BIT(4),
Pawel Osciake23ccc02010-10-11 10:56:41 -0300202};
203
204/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400205 * enum vb2_buffer_state - current video buffer state.
206 * @VB2_BUF_STATE_DEQUEUED: buffer under userspace control.
Hans Verkuilfd89e0b2018-05-21 04:54:47 -0400207 * @VB2_BUF_STATE_IN_REQUEST: buffer is queued in media request.
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400208 * @VB2_BUF_STATE_PREPARING: buffer is being prepared in videobuf.
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400209 * @VB2_BUF_STATE_QUEUED: buffer queued in videobuf, but not in driver.
210 * @VB2_BUF_STATE_REQUEUEING: re-queue a buffer to the driver.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300211 * @VB2_BUF_STATE_ACTIVE: buffer queued in driver and possibly used
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400212 * in a hardware operation.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300213 * @VB2_BUF_STATE_DONE: buffer returned from driver to videobuf, but
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400214 * not yet dequeued to userspace.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300215 * @VB2_BUF_STATE_ERROR: same as above, but the operation on the buffer
216 * has ended with an error, which will be reported
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400217 * to the userspace when it is dequeued.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300218 */
219enum vb2_buffer_state {
220 VB2_BUF_STATE_DEQUEUED,
Hans Verkuilfd89e0b2018-05-21 04:54:47 -0400221 VB2_BUF_STATE_IN_REQUEST,
Hans Verkuilb18a8ff2013-12-13 13:13:38 -0300222 VB2_BUF_STATE_PREPARING,
Pawel Osciake23ccc02010-10-11 10:56:41 -0300223 VB2_BUF_STATE_QUEUED,
Sakari Ailus6d058c52015-07-03 04:37:07 -0300224 VB2_BUF_STATE_REQUEUEING,
Pawel Osciake23ccc02010-10-11 10:56:41 -0300225 VB2_BUF_STATE_ACTIVE,
226 VB2_BUF_STATE_DONE,
227 VB2_BUF_STATE_ERROR,
228};
229
230struct vb2_queue;
231
232/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400233 * struct vb2_buffer - represents a video buffer.
234 * @vb2_queue: pointer to &struct vb2_queue with the queue to
235 * which this driver belongs.
236 * @index: id number of the buffer.
237 * @type: buffer type.
238 * @memory: the method, in which the actual data is passed.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300239 * @num_planes: number of planes in the buffer
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400240 * on an internal driver queue.
241 * @timestamp: frame timestamp in ns.
Hans Verkuil1cf96dc2018-05-21 04:54:46 -0400242 * @req_obj: used to bind this buffer to a request. This
243 * request object has a refcount.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300244 */
245struct vb2_buffer {
Pawel Osciake23ccc02010-10-11 10:56:41 -0300246 struct vb2_queue *vb2_queue;
Junghak Sung2d700712015-09-22 10:30:30 -0300247 unsigned int index;
248 unsigned int type;
249 unsigned int memory;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300250 unsigned int num_planes;
Junghak Sungd6dd6452015-11-03 08:16:37 -0200251 u64 timestamp;
Hans Verkuil1cf96dc2018-05-21 04:54:46 -0400252 struct media_request_object req_obj;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300253
Mauro Carvalho Chehabefe98012015-10-05 09:12:56 -0300254 /* private: internal use only
255 *
256 * state: current buffer state; do not change
Hans Verkuil55028692018-06-03 05:02:27 -0400257 * synced: this buffer has been synced for DMA, i.e. the
258 * 'prepare' memop was called. It is cleared again
259 * after the 'finish' memop is called.
260 * prepared: this buffer has been prepared, i.e. the
261 * buf_prepare op was called. It is cleared again
262 * after the 'buf_finish' op is called.
Mauro Carvalho Chehabefe98012015-10-05 09:12:56 -0300263 * queued_entry: entry on the queued buffers list, which holds
264 * all buffers queued from userspace
265 * done_entry: entry on the list that stores all buffers ready
266 * to be dequeued to userspace
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400267 * vb2_plane: per-plane information; do not change
Mauro Carvalho Chehabefe98012015-10-05 09:12:56 -0300268 */
Pawel Osciake23ccc02010-10-11 10:56:41 -0300269 enum vb2_buffer_state state;
Hans Verkuil55028692018-06-03 05:02:27 -0400270 bool synced;
271 bool prepared;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300272
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400273 struct vb2_plane planes[VB2_MAX_PLANES];
Pawel Osciake23ccc02010-10-11 10:56:41 -0300274 struct list_head queued_entry;
275 struct list_head done_entry;
Hans Verkuilb5b45412014-01-29 11:53:25 -0300276#ifdef CONFIG_VIDEO_ADV_DEBUG
277 /*
278 * Counters for how often these buffer-related ops are
279 * called. Used to check for unbalanced ops.
280 */
281 u32 cnt_mem_alloc;
282 u32 cnt_mem_put;
283 u32 cnt_mem_get_dmabuf;
284 u32 cnt_mem_get_userptr;
285 u32 cnt_mem_put_userptr;
286 u32 cnt_mem_prepare;
287 u32 cnt_mem_finish;
288 u32 cnt_mem_attach_dmabuf;
289 u32 cnt_mem_detach_dmabuf;
290 u32 cnt_mem_map_dmabuf;
291 u32 cnt_mem_unmap_dmabuf;
292 u32 cnt_mem_vaddr;
293 u32 cnt_mem_cookie;
294 u32 cnt_mem_num_users;
295 u32 cnt_mem_mmap;
296
297 u32 cnt_buf_init;
298 u32 cnt_buf_prepare;
299 u32 cnt_buf_finish;
300 u32 cnt_buf_cleanup;
301 u32 cnt_buf_queue;
Hans Verkuilfd89e0b2018-05-21 04:54:47 -0400302 u32 cnt_buf_request_complete;
Hans Verkuilb5b45412014-01-29 11:53:25 -0300303
304 /* This counts the number of calls to vb2_buffer_done() */
305 u32 cnt_buf_done;
306#endif
Pawel Osciake23ccc02010-10-11 10:56:41 -0300307};
308
309/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400310 * struct vb2_ops - driver-specific callbacks.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300311 *
Luca Ceresoli3f97df92018-03-08 07:26:22 -0500312 * These operations are not called from interrupt context except where
313 * mentioned specifically.
314 *
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300315 * @queue_setup: called from VIDIOC_REQBUFS() and VIDIOC_CREATE_BUFS()
Hans Verkuildf9ecb0c2015-10-28 00:50:37 -0200316 * handlers before memory allocation. It can be called
317 * twice: if the original number of requested buffers
318 * could not be allocated, then it will be called a
319 * second time with the actually allocated number of
320 * buffers to verify if that is OK.
321 * The driver should return the required number of buffers
Mauro Carvalho Chehab89cb3dd2016-07-17 08:44:08 -0300322 * in \*num_buffers, the required number of planes per
323 * buffer in \*num_planes, the size of each plane should be
Mauro Carvalho Chehab564aaf62016-07-23 07:12:03 -0300324 * set in the sizes\[\] array and optional per-plane
325 * allocator specific device in the alloc_devs\[\] array.
Anton Leontieve5c27ef32017-03-23 18:09:35 -0300326 * When called from VIDIOC_REQBUFS(), \*num_planes == 0,
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300327 * the driver has to use the currently configured format to
Mauro Carvalho Chehab89cb3dd2016-07-17 08:44:08 -0300328 * determine the plane sizes and \*num_buffers is the total
Hans Verkuildf9ecb0c2015-10-28 00:50:37 -0200329 * number of buffers that are being allocated. When called
Anton Leontieve5c27ef32017-03-23 18:09:35 -0300330 * from VIDIOC_CREATE_BUFS(), \*num_planes != 0 and it
Mauro Carvalho Chehab564aaf62016-07-23 07:12:03 -0300331 * describes the requested number of planes and sizes\[\]
Anton Leontieve5c27ef32017-03-23 18:09:35 -0300332 * contains the requested plane sizes. In this case
333 * \*num_buffers are being allocated additionally to
334 * q->num_buffers. If either \*num_planes or the requested
335 * sizes are invalid callback must return %-EINVAL.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300336 * @wait_prepare: release any locks taken while calling vb2 functions;
337 * it is called before an ioctl needs to wait for a new
338 * buffer to arrive; required to avoid a deadlock in
Hans Verkuil3f12e6b2014-02-28 12:25:28 -0300339 * blocking access type.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300340 * @wait_finish: reacquire all locks released in the previous callback;
341 * required to continue operation after sleeping while
Hans Verkuil3f12e6b2014-02-28 12:25:28 -0300342 * waiting for a new buffer to arrive.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300343 * @buf_init: called once after allocating a buffer (in MMAP case)
344 * or after acquiring a new USERPTR buffer; drivers may
345 * perform additional buffer-related initialization;
346 * initialization failure (return != 0) will prevent
Hans Verkuil3f12e6b2014-02-28 12:25:28 -0300347 * queue setup from completing successfully; optional.
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300348 * @buf_prepare: called every time the buffer is queued from userspace
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300349 * and from the VIDIOC_PREPARE_BUF() ioctl; drivers may
Hans Verkuilcf227422014-11-18 09:50:57 -0300350 * perform any initialization required before each
351 * hardware operation in this callback; drivers can
352 * access/modify the buffer here as it is still synced for
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300353 * the CPU; drivers that support VIDIOC_CREATE_BUFS() must
Hans Verkuilcf227422014-11-18 09:50:57 -0300354 * also validate the buffer size; if an error is returned,
355 * the buffer will not be queued in driver; optional.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300356 * @buf_finish: called before every dequeue of the buffer back to
Hans Verkuilcf227422014-11-18 09:50:57 -0300357 * userspace; the buffer is synced for the CPU, so drivers
358 * can access/modify the buffer contents; drivers may
359 * perform any operations required before userspace
360 * accesses the buffer; optional. The buffer state can be
Mauro Carvalho Chehab564aaf62016-07-23 07:12:03 -0300361 * one of the following: %DONE and %ERROR occur while
362 * streaming is in progress, and the %PREPARED state occurs
Hans Verkuilcf227422014-11-18 09:50:57 -0300363 * when the queue has been canceled and all pending
Mauro Carvalho Chehab564aaf62016-07-23 07:12:03 -0300364 * buffers are being returned to their default %DEQUEUED
Hans Verkuilcf227422014-11-18 09:50:57 -0300365 * state. Typically you only have to do something if the
Mauro Carvalho Chehab564aaf62016-07-23 07:12:03 -0300366 * state is %VB2_BUF_STATE_DONE, since in all other cases
Hans Verkuilcf227422014-11-18 09:50:57 -0300367 * the buffer contents will be ignored anyway.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300368 * @buf_cleanup: called once before the buffer is freed; drivers may
Hans Verkuil3f12e6b2014-02-28 12:25:28 -0300369 * perform any additional cleanup; optional.
Marek Szyprowskibd323e22011-08-29 08:51:49 -0300370 * @start_streaming: called once to enter 'streaming' state; the driver may
Mauro Carvalho Chehab564aaf62016-07-23 07:12:03 -0300371 * receive buffers with @buf_queue callback
372 * before @start_streaming is called; the driver gets the
373 * number of already queued buffers in count parameter;
374 * driver can return an error if hardware fails, in that
375 * case all buffers that have been already given by
376 * the @buf_queue callback are to be returned by the driver
Luca Ceresoli68a06bd2018-03-08 07:26:21 -0500377 * by calling vb2_buffer_done() with %VB2_BUF_STATE_QUEUED
378 * or %VB2_BUF_STATE_REQUEUEING. If you need a minimum
379 * number of buffers before you can start streaming, then
380 * set &vb2_queue->min_buffers_needed. If that is non-zero
381 * then @start_streaming won't be called until at least
382 * that many buffers have been queued up by userspace.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300383 * @stop_streaming: called when 'streaming' state must be disabled; driver
384 * should stop any DMA transactions or wait until they
Mauro Carvalho Chehab564aaf62016-07-23 07:12:03 -0300385 * finish and give back all buffers it got from &buf_queue
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300386 * callback by calling vb2_buffer_done() with either
Mauro Carvalho Chehab564aaf62016-07-23 07:12:03 -0300387 * %VB2_BUF_STATE_DONE or %VB2_BUF_STATE_ERROR; may use
Hans Verkuilccf58cb2014-07-23 03:17:06 -0300388 * vb2_wait_for_all_buffers() function
Pawel Osciake23ccc02010-10-11 10:56:41 -0300389 * @buf_queue: passes buffer vb to the driver; driver may start
390 * hardware operation on this buffer; driver should give
Marek Szyprowskibd323e22011-08-29 08:51:49 -0300391 * the buffer back by calling vb2_buffer_done() function;
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300392 * it is allways called after calling VIDIOC_STREAMON()
393 * ioctl; might be called before @start_streaming callback
394 * if user pre-queued buffers before calling
395 * VIDIOC_STREAMON().
Hans Verkuilfd89e0b2018-05-21 04:54:47 -0400396 * @buf_request_complete: a buffer that was never queued to the driver but is
397 * associated with a queued request was canceled.
398 * The driver will have to mark associated objects in the
399 * request as completed; required if requests are
400 * supported.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300401 */
402struct vb2_ops {
Hans Verkuildf9ecb0c2015-10-28 00:50:37 -0200403 int (*queue_setup)(struct vb2_queue *q,
Guennadi Liakhovetskifc714e702011-08-24 10:30:21 -0300404 unsigned int *num_buffers, unsigned int *num_planes,
Hans Verkuil36c0f8b2016-04-15 09:15:05 -0300405 unsigned int sizes[], struct device *alloc_devs[]);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300406
407 void (*wait_prepare)(struct vb2_queue *q);
408 void (*wait_finish)(struct vb2_queue *q);
409
410 int (*buf_init)(struct vb2_buffer *vb);
411 int (*buf_prepare)(struct vb2_buffer *vb);
Hans Verkuil06470642014-03-04 07:27:13 -0300412 void (*buf_finish)(struct vb2_buffer *vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300413 void (*buf_cleanup)(struct vb2_buffer *vb);
414
Marek Szyprowskibd323e22011-08-29 08:51:49 -0300415 int (*start_streaming)(struct vb2_queue *q, unsigned int count);
Hans Verkuile37559b2014-04-17 02:47:21 -0300416 void (*stop_streaming)(struct vb2_queue *q);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300417
418 void (*buf_queue)(struct vb2_buffer *vb);
Hans Verkuilfd89e0b2018-05-21 04:54:47 -0400419
420 void (*buf_request_complete)(struct vb2_buffer *vb);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300421};
422
Hans Verkuil10cc3b12015-11-20 08:32:00 -0200423/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400424 * struct vb2_buf_ops - driver-specific callbacks.
Hans Verkuil10cc3b12015-11-20 08:32:00 -0200425 *
Sakari Ailuse7e0c3e2016-04-03 16:15:00 -0300426 * @verify_planes_array: Verify that a given user space structure contains
427 * enough planes for the buffer. This is called
428 * for each dequeued buffer.
Hans Verkuil8e013702018-06-01 11:03:13 -0400429 * @init_buffer: given a &vb2_buffer initialize the extra data after
430 * struct vb2_buffer.
431 * For V4L2 this is a &struct vb2_v4l2_buffer.
Mauro Carvalho Chehab60e79262017-09-27 15:49:45 -0400432 * @fill_user_buffer: given a &vb2_buffer fill in the userspace structure.
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400433 * For V4L2 this is a &struct v4l2_buffer.
Mauro Carvalho Chehab60e79262017-09-27 15:49:45 -0400434 * @fill_vb2_buffer: given a userspace structure, fill in the &vb2_buffer.
Hans Verkuil10cc3b12015-11-20 08:32:00 -0200435 * If the userspace structure is invalid, then this op
436 * will return an error.
437 * @copy_timestamp: copy the timestamp from a userspace structure to
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400438 * the &struct vb2_buffer.
Hans Verkuil10cc3b12015-11-20 08:32:00 -0200439 */
Junghak Sungb0e0e1f2015-10-06 06:37:48 -0300440struct vb2_buf_ops {
Sakari Ailuse7e0c3e2016-04-03 16:15:00 -0300441 int (*verify_planes_array)(struct vb2_buffer *vb, const void *pb);
Hans Verkuil8e013702018-06-01 11:03:13 -0400442 void (*init_buffer)(struct vb2_buffer *vb);
Hans Verkuil10cc3b12015-11-20 08:32:00 -0200443 void (*fill_user_buffer)(struct vb2_buffer *vb, void *pb);
Hans Verkuildb6e8d52018-05-21 04:54:45 -0400444 int (*fill_vb2_buffer)(struct vb2_buffer *vb, struct vb2_plane *planes);
Hans Verkuil10cc3b12015-11-20 08:32:00 -0200445 void (*copy_timestamp)(struct vb2_buffer *vb, const void *pb);
Junghak Sungb0e0e1f2015-10-06 06:37:48 -0300446};
Hans Verkuil5a5adf62012-06-22 07:29:35 -0300447
Pawel Osciake23ccc02010-10-11 10:56:41 -0300448/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400449 * struct vb2_queue - a videobuf queue.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300450 *
Junghak Sungbed04f92015-10-06 06:37:47 -0300451 * @type: private buffer type whose content is defined by the vb2-core
452 * caller. For example, for V4L2, it should match
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400453 * the types defined on &enum v4l2_buf_type.
454 * @io_modes: supported io methods (see &enum vb2_io_modes).
455 * @alloc_devs: &struct device memory type/allocator-specific per-plane device
Hans Verkuil20be7ab2015-12-16 08:30:43 -0200456 * @dev: device to use for the default allocation context if the driver
Hans Verkuil36c0f8b2016-04-15 09:15:05 -0300457 * doesn't fill in the @alloc_devs array.
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700458 * @dma_attrs: DMA attributes to use for the DMA.
Stanimir Varbanov5b6f9abe2017-08-21 07:34:10 -0400459 * @bidirectional: when this flag is set the DMA direction for the buffers of
Mauro Carvalho Chehab60e79262017-09-27 15:49:45 -0400460 * this queue will be overridden with %DMA_BIDIRECTIONAL direction.
Stanimir Varbanov5b6f9abe2017-08-21 07:34:10 -0400461 * This is useful in cases where the hardware (firmware) writes to
Mauro Carvalho Chehab60e79262017-09-27 15:49:45 -0400462 * a buffer which is mapped as read (%DMA_TO_DEVICE), or reads from
463 * buffer which is mapped for write (%DMA_FROM_DEVICE) in order
Stanimir Varbanov5b6f9abe2017-08-21 07:34:10 -0400464 * to satisfy some internal hardware restrictions or adds a padding
465 * needed by the processing algorithm. In case the DMA mapping is
466 * not bidirectional but the hardware (firmware) trying to access
467 * the buffer (in the opposite direction) this could lead to an
468 * IOMMU protection faults.
Kamil Debski06e7a9b62015-02-23 09:26:16 -0300469 * @fileio_read_once: report EOF after reading the first buffer
470 * @fileio_write_immediately: queue buffer after each write() call
Kamil Debskif61bf132015-02-23 09:26:17 -0300471 * @allow_zero_bytesused: allow bytesused == 0 to be passed to the driver
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800472 * @quirk_poll_must_check_waiting_for_buffers: Return %EPOLLERR at poll when QBUF
Ricardo Ribaldab9387682016-04-25 06:04:45 -0300473 * has not been called. This is a vb1 idiom that has been adopted
474 * also by vb2.
Hans Verkuile5079cf2018-08-23 10:18:35 -0400475 * @supports_requests: this queue supports the Request API.
Hans Verkuil61add362018-05-23 07:51:25 -0400476 * @uses_qbuf: qbuf was used directly for this queue. Set to 1 the first
477 * time this is called. Set to 0 when the queue is canceled.
478 * If this is 1, then you cannot queue buffers from a request.
479 * @uses_requests: requests are used for this queue. Set to 1 the first time
480 * a request is queued. Set to 0 when the queue is canceled.
481 * If this is 1, then you cannot queue buffers directly.
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400482 * @lock: pointer to a mutex that protects the &struct vb2_queue. The
Hans Verkuil5a5adf62012-06-22 07:29:35 -0300483 * driver can set this to a mutex to let the v4l2 core serialize
484 * the queuing ioctls. If the driver wants to handle locking
485 * itself, then this should be set to NULL. This lock is not used
486 * by the videobuf2 core API.
487 * @owner: The filehandle that 'owns' the buffers, i.e. the filehandle
488 * that called reqbufs, create_buffers or started fileio.
489 * This field is not used by the videobuf2 core API, but it allows
490 * drivers to easily associate an owner filehandle with the queue.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300491 * @ops: driver-specific callbacks
492 * @mem_ops: memory allocator specific callbacks
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400493 * @buf_ops: callbacks to deliver buffer information.
494 * between user-space and kernel-space.
495 * @drv_priv: driver private data.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300496 * @buf_struct_size: size of the driver-specific buffer structure;
497 * "0" indicates the driver doesn't want to use a custom buffer
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400498 * structure type. for example, ``sizeof(struct vb2_v4l2_buffer)``
Junghak Sung2d700712015-09-22 10:30:30 -0300499 * will be used for v4l2.
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400500 * @timestamp_flags: Timestamp flags; ``V4L2_BUF_FLAG_TIMESTAMP_*`` and
501 * ``V4L2_BUF_FLAG_TSTAMP_SRC_*``
Hans Verkuilb6ba2052013-03-01 15:44:20 -0300502 * @gfp_flags: additional gfp flags used when allocating the buffers.
Mauro Carvalho Chehab60e79262017-09-27 15:49:45 -0400503 * Typically this is 0, but it may be e.g. %GFP_DMA or %__GFP_DMA32
Hans Verkuilb6ba2052013-03-01 15:44:20 -0300504 * to force the buffer allocation to a specific memory zone.
Hans Verkuilb3379c62014-02-24 13:51:03 -0300505 * @min_buffers_needed: the minimum number of buffers needed before
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300506 * @start_streaming can be called. Used when a DMA engine
Hans Verkuilb3379c62014-02-24 13:51:03 -0300507 * cannot be started unless at least this number of buffers
508 * have been queued into the driver.
Mauro Carvalho Chehabd78757e2015-08-22 08:57:02 -0300509 */
510/*
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300511 * Private elements (won't appear at the uAPI book):
Hans Verkuilf035eb42014-08-07 03:47:14 -0300512 * @mmap_lock: private mutex used when buffers are allocated/freed/mmapped
Pawel Osciake23ccc02010-10-11 10:56:41 -0300513 * @memory: current memory type used
Stanimir Varbanov5b6f9abe2017-08-21 07:34:10 -0400514 * @dma_dir: DMA mapping direction.
Pawel Osciake23ccc02010-10-11 10:56:41 -0300515 * @bufs: videobuf buffer structures
516 * @num_buffers: number of allocated/used buffers
517 * @queued_list: list of buffers currently queued from userspace
Hans Verkuilb3379c62014-02-24 13:51:03 -0300518 * @queued_count: number of buffers queued and ready for streaming.
Hans Verkuil6ea3b982014-02-06 05:46:11 -0300519 * @owned_by_drv_count: number of buffers owned by the driver
Pawel Osciake23ccc02010-10-11 10:56:41 -0300520 * @done_list: list of buffers ready to be dequeued to userspace
521 * @done_lock: lock to protect done_list list
522 * @done_wq: waitqueue for processes waiting for buffers ready to be dequeued
Pawel Osciake23ccc02010-10-11 10:56:41 -0300523 * @streaming: current streaming state
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300524 * @start_streaming_called: @start_streaming was called successfully and we
Hans Verkuilb3379c62014-02-24 13:51:03 -0300525 * started streaming.
Laurent Pinchart4bb72672014-06-03 18:53:25 -0300526 * @error: a fatal error occurred on the queue
Hans Verkuil58d75f42014-09-20 16:16:35 -0300527 * @waiting_for_buffers: used in poll() to check if vb2 is still waiting for
528 * buffers. Only set for capture queues if qbuf has not yet been
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800529 * called since poll() needs to return %EPOLLERR in that situation.
Junghak Sungbed04f92015-10-06 06:37:47 -0300530 * @is_multiplanar: set if buffer type is multiplanar
531 * @is_output: set if buffer type is output
Junghak Sung959c3ef2015-11-03 08:16:38 -0200532 * @copy_timestamp: set if vb2-core should set timestamps
Philipp Zabelc1621842015-05-04 07:51:06 -0300533 * @last_buffer_dequeued: used in poll() and DQBUF to immediately return if the
534 * last decoded buffer was already dequeued. Set for capture queues
Mauro Carvalho Chehab60e79262017-09-27 15:49:45 -0400535 * when a buffer with the %V4L2_BUF_FLAG_LAST is dequeued.
Marek Szyprowskib25748f2010-12-06 05:56:55 -0300536 * @fileio: file io emulator internal data, used only if emulator is active
Hans Verkuil3415a892014-04-14 07:33:00 -0300537 * @threadio: thread io internal data, used only if thread is active
Pawel Osciake23ccc02010-10-11 10:56:41 -0300538 */
539struct vb2_queue {
Junghak Sungbed04f92015-10-06 06:37:47 -0300540 unsigned int type;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300541 unsigned int io_modes;
Hans Verkuil20be7ab2015-12-16 08:30:43 -0200542 struct device *dev;
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700543 unsigned long dma_attrs;
Stanimir Varbanov5b6f9abe2017-08-21 07:34:10 -0400544 unsigned bidirectional:1;
Kamil Debski06e7a9b62015-02-23 09:26:16 -0300545 unsigned fileio_read_once:1;
546 unsigned fileio_write_immediately:1;
Kamil Debskif61bf132015-02-23 09:26:17 -0300547 unsigned allow_zero_bytesused:1;
Ricardo Ribaldab9387682016-04-25 06:04:45 -0300548 unsigned quirk_poll_must_check_waiting_for_buffers:1;
Hans Verkuile5079cf2018-08-23 10:18:35 -0400549 unsigned supports_requests:1;
Hans Verkuil61add362018-05-23 07:51:25 -0400550 unsigned uses_qbuf:1;
551 unsigned uses_requests:1;
Kamil Debski06e7a9b62015-02-23 09:26:16 -0300552
Hans Verkuil5a5adf62012-06-22 07:29:35 -0300553 struct mutex *lock;
Junghak Sungbed04f92015-10-06 06:37:47 -0300554 void *owner;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300555
556 const struct vb2_ops *ops;
557 const struct vb2_mem_ops *mem_ops;
Junghak Sungb0e0e1f2015-10-06 06:37:48 -0300558 const struct vb2_buf_ops *buf_ops;
559
Pawel Osciake23ccc02010-10-11 10:56:41 -0300560 void *drv_priv;
561 unsigned int buf_struct_size;
Sakari Ailusade48682014-02-25 19:12:19 -0300562 u32 timestamp_flags;
Hans Verkuilb6ba2052013-03-01 15:44:20 -0300563 gfp_t gfp_flags;
Hans Verkuilb3379c62014-02-24 13:51:03 -0300564 u32 min_buffers_needed;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300565
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400566 struct device *alloc_devs[VB2_MAX_PLANES];
567
Mauro Carvalho Chehabd78757e2015-08-22 08:57:02 -0300568 /* private: internal use only */
Hans Verkuilf035eb42014-08-07 03:47:14 -0300569 struct mutex mmap_lock;
Junghak Sungbed04f92015-10-06 06:37:47 -0300570 unsigned int memory;
Stanimir Varbanov5b6f9abe2017-08-21 07:34:10 -0400571 enum dma_data_direction dma_dir;
Junghak Sungbed04f92015-10-06 06:37:47 -0300572 struct vb2_buffer *bufs[VB2_MAX_FRAME];
Pawel Osciake23ccc02010-10-11 10:56:41 -0300573 unsigned int num_buffers;
574
575 struct list_head queued_list;
Hans Verkuilb3379c62014-02-24 13:51:03 -0300576 unsigned int queued_count;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300577
Hans Verkuil6ea3b982014-02-06 05:46:11 -0300578 atomic_t owned_by_drv_count;
Pawel Osciake23ccc02010-10-11 10:56:41 -0300579 struct list_head done_list;
580 spinlock_t done_lock;
581 wait_queue_head_t done_wq;
582
Pawel Osciake23ccc02010-10-11 10:56:41 -0300583 unsigned int streaming:1;
Hans Verkuilb3379c62014-02-24 13:51:03 -0300584 unsigned int start_streaming_called:1;
Laurent Pinchart4bb72672014-06-03 18:53:25 -0300585 unsigned int error:1;
Hans Verkuil58d75f42014-09-20 16:16:35 -0300586 unsigned int waiting_for_buffers:1;
Junghak Sungbed04f92015-10-06 06:37:47 -0300587 unsigned int is_multiplanar:1;
588 unsigned int is_output:1;
Junghak Sung959c3ef2015-11-03 08:16:38 -0200589 unsigned int copy_timestamp:1;
Philipp Zabelc1621842015-05-04 07:51:06 -0300590 unsigned int last_buffer_dequeued:1;
Marek Szyprowskib25748f2010-12-06 05:56:55 -0300591
592 struct vb2_fileio_data *fileio;
Hans Verkuil3415a892014-04-14 07:33:00 -0300593 struct vb2_threadio_data *threadio;
Hans Verkuilb5b45412014-01-29 11:53:25 -0300594
595#ifdef CONFIG_VIDEO_ADV_DEBUG
596 /*
597 * Counters for how often these queue-related ops are
598 * called. Used to check for unbalanced ops.
599 */
600 u32 cnt_queue_setup;
601 u32 cnt_wait_prepare;
602 u32 cnt_wait_finish;
603 u32 cnt_start_streaming;
604 u32 cnt_stop_streaming;
605#endif
Pawel Osciake23ccc02010-10-11 10:56:41 -0300606};
607
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300608/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400609 * vb2_plane_vaddr() - Return a kernel virtual address of a given plane.
610 * @vb: pointer to &struct vb2_buffer to which the plane in
611 * question belongs to.
612 * @plane_no: plane number for which the address is to be returned.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300613 *
614 * This function returns a kernel virtual address of a given plane if
615 * such a mapping exist, NULL otherwise.
616 */
Pawel Osciake23ccc02010-10-11 10:56:41 -0300617void *vb2_plane_vaddr(struct vb2_buffer *vb, unsigned int plane_no);
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300618
619/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400620 * vb2_plane_cookie() - Return allocator specific cookie for the given plane.
621 * @vb: pointer to &struct vb2_buffer to which the plane in
622 * question belongs to.
623 * @plane_no: plane number for which the cookie is to be returned.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300624 *
625 * This function returns an allocator specific cookie for a given plane if
626 * available, NULL otherwise. The allocator should provide some simple static
627 * inline function, which would convert this cookie to the allocator specific
628 * type that can be used directly by the driver to access the buffer. This can
629 * be for example physical address, pointer to scatter list or IOMMU mapping.
630 */
Pawel Osciake23ccc02010-10-11 10:56:41 -0300631void *vb2_plane_cookie(struct vb2_buffer *vb, unsigned int plane_no);
632
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300633/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400634 * vb2_buffer_done() - inform videobuf that an operation on a buffer
635 * is finished.
636 * @vb: pointer to &struct vb2_buffer to be used.
637 * @state: state of the buffer, as defined by &enum vb2_buffer_state.
638 * Either %VB2_BUF_STATE_DONE if the operation finished
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300639 * successfully, %VB2_BUF_STATE_ERROR if the operation finished
Luca Ceresoli68a06bd2018-03-08 07:26:21 -0500640 * with an error or any of %VB2_BUF_STATE_QUEUED or
641 * %VB2_BUF_STATE_REQUEUEING if the driver wants to
642 * requeue buffers (see below).
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300643 *
644 * This function should be called by the driver after a hardware operation on
645 * a buffer is finished and the buffer may be returned to userspace. The driver
646 * cannot use this buffer anymore until it is queued back to it by videobuf
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300647 * by the means of &vb2_ops->buf_queue callback. Only buffers previously queued
648 * to the driver by &vb2_ops->buf_queue can be passed to this function.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300649 *
650 * While streaming a buffer can only be returned in state DONE or ERROR.
Luca Ceresoli45ad3992018-03-08 07:26:20 -0500651 * The &vb2_ops->start_streaming op can also return them in case the DMA engine
652 * cannot be started for some reason. In that case the buffers should be
Luca Ceresoli68a06bd2018-03-08 07:26:21 -0500653 * returned with state QUEUED or REQUEUEING to put them back into the queue.
654 *
655 * %VB2_BUF_STATE_REQUEUEING is like %VB2_BUF_STATE_QUEUED, but it also calls
656 * &vb2_ops->buf_queue to queue buffers back to the driver. Note that calling
657 * vb2_buffer_done(..., VB2_BUF_STATE_REQUEUEING) from interrupt context will
658 * result in &vb2_ops->buf_queue being called in interrupt context as well.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300659 */
Pawel Osciake23ccc02010-10-11 10:56:41 -0300660void vb2_buffer_done(struct vb2_buffer *vb, enum vb2_buffer_state state);
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300661
662/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400663 * vb2_discard_done() - discard all buffers marked as DONE.
664 * @q: pointer to &struct vb2_queue with videobuf2 queue.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300665 *
666 * This function is intended to be used with suspend/resume operations. It
667 * discards all 'done' buffers as they would be too old to be requested after
668 * resume.
669 *
670 * Drivers must stop the hardware and synchronize with interrupt handlers and/or
671 * delayed works before calling this function to make sure no buffer will be
672 * touched by the driver and/or hardware.
673 */
Laurent Pinchart34ea4d42014-03-09 21:42:52 -0300674void vb2_discard_done(struct vb2_queue *q);
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300675
676/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400677 * vb2_wait_for_all_buffers() - wait until all buffers are given back to vb2.
678 * @q: pointer to &struct vb2_queue with videobuf2 queue.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300679 *
680 * This function will wait until all buffers that have been given to the driver
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300681 * by &vb2_ops->buf_queue are given back to vb2 with vb2_buffer_done(). It
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400682 * doesn't call &vb2_ops->wait_prepare/&vb2_ops->wait_finish pair.
683 * It is intended to be called with all locks taken, for example from
684 * &vb2_ops->stop_streaming callback.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300685 */
Pawel Osciake23ccc02010-10-11 10:56:41 -0300686int vb2_wait_for_all_buffers(struct vb2_queue *q);
687
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300688/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400689 * vb2_core_querybuf() - query video buffer information.
690 * @q: pointer to &struct vb2_queue with videobuf2 queue.
691 * @index: id number of the buffer.
692 * @pb: buffer struct passed from userspace.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300693 *
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400694 * Videobuf2 core helper to implement VIDIOC_QUERYBUF() operation. It is called
695 * internally by VB2 by an API-specific handler, like ``videobuf2-v4l2.h``.
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400696 *
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300697 * The passed buffer should have been verified.
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400698 *
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300699 * This function fills the relevant information for the userspace.
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400700 *
701 * Return: returns zero on success; an error code otherwise.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300702 */
Hans Verkuil10cc3b12015-11-20 08:32:00 -0200703void vb2_core_querybuf(struct vb2_queue *q, unsigned int index, void *pb);
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300704
705/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400706 * vb2_core_reqbufs() - Initiate streaming.
707 * @q: pointer to &struct vb2_queue with videobuf2 queue.
708 * @memory: memory type, as defined by &enum vb2_memory.
709 * @count: requested buffer count.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300710 *
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400711 * Videobuf2 core helper to implement VIDIOC_REQBUF() operation. It is called
712 * internally by VB2 by an API-specific handler, like ``videobuf2-v4l2.h``.
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300713 *
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300714 * This function:
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300715 *
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400716 * #) verifies streaming parameters passed from the userspace;
717 * #) sets up the queue;
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300718 * #) negotiates number of buffers and planes per buffer with the driver
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400719 * to be used during streaming;
Mauro Carvalho Chehab60e79262017-09-27 15:49:45 -0400720 * #) allocates internal buffer structures (&struct vb2_buffer), according to
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400721 * the agreed parameters;
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300722 * #) for MMAP memory type, allocates actual video memory, using the
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400723 * memory handling/allocation routines provided during queue initialization.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300724 *
725 * If req->count is 0, all the memory will be freed instead.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300726 *
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400727 * If the queue has been allocated previously by a previous vb2_core_reqbufs()
728 * call and the queue is not busy, memory will be reallocated.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300729 *
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400730 * Return: returns zero on success; an error code otherwise.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300731 */
Junghak Sung3c5be982015-10-06 06:37:49 -0300732int vb2_core_reqbufs(struct vb2_queue *q, enum vb2_memory memory,
733 unsigned int *count);
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300734
735/**
736 * vb2_core_create_bufs() - Allocate buffers and any required auxiliary structs
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400737 * @q: pointer to &struct vb2_queue with videobuf2 queue.
738 * @memory: memory type, as defined by &enum vb2_memory.
739 * @count: requested buffer count.
740 * @requested_planes: number of planes requested.
741 * @requested_sizes: array with the size of the planes.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300742 *
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400743 * Videobuf2 core helper to implement VIDIOC_CREATE_BUFS() operation. It is
744 * called internally by VB2 by an API-specific handler, like
745 * ``videobuf2-v4l2.h``.
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400746 *
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300747 * This function:
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300748 *
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400749 * #) verifies parameter sanity;
750 * #) calls the &vb2_ops->queue_setup queue operation;
751 * #) performs any necessary memory allocations.
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300752 *
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400753 * Return: returns zero on success; an error code otherwise.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300754 */
Junghak Sung3c5be982015-10-06 06:37:49 -0300755int vb2_core_create_bufs(struct vb2_queue *q, enum vb2_memory memory,
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300756 unsigned int *count, unsigned int requested_planes,
757 const unsigned int requested_sizes[]);
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300758
759/**
760 * vb2_core_prepare_buf() - Pass ownership of a buffer from userspace
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400761 * to the kernel.
762 * @q: pointer to &struct vb2_queue with videobuf2 queue.
763 * @index: id number of the buffer.
764 * @pb: buffer structure passed from userspace to
765 * &v4l2_ioctl_ops->vidioc_prepare_buf handler in driver.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300766 *
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400767 * Videobuf2 core helper to implement VIDIOC_PREPARE_BUF() operation. It is
768 * called internally by VB2 by an API-specific handler, like
769 * ``videobuf2-v4l2.h``.
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400770 *
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300771 * The passed buffer should have been verified.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300772 *
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400773 * This function calls vb2_ops->buf_prepare callback in the driver
774 * (if provided), in which driver-specific buffer initialization can
775 * be performed.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300776 *
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400777 * Return: returns zero on success; an error code otherwise.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300778 */
Junghak Sung3c5be982015-10-06 06:37:49 -0300779int vb2_core_prepare_buf(struct vb2_queue *q, unsigned int index, void *pb);
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300780
781/**
782 * vb2_core_qbuf() - Queue a buffer from userspace
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300783 *
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400784 * @q: pointer to &struct vb2_queue with videobuf2 queue.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300785 * @index: id number of the buffer
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400786 * @pb: buffer structure passed from userspace to
787 * v4l2_ioctl_ops->vidioc_qbuf handler in driver
Hans Verkuilfd89e0b2018-05-21 04:54:47 -0400788 * @req: pointer to &struct media_request, may be NULL.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300789 *
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400790 * Videobuf2 core helper to implement VIDIOC_QBUF() operation. It is called
791 * internally by VB2 by an API-specific handler, like ``videobuf2-v4l2.h``.
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300792 *
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300793 * This function:
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300794 *
Hans Verkuilfd89e0b2018-05-21 04:54:47 -0400795 * #) If @req is non-NULL, then the buffer will be bound to this
796 * media request and it returns. The buffer will be prepared and
797 * queued to the driver (i.e. the next two steps) when the request
798 * itself is queued.
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400799 * #) if necessary, calls &vb2_ops->buf_prepare callback in the driver
800 * (if provided), in which driver-specific buffer initialization can
801 * be performed;
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300802 * #) if streaming is on, queues the buffer in driver by the means of
803 * &vb2_ops->buf_queue callback for processing.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300804 *
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400805 * Return: returns zero on success; an error code otherwise.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300806 */
Hans Verkuilfd89e0b2018-05-21 04:54:47 -0400807int vb2_core_qbuf(struct vb2_queue *q, unsigned int index, void *pb,
808 struct media_request *req);
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300809
810/**
811 * vb2_core_dqbuf() - Dequeue a buffer to the userspace
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400812 * @q: pointer to &struct vb2_queue with videobuf2 queue
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300813 * @pindex: pointer to the buffer index. May be NULL
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400814 * @pb: buffer structure passed from userspace to
815 * v4l2_ioctl_ops->vidioc_dqbuf handler in driver.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300816 * @nonblocking: if true, this call will not sleep waiting for a buffer if no
817 * buffers ready for dequeuing are present. Normally the driver
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400818 * would be passing (file->f_flags & O_NONBLOCK) here.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300819 *
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400820 * Videobuf2 core helper to implement VIDIOC_DQBUF() operation. It is called
821 * internally by VB2 by an API-specific handler, like ``videobuf2-v4l2.h``.
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300822 *
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300823 * This function:
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300824 *
825 * #) calls buf_finish callback in the driver (if provided), in which
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300826 * driver can perform any additional operations that may be required before
827 * returning the buffer to userspace, such as cache sync,
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300828 * #) the buffer struct members are filled with relevant information for
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300829 * the userspace.
830 *
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400831 * Return: returns zero on success; an error code otherwise.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300832 */
Hans Verkuilfac710e2016-01-27 10:08:42 -0200833int vb2_core_dqbuf(struct vb2_queue *q, unsigned int *pindex, void *pb,
834 bool nonblocking);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300835
Mauro Carvalho Chehab8dcde472017-10-07 05:05:03 -0400836/**
837 * vb2_core_streamon() - Implements VB2 stream ON logic
838 *
839 * @q: pointer to &struct vb2_queue with videobuf2 queue
840 * @type: type of the queue to be started.
841 * For V4L2, this is defined by &enum v4l2_buf_type type.
842 *
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400843 * Videobuf2 core helper to implement VIDIOC_STREAMON() operation. It is called
844 * internally by VB2 by an API-specific handler, like ``videobuf2-v4l2.h``.
845 *
846 * Return: returns zero on success; an error code otherwise.
Mauro Carvalho Chehab8dcde472017-10-07 05:05:03 -0400847 */
Junghak Sung3c5be982015-10-06 06:37:49 -0300848int vb2_core_streamon(struct vb2_queue *q, unsigned int type);
Mauro Carvalho Chehab8dcde472017-10-07 05:05:03 -0400849
850/**
851 * vb2_core_streamoff() - Implements VB2 stream OFF logic
852 *
853 * @q: pointer to &struct vb2_queue with videobuf2 queue
854 * @type: type of the queue to be started.
855 * For V4L2, this is defined by &enum v4l2_buf_type type.
856 *
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400857 * Videobuf2 core helper to implement VIDIOC_STREAMOFF() operation. It is
858 * called internally by VB2 by an API-specific handler, like
859 * ``videobuf2-v4l2.h``.
860 *
861 * Return: returns zero on success; an error code otherwise.
Mauro Carvalho Chehab8dcde472017-10-07 05:05:03 -0400862 */
Junghak Sung3c5be982015-10-06 06:37:49 -0300863int vb2_core_streamoff(struct vb2_queue *q, unsigned int type);
Guennadi Liakhovetski2d864012011-09-28 09:23:02 -0300864
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300865/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400866 * vb2_core_expbuf() - Export a buffer as a file descriptor.
867 * @q: pointer to &struct vb2_queue with videobuf2 queue.
868 * @fd: pointer to the file descriptor associated with DMABUF
869 * (set by driver).
870 * @type: buffer type.
871 * @index: id number of the buffer.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300872 * @plane: index of the plane to be exported, 0 for single plane queues
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400873 * @flags: file flags for newly created file, as defined at
874 * include/uapi/asm-generic/fcntl.h.
875 * Currently, the only used flag is %O_CLOEXEC.
876 * is supported, refer to manual of open syscall for more details.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300877 *
Mauro Carvalho Chehab991232a2017-10-09 05:31:49 -0400878 *
879 * Videobuf2 core helper to implement VIDIOC_EXPBUF() operation. It is called
880 * internally by VB2 by an API-specific handler, like ``videobuf2-v4l2.h``.
881 *
882 * Return: returns zero on success; an error code otherwise.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300883 */
Junghak Sung3c5be982015-10-06 06:37:49 -0300884int vb2_core_expbuf(struct vb2_queue *q, int *fd, unsigned int type,
885 unsigned int index, unsigned int plane, unsigned int flags);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300886
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300887/**
888 * vb2_core_queue_init() - initialize a videobuf2 queue
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400889 * @q: pointer to &struct vb2_queue with videobuf2 queue.
890 * This structure should be allocated in driver
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300891 *
Mauro Carvalho Chehab60e79262017-09-27 15:49:45 -0400892 * The &vb2_queue structure should be allocated by the driver. The driver is
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300893 * responsible of clearing it's content and setting initial values for some
894 * required entries before calling this function.
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400895 *
896 * .. note::
897 *
898 * The following fields at @q should be set before calling this function:
899 * &vb2_queue->ops, &vb2_queue->mem_ops, &vb2_queue->type.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300900 */
Junghak Sung3c5be982015-10-06 06:37:49 -0300901int vb2_core_queue_init(struct vb2_queue *q);
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300902
903/**
904 * vb2_core_queue_release() - stop streaming, release the queue and free memory
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400905 * @q: pointer to &struct vb2_queue with videobuf2 queue.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300906 *
907 * This function stops streaming and performs necessary clean ups, including
908 * freeing video buffer memory. The driver is responsible for freeing
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400909 * the &struct vb2_queue itself.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300910 */
Junghak Sung3c5be982015-10-06 06:37:49 -0300911void vb2_core_queue_release(struct vb2_queue *q);
912
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300913/**
914 * vb2_queue_error() - signal a fatal error on the queue
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400915 * @q: pointer to &struct vb2_queue with videobuf2 queue.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300916 *
917 * Flag that a fatal unrecoverable error has occurred and wake up all processes
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800918 * waiting on the queue. Polling will now set %EPOLLERR and queuing and dequeuing
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400919 * buffers will return %-EIO.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300920 *
Mauro Carvalho Chehab60e79262017-09-27 15:49:45 -0400921 * The error flag will be cleared when canceling the queue, either from
922 * vb2_streamoff() or vb2_queue_release(). Drivers should thus not call this
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300923 * function before starting the stream, otherwise the error flag will remain set
924 * until the queue is released when closing the device node.
925 */
Laurent Pinchart4bb72672014-06-03 18:53:25 -0300926void vb2_queue_error(struct vb2_queue *q);
Pawel Osciake23ccc02010-10-11 10:56:41 -0300927
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300928/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400929 * vb2_mmap() - map video buffers into application address space.
930 * @q: pointer to &struct vb2_queue with videobuf2 queue.
931 * @vma: pointer to &struct vm_area_struct with the vma passed
932 * to the mmap file operation handler in the driver.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300933 *
934 * Should be called from mmap file operation handler of a driver.
935 * This function maps one plane of one of the available video buffers to
936 * userspace. To map whole video memory allocated on reqbufs, this function
937 * has to be called once per each plane per each buffer previously allocated.
938 *
939 * When the userspace application calls mmap, it passes to it an offset returned
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400940 * to it earlier by the means of &v4l2_ioctl_ops->vidioc_querybuf handler.
941 * That offset acts as a "cookie", which is then used to identify the plane
942 * to be mapped.
943 *
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300944 * This function finds a plane with a matching offset and a mapping is performed
945 * by the means of a provided memory operation.
946 *
947 * The return values from this function are intended to be directly returned
948 * from the mmap handler in driver.
949 */
Pawel Osciake23ccc02010-10-11 10:56:41 -0300950int vb2_mmap(struct vb2_queue *q, struct vm_area_struct *vma);
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300951
Scott Jiang6f524ec2011-09-21 09:25:23 -0300952#ifndef CONFIG_MMU
Mauro Carvalho Chehab8dcde472017-10-07 05:05:03 -0400953/**
954 * vb2_get_unmapped_area - map video buffers into application address space.
955 * @q: pointer to &struct vb2_queue with videobuf2 queue.
956 * @addr: memory address.
957 * @len: buffer size.
958 * @pgoff: page offset.
959 * @flags: memory flags.
960 *
961 * This function is used in noMMU platforms to propose address mapping
962 * for a given buffer. It's intended to be used as a handler for the
963 * &file_operations->get_unmapped_area operation.
964 *
965 * This is called by the mmap() syscall routines will call this
966 * to get a proposed address for the mapping, when ``!CONFIG_MMU``.
967 */
Scott Jiang6f524ec2011-09-21 09:25:23 -0300968unsigned long vb2_get_unmapped_area(struct vb2_queue *q,
969 unsigned long addr,
970 unsigned long len,
971 unsigned long pgoff,
972 unsigned long flags);
973#endif
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300974
975/**
Mauro Carvalho Chehab8dcde472017-10-07 05:05:03 -0400976 * vb2_core_poll() - implements poll syscall() logic.
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -0400977 * @q: pointer to &struct vb2_queue with videobuf2 queue.
978 * @file: &struct file argument passed to the poll
979 * file operation handler.
980 * @wait: &poll_table wait argument passed to the poll
981 * file operation handler.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -0300982 *
983 * This function implements poll file operation handler for a driver.
984 * For CAPTURE queues, if a buffer is ready to be dequeued, the userspace will
985 * be informed that the file descriptor of a video device is available for
986 * reading.
987 * For OUTPUT queues, if a buffer is ready to be dequeued, the file descriptor
988 * will be reported as available for writing.
989 *
990 * The return values from this function are intended to be directly returned
991 * from poll handler in driver.
992 */
Al Viroc23e0cb2017-07-03 03:02:56 -0400993__poll_t vb2_core_poll(struct vb2_queue *q, struct file *file,
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -0300994 poll_table *wait);
995
Mauro Carvalho Chehab8dcde472017-10-07 05:05:03 -0400996/**
997 * vb2_read() - implements read() syscall logic.
998 * @q: pointer to &struct vb2_queue with videobuf2 queue.
999 * @data: pointed to target userspace buffer
1000 * @count: number of bytes to read
1001 * @ppos: file handle position tracking pointer
1002 * @nonblock: mode selector (1 means blocking calls, 0 means nonblocking)
1003 */
Junghak Sungaf3bac12015-11-03 08:16:42 -02001004size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count,
1005 loff_t *ppos, int nonblock);
Mauro Carvalho Chehab8dcde472017-10-07 05:05:03 -04001006/**
1007 * vb2_read() - implements write() syscall logic.
1008 * @q: pointer to &struct vb2_queue with videobuf2 queue.
1009 * @data: pointed to target userspace buffer
1010 * @count: number of bytes to write
1011 * @ppos: file handle position tracking pointer
1012 * @nonblock: mode selector (1 means blocking calls, 0 means nonblocking)
1013 */
Junghak Sungaf3bac12015-11-03 08:16:42 -02001014size_t vb2_write(struct vb2_queue *q, const char __user *data, size_t count,
1015 loff_t *ppos, int nonblock);
1016
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -03001017/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -04001018 * typedef vb2_thread_fnc - callback function for use with vb2_thread.
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -03001019 *
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -04001020 * @vb: pointer to struct &vb2_buffer.
1021 * @priv: pointer to a private data.
Junghak Sungaf3bac12015-11-03 08:16:42 -02001022 *
1023 * This is called whenever a buffer is dequeued in the thread.
1024 */
1025typedef int (*vb2_thread_fnc)(struct vb2_buffer *vb, void *priv);
1026
1027/**
1028 * vb2_thread_start() - start a thread for the given queue.
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -04001029 * @q: pointer to &struct vb2_queue with videobuf2 queue.
1030 * @fnc: &vb2_thread_fnc callback function.
1031 * @priv: priv pointer passed to the callback function.
Junghak Sungaf3bac12015-11-03 08:16:42 -02001032 * @thread_name:the name of the thread. This will be prefixed with "vb2-".
1033 *
1034 * This starts a thread that will queue and dequeue until an error occurs
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -04001035 * or vb2_thread_stop() is called.
Junghak Sungaf3bac12015-11-03 08:16:42 -02001036 *
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -03001037 * .. attention::
1038 *
1039 * This function should not be used for anything else but the videobuf2-dvb
1040 * support. If you think you have another good use-case for this, then please
1041 * contact the linux-media mailing list first.
Junghak Sungaf3bac12015-11-03 08:16:42 -02001042 */
1043int vb2_thread_start(struct vb2_queue *q, vb2_thread_fnc fnc, void *priv,
1044 const char *thread_name);
1045
1046/**
1047 * vb2_thread_stop() - stop the thread for the given queue.
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -04001048 * @q: pointer to &struct vb2_queue with videobuf2 queue.
Junghak Sungaf3bac12015-11-03 08:16:42 -02001049 */
1050int vb2_thread_stop(struct vb2_queue *q);
Pawel Osciake23ccc02010-10-11 10:56:41 -03001051
1052/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -04001053 * vb2_is_streaming() - return streaming status of the queue.
1054 * @q: pointer to &struct vb2_queue with videobuf2 queue.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001055 */
1056static inline bool vb2_is_streaming(struct vb2_queue *q)
1057{
1058 return q->streaming;
1059}
1060
1061/**
Hans Verkuil74753cf2014-04-07 09:23:50 -03001062 * vb2_fileio_is_active() - return true if fileio is active.
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -04001063 * @q: pointer to &struct vb2_queue with videobuf2 queue.
Hans Verkuil74753cf2014-04-07 09:23:50 -03001064 *
1065 * This returns true if read() or write() is used to stream the data
1066 * as opposed to stream I/O. This is almost never an important distinction,
1067 * except in rare cases. One such case is that using read() or write() to
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -04001068 * stream a format using %V4L2_FIELD_ALTERNATE is not allowed since there
Hans Verkuil74753cf2014-04-07 09:23:50 -03001069 * is no way you can pass the field information of each buffer to/from
1070 * userspace. A driver that supports this field format should check for
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -04001071 * this in the &vb2_ops->queue_setup op and reject it if this function returns
1072 * true.
Hans Verkuil74753cf2014-04-07 09:23:50 -03001073 */
1074static inline bool vb2_fileio_is_active(struct vb2_queue *q)
1075{
1076 return q->fileio;
1077}
1078
1079/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -04001080 * vb2_is_busy() - return busy status of the queue.
1081 * @q: pointer to &struct vb2_queue with videobuf2 queue.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001082 *
1083 * This function checks if queue has any buffers allocated.
1084 */
1085static inline bool vb2_is_busy(struct vb2_queue *q)
1086{
1087 return (q->num_buffers > 0);
1088}
1089
1090/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -04001091 * vb2_get_drv_priv() - return driver private data associated with the queue.
1092 * @q: pointer to &struct vb2_queue with videobuf2 queue.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001093 */
1094static inline void *vb2_get_drv_priv(struct vb2_queue *q)
1095{
1096 return q->drv_priv;
1097}
1098
1099/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -04001100 * vb2_set_plane_payload() - set bytesused for the plane @plane_no.
1101 * @vb: pointer to &struct vb2_buffer to which the plane in
1102 * question belongs to.
1103 * @plane_no: plane number for which payload should be set.
1104 * @size: payload in bytes.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001105 */
1106static inline void vb2_set_plane_payload(struct vb2_buffer *vb,
1107 unsigned int plane_no, unsigned long size)
1108{
1109 if (plane_no < vb->num_planes)
Junghak Sung2d700712015-09-22 10:30:30 -03001110 vb->planes[plane_no].bytesused = size;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001111}
1112
1113/**
Laurent Pinchart9f00eda2011-02-27 14:38:19 -03001114 * vb2_get_plane_payload() - get bytesused for the plane plane_no
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -04001115 * @vb: pointer to &struct vb2_buffer to which the plane in
1116 * question belongs to.
1117 * @plane_no: plane number for which payload should be set.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001118 */
1119static inline unsigned long vb2_get_plane_payload(struct vb2_buffer *vb,
1120 unsigned int plane_no)
1121{
1122 if (plane_no < vb->num_planes)
Junghak Sung2d700712015-09-22 10:30:30 -03001123 return vb->planes[plane_no].bytesused;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001124 return 0;
1125}
1126
1127/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -04001128 * vb2_plane_size() - return plane size in bytes.
1129 * @vb: pointer to &struct vb2_buffer to which the plane in
1130 * question belongs to.
1131 * @plane_no: plane number for which size should be returned.
Pawel Osciake23ccc02010-10-11 10:56:41 -03001132 */
1133static inline unsigned long
1134vb2_plane_size(struct vb2_buffer *vb, unsigned int plane_no)
1135{
1136 if (plane_no < vb->num_planes)
Junghak Sung2d700712015-09-22 10:30:30 -03001137 return vb->planes[plane_no].length;
Pawel Osciake23ccc02010-10-11 10:56:41 -03001138 return 0;
1139}
1140
Prabhakar Ladead13032014-09-06 12:26:49 -03001141/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -04001142 * vb2_start_streaming_called() - return streaming status of driver.
1143 * @q: pointer to &struct vb2_queue with videobuf2 queue.
Prabhakar Ladead13032014-09-06 12:26:49 -03001144 */
1145static inline bool vb2_start_streaming_called(struct vb2_queue *q)
1146{
1147 return q->start_streaming_called;
1148}
1149
Philipp Zabelc1621842015-05-04 07:51:06 -03001150/**
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -04001151 * vb2_clear_last_buffer_dequeued() - clear last buffer dequeued flag of queue.
1152 * @q: pointer to &struct vb2_queue with videobuf2 queue.
Philipp Zabelc1621842015-05-04 07:51:06 -03001153 */
1154static inline void vb2_clear_last_buffer_dequeued(struct vb2_queue *q)
1155{
1156 q->last_buffer_dequeued = false;
1157}
1158
Junghak Sungaf3bac12015-11-03 08:16:42 -02001159/*
1160 * The following functions are not part of the vb2 core API, but are useful
1161 * functions for videobuf2-*.
1162 */
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -03001163
1164/**
1165 * vb2_buffer_in_use() - return true if the buffer is in use and
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -04001166 * the queue cannot be freed (by the means of VIDIOC_REQBUFS(0)) call.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -03001167 *
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -04001168 * @vb: buffer for which plane size should be returned.
1169 * @q: pointer to &struct vb2_queue with videobuf2 queue.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -03001170 */
Junghak Sungaf3bac12015-11-03 08:16:42 -02001171bool vb2_buffer_in_use(struct vb2_queue *q, struct vb2_buffer *vb);
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -03001172
1173/**
1174 * vb2_verify_memory_type() - Check whether the memory type and buffer type
1175 * passed to a buffer operation are compatible with the queue.
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -03001176 *
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -04001177 * @q: pointer to &struct vb2_queue with videobuf2 queue.
Mauro Carvalho Chehabf286f4d2016-09-08 14:08:34 -03001178 * @memory: memory model, as defined by enum &vb2_memory.
1179 * @type: private buffer type whose content is defined by the vb2-core
1180 * caller. For example, for V4L2, it should match
Mauro Carvalho Chehab2b141322017-10-06 12:22:43 -04001181 * the types defined on enum &v4l2_buf_type.
Mauro Carvalho Chehab88b7eb02016-09-08 13:34:37 -03001182 */
Junghak Sungaf3bac12015-11-03 08:16:42 -02001183int vb2_verify_memory_type(struct vb2_queue *q,
1184 enum vb2_memory memory, unsigned int type);
Hans Verkuilc07aa482018-05-21 04:54:51 -04001185
1186/**
1187 * vb2_request_object_is_buffer() - return true if the object is a buffer
1188 *
1189 * @obj: the request object.
1190 */
1191bool vb2_request_object_is_buffer(struct media_request_object *obj);
1192
1193/**
Paul Kocialkowski515c5a72018-09-13 10:51:51 -04001194 * vb2_request_buffer_cnt() - return the number of buffers in the request
Hans Verkuilc07aa482018-05-21 04:54:51 -04001195 *
1196 * @req: the request.
1197 */
Paul Kocialkowski515c5a72018-09-13 10:51:51 -04001198unsigned int vb2_request_buffer_cnt(struct media_request *req);
Hans Verkuilc07aa482018-05-21 04:54:51 -04001199
Pawel Osciake23ccc02010-10-11 10:56:41 -03001200#endif /* _MEDIA_VIDEOBUF2_CORE_H */