2 * helper functions for SG DMA video4linux capture buffers
4 * The functions expect the hardware being able to scatter gatter
5 * (i.e. the buffers are not linear in physical memory, but fragmented
6 * into PAGE_SIZE chunks). They also assume the driver does not need
7 * to touch the video data.
9 * (c) 2007 Mauro Carvalho Chehab, <mchehab@infradead.org>
11 * Highly based on video-buf written originally by:
12 * (c) 2001,02 Gerd Knorr <kraxel@bytesex.org>
13 * (c) 2006 Mauro Carvalho Chehab, <mchehab@infradead.org>
14 * (c) 2006 Ted Walther and John Sokol
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2
21 #include <linux/init.h>
22 #include <linux/module.h>
23 #include <linux/moduleparam.h>
24 #include <linux/slab.h>
25 #include <linux/interrupt.h>
27 #include <linux/dma-mapping.h>
28 #include <linux/vmalloc.h>
29 #include <linux/pagemap.h>
30 #include <linux/scatterlist.h>
32 #include <asm/pgtable.h>
34 #include <media/videobuf-dma-sg.h>
36 #define MAGIC_DMABUF 0x19721112
37 #define MAGIC_SG_MEM 0x17890714
39 #define MAGIC_CHECK(is,should) if (unlikely((is) != (should))) \
40 { printk(KERN_ERR "magic mismatch: %x (expected %x)\n",is,should); BUG(); }
43 module_param(debug, int, 0644);
45 MODULE_DESCRIPTION("helper module to manage video4linux dma sg buffers");
46 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@infradead.org>");
47 MODULE_LICENSE("GPL");
49 #define dprintk(level, fmt, arg...) if (debug >= level) \
50 printk(KERN_DEBUG "vbuf-sg: " fmt , ## arg)
52 /* --------------------------------------------------------------------- */
55 videobuf_vmalloc_to_sg(unsigned char *virt, int nr_pages)
57 struct scatterlist *sglist;
61 sglist = kcalloc(nr_pages, sizeof(struct scatterlist), GFP_KERNEL);
64 sg_init_table(sglist, nr_pages);
65 for (i = 0; i < nr_pages; i++, virt += PAGE_SIZE) {
66 pg = vmalloc_to_page(virt);
69 BUG_ON(PageHighMem(pg));
70 sg_set_page(&sglist[i], pg, PAGE_SIZE, 0);
80 videobuf_pages_to_sg(struct page **pages, int nr_pages, int offset)
82 struct scatterlist *sglist;
87 sglist = kcalloc(nr_pages, sizeof(*sglist), GFP_KERNEL);
90 sg_init_table(sglist, nr_pages);
94 if (PageHighMem(pages[0]))
95 /* DMA to highmem pages might not work */
97 sg_set_page(&sglist[0], pages[0], PAGE_SIZE - offset, offset);
98 for (i = 1; i < nr_pages; i++) {
101 if (PageHighMem(pages[i]))
103 sg_set_page(&sglist[i], pages[i], PAGE_SIZE, 0);
108 dprintk(2,"sgl: oops - no page\n");
113 dprintk(2,"sgl: oops - highmem page\n");
118 /* --------------------------------------------------------------------- */
120 struct videobuf_dmabuf *videobuf_to_dma (struct videobuf_buffer *buf)
122 struct videobuf_dma_sg_memory *mem = buf->priv;
125 MAGIC_CHECK(mem->magic, MAGIC_SG_MEM);
130 void videobuf_dma_init(struct videobuf_dmabuf *dma)
132 memset(dma,0,sizeof(*dma));
133 dma->magic = MAGIC_DMABUF;
136 static int videobuf_dma_init_user_locked(struct videobuf_dmabuf *dma,
137 int direction, unsigned long data, unsigned long size)
139 unsigned long first,last;
142 dma->direction = direction;
143 switch (dma->direction) {
144 case DMA_FROM_DEVICE:
154 first = (data & PAGE_MASK) >> PAGE_SHIFT;
155 last = ((data+size-1) & PAGE_MASK) >> PAGE_SHIFT;
156 dma->offset = data & ~PAGE_MASK;
157 dma->nr_pages = last-first+1;
158 dma->pages = kmalloc(dma->nr_pages * sizeof(struct page*),
160 if (NULL == dma->pages)
162 dprintk(1,"init user [0x%lx+0x%lx => %d pages]\n",
163 data,size,dma->nr_pages);
165 err = get_user_pages(current,current->mm,
166 data & PAGE_MASK, dma->nr_pages,
167 rw == READ, 1, /* force */
170 if (err != dma->nr_pages) {
171 dma->nr_pages = (err >= 0) ? err : 0;
172 dprintk(1,"get_user_pages: err=%d [%d]\n",err,dma->nr_pages);
173 return err < 0 ? err : -EINVAL;
178 int videobuf_dma_init_user(struct videobuf_dmabuf *dma, int direction,
179 unsigned long data, unsigned long size)
182 down_read(¤t->mm->mmap_sem);
183 ret = videobuf_dma_init_user_locked(dma, direction, data, size);
184 up_read(¤t->mm->mmap_sem);
189 int videobuf_dma_init_kernel(struct videobuf_dmabuf *dma, int direction,
192 dprintk(1,"init kernel [%d pages]\n",nr_pages);
193 dma->direction = direction;
194 dma->vmalloc = vmalloc_32(nr_pages << PAGE_SHIFT);
195 if (NULL == dma->vmalloc) {
196 dprintk(1,"vmalloc_32(%d pages) failed\n",nr_pages);
199 dprintk(1,"vmalloc is at addr 0x%08lx, size=%d\n",
200 (unsigned long)dma->vmalloc,
201 nr_pages << PAGE_SHIFT);
202 memset(dma->vmalloc,0,nr_pages << PAGE_SHIFT);
203 dma->nr_pages = nr_pages;
207 int videobuf_dma_init_overlay(struct videobuf_dmabuf *dma, int direction,
208 dma_addr_t addr, int nr_pages)
210 dprintk(1,"init overlay [%d pages @ bus 0x%lx]\n",
211 nr_pages,(unsigned long)addr);
212 dma->direction = direction;
216 dma->bus_addr = addr;
217 dma->nr_pages = nr_pages;
221 int videobuf_dma_map(struct videobuf_queue* q, struct videobuf_dmabuf *dma)
223 MAGIC_CHECK(dma->magic,MAGIC_DMABUF);
224 BUG_ON(0 == dma->nr_pages);
227 dma->sglist = videobuf_pages_to_sg(dma->pages, dma->nr_pages,
231 dma->sglist = videobuf_vmalloc_to_sg
232 (dma->vmalloc,dma->nr_pages);
235 dma->sglist = kmalloc(sizeof(struct scatterlist), GFP_KERNEL);
236 if (NULL != dma->sglist) {
238 sg_dma_address(&dma->sglist[0]) = dma->bus_addr & PAGE_MASK;
239 dma->sglist[0].offset = dma->bus_addr & ~PAGE_MASK;
240 sg_dma_len(&dma->sglist[0]) = dma->nr_pages * PAGE_SIZE;
243 if (NULL == dma->sglist) {
244 dprintk(1,"scatterlist is NULL\n");
247 if (!dma->bus_addr) {
248 dma->sglen = dma_map_sg(q->dev, dma->sglist,
249 dma->nr_pages, dma->direction);
250 if (0 == dma->sglen) {
252 "%s: videobuf_map_sg failed\n",__func__);
262 int videobuf_dma_sync(struct videobuf_queue *q, struct videobuf_dmabuf *dma)
264 MAGIC_CHECK(dma->magic, MAGIC_DMABUF);
267 dma_sync_sg_for_cpu(q->dev, dma->sglist, dma->nr_pages, dma->direction);
271 int videobuf_dma_unmap(struct videobuf_queue* q,struct videobuf_dmabuf *dma)
273 MAGIC_CHECK(dma->magic, MAGIC_DMABUF);
277 dma_unmap_sg(q->dev, dma->sglist, dma->nr_pages, dma->direction);
285 int videobuf_dma_free(struct videobuf_dmabuf *dma)
287 MAGIC_CHECK(dma->magic,MAGIC_DMABUF);
292 for (i=0; i < dma->nr_pages; i++)
293 page_cache_release(dma->pages[i]);
304 dma->direction = DMA_NONE;
308 /* --------------------------------------------------------------------- */
310 int videobuf_sg_dma_map(struct device *dev, struct videobuf_dmabuf *dma)
312 struct videobuf_queue q;
316 return videobuf_dma_map(&q, dma);
319 int videobuf_sg_dma_unmap(struct device *dev, struct videobuf_dmabuf *dma)
321 struct videobuf_queue q;
325 return videobuf_dma_unmap(&q, dma);
328 /* --------------------------------------------------------------------- */
331 videobuf_vm_open(struct vm_area_struct *vma)
333 struct videobuf_mapping *map = vma->vm_private_data;
335 dprintk(2,"vm_open %p [count=%d,vma=%08lx-%08lx]\n",map,
336 map->count,vma->vm_start,vma->vm_end);
341 videobuf_vm_close(struct vm_area_struct *vma)
343 struct videobuf_mapping *map = vma->vm_private_data;
344 struct videobuf_queue *q = map->q;
345 struct videobuf_dma_sg_memory *mem;
348 dprintk(2,"vm_close %p [count=%d,vma=%08lx-%08lx]\n",map,
349 map->count,vma->vm_start,vma->vm_end);
352 if (0 == map->count) {
353 dprintk(1,"munmap %p q=%p\n",map,q);
354 mutex_lock(&q->vb_lock);
355 for (i = 0; i < VIDEO_MAX_FRAME; i++) {
356 if (NULL == q->bufs[i])
358 mem=q->bufs[i]->priv;
363 MAGIC_CHECK(mem->magic,MAGIC_SG_MEM);
365 if (q->bufs[i]->map != map)
367 q->bufs[i]->map = NULL;
368 q->bufs[i]->baddr = 0;
369 q->ops->buf_release(q,q->bufs[i]);
371 mutex_unlock(&q->vb_lock);
378 * Get a anonymous page for the mapping. Make sure we can DMA to that
379 * memory location with 32bit PCI devices (i.e. don't use highmem for
380 * now ...). Bounce buffers don't work very well for the data rates
384 videobuf_vm_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
388 dprintk(3,"fault: fault @ %08lx [vma %08lx-%08lx]\n",
389 (unsigned long)vmf->virtual_address,vma->vm_start,vma->vm_end);
390 page = alloc_page(GFP_USER | __GFP_DMA32);
393 clear_user_page(page_address(page), (unsigned long)vmf->virtual_address,
399 static struct vm_operations_struct videobuf_vm_ops =
401 .open = videobuf_vm_open,
402 .close = videobuf_vm_close,
403 .fault = videobuf_vm_fault,
406 /* ---------------------------------------------------------------------
407 * SG handlers for the generic methods
410 /* Allocated area consists on 3 parts:
412 struct <driver>_buffer (cx88_buffer, saa7134_buf, ...)
413 struct videobuf_dma_sg_memory
416 static void *__videobuf_alloc(size_t size)
418 struct videobuf_dma_sg_memory *mem;
419 struct videobuf_buffer *vb;
421 vb = kzalloc(size+sizeof(*mem),GFP_KERNEL);
423 mem = vb->priv = ((char *)vb)+size;
424 mem->magic=MAGIC_SG_MEM;
426 videobuf_dma_init(&mem->dma);
428 dprintk(1,"%s: allocated at %p(%ld+%ld) & %p(%ld)\n",
429 __func__,vb,(long)sizeof(*vb),(long)size-sizeof(*vb),
430 mem,(long)sizeof(*mem));
435 static void *__videobuf_to_vmalloc (struct videobuf_buffer *buf)
437 struct videobuf_dma_sg_memory *mem = buf->priv;
440 MAGIC_CHECK(mem->magic, MAGIC_SG_MEM);
442 return mem->dma.vmalloc;
445 static int __videobuf_iolock (struct videobuf_queue* q,
446 struct videobuf_buffer *vb,
447 struct v4l2_framebuffer *fbuf)
451 struct videobuf_dma_sg_memory *mem = vb->priv;
454 MAGIC_CHECK(mem->magic, MAGIC_SG_MEM);
456 switch (vb->memory) {
457 case V4L2_MEMORY_MMAP:
458 case V4L2_MEMORY_USERPTR:
459 if (0 == vb->baddr) {
460 /* no userspace addr -- kernel bounce buffer */
461 pages = PAGE_ALIGN(vb->size) >> PAGE_SHIFT;
462 err = videobuf_dma_init_kernel( &mem->dma,
467 } else if (vb->memory == V4L2_MEMORY_USERPTR) {
468 /* dma directly to userspace */
469 err = videobuf_dma_init_user( &mem->dma,
471 vb->baddr,vb->bsize );
475 /* NOTE: HACK: videobuf_iolock on V4L2_MEMORY_MMAP
476 buffers can only be called from videobuf_qbuf
477 we take current->mm->mmap_sem there, to prevent
478 locking inversion, so don't take it here */
480 err = videobuf_dma_init_user_locked(&mem->dma,
482 vb->baddr, vb->bsize);
487 case V4L2_MEMORY_OVERLAY:
490 /* FIXME: need sanity checks for vb->boff */
492 * Using a double cast to avoid compiler warnings when
493 * building for PAE. Compiler doesn't like direct casting
494 * of a 32 bit ptr to 64 bit integer.
496 bus = (dma_addr_t)(unsigned long)fbuf->base + vb->boff;
497 pages = PAGE_ALIGN(vb->size) >> PAGE_SHIFT;
498 err = videobuf_dma_init_overlay(&mem->dma, DMA_FROM_DEVICE,
506 err = videobuf_dma_map(q, &mem->dma);
513 static int __videobuf_sync(struct videobuf_queue *q,
514 struct videobuf_buffer *buf)
516 struct videobuf_dma_sg_memory *mem = buf->priv;
518 MAGIC_CHECK(mem->magic,MAGIC_SG_MEM);
520 return videobuf_dma_sync(q,&mem->dma);
523 static int __videobuf_mmap_free(struct videobuf_queue *q)
527 for (i = 0; i < VIDEO_MAX_FRAME; i++) {
537 static int __videobuf_mmap_mapper(struct videobuf_queue *q,
538 struct vm_area_struct *vma)
540 struct videobuf_dma_sg_memory *mem;
541 struct videobuf_mapping *map;
542 unsigned int first,last,size,i;
546 if (!(vma->vm_flags & VM_WRITE)) {
547 dprintk(1,"mmap app bug: PROT_WRITE please\n");
550 if (!(vma->vm_flags & VM_SHARED)) {
551 dprintk(1,"mmap app bug: MAP_SHARED please\n");
555 /* This function maintains backwards compatibility with V4L1 and will
556 * map more than one buffer if the vma length is equal to the combined
557 * size of multiple buffers than it will map them together. See
558 * VIDIOCGMBUF in the v4l spec
560 * TODO: Allow drivers to specify if they support this mode
563 /* look for first buffer to map */
564 for (first = 0; first < VIDEO_MAX_FRAME; first++) {
565 if (NULL == q->bufs[first])
567 mem=q->bufs[first]->priv;
569 MAGIC_CHECK(mem->magic,MAGIC_SG_MEM);
571 if (V4L2_MEMORY_MMAP != q->bufs[first]->memory)
573 if (q->bufs[first]->boff == (vma->vm_pgoff << PAGE_SHIFT))
576 if (VIDEO_MAX_FRAME == first) {
577 dprintk(1,"mmap app bug: offset invalid [offset=0x%lx]\n",
578 (vma->vm_pgoff << PAGE_SHIFT));
582 /* look for last buffer to map */
583 for (size = 0, last = first; last < VIDEO_MAX_FRAME; last++) {
584 if (NULL == q->bufs[last])
586 if (V4L2_MEMORY_MMAP != q->bufs[last]->memory)
588 if (q->bufs[last]->map) {
592 size += q->bufs[last]->bsize;
593 if (size == (vma->vm_end - vma->vm_start))
596 if (VIDEO_MAX_FRAME == last) {
597 dprintk(1,"mmap app bug: size invalid [size=0x%lx]\n",
598 (vma->vm_end - vma->vm_start));
602 /* create mapping + update buffer list */
604 map = kmalloc(sizeof(struct videobuf_mapping),GFP_KERNEL);
609 for (i = first; i <= last; i++) {
610 if (NULL == q->bufs[i])
612 q->bufs[i]->map = map;
613 q->bufs[i]->baddr = vma->vm_start + size;
614 size += q->bufs[i]->bsize;
618 map->start = vma->vm_start;
619 map->end = vma->vm_end;
621 vma->vm_ops = &videobuf_vm_ops;
622 vma->vm_flags |= VM_DONTEXPAND | VM_RESERVED;
623 vma->vm_flags &= ~VM_IO; /* using shared anonymous pages */
624 vma->vm_private_data = map;
625 dprintk(1,"mmap %p: q=%p %08lx-%08lx pgoff %08lx bufs %d-%d\n",
626 map,q,vma->vm_start,vma->vm_end,vma->vm_pgoff,first,last);
633 static int __videobuf_copy_to_user ( struct videobuf_queue *q,
634 char __user *data, size_t count,
637 struct videobuf_dma_sg_memory *mem = q->read_buf->priv;
639 MAGIC_CHECK(mem->magic,MAGIC_SG_MEM);
641 /* copy to userspace */
642 if (count > q->read_buf->size - q->read_off)
643 count = q->read_buf->size - q->read_off;
645 if (copy_to_user(data, mem->dma.vmalloc+q->read_off, count))
651 static int __videobuf_copy_stream ( struct videobuf_queue *q,
652 char __user *data, size_t count, size_t pos,
653 int vbihack, int nonblocking )
656 struct videobuf_dma_sg_memory *mem = q->read_buf->priv;
658 MAGIC_CHECK(mem->magic,MAGIC_SG_MEM);
661 /* dirty, undocumented hack -- pass the frame counter
662 * within the last four bytes of each vbi data block.
663 * We need that one to maintain backward compatibility
664 * to all vbi decoding software out there ... */
665 fc = (unsigned int*)mem->dma.vmalloc;
666 fc += (q->read_buf->size>>2) -1;
667 *fc = q->read_buf->field_count >> 1;
668 dprintk(1,"vbihack: %d\n",*fc);
671 /* copy stuff using the common method */
672 count = __videobuf_copy_to_user (q,data,count,nonblocking);
674 if ( (count==-EFAULT) && (0 == pos) )
680 static struct videobuf_qtype_ops sg_ops = {
681 .magic = MAGIC_QTYPE_OPS,
683 .alloc = __videobuf_alloc,
684 .iolock = __videobuf_iolock,
685 .sync = __videobuf_sync,
686 .mmap_free = __videobuf_mmap_free,
687 .mmap_mapper = __videobuf_mmap_mapper,
688 .video_copy_to_user = __videobuf_copy_to_user,
689 .copy_stream = __videobuf_copy_stream,
690 .vmalloc = __videobuf_to_vmalloc,
693 void *videobuf_sg_alloc(size_t size)
695 struct videobuf_queue q;
697 /* Required to make generic handler to call __videobuf_alloc */
702 return videobuf_alloc(&q);
705 void videobuf_queue_sg_init(struct videobuf_queue* q,
706 struct videobuf_queue_ops *ops,
709 enum v4l2_buf_type type,
710 enum v4l2_field field,
714 videobuf_queue_core_init(q, ops, dev, irqlock, type, field, msize,
718 /* --------------------------------------------------------------------- */
720 EXPORT_SYMBOL_GPL(videobuf_vmalloc_to_sg);
722 EXPORT_SYMBOL_GPL(videobuf_to_dma);
723 EXPORT_SYMBOL_GPL(videobuf_dma_init);
724 EXPORT_SYMBOL_GPL(videobuf_dma_init_user);
725 EXPORT_SYMBOL_GPL(videobuf_dma_init_kernel);
726 EXPORT_SYMBOL_GPL(videobuf_dma_init_overlay);
727 EXPORT_SYMBOL_GPL(videobuf_dma_map);
728 EXPORT_SYMBOL_GPL(videobuf_dma_sync);
729 EXPORT_SYMBOL_GPL(videobuf_dma_unmap);
730 EXPORT_SYMBOL_GPL(videobuf_dma_free);
732 EXPORT_SYMBOL_GPL(videobuf_sg_dma_map);
733 EXPORT_SYMBOL_GPL(videobuf_sg_dma_unmap);
734 EXPORT_SYMBOL_GPL(videobuf_sg_alloc);
736 EXPORT_SYMBOL_GPL(videobuf_queue_sg_init);