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