[linux-2.6-block.git] / drivers / usb / gadget / function / uvc_queue.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _UVC_QUEUE_H_
#define _UVC_QUEUE_H_

#include <linux/list.h>
#include <linux/poll.h>
#include <linux/spinlock.h>

#include <media/videobuf2-v4l2.h>

struct file;
struct mutex;

/* Maximum frame size in bytes, for sanity checking. */
#define UVC_MAX_FRAME_SIZE	(16*1024*1024)
/* Maximum number of video buffers. */
#define UVC_MAX_VIDEO_BUFFERS	32

/* ------------------------------------------------------------------------
 * Structures.
 */

enum uvc_buffer_state {
	UVC_BUF_STATE_IDLE	= 0,
	UVC_BUF_STATE_QUEUED	= 1,
	UVC_BUF_STATE_ACTIVE	= 2,
	UVC_BUF_STATE_DONE	= 3,
	UVC_BUF_STATE_ERROR	= 4,
};

struct uvc_buffer {
	struct vb2_v4l2_buffer buf;
	struct list_head queue;

	enum uvc_buffer_state state;
	void *mem;
	struct sg_table *sgt;
	struct scatterlist *sg;
	unsigned int offset;
	unsigned int length;
	unsigned int bytesused;
	/* req_payload_size: only used with isoc */
	unsigned int req_payload_size;
};

#define UVC_QUEUE_DISCONNECTED		(1 << 0)
#define UVC_QUEUE_DROP_INCOMPLETE	(1 << 1)

struct uvc_video_queue {
	struct vb2_queue queue;

	unsigned int flags;
	__u32 sequence;

	unsigned int buf_used;

	bool use_sg;

	spinlock_t irqlock;	/* Protects flags and irqqueue */
	struct list_head irqqueue;
};

static inline int uvc_queue_streaming(struct uvc_video_queue *queue)
{
	return vb2_is_streaming(&queue->queue);
}

int uvcg_queue_init(struct uvc_video_queue *queue, struct device *dev, enum v4l2_buf_type type,
		    struct mutex *lock);

void uvcg_free_buffers(struct uvc_video_queue *queue);

int uvcg_alloc_buffers(struct uvc_video_queue *queue,
		       struct v4l2_requestbuffers *rb);

int uvcg_query_buffer(struct uvc_video_queue *queue, struct v4l2_buffer *buf);

int uvcg_queue_buffer(struct uvc_video_queue *queue, struct v4l2_buffer *buf);

int uvcg_dequeue_buffer(struct uvc_video_queue *queue,
			struct v4l2_buffer *buf, int nonblocking);

__poll_t uvcg_queue_poll(struct uvc_video_queue *queue,
			     struct file *file, poll_table *wait);

int uvcg_queue_mmap(struct uvc_video_queue *queue, struct vm_area_struct *vma);

#ifndef CONFIG_MMU
unsigned long uvcg_queue_get_unmapped_area(struct uvc_video_queue *queue,
					   unsigned long pgoff);
#endif /* CONFIG_MMU */

void uvcg_queue_cancel(struct uvc_video_queue *queue, int disconnect);

int uvcg_queue_enable(struct uvc_video_queue *queue, int enable);

void uvcg_complete_buffer(struct uvc_video_queue *queue,
					  struct uvc_buffer *buf);

struct uvc_buffer *uvcg_queue_head(struct uvc_video_queue *queue);

#endif /* _UVC_QUEUE_H_ */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
cdda479f LP	2	#ifndef _UVC_QUEUE_H_
	3	#define _UVC_QUEUE_H_
	4
284eb166	5	#include <linux/list.h>
cdda479f	6	#include <linux/poll.h>
284eb166 LP	7	#include <linux/spinlock.h>
284eb166 LP	8
c139990e	9	#include <media/videobuf2-v4l2.h>
cdda479f	10
284eb166 LP	11	struct file;
	12	struct mutex;
	13
