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_NOEXEC (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 */
65 IOMMU_CAP_NOEXEC, /* IOMMU_NOEXEC flag */
69 * Following constraints are specifc to FSL_PAMUV1:
70 * -aperture must be power of 2, and naturally aligned
71 * -number of windows must be power of 2, and address space size
72 * of each window is determined by aperture size / # of windows
73 * -the actual size of the mapped region of a window must be power
74 * of 2 starting with 4KB and physical address must be naturally
76 * DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints.
77 * The caller can invoke iommu_domain_get_attr to check if the underlying
78 * iommu implementation supports these constraints.
85 DOMAIN_ATTR_FSL_PAMU_STASH,
86 DOMAIN_ATTR_FSL_PAMU_ENABLE,
87 DOMAIN_ATTR_FSL_PAMUV1,
88 DOMAIN_ATTR_NESTING, /* two stages of translation */
92 #ifdef CONFIG_IOMMU_API
95 * struct iommu_ops - iommu ops and capabilities
96 * @domain_init: init iommu domain
97 * @domain_destroy: destroy iommu domain
98 * @attach_dev: attach device to an iommu domain
99 * @detach_dev: detach device from an iommu domain
100 * @map: map a physically contiguous memory region to an iommu domain
101 * @unmap: unmap a physically contiguous memory region from an iommu domain
102 * @map_sg: map a scatter-gather list of physically contiguous memory chunks
104 * @iova_to_phys: translate iova to physical address
105 * @add_device: add device to iommu grouping
106 * @remove_device: remove device from iommu grouping
107 * @domain_get_attr: Query domain attributes
108 * @domain_set_attr: Change domain attributes
109 * @pgsize_bitmap: bitmap of supported page sizes
112 bool (*capable)(enum iommu_cap);
113 int (*domain_init)(struct iommu_domain *domain);
114 void (*domain_destroy)(struct iommu_domain *domain);
115 int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
116 void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
117 int (*map)(struct iommu_domain *domain, unsigned long iova,
118 phys_addr_t paddr, size_t size, int prot);
119 size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
121 size_t (*map_sg)(struct iommu_domain *domain, unsigned long iova,
122 struct scatterlist *sg, unsigned int nents, int prot);
123 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova);
124 int (*add_device)(struct device *dev);
125 void (*remove_device)(struct device *dev);
126 int (*device_group)(struct device *dev, unsigned int *groupid);
127 int (*domain_get_attr)(struct iommu_domain *domain,
128 enum iommu_attr attr, void *data);
129 int (*domain_set_attr)(struct iommu_domain *domain,
130 enum iommu_attr attr, void *data);
132 /* Window handling functions */
133 int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr,
134 phys_addr_t paddr, u64 size, int prot);
135 void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr);
136 /* Set the numer of window per domain */
137 int (*domain_set_windows)(struct iommu_domain *domain, u32 w_count);
138 /* Get the numer of window per domain */
139 u32 (*domain_get_windows)(struct iommu_domain *domain);
141 unsigned long pgsize_bitmap;
144 #define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
145 #define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
146 #define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
147 #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
148 #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
149 #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
151 extern int bus_set_iommu(struct bus_type *bus, const struct iommu_ops *ops);
152 extern bool iommu_present(struct bus_type *bus);
153 extern bool iommu_capable(struct bus_type *bus, enum iommu_cap cap);
154 extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
155 extern struct iommu_group *iommu_group_get_by_id(int id);
156 extern void iommu_domain_free(struct iommu_domain *domain);
157 extern int iommu_attach_device(struct iommu_domain *domain,
159 extern void iommu_detach_device(struct iommu_domain *domain,
161 extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
162 phys_addr_t paddr, size_t size, int prot);
163 extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
165 extern size_t default_iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
166 struct scatterlist *sg,unsigned int nents,
168 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
169 extern void iommu_set_fault_handler(struct iommu_domain *domain,
170 iommu_fault_handler_t handler, void *token);
172 extern int iommu_attach_group(struct iommu_domain *domain,
173 struct iommu_group *group);
174 extern void iommu_detach_group(struct iommu_domain *domain,
175 struct iommu_group *group);
176 extern struct iommu_group *iommu_group_alloc(void);
177 extern void *iommu_group_get_iommudata(struct iommu_group *group);
178 extern void iommu_group_set_iommudata(struct iommu_group *group,
180 void (*release)(void *iommu_data));
181 extern int iommu_group_set_name(struct iommu_group *group, const char *name);
182 extern int iommu_group_add_device(struct iommu_group *group,
184 extern void iommu_group_remove_device(struct device *dev);
185 extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
186 int (*fn)(struct device *, void *));
187 extern struct iommu_group *iommu_group_get(struct device *dev);
188 extern void iommu_group_put(struct iommu_group *group);
189 extern int iommu_group_register_notifier(struct iommu_group *group,
190 struct notifier_block *nb);
191 extern int iommu_group_unregister_notifier(struct iommu_group *group,
192 struct notifier_block *nb);
193 extern int iommu_group_id(struct iommu_group *group);
194 extern struct iommu_group *iommu_group_get_for_dev(struct device *dev);
196 extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
198 extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
200 struct device *iommu_device_create(struct device *parent, void *drvdata,
201 const struct attribute_group **groups,
202 const char *fmt, ...);
203 void iommu_device_destroy(struct device *dev);
204 int iommu_device_link(struct device *dev, struct device *link);
205 void iommu_device_unlink(struct device *dev, struct device *link);
207 /* Window handling function prototypes */
208 extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
209 phys_addr_t offset, u64 size,
211 extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr);
213 * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
214 * @domain: the iommu domain where the fault has happened
215 * @dev: the device where the fault has happened
216 * @iova: the faulting address
217 * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
219 * This function should be called by the low-level IOMMU implementations
220 * whenever IOMMU faults happen, to allow high-level users, that are
221 * interested in such events, to know about them.
223 * This event may be useful for several possible use cases:
224 * - mere logging of the event
225 * - dynamic TLB/PTE loading
226 * - if restarting of the faulting device is required
228 * Returns 0 on success and an appropriate error code otherwise (if dynamic
229 * PTE/TLB loading will one day be supported, implementations will be able
230 * to tell whether it succeeded or not according to this return value).
232 * Specifically, -ENOSYS is returned if a fault handler isn't installed
233 * (though fault handlers can also return -ENOSYS, in case they want to
234 * elicit the default behavior of the IOMMU drivers).
236 static inline int report_iommu_fault(struct iommu_domain *domain,
237 struct device *dev, unsigned long iova, int flags)
242 * if upper layers showed interest and installed a fault handler,
246 ret = domain->handler(domain, dev, iova, flags,
247 domain->handler_token);
249 trace_io_page_fault(dev, iova, flags);
253 static inline size_t iommu_map_sg(struct iommu_domain *domain,
254 unsigned long iova, struct scatterlist *sg,
255 unsigned int nents, int prot)
257 return domain->ops->map_sg(domain, iova, sg, nents, prot);
260 #else /* CONFIG_IOMMU_API */
263 struct iommu_group {};
265 static inline bool iommu_present(struct bus_type *bus)
270 static inline bool iommu_capable(struct bus_type *bus, enum iommu_cap cap)
275 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
280 static inline struct iommu_group *iommu_group_get_by_id(int id)
285 static inline void iommu_domain_free(struct iommu_domain *domain)
289 static inline int iommu_attach_device(struct iommu_domain *domain,
295 static inline void iommu_detach_device(struct iommu_domain *domain,
300 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
301 phys_addr_t paddr, int gfp_order, int prot)
306 static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
312 static inline size_t iommu_map_sg(struct iommu_domain *domain,
313 unsigned long iova, struct scatterlist *sg,
314 unsigned int nents, int prot)
319 static inline int iommu_domain_window_enable(struct iommu_domain *domain,
320 u32 wnd_nr, phys_addr_t paddr,
326 static inline void iommu_domain_window_disable(struct iommu_domain *domain,
331 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
336 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
337 iommu_fault_handler_t handler, void *token)
341 static inline int iommu_attach_group(struct iommu_domain *domain,
342 struct iommu_group *group)
347 static inline void iommu_detach_group(struct iommu_domain *domain,
348 struct iommu_group *group)
352 static inline struct iommu_group *iommu_group_alloc(void)
354 return ERR_PTR(-ENODEV);
357 static inline void *iommu_group_get_iommudata(struct iommu_group *group)
362 static inline void iommu_group_set_iommudata(struct iommu_group *group,
364 void (*release)(void *iommu_data))
368 static inline int iommu_group_set_name(struct iommu_group *group,
374 static inline int iommu_group_add_device(struct iommu_group *group,
380 static inline void iommu_group_remove_device(struct device *dev)
384 static inline int iommu_group_for_each_dev(struct iommu_group *group,
386 int (*fn)(struct device *, void *))
391 static inline struct iommu_group *iommu_group_get(struct device *dev)
396 static inline void iommu_group_put(struct iommu_group *group)
400 static inline int iommu_group_register_notifier(struct iommu_group *group,
401 struct notifier_block *nb)
406 static inline int iommu_group_unregister_notifier(struct iommu_group *group,
407 struct notifier_block *nb)
412 static inline int iommu_group_id(struct iommu_group *group)
417 static inline int iommu_domain_get_attr(struct iommu_domain *domain,
418 enum iommu_attr attr, void *data)
423 static inline int iommu_domain_set_attr(struct iommu_domain *domain,
424 enum iommu_attr attr, void *data)
429 static inline struct device *iommu_device_create(struct device *parent,
431 const struct attribute_group **groups,
432 const char *fmt, ...)
434 return ERR_PTR(-ENODEV);
437 static inline void iommu_device_destroy(struct device *dev)
441 static inline int iommu_device_link(struct device *dev, struct device *link)
446 static inline void iommu_device_unlink(struct device *dev, struct device *link)
450 #endif /* CONFIG_IOMMU_API */
452 #endif /* __LINUX_IOMMU_H */