Commit | Line | Data |
---|---|---|
4a77a6cf JR |
1 | /* |
2 | * Copyright (C) 2007-2008 Advanced Micro Devices, Inc. | |
3 | * Author: Joerg Roedel <joerg.roedel@amd.com> | |
4 | * | |
5 | * This program is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU General Public License version 2 as published | |
7 | * by the Free Software Foundation. | |
8 | * | |
9 | * This program is distributed in the hope that it will be useful, | |
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
12 | * GNU General Public License for more details. | |
13 | * | |
14 | * You should have received a copy of the GNU General Public License | |
15 | * along with this program; if not, write to the Free Software | |
16 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
17 | */ | |
18 | ||
19 | #ifndef __LINUX_IOMMU_H | |
20 | #define __LINUX_IOMMU_H | |
21 | ||
74315ccc | 22 | #include <linux/errno.h> |
9a08d376 | 23 | #include <linux/err.h> |
76582d0a | 24 | #include <linux/types.h> |
56fa4849 | 25 | #include <trace/events/iommu.h> |
74315ccc | 26 | |
ca13bb3d WD |
27 | #define IOMMU_READ (1 << 0) |
28 | #define IOMMU_WRITE (1 << 1) | |
29 | #define IOMMU_CACHE (1 << 2) /* DMA cache coherency */ | |
30 | #define IOMMU_EXEC (1 << 3) | |
4a77a6cf | 31 | |
905d66c1 | 32 | struct iommu_ops; |
d72e31c9 | 33 | struct iommu_group; |
ff21776d | 34 | struct bus_type; |
4a77a6cf | 35 | struct device; |
4f3f8d9d | 36 | struct iommu_domain; |
ba1eabfa | 37 | struct notifier_block; |
4f3f8d9d OBC |
38 | |
39 | /* iommu fault flags */ | |
40 | #define IOMMU_FAULT_READ 0x0 | |
41 | #define IOMMU_FAULT_WRITE 0x1 | |
42 | ||
43 | typedef int (*iommu_fault_handler_t)(struct iommu_domain *, | |
77ca2332 | 44 | struct device *, unsigned long, int, void *); |
4a77a6cf | 45 | |
0ff64f80 JR |
46 | struct iommu_domain_geometry { |
47 | dma_addr_t aperture_start; /* First address that can be mapped */ | |
48 | dma_addr_t aperture_end; /* Last address that can be mapped */ | |
49 | bool force_aperture; /* DMA only allowed in mappable range? */ | |
50 | }; | |
51 | ||
4a77a6cf | 52 | struct iommu_domain { |
b22f6434 | 53 | const struct iommu_ops *ops; |
4a77a6cf | 54 | void *priv; |
4f3f8d9d | 55 | iommu_fault_handler_t handler; |
77ca2332 | 56 | void *handler_token; |
0ff64f80 | 57 | struct iommu_domain_geometry geometry; |
4a77a6cf JR |
58 | }; |
59 | ||
dbb9fd86 | 60 | #define IOMMU_CAP_CACHE_COHERENCY 0x1 |
323f99cb | 61 | #define IOMMU_CAP_INTR_REMAP 0x2 /* isolates device intrs */ |
dbb9fd86 | 62 | |
7cabf491 VS |
63 | /* |
64 | * Following constraints are specifc to FSL_PAMUV1: | |
65 | * -aperture must be power of 2, and naturally aligned | |
66 | * -number of windows must be power of 2, and address space size | |
67 | * of each window is determined by aperture size / # of windows | |
68 | * -the actual size of the mapped region of a window must be power | |
69 | * of 2 starting with 4KB and physical address must be naturally | |
70 | * aligned. | |
71 | * DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints. | |
72 | * The caller can invoke iommu_domain_get_attr to check if the underlying | |
73 | * iommu implementation supports these constraints. | |
74 | */ | |
75 | ||
0cd76dd1 | 76 | enum iommu_attr { |
0ff64f80 | 77 | DOMAIN_ATTR_GEOMETRY, |
d2e12160 | 78 | DOMAIN_ATTR_PAGING, |
69356712 | 79 | DOMAIN_ATTR_WINDOWS, |
7cabf491 VS |
80 | DOMAIN_ATTR_FSL_PAMU_STASH, |
81 | DOMAIN_ATTR_FSL_PAMU_ENABLE, | |
82 | DOMAIN_ATTR_FSL_PAMUV1, | |
c02607aa | 83 | DOMAIN_ATTR_NESTING, /* two stages of translation */ |
a8b8a88a | 84 | DOMAIN_ATTR_MAX, |
0cd76dd1 JR |
85 | }; |
86 | ||
39d4ebb9 JR |
87 | #ifdef CONFIG_IOMMU_API |
88 | ||
7d3002cc OBC |
89 | /** |
90 | * struct iommu_ops - iommu ops and capabilities | |
91 | * @domain_init: init iommu domain | |
92 | * @domain_destroy: destroy iommu domain | |
93 | * @attach_dev: attach device to an iommu domain | |
94 | * @detach_dev: detach device from an iommu domain | |
95 | * @map: map a physically contiguous memory region to an iommu domain | |
96 | * @unmap: unmap a physically contiguous memory region from an iommu domain | |
97 | * @iova_to_phys: translate iova to physical address | |
98 | * @domain_has_cap: domain capabilities query | |
d72e31c9 AW |
99 | * @add_device: add device to iommu grouping |
100 | * @remove_device: remove device from iommu grouping | |
0cd76dd1 JR |
101 | * @domain_get_attr: Query domain attributes |
102 | * @domain_set_attr: Change domain attributes | |
7d3002cc OBC |
103 | * @pgsize_bitmap: bitmap of supported page sizes |
104 | */ | |
4a77a6cf JR |
105 | struct iommu_ops { |
106 | int (*domain_init)(struct iommu_domain *domain); | |
107 | void (*domain_destroy)(struct iommu_domain *domain); | |
108 | int (*attach_dev)(struct iommu_domain *domain, struct device *dev); | |
109 | void (*detach_dev)(struct iommu_domain *domain, struct device *dev); | |
67651786 | 110 | int (*map)(struct iommu_domain *domain, unsigned long iova, |
5009065d OBC |
111 | phys_addr_t paddr, size_t size, int prot); |
112 | size_t (*unmap)(struct iommu_domain *domain, unsigned long iova, | |
113 | size_t size); | |
bb5547ac | 114 | phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova); |
dbb9fd86 SY |
115 | int (*domain_has_cap)(struct iommu_domain *domain, |
116 | unsigned long cap); | |
d72e31c9 AW |
117 | int (*add_device)(struct device *dev); |
118 | void (*remove_device)(struct device *dev); | |
1460432c | 119 | int (*device_group)(struct device *dev, unsigned int *groupid); |
0cd76dd1 JR |
120 | int (*domain_get_attr)(struct iommu_domain *domain, |
121 | enum iommu_attr attr, void *data); | |
122 | int (*domain_set_attr)(struct iommu_domain *domain, | |
123 | enum iommu_attr attr, void *data); | |
d7787d57 JR |
124 | |
125 | /* Window handling functions */ | |
126 | int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr, | |
80f97f0f | 127 | phys_addr_t paddr, u64 size, int prot); |
d7787d57 | 128 | void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr); |
69356712 JR |
129 | /* Set the numer of window per domain */ |
130 | int (*domain_set_windows)(struct iommu_domain *domain, u32 w_count); | |
131 | /* Get the numer of window per domain */ | |
132 | u32 (*domain_get_windows)(struct iommu_domain *domain); | |
d7787d57 | 133 | |
7d3002cc | 134 | unsigned long pgsize_bitmap; |
4a77a6cf JR |
135 | }; |
136 | ||
d72e31c9 AW |
137 | #define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */ |
138 | #define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */ | |
139 | #define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */ | |
140 | #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */ | |
141 | #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */ | |
142 | #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */ | |
143 | ||
b22f6434 | 144 | extern int bus_set_iommu(struct bus_type *bus, const struct iommu_ops *ops); |
a1b60c1c | 145 | extern bool iommu_present(struct bus_type *bus); |
905d66c1 | 146 | extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus); |
aa16bea9 | 147 | extern struct iommu_group *iommu_group_get_by_id(int id); |
4a77a6cf JR |
148 | extern void iommu_domain_free(struct iommu_domain *domain); |
149 | extern int iommu_attach_device(struct iommu_domain *domain, | |
150 | struct device *dev); | |
151 | extern void iommu_detach_device(struct iommu_domain *domain, | |
152 | struct device *dev); | |
cefc53c7 | 153 | extern int iommu_map(struct iommu_domain *domain, unsigned long iova, |
7d3002cc OBC |
154 | phys_addr_t paddr, size_t size, int prot); |
155 | extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova, | |
156 | size_t size); | |
bb5547ac | 157 | extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova); |
dbb9fd86 SY |
158 | extern int iommu_domain_has_cap(struct iommu_domain *domain, |
159 | unsigned long cap); | |
4f3f8d9d | 160 | extern void iommu_set_fault_handler(struct iommu_domain *domain, |
77ca2332 | 161 | iommu_fault_handler_t handler, void *token); |
d72e31c9 AW |
162 | |
163 | extern int iommu_attach_group(struct iommu_domain *domain, | |
164 | struct iommu_group *group); | |
165 | extern void iommu_detach_group(struct iommu_domain *domain, | |
166 | struct iommu_group *group); | |
167 | extern struct iommu_group *iommu_group_alloc(void); | |
168 | extern void *iommu_group_get_iommudata(struct iommu_group *group); | |
169 | extern void iommu_group_set_iommudata(struct iommu_group *group, | |
170 | void *iommu_data, | |
171 | void (*release)(void *iommu_data)); | |
172 | extern int iommu_group_set_name(struct iommu_group *group, const char *name); | |
173 | extern int iommu_group_add_device(struct iommu_group *group, | |
174 | struct device *dev); | |
175 | extern void iommu_group_remove_device(struct device *dev); | |
176 | extern int iommu_group_for_each_dev(struct iommu_group *group, void *data, | |
177 | int (*fn)(struct device *, void *)); | |
178 | extern struct iommu_group *iommu_group_get(struct device *dev); | |
179 | extern void iommu_group_put(struct iommu_group *group); | |
180 | extern int iommu_group_register_notifier(struct iommu_group *group, | |
181 | struct notifier_block *nb); | |
182 | extern int iommu_group_unregister_notifier(struct iommu_group *group, | |
183 | struct notifier_block *nb); | |
184 | extern int iommu_group_id(struct iommu_group *group); | |
104a1c13 | 185 | extern struct iommu_group *iommu_group_get_for_dev(struct device *dev); |
4f3f8d9d | 186 | |
0cd76dd1 JR |
187 | extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr, |
188 | void *data); | |
189 | extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr, | |
190 | void *data); | |
c61959ec AW |
191 | struct device *iommu_device_create(struct device *parent, void *drvdata, |
192 | const struct attribute_group **groups, | |
193 | const char *fmt, ...); | |
194 | void iommu_device_destroy(struct device *dev); | |
195 | int iommu_device_link(struct device *dev, struct device *link); | |
196 | void iommu_device_unlink(struct device *dev, struct device *link); | |
4f3f8d9d | 197 | |
d7787d57 JR |
198 | /* Window handling function prototypes */ |
199 | extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr, | |
80f97f0f VS |
200 | phys_addr_t offset, u64 size, |
201 | int prot); | |
d7787d57 | 202 | extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr); |
4f3f8d9d OBC |
203 | /** |
204 | * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework | |
205 | * @domain: the iommu domain where the fault has happened | |
206 | * @dev: the device where the fault has happened | |
207 | * @iova: the faulting address | |
208 | * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...) | |
209 | * | |
210 | * This function should be called by the low-level IOMMU implementations | |
211 | * whenever IOMMU faults happen, to allow high-level users, that are | |
212 | * interested in such events, to know about them. | |
213 | * | |
214 | * This event may be useful for several possible use cases: | |
215 | * - mere logging of the event | |
216 | * - dynamic TLB/PTE loading | |
217 | * - if restarting of the faulting device is required | |
218 | * | |
219 | * Returns 0 on success and an appropriate error code otherwise (if dynamic | |
220 | * PTE/TLB loading will one day be supported, implementations will be able | |
221 | * to tell whether it succeeded or not according to this return value). | |
0ed6d2d2 OBC |
222 | * |
223 | * Specifically, -ENOSYS is returned if a fault handler isn't installed | |
224 | * (though fault handlers can also return -ENOSYS, in case they want to | |
225 | * elicit the default behavior of the IOMMU drivers). | |
4f3f8d9d OBC |
226 | */ |
227 | static inline int report_iommu_fault(struct iommu_domain *domain, | |
228 | struct device *dev, unsigned long iova, int flags) | |
229 | { | |
0ed6d2d2 | 230 | int ret = -ENOSYS; |
4a77a6cf | 231 | |
4f3f8d9d OBC |
232 | /* |
233 | * if upper layers showed interest and installed a fault handler, | |
234 | * invoke it. | |
235 | */ | |
236 | if (domain->handler) | |
77ca2332 OBC |
237 | ret = domain->handler(domain, dev, iova, flags, |
238 | domain->handler_token); | |
4a77a6cf | 239 | |
56fa4849 | 240 | trace_io_page_fault(dev, iova, flags); |
4f3f8d9d | 241 | return ret; |
4a77a6cf JR |
242 | } |
243 | ||
4a77a6cf JR |
244 | #else /* CONFIG_IOMMU_API */ |
245 | ||
39d4ebb9 | 246 | struct iommu_ops {}; |
d72e31c9 | 247 | struct iommu_group {}; |
4a77a6cf | 248 | |
a1b60c1c | 249 | static inline bool iommu_present(struct bus_type *bus) |
4a77a6cf JR |
250 | { |
251 | return false; | |
252 | } | |
253 | ||
905d66c1 | 254 | static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus) |
4a77a6cf JR |
255 | { |
256 | return NULL; | |
257 | } | |
258 | ||
b62dfd29 AK |
259 | static inline struct iommu_group *iommu_group_get_by_id(int id) |
260 | { | |
261 | return NULL; | |
262 | } | |
263 | ||
4a77a6cf JR |
264 | static inline void iommu_domain_free(struct iommu_domain *domain) |
265 | { | |
266 | } | |
267 | ||
268 | static inline int iommu_attach_device(struct iommu_domain *domain, | |
269 | struct device *dev) | |
270 | { | |
271 | return -ENODEV; | |
272 | } | |
273 | ||
274 | static inline void iommu_detach_device(struct iommu_domain *domain, | |
275 | struct device *dev) | |
276 | { | |
277 | } | |
278 | ||
cefc53c7 JR |
279 | static inline int iommu_map(struct iommu_domain *domain, unsigned long iova, |
280 | phys_addr_t paddr, int gfp_order, int prot) | |
281 | { | |
282 | return -ENODEV; | |
283 | } | |
284 | ||
285 | static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova, | |
286 | int gfp_order) | |
287 | { | |
288 | return -ENODEV; | |
289 | } | |
290 | ||
d7787d57 JR |
291 | static inline int iommu_domain_window_enable(struct iommu_domain *domain, |
292 | u32 wnd_nr, phys_addr_t paddr, | |
80f97f0f | 293 | u64 size, int prot) |
d7787d57 JR |
294 | { |
295 | return -ENODEV; | |
296 | } | |
297 | ||
298 | static inline void iommu_domain_window_disable(struct iommu_domain *domain, | |
299 | u32 wnd_nr) | |
300 | { | |
301 | } | |
302 | ||
bb5547ac | 303 | static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova) |
4a77a6cf JR |
304 | { |
305 | return 0; | |
306 | } | |
307 | ||
5b5c1399 UM |
308 | static inline int iommu_domain_has_cap(struct iommu_domain *domain, |
309 | unsigned long cap) | |
dbb9fd86 SY |
310 | { |
311 | return 0; | |
312 | } | |
313 | ||
4f3f8d9d | 314 | static inline void iommu_set_fault_handler(struct iommu_domain *domain, |
77ca2332 | 315 | iommu_fault_handler_t handler, void *token) |
4f3f8d9d OBC |
316 | { |
317 | } | |
318 | ||
bef83de5 AW |
319 | static inline int iommu_attach_group(struct iommu_domain *domain, |
320 | struct iommu_group *group) | |
d72e31c9 AW |
321 | { |
322 | return -ENODEV; | |
323 | } | |
324 | ||
bef83de5 AW |
325 | static inline void iommu_detach_group(struct iommu_domain *domain, |
326 | struct iommu_group *group) | |
d72e31c9 AW |
327 | { |
328 | } | |
329 | ||
bef83de5 | 330 | static inline struct iommu_group *iommu_group_alloc(void) |
d72e31c9 AW |
331 | { |
332 | return ERR_PTR(-ENODEV); | |
333 | } | |
334 | ||
bef83de5 | 335 | static inline void *iommu_group_get_iommudata(struct iommu_group *group) |
d72e31c9 AW |
336 | { |
337 | return NULL; | |
338 | } | |
339 | ||
bef83de5 AW |
340 | static inline void iommu_group_set_iommudata(struct iommu_group *group, |
341 | void *iommu_data, | |
342 | void (*release)(void *iommu_data)) | |
d72e31c9 AW |
343 | { |
344 | } | |
345 | ||
bef83de5 AW |
346 | static inline int iommu_group_set_name(struct iommu_group *group, |
347 | const char *name) | |
d72e31c9 AW |
348 | { |
349 | return -ENODEV; | |
350 | } | |
351 | ||
bef83de5 AW |
352 | static inline int iommu_group_add_device(struct iommu_group *group, |
353 | struct device *dev) | |
d72e31c9 AW |
354 | { |
355 | return -ENODEV; | |
356 | } | |
357 | ||
bef83de5 | 358 | static inline void iommu_group_remove_device(struct device *dev) |
d72e31c9 AW |
359 | { |
360 | } | |
361 | ||
bef83de5 AW |
362 | static inline int iommu_group_for_each_dev(struct iommu_group *group, |
363 | void *data, | |
364 | int (*fn)(struct device *, void *)) | |
d72e31c9 AW |
365 | { |
366 | return -ENODEV; | |
367 | } | |
368 | ||
bef83de5 | 369 | static inline struct iommu_group *iommu_group_get(struct device *dev) |
d72e31c9 AW |
370 | { |
371 | return NULL; | |
372 | } | |
373 | ||
bef83de5 | 374 | static inline void iommu_group_put(struct iommu_group *group) |
d72e31c9 AW |
375 | { |
376 | } | |
377 | ||
bef83de5 AW |
378 | static inline int iommu_group_register_notifier(struct iommu_group *group, |
379 | struct notifier_block *nb) | |
1460432c AW |
380 | { |
381 | return -ENODEV; | |
382 | } | |
383 | ||
bef83de5 AW |
384 | static inline int iommu_group_unregister_notifier(struct iommu_group *group, |
385 | struct notifier_block *nb) | |
d72e31c9 AW |
386 | { |
387 | return 0; | |
388 | } | |
389 | ||
bef83de5 | 390 | static inline int iommu_group_id(struct iommu_group *group) |
d72e31c9 AW |
391 | { |
392 | return -ENODEV; | |
393 | } | |
1460432c | 394 | |
0cd76dd1 JR |
395 | static inline int iommu_domain_get_attr(struct iommu_domain *domain, |
396 | enum iommu_attr attr, void *data) | |
397 | { | |
398 | return -EINVAL; | |
399 | } | |
400 | ||
401 | static inline int iommu_domain_set_attr(struct iommu_domain *domain, | |
402 | enum iommu_attr attr, void *data) | |
403 | { | |
404 | return -EINVAL; | |
405 | } | |
406 | ||
e09f8ea5 AW |
407 | static inline struct device *iommu_device_create(struct device *parent, |
408 | void *drvdata, | |
409 | const struct attribute_group **groups, | |
410 | const char *fmt, ...) | |
c61959ec AW |
411 | { |
412 | return ERR_PTR(-ENODEV); | |
413 | } | |
414 | ||
e09f8ea5 | 415 | static inline void iommu_device_destroy(struct device *dev) |
c61959ec AW |
416 | { |
417 | } | |
418 | ||
e09f8ea5 | 419 | static inline int iommu_device_link(struct device *dev, struct device *link) |
c61959ec AW |
420 | { |
421 | return -EINVAL; | |
422 | } | |
423 | ||
e09f8ea5 | 424 | static inline void iommu_device_unlink(struct device *dev, struct device *link) |
c61959ec AW |
425 | { |
426 | } | |
427 | ||
4a77a6cf JR |
428 | #endif /* CONFIG_IOMMU_API */ |
429 | ||
430 | #endif /* __LINUX_IOMMU_H */ |