[deliverable/linux.git] / include / media / videobuf-core.h

/*
 * generic helper functions for handling video4linux capture buffers
 *
 * (c) 2007 Mauro Carvalho Chehab, <mchehab@infradead.org>
 *
 * Highly based on video-buf written originally by:
 * (c) 2001,02 Gerd Knorr <kraxel@bytesex.org>
 * (c) 2006 Mauro Carvalho Chehab, <mchehab@infradead.org>
 * (c) 2006 Ted Walther and John Sokol
 *
 * 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; either version 2
 */

#include <linux/poll.h>
#ifdef CONFIG_VIDEO_V4L1_COMPAT
#include <linux/videodev.h>
#endif
#include <linux/videodev2.h>

#define UNSET (-1U)


struct videobuf_buffer;
struct videobuf_queue;

/* --------------------------------------------------------------------- */

/*
 * A small set of helper functions to manage video4linux buffers.
 *
 * struct videobuf_buffer holds the data structures used by the helper
 * functions, additionally some commonly used fields for v4l buffers
 * (width, height, lists, waitqueue) are in there.  That struct should
 * be used as first element in the drivers buffer struct.
 *
 * about the mmap helpers (videobuf_mmap_*):
 *
 * The mmaper function allows to map any subset of contingous buffers.
 * This includes one mmap() call for all buffers (which the original
 * video4linux API uses) as well as one mmap() for every single buffer
 * (which v4l2 uses).
 *
 * If there is a valid mapping for a buffer, buffer->baddr/bsize holds
 * userspace address + size which can be feeded into the
 * videobuf_dma_init_user function listed above.
 *
 */

struct videobuf_mapping {
	unsigned int count;
	unsigned long start;
	unsigned long end;
	struct videobuf_queue *q;
};

enum videobuf_state {
	VIDEOBUF_NEEDS_INIT = 0,
	VIDEOBUF_PREPARED   = 1,
	VIDEOBUF_QUEUED     = 2,
	VIDEOBUF_ACTIVE     = 3,
	VIDEOBUF_DONE       = 4,
	VIDEOBUF_ERROR      = 5,
	VIDEOBUF_IDLE       = 6,
};

struct videobuf_buffer {
	unsigned int            i;
	u32                     magic;

	/* info about the buffer */
	unsigned int            width;
	unsigned int            height;
	unsigned int            bytesperline; /* use only if != 0 */
	unsigned long           size;
	unsigned int            input;
	enum v4l2_field         field;
	enum videobuf_state     state;
	struct list_head        stream;  /* QBUF/DQBUF list */

	/* touched by irq handler */
	struct list_head        queue;
	wait_queue_head_t       done;
	unsigned int            field_count;
	struct timeval          ts;

	/* Memory type */
	enum v4l2_memory        memory;

	/* buffer size */
	size_t                  bsize;

	/* buffer offset (mmap + overlay) */
	size_t                  boff;

	/* buffer addr (userland ptr!) */
	unsigned long           baddr;

	/* for mmap'ed buffers */
	struct videobuf_mapping *map;

	/* Private pointer to allow specific methods to store their data */
	int			privsize;
	void                    *priv;
};

struct videobuf_queue_ops {
	int (*buf_setup)(struct videobuf_queue *q,
			 unsigned int *count, unsigned int *size);
	int (*buf_prepare)(struct videobuf_queue *q,
			   struct videobuf_buffer *vb,
			   enum v4l2_field field);
	void (*buf_queue)(struct videobuf_queue *q,
			  struct videobuf_buffer *vb);
	void (*buf_release)(struct videobuf_queue *q,
			    struct videobuf_buffer *vb);
};

#define MAGIC_QTYPE_OPS	0x12261003

/* Helper operations - device type dependent */
struct videobuf_qtype_ops {
	u32                     magic;

	void* (*alloc)		(size_t size);
	int (*iolock)		(struct videobuf_queue* q,
				 struct videobuf_buffer *vb,
				 struct v4l2_framebuffer *fbuf);
	int (*mmap)		(struct videobuf_queue *q,
				 unsigned int *count,
				 unsigned int *size,
				 enum v4l2_memory memory);
	int (*sync)		(struct videobuf_queue* q,
				 struct videobuf_buffer *buf);
	int (*video_copy_to_user)(struct videobuf_queue *q,
				 char __user *data,
				 size_t count,
				 int nonblocking);
	int (*copy_stream)	(struct videobuf_queue *q,
				 char __user *data,
				 size_t count,
				 size_t pos,
				 int vbihack,
				 int nonblocking);
	int (*mmap_free)	(struct videobuf_queue *q);
	int (*mmap_mapper)	(struct videobuf_queue *q,
				struct vm_area_struct *vma);
};

