include/linux/dma-mapping.h

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