1 // SPDX-License-Identifier: GPL-2.0
3 * arch-independent dma-mapping routines
5 * Copyright (c) 2006 SUSE Linux Products GmbH
6 * Copyright (c) 2006 Tejun Heo <teheo@suse.de>
9 #include <linux/acpi.h>
10 #include <linux/dma-noncoherent.h>
11 #include <linux/export.h>
12 #include <linux/gfp.h>
13 #include <linux/of_device.h>
14 #include <linux/slab.h>
15 #include <linux/vmalloc.h>
23 dma_addr_t dma_handle;
27 static void dmam_release(struct device *dev, void *res)
29 struct dma_devres *this = res;
31 dma_free_attrs(dev, this->size, this->vaddr, this->dma_handle,
35 static int dmam_match(struct device *dev, void *res, void *match_data)
37 struct dma_devres *this = res, *match = match_data;
39 if (this->vaddr == match->vaddr) {
40 WARN_ON(this->size != match->size ||
41 this->dma_handle != match->dma_handle);
48 * dmam_alloc_coherent - Managed dma_alloc_coherent()
49 * @dev: Device to allocate coherent memory for
50 * @size: Size of allocation
51 * @dma_handle: Out argument for allocated DMA handle
52 * @gfp: Allocation flags
54 * Managed dma_alloc_coherent(). Memory allocated using this function
55 * will be automatically released on driver detach.
58 * Pointer to allocated memory on success, NULL on failure.
60 void *dmam_alloc_coherent(struct device *dev, size_t size,
61 dma_addr_t *dma_handle, gfp_t gfp)
63 struct dma_devres *dr;
66 dr = devres_alloc(dmam_release, sizeof(*dr), gfp);
70 vaddr = dma_alloc_coherent(dev, size, dma_handle, gfp);
77 dr->dma_handle = *dma_handle;
84 EXPORT_SYMBOL(dmam_alloc_coherent);
87 * dmam_free_coherent - Managed dma_free_coherent()
88 * @dev: Device to free coherent memory for
89 * @size: Size of allocation
90 * @vaddr: Virtual address of the memory to free
91 * @dma_handle: DMA handle of the memory to free
93 * Managed dma_free_coherent().
95 void dmam_free_coherent(struct device *dev, size_t size, void *vaddr,
96 dma_addr_t dma_handle)
98 struct dma_devres match_data = { size, vaddr, dma_handle };
100 dma_free_coherent(dev, size, vaddr, dma_handle);
101 WARN_ON(devres_destroy(dev, dmam_release, dmam_match, &match_data));
103 EXPORT_SYMBOL(dmam_free_coherent);
106 * dmam_alloc_attrs - Managed dma_alloc_attrs()
107 * @dev: Device to allocate non_coherent memory for
108 * @size: Size of allocation
109 * @dma_handle: Out argument for allocated DMA handle
110 * @gfp: Allocation flags
111 * @attrs: Flags in the DMA_ATTR_* namespace.
113 * Managed dma_alloc_attrs(). Memory allocated using this function will be
114 * automatically released on driver detach.
117 * Pointer to allocated memory on success, NULL on failure.
119 void *dmam_alloc_attrs(struct device *dev, size_t size, dma_addr_t *dma_handle,
120 gfp_t gfp, unsigned long attrs)
122 struct dma_devres *dr;
125 dr = devres_alloc(dmam_release, sizeof(*dr), gfp);
129 vaddr = dma_alloc_attrs(dev, size, dma_handle, gfp, attrs);
136 dr->dma_handle = *dma_handle;
144 EXPORT_SYMBOL(dmam_alloc_attrs);
146 #ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
148 static void dmam_coherent_decl_release(struct device *dev, void *res)
150 dma_release_declared_memory(dev);
154 * dmam_declare_coherent_memory - Managed dma_declare_coherent_memory()
155 * @dev: Device to declare coherent memory for
156 * @phys_addr: Physical address of coherent memory to be declared
157 * @device_addr: Device address of coherent memory to be declared
158 * @size: Size of coherent memory to be declared
161 * Managed dma_declare_coherent_memory().
164 * 0 on success, -errno on failure.
166 int dmam_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr,
167 dma_addr_t device_addr, size_t size, int flags)
172 res = devres_alloc(dmam_coherent_decl_release, 0, GFP_KERNEL);
176 rc = dma_declare_coherent_memory(dev, phys_addr, device_addr, size,
179 devres_add(dev, res);
185 EXPORT_SYMBOL(dmam_declare_coherent_memory);
188 * dmam_release_declared_memory - Managed dma_release_declared_memory().
189 * @dev: Device to release declared coherent memory for
191 * Managed dmam_release_declared_memory().
193 void dmam_release_declared_memory(struct device *dev)
195 WARN_ON(devres_destroy(dev, dmam_coherent_decl_release, NULL, NULL));
197 EXPORT_SYMBOL(dmam_release_declared_memory);
202 * Create scatter-list for the already allocated DMA buffer.
204 int dma_common_get_sgtable(struct device *dev, struct sg_table *sgt,
205 void *cpu_addr, dma_addr_t dma_addr, size_t size,
211 if (!dev_is_dma_coherent(dev)) {
212 if (!IS_ENABLED(CONFIG_ARCH_HAS_DMA_COHERENT_TO_PFN))
215 page = pfn_to_page(arch_dma_coherent_to_pfn(dev, cpu_addr,
218 page = virt_to_page(cpu_addr);
221 ret = sg_alloc_table(sgt, 1, GFP_KERNEL);
223 sg_set_page(sgt->sgl, page, PAGE_ALIGN(size), 0);
226 EXPORT_SYMBOL(dma_common_get_sgtable);
229 * Create userspace mapping for the DMA-coherent memory.
231 int dma_common_mmap(struct device *dev, struct vm_area_struct *vma,
232 void *cpu_addr, dma_addr_t dma_addr, size_t size,
235 #ifndef CONFIG_ARCH_NO_COHERENT_DMA_MMAP
236 unsigned long user_count = vma_pages(vma);
237 unsigned long count = PAGE_ALIGN(size) >> PAGE_SHIFT;
238 unsigned long off = vma->vm_pgoff;
242 vma->vm_page_prot = arch_dma_mmap_pgprot(dev, vma->vm_page_prot, attrs);
244 if (dma_mmap_from_dev_coherent(dev, vma, cpu_addr, size, &ret))
247 if (off >= count || user_count > count - off)
250 if (!dev_is_dma_coherent(dev)) {
251 if (!IS_ENABLED(CONFIG_ARCH_HAS_DMA_COHERENT_TO_PFN))
253 pfn = arch_dma_coherent_to_pfn(dev, cpu_addr, dma_addr);
255 pfn = page_to_pfn(virt_to_page(cpu_addr));
258 return remap_pfn_range(vma, vma->vm_start, pfn + vma->vm_pgoff,
259 user_count << PAGE_SHIFT, vma->vm_page_prot);
262 #endif /* !CONFIG_ARCH_NO_COHERENT_DMA_MMAP */
264 EXPORT_SYMBOL(dma_common_mmap);
267 static struct vm_struct *__dma_common_pages_remap(struct page **pages,
268 size_t size, unsigned long vm_flags, pgprot_t prot,
271 struct vm_struct *area;
273 area = get_vm_area_caller(size, vm_flags, caller);
277 if (map_vm_area(area, prot, pages)) {
286 * remaps an array of PAGE_SIZE pages into another vm_area
287 * Cannot be used in non-sleeping contexts
289 void *dma_common_pages_remap(struct page **pages, size_t size,
290 unsigned long vm_flags, pgprot_t prot,
293 struct vm_struct *area;
295 area = __dma_common_pages_remap(pages, size, vm_flags, prot, caller);
305 * remaps an allocated contiguous region into another vm_area.
306 * Cannot be used in non-sleeping contexts
309 void *dma_common_contiguous_remap(struct page *page, size_t size,
310 unsigned long vm_flags,
311 pgprot_t prot, const void *caller)
315 struct vm_struct *area;
317 pages = kmalloc(sizeof(struct page *) << get_order(size), GFP_KERNEL);
321 for (i = 0; i < (size >> PAGE_SHIFT); i++)
322 pages[i] = nth_page(page, i);
324 area = __dma_common_pages_remap(pages, size, vm_flags, prot, caller);
334 * unmaps a range previously mapped by dma_common_*_remap
336 void dma_common_free_remap(void *cpu_addr, size_t size, unsigned long vm_flags)
338 struct vm_struct *area = find_vm_area(cpu_addr);
340 if (!area || (area->flags & vm_flags) != vm_flags) {
341 WARN(1, "trying to free invalid coherent area: %p\n", cpu_addr);
345 unmap_kernel_range((unsigned long)cpu_addr, PAGE_ALIGN(size));