]>
git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - drivers/media/video/v4l2-mem2mem.c
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, <p.osciak@samsung.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>
23 MODULE_DESCRIPTION("Mem to mem device framework for videobuf");
24 MODULE_AUTHOR("Pawel Osciak, <p.osciak@samsung.com>");
25 MODULE_LICENSE("GPL");
28 module_param(debug
, bool, 0644);
30 #define dprintk(fmt, arg...) \
33 printk(KERN_DEBUG "%s: " fmt, __func__, ## arg);\
37 /* Instance is already queued on the job_queue */
38 #define TRANS_QUEUED (1 << 0)
39 /* Instance is currently running in hardware */
40 #define TRANS_RUNNING (1 << 1)
43 /* Offset base for buffers on the destination queue - used to distinguish
44 * between source and destination buffers when mmapping - they receive the same
45 * offsets but for different queues */
46 #define DST_QUEUE_OFF_BASE (1 << 30)
50 * struct v4l2_m2m_dev - per-device context
51 * @curr_ctx: currently running instance
52 * @job_queue: instances queued to run
53 * @job_spinlock: protects job_queue
54 * @m2m_ops: driver callbacks
57 struct v4l2_m2m_ctx
*curr_ctx
;
59 struct list_head job_queue
;
60 spinlock_t job_spinlock
;
62 struct v4l2_m2m_ops
*m2m_ops
;
65 static struct v4l2_m2m_queue_ctx
*get_queue_ctx(struct v4l2_m2m_ctx
*m2m_ctx
,
66 enum v4l2_buf_type type
)
68 if (V4L2_TYPE_IS_OUTPUT(type
))
69 return &m2m_ctx
->out_q_ctx
;
71 return &m2m_ctx
->cap_q_ctx
;
75 * v4l2_m2m_get_vq() - return vb2_queue for the given type
77 struct vb2_queue
*v4l2_m2m_get_vq(struct v4l2_m2m_ctx
*m2m_ctx
,
78 enum v4l2_buf_type type
)
80 struct v4l2_m2m_queue_ctx
*q_ctx
;
82 q_ctx
= get_queue_ctx(m2m_ctx
, type
);
88 EXPORT_SYMBOL(v4l2_m2m_get_vq
);
91 * v4l2_m2m_next_buf() - return next buffer from the list of ready buffers
93 void *v4l2_m2m_next_buf(struct v4l2_m2m_queue_ctx
*q_ctx
)
95 struct v4l2_m2m_buffer
*b
= NULL
;
98 spin_lock_irqsave(&q_ctx
->rdy_spinlock
, flags
);
100 if (list_empty(&q_ctx
->rdy_queue
))
103 b
= list_entry(q_ctx
->rdy_queue
.next
, struct v4l2_m2m_buffer
, list
);
105 spin_unlock_irqrestore(&q_ctx
->rdy_spinlock
, flags
);
108 EXPORT_SYMBOL_GPL(v4l2_m2m_next_buf
);
111 * v4l2_m2m_buf_remove() - take off a buffer from the list of ready buffers and
114 void *v4l2_m2m_buf_remove(struct v4l2_m2m_queue_ctx
*q_ctx
)
116 struct v4l2_m2m_buffer
*b
= NULL
;
119 spin_lock_irqsave(&q_ctx
->rdy_spinlock
, flags
);
120 if (!list_empty(&q_ctx
->rdy_queue
)) {
121 b
= list_entry(q_ctx
->rdy_queue
.next
, struct v4l2_m2m_buffer
,
126 spin_unlock_irqrestore(&q_ctx
->rdy_spinlock
, flags
);
130 EXPORT_SYMBOL_GPL(v4l2_m2m_buf_remove
);
133 * Scheduling handlers
137 * v4l2_m2m_get_curr_priv() - return driver private data for the currently
138 * running instance or NULL if no instance is running
140 void *v4l2_m2m_get_curr_priv(struct v4l2_m2m_dev
*m2m_dev
)
145 spin_lock_irqsave(&m2m_dev
->job_spinlock
, flags
);
146 if (m2m_dev
->curr_ctx
)
147 ret
= m2m_dev
->curr_ctx
->priv
;
148 spin_unlock_irqrestore(&m2m_dev
->job_spinlock
, flags
);
152 EXPORT_SYMBOL(v4l2_m2m_get_curr_priv
);
155 * v4l2_m2m_try_run() - select next job to perform and run it if possible
157 * Get next transaction (if present) from the waiting jobs list and run it.
159 static void v4l2_m2m_try_run(struct v4l2_m2m_dev
*m2m_dev
)
163 spin_lock_irqsave(&m2m_dev
->job_spinlock
, flags
);
164 if (NULL
!= m2m_dev
->curr_ctx
) {
165 spin_unlock_irqrestore(&m2m_dev
->job_spinlock
, flags
);
166 dprintk("Another instance is running, won't run now\n");
170 if (list_empty(&m2m_dev
->job_queue
)) {
171 spin_unlock_irqrestore(&m2m_dev
->job_spinlock
, flags
);
172 dprintk("No job pending\n");
176 m2m_dev
->curr_ctx
= list_entry(m2m_dev
->job_queue
.next
,
177 struct v4l2_m2m_ctx
, queue
);
178 m2m_dev
->curr_ctx
->job_flags
|= TRANS_RUNNING
;
179 spin_unlock_irqrestore(&m2m_dev
->job_spinlock
, flags
);
181 m2m_dev
->m2m_ops
->device_run(m2m_dev
->curr_ctx
->priv
);
185 * v4l2_m2m_try_schedule() - check whether an instance is ready to be added to
186 * the pending job queue and add it if so.
187 * @m2m_ctx: m2m context assigned to the instance to be checked
189 * There are three basic requirements an instance has to meet to be able to run:
190 * 1) at least one source buffer has to be queued,
191 * 2) at least one destination buffer has to be queued,
192 * 3) streaming has to be on.
194 * There may also be additional, custom requirements. In such case the driver
195 * should supply a custom callback (job_ready in v4l2_m2m_ops) that should
196 * return 1 if the instance is ready.
197 * An example of the above could be an instance that requires more than one
198 * src/dst buffer per transaction.
200 static void v4l2_m2m_try_schedule(struct v4l2_m2m_ctx
*m2m_ctx
)
202 struct v4l2_m2m_dev
*m2m_dev
;
203 unsigned long flags_job
, flags
;
205 m2m_dev
= m2m_ctx
->m2m_dev
;
206 dprintk("Trying to schedule a job for m2m_ctx: %p\n", m2m_ctx
);
208 if (!m2m_ctx
->out_q_ctx
.q
.streaming
209 || !m2m_ctx
->cap_q_ctx
.q
.streaming
) {
210 dprintk("Streaming needs to be on for both queues\n");
214 spin_lock_irqsave(&m2m_dev
->job_spinlock
, flags_job
);
215 if (m2m_ctx
->job_flags
& TRANS_QUEUED
) {
216 spin_unlock_irqrestore(&m2m_dev
->job_spinlock
, flags_job
);
217 dprintk("On job queue already\n");
221 spin_lock_irqsave(&m2m_ctx
->out_q_ctx
.rdy_spinlock
, flags
);
222 if (list_empty(&m2m_ctx
->out_q_ctx
.rdy_queue
)) {
223 spin_unlock_irqrestore(&m2m_ctx
->out_q_ctx
.rdy_spinlock
, flags
);
224 spin_unlock_irqrestore(&m2m_dev
->job_spinlock
, flags_job
);
225 dprintk("No input buffers available\n");
228 if (list_empty(&m2m_ctx
->cap_q_ctx
.rdy_queue
)) {
229 spin_unlock_irqrestore(&m2m_ctx
->out_q_ctx
.rdy_spinlock
, flags
);
230 spin_unlock_irqrestore(&m2m_dev
->job_spinlock
, flags_job
);
231 dprintk("No output buffers available\n");
234 spin_unlock_irqrestore(&m2m_ctx
->out_q_ctx
.rdy_spinlock
, flags
);
236 if (m2m_dev
->m2m_ops
->job_ready
237 && (!m2m_dev
->m2m_ops
->job_ready(m2m_ctx
->priv
))) {
238 spin_unlock_irqrestore(&m2m_dev
->job_spinlock
, flags_job
);
239 dprintk("Driver not ready\n");
243 list_add_tail(&m2m_ctx
->queue
, &m2m_dev
->job_queue
);
244 m2m_ctx
->job_flags
|= TRANS_QUEUED
;
246 spin_unlock_irqrestore(&m2m_dev
->job_spinlock
, flags_job
);
248 v4l2_m2m_try_run(m2m_dev
);
252 * v4l2_m2m_job_finish() - inform the framework that a job has been finished
253 * and have it clean up
255 * Called by a driver to yield back the device after it has finished with it.
256 * Should be called as soon as possible after reaching a state which allows
257 * other instances to take control of the device.
259 * This function has to be called only after device_run() callback has been
260 * called on the driver. To prevent recursion, it should not be called directly
261 * from the device_run() callback though.
263 void v4l2_m2m_job_finish(struct v4l2_m2m_dev
*m2m_dev
,
264 struct v4l2_m2m_ctx
*m2m_ctx
)
268 spin_lock_irqsave(&m2m_dev
->job_spinlock
, flags
);
269 if (!m2m_dev
->curr_ctx
|| m2m_dev
->curr_ctx
!= m2m_ctx
) {
270 spin_unlock_irqrestore(&m2m_dev
->job_spinlock
, flags
);
271 dprintk("Called by an instance not currently running\n");
275 list_del(&m2m_dev
->curr_ctx
->queue
);
276 m2m_dev
->curr_ctx
->job_flags
&= ~(TRANS_QUEUED
| TRANS_RUNNING
);
277 wake_up(&m2m_dev
->curr_ctx
->finished
);
278 m2m_dev
->curr_ctx
= NULL
;
280 spin_unlock_irqrestore(&m2m_dev
->job_spinlock
, flags
);
282 /* This instance might have more buffers ready, but since we do not
283 * allow more than one job on the job_queue per instance, each has
284 * to be scheduled separately after the previous one finishes. */
285 v4l2_m2m_try_schedule(m2m_ctx
);
286 v4l2_m2m_try_run(m2m_dev
);
288 EXPORT_SYMBOL(v4l2_m2m_job_finish
);
291 * v4l2_m2m_reqbufs() - multi-queue-aware REQBUFS multiplexer
293 int v4l2_m2m_reqbufs(struct file
*file
, struct v4l2_m2m_ctx
*m2m_ctx
,
294 struct v4l2_requestbuffers
*reqbufs
)
296 struct vb2_queue
*vq
;
298 vq
= v4l2_m2m_get_vq(m2m_ctx
, reqbufs
->type
);
299 return vb2_reqbufs(vq
, reqbufs
);
301 EXPORT_SYMBOL_GPL(v4l2_m2m_reqbufs
);
304 * v4l2_m2m_querybuf() - multi-queue-aware QUERYBUF multiplexer
306 * See v4l2_m2m_mmap() documentation for details.
308 int v4l2_m2m_querybuf(struct file
*file
, struct v4l2_m2m_ctx
*m2m_ctx
,
309 struct v4l2_buffer
*buf
)
311 struct vb2_queue
*vq
;
315 vq
= v4l2_m2m_get_vq(m2m_ctx
, buf
->type
);
316 ret
= vb2_querybuf(vq
, buf
);
318 /* Adjust MMAP memory offsets for the CAPTURE queue */
319 if (buf
->memory
== V4L2_MEMORY_MMAP
&& !V4L2_TYPE_IS_OUTPUT(vq
->type
)) {
320 if (V4L2_TYPE_IS_MULTIPLANAR(vq
->type
)) {
321 for (i
= 0; i
< buf
->length
; ++i
)
322 buf
->m
.planes
[i
].m
.mem_offset
323 += DST_QUEUE_OFF_BASE
;
325 buf
->m
.offset
+= DST_QUEUE_OFF_BASE
;
331 EXPORT_SYMBOL_GPL(v4l2_m2m_querybuf
);
334 * v4l2_m2m_qbuf() - enqueue a source or destination buffer, depending on
337 int v4l2_m2m_qbuf(struct file
*file
, struct v4l2_m2m_ctx
*m2m_ctx
,
338 struct v4l2_buffer
*buf
)
340 struct vb2_queue
*vq
;
343 vq
= v4l2_m2m_get_vq(m2m_ctx
, buf
->type
);
344 ret
= vb2_qbuf(vq
, buf
);
346 v4l2_m2m_try_schedule(m2m_ctx
);
350 EXPORT_SYMBOL_GPL(v4l2_m2m_qbuf
);
353 * v4l2_m2m_dqbuf() - dequeue a source or destination buffer, depending on
356 int v4l2_m2m_dqbuf(struct file
*file
, struct v4l2_m2m_ctx
*m2m_ctx
,
357 struct v4l2_buffer
*buf
)
359 struct vb2_queue
*vq
;
361 vq
= v4l2_m2m_get_vq(m2m_ctx
, buf
->type
);
362 return vb2_dqbuf(vq
, buf
, file
->f_flags
& O_NONBLOCK
);
364 EXPORT_SYMBOL_GPL(v4l2_m2m_dqbuf
);
367 * v4l2_m2m_streamon() - turn on streaming for a video queue
369 int v4l2_m2m_streamon(struct file
*file
, struct v4l2_m2m_ctx
*m2m_ctx
,
370 enum v4l2_buf_type type
)
372 struct vb2_queue
*vq
;
375 vq
= v4l2_m2m_get_vq(m2m_ctx
, type
);
376 ret
= vb2_streamon(vq
, type
);
378 v4l2_m2m_try_schedule(m2m_ctx
);
382 EXPORT_SYMBOL_GPL(v4l2_m2m_streamon
);
385 * v4l2_m2m_streamoff() - turn off streaming for a video queue
387 int v4l2_m2m_streamoff(struct file
*file
, struct v4l2_m2m_ctx
*m2m_ctx
,
388 enum v4l2_buf_type type
)
390 struct vb2_queue
*vq
;
392 vq
= v4l2_m2m_get_vq(m2m_ctx
, type
);
393 return vb2_streamoff(vq
, type
);
395 EXPORT_SYMBOL_GPL(v4l2_m2m_streamoff
);
398 * v4l2_m2m_poll() - poll replacement, for destination buffers only
400 * Call from the driver's poll() function. Will poll both queues. If a buffer
401 * is available to dequeue (with dqbuf) from the source queue, this will
402 * indicate that a non-blocking write can be performed, while read will be
403 * returned in case of the destination queue.
405 unsigned int v4l2_m2m_poll(struct file
*file
, struct v4l2_m2m_ctx
*m2m_ctx
,
406 struct poll_table_struct
*wait
)
408 struct vb2_queue
*src_q
, *dst_q
;
409 struct vb2_buffer
*src_vb
= NULL
, *dst_vb
= NULL
;
413 src_q
= v4l2_m2m_get_src_vq(m2m_ctx
);
414 dst_q
= v4l2_m2m_get_dst_vq(m2m_ctx
);
417 * There has to be at least one buffer queued on each queued_list, which
418 * means either in driver already or waiting for driver to claim it
419 * and start processing.
421 if ((!src_q
->streaming
|| list_empty(&src_q
->queued_list
))
422 && (!dst_q
->streaming
|| list_empty(&dst_q
->queued_list
))) {
427 if (m2m_ctx
->m2m_dev
->m2m_ops
->unlock
)
428 m2m_ctx
->m2m_dev
->m2m_ops
->unlock(m2m_ctx
->priv
);
430 poll_wait(file
, &src_q
->done_wq
, wait
);
431 poll_wait(file
, &dst_q
->done_wq
, wait
);
433 if (m2m_ctx
->m2m_dev
->m2m_ops
->lock
)
434 m2m_ctx
->m2m_dev
->m2m_ops
->lock(m2m_ctx
->priv
);
436 spin_lock_irqsave(&src_q
->done_lock
, flags
);
437 if (!list_empty(&src_q
->done_list
))
438 src_vb
= list_first_entry(&src_q
->done_list
, struct vb2_buffer
,
440 if (src_vb
&& (src_vb
->state
== VB2_BUF_STATE_DONE
441 || src_vb
->state
== VB2_BUF_STATE_ERROR
))
442 rc
|= POLLOUT
| POLLWRNORM
;
443 spin_unlock_irqrestore(&src_q
->done_lock
, flags
);
445 spin_lock_irqsave(&dst_q
->done_lock
, flags
);
446 if (!list_empty(&dst_q
->done_list
))
447 dst_vb
= list_first_entry(&dst_q
->done_list
, struct vb2_buffer
,
449 if (dst_vb
&& (dst_vb
->state
== VB2_BUF_STATE_DONE
450 || dst_vb
->state
== VB2_BUF_STATE_ERROR
))
451 rc
|= POLLIN
| POLLRDNORM
;
452 spin_unlock_irqrestore(&dst_q
->done_lock
, flags
);
457 EXPORT_SYMBOL_GPL(v4l2_m2m_poll
);
460 * v4l2_m2m_mmap() - source and destination queues-aware mmap multiplexer
462 * Call from driver's mmap() function. Will handle mmap() for both queues
463 * seamlessly for videobuffer, which will receive normal per-queue offsets and
464 * proper videobuf queue pointers. The differentiation is made outside videobuf
465 * by adding a predefined offset to buffers from one of the queues and
466 * subtracting it before passing it back to videobuf. Only drivers (and
467 * thus applications) receive modified offsets.
469 int v4l2_m2m_mmap(struct file
*file
, struct v4l2_m2m_ctx
*m2m_ctx
,
470 struct vm_area_struct
*vma
)
472 unsigned long offset
= vma
->vm_pgoff
<< PAGE_SHIFT
;
473 struct vb2_queue
*vq
;
475 if (offset
< DST_QUEUE_OFF_BASE
) {
476 vq
= v4l2_m2m_get_src_vq(m2m_ctx
);
478 vq
= v4l2_m2m_get_dst_vq(m2m_ctx
);
479 vma
->vm_pgoff
-= (DST_QUEUE_OFF_BASE
>> PAGE_SHIFT
);
482 return vb2_mmap(vq
, vma
);
484 EXPORT_SYMBOL(v4l2_m2m_mmap
);
487 * v4l2_m2m_init() - initialize per-driver m2m data
489 * Usually called from driver's probe() function.
491 struct v4l2_m2m_dev
*v4l2_m2m_init(struct v4l2_m2m_ops
*m2m_ops
)
493 struct v4l2_m2m_dev
*m2m_dev
;
496 return ERR_PTR(-EINVAL
);
498 BUG_ON(!m2m_ops
->device_run
);
499 BUG_ON(!m2m_ops
->job_abort
);
501 m2m_dev
= kzalloc(sizeof *m2m_dev
, GFP_KERNEL
);
503 return ERR_PTR(-ENOMEM
);
505 m2m_dev
->curr_ctx
= NULL
;
506 m2m_dev
->m2m_ops
= m2m_ops
;
507 INIT_LIST_HEAD(&m2m_dev
->job_queue
);
508 spin_lock_init(&m2m_dev
->job_spinlock
);
512 EXPORT_SYMBOL_GPL(v4l2_m2m_init
);
515 * v4l2_m2m_release() - cleans up and frees a m2m_dev structure
517 * Usually called from driver's remove() function.
519 void v4l2_m2m_release(struct v4l2_m2m_dev
*m2m_dev
)
523 EXPORT_SYMBOL_GPL(v4l2_m2m_release
);
526 * v4l2_m2m_ctx_init() - allocate and initialize a m2m context
527 * @priv - driver's instance private data
528 * @m2m_dev - a previously initialized m2m_dev struct
529 * @vq_init - a callback for queue type-specific initialization function to be
530 * used for initializing videobuf_queues
532 * Usually called from driver's open() function.
534 struct v4l2_m2m_ctx
*v4l2_m2m_ctx_init(struct v4l2_m2m_dev
*m2m_dev
,
536 int (*queue_init
)(void *priv
, struct vb2_queue
*src_vq
, struct vb2_queue
*dst_vq
))
538 struct v4l2_m2m_ctx
*m2m_ctx
;
539 struct v4l2_m2m_queue_ctx
*out_q_ctx
, *cap_q_ctx
;
542 m2m_ctx
= kzalloc(sizeof *m2m_ctx
, GFP_KERNEL
);
544 return ERR_PTR(-ENOMEM
);
546 m2m_ctx
->priv
= drv_priv
;
547 m2m_ctx
->m2m_dev
= m2m_dev
;
548 init_waitqueue_head(&m2m_ctx
->finished
);
550 out_q_ctx
= &m2m_ctx
->out_q_ctx
;
551 cap_q_ctx
= &m2m_ctx
->cap_q_ctx
;
553 INIT_LIST_HEAD(&out_q_ctx
->rdy_queue
);
554 INIT_LIST_HEAD(&cap_q_ctx
->rdy_queue
);
555 spin_lock_init(&out_q_ctx
->rdy_spinlock
);
556 spin_lock_init(&cap_q_ctx
->rdy_spinlock
);
558 INIT_LIST_HEAD(&m2m_ctx
->queue
);
560 ret
= queue_init(drv_priv
, &out_q_ctx
->q
, &cap_q_ctx
->q
);
570 EXPORT_SYMBOL_GPL(v4l2_m2m_ctx_init
);
573 * v4l2_m2m_ctx_release() - release m2m context
575 * Usually called from driver's release() function.
577 void v4l2_m2m_ctx_release(struct v4l2_m2m_ctx
*m2m_ctx
)
579 struct v4l2_m2m_dev
*m2m_dev
;
582 m2m_dev
= m2m_ctx
->m2m_dev
;
584 spin_lock_irqsave(&m2m_dev
->job_spinlock
, flags
);
585 if (m2m_ctx
->job_flags
& TRANS_RUNNING
) {
586 spin_unlock_irqrestore(&m2m_dev
->job_spinlock
, flags
);
587 m2m_dev
->m2m_ops
->job_abort(m2m_ctx
->priv
);
588 dprintk("m2m_ctx %p running, will wait to complete", m2m_ctx
);
589 wait_event(m2m_ctx
->finished
, !(m2m_ctx
->job_flags
& TRANS_RUNNING
));
590 } else if (m2m_ctx
->job_flags
& TRANS_QUEUED
) {
591 list_del(&m2m_ctx
->queue
);
592 m2m_ctx
->job_flags
&= ~(TRANS_QUEUED
| TRANS_RUNNING
);
593 spin_unlock_irqrestore(&m2m_dev
->job_spinlock
, flags
);
594 dprintk("m2m_ctx: %p had been on queue and was removed\n",
597 /* Do nothing, was not on queue/running */
598 spin_unlock_irqrestore(&m2m_dev
->job_spinlock
, flags
);
601 vb2_queue_release(&m2m_ctx
->cap_q_ctx
.q
);
602 vb2_queue_release(&m2m_ctx
->out_q_ctx
.q
);
606 EXPORT_SYMBOL_GPL(v4l2_m2m_ctx_release
);
609 * v4l2_m2m_buf_queue() - add a buffer to the proper ready buffers list.
611 * Call from buf_queue(), videobuf_queue_ops callback.
613 void v4l2_m2m_buf_queue(struct v4l2_m2m_ctx
*m2m_ctx
, struct vb2_buffer
*vb
)
615 struct v4l2_m2m_buffer
*b
= container_of(vb
, struct v4l2_m2m_buffer
, vb
);
616 struct v4l2_m2m_queue_ctx
*q_ctx
;
619 q_ctx
= get_queue_ctx(m2m_ctx
, vb
->vb2_queue
->type
);
623 spin_lock_irqsave(&q_ctx
->rdy_spinlock
, flags
);
624 list_add_tail(&b
->list
, &q_ctx
->rdy_queue
);
626 spin_unlock_irqrestore(&q_ctx
->rdy_spinlock
, flags
);
628 EXPORT_SYMBOL_GPL(v4l2_m2m_buf_queue
);