struct videobuf_queue {
	struct mutex               vb_lock;
	spinlock_t                 *irqlock;
	struct device		   *dev;

	wait_queue_head_t	   wait; /* wait if queue is empty */

	enum v4l2_buf_type         type;
	unsigned int               inputs; /* for V4L2_BUF_FLAG_INPUT */
	unsigned int               msize;
	enum v4l2_field            field;
	enum v4l2_field            last;   /* for field=V4L2_FIELD_ALTERNATE */
	struct videobuf_buffer     *bufs[VIDEO_MAX_FRAME];
	struct videobuf_queue_ops  *ops;
	struct videobuf_qtype_ops  *int_ops;

	unsigned int               streaming:1;
	unsigned int               reading:1;
	unsigned int		   is_mmapped:1;

	/* capture via mmap() + ioctl(QBUF/DQBUF) */
	struct list_head           stream;

	/* capture via read() */
	unsigned int               read_off;
	struct videobuf_buffer     *read_buf;

	/* driver private data */
	void                       *priv_data;
};

int videobuf_waiton(struct videobuf_buffer *vb, int non_blocking, int intr);
int videobuf_iolock(struct videobuf_queue* q, struct videobuf_buffer *vb,
		struct v4l2_framebuffer *fbuf);

void *videobuf_alloc(struct videobuf_queue* q);

void videobuf_queue_core_init(struct videobuf_queue *q,
			 struct videobuf_queue_ops *ops,
			 struct device *dev,
			 spinlock_t *irqlock,
			 enum v4l2_buf_type type,
			 enum v4l2_field field,
			 unsigned int msize,
			 void *priv,
			 struct videobuf_qtype_ops *int_ops);
int  videobuf_queue_is_busy(struct videobuf_queue *q);
void videobuf_queue_cancel(struct videobuf_queue *q);

enum v4l2_field videobuf_next_field(struct videobuf_queue *q);
int videobuf_reqbufs(struct videobuf_queue *q,
		     struct v4l2_requestbuffers *req);
int videobuf_querybuf(struct videobuf_queue *q, struct v4l2_buffer *b);
int videobuf_qbuf(struct videobuf_queue *q,
		  struct v4l2_buffer *b);
int videobuf_dqbuf(struct videobuf_queue *q,
		   struct v4l2_buffer *b, int nonblocking);
#ifdef CONFIG_VIDEO_V4L1_COMPAT
int videobuf_cgmbuf(struct videobuf_queue *q,
		    struct video_mbuf *mbuf, int count);
#endif
int videobuf_streamon(struct videobuf_queue *q);
int videobuf_streamoff(struct videobuf_queue *q);

void videobuf_stop(struct videobuf_queue *q);

int videobuf_read_start(struct videobuf_queue *q);
void videobuf_read_stop(struct videobuf_queue *q);
ssize_t videobuf_read_stream(struct videobuf_queue *q,
			     char __user *data, size_t count, loff_t *ppos,
			     int vbihack, int nonblocking);
ssize_t videobuf_read_one(struct videobuf_queue *q,
			  char __user *data, size_t count, loff_t *ppos,
			  int nonblocking);
unsigned int videobuf_poll_stream(struct file *file,
				  struct videobuf_queue *q,
				  poll_table *wait);

int videobuf_mmap_setup(struct videobuf_queue *q,
			unsigned int bcount, unsigned int bsize,
			enum v4l2_memory memory);
int videobuf_mmap_free(struct videobuf_queue *q);
int videobuf_mmap_mapper(struct videobuf_queue *q,
			 struct vm_area_struct *vma);

/* --------------------------------------------------------------------- */

/*
 * Local variables:
 * c-basic-offset: 8
 * End:
 */
