videobuf2-core.h 27 KB
Newer Older
1
/*
2
 * videobuf2-core.h - Video Buffer 2 Core Framework
3 4 5
 *
 * Copyright (C) 2010 Samsung Electronics
 *
6
 * Author: Pawel Osciak <pawel@osciak.com>
7 8 9 10 11 12 13 14 15 16 17
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation.
 */
#ifndef _MEDIA_VIDEOBUF2_CORE_H
#define _MEDIA_VIDEOBUF2_CORE_H

#include <linux/mm_types.h>
#include <linux/mutex.h>
#include <linux/poll.h>
18
#include <linux/dma-buf.h>
19

20 21 22 23 24 25 26 27 28 29
#define VB2_MAX_FRAME	(32)
#define VB2_MAX_PLANES	(8)

enum vb2_memory {
	VB2_MEMORY_UNKNOWN	= 0,
	VB2_MEMORY_MMAP		= 1,
	VB2_MEMORY_USERPTR	= 2,
	VB2_MEMORY_DMABUF	= 4,
};

30
struct vb2_fileio_data;
31
struct vb2_threadio_data;
32 33 34 35 36 37 38

/**
 * struct vb2_mem_ops - memory handling/memory allocator operations
 * @alloc:	allocate video memory and, optionally, allocator private data,
 *		return NULL on failure or a pointer to allocator private,
 *		per-buffer data on success; the returned private structure
 *		will then be passed as buf_priv argument to other ops in this
39 40 41
 *		structure. Additional gfp_flags to use when allocating the
 *		are also passed to this operation. These flags are from the
 *		gfp_flags field of vb2_queue.
42 43 44 45
 * @put:	inform the allocator that the buffer will no longer be used;
 *		usually will result in the allocator freeing the buffer (if
 *		no other users of this buffer are present); the buf_priv
 *		argument is the allocator private per-buffer structure
46
 *		previously returned from the alloc callback.
47 48
 * @get_dmabuf: acquire userspace memory for a hardware operation; used for
 *		 DMABUF memory types.
49 50 51 52 53 54
 * @get_userptr: acquire userspace memory for a hardware operation; used for
 *		 USERPTR memory types; vaddr is the address passed to the
 *		 videobuf layer when queuing a video buffer of USERPTR type;
 *		 should return an allocator private per-buffer structure
 *		 associated with the buffer on success, NULL on failure;
 *		 the returned private structure will then be passed as buf_priv
55
 *		 argument to other ops in this structure.
56
 * @put_userptr: inform the allocator that a USERPTR buffer will no longer
57
 *		 be used.
58
 * @attach_dmabuf: attach a shared struct dma_buf for a hardware operation;
59
 *		   used for DMABUF memory types; dev is the alloc device
60 61
 *		   dbuf is the shared dma_buf; returns NULL on failure;
 *		   allocator private per-buffer structure on success;
62
 *		   this needs to be used for further accesses to the buffer.
63 64 65
 * @detach_dmabuf: inform the exporter of the buffer that the current DMABUF
 *		   buffer is no longer used; the buf_priv argument is the
 *		   allocator private per-buffer structure previously returned
66
 *		   from the attach_dmabuf callback.
67 68
 * @map_dmabuf: request for access to the dmabuf from allocator; the allocator
 *		of dmabuf is informed that this driver is going to use the
69
 *		dmabuf.
70
 * @unmap_dmabuf: releases access control to the dmabuf - allocator is notified
71
 *		  that this driver is done using the dmabuf for now.
72
 * @prepare:	called every time the buffer is passed from userspace to the
73
 *		driver, useful for cache synchronisation, optional.
74
 * @finish:	called every time the buffer is passed back from the driver
75
 *		to the userspace, also optional.
76 77
 * @vaddr:	return a kernel virtual address to a given memory buffer
 *		associated with the passed private structure or NULL if no
78
 *		such mapping exists.
79 80
 * @cookie:	return allocator specific cookie for a given memory buffer
 *		associated with the passed private structure or NULL if not
81
 *		available.
82 83
 * @num_users:	return the current number of users of a memory buffer;
 *		return 1 if the videobuf layer (or actually the driver using
84
 *		it) is the only user.
85
 * @mmap:	setup a userspace mapping for a given memory buffer under
86
 *		the provided virtual memory region.
87
 *
88 89 90 91 92 93 94 95 96 97 98
 * Those operations are used by the videobuf2 core to implement the memory
 * handling/memory allocators for each type of supported streaming I/O method.
 *
 * .. note::
 *    #) Required ops for USERPTR types: get_userptr, put_userptr.
 *
 *    #) Required ops for MMAP types: alloc, put, num_users, mmap.
 *
 *    #) Required ops for read/write access types: alloc, put, num_users, vaddr.
 *
 *    #) Required ops for DMABUF types: attach_dmabuf, detach_dmabuf, map_dmabuf, unmap_dmabuf.
99 100
 */
