include/media/videobuf2-v4l2.h

   1 /*
   2  * videobuf2-v4l2.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_V4L2_H
  13 #define _MEDIA_VIDEOBUF2_V4L2_H
  14
  15 #include <linux/videodev2.h>
  16 #include <media/videobuf2-core.h>
  17
  18 #if VB2_MAX_FRAME != VIDEO_MAX_FRAME
  19 #error VB2_MAX_FRAME != VIDEO_MAX_FRAME
  20 #endif
  21
  22 #if VB2_MAX_PLANES != VIDEO_MAX_PLANES
  23 #error VB2_MAX_PLANES != VIDEO_MAX_PLANES
  24 #endif
  25
  26 /**
  27  * struct vb2_v4l2_buffer - video buffer information for v4l2
  28  * @vb2_buf:    video buffer 2
  29  * @flags:      buffer informational flags
  30  * @field:      enum v4l2_field; field order of the image in the buffer
  31  * @timestamp:  frame timestamp
  32  * @timecode:   frame timecode
  33  * @sequence:   sequence count of this frame
  34  * @config_store: this buffer should use this configuration store
  35  * Should contain enough information to be able to cover all the fields
  36  * of struct v4l2_buffer at videodev2.h
  37  */
  38 struct vb2_v4l2_buffer {
  39         struct vb2_buffer       vb2_buf;
  40
  41         __u32                   flags;
  42         __u32                   field;
  43         struct timeval          timestamp;
  44         struct v4l2_timecode    timecode;
  45         __u32                   sequence;
  46         __u32                   config_store;
  47 };
  48
  49 /*
  50  * to_vb2_v4l2_buffer() - cast struct vb2_buffer * to struct vb2_v4l2_buffer *
  51  */
  52 #define to_vb2_v4l2_buffer(vb) \
  53         container_of(vb, struct vb2_v4l2_buffer, vb2_buf)
  54
  55 int vb2_querybuf(struct vb2_queue *q, struct v4l2_buffer *b);
  56 int vb2_reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req);
  57
  58 int vb2_create_bufs(struct vb2_queue *q, struct v4l2_create_buffers *create);
  59 int vb2_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b);
  60
  61 int vb2_qbuf(struct vb2_queue *q, struct v4l2_buffer *b);
  62 int vb2_expbuf(struct vb2_queue *q, struct v4l2_exportbuffer *eb);
  63 int vb2_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking);
  64
  65 int vb2_streamon(struct vb2_queue *q, enum v4l2_buf_type type);
  66 int vb2_streamoff(struct vb2_queue *q, enum v4l2_buf_type type);
  67
  68 int __must_check vb2_queue_init(struct vb2_queue *q);
  69 void vb2_queue_release(struct vb2_queue *q);
  70
  71 unsigned int vb2_poll(struct vb2_queue *q, struct file *file, poll_table *wait);
  72 size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count,
  73                 loff_t *ppos, int nonblock);
  74 size_t vb2_write(struct vb2_queue *q, const char __user *data, size_t count,
  75                 loff_t *ppos, int nonblock);
  76
  77 /*
  78  * vb2_thread_fnc - callback function for use with vb2_thread
  79  *
  80  * This is called whenever a buffer is dequeued in the thread.
  81  */
  82 typedef int (*vb2_thread_fnc)(struct vb2_buffer *vb, void *priv);
  83
  84 /**
  85  * vb2_thread_start() - start a thread for the given queue.
  86  * @q:          videobuf queue
  87  * @fnc:        callback function
  88  * @priv:       priv pointer passed to the callback function
  89  * @thread_name:the name of the thread. This will be prefixed with "vb2-".
  90  *
  91  * This starts a thread that will queue and dequeue until an error occurs
  92  * or @vb2_thread_stop is called.
  93  *
  94  * This function should not be used for anything else but the videobuf2-dvb
  95  * support. If you think you have another good use-case for this, then please
  96  * contact the linux-media mailinglist first.
  97  */
  98 int vb2_thread_start(struct vb2_queue *q, vb2_thread_fnc fnc, void *priv,
  99                      const char *thread_name);
 100
 101 /**
 102  * vb2_thread_stop() - stop the thread for the given queue.
 103  * @q:          videobuf queue
 104  */
 105 int vb2_thread_stop(struct vb2_queue *q);
 106
 107 /*
 108  * The following functions are not part of the vb2 core API, but are simple
 109  * helper functions that you can use in your struct v4l2_file_operations,
 110  * struct v4l2_ioctl_ops and struct vb2_ops. They will serialize if vb2_queue->lock
 111  * or video_device->lock is set, and they will set and test vb2_queue->owner
 112  * to check if the calling filehandle is permitted to do the queuing operation.
 113  */
 114
 115 /* struct v4l2_ioctl_ops helpers */
 116
 117 int vb2_ioctl_reqbufs(struct file *file, void *priv,
 118                           struct v4l2_requestbuffers *p);
 119 int vb2_ioctl_create_bufs(struct file *file, void *priv,
 120                           struct v4l2_create_buffers *p);
 121 int vb2_ioctl_prepare_buf(struct file *file, void *priv,
 122                           struct v4l2_buffer *p);
 123 int vb2_ioctl_querybuf(struct file *file, void *priv, struct v4l2_buffer *p);
 124 int vb2_ioctl_qbuf(struct file *file, void *priv, struct v4l2_buffer *p);
 125 int vb2_ioctl_dqbuf(struct file *file, void *priv, struct v4l2_buffer *p);
 126 int vb2_ioctl_streamon(struct file *file, void *priv, enum v4l2_buf_type i);
 127 int vb2_ioctl_streamoff(struct file *file, void *priv, enum v4l2_buf_type i);
 128 int vb2_ioctl_expbuf(struct file *file, void *priv,
 129         struct v4l2_exportbuffer *p);
 130
 131 /* struct v4l2_file_operations helpers */
 132
 133 int vb2_fop_mmap(struct file *file, struct vm_area_struct *vma);
 134 int vb2_fop_release(struct file *file);
 135 int _vb2_fop_release(struct file *file, struct mutex *lock);
 136 ssize_t vb2_fop_write(struct file *file, const char __user *buf,
 137                 size_t count, loff_t *ppos);
 138 ssize_t vb2_fop_read(struct file *file, char __user *buf,
 139                 size_t count, loff_t *ppos);
 140 unsigned int vb2_fop_poll(struct file *file, poll_table *wait);
 141 #ifndef CONFIG_MMU
 142 unsigned long vb2_fop_get_unmapped_area(struct file *file, unsigned long addr,
 143                 unsigned long len, unsigned long pgoff, unsigned long flags);
 144 #endif
 145
 146 /* struct vb2_ops helpers, only use if vq->lock is non-NULL. */
 147
 148 void vb2_ops_wait_prepare(struct vb2_queue *vq);
 149 void vb2_ops_wait_finish(struct vb2_queue *vq);
 150
 151 #endif /* _MEDIA_VIDEOBUF2_V4L2_H */