]> git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blame - include/media/videobuf2-core.h
Merge tag 'clk-fixes-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git...
[mirror_ubuntu-eoan-kernel.git] / include / media / videobuf2-core.h
CommitLineData
e23ccc0a 1/*
c139990e 2 * videobuf2-core.h - Video Buffer 2 Core Framework
e23ccc0a
PO
3 *
4 * Copyright (C) 2010 Samsung Electronics
5 *
95072084 6 * Author: Pawel Osciak <pawel@osciak.com>
e23ccc0a
PO
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation.
11 */
12#ifndef _MEDIA_VIDEOBUF2_CORE_H
13#define _MEDIA_VIDEOBUF2_CORE_H
14
15#include <linux/mm_types.h>
16#include <linux/mutex.h>
17#include <linux/poll.h>
c5384048 18#include <linux/dma-buf.h>
37bc2d87 19#include <linux/bitops.h>
1cf96dcc 20#include <media/media-request.h>
e23ccc0a 21
bed04f93
JS
22#define VB2_MAX_FRAME (32)
23#define VB2_MAX_PLANES (8)
24
52839f66
MCC
25/**
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 */
bed04f93
JS
39enum vb2_memory {
40 VB2_MEMORY_UNKNOWN = 0,
41 VB2_MEMORY_MMAP = 1,
42 VB2_MEMORY_USERPTR = 2,
43 VB2_MEMORY_DMABUF = 4,
44};
45
b25748fe 46struct vb2_fileio_data;
3415a89f 47struct vb2_threadio_data;
e23ccc0a
PO
48
49/**
2b141324 50 * struct vb2_mem_ops - memory handling/memory allocator operations.
e23ccc0a 51 * @alloc: allocate video memory and, optionally, allocator private data,
0ff657b0 52 * return ERR_PTR() on failure or a pointer to allocator private,
e23ccc0a 53 * per-buffer data on success; the returned private structure
f286f4df 54 * will then be passed as @buf_priv argument to other ops in this
b6ba2057
HV
55 * 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.
e23ccc0a
PO
58 * @put: inform the allocator that the buffer will no longer be used;
59 * usually will result in the allocator freeing the buffer (if
f286f4df 60 * no other users of this buffer are present); the @buf_priv
e23ccc0a 61 * argument is the allocator private per-buffer structure
3f12e6b0 62 * previously returned from the alloc callback.
32d81b41
MCC
63 * @get_dmabuf: acquire userspace memory for a hardware operation; used for
64 * DMABUF memory types.
e23ccc0a
PO
65 * @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
0ff657b0 69 * associated with the buffer on success, ERR_PTR() on failure;
f286f4df 70 * the returned private structure will then be passed as @buf_priv
3f12e6b0 71 * argument to other ops in this structure.
e23ccc0a 72 * @put_userptr: inform the allocator that a USERPTR buffer will no longer
3f12e6b0 73 * be used.
60e7926b 74 * @attach_dmabuf: attach a shared &struct dma_buf for a hardware operation;
36c0f8b3 75 * used for DMABUF memory types; dev is the alloc device
0ff657b0 76 * dbuf is the shared dma_buf; returns ERR_PTR() on failure;
c5384048 77 * allocator private per-buffer structure on success;
3f12e6b0 78 * this needs to be used for further accesses to the buffer.
c5384048 79 * @detach_dmabuf: inform the exporter of the buffer that the current DMABUF
f286f4df 80 * buffer is no longer used; the @buf_priv argument is the
c5384048 81 * allocator private per-buffer structure previously returned
3f12e6b0 82 * from the attach_dmabuf callback.
c5384048
SS
83 * @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
3f12e6b0 85 * dmabuf.
c5384048 86 * @unmap_dmabuf: releases access control to the dmabuf - allocator is notified
3f12e6b0 87 * that this driver is done using the dmabuf for now.
3e0c2f20 88 * @prepare: called every time the buffer is passed from userspace to the
3f12e6b0 89 * driver, useful for cache synchronisation, optional.
3e0c2f20 90 * @finish: called every time the buffer is passed back from the driver
3f12e6b0 91 * to the userspace, also optional.
e23ccc0a
PO
92 * @vaddr: return a kernel virtual address to a given memory buffer
93 * associated with the passed private structure or NULL if no
3f12e6b0 94 * such mapping exists.
e23ccc0a
PO
95 * @cookie: return allocator specific cookie for a given memory buffer
96 * associated with the passed private structure or NULL if not
3f12e6b0 97 * available.
e23ccc0a
PO
98 * @num_users: return the current number of users of a memory buffer;
99 * return 1 if the videobuf layer (or actually the driver using
3f12e6b0 100 * it) is the only user.
e23ccc0a 101 * @mmap: setup a userspace mapping for a given memory buffer under
3f12e6b0 102 * the provided virtual memory region.
e23ccc0a 103 *
89cb3ddb
MCC
104 * 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 *
f286f4df
MCC
114 * #) Required ops for DMABUF types: attach_dmabuf, detach_dmabuf,
115 * map_dmabuf, unmap_dmabuf.
e23ccc0a
PO
116 */
117struct vb2_mem_ops {
00085f1e 118 void *(*alloc)(struct device *dev, unsigned long attrs,
f286f4df
MCC
119 unsigned long size,
120 enum dma_data_direction dma_dir,
d935c57e 121 gfp_t gfp_flags);
e23ccc0a 122 void (*put)(void *buf_priv);
ea3aba84 123 struct dma_buf *(*get_dmabuf)(void *buf_priv, unsigned long flags);
e23ccc0a 124
36c0f8b3 125 void *(*get_userptr)(struct device *dev, unsigned long vaddr,
cd474037
HV
126 unsigned long size,
127 enum dma_data_direction dma_dir);
e23ccc0a
PO
128 void (*put_userptr)(void *buf_priv);
129
3e0c2f20
MS
130 void (*prepare)(void *buf_priv);
131 void (*finish)(void *buf_priv);
132
f286f4df
MCC
133 void *(*attach_dmabuf)(struct device *dev,
134 struct dma_buf *dbuf,
cd474037
HV
135 unsigned long size,
136 enum dma_data_direction dma_dir);
c5384048
SS
137 void (*detach_dmabuf)(void *buf_priv);
138 int (*map_dmabuf)(void *buf_priv);
139 void (*unmap_dmabuf)(void *buf_priv);
140
e23ccc0a
PO
141 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
2d700715 149/**
2b141324
MCC
150 * struct vb2_plane - plane information.
151 * @mem_priv: private data with this plane.
152 * @dbuf: dma_buf - shared buffer object.
2d700715 153 * @dbuf_mapped: flag to show whether dbuf is mapped or not
2b141324
MCC
154 * @bytesused: number of bytes occupied by data in the plane (payload).
155 * @length: size of this plane (NOT the payload) in bytes.
58e1ba3c
HV
156 * @min_length: minimum required size of this plane (NOT the payload) in bytes.
157 * @length is always greater or equal to @min_length.
2b141324 158 * @m: Union with memtype-specific data.
60e7926b
MCC
159 * @m.offset: when memory in the associated struct vb2_buffer is
160 * %VB2_MEMORY_MMAP, equals the offset from the start of
2d700715 161 * the device memory for this plane (or is a "cookie" that
2b141324 162 * should be passed to mmap() called on the video node).
60e7926b 163 * @m.userptr: when memory is %VB2_MEMORY_USERPTR, a userspace pointer
2b141324 164 * pointing to this plane.
60e7926b 165 * @m.fd: when memory is %VB2_MEMORY_DMABUF, a userspace file
2b141324 166 * descriptor associated with this plane.
2d700715 167 * @data_offset: offset in the plane to the start of data; usually 0,
2b141324
MCC
168 * unless there is a header in front of the data.
169 *
2d700715 170 * Should contain enough information to be able to cover all the fields
2b141324 171 * of &struct v4l2_plane at videodev2.h.
2d700715 172 */
e23ccc0a
PO
173struct vb2_plane {
174 void *mem_priv;
c5384048
SS
175 struct dma_buf *dbuf;
176 unsigned int dbuf_mapped;
2d700715
JS
177 unsigned int bytesused;
178 unsigned int length;
58e1ba3c 179 unsigned int min_length;
2d700715
JS
180 union {
181 unsigned int offset;
182 unsigned long userptr;
183 int fd;
184 } m;
185 unsigned int data_offset;
e23ccc0a
PO
186};
187
188/**
2b141324
MCC
189 * 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.
e23ccc0a
PO
195 */
196enum vb2_io_modes {
37bc2d87
MCC
197 VB2_MMAP = BIT(0),
198 VB2_USERPTR = BIT(1),
199 VB2_READ = BIT(2),
200 VB2_WRITE = BIT(3),
201 VB2_DMABUF = BIT(4),
e23ccc0a
PO
202};
203
e23ccc0a 204/**
2b141324
MCC
205 * enum vb2_buffer_state - current video buffer state.
206 * @VB2_BUF_STATE_DEQUEUED: buffer under userspace control.
fd89e0bb 207 * @VB2_BUF_STATE_IN_REQUEST: buffer is queued in media request.
2b141324 208 * @VB2_BUF_STATE_PREPARING: buffer is being prepared in videobuf.
2b141324
MCC
209 * @VB2_BUF_STATE_QUEUED: buffer queued in videobuf, but not in driver.
210 * @VB2_BUF_STATE_REQUEUEING: re-queue a buffer to the driver.
e23ccc0a 211 * @VB2_BUF_STATE_ACTIVE: buffer queued in driver and possibly used
2b141324 212 * in a hardware operation.
e23ccc0a 213 * @VB2_BUF_STATE_DONE: buffer returned from driver to videobuf, but
2b141324 214 * not yet dequeued to userspace.
e23ccc0a
PO
215 * @VB2_BUF_STATE_ERROR: same as above, but the operation on the buffer
216 * has ended with an error, which will be reported
2b141324 217 * to the userspace when it is dequeued.
e23ccc0a
PO
218 */
219enum vb2_buffer_state {
220 VB2_BUF_STATE_DEQUEUED,
fd89e0bb 221 VB2_BUF_STATE_IN_REQUEST,
b18a8ff2 222 VB2_BUF_STATE_PREPARING,
e23ccc0a 223 VB2_BUF_STATE_QUEUED,
6d058c56 224 VB2_BUF_STATE_REQUEUEING,
e23ccc0a
PO
225 VB2_BUF_STATE_ACTIVE,
226 VB2_BUF_STATE_DONE,
227 VB2_BUF_STATE_ERROR,
228};
229
230struct vb2_queue;
231
232/**
2b141324
MCC
233 * 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.
e23ccc0a 239 * @num_planes: number of planes in the buffer
2b141324
MCC
240 * on an internal driver queue.
241 * @timestamp: frame timestamp in ns.
1cf96dcc
HV
242 * @req_obj: used to bind this buffer to a request. This
243 * request object has a refcount.
e23ccc0a
PO
244 */
245struct vb2_buffer {
e23ccc0a 246 struct vb2_queue *vb2_queue;
2d700715
JS
247 unsigned int index;
248 unsigned int type;
249 unsigned int memory;
e23ccc0a 250 unsigned int num_planes;
d6dd645e 251 u64 timestamp;
1cf96dcc 252 struct media_request_object req_obj;
e23ccc0a 253
efe98010
MCC
254 /* private: internal use only
255 *
256 * state: current buffer state; do not change
55028695
HV
257 * 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.
efe98010
MCC
263 * 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
2b141324 267 * vb2_plane: per-plane information; do not change
efe98010 268 */
e23ccc0a 269 enum vb2_buffer_state state;
55028695
HV
270 bool synced;
271 bool prepared;
e23ccc0a 272
2b141324 273 struct vb2_plane planes[VB2_MAX_PLANES];
e23ccc0a
PO
274 struct list_head queued_entry;
275 struct list_head done_entry;
b5b4541e
HV
276#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;
fd89e0bb 302 u32 cnt_buf_request_complete;
b5b4541e
HV
303
304 /* This counts the number of calls to vb2_buffer_done() */
305 u32 cnt_buf_done;
306#endif
e23ccc0a
PO
307};
308
309/**
2b141324 310 * struct vb2_ops - driver-specific callbacks.
e23ccc0a 311 *
3f97df91
LC
312 * These operations are not called from interrupt context except where
313 * mentioned specifically.
314 *
f286f4df 315 * @queue_setup: called from VIDIOC_REQBUFS() and VIDIOC_CREATE_BUFS()
df9ecb0c
HV
316 * 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
89cb3ddb
MCC
322 * in \*num_buffers, the required number of planes per
323 * buffer in \*num_planes, the size of each plane should be
564aaf69
MCC
324 * set in the sizes\[\] array and optional per-plane
325 * allocator specific device in the alloc_devs\[\] array.
e5c27ef3 326 * When called from VIDIOC_REQBUFS(), \*num_planes == 0,
f286f4df 327 * the driver has to use the currently configured format to
89cb3ddb 328 * determine the plane sizes and \*num_buffers is the total
df9ecb0c 329 * number of buffers that are being allocated. When called
e5c27ef3 330 * from VIDIOC_CREATE_BUFS(), \*num_planes != 0 and it
564aaf69 331 * describes the requested number of planes and sizes\[\]
e5c27ef3
AL
332 * 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.
e23ccc0a
PO
336 * @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
3f12e6b0 339 * blocking access type.
e23ccc0a
PO
340 * @wait_finish: reacquire all locks released in the previous callback;
341 * required to continue operation after sleeping while
3f12e6b0 342 * waiting for a new buffer to arrive.
e23ccc0a
PO
343 * @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
3f12e6b0 347 * queue setup from completing successfully; optional.
2d86401c 348 * @buf_prepare: called every time the buffer is queued from userspace
f286f4df 349 * and from the VIDIOC_PREPARE_BUF() ioctl; drivers may
cf227429
HV
350 * 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
f286f4df 353 * the CPU; drivers that support VIDIOC_CREATE_BUFS() must
cf227429
HV
354 * also validate the buffer size; if an error is returned,
355 * the buffer will not be queued in driver; optional.
e23ccc0a 356 * @buf_finish: called before every dequeue of the buffer back to
cf227429
HV
357 * 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
564aaf69
MCC
361 * one of the following: %DONE and %ERROR occur while
362 * streaming is in progress, and the %PREPARED state occurs
cf227429 363 * when the queue has been canceled and all pending
564aaf69 364 * buffers are being returned to their default %DEQUEUED
cf227429 365 * state. Typically you only have to do something if the
564aaf69 366 * state is %VB2_BUF_STATE_DONE, since in all other cases
cf227429 367 * the buffer contents will be ignored anyway.
e23ccc0a 368 * @buf_cleanup: called once before the buffer is freed; drivers may
3f12e6b0 369 * perform any additional cleanup; optional.
bd323e28 370 * @start_streaming: called once to enter 'streaming' state; the driver may
564aaf69
MCC
371 * 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
68a06bd0
LC
377 * 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.
e23ccc0a
PO
383 * @stop_streaming: called when 'streaming' state must be disabled; driver
384 * should stop any DMA transactions or wait until they
564aaf69 385 * finish and give back all buffers it got from &buf_queue
f286f4df 386 * callback by calling vb2_buffer_done() with either
564aaf69 387 * %VB2_BUF_STATE_DONE or %VB2_BUF_STATE_ERROR; may use
ccf58cb4 388 * vb2_wait_for_all_buffers() function
e23ccc0a
PO
389 * @buf_queue: passes buffer vb to the driver; driver may start
390 * hardware operation on this buffer; driver should give
bd323e28 391 * the buffer back by calling vb2_buffer_done() function;
f286f4df
MCC
392 * 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().
fd89e0bb
HV
396 * @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.
e23ccc0a
PO
401 */
402struct vb2_ops {
df9ecb0c 403 int (*queue_setup)(struct vb2_queue *q,
fc714e70 404 unsigned int *num_buffers, unsigned int *num_planes,
36c0f8b3 405 unsigned int sizes[], struct device *alloc_devs[]);
e23ccc0a
PO
406
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);
06470642 412 void (*buf_finish)(struct vb2_buffer *vb);
e23ccc0a
PO
413 void (*buf_cleanup)(struct vb2_buffer *vb);
414
bd323e28 415 int (*start_streaming)(struct vb2_queue *q, unsigned int count);
e37559b2 416 void (*stop_streaming)(struct vb2_queue *q);
e23ccc0a
PO
417
418 void (*buf_queue)(struct vb2_buffer *vb);
fd89e0bb
HV
419
420 void (*buf_request_complete)(struct vb2_buffer *vb);
e23ccc0a
PO
421};
422
10cc3b1e 423/**
2b141324 424 * struct vb2_buf_ops - driver-specific callbacks.
10cc3b1e 425 *
e7e0c3e2
SA
426 * @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.
8e013700
HV
429 * @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.
60e7926b 432 * @fill_user_buffer: given a &vb2_buffer fill in the userspace structure.
2b141324 433 * For V4L2 this is a &struct v4l2_buffer.
60e7926b 434 * @fill_vb2_buffer: given a userspace structure, fill in the &vb2_buffer.
10cc3b1e
HV
435 * 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
2b141324 438 * the &struct vb2_buffer.
10cc3b1e 439 */
b0e0e1f8 440struct vb2_buf_ops {
e7e0c3e2 441 int (*verify_planes_array)(struct vb2_buffer *vb, const void *pb);
8e013700 442 void (*init_buffer)(struct vb2_buffer *vb);
10cc3b1e 443 void (*fill_user_buffer)(struct vb2_buffer *vb, void *pb);
db6e8d57 444 int (*fill_vb2_buffer)(struct vb2_buffer *vb, struct vb2_plane *planes);
10cc3b1e 445 void (*copy_timestamp)(struct vb2_buffer *vb, const void *pb);
b0e0e1f8 446};
5a5adf6b 447
e23ccc0a 448/**
2b141324 449 * struct vb2_queue - a videobuf queue.
e23ccc0a 450 *
bed04f93
JS
451 * @type: private buffer type whose content is defined by the vb2-core
452 * caller. For example, for V4L2, it should match
2b141324
MCC
453 * 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
20be7ab8 456 * @dev: device to use for the default allocation context if the driver
36c0f8b3 457 * doesn't fill in the @alloc_devs array.
00085f1e 458 * @dma_attrs: DMA attributes to use for the DMA.
5b6f9abe 459 * @bidirectional: when this flag is set the DMA direction for the buffers of
60e7926b 460 * this queue will be overridden with %DMA_BIDIRECTIONAL direction.
5b6f9abe 461 * This is useful in cases where the hardware (firmware) writes to
60e7926b
MCC
462 * 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
5b6f9abe
SV
464 * 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.
06e7a9b6
KD
469 * @fileio_read_once: report EOF after reading the first buffer
470 * @fileio_write_immediately: queue buffer after each write() call
f61bf13b 471 * @allow_zero_bytesused: allow bytesused == 0 to be passed to the driver
a9a08845 472 * @quirk_poll_must_check_waiting_for_buffers: Return %EPOLLERR at poll when QBUF
b9387684
RRD
473 * has not been called. This is a vb1 idiom that has been adopted
474 * also by vb2.
e5079cf1 475 * @supports_requests: this queue supports the Request API.
61add367
HV
476 * @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.
2b141324 482 * @lock: pointer to a mutex that protects the &struct vb2_queue. The
5a5adf6b
HV
483 * 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.
e23ccc0a
PO
491 * @ops: driver-specific callbacks
492 * @mem_ops: memory allocator specific callbacks
2b141324
MCC
493 * @buf_ops: callbacks to deliver buffer information.
494 * between user-space and kernel-space.
495 * @drv_priv: driver private data.
e23ccc0a
PO
496 * @buf_struct_size: size of the driver-specific buffer structure;
497 * "0" indicates the driver doesn't want to use a custom buffer
2b141324 498 * structure type. for example, ``sizeof(struct vb2_v4l2_buffer)``
2d700715 499 * will be used for v4l2.
2b141324
MCC
500 * @timestamp_flags: Timestamp flags; ``V4L2_BUF_FLAG_TIMESTAMP_*`` and
501 * ``V4L2_BUF_FLAG_TSTAMP_SRC_*``
b6ba2057 502 * @gfp_flags: additional gfp flags used when allocating the buffers.
60e7926b 503 * Typically this is 0, but it may be e.g. %GFP_DMA or %__GFP_DMA32
b6ba2057 504 * to force the buffer allocation to a specific memory zone.
b3379c62 505 * @min_buffers_needed: the minimum number of buffers needed before
f286f4df 506 * @start_streaming can be called. Used when a DMA engine
b3379c62
HV
507 * cannot be started unless at least this number of buffers
508 * have been queued into the driver.
d78757e7
MCC
509 */
510/*
f286f4df 511 * Private elements (won't appear at the uAPI book):
f035eb4e 512 * @mmap_lock: private mutex used when buffers are allocated/freed/mmapped
e23ccc0a 513 * @memory: current memory type used
5b6f9abe 514 * @dma_dir: DMA mapping direction.
e23ccc0a
PO
515 * @bufs: videobuf buffer structures
516 * @num_buffers: number of allocated/used buffers
517 * @queued_list: list of buffers currently queued from userspace
b3379c62 518 * @queued_count: number of buffers queued and ready for streaming.
6ea3b980 519 * @owned_by_drv_count: number of buffers owned by the driver
e23ccc0a
PO
520 * @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
e23ccc0a 523 * @streaming: current streaming state
f286f4df 524 * @start_streaming_called: @start_streaming was called successfully and we
b3379c62 525 * started streaming.
4bb7267d 526 * @error: a fatal error occurred on the queue
58d75f4b
HV
527 * @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
a9a08845 529 * called since poll() needs to return %EPOLLERR in that situation.
bed04f93
JS
530 * @is_multiplanar: set if buffer type is multiplanar
531 * @is_output: set if buffer type is output
959c3ef3 532 * @copy_timestamp: set if vb2-core should set timestamps
c1621840
PZ
533 * @last_buffer_dequeued: used in poll() and DQBUF to immediately return if the
534 * last decoded buffer was already dequeued. Set for capture queues
60e7926b 535 * when a buffer with the %V4L2_BUF_FLAG_LAST is dequeued.
b25748fe 536 * @fileio: file io emulator internal data, used only if emulator is active
3415a89f 537 * @threadio: thread io internal data, used only if thread is active
e23ccc0a
PO
538 */
539struct vb2_queue {
bed04f93 540 unsigned int type;
e23ccc0a 541 unsigned int io_modes;
20be7ab8 542 struct device *dev;
00085f1e 543 unsigned long dma_attrs;
5b6f9abe 544 unsigned bidirectional:1;
06e7a9b6
KD
545 unsigned fileio_read_once:1;
546 unsigned fileio_write_immediately:1;
f61bf13b 547 unsigned allow_zero_bytesused:1;
b9387684 548 unsigned quirk_poll_must_check_waiting_for_buffers:1;
e5079cf1 549 unsigned supports_requests:1;
61add367
HV
550 unsigned uses_qbuf:1;
551 unsigned uses_requests:1;
06e7a9b6 552
5a5adf6b 553 struct mutex *lock;
bed04f93 554 void *owner;
e23ccc0a
PO
555
556 const struct vb2_ops *ops;
557 const struct vb2_mem_ops *mem_ops;
b0e0e1f8
JS
558 const struct vb2_buf_ops *buf_ops;
559
e23ccc0a
PO
560 void *drv_priv;
561 unsigned int buf_struct_size;
ade48681 562 u32 timestamp_flags;
b6ba2057 563 gfp_t gfp_flags;
b3379c62 564 u32 min_buffers_needed;
e23ccc0a 565
2b141324
MCC
566 struct device *alloc_devs[VB2_MAX_PLANES];
567
d78757e7 568 /* private: internal use only */
f035eb4e 569 struct mutex mmap_lock;
bed04f93 570 unsigned int memory;
5b6f9abe 571 enum dma_data_direction dma_dir;
bed04f93 572 struct vb2_buffer *bufs[VB2_MAX_FRAME];
e23ccc0a
PO
573 unsigned int num_buffers;
574
575 struct list_head queued_list;
b3379c62 576 unsigned int queued_count;
e23ccc0a 577
6ea3b980 578 atomic_t owned_by_drv_count;
e23ccc0a
PO
579 struct list_head done_list;
580 spinlock_t done_lock;
581 wait_queue_head_t done_wq;
582
e23ccc0a 583 unsigned int streaming:1;
b3379c62 584 unsigned int start_streaming_called:1;
4bb7267d 585 unsigned int error:1;
58d75f4b 586 unsigned int waiting_for_buffers:1;
bed04f93
JS
587 unsigned int is_multiplanar:1;
588 unsigned int is_output:1;
959c3ef3 589 unsigned int copy_timestamp:1;
c1621840 590 unsigned int last_buffer_dequeued:1;
b25748fe
MS
591
592 struct vb2_fileio_data *fileio;
3415a89f 593 struct vb2_threadio_data *threadio;
b5b4541e
HV
594
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
e23ccc0a
PO
606};
607
88b7eb09 608/**
2b141324
MCC
609 * 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.
88b7eb09
MCC
613 *
614 * This function returns a kernel virtual address of a given plane if
615 * such a mapping exist, NULL otherwise.
616 */
e23ccc0a 617void *vb2_plane_vaddr(struct vb2_buffer *vb, unsigned int plane_no);
88b7eb09
MCC
618
619/**
2b141324
MCC
620 * 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.
88b7eb09
MCC
624 *
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 */
e23ccc0a
PO
631void *vb2_plane_cookie(struct vb2_buffer *vb, unsigned int plane_no);
632
88b7eb09 633/**
2b141324
MCC
634 * 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
f286f4df 639 * successfully, %VB2_BUF_STATE_ERROR if the operation finished
68a06bd0
LC
640 * 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).
88b7eb09
MCC
643 *
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
f286f4df
MCC
647 * 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.
88b7eb09
MCC
649 *
650 * While streaming a buffer can only be returned in state DONE or ERROR.
45ad3999
LC
651 * 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
68a06bd0
LC
653 * 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.
88b7eb09 659 */
e23ccc0a 660void vb2_buffer_done(struct vb2_buffer *vb, enum vb2_buffer_state state);
88b7eb09
MCC
661
662/**
2b141324
MCC
663 * vb2_discard_done() - discard all buffers marked as DONE.
664 * @q: pointer to &struct vb2_queue with videobuf2 queue.
88b7eb09
MCC
665 *
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 */
34ea4d44 674void vb2_discard_done(struct vb2_queue *q);
88b7eb09
MCC
675
676/**
2b141324
MCC
677 * vb2_wait_for_all_buffers() - wait until all buffers are given back to vb2.
678 * @q: pointer to &struct vb2_queue with videobuf2 queue.
88b7eb09
MCC
679 *
680 * This function will wait until all buffers that have been given to the driver
f286f4df 681 * by &vb2_ops->buf_queue are given back to vb2 with vb2_buffer_done(). It
2b141324
MCC
682 * 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.
88b7eb09 685 */
e23ccc0a
PO
686int vb2_wait_for_all_buffers(struct vb2_queue *q);
687
88b7eb09 688/**
2b141324
MCC
689 * 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.
693 *
991232a9
MCC
694 * Videobuf2 core helper to implement VIDIOC_QUERYBUF() operation. It is called
695 * internally by VB2 by an API-specific handler, like ``videobuf2-v4l2.h``.
88b7eb09 696 *
88b7eb09 697 * The passed buffer should have been verified.
2b141324 698 *
88b7eb09 699 * This function fills the relevant information for the userspace.
991232a9
MCC
700 *
701 * Return: returns zero on success; an error code otherwise.
88b7eb09 702 */
10cc3b1e 703void vb2_core_querybuf(struct vb2_queue *q, unsigned int index, void *pb);
88b7eb09
MCC
704
705/**
2b141324
MCC
706 * 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.
88b7eb09 710 *
991232a9
MCC
711 * Videobuf2 core helper to implement VIDIOC_REQBUF() operation. It is called
712 * internally by VB2 by an API-specific handler, like ``videobuf2-v4l2.h``.
f286f4df 713 *
88b7eb09 714 * This function:
f286f4df 715 *
991232a9
MCC
716 * #) verifies streaming parameters passed from the userspace;
717 * #) sets up the queue;
f286f4df 718 * #) negotiates number of buffers and planes per buffer with the driver
991232a9 719 * to be used during streaming;
60e7926b 720 * #) allocates internal buffer structures (&struct vb2_buffer), according to
991232a9 721 * the agreed parameters;
f286f4df 722 * #) for MMAP memory type, allocates actual video memory, using the
991232a9 723 * memory handling/allocation routines provided during queue initialization.
88b7eb09
MCC
724 *
725 * If req->count is 0, all the memory will be freed instead.
88b7eb09 726 *
2b141324
MCC
727 * 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.
88b7eb09 729 *
991232a9 730 * Return: returns zero on success; an error code otherwise.
88b7eb09 731 */
3c5be988
JS
732int vb2_core_reqbufs(struct vb2_queue *q, enum vb2_memory memory,
733 unsigned int *count);
88b7eb09
MCC
734
735/**
736 * vb2_core_create_bufs() - Allocate buffers and any required auxiliary structs
2b141324
MCC
737 * @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.
742 *
991232a9
MCC
743 * 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``.
88b7eb09 746 *
88b7eb09 747 * This function:
88b7eb09 748 *
991232a9
MCC
749 * #) verifies parameter sanity;
750 * #) calls the &vb2_ops->queue_setup queue operation;
751 * #) performs any necessary memory allocations.
f286f4df 752 *
991232a9 753 * Return: returns zero on success; an error code otherwise.
88b7eb09 754 */
3c5be988 755int vb2_core_create_bufs(struct vb2_queue *q, enum vb2_memory memory,
f286f4df
MCC
756 unsigned int *count, unsigned int requested_planes,
757 const unsigned int requested_sizes[]);
88b7eb09
MCC
758
759/**
760 * vb2_core_prepare_buf() - Pass ownership of a buffer from userspace
2b141324
MCC
761 * 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.
766 *
991232a9
MCC
767 * 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``.
88b7eb09 770 *
88b7eb09 771 * The passed buffer should have been verified.
88b7eb09 772 *
991232a9
MCC
773 * This function calls vb2_ops->buf_prepare callback in the driver
774 * (if provided), in which driver-specific buffer initialization can
775 * be performed.
88b7eb09 776 *
991232a9 777 * Return: returns zero on success; an error code otherwise.
88b7eb09 778 */
3c5be988 779int vb2_core_prepare_buf(struct vb2_queue *q, unsigned int index, void *pb);
88b7eb09
MCC
780
781/**
782 * vb2_core_qbuf() - Queue a buffer from userspace
f286f4df 783 *
2b141324 784 * @q: pointer to &struct vb2_queue with videobuf2 queue.
88b7eb09 785 * @index: id number of the buffer
2b141324
MCC
786 * @pb: buffer structure passed from userspace to
787 * v4l2_ioctl_ops->vidioc_qbuf handler in driver
fd89e0bb 788 * @req: pointer to &struct media_request, may be NULL.
88b7eb09 789 *
991232a9
MCC
790 * Videobuf2 core helper to implement VIDIOC_QBUF() operation. It is called
791 * internally by VB2 by an API-specific handler, like ``videobuf2-v4l2.h``.
f286f4df 792 *
88b7eb09 793 * This function:
f286f4df 794 *
fd89e0bb
HV
795 * #) 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.
991232a9
MCC
799 * #) if necessary, calls &vb2_ops->buf_prepare callback in the driver
800 * (if provided), in which driver-specific buffer initialization can
801 * be performed;
f286f4df
MCC
802 * #) if streaming is on, queues the buffer in driver by the means of
803 * &vb2_ops->buf_queue callback for processing.
88b7eb09 804 *
991232a9 805 * Return: returns zero on success; an error code otherwise.
88b7eb09 806 */
fd89e0bb
HV
807int vb2_core_qbuf(struct vb2_queue *q, unsigned int index, void *pb,
808 struct media_request *req);
88b7eb09
MCC
809
810/**
811 * vb2_core_dqbuf() - Dequeue a buffer to the userspace
2b141324 812 * @q: pointer to &struct vb2_queue with videobuf2 queue
88b7eb09 813 * @pindex: pointer to the buffer index. May be NULL
2b141324
MCC
814 * @pb: buffer structure passed from userspace to
815 * v4l2_ioctl_ops->vidioc_dqbuf handler in driver.
88b7eb09
MCC
816 * @nonblocking: if true, this call will not sleep waiting for a buffer if no
817 * buffers ready for dequeuing are present. Normally the driver
2b141324 818 * would be passing (file->f_flags & O_NONBLOCK) here.
88b7eb09 819 *
991232a9
MCC
820 * Videobuf2 core helper to implement VIDIOC_DQBUF() operation. It is called
821 * internally by VB2 by an API-specific handler, like ``videobuf2-v4l2.h``.
f286f4df 822 *
88b7eb09 823 * This function:
f286f4df
MCC
824 *
825 * #) calls buf_finish callback in the driver (if provided), in which
88b7eb09
MCC
826 * driver can perform any additional operations that may be required before
827 * returning the buffer to userspace, such as cache sync,
f286f4df 828 * #) the buffer struct members are filled with relevant information for
88b7eb09
MCC
829 * the userspace.
830 *
991232a9 831 * Return: returns zero on success; an error code otherwise.
88b7eb09 832 */
fac710e4
HV
833int vb2_core_dqbuf(struct vb2_queue *q, unsigned int *pindex, void *pb,
834 bool nonblocking);
e23ccc0a 835
8dcde47f
MCC
836/**
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 *
991232a9
MCC
843 * 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.
8dcde47f 847 */
3c5be988 848int vb2_core_streamon(struct vb2_queue *q, unsigned int type);
8dcde47f
MCC
849
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 *
991232a9
MCC
857 * 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.
8dcde47f 862 */
3c5be988 863int vb2_core_streamoff(struct vb2_queue *q, unsigned int type);
2d86401c 864
88b7eb09 865/**
2b141324
MCC
866 * 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.
88b7eb09 872 * @plane: index of the plane to be exported, 0 for single plane queues
2b141324
MCC
873 * @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.
88b7eb09 877 *
991232a9
MCC
878 *
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.
88b7eb09 883 */
3c5be988
JS
884int vb2_core_expbuf(struct vb2_queue *q, int *fd, unsigned int type,
885 unsigned int index, unsigned int plane, unsigned int flags);
e23ccc0a 886
88b7eb09
MCC
887/**
888 * vb2_core_queue_init() - initialize a videobuf2 queue
2b141324
MCC
889 * @q: pointer to &struct vb2_queue with videobuf2 queue.
890 * This structure should be allocated in driver
88b7eb09 891 *
60e7926b 892 * The &vb2_queue structure should be allocated by the driver. The driver is
88b7eb09
MCC
893 * responsible of clearing it's content and setting initial values for some
894 * required entries before calling this function.
2b141324
MCC
895 *
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.
88b7eb09 900 */
3c5be988 901int vb2_core_queue_init(struct vb2_queue *q);
88b7eb09
MCC
902
903/**
904 * vb2_core_queue_release() - stop streaming, release the queue and free memory
2b141324 905 * @q: pointer to &struct vb2_queue with videobuf2 queue.
88b7eb09
MCC
906 *
907 * This function stops streaming and performs necessary clean ups, including
908 * freeing video buffer memory. The driver is responsible for freeing
2b141324 909 * the &struct vb2_queue itself.
88b7eb09 910 */
3c5be988 911void vb2_core_queue_release(struct vb2_queue *q);
e23ccc0a 912
88b7eb09
MCC
913/**
914 * vb2_queue_error() - signal a fatal error on the queue
2b141324 915 * @q: pointer to &struct vb2_queue with videobuf2 queue.
88b7eb09
MCC
916 *
917 * Flag that a fatal unrecoverable error has occurred and wake up all processes
a9a08845 918 * waiting on the queue. Polling will now set %EPOLLERR and queuing and dequeuing
2b141324 919 * buffers will return %-EIO.
88b7eb09 920 *
60e7926b
MCC
921 * 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
88b7eb09
MCC
923 * function before starting the stream, otherwise the error flag will remain set
924 * until the queue is released when closing the device node.
925 */
3c5be988 926void vb2_queue_error(struct vb2_queue *q);
e23ccc0a 927
88b7eb09 928/**
2b141324
MCC
929 * 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.
88b7eb09
MCC
933 *
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
2b141324
MCC
940 * 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 *
88b7eb09
MCC
944 * 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 */
e23ccc0a 950int vb2_mmap(struct vb2_queue *q, struct vm_area_struct *vma);
f286f4df 951
6f524ec1 952#ifndef CONFIG_MMU
8dcde47f
MCC
953/**
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 */
6f524ec1
SJ
968unsigned 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
88b7eb09
MCC
974
975/**
8dcde47f 976 * vb2_core_poll() - implements poll syscall() logic.
2b141324
MCC
977 * @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.
88b7eb09
MCC
982 *
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 */
c23e0cb8 993__poll_t vb2_core_poll(struct vb2_queue *q, struct file *file,
f286f4df
MCC
994 poll_table *wait);
995
8dcde47f
MCC
996/**
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 */
af3bac1a
JS
1004size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count,
1005 loff_t *ppos, int nonblock);
8dcde47f
MCC
1006/**
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 */
af3bac1a
JS
1014size_t vb2_write(struct vb2_queue *q, const char __user *data, size_t count,
1015 loff_t *ppos, int nonblock);
1016
f286f4df 1017/**
2b141324 1018 * typedef vb2_thread_fnc - callback function for use with vb2_thread.
f286f4df 1019 *
2b141324
MCC
1020 * @vb: pointer to struct &vb2_buffer.
1021 * @priv: pointer to a private data.
af3bac1a
JS
1022 *
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.
2b141324
MCC
1029 * @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.
af3bac1a
JS
1032 * @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
2b141324 1035 * or vb2_thread_stop() is called.
af3bac1a 1036 *
f286f4df
MCC
1037 * .. 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.
af3bac1a
JS
1042 */
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.
2b141324 1048 * @q: pointer to &struct vb2_queue with videobuf2 queue.
af3bac1a
JS
1049 */
1050int vb2_thread_stop(struct vb2_queue *q);
e23ccc0a
PO
1051
1052/**
2b141324
MCC
1053 * vb2_is_streaming() - return streaming status of the queue.
1054 * @q: pointer to &struct vb2_queue with videobuf2 queue.
e23ccc0a
PO
1055 */
1056static inline bool vb2_is_streaming(struct vb2_queue *q)
1057{
1058 return q->streaming;
1059}
1060
74753cff
HV
1061/**
1062 * vb2_fileio_is_active() - return true if fileio is active.
2b141324 1063 * @q: pointer to &struct vb2_queue with videobuf2 queue.
74753cff
HV
1064 *
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
2b141324 1068 * stream a format using %V4L2_FIELD_ALTERNATE is not allowed since there
74753cff
HV
1069 * 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
2b141324
MCC
1071 * this in the &vb2_ops->queue_setup op and reject it if this function returns
1072 * true.
74753cff
HV
1073 */
1074static inline bool vb2_fileio_is_active(struct vb2_queue *q)
1075{
1076 return q->fileio;
1077}
1078
e23ccc0a 1079/**
2b141324
MCC
1080 * vb2_is_busy() - return busy status of the queue.
1081 * @q: pointer to &struct vb2_queue with videobuf2 queue.
e23ccc0a
PO
1082 *
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/**
2b141324
MCC
1091 * vb2_get_drv_priv() - return driver private data associated with the queue.
1092 * @q: pointer to &struct vb2_queue with videobuf2 queue.
e23ccc0a
PO
1093 */
1094static inline void *vb2_get_drv_priv(struct vb2_queue *q)
1095{
1096 return q->drv_priv;
1097}
1098
1099/**
2b141324
MCC
1100 * 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.
e23ccc0a
PO
1105 */
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)
2d700715 1110 vb->planes[plane_no].bytesused = size;
e23ccc0a
PO
1111}
1112
1113/**
9f00edae 1114 * vb2_get_plane_payload() - get bytesused for the plane plane_no
2b141324
MCC
1115 * @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.
e23ccc0a
PO
1118 */
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)
2d700715 1123 return vb->planes[plane_no].bytesused;
e23ccc0a
PO
1124 return 0;
1125}
1126
1127/**
2b141324
MCC
1128 * 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.
e23ccc0a
PO
1132 */
1133static inline unsigned long
1134vb2_plane_size(struct vb2_buffer *vb, unsigned int plane_no)
1135{
1136 if (plane_no < vb->num_planes)
2d700715 1137 return vb->planes[plane_no].length;
e23ccc0a
PO
1138 return 0;
1139}
1140
ead13033 1141/**
2b141324
MCC
1142 * vb2_start_streaming_called() - return streaming status of driver.
1143 * @q: pointer to &struct vb2_queue with videobuf2 queue.
ead13033
PL
1144 */
1145static inline bool vb2_start_streaming_called(struct vb2_queue *q)
1146{
1147 return q->start_streaming_called;
1148}
1149
c1621840 1150/**
2b141324
MCC
1151 * vb2_clear_last_buffer_dequeued() - clear last buffer dequeued flag of queue.
1152 * @q: pointer to &struct vb2_queue with videobuf2 queue.
c1621840
PZ
1153 */
1154static inline void vb2_clear_last_buffer_dequeued(struct vb2_queue *q)
1155{
1156 q->last_buffer_dequeued = false;
1157}
1158
af3bac1a
JS
1159/*
1160 * The following functions are not part of the vb2 core API, but are useful
1161 * functions for videobuf2-*.
1162 */
88b7eb09
MCC
1163
1164/**
1165 * vb2_buffer_in_use() - return true if the buffer is in use and
2b141324 1166 * the queue cannot be freed (by the means of VIDIOC_REQBUFS(0)) call.
88b7eb09 1167 *
2b141324
MCC
1168 * @vb: buffer for which plane size should be returned.
1169 * @q: pointer to &struct vb2_queue with videobuf2 queue.
88b7eb09 1170 */
af3bac1a 1171bool vb2_buffer_in_use(struct vb2_queue *q, struct vb2_buffer *vb);
88b7eb09
MCC
1172
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.
f286f4df 1176 *
2b141324 1177 * @q: pointer to &struct vb2_queue with videobuf2 queue.
f286f4df
MCC
1178 * @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
2b141324 1181 * the types defined on enum &v4l2_buf_type.
88b7eb09 1182 */
af3bac1a
JS
1183int vb2_verify_memory_type(struct vb2_queue *q,
1184 enum vb2_memory memory, unsigned int type);
c07aa48e
HV
1185
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/**
515c5a73 1194 * vb2_request_buffer_cnt() - return the number of buffers in the request
c07aa48e
HV
1195 *
1196 * @req: the request.
1197 */
515c5a73 1198unsigned int vb2_request_buffer_cnt(struct media_request *req);
c07aa48e 1199
e23ccc0a 1200#endif /* _MEDIA_VIDEOBUF2_CORE_H */