2 * Memory-to-memory device framework for Video for Linux 2 and videobuf.
4 * Helper functions for devices that use videobuf buffers for both their
5 * source and destination.
7 * Copyright (c) 2009-2010 Samsung Electronics Co., Ltd.
8 * Pawel Osciak, <pawel@osciak.com>
9 * Marek Szyprowski, <m.szyprowski@samsung.com>
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 License, or (at your
14 * option) any later version.
16 #include <linux/module.h>
17 #include <linux/sched.h>
18 #include <linux/slab.h>
20 #include <media/videobuf2-core.h>
21 #include <media/v4l2-mem2mem.h>
22 #include <media/v4l2-dev.h>
23 #include <media/v4l2-fh.h>
24 #include <media/v4l2-event.h>
26 MODULE_DESCRIPTION("Mem to mem device framework for videobuf");
27 MODULE_AUTHOR("Pawel Osciak, <pawel@osciak.com>");
28 MODULE_LICENSE("GPL");
31 module_param(debug, bool, 0644);
33 #define dprintk(fmt, arg...) \
36 printk(KERN_DEBUG "%s: " fmt, __func__, ## arg);\
40 /* Instance is already queued on the job_queue */
41 #define TRANS_QUEUED (1 << 0)
42 /* Instance is currently running in hardware */
43 #define TRANS_RUNNING (1 << 1)
44 /* Instance is currently aborting */
45 #define TRANS_ABORT (1 << 2)
48 /* Offset base for buffers on the destination queue - used to distinguish
49 * between source and destination buffers when mmapping - they receive the same
50 * offsets but for different queues */
51 #define DST_QUEUE_OFF_BASE (1 << 30)
55 * struct v4l2_m2m_dev - per-device context
56 * @curr_ctx: currently running instance
57 * @job_queue: instances queued to run
58 * @job_spinlock: protects job_queue
59 * @m2m_ops: driver callbacks
62 struct v4l2_m2m_ctx *curr_ctx;
64 struct list_head job_queue;
65 spinlock_t job_spinlock;
67 const struct v4l2_m2m_ops *m2m_ops;
70 static struct v4l2_m2m_queue_ctx *get_queue_ctx(struct v4l2_m2m_ctx *m2m_ctx,
71 enum v4l2_buf_type type)
73 if (V4L2_TYPE_IS_OUTPUT(type))
74 return &m2m_ctx->out_q_ctx;
76 return &m2m_ctx->cap_q_ctx;
80 * v4l2_m2m_get_vq() - return vb2_queue for the given type
82 struct vb2_queue *v4l2_m2m_get_vq(struct v4l2_m2m_ctx *m2m_ctx,
83 enum v4l2_buf_type type)
85 struct v4l2_m2m_queue_ctx *q_ctx;
87 q_ctx = get_queue_ctx(m2m_ctx, type);
93 EXPORT_SYMBOL(v4l2_m2m_get_vq);
96 * v4l2_m2m_next_buf() - return next buffer from the list of ready buffers
98 void *v4l2_m2m_next_buf(struct v4l2_m2m_queue_ctx *q_ctx)
100 struct v4l2_m2m_buffer *b;
103 spin_lock_irqsave(&q_ctx->rdy_spinlock, flags);
105 if (list_empty(&q_ctx->rdy_queue)) {
106 spin_unlock_irqrestore(&q_ctx->rdy_spinlock, flags);
110 b = list_first_entry(&q_ctx->rdy_queue, struct v4l2_m2m_buffer, list);
111 spin_unlock_irqrestore(&q_ctx->rdy_spinlock, flags);
114 EXPORT_SYMBOL_GPL(v4l2_m2m_next_buf);
117 * v4l2_m2m_buf_remove() - take off a buffer from the list of ready buffers and
120 void *v4l2_m2m_buf_remove(struct v4l2_m2m_queue_ctx *q_ctx)
122 struct v4l2_m2m_buffer *b;
125 spin_lock_irqsave(&q_ctx->rdy_spinlock, flags);
126 if (list_empty(&q_ctx->rdy_queue)) {
127 spin_unlock_irqrestore(&q_ctx->rdy_spinlock, flags);
130 b = list_first_entry(&q_ctx->rdy_queue, struct v4l2_m2m_buffer, list);
133 spin_unlock_irqrestore(&q_ctx->rdy_spinlock, flags);
137 EXPORT_SYMBOL_GPL(v4l2_m2m_buf_remove);
140 * Scheduling handlers
144 * v4l2_m2m_get_curr_priv() - return driver private data for the currently
145 * running instance or NULL if no instance is running
147 void *v4l2_m2m_get_curr_priv(struct v4l2_m2m_dev *m2m_dev)
152 spin_lock_irqsave(&m2m_dev->job_spinlock, flags);
153 if (m2m_dev->curr_ctx)
154 ret = m2m_dev->curr_ctx->priv;
155 spin_unlock_irqrestore(&m2m_dev->job_spinlock, flags);
159 EXPORT_SYMBOL(v4l2_m2m_get_curr_priv);
162 * v4l2_m2m_try_run() - select next job to perform and run it if possible
164 * Get next transaction (if present) from the waiting jobs list and run it.
166 static void v4l2_m2m_try_run(struct v4l2_m2m_dev *m2m_dev)
170 spin_lock_irqsave(&m2m_dev->job_spinlock, flags);
171 if (NULL != m2m_dev->curr_ctx) {
172 spin_unlock_irqrestore(&m2m_dev->job_spinlock, flags);
173 dprintk("Another instance is running, won't run now\n");
177 if (list_empty(&m2m_dev->job_queue)) {
178 spin_unlock_irqrestore(&m2m_dev->job_spinlock, flags);
179 dprintk("No job pending\n");
183 m2m_dev->curr_ctx = list_first_entry(&m2m_dev->job_queue,
184 struct v4l2_m2m_ctx, queue);
185 m2m_dev->curr_ctx->job_flags |= TRANS_RUNNING;
186 spin_unlock_irqrestore(&m2m_dev->job_spinlock, flags);
188 m2m_dev->m2m_ops->device_run(m2m_dev->curr_ctx->priv);
192 * v4l2_m2m_try_schedule() - check whether an instance is ready to be added to
193 * the pending job queue and add it if so.
194 * @m2m_ctx: m2m context assigned to the instance to be checked
196 * There are three basic requirements an instance has to meet to be able to run:
197 * 1) at least one source buffer has to be queued,
198 * 2) at least one destination buffer has to be queued,
199 * 3) streaming has to be on.
201 * If a queue is buffered (for example a decoder hardware ringbuffer that has
202 * to be drained before doing streamoff), allow scheduling without v4l2 buffers
205 * There may also be additional, custom requirements. In such case the driver
206 * should supply a custom callback (job_ready in v4l2_m2m_ops) that should
207 * return 1 if the instance is ready.
208 * An example of the above could be an instance that requires more than one
209 * src/dst buffer per transaction.
211 void v4l2_m2m_try_schedule(struct v4l2_m2m_ctx *m2m_ctx)
213 struct v4l2_m2m_dev *m2m_dev;
214 unsigned long flags_job, flags_out, flags_cap;
216 m2m_dev = m2m_ctx->m2m_dev;
217 dprintk("Trying to schedule a job for m2m_ctx: %p\n", m2m_ctx);
219 if (!m2m_ctx->out_q_ctx.q.streaming
220 || !m2m_ctx->cap_q_ctx.q.streaming) {
221 dprintk("Streaming needs to be on for both queues\n");
225 spin_lock_irqsave(&m2m_dev->job_spinlock, flags_job);
227 /* If the context is aborted then don't schedule it */
228 if (m2m_ctx->job_flags & TRANS_ABORT) {
229 spin_unlock_irqrestore(&m2m_dev->job_spinlock, flags_job);
230 dprintk("Aborted context\n");
234 if (m2m_ctx->job_flags & TRANS_QUEUED) {
235 spin_unlock_irqrestore(&m2m_dev->job_spinlock, flags_job);
236 dprintk("On job queue already\n");
240 spin_lock_irqsave(&m2m_ctx->out_q_ctx.rdy_spinlock, flags_out);
241 if (list_empty(&m2m_ctx->out_q_ctx.rdy_queue)
242 && !m2m_ctx->out_q_ctx.buffered) {
243 spin_unlock_irqrestore(&m2m_ctx->out_q_ctx.rdy_spinlock,
245 spin_unlock_irqrestore(&m2m_dev->job_spinlock, flags_job);
246 dprintk("No input buffers available\n");
249 spin_lock_irqsave(&m2m_ctx->cap_q_ctx.rdy_spinlock, flags_cap);
250 if (list_empty(&m2m_ctx->cap_q_ctx.rdy_queue)
251 && !m2m_ctx->cap_q_ctx.buffered) {
252 spin_unlock_irqrestore(&m2m_ctx->cap_q_ctx.rdy_spinlock,
254 spin_unlock_irqrestore(&m2m_ctx->out_q_ctx.rdy_spinlock,
256 spin_unlock_irqrestore(&m2m_dev->job_spinlock, flags_job);
257 dprintk("No output buffers available\n");
260 spin_unlock_irqrestore(&m2m_ctx->cap_q_ctx.rdy_spinlock, flags_cap);
261 spin_unlock_irqrestore(&m2m_ctx->out_q_ctx.rdy_spinlock, flags_out);
263 if (m2m_dev->m2m_ops->job_ready
264 && (!m2m_dev->m2m_ops->job_ready(m2m_ctx->priv))) {
265 spin_unlock_irqrestore(&m2m_dev->job_spinlock, flags_job);
266 dprintk("Driver not ready\n");
270 list_add_tail(&m2m_ctx->queue, &m2m_dev->job_queue);
271 m2m_ctx->job_flags |= TRANS_QUEUED;
273 spin_unlock_irqrestore(&m2m_dev->job_spinlock, flags_job);
275 v4l2_m2m_try_run(m2m_dev);
277 EXPORT_SYMBOL_GPL(v4l2_m2m_try_schedule);
280 * v4l2_m2m_cancel_job() - cancel pending jobs for the context
282 * In case of streamoff or release called on any context,
283 * 1] If the context is currently running, then abort job will be called
284 * 2] If the context is queued, then the context will be removed from
287 static void v4l2_m2m_cancel_job(struct v4l2_m2m_ctx *m2m_ctx)
289 struct v4l2_m2m_dev *m2m_dev;
292 m2m_dev = m2m_ctx->m2m_dev;
293 spin_lock_irqsave(&m2m_dev->job_spinlock, flags);
295 m2m_ctx->job_flags |= TRANS_ABORT;
296 if (m2m_ctx->job_flags & TRANS_RUNNING) {
297 spin_unlock_irqrestore(&m2m_dev->job_spinlock, flags);
298 m2m_dev->m2m_ops->job_abort(m2m_ctx->priv);
299 dprintk("m2m_ctx %p running, will wait to complete", m2m_ctx);
300 wait_event(m2m_ctx->finished,
301 !(m2m_ctx->job_flags & TRANS_RUNNING));
302 } else if (m2m_ctx->job_flags & TRANS_QUEUED) {
303 list_del(&m2m_ctx->queue);
304 m2m_ctx->job_flags &= ~(TRANS_QUEUED | TRANS_RUNNING);
305 spin_unlock_irqrestore(&m2m_dev->job_spinlock, flags);
306 dprintk("m2m_ctx: %p had been on queue and was removed\n",
309 /* Do nothing, was not on queue/running */
310 spin_unlock_irqrestore(&m2m_dev->job_spinlock, flags);
315 * v4l2_m2m_job_finish() - inform the framework that a job has been finished
316 * and have it clean up
318 * Called by a driver to yield back the device after it has finished with it.
319 * Should be called as soon as possible after reaching a state which allows
320 * other instances to take control of the device.
322 * This function has to be called only after device_run() callback has been
323 * called on the driver. To prevent recursion, it should not be called directly
324 * from the device_run() callback though.
326 void v4l2_m2m_job_finish(struct v4l2_m2m_dev *m2m_dev,
327 struct v4l2_m2m_ctx *m2m_ctx)
331 spin_lock_irqsave(&m2m_dev->job_spinlock, flags);
332 if (!m2m_dev->curr_ctx || m2m_dev->curr_ctx != m2m_ctx) {
333 spin_unlock_irqrestore(&m2m_dev->job_spinlock, flags);
334 dprintk("Called by an instance not currently running\n");
338 list_del(&m2m_dev->curr_ctx->queue);
339 m2m_dev->curr_ctx->job_flags &= ~(TRANS_QUEUED | TRANS_RUNNING);
340 wake_up(&m2m_dev->curr_ctx->finished);
341 m2m_dev->curr_ctx = NULL;
343 spin_unlock_irqrestore(&m2m_dev->job_spinlock, flags);
345 /* This instance might have more buffers ready, but since we do not
346 * allow more than one job on the job_queue per instance, each has
347 * to be scheduled separately after the previous one finishes. */
348 v4l2_m2m_try_schedule(m2m_ctx);
349 v4l2_m2m_try_run(m2m_dev);
351 EXPORT_SYMBOL(v4l2_m2m_job_finish);
354 * v4l2_m2m_reqbufs() - multi-queue-aware REQBUFS multiplexer
356 int v4l2_m2m_reqbufs(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
357 struct v4l2_requestbuffers *reqbufs)
359 struct vb2_queue *vq;
362 vq = v4l2_m2m_get_vq(m2m_ctx, reqbufs->type);
363 ret = vb2_reqbufs(vq, reqbufs);
364 /* If count == 0, then the owner has released all buffers and he
365 is no longer owner of the queue. Otherwise we have an owner. */
367 vq->owner = reqbufs->count ? file->private_data : NULL;
371 EXPORT_SYMBOL_GPL(v4l2_m2m_reqbufs);
374 * v4l2_m2m_querybuf() - multi-queue-aware QUERYBUF multiplexer
376 * See v4l2_m2m_mmap() documentation for details.
378 int v4l2_m2m_querybuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
379 struct v4l2_buffer *buf)
381 struct vb2_queue *vq;
385 vq = v4l2_m2m_get_vq(m2m_ctx, buf->type);
386 ret = vb2_querybuf(vq, buf);
388 /* Adjust MMAP memory offsets for the CAPTURE queue */
389 if (buf->memory == V4L2_MEMORY_MMAP && !V4L2_TYPE_IS_OUTPUT(vq->type)) {
390 if (V4L2_TYPE_IS_MULTIPLANAR(vq->type)) {
391 for (i = 0; i < buf->length; ++i)
392 buf->m.planes[i].m.mem_offset
393 += DST_QUEUE_OFF_BASE;
395 buf->m.offset += DST_QUEUE_OFF_BASE;
401 EXPORT_SYMBOL_GPL(v4l2_m2m_querybuf);
404 * v4l2_m2m_qbuf() - enqueue a source or destination buffer, depending on
407 int v4l2_m2m_qbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
408 struct v4l2_buffer *buf)
410 struct vb2_queue *vq;
413 vq = v4l2_m2m_get_vq(m2m_ctx, buf->type);
414 ret = vb2_qbuf(vq, buf);
416 v4l2_m2m_try_schedule(m2m_ctx);
420 EXPORT_SYMBOL_GPL(v4l2_m2m_qbuf);
423 * v4l2_m2m_dqbuf() - dequeue a source or destination buffer, depending on
426 int v4l2_m2m_dqbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
427 struct v4l2_buffer *buf)
429 struct vb2_queue *vq;
431 vq = v4l2_m2m_get_vq(m2m_ctx, buf->type);
432 return vb2_dqbuf(vq, buf, file->f_flags & O_NONBLOCK);
434 EXPORT_SYMBOL_GPL(v4l2_m2m_dqbuf);
437 * v4l2_m2m_prepare_buf() - prepare a source or destination buffer, depending on
440 int v4l2_m2m_prepare_buf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
441 struct v4l2_buffer *buf)
443 struct vb2_queue *vq;
446 vq = v4l2_m2m_get_vq(m2m_ctx, buf->type);
447 ret = vb2_prepare_buf(vq, buf);
449 v4l2_m2m_try_schedule(m2m_ctx);
453 EXPORT_SYMBOL_GPL(v4l2_m2m_prepare_buf);
456 * v4l2_m2m_create_bufs() - create a source or destination buffer, depending
459 int v4l2_m2m_create_bufs(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
460 struct v4l2_create_buffers *create)
462 struct vb2_queue *vq;
464 vq = v4l2_m2m_get_vq(m2m_ctx, create->format.type);
465 return vb2_create_bufs(vq, create);
467 EXPORT_SYMBOL_GPL(v4l2_m2m_create_bufs);
470 * v4l2_m2m_expbuf() - export a source or destination buffer, depending on
473 int v4l2_m2m_expbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
474 struct v4l2_exportbuffer *eb)
476 struct vb2_queue *vq;
478 vq = v4l2_m2m_get_vq(m2m_ctx, eb->type);
479 return vb2_expbuf(vq, eb);
481 EXPORT_SYMBOL_GPL(v4l2_m2m_expbuf);
483 * v4l2_m2m_streamon() - turn on streaming for a video queue
485 int v4l2_m2m_streamon(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
486 enum v4l2_buf_type type)
488 struct vb2_queue *vq;
491 vq = v4l2_m2m_get_vq(m2m_ctx, type);
492 ret = vb2_streamon(vq, type);
494 v4l2_m2m_try_schedule(m2m_ctx);
498 EXPORT_SYMBOL_GPL(v4l2_m2m_streamon);
501 * v4l2_m2m_streamoff() - turn off streaming for a video queue
503 int v4l2_m2m_streamoff(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
504 enum v4l2_buf_type type)
506 struct v4l2_m2m_dev *m2m_dev;
507 struct v4l2_m2m_queue_ctx *q_ctx;
508 unsigned long flags_job, flags;
511 /* wait until the current context is dequeued from job_queue */
512 v4l2_m2m_cancel_job(m2m_ctx);
514 q_ctx = get_queue_ctx(m2m_ctx, type);
515 ret = vb2_streamoff(&q_ctx->q, type);
519 m2m_dev = m2m_ctx->m2m_dev;
520 spin_lock_irqsave(&m2m_dev->job_spinlock, flags_job);
521 /* We should not be scheduled anymore, since we're dropping a queue. */
522 if (m2m_ctx->job_flags & TRANS_QUEUED)
523 list_del(&m2m_ctx->queue);
524 m2m_ctx->job_flags = 0;
526 spin_lock_irqsave(&q_ctx->rdy_spinlock, flags);
527 /* Drop queue, since streamoff returns device to the same state as after
528 * calling reqbufs. */
529 INIT_LIST_HEAD(&q_ctx->rdy_queue);
531 spin_unlock_irqrestore(&q_ctx->rdy_spinlock, flags);
533 if (m2m_dev->curr_ctx == m2m_ctx) {
534 m2m_dev->curr_ctx = NULL;
535 wake_up(&m2m_ctx->finished);
537 spin_unlock_irqrestore(&m2m_dev->job_spinlock, flags_job);
541 EXPORT_SYMBOL_GPL(v4l2_m2m_streamoff);
544 * v4l2_m2m_poll() - poll replacement, for destination buffers only
546 * Call from the driver's poll() function. Will poll both queues. If a buffer
547 * is available to dequeue (with dqbuf) from the source queue, this will
548 * indicate that a non-blocking write can be performed, while read will be
549 * returned in case of the destination queue.
551 unsigned int v4l2_m2m_poll(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
552 struct poll_table_struct *wait)
554 struct video_device *vfd = video_devdata(file);
555 unsigned long req_events = poll_requested_events(wait);
556 struct vb2_queue *src_q, *dst_q;
557 struct vb2_buffer *src_vb = NULL, *dst_vb = NULL;
561 if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags)) {
562 struct v4l2_fh *fh = file->private_data;
564 if (v4l2_event_pending(fh))
566 else if (req_events & POLLPRI)
567 poll_wait(file, &fh->wait, wait);
568 if (!(req_events & (POLLOUT | POLLWRNORM | POLLIN | POLLRDNORM)))
572 src_q = v4l2_m2m_get_src_vq(m2m_ctx);
573 dst_q = v4l2_m2m_get_dst_vq(m2m_ctx);
576 * There has to be at least one buffer queued on each queued_list, which
577 * means either in driver already or waiting for driver to claim it
578 * and start processing.
580 if ((!src_q->streaming || list_empty(&src_q->queued_list))
581 && (!dst_q->streaming || list_empty(&dst_q->queued_list))) {
586 if (m2m_ctx->m2m_dev->m2m_ops->unlock)
587 m2m_ctx->m2m_dev->m2m_ops->unlock(m2m_ctx->priv);
588 else if (m2m_ctx->q_lock)
589 mutex_unlock(m2m_ctx->q_lock);
591 if (list_empty(&src_q->done_list))
592 poll_wait(file, &src_q->done_wq, wait);
593 if (list_empty(&dst_q->done_list)) {
595 * If the last buffer was dequeued from the capture queue,
596 * return immediately. DQBUF will return -EPIPE.
598 if (dst_q->last_buffer_dequeued)
599 return rc | POLLIN | POLLRDNORM;
601 poll_wait(file, &dst_q->done_wq, wait);
604 if (m2m_ctx->m2m_dev->m2m_ops->lock)
605 m2m_ctx->m2m_dev->m2m_ops->lock(m2m_ctx->priv);
606 else if (m2m_ctx->q_lock) {
607 if (mutex_lock_interruptible(m2m_ctx->q_lock)) {
613 spin_lock_irqsave(&src_q->done_lock, flags);
614 if (!list_empty(&src_q->done_list))
615 src_vb = list_first_entry(&src_q->done_list, struct vb2_buffer,
617 if (src_vb && (src_vb->state == VB2_BUF_STATE_DONE
618 || src_vb->state == VB2_BUF_STATE_ERROR))
619 rc |= POLLOUT | POLLWRNORM;
620 spin_unlock_irqrestore(&src_q->done_lock, flags);
622 spin_lock_irqsave(&dst_q->done_lock, flags);
623 if (!list_empty(&dst_q->done_list))
624 dst_vb = list_first_entry(&dst_q->done_list, struct vb2_buffer,
626 if (dst_vb && (dst_vb->state == VB2_BUF_STATE_DONE
627 || dst_vb->state == VB2_BUF_STATE_ERROR))
628 rc |= POLLIN | POLLRDNORM;
629 spin_unlock_irqrestore(&dst_q->done_lock, flags);
634 EXPORT_SYMBOL_GPL(v4l2_m2m_poll);
637 * v4l2_m2m_mmap() - source and destination queues-aware mmap multiplexer
639 * Call from driver's mmap() function. Will handle mmap() for both queues
640 * seamlessly for videobuffer, which will receive normal per-queue offsets and
641 * proper videobuf queue pointers. The differentiation is made outside videobuf
642 * by adding a predefined offset to buffers from one of the queues and
643 * subtracting it before passing it back to videobuf. Only drivers (and
644 * thus applications) receive modified offsets.
646 int v4l2_m2m_mmap(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
647 struct vm_area_struct *vma)
649 unsigned long offset = vma->vm_pgoff << PAGE_SHIFT;
650 struct vb2_queue *vq;
652 if (offset < DST_QUEUE_OFF_BASE) {
653 vq = v4l2_m2m_get_src_vq(m2m_ctx);
655 vq = v4l2_m2m_get_dst_vq(m2m_ctx);
656 vma->vm_pgoff -= (DST_QUEUE_OFF_BASE >> PAGE_SHIFT);
659 return vb2_mmap(vq, vma);
661 EXPORT_SYMBOL(v4l2_m2m_mmap);
664 * v4l2_m2m_init() - initialize per-driver m2m data
666 * Usually called from driver's probe() function.
668 struct v4l2_m2m_dev *v4l2_m2m_init(const struct v4l2_m2m_ops *m2m_ops)
670 struct v4l2_m2m_dev *m2m_dev;
672 if (!m2m_ops || WARN_ON(!m2m_ops->device_run) ||
673 WARN_ON(!m2m_ops->job_abort))
674 return ERR_PTR(-EINVAL);
676 m2m_dev = kzalloc(sizeof *m2m_dev, GFP_KERNEL);
678 return ERR_PTR(-ENOMEM);
680 m2m_dev->curr_ctx = NULL;
681 m2m_dev->m2m_ops = m2m_ops;
682 INIT_LIST_HEAD(&m2m_dev->job_queue);
683 spin_lock_init(&m2m_dev->job_spinlock);
687 EXPORT_SYMBOL_GPL(v4l2_m2m_init);
690 * v4l2_m2m_release() - cleans up and frees a m2m_dev structure
692 * Usually called from driver's remove() function.
694 void v4l2_m2m_release(struct v4l2_m2m_dev *m2m_dev)
698 EXPORT_SYMBOL_GPL(v4l2_m2m_release);
701 * v4l2_m2m_ctx_init() - allocate and initialize a m2m context
702 * @priv - driver's instance private data
703 * @m2m_dev - a previously initialized m2m_dev struct
704 * @vq_init - a callback for queue type-specific initialization function to be
705 * used for initializing videobuf_queues
707 * Usually called from driver's open() function.
709 struct v4l2_m2m_ctx *v4l2_m2m_ctx_init(struct v4l2_m2m_dev *m2m_dev,
711 int (*queue_init)(void *priv, struct vb2_queue *src_vq, struct vb2_queue *dst_vq))
713 struct v4l2_m2m_ctx *m2m_ctx;
714 struct v4l2_m2m_queue_ctx *out_q_ctx, *cap_q_ctx;
717 m2m_ctx = kzalloc(sizeof *m2m_ctx, GFP_KERNEL);
719 return ERR_PTR(-ENOMEM);
721 m2m_ctx->priv = drv_priv;
722 m2m_ctx->m2m_dev = m2m_dev;
723 init_waitqueue_head(&m2m_ctx->finished);
725 out_q_ctx = &m2m_ctx->out_q_ctx;
726 cap_q_ctx = &m2m_ctx->cap_q_ctx;
728 INIT_LIST_HEAD(&out_q_ctx->rdy_queue);
729 INIT_LIST_HEAD(&cap_q_ctx->rdy_queue);
730 spin_lock_init(&out_q_ctx->rdy_spinlock);
731 spin_lock_init(&cap_q_ctx->rdy_spinlock);
733 INIT_LIST_HEAD(&m2m_ctx->queue);
735 ret = queue_init(drv_priv, &out_q_ctx->q, &cap_q_ctx->q);
740 * If both queues use same mutex assign it as the common buffer
741 * queues lock to the m2m context. This lock is used in the
742 * v4l2_m2m_ioctl_* helpers.
744 if (out_q_ctx->q.lock == cap_q_ctx->q.lock)
745 m2m_ctx->q_lock = out_q_ctx->q.lock;
752 EXPORT_SYMBOL_GPL(v4l2_m2m_ctx_init);
755 * v4l2_m2m_ctx_release() - release m2m context
757 * Usually called from driver's release() function.
759 void v4l2_m2m_ctx_release(struct v4l2_m2m_ctx *m2m_ctx)
761 /* wait until the current context is dequeued from job_queue */
762 v4l2_m2m_cancel_job(m2m_ctx);
764 vb2_queue_release(&m2m_ctx->cap_q_ctx.q);
765 vb2_queue_release(&m2m_ctx->out_q_ctx.q);
769 EXPORT_SYMBOL_GPL(v4l2_m2m_ctx_release);
772 * v4l2_m2m_buf_queue() - add a buffer to the proper ready buffers list.
774 * Call from buf_queue(), videobuf_queue_ops callback.
776 void v4l2_m2m_buf_queue(struct v4l2_m2m_ctx *m2m_ctx, struct vb2_buffer *vb)
778 struct v4l2_m2m_buffer *b = container_of(vb, struct v4l2_m2m_buffer, vb);
779 struct v4l2_m2m_queue_ctx *q_ctx;
782 q_ctx = get_queue_ctx(m2m_ctx, vb->vb2_queue->type);
786 spin_lock_irqsave(&q_ctx->rdy_spinlock, flags);
787 list_add_tail(&b->list, &q_ctx->rdy_queue);
789 spin_unlock_irqrestore(&q_ctx->rdy_spinlock, flags);
791 EXPORT_SYMBOL_GPL(v4l2_m2m_buf_queue);
793 /* Videobuf2 ioctl helpers */
795 int v4l2_m2m_ioctl_reqbufs(struct file *file, void *priv,
796 struct v4l2_requestbuffers *rb)
798 struct v4l2_fh *fh = file->private_data;
800 return v4l2_m2m_reqbufs(file, fh->m2m_ctx, rb);
802 EXPORT_SYMBOL_GPL(v4l2_m2m_ioctl_reqbufs);
804 int v4l2_m2m_ioctl_create_bufs(struct file *file, void *priv,
805 struct v4l2_create_buffers *create)
807 struct v4l2_fh *fh = file->private_data;
809 return v4l2_m2m_create_bufs(file, fh->m2m_ctx, create);
811 EXPORT_SYMBOL_GPL(v4l2_m2m_ioctl_create_bufs);
813 int v4l2_m2m_ioctl_querybuf(struct file *file, void *priv,
814 struct v4l2_buffer *buf)
816 struct v4l2_fh *fh = file->private_data;
818 return v4l2_m2m_querybuf(file, fh->m2m_ctx, buf);
820 EXPORT_SYMBOL_GPL(v4l2_m2m_ioctl_querybuf);
822 int v4l2_m2m_ioctl_qbuf(struct file *file, void *priv,
823 struct v4l2_buffer *buf)
825 struct v4l2_fh *fh = file->private_data;
827 return v4l2_m2m_qbuf(file, fh->m2m_ctx, buf);
829 EXPORT_SYMBOL_GPL(v4l2_m2m_ioctl_qbuf);
831 int v4l2_m2m_ioctl_dqbuf(struct file *file, void *priv,
832 struct v4l2_buffer *buf)
834 struct v4l2_fh *fh = file->private_data;
836 return v4l2_m2m_dqbuf(file, fh->m2m_ctx, buf);
838 EXPORT_SYMBOL_GPL(v4l2_m2m_ioctl_dqbuf);
840 int v4l2_m2m_ioctl_prepare_buf(struct file *file, void *priv,
841 struct v4l2_buffer *buf)
843 struct v4l2_fh *fh = file->private_data;
845 return v4l2_m2m_prepare_buf(file, fh->m2m_ctx, buf);
847 EXPORT_SYMBOL_GPL(v4l2_m2m_ioctl_prepare_buf);
849 int v4l2_m2m_ioctl_expbuf(struct file *file, void *priv,
850 struct v4l2_exportbuffer *eb)
852 struct v4l2_fh *fh = file->private_data;
854 return v4l2_m2m_expbuf(file, fh->m2m_ctx, eb);
856 EXPORT_SYMBOL_GPL(v4l2_m2m_ioctl_expbuf);
858 int v4l2_m2m_ioctl_streamon(struct file *file, void *priv,
859 enum v4l2_buf_type type)
861 struct v4l2_fh *fh = file->private_data;
863 return v4l2_m2m_streamon(file, fh->m2m_ctx, type);
865 EXPORT_SYMBOL_GPL(v4l2_m2m_ioctl_streamon);
867 int v4l2_m2m_ioctl_streamoff(struct file *file, void *priv,
868 enum v4l2_buf_type type)
870 struct v4l2_fh *fh = file->private_data;
872 return v4l2_m2m_streamoff(file, fh->m2m_ctx, type);
874 EXPORT_SYMBOL_GPL(v4l2_m2m_ioctl_streamoff);
877 * v4l2_file_operations helpers. It is assumed here same lock is used
878 * for the output and the capture buffer queue.
881 int v4l2_m2m_fop_mmap(struct file *file, struct vm_area_struct *vma)
883 struct v4l2_fh *fh = file->private_data;
885 return v4l2_m2m_mmap(file, fh->m2m_ctx, vma);
887 EXPORT_SYMBOL_GPL(v4l2_m2m_fop_mmap);
889 unsigned int v4l2_m2m_fop_poll(struct file *file, poll_table *wait)
891 struct v4l2_fh *fh = file->private_data;
892 struct v4l2_m2m_ctx *m2m_ctx = fh->m2m_ctx;
896 mutex_lock(m2m_ctx->q_lock);
898 ret = v4l2_m2m_poll(file, m2m_ctx, wait);
901 mutex_unlock(m2m_ctx->q_lock);
905 EXPORT_SYMBOL_GPL(v4l2_m2m_fop_poll);