Robert P. J. Day | 96532ba | 2008-02-03 15:06:26 +0200 | [diff] [blame] | 1 | #ifndef _LINUX_DMA_MAPPING_H |
| 2 | #define _LINUX_DMA_MAPPING_H |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 3 | |
Andrew Morton | 842fa69 | 2011-11-02 13:39:33 -0700 | [diff] [blame] | 4 | #include <linux/string.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 5 | #include <linux/device.h> |
| 6 | #include <linux/err.h> |
FUJITA Tomonori | f0402a2 | 2009-01-05 23:59:01 +0900 | [diff] [blame] | 7 | #include <linux/dma-attrs.h> |
Alexey Dobriyan | b7f080c | 2011-06-16 11:01:34 +0000 | [diff] [blame] | 8 | #include <linux/dma-direction.h> |
FUJITA Tomonori | f0402a2 | 2009-01-05 23:59:01 +0900 | [diff] [blame] | 9 | #include <linux/scatterlist.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 10 | |
Bjorn Helgaas | 77f2ea2 | 2014-04-30 11:20:53 -0600 | [diff] [blame] | 11 | /* |
| 12 | * A dma_addr_t can hold any valid DMA or bus address for the platform. |
| 13 | * It can be given to a device to use as a DMA source or target. A CPU cannot |
| 14 | * reference a dma_addr_t directly because there may be translation between |
| 15 | * its physical address space and the bus address space. |
| 16 | */ |
FUJITA Tomonori | f0402a2 | 2009-01-05 23:59:01 +0900 | [diff] [blame] | 17 | struct dma_map_ops { |
Marek Szyprowski | 613c457 | 2012-03-28 16:36:27 +0200 | [diff] [blame] | 18 | void* (*alloc)(struct device *dev, size_t size, |
| 19 | dma_addr_t *dma_handle, gfp_t gfp, |
| 20 | struct dma_attrs *attrs); |
| 21 | void (*free)(struct device *dev, size_t size, |
| 22 | void *vaddr, dma_addr_t dma_handle, |
| 23 | struct dma_attrs *attrs); |
Marek Szyprowski | 9adc537 | 2011-12-21 16:55:33 +0100 | [diff] [blame] | 24 | int (*mmap)(struct device *, struct vm_area_struct *, |
| 25 | void *, dma_addr_t, size_t, struct dma_attrs *attrs); |
| 26 | |
Marek Szyprowski | d2b7428 | 2012-06-13 10:05:52 +0200 | [diff] [blame] | 27 | int (*get_sgtable)(struct device *dev, struct sg_table *sgt, void *, |
| 28 | dma_addr_t, size_t, struct dma_attrs *attrs); |
| 29 | |
FUJITA Tomonori | f0402a2 | 2009-01-05 23:59:01 +0900 | [diff] [blame] | 30 | dma_addr_t (*map_page)(struct device *dev, struct page *page, |
| 31 | unsigned long offset, size_t size, |
| 32 | enum dma_data_direction dir, |
| 33 | struct dma_attrs *attrs); |
| 34 | void (*unmap_page)(struct device *dev, dma_addr_t dma_handle, |
| 35 | size_t size, enum dma_data_direction dir, |
| 36 | struct dma_attrs *attrs); |
| 37 | int (*map_sg)(struct device *dev, struct scatterlist *sg, |
| 38 | int nents, enum dma_data_direction dir, |
| 39 | struct dma_attrs *attrs); |
| 40 | void (*unmap_sg)(struct device *dev, |
| 41 | struct scatterlist *sg, int nents, |
| 42 | enum dma_data_direction dir, |
| 43 | struct dma_attrs *attrs); |
| 44 | void (*sync_single_for_cpu)(struct device *dev, |
| 45 | dma_addr_t dma_handle, size_t size, |
| 46 | enum dma_data_direction dir); |
| 47 | void (*sync_single_for_device)(struct device *dev, |
| 48 | dma_addr_t dma_handle, size_t size, |
| 49 | enum dma_data_direction dir); |
FUJITA Tomonori | f0402a2 | 2009-01-05 23:59:01 +0900 | [diff] [blame] | 50 | void (*sync_sg_for_cpu)(struct device *dev, |
| 51 | struct scatterlist *sg, int nents, |
| 52 | enum dma_data_direction dir); |
| 53 | void (*sync_sg_for_device)(struct device *dev, |
| 54 | struct scatterlist *sg, int nents, |
| 55 | enum dma_data_direction dir); |
| 56 | int (*mapping_error)(struct device *dev, dma_addr_t dma_addr); |
| 57 | int (*dma_supported)(struct device *dev, u64 mask); |
FUJITA Tomonori | f726f30e | 2009-08-04 19:08:24 +0000 | [diff] [blame] | 58 | int (*set_dma_mask)(struct device *dev, u64 mask); |
Milton Miller | 3a8f755 | 2011-06-24 09:05:23 +0000 | [diff] [blame] | 59 | #ifdef ARCH_HAS_DMA_GET_REQUIRED_MASK |
| 60 | u64 (*get_required_mask)(struct device *dev); |
| 61 | #endif |
FUJITA Tomonori | f0402a2 | 2009-01-05 23:59:01 +0900 | [diff] [blame] | 62 | int is_phys; |
| 63 | }; |
| 64 | |
Andrew Morton | 8f286c3 | 2007-10-18 03:05:07 -0700 | [diff] [blame] | 65 | #define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : ((1ULL<<(n))-1)) |
Borislav Petkov | 34c6538 | 2007-10-18 03:05:06 -0700 | [diff] [blame] | 66 | |
James Bottomley | 32e8f70 | 2007-10-16 01:23:55 -0700 | [diff] [blame] | 67 | #define DMA_MASK_NONE 0x0ULL |
| 68 | |
Rolf Eike Beer | d6bd3a3 | 2006-09-29 01:59:48 -0700 | [diff] [blame] | 69 | static inline int valid_dma_direction(int dma_direction) |
| 70 | { |
| 71 | return ((dma_direction == DMA_BIDIRECTIONAL) || |
| 72 | (dma_direction == DMA_TO_DEVICE) || |
| 73 | (dma_direction == DMA_FROM_DEVICE)); |
| 74 | } |
| 75 | |
James Bottomley | 32e8f70 | 2007-10-16 01:23:55 -0700 | [diff] [blame] | 76 | static inline int is_device_dma_capable(struct device *dev) |
| 77 | { |
| 78 | return dev->dma_mask != NULL && *dev->dma_mask != DMA_MASK_NONE; |
| 79 | } |
| 80 | |
Dan Williams | 1b0fac4 | 2007-07-15 23:40:26 -0700 | [diff] [blame] | 81 | #ifdef CONFIG_HAS_DMA |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 82 | #include <asm/dma-mapping.h> |
Dan Williams | 1b0fac4 | 2007-07-15 23:40:26 -0700 | [diff] [blame] | 83 | #else |
| 84 | #include <asm-generic/dma-mapping-broken.h> |
| 85 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 86 | |
FUJITA Tomonori | 589fc9a | 2008-09-12 19:42:34 +0900 | [diff] [blame] | 87 | static inline u64 dma_get_mask(struct device *dev) |
| 88 | { |
FUJITA Tomonori | 07a2c01 | 2008-09-19 02:02:05 +0900 | [diff] [blame] | 89 | if (dev && dev->dma_mask && *dev->dma_mask) |
FUJITA Tomonori | 589fc9a | 2008-09-12 19:42:34 +0900 | [diff] [blame] | 90 | return *dev->dma_mask; |
Yang Hongyang | 284901a | 2009-04-06 19:01:15 -0700 | [diff] [blame] | 91 | return DMA_BIT_MASK(32); |
FUJITA Tomonori | 589fc9a | 2008-09-12 19:42:34 +0900 | [diff] [blame] | 92 | } |
| 93 | |
Rob Herring | 58af4a2 | 2012-03-20 14:33:01 -0500 | [diff] [blame] | 94 | #ifdef CONFIG_ARCH_HAS_DMA_SET_COHERENT_MASK |
FUJITA Tomonori | 710224f | 2010-09-22 13:04:55 -0700 | [diff] [blame] | 95 | int dma_set_coherent_mask(struct device *dev, u64 mask); |
| 96 | #else |
FUJITA Tomonori | 6a1961f | 2010-03-10 15:23:39 -0800 | [diff] [blame] | 97 | static inline int dma_set_coherent_mask(struct device *dev, u64 mask) |
| 98 | { |
| 99 | if (!dma_supported(dev, mask)) |
| 100 | return -EIO; |
| 101 | dev->coherent_dma_mask = mask; |
| 102 | return 0; |
| 103 | } |
FUJITA Tomonori | 710224f | 2010-09-22 13:04:55 -0700 | [diff] [blame] | 104 | #endif |
FUJITA Tomonori | 6a1961f | 2010-03-10 15:23:39 -0800 | [diff] [blame] | 105 | |
Russell King | 4aa806b | 2013-06-26 13:49:44 +0100 | [diff] [blame] | 106 | /* |
| 107 | * Set both the DMA mask and the coherent DMA mask to the same thing. |
| 108 | * Note that we don't check the return value from dma_set_coherent_mask() |
| 109 | * as the DMA API guarantees that the coherent DMA mask can be set to |
| 110 | * the same or smaller than the streaming DMA mask. |
| 111 | */ |
| 112 | static inline int dma_set_mask_and_coherent(struct device *dev, u64 mask) |
| 113 | { |
| 114 | int rc = dma_set_mask(dev, mask); |
| 115 | if (rc == 0) |
| 116 | dma_set_coherent_mask(dev, mask); |
| 117 | return rc; |
| 118 | } |
| 119 | |
Russell King | fa6a8d6 | 2013-06-27 12:21:45 +0100 | [diff] [blame] | 120 | /* |
| 121 | * Similar to the above, except it deals with the case where the device |
| 122 | * does not have dev->dma_mask appropriately setup. |
| 123 | */ |
| 124 | static inline int dma_coerce_mask_and_coherent(struct device *dev, u64 mask) |
| 125 | { |
| 126 | dev->dma_mask = &dev->coherent_dma_mask; |
| 127 | return dma_set_mask_and_coherent(dev, mask); |
| 128 | } |
| 129 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 130 | extern u64 dma_get_required_mask(struct device *dev); |
| 131 | |
FUJITA Tomonori | 6b7b651 | 2008-02-04 22:27:55 -0800 | [diff] [blame] | 132 | static inline unsigned int dma_get_max_seg_size(struct device *dev) |
| 133 | { |
| 134 | return dev->dma_parms ? dev->dma_parms->max_segment_size : 65536; |
| 135 | } |
| 136 | |
| 137 | static inline unsigned int dma_set_max_seg_size(struct device *dev, |
| 138 | unsigned int size) |
| 139 | { |
| 140 | if (dev->dma_parms) { |
| 141 | dev->dma_parms->max_segment_size = size; |
| 142 | return 0; |
| 143 | } else |
| 144 | return -EIO; |
| 145 | } |
| 146 | |
FUJITA Tomonori | d22a696 | 2008-02-04 22:28:13 -0800 | [diff] [blame] | 147 | static inline unsigned long dma_get_seg_boundary(struct device *dev) |
| 148 | { |
| 149 | return dev->dma_parms ? |
| 150 | dev->dma_parms->segment_boundary_mask : 0xffffffff; |
| 151 | } |
| 152 | |
| 153 | static inline int dma_set_seg_boundary(struct device *dev, unsigned long mask) |
| 154 | { |
| 155 | if (dev->dma_parms) { |
| 156 | dev->dma_parms->segment_boundary_mask = mask; |
| 157 | return 0; |
| 158 | } else |
| 159 | return -EIO; |
| 160 | } |
| 161 | |
Santosh Shilimkar | 00c8f16 | 2013-07-29 14:18:48 +0100 | [diff] [blame] | 162 | #ifndef dma_max_pfn |
| 163 | static inline unsigned long dma_max_pfn(struct device *dev) |
| 164 | { |
| 165 | return *dev->dma_mask >> PAGE_SHIFT; |
| 166 | } |
| 167 | #endif |
| 168 | |
Andrew Morton | 842fa69 | 2011-11-02 13:39:33 -0700 | [diff] [blame] | 169 | static inline void *dma_zalloc_coherent(struct device *dev, size_t size, |
| 170 | dma_addr_t *dma_handle, gfp_t flag) |
| 171 | { |
Joe Perches | ede23fa8 | 2013-08-26 22:45:23 -0700 | [diff] [blame] | 172 | void *ret = dma_alloc_coherent(dev, size, dma_handle, |
| 173 | flag | __GFP_ZERO); |
Andrew Morton | 842fa69 | 2011-11-02 13:39:33 -0700 | [diff] [blame] | 174 | return ret; |
| 175 | } |
| 176 | |
Heiko Carstens | e259f19 | 2010-08-13 09:39:18 +0200 | [diff] [blame] | 177 | #ifdef CONFIG_HAS_DMA |
FUJITA Tomonori | 4565f01 | 2010-08-10 18:03:22 -0700 | [diff] [blame] | 178 | static inline int dma_get_cache_alignment(void) |
| 179 | { |
| 180 | #ifdef ARCH_DMA_MINALIGN |
| 181 | return ARCH_DMA_MINALIGN; |
| 182 | #endif |
| 183 | return 1; |
| 184 | } |
Heiko Carstens | e259f19 | 2010-08-13 09:39:18 +0200 | [diff] [blame] | 185 | #endif |
FUJITA Tomonori | 4565f01 | 2010-08-10 18:03:22 -0700 | [diff] [blame] | 186 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 187 | /* flags for the coherent memory api */ |
| 188 | #define DMA_MEMORY_MAP 0x01 |
| 189 | #define DMA_MEMORY_IO 0x02 |
| 190 | #define DMA_MEMORY_INCLUDES_CHILDREN 0x04 |
| 191 | #define DMA_MEMORY_EXCLUSIVE 0x08 |
| 192 | |
| 193 | #ifndef ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY |
| 194 | static inline int |
Bjorn Helgaas | 88a984b | 2014-05-20 16:54:22 -0600 | [diff] [blame^] | 195 | dma_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 196 | dma_addr_t device_addr, size_t size, int flags) |
| 197 | { |
| 198 | return 0; |
| 199 | } |
| 200 | |
| 201 | static inline void |
| 202 | dma_release_declared_memory(struct device *dev) |
| 203 | { |
| 204 | } |
| 205 | |
| 206 | static inline void * |
| 207 | dma_mark_declared_memory_occupied(struct device *dev, |
| 208 | dma_addr_t device_addr, size_t size) |
| 209 | { |
| 210 | return ERR_PTR(-EBUSY); |
| 211 | } |
| 212 | #endif |
| 213 | |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 214 | /* |
| 215 | * Managed DMA API |
| 216 | */ |
| 217 | extern void *dmam_alloc_coherent(struct device *dev, size_t size, |
| 218 | dma_addr_t *dma_handle, gfp_t gfp); |
| 219 | extern void dmam_free_coherent(struct device *dev, size_t size, void *vaddr, |
| 220 | dma_addr_t dma_handle); |
| 221 | extern void *dmam_alloc_noncoherent(struct device *dev, size_t size, |
| 222 | dma_addr_t *dma_handle, gfp_t gfp); |
| 223 | extern void dmam_free_noncoherent(struct device *dev, size_t size, void *vaddr, |
| 224 | dma_addr_t dma_handle); |
| 225 | #ifdef ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY |
Bjorn Helgaas | 88a984b | 2014-05-20 16:54:22 -0600 | [diff] [blame^] | 226 | extern int dmam_declare_coherent_memory(struct device *dev, |
| 227 | phys_addr_t phys_addr, |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 228 | dma_addr_t device_addr, size_t size, |
| 229 | int flags); |
| 230 | extern void dmam_release_declared_memory(struct device *dev); |
| 231 | #else /* ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY */ |
| 232 | static inline int dmam_declare_coherent_memory(struct device *dev, |
Bjorn Helgaas | 88a984b | 2014-05-20 16:54:22 -0600 | [diff] [blame^] | 233 | phys_addr_t phys_addr, dma_addr_t device_addr, |
Tejun Heo | 9ac7849 | 2007-01-20 16:00:26 +0900 | [diff] [blame] | 234 | size_t size, gfp_t gfp) |
| 235 | { |
| 236 | return 0; |
| 237 | } |
| 238 | |
| 239 | static inline void dmam_release_declared_memory(struct device *dev) |
| 240 | { |
| 241 | } |
| 242 | #endif /* ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY */ |
| 243 | |
Arthur Kepner | 74bc7ce | 2008-04-29 01:00:30 -0700 | [diff] [blame] | 244 | #ifndef CONFIG_HAVE_DMA_ATTRS |
| 245 | struct dma_attrs; |
| 246 | |
| 247 | #define dma_map_single_attrs(dev, cpu_addr, size, dir, attrs) \ |
| 248 | dma_map_single(dev, cpu_addr, size, dir) |
| 249 | |
| 250 | #define dma_unmap_single_attrs(dev, dma_addr, size, dir, attrs) \ |
| 251 | dma_unmap_single(dev, dma_addr, size, dir) |
| 252 | |
| 253 | #define dma_map_sg_attrs(dev, sgl, nents, dir, attrs) \ |
| 254 | dma_map_sg(dev, sgl, nents, dir) |
| 255 | |
| 256 | #define dma_unmap_sg_attrs(dev, sgl, nents, dir, attrs) \ |
| 257 | dma_unmap_sg(dev, sgl, nents, dir) |
| 258 | |
| 259 | #endif /* CONFIG_HAVE_DMA_ATTRS */ |
| 260 | |
FUJITA Tomonori | 0acedc1 | 2010-03-10 15:23:31 -0800 | [diff] [blame] | 261 | #ifdef CONFIG_NEED_DMA_MAP_STATE |
| 262 | #define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME) dma_addr_t ADDR_NAME |
| 263 | #define DEFINE_DMA_UNMAP_LEN(LEN_NAME) __u32 LEN_NAME |
| 264 | #define dma_unmap_addr(PTR, ADDR_NAME) ((PTR)->ADDR_NAME) |
| 265 | #define dma_unmap_addr_set(PTR, ADDR_NAME, VAL) (((PTR)->ADDR_NAME) = (VAL)) |
| 266 | #define dma_unmap_len(PTR, LEN_NAME) ((PTR)->LEN_NAME) |
| 267 | #define dma_unmap_len_set(PTR, LEN_NAME, VAL) (((PTR)->LEN_NAME) = (VAL)) |
| 268 | #else |
| 269 | #define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME) |
| 270 | #define DEFINE_DMA_UNMAP_LEN(LEN_NAME) |
| 271 | #define dma_unmap_addr(PTR, ADDR_NAME) (0) |
| 272 | #define dma_unmap_addr_set(PTR, ADDR_NAME, VAL) do { } while (0) |
| 273 | #define dma_unmap_len(PTR, LEN_NAME) (0) |
| 274 | #define dma_unmap_len_set(PTR, LEN_NAME, VAL) do { } while (0) |
| 275 | #endif |
| 276 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 277 | #endif |