2 * generic helper functions for handling video4linux capture buffers
4 * (c) 2007 Mauro Carvalho Chehab, <mchehab@infradead.org>
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
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
16 #ifndef _VIDEOBUF_CORE_H
17 #define _VIDEOBUF_CORE_H
19 #include <linux/poll.h>
20 #ifdef CONFIG_VIDEO_V4L1_COMPAT
22 #include <linux/videodev.h>
24 #include <linux/videodev2.h>
29 struct videobuf_buffer;
30 struct videobuf_queue;
32 /* --------------------------------------------------------------------- */
35 * A small set of helper functions to manage video4linux buffers.
37 * struct videobuf_buffer holds the data structures used by the helper
38 * functions, additionally some commonly used fields for v4l buffers
39 * (width, height, lists, waitqueue) are in there. That struct should
40 * be used as first element in the drivers buffer struct.
42 * about the mmap helpers (videobuf_mmap_*):
44 * The mmaper function allows to map any subset of contingous buffers.
45 * This includes one mmap() call for all buffers (which the original
46 * video4linux API uses) as well as one mmap() for every single buffer
49 * If there is a valid mapping for a buffer, buffer->baddr/bsize holds
50 * userspace address + size which can be feeded into the
51 * videobuf_dma_init_user function listed above.
55 struct videobuf_mapping {
59 struct videobuf_queue *q;
63 VIDEOBUF_NEEDS_INIT = 0,
64 VIDEOBUF_PREPARED = 1,
72 struct videobuf_buffer {
76 /* info about the buffer */
79 unsigned int bytesperline; /* use only if != 0 */
82 enum v4l2_field field;
83 enum videobuf_state state;
84 struct list_head stream; /* QBUF/DQBUF list */
86 /* touched by irq handler */
87 struct list_head queue;
88 wait_queue_head_t done;
89 unsigned int field_count;
93 enum v4l2_memory memory;
98 /* buffer offset (mmap + overlay) */
101 /* buffer addr (userland ptr!) */
104 /* for mmap'ed buffers */
105 struct videobuf_mapping *map;
107 /* Private pointer to allow specific methods to store their data */
112 struct videobuf_queue_ops {
113 int (*buf_setup)(struct videobuf_queue *q,
114 unsigned int *count, unsigned int *size);
115 int (*buf_prepare)(struct videobuf_queue *q,
116 struct videobuf_buffer *vb,
117 enum v4l2_field field);
118 void (*buf_queue)(struct videobuf_queue *q,
119 struct videobuf_buffer *vb);
120 void (*buf_release)(struct videobuf_queue *q,
121 struct videobuf_buffer *vb);
124 #define MAGIC_QTYPE_OPS 0x12261003
126 /* Helper operations - device type dependent */
127 struct videobuf_qtype_ops {
130 void *(*alloc) (size_t size);
131 void *(*vmalloc) (struct videobuf_buffer *buf);
132 int (*iolock) (struct videobuf_queue *q,
133 struct videobuf_buffer *vb,
134 struct v4l2_framebuffer *fbuf);
135 int (*sync) (struct videobuf_queue *q,
136 struct videobuf_buffer *buf);
137 int (*video_copy_to_user)(struct videobuf_queue *q,
141 int (*copy_stream) (struct videobuf_queue *q,
147 int (*mmap_free) (struct videobuf_queue *q);
148 int (*mmap_mapper) (struct videobuf_queue *q,
149 struct vm_area_struct *vma);
152 struct videobuf_queue {
153 struct mutex vb_lock;
157 wait_queue_head_t wait; /* wait if queue is empty */
159 enum v4l2_buf_type type;
160 unsigned int inputs; /* for V4L2_BUF_FLAG_INPUT */
162 enum v4l2_field field;
163 enum v4l2_field last; /* for field=V4L2_FIELD_ALTERNATE */
164 struct videobuf_buffer *bufs[VIDEO_MAX_FRAME];
165 const struct videobuf_queue_ops *ops;
166 struct videobuf_qtype_ops *int_ops;
168 unsigned int streaming:1;
169 unsigned int reading:1;
170 unsigned int is_mmapped:1;
172 /* capture via mmap() + ioctl(QBUF/DQBUF) */
173 struct list_head stream;
175 /* capture via read() */
176 unsigned int read_off;
177 struct videobuf_buffer *read_buf;
179 /* driver private data */
183 int videobuf_waiton(struct videobuf_buffer *vb, int non_blocking, int intr);
184 int videobuf_iolock(struct videobuf_queue *q, struct videobuf_buffer *vb,
185 struct v4l2_framebuffer *fbuf);
187 void *videobuf_alloc(struct videobuf_queue* q);
189 /* Used on videobuf-dvb */
190 void *videobuf_queue_to_vmalloc(struct videobuf_queue *q,
191 struct videobuf_buffer *buf);
193 void videobuf_queue_core_init(struct videobuf_queue *q,
194 const struct videobuf_queue_ops *ops,
197 enum v4l2_buf_type type,
198 enum v4l2_field field,
201 struct videobuf_qtype_ops *int_ops);
202 int videobuf_queue_is_busy(struct videobuf_queue *q);
203 void videobuf_queue_cancel(struct videobuf_queue *q);
205 enum v4l2_field videobuf_next_field(struct videobuf_queue *q);
206 int videobuf_reqbufs(struct videobuf_queue *q,
207 struct v4l2_requestbuffers *req);
208 int videobuf_querybuf(struct videobuf_queue *q, struct v4l2_buffer *b);
209 int videobuf_qbuf(struct videobuf_queue *q,
210 struct v4l2_buffer *b);
211 int videobuf_dqbuf(struct videobuf_queue *q,
212 struct v4l2_buffer *b, int nonblocking);
213 #ifdef CONFIG_VIDEO_V4L1_COMPAT
214 int videobuf_cgmbuf(struct videobuf_queue *q,
215 struct video_mbuf *mbuf, int count);
217 int videobuf_streamon(struct videobuf_queue *q);
218 int videobuf_streamoff(struct videobuf_queue *q);
220 void videobuf_stop(struct videobuf_queue *q);
222 int videobuf_read_start(struct videobuf_queue *q);
223 void videobuf_read_stop(struct videobuf_queue *q);
224 ssize_t videobuf_read_stream(struct videobuf_queue *q,
225 char __user *data, size_t count, loff_t *ppos,
226 int vbihack, int nonblocking);
227 ssize_t videobuf_read_one(struct videobuf_queue *q,
228 char __user *data, size_t count, loff_t *ppos,
230 unsigned int videobuf_poll_stream(struct file *file,
231 struct videobuf_queue *q,
234 int videobuf_mmap_setup(struct videobuf_queue *q,
235 unsigned int bcount, unsigned int bsize,
236 enum v4l2_memory memory);
237 int __videobuf_mmap_setup(struct videobuf_queue *q,
238 unsigned int bcount, unsigned int bsize,
239 enum v4l2_memory memory);
240 int videobuf_mmap_free(struct videobuf_queue *q);
241 int videobuf_mmap_mapper(struct videobuf_queue *q,
242 struct vm_area_struct *vma);