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