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