]>
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> |
76582d0a | 23 | #include <linux/types.h> |
74315ccc | 24 | |
4a77a6cf JR |
25 | #define IOMMU_READ (1) |
26 | #define IOMMU_WRITE (2) | |
9cf06697 | 27 | #define IOMMU_CACHE (4) /* DMA cache coherency */ |
4a77a6cf | 28 | |
905d66c1 | 29 | struct iommu_ops; |
d72e31c9 | 30 | struct iommu_group; |
ff21776d | 31 | struct bus_type; |
4a77a6cf | 32 | struct device; |
4f3f8d9d | 33 | struct iommu_domain; |
ba1eabfa | 34 | struct notifier_block; |
4f3f8d9d OBC |
35 | |
36 | /* iommu fault flags */ | |
37 | #define IOMMU_FAULT_READ 0x0 | |
38 | #define IOMMU_FAULT_WRITE 0x1 | |
39 | ||
40 | typedef int (*iommu_fault_handler_t)(struct iommu_domain *, | |
77ca2332 | 41 | struct device *, unsigned long, int, void *); |
4a77a6cf | 42 | |
0ff64f80 JR |
43 | struct iommu_domain_geometry { |
44 | dma_addr_t aperture_start; /* First address that can be mapped */ | |
45 | dma_addr_t aperture_end; /* Last address that can be mapped */ | |
46 | bool force_aperture; /* DMA only allowed in mappable range? */ | |
47 | }; | |
48 | ||
4a77a6cf | 49 | struct iommu_domain { |
905d66c1 | 50 | struct iommu_ops *ops; |
4a77a6cf | 51 | void *priv; |
4f3f8d9d | 52 | iommu_fault_handler_t handler; |
77ca2332 | 53 | void *handler_token; |
0ff64f80 | 54 | struct iommu_domain_geometry geometry; |
4a77a6cf JR |
55 | }; |
56 | ||
dbb9fd86 | 57 | #define IOMMU_CAP_CACHE_COHERENCY 0x1 |
323f99cb | 58 | #define IOMMU_CAP_INTR_REMAP 0x2 /* isolates device intrs */ |
dbb9fd86 | 59 | |
0cd76dd1 JR |
60 | enum iommu_attr { |
61 | DOMAIN_ATTR_MAX, | |
0ff64f80 | 62 | DOMAIN_ATTR_GEOMETRY, |
0cd76dd1 JR |
63 | }; |
64 | ||
39d4ebb9 JR |
65 | #ifdef CONFIG_IOMMU_API |
66 | ||
7d3002cc OBC |
67 | /** |
68 | * struct iommu_ops - iommu ops and capabilities | |
69 | * @domain_init: init iommu domain | |
70 | * @domain_destroy: destroy iommu domain | |
71 | * @attach_dev: attach device to an iommu domain | |
72 | * @detach_dev: detach device from an iommu domain | |
73 | * @map: map a physically contiguous memory region to an iommu domain | |
74 | * @unmap: unmap a physically contiguous memory region from an iommu domain | |
75 | * @iova_to_phys: translate iova to physical address | |
76 | * @domain_has_cap: domain capabilities query | |
d72e31c9 AW |
77 | * @add_device: add device to iommu grouping |
78 | * @remove_device: remove device from iommu grouping | |
0cd76dd1 JR |
79 | * @domain_get_attr: Query domain attributes |
80 | * @domain_set_attr: Change domain attributes | |
7d3002cc OBC |
81 | * @pgsize_bitmap: bitmap of supported page sizes |
82 | */ | |
4a77a6cf JR |
83 | struct iommu_ops { |
84 | int (*domain_init)(struct iommu_domain *domain); | |
85 | void (*domain_destroy)(struct iommu_domain *domain); | |
86 | int (*attach_dev)(struct iommu_domain *domain, struct device *dev); | |
87 | void (*detach_dev)(struct iommu_domain *domain, struct device *dev); | |
67651786 | 88 | int (*map)(struct iommu_domain *domain, unsigned long iova, |
5009065d OBC |
89 | phys_addr_t paddr, size_t size, int prot); |
90 | size_t (*unmap)(struct iommu_domain *domain, unsigned long iova, | |
91 | size_t size); | |
4a77a6cf JR |
92 | phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, |
93 | unsigned long iova); | |
dbb9fd86 SY |
94 | int (*domain_has_cap)(struct iommu_domain *domain, |
95 | unsigned long cap); | |
d72e31c9 AW |
96 | int (*add_device)(struct device *dev); |
97 | void (*remove_device)(struct device *dev); | |
1460432c | 98 | int (*device_group)(struct device *dev, unsigned int *groupid); |
0cd76dd1 JR |
99 | int (*domain_get_attr)(struct iommu_domain *domain, |
100 | enum iommu_attr attr, void *data); | |
101 | int (*domain_set_attr)(struct iommu_domain *domain, | |
102 | enum iommu_attr attr, void *data); | |
7d3002cc | 103 | unsigned long pgsize_bitmap; |
4a77a6cf JR |
104 | }; |
105 | ||
d72e31c9 AW |
106 | #define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */ |
107 | #define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */ | |
108 | #define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */ | |
109 | #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */ | |
110 | #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */ | |
111 | #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */ | |
112 | ||
ff21776d | 113 | extern int bus_set_iommu(struct bus_type *bus, struct iommu_ops *ops); |
a1b60c1c | 114 | extern bool iommu_present(struct bus_type *bus); |
905d66c1 | 115 | extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus); |
4a77a6cf JR |
116 | extern void iommu_domain_free(struct iommu_domain *domain); |
117 | extern int iommu_attach_device(struct iommu_domain *domain, | |
118 | struct device *dev); | |
119 | extern void iommu_detach_device(struct iommu_domain *domain, | |
120 | struct device *dev); | |
cefc53c7 | 121 | extern int iommu_map(struct iommu_domain *domain, unsigned long iova, |
7d3002cc OBC |
122 | phys_addr_t paddr, size_t size, int prot); |
123 | extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova, | |
124 | size_t size); | |
4a77a6cf JR |
125 | extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, |
126 | unsigned long iova); | |
dbb9fd86 SY |
127 | extern int iommu_domain_has_cap(struct iommu_domain *domain, |
128 | unsigned long cap); | |
4f3f8d9d | 129 | extern void iommu_set_fault_handler(struct iommu_domain *domain, |
77ca2332 | 130 | iommu_fault_handler_t handler, void *token); |
d72e31c9 AW |
131 | |
132 | extern int iommu_attach_group(struct iommu_domain *domain, | |
133 | struct iommu_group *group); | |
134 | extern void iommu_detach_group(struct iommu_domain *domain, | |
135 | struct iommu_group *group); | |
136 | extern struct iommu_group *iommu_group_alloc(void); | |
137 | extern void *iommu_group_get_iommudata(struct iommu_group *group); | |
138 | extern void iommu_group_set_iommudata(struct iommu_group *group, | |
139 | void *iommu_data, | |
140 | void (*release)(void *iommu_data)); | |
141 | extern int iommu_group_set_name(struct iommu_group *group, const char *name); | |
142 | extern int iommu_group_add_device(struct iommu_group *group, | |
143 | struct device *dev); | |
144 | extern void iommu_group_remove_device(struct device *dev); | |
145 | extern int iommu_group_for_each_dev(struct iommu_group *group, void *data, | |
146 | int (*fn)(struct device *, void *)); | |
147 | extern struct iommu_group *iommu_group_get(struct device *dev); | |
148 | extern void iommu_group_put(struct iommu_group *group); | |
149 | extern int iommu_group_register_notifier(struct iommu_group *group, | |
150 | struct notifier_block *nb); | |
151 | extern int iommu_group_unregister_notifier(struct iommu_group *group, | |
152 | struct notifier_block *nb); | |
153 | extern int iommu_group_id(struct iommu_group *group); | |
4f3f8d9d | 154 | |
0cd76dd1 JR |
155 | extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr, |
156 | void *data); | |
157 | extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr, | |
158 | void *data); | |
4f3f8d9d OBC |
159 | |
160 | /** | |
161 | * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework | |
162 | * @domain: the iommu domain where the fault has happened | |
163 | * @dev: the device where the fault has happened | |
164 | * @iova: the faulting address | |
165 | * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...) | |
166 | * | |
167 | * This function should be called by the low-level IOMMU implementations | |
168 | * whenever IOMMU faults happen, to allow high-level users, that are | |
169 | * interested in such events, to know about them. | |
170 | * | |
171 | * This event may be useful for several possible use cases: | |
172 | * - mere logging of the event | |
173 | * - dynamic TLB/PTE loading | |
174 | * - if restarting of the faulting device is required | |
175 | * | |
176 | * Returns 0 on success and an appropriate error code otherwise (if dynamic | |
177 | * PTE/TLB loading will one day be supported, implementations will be able | |
178 | * to tell whether it succeeded or not according to this return value). | |
0ed6d2d2 OBC |
179 | * |
180 | * Specifically, -ENOSYS is returned if a fault handler isn't installed | |
181 | * (though fault handlers can also return -ENOSYS, in case they want to | |
182 | * elicit the default behavior of the IOMMU drivers). | |
4f3f8d9d OBC |
183 | */ |
184 | static inline int report_iommu_fault(struct iommu_domain *domain, | |
185 | struct device *dev, unsigned long iova, int flags) | |
186 | { | |
0ed6d2d2 | 187 | int ret = -ENOSYS; |
4a77a6cf | 188 | |
4f3f8d9d OBC |
189 | /* |
190 | * if upper layers showed interest and installed a fault handler, | |
191 | * invoke it. | |
192 | */ | |
193 | if (domain->handler) | |
77ca2332 OBC |
194 | ret = domain->handler(domain, dev, iova, flags, |
195 | domain->handler_token); | |
4a77a6cf | 196 | |
4f3f8d9d | 197 | return ret; |
4a77a6cf JR |
198 | } |
199 | ||
4a77a6cf JR |
200 | #else /* CONFIG_IOMMU_API */ |
201 | ||
39d4ebb9 | 202 | struct iommu_ops {}; |
d72e31c9 | 203 | struct iommu_group {}; |
4a77a6cf | 204 | |
a1b60c1c | 205 | static inline bool iommu_present(struct bus_type *bus) |
4a77a6cf JR |
206 | { |
207 | return false; | |
208 | } | |
209 | ||
905d66c1 | 210 | static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus) |
4a77a6cf JR |
211 | { |
212 | return NULL; | |
213 | } | |
214 | ||
215 | static inline void iommu_domain_free(struct iommu_domain *domain) | |
216 | { | |
217 | } | |
218 | ||
219 | static inline int iommu_attach_device(struct iommu_domain *domain, | |
220 | struct device *dev) | |
221 | { | |
222 | return -ENODEV; | |
223 | } | |
224 | ||
225 | static inline void iommu_detach_device(struct iommu_domain *domain, | |
226 | struct device *dev) | |
227 | { | |
228 | } | |
229 | ||
cefc53c7 JR |
230 | static inline int iommu_map(struct iommu_domain *domain, unsigned long iova, |
231 | phys_addr_t paddr, int gfp_order, int prot) | |
232 | { | |
233 | return -ENODEV; | |
234 | } | |
235 | ||
236 | static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova, | |
237 | int gfp_order) | |
238 | { | |
239 | return -ENODEV; | |
240 | } | |
241 | ||
4a77a6cf JR |
242 | static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, |
243 | unsigned long iova) | |
244 | { | |
245 | return 0; | |
246 | } | |
247 | ||
dbb9fd86 SY |
248 | static inline int domain_has_cap(struct iommu_domain *domain, |
249 | unsigned long cap) | |
250 | { | |
251 | return 0; | |
252 | } | |
253 | ||
4f3f8d9d | 254 | static inline void iommu_set_fault_handler(struct iommu_domain *domain, |
77ca2332 | 255 | iommu_fault_handler_t handler, void *token) |
4f3f8d9d OBC |
256 | { |
257 | } | |
258 | ||
d72e31c9 AW |
259 | int iommu_attach_group(struct iommu_domain *domain, struct iommu_group *group) |
260 | { | |
261 | return -ENODEV; | |
262 | } | |
263 | ||
264 | void iommu_detach_group(struct iommu_domain *domain, struct iommu_group *group) | |
265 | { | |
266 | } | |
267 | ||
268 | struct iommu_group *iommu_group_alloc(void) | |
269 | { | |
270 | return ERR_PTR(-ENODEV); | |
271 | } | |
272 | ||
273 | void *iommu_group_get_iommudata(struct iommu_group *group) | |
274 | { | |
275 | return NULL; | |
276 | } | |
277 | ||
278 | void iommu_group_set_iommudata(struct iommu_group *group, void *iommu_data, | |
279 | void (*release)(void *iommu_data)) | |
280 | { | |
281 | } | |
282 | ||
283 | int iommu_group_set_name(struct iommu_group *group, const char *name) | |
284 | { | |
285 | return -ENODEV; | |
286 | } | |
287 | ||
288 | int iommu_group_add_device(struct iommu_group *group, struct device *dev) | |
289 | { | |
290 | return -ENODEV; | |
291 | } | |
292 | ||
293 | void iommu_group_remove_device(struct device *dev) | |
294 | { | |
295 | } | |
296 | ||
297 | int iommu_group_for_each_dev(struct iommu_group *group, void *data, | |
298 | int (*fn)(struct device *, void *)) | |
299 | { | |
300 | return -ENODEV; | |
301 | } | |
302 | ||
303 | struct iommu_group *iommu_group_get(struct device *dev) | |
304 | { | |
305 | return NULL; | |
306 | } | |
307 | ||
308 | void iommu_group_put(struct iommu_group *group) | |
309 | { | |
310 | } | |
311 | ||
312 | int iommu_group_register_notifier(struct iommu_group *group, | |
313 | struct notifier_block *nb) | |
1460432c AW |
314 | { |
315 | return -ENODEV; | |
316 | } | |
317 | ||
d72e31c9 AW |
318 | int iommu_group_unregister_notifier(struct iommu_group *group, |
319 | struct notifier_block *nb) | |
320 | { | |
321 | return 0; | |
322 | } | |
323 | ||
324 | int iommu_group_id(struct iommu_group *group) | |
325 | { | |
326 | return -ENODEV; | |
327 | } | |
1460432c | 328 | |
0cd76dd1 JR |
329 | static inline int iommu_domain_get_attr(struct iommu_domain *domain, |
330 | enum iommu_attr attr, void *data) | |
331 | { | |
332 | return -EINVAL; | |
333 | } | |
334 | ||
335 | static inline int iommu_domain_set_attr(struct iommu_domain *domain, | |
336 | enum iommu_attr attr, void *data) | |
337 | { | |
338 | return -EINVAL; | |
339 | } | |
340 | ||
4a77a6cf JR |
341 | #endif /* CONFIG_IOMMU_API */ |
342 | ||
343 | #endif /* __LINUX_IOMMU_H */ |