blob: 8849aaba6aa5a4ef0a0efa830835f2d11cf40423 [file] [log] [blame]
Pawel Osciak7f986392010-04-23 05:38:37 -03001/*
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.
Pawel Osciak95072082011-03-13 15:23:32 -03008 * Pawel Osciak, <pawel@osciak.com>
Pawel Osciak7f986392010-04-23 05:38:37 -03009 * 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
Marek Szyprowski908a0d72011-01-12 06:50:24 -030020#include <media/videobuf2-core.h>
Pawel Osciak7f986392010-04-23 05:38:37 -030021
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.
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -030043 * @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.
Pawel Osciak7f986392010-04-23 05:38:37 -030047 */
48struct v4l2_m2m_ops {
49 void (*device_run)(void *priv);
50 int (*job_ready)(void *priv);
51 void (*job_abort)(void *priv);
Marek Szyprowski908a0d72011-01-12 06:50:24 -030052 void (*lock)(void *priv);
53 void (*unlock)(void *priv);
Pawel Osciak7f986392010-04-23 05:38:37 -030054};
55
56struct v4l2_m2m_dev;
57
58struct v4l2_m2m_queue_ctx {
59/* private: internal use only */
Marek Szyprowski908a0d72011-01-12 06:50:24 -030060 struct vb2_queue q;
Pawel Osciak7f986392010-04-23 05:38:37 -030061
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;
Marek Szyprowski908a0d72011-01-12 06:50:24 -030065 spinlock_t rdy_spinlock;
Pawel Osciak7f986392010-04-23 05:38:37 -030066 u8 num_rdy;
Philipp Zabel33bdd5a2013-06-03 04:23:48 -030067 bool buffered;
Pawel Osciak7f986392010-04-23 05:38:37 -030068};
69
70struct v4l2_m2m_ctx {
Sylwester Nawrocki8e6e8f92013-09-14 18:39:04 -030071 /* optional cap/out vb2 queues lock */
72 struct mutex *q_lock;
73
Pawel Osciak7f986392010-04-23 05:38:37 -030074/* 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;
Marek Szyprowski908a0d72011-01-12 06:50:24 -030086 wait_queue_head_t finished;
Pawel Osciak7f986392010-04-23 05:38:37 -030087
88 /* Instance private data */
89 void *priv;
90};
91
Marek Szyprowski908a0d72011-01-12 06:50:24 -030092struct v4l2_m2m_buffer {
93 struct vb2_buffer vb;
94 struct list_head list;
95};
96
Pawel Osciak7f986392010-04-23 05:38:37 -030097void *v4l2_m2m_get_curr_priv(struct v4l2_m2m_dev *m2m_dev);
98
Marek Szyprowski908a0d72011-01-12 06:50:24 -030099struct vb2_queue *v4l2_m2m_get_vq(struct v4l2_m2m_ctx *m2m_ctx,
Pawel Osciak7f986392010-04-23 05:38:37 -0300100 enum v4l2_buf_type type);
101
Michael Olbrich1190a412014-07-22 09:36:04 -0300102void v4l2_m2m_try_schedule(struct v4l2_m2m_ctx *m2m_ctx);
103
Pawel Osciak7f986392010-04-23 05:38:37 -0300104void v4l2_m2m_job_finish(struct v4l2_m2m_dev *m2m_dev,
105 struct v4l2_m2m_ctx *m2m_ctx);
106
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300107static inline void
108v4l2_m2m_buf_done(struct vb2_buffer *buf, enum vb2_buffer_state state)
109{
110 vb2_buffer_done(buf, state);
111}
112
Pawel Osciak7f986392010-04-23 05:38:37 -0300113int v4l2_m2m_reqbufs(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
114 struct v4l2_requestbuffers *reqbufs);
115
116int v4l2_m2m_querybuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
117 struct v4l2_buffer *buf);
118
119int v4l2_m2m_qbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
120 struct v4l2_buffer *buf);
121int v4l2_m2m_dqbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
122 struct v4l2_buffer *buf);
Hans Verkuile68cf472015-06-05 11:28:50 -0300123int v4l2_m2m_prepare_buf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
124 struct v4l2_buffer *buf);
Philipp Zabel8b94ca62013-05-21 04:16:28 -0300125int v4l2_m2m_create_bufs(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
126 struct v4l2_create_buffers *create);
Pawel Osciak7f986392010-04-23 05:38:37 -0300127
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -0300128int v4l2_m2m_expbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
129 struct v4l2_exportbuffer *eb);
130
Pawel Osciak7f986392010-04-23 05:38:37 -0300131int v4l2_m2m_streamon(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
132 enum v4l2_buf_type type);
133int v4l2_m2m_streamoff(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
134 enum v4l2_buf_type type);
135
136unsigned int v4l2_m2m_poll(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
137 struct poll_table_struct *wait);
138
139int v4l2_m2m_mmap(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
140 struct vm_area_struct *vma);
141
Guennadi Liakhovetskib1252eb2012-09-11 06:32:17 -0300142struct v4l2_m2m_dev *v4l2_m2m_init(const struct v4l2_m2m_ops *m2m_ops);
Pawel Osciak7f986392010-04-23 05:38:37 -0300143void v4l2_m2m_release(struct v4l2_m2m_dev *m2m_dev);
144
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300145struct 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
Philipp Zabel33bdd5a2013-06-03 04:23:48 -0300149static 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
155static 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
Pawel Osciak7f986392010-04-23 05:38:37 -0300161void v4l2_m2m_ctx_release(struct v4l2_m2m_ctx *m2m_ctx);
162
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300163void v4l2_m2m_buf_queue(struct v4l2_m2m_ctx *m2m_ctx, struct vb2_buffer *vb);
Pawel Osciak7f986392010-04-23 05:38:37 -0300164
165/**
166 * v4l2_m2m_num_src_bufs_ready() - return the number of source buffers ready for
167 * use
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300168 *
169 * @m2m_ctx: pointer to struct v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300170 */
171static inline
172unsigned int v4l2_m2m_num_src_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx)
173{
Sascha Hauer961ae442012-08-31 09:18:04 -0300174 return m2m_ctx->out_q_ctx.num_rdy;
Pawel Osciak7f986392010-04-23 05:38:37 -0300175}
176
177/**
178 * v4l2_m2m_num_src_bufs_ready() - return the number of destination buffers
179 * ready for use
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300180 *
181 * @m2m_ctx: pointer to struct v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300182 */
183static inline
184unsigned int v4l2_m2m_num_dst_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx)
185{
Sascha Hauer961ae442012-08-31 09:18:04 -0300186 return m2m_ctx->cap_q_ctx.num_rdy;
Pawel Osciak7f986392010-04-23 05:38:37 -0300187}
188
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300189void *v4l2_m2m_next_buf(struct v4l2_m2m_queue_ctx *q_ctx);
Pawel Osciak7f986392010-04-23 05:38:37 -0300190
191/**
192 * v4l2_m2m_next_src_buf() - return next source buffer from the list of ready
193 * buffers
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300194 *
195 * @m2m_ctx: pointer to struct v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300196 */
197static inline void *v4l2_m2m_next_src_buf(struct v4l2_m2m_ctx *m2m_ctx)
198{
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300199 return v4l2_m2m_next_buf(&m2m_ctx->out_q_ctx);
Pawel Osciak7f986392010-04-23 05:38:37 -0300200}
201
202/**
203 * v4l2_m2m_next_dst_buf() - return next destination buffer from the list of
204 * ready buffers
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300205 *
206 * @m2m_ctx: pointer to struct v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300207 */
208static inline void *v4l2_m2m_next_dst_buf(struct v4l2_m2m_ctx *m2m_ctx)
209{
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300210 return v4l2_m2m_next_buf(&m2m_ctx->cap_q_ctx);
Pawel Osciak7f986392010-04-23 05:38:37 -0300211}
212
213/**
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300214 * v4l2_m2m_get_src_vq() - return vb2_queue for source buffers
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300215 *
216 * @m2m_ctx: pointer to struct v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300217 */
218static inline
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300219struct vb2_queue *v4l2_m2m_get_src_vq(struct v4l2_m2m_ctx *m2m_ctx)
Pawel Osciak7f986392010-04-23 05:38:37 -0300220{
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300221 return &m2m_ctx->out_q_ctx.q;
Pawel Osciak7f986392010-04-23 05:38:37 -0300222}
223
224/**
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300225 * v4l2_m2m_get_dst_vq() - return vb2_queue for destination buffers
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300226 *
227 * @m2m_ctx: pointer to struct v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300228 */
229static inline
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300230struct vb2_queue *v4l2_m2m_get_dst_vq(struct v4l2_m2m_ctx *m2m_ctx)
Pawel Osciak7f986392010-04-23 05:38:37 -0300231{
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300232 return &m2m_ctx->cap_q_ctx.q;
Pawel Osciak7f986392010-04-23 05:38:37 -0300233}
234
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300235void *v4l2_m2m_buf_remove(struct v4l2_m2m_queue_ctx *q_ctx);
Pawel Osciak7f986392010-04-23 05:38:37 -0300236
237/**
238 * v4l2_m2m_src_buf_remove() - take off a source buffer from the list of ready
239 * buffers and return it
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300240 *
241 * @m2m_ctx: pointer to struct v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300242 */
243static inline void *v4l2_m2m_src_buf_remove(struct v4l2_m2m_ctx *m2m_ctx)
244{
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300245 return v4l2_m2m_buf_remove(&m2m_ctx->out_q_ctx);
Pawel Osciak7f986392010-04-23 05:38:37 -0300246}
247
248/**
249 * v4l2_m2m_dst_buf_remove() - take off a destination buffer from the list of
250 * ready buffers and return it
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300251 *
252 * @m2m_ctx: pointer to struct v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300253 */
254static inline void *v4l2_m2m_dst_buf_remove(struct v4l2_m2m_ctx *m2m_ctx)
255{
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300256 return v4l2_m2m_buf_remove(&m2m_ctx->cap_q_ctx);
Pawel Osciak7f986392010-04-23 05:38:37 -0300257}
258
Sylwester Nawrocki8e6e8f92013-09-14 18:39:04 -0300259/* v4l2 ioctl helpers */
260
261int v4l2_m2m_ioctl_reqbufs(struct file *file, void *priv,
262 struct v4l2_requestbuffers *rb);
263int v4l2_m2m_ioctl_create_bufs(struct file *file, void *fh,
264 struct v4l2_create_buffers *create);
265int v4l2_m2m_ioctl_querybuf(struct file *file, void *fh,
266 struct v4l2_buffer *buf);
267int v4l2_m2m_ioctl_expbuf(struct file *file, void *fh,
268 struct v4l2_exportbuffer *eb);
269int v4l2_m2m_ioctl_qbuf(struct file *file, void *fh,
270 struct v4l2_buffer *buf);
271int v4l2_m2m_ioctl_dqbuf(struct file *file, void *fh,
272 struct v4l2_buffer *buf);
Hans Verkuile68cf472015-06-05 11:28:50 -0300273int v4l2_m2m_ioctl_prepare_buf(struct file *file, void *fh,
274 struct v4l2_buffer *buf);
Sylwester Nawrocki8e6e8f92013-09-14 18:39:04 -0300275int v4l2_m2m_ioctl_streamon(struct file *file, void *fh,
276 enum v4l2_buf_type type);
277int v4l2_m2m_ioctl_streamoff(struct file *file, void *fh,
278 enum v4l2_buf_type type);
279int v4l2_m2m_fop_mmap(struct file *file, struct vm_area_struct *vma);
280unsigned int v4l2_m2m_fop_poll(struct file *file, poll_table *wait);
281
Pawel Osciak7f986392010-04-23 05:38:37 -0300282#endif /* _MEDIA_V4L2_MEM2MEM_H */
283