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