Commit | Line | Data |
---|---|---|
7f98639d PO |
1 | /* |
2 | * Memory-to-memory device framework for Video for Linux 2. | |
3 | * | |
4 | * Helper functions for devices that use memory buffers for both source | |
5 | * and destination. | |
6 | * | |
7 | * Copyright (c) 2009 Samsung Electronics Co., Ltd. | |
95072084 | 8 | * Pawel Osciak, <pawel@osciak.com> |
7f98639d PO |
9 | * Marek Szyprowski, <m.szyprowski@samsung.com> |
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 the | |
13 | * Free Software Foundation; either version 2 of the | |
14 | * License, or (at your option) any later version | |
15 | */ | |
16 | ||
17 | #ifndef _MEDIA_V4L2_MEM2MEM_H | |
18 | #define _MEDIA_V4L2_MEM2MEM_H | |
19 | ||
c139990e | 20 | #include <media/videobuf2-v4l2.h> |
7f98639d PO |
21 | |
22 | /** | |
23 | * struct v4l2_m2m_ops - mem-to-mem device driver callbacks | |
24 | * @device_run: required. Begin the actual job (transaction) inside this | |
25 | * callback. | |
26 | * The job does NOT have to end before this callback returns | |
27 | * (and it will be the usual case). When the job finishes, | |
28 | * v4l2_m2m_job_finish() has to be called. | |
29 | * @job_ready: optional. Should return 0 if the driver does not have a job | |
30 | * fully prepared to run yet (i.e. it will not be able to finish a | |
31 | * transaction without sleeping). If not provided, it will be | |
32 | * assumed that one source and one destination buffer are all | |
33 | * that is required for the driver to perform one full transaction. | |
34 | * This method may not sleep. | |
35 | * @job_abort: required. Informs the driver that it has to abort the currently | |
36 | * running transaction as soon as possible (i.e. as soon as it can | |
37 | * stop the device safely; e.g. in the next interrupt handler), | |
38 | * even if the transaction would not have been finished by then. | |
39 | * After the driver performs the necessary steps, it has to call | |
40 | * v4l2_m2m_job_finish() (as if the transaction ended normally). | |
41 | * This function does not have to (and will usually not) wait | |
42 | * until the device enters a state when it can be stopped. | |
62c0d016 MCC |
43 | * @lock: optional. Define a driver's own lock callback, instead of using |
44 | * m2m_ctx->q_lock. | |
45 | * @unlock: optional. Define a driver's own unlock callback, instead of | |
46 | * using m2m_ctx->q_lock. | |
7f98639d PO |
47 | */ |
48 | struct v4l2_m2m_ops { | |
49 | void (*device_run)(void *priv); | |
50 | int (*job_ready)(void *priv); | |
51 | void (*job_abort)(void *priv); | |
908a0d7c MS |
52 | void (*lock)(void *priv); |
53 | void (*unlock)(void *priv); | |
7f98639d PO |
54 | }; |
55 | ||
56 | struct v4l2_m2m_dev; | |
57 | ||
58 | struct v4l2_m2m_queue_ctx { | |
59 | /* private: internal use only */ | |
908a0d7c | 60 | struct vb2_queue q; |
7f98639d PO |
61 | |
62 | /* Queue for buffers ready to be processed as soon as this | |
63 | * instance receives access to the device */ | |
64 | struct list_head rdy_queue; | |
908a0d7c | 65 | spinlock_t rdy_spinlock; |
7f98639d | 66 | u8 num_rdy; |
33bdd5a8 | 67 | bool buffered; |
7f98639d PO |
68 | }; |
69 | ||
70 | struct v4l2_m2m_ctx { | |
8e6e8f93 SN |
71 | /* optional cap/out vb2 queues lock */ |
72 | struct mutex *q_lock; | |
73 | ||
7f98639d PO |
74 | /* private: internal use only */ |
75 | struct v4l2_m2m_dev *m2m_dev; | |
76 | ||
77 | /* Capture (output to memory) queue context */ | |
78 | struct v4l2_m2m_queue_ctx cap_q_ctx; | |
79 | ||
80 | /* Output (input from memory) queue context */ | |
81 | struct v4l2_m2m_queue_ctx out_q_ctx; | |
82 | ||
83 | /* For device job queue */ | |
84 | struct list_head queue; | |
85 | unsigned long job_flags; | |
908a0d7c | 86 | wait_queue_head_t finished; |
7f98639d PO |
87 | |
88 | /* Instance private data */ | |
89 | void *priv; | |
90 | }; | |
91 | ||
908a0d7c | 92 | struct v4l2_m2m_buffer { |
2d700715 | 93 | struct vb2_v4l2_buffer vb; |
908a0d7c MS |
94 | struct list_head list; |
95 | }; | |
96 | ||
7f98639d PO |
97 | void *v4l2_m2m_get_curr_priv(struct v4l2_m2m_dev *m2m_dev); |
98 | ||
908a0d7c | 99 | struct vb2_queue *v4l2_m2m_get_vq(struct v4l2_m2m_ctx *m2m_ctx, |
7f98639d PO |
100 | enum v4l2_buf_type type); |
101 | ||
1190a419 MO |
102 | void v4l2_m2m_try_schedule(struct v4l2_m2m_ctx *m2m_ctx); |
103 | ||
7f98639d PO |
104 | void v4l2_m2m_job_finish(struct v4l2_m2m_dev *m2m_dev, |
105 | struct v4l2_m2m_ctx *m2m_ctx); | |
106 | ||
908a0d7c | 107 | static inline void |
2d700715 | 108 | v4l2_m2m_buf_done(struct vb2_v4l2_buffer *buf, enum vb2_buffer_state state) |
908a0d7c | 109 | { |
2d700715 | 110 | vb2_buffer_done(&buf->vb2_buf, state); |
908a0d7c MS |
111 | } |
112 | ||
7f98639d PO |
113 | int v4l2_m2m_reqbufs(struct file *file, struct v4l2_m2m_ctx *m2m_ctx, |
114 | struct v4l2_requestbuffers *reqbufs); | |
115 | ||
116 | int v4l2_m2m_querybuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx, | |
117 | struct v4l2_buffer *buf); | |
118 | ||
119 | int v4l2_m2m_qbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx, | |
120 | struct v4l2_buffer *buf); | |
121 | int v4l2_m2m_dqbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx, | |
122 | struct v4l2_buffer *buf); | |
e68cf471 HV |
123 | int v4l2_m2m_prepare_buf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx, |
124 | struct v4l2_buffer *buf); | |
8b94ca61 PZ |
125 | int v4l2_m2m_create_bufs(struct file *file, struct v4l2_m2m_ctx *m2m_ctx, |
126 | struct v4l2_create_buffers *create); | |
7f98639d | 127 | |
83ae7c5a TS |
128 | int v4l2_m2m_expbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx, |
129 | struct v4l2_exportbuffer *eb); | |
130 | ||
7f98639d PO |
131 | int v4l2_m2m_streamon(struct file *file, struct v4l2_m2m_ctx *m2m_ctx, |
132 | enum v4l2_buf_type type); | |
133 | int v4l2_m2m_streamoff(struct file *file, struct v4l2_m2m_ctx *m2m_ctx, | |
134 | enum v4l2_buf_type type); | |
135 | ||
136 | unsigned int v4l2_m2m_poll(struct file *file, struct v4l2_m2m_ctx *m2m_ctx, | |
137 | struct poll_table_struct *wait); | |
138 | ||
139 | int v4l2_m2m_mmap(struct file *file, struct v4l2_m2m_ctx *m2m_ctx, | |
140 | struct vm_area_struct *vma); | |
141 | ||
b1252eb8 | 142 | struct v4l2_m2m_dev *v4l2_m2m_init(const struct v4l2_m2m_ops *m2m_ops); |
7f98639d PO |
143 | void v4l2_m2m_release(struct v4l2_m2m_dev *m2m_dev); |
144 | ||
908a0d7c MS |
145 | struct v4l2_m2m_ctx *v4l2_m2m_ctx_init(struct v4l2_m2m_dev *m2m_dev, |
146 | void *drv_priv, | |
147 | int (*queue_init)(void *priv, struct vb2_queue *src_vq, struct vb2_queue *dst_vq)); | |
148 | ||
33bdd5a8 PZ |
149 | static inline void v4l2_m2m_set_src_buffered(struct v4l2_m2m_ctx *m2m_ctx, |
150 | bool buffered) | |
151 | { | |
152 | m2m_ctx->out_q_ctx.buffered = buffered; | |
153 | } | |
154 | ||
155 | static inline void v4l2_m2m_set_dst_buffered(struct v4l2_m2m_ctx *m2m_ctx, | |
156 | bool buffered) | |
157 | { | |
158 | m2m_ctx->cap_q_ctx.buffered = buffered; | |
159 | } | |
160 | ||
7f98639d PO |
161 | void v4l2_m2m_ctx_release(struct v4l2_m2m_ctx *m2m_ctx); |
162 | ||
2d700715 JS |
163 | void v4l2_m2m_buf_queue(struct v4l2_m2m_ctx *m2m_ctx, |
164 | struct vb2_v4l2_buffer *vbuf); | |
7f98639d PO |
165 | |
166 | /** | |
167 | * v4l2_m2m_num_src_bufs_ready() - return the number of source buffers ready for | |
168 | * use | |
62c0d016 MCC |
169 | * |
170 | * @m2m_ctx: pointer to struct v4l2_m2m_ctx | |
7f98639d PO |
171 | */ |
172 | static inline | |
173 | unsigned int v4l2_m2m_num_src_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx) | |
174 | { | |
961ae449 | 175 | return m2m_ctx->out_q_ctx.num_rdy; |
7f98639d PO |
176 | } |
177 | ||
178 | /** | |
179 | * v4l2_m2m_num_src_bufs_ready() - return the number of destination buffers | |
180 | * ready for use | |
62c0d016 MCC |
181 | * |
182 | * @m2m_ctx: pointer to struct v4l2_m2m_ctx | |
7f98639d PO |
183 | */ |
184 | static inline | |
185 | unsigned int v4l2_m2m_num_dst_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx) | |
186 | { | |
961ae449 | 187 | return m2m_ctx->cap_q_ctx.num_rdy; |
7f98639d PO |
188 | } |
189 | ||
908a0d7c | 190 | void *v4l2_m2m_next_buf(struct v4l2_m2m_queue_ctx *q_ctx); |
7f98639d PO |
191 | |
192 | /** | |
193 | * v4l2_m2m_next_src_buf() - return next source buffer from the list of ready | |
194 | * buffers | |
62c0d016 MCC |
195 | * |
196 | * @m2m_ctx: pointer to struct v4l2_m2m_ctx | |
7f98639d PO |
197 | */ |
198 | static inline void *v4l2_m2m_next_src_buf(struct v4l2_m2m_ctx *m2m_ctx) | |
199 | { | |
908a0d7c | 200 | return v4l2_m2m_next_buf(&m2m_ctx->out_q_ctx); |
7f98639d PO |
201 | } |
202 | ||
203 | /** | |
204 | * v4l2_m2m_next_dst_buf() - return next destination buffer from the list of | |
205 | * ready buffers | |
62c0d016 MCC |
206 | * |
207 | * @m2m_ctx: pointer to struct v4l2_m2m_ctx | |
7f98639d PO |
208 | */ |
209 | static inline void *v4l2_m2m_next_dst_buf(struct v4l2_m2m_ctx *m2m_ctx) | |
210 | { | |
908a0d7c | 211 | return v4l2_m2m_next_buf(&m2m_ctx->cap_q_ctx); |
7f98639d PO |
212 | } |
213 | ||
214 | /** | |
908a0d7c | 215 | * v4l2_m2m_get_src_vq() - return vb2_queue for source buffers |
62c0d016 MCC |
216 | * |
217 | * @m2m_ctx: pointer to struct v4l2_m2m_ctx | |
7f98639d PO |
218 | */ |
219 | static inline | |
908a0d7c | 220 | struct vb2_queue *v4l2_m2m_get_src_vq(struct v4l2_m2m_ctx *m2m_ctx) |
7f98639d | 221 | { |
908a0d7c | 222 | return &m2m_ctx->out_q_ctx.q; |
7f98639d PO |
223 | } |
224 | ||
225 | /** | |
908a0d7c | 226 | * v4l2_m2m_get_dst_vq() - return vb2_queue for destination buffers |
62c0d016 MCC |
227 | * |
228 | * @m2m_ctx: pointer to struct v4l2_m2m_ctx | |
7f98639d PO |
229 | */ |
230 | static inline | |
908a0d7c | 231 | struct vb2_queue *v4l2_m2m_get_dst_vq(struct v4l2_m2m_ctx *m2m_ctx) |
7f98639d | 232 | { |
908a0d7c | 233 | return &m2m_ctx->cap_q_ctx.q; |
7f98639d PO |
234 | } |
235 | ||
908a0d7c | 236 | void *v4l2_m2m_buf_remove(struct v4l2_m2m_queue_ctx *q_ctx); |
7f98639d PO |
237 | |
238 | /** | |
239 | * v4l2_m2m_src_buf_remove() - take off a source buffer from the list of ready | |
240 | * buffers and return it | |
62c0d016 MCC |
241 | * |
242 | * @m2m_ctx: pointer to struct v4l2_m2m_ctx | |
7f98639d PO |
243 | */ |
244 | static inline void *v4l2_m2m_src_buf_remove(struct v4l2_m2m_ctx *m2m_ctx) | |
245 | { | |
908a0d7c | 246 | return v4l2_m2m_buf_remove(&m2m_ctx->out_q_ctx); |
7f98639d PO |
247 | } |
248 | ||
249 | /** | |
250 | * v4l2_m2m_dst_buf_remove() - take off a destination buffer from the list of | |
251 | * ready buffers and return it | |
62c0d016 MCC |
252 | * |
253 | * @m2m_ctx: pointer to struct v4l2_m2m_ctx | |
7f98639d PO |
254 | */ |
255 | static inline void *v4l2_m2m_dst_buf_remove(struct v4l2_m2m_ctx *m2m_ctx) | |
256 | { | |
908a0d7c | 257 | return v4l2_m2m_buf_remove(&m2m_ctx->cap_q_ctx); |
7f98639d PO |
258 | } |
259 | ||
8e6e8f93 SN |
260 | /* v4l2 ioctl helpers */ |
261 | ||
262 | int v4l2_m2m_ioctl_reqbufs(struct file *file, void *priv, | |
263 | struct v4l2_requestbuffers *rb); | |
264 | int v4l2_m2m_ioctl_create_bufs(struct file *file, void *fh, | |
265 | struct v4l2_create_buffers *create); | |
266 | int v4l2_m2m_ioctl_querybuf(struct file *file, void *fh, | |
267 | struct v4l2_buffer *buf); | |
268 | int v4l2_m2m_ioctl_expbuf(struct file *file, void *fh, | |
269 | struct v4l2_exportbuffer *eb); | |
270 | int v4l2_m2m_ioctl_qbuf(struct file *file, void *fh, | |
271 | struct v4l2_buffer *buf); | |
272 | int v4l2_m2m_ioctl_dqbuf(struct file *file, void *fh, | |
273 | struct v4l2_buffer *buf); | |
e68cf471 HV |
274 | int v4l2_m2m_ioctl_prepare_buf(struct file *file, void *fh, |
275 | struct v4l2_buffer *buf); | |
8e6e8f93 SN |
276 | int v4l2_m2m_ioctl_streamon(struct file *file, void *fh, |
277 | enum v4l2_buf_type type); | |
278 | int v4l2_m2m_ioctl_streamoff(struct file *file, void *fh, | |
279 | enum v4l2_buf_type type); | |
280 | int v4l2_m2m_fop_mmap(struct file *file, struct vm_area_struct *vma); | |
281 | unsigned int v4l2_m2m_fop_poll(struct file *file, poll_table *wait); | |
282 | ||
7f98639d PO |
283 | #endif /* _MEDIA_V4L2_MEM2MEM_H */ |
284 |