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