1 /*
2  * videobuf2-core.h - Video Buffer 2 Core Framework
3  *
4  * Copyright (C) 2010 Samsung Electronics
5  *
6  * Author: Pawel Osciak <pawel@osciak.com>
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/dma-buf.h>
19 #include <linux/bitops.h>
20 #include <media/media-request.h>
21 #include <media/frame_vector.h>
22 
23 #define VB2_MAX_FRAME	(32)
24 #define VB2_MAX_PLANES	(8)
25 
26 /**
27  * enum vb2_memory - type of memory model used to make the buffers visible
28  *	on userspace.
29  *
30  * @VB2_MEMORY_UNKNOWN:	Buffer status is unknown or it is not used yet on
31  *			userspace.
32  * @VB2_MEMORY_MMAP:	The buffers are allocated by the Kernel and it is
33  *			memory mapped via mmap() ioctl. This model is
34  *			also used when the user is using the buffers via
35  *			read() or write() system calls.
36  * @VB2_MEMORY_USERPTR:	The buffers was allocated in userspace and it is
37  *			memory mapped via mmap() ioctl.
38  * @VB2_MEMORY_DMABUF:	The buffers are passed to userspace via DMA buffer.
39  */
40 enum vb2_memory {
41 	VB2_MEMORY_UNKNOWN	= 0,
42 	VB2_MEMORY_MMAP		= 1,
43 	VB2_MEMORY_USERPTR	= 2,
44 	VB2_MEMORY_DMABUF	= 4,
45 };
46 
47 struct vb2_fileio_data;
48 struct vb2_threadio_data;
49 
50 /**
51  * struct vb2_mem_ops - memory handling/memory allocator operations.
52  * @alloc:	allocate video memory and, optionally, allocator private data,
53  *		return ERR_PTR() on failure or a pointer to allocator private,
54  *		per-buffer data on success; the returned private structure
55  *		will then be passed as @buf_priv argument to other ops in this
56  *		structure. Additional gfp_flags to use when allocating the
57  *		are also passed to this operation. These flags are from the
58  *		gfp_flags field of vb2_queue. The size argument to this function
59  *		shall be *page aligned*.
60  * @put:	inform the allocator that the buffer will no longer be used;
61  *		usually will result in the allocator freeing the buffer (if
62  *		no other users of this buffer are present); the @buf_priv
63  *		argument is the allocator private per-buffer structure
64  *		previously returned from the alloc callback.
65  * @get_dmabuf: acquire userspace memory for a hardware operation; used for
66  *		 DMABUF memory types.
67  * @get_userptr: acquire userspace memory for a hardware operation; used for
68  *		 USERPTR memory types; vaddr is the address passed to the
69  *		 videobuf layer when queuing a video buffer of USERPTR type;
70  *		 should return an allocator private per-buffer structure
71  *		 associated with the buffer on success, ERR_PTR() on failure;
72  *		 the returned private structure will then be passed as @buf_priv
73  *		 argument to other ops in this structure.
74  * @put_userptr: inform the allocator that a USERPTR buffer will no longer
75  *		 be used.
76  * @attach_dmabuf: attach a shared &struct dma_buf for a hardware operation;
77  *		   used for DMABUF memory types; dev is the alloc device
78  *		   dbuf is the shared dma_buf; returns ERR_PTR() on failure;
79  *		   allocator private per-buffer structure on success;
80  *		   this needs to be used for further accesses to the buffer.
81  * @detach_dmabuf: inform the exporter of the buffer that the current DMABUF
82  *		   buffer is no longer used; the @buf_priv argument is the
83  *		   allocator private per-buffer structure previously returned
84  *		   from the attach_dmabuf callback.
85  * @map_dmabuf: request for access to the dmabuf from allocator; the allocator
86  *		of dmabuf is informed that this driver is going to use the
87  *		dmabuf.
88  * @unmap_dmabuf: releases access control to the dmabuf - allocator is notified
89  *		  that this driver is done using the dmabuf for now.
90  * @prepare:	called every time the buffer is passed from userspace to the
91  *		driver, useful for cache synchronisation, optional.
92  * @finish:	called every time the buffer is passed back from the driver
93  *		to the userspace, also optional.
94  * @vaddr:	return a kernel virtual address to a given memory buffer
95  *		associated with the passed private structure or NULL if no
96  *		such mapping exists.
97  * @cookie:	return allocator specific cookie for a given memory buffer
98  *		associated with the passed private structure or NULL if not
99  *		available.
100  * @num_users:	return the current number of users of a memory buffer;
101  *		return 1 if the videobuf layer (or actually the driver using
102  *		it) is the only user.
103  * @mmap:	setup a userspace mapping for a given memory buffer under
104  *		the provided virtual memory region.
105  *
106  * Those operations are used by the videobuf2 core to implement the memory
107  * handling/memory allocators for each type of supported streaming I/O method.
108  *
109  * .. note::
110  *    #) Required ops for USERPTR types: get_userptr, put_userptr.
111  *
112  *    #) Required ops for MMAP types: alloc, put, num_users, mmap.
113  *
114  *    #) Required ops for read/write access types: alloc, put, num_users, vaddr.
115  *
116  *    #) Required ops for DMABUF types: attach_dmabuf, detach_dmabuf,
117  *       map_dmabuf, unmap_dmabuf.
118  */
119 struct vb2_mem_ops {
120 	void		*(*alloc)(struct device *dev, unsigned long attrs,
121 				  unsigned long size,
122 				  enum dma_data_direction dma_dir,
123 				  gfp_t gfp_flags);
124 	void		(*put)(void *buf_priv);
125 	struct dma_buf *(*get_dmabuf)(void *buf_priv, unsigned long flags);
126 
127 	void		*(*get_userptr)(struct device *dev, unsigned long vaddr,
128 					unsigned long size,
129 					enum dma_data_direction dma_dir);
130 	void		(*put_userptr)(void *buf_priv);
131 
132 	void		(*prepare)(void *buf_priv);
133 	void		(*finish)(void *buf_priv);
134 
135 	void		*(*attach_dmabuf)(struct device *dev,
136 					  struct dma_buf *dbuf,
137 					  unsigned long size,
138 					  enum dma_data_direction dma_dir);
139 	void		(*detach_dmabuf)(void *buf_priv);
140 	int		(*map_dmabuf)(void *buf_priv);
141 	void		(*unmap_dmabuf)(void *buf_priv);
142 
143 	void		*(*vaddr)(void *buf_priv);
144 	void		*(*cookie)(void *buf_priv);
145 
146 	unsigned int	(*num_users)(void *buf_priv);
147 
148 	int		(*mmap)(void *buf_priv, struct vm_area_struct *vma);
149 };
150 
151 /**
152  * struct vb2_plane - plane information.
153  * @mem_priv:	private data with this plane.
154  * @dbuf:	dma_buf - shared buffer object.
155  * @dbuf_mapped:	flag to show whether dbuf is mapped or not
156  * @bytesused:	number of bytes occupied by data in the plane (payload).
157  * @length:	size of this plane (NOT the payload) in bytes. The maximum
158  *		valid size is MAX_UINT - PAGE_SIZE.
159  * @min_length:	minimum required size of this plane (NOT the payload) in bytes.
160  *		@length is always greater or equal to @min_length, and like
161  *		@length, it is limited to MAX_UINT - PAGE_SIZE.
162  * @m:		Union with memtype-specific data.
163  * @m.offset:	when memory in the associated struct vb2_buffer is
164  *		%VB2_MEMORY_MMAP, equals the offset from the start of
165  *		the device memory for this plane (or is a "cookie" that
166  *		should be passed to mmap() called on the video node).
167  * @m.userptr:	when memory is %VB2_MEMORY_USERPTR, a userspace pointer
168  *		pointing to this plane.
169  * @m.fd:	when memory is %VB2_MEMORY_DMABUF, a userspace file
170  *		descriptor associated with this plane.
171  * @data_offset:	offset in the plane to the start of data; usually 0,
172  *		unless there is a header in front of the data.
173  *
174  * Should contain enough information to be able to cover all the fields
175  * of &struct v4l2_plane at videodev2.h.
176  */
177 struct vb2_plane {
178 	void			*mem_priv;
179 	struct dma_buf		*dbuf;
180 	unsigned int		dbuf_mapped;
181 	unsigned int		bytesused;
182 	unsigned int		length;
183 	unsigned int		min_length;
184 	union {
185 		unsigned int	offset;
186 		unsigned long	userptr;
187 		int		fd;
188 	} m;
189 	unsigned int		data_offset;
190 };
191 
192 /**
193  * enum vb2_io_modes - queue access methods.
194  * @VB2_MMAP:		driver supports MMAP with streaming API.
195  * @VB2_USERPTR:	driver supports USERPTR with streaming API.
196  * @VB2_READ:		driver supports read() style access.
197  * @VB2_WRITE:		driver supports write() style access.
198  * @VB2_DMABUF:		driver supports DMABUF with streaming API.
199  */
200 enum vb2_io_modes {
201 	VB2_MMAP	= BIT(0),
202 	VB2_USERPTR	= BIT(1),
203 	VB2_READ	= BIT(2),
204 	VB2_WRITE	= BIT(3),
205 	VB2_DMABUF	= BIT(4),
206 };
207 
208 /**
209  * enum vb2_buffer_state - current video buffer state.
210  * @VB2_BUF_STATE_DEQUEUED:	buffer under userspace control.
211  * @VB2_BUF_STATE_IN_REQUEST:	buffer is queued in media request.
212  * @VB2_BUF_STATE_PREPARING:	buffer is being prepared in videobuf.
213  * @VB2_BUF_STATE_QUEUED:	buffer queued in videobuf, but not in driver.
214  * @VB2_BUF_STATE_ACTIVE:	buffer queued in driver and possibly used
215  *				in a hardware operation.
216  * @VB2_BUF_STATE_DONE:		buffer returned from driver to videobuf, but
217  *				not yet dequeued to userspace.
218  * @VB2_BUF_STATE_ERROR:	same as above, but the operation on the buffer
219  *				has ended with an error, which will be reported
220  *				to the userspace when it is dequeued.
221  */
222 enum vb2_buffer_state {
223 	VB2_BUF_STATE_DEQUEUED,
224 	VB2_BUF_STATE_IN_REQUEST,
225 	VB2_BUF_STATE_PREPARING,
226 	VB2_BUF_STATE_QUEUED,
227 	VB2_BUF_STATE_ACTIVE,
228 	VB2_BUF_STATE_DONE,
229 	VB2_BUF_STATE_ERROR,
230 };
231 
232 struct vb2_queue;
233 
234 /**
235  * struct vb2_buffer - represents a video buffer.
236  * @vb2_queue:		pointer to &struct vb2_queue with the queue to
237  *			which this driver belongs.
238  * @index:		id number of the buffer.
239  * @type:		buffer type.
240  * @memory:		the method, in which the actual data is passed.
241  * @num_planes:		number of planes in the buffer
242  *			on an internal driver queue.
243  * @timestamp:		frame timestamp in ns.
244  * @request:		the request this buffer is associated with.
245  * @req_obj:		used to bind this buffer to a request. This
246  *			request object has a refcount.
247  */
248 struct vb2_buffer {
249 	struct vb2_queue	*vb2_queue;
250 	unsigned int		index;
251 	unsigned int		type;
252 	unsigned int		memory;
253 	unsigned int		num_planes;
254 	u64			timestamp;
255 	struct media_request	*request;
256 	struct media_request_object	req_obj;
257 
258 	/* private: internal use only
259 	 *
260 	 * state:		current buffer state; do not change
261 	 * synced:		this buffer has been synced for DMA, i.e. the
262 	 *			'prepare' memop was called. It is cleared again
263 	 *			after the 'finish' memop is called.
264 	 * prepared:		this buffer has been prepared, i.e. the
265 	 *			buf_prepare op was called. It is cleared again
266 	 *			after the 'buf_finish' op is called.
267 	 * copied_timestamp:	the timestamp of this capture buffer was copied
268 	 *			from an output buffer.
269 	 * need_cache_sync_on_prepare: when set buffer's ->prepare() function
270 	 *			performs cache sync/invalidation.
271 	 * need_cache_sync_on_finish: when set buffer's ->finish() function
272 	 *			performs cache sync/invalidation.
273 	 * queued_entry:	entry on the queued buffers list, which holds
274 	 *			all buffers queued from userspace
275 	 * done_entry:		entry on the list that stores all buffers ready
276 	 *			to be dequeued to userspace
277 	 * vb2_plane:		per-plane information; do not change
278 	 */
279 	enum vb2_buffer_state	state;
280 	unsigned int		synced:1;
281 	unsigned int		prepared:1;
282 	unsigned int		copied_timestamp:1;
283 	unsigned int		need_cache_sync_on_prepare:1;
284 	unsigned int		need_cache_sync_on_finish:1;
285 
286 	struct vb2_plane	planes[VB2_MAX_PLANES];
287 	struct list_head	queued_entry;
288 	struct list_head	done_entry;
289 #ifdef CONFIG_VIDEO_ADV_DEBUG
290 	/*
291 	 * Counters for how often these buffer-related ops are
292 	 * called. Used to check for unbalanced ops.
293 	 */
294 	u32		cnt_mem_alloc;
295 	u32		cnt_mem_put;
296 	u32		cnt_mem_get_dmabuf;
297 	u32		cnt_mem_get_userptr;
298 	u32		cnt_mem_put_userptr;
299 	u32		cnt_mem_prepare;
300 	u32		cnt_mem_finish;
301 	u32		cnt_mem_attach_dmabuf;
302 	u32		cnt_mem_detach_dmabuf;
303 	u32		cnt_mem_map_dmabuf;
304 	u32		cnt_mem_unmap_dmabuf;
305 	u32		cnt_mem_vaddr;
306 	u32		cnt_mem_cookie;
307 	u32		cnt_mem_num_users;
308 	u32		cnt_mem_mmap;
309 
310 	u32		cnt_buf_out_validate;
311 	u32		cnt_buf_init;
312 	u32		cnt_buf_prepare;
313 	u32		cnt_buf_finish;
314 	u32		cnt_buf_cleanup;
315 	u32		cnt_buf_queue;
316 	u32		cnt_buf_request_complete;
317 
318 	/* This counts the number of calls to vb2_buffer_done() */
319 	u32		cnt_buf_done;
320 #endif
321 };
322 
323 /**
324  * struct vb2_ops - driver-specific callbacks.
325  *
326  * These operations are not called from interrupt context except where
327  * mentioned specifically.
328  *
329  * @queue_setup:	called from VIDIOC_REQBUFS() and VIDIOC_CREATE_BUFS()
330  *			handlers before memory allocation. It can be called
331  *			twice: if the original number of requested buffers
332  *			could not be allocated, then it will be called a
333  *			second time with the actually allocated number of
334  *			buffers to verify if that is OK.
335  *			The driver should return the required number of buffers
336  *			in \*num_buffers, the required number of planes per
337  *			buffer in \*num_planes, the size of each plane should be
338  *			set in the sizes\[\] array and optional per-plane
339  *			allocator specific device in the alloc_devs\[\] array.
340  *			When called from VIDIOC_REQBUFS(), \*num_planes == 0,
341  *			the driver has to use the currently configured format to
342  *			determine the plane sizes and \*num_buffers is the total
343  *			number of buffers that are being allocated. When called
344  *			from VIDIOC_CREATE_BUFS(), \*num_planes != 0 and it
345  *			describes the requested number of planes and sizes\[\]
346  *			contains the requested plane sizes. In this case
347  *			\*num_buffers are being allocated additionally to
348  *			q->num_buffers. If either \*num_planes or the requested
349  *			sizes are invalid callback must return %-EINVAL.
350  * @wait_prepare:	release any locks taken while calling vb2 functions;
351  *			it is called before an ioctl needs to wait for a new
352  *			buffer to arrive; required to avoid a deadlock in
353  *			blocking access type.
354  * @wait_finish:	reacquire all locks released in the previous callback;
355  *			required to continue operation after sleeping while
356  *			waiting for a new buffer to arrive.
357  * @buf_out_validate:	called when the output buffer is prepared or queued
358  *			to a request; drivers can use this to validate
359  *			userspace-provided information; this is required only
360  *			for OUTPUT queues.
361  * @buf_init:		called once after allocating a buffer (in MMAP case)
362  *			or after acquiring a new USERPTR buffer; drivers may
363  *			perform additional buffer-related initialization;
364  *			initialization failure (return != 0) will prevent
365  *			queue setup from completing successfully; optional.
366  * @buf_prepare:	called every time the buffer is queued from userspace
367  *			and from the VIDIOC_PREPARE_BUF() ioctl; drivers may
368  *			perform any initialization required before each
369  *			hardware operation in this callback; drivers can
370  *			access/modify the buffer here as it is still synced for
371  *			the CPU; drivers that support VIDIOC_CREATE_BUFS() must
372  *			also validate the buffer size; if an error is returned,
373  *			the buffer will not be queued in driver; optional.
374  * @buf_finish:		called before every dequeue of the buffer back to
375  *			userspace; the buffer is synced for the CPU, so drivers
376  *			can access/modify the buffer contents; drivers may
377  *			perform any operations required before userspace
378  *			accesses the buffer; optional. The buffer state can be
379  *			one of the following: %DONE and %ERROR occur while
380  *			streaming is in progress, and the %PREPARED state occurs
381  *			when the queue has been canceled and all pending
382  *			buffers are being returned to their default %DEQUEUED
383  *			state. Typically you only have to do something if the
384  *			state is %VB2_BUF_STATE_DONE, since in all other cases
385  *			the buffer contents will be ignored anyway.
386  * @buf_cleanup:	called once before the buffer is freed; drivers may
387  *			perform any additional cleanup; optional.
388  * @start_streaming:	called once to enter 'streaming' state; the driver may
389  *			receive buffers with @buf_queue callback
390  *			before @start_streaming is called; the driver gets the
391  *			number of already queued buffers in count parameter;
392  *			driver can return an error if hardware fails, in that
393  *			case all buffers that have been already given by
394  *			the @buf_queue callback are to be returned by the driver
395  *			by calling vb2_buffer_done() with %VB2_BUF_STATE_QUEUED.
396  *			If you need a minimum number of buffers before you can
397  *			start streaming, then set
398  *			&vb2_queue->min_buffers_needed. If that is non-zero
399  *			then @start_streaming won't be called until at least
400  *			that many buffers have been queued up by userspace.
401  * @stop_streaming:	called when 'streaming' state must be disabled; driver
402  *			should stop any DMA transactions or wait until they
403  *			finish and give back all buffers it got from &buf_queue
404  *			callback by calling vb2_buffer_done() with either
405  *			%VB2_BUF_STATE_DONE or %VB2_BUF_STATE_ERROR; may use
406  *			vb2_wait_for_all_buffers() function
407  * @buf_queue:		passes buffer vb to the driver; driver may start
408  *			hardware operation on this buffer; driver should give
409  *			the buffer back by calling vb2_buffer_done() function;
410  *			it is always called after calling VIDIOC_STREAMON()
411  *			ioctl; might be called before @start_streaming callback
412  *			if user pre-queued buffers before calling
413  *			VIDIOC_STREAMON().
414  * @buf_request_complete: a buffer that was never queued to the driver but is
415  *			associated with a queued request was canceled.
416  *			The driver will have to mark associated objects in the
417  *			request as completed; required if requests are
418  *			supported.
419  */
420 struct vb2_ops {
421 	int (*queue_setup)(struct vb2_queue *q,
422 			   unsigned int *num_buffers, unsigned int *num_planes,
423 			   unsigned int sizes[], struct device *alloc_devs[]);
424 
425 	void (*wait_prepare)(struct vb2_queue *q);
426 	void (*wait_finish)(struct vb2_queue *q);
427 
428 	int (*buf_out_validate)(struct vb2_buffer *vb);
429 	int (*buf_init)(struct vb2_buffer *vb);
430 	int (*buf_prepare)(struct vb2_buffer *vb);
431 	void (*buf_finish)(struct vb2_buffer *vb);
432 	void (*buf_cleanup)(struct vb2_buffer *vb);
433 
434 	int (*start_streaming)(struct vb2_queue *q, unsigned int count);
435 	void (*stop_streaming)(struct vb2_queue *q);
436 
437 	void (*buf_queue)(struct vb2_buffer *vb);
438 
439 	void (*buf_request_complete)(struct vb2_buffer *vb);
440 };
441 
442 /**
443  * struct vb2_buf_ops - driver-specific callbacks.
444  *
445  * @verify_planes_array: Verify that a given user space structure contains
446  *			enough planes for the buffer. This is called
447  *			for each dequeued buffer.
448  * @init_buffer:	given a &vb2_buffer initialize the extra data after
449  *			struct vb2_buffer.
450  *			For V4L2 this is a &struct vb2_v4l2_buffer.
451  * @fill_user_buffer:	given a &vb2_buffer fill in the userspace structure.
452  *			For V4L2 this is a &struct v4l2_buffer.
453  * @fill_vb2_buffer:	given a userspace structure, fill in the &vb2_buffer.
454  *			If the userspace structure is invalid, then this op
455  *			will return an error.
456  * @copy_timestamp:	copy the timestamp from a userspace structure to
457  *			the &struct vb2_buffer.
458  */
459 struct vb2_buf_ops {
460 	int (*verify_planes_array)(struct vb2_buffer *vb, const void *pb);
461 	void (*init_buffer)(struct vb2_buffer *vb);
462 	void (*fill_user_buffer)(struct vb2_buffer *vb, void *pb);
463 	int (*fill_vb2_buffer)(struct vb2_buffer *vb, struct vb2_plane *planes);
464 	void (*copy_timestamp)(struct vb2_buffer *vb, const void *pb);
465 };
466 
467 /**
468  * struct vb2_queue - a videobuf queue.
469  *
470  * @type:	private buffer type whose content is defined by the vb2-core
471  *		caller. For example, for V4L2, it should match
472  *		the types defined on &enum v4l2_buf_type.
473  * @io_modes:	supported io methods (see &enum vb2_io_modes).
474  * @alloc_devs:	&struct device memory type/allocator-specific per-plane device
475  * @dev:	device to use for the default allocation context if the driver
476  *		doesn't fill in the @alloc_devs array.
477  * @dma_attrs:	DMA attributes to use for the DMA.
478  * @bidirectional: when this flag is set the DMA direction for the buffers of
479  *		this queue will be overridden with %DMA_BIDIRECTIONAL direction.
480  *		This is useful in cases where the hardware (firmware) writes to
481  *		a buffer which is mapped as read (%DMA_TO_DEVICE), or reads from
482  *		buffer which is mapped for write (%DMA_FROM_DEVICE) in order
483  *		to satisfy some internal hardware restrictions or adds a padding
484  *		needed by the processing algorithm. In case the DMA mapping is
485  *		not bidirectional but the hardware (firmware) trying to access
486  *		the buffer (in the opposite direction) this could lead to an
487  *		IOMMU protection faults.
488  * @fileio_read_once:		report EOF after reading the first buffer
489  * @fileio_write_immediately:	queue buffer after each write() call
490  * @allow_zero_bytesused:	allow bytesused == 0 to be passed to the driver
491  * @quirk_poll_must_check_waiting_for_buffers: Return %EPOLLERR at poll when QBUF
492  *              has not been called. This is a vb1 idiom that has been adopted
493  *              also by vb2.
494  * @supports_requests: this queue supports the Request API.
495  * @requires_requests: this queue requires the Request API. If this is set to 1,
496  *		then supports_requests must be set to 1 as well.
497  * @uses_qbuf:	qbuf was used directly for this queue. Set to 1 the first
498  *		time this is called. Set to 0 when the queue is canceled.
499  *		If this is 1, then you cannot queue buffers from a request.
500  * @uses_requests: requests are used for this queue. Set to 1 the first time
501  *		a request is queued. Set to 0 when the queue is canceled.
502  *		If this is 1, then you cannot queue buffers directly.
503  * @allow_cache_hints: when set user-space can pass cache management hints in
504  *		order to skip cache flush/invalidation on ->prepare() or/and
505  *		->finish().
506  * @lock:	pointer to a mutex that protects the &struct vb2_queue. The
507  *		driver can set this to a mutex to let the v4l2 core serialize
508  *		the queuing ioctls. If the driver wants to handle locking
509  *		itself, then this should be set to NULL. This lock is not used
510  *		by the videobuf2 core API.
511  * @owner:	The filehandle that 'owns' the buffers, i.e. the filehandle
512  *		that called reqbufs, create_buffers or started fileio.
513  *		This field is not used by the videobuf2 core API, but it allows
514  *		drivers to easily associate an owner filehandle with the queue.
515  * @ops:	driver-specific callbacks
516  * @mem_ops:	memory allocator specific callbacks
517  * @buf_ops:	callbacks to deliver buffer information.
518  *		between user-space and kernel-space.
519  * @drv_priv:	driver private data.
520  * @subsystem_flags: Flags specific to the subsystem (V4L2/DVB/etc.). Not used
521  *		by the vb2 core.
522  * @buf_struct_size: size of the driver-specific buffer structure;
523  *		"0" indicates the driver doesn't want to use a custom buffer
524  *		structure type. In that case a subsystem-specific struct
525  *		will be used (in the case of V4L2 that is
526  *		``sizeof(struct vb2_v4l2_buffer)``). The first field of the
527  *		driver-specific buffer structure must be the subsystem-specific
528  *		struct (vb2_v4l2_buffer in the case of V4L2).
529  * @timestamp_flags: Timestamp flags; ``V4L2_BUF_FLAG_TIMESTAMP_*`` and
530  *		``V4L2_BUF_FLAG_TSTAMP_SRC_*``
531  * @gfp_flags:	additional gfp flags used when allocating the buffers.
532  *		Typically this is 0, but it may be e.g. %GFP_DMA or %__GFP_DMA32
533  *		to force the buffer allocation to a specific memory zone.
534  * @min_buffers_needed: the minimum number of buffers needed before
535  *		@start_streaming can be called. Used when a DMA engine
536  *		cannot be started unless at least this number of buffers
537  *		have been queued into the driver.
538  */
539 /*
540  * Private elements (won't appear at the uAPI book):
541  * @mmap_lock:	private mutex used when buffers are allocated/freed/mmapped
542  * @memory:	current memory type used
543  * @dma_dir:	DMA mapping direction.
544  * @bufs:	videobuf buffer structures
545  * @num_buffers: number of allocated/used buffers
546  * @queued_list: list of buffers currently queued from userspace
547  * @queued_count: number of buffers queued and ready for streaming.
548  * @owned_by_drv_count: number of buffers owned by the driver
549  * @done_list:	list of buffers ready to be dequeued to userspace
550  * @done_lock:	lock to protect done_list list
551  * @done_wq:	waitqueue for processes waiting for buffers ready to be dequeued
552  * @streaming:	current streaming state
553  * @start_streaming_called: @start_streaming was called successfully and we
554  *		started streaming.
555  * @error:	a fatal error occurred on the queue
556  * @waiting_for_buffers: used in poll() to check if vb2 is still waiting for
557  *		buffers. Only set for capture queues if qbuf has not yet been
558  *		called since poll() needs to return %EPOLLERR in that situation.
559  * @is_multiplanar: set if buffer type is multiplanar
560  * @is_output:	set if buffer type is output
561  * @copy_timestamp: set if vb2-core should set timestamps
562  * @last_buffer_dequeued: used in poll() and DQBUF to immediately return if the
563  *		last decoded buffer was already dequeued. Set for capture queues
564  *		when a buffer with the %V4L2_BUF_FLAG_LAST is dequeued.
565  * @fileio:	file io emulator internal data, used only if emulator is active
566  * @threadio:	thread io internal data, used only if thread is active
567  * @name:	queue name, used for logging purpose. Initialized automatically
568  *		if left empty by drivers.
569  */
570 struct vb2_queue {
571 	unsigned int			type;
572 	unsigned int			io_modes;
573 	struct device			*dev;
574 	unsigned long			dma_attrs;
575 	unsigned int			bidirectional:1;
576 	unsigned int			fileio_read_once:1;
577 	unsigned int			fileio_write_immediately:1;
578 	unsigned int			allow_zero_bytesused:1;
579 	unsigned int		   quirk_poll_must_check_waiting_for_buffers:1;
580 	unsigned int			supports_requests:1;
581 	unsigned int			requires_requests:1;
582 	unsigned int			uses_qbuf:1;
583 	unsigned int			uses_requests:1;
584 	unsigned int			allow_cache_hints:1;
585 
586 	struct mutex			*lock;
587 	void				*owner;
588 
589 	const struct vb2_ops		*ops;
590 	const struct vb2_mem_ops	*mem_ops;
591 	const struct vb2_buf_ops	*buf_ops;
592 
593 	void				*drv_priv;
594 	u32				subsystem_flags;
595 	unsigned int			buf_struct_size;
596 	u32				timestamp_flags;
597 	gfp_t				gfp_flags;
598 	u32				min_buffers_needed;
599 
600 	struct device			*alloc_devs[VB2_MAX_PLANES];
601 
602 	/* private: internal use only */
603 	struct mutex			mmap_lock;
604 	unsigned int			memory;
605 	enum dma_data_direction		dma_dir;
606 	struct vb2_buffer		*bufs[VB2_MAX_FRAME];
607 	unsigned int			num_buffers;
608 
609 	struct list_head		queued_list;
610 	unsigned int			queued_count;
611 
612 	atomic_t			owned_by_drv_count;
613 	struct list_head		done_list;
614 	spinlock_t			done_lock;
615 	wait_queue_head_t		done_wq;
616 
617 	unsigned int			streaming:1;
618 	unsigned int			start_streaming_called:1;
619 	unsigned int			error:1;
620 	unsigned int			waiting_for_buffers:1;
621 	unsigned int			waiting_in_dqbuf:1;
622 	unsigned int			is_multiplanar:1;
623 	unsigned int			is_output:1;
624 	unsigned int			copy_timestamp:1;
625 	unsigned int			last_buffer_dequeued:1;
626 
627 	struct vb2_fileio_data		*fileio;
628 	struct vb2_threadio_data	*threadio;
629 
630 	char				name[32];
631 
632 #ifdef CONFIG_VIDEO_ADV_DEBUG
633 	/*
634 	 * Counters for how often these queue-related ops are
635 	 * called. Used to check for unbalanced ops.
636 	 */
637 	u32				cnt_queue_setup;
638 	u32				cnt_wait_prepare;
639 	u32				cnt_wait_finish;
640 	u32				cnt_start_streaming;
641 	u32				cnt_stop_streaming;
642 #endif
643 };
644 
645 /**
646  * vb2_queue_allows_cache_hints() - Return true if the queue allows cache
647  * and memory consistency hints.
648  *
649  * @q:		pointer to &struct vb2_queue with videobuf2 queue
650  */
651 static inline bool vb2_queue_allows_cache_hints(struct vb2_queue *q)
652 {
653 	return q->allow_cache_hints && q->memory == VB2_MEMORY_MMAP;
654 }
655 
656 /**
657  * vb2_plane_vaddr() - Return a kernel virtual address of a given plane.
658  * @vb:		pointer to &struct vb2_buffer to which the plane in
659  *		question belongs to.
660  * @plane_no:	plane number for which the address is to be returned.
661  *
662  * This function returns a kernel virtual address of a given plane if
663  * such a mapping exist, NULL otherwise.
664  */
665 void *vb2_plane_vaddr(struct vb2_buffer *vb, unsigned int plane_no);
666 
667 /**
668  * vb2_plane_cookie() - Return allocator specific cookie for the given plane.
669  * @vb:		pointer to &struct vb2_buffer to which the plane in
670  *		question belongs to.
671  * @plane_no:	plane number for which the cookie is to be returned.
672  *
673  * This function returns an allocator specific cookie for a given plane if
674  * available, NULL otherwise. The allocator should provide some simple static
675  * inline function, which would convert this cookie to the allocator specific
676  * type that can be used directly by the driver to access the buffer. This can
677  * be for example physical address, pointer to scatter list or IOMMU mapping.
678  */
679 void *vb2_plane_cookie(struct vb2_buffer *vb, unsigned int plane_no);
680 
681 /**
682  * vb2_buffer_done() - inform videobuf that an operation on a buffer
683  *	is finished.
684  * @vb:		pointer to &struct vb2_buffer to be used.
685  * @state:	state of the buffer, as defined by &enum vb2_buffer_state.
686  *		Either %VB2_BUF_STATE_DONE if the operation finished
687  *		successfully, %VB2_BUF_STATE_ERROR if the operation finished
688  *		with an error or %VB2_BUF_STATE_QUEUED.
689  *
690  * This function should be called by the driver after a hardware operation on
691  * a buffer is finished and the buffer may be returned to userspace. The driver
692  * cannot use this buffer anymore until it is queued back to it by videobuf
693  * by the means of &vb2_ops->buf_queue callback. Only buffers previously queued
694  * to the driver by &vb2_ops->buf_queue can be passed to this function.
695  *
696  * While streaming a buffer can only be returned in state DONE or ERROR.
697  * The &vb2_ops->start_streaming op can also return them in case the DMA engine
698  * cannot be started for some reason. In that case the buffers should be
699  * returned with state QUEUED to put them back into the queue.
700  */
701 void vb2_buffer_done(struct vb2_buffer *vb, enum vb2_buffer_state state);
702 
703 /**
704  * vb2_discard_done() - discard all buffers marked as DONE.
705  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
706  *
707  * This function is intended to be used with suspend/resume operations. It
708  * discards all 'done' buffers as they would be too old to be requested after
709  * resume.
710  *
711  * Drivers must stop the hardware and synchronize with interrupt handlers and/or
712  * delayed works before calling this function to make sure no buffer will be
713  * touched by the driver and/or hardware.
714  */
715 void vb2_discard_done(struct vb2_queue *q);
716 
717 /**
718  * vb2_wait_for_all_buffers() - wait until all buffers are given back to vb2.
719  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
720  *
721  * This function will wait until all buffers that have been given to the driver
722  * by &vb2_ops->buf_queue are given back to vb2 with vb2_buffer_done(). It
723  * doesn't call &vb2_ops->wait_prepare/&vb2_ops->wait_finish pair.
724  * It is intended to be called with all locks taken, for example from
725  * &vb2_ops->stop_streaming callback.
726  */
727 int vb2_wait_for_all_buffers(struct vb2_queue *q);
728 
729 /**
730  * vb2_core_querybuf() - query video buffer information.
731  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
732  * @index:	id number of the buffer.
733  * @pb:		buffer struct passed from userspace.
734  *
735  * Videobuf2 core helper to implement VIDIOC_QUERYBUF() operation. It is called
736  * internally by VB2 by an API-specific handler, like ``videobuf2-v4l2.h``.
737  *
738  * The passed buffer should have been verified.
739  *
740  * This function fills the relevant information for the userspace.
741  *
742  * Return: returns zero on success; an error code otherwise.
743  */
744 void vb2_core_querybuf(struct vb2_queue *q, unsigned int index, void *pb);
745 
746 /**
747  * vb2_core_reqbufs() - Initiate streaming.
748  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
749  * @memory:	memory type, as defined by &enum vb2_memory.
750  * @count:	requested buffer count.
751  *
752  * Videobuf2 core helper to implement VIDIOC_REQBUF() operation. It is called
753  * internally by VB2 by an API-specific handler, like ``videobuf2-v4l2.h``.
754  *
755  * This function:
756  *
757  * #) verifies streaming parameters passed from the userspace;
758  * #) sets up the queue;
759  * #) negotiates number of buffers and planes per buffer with the driver
760  *    to be used during streaming;
761  * #) allocates internal buffer structures (&struct vb2_buffer), according to
762  *    the agreed parameters;
763  * #) for MMAP memory type, allocates actual video memory, using the
764  *    memory handling/allocation routines provided during queue initialization.
765  *
766  * If req->count is 0, all the memory will be freed instead.
767  *
768  * If the queue has been allocated previously by a previous vb2_core_reqbufs()
769  * call and the queue is not busy, memory will be reallocated.
770  *
771  * Return: returns zero on success; an error code otherwise.
772  */
773 int vb2_core_reqbufs(struct vb2_queue *q, enum vb2_memory memory,
774 		    unsigned int *count);
775 
776 /**
777  * vb2_core_create_bufs() - Allocate buffers and any required auxiliary structs
778  * @q: pointer to &struct vb2_queue with videobuf2 queue.
779  * @memory: memory type, as defined by &enum vb2_memory.
780  * @count: requested buffer count.
781  * @requested_planes: number of planes requested.
782  * @requested_sizes: array with the size of the planes.
783  *
784  * Videobuf2 core helper to implement VIDIOC_CREATE_BUFS() operation. It is
785  * called internally by VB2 by an API-specific handler, like
786  * ``videobuf2-v4l2.h``.
787  *
788  * This function:
789  *
790  * #) verifies parameter sanity;
791  * #) calls the &vb2_ops->queue_setup queue operation;
792  * #) performs any necessary memory allocations.
793  *
794  * Return: returns zero on success; an error code otherwise.
795  */
796 int vb2_core_create_bufs(struct vb2_queue *q, enum vb2_memory memory,
797 			 unsigned int *count,
798 			 unsigned int requested_planes,
799 			 const unsigned int requested_sizes[]);
800 
801 /**
802  * vb2_core_prepare_buf() - Pass ownership of a buffer from userspace
803  *			to the kernel.
804  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
805  * @index:	id number of the buffer.
806  * @pb:		buffer structure passed from userspace to
807  *		&v4l2_ioctl_ops->vidioc_prepare_buf handler in driver.
808  *
809  * Videobuf2 core helper to implement VIDIOC_PREPARE_BUF() operation. It is
810  * called internally by VB2 by an API-specific handler, like
811  * ``videobuf2-v4l2.h``.
812  *
813  * The passed buffer should have been verified.
814  *
815  * This function calls vb2_ops->buf_prepare callback in the driver
816  * (if provided), in which driver-specific buffer initialization can
817  * be performed.
818  *
819  * Return: returns zero on success; an error code otherwise.
820  */
821 int vb2_core_prepare_buf(struct vb2_queue *q, unsigned int index, void *pb);
822 
823 /**
824  * vb2_core_qbuf() - Queue a buffer from userspace
825  *
826  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
827  * @index:	id number of the buffer
828  * @pb:		buffer structure passed from userspace to
829  *		v4l2_ioctl_ops->vidioc_qbuf handler in driver
830  * @req:	pointer to &struct media_request, may be NULL.
831  *
832  * Videobuf2 core helper to implement VIDIOC_QBUF() operation. It is called
833  * internally by VB2 by an API-specific handler, like ``videobuf2-v4l2.h``.
834  *
835  * This function:
836  *
837  * #) If @req is non-NULL, then the buffer will be bound to this
838  *    media request and it returns. The buffer will be prepared and
839  *    queued to the driver (i.e. the next two steps) when the request
840  *    itself is queued.
841  * #) if necessary, calls &vb2_ops->buf_prepare callback in the driver
842  *    (if provided), in which driver-specific buffer initialization can
843  *    be performed;
844  * #) if streaming is on, queues the buffer in driver by the means of
845  *    &vb2_ops->buf_queue callback for processing.
846  *
847  * Return: returns zero on success; an error code otherwise.
848  */
849 int vb2_core_qbuf(struct vb2_queue *q, unsigned int index, void *pb,
850 		  struct media_request *req);
851 
852 /**
853  * vb2_core_dqbuf() - Dequeue a buffer to the userspace
854  * @q:		pointer to &struct vb2_queue with videobuf2 queue
855  * @pindex:	pointer to the buffer index. May be NULL
856  * @pb:		buffer structure passed from userspace to
857  *		v4l2_ioctl_ops->vidioc_dqbuf handler in driver.
858  * @nonblocking: if true, this call will not sleep waiting for a buffer if no
859  *		 buffers ready for dequeuing are present. Normally the driver
860  *		 would be passing (file->f_flags & O_NONBLOCK) here.
861  *
862  * Videobuf2 core helper to implement VIDIOC_DQBUF() operation. It is called
863  * internally by VB2 by an API-specific handler, like ``videobuf2-v4l2.h``.
864  *
865  * This function:
866  *
867  * #) calls buf_finish callback in the driver (if provided), in which
868  *    driver can perform any additional operations that may be required before
869  *    returning the buffer to userspace, such as cache sync,
870  * #) the buffer struct members are filled with relevant information for
871  *    the userspace.
872  *
873  * Return: returns zero on success; an error code otherwise.
874  */
875 int vb2_core_dqbuf(struct vb2_queue *q, unsigned int *pindex, void *pb,
876 		   bool nonblocking);
877 
878 /**
879  * vb2_core_streamon() - Implements VB2 stream ON logic
880  *
881  * @q:		pointer to &struct vb2_queue with videobuf2 queue
882  * @type:	type of the queue to be started.
883  *		For V4L2, this is defined by &enum v4l2_buf_type type.
884  *
885  * Videobuf2 core helper to implement VIDIOC_STREAMON() operation. It is called
886  * internally by VB2 by an API-specific handler, like ``videobuf2-v4l2.h``.
887  *
888  * Return: returns zero on success; an error code otherwise.
889  */
890 int vb2_core_streamon(struct vb2_queue *q, unsigned int type);
891 
892 /**
893  * vb2_core_streamoff() - Implements VB2 stream OFF logic
894  *
895  * @q:		pointer to &struct vb2_queue with videobuf2 queue
896  * @type:	type of the queue to be started.
897  *		For V4L2, this is defined by &enum v4l2_buf_type type.
898  *
899  * Videobuf2 core helper to implement VIDIOC_STREAMOFF() operation. It is
900  * called internally by VB2 by an API-specific handler, like
901  * ``videobuf2-v4l2.h``.
902  *
903  * Return: returns zero on success; an error code otherwise.
904  */
905 int vb2_core_streamoff(struct vb2_queue *q, unsigned int type);
906 
907 /**
908  * vb2_core_expbuf() - Export a buffer as a file descriptor.
909  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
910  * @fd:		pointer to the file descriptor associated with DMABUF
911  *		(set by driver).
912  * @type:	buffer type.
913  * @index:	id number of the buffer.
914  * @plane:	index of the plane to be exported, 0 for single plane queues
915  * @flags:	file flags for newly created file, as defined at
916  *		include/uapi/asm-generic/fcntl.h.
917  *		Currently, the only used flag is %O_CLOEXEC.
918  *		is supported, refer to manual of open syscall for more details.
919  *
920  *
921  * Videobuf2 core helper to implement VIDIOC_EXPBUF() operation. It is called
922  * internally by VB2 by an API-specific handler, like ``videobuf2-v4l2.h``.
923  *
924  * Return: returns zero on success; an error code otherwise.
925  */
926 int vb2_core_expbuf(struct vb2_queue *q, int *fd, unsigned int type,
927 		unsigned int index, unsigned int plane, unsigned int flags);
928 
929 /**
930  * vb2_core_queue_init() - initialize a videobuf2 queue
931  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
932  *		This structure should be allocated in driver
933  *
934  * The &vb2_queue structure should be allocated by the driver. The driver is
935  * responsible of clearing it's content and setting initial values for some
936  * required entries before calling this function.
937  *
938  * .. note::
939  *
940  *    The following fields at @q should be set before calling this function:
941  *    &vb2_queue->ops, &vb2_queue->mem_ops, &vb2_queue->type.
942  */
943 int vb2_core_queue_init(struct vb2_queue *q);
944 
945 /**
946  * vb2_core_queue_release() - stop streaming, release the queue and free memory
947  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
948  *
949  * This function stops streaming and performs necessary clean ups, including
950  * freeing video buffer memory. The driver is responsible for freeing
951  * the &struct vb2_queue itself.
952  */
953 void vb2_core_queue_release(struct vb2_queue *q);
954 
955 /**
956  * vb2_queue_error() - signal a fatal error on the queue
957  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
958  *
959  * Flag that a fatal unrecoverable error has occurred and wake up all processes
960  * waiting on the queue. Polling will now set %EPOLLERR and queuing and dequeuing
961  * buffers will return %-EIO.
962  *
963  * The error flag will be cleared when canceling the queue, either from
964  * vb2_streamoff() or vb2_queue_release(). Drivers should thus not call this
965  * function before starting the stream, otherwise the error flag will remain set
966  * until the queue is released when closing the device node.
967  */
968 void vb2_queue_error(struct vb2_queue *q);
969 
970 /**
971  * vb2_mmap() - map video buffers into application address space.
972  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
973  * @vma:	pointer to &struct vm_area_struct with the vma passed
974  *		to the mmap file operation handler in the driver.
975  *
976  * Should be called from mmap file operation handler of a driver.
977  * This function maps one plane of one of the available video buffers to
978  * userspace. To map whole video memory allocated on reqbufs, this function
979  * has to be called once per each plane per each buffer previously allocated.
980  *
981  * When the userspace application calls mmap, it passes to it an offset returned
982  * to it earlier by the means of &v4l2_ioctl_ops->vidioc_querybuf handler.
983  * That offset acts as a "cookie", which is then used to identify the plane
984  * to be mapped.
985  *
986  * This function finds a plane with a matching offset and a mapping is performed
987  * by the means of a provided memory operation.
988  *
989  * The return values from this function are intended to be directly returned
990  * from the mmap handler in driver.
991  */
992 int vb2_mmap(struct vb2_queue *q, struct vm_area_struct *vma);
993 
994 #ifndef CONFIG_MMU
995 /**
996  * vb2_get_unmapped_area - map video buffers into application address space.
997  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
998  * @addr:	memory address.
999  * @len:	buffer size.
1000  * @pgoff:	page offset.
1001  * @flags:	memory flags.
1002  *
1003  * This function is used in noMMU platforms to propose address mapping
1004  * for a given buffer. It's intended to be used as a handler for the
1005  * &file_operations->get_unmapped_area operation.
1006  *
1007  * This is called by the mmap() syscall routines will call this
1008  * to get a proposed address for the mapping, when ``!CONFIG_MMU``.
1009  */
1010 unsigned long vb2_get_unmapped_area(struct vb2_queue *q,
1011 				    unsigned long addr,
1012 				    unsigned long len,
1013 				    unsigned long pgoff,
1014 				    unsigned long flags);
1015 #endif
1016 
1017 /**
1018  * vb2_core_poll() - implements poll syscall() logic.
1019  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
1020  * @file:	&struct file argument passed to the poll
1021  *		file operation handler.
1022  * @wait:	&poll_table wait argument passed to the poll
1023  *		file operation handler.
1024  *
1025  * This function implements poll file operation handler for a driver.
1026  * For CAPTURE queues, if a buffer is ready to be dequeued, the userspace will
1027  * be informed that the file descriptor of a video device is available for
1028  * reading.
1029  * For OUTPUT queues, if a buffer is ready to be dequeued, the file descriptor
1030  * will be reported as available for writing.
1031  *
1032  * The return values from this function are intended to be directly returned
1033  * from poll handler in driver.
1034  */
1035 __poll_t vb2_core_poll(struct vb2_queue *q, struct file *file,
1036 			   poll_table *wait);
1037 
1038 /**
1039  * vb2_read() - implements read() syscall logic.
1040  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
1041  * @data:	pointed to target userspace buffer
1042  * @count:	number of bytes to read
1043  * @ppos:	file handle position tracking pointer
1044  * @nonblock:	mode selector (1 means blocking calls, 0 means nonblocking)
1045  */
1046 size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count,
1047 		loff_t *ppos, int nonblock);
1048 /**
1049  * vb2_write() - implements write() syscall logic.
1050  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
1051  * @data:	pointed to target userspace buffer
1052  * @count:	number of bytes to write
1053  * @ppos:	file handle position tracking pointer
1054  * @nonblock:	mode selector (1 means blocking calls, 0 means nonblocking)
1055  */
1056 size_t vb2_write(struct vb2_queue *q, const char __user *data, size_t count,
1057 		loff_t *ppos, int nonblock);
1058 
1059 /**
1060  * typedef vb2_thread_fnc - callback function for use with vb2_thread.
1061  *
1062  * @vb: pointer to struct &vb2_buffer.
1063  * @priv: pointer to a private data.
1064  *
1065  * This is called whenever a buffer is dequeued in the thread.
1066  */
1067 typedef int (*vb2_thread_fnc)(struct vb2_buffer *vb, void *priv);
1068 
1069 /**
1070  * vb2_thread_start() - start a thread for the given queue.
1071  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
1072  * @fnc:	&vb2_thread_fnc callback function.
1073  * @priv:	priv pointer passed to the callback function.
1074  * @thread_name:the name of the thread. This will be prefixed with "vb2-".
1075  *
1076  * This starts a thread that will queue and dequeue until an error occurs
1077  * or vb2_thread_stop() is called.
1078  *
1079  * .. attention::
1080  *
1081  *   This function should not be used for anything else but the videobuf2-dvb
1082  *   support. If you think you have another good use-case for this, then please
1083  *   contact the linux-media mailing list first.
1084  */
1085 int vb2_thread_start(struct vb2_queue *q, vb2_thread_fnc fnc, void *priv,
1086 		     const char *thread_name);
1087 
1088 /**
1089  * vb2_thread_stop() - stop the thread for the given queue.
1090  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
1091  */
1092 int vb2_thread_stop(struct vb2_queue *q);
1093 
1094 /**
1095  * vb2_is_streaming() - return streaming status of the queue.
1096  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
1097  */
1098 static inline bool vb2_is_streaming(struct vb2_queue *q)
1099 {
1100 	return q->streaming;
1101 }
1102 
1103 /**
1104  * vb2_fileio_is_active() - return true if fileio is active.
1105  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
1106  *
1107  * This returns true if read() or write() is used to stream the data
1108  * as opposed to stream I/O. This is almost never an important distinction,
1109  * except in rare cases. One such case is that using read() or write() to
1110  * stream a format using %V4L2_FIELD_ALTERNATE is not allowed since there
1111  * is no way you can pass the field information of each buffer to/from
1112  * userspace. A driver that supports this field format should check for
1113  * this in the &vb2_ops->queue_setup op and reject it if this function returns
1114  * true.
1115  */
1116 static inline bool vb2_fileio_is_active(struct vb2_queue *q)
1117 {
1118 	return q->fileio;
1119 }
1120 
1121 /**
1122  * vb2_is_busy() - return busy status of the queue.
1123  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
1124  *
1125  * This function checks if queue has any buffers allocated.
1126  */
1127 static inline bool vb2_is_busy(struct vb2_queue *q)
1128 {
1129 	return (q->num_buffers > 0);
1130 }
1131 
1132 /**
1133  * vb2_get_drv_priv() - return driver private data associated with the queue.
1134  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
1135  */
1136 static inline void *vb2_get_drv_priv(struct vb2_queue *q)
1137 {
1138 	return q->drv_priv;
1139 }
1140 
1141 /**
1142  * vb2_set_plane_payload() - set bytesused for the plane @plane_no.
1143  * @vb:		pointer to &struct vb2_buffer to which the plane in
1144  *		question belongs to.
1145  * @plane_no:	plane number for which payload should be set.
1146  * @size:	payload in bytes.
1147  */
1148 static inline void vb2_set_plane_payload(struct vb2_buffer *vb,
1149 				 unsigned int plane_no, unsigned long size)
1150 {
1151 	if (plane_no < vb->num_planes)
1152 		vb->planes[plane_no].bytesused = size;
1153 }
1154 
1155 /**
1156  * vb2_get_plane_payload() - get bytesused for the plane plane_no
1157  * @vb:		pointer to &struct vb2_buffer to which the plane in
1158  *		question belongs to.
1159  * @plane_no:	plane number for which payload should be set.
1160  */
1161 static inline unsigned long vb2_get_plane_payload(struct vb2_buffer *vb,
1162 				 unsigned int plane_no)
1163 {
1164 	if (plane_no < vb->num_planes)
1165 		return vb->planes[plane_no].bytesused;
1166 	return 0;
1167 }
1168 
1169 /**
1170  * vb2_plane_size() - return plane size in bytes.
1171  * @vb:		pointer to &struct vb2_buffer to which the plane in
1172  *		question belongs to.
1173  * @plane_no:	plane number for which size should be returned.
1174  */
1175 static inline unsigned long
1176 vb2_plane_size(struct vb2_buffer *vb, unsigned int plane_no)
1177 {
1178 	if (plane_no < vb->num_planes)
1179 		return vb->planes[plane_no].length;
1180 	return 0;
1181 }
1182 
1183 /**
1184  * vb2_start_streaming_called() - return streaming status of driver.
1185  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
1186  */
1187 static inline bool vb2_start_streaming_called(struct vb2_queue *q)
1188 {
1189 	return q->start_streaming_called;
1190 }
1191 
1192 /**
1193  * vb2_clear_last_buffer_dequeued() - clear last buffer dequeued flag of queue.
1194  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
1195  */
1196 static inline void vb2_clear_last_buffer_dequeued(struct vb2_queue *q)
1197 {
1198 	q->last_buffer_dequeued = false;
1199 }
1200 
1201 /**
1202  * vb2_get_buffer() - get a buffer from a queue
1203  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
1204  * @index:	buffer index
1205  *
1206  * This function obtains a buffer from a queue, by its index.
1207  * Keep in mind that there is no refcounting involved in this
1208  * operation, so the buffer lifetime should be taken into
1209  * consideration.
1210  */
1211 static inline struct vb2_buffer *vb2_get_buffer(struct vb2_queue *q,
1212 						unsigned int index)
1213 {
1214 	if (index < q->num_buffers)
1215 		return q->bufs[index];
1216 	return NULL;
1217 }
1218 
1219 /*
1220  * The following functions are not part of the vb2 core API, but are useful
1221  * functions for videobuf2-*.
1222  */
1223 
1224 /**
1225  * vb2_buffer_in_use() - return true if the buffer is in use and
1226  * the queue cannot be freed (by the means of VIDIOC_REQBUFS(0)) call.
1227  *
1228  * @vb:		buffer for which plane size should be returned.
1229  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
1230  */
1231 bool vb2_buffer_in_use(struct vb2_queue *q, struct vb2_buffer *vb);
1232 
1233 /**
1234  * vb2_verify_memory_type() - Check whether the memory type and buffer type
1235  * passed to a buffer operation are compatible with the queue.
1236  *
1237  * @q:		pointer to &struct vb2_queue with videobuf2 queue.
1238  * @memory:	memory model, as defined by enum &vb2_memory.
1239  * @type:	private buffer type whose content is defined by the vb2-core
1240  *		caller. For example, for V4L2, it should match
1241  *		the types defined on enum &v4l2_buf_type.
1242  */
1243 int vb2_verify_memory_type(struct vb2_queue *q,
1244 		enum vb2_memory memory, unsigned int type);
1245 
1246 /**
1247  * vb2_request_object_is_buffer() - return true if the object is a buffer
1248  *
1249  * @obj:	the request object.
1250  */
1251 bool vb2_request_object_is_buffer(struct media_request_object *obj);
1252 
1253 /**
1254  * vb2_request_buffer_cnt() - return the number of buffers in the request
1255  *
1256  * @req:	the request.
1257  */
1258 unsigned int vb2_request_buffer_cnt(struct media_request *req);
1259 
1260 #endif /* _MEDIA_VIDEOBUF2_CORE_H */
1261