xref: /linux-6.15/include/linux/swiotlb.h (revision db1a8b97)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __LINUX_SWIOTLB_H
3 #define __LINUX_SWIOTLB_H
4 
5 #include <linux/dma-direction.h>
6 #include <linux/init.h>
7 #include <linux/types.h>
8 
9 struct device;
10 struct page;
11 struct scatterlist;
12 
13 enum swiotlb_force {
14 	SWIOTLB_NORMAL,		/* Default - depending on HW DMA mask etc. */
15 	SWIOTLB_FORCE,		/* swiotlb=force */
16 	SWIOTLB_NO_FORCE,	/* swiotlb=noforce */
17 };
18 
19 /*
20  * Maximum allowable number of contiguous slabs to map,
21  * must be a power of 2.  What is the appropriate value ?
22  * The complexity of {map,unmap}_single is linearly dependent on this value.
23  */
24 #define IO_TLB_SEGSIZE	128
25 
26 /*
27  * log of the size of each IO TLB slab.  The number of slabs is command line
28  * controllable.
29  */
30 #define IO_TLB_SHIFT 11
31 
32 extern void swiotlb_init(int verbose);
33 int swiotlb_init_with_tbl(char *tlb, unsigned long nslabs, int verbose);
34 extern unsigned long swiotlb_nr_tbl(void);
35 unsigned long swiotlb_size_or_default(void);
36 extern int swiotlb_late_init_with_tbl(char *tlb, unsigned long nslabs);
37 extern int swiotlb_late_init_with_default_size(size_t default_size);
38 extern void __init swiotlb_update_mem_attributes(void);
39 
40 /*
41  * Enumeration for sync targets
42  */
43 enum dma_sync_target {
44 	SYNC_FOR_CPU = 0,
45 	SYNC_FOR_DEVICE = 1,
46 };
47 
48 phys_addr_t swiotlb_tbl_map_single(struct device *hwdev, phys_addr_t phys,
49 		size_t mapping_size, size_t alloc_size,
50 		enum dma_data_direction dir, unsigned long attrs);
51 
52 extern void swiotlb_tbl_unmap_single(struct device *hwdev,
53 				     phys_addr_t tlb_addr,
54 				     size_t mapping_size,
55 				     size_t alloc_size,
56 				     enum dma_data_direction dir,
57 				     unsigned long attrs);
58 
59 extern void swiotlb_tbl_sync_single(struct device *hwdev,
60 				    phys_addr_t tlb_addr,
61 				    size_t size, enum dma_data_direction dir,
62 				    enum dma_sync_target target);
63 
64 dma_addr_t swiotlb_map(struct device *dev, phys_addr_t phys,
65 		size_t size, enum dma_data_direction dir, unsigned long attrs);
66 
67 #ifdef CONFIG_SWIOTLB
68 extern enum swiotlb_force swiotlb_force;
69 extern phys_addr_t io_tlb_start, io_tlb_end;
70 
71 static inline bool is_swiotlb_buffer(phys_addr_t paddr)
72 {
73 	return paddr >= io_tlb_start && paddr < io_tlb_end;
74 }
75 
76 void __init swiotlb_exit(void);
77 unsigned int swiotlb_max_segment(void);
78 size_t swiotlb_max_mapping_size(struct device *dev);
79 bool is_swiotlb_active(void);
80 #else
81 #define swiotlb_force SWIOTLB_NO_FORCE
82 static inline bool is_swiotlb_buffer(phys_addr_t paddr)
83 {
84 	return false;
85 }
86 static inline void swiotlb_exit(void)
87 {
88 }
89 static inline unsigned int swiotlb_max_segment(void)
90 {
91 	return 0;
92 }
93 static inline size_t swiotlb_max_mapping_size(struct device *dev)
94 {
95 	return SIZE_MAX;
96 }
97 
98 static inline bool is_swiotlb_active(void)
99 {
100 	return false;
101 }
102 #endif /* CONFIG_SWIOTLB */
103 
104 extern void swiotlb_print_info(void);
105 extern void swiotlb_set_max_segment(unsigned int);
106 
107 #endif /* __LINUX_SWIOTLB_H */
108