blob: e157d5c9b224e957c8a901d9d3f40cfb3654c761 [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
Junghak Sungc1399902015-09-22 10:30:29 -030020#include <media/videobuf2-v4l2.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
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -030044 * &v4l2_m2m_ctx->q_lock.
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -030045 * @unlock: optional. Define a driver's own unlock callback, instead of
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -030046 * using &v4l2_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
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -030058/**
59 * struct v4l2_m2m_queue_ctx - represents a queue for buffers ready to be
60 * processed
61 *
62 * @q: pointer to struct &vb2_queue
63 * @rdy_queue: List of V4L2 mem-to-mem queues
64 * @rdy_spinlock: spin lock to protect the struct usage
65 * @num_rdy: number of buffers ready to be processed
66 * @buffered: is the queue buffered?
67 *
68 * Queue for buffers ready to be processed as soon as this
69 * instance receives access to the device.
70 */
71
Pawel Osciak7f986392010-04-23 05:38:37 -030072struct v4l2_m2m_queue_ctx {
Marek Szyprowski908a0d72011-01-12 06:50:24 -030073 struct vb2_queue q;
Pawel Osciak7f986392010-04-23 05:38:37 -030074
Pawel Osciak7f986392010-04-23 05:38:37 -030075 struct list_head rdy_queue;
Marek Szyprowski908a0d72011-01-12 06:50:24 -030076 spinlock_t rdy_spinlock;
Pawel Osciak7f986392010-04-23 05:38:37 -030077 u8 num_rdy;
Philipp Zabel33bdd5a2013-06-03 04:23:48 -030078 bool buffered;
Pawel Osciak7f986392010-04-23 05:38:37 -030079};
80
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -030081/**
82 * struct v4l2_m2m_ctx - Memory to memory context structure
83 *
84 * @q_lock: struct &mutex lock
Mauro Carvalho Chehab9f8d3a22016-09-08 17:20:44 -030085 * @m2m_dev: opaque pointer to the internal data to handle M2M context
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -030086 * @cap_q_ctx: Capture (output to memory) queue context
87 * @out_q_ctx: Output (input from memory) queue context
88 * @queue: List of memory to memory contexts
89 * @job_flags: Job queue flags, used internally by v4l2-mem2mem.c:
90 * %TRANS_QUEUED, %TRANS_RUNNING and %TRANS_ABORT.
91 * @finished: Wait queue used to signalize when a job queue finished.
92 * @priv: Instance private data
Sakari Ailus708f48e2016-10-18 11:15:32 -020093 *
94 * The memory to memory context is specific to a file handle, NOT to e.g.
95 * a device.
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -030096 */
Pawel Osciak7f986392010-04-23 05:38:37 -030097struct v4l2_m2m_ctx {
Sylwester Nawrocki8e6e8f92013-09-14 18:39:04 -030098 /* optional cap/out vb2 queues lock */
99 struct mutex *q_lock;
100
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -0300101 /* internal use only */
Pawel Osciak7f986392010-04-23 05:38:37 -0300102 struct v4l2_m2m_dev *m2m_dev;
103
Pawel Osciak7f986392010-04-23 05:38:37 -0300104 struct v4l2_m2m_queue_ctx cap_q_ctx;
105
Pawel Osciak7f986392010-04-23 05:38:37 -0300106 struct v4l2_m2m_queue_ctx out_q_ctx;
107
108 /* For device job queue */
109 struct list_head queue;
110 unsigned long job_flags;
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300111 wait_queue_head_t finished;
Pawel Osciak7f986392010-04-23 05:38:37 -0300112
Pawel Osciak7f986392010-04-23 05:38:37 -0300113 void *priv;
114};
115
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -0300116/**
117 * struct v4l2_m2m_buffer - Memory to memory buffer
118 *
119 * @vb: pointer to struct &vb2_v4l2_buffer
120 * @list: list of m2m buffers
121 */
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300122struct v4l2_m2m_buffer {
Junghak Sung2d700712015-09-22 10:30:30 -0300123 struct vb2_v4l2_buffer vb;
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300124 struct list_head list;
125};
126
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300127/**
128 * v4l2_m2m_get_curr_priv() - return driver private data for the currently
129 * running instance or NULL if no instance is running
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300130 *
Mauro Carvalho Chehab9f8d3a22016-09-08 17:20:44 -0300131 * @m2m_dev: opaque pointer to the internal data to handle M2M context
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300132 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300133void *v4l2_m2m_get_curr_priv(struct v4l2_m2m_dev *m2m_dev);
134
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300135/**
136 * v4l2_m2m_get_vq() - return vb2_queue for the given type
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300137 *
138 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
139 * @type: type of the V4L2 buffer, as defined by enum &v4l2_buf_type
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300140 */
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300141struct vb2_queue *v4l2_m2m_get_vq(struct v4l2_m2m_ctx *m2m_ctx,
Pawel Osciak7f986392010-04-23 05:38:37 -0300142 enum v4l2_buf_type type);
143
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300144/**
145 * v4l2_m2m_try_schedule() - check whether an instance is ready to be added to
146 * the pending job queue and add it if so.
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300147 *
148 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300149 *
150 * There are three basic requirements an instance has to meet to be able to run:
151 * 1) at least one source buffer has to be queued,
152 * 2) at least one destination buffer has to be queued,
153 * 3) streaming has to be on.
154 *
155 * If a queue is buffered (for example a decoder hardware ringbuffer that has
156 * to be drained before doing streamoff), allow scheduling without v4l2 buffers
157 * on that queue.
158 *
159 * There may also be additional, custom requirements. In such case the driver
160 * should supply a custom callback (job_ready in v4l2_m2m_ops) that should
161 * return 1 if the instance is ready.
162 * An example of the above could be an instance that requires more than one
163 * src/dst buffer per transaction.
164 */
Michael Olbrich1190a412014-07-22 09:36:04 -0300165void v4l2_m2m_try_schedule(struct v4l2_m2m_ctx *m2m_ctx);
166
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300167/**
168 * v4l2_m2m_job_finish() - inform the framework that a job has been finished
169 * and have it clean up
170 *
Mauro Carvalho Chehab9f8d3a22016-09-08 17:20:44 -0300171 * @m2m_dev: opaque pointer to the internal data to handle M2M context
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300172 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
173 *
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300174 * Called by a driver to yield back the device after it has finished with it.
175 * Should be called as soon as possible after reaching a state which allows
176 * other instances to take control of the device.
177 *
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -0300178 * This function has to be called only after &v4l2_m2m_ops->device_run
179 * callback has been called on the driver. To prevent recursion, it should
180 * not be called directly from the &v4l2_m2m_ops->device_run callback though.
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300181 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300182void v4l2_m2m_job_finish(struct v4l2_m2m_dev *m2m_dev,
183 struct v4l2_m2m_ctx *m2m_ctx);
184
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300185static inline void
Junghak Sung2d700712015-09-22 10:30:30 -0300186v4l2_m2m_buf_done(struct vb2_v4l2_buffer *buf, enum vb2_buffer_state state)
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300187{
Junghak Sung2d700712015-09-22 10:30:30 -0300188 vb2_buffer_done(&buf->vb2_buf, state);
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300189}
190
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300191/**
192 * v4l2_m2m_reqbufs() - multi-queue-aware REQBUFS multiplexer
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300193 *
194 * @file: pointer to struct &file
195 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
196 * @reqbufs: pointer to struct &v4l2_requestbuffers
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300197 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300198int v4l2_m2m_reqbufs(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
199 struct v4l2_requestbuffers *reqbufs);
200
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300201/**
202 * v4l2_m2m_querybuf() - multi-queue-aware QUERYBUF multiplexer
203 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300204 * @file: pointer to struct &file
205 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
206 * @buf: pointer to struct &v4l2_buffer
207 *
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300208 * See v4l2_m2m_mmap() documentation for details.
209 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300210int v4l2_m2m_querybuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
211 struct v4l2_buffer *buf);
212
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300213/**
214 * v4l2_m2m_qbuf() - enqueue a source or destination buffer, depending on
215 * the type
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300216 *
217 * @file: pointer to struct &file
218 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
219 * @buf: pointer to struct &v4l2_buffer
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300220 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300221int v4l2_m2m_qbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
222 struct v4l2_buffer *buf);
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300223
224/**
225 * v4l2_m2m_dqbuf() - dequeue a source or destination buffer, depending on
226 * the type
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300227 *
228 * @file: pointer to struct &file
229 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
230 * @buf: pointer to struct &v4l2_buffer
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300231 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300232int v4l2_m2m_dqbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
233 struct v4l2_buffer *buf);
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300234
235/**
236 * v4l2_m2m_prepare_buf() - prepare a source or destination buffer, depending on
237 * the type
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300238 *
239 * @file: pointer to struct &file
240 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
241 * @buf: pointer to struct &v4l2_buffer
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300242 */
Hans Verkuile68cf472015-06-05 11:28:50 -0300243int v4l2_m2m_prepare_buf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
244 struct v4l2_buffer *buf);
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300245
246/**
247 * v4l2_m2m_create_bufs() - create a source or destination buffer, depending
248 * on the type
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300249 *
250 * @file: pointer to struct &file
251 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
252 * @create: pointer to struct &v4l2_create_buffers
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300253 */
Philipp Zabel8b94ca62013-05-21 04:16:28 -0300254int v4l2_m2m_create_bufs(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
255 struct v4l2_create_buffers *create);
Pawel Osciak7f986392010-04-23 05:38:37 -0300256
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300257/**
258 * v4l2_m2m_expbuf() - export a source or destination buffer, depending on
259 * the type
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300260 *
261 * @file: pointer to struct &file
262 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
263 * @eb: pointer to struct &v4l2_exportbuffer
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300264 */
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -0300265int v4l2_m2m_expbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
266 struct v4l2_exportbuffer *eb);
267
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300268/**
269 * v4l2_m2m_streamon() - turn on streaming for a video queue
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300270 *
271 * @file: pointer to struct &file
272 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
273 * @type: type of the V4L2 buffer, as defined by enum &v4l2_buf_type
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300274 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300275int v4l2_m2m_streamon(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
276 enum v4l2_buf_type type);
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300277
278/**
279 * v4l2_m2m_streamoff() - turn off streaming for a video queue
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300280 *
281 * @file: pointer to struct &file
282 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
283 * @type: type of the V4L2 buffer, as defined by enum &v4l2_buf_type
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300284 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300285int v4l2_m2m_streamoff(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
286 enum v4l2_buf_type type);
287
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300288/**
289 * v4l2_m2m_poll() - poll replacement, for destination buffers only
290 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300291 * @file: pointer to struct &file
292 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
293 * @wait: pointer to struct &poll_table_struct
294 *
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300295 * Call from the driver's poll() function. Will poll both queues. If a buffer
296 * is available to dequeue (with dqbuf) from the source queue, this will
297 * indicate that a non-blocking write can be performed, while read will be
298 * returned in case of the destination queue.
299 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300300unsigned int v4l2_m2m_poll(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
301 struct poll_table_struct *wait);
302
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300303/**
304 * v4l2_m2m_mmap() - source and destination queues-aware mmap multiplexer
305 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300306 * @file: pointer to struct &file
307 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
308 * @vma: pointer to struct &vm_area_struct
309 *
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300310 * Call from driver's mmap() function. Will handle mmap() for both queues
311 * seamlessly for videobuffer, which will receive normal per-queue offsets and
312 * proper videobuf queue pointers. The differentiation is made outside videobuf
313 * by adding a predefined offset to buffers from one of the queues and
314 * subtracting it before passing it back to videobuf. Only drivers (and
315 * thus applications) receive modified offsets.
316 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300317int v4l2_m2m_mmap(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
318 struct vm_area_struct *vma);
319
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300320/**
321 * v4l2_m2m_init() - initialize per-driver m2m data
322 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300323 * @m2m_ops: pointer to struct v4l2_m2m_ops
324 *
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -0300325 * Usually called from driver's ``probe()`` function.
326 *
327 * Return: returns an opaque pointer to the internal data to handle M2M context
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300328 */
Guennadi Liakhovetskib1252eb2012-09-11 06:32:17 -0300329struct v4l2_m2m_dev *v4l2_m2m_init(const struct v4l2_m2m_ops *m2m_ops);
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300330
331/**
332 * v4l2_m2m_release() - cleans up and frees a m2m_dev structure
333 *
Mauro Carvalho Chehab9f8d3a22016-09-08 17:20:44 -0300334 * @m2m_dev: opaque pointer to the internal data to handle M2M context
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300335 *
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -0300336 * Usually called from driver's ``remove()`` function.
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300337 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300338void v4l2_m2m_release(struct v4l2_m2m_dev *m2m_dev);
339
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300340/**
341 * v4l2_m2m_ctx_init() - allocate and initialize a m2m context
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300342 *
Mauro Carvalho Chehab9f8d3a22016-09-08 17:20:44 -0300343 * @m2m_dev: opaque pointer to the internal data to handle M2M context
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300344 * @drv_priv: driver's instance private data
345 * @queue_init: a callback for queue type-specific initialization function
346 * to be used for initializing videobuf_queues
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300347 *
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -0300348 * Usually called from driver's ``open()`` function.
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300349 */
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300350struct v4l2_m2m_ctx *v4l2_m2m_ctx_init(struct v4l2_m2m_dev *m2m_dev,
351 void *drv_priv,
352 int (*queue_init)(void *priv, struct vb2_queue *src_vq, struct vb2_queue *dst_vq));
353
Philipp Zabel33bdd5a2013-06-03 04:23:48 -0300354static inline void v4l2_m2m_set_src_buffered(struct v4l2_m2m_ctx *m2m_ctx,
355 bool buffered)
356{
357 m2m_ctx->out_q_ctx.buffered = buffered;
358}
359
360static inline void v4l2_m2m_set_dst_buffered(struct v4l2_m2m_ctx *m2m_ctx,
361 bool buffered)
362{
363 m2m_ctx->cap_q_ctx.buffered = buffered;
364}
365
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300366/**
367 * v4l2_m2m_ctx_release() - release m2m context
368 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300369 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
370 *
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300371 * Usually called from driver's release() function.
372 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300373void v4l2_m2m_ctx_release(struct v4l2_m2m_ctx *m2m_ctx);
374
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300375/**
376 * v4l2_m2m_buf_queue() - add a buffer to the proper ready buffers list.
377 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300378 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
379 * @vbuf: pointer to struct &vb2_v4l2_buffer
380 *
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -0300381 * Call from videobuf_queue_ops->ops->buf_queue, videobuf_queue_ops callback.
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300382 */
Junghak Sung2d700712015-09-22 10:30:30 -0300383void v4l2_m2m_buf_queue(struct v4l2_m2m_ctx *m2m_ctx,
384 struct vb2_v4l2_buffer *vbuf);
Pawel Osciak7f986392010-04-23 05:38:37 -0300385
386/**
387 * v4l2_m2m_num_src_bufs_ready() - return the number of source buffers ready for
388 * use
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300389 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300390 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300391 */
392static inline
393unsigned int v4l2_m2m_num_src_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx)
394{
Sascha Hauer961ae442012-08-31 09:18:04 -0300395 return m2m_ctx->out_q_ctx.num_rdy;
Pawel Osciak7f986392010-04-23 05:38:37 -0300396}
397
398/**
Mauro Carvalho Chehabe383ce02016-09-22 07:59:03 -0300399 * v4l2_m2m_num_dst_bufs_ready() - return the number of destination buffers
Pawel Osciak7f986392010-04-23 05:38:37 -0300400 * ready for use
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300401 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300402 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300403 */
404static inline
405unsigned int v4l2_m2m_num_dst_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx)
406{
Sascha Hauer961ae442012-08-31 09:18:04 -0300407 return m2m_ctx->cap_q_ctx.num_rdy;
Pawel Osciak7f986392010-04-23 05:38:37 -0300408}
409
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300410/**
411 * v4l2_m2m_next_buf() - return next buffer from the list of ready buffers
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300412 *
413 * @q_ctx: pointer to struct @v4l2_m2m_queue_ctx
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300414 */
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300415void *v4l2_m2m_next_buf(struct v4l2_m2m_queue_ctx *q_ctx);
Pawel Osciak7f986392010-04-23 05:38:37 -0300416
417/**
418 * v4l2_m2m_next_src_buf() - return next source buffer from the list of ready
419 * buffers
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300420 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300421 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300422 */
423static inline void *v4l2_m2m_next_src_buf(struct v4l2_m2m_ctx *m2m_ctx)
424{
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300425 return v4l2_m2m_next_buf(&m2m_ctx->out_q_ctx);
Pawel Osciak7f986392010-04-23 05:38:37 -0300426}
427
428/**
429 * v4l2_m2m_next_dst_buf() - return next destination buffer from the list of
430 * ready buffers
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300431 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300432 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300433 */
434static inline void *v4l2_m2m_next_dst_buf(struct v4l2_m2m_ctx *m2m_ctx)
435{
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300436 return v4l2_m2m_next_buf(&m2m_ctx->cap_q_ctx);
Pawel Osciak7f986392010-04-23 05:38:37 -0300437}
438
439/**
Stanimir Varbanovd4987562017-06-15 13:31:42 -0300440 * v4l2_m2m_for_each_dst_buf() - iterate over a list of destination ready
441 * buffers
442 *
443 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
444 * @b: current buffer of type struct v4l2_m2m_buffer
445 */
446#define v4l2_m2m_for_each_dst_buf(m2m_ctx, b) \
447 list_for_each_entry(b, &m2m_ctx->cap_q_ctx.rdy_queue, list)
448
449/**
450 * v4l2_m2m_for_each_src_buf() - iterate over a list of source ready buffers
451 *
452 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
453 * @b: current buffer of type struct v4l2_m2m_buffer
454 */
455#define v4l2_m2m_for_each_src_buf(m2m_ctx, b) \
456 list_for_each_entry(b, &m2m_ctx->out_q_ctx.rdy_queue, list)
457
458/**
459 * v4l2_m2m_for_each_dst_buf_safe() - iterate over a list of destination ready
460 * buffers safely
461 *
462 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
463 * @b: current buffer of type struct v4l2_m2m_buffer
464 * @n: used as temporary storage
465 */
466#define v4l2_m2m_for_each_dst_buf_safe(m2m_ctx, b, n) \
467 list_for_each_entry_safe(b, n, &m2m_ctx->cap_q_ctx.rdy_queue, list)
468
469/**
470 * v4l2_m2m_for_each_src_buf_safe() - iterate over a list of source ready
471 * buffers safely
472 *
473 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
474 * @b: current buffer of type struct v4l2_m2m_buffer
475 * @n: used as temporary storage
476 */
477#define v4l2_m2m_for_each_src_buf_safe(m2m_ctx, b, n) \
478 list_for_each_entry_safe(b, n, &m2m_ctx->out_q_ctx.rdy_queue, list)
479
480/**
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300481 * v4l2_m2m_get_src_vq() - return vb2_queue for source buffers
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300482 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300483 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300484 */
485static inline
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300486struct vb2_queue *v4l2_m2m_get_src_vq(struct v4l2_m2m_ctx *m2m_ctx)
Pawel Osciak7f986392010-04-23 05:38:37 -0300487{
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300488 return &m2m_ctx->out_q_ctx.q;
Pawel Osciak7f986392010-04-23 05:38:37 -0300489}
490
491/**
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300492 * v4l2_m2m_get_dst_vq() - return vb2_queue for destination buffers
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300493 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300494 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300495 */
496static inline
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300497struct vb2_queue *v4l2_m2m_get_dst_vq(struct v4l2_m2m_ctx *m2m_ctx)
Pawel Osciak7f986392010-04-23 05:38:37 -0300498{
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300499 return &m2m_ctx->cap_q_ctx.q;
Pawel Osciak7f986392010-04-23 05:38:37 -0300500}
501
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300502/**
503 * v4l2_m2m_buf_remove() - take off a buffer from the list of ready buffers and
504 * return it
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300505 *
506 * @q_ctx: pointer to struct @v4l2_m2m_queue_ctx
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300507 */
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300508void *v4l2_m2m_buf_remove(struct v4l2_m2m_queue_ctx *q_ctx);
Pawel Osciak7f986392010-04-23 05:38:37 -0300509
510/**
511 * v4l2_m2m_src_buf_remove() - take off a source buffer from the list of ready
512 * buffers and return it
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300513 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300514 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300515 */
516static inline void *v4l2_m2m_src_buf_remove(struct v4l2_m2m_ctx *m2m_ctx)
517{
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300518 return v4l2_m2m_buf_remove(&m2m_ctx->out_q_ctx);
Pawel Osciak7f986392010-04-23 05:38:37 -0300519}
520
521/**
522 * v4l2_m2m_dst_buf_remove() - take off a destination buffer from the list of
523 * ready buffers and return it
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300524 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300525 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300526 */
527static inline void *v4l2_m2m_dst_buf_remove(struct v4l2_m2m_ctx *m2m_ctx)
528{
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300529 return v4l2_m2m_buf_remove(&m2m_ctx->cap_q_ctx);
Pawel Osciak7f986392010-04-23 05:38:37 -0300530}
531
Stanimir Varbanovd4987562017-06-15 13:31:42 -0300532/**
533 * v4l2_m2m_buf_remove_by_buf() - take off exact buffer from the list of ready
534 * buffers
535 *
536 * @q_ctx: pointer to struct @v4l2_m2m_queue_ctx
537 * @vbuf: the buffer to be removed
538 */
539void v4l2_m2m_buf_remove_by_buf(struct v4l2_m2m_queue_ctx *q_ctx,
540 struct vb2_v4l2_buffer *vbuf);
541
542/**
543 * v4l2_m2m_src_buf_remove_by_buf() - take off exact source buffer from the list
544 * of ready buffers
545 *
546 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
547 * @vbuf: the buffer to be removed
548 */
549static inline void v4l2_m2m_src_buf_remove_by_buf(struct v4l2_m2m_ctx *m2m_ctx,
550 struct vb2_v4l2_buffer *vbuf)
551{
552 v4l2_m2m_buf_remove_by_buf(&m2m_ctx->out_q_ctx, vbuf);
553}
554
555/**
556 * v4l2_m2m_dst_buf_remove_by_buf() - take off exact destination buffer from the
557 * list of ready buffers
558 *
559 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
560 * @vbuf: the buffer to be removed
561 */
562static inline void v4l2_m2m_dst_buf_remove_by_buf(struct v4l2_m2m_ctx *m2m_ctx,
563 struct vb2_v4l2_buffer *vbuf)
564{
565 v4l2_m2m_buf_remove_by_buf(&m2m_ctx->cap_q_ctx, vbuf);
566}
567
568struct vb2_v4l2_buffer *
569v4l2_m2m_buf_remove_by_idx(struct v4l2_m2m_queue_ctx *q_ctx, unsigned int idx);
570
571static inline struct vb2_v4l2_buffer *
572v4l2_m2m_src_buf_remove_by_idx(struct v4l2_m2m_ctx *m2m_ctx, unsigned int idx)
573{
574 return v4l2_m2m_buf_remove_by_idx(&m2m_ctx->out_q_ctx, idx);
575}
576
577static inline struct vb2_v4l2_buffer *
578v4l2_m2m_dst_buf_remove_by_idx(struct v4l2_m2m_ctx *m2m_ctx, unsigned int idx)
579{
580 return v4l2_m2m_buf_remove_by_idx(&m2m_ctx->cap_q_ctx, idx);
581}
582
Sylwester Nawrocki8e6e8f92013-09-14 18:39:04 -0300583/* v4l2 ioctl helpers */
584
585int v4l2_m2m_ioctl_reqbufs(struct file *file, void *priv,
586 struct v4l2_requestbuffers *rb);
587int v4l2_m2m_ioctl_create_bufs(struct file *file, void *fh,
588 struct v4l2_create_buffers *create);
589int v4l2_m2m_ioctl_querybuf(struct file *file, void *fh,
590 struct v4l2_buffer *buf);
591int v4l2_m2m_ioctl_expbuf(struct file *file, void *fh,
592 struct v4l2_exportbuffer *eb);
593int v4l2_m2m_ioctl_qbuf(struct file *file, void *fh,
594 struct v4l2_buffer *buf);
595int v4l2_m2m_ioctl_dqbuf(struct file *file, void *fh,
596 struct v4l2_buffer *buf);
Hans Verkuile68cf472015-06-05 11:28:50 -0300597int v4l2_m2m_ioctl_prepare_buf(struct file *file, void *fh,
598 struct v4l2_buffer *buf);
Sylwester Nawrocki8e6e8f92013-09-14 18:39:04 -0300599int v4l2_m2m_ioctl_streamon(struct file *file, void *fh,
600 enum v4l2_buf_type type);
601int v4l2_m2m_ioctl_streamoff(struct file *file, void *fh,
602 enum v4l2_buf_type type);
603int v4l2_m2m_fop_mmap(struct file *file, struct vm_area_struct *vma);
604unsigned int v4l2_m2m_fop_poll(struct file *file, poll_table *wait);
605
Pawel Osciak7f986392010-04-23 05:38:37 -0300606#endif /* _MEDIA_V4L2_MEM2MEM_H */
607