struct vb2_mem_ops {
101
	void		*(*alloc)(struct device *dev, unsigned long attrs,
102
				  unsigned long size, enum dma_data_direction dma_dir,
103
				  gfp_t gfp_flags);
104
	void		(*put)(void *buf_priv);
105
	struct dma_buf *(*get_dmabuf)(void *buf_priv, unsigned long flags);
106

107
	void		*(*get_userptr)(struct device *dev, unsigned long vaddr,
108 109
					unsigned long size,
					enum dma_data_direction dma_dir);
110 111
	void		(*put_userptr)(void *buf_priv);

112 113 114
	void		(*prepare)(void *buf_priv);
	void		(*finish)(void *buf_priv);

115
	void		*(*attach_dmabuf)(struct device *dev, struct dma_buf *dbuf,
116 117
					  unsigned long size,
					  enum dma_data_direction dma_dir);
118 119 120 121
	void		(*detach_dmabuf)(void *buf_priv);
	int		(*map_dmabuf)(void *buf_priv);
	void		(*unmap_dmabuf)(void *buf_priv);

122 123 124 125 126 127 128 129
	void		*(*vaddr)(void *buf_priv);
	void		*(*cookie)(void *buf_priv);

	unsigned int	(*num_users)(void *buf_priv);

	int		(*mmap)(void *buf_priv, struct vm_area_struct *vma);
};

130 131 132 133 134 135 136
/**
 * struct vb2_plane - plane information
 * @mem_priv:	private data with this plane
 * @dbuf:	dma_buf - shared buffer object
 * @dbuf_mapped:	flag to show whether dbuf is mapped or not
 * @bytesused:	number of bytes occupied by data in the plane (payload)
 * @length:	size of this plane (NOT the payload) in bytes
137 138
 * @min_length:	minimum required size of this plane (NOT the payload) in bytes.
 *		@length is always greater or equal to @min_length.
139
 * @offset:	when memory in the associated struct vb2_buffer is
140 141 142 143 144 145 146
 *		VB2_MEMORY_MMAP, equals the offset from the start of
 *		the device memory for this plane (or is a "cookie" that
 *		should be passed to mmap() called on the video node)
 * @userptr:	when memory is VB2_MEMORY_USERPTR, a userspace pointer
 *		pointing to this plane
 * @fd:		when memory is VB2_MEMORY_DMABUF, a userspace file
 *		descriptor associated with this plane
147 148
 * @m:		Union with memtype-specific data (@offset, @userptr or
 *		@fd).
149 150 151 152 153
 * @data_offset:	offset in the plane to the start of data; usually 0,
 *		unless there is a header in front of the data
 * Should contain enough information to be able to cover all the fields
 * of struct v4l2_plane at videodev2.h
 */
154 155
struct vb2_plane {
	void			*mem_priv;
156 157
	struct dma_buf		*dbuf;
	unsigned int		dbuf_mapped;
158 159
	unsigned int		bytesused;
	unsigned int		length;
160
	unsigned int		min_length;
161 162 163 164 165 166
	union {
		unsigned int	offset;
		unsigned long	userptr;
		int		fd;
	} m;
	unsigned int		data_offset;
167 168 169 170 171 172 173 174
};

/**
 * enum vb2_io_modes - queue access methods
 * @VB2_MMAP:		driver supports MMAP with streaming API
 * @VB2_USERPTR:	driver supports USERPTR with streaming API
 * @VB2_READ:		driver supports read() style access
 * @VB2_WRITE:		driver supports write() style access
175
 * @VB2_DMABUF:		driver supports DMABUF with streaming API
176 177 178 179 180 181
 */
