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