2 * generic helper functions for handling video4linux capture buffers
4 * (c) 2007 Mauro Carvalho Chehab, <mchehab@infradead.org>
6 * Highly based on video-buf written originally by:
7 * (c) 2001,02 Gerd Knorr <kraxel@bytesex.org>
8 * (c) 2006 Mauro Carvalho Chehab, <mchehab@infradead.org>
9 * (c) 2006 Ted Walther and John Sokol
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
13 * the Free Software Foundation; either version 2
16 #include <linux/init.h>
17 #include <linux/module.h>
18 #include <linux/moduleparam.h>
19 #include <linux/slab.h>
20 #include <linux/interrupt.h>
22 #include <media/videobuf-core.h>
24 #define MAGIC_BUFFER 0x20070728
25 #define MAGIC_CHECK(is,should) if (unlikely((is) != (should))) \
26 { printk(KERN_ERR "magic mismatch: %x (expected %x)\n",is,should); BUG(); }
29 module_param(debug, int, 0644);
31 MODULE_DESCRIPTION("helper module to manage video4linux buffers");
32 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@infradead.org>");
33 MODULE_LICENSE("GPL");
35 #define dprintk(level, fmt, arg...) if (debug >= level) \
36 printk(KERN_DEBUG "vbuf: " fmt , ## arg)
38 /* --------------------------------------------------------------------- */
40 #define CALL(q, f, arg...) \
41 ( (q->int_ops->f)? q->int_ops->f(arg) : 0)
43 void* videobuf_alloc(struct videobuf_queue* q)
45 struct videobuf_buffer *vb;
47 BUG_ON (q->msize<sizeof(*vb));
49 if (!q->int_ops || !q->int_ops->alloc) {
50 printk(KERN_ERR "No specific ops defined!\n");
54 vb = q->int_ops->alloc(q->msize);
57 init_waitqueue_head(&vb->done);
58 vb->magic = MAGIC_BUFFER;
64 int videobuf_waiton(struct videobuf_buffer *vb, int non_blocking, int intr)
67 DECLARE_WAITQUEUE(wait, current);
69 MAGIC_CHECK(vb->magic,MAGIC_BUFFER);
70 add_wait_queue(&vb->done, &wait);
71 while (vb->state == STATE_ACTIVE || vb->state == STATE_QUEUED) {
76 set_current_state(intr ? TASK_INTERRUPTIBLE
77 : TASK_UNINTERRUPTIBLE);
78 if (vb->state == STATE_ACTIVE || vb->state == STATE_QUEUED)
80 set_current_state(TASK_RUNNING);
81 if (intr && signal_pending(current)) {
82 dprintk(1,"buffer waiton: -EINTR\n");
87 remove_wait_queue(&vb->done, &wait);
91 int videobuf_iolock(struct videobuf_queue* q, struct videobuf_buffer *vb,
92 struct v4l2_framebuffer *fbuf)
94 MAGIC_CHECK(vb->magic,MAGIC_BUFFER);
95 MAGIC_CHECK(q->int_ops->magic,MAGIC_QTYPE_OPS);
97 return CALL(q,iolock,q,vb,fbuf);
100 /* --------------------------------------------------------------------- */
103 void videobuf_queue_init(struct videobuf_queue* q,
104 struct videobuf_queue_ops *ops,
107 enum v4l2_buf_type type,
108 enum v4l2_field field,
112 memset(q,0,sizeof(*q));
113 q->irqlock = irqlock;
121 /* All buffer operations are mandatory */
122 BUG_ON (!q->ops->buf_setup);
123 BUG_ON (!q->ops->buf_prepare);
124 BUG_ON (!q->ops->buf_queue);
125 BUG_ON (!q->ops->buf_release);
127 mutex_init(&q->lock);
128 INIT_LIST_HEAD(&q->stream);
131 int videobuf_queue_is_busy(struct videobuf_queue *q)
135 MAGIC_CHECK(q->int_ops->magic,MAGIC_QTYPE_OPS);
138 dprintk(1,"busy: streaming active\n");
142 dprintk(1,"busy: pending read #1\n");
146 dprintk(1,"busy: pending read #2\n");
149 for (i = 0; i < VIDEO_MAX_FRAME; i++) {
150 if (NULL == q->bufs[i])
152 if (q->bufs[i]->map) {
153 dprintk(1,"busy: buffer #%d mapped\n",i);
156 if (q->bufs[i]->state == STATE_QUEUED) {
157 dprintk(1,"busy: buffer #%d queued\n",i);
160 if (q->bufs[i]->state == STATE_ACTIVE) {
161 dprintk(1,"busy: buffer #%d avtive\n",i);
168 void videobuf_queue_cancel(struct videobuf_queue *q)
170 unsigned long flags=0;
173 /* remove queued buffers from list */
175 spin_lock_irqsave(q->irqlock,flags);
176 for (i = 0; i < VIDEO_MAX_FRAME; i++) {
177 if (NULL == q->bufs[i])
179 if (q->bufs[i]->state == STATE_QUEUED) {
180 list_del(&q->bufs[i]->queue);
181 q->bufs[i]->state = STATE_ERROR;
185 spin_unlock_irqrestore(q->irqlock,flags);
187 /* free all buffers + clear queue */
188 for (i = 0; i < VIDEO_MAX_FRAME; i++) {
189 if (NULL == q->bufs[i])
191 q->ops->buf_release(q,q->bufs[i]);
193 INIT_LIST_HEAD(&q->stream);
196 /* --------------------------------------------------------------------- */
198 enum v4l2_field videobuf_next_field(struct videobuf_queue *q)
200 enum v4l2_field field = q->field;
202 BUG_ON(V4L2_FIELD_ANY == field);
204 if (V4L2_FIELD_ALTERNATE == field) {
205 if (V4L2_FIELD_TOP == q->last) {
206 field = V4L2_FIELD_BOTTOM;
207 q->last = V4L2_FIELD_BOTTOM;
209 field = V4L2_FIELD_TOP;
210 q->last = V4L2_FIELD_TOP;
216 static void videobuf_status(struct videobuf_queue *q, struct v4l2_buffer *b,
217 struct videobuf_buffer *vb, enum v4l2_buf_type type)
219 MAGIC_CHECK(vb->magic,MAGIC_BUFFER);
220 MAGIC_CHECK(q->int_ops->magic,MAGIC_QTYPE_OPS);
225 b->memory = vb->memory;
227 case V4L2_MEMORY_MMAP:
228 b->m.offset = vb->boff;
229 b->length = vb->bsize;
231 case V4L2_MEMORY_USERPTR:
232 b->m.userptr = vb->baddr;
233 b->length = vb->bsize;
235 case V4L2_MEMORY_OVERLAY:
236 b->m.offset = vb->boff;
242 b->flags |= V4L2_BUF_FLAG_MAPPED;
248 b->flags |= V4L2_BUF_FLAG_QUEUED;
252 b->flags |= V4L2_BUF_FLAG_DONE;
254 case STATE_NEEDS_INIT:
260 if (vb->input != UNSET) {
261 b->flags |= V4L2_BUF_FLAG_INPUT;
262 b->input = vb->input;
265 b->field = vb->field;
266 b->timestamp = vb->ts;
267 b->bytesused = vb->size;
268 b->sequence = vb->field_count >> 1;
271 int videobuf_reqbufs(struct videobuf_queue *q,
272 struct v4l2_requestbuffers *req)
274 unsigned int size,count;
277 if (req->type != q->type) {
278 dprintk(1,"reqbufs: queue type invalid\n");
281 if (req->count < 1) {
282 dprintk(1,"reqbufs: count invalid (%d)\n",req->count);
285 if (req->memory != V4L2_MEMORY_MMAP &&
286 req->memory != V4L2_MEMORY_USERPTR &&
287 req->memory != V4L2_MEMORY_OVERLAY) {
288 dprintk(1,"reqbufs: memory type invalid\n");
293 dprintk(1,"reqbufs: streaming already exists\n");
296 if (!list_empty(&q->stream)) {
297 dprintk(1,"reqbufs: stream running\n");
301 mutex_lock(&q->lock);
303 if (count > VIDEO_MAX_FRAME)
304 count = VIDEO_MAX_FRAME;
306 q->ops->buf_setup(q,&count,&size);
307 size = PAGE_ALIGN(size);
308 dprintk(1,"reqbufs: bufs=%d, size=0x%x [%d pages total]\n",
309 count, size, (count*size)>>PAGE_SHIFT);
311 retval = videobuf_mmap_setup(q,count,size,req->memory);
313 dprintk(1,"reqbufs: mmap setup returned %d\n",retval);
320 mutex_unlock(&q->lock);
324 int videobuf_querybuf(struct videobuf_queue *q, struct v4l2_buffer *b)
326 if (unlikely(b->type != q->type)) {
327 dprintk(1,"querybuf: Wrong type.\n");
330 if (unlikely(b->index < 0 || b->index >= VIDEO_MAX_FRAME)) {
331 dprintk(1,"querybuf: index out of range.\n");
334 if (unlikely(NULL == q->bufs[b->index])) {
335 dprintk(1,"querybuf: buffer is null.\n");
338 videobuf_status(q,b,q->bufs[b->index],q->type);
342 int videobuf_qbuf(struct videobuf_queue *q,
343 struct v4l2_buffer *b)
345 struct videobuf_buffer *buf;
346 enum v4l2_field field;
347 unsigned long flags=0;
350 MAGIC_CHECK(q->int_ops->magic,MAGIC_QTYPE_OPS);
352 if (b->memory == V4L2_MEMORY_MMAP)
353 down_read(¤t->mm->mmap_sem);
355 mutex_lock(&q->lock);
358 dprintk(1,"qbuf: Reading running...\n");
362 if (b->type != q->type) {
363 dprintk(1,"qbuf: Wrong type.\n");
366 if (b->index < 0 || b->index >= VIDEO_MAX_FRAME) {
367 dprintk(1,"qbuf: index out of range.\n");
370 buf = q->bufs[b->index];
372 dprintk(1,"qbuf: buffer is null.\n");
375 MAGIC_CHECK(buf->magic,MAGIC_BUFFER);
376 if (buf->memory != b->memory) {
377 dprintk(1,"qbuf: memory type is wrong.\n");
380 if (buf->state != STATE_NEEDS_INIT && buf->state != STATE_IDLE) {
381 dprintk(1,"qbuf: buffer is already queued or active.\n");
385 if (b->flags & V4L2_BUF_FLAG_INPUT) {
386 if (b->input >= q->inputs) {
387 dprintk(1,"qbuf: wrong input.\n");
390 buf->input = b->input;
396 case V4L2_MEMORY_MMAP:
397 if (0 == buf->baddr) {
398 dprintk(1,"qbuf: mmap requested but buffer addr is zero!\n");
402 case V4L2_MEMORY_USERPTR:
403 if (b->length < buf->bsize) {
404 dprintk(1,"qbuf: buffer length is not enough\n");
407 if (STATE_NEEDS_INIT != buf->state && buf->baddr != b->m.userptr)
408 q->ops->buf_release(q,buf);
409 buf->baddr = b->m.userptr;
411 case V4L2_MEMORY_OVERLAY:
412 buf->boff = b->m.offset;
415 dprintk(1,"qbuf: wrong memory type\n");
419 dprintk(1,"qbuf: requesting next field\n");
420 field = videobuf_next_field(q);
421 retval = q->ops->buf_prepare(q,buf,field);
423 dprintk(1,"qbuf: buffer_prepare returned %d\n",retval);
427 list_add_tail(&buf->stream,&q->stream);
430 spin_lock_irqsave(q->irqlock,flags);
431 q->ops->buf_queue(q,buf);
433 spin_unlock_irqrestore(q->irqlock,flags);
435 dprintk(1,"qbuf: succeded\n");
439 mutex_unlock(&q->lock);
441 if (b->memory == V4L2_MEMORY_MMAP)
442 up_read(¤t->mm->mmap_sem);
447 int videobuf_dqbuf(struct videobuf_queue *q,
448 struct v4l2_buffer *b, int nonblocking)
450 struct videobuf_buffer *buf;
453 MAGIC_CHECK(q->int_ops->magic,MAGIC_QTYPE_OPS);
455 mutex_lock(&q->lock);
458 dprintk(1,"dqbuf: Reading running...\n");
462 if (b->type != q->type) {
463 dprintk(1,"dqbuf: Wrong type.\n");
466 if (list_empty(&q->stream)) {
467 dprintk(1,"dqbuf: stream running\n");
470 buf = list_entry(q->stream.next, struct videobuf_buffer, stream);
471 retval = videobuf_waiton(buf, nonblocking, 1);
473 dprintk(1,"dqbuf: waiton returned %d\n",retval);
476 switch (buf->state) {
478 dprintk(1,"dqbuf: state is error\n");
481 buf->state = STATE_IDLE;
484 dprintk(1,"dqbuf: state is done\n");
486 buf->state = STATE_IDLE;
489 dprintk(1,"dqbuf: state invalid\n");
493 list_del(&buf->stream);
494 memset(b,0,sizeof(*b));
495 videobuf_status(q,b,buf,q->type);
498 mutex_unlock(&q->lock);
502 int videobuf_streamon(struct videobuf_queue *q)
504 struct videobuf_buffer *buf;
505 struct list_head *list;
506 unsigned long flags=0;
509 mutex_lock(&q->lock);
518 spin_lock_irqsave(q->irqlock,flags);
519 list_for_each(list,&q->stream) {
520 buf = list_entry(list, struct videobuf_buffer, stream);
521 if (buf->state == STATE_PREPARED)
522 q->ops->buf_queue(q,buf);
525 spin_unlock_irqrestore(q->irqlock,flags);
528 mutex_unlock(&q->lock);
532 int videobuf_streamoff(struct videobuf_queue *q)
534 int retval = -EINVAL;
536 mutex_lock(&q->lock);
539 videobuf_queue_cancel(q);
544 mutex_unlock(&q->lock);
548 static ssize_t videobuf_read_zerocopy(struct videobuf_queue *q,
550 size_t count, loff_t *ppos)
552 enum v4l2_field field;
553 unsigned long flags=0;
556 MAGIC_CHECK(q->int_ops->magic,MAGIC_QTYPE_OPS);
559 q->read_buf = videobuf_alloc(q);
560 if (NULL == q->read_buf)
563 q->read_buf->memory = V4L2_MEMORY_USERPTR;
564 q->read_buf->baddr = (unsigned long)data;
565 q->read_buf->bsize = count;
567 field = videobuf_next_field(q);
568 retval = q->ops->buf_prepare(q,q->read_buf,field);
572 /* start capture & wait */
574 spin_lock_irqsave(q->irqlock,flags);
575 q->ops->buf_queue(q,q->read_buf);
577 spin_unlock_irqrestore(q->irqlock,flags);
578 retval = videobuf_waiton(q->read_buf,0,0);
580 CALL(q,sync,q,q->read_buf);
581 if (STATE_ERROR == q->read_buf->state)
584 retval = q->read_buf->size;
589 q->ops->buf_release(q,q->read_buf);
595 ssize_t videobuf_read_one(struct videobuf_queue *q,
596 char __user *data, size_t count, loff_t *ppos,
599 enum v4l2_field field;
600 unsigned long flags=0;
601 unsigned size, nbufs;
604 MAGIC_CHECK(q->int_ops->magic,MAGIC_QTYPE_OPS);
606 mutex_lock(&q->lock);
609 q->ops->buf_setup(q,&nbufs,&size);
611 if (NULL == q->read_buf &&
614 retval = videobuf_read_zerocopy(q,data,count,ppos);
615 if (retval >= 0 || retval == -EIO)
618 /* fallback to kernel bounce buffer on failures */
621 if (NULL == q->read_buf) {
622 /* need to capture a new frame */
624 q->read_buf = videobuf_alloc(q);
626 dprintk(1,"video alloc=0x%p\n", q->read_buf);
627 if (NULL == q->read_buf)
629 q->read_buf->memory = V4L2_MEMORY_USERPTR;
630 q->read_buf->bsize = count; /* preferred size */
631 field = videobuf_next_field(q);
632 retval = q->ops->buf_prepare(q,q->read_buf,field);
640 spin_lock_irqsave(q->irqlock,flags);
642 q->ops->buf_queue(q,q->read_buf);
644 spin_unlock_irqrestore(q->irqlock,flags);
648 /* wait until capture is done */
649 retval = videobuf_waiton(q->read_buf, nonblocking, 1);
653 CALL(q,sync,q,q->read_buf);
655 if (STATE_ERROR == q->read_buf->state) {
656 /* catch I/O errors */
657 q->ops->buf_release(q,q->read_buf);
664 /* Copy to userspace */
665 retval=CALL(q,copy_to_user,q,data,count,nonblocking);
669 q->read_off += retval;
670 if (q->read_off == q->read_buf->size) {
671 /* all data copied, cleanup */
672 q->ops->buf_release(q,q->read_buf);
678 mutex_unlock(&q->lock);
682 int videobuf_read_start(struct videobuf_queue *q)
684 enum v4l2_field field;
685 unsigned long flags=0;
686 int count = 0, size = 0;
689 q->ops->buf_setup(q,&count,&size);
692 if (count > VIDEO_MAX_FRAME)
693 count = VIDEO_MAX_FRAME;
694 size = PAGE_ALIGN(size);
696 err = videobuf_mmap_setup(q, count, size, V4L2_MEMORY_USERPTR);
700 for (i = 0; i < count; i++) {
701 field = videobuf_next_field(q);
702 err = q->ops->buf_prepare(q,q->bufs[i],field);
705 list_add_tail(&q->bufs[i]->stream, &q->stream);
708 spin_lock_irqsave(q->irqlock,flags);
709 for (i = 0; i < count; i++)
710 q->ops->buf_queue(q,q->bufs[i]);
712 spin_unlock_irqrestore(q->irqlock,flags);
717 void videobuf_read_stop(struct videobuf_queue *q)
721 videobuf_queue_cancel(q);
722 videobuf_mmap_free(q);
723 INIT_LIST_HEAD(&q->stream);
724 for (i = 0; i < VIDEO_MAX_FRAME; i++) {
725 if (NULL == q->bufs[i])
734 ssize_t videobuf_read_stream(struct videobuf_queue *q,
735 char __user *data, size_t count, loff_t *ppos,
736 int vbihack, int nonblocking)
739 unsigned long flags=0;
741 MAGIC_CHECK(q->int_ops->magic,MAGIC_QTYPE_OPS);
743 dprintk(2,"%s\n",__FUNCTION__);
744 mutex_lock(&q->lock);
749 retval = videobuf_read_start(q);
756 /* get / wait for data */
757 if (NULL == q->read_buf) {
758 q->read_buf = list_entry(q->stream.next,
759 struct videobuf_buffer,
761 list_del(&q->read_buf->stream);
764 rc = videobuf_waiton(q->read_buf, nonblocking, 1);
771 if (q->read_buf->state == STATE_DONE) {
772 rc = CALL (q,copy_stream, q, data, count,
773 retval, vbihack, nonblocking);
783 q->read_off = q->read_buf->size;
788 /* requeue buffer when done with copying */
789 if (q->read_off == q->read_buf->size) {
790 list_add_tail(&q->read_buf->stream,
793 spin_lock_irqsave(q->irqlock,flags);
794 q->ops->buf_queue(q,q->read_buf);
796 spin_unlock_irqrestore(q->irqlock,flags);
804 mutex_unlock(&q->lock);
808 unsigned int videobuf_poll_stream(struct file *file,
809 struct videobuf_queue *q,
812 struct videobuf_buffer *buf = NULL;
815 mutex_lock(&q->lock);
817 if (!list_empty(&q->stream))
818 buf = list_entry(q->stream.next,
819 struct videobuf_buffer, stream);
822 videobuf_read_start(q);
825 } else if (NULL == q->read_buf) {
826 q->read_buf = list_entry(q->stream.next,
827 struct videobuf_buffer,
829 list_del(&q->read_buf->stream);
838 poll_wait(file, &buf->done, wait);
839 if (buf->state == STATE_DONE ||
840 buf->state == STATE_ERROR)
841 rc = POLLIN|POLLRDNORM;
843 mutex_unlock(&q->lock);
847 int videobuf_mmap_setup(struct videobuf_queue *q,
848 unsigned int bcount, unsigned int bsize,
849 enum v4l2_memory memory)
854 MAGIC_CHECK(q->int_ops->magic,MAGIC_QTYPE_OPS);
856 err = videobuf_mmap_free(q);
860 /* Allocate and initialize buffers */
861 for (i = 0; i < bcount; i++) {
862 q->bufs[i] = videobuf_alloc(q);
865 q->bufs[i]->input = UNSET;
866 q->bufs[i]->memory = memory;
867 q->bufs[i]->bsize = bsize;
869 case V4L2_MEMORY_MMAP:
870 q->bufs[i]->boff = bsize * i;
872 case V4L2_MEMORY_USERPTR:
873 case V4L2_MEMORY_OVERLAY:
879 dprintk(1,"mmap setup: %d buffers, %d bytes each\n",
885 int videobuf_mmap_free(struct videobuf_queue *q)
893 MAGIC_CHECK(q->int_ops->magic,MAGIC_QTYPE_OPS);
895 rc = CALL(q,mmap_free,q);
899 for (i = 0; i < VIDEO_MAX_FRAME; i++) {
900 if (NULL == q->bufs[i])
902 q->ops->buf_release(q,q->bufs[i]);
910 int videobuf_mmap_mapper(struct videobuf_queue *q,
911 struct vm_area_struct *vma)
915 MAGIC_CHECK(q->int_ops->magic,MAGIC_QTYPE_OPS);
917 mutex_lock(&q->lock);
918 retval=CALL(q,mmap_mapper,q,vma);
919 mutex_unlock(&q->lock);
924 #ifdef CONFIG_VIDEO_V4L1_COMPAT
925 int videobuf_cgmbuf(struct videobuf_queue *q,
926 struct video_mbuf *mbuf, int count)
928 struct v4l2_requestbuffers req;
931 MAGIC_CHECK(q->int_ops->magic,MAGIC_QTYPE_OPS);
933 memset(&req,0,sizeof(req));
936 req.memory = V4L2_MEMORY_MMAP;
937 rc = videobuf_reqbufs(q,&req);
941 mbuf->frames = req.count;
943 for (i = 0; i < mbuf->frames; i++) {
944 mbuf->offsets[i] = q->bufs[i]->boff;
945 mbuf->size += q->bufs[i]->bsize;
952 /* --------------------------------------------------------------------- */
954 EXPORT_SYMBOL_GPL(videobuf_waiton);
955 EXPORT_SYMBOL_GPL(videobuf_iolock);
957 EXPORT_SYMBOL_GPL(videobuf_alloc);
959 EXPORT_SYMBOL_GPL(videobuf_queue_init);
960 EXPORT_SYMBOL_GPL(videobuf_queue_cancel);
961 EXPORT_SYMBOL_GPL(videobuf_queue_is_busy);
963 EXPORT_SYMBOL_GPL(videobuf_next_field);
964 EXPORT_SYMBOL_GPL(videobuf_reqbufs);
965 EXPORT_SYMBOL_GPL(videobuf_querybuf);
966 EXPORT_SYMBOL_GPL(videobuf_qbuf);
967 EXPORT_SYMBOL_GPL(videobuf_dqbuf);
968 EXPORT_SYMBOL_GPL(videobuf_cgmbuf);
969 EXPORT_SYMBOL_GPL(videobuf_streamon);
970 EXPORT_SYMBOL_GPL(videobuf_streamoff);
972 EXPORT_SYMBOL_GPL(videobuf_read_start);
973 EXPORT_SYMBOL_GPL(videobuf_read_stop);
974 EXPORT_SYMBOL_GPL(videobuf_read_stream);
975 EXPORT_SYMBOL_GPL(videobuf_read_one);
976 EXPORT_SYMBOL_GPL(videobuf_poll_stream);
978 EXPORT_SYMBOL_GPL(videobuf_mmap_setup);
979 EXPORT_SYMBOL_GPL(videobuf_mmap_free);
980 EXPORT_SYMBOL_GPL(videobuf_mmap_mapper);