Loading...
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * Memory-to-memory device framework for Video for Linux 2.
4 *
5 * Helper functions for devices that use memory buffers for both source
6 * and destination.
7 *
8 * Copyright (c) 2009 Samsung Electronics Co., Ltd.
9 * Pawel Osciak, <pawel@osciak.com>
10 * Marek Szyprowski, <m.szyprowski@samsung.com>
11 */
12
13#ifndef _MEDIA_V4L2_MEM2MEM_H
14#define _MEDIA_V4L2_MEM2MEM_H
15
16#include <media/videobuf2-v4l2.h>
17
18/**
19 * struct v4l2_m2m_ops - mem-to-mem device driver callbacks
20 * @device_run: required. Begin the actual job (transaction) inside this
21 * callback.
22 * The job does NOT have to end before this callback returns
23 * (and it will be the usual case). When the job finishes,
24 * v4l2_m2m_job_finish() or v4l2_m2m_buf_done_and_job_finish()
25 * has to be called.
26 * @job_ready: optional. Should return 0 if the driver does not have a job
27 * fully prepared to run yet (i.e. it will not be able to finish a
28 * transaction without sleeping). If not provided, it will be
29 * assumed that one source and one destination buffer are all
30 * that is required for the driver to perform one full transaction.
31 * This method may not sleep.
32 * @job_abort: optional. Informs the driver that it has to abort the currently
33 * running transaction as soon as possible (i.e. as soon as it can
34 * stop the device safely; e.g. in the next interrupt handler),
35 * even if the transaction would not have been finished by then.
36 * After the driver performs the necessary steps, it has to call
37 * v4l2_m2m_job_finish() or v4l2_m2m_buf_done_and_job_finish() as
38 * if the transaction ended normally.
39 * This function does not have to (and will usually not) wait
40 * until the device enters a state when it can be stopped.
41 */
42struct v4l2_m2m_ops {
43 void (*device_run)(void *priv);
44 int (*job_ready)(void *priv);
45 void (*job_abort)(void *priv);
46};
47
48struct video_device;
49struct v4l2_m2m_dev;
50
51/**
52 * struct v4l2_m2m_queue_ctx - represents a queue for buffers ready to be
53 * processed
54 *
55 * @q: pointer to struct &vb2_queue
56 * @rdy_queue: List of V4L2 mem-to-mem queues
57 * @rdy_spinlock: spin lock to protect the struct usage
58 * @num_rdy: number of buffers ready to be processed
59 * @buffered: is the queue buffered?
60 *
61 * Queue for buffers ready to be processed as soon as this
62 * instance receives access to the device.
63 */
64
65struct v4l2_m2m_queue_ctx {
66 struct vb2_queue q;
67
68 struct list_head rdy_queue;
69 spinlock_t rdy_spinlock;
70 u8 num_rdy;
71 bool buffered;
72};
73
74/**
75 * struct v4l2_m2m_ctx - Memory to memory context structure
76 *
77 * @q_lock: struct &mutex lock
78 * @new_frame: valid in the device_run callback: if true, then this
79 * starts a new frame; if false, then this is a new slice
80 * for an existing frame. This is always true unless
81 * V4L2_BUF_CAP_SUPPORTS_M2M_HOLD_CAPTURE_BUF is set, which
82 * indicates slicing support.
83 * @is_draining: indicates device is in draining phase
84 * @last_src_buf: indicate the last source buffer for draining
85 * @next_buf_last: next capture queud buffer will be tagged as last
86 * @has_stopped: indicate the device has been stopped
87 * @ignore_cap_streaming: If true, job_ready can be called even if the CAPTURE
88 * queue is not streaming. This allows firmware to
89 * analyze the bitstream header which arrives on the
90 * OUTPUT queue. The driver must implement the job_ready
91 * callback correctly to make sure that the requirements
92 * for actual decoding are met.
93 * @m2m_dev: opaque pointer to the internal data to handle M2M context
94 * @cap_q_ctx: Capture (output to memory) queue context
95 * @out_q_ctx: Output (input from memory) queue context
96 * @queue: List of memory to memory contexts
97 * @job_flags: Job queue flags, used internally by v4l2-mem2mem.c:
98 * %TRANS_QUEUED, %TRANS_RUNNING and %TRANS_ABORT.
99 * @finished: Wait queue used to signalize when a job queue finished.
100 * @priv: Instance private data
101 *
102 * The memory to memory context is specific to a file handle, NOT to e.g.
103 * a device.
104 */
105struct v4l2_m2m_ctx {
106 /* optional cap/out vb2 queues lock */
107 struct mutex *q_lock;
108
109 bool new_frame;
110
111 bool is_draining;
112 struct vb2_v4l2_buffer *last_src_buf;
113 bool next_buf_last;
114 bool has_stopped;
115 bool ignore_cap_streaming;
116
117 /* internal use only */
118 struct v4l2_m2m_dev *m2m_dev;
119
120 struct v4l2_m2m_queue_ctx cap_q_ctx;
121
122 struct v4l2_m2m_queue_ctx out_q_ctx;
123
124 /* For device job queue */
125 struct list_head queue;
126 unsigned long job_flags;
127 wait_queue_head_t finished;
128
129 void *priv;
130};
131
132/**
133 * struct v4l2_m2m_buffer - Memory to memory buffer
134 *
135 * @vb: pointer to struct &vb2_v4l2_buffer
136 * @list: list of m2m buffers
137 */
138struct v4l2_m2m_buffer {
139 struct vb2_v4l2_buffer vb;
140 struct list_head list;
141};
142
143/**
144 * v4l2_m2m_get_curr_priv() - return driver private data for the currently
145 * running instance or NULL if no instance is running
146 *
147 * @m2m_dev: opaque pointer to the internal data to handle M2M context
148 */
149void *v4l2_m2m_get_curr_priv(struct v4l2_m2m_dev *m2m_dev);
150
151/**
152 * v4l2_m2m_get_vq() - return vb2_queue for the given type
153 *
154 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
155 * @type: type of the V4L2 buffer, as defined by enum &v4l2_buf_type
156 */
157struct vb2_queue *v4l2_m2m_get_vq(struct v4l2_m2m_ctx *m2m_ctx,
158 enum v4l2_buf_type type);
159
160/**
161 * v4l2_m2m_try_schedule() - check whether an instance is ready to be added to
162 * the pending job queue and add it if so.
163 *
164 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
165 *
166 * There are three basic requirements an instance has to meet to be able to run:
167 * 1) at least one source buffer has to be queued,
168 * 2) at least one destination buffer has to be queued,
169 * 3) streaming has to be on.
170 *
171 * If a queue is buffered (for example a decoder hardware ringbuffer that has
172 * to be drained before doing streamoff), allow scheduling without v4l2 buffers
173 * on that queue.
174 *
175 * There may also be additional, custom requirements. In such case the driver
176 * should supply a custom callback (job_ready in v4l2_m2m_ops) that should
177 * return 1 if the instance is ready.
178 * An example of the above could be an instance that requires more than one
179 * src/dst buffer per transaction.
180 */
181void v4l2_m2m_try_schedule(struct v4l2_m2m_ctx *m2m_ctx);
182
183/**
184 * v4l2_m2m_job_finish() - inform the framework that a job has been finished
185 * and have it clean up
186 *
187 * @m2m_dev: opaque pointer to the internal data to handle M2M context
188 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
189 *
190 * Called by a driver to yield back the device after it has finished with it.
191 * Should be called as soon as possible after reaching a state which allows
192 * other instances to take control of the device.
193 *
194 * This function has to be called only after &v4l2_m2m_ops->device_run
195 * callback has been called on the driver. To prevent recursion, it should
196 * not be called directly from the &v4l2_m2m_ops->device_run callback though.
197 */
198void v4l2_m2m_job_finish(struct v4l2_m2m_dev *m2m_dev,
199 struct v4l2_m2m_ctx *m2m_ctx);
200
201/**
202 * v4l2_m2m_buf_done_and_job_finish() - return source/destination buffers with
203 * state and inform the framework that a job has been finished and have it
204 * clean up
205 *
206 * @m2m_dev: opaque pointer to the internal data to handle M2M context
207 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
208 * @state: vb2 buffer state passed to v4l2_m2m_buf_done().
209 *
210 * Drivers that set V4L2_BUF_CAP_SUPPORTS_M2M_HOLD_CAPTURE_BUF must use this
211 * function instead of job_finish() to take held buffers into account. It is
212 * optional for other drivers.
213 *
214 * This function removes the source buffer from the ready list and returns
215 * it with the given state. The same is done for the destination buffer, unless
216 * it is marked 'held'. In that case the buffer is kept on the ready list.
217 *
218 * After that the job is finished (see job_finish()).
219 *
220 * This allows for multiple output buffers to be used to fill in a single
221 * capture buffer. This is typically used by stateless decoders where
222 * multiple e.g. H.264 slices contribute to a single decoded frame.
223 */
224void v4l2_m2m_buf_done_and_job_finish(struct v4l2_m2m_dev *m2m_dev,
225 struct v4l2_m2m_ctx *m2m_ctx,
226 enum vb2_buffer_state state);
227
228static inline void
229v4l2_m2m_buf_done(struct vb2_v4l2_buffer *buf, enum vb2_buffer_state state)
230{
231 vb2_buffer_done(&buf->vb2_buf, state);
232}
233
234/**
235 * v4l2_m2m_clear_state() - clear encoding/decoding state
236 *
237 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
238 */
239static inline void
240v4l2_m2m_clear_state(struct v4l2_m2m_ctx *m2m_ctx)
241{
242 m2m_ctx->next_buf_last = false;
243 m2m_ctx->is_draining = false;
244 m2m_ctx->has_stopped = false;
245}
246
247/**
248 * v4l2_m2m_mark_stopped() - set current encoding/decoding state as stopped
249 *
250 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
251 */
252static inline void
253v4l2_m2m_mark_stopped(struct v4l2_m2m_ctx *m2m_ctx)
254{
255 m2m_ctx->next_buf_last = false;
256 m2m_ctx->is_draining = false;
257 m2m_ctx->has_stopped = true;
258}
259
260/**
261 * v4l2_m2m_dst_buf_is_last() - return the current encoding/decoding session
262 * draining management state of next queued capture buffer
263 *
264 * This last capture buffer should be tagged with V4L2_BUF_FLAG_LAST to notify
265 * the end of the capture session.
266 *
267 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
268 */
269static inline bool
270v4l2_m2m_dst_buf_is_last(struct v4l2_m2m_ctx *m2m_ctx)
271{
272 return m2m_ctx->is_draining && m2m_ctx->next_buf_last;
273}
274
275/**
276 * v4l2_m2m_has_stopped() - return the current encoding/decoding session
277 * stopped state
278 *
279 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
280 */
281static inline bool
282v4l2_m2m_has_stopped(struct v4l2_m2m_ctx *m2m_ctx)
283{
284 return m2m_ctx->has_stopped;
285}
286
287/**
288 * v4l2_m2m_is_last_draining_src_buf() - return the output buffer draining
289 * state in the current encoding/decoding session
290 *
291 * This will identify the last output buffer queued before a session stop
292 * was required, leading to an actual encoding/decoding session stop state
293 * in the encoding/decoding process after being processed.
294 *
295 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
296 * @vbuf: pointer to struct &v4l2_buffer
297 */
298static inline bool
299v4l2_m2m_is_last_draining_src_buf(struct v4l2_m2m_ctx *m2m_ctx,
300 struct vb2_v4l2_buffer *vbuf)
301{
302 return m2m_ctx->is_draining && vbuf == m2m_ctx->last_src_buf;
303}
304
305/**
306 * v4l2_m2m_last_buffer_done() - marks the buffer with LAST flag and DONE
307 *
308 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
309 * @vbuf: pointer to struct &v4l2_buffer
310 */
311void v4l2_m2m_last_buffer_done(struct v4l2_m2m_ctx *m2m_ctx,
312 struct vb2_v4l2_buffer *vbuf);
313
314/**
315 * v4l2_m2m_suspend() - stop new jobs from being run and wait for current job
316 * to finish
317 *
318 * @m2m_dev: opaque pointer to the internal data to handle M2M context
319 *
320 * Called by a driver in the suspend hook. Stop new jobs from being run, and
321 * wait for current running job to finish.
322 */
323void v4l2_m2m_suspend(struct v4l2_m2m_dev *m2m_dev);
324
325/**
326 * v4l2_m2m_resume() - resume job running and try to run a queued job
327 *
328 * @m2m_dev: opaque pointer to the internal data to handle M2M context
329 *
330 * Called by a driver in the resume hook. This reverts the operation of
331 * v4l2_m2m_suspend() and allows job to be run. Also try to run a queued job if
332 * there is any.
333 */
334void v4l2_m2m_resume(struct v4l2_m2m_dev *m2m_dev);
335
336/**
337 * v4l2_m2m_reqbufs() - multi-queue-aware REQBUFS multiplexer
338 *
339 * @file: pointer to struct &file
340 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
341 * @reqbufs: pointer to struct &v4l2_requestbuffers
342 */
343int v4l2_m2m_reqbufs(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
344 struct v4l2_requestbuffers *reqbufs);
345
346/**
347 * v4l2_m2m_querybuf() - multi-queue-aware QUERYBUF multiplexer
348 *
349 * @file: pointer to struct &file
350 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
351 * @buf: pointer to struct &v4l2_buffer
352 *
353 * See v4l2_m2m_mmap() documentation for details.
354 */
355int v4l2_m2m_querybuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
356 struct v4l2_buffer *buf);
357
358/**
359 * v4l2_m2m_qbuf() - enqueue a source or destination buffer, depending on
360 * the type
361 *
362 * @file: pointer to struct &file
363 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
364 * @buf: pointer to struct &v4l2_buffer
365 */
366int v4l2_m2m_qbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
367 struct v4l2_buffer *buf);
368
369/**
370 * v4l2_m2m_dqbuf() - dequeue a source or destination buffer, depending on
371 * the type
372 *
373 * @file: pointer to struct &file
374 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
375 * @buf: pointer to struct &v4l2_buffer
376 */
377int v4l2_m2m_dqbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
378 struct v4l2_buffer *buf);
379
380/**
381 * v4l2_m2m_prepare_buf() - prepare a source or destination buffer, depending on
382 * the type
383 *
384 * @file: pointer to struct &file
385 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
386 * @buf: pointer to struct &v4l2_buffer
387 */
388int v4l2_m2m_prepare_buf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
389 struct v4l2_buffer *buf);
390
391/**
392 * v4l2_m2m_create_bufs() - create a source or destination buffer, depending
393 * on the type
394 *
395 * @file: pointer to struct &file
396 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
397 * @create: pointer to struct &v4l2_create_buffers
398 */
399int v4l2_m2m_create_bufs(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
400 struct v4l2_create_buffers *create);
401
402/**
403 * v4l2_m2m_expbuf() - export a source or destination buffer, depending on
404 * the type
405 *
406 * @file: pointer to struct &file
407 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
408 * @eb: pointer to struct &v4l2_exportbuffer
409 */
410int v4l2_m2m_expbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
411 struct v4l2_exportbuffer *eb);
412
413/**
414 * v4l2_m2m_streamon() - turn on streaming for a video queue
415 *
416 * @file: pointer to struct &file
417 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
418 * @type: type of the V4L2 buffer, as defined by enum &v4l2_buf_type
419 */
420int v4l2_m2m_streamon(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
421 enum v4l2_buf_type type);
422
423/**
424 * v4l2_m2m_streamoff() - turn off streaming for a video queue
425 *
426 * @file: pointer to struct &file
427 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
428 * @type: type of the V4L2 buffer, as defined by enum &v4l2_buf_type
429 */
430int v4l2_m2m_streamoff(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
431 enum v4l2_buf_type type);
432
433/**
434 * v4l2_m2m_update_start_streaming_state() - update the encoding/decoding
435 * session state when a start of streaming of a video queue is requested
436 *
437 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
438 * @q: queue
439 */
440void v4l2_m2m_update_start_streaming_state(struct v4l2_m2m_ctx *m2m_ctx,
441 struct vb2_queue *q);
442
443/**
444 * v4l2_m2m_update_stop_streaming_state() - update the encoding/decoding
445 * session state when a stop of streaming of a video queue is requested
446 *
447 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
448 * @q: queue
449 */
450void v4l2_m2m_update_stop_streaming_state(struct v4l2_m2m_ctx *m2m_ctx,
451 struct vb2_queue *q);
452
453/**
454 * v4l2_m2m_encoder_cmd() - execute an encoder command
455 *
456 * @file: pointer to struct &file
457 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
458 * @ec: pointer to the encoder command
459 */
460int v4l2_m2m_encoder_cmd(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
461 struct v4l2_encoder_cmd *ec);
462
463/**
464 * v4l2_m2m_decoder_cmd() - execute a decoder command
465 *
466 * @file: pointer to struct &file
467 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
468 * @dc: pointer to the decoder command
469 */
470int v4l2_m2m_decoder_cmd(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
471 struct v4l2_decoder_cmd *dc);
472
473/**
474 * v4l2_m2m_poll() - poll replacement, for destination buffers only
475 *
476 * @file: pointer to struct &file
477 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
478 * @wait: pointer to struct &poll_table_struct
479 *
480 * Call from the driver's poll() function. Will poll both queues. If a buffer
481 * is available to dequeue (with dqbuf) from the source queue, this will
482 * indicate that a non-blocking write can be performed, while read will be
483 * returned in case of the destination queue.
484 */
485__poll_t v4l2_m2m_poll(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
486 struct poll_table_struct *wait);
487
488/**
489 * v4l2_m2m_mmap() - source and destination queues-aware mmap multiplexer
490 *
491 * @file: pointer to struct &file
492 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
493 * @vma: pointer to struct &vm_area_struct
494 *
495 * Call from driver's mmap() function. Will handle mmap() for both queues
496 * seamlessly for the video buffer, which will receive normal per-queue offsets
497 * and proper vb2 queue pointers. The differentiation is made outside
498 * vb2 by adding a predefined offset to buffers from one of the queues
499 * and subtracting it before passing it back to vb2. Only drivers (and
500 * thus applications) receive modified offsets.
501 */
502int v4l2_m2m_mmap(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
503 struct vm_area_struct *vma);
504
505#ifndef CONFIG_MMU
506unsigned long v4l2_m2m_get_unmapped_area(struct file *file, unsigned long addr,
507 unsigned long len, unsigned long pgoff,
508 unsigned long flags);
509#endif
510/**
511 * v4l2_m2m_init() - initialize per-driver m2m data
512 *
513 * @m2m_ops: pointer to struct v4l2_m2m_ops
514 *
515 * Usually called from driver's ``probe()`` function.
516 *
517 * Return: returns an opaque pointer to the internal data to handle M2M context
518 */
519struct v4l2_m2m_dev *v4l2_m2m_init(const struct v4l2_m2m_ops *m2m_ops);
520
521#if defined(CONFIG_MEDIA_CONTROLLER)
522void v4l2_m2m_unregister_media_controller(struct v4l2_m2m_dev *m2m_dev);
523int v4l2_m2m_register_media_controller(struct v4l2_m2m_dev *m2m_dev,
524 struct video_device *vdev, int function);
525#else
526static inline void
527v4l2_m2m_unregister_media_controller(struct v4l2_m2m_dev *m2m_dev)
528{
529}
530
531static inline int
532v4l2_m2m_register_media_controller(struct v4l2_m2m_dev *m2m_dev,
533 struct video_device *vdev, int function)
534{
535 return 0;
536}
537#endif
538
539/**
540 * v4l2_m2m_release() - cleans up and frees a m2m_dev structure
541 *
542 * @m2m_dev: opaque pointer to the internal data to handle M2M context
543 *
544 * Usually called from driver's ``remove()`` function.
545 */
546void v4l2_m2m_release(struct v4l2_m2m_dev *m2m_dev);
547
548/**
549 * v4l2_m2m_ctx_init() - allocate and initialize a m2m context
550 *
551 * @m2m_dev: opaque pointer to the internal data to handle M2M context
552 * @drv_priv: driver's instance private data
553 * @queue_init: a callback for queue type-specific initialization function
554 * to be used for initializing vb2_queues
555 *
556 * Usually called from driver's ``open()`` function.
557 */
558struct v4l2_m2m_ctx *v4l2_m2m_ctx_init(struct v4l2_m2m_dev *m2m_dev,
559 void *drv_priv,
560 int (*queue_init)(void *priv, struct vb2_queue *src_vq, struct vb2_queue *dst_vq));
561
562static inline void v4l2_m2m_set_src_buffered(struct v4l2_m2m_ctx *m2m_ctx,
563 bool buffered)
564{
565 m2m_ctx->out_q_ctx.buffered = buffered;
566}
567
568static inline void v4l2_m2m_set_dst_buffered(struct v4l2_m2m_ctx *m2m_ctx,
569 bool buffered)
570{
571 m2m_ctx->cap_q_ctx.buffered = buffered;
572}
573
574/**
575 * v4l2_m2m_ctx_release() - release m2m context
576 *
577 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
578 *
579 * Usually called from driver's release() function.
580 */
581void v4l2_m2m_ctx_release(struct v4l2_m2m_ctx *m2m_ctx);
582
583/**
584 * v4l2_m2m_buf_queue() - add a buffer to the proper ready buffers list.
585 *
586 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
587 * @vbuf: pointer to struct &vb2_v4l2_buffer
588 *
589 * Call from vb2_queue_ops->ops->buf_queue, vb2_queue_ops callback.
590 */
591void v4l2_m2m_buf_queue(struct v4l2_m2m_ctx *m2m_ctx,
592 struct vb2_v4l2_buffer *vbuf);
593
594/**
595 * v4l2_m2m_num_src_bufs_ready() - return the number of source buffers ready for
596 * use
597 *
598 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
599 */
600static inline
601unsigned int v4l2_m2m_num_src_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx)
602{
603 unsigned int num_buf_rdy;
604 unsigned long flags;
605
606 spin_lock_irqsave(&m2m_ctx->out_q_ctx.rdy_spinlock, flags);
607 num_buf_rdy = m2m_ctx->out_q_ctx.num_rdy;
608 spin_unlock_irqrestore(&m2m_ctx->out_q_ctx.rdy_spinlock, flags);
609
610 return num_buf_rdy;
611}
612
613/**
614 * v4l2_m2m_num_dst_bufs_ready() - return the number of destination buffers
615 * ready for use
616 *
617 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
618 */
619static inline
620unsigned int v4l2_m2m_num_dst_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx)
621{
622 unsigned int num_buf_rdy;
623 unsigned long flags;
624
625 spin_lock_irqsave(&m2m_ctx->cap_q_ctx.rdy_spinlock, flags);
626 num_buf_rdy = m2m_ctx->cap_q_ctx.num_rdy;
627 spin_unlock_irqrestore(&m2m_ctx->cap_q_ctx.rdy_spinlock, flags);
628
629 return num_buf_rdy;
630}
631
632/**
633 * v4l2_m2m_next_buf() - return next buffer from the list of ready buffers
634 *
635 * @q_ctx: pointer to struct @v4l2_m2m_queue_ctx
636 */
637struct vb2_v4l2_buffer *v4l2_m2m_next_buf(struct v4l2_m2m_queue_ctx *q_ctx);
638
639/**
640 * v4l2_m2m_next_src_buf() - return next source buffer from the list of ready
641 * buffers
642 *
643 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
644 */
645static inline struct vb2_v4l2_buffer *
646v4l2_m2m_next_src_buf(struct v4l2_m2m_ctx *m2m_ctx)
647{
648 return v4l2_m2m_next_buf(&m2m_ctx->out_q_ctx);
649}
650
651/**
652 * v4l2_m2m_next_dst_buf() - return next destination buffer from the list of
653 * ready buffers
654 *
655 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
656 */
657static inline struct vb2_v4l2_buffer *
658v4l2_m2m_next_dst_buf(struct v4l2_m2m_ctx *m2m_ctx)
659{
660 return v4l2_m2m_next_buf(&m2m_ctx->cap_q_ctx);
661}
662
663/**
664 * v4l2_m2m_last_buf() - return last buffer from the list of ready buffers
665 *
666 * @q_ctx: pointer to struct @v4l2_m2m_queue_ctx
667 */
668struct vb2_v4l2_buffer *v4l2_m2m_last_buf(struct v4l2_m2m_queue_ctx *q_ctx);
669
670/**
671 * v4l2_m2m_last_src_buf() - return last source buffer from the list of
672 * ready buffers
673 *
674 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
675 */
676static inline struct vb2_v4l2_buffer *
677v4l2_m2m_last_src_buf(struct v4l2_m2m_ctx *m2m_ctx)
678{
679 return v4l2_m2m_last_buf(&m2m_ctx->out_q_ctx);
680}
681
682/**
683 * v4l2_m2m_last_dst_buf() - return last destination buffer from the list of
684 * ready buffers
685 *
686 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
687 */
688static inline struct vb2_v4l2_buffer *
689v4l2_m2m_last_dst_buf(struct v4l2_m2m_ctx *m2m_ctx)
690{
691 return v4l2_m2m_last_buf(&m2m_ctx->cap_q_ctx);
692}
693
694/**
695 * v4l2_m2m_for_each_dst_buf() - iterate over a list of destination ready
696 * buffers
697 *
698 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
699 * @b: current buffer of type struct v4l2_m2m_buffer
700 */
701#define v4l2_m2m_for_each_dst_buf(m2m_ctx, b) \
702 list_for_each_entry(b, &m2m_ctx->cap_q_ctx.rdy_queue, list)
703
704/**
705 * v4l2_m2m_for_each_src_buf() - iterate over a list of source ready buffers
706 *
707 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
708 * @b: current buffer of type struct v4l2_m2m_buffer
709 */
710#define v4l2_m2m_for_each_src_buf(m2m_ctx, b) \
711 list_for_each_entry(b, &m2m_ctx->out_q_ctx.rdy_queue, list)
712
713/**
714 * v4l2_m2m_for_each_dst_buf_safe() - iterate over a list of destination ready
715 * buffers safely
716 *
717 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
718 * @b: current buffer of type struct v4l2_m2m_buffer
719 * @n: used as temporary storage
720 */
721#define v4l2_m2m_for_each_dst_buf_safe(m2m_ctx, b, n) \
722 list_for_each_entry_safe(b, n, &m2m_ctx->cap_q_ctx.rdy_queue, list)
723
724/**
725 * v4l2_m2m_for_each_src_buf_safe() - iterate over a list of source ready
726 * buffers safely
727 *
728 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
729 * @b: current buffer of type struct v4l2_m2m_buffer
730 * @n: used as temporary storage
731 */
732#define v4l2_m2m_for_each_src_buf_safe(m2m_ctx, b, n) \
733 list_for_each_entry_safe(b, n, &m2m_ctx->out_q_ctx.rdy_queue, list)
734
735/**
736 * v4l2_m2m_get_src_vq() - return vb2_queue for source buffers
737 *
738 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
739 */
740static inline
741struct vb2_queue *v4l2_m2m_get_src_vq(struct v4l2_m2m_ctx *m2m_ctx)
742{
743 return &m2m_ctx->out_q_ctx.q;
744}
745
746/**
747 * v4l2_m2m_get_dst_vq() - return vb2_queue for destination buffers
748 *
749 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
750 */
751static inline
752struct vb2_queue *v4l2_m2m_get_dst_vq(struct v4l2_m2m_ctx *m2m_ctx)
753{
754 return &m2m_ctx->cap_q_ctx.q;
755}
756
757/**
758 * v4l2_m2m_buf_remove() - take off a buffer from the list of ready buffers and
759 * return it
760 *
761 * @q_ctx: pointer to struct @v4l2_m2m_queue_ctx
762 */
763struct vb2_v4l2_buffer *v4l2_m2m_buf_remove(struct v4l2_m2m_queue_ctx *q_ctx);
764
765/**
766 * v4l2_m2m_src_buf_remove() - take off a source buffer from the list of ready
767 * buffers and return it
768 *
769 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
770 */
771static inline struct vb2_v4l2_buffer *
772v4l2_m2m_src_buf_remove(struct v4l2_m2m_ctx *m2m_ctx)
773{
774 return v4l2_m2m_buf_remove(&m2m_ctx->out_q_ctx);
775}
776
777/**
778 * v4l2_m2m_dst_buf_remove() - take off a destination buffer from the list of
779 * ready buffers and return it
780 *
781 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
782 */
783static inline struct vb2_v4l2_buffer *
784v4l2_m2m_dst_buf_remove(struct v4l2_m2m_ctx *m2m_ctx)
785{
786 return v4l2_m2m_buf_remove(&m2m_ctx->cap_q_ctx);
787}
788
789/**
790 * v4l2_m2m_buf_remove_by_buf() - take off exact buffer from the list of ready
791 * buffers
792 *
793 * @q_ctx: pointer to struct @v4l2_m2m_queue_ctx
794 * @vbuf: the buffer to be removed
795 */
796void v4l2_m2m_buf_remove_by_buf(struct v4l2_m2m_queue_ctx *q_ctx,
797 struct vb2_v4l2_buffer *vbuf);
798
799/**
800 * v4l2_m2m_src_buf_remove_by_buf() - take off exact source buffer from the list
801 * of ready buffers
802 *
803 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
804 * @vbuf: the buffer to be removed
805 */
806static inline void v4l2_m2m_src_buf_remove_by_buf(struct v4l2_m2m_ctx *m2m_ctx,
807 struct vb2_v4l2_buffer *vbuf)
808{
809 v4l2_m2m_buf_remove_by_buf(&m2m_ctx->out_q_ctx, vbuf);
810}
811
812/**
813 * v4l2_m2m_dst_buf_remove_by_buf() - take off exact destination buffer from the
814 * list of ready buffers
815 *
816 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
817 * @vbuf: the buffer to be removed
818 */
819static inline void v4l2_m2m_dst_buf_remove_by_buf(struct v4l2_m2m_ctx *m2m_ctx,
820 struct vb2_v4l2_buffer *vbuf)
821{
822 v4l2_m2m_buf_remove_by_buf(&m2m_ctx->cap_q_ctx, vbuf);
823}
824
825struct vb2_v4l2_buffer *
826v4l2_m2m_buf_remove_by_idx(struct v4l2_m2m_queue_ctx *q_ctx, unsigned int idx);
827
828static inline struct vb2_v4l2_buffer *
829v4l2_m2m_src_buf_remove_by_idx(struct v4l2_m2m_ctx *m2m_ctx, unsigned int idx)
830{
831 return v4l2_m2m_buf_remove_by_idx(&m2m_ctx->out_q_ctx, idx);
832}
833
834static inline struct vb2_v4l2_buffer *
835v4l2_m2m_dst_buf_remove_by_idx(struct v4l2_m2m_ctx *m2m_ctx, unsigned int idx)
836{
837 return v4l2_m2m_buf_remove_by_idx(&m2m_ctx->cap_q_ctx, idx);
838}
839
840/**
841 * v4l2_m2m_buf_copy_metadata() - copy buffer metadata from
842 * the output buffer to the capture buffer
843 *
844 * @out_vb: the output buffer that is the source of the metadata.
845 * @cap_vb: the capture buffer that will receive the metadata.
846 * @copy_frame_flags: copy the KEY/B/PFRAME flags as well.
847 *
848 * This helper function copies the timestamp, timecode (if the TIMECODE
849 * buffer flag was set), field and the TIMECODE, KEYFRAME, BFRAME, PFRAME
850 * and TSTAMP_SRC_MASK flags from @out_vb to @cap_vb.
851 *
852 * If @copy_frame_flags is false, then the KEYFRAME, BFRAME and PFRAME
853 * flags are not copied. This is typically needed for encoders that
854 * set this bits explicitly.
855 */
856void v4l2_m2m_buf_copy_metadata(const struct vb2_v4l2_buffer *out_vb,
857 struct vb2_v4l2_buffer *cap_vb,
858 bool copy_frame_flags);
859
860/* v4l2 request helper */
861
862void v4l2_m2m_request_queue(struct media_request *req);
863
864/* v4l2 ioctl helpers */
865
866int v4l2_m2m_ioctl_reqbufs(struct file *file, void *priv,
867 struct v4l2_requestbuffers *rb);
868int v4l2_m2m_ioctl_create_bufs(struct file *file, void *fh,
869 struct v4l2_create_buffers *create);
870int v4l2_m2m_ioctl_remove_bufs(struct file *file, void *priv,
871 struct v4l2_remove_buffers *d);
872int v4l2_m2m_ioctl_querybuf(struct file *file, void *fh,
873 struct v4l2_buffer *buf);
874int v4l2_m2m_ioctl_expbuf(struct file *file, void *fh,
875 struct v4l2_exportbuffer *eb);
876int v4l2_m2m_ioctl_qbuf(struct file *file, void *fh,
877 struct v4l2_buffer *buf);
878int v4l2_m2m_ioctl_dqbuf(struct file *file, void *fh,
879 struct v4l2_buffer *buf);
880int v4l2_m2m_ioctl_prepare_buf(struct file *file, void *fh,
881 struct v4l2_buffer *buf);
882int v4l2_m2m_ioctl_streamon(struct file *file, void *fh,
883 enum v4l2_buf_type type);
884int v4l2_m2m_ioctl_streamoff(struct file *file, void *fh,
885 enum v4l2_buf_type type);
886int v4l2_m2m_ioctl_encoder_cmd(struct file *file, void *fh,
887 struct v4l2_encoder_cmd *ec);
888int v4l2_m2m_ioctl_decoder_cmd(struct file *file, void *fh,
889 struct v4l2_decoder_cmd *dc);
890int v4l2_m2m_ioctl_try_encoder_cmd(struct file *file, void *fh,
891 struct v4l2_encoder_cmd *ec);
892int v4l2_m2m_ioctl_try_decoder_cmd(struct file *file, void *fh,
893 struct v4l2_decoder_cmd *dc);
894int v4l2_m2m_ioctl_stateless_try_decoder_cmd(struct file *file, void *fh,
895 struct v4l2_decoder_cmd *dc);
896int v4l2_m2m_ioctl_stateless_decoder_cmd(struct file *file, void *priv,
897 struct v4l2_decoder_cmd *dc);
898int v4l2_m2m_fop_mmap(struct file *file, struct vm_area_struct *vma);
899__poll_t v4l2_m2m_fop_poll(struct file *file, poll_table *wait);
900
901#endif /* _MEDIA_V4L2_MEM2MEM_H */
902
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.
8 * Pawel Osciak, <pawel@osciak.com>
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
20#include <media/videobuf2-v4l2.h>
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.
43 * @lock: optional. Define a driver's own lock callback, instead of using
44 * &v4l2_m2m_ctx->q_lock.
45 * @unlock: optional. Define a driver's own unlock callback, instead of
46 * using &v4l2_m2m_ctx->q_lock.
47 */
48struct v4l2_m2m_ops {
49 void (*device_run)(void *priv);
50 int (*job_ready)(void *priv);
51 void (*job_abort)(void *priv);
52 void (*lock)(void *priv);
53 void (*unlock)(void *priv);
54};
55
56struct v4l2_m2m_dev;
57
58/**
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
72struct v4l2_m2m_queue_ctx {
73 struct vb2_queue q;
74
75 struct list_head rdy_queue;
76 spinlock_t rdy_spinlock;
77 u8 num_rdy;
78 bool buffered;
79};
80
81/**
82 * struct v4l2_m2m_ctx - Memory to memory context structure
83 *
84 * @q_lock: struct &mutex lock
85 * @m2m_dev: opaque pointer to the internal data to handle M2M context
86 * @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
93 *
94 * The memory to memory context is specific to a file handle, NOT to e.g.
95 * a device.
96 */
97struct v4l2_m2m_ctx {
98 /* optional cap/out vb2 queues lock */
99 struct mutex *q_lock;
100
101 /* internal use only */
102 struct v4l2_m2m_dev *m2m_dev;
103
104 struct v4l2_m2m_queue_ctx cap_q_ctx;
105
106 struct v4l2_m2m_queue_ctx out_q_ctx;
107
108 /* For device job queue */
109 struct list_head queue;
110 unsigned long job_flags;
111 wait_queue_head_t finished;
112
113 void *priv;
114};
115
116/**
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 */
122struct v4l2_m2m_buffer {
123 struct vb2_v4l2_buffer vb;
124 struct list_head list;
125};
126
127/**
128 * v4l2_m2m_get_curr_priv() - return driver private data for the currently
129 * running instance or NULL if no instance is running
130 *
131 * @m2m_dev: opaque pointer to the internal data to handle M2M context
132 */
133void *v4l2_m2m_get_curr_priv(struct v4l2_m2m_dev *m2m_dev);
134
135/**
136 * v4l2_m2m_get_vq() - return vb2_queue for the given type
137 *
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
140 */
141struct vb2_queue *v4l2_m2m_get_vq(struct v4l2_m2m_ctx *m2m_ctx,
142 enum v4l2_buf_type type);
143
144/**
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.
147 *
148 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
149 *
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 */
165void v4l2_m2m_try_schedule(struct v4l2_m2m_ctx *m2m_ctx);
166
167/**
168 * v4l2_m2m_job_finish() - inform the framework that a job has been finished
169 * and have it clean up
170 *
171 * @m2m_dev: opaque pointer to the internal data to handle M2M context
172 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
173 *
174 * 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 *
178 * 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.
181 */
182void v4l2_m2m_job_finish(struct v4l2_m2m_dev *m2m_dev,
183 struct v4l2_m2m_ctx *m2m_ctx);
184
185static inline void
186v4l2_m2m_buf_done(struct vb2_v4l2_buffer *buf, enum vb2_buffer_state state)
187{
188 vb2_buffer_done(&buf->vb2_buf, state);
189}
190
191/**
192 * v4l2_m2m_reqbufs() - multi-queue-aware REQBUFS multiplexer
193 *
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
197 */
198int v4l2_m2m_reqbufs(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
199 struct v4l2_requestbuffers *reqbufs);
200
201/**
202 * v4l2_m2m_querybuf() - multi-queue-aware QUERYBUF multiplexer
203 *
204 * @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 *
208 * See v4l2_m2m_mmap() documentation for details.
209 */
210int v4l2_m2m_querybuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
211 struct v4l2_buffer *buf);
212
213/**
214 * v4l2_m2m_qbuf() - enqueue a source or destination buffer, depending on
215 * the type
216 *
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
220 */
221int v4l2_m2m_qbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
222 struct v4l2_buffer *buf);
223
224/**
225 * v4l2_m2m_dqbuf() - dequeue a source or destination buffer, depending on
226 * the type
227 *
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
231 */
232int v4l2_m2m_dqbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
233 struct v4l2_buffer *buf);
234
235/**
236 * v4l2_m2m_prepare_buf() - prepare a source or destination buffer, depending on
237 * the type
238 *
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
242 */
243int v4l2_m2m_prepare_buf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
244 struct v4l2_buffer *buf);
245
246/**
247 * v4l2_m2m_create_bufs() - create a source or destination buffer, depending
248 * on the type
249 *
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
253 */
254int v4l2_m2m_create_bufs(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
255 struct v4l2_create_buffers *create);
256
257/**
258 * v4l2_m2m_expbuf() - export a source or destination buffer, depending on
259 * the type
260 *
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
264 */
265int v4l2_m2m_expbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
266 struct v4l2_exportbuffer *eb);
267
268/**
269 * v4l2_m2m_streamon() - turn on streaming for a video queue
270 *
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
274 */
275int v4l2_m2m_streamon(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
276 enum v4l2_buf_type type);
277
278/**
279 * v4l2_m2m_streamoff() - turn off streaming for a video queue
280 *
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
284 */
285int v4l2_m2m_streamoff(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
286 enum v4l2_buf_type type);
287
288/**
289 * v4l2_m2m_poll() - poll replacement, for destination buffers only
290 *
291 * @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 *
295 * 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 */
300unsigned int v4l2_m2m_poll(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
301 struct poll_table_struct *wait);
302
303/**
304 * v4l2_m2m_mmap() - source and destination queues-aware mmap multiplexer
305 *
306 * @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 *
310 * 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 */
317int v4l2_m2m_mmap(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
318 struct vm_area_struct *vma);
319
320/**
321 * v4l2_m2m_init() - initialize per-driver m2m data
322 *
323 * @m2m_ops: pointer to struct v4l2_m2m_ops
324 *
325 * Usually called from driver's ``probe()`` function.
326 *
327 * Return: returns an opaque pointer to the internal data to handle M2M context
328 */
329struct v4l2_m2m_dev *v4l2_m2m_init(const struct v4l2_m2m_ops *m2m_ops);
330
331/**
332 * v4l2_m2m_release() - cleans up and frees a m2m_dev structure
333 *
334 * @m2m_dev: opaque pointer to the internal data to handle M2M context
335 *
336 * Usually called from driver's ``remove()`` function.
337 */
338void v4l2_m2m_release(struct v4l2_m2m_dev *m2m_dev);
339
340/**
341 * v4l2_m2m_ctx_init() - allocate and initialize a m2m context
342 *
343 * @m2m_dev: opaque pointer to the internal data to handle M2M context
344 * @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
347 *
348 * Usually called from driver's ``open()`` function.
349 */
350struct 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
354static 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
366/**
367 * v4l2_m2m_ctx_release() - release m2m context
368 *
369 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
370 *
371 * Usually called from driver's release() function.
372 */
373void v4l2_m2m_ctx_release(struct v4l2_m2m_ctx *m2m_ctx);
374
375/**
376 * v4l2_m2m_buf_queue() - add a buffer to the proper ready buffers list.
377 *
378 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
379 * @vbuf: pointer to struct &vb2_v4l2_buffer
380 *
381 * Call from videobuf_queue_ops->ops->buf_queue, videobuf_queue_ops callback.
382 */
383void v4l2_m2m_buf_queue(struct v4l2_m2m_ctx *m2m_ctx,
384 struct vb2_v4l2_buffer *vbuf);
385
386/**
387 * v4l2_m2m_num_src_bufs_ready() - return the number of source buffers ready for
388 * use
389 *
390 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
391 */
392static inline
393unsigned int v4l2_m2m_num_src_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx)
394{
395 return m2m_ctx->out_q_ctx.num_rdy;
396}
397
398/**
399 * v4l2_m2m_num_dst_bufs_ready() - return the number of destination buffers
400 * ready for use
401 *
402 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
403 */
404static inline
405unsigned int v4l2_m2m_num_dst_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx)
406{
407 return m2m_ctx->cap_q_ctx.num_rdy;
408}
409
410/**
411 * v4l2_m2m_next_buf() - return next buffer from the list of ready buffers
412 *
413 * @q_ctx: pointer to struct @v4l2_m2m_queue_ctx
414 */
415void *v4l2_m2m_next_buf(struct v4l2_m2m_queue_ctx *q_ctx);
416
417/**
418 * v4l2_m2m_next_src_buf() - return next source buffer from the list of ready
419 * buffers
420 *
421 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
422 */
423static inline void *v4l2_m2m_next_src_buf(struct v4l2_m2m_ctx *m2m_ctx)
424{
425 return v4l2_m2m_next_buf(&m2m_ctx->out_q_ctx);
426}
427
428/**
429 * v4l2_m2m_next_dst_buf() - return next destination buffer from the list of
430 * ready buffers
431 *
432 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
433 */
434static inline void *v4l2_m2m_next_dst_buf(struct v4l2_m2m_ctx *m2m_ctx)
435{
436 return v4l2_m2m_next_buf(&m2m_ctx->cap_q_ctx);
437}
438
439/**
440 * v4l2_m2m_get_src_vq() - return vb2_queue for source buffers
441 *
442 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
443 */
444static inline
445struct vb2_queue *v4l2_m2m_get_src_vq(struct v4l2_m2m_ctx *m2m_ctx)
446{
447 return &m2m_ctx->out_q_ctx.q;
448}
449
450/**
451 * v4l2_m2m_get_dst_vq() - return vb2_queue for destination buffers
452 *
453 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
454 */
455static inline
456struct vb2_queue *v4l2_m2m_get_dst_vq(struct v4l2_m2m_ctx *m2m_ctx)
457{
458 return &m2m_ctx->cap_q_ctx.q;
459}
460
461/**
462 * v4l2_m2m_buf_remove() - take off a buffer from the list of ready buffers and
463 * return it
464 *
465 * @q_ctx: pointer to struct @v4l2_m2m_queue_ctx
466 */
467void *v4l2_m2m_buf_remove(struct v4l2_m2m_queue_ctx *q_ctx);
468
469/**
470 * v4l2_m2m_src_buf_remove() - take off a source buffer from the list of ready
471 * buffers and return it
472 *
473 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
474 */
475static inline void *v4l2_m2m_src_buf_remove(struct v4l2_m2m_ctx *m2m_ctx)
476{
477 return v4l2_m2m_buf_remove(&m2m_ctx->out_q_ctx);
478}
479
480/**
481 * v4l2_m2m_dst_buf_remove() - take off a destination buffer from the list of
482 * ready buffers and return it
483 *
484 * @m2m_ctx: m2m context assigned to the instance given by struct &v4l2_m2m_ctx
485 */
486static inline void *v4l2_m2m_dst_buf_remove(struct v4l2_m2m_ctx *m2m_ctx)
487{
488 return v4l2_m2m_buf_remove(&m2m_ctx->cap_q_ctx);
489}
490
491/* v4l2 ioctl helpers */
492
493int v4l2_m2m_ioctl_reqbufs(struct file *file, void *priv,
494 struct v4l2_requestbuffers *rb);
495int v4l2_m2m_ioctl_create_bufs(struct file *file, void *fh,
496 struct v4l2_create_buffers *create);
497int v4l2_m2m_ioctl_querybuf(struct file *file, void *fh,
498 struct v4l2_buffer *buf);
499int v4l2_m2m_ioctl_expbuf(struct file *file, void *fh,
500 struct v4l2_exportbuffer *eb);
501int v4l2_m2m_ioctl_qbuf(struct file *file, void *fh,
502 struct v4l2_buffer *buf);
503int v4l2_m2m_ioctl_dqbuf(struct file *file, void *fh,
504 struct v4l2_buffer *buf);
505int v4l2_m2m_ioctl_prepare_buf(struct file *file, void *fh,
506 struct v4l2_buffer *buf);
507int v4l2_m2m_ioctl_streamon(struct file *file, void *fh,
508 enum v4l2_buf_type type);
509int v4l2_m2m_ioctl_streamoff(struct file *file, void *fh,
510 enum v4l2_buf_type type);
511int v4l2_m2m_fop_mmap(struct file *file, struct vm_area_struct *vma);
512unsigned int v4l2_m2m_fop_poll(struct file *file, poll_table *wait);
513
514#endif /* _MEDIA_V4L2_MEM2MEM_H */
515