enum vb2_io_modes {
	VB2_MMAP	= (1 << 0),
	VB2_USERPTR	= (1 << 1),
	VB2_READ	= (1 << 2),
	VB2_WRITE	= (1 << 3),
182
	VB2_DMABUF	= (1 << 4),
183 184 185 186 187
};

/**
 * enum vb2_buffer_state - current video buffer state
 * @VB2_BUF_STATE_DEQUEUED:	buffer under userspace control
188
 * @VB2_BUF_STATE_PREPARING:	buffer is being prepared in videobuf
189
 * @VB2_BUF_STATE_PREPARED:	buffer prepared in videobuf and by the driver
190
 * @VB2_BUF_STATE_QUEUED:	buffer queued in videobuf, but not in driver
191
 * @VB2_BUF_STATE_REQUEUEING:	re-queue a buffer to the driver
192 193 194 195 196 197 198 199 200 201
 * @VB2_BUF_STATE_ACTIVE:	buffer queued in driver and possibly used
 *				in a hardware operation
 * @VB2_BUF_STATE_DONE:		buffer returned from driver to videobuf, but
 *				not yet dequeued to userspace
 * @VB2_BUF_STATE_ERROR:	same as above, but the operation on the buffer
 *				has ended with an error, which will be reported
 *				to the userspace when it is dequeued
 */
enum vb2_buffer_state {
	VB2_BUF_STATE_DEQUEUED,
202
	VB2_BUF_STATE_PREPARING,
203
	VB2_BUF_STATE_PREPARED,
204
	VB2_BUF_STATE_QUEUED,
205
	VB2_BUF_STATE_REQUEUEING,
206 207 208 209 210 211 212 213 214 215
	VB2_BUF_STATE_ACTIVE,
	VB2_BUF_STATE_DONE,
	VB2_BUF_STATE_ERROR,
};

struct vb2_queue;

/**
 * struct vb2_buffer - represents a video buffer
 * @vb2_queue:		the queue to which this driver belongs
216 217 218
 * @index:		id number of the buffer
 * @type:		buffer type
 * @memory:		the method, in which the actual data is passed
219 220
 * @num_planes:		number of planes in the buffer
 *			on an internal driver queue
221
 * @planes:		private per-plane information; do not change
222
 * @timestamp:		frame timestamp in ns
223 224 225
 */
struct vb2_buffer {
	struct vb2_queue	*vb2_queue;
226 227 228
	unsigned int		index;
	unsigned int		type;
	unsigned int		memory;
229
	unsigned int		num_planes;
230
	struct vb2_plane	planes[VB2_MAX_PLANES];
231
	u64			timestamp;
232

233 234 235 236 237 238 239 240
	/* private: internal use only
	 *
	 * state:		current buffer state; do not change
	 * queued_entry:	entry on the queued buffers list, which holds
	 *			all buffers queued from userspace
	 * done_entry:		entry on the list that stores all buffers ready
	 *			to be dequeued to userspace
	 */
241 242 243 244
	enum vb2_buffer_state	state;

	struct list_head	queued_entry;
	struct list_head	done_entry;
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
#ifdef CONFIG_VIDEO_ADV_DEBUG
	/*
	 * Counters for how often these buffer-related ops are
	 * called. Used to check for unbalanced ops.
	 */
	u32		cnt_mem_alloc;
	u32		cnt_mem_put;
	u32		cnt_mem_get_dmabuf;
	u32		cnt_mem_get_userptr;
	u32		cnt_mem_put_userptr;
	u32		cnt_mem_prepare;
	u32		cnt_mem_finish;
	u32		cnt_mem_attach_dmabuf;
	u32		cnt_mem_detach_dmabuf;
	u32		cnt_mem_map_dmabuf;
	u32		cnt_mem_unmap_dmabuf;
	u32		cnt_mem_vaddr;
	u32		cnt_mem_cookie;
	u32		cnt_mem_num_users;
	u32		cnt_mem_mmap;

	u32		cnt_buf_init;
	u32		cnt_buf_prepare;
	u32		cnt_buf_finish;
	u32		cnt_buf_cleanup;
	u32		cnt_buf_queue;

