include/media/videobuf-core.h

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