xref: /linux-6.15/include/linux/swiotlb.h (revision aff985fd)
1 #ifndef __LINUX_SWIOTLB_H
2 #define __LINUX_SWIOTLB_H
3 
4 #include <linux/dma-direction.h>
5 #include <linux/init.h>
6 #include <linux/types.h>
7 
8 struct device;
9 struct page;
10 struct scatterlist;
11 
12 extern int swiotlb_force;
13 
14 /*
15  * Maximum allowable number of contiguous slabs to map,
16  * must be a power of 2.  What is the appropriate value ?
17  * The complexity of {map,unmap}_single is linearly dependent on this value.
18  */
19 #define IO_TLB_SEGSIZE	128
20 
21 /*
22  * log of the size of each IO TLB slab.  The number of slabs is command line
23  * controllable.
24  */
25 #define IO_TLB_SHIFT 11
26 
27 extern void swiotlb_init(int verbose);
28 int swiotlb_init_with_tbl(char *tlb, unsigned long nslabs, int verbose);
29 extern unsigned long swiotlb_nr_tbl(void);
30 unsigned long swiotlb_size_or_default(void);
31 extern int swiotlb_late_init_with_tbl(char *tlb, unsigned long nslabs);
32 
33 /*
34  * Enumeration for sync targets
35  */
36 enum dma_sync_target {
37 	SYNC_FOR_CPU = 0,
38 	SYNC_FOR_DEVICE = 1,
39 };
40 
41 /* define the last possible byte of physical address space as a mapping error */
42 #define SWIOTLB_MAP_ERROR (~(phys_addr_t)0x0)
43 
44 extern phys_addr_t swiotlb_tbl_map_single(struct device *hwdev,
45 					  dma_addr_t tbl_dma_addr,
46 					  phys_addr_t phys, size_t size,
47 					  enum dma_data_direction dir,
48 					  unsigned long attrs);
49 
50 extern void swiotlb_tbl_unmap_single(struct device *hwdev,
51 				     phys_addr_t tlb_addr,
52 				     size_t size, enum dma_data_direction dir,
53 				     unsigned long attrs);
54 
55 extern void swiotlb_tbl_sync_single(struct device *hwdev,
56 				    phys_addr_t tlb_addr,
57 				    size_t size, enum dma_data_direction dir,
58 				    enum dma_sync_target target);
59 
60 /* Accessory functions. */
61 extern void
62 *swiotlb_alloc_coherent(struct device *hwdev, size_t size,
63 			dma_addr_t *dma_handle, gfp_t flags);
64 
65 extern void
66 swiotlb_free_coherent(struct device *hwdev, size_t size,
67 		      void *vaddr, dma_addr_t dma_handle);
68 
69 extern dma_addr_t swiotlb_map_page(struct device *dev, struct page *page,
70 				   unsigned long offset, size_t size,
71 				   enum dma_data_direction dir,
72 				   unsigned long attrs);
73 extern void swiotlb_unmap_page(struct device *hwdev, dma_addr_t dev_addr,
74 			       size_t size, enum dma_data_direction dir,
75 			       unsigned long attrs);
76 
77 extern int
78 swiotlb_map_sg_attrs(struct device *hwdev, struct scatterlist *sgl, int nelems,
79 		     enum dma_data_direction dir,
80 		     unsigned long attrs);
81 
82 extern void
83 swiotlb_unmap_sg_attrs(struct device *hwdev, struct scatterlist *sgl,
84 		       int nelems, enum dma_data_direction dir,
85 		       unsigned long attrs);
86 
87 extern void
88 swiotlb_sync_single_for_cpu(struct device *hwdev, dma_addr_t dev_addr,
89 			    size_t size, enum dma_data_direction dir);
90 
91 extern void
92 swiotlb_sync_sg_for_cpu(struct device *hwdev, struct scatterlist *sg,
93 			int nelems, enum dma_data_direction dir);
94 
95 extern void
96 swiotlb_sync_single_for_device(struct device *hwdev, dma_addr_t dev_addr,
97 			       size_t size, enum dma_data_direction dir);
98 
99 extern void
100 swiotlb_sync_sg_for_device(struct device *hwdev, struct scatterlist *sg,
101 			   int nelems, enum dma_data_direction dir);
102 
103 extern int
104 swiotlb_dma_mapping_error(struct device *hwdev, dma_addr_t dma_addr);
105 
106 extern int
107 swiotlb_dma_supported(struct device *hwdev, u64 mask);
108 
109 #ifdef CONFIG_SWIOTLB
110 extern void __init swiotlb_free(void);
111 #else
112 static inline void swiotlb_free(void) { }
113 #endif
114 
115 extern void swiotlb_print_info(void);
116 extern int is_swiotlb_buffer(phys_addr_t paddr);
117 
118 #endif /* __LINUX_SWIOTLB_H */
119