	/* This counts the number of calls to vb2_buffer_done() */
	u32		cnt_buf_done;
#endif
275 276 277 278 279
};

/**
 * struct vb2_ops - driver-specific callbacks
 *
280
 * @queue_setup:	called from %VIDIOC_REQBUFS and %VIDIOC_CREATE_BUFS
281 282 283 284 285 286
 *			handlers before memory allocation. It can be called
 *			twice: if the original number of requested buffers
 *			could not be allocated, then it will be called a
 *			second time with the actually allocated number of
 *			buffers to verify if that is OK.
 *			The driver should return the required number of buffers
287 288
 *			in \*num_buffers, the required number of planes per
 *			buffer in \*num_planes, the size of each plane should be
289 290 291
 *			set in the sizes\[\] array and optional per-plane
 *			allocator specific device in the alloc_devs\[\] array.
 *			When called from %VIDIOC_REQBUFS, \*num_planes == 0, the
292
 *			driver has to use the currently configured format to
293
 *			determine the plane sizes and \*num_buffers is the total
294
 *			number of buffers that are being allocated. When called
295 296
 *			from %VIDIOC_CREATE_BUFS, \*num_planes != 0 and it
 *			describes the requested number of planes and sizes\[\]
297
 *			contains the requested plane sizes. If either
298
 *			\*num_planes or the requested sizes are invalid callback
299
 *			must return %-EINVAL. In this case \*num_buffers are
300
 *			being allocated additionally to q->num_buffers.
301 302 303
 * @wait_prepare:	release any locks taken while calling vb2 functions;
 *			it is called before an ioctl needs to wait for a new
 *			buffer to arrive; required to avoid a deadlock in
304
 *			blocking access type.
305 306
 * @wait_finish:	reacquire all locks released in the previous callback;
 *			required to continue operation after sleeping while
307
 *			waiting for a new buffer to arrive.
308 309 310 311
 * @buf_init:		called once after allocating a buffer (in MMAP case)
 *			or after acquiring a new USERPTR buffer; drivers may
 *			perform additional buffer-related initialization;
 *			initialization failure (return != 0) will prevent
312
 *			queue setup from completing successfully; optional.
313
 * @buf_prepare:	called every time the buffer is queued from userspace
314
 *			and from the %VIDIOC_PREPARE_BUF ioctl; drivers may
315 316 317
 *			perform any initialization required before each
 *			hardware operation in this callback; drivers can
 *			access/modify the buffer here as it is still synced for
318
 *			the CPU; drivers that support %VIDIOC_CREATE_BUFS must
319 320
 *			also validate the buffer size; if an error is returned,
 *			the buffer will not be queued in driver; optional.
321
 * @buf_finish:		called before every dequeue of the buffer back to
322 323 324 325
 *			userspace; the buffer is synced for the CPU, so drivers
 *			can access/modify the buffer contents; drivers may
 *			perform any operations required before userspace
 *			accesses the buffer; optional. The buffer state can be
326 327
 *			one of the following: %DONE and %ERROR occur while
 *			streaming is in progress, and the %PREPARED state occurs
328
 *			when the queue has been canceled and all pending
329
 *			buffers are being returned to their default %DEQUEUED
330
 *			state. Typically you only have to do something if the
331
 *			state is %VB2_BUF_STATE_DONE, since in all other cases
332
 *			the buffer contents will be ignored anyway.
333
 * @buf_cleanup:	called once before the buffer is freed; drivers may
334
 *			perform any additional cleanup; optional.
335
 * @start_streaming:	called once to enter 'streaming' state; the driver may
336 337 338 339 340 341 342
 *			receive buffers with @buf_queue callback
 *			before @start_streaming is called; the driver gets the
 *			number of already queued buffers in count parameter;
 *			driver can return an error if hardware fails, in that
 *			case all buffers that have been already given by
 *			the @buf_queue callback are to be returned by the driver
 *			by calling @vb2_buffer_done\(%VB2_BUF_STATE_QUEUED\).
343 344 345 346 347
 *			If you need a minimum number of buffers before you can
 *			start streaming, then set @min_buffers_needed in the
 *			vb2_queue structure. If that is non-zero then
 *			start_streaming won't be called until at least that
 *			many buffers have been queued up by userspace.
348 349
 * @stop_streaming:	called when 'streaming' state must be disabled; driver
 *			should stop any DMA transactions or wait until they
350 351 352
 *			finish and give back all buffers it got from &buf_queue
 *			callback by calling @vb2_buffer_done\(\) with either
 *			%VB2_BUF_STATE_DONE or %VB2_BUF_STATE_ERROR; may use
353
 *			vb2_wait_for_all_buffers() function
354 355
 * @buf_queue:		passes buffer vb to the driver; driver may start
 *			hardware operation on this buffer; driver should give
356
 *			the buffer back by calling vb2_buffer_done() function;
357
 *			it is allways called after calling %VIDIOC_STREAMON ioctl;
358
 *			might be called before start_streaming callback if user
359
 *			pre-queued buffers before calling %VIDIOC_STREAMON.
360 361
 */
