video: tegra: dtv: Add ioctl for buffer size query
[linux-3.10.git] / 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 #include <linux/dma-buf.h>
20
21 struct vb2_alloc_ctx;
22 struct vb2_fileio_data;
23
24 /**
25  * struct vb2_mem_ops - memory handling/memory allocator operations
26  * @alloc:      allocate video memory and, optionally, allocator private data,
27  *              return NULL on failure or a pointer to allocator private,
28  *              per-buffer data on success; the returned private structure
29  *              will then be passed as buf_priv argument to other ops in this
30  *              structure. Additional gfp_flags to use when allocating the
31  *              are also passed to this operation. These flags are from the
32  *              gfp_flags field of vb2_queue.
33  * @put:        inform the allocator that the buffer will no longer be used;
34  *              usually will result in the allocator freeing the buffer (if
35  *              no other users of this buffer are present); the buf_priv
36  *              argument is the allocator private per-buffer structure
37  *              previously returned from the alloc callback
38  * @get_userptr: acquire userspace memory for a hardware operation; used for
39  *               USERPTR memory types; vaddr is the address passed to the
40  *               videobuf layer when queuing a video buffer of USERPTR type;
41  *               should return an allocator private per-buffer structure
42  *               associated with the buffer on success, NULL on failure;
43  *               the returned private structure will then be passed as buf_priv
44  *               argument to other ops in this structure
45  * @put_userptr: inform the allocator that a USERPTR buffer will no longer
46  *               be used
47  * @attach_dmabuf: attach a shared struct dma_buf for a hardware operation;
48  *                 used for DMABUF memory types; alloc_ctx is the alloc context
49  *                 dbuf is the shared dma_buf; returns NULL on failure;
50  *                 allocator private per-buffer structure on success;
51  *                 this needs to be used for further accesses to the buffer
52  * @detach_dmabuf: inform the exporter of the buffer that the current DMABUF
53  *                 buffer is no longer used; the buf_priv argument is the
54  *                 allocator private per-buffer structure previously returned
55  *                 from the attach_dmabuf callback
56  * @map_dmabuf: request for access to the dmabuf from allocator; the allocator
57  *              of dmabuf is informed that this driver is going to use the
58  *              dmabuf
59  * @unmap_dmabuf: releases access control to the dmabuf - allocator is notified
60  *                that this driver is done using the dmabuf for now
61  * @prepare:    called every time the buffer is passed from userspace to the
62  *              driver, useful for cache synchronisation, optional
63  * @finish:     called every time the buffer is passed back from the driver
64  *              to the userspace, also optional
65  * @vaddr:      return a kernel virtual address to a given memory buffer
66  *              associated with the passed private structure or NULL if no
67  *              such mapping exists
68  * @cookie:     return allocator specific cookie for a given memory buffer
69  *              associated with the passed private structure or NULL if not
70  *              available
71  * @num_users:  return the current number of users of a memory buffer;
72  *              return 1 if the videobuf layer (or actually the driver using
73  *              it) is the only user
74  * @mmap:       setup a userspace mapping for a given memory buffer under
75  *              the provided virtual memory region
76  *
77  * Required ops for USERPTR types: get_userptr, put_userptr.
78  * Required ops for MMAP types: alloc, put, num_users, mmap.
79  * Required ops for read/write access types: alloc, put, num_users, vaddr
80  * Required ops for DMABUF types: attach_dmabuf, detach_dmabuf, map_dmabuf,
81  *                                unmap_dmabuf.
82  */
83 struct vb2_mem_ops {
84         void            *(*alloc)(void *alloc_ctx, unsigned long size, gfp_t gfp_flags);
85         void            (*put)(void *buf_priv);
86         struct dma_buf *(*get_dmabuf)(void *buf_priv);
87
88         void            *(*get_userptr)(void *alloc_ctx, unsigned long vaddr,
89                                         unsigned long size, int write);
90         void            (*put_userptr)(void *buf_priv);
91
92         void            (*prepare)(void *buf_priv);
93         void            (*finish)(void *buf_priv);
94
95         void            *(*attach_dmabuf)(void *alloc_ctx, struct dma_buf *dbuf,
96                                 unsigned long size, int write);
97         void            (*detach_dmabuf)(void *buf_priv);
98         int             (*map_dmabuf)(void *buf_priv);
99         void            (*unmap_dmabuf)(void *buf_priv);
100
101         void            *(*vaddr)(void *buf_priv);
102         void            *(*cookie)(void *buf_priv);
103
104         unsigned int    (*num_users)(void *buf_priv);
105
106         int             (*mmap)(void *buf_priv, struct vm_area_struct *vma);
107 };
108
109 struct vb2_plane {
110         void                    *mem_priv;
111         struct dma_buf          *dbuf;
112         unsigned int            dbuf_mapped;
113 };
114
115 /**
116  * enum vb2_io_modes - queue access methods
117  * @VB2_MMAP:           driver supports MMAP with streaming API
118  * @VB2_USERPTR:        driver supports USERPTR with streaming API
119  * @VB2_READ:           driver supports read() style access
120  * @VB2_WRITE:          driver supports write() style access
121  * @VB2_DMABUF:         driver supports DMABUF with streaming API
122  */
123 enum vb2_io_modes {
124         VB2_MMAP        = (1 << 0),
125         VB2_USERPTR     = (1 << 1),
126         VB2_READ        = (1 << 2),
127         VB2_WRITE       = (1 << 3),
128         VB2_DMABUF      = (1 << 4),
129 };
130
131 /**
132  * enum vb2_fileio_flags - flags for selecting a mode of the file io emulator,
133  * by default the 'streaming' style is used by the file io emulator
134  * @VB2_FILEIO_READ_ONCE:       report EOF after reading the first buffer
135  * @VB2_FILEIO_WRITE_IMMEDIATELY:       queue buffer after each write() call
136  */
137 enum vb2_fileio_flags {
138         VB2_FILEIO_READ_ONCE            = (1 << 0),
139         VB2_FILEIO_WRITE_IMMEDIATELY    = (1 << 1),
140 };
141
142 /**
143  * enum vb2_buffer_state - current video buffer state
144  * @VB2_BUF_STATE_DEQUEUED:     buffer under userspace control
145  * @VB2_BUF_STATE_PREPARED:     buffer prepared in videobuf and by the driver
146  * @VB2_BUF_STATE_QUEUED:       buffer queued in videobuf, but not in driver
147  * @VB2_BUF_STATE_ACTIVE:       buffer queued in driver and possibly used
148  *                              in a hardware operation
149  * @VB2_BUF_STATE_DONE:         buffer returned from driver to videobuf, but
150  *                              not yet dequeued to userspace
151  * @VB2_BUF_STATE_ERROR:        same as above, but the operation on the buffer
152  *                              has ended with an error, which will be reported
153  *                              to the userspace when it is dequeued
154  */
155 enum vb2_buffer_state {
156         VB2_BUF_STATE_DEQUEUED,
157         VB2_BUF_STATE_PREPARED,
158         VB2_BUF_STATE_QUEUED,
159         VB2_BUF_STATE_ACTIVE,
160         VB2_BUF_STATE_DONE,
161         VB2_BUF_STATE_ERROR,
162 };
163
164 struct vb2_queue;
165
166 /**
167  * struct vb2_buffer - represents a video buffer
168  * @v4l2_buf:           struct v4l2_buffer associated with this buffer; can
169  *                      be read by the driver and relevant entries can be
170  *                      changed by the driver in case of CAPTURE types
171  *                      (such as timestamp)
172  * @v4l2_planes:        struct v4l2_planes associated with this buffer; can
173  *                      be read by the driver and relevant entries can be
174  *                      changed by the driver in case of CAPTURE types
175  *                      (such as bytesused); NOTE that even for single-planar
176  *                      types, the v4l2_planes[0] struct should be used
177  *                      instead of v4l2_buf for filling bytesused - drivers
178  *                      should use the vb2_set_plane_payload() function for that
179  * @vb2_queue:          the queue to which this driver belongs
180  * @num_planes:         number of planes in the buffer
181  *                      on an internal driver queue
182  * @state:              current buffer state; do not change
183  * @queued_entry:       entry on the queued buffers list, which holds all
184  *                      buffers queued from userspace
185  * @done_entry:         entry on the list that stores all buffers ready to
186  *                      be dequeued to userspace
187  * @planes:             private per-plane information; do not change
188  */
189 struct vb2_buffer {
190         struct v4l2_buffer      v4l2_buf;
191         struct v4l2_plane       v4l2_planes[VIDEO_MAX_PLANES];
192
193         struct vb2_queue        *vb2_queue;
194
195         unsigned int            num_planes;
196
197 /* Private: internal use only */
198         enum vb2_buffer_state   state;
199
200         struct list_head        queued_entry;
201         struct list_head        done_entry;
202
203         struct vb2_plane        planes[VIDEO_MAX_PLANES];
204 };
205
206 /**
207  * struct vb2_ops - driver-specific callbacks
208  *
209  * @queue_setup:        called from VIDIOC_REQBUFS and VIDIOC_CREATE_BUFS
210  *                      handlers before memory allocation, or, if
211  *                      *num_planes != 0, after the allocation to verify a
212  *                      smaller number of buffers. Driver should return
213  *                      the required number of buffers in *num_buffers, the
214  *                      required number of planes per buffer in *num_planes; the
215  *                      size of each plane should be set in the sizes[] array
216  *                      and optional per-plane allocator specific context in the
217  *                      alloc_ctxs[] array. When called from VIDIOC_REQBUFS,
218  *                      fmt == NULL, the driver has to use the currently
219  *                      configured format and *num_buffers is the total number
220  *                      of buffers, that are being allocated. When called from
221  *                      VIDIOC_CREATE_BUFS, fmt != NULL and it describes the
222  *                      target frame format. In this case *num_buffers are being
223  *                      allocated additionally to q->num_buffers.
224  * @wait_prepare:       release any locks taken while calling vb2 functions;
225  *                      it is called before an ioctl needs to wait for a new
226  *                      buffer to arrive; required to avoid a deadlock in
227  *                      blocking access type
228  * @wait_finish:        reacquire all locks released in the previous callback;
229  *                      required to continue operation after sleeping while
230  *                      waiting for a new buffer to arrive
231  * @buf_init:           called once after allocating a buffer (in MMAP case)
232  *                      or after acquiring a new USERPTR buffer; drivers may
233  *                      perform additional buffer-related initialization;
234  *                      initialization failure (return != 0) will prevent
235  *                      queue setup from completing successfully; optional
236  * @buf_prepare:        called every time the buffer is queued from userspace
237  *                      and from the VIDIOC_PREPARE_BUF ioctl; drivers may
238  *                      perform any initialization required before each hardware
239  *                      operation in this callback; if an error is returned, the
240  *                      buffer will not be queued in driver; optional
241  * @buf_finish:         called before every dequeue of the buffer back to
242  *                      userspace; drivers may perform any operations required
243  *                      before userspace accesses the buffer; optional
244  * @buf_cleanup:        called once before the buffer is freed; drivers may
245  *                      perform any additional cleanup; optional
246  * @start_streaming:    called once to enter 'streaming' state; the driver may
247  *                      receive buffers with @buf_queue callback before
248  *                      @start_streaming is called; the driver gets the number
249  *                      of already queued buffers in count parameter; driver
250  *                      can return an error if hardware fails or not enough
251  *                      buffers has been queued, in such case all buffers that
252  *                      have been already given by the @buf_queue callback are
253  *                      invalidated.
254  * @stop_streaming:     called when 'streaming' state must be disabled; driver
255  *                      should stop any DMA transactions or wait until they
256  *                      finish and give back all buffers it got from buf_queue()
257  *                      callback; may use vb2_wait_for_all_buffers() function
258  * @buf_queue:          passes buffer vb to the driver; driver may start
259  *                      hardware operation on this buffer; driver should give
260  *                      the buffer back by calling vb2_buffer_done() function;
261  *                      it is allways called after calling STREAMON ioctl;
262  *                      might be called before start_streaming callback if user
263  *                      pre-queued buffers before calling STREAMON
264  */
265 struct vb2_ops {
266         int (*queue_setup)(struct vb2_queue *q, const struct v4l2_format *fmt,
267                            unsigned int *num_buffers, unsigned int *num_planes,
268                            unsigned int sizes[], void *alloc_ctxs[]);
269
270         void (*wait_prepare)(struct vb2_queue *q);
271         void (*wait_finish)(struct vb2_queue *q);
272
273         int (*buf_init)(struct vb2_buffer *vb);
274         int (*buf_prepare)(struct vb2_buffer *vb);
275         int (*buf_finish)(struct vb2_buffer *vb);
276         void (*buf_cleanup)(struct vb2_buffer *vb);
277
278         int (*start_streaming)(struct vb2_queue *q, unsigned int count);
279         int (*stop_streaming)(struct vb2_queue *q);
280
281         void (*buf_queue)(struct vb2_buffer *vb);
282 };
283
284 struct v4l2_fh;
285
286 /**
287  * struct vb2_queue - a videobuf queue
288  *
289  * @type:       queue type (see V4L2_BUF_TYPE_* in linux/videodev2.h
290  * @io_modes:   supported io methods (see vb2_io_modes enum)
291  * @io_flags:   additional io flags (see vb2_fileio_flags enum)
292  * @lock:       pointer to a mutex that protects the vb2_queue struct. The
293  *              driver can set this to a mutex to let the v4l2 core serialize
294  *              the queuing ioctls. If the driver wants to handle locking
295  *              itself, then this should be set to NULL. This lock is not used
296  *              by the videobuf2 core API.
297  * @owner:      The filehandle that 'owns' the buffers, i.e. the filehandle
298  *              that called reqbufs, create_buffers or started fileio.
299  *              This field is not used by the videobuf2 core API, but it allows
300  *              drivers to easily associate an owner filehandle with the queue.
301  * @ops:        driver-specific callbacks
302  * @mem_ops:    memory allocator specific callbacks
303  * @drv_priv:   driver private data
304  * @buf_struct_size: size of the driver-specific buffer structure;
305  *              "0" indicates the driver doesn't want to use a custom buffer
306  *              structure type, so sizeof(struct vb2_buffer) will is used
307  * @gfp_flags:  additional gfp flags used when allocating the buffers.
308  *              Typically this is 0, but it may be e.g. GFP_DMA or __GFP_DMA32
309  *              to force the buffer allocation to a specific memory zone.
310  *
311  * @memory:     current memory type used
312  * @bufs:       videobuf buffer structures
313  * @num_buffers: number of allocated/used buffers
314  * @queued_list: list of buffers currently queued from userspace
315  * @queued_count: number of buffers owned by the driver
316  * @done_list:  list of buffers ready to be dequeued to userspace
317  * @done_lock:  lock to protect done_list list
318  * @done_wq:    waitqueue for processes waiting for buffers ready to be dequeued
319  * @alloc_ctx:  memory type/allocator-specific contexts for each plane
320  * @streaming:  current streaming state
321  * @fileio:     file io emulator internal data, used only if emulator is active
322  */
323 struct vb2_queue {
324         enum v4l2_buf_type              type;
325         unsigned int                    io_modes;
326         unsigned int                    io_flags;
327         struct mutex                    *lock;
328         struct v4l2_fh                  *owner;
329
330         const struct vb2_ops            *ops;
331         const struct vb2_mem_ops        *mem_ops;
332         void                            *drv_priv;
333         unsigned int                    buf_struct_size;
334         u32                             timestamp_type;
335         gfp_t                           gfp_flags;
336
337 /* private: internal use only */
338         enum v4l2_memory                memory;
339         struct vb2_buffer               *bufs[VIDEO_MAX_FRAME];
340         unsigned int                    num_buffers;
341
342         struct list_head                queued_list;
343
344         atomic_t                        queued_count;
345         struct list_head                done_list;
346         spinlock_t                      done_lock;
347         wait_queue_head_t               done_wq;
348
349         void                            *alloc_ctx[VIDEO_MAX_PLANES];
350         unsigned int                    plane_sizes[VIDEO_MAX_PLANES];
351
352         unsigned int                    streaming:1;
353
354         struct vb2_fileio_data          *fileio;
355 };
356
357 void *vb2_plane_vaddr(struct vb2_buffer *vb, unsigned int plane_no);
358 void *vb2_plane_cookie(struct vb2_buffer *vb, unsigned int plane_no);
359
360 void vb2_buffer_done(struct vb2_buffer *vb, enum vb2_buffer_state state);
361 int vb2_wait_for_all_buffers(struct vb2_queue *q);
362
363 int vb2_querybuf(struct vb2_queue *q, struct v4l2_buffer *b);
364 int vb2_reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req);
365
366 int vb2_create_bufs(struct vb2_queue *q, struct v4l2_create_buffers *create);
367 int vb2_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b);
368
369 int __must_check vb2_queue_init(struct vb2_queue *q);
370
371 void vb2_queue_release(struct vb2_queue *q);
372
373 int vb2_qbuf(struct vb2_queue *q, struct v4l2_buffer *b);
374 int vb2_expbuf(struct vb2_queue *q, struct v4l2_exportbuffer *eb);
375 int vb2_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking);
376
377 int vb2_streamon(struct vb2_queue *q, enum v4l2_buf_type type);
378 int vb2_streamoff(struct vb2_queue *q, enum v4l2_buf_type type);
379
380 int vb2_mmap(struct vb2_queue *q, struct vm_area_struct *vma);
381 #ifndef CONFIG_MMU
382 unsigned long vb2_get_unmapped_area(struct vb2_queue *q,
383                                     unsigned long addr,
384                                     unsigned long len,
385                                     unsigned long pgoff,
386                                     unsigned long flags);
387 #endif
388 unsigned int vb2_poll(struct vb2_queue *q, struct file *file, poll_table *wait);
389 size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count,
390                 loff_t *ppos, int nonblock);
391 size_t vb2_write(struct vb2_queue *q, char __user *data, size_t count,
392                 loff_t *ppos, int nonblock);
393
394 /**
395  * vb2_is_streaming() - return streaming status of the queue
396  * @q:          videobuf queue
397  */
398 static inline bool vb2_is_streaming(struct vb2_queue *q)
399 {
400         return q->streaming;
401 }
402
403 /**
404  * vb2_is_busy() - return busy status of the queue
405  * @q:          videobuf queue
406  *
407  * This function checks if queue has any buffers allocated.
408  */
409 static inline bool vb2_is_busy(struct vb2_queue *q)
410 {
411         return (q->num_buffers > 0);
412 }
413
414 /**
415  * vb2_get_drv_priv() - return driver private data associated with the queue
416  * @q:          videobuf queue
417  */
418 static inline void *vb2_get_drv_priv(struct vb2_queue *q)
419 {
420         return q->drv_priv;
421 }
422
423 /**
424  * vb2_set_plane_payload() - set bytesused for the plane plane_no
425  * @vb:         buffer for which plane payload should be set
426  * @plane_no:   plane number for which payload should be set
427  * @size:       payload in bytes
428  */
429 static inline void vb2_set_plane_payload(struct vb2_buffer *vb,
430                                  unsigned int plane_no, unsigned long size)
431 {
432         if (plane_no < vb->num_planes)
433                 vb->v4l2_planes[plane_no].bytesused = size;
434 }
435
436 /**
437  * vb2_get_plane_payload() - get bytesused for the plane plane_no
438  * @vb:         buffer for which plane payload should be set
439  * @plane_no:   plane number for which payload should be set
440  * @size:       payload in bytes
441  */
442 static inline unsigned long vb2_get_plane_payload(struct vb2_buffer *vb,
443                                  unsigned int plane_no)
444 {
445         if (plane_no < vb->num_planes)
446                 return vb->v4l2_planes[plane_no].bytesused;
447         return 0;
448 }
449
450 /**
451  * vb2_plane_size() - return plane size in bytes
452  * @vb:         buffer for which plane size should be returned
453  * @plane_no:   plane number for which size should be returned
454  */
455 static inline unsigned long
456 vb2_plane_size(struct vb2_buffer *vb, unsigned int plane_no)
457 {
458         if (plane_no < vb->num_planes)
459                 return vb->v4l2_planes[plane_no].length;
460         return 0;
461 }
462
463 /*
464  * The following functions are not part of the vb2 core API, but are simple
465  * helper functions that you can use in your struct v4l2_file_operations,
466  * struct v4l2_ioctl_ops and struct vb2_ops. They will serialize if vb2_queue->lock
467  * or video_device->lock is set, and they will set and test vb2_queue->owner
468  * to check if the calling filehandle is permitted to do the queuing operation.
469  */
470
471 /* struct v4l2_ioctl_ops helpers */
472
473 int vb2_ioctl_reqbufs(struct file *file, void *priv,
474                           struct v4l2_requestbuffers *p);
475 int vb2_ioctl_create_bufs(struct file *file, void *priv,
476                           struct v4l2_create_buffers *p);
477 int vb2_ioctl_prepare_buf(struct file *file, void *priv,
478                           struct v4l2_buffer *p);
479 int vb2_ioctl_querybuf(struct file *file, void *priv, struct v4l2_buffer *p);
480 int vb2_ioctl_qbuf(struct file *file, void *priv, struct v4l2_buffer *p);
481 int vb2_ioctl_dqbuf(struct file *file, void *priv, struct v4l2_buffer *p);
482 int vb2_ioctl_streamon(struct file *file, void *priv, enum v4l2_buf_type i);
483 int vb2_ioctl_streamoff(struct file *file, void *priv, enum v4l2_buf_type i);
484 int vb2_ioctl_expbuf(struct file *file, void *priv,
485         struct v4l2_exportbuffer *p);
486
487 /* struct v4l2_file_operations helpers */
488
489 int vb2_fop_mmap(struct file *file, struct vm_area_struct *vma);
490 int vb2_fop_release(struct file *file);
491 ssize_t vb2_fop_write(struct file *file, char __user *buf,
492                 size_t count, loff_t *ppos);
493 ssize_t vb2_fop_read(struct file *file, char __user *buf,
494                 size_t count, loff_t *ppos);
495 unsigned int vb2_fop_poll(struct file *file, poll_table *wait);
496 #ifndef CONFIG_MMU
497 unsigned long vb2_fop_get_unmapped_area(struct file *file, unsigned long addr,
498                 unsigned long len, unsigned long pgoff, unsigned long flags);
499 #endif
500
501 /* struct vb2_ops helpers, only use if vq->lock is non-NULL. */
502
503 void vb2_ops_wait_prepare(struct vb2_queue *vq);
504 void vb2_ops_wait_finish(struct vb2_queue *vq);
505
506 #endif /* _MEDIA_VIDEOBUF2_CORE_H */