Commit	Line	Data
7a7d9a89 MCC	1	/*
	2	* generic helper functions for handling video4linux capture buffers
	3	*
	4	* (c) 2007 Mauro Carvalho Chehab, <mchehab@infradead.org>
	5	*
	6	* Highly based on video-buf written originally by:
	7	* (c) 2001,02 Gerd Knorr <kraxel@bytesex.org>
	8	* (c) 2006 Mauro Carvalho Chehab, <mchehab@infradead.org>
	9	* (c) 2006 Ted Walther and John Sokol
	10	*
	11	* This program is free software; you can redistribute it and/or modify
	12	* it under the terms of the GNU General Public License as published by
	13	* the Free Software Foundation; either version 2
	14	*/
	15
	16	#include <linux/poll.h>
	17	#ifdef CONFIG_VIDEO_V4L1_COMPAT
	18	#include <linux/videodev.h>
	19	#endif
	20	#include <linux/videodev2.h>
	21
	22	#define UNSET (-1U)
	23
	24
	25	struct videobuf_buffer;
	26	struct videobuf_queue;
	27
	28	/* --------------------------------------------------------------------- */
	29
	30	/*
	31	* A small set of helper functions to manage video4linux buffers.
	32	*
	33	* struct videobuf_buffer holds the data structures used by the helper
	34	* functions, additionally some commonly used fields for v4l buffers
	35	* (width, height, lists, waitqueue) are in there. That struct should
	36	* be used as first element in the drivers buffer struct.
	37	*
	38	* about the mmap helpers (videobuf_mmap_*):
	39	*
	40	* The mmaper function allows to map any subset of contingous buffers.
	41	* This includes one mmap() call for all buffers (which the original
	42	* video4linux API uses) as well as one mmap() for every single buffer
	43	* (which v4l2 uses).
	44	*
	45	* If there is a valid mapping for a buffer, buffer->baddr/bsize holds
	46	* userspace address + size which can be feeded into the
	47	* videobuf_dma_init_user function listed above.
	48	*
	49	*/
	50
	51	struct videobuf_mapping {
	52	unsigned int count;
	53	unsigned long start;
	54	unsigned long end;
	55	struct videobuf_queue *q;
	56	};
	57
	58	enum videobuf_state {
0fc0686e BP	59	VIDEOBUF_NEEDS_INIT = 0,
	60	VIDEOBUF_PREPARED = 1,
	61	VIDEOBUF_QUEUED = 2,
	62	VIDEOBUF_ACTIVE = 3,
	63	VIDEOBUF_DONE = 4,
	64	VIDEOBUF_ERROR = 5,
	65	VIDEOBUF_IDLE = 6,
7a7d9a89 MCC	66	};
	67
	68	struct videobuf_buffer {
	69	unsigned int i;
	70	u32 magic;
	71
	72	/* info about the buffer */
	73	unsigned int width;
	74	unsigned int height;
	75	unsigned int bytesperline; /* use only if != 0 */
	76	unsigned long size;
	77	unsigned int input;
	78	enum v4l2_field field;
	79	enum videobuf_state state;
	80	struct list_head stream; /* QBUF/DQBUF list */
	81
	82	/* touched by irq handler */
	83	struct list_head queue;
	84	wait_queue_head_t done;
	85	unsigned int field_count;
	86	struct timeval ts;
	87
	88	/* Memory type */
	89	enum v4l2_memory memory;
	90
	91	/* buffer size */
	92	size_t bsize;
	93
	94	/* buffer offset (mmap + overlay) */
	95	size_t boff;
	96
	97	/* buffer addr (userland ptr!) */
	98	unsigned long baddr;
	99
851c0c96 MCC	100	/* for mmap'ed buffers */
	101	struct videobuf_mapping *map;
	102
7a7d9a89 MCC	103	/* Private pointer to allow specific methods to store their data */
	104	int privsize;
	105	void *priv;
	106	};
	107
	108	struct videobuf_queue_ops {
	109	int (buf_setup)(struct videobuf_queue q,
	110	unsigned int count, unsigned int size);
	111	int (buf_prepare)(struct videobuf_queue q,
	112	struct videobuf_buffer *vb,
	113	enum v4l2_field field);
	114	void (buf_queue)(struct videobuf_queue q,
	115	struct videobuf_buffer *vb);
	116	void (buf_release)(struct videobuf_queue q,
	117	struct videobuf_buffer *vb);
	118	};
	119
	120	#define MAGIC_QTYPE_OPS 0x12261003
	121
	122	/* Helper operations - device type dependent */
	123	struct videobuf_qtype_ops {
	124	u32 magic;
	125
	126	void* (*alloc) (size_t size);
	127	int (iolock) (struct videobuf_queue q,
	128	struct videobuf_buffer *vb,
	129	struct v4l2_framebuffer *fbuf);
	130	int (mmap) (struct videobuf_queue q,
	131	unsigned int *count,
	132	unsigned int *size,
	133	enum v4l2_memory memory);
	134	int (sync) (struct videobuf_queue q,
	135	struct videobuf_buffer *buf);
13bcd5d0	136	int (video_copy_to_user)(struct videobuf_queue q,
7a7d9a89 MCC	137	char __user *data,
	138	size_t count,
	139	int nonblocking);
	140	int (copy_stream) (struct videobuf_queue q,
	141	char __user *data,
	142	size_t count,
	143	size_t pos,
	144	int vbihack,
	145	int nonblocking);
	146	int (mmap_free) (struct videobuf_queue q);
	147	int (mmap_mapper) (struct videobuf_queue q,
	148	struct vm_area_struct *vma);
7a7d9a89 MCC	149	};
	150
	151	struct videobuf_queue {
64f9477f	152	struct mutex vb_lock;
7a7d9a89	153	spinlock_t *irqlock;
e9bcf667	154	struct device *dev;
7a7d9a89	155
137d1cb1 BP	156	wait_queue_head_t wait; /* wait if queue is empty */
137d1cb1 BP	157
7a7d9a89 MCC	158	enum v4l2_buf_type type;
	159	unsigned int inputs; /* for V4L2_BUF_FLAG_INPUT */
	160	unsigned int msize;
	161	enum v4l2_field field;
	162	enum v4l2_field last; /* for field=V4L2_FIELD_ALTERNATE */
	163	struct videobuf_buffer *bufs[VIDEO_MAX_FRAME];
	164	struct videobuf_queue_ops *ops;
	165	struct videobuf_qtype_ops *int_ops;
	166
d6964aa8 BP	167	unsigned int streaming:1;
d6964aa8 BP	168	unsigned int reading:1;
d05051c8 MCC	169	unsigned int is_mmapped:1;
d05051c8 MCC	170
7a7d9a89	171	/* capture via mmap() + ioctl(QBUF/DQBUF) */
7a7d9a89 MCC	172	struct list_head stream;
	173
	174	/* capture via read() */
7a7d9a89 MCC	175	unsigned int read_off;
	176	struct videobuf_buffer *read_buf;
	177
	178	/* driver private data */
	179	void *priv_data;
7a7d9a89 MCC	180	};
	181
	182	int videobuf_waiton(struct videobuf_buffer *vb, int non_blocking, int intr);
	183	int videobuf_iolock(struct videobuf_queue* q, struct videobuf_buffer *vb,
	184	struct v4l2_framebuffer *fbuf);
	185
	186	void videobuf_alloc(struct videobuf_queue q);
	187
