include/media/videobuf2-core.h

   1 /*
   2  * videobuf2-core.h - V4L2 driver helper framework
   3  *
   4  * Copyright (C) 2010 Samsung Electronics
   5  *
   6  * Author: Pawel Osciak <pawel@osciak.com>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation.
  11  */
  12 #ifndef _MEDIA_VIDEOBUF2_CORE_H
  13 #define _MEDIA_VIDEOBUF2_CORE_H
  14
  15 #include <linux/mm_types.h>
  16 #include <linux/mutex.h>
  17 #include <linux/poll.h>
  18 #include <linux/videodev2.h>
  19
  20 struct vb2_alloc_ctx;
  21 struct vb2_fileio_data;
  22
  23 /**
  24  * struct vb2_mem_ops - memory handling/memory allocator operations
  25  * @alloc:      allocate video memory and, optionally, allocator private data,
  26  *              return NULL on failure or a pointer to allocator private,
  27  *              per-buffer data on success; the returned private structure
  28  *              will then be passed as buf_priv argument to other ops in this
  29  *              structure
  30  * @put:        inform the allocator that the buffer will no longer be used;
  31  *              usually will result in the allocator freeing the buffer (if
  32  *              no other users of this buffer are present); the buf_priv
  33  *              argument is the allocator private per-buffer structure
  34  *              previously returned from the alloc callback
  35  * @get_userptr: acquire userspace memory for a hardware operation; used for
  36  *               USERPTR memory types; vaddr is the address passed to the
  37  *               videobuf layer when queuing a video buffer of USERPTR type;
  38  *               should return an allocator private per-buffer structure
  39  *               associated with the buffer on success, NULL on failure;
  40  *               the returned private structure will then be passed as buf_priv
  41  *               argument to other ops in this structure
  42  * @put_userptr: inform the allocator that a USERPTR buffer will no longer
  43  *               be used
  44  * @vaddr:      return a kernel virtual address to a given memory buffer
  45  *              associated with the passed private structure or NULL if no
  46  *              such mapping exists
  47  * @cookie:     return allocator specific cookie for a given memory buffer
  48  *              associated with the passed private structure or NULL if not
  49  *              available
  50  * @num_users:  return the current number of users of a memory buffer;
  51  *              return 1 if the videobuf layer (or actually the driver using
  52  *              it) is the only user
  53  * @mmap:       setup a userspace mapping for a given memory buffer under
  54  *              the provided virtual memory region
  55  *
  56  * Required ops for USERPTR types: get_userptr, put_userptr.
  57  * Required ops for MMAP types: alloc, put, num_users, mmap.
  58  * Required ops for read/write access types: alloc, put, num_users, vaddr
  59  */
  60 struct vb2_mem_ops {
  61         void            *(*alloc)(void *alloc_ctx, unsigned long size);
  62         void            (*put)(void *buf_priv);
  63
  64         void            *(*get_userptr)(void *alloc_ctx, unsigned long vaddr,
  65                                         unsigned long size, int write);
  66         void            (*put_userptr)(void *buf_priv);
  67
  68         void            *(*vaddr)(void *buf_priv);
  69         void            *(*cookie)(void *buf_priv);
  70
  71         unsigned int    (*num_users)(void *buf_priv);
  72
  73         int             (*mmap)(void *buf_priv, struct vm_area_struct *vma);
  74 };
  75
  76 struct vb2_plane {
  77         void                    *mem_priv;
  78 };
  79
  80 /**
  81  * enum vb2_io_modes - queue access methods
  82  * @VB2_MMAP:           driver supports MMAP with streaming API
  83  * @VB2_USERPTR:        driver supports USERPTR with streaming API
  84  * @VB2_READ:           driver supports read() style access
  85  * @VB2_WRITE:          driver supports write() style access
  86  */
  87 enum vb2_io_modes {
  88         VB2_MMAP        = (1 << 0),
  89         VB2_USERPTR     = (1 << 1),
  90         VB2_READ        = (1 << 2),
  91         VB2_WRITE       = (1 << 3),
  92 };
  93
  94 /**
  95  * enum vb2_fileio_flags - flags for selecting a mode of the file io emulator,
  96  * by default the 'streaming' style is used by the file io emulator
  97  * @VB2_FILEIO_READ_ONCE:       report EOF after reading the first buffer
  98  * @VB2_FILEIO_WRITE_IMMEDIATELY:       queue buffer after each write() call
  99  */
 100 enum vb2_fileio_flags {
 101         VB2_FILEIO_READ_ONCE            = (1 << 0),
 102         VB2_FILEIO_WRITE_IMMEDIATELY    = (1 << 1),
 103 };
 104
 105 /**
 106  * enum vb2_buffer_state - current video buffer state
 107  * @VB2_BUF_STATE_DEQUEUED:     buffer under userspace control
 108  * @VB2_BUF_STATE_PREPARED:     buffer prepared in videobuf and by the driver
 109  * @VB2_BUF_STATE_QUEUED:       buffer queued in videobuf, but not in driver
 110  * @VB2_BUF_STATE_ACTIVE:       buffer queued in driver and possibly used
 111  *                              in a hardware operation
 112  * @VB2_BUF_STATE_DONE:         buffer returned from driver to videobuf, but
 113  *                              not yet dequeued to userspace
 114  * @VB2_BUF_STATE_ERROR:        same as above, but the operation on the buffer
 115  *                              has ended with an error, which will be reported
 116  *                              to the userspace when it is dequeued
 117  */
 118 enum vb2_buffer_state {
 119         VB2_BUF_STATE_DEQUEUED,
 120         VB2_BUF_STATE_PREPARED,
 121         VB2_BUF_STATE_QUEUED,
 122         VB2_BUF_STATE_ACTIVE,
 123         VB2_BUF_STATE_DONE,
 124         VB2_BUF_STATE_ERROR,
 125 };
 126
 127 struct vb2_queue;
 128
 129 /**
 130  * struct vb2_buffer - represents a video buffer
 131  * @v4l2_buf:           struct v4l2_buffer associated with this buffer; can
 132  *                      be read by the driver and relevant entries can be
 133  *                      changed by the driver in case of CAPTURE types
 134  *                      (such as timestamp)
 135  * @v4l2_planes:        struct v4l2_planes associated with this buffer; can
 136  *                      be read by the driver and relevant entries can be
 137  *                      changed by the driver in case of CAPTURE types
 138  *                      (such as bytesused); NOTE that even for single-planar
 139  *                      types, the v4l2_planes[0] struct should be used
 140  *                      instead of v4l2_buf for filling bytesused - drivers
 141  *                      should use the vb2_set_plane_payload() function for that
 142  * @vb2_queue:          the queue to which this driver belongs
 143  * @num_planes:         number of planes in the buffer
 144  *                      on an internal driver queue
 145  * @state:              current buffer state; do not change
 146  * @queued_entry:       entry on the queued buffers list, which holds all
 147  *                      buffers queued from userspace
 148  * @done_entry:         entry on the list that stores all buffers ready to
 149  *                      be dequeued to userspace
 150  * @planes:             private per-plane information; do not change
 151  */
 152 struct vb2_buffer {
 153         struct v4l2_buffer      v4l2_buf;
 154         struct v4l2_plane       v4l2_planes[VIDEO_MAX_PLANES];
 155
 156         struct vb2_queue        *vb2_queue;
 157
 158         unsigned int            num_planes;
 159
 160 /* Private: internal use only */
 161         enum vb2_buffer_state   state;
 162
 163         struct list_head        queued_entry;
 164         struct list_head        done_entry;
 165
 166         struct vb2_plane        planes[VIDEO_MAX_PLANES];
 167 };
 168
 169 /**
 170  * struct vb2_ops - driver-specific callbacks
 171  *
 172  * @queue_setup:        called from a VIDIOC_REQBUFS handler, before
 173  *                      memory allocation; driver should return the required
 174  *                      number of buffers in num_buffers, the required number
 175  *                      of planes per buffer in num_planes; the size of each
 176  *                      plane should be set in the sizes[] array and optional
 177  *                      per-plane allocator specific context in alloc_ctxs[]
 178  *                      array
 179  * @wait_prepare:       release any locks taken while calling vb2 functions;
 180  *                      it is called before an ioctl needs to wait for a new
 181  *                      buffer to arrive; required to avoid a deadlock in
 182  *                      blocking access type
 183  * @wait_finish:        reacquire all locks released in the previous callback;
 184  *                      required to continue operation after sleeping while
 185  *                      waiting for a new buffer to arrive
 186  * @buf_init:           called once after allocating a buffer (in MMAP case)
 187  *                      or after acquiring a new USERPTR buffer; drivers may
 188  *                      perform additional buffer-related initialization;
 189  *                      initialization failure (return != 0) will prevent
 190  *                      queue setup from completing successfully; optional
 191  * @buf_prepare:        called every time the buffer is queued from userspace;
 192  *                      drivers may perform any initialization required before
 193  *                      each hardware operation in this callback;
 194  *                      if an error is returned, the buffer will not be queued
 195  *                      in driver; optional
 196  * @buf_finish:         called before every dequeue of the buffer back to
 197  *                      userspace; drivers may perform any operations required
 198  *                      before userspace accesses the buffer; optional
 199  * @buf_cleanup:        called once before the buffer is freed; drivers may
 200  *                      perform any additional cleanup; optional
 201  * @start_streaming:    called once to enter 'streaming' state; the driver may
 202  *                      receive buffers with @buf_queue callback before
 203  *                      @start_streaming is called; the driver gets the number
 204  *                      of already queued buffers in count parameter; driver
 205  *                      can return an error if hardware fails or not enough
 206  *                      buffers has been queued, in such case all buffers that
 207  *                      have been already given by the @buf_queue callback are
 208  *                      invalidated.
 209  * @stop_streaming:     called when 'streaming' state must be disabled; driver
 210  *                      should stop any DMA transactions or wait until they
 211  *                      finish and give back all buffers it got from buf_queue()
 212  *                      callback; may use vb2_wait_for_all_buffers() function
 213  * @buf_queue:          passes buffer vb to the driver; driver may start
 214  *                      hardware operation on this buffer; driver should give
 215  *                      the buffer back by calling vb2_buffer_done() function;
 216  *                      it is allways called after calling STREAMON ioctl;
 217  *                      might be called before start_streaming callback if user
 218  *                      pre-queued buffers before calling STREAMON
 219  */
 220 struct vb2_ops {
 221         int (*queue_setup)(struct vb2_queue *q, const struct v4l2_format *fmt,
 222                            unsigned int *num_buffers, unsigned int *num_planes,
 223                            unsigned int sizes[], void *alloc_ctxs[]);
 224
 225         void (*wait_prepare)(struct vb2_queue *q);
 226         void (*wait_finish)(struct vb2_queue *q);
 227
 228         int (*buf_init)(struct vb2_buffer *vb);
 229         int (*buf_prepare)(struct vb2_buffer *vb);
 230         int (*buf_finish)(struct vb2_buffer *vb);
 231         void (*buf_cleanup)(struct vb2_buffer *vb);
 232
 233         int (*start_streaming)(struct vb2_queue *q, unsigned int count);
 234         int (*stop_streaming)(struct vb2_queue *q);
 235
 236         void (*buf_queue)(struct vb2_buffer *vb);
 237 };
 238
 239 /**
 240  * struct vb2_queue - a videobuf queue
 241  *
 242  * @type:       queue type (see V4L2_BUF_TYPE_* in linux/videodev2.h
 243  * @io_modes:   supported io methods (see vb2_io_modes enum)
 244  * @io_flags:   additional io flags (see vb2_fileio_flags enum)
 245  * @ops:        driver-specific callbacks
 246  * @mem_ops:    memory allocator specific callbacks
 247  * @drv_priv:   driver private data
 248  * @buf_struct_size: size of the driver-specific buffer structure;
 249  *              "0" indicates the driver doesn't want to use a custom buffer
 250  *              structure type, so sizeof(struct vb2_buffer) will is used
 251  *
 252  * @memory:     current memory type used
 253  * @bufs:       videobuf buffer structures
 254  * @num_buffers: number of allocated/used buffers
 255  * @queued_list: list of buffers currently queued from userspace
 256  * @queued_count: number of buffers owned by the driver
 257  * @done_list:  list of buffers ready to be dequeued to userspace
 258  * @done_lock:  lock to protect done_list list
 259  * @done_wq:    waitqueue for processes waiting for buffers ready to be dequeued
 260  * @alloc_ctx:  memory type/allocator-specific contexts for each plane
 261  * @streaming:  current streaming state
 262  * @fileio:     file io emulator internal data, used only if emulator is active
 263  */
 264 struct vb2_queue {
 265         enum v4l2_buf_type              type;
 266         unsigned int                    io_modes;
 267         unsigned int                    io_flags;
 268
 269         const struct vb2_ops            *ops;
 270         const struct vb2_mem_ops        *mem_ops;
 271         void                            *drv_priv;
 272         unsigned int                    buf_struct_size;
 273
 274 /* private: internal use only */
 275         enum v4l2_memory                memory;
 276         struct vb2_buffer               *bufs[VIDEO_MAX_FRAME];
 277         unsigned int                    num_buffers;
 278
 279         struct list_head                queued_list;
 280
 281         atomic_t                        queued_count;
 282         struct list_head                done_list;
 283         spinlock_t                      done_lock;
 284         wait_queue_head_t               done_wq;
 285
 286         void                            *alloc_ctx[VIDEO_MAX_PLANES];
 287         unsigned int                    plane_sizes[VIDEO_MAX_PLANES];
 288
 289         unsigned int                    streaming:1;
 290
 291         struct vb2_fileio_data          *fileio;
 292 };
 293
 294 void *vb2_plane_vaddr(struct vb2_buffer *vb, unsigned int plane_no);
 295 void *vb2_plane_cookie(struct vb2_buffer *vb, unsigned int plane_no);
 296
 297 void vb2_buffer_done(struct vb2_buffer *vb, enum vb2_buffer_state state);
 298 int vb2_wait_for_all_buffers(struct vb2_queue *q);
 299
 300 int vb2_querybuf(struct vb2_queue *q, struct v4l2_buffer *b);
 301 int vb2_reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req);
 302
 303 int vb2_queue_init(struct vb2_queue *q);
 304
 305 void vb2_queue_release(struct vb2_queue *q);
 306
 307 int vb2_qbuf(struct vb2_queue *q, struct v4l2_buffer *b);
 308 int vb2_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking);
 309
 310 int vb2_streamon(struct vb2_queue *q, enum v4l2_buf_type type);
 311 int vb2_streamoff(struct vb2_queue *q, enum v4l2_buf_type type);
 312
 313 int vb2_mmap(struct vb2_queue *q, struct vm_area_struct *vma);
 314 unsigned int vb2_poll(struct vb2_queue *q, struct file *file, poll_table *wait);
 315 size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count,
 316                 loff_t *ppos, int nonblock);
 317 size_t vb2_write(struct vb2_queue *q, char __user *data, size_t count,
 318                 loff_t *ppos, int nonblock);
 319
 320 /**
 321  * vb2_is_streaming() - return streaming status of the queue
 322  * @q:          videobuf queue
 323  */
 324 static inline bool vb2_is_streaming(struct vb2_queue *q)
 325 {
 326         return q->streaming;
 327 }
 328
 329 /**
 330  * vb2_is_busy() - return busy status of the queue
 331  * @q:          videobuf queue
 332  *
 333  * This function checks if queue has any buffers allocated.
 334  */
 335 static inline bool vb2_is_busy(struct vb2_queue *q)
 336 {
 337         return (q->num_buffers > 0);
 338 }
 339
 340 /**
 341  * vb2_get_drv_priv() - return driver private data associated with the queue
 342  * @q:          videobuf queue
 343  */
 344 static inline void *vb2_get_drv_priv(struct vb2_queue *q)
 345 {
 346         return q->drv_priv;
 347 }
 348
 349 /**
 350  * vb2_set_plane_payload() - set bytesused for the plane plane_no
 351  * @vb:         buffer for which plane payload should be set
 352  * @plane_no:   plane number for which payload should be set
 353  * @size:       payload in bytes
 354  */
 355 static inline void vb2_set_plane_payload(struct vb2_buffer *vb,
 356                                  unsigned int plane_no, unsigned long size)
 357 {
 358         if (plane_no < vb->num_planes)
 359                 vb->v4l2_planes[plane_no].bytesused = size;
 360 }
 361
 362 /**
 363  * vb2_get_plane_payload() - get bytesused for the plane plane_no
 364  * @vb:         buffer for which plane payload should be set
 365  * @plane_no:   plane number for which payload should be set
 366  * @size:       payload in bytes
 367  */
 368 static inline unsigned long vb2_get_plane_payload(struct vb2_buffer *vb,
 369                                  unsigned int plane_no)
 370 {
 371         if (plane_no < vb->num_planes)
 372                 return vb->v4l2_planes[plane_no].bytesused;
 373         return 0;
 374 }
 375
 376 /**
 377  * vb2_plane_size() - return plane size in bytes
 378  * @vb:         buffer for which plane size should be returned
 379  * @plane_no:   plane number for which size should be returned
 380  */
 381 static inline unsigned long
 382 vb2_plane_size(struct vb2_buffer *vb, unsigned int plane_no)
 383 {
 384         if (plane_no < vb->num_planes)
 385                 return vb->v4l2_planes[plane_no].length;
 386         return 0;
 387 }
 388
 389 #endif /* _MEDIA_VIDEOBUF2_CORE_H */