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#ifndef _VIDEOBUF_CORE_H 17#define _VIDEOBUF_CORE_H 18 19#include <linux/poll.h> 20#ifdef CONFIG_VIDEO_V4L1_COMPAT 21#define __MIN_V4L1 22#include <linux/videodev.h> 23#endif 24#include <linux/videodev2.h> 25 26#define UNSET (-1U) 27 28 29struct videobuf_buffer; 30struct videobuf_queue; 31 32/* --------------------------------------------------------------------- */ 33 34/* 35 * A small set of helper functions to manage video4linux buffers. 36 * 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. 41 * 42 * about the mmap helpers (videobuf_mmap_*): 43 * 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 47 * (which v4l2 uses). 48 * 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. 52 * 53 */ 54 55struct videobuf_mapping { 56 unsigned int count; 57 struct videobuf_queue *q; 58}; 59 60enum videobuf_state { 61 VIDEOBUF_NEEDS_INIT = 0, 62 VIDEOBUF_PREPARED = 1, 63 VIDEOBUF_QUEUED = 2, 64 VIDEOBUF_ACTIVE = 3, 65 VIDEOBUF_DONE = 4, 66 VIDEOBUF_ERROR = 5, 67 VIDEOBUF_IDLE = 6, 68}; 69 70struct videobuf_buffer { 71 unsigned int i; 72 u32 magic; 73 74 /* info about the buffer */ 75 unsigned int width; 76 unsigned int height; 77 unsigned int bytesperline; /* use only if != 0 */ 78 unsigned long size; 79 unsigned int input; 80 enum v4l2_field field; 81 enum videobuf_state state; 82 struct list_head stream; /* QBUF/DQBUF list */ 83 84 /* touched by irq handler */ 85 struct list_head queue; 86 wait_queue_head_t done; 87 unsigned int field_count; 88 struct timeval ts; 89 90 /* Memory type */ 91 enum v4l2_memory memory; 92 93 /* buffer size */ 94 size_t bsize; 95 96 /* buffer offset (mmap + overlay) */ 97 size_t boff; 98 99 /* buffer addr (userland ptr!) */ 100 unsigned long baddr; 101 102 /* for mmap'ed buffers */ 103 struct videobuf_mapping *map; 104 105 /* Private pointer to allow specific methods to store their data */ 106 int privsize; 107 void *priv; 108}; 109 110struct videobuf_queue_ops { 111 int (*buf_setup)(struct videobuf_queue *q, 112 unsigned int *count, unsigned int *size); 113 int (*buf_prepare)(struct videobuf_queue *q, 114 struct videobuf_buffer *vb, 115 enum v4l2_field field); 116 void (*buf_queue)(struct videobuf_queue *q, 117 struct videobuf_buffer *vb); 118 void (*buf_release)(struct videobuf_queue *q, 119 struct videobuf_buffer *vb); 120}; 121 122#define MAGIC_QTYPE_OPS 0x12261003 123 124/* Helper operations - device type dependent */ 125struct videobuf_qtype_ops { 126 u32 magic; 127 128 struct videobuf_buffer *(*alloc_vb)(size_t size); 129 void *(*vaddr) (struct videobuf_buffer *buf); 130 int (*iolock) (struct videobuf_queue *q, 131 struct videobuf_buffer *vb, 132 struct v4l2_framebuffer *fbuf); 133 int (*sync) (struct videobuf_queue *q, 134 struct videobuf_buffer *buf); 135 int (*mmap_mapper) (struct videobuf_queue *q, 136 struct videobuf_buffer *buf, 137 struct vm_area_struct *vma); 138}; 139 140struct videobuf_queue { 141 struct mutex vb_lock; 142 spinlock_t *irqlock; 143 struct device *dev; 144 145 wait_queue_head_t wait; /* wait if queue is empty */ 146 147 enum v4l2_buf_type type; 148 unsigned int inputs; /* for V4L2_BUF_FLAG_INPUT */ 149 unsigned int msize; 150 enum v4l2_field field; 151 enum v4l2_field last; /* for field=V4L2_FIELD_ALTERNATE */ 152 struct videobuf_buffer *bufs[VIDEO_MAX_FRAME]; 153 const struct videobuf_queue_ops *ops; 154 struct videobuf_qtype_ops *int_ops; 155 156 unsigned int streaming:1; 157 unsigned int reading:1; 158 159 /* capture via mmap() + ioctl(QBUF/DQBUF) */ 160 struct list_head stream; 161 162 /* capture via read() */ 163 unsigned int read_off; 164 struct videobuf_buffer *read_buf; 165 166 /* driver private data */ 167 void *priv_data; 168}; 169 170int videobuf_waiton(struct videobuf_buffer *vb, int non_blocking, int intr); 171int videobuf_iolock(struct videobuf_queue *q, struct videobuf_buffer *vb, 172 struct v4l2_framebuffer *fbuf); 173 174struct videobuf_buffer *videobuf_alloc_vb(struct videobuf_queue *q); 175 176/* Used on videobuf-dvb */ 177void *videobuf_queue_to_vaddr(struct videobuf_queue *q, 178 struct videobuf_buffer *buf); 179 180void videobuf_queue_core_init(struct videobuf_queue *q, 181 const struct videobuf_queue_ops *ops, 182 struct device *dev, 183 spinlock_t *irqlock, 184 enum v4l2_buf_type type, 185 enum v4l2_field field, 186 unsigned int msize, 187 void *priv, 188 struct videobuf_qtype_ops *int_ops); 189int videobuf_queue_is_busy(struct videobuf_queue *q); 190void videobuf_queue_cancel(struct videobuf_queue *q); 191 192enum v4l2_field videobuf_next_field(struct videobuf_queue *q); 193int videobuf_reqbufs(struct videobuf_queue *q, 194 struct v4l2_requestbuffers *req); 195int videobuf_querybuf(struct videobuf_queue *q, struct v4l2_buffer *b); 196int videobuf_qbuf(struct videobuf_queue *q, 197 struct v4l2_buffer *b); 198int videobuf_dqbuf(struct videobuf_queue *q, 199 struct v4l2_buffer *b, int nonblocking); 200#ifdef CONFIG_VIDEO_V4L1_COMPAT 201int videobuf_cgmbuf(struct videobuf_queue *q, 202 struct video_mbuf *mbuf, int count); 203#endif 204int videobuf_streamon(struct videobuf_queue *q); 205int videobuf_streamoff(struct videobuf_queue *q); 206 207void videobuf_stop(struct videobuf_queue *q); 208 209int videobuf_read_start(struct videobuf_queue *q); 210void videobuf_read_stop(struct videobuf_queue *q); 211ssize_t videobuf_read_stream(struct videobuf_queue *q, 212 char __user *data, size_t count, loff_t *ppos, 213 int vbihack, int nonblocking); 214ssize_t videobuf_read_one(struct videobuf_queue *q, 215 char __user *data, size_t count, loff_t *ppos, 216 int nonblocking); 217unsigned int videobuf_poll_stream(struct file *file, 218 struct videobuf_queue *q, 219 poll_table *wait); 220 221int videobuf_mmap_setup(struct videobuf_queue *q, 222 unsigned int bcount, unsigned int bsize, 223 enum v4l2_memory memory); 224int __videobuf_mmap_setup(struct videobuf_queue *q, 225 unsigned int bcount, unsigned int bsize, 226 enum v4l2_memory memory); 227int videobuf_mmap_free(struct videobuf_queue *q); 228int videobuf_mmap_mapper(struct videobuf_queue *q, 229 struct vm_area_struct *vma); 230 231#endif 232