struct vb2_ops {
362
	int (*queue_setup)(struct vb2_queue *q,
363
			   unsigned int *num_buffers, unsigned int *num_planes,
364
			   unsigned int sizes[], struct device *alloc_devs[]);
365 366 367 368 369 370

	void (*wait_prepare)(struct vb2_queue *q);
	void (*wait_finish)(struct vb2_queue *q);

	int (*buf_init)(struct vb2_buffer *vb);
	int (*buf_prepare)(struct vb2_buffer *vb);
371
	void (*buf_finish)(struct vb2_buffer *vb);
372 373
	void (*buf_cleanup)(struct vb2_buffer *vb);

374
	int (*start_streaming)(struct vb2_queue *q, unsigned int count);
375
	void (*stop_streaming)(struct vb2_queue *q);
376 377 378 379

	void (*buf_queue)(struct vb2_buffer *vb);
};

380 381 382
/**
 * struct vb2_ops - driver-specific callbacks
 *
383 384 385
 * @verify_planes_array: Verify that a given user space structure contains
 *			enough planes for the buffer. This is called
 *			for each dequeued buffer.
386 387 388 389 390 391 392 393
 * @fill_user_buffer:	given a vb2_buffer fill in the userspace structure.
 *			For V4L2 this is a struct v4l2_buffer.
 * @fill_vb2_buffer:	given a userspace structure, fill in the vb2_buffer.
 *			If the userspace structure is invalid, then this op
 *			will return an error.
 * @copy_timestamp:	copy the timestamp from a userspace structure to
 *			the vb2_buffer struct.
 */
394
struct vb2_buf_ops {
395
	int (*verify_planes_array)(struct vb2_buffer *vb, const void *pb);
396
	void (*fill_user_buffer)(struct vb2_buffer *vb, void *pb);
397 398
	int (*fill_vb2_buffer)(struct vb2_buffer *vb, const void *pb,
				struct vb2_plane *planes);
399
	void (*copy_timestamp)(struct vb2_buffer *vb, const void *pb);
400
};
401

402 403 404
/**
 * struct vb2_queue - a videobuf queue
 *
405 406 407
 * @type:	private buffer type whose content is defined by the vb2-core
 *		caller. For example, for V4L2, it should match
 *		the V4L2_BUF_TYPE_* in include/uapi/linux/videodev2.h
408
 * @io_modes:	supported io methods (see vb2_io_modes enum)
409
 * @dev:	device to use for the default allocation context if the driver
410
 *		doesn't fill in the @alloc_devs array.
411
 * @dma_attrs:	DMA attributes to use for the DMA.
412 413
 * @fileio_read_once:		report EOF after reading the first buffer
 * @fileio_write_immediately:	queue buffer after each write() call
414
 * @allow_zero_bytesused:	allow bytesused == 0 to be passed to the driver
415 416 417
 * @quirk_poll_must_check_waiting_for_buffers: Return POLLERR at poll when QBUF
 *              has not been called. This is a vb1 idiom that has been adopted
 *              also by vb2.
418 419 420 421 422 423 424 425 426
 * @lock:	pointer to a mutex that protects the vb2_queue struct. The
 *		driver can set this to a mutex to let the v4l2 core serialize
 *		the queuing ioctls. If the driver wants to handle locking
 *		itself, then this should be set to NULL. This lock is not used
 *		by the videobuf2 core API.
 * @owner:	The filehandle that 'owns' the buffers, i.e. the filehandle
 *		that called reqbufs, create_buffers or started fileio.
 *		This field is not used by the videobuf2 core API, but it allows
 *		drivers to easily associate an owner filehandle with the queue.
427 428
 * @ops:	driver-specific callbacks
 * @mem_ops:	memory allocator specific callbacks
429 430
 * @buf_ops:	callbacks to deliver buffer information
 *		between user-space and kernel-space
431 432 433
 * @drv_priv:	driver private data
 * @buf_struct_size: size of the driver-specific buffer structure;
 *		"0" indicates the driver doesn't want to use a custom buffer
434 435
 *		structure type. for example, sizeof(struct vb2_v4l2_buffer)
 *		will be used for v4l2.
436 437
 * @timestamp_flags: Timestamp flags; V4L2_BUF_FLAG_TIMESTAMP_* and
 *		V4L2_BUF_FLAG_TSTAMP_SRC_*
438 439 440
 * @gfp_flags:	additional gfp flags used when allocating the buffers.
 *		Typically this is 0, but it may be e.g. GFP_DMA or __GFP_DMA32
 *		to force the buffer allocation to a specific memory zone.
441 442 443 444
 * @min_buffers_needed: the minimum number of buffers needed before
 *		start_streaming() can be called. Used when a DMA engine
 *		cannot be started unless at least this number of buffers
 *		have been queued into the driver.
445 446 447
 */