cdda479f LP	14	/* Maximum frame size in bytes, for sanity checking. */
	15	#define UVC_MAX_FRAME_SIZE (1610241024)
	16	/* Maximum number of video buffers. */
	17	#define UVC_MAX_VIDEO_BUFFERS 32
	18
	19	/* ------------------------------------------------------------------------
	20	* Structures.
	21	*/
	22
	23	enum uvc_buffer_state {
	24	UVC_BUF_STATE_IDLE = 0,
	25	UVC_BUF_STATE_QUEUED = 1,
	26	UVC_BUF_STATE_ACTIVE = 2,
	27	UVC_BUF_STATE_DONE = 3,
	28	UVC_BUF_STATE_ERROR = 4,
	29	};
	30
	31	struct uvc_buffer {
2d700715	32	struct vb2_v4l2_buffer buf;
cdda479f	33	struct list_head queue;
d6925225	34
cdda479f	35	enum uvc_buffer_state state;
d6925225	36	void *mem;
e81e7f9a MG	37	struct sg_table *sgt;
	38	struct scatterlist *sg;
	39	unsigned int offset;
d6925225 BS	40	unsigned int length;
d6925225 BS	41	unsigned int bytesused;
98ad0329 MG	42	/* req_payload_size: only used with isoc */
98ad0329 MG	43	unsigned int req_payload_size;
cdda479f LP	44	};
cdda479f LP	45
d6925225 BS	46	#define UVC_QUEUE_DISCONNECTED (1 << 0)
d6925225 BS	47	#define UVC_QUEUE_DROP_INCOMPLETE (1 << 1)
cdda479f LP	48
cdda479f LP	49	struct uvc_video_queue {
d6925225	50	struct vb2_queue queue;
cdda479f	51
cdda479f LP	52	unsigned int flags;
	53	__u32 sequence;
	54
cdda479f	55	unsigned int buf_used;
cdda479f	56
e81e7f9a MG	57	bool use_sg;
e81e7f9a MG	58
d6925225	59	spinlock_t irqlock; /* Protects flags and irqqueue */
cdda479f LP	60	struct list_head irqqueue;
	61	};
	62
cdda479f LP	63	static inline int uvc_queue_streaming(struct uvc_video_queue *queue)
cdda479f LP	64	{
d6925225	65	return vb2_is_streaming(&queue->queue);
cdda479f	66	}
cdda479f	67
e81e7f9a	68	int uvcg_queue_init(struct uvc_video_queue queue, struct device dev, enum v4l2_buf_type type,
d8e96c4b	69	struct mutex *lock);
3a83c16e AP	70
	71	void uvcg_free_buffers(struct uvc_video_queue *queue);
	72
	73	int uvcg_alloc_buffers(struct uvc_video_queue *queue,
	74	struct v4l2_requestbuffers *rb);
	75
	76	int uvcg_query_buffer(struct uvc_video_queue queue, struct v4l2_buffer buf);
	77
	78	int uvcg_queue_buffer(struct uvc_video_queue queue, struct v4l2_buffer buf);
	79
	80	int uvcg_dequeue_buffer(struct uvc_video_queue *queue,
	81	struct v4l2_buffer *buf, int nonblocking);
	82
c23e0cb8	83	__poll_t uvcg_queue_poll(struct uvc_video_queue *queue,
3a83c16e AP	84	struct file file, poll_table wait);
	85
	86	int uvcg_queue_mmap(struct uvc_video_queue queue, struct vm_area_struct vma);
	87
	88	#ifndef CONFIG_MMU
	89	unsigned long uvcg_queue_get_unmapped_area(struct uvc_video_queue *queue,
	90	unsigned long pgoff);
	91	#endif /* CONFIG_MMU */
	92
	93	void uvcg_queue_cancel(struct uvc_video_queue *queue, int disconnect);
	94
	95	int uvcg_queue_enable(struct uvc_video_queue *queue, int enable);
	96
61aa709c	97	void uvcg_complete_buffer(struct uvc_video_queue *queue,
3a83c16e AP	98	struct uvc_buffer *buf);
	99
	100	struct uvc_buffer uvcg_queue_head(struct uvc_video_queue queue);
	101
cdda479f LP	102	#endif /* _UVC_QUEUE_H_ */
cdda479f LP	103