blob: 5467264771ec136f1b2f9b4ee538f847221f90d9 [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.
Ezequiel Garcia5525b832018-06-18 00:38:52 -040035 * @job_abort: optional. Informs the driver that it has to abort the currently
Pawel Osciak7f986392010-04-23 05:38:37 -030036 * 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.
43 */
44struct v4l2_m2m_ops {
45 void (*device_run)(void *priv);
46 int (*job_ready)(void *priv);
47 void (*job_abort)(void *priv);
48};
49
Ezequiel Garciabe2fff62018-07-02 11:36:05 -040050struct video_device;
Pawel Osciak7f986392010-04-23 05:38:37 -030051struct v4l2_m2m_dev;
52
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -030053/**
54 * struct v4l2_m2m_queue_ctx - represents a queue for buffers ready to be
55 * processed
56 *
57 * @q: pointer to struct &vb2_queue
58 * @rdy_queue: List of V4L2 mem-to-mem queues
59 * @rdy_spinlock: spin lock to protect the struct usage
60 * @num_rdy: number of buffers ready to be processed
61 * @buffered: is the queue buffered?
62 *
63 * Queue for buffers ready to be processed as soon as this
64 * instance receives access to the device.
65 */
66
Pawel Osciak7f986392010-04-23 05:38:37 -030067struct v4l2_m2m_queue_ctx {
Marek Szyprowski908a0d72011-01-12 06:50:24 -030068 struct vb2_queue q;
Pawel Osciak7f986392010-04-23 05:38:37 -030069
Pawel Osciak7f986392010-04-23 05:38:37 -030070 struct list_head rdy_queue;
Marek Szyprowski908a0d72011-01-12 06:50:24 -030071 spinlock_t rdy_spinlock;
Pawel Osciak7f986392010-04-23 05:38:37 -030072 u8 num_rdy;
Philipp Zabel33bdd5a2013-06-03 04:23:48 -030073 bool buffered;
Pawel Osciak7f986392010-04-23 05:38:37 -030074};
75
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -030076/**
77 * struct v4l2_m2m_ctx - Memory to memory context structure
78 *
79 * @q_lock: struct &mutex lock
Mauro Carvalho Chehab9f8d3a22016-09-08 17:20:44 -030080 * @m2m_dev: opaque pointer to the internal data to handle M2M context
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -030081 * @cap_q_ctx: Capture (output to memory) queue context
82 * @out_q_ctx: Output (input from memory) queue context
83 * @queue: List of memory to memory contexts
84 * @job_flags: Job queue flags, used internally by v4l2-mem2mem.c:
85 * %TRANS_QUEUED, %TRANS_RUNNING and %TRANS_ABORT.
86 * @finished: Wait queue used to signalize when a job queue finished.
87 * @priv: Instance private data
Sakari Ailus708f48e2016-10-18 11:15:32 -020088 *
89 * The memory to memory context is specific to a file handle, NOT to e.g.
90 * a device.
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -030091 */
Pawel Osciak7f986392010-04-23 05:38:37 -030092struct v4l2_m2m_ctx {
Sylwester Nawrocki8e6e8f92013-09-14 18:39:04 -030093 /* optional cap/out vb2 queues lock */
94 struct mutex *q_lock;
95
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -030096 /* internal use only */
Pawel Osciak7f986392010-04-23 05:38:37 -030097 struct v4l2_m2m_dev *m2m_dev;
98
Pawel Osciak7f986392010-04-23 05:38:37 -030099 struct v4l2_m2m_queue_ctx cap_q_ctx;
100
Pawel Osciak7f986392010-04-23 05:38:37 -0300101 struct v4l2_m2m_queue_ctx out_q_ctx;
102
103 /* For device job queue */
104 struct list_head queue;
105 unsigned long job_flags;
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300106 wait_queue_head_t finished;
Pawel Osciak7f986392010-04-23 05:38:37 -0300107
Pawel Osciak7f986392010-04-23 05:38:37 -0300108 void *priv;
109};
110
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -0300111/**
112 * struct v4l2_m2m_buffer - Memory to memory buffer
113 *
114 * @vb: pointer to struct &vb2_v4l2_buffer
115 * @list: list of m2m buffers
116 */
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300117struct v4l2_m2m_buffer {
Junghak Sung2d700712015-09-22 10:30:30 -0300118 struct vb2_v4l2_buffer vb;
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300119 struct list_head list;
120};
121
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300122/**
123 * v4l2_m2m_get_curr_priv() - return driver private data for the currently
124 * running instance or NULL if no instance is running
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300125 *
Mauro Carvalho Chehab9f8d3a22016-09-08 17:20:44 -0300126 * @m2m_dev: opaque pointer to the internal data to handle M2M context
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300127 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300128void *v4l2_m2m_get_curr_priv(struct v4l2_m2m_dev *m2m_dev);
129
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300130/**
131 * v4l2_m2m_get_vq() - return vb2_queue for the given type
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300132 *
133 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
134 * @type: type of the V4L2 buffer, as defined by enum &v4l2_buf_type
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300135 */
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300136struct vb2_queue *v4l2_m2m_get_vq(struct v4l2_m2m_ctx *m2m_ctx,
Pawel Osciak7f986392010-04-23 05:38:37 -0300137 enum v4l2_buf_type type);
138
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300139/**
140 * v4l2_m2m_try_schedule() - check whether an instance is ready to be added to
141 * the pending job queue and add it if so.
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300142 *
143 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300144 *
145 * There are three basic requirements an instance has to meet to be able to run:
146 * 1) at least one source buffer has to be queued,
147 * 2) at least one destination buffer has to be queued,
148 * 3) streaming has to be on.
149 *
150 * If a queue is buffered (for example a decoder hardware ringbuffer that has
151 * to be drained before doing streamoff), allow scheduling without v4l2 buffers
152 * on that queue.
153 *
154 * There may also be additional, custom requirements. In such case the driver
155 * should supply a custom callback (job_ready in v4l2_m2m_ops) that should
156 * return 1 if the instance is ready.
157 * An example of the above could be an instance that requires more than one
158 * src/dst buffer per transaction.
159 */
Michael Olbrich1190a412014-07-22 09:36:04 -0300160void v4l2_m2m_try_schedule(struct v4l2_m2m_ctx *m2m_ctx);
161
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300162/**
163 * v4l2_m2m_job_finish() - inform the framework that a job has been finished
164 * and have it clean up
165 *
Mauro Carvalho Chehab9f8d3a22016-09-08 17:20:44 -0300166 * @m2m_dev: opaque pointer to the internal data to handle M2M context
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300167 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
168 *
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300169 * Called by a driver to yield back the device after it has finished with it.
170 * Should be called as soon as possible after reaching a state which allows
171 * other instances to take control of the device.
172 *
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -0300173 * This function has to be called only after &v4l2_m2m_ops->device_run
174 * callback has been called on the driver. To prevent recursion, it should
175 * not be called directly from the &v4l2_m2m_ops->device_run callback though.
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300176 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300177void v4l2_m2m_job_finish(struct v4l2_m2m_dev *m2m_dev,
178 struct v4l2_m2m_ctx *m2m_ctx);
179
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300180static inline void
Junghak Sung2d700712015-09-22 10:30:30 -0300181v4l2_m2m_buf_done(struct vb2_v4l2_buffer *buf, enum vb2_buffer_state state)
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300182{
Junghak Sung2d700712015-09-22 10:30:30 -0300183 vb2_buffer_done(&buf->vb2_buf, state);
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300184}
185
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300186/**
187 * v4l2_m2m_reqbufs() - multi-queue-aware REQBUFS multiplexer
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300188 *
189 * @file: pointer to struct &file
190 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
191 * @reqbufs: pointer to struct &v4l2_requestbuffers
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300192 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300193int v4l2_m2m_reqbufs(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
194 struct v4l2_requestbuffers *reqbufs);
195
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300196/**
197 * v4l2_m2m_querybuf() - multi-queue-aware QUERYBUF multiplexer
198 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300199 * @file: pointer to struct &file
200 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
201 * @buf: pointer to struct &v4l2_buffer
202 *
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300203 * See v4l2_m2m_mmap() documentation for details.
204 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300205int v4l2_m2m_querybuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
206 struct v4l2_buffer *buf);
207
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300208/**
209 * v4l2_m2m_qbuf() - enqueue a source or destination buffer, depending on
210 * the type
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300211 *
212 * @file: pointer to struct &file
213 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
214 * @buf: pointer to struct &v4l2_buffer
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300215 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300216int v4l2_m2m_qbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
217 struct v4l2_buffer *buf);
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300218
219/**
220 * v4l2_m2m_dqbuf() - dequeue a source or destination buffer, depending on
221 * the type
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300222 *
223 * @file: pointer to struct &file
224 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
225 * @buf: pointer to struct &v4l2_buffer
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300226 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300227int v4l2_m2m_dqbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
228 struct v4l2_buffer *buf);
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300229
230/**
231 * v4l2_m2m_prepare_buf() - prepare a source or destination buffer, depending on
232 * the type
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300233 *
234 * @file: pointer to struct &file
235 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
236 * @buf: pointer to struct &v4l2_buffer
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300237 */
Hans Verkuile68cf472015-06-05 11:28:50 -0300238int v4l2_m2m_prepare_buf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
239 struct v4l2_buffer *buf);
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300240
241/**
242 * v4l2_m2m_create_bufs() - create a source or destination buffer, depending
243 * on the type
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300244 *
245 * @file: pointer to struct &file
246 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
247 * @create: pointer to struct &v4l2_create_buffers
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300248 */
Philipp Zabel8b94ca62013-05-21 04:16:28 -0300249int v4l2_m2m_create_bufs(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
250 struct v4l2_create_buffers *create);
Pawel Osciak7f986392010-04-23 05:38:37 -0300251
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300252/**
253 * v4l2_m2m_expbuf() - export a source or destination buffer, depending on
254 * the type
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300255 *
256 * @file: pointer to struct &file
257 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
258 * @eb: pointer to struct &v4l2_exportbuffer
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300259 */
Tomasz Stanislawski83ae7c52012-06-14 11:32:24 -0300260int v4l2_m2m_expbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
261 struct v4l2_exportbuffer *eb);
262
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300263/**
264 * v4l2_m2m_streamon() - turn on streaming for a video queue
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300265 *
266 * @file: pointer to struct &file
267 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
268 * @type: type of the V4L2 buffer, as defined by enum &v4l2_buf_type
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300269 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300270int v4l2_m2m_streamon(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
271 enum v4l2_buf_type type);
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300272
273/**
274 * v4l2_m2m_streamoff() - turn off streaming for a video queue
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300275 *
276 * @file: pointer to struct &file
277 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
278 * @type: type of the V4L2 buffer, as defined by enum &v4l2_buf_type
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300279 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300280int v4l2_m2m_streamoff(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
281 enum v4l2_buf_type type);
282
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300283/**
284 * v4l2_m2m_poll() - poll replacement, for destination buffers only
285 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300286 * @file: pointer to struct &file
287 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
288 * @wait: pointer to struct &poll_table_struct
289 *
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300290 * Call from the driver's poll() function. Will poll both queues. If a buffer
291 * is available to dequeue (with dqbuf) from the source queue, this will
292 * indicate that a non-blocking write can be performed, while read will be
293 * returned in case of the destination queue.
294 */
Al Viroc23e0cb2017-07-03 03:02:56 -0400295__poll_t v4l2_m2m_poll(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
Pawel Osciak7f986392010-04-23 05:38:37 -0300296 struct poll_table_struct *wait);
297
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300298/**
299 * v4l2_m2m_mmap() - source and destination queues-aware mmap multiplexer
300 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300301 * @file: pointer to struct &file
302 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
303 * @vma: pointer to struct &vm_area_struct
304 *
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300305 * Call from driver's mmap() function. Will handle mmap() for both queues
306 * seamlessly for videobuffer, which will receive normal per-queue offsets and
307 * proper videobuf queue pointers. The differentiation is made outside videobuf
308 * by adding a predefined offset to buffers from one of the queues and
309 * subtracting it before passing it back to videobuf. Only drivers (and
310 * thus applications) receive modified offsets.
311 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300312int v4l2_m2m_mmap(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
313 struct vm_area_struct *vma);
314
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300315/**
316 * v4l2_m2m_init() - initialize per-driver m2m data
317 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300318 * @m2m_ops: pointer to struct v4l2_m2m_ops
319 *
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -0300320 * Usually called from driver's ``probe()`` function.
321 *
322 * Return: returns an opaque pointer to the internal data to handle M2M context
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300323 */
Guennadi Liakhovetskib1252eb2012-09-11 06:32:17 -0300324struct v4l2_m2m_dev *v4l2_m2m_init(const struct v4l2_m2m_ops *m2m_ops);
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300325
Ezequiel Garciabe2fff62018-07-02 11:36:05 -0400326#if defined(CONFIG_MEDIA_CONTROLLER)
327void v4l2_m2m_unregister_media_controller(struct v4l2_m2m_dev *m2m_dev);
328int v4l2_m2m_register_media_controller(struct v4l2_m2m_dev *m2m_dev,
329 struct video_device *vdev, int function);
330#else
331static inline void
332v4l2_m2m_unregister_media_controller(struct v4l2_m2m_dev *m2m_dev)
333{
334}
335
336static inline int
337v4l2_m2m_register_media_controller(struct v4l2_m2m_dev *m2m_dev,
338 struct video_device *vdev, int function)
339{
340 return 0;
341}
342#endif
343
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300344/**
345 * v4l2_m2m_release() - cleans up and frees a m2m_dev structure
346 *
Mauro Carvalho Chehab9f8d3a22016-09-08 17:20:44 -0300347 * @m2m_dev: opaque pointer to the internal data to handle M2M context
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300348 *
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -0300349 * Usually called from driver's ``remove()`` function.
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300350 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300351void v4l2_m2m_release(struct v4l2_m2m_dev *m2m_dev);
352
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300353/**
354 * v4l2_m2m_ctx_init() - allocate and initialize a m2m context
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300355 *
Mauro Carvalho Chehab9f8d3a22016-09-08 17:20:44 -0300356 * @m2m_dev: opaque pointer to the internal data to handle M2M context
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300357 * @drv_priv: driver's instance private data
358 * @queue_init: a callback for queue type-specific initialization function
359 * to be used for initializing videobuf_queues
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300360 *
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -0300361 * Usually called from driver's ``open()`` function.
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300362 */
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300363struct v4l2_m2m_ctx *v4l2_m2m_ctx_init(struct v4l2_m2m_dev *m2m_dev,
364 void *drv_priv,
365 int (*queue_init)(void *priv, struct vb2_queue *src_vq, struct vb2_queue *dst_vq));
366
Philipp Zabel33bdd5a2013-06-03 04:23:48 -0300367static inline void v4l2_m2m_set_src_buffered(struct v4l2_m2m_ctx *m2m_ctx,
368 bool buffered)
369{
370 m2m_ctx->out_q_ctx.buffered = buffered;
371}
372
373static inline void v4l2_m2m_set_dst_buffered(struct v4l2_m2m_ctx *m2m_ctx,
374 bool buffered)
375{
376 m2m_ctx->cap_q_ctx.buffered = buffered;
377}
378
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300379/**
380 * v4l2_m2m_ctx_release() - release m2m context
381 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300382 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
383 *
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300384 * Usually called from driver's release() function.
385 */
Pawel Osciak7f986392010-04-23 05:38:37 -0300386void v4l2_m2m_ctx_release(struct v4l2_m2m_ctx *m2m_ctx);
387
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300388/**
389 * v4l2_m2m_buf_queue() - add a buffer to the proper ready buffers list.
390 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300391 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
392 * @vbuf: pointer to struct &vb2_v4l2_buffer
393 *
Mauro Carvalho Chehab5fa5edb2016-09-08 10:16:36 -0300394 * Call from videobuf_queue_ops->ops->buf_queue, videobuf_queue_ops callback.
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300395 */
Junghak Sung2d700712015-09-22 10:30:30 -0300396void v4l2_m2m_buf_queue(struct v4l2_m2m_ctx *m2m_ctx,
397 struct vb2_v4l2_buffer *vbuf);
Pawel Osciak7f986392010-04-23 05:38:37 -0300398
399/**
400 * v4l2_m2m_num_src_bufs_ready() - return the number of source buffers ready for
401 * use
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300402 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300403 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300404 */
405static inline
406unsigned int v4l2_m2m_num_src_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx)
407{
Sascha Hauer961ae442012-08-31 09:18:04 -0300408 return m2m_ctx->out_q_ctx.num_rdy;
Pawel Osciak7f986392010-04-23 05:38:37 -0300409}
410
411/**
Mauro Carvalho Chehabe383ce02016-09-22 07:59:03 -0300412 * v4l2_m2m_num_dst_bufs_ready() - return the number of destination buffers
Pawel Osciak7f986392010-04-23 05:38:37 -0300413 * ready for use
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300414 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300415 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300416 */
417static inline
418unsigned int v4l2_m2m_num_dst_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx)
419{
Sascha Hauer961ae442012-08-31 09:18:04 -0300420 return m2m_ctx->cap_q_ctx.num_rdy;
Pawel Osciak7f986392010-04-23 05:38:37 -0300421}
422
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300423/**
424 * v4l2_m2m_next_buf() - return next buffer from the list of ready buffers
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300425 *
426 * @q_ctx: pointer to struct @v4l2_m2m_queue_ctx
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300427 */
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300428void *v4l2_m2m_next_buf(struct v4l2_m2m_queue_ctx *q_ctx);
Pawel Osciak7f986392010-04-23 05:38:37 -0300429
430/**
431 * v4l2_m2m_next_src_buf() - return next source buffer from the list of ready
432 * buffers
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300433 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300434 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300435 */
436static inline void *v4l2_m2m_next_src_buf(struct v4l2_m2m_ctx *m2m_ctx)
437{
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300438 return v4l2_m2m_next_buf(&m2m_ctx->out_q_ctx);
Pawel Osciak7f986392010-04-23 05:38:37 -0300439}
440
441/**
442 * v4l2_m2m_next_dst_buf() - return next destination buffer from the list of
443 * ready buffers
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300444 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300445 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300446 */
447static inline void *v4l2_m2m_next_dst_buf(struct v4l2_m2m_ctx *m2m_ctx)
448{
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300449 return v4l2_m2m_next_buf(&m2m_ctx->cap_q_ctx);
Pawel Osciak7f986392010-04-23 05:38:37 -0300450}
451
452/**
Hans Verkuilee1228c2018-06-26 09:26:52 -0400453 * v4l2_m2m_last_buf() - return last buffer from the list of ready buffers
454 *
455 * @q_ctx: pointer to struct @v4l2_m2m_queue_ctx
456 */
457void *v4l2_m2m_last_buf(struct v4l2_m2m_queue_ctx *q_ctx);
458
459/**
460 * v4l2_m2m_last_src_buf() - return last destination buffer from the list of
461 * ready buffers
462 *
463 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
464 */
465static inline void *v4l2_m2m_last_src_buf(struct v4l2_m2m_ctx *m2m_ctx)
466{
467 return v4l2_m2m_last_buf(&m2m_ctx->out_q_ctx);
468}
469
470/**
471 * v4l2_m2m_last_dst_buf() - return last destination buffer from the list of
472 * ready buffers
473 *
474 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
475 */
476static inline void *v4l2_m2m_last_dst_buf(struct v4l2_m2m_ctx *m2m_ctx)
477{
478 return v4l2_m2m_last_buf(&m2m_ctx->cap_q_ctx);
479}
480
481/**
Stanimir Varbanovd4987562017-06-15 13:31:42 -0300482 * v4l2_m2m_for_each_dst_buf() - iterate over a list of destination ready
483 * buffers
484 *
485 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
486 * @b: current buffer of type struct v4l2_m2m_buffer
487 */
488#define v4l2_m2m_for_each_dst_buf(m2m_ctx, b) \
489 list_for_each_entry(b, &m2m_ctx->cap_q_ctx.rdy_queue, list)
490
491/**
492 * v4l2_m2m_for_each_src_buf() - iterate over a list of source ready buffers
493 *
494 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
495 * @b: current buffer of type struct v4l2_m2m_buffer
496 */
497#define v4l2_m2m_for_each_src_buf(m2m_ctx, b) \
498 list_for_each_entry(b, &m2m_ctx->out_q_ctx.rdy_queue, list)
499
500/**
501 * v4l2_m2m_for_each_dst_buf_safe() - iterate over a list of destination ready
502 * buffers safely
503 *
504 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
505 * @b: current buffer of type struct v4l2_m2m_buffer
506 * @n: used as temporary storage
507 */
508#define v4l2_m2m_for_each_dst_buf_safe(m2m_ctx, b, n) \
509 list_for_each_entry_safe(b, n, &m2m_ctx->cap_q_ctx.rdy_queue, list)
510
511/**
512 * v4l2_m2m_for_each_src_buf_safe() - iterate over a list of source ready
513 * buffers safely
514 *
515 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
516 * @b: current buffer of type struct v4l2_m2m_buffer
517 * @n: used as temporary storage
518 */
519#define v4l2_m2m_for_each_src_buf_safe(m2m_ctx, b, n) \
520 list_for_each_entry_safe(b, n, &m2m_ctx->out_q_ctx.rdy_queue, list)
521
522/**
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300523 * v4l2_m2m_get_src_vq() - return vb2_queue for source buffers
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
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300528struct vb2_queue *v4l2_m2m_get_src_vq(struct v4l2_m2m_ctx *m2m_ctx)
Pawel Osciak7f986392010-04-23 05:38:37 -0300529{
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300530 return &m2m_ctx->out_q_ctx.q;
Pawel Osciak7f986392010-04-23 05:38:37 -0300531}
532
533/**
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300534 * v4l2_m2m_get_dst_vq() - return vb2_queue for destination buffers
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300535 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300536 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300537 */
538static inline
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300539struct vb2_queue *v4l2_m2m_get_dst_vq(struct v4l2_m2m_ctx *m2m_ctx)
Pawel Osciak7f986392010-04-23 05:38:37 -0300540{
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300541 return &m2m_ctx->cap_q_ctx.q;
Pawel Osciak7f986392010-04-23 05:38:37 -0300542}
543
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300544/**
545 * v4l2_m2m_buf_remove() - take off a buffer from the list of ready buffers and
546 * return it
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300547 *
548 * @q_ctx: pointer to struct @v4l2_m2m_queue_ctx
Mauro Carvalho Chehab47816462016-09-08 10:16:27 -0300549 */
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300550void *v4l2_m2m_buf_remove(struct v4l2_m2m_queue_ctx *q_ctx);
Pawel Osciak7f986392010-04-23 05:38:37 -0300551
552/**
553 * v4l2_m2m_src_buf_remove() - take off a source buffer from the list of ready
554 * buffers and return it
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300555 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300556 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300557 */
558static inline void *v4l2_m2m_src_buf_remove(struct v4l2_m2m_ctx *m2m_ctx)
559{
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300560 return v4l2_m2m_buf_remove(&m2m_ctx->out_q_ctx);
Pawel Osciak7f986392010-04-23 05:38:37 -0300561}
562
563/**
564 * v4l2_m2m_dst_buf_remove() - take off a destination buffer from the list of
565 * ready buffers and return it
Mauro Carvalho Chehab62c0d012015-08-22 05:34:40 -0300566 *
Mauro Carvalho Chehabdcbd8732016-09-08 10:39:58 -0300567 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
Pawel Osciak7f986392010-04-23 05:38:37 -0300568 */
569static inline void *v4l2_m2m_dst_buf_remove(struct v4l2_m2m_ctx *m2m_ctx)
570{
Marek Szyprowski908a0d72011-01-12 06:50:24 -0300571 return v4l2_m2m_buf_remove(&m2m_ctx->cap_q_ctx);
Pawel Osciak7f986392010-04-23 05:38:37 -0300572}
573
Stanimir Varbanovd4987562017-06-15 13:31:42 -0300574/**
575 * v4l2_m2m_buf_remove_by_buf() - take off exact buffer from the list of ready
576 * buffers
577 *
578 * @q_ctx: pointer to struct @v4l2_m2m_queue_ctx
579 * @vbuf: the buffer to be removed
580 */
581void v4l2_m2m_buf_remove_by_buf(struct v4l2_m2m_queue_ctx *q_ctx,
582 struct vb2_v4l2_buffer *vbuf);
583
584/**
585 * v4l2_m2m_src_buf_remove_by_buf() - take off exact source buffer from the list
586 * of ready buffers
587 *
588 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
589 * @vbuf: the buffer to be removed
590 */
591static inline void v4l2_m2m_src_buf_remove_by_buf(struct v4l2_m2m_ctx *m2m_ctx,
592 struct vb2_v4l2_buffer *vbuf)
593{
594 v4l2_m2m_buf_remove_by_buf(&m2m_ctx->out_q_ctx, vbuf);
595}
596
597/**
598 * v4l2_m2m_dst_buf_remove_by_buf() - take off exact destination buffer from the
599 * list of ready buffers
600 *
601 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
602 * @vbuf: the buffer to be removed
603 */
604static inline void v4l2_m2m_dst_buf_remove_by_buf(struct v4l2_m2m_ctx *m2m_ctx,
605 struct vb2_v4l2_buffer *vbuf)
606{
607 v4l2_m2m_buf_remove_by_buf(&m2m_ctx->cap_q_ctx, vbuf);
608}
609
610struct vb2_v4l2_buffer *
611v4l2_m2m_buf_remove_by_idx(struct v4l2_m2m_queue_ctx *q_ctx, unsigned int idx);
612
613static inline struct vb2_v4l2_buffer *
614v4l2_m2m_src_buf_remove_by_idx(struct v4l2_m2m_ctx *m2m_ctx, unsigned int idx)
615{
616 return v4l2_m2m_buf_remove_by_idx(&m2m_ctx->out_q_ctx, idx);
617}
618
619static inline struct vb2_v4l2_buffer *
620v4l2_m2m_dst_buf_remove_by_idx(struct v4l2_m2m_ctx *m2m_ctx, unsigned int idx)
621{
622 return v4l2_m2m_buf_remove_by_idx(&m2m_ctx->cap_q_ctx, idx);
623}
624
Hans Verkuil803a7ab2018-05-21 04:54:53 -0400625/* v4l2 request helper */
626
Ezequiel Garciaef86eaf2018-10-18 14:54:29 -0400627void v4l2_m2m_request_queue(struct media_request *req);
Hans Verkuil803a7ab2018-05-21 04:54:53 -0400628
Sylwester Nawrocki8e6e8f92013-09-14 18:39:04 -0300629/* v4l2 ioctl helpers */
630
631int v4l2_m2m_ioctl_reqbufs(struct file *file, void *priv,
632 struct v4l2_requestbuffers *rb);
633int v4l2_m2m_ioctl_create_bufs(struct file *file, void *fh,
634 struct v4l2_create_buffers *create);
635int v4l2_m2m_ioctl_querybuf(struct file *file, void *fh,
636 struct v4l2_buffer *buf);
637int v4l2_m2m_ioctl_expbuf(struct file *file, void *fh,
638 struct v4l2_exportbuffer *eb);
639int v4l2_m2m_ioctl_qbuf(struct file *file, void *fh,
640 struct v4l2_buffer *buf);
641int v4l2_m2m_ioctl_dqbuf(struct file *file, void *fh,
642 struct v4l2_buffer *buf);
Hans Verkuile68cf472015-06-05 11:28:50 -0300643int v4l2_m2m_ioctl_prepare_buf(struct file *file, void *fh,
644 struct v4l2_buffer *buf);
Sylwester Nawrocki8e6e8f92013-09-14 18:39:04 -0300645int v4l2_m2m_ioctl_streamon(struct file *file, void *fh,
646 enum v4l2_buf_type type);
647int v4l2_m2m_ioctl_streamoff(struct file *file, void *fh,
648 enum v4l2_buf_type type);
649int v4l2_m2m_fop_mmap(struct file *file, struct vm_area_struct *vma);
Al Viroc23e0cb2017-07-03 03:02:56 -0400650__poll_t v4l2_m2m_fop_poll(struct file *file, poll_table *wait);
Sylwester Nawrocki8e6e8f92013-09-14 18:39:04 -0300651
Pawel Osciak7f986392010-04-23 05:38:37 -0300652#endif /* _MEDIA_V4L2_MEM2MEM_H */
653