/*
 * Private elements (won't appear at the DocBook):
448
 * @mmap_lock:	private mutex used when buffers are allocated/freed/mmapped
449 450 451 452
 * @memory:	current memory type used
 * @bufs:	videobuf buffer structures
 * @num_buffers: number of allocated/used buffers
 * @queued_list: list of buffers currently queued from userspace
453
 * @queued_count: number of buffers queued and ready for streaming.
454
 * @owned_by_drv_count: number of buffers owned by the driver
455 456 457
 * @done_list:	list of buffers ready to be dequeued to userspace
 * @done_lock:	lock to protect done_list list
 * @done_wq:	waitqueue for processes waiting for buffers ready to be dequeued
458
 * @alloc_devs:	memory type/allocator-specific per-plane device
459
 * @streaming:	current streaming state
460 461
 * @start_streaming_called: start_streaming() was called successfully and we
 *		started streaming.
462
 * @error:	a fatal error occurred on the queue
463 464 465
 * @waiting_for_buffers: used in poll() to check if vb2 is still waiting for
 *		buffers. Only set for capture queues if qbuf has not yet been
 *		called since poll() needs to return POLLERR in that situation.
466 467
 * @is_multiplanar: set if buffer type is multiplanar
 * @is_output:	set if buffer type is output
468
 * @copy_timestamp: set if vb2-core should set timestamps
469 470 471
 * @last_buffer_dequeued: used in poll() and DQBUF to immediately return if the
 *		last decoded buffer was already dequeued. Set for capture queues
 *		when a buffer with the V4L2_BUF_FLAG_LAST is dequeued.
472
 * @fileio:	file io emulator internal data, used only if emulator is active
473
 * @threadio:	thread io internal data, used only if thread is active
474 475
 */
struct vb2_queue {
476
	unsigned int			type;
477
	unsigned int			io_modes;
478
	struct device			*dev;
479
	unsigned long			dma_attrs;
480 481
	unsigned			fileio_read_once:1;
	unsigned			fileio_write_immediately:1;
482
	unsigned			allow_zero_bytesused:1;
483
	unsigned		   quirk_poll_must_check_waiting_for_buffers:1;
484

485
	struct mutex			*lock;
486
	void				*owner;
487 488 489

	const struct vb2_ops		*ops;
	const struct vb2_mem_ops	*mem_ops;
490 491
	const struct vb2_buf_ops	*buf_ops;

492 493
	void				*drv_priv;
	unsigned int			buf_struct_size;
494
	u32				timestamp_flags;
495
	gfp_t				gfp_flags;
496
	u32				min_buffers_needed;
497

498
	/* private: internal use only */
499
	struct mutex			mmap_lock;
500 501
	unsigned int			memory;
	struct vb2_buffer		*bufs[VB2_MAX_FRAME];
502 503 504
	unsigned int			num_buffers;

