ff182086fb40563bc5f4771bbd04fb29bb0e6c53
[sfrench/cifs-2.6.git] / drivers / media / platform / omap3isp / ispqueue.h
1 /*
2  * ispqueue.h
3  *
4  * TI OMAP3 ISP - Video buffers queue handling
5  *
6  * Copyright (C) 2010 Nokia Corporation
7  *
8  * Contacts: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
9  *           Sakari Ailus <sakari.ailus@iki.fi>
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 version 2 as
13  * published by the Free Software Foundation.
14  *
15  * This program is distributed in the hope that it will be useful, but
16  * WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
23  * 02110-1301 USA
24  */
25
26 #ifndef OMAP3_ISP_QUEUE_H
27 #define OMAP3_ISP_QUEUE_H
28
29 #include <linux/kernel.h>
30 #include <linux/list.h>
31 #include <linux/mm_types.h>
32 #include <linux/mutex.h>
33 #include <linux/videodev2.h>
34 #include <linux/wait.h>
35
36 struct isp_video_queue;
37 struct page;
38 struct scatterlist;
39
40 #define ISP_VIDEO_MAX_BUFFERS           16
41
42 /**
43  * enum isp_video_buffer_state - ISP video buffer state
44  * @ISP_BUF_STATE_IDLE: The buffer is under userspace control (dequeued
45  *      or not queued yet).
46  * @ISP_BUF_STATE_QUEUED: The buffer has been queued but isn't used by the
47  *      device yet.
48  * @ISP_BUF_STATE_ACTIVE: The buffer is in use for an active video transfer.
49  * @ISP_BUF_STATE_ERROR: The device is done with the buffer and an error
50  *      occurred. For capture device the buffer likely contains corrupted data or
51  *      no data at all.
52  * @ISP_BUF_STATE_DONE: The device is done with the buffer and no error occurred.
53  *      For capture devices the buffer contains valid data.
54  */
55 enum isp_video_buffer_state {
56         ISP_BUF_STATE_IDLE,
57         ISP_BUF_STATE_QUEUED,
58         ISP_BUF_STATE_ACTIVE,
59         ISP_BUF_STATE_ERROR,
60         ISP_BUF_STATE_DONE,
61 };
62
63 /**
64  * struct isp_video_buffer - ISP video buffer
65  * @vma_use_count: Number of times the buffer is mmap'ed to userspace
66  * @stream: List head for insertion into main queue
67  * @queue: ISP buffers queue this buffer belongs to
68  * @prepared: Whether the buffer has been prepared
69  * @skip_cache: Whether to skip cache management operations for this buffer
70  * @vaddr: Memory virtual address (for kernel buffers)
71  * @vm_flags: Buffer VMA flags (for userspace buffers)
72  * @npages: Number of pages (for userspace buffers)
73  * @sgt: Scatter gather table (for userspace buffers)
74  * @pages: Pages table (for userspace non-VM_PFNMAP buffers)
75  * @vbuf: V4L2 buffer
76  * @state: Current buffer state
77  * @wait: Wait queue to signal buffer completion
78  */
79 struct isp_video_buffer {
80         unsigned long vma_use_count;
81         struct list_head stream;
82         struct isp_video_queue *queue;
83         unsigned int prepared:1;
84         bool skip_cache;
85
86         /* For kernel buffers. */
87         void *vaddr;
88
89         /* For userspace buffers. */
90         vm_flags_t vm_flags;
91         unsigned int npages;
92         struct sg_table sgt;
93
94         /* For non-VM_PFNMAP userspace buffers. */
95         struct page **pages;
96
97         /* Touched by the interrupt handler. */
98         struct v4l2_buffer vbuf;
99         enum isp_video_buffer_state state;
100         wait_queue_head_t wait;
101         dma_addr_t dma;
102 };
103
104 #define to_isp_video_buffer(vb) container_of(vb, struct isp_video_buffer, vb)
105
106 /**
107  * struct isp_video_queue_operations - Driver-specific operations
108  * @queue_prepare: Called before allocating buffers. Drivers should clamp the
109  *      number of buffers according to their requirements, and must return the
110  *      buffer size in bytes.
111  * @buffer_prepare: Called the first time a buffer is queued, or after changing
112  *      the userspace memory address for a USERPTR buffer, with the queue lock
113  *      held. Drivers should perform device-specific buffer preparation (such as
114  *      mapping the buffer memory in an IOMMU). This operation is optional.
115  * @buffer_queue: Called when a buffer is being added.
116  */
117 struct isp_video_queue_operations {
118         void (*queue_prepare)(struct isp_video_queue *queue,
119                               unsigned int *nbuffers, unsigned int *size);
120         int  (*buffer_prepare)(struct isp_video_buffer *buf);
121         void (*buffer_queue)(struct isp_video_buffer *buf);
122 };
123
124 /**
125  * struct isp_video_queue - ISP video buffers queue
126  * @type: Type of video buffers handled by this queue
127  * @ops: Queue operations
128  * @dev: Device used for DMA operations
129  * @bufsize: Size of a driver-specific buffer object
130  * @count: Number of currently allocated buffers
131  * @buffers: ISP video buffers
132  * @streaming: Queue state, indicates whether the queue is streaming
133  * @queue: List of all queued buffers
134  */
135 struct isp_video_queue {
136         enum v4l2_buf_type type;
137         const struct isp_video_queue_operations *ops;
138         struct device *dev;
139         unsigned int bufsize;
140
141         unsigned int count;
142         struct isp_video_buffer *buffers[ISP_VIDEO_MAX_BUFFERS];
143
144         unsigned int streaming:1;
145
146         struct list_head queue;
147 };
148
149 int omap3isp_video_queue_cleanup(struct isp_video_queue *queue);
150 int omap3isp_video_queue_init(struct isp_video_queue *queue,
151                               enum v4l2_buf_type type,
152                               const struct isp_video_queue_operations *ops,
153                               struct device *dev, unsigned int bufsize);
154
155 int omap3isp_video_queue_reqbufs(struct isp_video_queue *queue,
156                                  struct v4l2_requestbuffers *rb);
157 int omap3isp_video_queue_querybuf(struct isp_video_queue *queue,
158                                   struct v4l2_buffer *vbuf);
159 int omap3isp_video_queue_qbuf(struct isp_video_queue *queue,
160                               struct v4l2_buffer *vbuf);
161 int omap3isp_video_queue_dqbuf(struct isp_video_queue *queue,
162                                struct v4l2_buffer *vbuf, int nonblocking);
163 int omap3isp_video_queue_streamon(struct isp_video_queue *queue);
164 void omap3isp_video_queue_streamoff(struct isp_video_queue *queue);
165 void omap3isp_video_queue_discard_done(struct isp_video_queue *queue);
166 int omap3isp_video_queue_mmap(struct isp_video_queue *queue,
167                               struct vm_area_struct *vma);
168 unsigned int omap3isp_video_queue_poll(struct isp_video_queue *queue,
169                                        struct file *file, poll_table *wait);
170
171 #endif /* OMAP3_ISP_QUEUE_H */