2 * Copyright (C) 2007-2008 Advanced Micro Devices, Inc.
3 * Author: Joerg Roedel <joerg.roedel@amd.com>
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.
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.
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
19 #ifndef __LINUX_IOMMU_H
20 #define __LINUX_IOMMU_H
22 #include <linux/errno.h>
23 #include <linux/types.h>
25 #define IOMMU_READ (1)
26 #define IOMMU_WRITE (2)
27 #define IOMMU_CACHE (4) /* DMA cache coherency */
34 struct notifier_block;
36 /* iommu fault flags */
37 #define IOMMU_FAULT_READ 0x0
38 #define IOMMU_FAULT_WRITE 0x1
40 typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
41 struct device *, unsigned long, int, void *);
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? */
50 struct iommu_ops *ops;
52 iommu_fault_handler_t handler;
54 struct iommu_domain_geometry geometry;
57 #define IOMMU_CAP_CACHE_COHERENCY 0x1
58 #define IOMMU_CAP_INTR_REMAP 0x2 /* isolates device intrs */
66 #ifdef CONFIG_IOMMU_API
69 * struct iommu_ops - iommu ops and capabilities
70 * @domain_init: init iommu domain
71 * @domain_destroy: destroy iommu domain
72 * @attach_dev: attach device to an iommu domain
73 * @detach_dev: detach device from an iommu domain
74 * @map: map a physically contiguous memory region to an iommu domain
75 * @unmap: unmap a physically contiguous memory region from an iommu domain
76 * @iova_to_phys: translate iova to physical address
77 * @domain_has_cap: domain capabilities query
78 * @add_device: add device to iommu grouping
79 * @remove_device: remove device from iommu grouping
80 * @domain_get_attr: Query domain attributes
81 * @domain_set_attr: Change domain attributes
82 * @pgsize_bitmap: bitmap of supported page sizes
85 int (*domain_init)(struct iommu_domain *domain);
86 void (*domain_destroy)(struct iommu_domain *domain);
87 int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
88 void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
89 int (*map)(struct iommu_domain *domain, unsigned long iova,
90 phys_addr_t paddr, size_t size, int prot);
91 size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
93 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain,
95 int (*domain_has_cap)(struct iommu_domain *domain,
97 int (*add_device)(struct device *dev);
98 void (*remove_device)(struct device *dev);
99 int (*device_group)(struct device *dev, unsigned int *groupid);
100 int (*domain_get_attr)(struct iommu_domain *domain,
101 enum iommu_attr attr, void *data);
102 int (*domain_set_attr)(struct iommu_domain *domain,
103 enum iommu_attr attr, void *data);
105 /* Window handling functions */
106 int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr,
107 phys_addr_t paddr, u64 size);
108 void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr);
110 unsigned long pgsize_bitmap;
113 #define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
114 #define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
115 #define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
116 #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
117 #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
118 #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
120 extern int bus_set_iommu(struct bus_type *bus, struct iommu_ops *ops);
121 extern bool iommu_present(struct bus_type *bus);
122 extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
123 extern void iommu_domain_free(struct iommu_domain *domain);
124 extern int iommu_attach_device(struct iommu_domain *domain,
126 extern void iommu_detach_device(struct iommu_domain *domain,
128 extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
129 phys_addr_t paddr, size_t size, int prot);
130 extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
132 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain,
134 extern int iommu_domain_has_cap(struct iommu_domain *domain,
136 extern void iommu_set_fault_handler(struct iommu_domain *domain,
137 iommu_fault_handler_t handler, void *token);
139 extern int iommu_attach_group(struct iommu_domain *domain,
140 struct iommu_group *group);
141 extern void iommu_detach_group(struct iommu_domain *domain,
142 struct iommu_group *group);
143 extern struct iommu_group *iommu_group_alloc(void);
144 extern void *iommu_group_get_iommudata(struct iommu_group *group);
145 extern void iommu_group_set_iommudata(struct iommu_group *group,
147 void (*release)(void *iommu_data));
148 extern int iommu_group_set_name(struct iommu_group *group, const char *name);
149 extern int iommu_group_add_device(struct iommu_group *group,
151 extern void iommu_group_remove_device(struct device *dev);
152 extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
153 int (*fn)(struct device *, void *));
154 extern struct iommu_group *iommu_group_get(struct device *dev);
155 extern void iommu_group_put(struct iommu_group *group);
156 extern int iommu_group_register_notifier(struct iommu_group *group,
157 struct notifier_block *nb);
158 extern int iommu_group_unregister_notifier(struct iommu_group *group,
159 struct notifier_block *nb);
160 extern int iommu_group_id(struct iommu_group *group);
162 extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
164 extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
167 /* Window handling function prototypes */
168 extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
169 phys_addr_t offset, u64 size);
170 extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr);
172 * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
173 * @domain: the iommu domain where the fault has happened
174 * @dev: the device where the fault has happened
175 * @iova: the faulting address
176 * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
178 * This function should be called by the low-level IOMMU implementations
179 * whenever IOMMU faults happen, to allow high-level users, that are
180 * interested in such events, to know about them.
182 * This event may be useful for several possible use cases:
183 * - mere logging of the event
184 * - dynamic TLB/PTE loading
185 * - if restarting of the faulting device is required
187 * Returns 0 on success and an appropriate error code otherwise (if dynamic
188 * PTE/TLB loading will one day be supported, implementations will be able
189 * to tell whether it succeeded or not according to this return value).
191 * Specifically, -ENOSYS is returned if a fault handler isn't installed
192 * (though fault handlers can also return -ENOSYS, in case they want to
193 * elicit the default behavior of the IOMMU drivers).
195 static inline int report_iommu_fault(struct iommu_domain *domain,
196 struct device *dev, unsigned long iova, int flags)
201 * if upper layers showed interest and installed a fault handler,
205 ret = domain->handler(domain, dev, iova, flags,
206 domain->handler_token);
211 #else /* CONFIG_IOMMU_API */
214 struct iommu_group {};
216 static inline bool iommu_present(struct bus_type *bus)
221 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
226 static inline void iommu_domain_free(struct iommu_domain *domain)
230 static inline int iommu_attach_device(struct iommu_domain *domain,
236 static inline void iommu_detach_device(struct iommu_domain *domain,
241 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
242 phys_addr_t paddr, int gfp_order, int prot)
247 static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
253 static inline int iommu_domain_window_enable(struct iommu_domain *domain,
254 u32 wnd_nr, phys_addr_t paddr,
260 static inline void iommu_domain_window_disable(struct iommu_domain *domain,
265 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain,
271 static inline int domain_has_cap(struct iommu_domain *domain,
277 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
278 iommu_fault_handler_t handler, void *token)
282 static inline int iommu_attach_group(struct iommu_domain *domain,
283 struct iommu_group *group)
288 static inline void iommu_detach_group(struct iommu_domain *domain,
289 struct iommu_group *group)
293 static inline struct iommu_group *iommu_group_alloc(void)
295 return ERR_PTR(-ENODEV);
298 static inline void *iommu_group_get_iommudata(struct iommu_group *group)
303 static inline void iommu_group_set_iommudata(struct iommu_group *group,
305 void (*release)(void *iommu_data))
309 static inline int iommu_group_set_name(struct iommu_group *group,
315 static inline int iommu_group_add_device(struct iommu_group *group,
321 static inline void iommu_group_remove_device(struct device *dev)
325 static inline int iommu_group_for_each_dev(struct iommu_group *group,
327 int (*fn)(struct device *, void *))
332 static inline struct iommu_group *iommu_group_get(struct device *dev)
337 static inline void iommu_group_put(struct iommu_group *group)
341 static inline int iommu_group_register_notifier(struct iommu_group *group,
342 struct notifier_block *nb)
347 static inline int iommu_group_unregister_notifier(struct iommu_group *group,
348 struct notifier_block *nb)
353 static inline int iommu_group_id(struct iommu_group *group)
358 static inline int iommu_domain_get_attr(struct iommu_domain *domain,
359 enum iommu_attr attr, void *data)
364 static inline int iommu_domain_set_attr(struct iommu_domain *domain,
365 enum iommu_attr attr, void *data)
370 #endif /* CONFIG_IOMMU_API */
372 #endif /* __LINUX_IOMMU_H */