	struct list_head		queued_list;
505
	unsigned int			queued_count;
506

507
	atomic_t			owned_by_drv_count;
508 509 510 511
	struct list_head		done_list;
	spinlock_t			done_lock;
	wait_queue_head_t		done_wq;

512
	struct device			*alloc_devs[VB2_MAX_PLANES];
513 514

	unsigned int			streaming:1;
515
	unsigned int			start_streaming_called:1;
516
	unsigned int			error:1;
517
	unsigned int			waiting_for_buffers:1;
518 519
	unsigned int			is_multiplanar:1;
	unsigned int			is_output:1;
520
	unsigned int			copy_timestamp:1;
521
	unsigned int			last_buffer_dequeued:1;
522 523

	struct vb2_fileio_data		*fileio;
524
	struct vb2_threadio_data	*threadio;
525 526 527 528 529 530 531 532 533 534 535 536

#ifdef CONFIG_VIDEO_ADV_DEBUG
	/*
	 * Counters for how often these queue-related ops are
	 * called. Used to check for unbalanced ops.
	 */
	u32				cnt_queue_setup;
	u32				cnt_wait_prepare;
	u32				cnt_wait_finish;
	u32				cnt_start_streaming;
	u32				cnt_stop_streaming;
#endif
537 538 539 540 541 542
};

void *vb2_plane_vaddr(struct vb2_buffer *vb, unsigned int plane_no);
void *vb2_plane_cookie(struct vb2_buffer *vb, unsigned int plane_no);

void vb2_buffer_done(struct vb2_buffer *vb, enum vb2_buffer_state state);
543
void vb2_discard_done(struct vb2_queue *q);
544 545
int vb2_wait_for_all_buffers(struct vb2_queue *q);

546
void vb2_core_querybuf(struct vb2_queue *q, unsigned int index, void *pb);
547 548 549
int vb2_core_reqbufs(struct vb2_queue *q, enum vb2_memory memory,
		unsigned int *count);
int vb2_core_create_bufs(struct vb2_queue *q, enum vb2_memory memory,
550 551
		unsigned int *count, unsigned requested_planes,
		const unsigned int requested_sizes[]);
552 553
int vb2_core_prepare_buf(struct vb2_queue *q, unsigned int index, void *pb);
int vb2_core_qbuf(struct vb2_queue *q, unsigned int index, void *pb);
554 555
int vb2_core_dqbuf(struct vb2_queue *q, unsigned int *pindex, void *pb,
		   bool nonblocking);
556

557 558
int vb2_core_streamon(struct vb2_queue *q, unsigned int type);
int vb2_core_streamoff(struct vb2_queue *q, unsigned int type);
559

560 561
int vb2_core_expbuf(struct vb2_queue *q, int *fd, unsigned int type,
		unsigned int index, unsigned int plane, unsigned int flags);
562

563 564
int vb2_core_queue_init(struct vb2_queue *q);
void vb2_core_queue_release(struct vb2_queue *q);
565

566
void vb2_queue_error(struct vb2_queue *q);
567 568

int vb2_mmap(struct vb2_queue *q, struct vm_area_struct *vma);
569 570 571 572 573 574 575
#ifndef CONFIG_MMU
unsigned long vb2_get_unmapped_area(struct vb2_queue *q,
				    unsigned long addr,
				    unsigned long len,
				    unsigned long pgoff,
				    unsigned long flags);
#endif
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
unsigned int vb2_core_poll(struct vb2_queue *q, struct file *file,
		poll_table *wait);
size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count,
		loff_t *ppos, int nonblock);
size_t vb2_write(struct vb2_queue *q, const char __user *data, size_t count,
		loff_t *ppos, int nonblock);

/*
 * vb2_thread_fnc - callback function for use with vb2_thread
 *
 * This is called whenever a buffer is dequeued in the thread.
 */
typedef int (*vb2_thread_fnc)(struct vb2_buffer *vb, void *priv);

/**
 * vb2_thread_start() - start a thread for the given queue.
 * @q:		videobuf queue
 * @fnc:	callback function
 * @priv:	priv pointer passed to the callback function
 * @thread_name:the name of the thread. This will be prefixed with "vb2-".
 *
 * This starts a thread that will queue and dequeue until an error occurs
 * or @vb2_thread_stop is called.
 *
 * This function should not be used for anything else but the videobuf2-dvb
 * support. If you think you have another good use-case for this, then please
 * contact the linux-media mailinglist first.
 */
