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