arch/arm/include/asm/dma-mapping.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef ASMARM_DMA_MAPPING_H
   3 #define ASMARM_DMA_MAPPING_H
   4
   5 #ifdef __KERNEL__
   6
   7 #include <linux/mm_types.h>
   8 #include <linux/scatterlist.h>
   9 #include <linux/dma-debug.h>
  10
  11 #include <asm/memory.h>
  12
  13 #include <xen/xen.h>
  14 #include <asm/xen/hypervisor.h>
  15
  16 extern const struct dma_map_ops arm_dma_ops;
  17 extern const struct dma_map_ops arm_coherent_dma_ops;
  18
  19 static inline const struct dma_map_ops *get_arch_dma_ops(struct bus_type *bus)
  20 {
  21         return IS_ENABLED(CONFIG_MMU) ? &arm_dma_ops : NULL;
  22 }
  23
  24 #ifdef __arch_page_to_dma
  25 #error Please update to __arch_pfn_to_dma
  26 #endif
  27
  28 /*
  29  * dma_to_pfn/pfn_to_dma/dma_to_virt/virt_to_dma are architecture private
  30  * functions used internally by the DMA-mapping API to provide DMA
  31  * addresses. They must not be used by drivers.
  32  */
  33 #ifndef __arch_pfn_to_dma
  34 static inline dma_addr_t pfn_to_dma(struct device *dev, unsigned long pfn)
  35 {
  36         if (dev)
  37                 pfn -= dev->dma_pfn_offset;
  38         return (dma_addr_t)__pfn_to_bus(pfn);
  39 }
  40
  41 static inline unsigned long dma_to_pfn(struct device *dev, dma_addr_t addr)
  42 {
  43         unsigned long pfn = __bus_to_pfn(addr);
  44
  45         if (dev)
  46                 pfn += dev->dma_pfn_offset;
  47
  48         return pfn;
  49 }
  50
  51 static inline void *dma_to_virt(struct device *dev, dma_addr_t addr)
  52 {
  53         if (dev) {
  54                 unsigned long pfn = dma_to_pfn(dev, addr);
  55
  56                 return phys_to_virt(__pfn_to_phys(pfn));
  57         }
  58
  59         return (void *)__bus_to_virt((unsigned long)addr);
  60 }
  61
  62 static inline dma_addr_t virt_to_dma(struct device *dev, void *addr)
  63 {
  64         if (dev)
  65                 return pfn_to_dma(dev, virt_to_pfn(addr));
  66
  67         return (dma_addr_t)__virt_to_bus((unsigned long)(addr));
  68 }
  69
  70 #else
  71 static inline dma_addr_t pfn_to_dma(struct device *dev, unsigned long pfn)
  72 {
  73         return __arch_pfn_to_dma(dev, pfn);
  74 }
  75
  76 static inline unsigned long dma_to_pfn(struct device *dev, dma_addr_t addr)
  77 {
  78         return __arch_dma_to_pfn(dev, addr);
  79 }
  80
  81 static inline void *dma_to_virt(struct device *dev, dma_addr_t addr)
  82 {
  83         return __arch_dma_to_virt(dev, addr);
  84 }
  85
  86 static inline dma_addr_t virt_to_dma(struct device *dev, void *addr)
  87 {
  88         return __arch_virt_to_dma(dev, addr);
  89 }
  90 #endif
  91
  92 /* The ARM override for dma_max_pfn() */
  93 static inline unsigned long dma_max_pfn(struct device *dev)
  94 {
  95         return dma_to_pfn(dev, *dev->dma_mask);
  96 }
  97 #define dma_max_pfn(dev) dma_max_pfn(dev)
  98
  99 /* do not use this function in a driver */
 100 static inline bool is_device_dma_coherent(struct device *dev)
 101 {
 102         return dev->archdata.dma_coherent;
 103 }
 104
 105 /**
 106  * arm_dma_alloc - allocate consistent memory for DMA
 107  * @dev: valid struct device pointer, or NULL for ISA and EISA-like devices
 108  * @size: required memory size
 109  * @handle: bus-specific DMA address
 110  * @attrs: optinal attributes that specific mapping properties
 111  *
 112  * Allocate some memory for a device for performing DMA.  This function
 113  * allocates pages, and will return the CPU-viewed address, and sets @handle
 114  * to be the device-viewed address.
 115  */
 116 extern void *arm_dma_alloc(struct device *dev, size_t size, dma_addr_t *handle,
 117                            gfp_t gfp, unsigned long attrs);
 118
 119 /**
 120  * arm_dma_free - free memory allocated by arm_dma_alloc
 121  * @dev: valid struct device pointer, or NULL for ISA and EISA-like devices
 122  * @size: size of memory originally requested in dma_alloc_coherent
 123  * @cpu_addr: CPU-view address returned from dma_alloc_coherent
 124  * @handle: device-view address returned from dma_alloc_coherent
 125  * @attrs: optinal attributes that specific mapping properties
 126  *
 127  * Free (and unmap) a DMA buffer previously allocated by
 128  * arm_dma_alloc().
 129  *
 130  * References to memory and mappings associated with cpu_addr/handle
 131  * during and after this call executing are illegal.
 132  */
 133 extern void arm_dma_free(struct device *dev, size_t size, void *cpu_addr,
 134                          dma_addr_t handle, unsigned long attrs);
 135
 136 /**
 137  * arm_dma_mmap - map a coherent DMA allocation into user space
 138  * @dev: valid struct device pointer, or NULL for ISA and EISA-like devices
 139  * @vma: vm_area_struct describing requested user mapping
 140  * @cpu_addr: kernel CPU-view address returned from dma_alloc_coherent
 141  * @handle: device-view address returned from dma_alloc_coherent
 142  * @size: size of memory originally requested in dma_alloc_coherent
 143  * @attrs: optinal attributes that specific mapping properties
 144  *
 145  * Map a coherent DMA buffer previously allocated by dma_alloc_coherent
 146  * into user space.  The coherent DMA buffer must not be freed by the
 147  * driver until the user space mapping has been released.
 148  */
 149 extern int arm_dma_mmap(struct device *dev, struct vm_area_struct *vma,
 150                         void *cpu_addr, dma_addr_t dma_addr, size_t size,
 151                         unsigned long attrs);
 152
 153 /*
 154  * For SA-1111, IXP425, and ADI systems  the dma-mapping functions are "magic"
 155  * and utilize bounce buffers as needed to work around limited DMA windows.
 156  *
 157  * On the SA-1111, a bug limits DMA to only certain regions of RAM.
 158  * On the IXP425, the PCI inbound window is 64MB (256MB total RAM)
 159  * On some ADI engineering systems, PCI inbound window is 32MB (12MB total RAM)
 160  *
 161  * The following are helper functions used by the dmabounce subystem
 162  *
 163  */
 164
 165 /**
 166  * dmabounce_register_dev
 167  *
 168  * @dev: valid struct device pointer
 169  * @small_buf_size: size of buffers to use with small buffer pool
 170  * @large_buf_size: size of buffers to use with large buffer pool (can be 0)
 171  * @needs_bounce_fn: called to determine whether buffer needs bouncing
 172  *
 173  * This function should be called by low-level platform code to register
 174  * a device as requireing DMA buffer bouncing. The function will allocate
 175  * appropriate DMA pools for the device.
 176  */
 177 extern int dmabounce_register_dev(struct device *, unsigned long,
 178                 unsigned long, int (*)(struct device *, dma_addr_t, size_t));
 179
 180 /**
 181  * dmabounce_unregister_dev
 182  *
 183  * @dev: valid struct device pointer
 184  *
 185  * This function should be called by low-level platform code when device
 186  * that was previously registered with dmabounce_register_dev is removed
 187  * from the system.
 188  *
 189  */
 190 extern void dmabounce_unregister_dev(struct device *);
 191
 192
 193
 194 /*
 195  * The scatter list versions of the above methods.
 196  */
 197 extern int arm_dma_map_sg(struct device *, struct scatterlist *, int,
 198                 enum dma_data_direction, unsigned long attrs);
 199 extern void arm_dma_unmap_sg(struct device *, struct scatterlist *, int,
 200                 enum dma_data_direction, unsigned long attrs);
 201 extern void arm_dma_sync_sg_for_cpu(struct device *, struct scatterlist *, int,
 202                 enum dma_data_direction);
 203 extern void arm_dma_sync_sg_for_device(struct device *, struct scatterlist *, int,
 204                 enum dma_data_direction);
 205 extern int arm_dma_get_sgtable(struct device *dev, struct sg_table *sgt,
 206                 void *cpu_addr, dma_addr_t dma_addr, size_t size,
 207                 unsigned long attrs);
 208
 209 #endif /* __KERNEL__ */
 210 #endif