1 // SPDX-License-Identifier: GPL-2.0-only
3 * linux/arch/arm/mm/dma-mapping.c
5 * Copyright (C) 2000-2004 Russell King
7 * DMA uncached mapping support.
9 #include <linux/module.h>
11 #include <linux/genalloc.h>
12 #include <linux/gfp.h>
13 #include <linux/errno.h>
14 #include <linux/list.h>
15 #include <linux/init.h>
16 #include <linux/device.h>
17 #include <linux/dma-direct.h>
18 #include <linux/dma-map-ops.h>
19 #include <linux/highmem.h>
20 #include <linux/memblock.h>
21 #include <linux/slab.h>
22 #include <linux/iommu.h>
24 #include <linux/vmalloc.h>
25 #include <linux/sizes.h>
26 #include <linux/cma.h>
28 #include <asm/memory.h>
29 #include <asm/highmem.h>
30 #include <asm/cacheflush.h>
31 #include <asm/tlbflush.h>
32 #include <asm/mach/arch.h>
33 #include <asm/dma-iommu.h>
34 #include <asm/mach/map.h>
35 #include <asm/system_info.h>
36 #include <asm/xen/xen-ops.h>
41 struct arm_dma_alloc_args {
51 struct arm_dma_free_args {
62 struct arm_dma_allocator {
63 void *(*alloc)(struct arm_dma_alloc_args *args,
64 struct page **ret_page);
65 void (*free)(struct arm_dma_free_args *args);
68 struct arm_dma_buffer {
69 struct list_head list;
71 struct arm_dma_allocator *allocator;
74 static LIST_HEAD(arm_dma_bufs);
75 static DEFINE_SPINLOCK(arm_dma_bufs_lock);
77 static struct arm_dma_buffer *arm_dma_buffer_find(void *virt)
79 struct arm_dma_buffer *buf, *found = NULL;
82 spin_lock_irqsave(&arm_dma_bufs_lock, flags);
83 list_for_each_entry(buf, &arm_dma_bufs, list) {
84 if (buf->virt == virt) {
90 spin_unlock_irqrestore(&arm_dma_bufs_lock, flags);
95 * The DMA API is built upon the notion of "buffer ownership". A buffer
96 * is either exclusively owned by the CPU (and therefore may be accessed
97 * by it) or exclusively owned by the DMA device. These helper functions
98 * represent the transitions between these two ownership states.
100 * Note, however, that on later ARMs, this notion does not work due to
101 * speculative prefetches. We model our approach on the assumption that
102 * the CPU does do speculative prefetches, which means we clean caches
103 * before transfers and delay cache invalidation until transfer completion.
106 static void __dma_page_cpu_to_dev(struct page *, unsigned long,
107 size_t, enum dma_data_direction);
108 static void __dma_page_dev_to_cpu(struct page *, unsigned long,
109 size_t, enum dma_data_direction);
112 * arm_dma_map_page - map a portion of a page for streaming DMA
113 * @dev: valid struct device pointer, or NULL for ISA and EISA-like devices
114 * @page: page that buffer resides in
115 * @offset: offset into page for start of buffer
116 * @size: size of buffer to map
117 * @dir: DMA transfer direction
119 * Ensure that any data held in the cache is appropriately discarded
122 * The device owns this memory once this call has completed. The CPU
123 * can regain ownership by calling dma_unmap_page().
125 static dma_addr_t arm_dma_map_page(struct device *dev, struct page *page,
126 unsigned long offset, size_t size, enum dma_data_direction dir,
129 if ((attrs & DMA_ATTR_SKIP_CPU_SYNC) == 0)
130 __dma_page_cpu_to_dev(page, offset, size, dir);
131 return pfn_to_dma(dev, page_to_pfn(page)) + offset;
134 static dma_addr_t arm_coherent_dma_map_page(struct device *dev, struct page *page,
135 unsigned long offset, size_t size, enum dma_data_direction dir,
138 return pfn_to_dma(dev, page_to_pfn(page)) + offset;
142 * arm_dma_unmap_page - unmap a buffer previously mapped through dma_map_page()
143 * @dev: valid struct device pointer, or NULL for ISA and EISA-like devices
144 * @handle: DMA address of buffer
145 * @size: size of buffer (same as passed to dma_map_page)
146 * @dir: DMA transfer direction (same as passed to dma_map_page)
148 * Unmap a page streaming mode DMA translation. The handle and size
149 * must match what was provided in the previous dma_map_page() call.
150 * All other usages are undefined.
152 * After this call, reads by the CPU to the buffer are guaranteed to see
153 * whatever the device wrote there.
155 static void arm_dma_unmap_page(struct device *dev, dma_addr_t handle,
156 size_t size, enum dma_data_direction dir, unsigned long attrs)
158 if ((attrs & DMA_ATTR_SKIP_CPU_SYNC) == 0)
159 __dma_page_dev_to_cpu(pfn_to_page(dma_to_pfn(dev, handle)),
160 handle & ~PAGE_MASK, size, dir);
163 static void arm_dma_sync_single_for_cpu(struct device *dev,
164 dma_addr_t handle, size_t size, enum dma_data_direction dir)
166 unsigned int offset = handle & (PAGE_SIZE - 1);
167 struct page *page = pfn_to_page(dma_to_pfn(dev, handle-offset));
168 __dma_page_dev_to_cpu(page, offset, size, dir);
171 static void arm_dma_sync_single_for_device(struct device *dev,
172 dma_addr_t handle, size_t size, enum dma_data_direction dir)
174 unsigned int offset = handle & (PAGE_SIZE - 1);
175 struct page *page = pfn_to_page(dma_to_pfn(dev, handle-offset));
176 __dma_page_cpu_to_dev(page, offset, size, dir);
180 * Return whether the given device DMA address mask can be supported
181 * properly. For example, if your device can only drive the low 24-bits
182 * during bus mastering, then you would pass 0x00ffffff as the mask
185 static int arm_dma_supported(struct device *dev, u64 mask)
187 unsigned long max_dma_pfn = min(max_pfn - 1, arm_dma_pfn_limit);
190 * Translate the device's DMA mask to a PFN limit. This
191 * PFN number includes the page which we can DMA to.
193 return dma_to_pfn(dev, mask) >= max_dma_pfn;
196 const struct dma_map_ops arm_dma_ops = {
197 .alloc = arm_dma_alloc,
198 .free = arm_dma_free,
199 .alloc_pages = dma_direct_alloc_pages,
200 .free_pages = dma_direct_free_pages,
201 .mmap = arm_dma_mmap,
202 .get_sgtable = arm_dma_get_sgtable,
203 .map_page = arm_dma_map_page,
204 .unmap_page = arm_dma_unmap_page,
205 .map_sg = arm_dma_map_sg,
206 .unmap_sg = arm_dma_unmap_sg,
207 .map_resource = dma_direct_map_resource,
208 .sync_single_for_cpu = arm_dma_sync_single_for_cpu,
209 .sync_single_for_device = arm_dma_sync_single_for_device,
210 .sync_sg_for_cpu = arm_dma_sync_sg_for_cpu,
211 .sync_sg_for_device = arm_dma_sync_sg_for_device,
212 .dma_supported = arm_dma_supported,
213 .get_required_mask = dma_direct_get_required_mask,
215 EXPORT_SYMBOL(arm_dma_ops);
217 static void *arm_coherent_dma_alloc(struct device *dev, size_t size,
218 dma_addr_t *handle, gfp_t gfp, unsigned long attrs);
219 static void arm_coherent_dma_free(struct device *dev, size_t size, void *cpu_addr,
220 dma_addr_t handle, unsigned long attrs);
221 static int arm_coherent_dma_mmap(struct device *dev, struct vm_area_struct *vma,
222 void *cpu_addr, dma_addr_t dma_addr, size_t size,
223 unsigned long attrs);
225 const struct dma_map_ops arm_coherent_dma_ops = {
226 .alloc = arm_coherent_dma_alloc,
227 .free = arm_coherent_dma_free,
228 .alloc_pages = dma_direct_alloc_pages,
229 .free_pages = dma_direct_free_pages,
230 .mmap = arm_coherent_dma_mmap,
231 .get_sgtable = arm_dma_get_sgtable,
232 .map_page = arm_coherent_dma_map_page,
233 .map_sg = arm_dma_map_sg,
234 .map_resource = dma_direct_map_resource,
235 .dma_supported = arm_dma_supported,
236 .get_required_mask = dma_direct_get_required_mask,
238 EXPORT_SYMBOL(arm_coherent_dma_ops);
240 static void __dma_clear_buffer(struct page *page, size_t size, int coherent_flag)
243 * Ensure that the allocated pages are zeroed, and that any data
244 * lurking in the kernel direct-mapped region is invalidated.
246 if (PageHighMem(page)) {
247 phys_addr_t base = __pfn_to_phys(page_to_pfn(page));
248 phys_addr_t end = base + size;
250 void *ptr = kmap_atomic(page);
251 memset(ptr, 0, PAGE_SIZE);
252 if (coherent_flag != COHERENT)
253 dmac_flush_range(ptr, ptr + PAGE_SIZE);
258 if (coherent_flag != COHERENT)
259 outer_flush_range(base, end);
261 void *ptr = page_address(page);
262 memset(ptr, 0, size);
263 if (coherent_flag != COHERENT) {
264 dmac_flush_range(ptr, ptr + size);
265 outer_flush_range(__pa(ptr), __pa(ptr) + size);
271 * Allocate a DMA buffer for 'dev' of size 'size' using the
272 * specified gfp mask. Note that 'size' must be page aligned.
274 static struct page *__dma_alloc_buffer(struct device *dev, size_t size,
275 gfp_t gfp, int coherent_flag)
277 unsigned long order = get_order(size);
278 struct page *page, *p, *e;
280 page = alloc_pages(gfp, order);
285 * Now split the huge page and free the excess pages
287 split_page(page, order);
288 for (p = page + (size >> PAGE_SHIFT), e = page + (1 << order); p < e; p++)
291 __dma_clear_buffer(page, size, coherent_flag);
297 * Free a DMA buffer. 'size' must be page aligned.
299 static void __dma_free_buffer(struct page *page, size_t size)
301 struct page *e = page + (size >> PAGE_SHIFT);
309 static void *__alloc_from_contiguous(struct device *dev, size_t size,
310 pgprot_t prot, struct page **ret_page,
311 const void *caller, bool want_vaddr,
312 int coherent_flag, gfp_t gfp);
314 static void *__alloc_remap_buffer(struct device *dev, size_t size, gfp_t gfp,
315 pgprot_t prot, struct page **ret_page,
316 const void *caller, bool want_vaddr);
318 #define DEFAULT_DMA_COHERENT_POOL_SIZE SZ_256K
319 static struct gen_pool *atomic_pool __ro_after_init;
321 static size_t atomic_pool_size __initdata = DEFAULT_DMA_COHERENT_POOL_SIZE;
323 static int __init early_coherent_pool(char *p)
325 atomic_pool_size = memparse(p, &p);
328 early_param("coherent_pool", early_coherent_pool);
331 * Initialise the coherent pool for atomic allocations.
333 static int __init atomic_pool_init(void)
335 pgprot_t prot = pgprot_dmacoherent(PAGE_KERNEL);
336 gfp_t gfp = GFP_KERNEL | GFP_DMA;
340 atomic_pool = gen_pool_create(PAGE_SHIFT, -1);
344 * The atomic pool is only used for non-coherent allocations
345 * so we must pass NORMAL for coherent_flag.
347 if (dev_get_cma_area(NULL))
348 ptr = __alloc_from_contiguous(NULL, atomic_pool_size, prot,
349 &page, atomic_pool_init, true, NORMAL,
352 ptr = __alloc_remap_buffer(NULL, atomic_pool_size, gfp, prot,
353 &page, atomic_pool_init, true);
357 ret = gen_pool_add_virt(atomic_pool, (unsigned long)ptr,
359 atomic_pool_size, -1);
361 goto destroy_genpool;
363 gen_pool_set_algo(atomic_pool,
364 gen_pool_first_fit_order_align,
366 pr_info("DMA: preallocated %zu KiB pool for atomic coherent allocations\n",
367 atomic_pool_size / 1024);
372 gen_pool_destroy(atomic_pool);
375 pr_err("DMA: failed to allocate %zu KiB pool for atomic coherent allocation\n",
376 atomic_pool_size / 1024);
380 * CMA is activated by core_initcall, so we must be called after it.
382 postcore_initcall(atomic_pool_init);
384 #ifdef CONFIG_CMA_AREAS
385 struct dma_contig_early_reserve {
390 static struct dma_contig_early_reserve dma_mmu_remap[MAX_CMA_AREAS] __initdata;
392 static int dma_mmu_remap_num __initdata;
394 void __init dma_contiguous_early_fixup(phys_addr_t base, unsigned long size)
396 dma_mmu_remap[dma_mmu_remap_num].base = base;
397 dma_mmu_remap[dma_mmu_remap_num].size = size;
401 void __init dma_contiguous_remap(void)
404 for (i = 0; i < dma_mmu_remap_num; i++) {
405 phys_addr_t start = dma_mmu_remap[i].base;
406 phys_addr_t end = start + dma_mmu_remap[i].size;
410 if (end > arm_lowmem_limit)
411 end = arm_lowmem_limit;
415 map.pfn = __phys_to_pfn(start);
416 map.virtual = __phys_to_virt(start);
417 map.length = end - start;
418 map.type = MT_MEMORY_DMA_READY;
421 * Clear previous low-memory mapping to ensure that the
422 * TLB does not see any conflicting entries, then flush
423 * the TLB of the old entries before creating new mappings.
425 * This ensures that any speculatively loaded TLB entries
426 * (even though they may be rare) can not cause any problems,
427 * and ensures that this code is architecturally compliant.
429 for (addr = __phys_to_virt(start); addr < __phys_to_virt(end);
431 pmd_clear(pmd_off_k(addr));
433 flush_tlb_kernel_range(__phys_to_virt(start),
434 __phys_to_virt(end));
436 iotable_init(&map, 1);
441 static int __dma_update_pte(pte_t *pte, unsigned long addr, void *data)
443 struct page *page = virt_to_page(addr);
444 pgprot_t prot = *(pgprot_t *)data;
446 set_pte_ext(pte, mk_pte(page, prot), 0);
450 static void __dma_remap(struct page *page, size_t size, pgprot_t prot)
452 unsigned long start = (unsigned long) page_address(page);
453 unsigned end = start + size;
455 apply_to_page_range(&init_mm, start, size, __dma_update_pte, &prot);
456 flush_tlb_kernel_range(start, end);
459 static void *__alloc_remap_buffer(struct device *dev, size_t size, gfp_t gfp,
460 pgprot_t prot, struct page **ret_page,
461 const void *caller, bool want_vaddr)
466 * __alloc_remap_buffer is only called when the device is
469 page = __dma_alloc_buffer(dev, size, gfp, NORMAL);
475 ptr = dma_common_contiguous_remap(page, size, prot, caller);
477 __dma_free_buffer(page, size);
486 static void *__alloc_from_pool(size_t size, struct page **ret_page)
492 WARN(1, "coherent pool not initialised!\n");
496 val = gen_pool_alloc(atomic_pool, size);
498 phys_addr_t phys = gen_pool_virt_to_phys(atomic_pool, val);
500 *ret_page = phys_to_page(phys);
507 static bool __in_atomic_pool(void *start, size_t size)
509 return gen_pool_has_addr(atomic_pool, (unsigned long)start, size);
512 static int __free_from_pool(void *start, size_t size)
514 if (!__in_atomic_pool(start, size))
517 gen_pool_free(atomic_pool, (unsigned long)start, size);
522 static void *__alloc_from_contiguous(struct device *dev, size_t size,
523 pgprot_t prot, struct page **ret_page,
524 const void *caller, bool want_vaddr,
525 int coherent_flag, gfp_t gfp)
527 unsigned long order = get_order(size);
528 size_t count = size >> PAGE_SHIFT;
532 page = dma_alloc_from_contiguous(dev, count, order, gfp & __GFP_NOWARN);
536 __dma_clear_buffer(page, size, coherent_flag);
541 if (PageHighMem(page)) {
542 ptr = dma_common_contiguous_remap(page, size, prot, caller);
544 dma_release_from_contiguous(dev, page, count);
548 __dma_remap(page, size, prot);
549 ptr = page_address(page);
557 static void __free_from_contiguous(struct device *dev, struct page *page,
558 void *cpu_addr, size_t size, bool want_vaddr)
561 if (PageHighMem(page))
562 dma_common_free_remap(cpu_addr, size);
564 __dma_remap(page, size, PAGE_KERNEL);
566 dma_release_from_contiguous(dev, page, size >> PAGE_SHIFT);
569 static inline pgprot_t __get_dma_pgprot(unsigned long attrs, pgprot_t prot)
571 prot = (attrs & DMA_ATTR_WRITE_COMBINE) ?
572 pgprot_writecombine(prot) :
573 pgprot_dmacoherent(prot);
577 static void *__alloc_simple_buffer(struct device *dev, size_t size, gfp_t gfp,
578 struct page **ret_page)
581 /* __alloc_simple_buffer is only called when the device is coherent */
582 page = __dma_alloc_buffer(dev, size, gfp, COHERENT);
587 return page_address(page);
590 static void *simple_allocator_alloc(struct arm_dma_alloc_args *args,
591 struct page **ret_page)
593 return __alloc_simple_buffer(args->dev, args->size, args->gfp,
597 static void simple_allocator_free(struct arm_dma_free_args *args)
599 __dma_free_buffer(args->page, args->size);
602 static struct arm_dma_allocator simple_allocator = {
603 .alloc = simple_allocator_alloc,
604 .free = simple_allocator_free,
607 static void *cma_allocator_alloc(struct arm_dma_alloc_args *args,
608 struct page **ret_page)
610 return __alloc_from_contiguous(args->dev, args->size, args->prot,
611 ret_page, args->caller,
612 args->want_vaddr, args->coherent_flag,
616 static void cma_allocator_free(struct arm_dma_free_args *args)
618 __free_from_contiguous(args->dev, args->page, args->cpu_addr,
619 args->size, args->want_vaddr);
622 static struct arm_dma_allocator cma_allocator = {
623 .alloc = cma_allocator_alloc,
624 .free = cma_allocator_free,
627 static void *pool_allocator_alloc(struct arm_dma_alloc_args *args,
628 struct page **ret_page)
630 return __alloc_from_pool(args->size, ret_page);
633 static void pool_allocator_free(struct arm_dma_free_args *args)
635 __free_from_pool(args->cpu_addr, args->size);
638 static struct arm_dma_allocator pool_allocator = {
639 .alloc = pool_allocator_alloc,
640 .free = pool_allocator_free,
643 static void *remap_allocator_alloc(struct arm_dma_alloc_args *args,
644 struct page **ret_page)
646 return __alloc_remap_buffer(args->dev, args->size, args->gfp,
647 args->prot, ret_page, args->caller,
651 static void remap_allocator_free(struct arm_dma_free_args *args)
653 if (args->want_vaddr)
654 dma_common_free_remap(args->cpu_addr, args->size);
656 __dma_free_buffer(args->page, args->size);
659 static struct arm_dma_allocator remap_allocator = {
660 .alloc = remap_allocator_alloc,
661 .free = remap_allocator_free,
664 static void *__dma_alloc(struct device *dev, size_t size, dma_addr_t *handle,
665 gfp_t gfp, pgprot_t prot, bool is_coherent,
666 unsigned long attrs, const void *caller)
668 u64 mask = min_not_zero(dev->coherent_dma_mask, dev->bus_dma_limit);
669 struct page *page = NULL;
671 bool allowblock, cma;
672 struct arm_dma_buffer *buf;
673 struct arm_dma_alloc_args args = {
675 .size = PAGE_ALIGN(size),
679 .want_vaddr = ((attrs & DMA_ATTR_NO_KERNEL_MAPPING) == 0),
680 .coherent_flag = is_coherent ? COHERENT : NORMAL,
683 #ifdef CONFIG_DMA_API_DEBUG
684 u64 limit = (mask + 1) & ~mask;
685 if (limit && size >= limit) {
686 dev_warn(dev, "coherent allocation too big (requested %#x mask %#llx)\n",
692 buf = kzalloc(sizeof(*buf),
693 gfp & ~(__GFP_DMA | __GFP_DMA32 | __GFP_HIGHMEM));
697 if (mask < 0xffffffffULL)
701 * Following is a work-around (a.k.a. hack) to prevent pages
702 * with __GFP_COMP being passed to split_page() which cannot
703 * handle them. The real problem is that this flag probably
704 * should be 0 on ARM as it is not supported on this
705 * platform; see CONFIG_HUGETLBFS.
707 gfp &= ~(__GFP_COMP);
710 *handle = DMA_MAPPING_ERROR;
711 allowblock = gfpflags_allow_blocking(gfp);
712 cma = allowblock ? dev_get_cma_area(dev) : NULL;
715 buf->allocator = &cma_allocator;
716 else if (is_coherent)
717 buf->allocator = &simple_allocator;
719 buf->allocator = &remap_allocator;
721 buf->allocator = &pool_allocator;
723 addr = buf->allocator->alloc(&args, &page);
728 *handle = pfn_to_dma(dev, page_to_pfn(page));
729 buf->virt = args.want_vaddr ? addr : page;
731 spin_lock_irqsave(&arm_dma_bufs_lock, flags);
732 list_add(&buf->list, &arm_dma_bufs);
733 spin_unlock_irqrestore(&arm_dma_bufs_lock, flags);
738 return args.want_vaddr ? addr : page;
742 * Allocate DMA-coherent memory space and return both the kernel remapped
743 * virtual and bus address for that space.
745 void *arm_dma_alloc(struct device *dev, size_t size, dma_addr_t *handle,
746 gfp_t gfp, unsigned long attrs)
748 pgprot_t prot = __get_dma_pgprot(attrs, PAGE_KERNEL);
750 return __dma_alloc(dev, size, handle, gfp, prot, false,
751 attrs, __builtin_return_address(0));
754 static void *arm_coherent_dma_alloc(struct device *dev, size_t size,
755 dma_addr_t *handle, gfp_t gfp, unsigned long attrs)
757 return __dma_alloc(dev, size, handle, gfp, PAGE_KERNEL, true,
758 attrs, __builtin_return_address(0));
761 static int __arm_dma_mmap(struct device *dev, struct vm_area_struct *vma,
762 void *cpu_addr, dma_addr_t dma_addr, size_t size,
766 unsigned long nr_vma_pages = vma_pages(vma);
767 unsigned long nr_pages = PAGE_ALIGN(size) >> PAGE_SHIFT;
768 unsigned long pfn = dma_to_pfn(dev, dma_addr);
769 unsigned long off = vma->vm_pgoff;
771 if (dma_mmap_from_dev_coherent(dev, vma, cpu_addr, size, &ret))
774 if (off < nr_pages && nr_vma_pages <= (nr_pages - off)) {
775 ret = remap_pfn_range(vma, vma->vm_start,
777 vma->vm_end - vma->vm_start,
785 * Create userspace mapping for the DMA-coherent memory.
787 static int arm_coherent_dma_mmap(struct device *dev, struct vm_area_struct *vma,
788 void *cpu_addr, dma_addr_t dma_addr, size_t size,
791 return __arm_dma_mmap(dev, vma, cpu_addr, dma_addr, size, attrs);
794 int arm_dma_mmap(struct device *dev, struct vm_area_struct *vma,
795 void *cpu_addr, dma_addr_t dma_addr, size_t size,
798 vma->vm_page_prot = __get_dma_pgprot(attrs, vma->vm_page_prot);
799 return __arm_dma_mmap(dev, vma, cpu_addr, dma_addr, size, attrs);
803 * Free a buffer as defined by the above mapping.
805 static void __arm_dma_free(struct device *dev, size_t size, void *cpu_addr,
806 dma_addr_t handle, unsigned long attrs,
809 struct page *page = pfn_to_page(dma_to_pfn(dev, handle));
810 struct arm_dma_buffer *buf;
811 struct arm_dma_free_args args = {
813 .size = PAGE_ALIGN(size),
814 .cpu_addr = cpu_addr,
816 .want_vaddr = ((attrs & DMA_ATTR_NO_KERNEL_MAPPING) == 0),
819 buf = arm_dma_buffer_find(cpu_addr);
820 if (WARN(!buf, "Freeing invalid buffer %p\n", cpu_addr))
823 buf->allocator->free(&args);
827 void arm_dma_free(struct device *dev, size_t size, void *cpu_addr,
828 dma_addr_t handle, unsigned long attrs)
830 __arm_dma_free(dev, size, cpu_addr, handle, attrs, false);
833 static void arm_coherent_dma_free(struct device *dev, size_t size, void *cpu_addr,
834 dma_addr_t handle, unsigned long attrs)
836 __arm_dma_free(dev, size, cpu_addr, handle, attrs, true);
839 int arm_dma_get_sgtable(struct device *dev, struct sg_table *sgt,
840 void *cpu_addr, dma_addr_t handle, size_t size,
843 unsigned long pfn = dma_to_pfn(dev, handle);
847 /* If the PFN is not valid, we do not have a struct page */
851 page = pfn_to_page(pfn);
853 ret = sg_alloc_table(sgt, 1, GFP_KERNEL);
857 sg_set_page(sgt->sgl, page, PAGE_ALIGN(size), 0);
861 static void dma_cache_maint_page(struct page *page, unsigned long offset,
862 size_t size, enum dma_data_direction dir,
863 void (*op)(const void *, size_t, int))
868 pfn = page_to_pfn(page) + offset / PAGE_SIZE;
872 * A single sg entry may refer to multiple physically contiguous
873 * pages. But we still need to process highmem pages individually.
874 * If highmem is not configured then the bulk of this loop gets
881 page = pfn_to_page(pfn);
883 if (PageHighMem(page)) {
884 if (len + offset > PAGE_SIZE)
885 len = PAGE_SIZE - offset;
887 if (cache_is_vipt_nonaliasing()) {
888 vaddr = kmap_atomic(page);
889 op(vaddr + offset, len, dir);
890 kunmap_atomic(vaddr);
892 vaddr = kmap_high_get(page);
894 op(vaddr + offset, len, dir);
899 vaddr = page_address(page) + offset;
909 * Make an area consistent for devices.
910 * Note: Drivers should NOT use this function directly, as it will break
911 * platforms with CONFIG_DMABOUNCE.
912 * Use the driver DMA support - see dma-mapping.h (dma_sync_*)
914 static void __dma_page_cpu_to_dev(struct page *page, unsigned long off,
915 size_t size, enum dma_data_direction dir)
919 dma_cache_maint_page(page, off, size, dir, dmac_map_area);
921 paddr = page_to_phys(page) + off;
922 if (dir == DMA_FROM_DEVICE) {
923 outer_inv_range(paddr, paddr + size);
925 outer_clean_range(paddr, paddr + size);
927 /* FIXME: non-speculating: flush on bidirectional mappings? */
930 static void __dma_page_dev_to_cpu(struct page *page, unsigned long off,
931 size_t size, enum dma_data_direction dir)
933 phys_addr_t paddr = page_to_phys(page) + off;
935 /* FIXME: non-speculating: not required */
936 /* in any case, don't bother invalidating if DMA to device */
937 if (dir != DMA_TO_DEVICE) {
938 outer_inv_range(paddr, paddr + size);
940 dma_cache_maint_page(page, off, size, dir, dmac_unmap_area);
944 * Mark the D-cache clean for these pages to avoid extra flushing.
946 if (dir != DMA_TO_DEVICE && size >= PAGE_SIZE) {
950 pfn = page_to_pfn(page) + off / PAGE_SIZE;
954 left -= PAGE_SIZE - off;
956 while (left >= PAGE_SIZE) {
957 page = pfn_to_page(pfn++);
958 set_bit(PG_dcache_clean, &page->flags);
965 * arm_dma_map_sg - map a set of SG buffers for streaming mode DMA
966 * @dev: valid struct device pointer, or NULL for ISA and EISA-like devices
967 * @sg: list of buffers
968 * @nents: number of buffers to map
969 * @dir: DMA transfer direction
971 * Map a set of buffers described by scatterlist in streaming mode for DMA.
972 * This is the scatter-gather version of the dma_map_single interface.
973 * Here the scatter gather list elements are each tagged with the
974 * appropriate dma address and length. They are obtained via
975 * sg_dma_{address,length}.
977 * Device ownership issues as mentioned for dma_map_single are the same
980 int arm_dma_map_sg(struct device *dev, struct scatterlist *sg, int nents,
981 enum dma_data_direction dir, unsigned long attrs)
983 const struct dma_map_ops *ops = get_dma_ops(dev);
984 struct scatterlist *s;
987 for_each_sg(sg, s, nents, i) {
988 #ifdef CONFIG_NEED_SG_DMA_LENGTH
989 s->dma_length = s->length;
991 s->dma_address = ops->map_page(dev, sg_page(s), s->offset,
992 s->length, dir, attrs);
993 if (dma_mapping_error(dev, s->dma_address)) {
1001 for_each_sg(sg, s, i, j)
1002 ops->unmap_page(dev, sg_dma_address(s), sg_dma_len(s), dir, attrs);
1007 * arm_dma_unmap_sg - unmap a set of SG buffers mapped by dma_map_sg
1008 * @dev: valid struct device pointer, or NULL for ISA and EISA-like devices
1009 * @sg: list of buffers
1010 * @nents: number of buffers to unmap (same as was passed to dma_map_sg)
1011 * @dir: DMA transfer direction (same as was passed to dma_map_sg)
1013 * Unmap a set of streaming mode DMA translations. Again, CPU access
1014 * rules concerning calls here are the same as for dma_unmap_single().
1016 void arm_dma_unmap_sg(struct device *dev, struct scatterlist *sg, int nents,
1017 enum dma_data_direction dir, unsigned long attrs)
1019 const struct dma_map_ops *ops = get_dma_ops(dev);
1020 struct scatterlist *s;
1024 for_each_sg(sg, s, nents, i)
1025 ops->unmap_page(dev, sg_dma_address(s), sg_dma_len(s), dir, attrs);
1029 * arm_dma_sync_sg_for_cpu
1030 * @dev: valid struct device pointer, or NULL for ISA and EISA-like devices
1031 * @sg: list of buffers
1032 * @nents: number of buffers to map (returned from dma_map_sg)
1033 * @dir: DMA transfer direction (same as was passed to dma_map_sg)
1035 void arm_dma_sync_sg_for_cpu(struct device *dev, struct scatterlist *sg,
1036 int nents, enum dma_data_direction dir)
1038 const struct dma_map_ops *ops = get_dma_ops(dev);
1039 struct scatterlist *s;
1042 for_each_sg(sg, s, nents, i)
1043 ops->sync_single_for_cpu(dev, sg_dma_address(s), s->length,
1048 * arm_dma_sync_sg_for_device
1049 * @dev: valid struct device pointer, or NULL for ISA and EISA-like devices
1050 * @sg: list of buffers
1051 * @nents: number of buffers to map (returned from dma_map_sg)
1052 * @dir: DMA transfer direction (same as was passed to dma_map_sg)
1054 void arm_dma_sync_sg_for_device(struct device *dev, struct scatterlist *sg,
1055 int nents, enum dma_data_direction dir)
1057 const struct dma_map_ops *ops = get_dma_ops(dev);
1058 struct scatterlist *s;
1061 for_each_sg(sg, s, nents, i)
1062 ops->sync_single_for_device(dev, sg_dma_address(s), s->length,
1066 static const struct dma_map_ops *arm_get_dma_map_ops(bool coherent)
1069 * When CONFIG_ARM_LPAE is set, physical address can extend above
1070 * 32-bits, which then can't be addressed by devices that only support
1072 * Use the generic dma-direct / swiotlb ops code in that case, as that
1073 * handles bounce buffering for us.
1075 if (IS_ENABLED(CONFIG_ARM_LPAE))
1077 return coherent ? &arm_coherent_dma_ops : &arm_dma_ops;
1080 #ifdef CONFIG_ARM_DMA_USE_IOMMU
1082 static int __dma_info_to_prot(enum dma_data_direction dir, unsigned long attrs)
1086 if (attrs & DMA_ATTR_PRIVILEGED)
1090 case DMA_BIDIRECTIONAL:
1091 return prot | IOMMU_READ | IOMMU_WRITE;
1093 return prot | IOMMU_READ;
1094 case DMA_FROM_DEVICE:
1095 return prot | IOMMU_WRITE;
1103 static int extend_iommu_mapping(struct dma_iommu_mapping *mapping);
1105 static inline dma_addr_t __alloc_iova(struct dma_iommu_mapping *mapping,
1108 unsigned int order = get_order(size);
1109 unsigned int align = 0;
1110 unsigned int count, start;
1111 size_t mapping_size = mapping->bits << PAGE_SHIFT;
1112 unsigned long flags;
1116 if (order > CONFIG_ARM_DMA_IOMMU_ALIGNMENT)
1117 order = CONFIG_ARM_DMA_IOMMU_ALIGNMENT;
1119 count = PAGE_ALIGN(size) >> PAGE_SHIFT;
1120 align = (1 << order) - 1;
1122 spin_lock_irqsave(&mapping->lock, flags);
1123 for (i = 0; i < mapping->nr_bitmaps; i++) {
1124 start = bitmap_find_next_zero_area(mapping->bitmaps[i],
1125 mapping->bits, 0, count, align);
1127 if (start > mapping->bits)
1130 bitmap_set(mapping->bitmaps[i], start, count);
1135 * No unused range found. Try to extend the existing mapping
1136 * and perform a second attempt to reserve an IO virtual
1137 * address range of size bytes.
1139 if (i == mapping->nr_bitmaps) {
1140 if (extend_iommu_mapping(mapping)) {
1141 spin_unlock_irqrestore(&mapping->lock, flags);
1142 return DMA_MAPPING_ERROR;
1145 start = bitmap_find_next_zero_area(mapping->bitmaps[i],
1146 mapping->bits, 0, count, align);
1148 if (start > mapping->bits) {
1149 spin_unlock_irqrestore(&mapping->lock, flags);
1150 return DMA_MAPPING_ERROR;
1153 bitmap_set(mapping->bitmaps[i], start, count);
1155 spin_unlock_irqrestore(&mapping->lock, flags);
1157 iova = mapping->base + (mapping_size * i);
1158 iova += start << PAGE_SHIFT;
1163 static inline void __free_iova(struct dma_iommu_mapping *mapping,
1164 dma_addr_t addr, size_t size)
1166 unsigned int start, count;
1167 size_t mapping_size = mapping->bits << PAGE_SHIFT;
1168 unsigned long flags;
1169 dma_addr_t bitmap_base;
1175 bitmap_index = (u32) (addr - mapping->base) / (u32) mapping_size;
1176 BUG_ON(addr < mapping->base || bitmap_index > mapping->extensions);
1178 bitmap_base = mapping->base + mapping_size * bitmap_index;
1180 start = (addr - bitmap_base) >> PAGE_SHIFT;
1182 if (addr + size > bitmap_base + mapping_size) {
1184 * The address range to be freed reaches into the iova
1185 * range of the next bitmap. This should not happen as
1186 * we don't allow this in __alloc_iova (at the
1191 count = size >> PAGE_SHIFT;
1193 spin_lock_irqsave(&mapping->lock, flags);
1194 bitmap_clear(mapping->bitmaps[bitmap_index], start, count);
1195 spin_unlock_irqrestore(&mapping->lock, flags);
1198 /* We'll try 2M, 1M, 64K, and finally 4K; array must end with 0! */
1199 static const int iommu_order_array[] = { 9, 8, 4, 0 };
1201 static struct page **__iommu_alloc_buffer(struct device *dev, size_t size,
1202 gfp_t gfp, unsigned long attrs,
1205 struct page **pages;
1206 int count = size >> PAGE_SHIFT;
1207 int array_size = count * sizeof(struct page *);
1211 if (array_size <= PAGE_SIZE)
1212 pages = kzalloc(array_size, GFP_KERNEL);
1214 pages = vzalloc(array_size);
1218 if (attrs & DMA_ATTR_FORCE_CONTIGUOUS)
1220 unsigned long order = get_order(size);
1223 page = dma_alloc_from_contiguous(dev, count, order,
1224 gfp & __GFP_NOWARN);
1228 __dma_clear_buffer(page, size, coherent_flag);
1230 for (i = 0; i < count; i++)
1231 pages[i] = page + i;
1236 /* Go straight to 4K chunks if caller says it's OK. */
1237 if (attrs & DMA_ATTR_ALLOC_SINGLE_PAGES)
1238 order_idx = ARRAY_SIZE(iommu_order_array) - 1;
1241 * IOMMU can map any pages, so himem can also be used here
1243 gfp |= __GFP_NOWARN | __GFP_HIGHMEM;
1248 order = iommu_order_array[order_idx];
1250 /* Drop down when we get small */
1251 if (__fls(count) < order) {
1257 /* See if it's easy to allocate a high-order chunk */
1258 pages[i] = alloc_pages(gfp | __GFP_NORETRY, order);
1260 /* Go down a notch at first sign of pressure */
1266 pages[i] = alloc_pages(gfp, 0);
1272 split_page(pages[i], order);
1275 pages[i + j] = pages[i] + j;
1278 __dma_clear_buffer(pages[i], PAGE_SIZE << order, coherent_flag);
1280 count -= 1 << order;
1287 __free_pages(pages[i], 0);
1292 static int __iommu_free_buffer(struct device *dev, struct page **pages,
1293 size_t size, unsigned long attrs)
1295 int count = size >> PAGE_SHIFT;
1298 if (attrs & DMA_ATTR_FORCE_CONTIGUOUS) {
1299 dma_release_from_contiguous(dev, pages[0], count);
1301 for (i = 0; i < count; i++)
1303 __free_pages(pages[i], 0);
1311 * Create a mapping in device IO address space for specified pages
1314 __iommu_create_mapping(struct device *dev, struct page **pages, size_t size,
1315 unsigned long attrs)
1317 struct dma_iommu_mapping *mapping = to_dma_iommu_mapping(dev);
1318 unsigned int count = PAGE_ALIGN(size) >> PAGE_SHIFT;
1319 dma_addr_t dma_addr, iova;
1322 dma_addr = __alloc_iova(mapping, size);
1323 if (dma_addr == DMA_MAPPING_ERROR)
1327 for (i = 0; i < count; ) {
1330 unsigned int next_pfn = page_to_pfn(pages[i]) + 1;
1331 phys_addr_t phys = page_to_phys(pages[i]);
1332 unsigned int len, j;
1334 for (j = i + 1; j < count; j++, next_pfn++)
1335 if (page_to_pfn(pages[j]) != next_pfn)
1338 len = (j - i) << PAGE_SHIFT;
1339 ret = iommu_map(mapping->domain, iova, phys, len,
1340 __dma_info_to_prot(DMA_BIDIRECTIONAL, attrs));
1348 iommu_unmap(mapping->domain, dma_addr, iova-dma_addr);
1349 __free_iova(mapping, dma_addr, size);
1350 return DMA_MAPPING_ERROR;
1353 static int __iommu_remove_mapping(struct device *dev, dma_addr_t iova, size_t size)
1355 struct dma_iommu_mapping *mapping = to_dma_iommu_mapping(dev);
1358 * add optional in-page offset from iova to size and align
1359 * result to page size
1361 size = PAGE_ALIGN((iova & ~PAGE_MASK) + size);
1364 iommu_unmap(mapping->domain, iova, size);
1365 __free_iova(mapping, iova, size);
1369 static struct page **__atomic_get_pages(void *addr)
1374 phys = gen_pool_virt_to_phys(atomic_pool, (unsigned long)addr);
1375 page = phys_to_page(phys);
1377 return (struct page **)page;
1380 static struct page **__iommu_get_pages(void *cpu_addr, unsigned long attrs)
1382 if (__in_atomic_pool(cpu_addr, PAGE_SIZE))
1383 return __atomic_get_pages(cpu_addr);
1385 if (attrs & DMA_ATTR_NO_KERNEL_MAPPING)
1388 return dma_common_find_pages(cpu_addr);
1391 static void *__iommu_alloc_simple(struct device *dev, size_t size, gfp_t gfp,
1392 dma_addr_t *handle, int coherent_flag,
1393 unsigned long attrs)
1398 if (coherent_flag == COHERENT)
1399 addr = __alloc_simple_buffer(dev, size, gfp, &page);
1401 addr = __alloc_from_pool(size, &page);
1405 *handle = __iommu_create_mapping(dev, &page, size, attrs);
1406 if (*handle == DMA_MAPPING_ERROR)
1412 __free_from_pool(addr, size);
1416 static void __iommu_free_atomic(struct device *dev, void *cpu_addr,
1417 dma_addr_t handle, size_t size, int coherent_flag)
1419 __iommu_remove_mapping(dev, handle, size);
1420 if (coherent_flag == COHERENT)
1421 __dma_free_buffer(virt_to_page(cpu_addr), size);
1423 __free_from_pool(cpu_addr, size);
1426 static void *__arm_iommu_alloc_attrs(struct device *dev, size_t size,
1427 dma_addr_t *handle, gfp_t gfp, unsigned long attrs,
1430 pgprot_t prot = __get_dma_pgprot(attrs, PAGE_KERNEL);
1431 struct page **pages;
1434 *handle = DMA_MAPPING_ERROR;
1435 size = PAGE_ALIGN(size);
1437 if (coherent_flag == COHERENT || !gfpflags_allow_blocking(gfp))
1438 return __iommu_alloc_simple(dev, size, gfp, handle,
1439 coherent_flag, attrs);
1442 * Following is a work-around (a.k.a. hack) to prevent pages
1443 * with __GFP_COMP being passed to split_page() which cannot
1444 * handle them. The real problem is that this flag probably
1445 * should be 0 on ARM as it is not supported on this
1446 * platform; see CONFIG_HUGETLBFS.
1448 gfp &= ~(__GFP_COMP);
1450 pages = __iommu_alloc_buffer(dev, size, gfp, attrs, coherent_flag);
1454 *handle = __iommu_create_mapping(dev, pages, size, attrs);
1455 if (*handle == DMA_MAPPING_ERROR)
1458 if (attrs & DMA_ATTR_NO_KERNEL_MAPPING)
1461 addr = dma_common_pages_remap(pages, size, prot,
1462 __builtin_return_address(0));
1469 __iommu_remove_mapping(dev, *handle, size);
1471 __iommu_free_buffer(dev, pages, size, attrs);
1475 static void *arm_iommu_alloc_attrs(struct device *dev, size_t size,
1476 dma_addr_t *handle, gfp_t gfp, unsigned long attrs)
1478 return __arm_iommu_alloc_attrs(dev, size, handle, gfp, attrs, NORMAL);
1481 static void *arm_coherent_iommu_alloc_attrs(struct device *dev, size_t size,
1482 dma_addr_t *handle, gfp_t gfp, unsigned long attrs)
1484 return __arm_iommu_alloc_attrs(dev, size, handle, gfp, attrs, COHERENT);
1487 static int __arm_iommu_mmap_attrs(struct device *dev, struct vm_area_struct *vma,
1488 void *cpu_addr, dma_addr_t dma_addr, size_t size,
1489 unsigned long attrs)
1491 struct page **pages = __iommu_get_pages(cpu_addr, attrs);
1492 unsigned long nr_pages = PAGE_ALIGN(size) >> PAGE_SHIFT;
1498 if (vma->vm_pgoff >= nr_pages)
1501 err = vm_map_pages(vma, pages, nr_pages);
1503 pr_err("Remapping memory failed: %d\n", err);
1507 static int arm_iommu_mmap_attrs(struct device *dev,
1508 struct vm_area_struct *vma, void *cpu_addr,
1509 dma_addr_t dma_addr, size_t size, unsigned long attrs)
1511 vma->vm_page_prot = __get_dma_pgprot(attrs, vma->vm_page_prot);
1513 return __arm_iommu_mmap_attrs(dev, vma, cpu_addr, dma_addr, size, attrs);
1516 static int arm_coherent_iommu_mmap_attrs(struct device *dev,
1517 struct vm_area_struct *vma, void *cpu_addr,
1518 dma_addr_t dma_addr, size_t size, unsigned long attrs)
1520 return __arm_iommu_mmap_attrs(dev, vma, cpu_addr, dma_addr, size, attrs);
1524 * free a page as defined by the above mapping.
1525 * Must not be called with IRQs disabled.
1527 static void __arm_iommu_free_attrs(struct device *dev, size_t size, void *cpu_addr,
1528 dma_addr_t handle, unsigned long attrs, int coherent_flag)
1530 struct page **pages;
1531 size = PAGE_ALIGN(size);
1533 if (coherent_flag == COHERENT || __in_atomic_pool(cpu_addr, size)) {
1534 __iommu_free_atomic(dev, cpu_addr, handle, size, coherent_flag);
1538 pages = __iommu_get_pages(cpu_addr, attrs);
1540 WARN(1, "trying to free invalid coherent area: %p\n", cpu_addr);
1544 if ((attrs & DMA_ATTR_NO_KERNEL_MAPPING) == 0)
1545 dma_common_free_remap(cpu_addr, size);
1547 __iommu_remove_mapping(dev, handle, size);
1548 __iommu_free_buffer(dev, pages, size, attrs);
1551 static void arm_iommu_free_attrs(struct device *dev, size_t size,
1552 void *cpu_addr, dma_addr_t handle,
1553 unsigned long attrs)
1555 __arm_iommu_free_attrs(dev, size, cpu_addr, handle, attrs, NORMAL);
1558 static void arm_coherent_iommu_free_attrs(struct device *dev, size_t size,
1559 void *cpu_addr, dma_addr_t handle, unsigned long attrs)
1561 __arm_iommu_free_attrs(dev, size, cpu_addr, handle, attrs, COHERENT);
1564 static int arm_iommu_get_sgtable(struct device *dev, struct sg_table *sgt,
1565 void *cpu_addr, dma_addr_t dma_addr,
1566 size_t size, unsigned long attrs)
1568 unsigned int count = PAGE_ALIGN(size) >> PAGE_SHIFT;
1569 struct page **pages = __iommu_get_pages(cpu_addr, attrs);
1574 return sg_alloc_table_from_pages(sgt, pages, count, 0, size,
1579 * Map a part of the scatter-gather list into contiguous io address space
1581 static int __map_sg_chunk(struct device *dev, struct scatterlist *sg,
1582 size_t size, dma_addr_t *handle,
1583 enum dma_data_direction dir, unsigned long attrs,
1586 struct dma_iommu_mapping *mapping = to_dma_iommu_mapping(dev);
1587 dma_addr_t iova, iova_base;
1590 struct scatterlist *s;
1593 size = PAGE_ALIGN(size);
1594 *handle = DMA_MAPPING_ERROR;
1596 iova_base = iova = __alloc_iova(mapping, size);
1597 if (iova == DMA_MAPPING_ERROR)
1600 for (count = 0, s = sg; count < (size >> PAGE_SHIFT); s = sg_next(s)) {
1601 phys_addr_t phys = page_to_phys(sg_page(s));
1602 unsigned int len = PAGE_ALIGN(s->offset + s->length);
1604 if (!is_coherent && (attrs & DMA_ATTR_SKIP_CPU_SYNC) == 0)
1605 __dma_page_cpu_to_dev(sg_page(s), s->offset, s->length, dir);
1607 prot = __dma_info_to_prot(dir, attrs);
1609 ret = iommu_map(mapping->domain, iova, phys, len, prot);
1612 count += len >> PAGE_SHIFT;
1615 *handle = iova_base;
1619 iommu_unmap(mapping->domain, iova_base, count * PAGE_SIZE);
1620 __free_iova(mapping, iova_base, size);
1624 static int __iommu_map_sg(struct device *dev, struct scatterlist *sg, int nents,
1625 enum dma_data_direction dir, unsigned long attrs,
1628 struct scatterlist *s = sg, *dma = sg, *start = sg;
1629 int i, count = 0, ret;
1630 unsigned int offset = s->offset;
1631 unsigned int size = s->offset + s->length;
1632 unsigned int max = dma_get_max_seg_size(dev);
1634 for (i = 1; i < nents; i++) {
1639 if (s->offset || (size & ~PAGE_MASK) || size + s->length > max) {
1640 ret = __map_sg_chunk(dev, start, size,
1641 &dma->dma_address, dir, attrs,
1646 dma->dma_address += offset;
1647 dma->dma_length = size - offset;
1649 size = offset = s->offset;
1656 ret = __map_sg_chunk(dev, start, size, &dma->dma_address, dir, attrs,
1661 dma->dma_address += offset;
1662 dma->dma_length = size - offset;
1667 for_each_sg(sg, s, count, i)
1668 __iommu_remove_mapping(dev, sg_dma_address(s), sg_dma_len(s));
1675 * arm_coherent_iommu_map_sg - map a set of SG buffers for streaming mode DMA
1676 * @dev: valid struct device pointer
1677 * @sg: list of buffers
1678 * @nents: number of buffers to map
1679 * @dir: DMA transfer direction
1681 * Map a set of i/o coherent buffers described by scatterlist in streaming
1682 * mode for DMA. The scatter gather list elements are merged together (if
1683 * possible) and tagged with the appropriate dma address and length. They are
1684 * obtained via sg_dma_{address,length}.
1686 static int arm_coherent_iommu_map_sg(struct device *dev, struct scatterlist *sg,
1687 int nents, enum dma_data_direction dir, unsigned long attrs)
1689 return __iommu_map_sg(dev, sg, nents, dir, attrs, true);
1693 * arm_iommu_map_sg - map a set of SG buffers for streaming mode DMA
1694 * @dev: valid struct device pointer
1695 * @sg: list of buffers
1696 * @nents: number of buffers to map
1697 * @dir: DMA transfer direction
1699 * Map a set of buffers described by scatterlist in streaming mode for DMA.
1700 * The scatter gather list elements are merged together (if possible) and
1701 * tagged with the appropriate dma address and length. They are obtained via
1702 * sg_dma_{address,length}.
1704 static int arm_iommu_map_sg(struct device *dev, struct scatterlist *sg,
1705 int nents, enum dma_data_direction dir, unsigned long attrs)
1707 return __iommu_map_sg(dev, sg, nents, dir, attrs, false);
1710 static void __iommu_unmap_sg(struct device *dev, struct scatterlist *sg,
1711 int nents, enum dma_data_direction dir,
1712 unsigned long attrs, bool is_coherent)
1714 struct scatterlist *s;
1717 for_each_sg(sg, s, nents, i) {
1719 __iommu_remove_mapping(dev, sg_dma_address(s),
1721 if (!is_coherent && (attrs & DMA_ATTR_SKIP_CPU_SYNC) == 0)
1722 __dma_page_dev_to_cpu(sg_page(s), s->offset,
1728 * arm_coherent_iommu_unmap_sg - unmap a set of SG buffers mapped by dma_map_sg
1729 * @dev: valid struct device pointer
1730 * @sg: list of buffers
1731 * @nents: number of buffers to unmap (same as was passed to dma_map_sg)
1732 * @dir: DMA transfer direction (same as was passed to dma_map_sg)
1734 * Unmap a set of streaming mode DMA translations. Again, CPU access
1735 * rules concerning calls here are the same as for dma_unmap_single().
1737 static void arm_coherent_iommu_unmap_sg(struct device *dev,
1738 struct scatterlist *sg, int nents, enum dma_data_direction dir,
1739 unsigned long attrs)
1741 __iommu_unmap_sg(dev, sg, nents, dir, attrs, true);
1745 * arm_iommu_unmap_sg - unmap a set of SG buffers mapped by dma_map_sg
1746 * @dev: valid struct device pointer
1747 * @sg: list of buffers
1748 * @nents: number of buffers to unmap (same as was passed to dma_map_sg)
1749 * @dir: DMA transfer direction (same as was passed to dma_map_sg)
1751 * Unmap a set of streaming mode DMA translations. Again, CPU access
1752 * rules concerning calls here are the same as for dma_unmap_single().
1754 static void arm_iommu_unmap_sg(struct device *dev,
1755 struct scatterlist *sg, int nents,
1756 enum dma_data_direction dir,
1757 unsigned long attrs)
1759 __iommu_unmap_sg(dev, sg, nents, dir, attrs, false);
1763 * arm_iommu_sync_sg_for_cpu
1764 * @dev: valid struct device pointer
1765 * @sg: list of buffers
1766 * @nents: number of buffers to map (returned from dma_map_sg)
1767 * @dir: DMA transfer direction (same as was passed to dma_map_sg)
1769 static void arm_iommu_sync_sg_for_cpu(struct device *dev,
1770 struct scatterlist *sg,
1771 int nents, enum dma_data_direction dir)
1773 struct scatterlist *s;
1776 for_each_sg(sg, s, nents, i)
1777 __dma_page_dev_to_cpu(sg_page(s), s->offset, s->length, dir);
1782 * arm_iommu_sync_sg_for_device
1783 * @dev: valid struct device pointer
1784 * @sg: list of buffers
1785 * @nents: number of buffers to map (returned from dma_map_sg)
1786 * @dir: DMA transfer direction (same as was passed to dma_map_sg)
1788 static void arm_iommu_sync_sg_for_device(struct device *dev,
1789 struct scatterlist *sg,
1790 int nents, enum dma_data_direction dir)
1792 struct scatterlist *s;
1795 for_each_sg(sg, s, nents, i)
1796 __dma_page_cpu_to_dev(sg_page(s), s->offset, s->length, dir);
1801 * arm_coherent_iommu_map_page
1802 * @dev: valid struct device pointer
1803 * @page: page that buffer resides in
1804 * @offset: offset into page for start of buffer
1805 * @size: size of buffer to map
1806 * @dir: DMA transfer direction
1808 * Coherent IOMMU aware version of arm_dma_map_page()
1810 static dma_addr_t arm_coherent_iommu_map_page(struct device *dev, struct page *page,
1811 unsigned long offset, size_t size, enum dma_data_direction dir,
1812 unsigned long attrs)
1814 struct dma_iommu_mapping *mapping = to_dma_iommu_mapping(dev);
1815 dma_addr_t dma_addr;
1816 int ret, prot, len = PAGE_ALIGN(size + offset);
1818 dma_addr = __alloc_iova(mapping, len);
1819 if (dma_addr == DMA_MAPPING_ERROR)
1822 prot = __dma_info_to_prot(dir, attrs);
1824 ret = iommu_map(mapping->domain, dma_addr, page_to_phys(page), len, prot);
1828 return dma_addr + offset;
1830 __free_iova(mapping, dma_addr, len);
1831 return DMA_MAPPING_ERROR;
1835 * arm_iommu_map_page
1836 * @dev: valid struct device pointer
1837 * @page: page that buffer resides in
1838 * @offset: offset into page for start of buffer
1839 * @size: size of buffer to map
1840 * @dir: DMA transfer direction
1842 * IOMMU aware version of arm_dma_map_page()
1844 static dma_addr_t arm_iommu_map_page(struct device *dev, struct page *page,
1845 unsigned long offset, size_t size, enum dma_data_direction dir,
1846 unsigned long attrs)
1848 if ((attrs & DMA_ATTR_SKIP_CPU_SYNC) == 0)
1849 __dma_page_cpu_to_dev(page, offset, size, dir);
1851 return arm_coherent_iommu_map_page(dev, page, offset, size, dir, attrs);
1855 * arm_coherent_iommu_unmap_page
1856 * @dev: valid struct device pointer
1857 * @handle: DMA address of buffer
1858 * @size: size of buffer (same as passed to dma_map_page)
1859 * @dir: DMA transfer direction (same as passed to dma_map_page)
1861 * Coherent IOMMU aware version of arm_dma_unmap_page()
1863 static void arm_coherent_iommu_unmap_page(struct device *dev, dma_addr_t handle,
1864 size_t size, enum dma_data_direction dir, unsigned long attrs)
1866 struct dma_iommu_mapping *mapping = to_dma_iommu_mapping(dev);
1867 dma_addr_t iova = handle & PAGE_MASK;
1868 int offset = handle & ~PAGE_MASK;
1869 int len = PAGE_ALIGN(size + offset);
1874 iommu_unmap(mapping->domain, iova, len);
1875 __free_iova(mapping, iova, len);
1879 * arm_iommu_unmap_page
1880 * @dev: valid struct device pointer
1881 * @handle: DMA address of buffer
1882 * @size: size of buffer (same as passed to dma_map_page)
1883 * @dir: DMA transfer direction (same as passed to dma_map_page)
1885 * IOMMU aware version of arm_dma_unmap_page()
1887 static void arm_iommu_unmap_page(struct device *dev, dma_addr_t handle,
1888 size_t size, enum dma_data_direction dir, unsigned long attrs)
1890 struct dma_iommu_mapping *mapping = to_dma_iommu_mapping(dev);
1891 dma_addr_t iova = handle & PAGE_MASK;
1892 struct page *page = phys_to_page(iommu_iova_to_phys(mapping->domain, iova));
1893 int offset = handle & ~PAGE_MASK;
1894 int len = PAGE_ALIGN(size + offset);
1899 if ((attrs & DMA_ATTR_SKIP_CPU_SYNC) == 0)
1900 __dma_page_dev_to_cpu(page, offset, size, dir);
1902 iommu_unmap(mapping->domain, iova, len);
1903 __free_iova(mapping, iova, len);
1907 * arm_iommu_map_resource - map a device resource for DMA
1908 * @dev: valid struct device pointer
1909 * @phys_addr: physical address of resource
1910 * @size: size of resource to map
1911 * @dir: DMA transfer direction
1913 static dma_addr_t arm_iommu_map_resource(struct device *dev,
1914 phys_addr_t phys_addr, size_t size,
1915 enum dma_data_direction dir, unsigned long attrs)
1917 struct dma_iommu_mapping *mapping = to_dma_iommu_mapping(dev);
1918 dma_addr_t dma_addr;
1920 phys_addr_t addr = phys_addr & PAGE_MASK;
1921 unsigned int offset = phys_addr & ~PAGE_MASK;
1922 size_t len = PAGE_ALIGN(size + offset);
1924 dma_addr = __alloc_iova(mapping, len);
1925 if (dma_addr == DMA_MAPPING_ERROR)
1928 prot = __dma_info_to_prot(dir, attrs) | IOMMU_MMIO;
1930 ret = iommu_map(mapping->domain, dma_addr, addr, len, prot);
1934 return dma_addr + offset;
1936 __free_iova(mapping, dma_addr, len);
1937 return DMA_MAPPING_ERROR;
1941 * arm_iommu_unmap_resource - unmap a device DMA resource
1942 * @dev: valid struct device pointer
1943 * @dma_handle: DMA address to resource
1944 * @size: size of resource to map
1945 * @dir: DMA transfer direction
1947 static void arm_iommu_unmap_resource(struct device *dev, dma_addr_t dma_handle,
1948 size_t size, enum dma_data_direction dir,
1949 unsigned long attrs)
1951 struct dma_iommu_mapping *mapping = to_dma_iommu_mapping(dev);
1952 dma_addr_t iova = dma_handle & PAGE_MASK;
1953 unsigned int offset = dma_handle & ~PAGE_MASK;
1954 size_t len = PAGE_ALIGN(size + offset);
1959 iommu_unmap(mapping->domain, iova, len);
1960 __free_iova(mapping, iova, len);
1963 static void arm_iommu_sync_single_for_cpu(struct device *dev,
1964 dma_addr_t handle, size_t size, enum dma_data_direction dir)
1966 struct dma_iommu_mapping *mapping = to_dma_iommu_mapping(dev);
1967 dma_addr_t iova = handle & PAGE_MASK;
1968 struct page *page = phys_to_page(iommu_iova_to_phys(mapping->domain, iova));
1969 unsigned int offset = handle & ~PAGE_MASK;
1974 __dma_page_dev_to_cpu(page, offset, size, dir);
1977 static void arm_iommu_sync_single_for_device(struct device *dev,
1978 dma_addr_t handle, size_t size, enum dma_data_direction dir)
1980 struct dma_iommu_mapping *mapping = to_dma_iommu_mapping(dev);
1981 dma_addr_t iova = handle & PAGE_MASK;
1982 struct page *page = phys_to_page(iommu_iova_to_phys(mapping->domain, iova));
1983 unsigned int offset = handle & ~PAGE_MASK;
1988 __dma_page_cpu_to_dev(page, offset, size, dir);
1991 static const struct dma_map_ops iommu_ops = {
1992 .alloc = arm_iommu_alloc_attrs,
1993 .free = arm_iommu_free_attrs,
1994 .mmap = arm_iommu_mmap_attrs,
1995 .get_sgtable = arm_iommu_get_sgtable,
1997 .map_page = arm_iommu_map_page,
1998 .unmap_page = arm_iommu_unmap_page,
1999 .sync_single_for_cpu = arm_iommu_sync_single_for_cpu,
2000 .sync_single_for_device = arm_iommu_sync_single_for_device,
2002 .map_sg = arm_iommu_map_sg,
2003 .unmap_sg = arm_iommu_unmap_sg,
2004 .sync_sg_for_cpu = arm_iommu_sync_sg_for_cpu,
2005 .sync_sg_for_device = arm_iommu_sync_sg_for_device,
2007 .map_resource = arm_iommu_map_resource,
2008 .unmap_resource = arm_iommu_unmap_resource,
2010 .dma_supported = arm_dma_supported,
2013 static const struct dma_map_ops iommu_coherent_ops = {
2014 .alloc = arm_coherent_iommu_alloc_attrs,
2015 .free = arm_coherent_iommu_free_attrs,
2016 .mmap = arm_coherent_iommu_mmap_attrs,
2017 .get_sgtable = arm_iommu_get_sgtable,
2019 .map_page = arm_coherent_iommu_map_page,
2020 .unmap_page = arm_coherent_iommu_unmap_page,
2022 .map_sg = arm_coherent_iommu_map_sg,
2023 .unmap_sg = arm_coherent_iommu_unmap_sg,
2025 .map_resource = arm_iommu_map_resource,
2026 .unmap_resource = arm_iommu_unmap_resource,
2028 .dma_supported = arm_dma_supported,
2032 * arm_iommu_create_mapping
2033 * @bus: pointer to the bus holding the client device (for IOMMU calls)
2034 * @base: start address of the valid IO address space
2035 * @size: maximum size of the valid IO address space
2037 * Creates a mapping structure which holds information about used/unused
2038 * IO address ranges, which is required to perform memory allocation and
2039 * mapping with IOMMU aware functions.
2041 * The client device need to be attached to the mapping with
2042 * arm_iommu_attach_device function.
2044 struct dma_iommu_mapping *
2045 arm_iommu_create_mapping(struct bus_type *bus, dma_addr_t base, u64 size)
2047 unsigned int bits = size >> PAGE_SHIFT;
2048 unsigned int bitmap_size = BITS_TO_LONGS(bits) * sizeof(long);
2049 struct dma_iommu_mapping *mapping;
2053 /* currently only 32-bit DMA address space is supported */
2054 if (size > DMA_BIT_MASK(32) + 1)
2055 return ERR_PTR(-ERANGE);
2058 return ERR_PTR(-EINVAL);
2060 if (bitmap_size > PAGE_SIZE) {
2061 extensions = bitmap_size / PAGE_SIZE;
2062 bitmap_size = PAGE_SIZE;
2065 mapping = kzalloc(sizeof(struct dma_iommu_mapping), GFP_KERNEL);
2069 mapping->bitmap_size = bitmap_size;
2070 mapping->bitmaps = kcalloc(extensions, sizeof(unsigned long *),
2072 if (!mapping->bitmaps)
2075 mapping->bitmaps[0] = kzalloc(bitmap_size, GFP_KERNEL);
2076 if (!mapping->bitmaps[0])
2079 mapping->nr_bitmaps = 1;
2080 mapping->extensions = extensions;
2081 mapping->base = base;
2082 mapping->bits = BITS_PER_BYTE * bitmap_size;
2084 spin_lock_init(&mapping->lock);
2086 mapping->domain = iommu_domain_alloc(bus);
2087 if (!mapping->domain)
2090 kref_init(&mapping->kref);
2093 kfree(mapping->bitmaps[0]);
2095 kfree(mapping->bitmaps);
2099 return ERR_PTR(err);
2101 EXPORT_SYMBOL_GPL(arm_iommu_create_mapping);
2103 static void release_iommu_mapping(struct kref *kref)
2106 struct dma_iommu_mapping *mapping =
2107 container_of(kref, struct dma_iommu_mapping, kref);
2109 iommu_domain_free(mapping->domain);
2110 for (i = 0; i < mapping->nr_bitmaps; i++)
2111 kfree(mapping->bitmaps[i]);
2112 kfree(mapping->bitmaps);
2116 static int extend_iommu_mapping(struct dma_iommu_mapping *mapping)
2120 if (mapping->nr_bitmaps >= mapping->extensions)
2123 next_bitmap = mapping->nr_bitmaps;
2124 mapping->bitmaps[next_bitmap] = kzalloc(mapping->bitmap_size,
2126 if (!mapping->bitmaps[next_bitmap])
2129 mapping->nr_bitmaps++;
2134 void arm_iommu_release_mapping(struct dma_iommu_mapping *mapping)
2137 kref_put(&mapping->kref, release_iommu_mapping);
2139 EXPORT_SYMBOL_GPL(arm_iommu_release_mapping);
2141 static int __arm_iommu_attach_device(struct device *dev,
2142 struct dma_iommu_mapping *mapping)
2146 err = iommu_attach_device(mapping->domain, dev);
2150 kref_get(&mapping->kref);
2151 to_dma_iommu_mapping(dev) = mapping;
2153 pr_debug("Attached IOMMU controller to %s device.\n", dev_name(dev));
2158 * arm_iommu_attach_device
2159 * @dev: valid struct device pointer
2160 * @mapping: io address space mapping structure (returned from
2161 * arm_iommu_create_mapping)
2163 * Attaches specified io address space mapping to the provided device.
2164 * This replaces the dma operations (dma_map_ops pointer) with the
2165 * IOMMU aware version.
2167 * More than one client might be attached to the same io address space
2170 int arm_iommu_attach_device(struct device *dev,
2171 struct dma_iommu_mapping *mapping)
2175 err = __arm_iommu_attach_device(dev, mapping);
2179 set_dma_ops(dev, &iommu_ops);
2182 EXPORT_SYMBOL_GPL(arm_iommu_attach_device);
2185 * arm_iommu_detach_device
2186 * @dev: valid struct device pointer
2188 * Detaches the provided device from a previously attached map.
2189 * This overwrites the dma_ops pointer with appropriate non-IOMMU ops.
2191 void arm_iommu_detach_device(struct device *dev)
2193 struct dma_iommu_mapping *mapping;
2195 mapping = to_dma_iommu_mapping(dev);
2197 dev_warn(dev, "Not attached\n");
2201 iommu_detach_device(mapping->domain, dev);
2202 kref_put(&mapping->kref, release_iommu_mapping);
2203 to_dma_iommu_mapping(dev) = NULL;
2204 set_dma_ops(dev, arm_get_dma_map_ops(dev->archdata.dma_coherent));
2206 pr_debug("Detached IOMMU controller from %s device.\n", dev_name(dev));
2208 EXPORT_SYMBOL_GPL(arm_iommu_detach_device);
2210 static const struct dma_map_ops *arm_get_iommu_dma_map_ops(bool coherent)
2212 return coherent ? &iommu_coherent_ops : &iommu_ops;
2215 static bool arm_setup_iommu_dma_ops(struct device *dev, u64 dma_base, u64 size,
2216 const struct iommu_ops *iommu)
2218 struct dma_iommu_mapping *mapping;
2223 mapping = arm_iommu_create_mapping(dev->bus, dma_base, size);
2224 if (IS_ERR(mapping)) {
2225 pr_warn("Failed to create %llu-byte IOMMU mapping for device %s\n",
2226 size, dev_name(dev));
2230 if (__arm_iommu_attach_device(dev, mapping)) {
2231 pr_warn("Failed to attached device %s to IOMMU_mapping\n",
2233 arm_iommu_release_mapping(mapping);
2240 static void arm_teardown_iommu_dma_ops(struct device *dev)
2242 struct dma_iommu_mapping *mapping = to_dma_iommu_mapping(dev);
2247 arm_iommu_detach_device(dev);
2248 arm_iommu_release_mapping(mapping);
2253 static bool arm_setup_iommu_dma_ops(struct device *dev, u64 dma_base, u64 size,
2254 const struct iommu_ops *iommu)
2259 static void arm_teardown_iommu_dma_ops(struct device *dev) { }
2261 #define arm_get_iommu_dma_map_ops arm_get_dma_map_ops
2263 #endif /* CONFIG_ARM_DMA_USE_IOMMU */
2265 void arch_setup_dma_ops(struct device *dev, u64 dma_base, u64 size,
2266 const struct iommu_ops *iommu, bool coherent)
2268 const struct dma_map_ops *dma_ops;
2270 dev->archdata.dma_coherent = coherent;
2271 #ifdef CONFIG_SWIOTLB
2272 dev->dma_coherent = coherent;
2276 * Don't override the dma_ops if they have already been set. Ideally
2277 * this should be the only location where dma_ops are set, remove this
2278 * check when all other callers of set_dma_ops will have disappeared.
2283 if (arm_setup_iommu_dma_ops(dev, dma_base, size, iommu))
2284 dma_ops = arm_get_iommu_dma_map_ops(coherent);
2286 dma_ops = arm_get_dma_map_ops(coherent);
2288 set_dma_ops(dev, dma_ops);
2290 xen_setup_dma_ops(dev);
2291 dev->archdata.dma_ops_setup = true;
2294 void arch_teardown_dma_ops(struct device *dev)
2296 if (!dev->archdata.dma_ops_setup)
2299 arm_teardown_iommu_dma_ops(dev);
2300 /* Let arch_setup_dma_ops() start again from scratch upon re-probe */
2301 set_dma_ops(dev, NULL);
2304 #ifdef CONFIG_SWIOTLB
2305 void arch_sync_dma_for_device(phys_addr_t paddr, size_t size,
2306 enum dma_data_direction dir)
2308 __dma_page_cpu_to_dev(phys_to_page(paddr), paddr & (PAGE_SIZE - 1),
2312 void arch_sync_dma_for_cpu(phys_addr_t paddr, size_t size,
2313 enum dma_data_direction dir)
2315 __dma_page_dev_to_cpu(phys_to_page(paddr), paddr & (PAGE_SIZE - 1),
2319 void *arch_dma_alloc(struct device *dev, size_t size, dma_addr_t *dma_handle,
2320 gfp_t gfp, unsigned long attrs)
2322 return __dma_alloc(dev, size, dma_handle, gfp,
2323 __get_dma_pgprot(attrs, PAGE_KERNEL), false,
2324 attrs, __builtin_return_address(0));
2327 void arch_dma_free(struct device *dev, size_t size, void *cpu_addr,
2328 dma_addr_t dma_handle, unsigned long attrs)
2330 __arm_dma_free(dev, size, cpu_addr, dma_handle, attrs, false);
2332 #endif /* CONFIG_SWIOTLB */