include/linux/dma-mapping.h

   1 #ifndef _LINUX_DMA_MAPPING_H
   2 #define _LINUX_DMA_MAPPING_H
   3
   4 #include <linux/string.h>
   5 #include <linux/device.h>
   6 #include <linux/err.h>
   7 #include <linux/dma-attrs.h>
   8 #include <linux/dma-direction.h>
   9 #include <linux/scatterlist.h>
  10
  11 struct dma_map_ops {
  12         void* (*alloc)(struct device *dev, size_t size,
  13                                 dma_addr_t *dma_handle, gfp_t gfp,
  14                                 struct dma_attrs *attrs);
  15         void (*free)(struct device *dev, size_t size,
  16                               void *vaddr, dma_addr_t dma_handle,
  17                               struct dma_attrs *attrs);
  18         int (*mmap)(struct device *, struct vm_area_struct *,
  19                           void *, dma_addr_t, size_t, struct dma_attrs *attrs);
  20
  21         dma_addr_t (*map_page)(struct device *dev, struct page *page,
  22                                unsigned long offset, size_t size,
  23                                enum dma_data_direction dir,
  24                                struct dma_attrs *attrs);
  25         void (*unmap_page)(struct device *dev, dma_addr_t dma_handle,
  26                            size_t size, enum dma_data_direction dir,
  27                            struct dma_attrs *attrs);
  28         int (*map_sg)(struct device *dev, struct scatterlist *sg,
  29                       int nents, enum dma_data_direction dir,
  30                       struct dma_attrs *attrs);
  31         void (*unmap_sg)(struct device *dev,
  32                          struct scatterlist *sg, int nents,
  33                          enum dma_data_direction dir,
  34                          struct dma_attrs *attrs);
  35         void (*sync_single_for_cpu)(struct device *dev,
  36                                     dma_addr_t dma_handle, size_t size,
  37                                     enum dma_data_direction dir);
  38         void (*sync_single_for_device)(struct device *dev,
  39                                        dma_addr_t dma_handle, size_t size,
  40                                        enum dma_data_direction dir);
  41         void (*sync_sg_for_cpu)(struct device *dev,
  42                                 struct scatterlist *sg, int nents,
  43                                 enum dma_data_direction dir);
  44         void (*sync_sg_for_device)(struct device *dev,
  45                                    struct scatterlist *sg, int nents,
  46                                    enum dma_data_direction dir);
  47         int (*mapping_error)(struct device *dev, dma_addr_t dma_addr);
  48         int (*dma_supported)(struct device *dev, u64 mask);
  49         int (*set_dma_mask)(struct device *dev, u64 mask);
  50 #ifdef ARCH_HAS_DMA_GET_REQUIRED_MASK
  51         u64 (*get_required_mask)(struct device *dev);
  52 #endif
  53         int is_phys;
  54 };
  55
  56 #define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : ((1ULL<<(n))-1))
  57
  58 #define DMA_MASK_NONE   0x0ULL
  59
  60 static inline int valid_dma_direction(int dma_direction)
  61 {
  62         return ((dma_direction == DMA_BIDIRECTIONAL) ||
  63                 (dma_direction == DMA_TO_DEVICE) ||
  64                 (dma_direction == DMA_FROM_DEVICE));
  65 }
  66
  67 static inline int is_device_dma_capable(struct device *dev)
  68 {
  69         return dev->dma_mask != NULL && *dev->dma_mask != DMA_MASK_NONE;
  70 }
  71
  72 #ifdef CONFIG_HAS_DMA
  73 #include <asm/dma-mapping.h>
  74 #else
  75 #include <asm-generic/dma-mapping-broken.h>
  76 #endif
  77
  78 static inline u64 dma_get_mask(struct device *dev)
  79 {
  80         if (dev && dev->dma_mask && *dev->dma_mask)
  81                 return *dev->dma_mask;
  82         return DMA_BIT_MASK(32);
  83 }
  84
  85 #ifdef CONFIG_ARCH_HAS_DMA_SET_COHERENT_MASK
  86 int dma_set_coherent_mask(struct device *dev, u64 mask);
  87 #else
  88 static inline int dma_set_coherent_mask(struct device *dev, u64 mask)
  89 {
  90         if (!dma_supported(dev, mask))
  91                 return -EIO;
  92         dev->coherent_dma_mask = mask;
  93         return 0;
  94 }
  95 #endif
  96
  97 extern u64 dma_get_required_mask(struct device *dev);
  98
  99 static inline unsigned int dma_get_max_seg_size(struct device *dev)
 100 {
 101         return dev->dma_parms ? dev->dma_parms->max_segment_size : 65536;
 102 }
 103
 104 static inline unsigned int dma_set_max_seg_size(struct device *dev,
 105                                                 unsigned int size)
 106 {
 107         if (dev->dma_parms) {
 108                 dev->dma_parms->max_segment_size = size;
 109                 return 0;
 110         } else
 111                 return -EIO;
 112 }
 113
 114 static inline unsigned long dma_get_seg_boundary(struct device *dev)
 115 {
 116         return dev->dma_parms ?
 117                 dev->dma_parms->segment_boundary_mask : 0xffffffff;
 118 }
 119
 120 static inline int dma_set_seg_boundary(struct device *dev, unsigned long mask)
 121 {
 122         if (dev->dma_parms) {
 123                 dev->dma_parms->segment_boundary_mask = mask;
 124                 return 0;
 125         } else
 126                 return -EIO;
 127 }
 128
 129 static inline void *dma_zalloc_coherent(struct device *dev, size_t size,
 130                                         dma_addr_t *dma_handle, gfp_t flag)
 131 {
 132         void *ret = dma_alloc_coherent(dev, size, dma_handle, flag);
 133         if (ret)
 134                 memset(ret, 0, size);
 135         return ret;
 136 }
 137
 138 static inline int dma_get_cache_alignment(void)
 139 {
 140 #ifdef ARCH_DMA_MINALIGN
 141         return ARCH_DMA_MINALIGN;
 142 #endif
 143         return 1;
 144 }
 145
 146 /* flags for the coherent memory api */
 147 #define DMA_MEMORY_MAP                  0x01
 148 #define DMA_MEMORY_IO                   0x02
 149 #define DMA_MEMORY_INCLUDES_CHILDREN    0x04
 150 #define DMA_MEMORY_EXCLUSIVE            0x08
 151
 152 #ifndef ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY
 153 static inline int
 154 dma_declare_coherent_memory(struct device *dev, dma_addr_t bus_addr,
 155                             dma_addr_t device_addr, size_t size, int flags)
 156 {
 157         return 0;
 158 }
 159
 160 static inline void
 161 dma_release_declared_memory(struct device *dev)
 162 {
 163 }
 164
 165 static inline void *
 166 dma_mark_declared_memory_occupied(struct device *dev,
 167                                   dma_addr_t device_addr, size_t size)
 168 {
 169         return ERR_PTR(-EBUSY);
 170 }
 171 #endif
 172
 173 /*
 174  * Managed DMA API
 175  */
 176 extern void *dmam_alloc_coherent(struct device *dev, size_t size,
 177                                  dma_addr_t *dma_handle, gfp_t gfp);
 178 extern void dmam_free_coherent(struct device *dev, size_t size, void *vaddr,
 179                                dma_addr_t dma_handle);
 180 extern void *dmam_alloc_noncoherent(struct device *dev, size_t size,
 181                                     dma_addr_t *dma_handle, gfp_t gfp);
 182 extern void dmam_free_noncoherent(struct device *dev, size_t size, void *vaddr,
 183                                   dma_addr_t dma_handle);
 184 #ifdef ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY
 185 extern int dmam_declare_coherent_memory(struct device *dev, dma_addr_t bus_addr,
 186                                         dma_addr_t device_addr, size_t size,
 187                                         int flags);
 188 extern void dmam_release_declared_memory(struct device *dev);
 189 #else /* ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY */
 190 static inline int dmam_declare_coherent_memory(struct device *dev,
 191                                 dma_addr_t bus_addr, dma_addr_t device_addr,
 192                                 size_t size, gfp_t gfp)
 193 {
 194         return 0;
 195 }
 196
 197 static inline void dmam_release_declared_memory(struct device *dev)
 198 {
 199 }
 200 #endif /* ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY */
 201
 202 #ifndef CONFIG_HAVE_DMA_ATTRS
 203 struct dma_attrs;
 204
 205 #define dma_map_single_attrs(dev, cpu_addr, size, dir, attrs) \
 206         dma_map_single(dev, cpu_addr, size, dir)
 207
 208 #define dma_unmap_single_attrs(dev, dma_addr, size, dir, attrs) \
 209         dma_unmap_single(dev, dma_addr, size, dir)
 210
 211 #define dma_map_sg_attrs(dev, sgl, nents, dir, attrs) \
 212         dma_map_sg(dev, sgl, nents, dir)
 213
 214 #define dma_unmap_sg_attrs(dev, sgl, nents, dir, attrs) \
 215         dma_unmap_sg(dev, sgl, nents, dir)
 216
 217 #endif /* CONFIG_HAVE_DMA_ATTRS */
 218
 219 #ifdef CONFIG_NEED_DMA_MAP_STATE
 220 #define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME)        dma_addr_t ADDR_NAME
 221 #define DEFINE_DMA_UNMAP_LEN(LEN_NAME)          __u32 LEN_NAME
 222 #define dma_unmap_addr(PTR, ADDR_NAME)           ((PTR)->ADDR_NAME)
 223 #define dma_unmap_addr_set(PTR, ADDR_NAME, VAL)  (((PTR)->ADDR_NAME) = (VAL))
 224 #define dma_unmap_len(PTR, LEN_NAME)             ((PTR)->LEN_NAME)
 225 #define dma_unmap_len_set(PTR, LEN_NAME, VAL)    (((PTR)->LEN_NAME) = (VAL))
 226 #else
 227 #define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME)
 228 #define DEFINE_DMA_UNMAP_LEN(LEN_NAME)
 229 #define dma_unmap_addr(PTR, ADDR_NAME)           (0)
 230 #define dma_unmap_addr_set(PTR, ADDR_NAME, VAL)  do { } while (0)
 231 #define dma_unmap_len(PTR, LEN_NAME)             (0)
 232 #define dma_unmap_len_set(PTR, LEN_NAME, VAL)    do { } while (0)
 233 #endif
 234
 235 #endif