int vb2_thread_start(struct vb2_queue *q, vb2_thread_fnc fnc, void *priv,
		     const char *thread_name);

/**
 * vb2_thread_stop() - stop the thread for the given queue.
 * @q:		videobuf queue
 */
int vb2_thread_stop(struct vb2_queue *q);
612 613 614 615 616 617 618 619 620 621

/**
 * vb2_is_streaming() - return streaming status of the queue
 * @q:		videobuf queue
 */
static inline bool vb2_is_streaming(struct vb2_queue *q)
{
	return q->streaming;
}

622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
/**
 * vb2_fileio_is_active() - return true if fileio is active.
 * @q:		videobuf queue
 *
 * This returns true if read() or write() is used to stream the data
 * as opposed to stream I/O. This is almost never an important distinction,
 * except in rare cases. One such case is that using read() or write() to
 * stream a format using V4L2_FIELD_ALTERNATE is not allowed since there
 * is no way you can pass the field information of each buffer to/from
 * userspace. A driver that supports this field format should check for
 * this in the queue_setup op and reject it if this function returns true.
 */
static inline bool vb2_fileio_is_active(struct vb2_queue *q)
{
	return q->fileio;
}

639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668
/**
 * vb2_is_busy() - return busy status of the queue
 * @q:		videobuf queue
 *
 * This function checks if queue has any buffers allocated.
 */
static inline bool vb2_is_busy(struct vb2_queue *q)
{
	return (q->num_buffers > 0);
}

/**
 * vb2_get_drv_priv() - return driver private data associated with the queue
 * @q:		videobuf queue
 */
static inline void *vb2_get_drv_priv(struct vb2_queue *q)
{
	return q->drv_priv;
}

/**
 * vb2_set_plane_payload() - set bytesused for the plane plane_no
 * @vb:		buffer for which plane payload should be set
 * @plane_no:	plane number for which payload should be set
 * @size:	payload in bytes
 */
static inline void vb2_set_plane_payload(struct vb2_buffer *vb,
				 unsigned int plane_no, unsigned long size)
{
	if (plane_no < vb->num_planes)
669
		vb->planes[plane_no].bytesused = size;
670 671 672
}

/**
673
 * vb2_get_plane_payload() - get bytesused for the plane plane_no
674 675 676 677 678 679 680
 * @vb:		buffer for which plane payload should be set
 * @plane_no:	plane number for which payload should be set
 */
static inline unsigned long vb2_get_plane_payload(struct vb2_buffer *vb,
				 unsigned int plane_no)
{
	if (plane_no < vb->num_planes)
681
		return vb->planes[plane_no].bytesused;
682 683 684 685 686 687 688 689 690 691 692 693
	return 0;
}

/**
 * vb2_plane_size() - return plane size in bytes
 * @vb:		buffer for which plane size should be returned
 * @plane_no:	plane number for which size should be returned
 */
static inline unsigned long
vb2_plane_size(struct vb2_buffer *vb, unsigned int plane_no)
{
	if (plane_no < vb->num_planes)
694
		return vb->planes[plane_no].length;
695 696 697
	return 0;
}

698 699 700 701 702 703 704 705 706
/**
 * vb2_start_streaming_called() - return streaming status of driver
 * @q:		videobuf queue
 */
static inline bool vb2_start_streaming_called(struct vb2_queue *q)
{
	return q->start_streaming_called;
}

707 708 709 710 711 712 713 714 715
/**
 * vb2_clear_last_buffer_dequeued() - clear last buffer dequeued flag of queue
 * @q:		videobuf queue
 */
static inline void vb2_clear_last_buffer_dequeued(struct vb2_queue *q)
{
	q->last_buffer_dequeued = false;
}

716 717 718 719 720 721 722
/*
 * The following functions are not part of the vb2 core API, but are useful
 * functions for videobuf2-*.
 */
bool vb2_buffer_in_use(struct vb2_queue *q, struct vb2_buffer *vb);
int vb2_verify_memory_type(struct vb2_queue *q,
		enum vb2_memory memory, unsigned int type);
723
#endif /* _MEDIA_VIDEOBUF2_CORE_H */