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