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

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