d4cae5a5	188	void videobuf_queue_core_init(struct videobuf_queue *q,
7a7d9a89	189	struct videobuf_queue_ops *ops,
e9bcf667	190	struct device *dev,
7a7d9a89 MCC	191	spinlock_t *irqlock,
	192	enum v4l2_buf_type type,
	193	enum v4l2_field field,
	194	unsigned int msize,
d4cae5a5 MCC	195	void *priv,
d4cae5a5 MCC	196	struct videobuf_qtype_ops *int_ops);
7a7d9a89 MCC	197	int videobuf_queue_is_busy(struct videobuf_queue *q);
	198	void videobuf_queue_cancel(struct videobuf_queue *q);
	199
	200	enum v4l2_field videobuf_next_field(struct videobuf_queue *q);
	201	int videobuf_reqbufs(struct videobuf_queue *q,
	202	struct v4l2_requestbuffers *req);
	203	int videobuf_querybuf(struct videobuf_queue q, struct v4l2_buffer b);
	204	int videobuf_qbuf(struct videobuf_queue *q,
	205	struct v4l2_buffer *b);
	206	int videobuf_dqbuf(struct videobuf_queue *q,
	207	struct v4l2_buffer *b, int nonblocking);
	208	#ifdef CONFIG_VIDEO_V4L1_COMPAT
	209	int videobuf_cgmbuf(struct videobuf_queue *q,
	210	struct video_mbuf *mbuf, int count);
	211	#endif
	212	int videobuf_streamon(struct videobuf_queue *q);
	213	int videobuf_streamoff(struct videobuf_queue *q);
	214
19bc5133 BP	215	void videobuf_stop(struct videobuf_queue *q);
19bc5133 BP	216
7a7d9a89 MCC	217	int videobuf_read_start(struct videobuf_queue *q);
	218	void videobuf_read_stop(struct videobuf_queue *q);
	219	ssize_t videobuf_read_stream(struct videobuf_queue *q,
	220	char __user data, size_t count, loff_t ppos,
	221	int vbihack, int nonblocking);
	222	ssize_t videobuf_read_one(struct videobuf_queue *q,
	223	char __user data, size_t count, loff_t ppos,
	224	int nonblocking);
	225	unsigned int videobuf_poll_stream(struct file *file,
	226	struct videobuf_queue *q,
	227	poll_table *wait);
	228
	229	int videobuf_mmap_setup(struct videobuf_queue *q,
	230	unsigned int bcount, unsigned int bsize,
	231	enum v4l2_memory memory);
	232	int videobuf_mmap_free(struct videobuf_queue *q);
	233	int videobuf_mmap_mapper(struct videobuf_queue *q,
	234	struct vm_area_struct *vma);
	235
	236	/* --------------------------------------------------------------------- */
	237
	238	/*
	239	* Local variables:
	240	* c-basic-offset: 8
	241	* End:
	242	*/