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/err.h>
24 #include <linux/types.h>
25 #include <linux/scatterlist.h>
26 #include <trace/events/iommu.h>
28 #define IOMMU_READ (1 << 0)
29 #define IOMMU_WRITE (1 << 1)
30 #define IOMMU_CACHE (1 << 2) /* DMA cache coherency */
31 #define IOMMU_EXEC (1 << 3)
38 struct notifier_block;
40 /* iommu fault flags */
41 #define IOMMU_FAULT_READ 0x0
42 #define IOMMU_FAULT_WRITE 0x1
44 typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
45 struct device *, unsigned long, int, void *);
47 struct iommu_domain_geometry {
48 dma_addr_t aperture_start; /* First address that can be mapped */
49 dma_addr_t aperture_end; /* Last address that can be mapped */
50 bool force_aperture; /* DMA only allowed in mappable range? */
54 const struct iommu_ops *ops;
56 iommu_fault_handler_t handler;
58 struct iommu_domain_geometry geometry;
62 IOMMU_CAP_CACHE_COHERENCY, /* IOMMU can enforce cache coherent DMA
64 IOMMU_CAP_INTR_REMAP, /* IOMMU supports interrupt isolation */
68 * Following constraints are specifc to FSL_PAMUV1:
69 * -aperture must be power of 2, and naturally aligned
70 * -number of windows must be power of 2, and address space size
71 * of each window is determined by aperture size / # of windows
72 * -the actual size of the mapped region of a window must be power
73 * of 2 starting with 4KB and physical address must be naturally
75 * DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints.
76 * The caller can invoke iommu_domain_get_attr to check if the underlying
77 * iommu implementation supports these constraints.
84 DOMAIN_ATTR_FSL_PAMU_STASH,
85 DOMAIN_ATTR_FSL_PAMU_ENABLE,
86 DOMAIN_ATTR_FSL_PAMUV1,
87 DOMAIN_ATTR_NESTING, /* two stages of translation */
91 #ifdef CONFIG_IOMMU_API
94 * struct iommu_ops - iommu ops and capabilities
95 * @domain_init: init iommu domain
96 * @domain_destroy: destroy iommu domain
97 * @attach_dev: attach device to an iommu domain
98 * @detach_dev: detach device from an iommu domain
99 * @map: map a physically contiguous memory region to an iommu domain
100 * @unmap: unmap a physically contiguous memory region from an iommu domain
101 * @map_sg: map a scatter-gather list of physically contiguous memory chunks
103 * @iova_to_phys: translate iova to physical address
104 * @add_device: add device to iommu grouping
105 * @remove_device: remove device from iommu grouping
106 * @domain_get_attr: Query domain attributes
107 * @domain_set_attr: Change domain attributes
108 * @pgsize_bitmap: bitmap of supported page sizes
111 bool (*capable)(enum iommu_cap);
112 int (*domain_init)(struct iommu_domain *domain);
113 void (*domain_destroy)(struct iommu_domain *domain);
114 int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
115 void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
116 int (*map)(struct iommu_domain *domain, unsigned long iova,
117 phys_addr_t paddr, size_t size, int prot);
118 size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
120 size_t (*map_sg)(struct iommu_domain *domain, unsigned long iova,
121 struct scatterlist *sg, unsigned int nents, int prot);
122 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova);
123 int (*add_device)(struct device *dev);
124 void (*remove_device)(struct device *dev);
125 int (*device_group)(struct device *dev, unsigned int *groupid);
126 int (*domain_get_attr)(struct iommu_domain *domain,
127 enum iommu_attr attr, void *data);
128 int (*domain_set_attr)(struct iommu_domain *domain,
129 enum iommu_attr attr, void *data);
131 /* Window handling functions */
132 int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr,
133 phys_addr_t paddr, u64 size, int prot);
134 void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr);
135 /* Set the numer of window per domain */
136 int (*domain_set_windows)(struct iommu_domain *domain, u32 w_count);
137 /* Get the numer of window per domain */
138 u32 (*domain_get_windows)(struct iommu_domain *domain);
140 unsigned long pgsize_bitmap;
143 #define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
144 #define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
145 #define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
146 #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
147 #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
148 #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
150 extern int bus_set_iommu(struct bus_type *bus, const struct iommu_ops *ops);
151 extern bool iommu_present(struct bus_type *bus);
152 extern bool iommu_capable(struct bus_type *bus, enum iommu_cap cap);
153 extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
154 extern struct iommu_group *iommu_group_get_by_id(int id);
155 extern void iommu_domain_free(struct iommu_domain *domain);
156 extern int iommu_attach_device(struct iommu_domain *domain,
158 extern void iommu_detach_device(struct iommu_domain *domain,
160 extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
161 phys_addr_t paddr, size_t size, int prot);
162 extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
164 extern size_t default_iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
165 struct scatterlist *sg,unsigned int nents,
167 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
168 extern void iommu_set_fault_handler(struct iommu_domain *domain,
169 iommu_fault_handler_t handler, void *token);
171 extern int iommu_attach_group(struct iommu_domain *domain,
172 struct iommu_group *group);
173 extern void iommu_detach_group(struct iommu_domain *domain,
174 struct iommu_group *group);
175 extern struct iommu_group *iommu_group_alloc(void);
176 extern void *iommu_group_get_iommudata(struct iommu_group *group);
177 extern void iommu_group_set_iommudata(struct iommu_group *group,
179 void (*release)(void *iommu_data));
180 extern int iommu_group_set_name(struct iommu_group *group, const char *name);
181 extern int iommu_group_add_device(struct iommu_group *group,
183 extern void iommu_group_remove_device(struct device *dev);
184 extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
185 int (*fn)(struct device *, void *));
186 extern struct iommu_group *iommu_group_get(struct device *dev);
187 extern void iommu_group_put(struct iommu_group *group);
188 extern int iommu_group_register_notifier(struct iommu_group *group,
189 struct notifier_block *nb);
190 extern int iommu_group_unregister_notifier(struct iommu_group *group,
191 struct notifier_block *nb);
192 extern int iommu_group_id(struct iommu_group *group);
193 extern struct iommu_group *iommu_group_get_for_dev(struct device *dev);
195 extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
197 extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
199 struct device *iommu_device_create(struct device *parent, void *drvdata,
200 const struct attribute_group **groups,
201 const char *fmt, ...);
202 void iommu_device_destroy(struct device *dev);
203 int iommu_device_link(struct device *dev, struct device *link);
204 void iommu_device_unlink(struct device *dev, struct device *link);
206 /* Window handling function prototypes */
207 extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
208 phys_addr_t offset, u64 size,
210 extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr);
212 * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
213 * @domain: the iommu domain where the fault has happened
214 * @dev: the device where the fault has happened
215 * @iova: the faulting address
216 * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
218 * This function should be called by the low-level IOMMU implementations
219 * whenever IOMMU faults happen, to allow high-level users, that are
220 * interested in such events, to know about them.
222 * This event may be useful for several possible use cases:
223 * - mere logging of the event
224 * - dynamic TLB/PTE loading
225 * - if restarting of the faulting device is required
227 * Returns 0 on success and an appropriate error code otherwise (if dynamic
228 * PTE/TLB loading will one day be supported, implementations will be able
229 * to tell whether it succeeded or not according to this return value).
231 * Specifically, -ENOSYS is returned if a fault handler isn't installed
232 * (though fault handlers can also return -ENOSYS, in case they want to
233 * elicit the default behavior of the IOMMU drivers).
235 static inline int report_iommu_fault(struct iommu_domain *domain,
236 struct device *dev, unsigned long iova, int flags)
241 * if upper layers showed interest and installed a fault handler,
245 ret = domain->handler(domain, dev, iova, flags,
246 domain->handler_token);
248 trace_io_page_fault(dev, iova, flags);
252 static inline size_t iommu_map_sg(struct iommu_domain *domain,
253 unsigned long iova, struct scatterlist *sg,
254 unsigned int nents, int prot)
256 return domain->ops->map_sg(domain, iova, sg, nents, prot);
259 #else /* CONFIG_IOMMU_API */
262 struct iommu_group {};
264 static inline bool iommu_present(struct bus_type *bus)
269 static inline bool iommu_capable(struct bus_type *bus, enum iommu_cap cap)
274 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
279 static inline struct iommu_group *iommu_group_get_by_id(int id)
284 static inline void iommu_domain_free(struct iommu_domain *domain)
288 static inline int iommu_attach_device(struct iommu_domain *domain,
294 static inline void iommu_detach_device(struct iommu_domain *domain,
299 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
300 phys_addr_t paddr, int gfp_order, int prot)
305 static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
311 static inline size_t iommu_map_sg(struct iommu_domain *domain,
312 unsigned long iova, struct scatterlist *sg,
313 unsigned int nents, int prot)
318 static inline int iommu_domain_window_enable(struct iommu_domain *domain,
319 u32 wnd_nr, phys_addr_t paddr,
325 static inline void iommu_domain_window_disable(struct iommu_domain *domain,
330 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
335 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
336 iommu_fault_handler_t handler, void *token)
340 static inline int iommu_attach_group(struct iommu_domain *domain,
341 struct iommu_group *group)
346 static inline void iommu_detach_group(struct iommu_domain *domain,
347 struct iommu_group *group)
351 static inline struct iommu_group *iommu_group_alloc(void)
353 return ERR_PTR(-ENODEV);
356 static inline void *iommu_group_get_iommudata(struct iommu_group *group)
361 static inline void iommu_group_set_iommudata(struct iommu_group *group,
363 void (*release)(void *iommu_data))
367 static inline int iommu_group_set_name(struct iommu_group *group,
373 static inline int iommu_group_add_device(struct iommu_group *group,
379 static inline void iommu_group_remove_device(struct device *dev)
383 static inline int iommu_group_for_each_dev(struct iommu_group *group,
385 int (*fn)(struct device *, void *))
390 static inline struct iommu_group *iommu_group_get(struct device *dev)
395 static inline void iommu_group_put(struct iommu_group *group)
399 static inline int iommu_group_register_notifier(struct iommu_group *group,
400 struct notifier_block *nb)
405 static inline int iommu_group_unregister_notifier(struct iommu_group *group,
406 struct notifier_block *nb)
411 static inline int iommu_group_id(struct iommu_group *group)
416 static inline int iommu_domain_get_attr(struct iommu_domain *domain,
417 enum iommu_attr attr, void *data)
422 static inline int iommu_domain_set_attr(struct iommu_domain *domain,
423 enum iommu_attr attr, void *data)
428 static inline struct device *iommu_device_create(struct device *parent,
430 const struct attribute_group **groups,
431 const char *fmt, ...)
433 return ERR_PTR(-ENODEV);
436 static inline void iommu_device_destroy(struct device *dev)
440 static inline int iommu_device_link(struct device *dev, struct device *link)
445 static inline void iommu_device_unlink(struct device *dev, struct device *link)
449 #endif /* CONFIG_IOMMU_API */
451 #endif /* __LINUX_IOMMU_H */