1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * This header is for implementations of dma_map_ops and related code. 4 * It should not be included in drivers just using the DMA API. 5 */ 6 #ifndef _LINUX_DMA_MAP_OPS_H 7 #define _LINUX_DMA_MAP_OPS_H 8 9 #include <linux/dma-mapping.h> 10 #include <linux/pgtable.h> 11 12 struct cma; 13 14 struct dma_map_ops { 15 void *(*alloc)(struct device *dev, size_t size, 16 dma_addr_t *dma_handle, gfp_t gfp, 17 unsigned long attrs); 18 void (*free)(struct device *dev, size_t size, void *vaddr, 19 dma_addr_t dma_handle, unsigned long attrs); 20 struct page *(*alloc_pages)(struct device *dev, size_t size, 21 dma_addr_t *dma_handle, enum dma_data_direction dir, 22 gfp_t gfp); 23 void (*free_pages)(struct device *dev, size_t size, struct page *vaddr, 24 dma_addr_t dma_handle, enum dma_data_direction dir); 25 struct sg_table *(*alloc_noncontiguous)(struct device *dev, size_t size, 26 enum dma_data_direction dir, gfp_t gfp, 27 unsigned long attrs); 28 void (*free_noncontiguous)(struct device *dev, size_t size, 29 struct sg_table *sgt, enum dma_data_direction dir); 30 int (*mmap)(struct device *, struct vm_area_struct *, 31 void *, dma_addr_t, size_t, unsigned long attrs); 32 33 int (*get_sgtable)(struct device *dev, struct sg_table *sgt, 34 void *cpu_addr, dma_addr_t dma_addr, size_t size, 35 unsigned long attrs); 36 37 dma_addr_t (*map_page)(struct device *dev, struct page *page, 38 unsigned long offset, size_t size, 39 enum dma_data_direction dir, unsigned long attrs); 40 void (*unmap_page)(struct device *dev, dma_addr_t dma_handle, 41 size_t size, enum dma_data_direction dir, 42 unsigned long attrs); 43 /* 44 * map_sg should return a negative error code on error. See 45 * dma_map_sgtable() for a list of appropriate error codes 46 * and their meanings. 47 */ 48 int (*map_sg)(struct device *dev, struct scatterlist *sg, int nents, 49 enum dma_data_direction dir, unsigned long attrs); 50 void (*unmap_sg)(struct device *dev, struct scatterlist *sg, int nents, 51 enum dma_data_direction dir, unsigned long attrs); 52 dma_addr_t (*map_resource)(struct device *dev, phys_addr_t phys_addr, 53 size_t size, enum dma_data_direction dir, 54 unsigned long attrs); 55 void (*unmap_resource)(struct device *dev, dma_addr_t dma_handle, 56 size_t size, enum dma_data_direction dir, 57 unsigned long attrs); 58 void (*sync_single_for_cpu)(struct device *dev, dma_addr_t dma_handle, 59 size_t size, enum dma_data_direction dir); 60 void (*sync_single_for_device)(struct device *dev, 61 dma_addr_t dma_handle, size_t size, 62 enum dma_data_direction dir); 63 void (*sync_sg_for_cpu)(struct device *dev, struct scatterlist *sg, 64 int nents, enum dma_data_direction dir); 65 void (*sync_sg_for_device)(struct device *dev, struct scatterlist *sg, 66 int nents, enum dma_data_direction dir); 67 void (*cache_sync)(struct device *dev, void *vaddr, size_t size, 68 enum dma_data_direction direction); 69 int (*dma_supported)(struct device *dev, u64 mask); 70 u64 (*get_required_mask)(struct device *dev); 71 size_t (*max_mapping_size)(struct device *dev); 72 unsigned long (*get_merge_boundary)(struct device *dev); 73 }; 74 75 #ifdef CONFIG_DMA_OPS 76 #include <asm/dma-mapping.h> 77 78 static inline const struct dma_map_ops *get_dma_ops(struct device *dev) 79 { 80 if (dev->dma_ops) 81 return dev->dma_ops; 82 return get_arch_dma_ops(dev->bus); 83 } 84 85 static inline void set_dma_ops(struct device *dev, 86 const struct dma_map_ops *dma_ops) 87 { 88 dev->dma_ops = dma_ops; 89 } 90 #else /* CONFIG_DMA_OPS */ 91 static inline const struct dma_map_ops *get_dma_ops(struct device *dev) 92 { 93 return NULL; 94 } 95 static inline void set_dma_ops(struct device *dev, 96 const struct dma_map_ops *dma_ops) 97 { 98 } 99 #endif /* CONFIG_DMA_OPS */ 100 101 #ifdef CONFIG_DMA_CMA 102 extern struct cma *dma_contiguous_default_area; 103 104 static inline struct cma *dev_get_cma_area(struct device *dev) 105 { 106 if (dev && dev->cma_area) 107 return dev->cma_area; 108 return dma_contiguous_default_area; 109 } 110 111 void dma_contiguous_reserve(phys_addr_t addr_limit); 112 int __init dma_contiguous_reserve_area(phys_addr_t size, phys_addr_t base, 113 phys_addr_t limit, struct cma **res_cma, bool fixed); 114 115 struct page *dma_alloc_from_contiguous(struct device *dev, size_t count, 116 unsigned int order, bool no_warn); 117 bool dma_release_from_contiguous(struct device *dev, struct page *pages, 118 int count); 119 struct page *dma_alloc_contiguous(struct device *dev, size_t size, gfp_t gfp); 120 void dma_free_contiguous(struct device *dev, struct page *page, size_t size); 121 122 void dma_contiguous_early_fixup(phys_addr_t base, unsigned long size); 123 #else /* CONFIG_DMA_CMA */ 124 static inline struct cma *dev_get_cma_area(struct device *dev) 125 { 126 return NULL; 127 } 128 static inline void dma_contiguous_reserve(phys_addr_t limit) 129 { 130 } 131 static inline int dma_contiguous_reserve_area(phys_addr_t size, 132 phys_addr_t base, phys_addr_t limit, struct cma **res_cma, 133 bool fixed) 134 { 135 return -ENOSYS; 136 } 137 static inline struct page *dma_alloc_from_contiguous(struct device *dev, 138 size_t count, unsigned int order, bool no_warn) 139 { 140 return NULL; 141 } 142 static inline bool dma_release_from_contiguous(struct device *dev, 143 struct page *pages, int count) 144 { 145 return false; 146 } 147 /* Use fallback alloc() and free() when CONFIG_DMA_CMA=n */ 148 static inline struct page *dma_alloc_contiguous(struct device *dev, size_t size, 149 gfp_t gfp) 150 { 151 return NULL; 152 } 153 static inline void dma_free_contiguous(struct device *dev, struct page *page, 154 size_t size) 155 { 156 __free_pages(page, get_order(size)); 157 } 158 #endif /* CONFIG_DMA_CMA*/ 159 160 #ifdef CONFIG_DMA_PERNUMA_CMA 161 void dma_pernuma_cma_reserve(void); 162 #else 163 static inline void dma_pernuma_cma_reserve(void) { } 164 #endif /* CONFIG_DMA_PERNUMA_CMA */ 165 166 #ifdef CONFIG_DMA_DECLARE_COHERENT 167 int dma_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr, 168 dma_addr_t device_addr, size_t size); 169 int dma_alloc_from_dev_coherent(struct device *dev, ssize_t size, 170 dma_addr_t *dma_handle, void **ret); 171 int dma_release_from_dev_coherent(struct device *dev, int order, void *vaddr); 172 int dma_mmap_from_dev_coherent(struct device *dev, struct vm_area_struct *vma, 173 void *cpu_addr, size_t size, int *ret); 174 175 void *dma_alloc_from_global_coherent(struct device *dev, ssize_t size, 176 dma_addr_t *dma_handle); 177 int dma_release_from_global_coherent(int order, void *vaddr); 178 int dma_mmap_from_global_coherent(struct vm_area_struct *vma, void *cpu_addr, 179 size_t size, int *ret); 180 181 #else 182 static inline int dma_declare_coherent_memory(struct device *dev, 183 phys_addr_t phys_addr, dma_addr_t device_addr, size_t size) 184 { 185 return -ENOSYS; 186 } 187 #define dma_alloc_from_dev_coherent(dev, size, handle, ret) (0) 188 #define dma_release_from_dev_coherent(dev, order, vaddr) (0) 189 #define dma_mmap_from_dev_coherent(dev, vma, vaddr, order, ret) (0) 190 191 static inline void *dma_alloc_from_global_coherent(struct device *dev, 192 ssize_t size, dma_addr_t *dma_handle) 193 { 194 return NULL; 195 } 196 static inline int dma_release_from_global_coherent(int order, void *vaddr) 197 { 198 return 0; 199 } 200 static inline int dma_mmap_from_global_coherent(struct vm_area_struct *vma, 201 void *cpu_addr, size_t size, int *ret) 202 { 203 return 0; 204 } 205 #endif /* CONFIG_DMA_DECLARE_COHERENT */ 206 207 /* 208 * This is the actual return value from the ->alloc_noncontiguous method. 209 * The users of the DMA API should only care about the sg_table, but to make 210 * the DMA-API internal vmaping and freeing easier we stash away the page 211 * array as well (except for the fallback case). This can go away any time, 212 * e.g. when a vmap-variant that takes a scatterlist comes along. 213 */ 214 struct dma_sgt_handle { 215 struct sg_table sgt; 216 struct page **pages; 217 }; 218 #define sgt_handle(sgt) \ 219 container_of((sgt), struct dma_sgt_handle, sgt) 220 221 int dma_common_get_sgtable(struct device *dev, struct sg_table *sgt, 222 void *cpu_addr, dma_addr_t dma_addr, size_t size, 223 unsigned long attrs); 224 int dma_common_mmap(struct device *dev, struct vm_area_struct *vma, 225 void *cpu_addr, dma_addr_t dma_addr, size_t size, 226 unsigned long attrs); 227 struct page *dma_common_alloc_pages(struct device *dev, size_t size, 228 dma_addr_t *dma_handle, enum dma_data_direction dir, gfp_t gfp); 229 void dma_common_free_pages(struct device *dev, size_t size, struct page *vaddr, 230 dma_addr_t dma_handle, enum dma_data_direction dir); 231 232 struct page **dma_common_find_pages(void *cpu_addr); 233 void *dma_common_contiguous_remap(struct page *page, size_t size, pgprot_t prot, 234 const void *caller); 235 void *dma_common_pages_remap(struct page **pages, size_t size, pgprot_t prot, 236 const void *caller); 237 void dma_common_free_remap(void *cpu_addr, size_t size); 238 239 struct page *dma_alloc_from_pool(struct device *dev, size_t size, 240 void **cpu_addr, gfp_t flags, 241 bool (*phys_addr_ok)(struct device *, phys_addr_t, size_t)); 242 bool dma_free_from_pool(struct device *dev, void *start, size_t size); 243 244 int dma_direct_set_offset(struct device *dev, phys_addr_t cpu_start, 245 dma_addr_t dma_start, u64 size); 246 247 #if defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_DEVICE) || \ 248 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU) || \ 249 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU_ALL) 250 extern bool dma_default_coherent; 251 static inline bool dev_is_dma_coherent(struct device *dev) 252 { 253 return dev->dma_coherent; 254 } 255 #else 256 static inline bool dev_is_dma_coherent(struct device *dev) 257 { 258 return true; 259 } 260 #endif /* CONFIG_ARCH_HAS_DMA_COHERENCE_H */ 261 262 void *arch_dma_alloc(struct device *dev, size_t size, dma_addr_t *dma_handle, 263 gfp_t gfp, unsigned long attrs); 264 void arch_dma_free(struct device *dev, size_t size, void *cpu_addr, 265 dma_addr_t dma_addr, unsigned long attrs); 266 267 #ifdef CONFIG_MMU 268 /* 269 * Page protection so that devices that can't snoop CPU caches can use the 270 * memory coherently. We default to pgprot_noncached which is usually used 271 * for ioremap as a safe bet, but architectures can override this with less 272 * strict semantics if possible. 273 */ 274 #ifndef pgprot_dmacoherent 275 #define pgprot_dmacoherent(prot) pgprot_noncached(prot) 276 #endif 277 278 pgprot_t dma_pgprot(struct device *dev, pgprot_t prot, unsigned long attrs); 279 #else 280 static inline pgprot_t dma_pgprot(struct device *dev, pgprot_t prot, 281 unsigned long attrs) 282 { 283 return prot; /* no protection bits supported without page tables */ 284 } 285 #endif /* CONFIG_MMU */ 286 287 #ifdef CONFIG_ARCH_HAS_SYNC_DMA_FOR_DEVICE 288 void arch_sync_dma_for_device(phys_addr_t paddr, size_t size, 289 enum dma_data_direction dir); 290 #else 291 static inline void arch_sync_dma_for_device(phys_addr_t paddr, size_t size, 292 enum dma_data_direction dir) 293 { 294 } 295 #endif /* ARCH_HAS_SYNC_DMA_FOR_DEVICE */ 296 297 #ifdef CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU 298 void arch_sync_dma_for_cpu(phys_addr_t paddr, size_t size, 299 enum dma_data_direction dir); 300 #else 301 static inline void arch_sync_dma_for_cpu(phys_addr_t paddr, size_t size, 302 enum dma_data_direction dir) 303 { 304 } 305 #endif /* ARCH_HAS_SYNC_DMA_FOR_CPU */ 306 307 #ifdef CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU_ALL 308 void arch_sync_dma_for_cpu_all(void); 309 #else 310 static inline void arch_sync_dma_for_cpu_all(void) 311 { 312 } 313 #endif /* CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU_ALL */ 314 315 #ifdef CONFIG_ARCH_HAS_DMA_PREP_COHERENT 316 void arch_dma_prep_coherent(struct page *page, size_t size); 317 #else 318 static inline void arch_dma_prep_coherent(struct page *page, size_t size) 319 { 320 } 321 #endif /* CONFIG_ARCH_HAS_DMA_PREP_COHERENT */ 322 323 #ifdef CONFIG_ARCH_HAS_DMA_MARK_CLEAN 324 void arch_dma_mark_clean(phys_addr_t paddr, size_t size); 325 #else 326 static inline void arch_dma_mark_clean(phys_addr_t paddr, size_t size) 327 { 328 } 329 #endif /* ARCH_HAS_DMA_MARK_CLEAN */ 330 331 void *arch_dma_set_uncached(void *addr, size_t size); 332 void arch_dma_clear_uncached(void *addr, size_t size); 333 334 #ifdef CONFIG_ARCH_HAS_DMA_MAP_DIRECT 335 bool arch_dma_map_page_direct(struct device *dev, phys_addr_t addr); 336 bool arch_dma_unmap_page_direct(struct device *dev, dma_addr_t dma_handle); 337 bool arch_dma_map_sg_direct(struct device *dev, struct scatterlist *sg, 338 int nents); 339 bool arch_dma_unmap_sg_direct(struct device *dev, struct scatterlist *sg, 340 int nents); 341 #else 342 #define arch_dma_map_page_direct(d, a) (false) 343 #define arch_dma_unmap_page_direct(d, a) (false) 344 #define arch_dma_map_sg_direct(d, s, n) (false) 345 #define arch_dma_unmap_sg_direct(d, s, n) (false) 346 #endif 347 348 #ifdef CONFIG_ARCH_HAS_SETUP_DMA_OPS 349 void arch_setup_dma_ops(struct device *dev, u64 dma_base, u64 size, 350 const struct iommu_ops *iommu, bool coherent); 351 #else 352 static inline void arch_setup_dma_ops(struct device *dev, u64 dma_base, 353 u64 size, const struct iommu_ops *iommu, bool coherent) 354 { 355 } 356 #endif /* CONFIG_ARCH_HAS_SETUP_DMA_OPS */ 357 358 #ifdef CONFIG_ARCH_HAS_TEARDOWN_DMA_OPS 359 void arch_teardown_dma_ops(struct device *dev); 360 #else 361 static inline void arch_teardown_dma_ops(struct device *dev) 362 { 363 } 364 #endif /* CONFIG_ARCH_HAS_TEARDOWN_DMA_OPS */ 365 366 #ifdef CONFIG_DMA_API_DEBUG 367 void dma_debug_add_bus(struct bus_type *bus); 368 void debug_dma_dump_mappings(struct device *dev); 369 #else 370 static inline void dma_debug_add_bus(struct bus_type *bus) 371 { 372 } 373 static inline void debug_dma_dump_mappings(struct device *dev) 374 { 375 } 376 #endif /* CONFIG_DMA_API_DEBUG */ 377 378 extern const struct dma_map_ops dma_dummy_ops; 379 380 #endif /* _LINUX_DMA_MAP_OPS_H */ 381