Commit | Line | Data |
---|---|---|
775c8a3d | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
9663f2e6 KP |
2 | /* |
3 | * Copyright © 2008 Keith Packard <keithp@keithp.com> | |
9663f2e6 KP |
4 | */ |
5 | ||
6 | #ifndef _LINUX_IO_MAPPING_H | |
7 | #define _LINUX_IO_MAPPING_H | |
8 | ||
9 | #include <linux/types.h> | |
5a0e3ad6 | 10 | #include <linux/slab.h> |
187f1882 | 11 | #include <linux/bug.h> |
2584cf83 | 12 | #include <linux/io.h> |
65fddcfc | 13 | #include <linux/pgtable.h> |
9663f2e6 | 14 | #include <asm/page.h> |
9663f2e6 KP |
15 | |
16 | /* | |
17 | * The io_mapping mechanism provides an abstraction for mapping | |
18 | * individual pages from an io device to the CPU in an efficient fashion. | |
19 | * | |
7d3d3254 | 20 | * See Documentation/driver-api/io-mapping.rst |
9663f2e6 KP |
21 | */ |
22 | ||
4ab0d47d VP |
23 | struct io_mapping { |
24 | resource_size_t base; | |
25 | unsigned long size; | |
26 | pgprot_t prot; | |
cafaf14a | 27 | void __iomem *iomem; |
4ab0d47d VP |
28 | }; |
29 | ||
cafaf14a CW |
30 | #ifdef CONFIG_HAVE_ATOMIC_IOMAP |
31 | ||
2b755626 | 32 | #include <linux/pfn.h> |
cafaf14a | 33 | #include <asm/iomap.h> |
e5beae16 KP |
34 | /* |
35 | * For small address space machines, mapping large objects | |
36 | * into the kernel virtual space isn't practical. Where | |
37 | * available, use fixmap support to dynamically map pages | |
38 | * of the object at run time. | |
39 | */ | |
9663f2e6 | 40 | |
9663f2e6 | 41 | static inline struct io_mapping * |
cafaf14a CW |
42 | io_mapping_init_wc(struct io_mapping *iomap, |
43 | resource_size_t base, | |
44 | unsigned long size) | |
9663f2e6 | 45 | { |
9e36fda0 | 46 | pgprot_t prot; |
4ab0d47d | 47 | |
9e36fda0 | 48 | if (iomap_create_wc(base, size, &prot)) |
cafaf14a | 49 | return NULL; |
4ab0d47d VP |
50 | |
51 | iomap->base = base; | |
52 | iomap->size = size; | |
9e36fda0 | 53 | iomap->prot = prot; |
4ab0d47d | 54 | return iomap; |
9663f2e6 KP |
55 | } |
56 | ||
57 | static inline void | |
cafaf14a | 58 | io_mapping_fini(struct io_mapping *mapping) |
9663f2e6 | 59 | { |
9e36fda0 | 60 | iomap_free(mapping->base, mapping->size); |
9663f2e6 KP |
61 | } |
62 | ||
63 | /* Atomic map/unmap */ | |
29bc17ec | 64 | static inline void __iomem * |
fca3ec01 | 65 | io_mapping_map_atomic_wc(struct io_mapping *mapping, |
3e4d3af5 | 66 | unsigned long offset) |
9663f2e6 | 67 | { |
4ab0d47d | 68 | resource_size_t phys_addr; |
4ab0d47d VP |
69 | |
70 | BUG_ON(offset >= mapping->size); | |
71 | phys_addr = mapping->base + offset; | |
351191ad TG |
72 | preempt_disable(); |
73 | pagefault_disable(); | |
74 | return __iomap_local_pfn_prot(PHYS_PFN(phys_addr), mapping->prot); | |
9663f2e6 KP |
75 | } |
76 | ||
77 | static inline void | |
3e4d3af5 | 78 | io_mapping_unmap_atomic(void __iomem *vaddr) |
9663f2e6 | 79 | { |
351191ad TG |
80 | kunmap_local_indexed((void __force *)vaddr); |
81 | pagefault_enable(); | |
82 | preempt_enable(); | |
9663f2e6 KP |
83 | } |
84 | ||
e66f6e09 TG |
85 | static inline void __iomem * |
86 | io_mapping_map_local_wc(struct io_mapping *mapping, unsigned long offset) | |
87 | { | |
88 | resource_size_t phys_addr; | |
89 | ||
90 | BUG_ON(offset >= mapping->size); | |
91 | phys_addr = mapping->base + offset; | |
92 | return __iomap_local_pfn_prot(PHYS_PFN(phys_addr), mapping->prot); | |
93 | } | |
94 | ||
95 | static inline void io_mapping_unmap_local(void __iomem *vaddr) | |
96 | { | |
97 | kunmap_local_indexed((void __force *)vaddr); | |
98 | } | |
99 | ||
29bc17ec | 100 | static inline void __iomem * |
d8dab00d CW |
101 | io_mapping_map_wc(struct io_mapping *mapping, |
102 | unsigned long offset, | |
103 | unsigned long size) | |
9663f2e6 | 104 | { |
5ce04e3d PV |
105 | resource_size_t phys_addr; |
106 | ||
4ab0d47d | 107 | BUG_ON(offset >= mapping->size); |
5ce04e3d PV |
108 | phys_addr = mapping->base + offset; |
109 | ||
d8dab00d | 110 | return ioremap_wc(phys_addr, size); |
9663f2e6 KP |
111 | } |
112 | ||
113 | static inline void | |
29bc17ec | 114 | io_mapping_unmap(void __iomem *vaddr) |
9663f2e6 | 115 | { |
e5beae16 | 116 | iounmap(vaddr); |
9663f2e6 KP |
117 | } |
118 | ||
e66f6e09 | 119 | #else /* HAVE_ATOMIC_IOMAP */ |
9663f2e6 | 120 | |
24dd85ff | 121 | #include <linux/uaccess.h> |
4ab0d47d | 122 | |
e5beae16 | 123 | /* Create the io_mapping object*/ |
9663f2e6 | 124 | static inline struct io_mapping * |
cafaf14a CW |
125 | io_mapping_init_wc(struct io_mapping *iomap, |
126 | resource_size_t base, | |
127 | unsigned long size) | |
128 | { | |
e0b3e0b1 MR |
129 | iomap->iomem = ioremap_wc(base, size); |
130 | if (!iomap->iomem) | |
131 | return NULL; | |
132 | ||
cafaf14a CW |
133 | iomap->base = base; |
134 | iomap->size = size; | |
35124389 DV |
135 | #if defined(pgprot_noncached_wc) /* archs can't agree on a name ... */ |
136 | iomap->prot = pgprot_noncached_wc(PAGE_KERNEL); | |
137 | #elif defined(pgprot_writecombine) | |
bcaaa0c4 | 138 | iomap->prot = pgprot_writecombine(PAGE_KERNEL); |
35124389 DV |
139 | #else |
140 | iomap->prot = pgprot_noncached(PAGE_KERNEL); | |
141 | #endif | |
cafaf14a CW |
142 | |
143 | return iomap; | |
144 | } | |
145 | ||
146 | static inline void | |
147 | io_mapping_fini(struct io_mapping *mapping) | |
148 | { | |
149 | iounmap(mapping->iomem); | |
150 | } | |
151 | ||
152 | /* Non-atomic map/unmap */ | |
153 | static inline void __iomem * | |
154 | io_mapping_map_wc(struct io_mapping *mapping, | |
155 | unsigned long offset, | |
156 | unsigned long size) | |
9663f2e6 | 157 | { |
cafaf14a | 158 | return mapping->iomem + offset; |
9663f2e6 KP |
159 | } |
160 | ||
161 | static inline void | |
cafaf14a | 162 | io_mapping_unmap(void __iomem *vaddr) |
9663f2e6 KP |
163 | { |
164 | } | |
165 | ||
166 | /* Atomic map/unmap */ | |
29bc17ec | 167 | static inline void __iomem * |
fca3ec01 | 168 | io_mapping_map_atomic_wc(struct io_mapping *mapping, |
3e4d3af5 | 169 | unsigned long offset) |
9663f2e6 | 170 | { |
2cb7c9cb | 171 | preempt_disable(); |
24dd85ff | 172 | pagefault_disable(); |
cafaf14a | 173 | return io_mapping_map_wc(mapping, offset, PAGE_SIZE); |
9663f2e6 KP |
174 | } |
175 | ||
176 | static inline void | |
3e4d3af5 | 177 | io_mapping_unmap_atomic(void __iomem *vaddr) |
9663f2e6 | 178 | { |
cafaf14a | 179 | io_mapping_unmap(vaddr); |
24dd85ff | 180 | pagefault_enable(); |
2cb7c9cb | 181 | preempt_enable(); |
9663f2e6 KP |
182 | } |
183 | ||
e66f6e09 TG |
184 | static inline void __iomem * |
185 | io_mapping_map_local_wc(struct io_mapping *mapping, unsigned long offset) | |
186 | { | |
187 | return io_mapping_map_wc(mapping, offset, PAGE_SIZE); | |
188 | } | |
189 | ||
190 | static inline void io_mapping_unmap_local(void __iomem *vaddr) | |
191 | { | |
192 | io_mapping_unmap(vaddr); | |
193 | } | |
194 | ||
195 | #endif /* !HAVE_ATOMIC_IOMAP */ | |
cafaf14a CW |
196 | |
197 | static inline struct io_mapping * | |
198 | io_mapping_create_wc(resource_size_t base, | |
199 | unsigned long size) | |
9663f2e6 | 200 | { |
cafaf14a CW |
201 | struct io_mapping *iomap; |
202 | ||
203 | iomap = kmalloc(sizeof(*iomap), GFP_KERNEL); | |
204 | if (!iomap) | |
205 | return NULL; | |
206 | ||
207 | if (!io_mapping_init_wc(iomap, base, size)) { | |
208 | kfree(iomap); | |
209 | return NULL; | |
210 | } | |
211 | ||
212 | return iomap; | |
9663f2e6 KP |
213 | } |
214 | ||
215 | static inline void | |
cafaf14a | 216 | io_mapping_free(struct io_mapping *iomap) |
9663f2e6 | 217 | { |
cafaf14a CW |
218 | io_mapping_fini(iomap); |
219 | kfree(iomap); | |
9663f2e6 | 220 | } |
e5beae16 | 221 | |
9663f2e6 | 222 | #endif /* _LINUX_IO_MAPPING_H */ |
1fbaf8fc CH |
223 | |
224 | int io_mapping_map_user(struct io_mapping *iomap, struct vm_area_struct *vma, | |
225 | unsigned long addr, unsigned long pfn, unsigned long size); |