2 * videobuf2-dma-contig.c - DMA contig memory allocator for videobuf2
4 * Copyright (C) 2010 Samsung Electronics
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation.
13 #include <linux/dma-buf.h>
14 #include <linux/module.h>
15 #include <linux/refcount.h>
16 #include <linux/scatterlist.h>
17 #include <linux/sched.h>
18 #include <linux/slab.h>
19 #include <linux/dma-mapping.h>
21 #include <media/videobuf2-v4l2.h>
22 #include <media/videobuf2-dma-contig.h>
23 #include <media/videobuf2-memops.h>
32 enum dma_data_direction dma_dir;
33 struct sg_table *dma_sgt;
34 struct frame_vector *vec;
37 struct vb2_vmarea_handler handler;
39 struct sg_table *sgt_base;
42 struct dma_buf_attachment *db_attach;
45 /*********************************************/
46 /* scatterlist table functions */
47 /*********************************************/
49 static unsigned long vb2_dc_get_contiguous_size(struct sg_table *sgt)
51 struct scatterlist *s;
52 dma_addr_t expected = sg_dma_address(sgt->sgl);
54 unsigned long size = 0;
56 for_each_sg(sgt->sgl, s, sgt->nents, i) {
57 if (sg_dma_address(s) != expected)
59 expected = sg_dma_address(s) + sg_dma_len(s);
60 size += sg_dma_len(s);
65 /*********************************************/
66 /* callbacks for all buffers */
67 /*********************************************/
69 static void *vb2_dc_cookie(void *buf_priv)
71 struct vb2_dc_buf *buf = buf_priv;
73 return &buf->dma_addr;
76 static void *vb2_dc_vaddr(void *buf_priv)
78 struct vb2_dc_buf *buf = buf_priv;
80 if (!buf->vaddr && buf->db_attach)
81 buf->vaddr = dma_buf_vmap(buf->db_attach->dmabuf);
86 static unsigned int vb2_dc_num_users(void *buf_priv)
88 struct vb2_dc_buf *buf = buf_priv;
90 return refcount_read(&buf->refcount);
93 static void vb2_dc_prepare(void *buf_priv)
95 struct vb2_dc_buf *buf = buf_priv;
96 struct sg_table *sgt = buf->dma_sgt;
98 /* DMABUF exporter will flush the cache for us */
99 if (!sgt || buf->db_attach)
102 dma_sync_sg_for_device(buf->dev, sgt->sgl, sgt->orig_nents,
106 static void vb2_dc_finish(void *buf_priv)
108 struct vb2_dc_buf *buf = buf_priv;
109 struct sg_table *sgt = buf->dma_sgt;
111 /* DMABUF exporter will flush the cache for us */
112 if (!sgt || buf->db_attach)
115 dma_sync_sg_for_cpu(buf->dev, sgt->sgl, sgt->orig_nents, buf->dma_dir);
118 /*********************************************/
119 /* callbacks for MMAP buffers */
120 /*********************************************/
122 static void vb2_dc_put(void *buf_priv)
124 struct vb2_dc_buf *buf = buf_priv;
126 if (!refcount_dec_and_test(&buf->refcount))
130 sg_free_table(buf->sgt_base);
131 kfree(buf->sgt_base);
133 dma_free_attrs(buf->dev, buf->size, buf->cookie, buf->dma_addr,
135 put_device(buf->dev);
139 static void *vb2_dc_alloc(struct device *dev, unsigned long attrs,
140 unsigned long size, enum dma_data_direction dma_dir,
143 struct vb2_dc_buf *buf;
146 return ERR_PTR(-EINVAL);
148 buf = kzalloc(sizeof *buf, GFP_KERNEL);
150 return ERR_PTR(-ENOMEM);
154 buf->cookie = dma_alloc_attrs(dev, size, &buf->dma_addr,
155 GFP_KERNEL | gfp_flags, buf->attrs);
157 dev_err(dev, "dma_alloc_coherent of size %ld failed\n", size);
159 return ERR_PTR(-ENOMEM);
162 if ((buf->attrs & DMA_ATTR_NO_KERNEL_MAPPING) == 0)
163 buf->vaddr = buf->cookie;
165 /* Prevent the device from being released while the buffer is used */
166 buf->dev = get_device(dev);
168 buf->dma_dir = dma_dir;
170 buf->handler.refcount = &buf->refcount;
171 buf->handler.put = vb2_dc_put;
172 buf->handler.arg = buf;
174 refcount_set(&buf->refcount, 1);
179 static int vb2_dc_mmap(void *buf_priv, struct vm_area_struct *vma)
181 struct vb2_dc_buf *buf = buf_priv;
185 printk(KERN_ERR "No buffer to map\n");
190 * dma_mmap_* uses vm_pgoff as in-buffer offset, but we want to
195 ret = dma_mmap_attrs(buf->dev, vma, buf->cookie,
196 buf->dma_addr, buf->size, buf->attrs);
199 pr_err("Remapping memory failed, error: %d\n", ret);
203 vma->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
204 vma->vm_private_data = &buf->handler;
205 vma->vm_ops = &vb2_common_vm_ops;
207 vma->vm_ops->open(vma);
209 pr_debug("%s: mapped dma addr 0x%08lx at 0x%08lx, size %ld\n",
210 __func__, (unsigned long)buf->dma_addr, vma->vm_start,
216 /*********************************************/
217 /* DMABUF ops for exporters */
218 /*********************************************/
220 struct vb2_dc_attachment {
222 enum dma_data_direction dma_dir;
225 static int vb2_dc_dmabuf_ops_attach(struct dma_buf *dbuf, struct device *dev,
226 struct dma_buf_attachment *dbuf_attach)
228 struct vb2_dc_attachment *attach;
230 struct scatterlist *rd, *wr;
231 struct sg_table *sgt;
232 struct vb2_dc_buf *buf = dbuf->priv;
235 attach = kzalloc(sizeof(*attach), GFP_KERNEL);
240 /* Copy the buf->base_sgt scatter list to the attachment, as we can't
241 * map the same scatter list to multiple attachments at the same time.
243 ret = sg_alloc_table(sgt, buf->sgt_base->orig_nents, GFP_KERNEL);
249 rd = buf->sgt_base->sgl;
251 for (i = 0; i < sgt->orig_nents; ++i) {
252 sg_set_page(wr, sg_page(rd), rd->length, rd->offset);
257 attach->dma_dir = DMA_NONE;
258 dbuf_attach->priv = attach;
263 static void vb2_dc_dmabuf_ops_detach(struct dma_buf *dbuf,
264 struct dma_buf_attachment *db_attach)
266 struct vb2_dc_attachment *attach = db_attach->priv;
267 struct sg_table *sgt;
274 /* release the scatterlist cache */
275 if (attach->dma_dir != DMA_NONE)
276 dma_unmap_sg(db_attach->dev, sgt->sgl, sgt->orig_nents,
280 db_attach->priv = NULL;
283 static struct sg_table *vb2_dc_dmabuf_ops_map(
284 struct dma_buf_attachment *db_attach, enum dma_data_direction dma_dir)
286 struct vb2_dc_attachment *attach = db_attach->priv;
287 /* stealing dmabuf mutex to serialize map/unmap operations */
288 struct mutex *lock = &db_attach->dmabuf->lock;
289 struct sg_table *sgt;
294 /* return previously mapped sg table */
295 if (attach->dma_dir == dma_dir) {
300 /* release any previous cache */
301 if (attach->dma_dir != DMA_NONE) {
302 dma_unmap_sg(db_attach->dev, sgt->sgl, sgt->orig_nents,
304 attach->dma_dir = DMA_NONE;
307 /* mapping to the client with new direction */
308 sgt->nents = dma_map_sg(db_attach->dev, sgt->sgl, sgt->orig_nents,
311 pr_err("failed to map scatterlist\n");
313 return ERR_PTR(-EIO);
316 attach->dma_dir = dma_dir;
323 static void vb2_dc_dmabuf_ops_unmap(struct dma_buf_attachment *db_attach,
324 struct sg_table *sgt, enum dma_data_direction dma_dir)
326 /* nothing to be done here */
329 static void vb2_dc_dmabuf_ops_release(struct dma_buf *dbuf)
331 /* drop reference obtained in vb2_dc_get_dmabuf */
332 vb2_dc_put(dbuf->priv);
335 static void *vb2_dc_dmabuf_ops_kmap(struct dma_buf *dbuf, unsigned long pgnum)
337 struct vb2_dc_buf *buf = dbuf->priv;
339 return buf->vaddr ? buf->vaddr + pgnum * PAGE_SIZE : NULL;
342 static void *vb2_dc_dmabuf_ops_vmap(struct dma_buf *dbuf)
344 struct vb2_dc_buf *buf = dbuf->priv;
349 static int vb2_dc_dmabuf_ops_mmap(struct dma_buf *dbuf,
350 struct vm_area_struct *vma)
352 return vb2_dc_mmap(dbuf->priv, vma);
355 static struct dma_buf_ops vb2_dc_dmabuf_ops = {
356 .attach = vb2_dc_dmabuf_ops_attach,
357 .detach = vb2_dc_dmabuf_ops_detach,
358 .map_dma_buf = vb2_dc_dmabuf_ops_map,
359 .unmap_dma_buf = vb2_dc_dmabuf_ops_unmap,
360 .map = vb2_dc_dmabuf_ops_kmap,
361 .map_atomic = vb2_dc_dmabuf_ops_kmap,
362 .vmap = vb2_dc_dmabuf_ops_vmap,
363 .mmap = vb2_dc_dmabuf_ops_mmap,
364 .release = vb2_dc_dmabuf_ops_release,
367 static struct sg_table *vb2_dc_get_base_sgt(struct vb2_dc_buf *buf)
370 struct sg_table *sgt;
372 sgt = kmalloc(sizeof(*sgt), GFP_KERNEL);
374 dev_err(buf->dev, "failed to alloc sg table\n");
378 ret = dma_get_sgtable_attrs(buf->dev, sgt, buf->cookie, buf->dma_addr,
379 buf->size, buf->attrs);
381 dev_err(buf->dev, "failed to get scatterlist from DMA API\n");
389 static struct dma_buf *vb2_dc_get_dmabuf(void *buf_priv, unsigned long flags)
391 struct vb2_dc_buf *buf = buf_priv;
392 struct dma_buf *dbuf;
393 DEFINE_DMA_BUF_EXPORT_INFO(exp_info);
395 exp_info.ops = &vb2_dc_dmabuf_ops;
396 exp_info.size = buf->size;
397 exp_info.flags = flags;
401 buf->sgt_base = vb2_dc_get_base_sgt(buf);
403 if (WARN_ON(!buf->sgt_base))
406 dbuf = dma_buf_export(&exp_info);
410 /* dmabuf keeps reference to vb2 buffer */
411 refcount_inc(&buf->refcount);
416 /*********************************************/
417 /* callbacks for USERPTR buffers */
418 /*********************************************/
420 static void vb2_dc_put_userptr(void *buf_priv)
422 struct vb2_dc_buf *buf = buf_priv;
423 struct sg_table *sgt = buf->dma_sgt;
429 * No need to sync to CPU, it's already synced to the CPU
430 * since the finish() memop will have been called before this.
432 dma_unmap_sg_attrs(buf->dev, sgt->sgl, sgt->orig_nents,
433 buf->dma_dir, DMA_ATTR_SKIP_CPU_SYNC);
434 pages = frame_vector_pages(buf->vec);
435 /* sgt should exist only if vector contains pages... */
436 BUG_ON(IS_ERR(pages));
437 for (i = 0; i < frame_vector_count(buf->vec); i++)
438 set_page_dirty_lock(pages[i]);
442 vb2_destroy_framevec(buf->vec);
447 * For some kind of reserved memory there might be no struct page available,
448 * so all that can be done to support such 'pages' is to try to convert
449 * pfn to dma address or at the last resort just assume that
450 * dma address == physical address (like it has been assumed in earlier version
451 * of videobuf2-dma-contig
454 #ifdef __arch_pfn_to_dma
455 static inline dma_addr_t vb2_dc_pfn_to_dma(struct device *dev, unsigned long pfn)
457 return (dma_addr_t)__arch_pfn_to_dma(dev, pfn);
459 #elif defined(__pfn_to_bus)
460 static inline dma_addr_t vb2_dc_pfn_to_dma(struct device *dev, unsigned long pfn)
462 return (dma_addr_t)__pfn_to_bus(pfn);
464 #elif defined(__pfn_to_phys)
465 static inline dma_addr_t vb2_dc_pfn_to_dma(struct device *dev, unsigned long pfn)
467 return (dma_addr_t)__pfn_to_phys(pfn);
470 static inline dma_addr_t vb2_dc_pfn_to_dma(struct device *dev, unsigned long pfn)
472 /* really, we cannot do anything better at this point */
473 return (dma_addr_t)(pfn) << PAGE_SHIFT;
477 static void *vb2_dc_get_userptr(struct device *dev, unsigned long vaddr,
478 unsigned long size, enum dma_data_direction dma_dir)
480 struct vb2_dc_buf *buf;
481 struct frame_vector *vec;
485 struct sg_table *sgt;
486 unsigned long contig_size;
487 unsigned long dma_align = dma_get_cache_alignment();
489 /* Only cache aligned DMA transfers are reliable */
490 if (!IS_ALIGNED(vaddr | size, dma_align)) {
491 pr_debug("user data must be aligned to %lu bytes\n", dma_align);
492 return ERR_PTR(-EINVAL);
496 pr_debug("size is zero\n");
497 return ERR_PTR(-EINVAL);
501 return ERR_PTR(-EINVAL);
503 buf = kzalloc(sizeof *buf, GFP_KERNEL);
505 return ERR_PTR(-ENOMEM);
508 buf->dma_dir = dma_dir;
510 offset = lower_32_bits(offset_in_page(vaddr));
511 vec = vb2_create_framevec(vaddr, size, dma_dir == DMA_FROM_DEVICE);
517 n_pages = frame_vector_count(vec);
518 ret = frame_vector_to_pages(vec);
520 unsigned long *nums = frame_vector_pfns(vec);
523 * Failed to convert to pages... Check the memory is physically
524 * contiguous and use direct mapping
526 for (i = 1; i < n_pages; i++)
527 if (nums[i-1] + 1 != nums[i])
529 buf->dma_addr = vb2_dc_pfn_to_dma(buf->dev, nums[0]);
533 sgt = kzalloc(sizeof(*sgt), GFP_KERNEL);
535 pr_err("failed to allocate sg table\n");
540 ret = sg_alloc_table_from_pages(sgt, frame_vector_pages(vec), n_pages,
541 offset, size, GFP_KERNEL);
543 pr_err("failed to initialize sg table\n");
548 * No need to sync to the device, this will happen later when the
549 * prepare() memop is called.
551 sgt->nents = dma_map_sg_attrs(buf->dev, sgt->sgl, sgt->orig_nents,
552 buf->dma_dir, DMA_ATTR_SKIP_CPU_SYNC);
553 if (sgt->nents <= 0) {
554 pr_err("failed to map scatterlist\n");
559 contig_size = vb2_dc_get_contiguous_size(sgt);
560 if (contig_size < size) {
561 pr_err("contiguous mapping is too small %lu/%lu\n",
567 buf->dma_addr = sg_dma_address(sgt->sgl);
575 dma_unmap_sg_attrs(buf->dev, sgt->sgl, sgt->orig_nents,
576 buf->dma_dir, DMA_ATTR_SKIP_CPU_SYNC);
585 vb2_destroy_framevec(vec);
593 /*********************************************/
594 /* callbacks for DMABUF buffers */
595 /*********************************************/
597 static int vb2_dc_map_dmabuf(void *mem_priv)
599 struct vb2_dc_buf *buf = mem_priv;
600 struct sg_table *sgt;
601 unsigned long contig_size;
603 if (WARN_ON(!buf->db_attach)) {
604 pr_err("trying to pin a non attached buffer\n");
608 if (WARN_ON(buf->dma_sgt)) {
609 pr_err("dmabuf buffer is already pinned\n");
613 /* get the associated scatterlist for this buffer */
614 sgt = dma_buf_map_attachment(buf->db_attach, buf->dma_dir);
616 pr_err("Error getting dmabuf scatterlist\n");
620 /* checking if dmabuf is big enough to store contiguous chunk */
621 contig_size = vb2_dc_get_contiguous_size(sgt);
622 if (contig_size < buf->size) {
623 pr_err("contiguous chunk is too small %lu/%lu b\n",
624 contig_size, buf->size);
625 dma_buf_unmap_attachment(buf->db_attach, sgt, buf->dma_dir);
629 buf->dma_addr = sg_dma_address(sgt->sgl);
636 static void vb2_dc_unmap_dmabuf(void *mem_priv)
638 struct vb2_dc_buf *buf = mem_priv;
639 struct sg_table *sgt = buf->dma_sgt;
641 if (WARN_ON(!buf->db_attach)) {
642 pr_err("trying to unpin a not attached buffer\n");
647 pr_err("dmabuf buffer is already unpinned\n");
652 dma_buf_vunmap(buf->db_attach->dmabuf, buf->vaddr);
655 dma_buf_unmap_attachment(buf->db_attach, sgt, buf->dma_dir);
661 static void vb2_dc_detach_dmabuf(void *mem_priv)
663 struct vb2_dc_buf *buf = mem_priv;
665 /* if vb2 works correctly you should never detach mapped buffer */
666 if (WARN_ON(buf->dma_addr))
667 vb2_dc_unmap_dmabuf(buf);
669 /* detach this attachment */
670 dma_buf_detach(buf->db_attach->dmabuf, buf->db_attach);
674 static void *vb2_dc_attach_dmabuf(struct device *dev, struct dma_buf *dbuf,
675 unsigned long size, enum dma_data_direction dma_dir)
677 struct vb2_dc_buf *buf;
678 struct dma_buf_attachment *dba;
680 if (dbuf->size < size)
681 return ERR_PTR(-EFAULT);
684 return ERR_PTR(-EINVAL);
686 buf = kzalloc(sizeof(*buf), GFP_KERNEL);
688 return ERR_PTR(-ENOMEM);
691 /* create attachment for the dmabuf with the user device */
692 dba = dma_buf_attach(dbuf, buf->dev);
694 pr_err("failed to attach dmabuf\n");
699 buf->dma_dir = dma_dir;
701 buf->db_attach = dba;
706 /*********************************************/
707 /* DMA CONTIG exported functions */
708 /*********************************************/
710 const struct vb2_mem_ops vb2_dma_contig_memops = {
711 .alloc = vb2_dc_alloc,
713 .get_dmabuf = vb2_dc_get_dmabuf,
714 .cookie = vb2_dc_cookie,
715 .vaddr = vb2_dc_vaddr,
717 .get_userptr = vb2_dc_get_userptr,
718 .put_userptr = vb2_dc_put_userptr,
719 .prepare = vb2_dc_prepare,
720 .finish = vb2_dc_finish,
721 .map_dmabuf = vb2_dc_map_dmabuf,
722 .unmap_dmabuf = vb2_dc_unmap_dmabuf,
723 .attach_dmabuf = vb2_dc_attach_dmabuf,
724 .detach_dmabuf = vb2_dc_detach_dmabuf,
725 .num_users = vb2_dc_num_users,
727 EXPORT_SYMBOL_GPL(vb2_dma_contig_memops);
730 * vb2_dma_contig_set_max_seg_size() - configure DMA max segment size
731 * @dev: device for configuring DMA parameters
732 * @size: size of DMA max segment size to set
734 * To allow mapping the scatter-list into a single chunk in the DMA
735 * address space, the device is required to have the DMA max segment
736 * size parameter set to a value larger than the buffer size. Otherwise,
737 * the DMA-mapping subsystem will split the mapping into max segment
738 * size chunks. This function sets the DMA max segment size
739 * parameter to let DMA-mapping map a buffer as a single chunk in DMA
741 * This code assumes that the DMA-mapping subsystem will merge all
742 * scatterlist segments if this is really possible (for example when
743 * an IOMMU is available and enabled).
744 * Ideally, this parameter should be set by the generic bus code, but it
745 * is left with the default 64KiB value due to historical litmiations in
746 * other subsystems (like limited USB host drivers) and there no good
747 * place to set it to the proper value.
748 * This function should be called from the drivers, which are known to
749 * operate on platforms with IOMMU and provide access to shared buffers
750 * (either USERPTR or DMABUF). This should be done before initializing
753 int vb2_dma_contig_set_max_seg_size(struct device *dev, unsigned int size)
755 if (!dev->dma_parms) {
756 dev->dma_parms = kzalloc(sizeof(*dev->dma_parms), GFP_KERNEL);
760 if (dma_get_max_seg_size(dev) < size)
761 return dma_set_max_seg_size(dev, size);
765 EXPORT_SYMBOL_GPL(vb2_dma_contig_set_max_seg_size);
768 * vb2_dma_contig_clear_max_seg_size() - release resources for DMA parameters
769 * @dev: device for configuring DMA parameters
771 * This function releases resources allocated to configure DMA parameters
772 * (see vb2_dma_contig_set_max_seg_size() function). It should be called from
773 * device drivers on driver remove.
775 void vb2_dma_contig_clear_max_seg_size(struct device *dev)
777 kfree(dev->dma_parms);
778 dev->dma_parms = NULL;
780 EXPORT_SYMBOL_GPL(vb2_dma_contig_clear_max_seg_size);
782 MODULE_DESCRIPTION("DMA-contig memory handling routines for videobuf2");
784 MODULE_LICENSE("GPL");