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