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