1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_DMA_MAPPING_H
3 #define _LINUX_DMA_MAPPING_H
5 #include <linux/cache.h>
6 #include <linux/sizes.h>
7 #include <linux/string.h>
8 #include <linux/device.h>
10 #include <linux/dma-direction.h>
11 #include <linux/scatterlist.h>
12 #include <linux/bug.h>
13 #include <linux/mem_encrypt.h>
16 * List of possible attributes associated with a DMA mapping. The semantics
17 * of each attribute should be defined in Documentation/core-api/dma-attributes.rst.
21 * DMA_ATTR_WEAK_ORDERING: Specifies that reads and writes to the mapping
22 * may be weakly ordered, that is that reads and writes may pass each other.
24 #define DMA_ATTR_WEAK_ORDERING (1UL << 1)
26 * DMA_ATTR_WRITE_COMBINE: Specifies that writes to the mapping may be
27 * buffered to improve performance.
29 #define DMA_ATTR_WRITE_COMBINE (1UL << 2)
31 * DMA_ATTR_NO_KERNEL_MAPPING: Lets the platform to avoid creating a kernel
32 * virtual mapping for the allocated buffer.
34 #define DMA_ATTR_NO_KERNEL_MAPPING (1UL << 4)
36 * DMA_ATTR_SKIP_CPU_SYNC: Allows platform code to skip synchronization of
37 * the CPU cache for the given buffer assuming that it has been already
38 * transferred to 'device' domain.
40 #define DMA_ATTR_SKIP_CPU_SYNC (1UL << 5)
42 * DMA_ATTR_FORCE_CONTIGUOUS: Forces contiguous allocation of the buffer
45 #define DMA_ATTR_FORCE_CONTIGUOUS (1UL << 6)
47 * DMA_ATTR_ALLOC_SINGLE_PAGES: This is a hint to the DMA-mapping subsystem
48 * that it's probably not worth the time to try to allocate memory to in a way
49 * that gives better TLB efficiency.
51 #define DMA_ATTR_ALLOC_SINGLE_PAGES (1UL << 7)
53 * DMA_ATTR_NO_WARN: This tells the DMA-mapping subsystem to suppress
54 * allocation failure reports (similarly to __GFP_NOWARN).
56 #define DMA_ATTR_NO_WARN (1UL << 8)
59 * DMA_ATTR_PRIVILEGED: used to indicate that the buffer is fully
60 * accessible at an elevated privilege level (and ideally inaccessible or
61 * at least read-only at lesser-privileged levels).
63 #define DMA_ATTR_PRIVILEGED (1UL << 9)
66 * A dma_addr_t can hold any valid DMA or bus address for the platform. It can
67 * be given to a device to use as a DMA source or target. It is specific to a
68 * given device and there may be a translation between the CPU physical address
69 * space and the bus address space.
71 * DMA_MAPPING_ERROR is the magic error code if a mapping failed. It should not
72 * be used directly in drivers, but checked for using dma_mapping_error()
75 #define DMA_MAPPING_ERROR (~(dma_addr_t)0)
77 #define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : ((1ULL<<(n))-1))
79 #ifdef CONFIG_DMA_API_DEBUG
80 void debug_dma_mapping_error(struct device *dev, dma_addr_t dma_addr);
81 void debug_dma_map_single(struct device *dev, const void *addr,
84 static inline void debug_dma_mapping_error(struct device *dev,
88 static inline void debug_dma_map_single(struct device *dev, const void *addr,
92 #endif /* CONFIG_DMA_API_DEBUG */
95 static inline int dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
97 debug_dma_mapping_error(dev, dma_addr);
99 if (unlikely(dma_addr == DMA_MAPPING_ERROR))
104 dma_addr_t dma_map_page_attrs(struct device *dev, struct page *page,
105 size_t offset, size_t size, enum dma_data_direction dir,
106 unsigned long attrs);
107 void dma_unmap_page_attrs(struct device *dev, dma_addr_t addr, size_t size,
108 enum dma_data_direction dir, unsigned long attrs);
109 unsigned int dma_map_sg_attrs(struct device *dev, struct scatterlist *sg,
110 int nents, enum dma_data_direction dir, unsigned long attrs);
111 void dma_unmap_sg_attrs(struct device *dev, struct scatterlist *sg,
112 int nents, enum dma_data_direction dir,
113 unsigned long attrs);
114 int dma_map_sgtable(struct device *dev, struct sg_table *sgt,
115 enum dma_data_direction dir, unsigned long attrs);
116 dma_addr_t dma_map_resource(struct device *dev, phys_addr_t phys_addr,
117 size_t size, enum dma_data_direction dir, unsigned long attrs);
118 void dma_unmap_resource(struct device *dev, dma_addr_t addr, size_t size,
119 enum dma_data_direction dir, unsigned long attrs);
120 void dma_sync_single_for_cpu(struct device *dev, dma_addr_t addr, size_t size,
121 enum dma_data_direction dir);
122 void dma_sync_single_for_device(struct device *dev, dma_addr_t addr,
123 size_t size, enum dma_data_direction dir);
124 void dma_sync_sg_for_cpu(struct device *dev, struct scatterlist *sg,
125 int nelems, enum dma_data_direction dir);
126 void dma_sync_sg_for_device(struct device *dev, struct scatterlist *sg,
127 int nelems, enum dma_data_direction dir);
128 void *dma_alloc_attrs(struct device *dev, size_t size, dma_addr_t *dma_handle,
129 gfp_t flag, unsigned long attrs);
130 void dma_free_attrs(struct device *dev, size_t size, void *cpu_addr,
131 dma_addr_t dma_handle, unsigned long attrs);
132 void *dmam_alloc_attrs(struct device *dev, size_t size, dma_addr_t *dma_handle,
133 gfp_t gfp, unsigned long attrs);
134 void dmam_free_coherent(struct device *dev, size_t size, void *vaddr,
135 dma_addr_t dma_handle);
136 int dma_get_sgtable_attrs(struct device *dev, struct sg_table *sgt,
137 void *cpu_addr, dma_addr_t dma_addr, size_t size,
138 unsigned long attrs);
139 int dma_mmap_attrs(struct device *dev, struct vm_area_struct *vma,
140 void *cpu_addr, dma_addr_t dma_addr, size_t size,
141 unsigned long attrs);
142 bool dma_can_mmap(struct device *dev);
143 bool dma_pci_p2pdma_supported(struct device *dev);
144 int dma_set_mask(struct device *dev, u64 mask);
145 int dma_set_coherent_mask(struct device *dev, u64 mask);
146 u64 dma_get_required_mask(struct device *dev);
147 size_t dma_max_mapping_size(struct device *dev);
148 size_t dma_opt_mapping_size(struct device *dev);
149 bool dma_need_sync(struct device *dev, dma_addr_t dma_addr);
150 unsigned long dma_get_merge_boundary(struct device *dev);
151 struct sg_table *dma_alloc_noncontiguous(struct device *dev, size_t size,
152 enum dma_data_direction dir, gfp_t gfp, unsigned long attrs);
153 void dma_free_noncontiguous(struct device *dev, size_t size,
154 struct sg_table *sgt, enum dma_data_direction dir);
155 void *dma_vmap_noncontiguous(struct device *dev, size_t size,
156 struct sg_table *sgt);
157 void dma_vunmap_noncontiguous(struct device *dev, void *vaddr);
158 int dma_mmap_noncontiguous(struct device *dev, struct vm_area_struct *vma,
159 size_t size, struct sg_table *sgt);
160 #else /* CONFIG_HAS_DMA */
161 static inline dma_addr_t dma_map_page_attrs(struct device *dev,
162 struct page *page, size_t offset, size_t size,
163 enum dma_data_direction dir, unsigned long attrs)
165 return DMA_MAPPING_ERROR;
167 static inline void dma_unmap_page_attrs(struct device *dev, dma_addr_t addr,
168 size_t size, enum dma_data_direction dir, unsigned long attrs)
171 static inline unsigned int dma_map_sg_attrs(struct device *dev,
172 struct scatterlist *sg, int nents, enum dma_data_direction dir,
177 static inline void dma_unmap_sg_attrs(struct device *dev,
178 struct scatterlist *sg, int nents, enum dma_data_direction dir,
182 static inline int dma_map_sgtable(struct device *dev, struct sg_table *sgt,
183 enum dma_data_direction dir, unsigned long attrs)
187 static inline dma_addr_t dma_map_resource(struct device *dev,
188 phys_addr_t phys_addr, size_t size, enum dma_data_direction dir,
191 return DMA_MAPPING_ERROR;
193 static inline void dma_unmap_resource(struct device *dev, dma_addr_t addr,
194 size_t size, enum dma_data_direction dir, unsigned long attrs)
197 static inline void dma_sync_single_for_cpu(struct device *dev, dma_addr_t addr,
198 size_t size, enum dma_data_direction dir)
201 static inline void dma_sync_single_for_device(struct device *dev,
202 dma_addr_t addr, size_t size, enum dma_data_direction dir)
205 static inline void dma_sync_sg_for_cpu(struct device *dev,
206 struct scatterlist *sg, int nelems, enum dma_data_direction dir)
209 static inline void dma_sync_sg_for_device(struct device *dev,
210 struct scatterlist *sg, int nelems, enum dma_data_direction dir)
213 static inline int dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
217 static inline void *dma_alloc_attrs(struct device *dev, size_t size,
218 dma_addr_t *dma_handle, gfp_t flag, unsigned long attrs)
222 static void dma_free_attrs(struct device *dev, size_t size, void *cpu_addr,
223 dma_addr_t dma_handle, unsigned long attrs)
226 static inline void *dmam_alloc_attrs(struct device *dev, size_t size,
227 dma_addr_t *dma_handle, gfp_t gfp, unsigned long attrs)
231 static inline void dmam_free_coherent(struct device *dev, size_t size,
232 void *vaddr, dma_addr_t dma_handle)
235 static inline int dma_get_sgtable_attrs(struct device *dev,
236 struct sg_table *sgt, void *cpu_addr, dma_addr_t dma_addr,
237 size_t size, unsigned long attrs)
241 static inline int dma_mmap_attrs(struct device *dev, struct vm_area_struct *vma,
242 void *cpu_addr, dma_addr_t dma_addr, size_t size,
247 static inline bool dma_can_mmap(struct device *dev)
251 static inline bool dma_pci_p2pdma_supported(struct device *dev)
255 static inline int dma_set_mask(struct device *dev, u64 mask)
259 static inline int dma_set_coherent_mask(struct device *dev, u64 mask)
263 static inline u64 dma_get_required_mask(struct device *dev)
267 static inline size_t dma_max_mapping_size(struct device *dev)
271 static inline size_t dma_opt_mapping_size(struct device *dev)
275 static inline bool dma_need_sync(struct device *dev, dma_addr_t dma_addr)
279 static inline unsigned long dma_get_merge_boundary(struct device *dev)
283 static inline struct sg_table *dma_alloc_noncontiguous(struct device *dev,
284 size_t size, enum dma_data_direction dir, gfp_t gfp,
289 static inline void dma_free_noncontiguous(struct device *dev, size_t size,
290 struct sg_table *sgt, enum dma_data_direction dir)
293 static inline void *dma_vmap_noncontiguous(struct device *dev, size_t size,
294 struct sg_table *sgt)
298 static inline void dma_vunmap_noncontiguous(struct device *dev, void *vaddr)
301 static inline int dma_mmap_noncontiguous(struct device *dev,
302 struct vm_area_struct *vma, size_t size, struct sg_table *sgt)
306 #endif /* CONFIG_HAS_DMA */
308 struct page *dma_alloc_pages(struct device *dev, size_t size,
309 dma_addr_t *dma_handle, enum dma_data_direction dir, gfp_t gfp);
310 void dma_free_pages(struct device *dev, size_t size, struct page *page,
311 dma_addr_t dma_handle, enum dma_data_direction dir);
312 int dma_mmap_pages(struct device *dev, struct vm_area_struct *vma,
313 size_t size, struct page *page);
315 static inline void *dma_alloc_noncoherent(struct device *dev, size_t size,
316 dma_addr_t *dma_handle, enum dma_data_direction dir, gfp_t gfp)
318 struct page *page = dma_alloc_pages(dev, size, dma_handle, dir, gfp);
319 return page ? page_address(page) : NULL;
322 static inline void dma_free_noncoherent(struct device *dev, size_t size,
323 void *vaddr, dma_addr_t dma_handle, enum dma_data_direction dir)
325 dma_free_pages(dev, size, virt_to_page(vaddr), dma_handle, dir);
328 static inline dma_addr_t dma_map_single_attrs(struct device *dev, void *ptr,
329 size_t size, enum dma_data_direction dir, unsigned long attrs)
331 /* DMA must never operate on areas that might be remapped. */
332 if (dev_WARN_ONCE(dev, is_vmalloc_addr(ptr),
333 "rejecting DMA map of vmalloc memory\n"))
334 return DMA_MAPPING_ERROR;
335 debug_dma_map_single(dev, ptr, size);
336 return dma_map_page_attrs(dev, virt_to_page(ptr), offset_in_page(ptr),
340 static inline void dma_unmap_single_attrs(struct device *dev, dma_addr_t addr,
341 size_t size, enum dma_data_direction dir, unsigned long attrs)
343 return dma_unmap_page_attrs(dev, addr, size, dir, attrs);
346 static inline void dma_sync_single_range_for_cpu(struct device *dev,
347 dma_addr_t addr, unsigned long offset, size_t size,
348 enum dma_data_direction dir)
350 return dma_sync_single_for_cpu(dev, addr + offset, size, dir);
353 static inline void dma_sync_single_range_for_device(struct device *dev,
354 dma_addr_t addr, unsigned long offset, size_t size,
355 enum dma_data_direction dir)
357 return dma_sync_single_for_device(dev, addr + offset, size, dir);
361 * dma_unmap_sgtable - Unmap the given buffer for DMA
362 * @dev: The device for which to perform the DMA operation
363 * @sgt: The sg_table object describing the buffer
364 * @dir: DMA direction
365 * @attrs: Optional DMA attributes for the unmap operation
367 * Unmaps a buffer described by a scatterlist stored in the given sg_table
368 * object for the @dir DMA operation by the @dev device. After this function
369 * the ownership of the buffer is transferred back to the CPU domain.
371 static inline void dma_unmap_sgtable(struct device *dev, struct sg_table *sgt,
372 enum dma_data_direction dir, unsigned long attrs)
374 dma_unmap_sg_attrs(dev, sgt->sgl, sgt->orig_nents, dir, attrs);
378 * dma_sync_sgtable_for_cpu - Synchronize the given buffer for CPU access
379 * @dev: The device for which to perform the DMA operation
380 * @sgt: The sg_table object describing the buffer
381 * @dir: DMA direction
383 * Performs the needed cache synchronization and moves the ownership of the
384 * buffer back to the CPU domain, so it is safe to perform any access to it
385 * by the CPU. Before doing any further DMA operations, one has to transfer
386 * the ownership of the buffer back to the DMA domain by calling the
387 * dma_sync_sgtable_for_device().
389 static inline void dma_sync_sgtable_for_cpu(struct device *dev,
390 struct sg_table *sgt, enum dma_data_direction dir)
392 dma_sync_sg_for_cpu(dev, sgt->sgl, sgt->orig_nents, dir);
396 * dma_sync_sgtable_for_device - Synchronize the given buffer for DMA
397 * @dev: The device for which to perform the DMA operation
398 * @sgt: The sg_table object describing the buffer
399 * @dir: DMA direction
401 * Performs the needed cache synchronization and moves the ownership of the
402 * buffer back to the DMA domain, so it is safe to perform the DMA operation.
403 * Once finished, one has to call dma_sync_sgtable_for_cpu() or
404 * dma_unmap_sgtable().
406 static inline void dma_sync_sgtable_for_device(struct device *dev,
407 struct sg_table *sgt, enum dma_data_direction dir)
409 dma_sync_sg_for_device(dev, sgt->sgl, sgt->orig_nents, dir);
412 #define dma_map_single(d, a, s, r) dma_map_single_attrs(d, a, s, r, 0)
413 #define dma_unmap_single(d, a, s, r) dma_unmap_single_attrs(d, a, s, r, 0)
414 #define dma_map_sg(d, s, n, r) dma_map_sg_attrs(d, s, n, r, 0)
415 #define dma_unmap_sg(d, s, n, r) dma_unmap_sg_attrs(d, s, n, r, 0)
416 #define dma_map_page(d, p, o, s, r) dma_map_page_attrs(d, p, o, s, r, 0)
417 #define dma_unmap_page(d, a, s, r) dma_unmap_page_attrs(d, a, s, r, 0)
418 #define dma_get_sgtable(d, t, v, h, s) dma_get_sgtable_attrs(d, t, v, h, s, 0)
419 #define dma_mmap_coherent(d, v, c, h, s) dma_mmap_attrs(d, v, c, h, s, 0)
421 bool dma_coherent_ok(struct device *dev, phys_addr_t phys, size_t size);
423 static inline void *dma_alloc_coherent(struct device *dev, size_t size,
424 dma_addr_t *dma_handle, gfp_t gfp)
426 return dma_alloc_attrs(dev, size, dma_handle, gfp,
427 (gfp & __GFP_NOWARN) ? DMA_ATTR_NO_WARN : 0);
430 static inline void dma_free_coherent(struct device *dev, size_t size,
431 void *cpu_addr, dma_addr_t dma_handle)
433 return dma_free_attrs(dev, size, cpu_addr, dma_handle, 0);
437 static inline u64 dma_get_mask(struct device *dev)
439 if (dev->dma_mask && *dev->dma_mask)
440 return *dev->dma_mask;
441 return DMA_BIT_MASK(32);
445 * Set both the DMA mask and the coherent DMA mask to the same thing.
446 * Note that we don't check the return value from dma_set_coherent_mask()
447 * as the DMA API guarantees that the coherent DMA mask can be set to
448 * the same or smaller than the streaming DMA mask.
450 static inline int dma_set_mask_and_coherent(struct device *dev, u64 mask)
452 int rc = dma_set_mask(dev, mask);
454 dma_set_coherent_mask(dev, mask);
459 * Similar to the above, except it deals with the case where the device
460 * does not have dev->dma_mask appropriately setup.
462 static inline int dma_coerce_mask_and_coherent(struct device *dev, u64 mask)
464 dev->dma_mask = &dev->coherent_dma_mask;
465 return dma_set_mask_and_coherent(dev, mask);
469 * dma_addressing_limited - return if the device is addressing limited
470 * @dev: device to check
472 * Return %true if the devices DMA mask is too small to address all memory in
473 * the system, else %false. Lack of addressing bits is the prime reason for
474 * bounce buffering, but might not be the only one.
476 static inline bool dma_addressing_limited(struct device *dev)
478 return min_not_zero(dma_get_mask(dev), dev->bus_dma_limit) <
479 dma_get_required_mask(dev);
482 static inline unsigned int dma_get_max_seg_size(struct device *dev)
484 if (dev->dma_parms && dev->dma_parms->max_segment_size)
485 return dev->dma_parms->max_segment_size;
489 static inline int dma_set_max_seg_size(struct device *dev, unsigned int size)
491 if (dev->dma_parms) {
492 dev->dma_parms->max_segment_size = size;
498 static inline unsigned long dma_get_seg_boundary(struct device *dev)
500 if (dev->dma_parms && dev->dma_parms->segment_boundary_mask)
501 return dev->dma_parms->segment_boundary_mask;
506 * dma_get_seg_boundary_nr_pages - return the segment boundary in "page" units
507 * @dev: device to guery the boundary for
508 * @page_shift: ilog() of the IOMMU page size
510 * Return the segment boundary in IOMMU page units (which may be different from
511 * the CPU page size) for the passed in device.
513 * If @dev is NULL a boundary of U32_MAX is assumed, this case is just for
514 * non-DMA API callers.
516 static inline unsigned long dma_get_seg_boundary_nr_pages(struct device *dev,
517 unsigned int page_shift)
520 return (U32_MAX >> page_shift) + 1;
521 return (dma_get_seg_boundary(dev) >> page_shift) + 1;
524 static inline int dma_set_seg_boundary(struct device *dev, unsigned long mask)
526 if (dev->dma_parms) {
527 dev->dma_parms->segment_boundary_mask = mask;
533 static inline unsigned int dma_get_min_align_mask(struct device *dev)
536 return dev->dma_parms->min_align_mask;
540 static inline int dma_set_min_align_mask(struct device *dev,
541 unsigned int min_align_mask)
543 if (WARN_ON_ONCE(!dev->dma_parms))
545 dev->dma_parms->min_align_mask = min_align_mask;
549 #ifndef dma_get_cache_alignment
550 static inline int dma_get_cache_alignment(void)
552 #ifdef ARCH_HAS_DMA_MINALIGN
553 return ARCH_DMA_MINALIGN;
559 static inline void *dmam_alloc_coherent(struct device *dev, size_t size,
560 dma_addr_t *dma_handle, gfp_t gfp)
562 return dmam_alloc_attrs(dev, size, dma_handle, gfp,
563 (gfp & __GFP_NOWARN) ? DMA_ATTR_NO_WARN : 0);
566 static inline void *dma_alloc_wc(struct device *dev, size_t size,
567 dma_addr_t *dma_addr, gfp_t gfp)
569 unsigned long attrs = DMA_ATTR_WRITE_COMBINE;
571 if (gfp & __GFP_NOWARN)
572 attrs |= DMA_ATTR_NO_WARN;
574 return dma_alloc_attrs(dev, size, dma_addr, gfp, attrs);
577 static inline void dma_free_wc(struct device *dev, size_t size,
578 void *cpu_addr, dma_addr_t dma_addr)
580 return dma_free_attrs(dev, size, cpu_addr, dma_addr,
581 DMA_ATTR_WRITE_COMBINE);
584 static inline int dma_mmap_wc(struct device *dev,
585 struct vm_area_struct *vma,
586 void *cpu_addr, dma_addr_t dma_addr,
589 return dma_mmap_attrs(dev, vma, cpu_addr, dma_addr, size,
590 DMA_ATTR_WRITE_COMBINE);
593 #ifdef CONFIG_NEED_DMA_MAP_STATE
594 #define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME) dma_addr_t ADDR_NAME
595 #define DEFINE_DMA_UNMAP_LEN(LEN_NAME) __u32 LEN_NAME
596 #define dma_unmap_addr(PTR, ADDR_NAME) ((PTR)->ADDR_NAME)
597 #define dma_unmap_addr_set(PTR, ADDR_NAME, VAL) (((PTR)->ADDR_NAME) = (VAL))
598 #define dma_unmap_len(PTR, LEN_NAME) ((PTR)->LEN_NAME)
599 #define dma_unmap_len_set(PTR, LEN_NAME, VAL) (((PTR)->LEN_NAME) = (VAL))
601 #define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME)
602 #define DEFINE_DMA_UNMAP_LEN(LEN_NAME)
603 #define dma_unmap_addr(PTR, ADDR_NAME) (0)
604 #define dma_unmap_addr_set(PTR, ADDR_NAME, VAL) do { } while (0)
605 #define dma_unmap_len(PTR, LEN_NAME) (0)
606 #define dma_unmap_len_set(PTR, LEN_NAME, VAL) do { } while (0)
609 #endif /* _LINUX_DMA_MAPPING_H */