2 * helper functions for SG DMA video4linux capture buffers
4 * The functions expect the hardware being able to scatter gather
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@kernel.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@kernel.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/sched/mm.h>
25 #include <linux/slab.h>
26 #include <linux/interrupt.h>
28 #include <linux/dma-mapping.h>
29 #include <linux/vmalloc.h>
30 #include <linux/pagemap.h>
31 #include <linux/scatterlist.h>
33 #include <asm/pgtable.h>
35 #include <media/videobuf-dma-sg.h>
37 #define MAGIC_DMABUF 0x19721112
38 #define MAGIC_SG_MEM 0x17890714
40 #define MAGIC_CHECK(is, should) \
41 if (unlikely((is) != (should))) { \
42 printk(KERN_ERR "magic mismatch: %x (expected %x)\n", \
48 module_param(debug, int, 0644);
50 MODULE_DESCRIPTION("helper module to manage video4linux dma sg buffers");
51 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@kernel.org>");
52 MODULE_LICENSE("GPL");
54 #define dprintk(level, fmt, arg...) \
56 printk(KERN_DEBUG "vbuf-sg: " fmt , ## arg)
58 /* --------------------------------------------------------------------- */
61 * Return a scatterlist for some page-aligned vmalloc()'ed memory
62 * block (NULL on errors). Memory for the scatterlist is allocated
63 * using kmalloc. The caller must free the memory.
65 static struct scatterlist *videobuf_vmalloc_to_sg(unsigned char *virt,
68 struct scatterlist *sglist;
72 sglist = vzalloc(nr_pages * sizeof(*sglist));
75 sg_init_table(sglist, nr_pages);
76 for (i = 0; i < nr_pages; i++, virt += PAGE_SIZE) {
77 pg = vmalloc_to_page(virt);
80 BUG_ON(PageHighMem(pg));
81 sg_set_page(&sglist[i], pg, PAGE_SIZE, 0);
91 * Return a scatterlist for a an array of userpages (NULL on errors).
92 * Memory for the scatterlist is allocated using kmalloc. The caller
93 * must free the memory.
95 static struct scatterlist *videobuf_pages_to_sg(struct page **pages,
96 int nr_pages, int offset, size_t size)
98 struct scatterlist *sglist;
101 if (NULL == pages[0])
103 sglist = vmalloc(nr_pages * sizeof(*sglist));
106 sg_init_table(sglist, nr_pages);
108 if (PageHighMem(pages[0]))
109 /* DMA to highmem pages might not work */
111 sg_set_page(&sglist[0], pages[0],
112 min_t(size_t, PAGE_SIZE - offset, size), offset);
113 size -= min_t(size_t, PAGE_SIZE - offset, size);
114 for (i = 1; i < nr_pages; i++) {
115 if (NULL == pages[i])
117 if (PageHighMem(pages[i]))
119 sg_set_page(&sglist[i], pages[i], min_t(size_t, PAGE_SIZE, size), 0);
120 size -= min_t(size_t, PAGE_SIZE, size);
125 dprintk(2, "sgl: oops - no page\n");
130 dprintk(2, "sgl: oops - highmem page\n");
135 /* --------------------------------------------------------------------- */
137 struct videobuf_dmabuf *videobuf_to_dma(struct videobuf_buffer *buf)
139 struct videobuf_dma_sg_memory *mem = buf->priv;
142 MAGIC_CHECK(mem->magic, MAGIC_SG_MEM);
146 EXPORT_SYMBOL_GPL(videobuf_to_dma);
148 static void videobuf_dma_init(struct videobuf_dmabuf *dma)
150 memset(dma, 0, sizeof(*dma));
151 dma->magic = MAGIC_DMABUF;
154 static int videobuf_dma_init_user_locked(struct videobuf_dmabuf *dma,
155 int direction, unsigned long data, unsigned long size)
157 unsigned long first, last;
159 unsigned int flags = FOLL_FORCE;
161 dma->direction = direction;
162 switch (dma->direction) {
163 case DMA_FROM_DEVICE:
173 first = (data & PAGE_MASK) >> PAGE_SHIFT;
174 last = ((data+size-1) & PAGE_MASK) >> PAGE_SHIFT;
175 dma->offset = data & ~PAGE_MASK;
177 dma->nr_pages = last-first+1;
178 dma->pages = kmalloc_array(dma->nr_pages, sizeof(struct page *),
180 if (NULL == dma->pages)
186 dprintk(1, "init user [0x%lx+0x%lx => %d pages]\n",
187 data, size, dma->nr_pages);
189 err = get_user_pages_longterm(data & PAGE_MASK, dma->nr_pages,
190 flags, dma->pages, NULL);
192 if (err != dma->nr_pages) {
193 dma->nr_pages = (err >= 0) ? err : 0;
194 dprintk(1, "get_user_pages_longterm: err=%d [%d]\n", err,
196 return err < 0 ? err : -EINVAL;
201 static int videobuf_dma_init_user(struct videobuf_dmabuf *dma, int direction,
202 unsigned long data, unsigned long size)
206 down_read(¤t->mm->mmap_sem);
207 ret = videobuf_dma_init_user_locked(dma, direction, data, size);
208 up_read(¤t->mm->mmap_sem);
213 static int videobuf_dma_init_kernel(struct videobuf_dmabuf *dma, int direction,
218 dprintk(1, "init kernel [%d pages]\n", nr_pages);
220 dma->direction = direction;
221 dma->vaddr_pages = kcalloc(nr_pages, sizeof(*dma->vaddr_pages),
223 if (!dma->vaddr_pages)
226 dma->dma_addr = kcalloc(nr_pages, sizeof(*dma->dma_addr), GFP_KERNEL);
227 if (!dma->dma_addr) {
228 kfree(dma->vaddr_pages);
231 for (i = 0; i < nr_pages; i++) {
234 addr = dma_alloc_coherent(dma->dev, PAGE_SIZE,
235 &(dma->dma_addr[i]), GFP_KERNEL);
239 dma->vaddr_pages[i] = virt_to_page(addr);
241 dma->vaddr = vmap(dma->vaddr_pages, nr_pages, VM_MAP | VM_IOREMAP,
243 if (NULL == dma->vaddr) {
244 dprintk(1, "vmalloc_32(%d pages) failed\n", nr_pages);
248 dprintk(1, "vmalloc is at addr %p, size=%d\n",
249 dma->vaddr, nr_pages << PAGE_SHIFT);
251 memset(dma->vaddr, 0, nr_pages << PAGE_SHIFT);
252 dma->nr_pages = nr_pages;
260 addr = page_address(dma->vaddr_pages[i]);
261 dma_free_coherent(dma->dev, PAGE_SIZE, addr, dma->dma_addr[i]);
263 kfree(dma->dma_addr);
264 dma->dma_addr = NULL;
265 kfree(dma->vaddr_pages);
266 dma->vaddr_pages = NULL;
272 static int videobuf_dma_init_overlay(struct videobuf_dmabuf *dma, int direction,
273 dma_addr_t addr, int nr_pages)
275 dprintk(1, "init overlay [%d pages @ bus 0x%lx]\n",
276 nr_pages, (unsigned long)addr);
277 dma->direction = direction;
282 dma->bus_addr = addr;
283 dma->nr_pages = nr_pages;
288 static int videobuf_dma_map(struct device *dev, struct videobuf_dmabuf *dma)
290 MAGIC_CHECK(dma->magic, MAGIC_DMABUF);
291 BUG_ON(0 == dma->nr_pages);
294 dma->sglist = videobuf_pages_to_sg(dma->pages, dma->nr_pages,
295 dma->offset, dma->size);
298 dma->sglist = videobuf_vmalloc_to_sg(dma->vaddr,
302 dma->sglist = vmalloc(sizeof(*dma->sglist));
303 if (NULL != dma->sglist) {
305 sg_dma_address(&dma->sglist[0]) = dma->bus_addr
307 dma->sglist[0].offset = dma->bus_addr & ~PAGE_MASK;
308 sg_dma_len(&dma->sglist[0]) = dma->nr_pages * PAGE_SIZE;
311 if (NULL == dma->sglist) {
312 dprintk(1, "scatterlist is NULL\n");
315 if (!dma->bus_addr) {
316 dma->sglen = dma_map_sg(dev, dma->sglist,
317 dma->nr_pages, dma->direction);
318 if (0 == dma->sglen) {
320 "%s: videobuf_map_sg failed\n", __func__);
331 int videobuf_dma_unmap(struct device *dev, struct videobuf_dmabuf *dma)
333 MAGIC_CHECK(dma->magic, MAGIC_DMABUF);
338 dma_unmap_sg(dev, dma->sglist, dma->nr_pages, dma->direction);
346 EXPORT_SYMBOL_GPL(videobuf_dma_unmap);
348 int videobuf_dma_free(struct videobuf_dmabuf *dma)
351 MAGIC_CHECK(dma->magic, MAGIC_DMABUF);
355 for (i = 0; i < dma->nr_pages; i++)
356 put_page(dma->pages[i]);
362 for (i = 0; i < dma->nr_pages; i++) {
365 addr = page_address(dma->vaddr_pages[i]);
366 dma_free_coherent(dma->dev, PAGE_SIZE, addr,
369 kfree(dma->dma_addr);
370 dma->dma_addr = NULL;
371 kfree(dma->vaddr_pages);
372 dma->vaddr_pages = NULL;
379 dma->direction = DMA_NONE;
383 EXPORT_SYMBOL_GPL(videobuf_dma_free);
385 /* --------------------------------------------------------------------- */
387 static void videobuf_vm_open(struct vm_area_struct *vma)
389 struct videobuf_mapping *map = vma->vm_private_data;
391 dprintk(2, "vm_open %p [count=%d,vma=%08lx-%08lx]\n", map,
392 map->count, vma->vm_start, vma->vm_end);
397 static void videobuf_vm_close(struct vm_area_struct *vma)
399 struct videobuf_mapping *map = vma->vm_private_data;
400 struct videobuf_queue *q = map->q;
401 struct videobuf_dma_sg_memory *mem;
404 dprintk(2, "vm_close %p [count=%d,vma=%08lx-%08lx]\n", map,
405 map->count, vma->vm_start, vma->vm_end);
408 if (0 == map->count) {
409 dprintk(1, "munmap %p q=%p\n", map, q);
410 videobuf_queue_lock(q);
411 for (i = 0; i < VIDEO_MAX_FRAME; i++) {
412 if (NULL == q->bufs[i])
414 mem = q->bufs[i]->priv;
418 MAGIC_CHECK(mem->magic, MAGIC_SG_MEM);
420 if (q->bufs[i]->map != map)
422 q->bufs[i]->map = NULL;
423 q->bufs[i]->baddr = 0;
424 q->ops->buf_release(q, q->bufs[i]);
426 videobuf_queue_unlock(q);
433 * Get a anonymous page for the mapping. Make sure we can DMA to that
434 * memory location with 32bit PCI devices (i.e. don't use highmem for
435 * now ...). Bounce buffers don't work very well for the data rates
438 static vm_fault_t videobuf_vm_fault(struct vm_fault *vmf)
440 struct vm_area_struct *vma = vmf->vma;
443 dprintk(3, "fault: fault @ %08lx [vma %08lx-%08lx]\n",
444 vmf->address, vma->vm_start, vma->vm_end);
446 page = alloc_page(GFP_USER | __GFP_DMA32);
449 clear_user_highpage(page, vmf->address);
455 static const struct vm_operations_struct videobuf_vm_ops = {
456 .open = videobuf_vm_open,
457 .close = videobuf_vm_close,
458 .fault = videobuf_vm_fault,
461 /* ---------------------------------------------------------------------
462 * SG handlers for the generic methods
465 /* Allocated area consists on 3 parts:
467 struct <driver>_buffer (cx88_buffer, saa7134_buf, ...)
468 struct videobuf_dma_sg_memory
471 static struct videobuf_buffer *__videobuf_alloc_vb(size_t size)
473 struct videobuf_dma_sg_memory *mem;
474 struct videobuf_buffer *vb;
476 vb = kzalloc(size + sizeof(*mem), GFP_KERNEL);
480 mem = vb->priv = ((char *)vb) + size;
481 mem->magic = MAGIC_SG_MEM;
483 videobuf_dma_init(&mem->dma);
485 dprintk(1, "%s: allocated at %p(%ld+%ld) & %p(%ld)\n",
486 __func__, vb, (long)sizeof(*vb), (long)size - sizeof(*vb),
487 mem, (long)sizeof(*mem));
492 static void *__videobuf_to_vaddr(struct videobuf_buffer *buf)
494 struct videobuf_dma_sg_memory *mem = buf->priv;
497 MAGIC_CHECK(mem->magic, MAGIC_SG_MEM);
499 return mem->dma.vaddr;
502 static int __videobuf_iolock(struct videobuf_queue *q,
503 struct videobuf_buffer *vb,
504 struct v4l2_framebuffer *fbuf)
508 struct videobuf_dma_sg_memory *mem = vb->priv;
511 MAGIC_CHECK(mem->magic, MAGIC_SG_MEM);
514 mem->dma.dev = q->dev;
516 WARN_ON(mem->dma.dev != q->dev);
518 switch (vb->memory) {
519 case V4L2_MEMORY_MMAP:
520 case V4L2_MEMORY_USERPTR:
521 if (0 == vb->baddr) {
522 /* no userspace addr -- kernel bounce buffer */
523 pages = PAGE_ALIGN(vb->size) >> PAGE_SHIFT;
524 err = videobuf_dma_init_kernel(&mem->dma,
529 } else if (vb->memory == V4L2_MEMORY_USERPTR) {
530 /* dma directly to userspace */
531 err = videobuf_dma_init_user(&mem->dma,
533 vb->baddr, vb->bsize);
537 /* NOTE: HACK: videobuf_iolock on V4L2_MEMORY_MMAP
538 buffers can only be called from videobuf_qbuf
539 we take current->mm->mmap_sem there, to prevent
540 locking inversion, so don't take it here */
542 err = videobuf_dma_init_user_locked(&mem->dma,
544 vb->baddr, vb->bsize);
549 case V4L2_MEMORY_OVERLAY:
552 /* FIXME: need sanity checks for vb->boff */
554 * Using a double cast to avoid compiler warnings when
555 * building for PAE. Compiler doesn't like direct casting
556 * of a 32 bit ptr to 64 bit integer.
558 bus = (dma_addr_t)(unsigned long)fbuf->base + vb->boff;
559 pages = PAGE_ALIGN(vb->size) >> PAGE_SHIFT;
560 err = videobuf_dma_init_overlay(&mem->dma, DMA_FROM_DEVICE,
568 err = videobuf_dma_map(q->dev, &mem->dma);
575 static int __videobuf_sync(struct videobuf_queue *q,
576 struct videobuf_buffer *buf)
578 struct videobuf_dma_sg_memory *mem = buf->priv;
579 BUG_ON(!mem || !mem->dma.sglen);
581 MAGIC_CHECK(mem->magic, MAGIC_SG_MEM);
582 MAGIC_CHECK(mem->dma.magic, MAGIC_DMABUF);
584 dma_sync_sg_for_cpu(q->dev, mem->dma.sglist,
585 mem->dma.nr_pages, mem->dma.direction);
590 static int __videobuf_mmap_mapper(struct videobuf_queue *q,
591 struct videobuf_buffer *buf,
592 struct vm_area_struct *vma)
594 struct videobuf_dma_sg_memory *mem = buf->priv;
595 struct videobuf_mapping *map;
596 unsigned int first, last, size = 0, i;
602 MAGIC_CHECK(mem->magic, MAGIC_SG_MEM);
604 /* look for first buffer to map */
605 for (first = 0; first < VIDEO_MAX_FRAME; first++) {
606 if (buf == q->bufs[first]) {
607 size = PAGE_ALIGN(q->bufs[first]->bsize);
612 /* paranoia, should never happen since buf is always valid. */
614 dprintk(1, "mmap app bug: offset invalid [offset=0x%lx]\n",
615 (vma->vm_pgoff << PAGE_SHIFT));
621 /* create mapping + update buffer list */
623 map = kmalloc(sizeof(struct videobuf_mapping), GFP_KERNEL);
628 for (i = first; i <= last; i++) {
629 if (NULL == q->bufs[i])
631 q->bufs[i]->map = map;
632 q->bufs[i]->baddr = vma->vm_start + size;
633 size += PAGE_ALIGN(q->bufs[i]->bsize);
638 vma->vm_ops = &videobuf_vm_ops;
639 vma->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
640 vma->vm_flags &= ~VM_IO; /* using shared anonymous pages */
641 vma->vm_private_data = map;
642 dprintk(1, "mmap %p: q=%p %08lx-%08lx pgoff %08lx bufs %d-%d\n",
643 map, q, vma->vm_start, vma->vm_end, vma->vm_pgoff, first, last);
650 static struct videobuf_qtype_ops sg_ops = {
651 .magic = MAGIC_QTYPE_OPS,
653 .alloc_vb = __videobuf_alloc_vb,
654 .iolock = __videobuf_iolock,
655 .sync = __videobuf_sync,
656 .mmap_mapper = __videobuf_mmap_mapper,
657 .vaddr = __videobuf_to_vaddr,
660 void *videobuf_sg_alloc(size_t size)
662 struct videobuf_queue q;
664 /* Required to make generic handler to call __videobuf_alloc */
669 return videobuf_alloc_vb(&q);
671 EXPORT_SYMBOL_GPL(videobuf_sg_alloc);
673 void videobuf_queue_sg_init(struct videobuf_queue *q,
674 const struct videobuf_queue_ops *ops,
677 enum v4l2_buf_type type,
678 enum v4l2_field field,
681 struct mutex *ext_lock)
683 videobuf_queue_core_init(q, ops, dev, irqlock, type, field, msize,
684 priv, &sg_ops, ext_lock);
686 EXPORT_SYMBOL_GPL(videobuf_queue_sg_init);