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>
26 #define IOMMU_READ (1)
27 #define IOMMU_WRITE (2)
28 #define IOMMU_CACHE (4) /* DMA cache coherency */
35 struct notifier_block;
37 /* iommu fault flags */
38 #define IOMMU_FAULT_READ 0x0
39 #define IOMMU_FAULT_WRITE 0x1
41 typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
42 struct device *, unsigned long, int, void *);
44 struct iommu_domain_geometry {
45 dma_addr_t aperture_start; /* First address that can be mapped */
46 dma_addr_t aperture_end; /* Last address that can be mapped */
47 bool force_aperture; /* DMA only allowed in mappable range? */
51 struct iommu_ops *ops;
53 iommu_fault_handler_t handler;
55 struct iommu_domain_geometry geometry;
58 #define IOMMU_CAP_CACHE_COHERENCY 0x1
59 #define IOMMU_CAP_INTR_REMAP 0x2 /* isolates device intrs */
62 * Following constraints are specifc to FSL_PAMUV1:
63 * -aperture must be power of 2, and naturally aligned
64 * -number of windows must be power of 2, and address space size
65 * of each window is determined by aperture size / # of windows
66 * -the actual size of the mapped region of a window must be power
67 * of 2 starting with 4KB and physical address must be naturally
69 * DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints.
70 * The caller can invoke iommu_domain_get_attr to check if the underlying
71 * iommu implementation supports these constraints.
78 DOMAIN_ATTR_FSL_PAMU_STASH,
79 DOMAIN_ATTR_FSL_PAMU_ENABLE,
80 DOMAIN_ATTR_FSL_PAMUV1,
84 #ifdef CONFIG_IOMMU_API
87 * struct iommu_ops - iommu ops and capabilities
88 * @domain_init: init iommu domain
89 * @domain_destroy: destroy iommu domain
90 * @attach_dev: attach device to an iommu domain
91 * @detach_dev: detach device from an iommu domain
92 * @map: map a physically contiguous memory region to an iommu domain
93 * @unmap: unmap a physically contiguous memory region from an iommu domain
94 * @iova_to_phys: translate iova to physical address
95 * @domain_has_cap: domain capabilities query
96 * @add_device: add device to iommu grouping
97 * @remove_device: remove device from iommu grouping
98 * @domain_get_attr: Query domain attributes
99 * @domain_set_attr: Change domain attributes
100 * @pgsize_bitmap: bitmap of supported page sizes
103 int (*domain_init)(struct iommu_domain *domain);
104 void (*domain_destroy)(struct iommu_domain *domain);
105 int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
106 void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
107 int (*map)(struct iommu_domain *domain, unsigned long iova,
108 phys_addr_t paddr, size_t size, int prot);
109 size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
111 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova);
112 int (*domain_has_cap)(struct iommu_domain *domain,
114 int (*add_device)(struct device *dev);
115 void (*remove_device)(struct device *dev);
116 int (*device_group)(struct device *dev, unsigned int *groupid);
117 int (*domain_get_attr)(struct iommu_domain *domain,
118 enum iommu_attr attr, void *data);
119 int (*domain_set_attr)(struct iommu_domain *domain,
120 enum iommu_attr attr, void *data);
122 /* Window handling functions */
123 int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr,
124 phys_addr_t paddr, u64 size, int prot);
125 void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr);
126 /* Set the numer of window per domain */
127 int (*domain_set_windows)(struct iommu_domain *domain, u32 w_count);
128 /* Get the numer of window per domain */
129 u32 (*domain_get_windows)(struct iommu_domain *domain);
131 unsigned long pgsize_bitmap;
134 #define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
135 #define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
136 #define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
137 #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
138 #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
139 #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
141 extern int bus_set_iommu(struct bus_type *bus, struct iommu_ops *ops);
142 extern bool iommu_present(struct bus_type *bus);
143 extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
144 extern struct iommu_group *iommu_group_get_by_id(int id);
145 extern void iommu_domain_free(struct iommu_domain *domain);
146 extern int iommu_attach_device(struct iommu_domain *domain,
148 extern void iommu_detach_device(struct iommu_domain *domain,
150 extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
151 phys_addr_t paddr, size_t size, int prot);
152 extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
154 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
155 extern int iommu_domain_has_cap(struct iommu_domain *domain,
157 extern void iommu_set_fault_handler(struct iommu_domain *domain,
158 iommu_fault_handler_t handler, void *token);
160 extern int iommu_attach_group(struct iommu_domain *domain,
161 struct iommu_group *group);
162 extern void iommu_detach_group(struct iommu_domain *domain,
163 struct iommu_group *group);
164 extern struct iommu_group *iommu_group_alloc(void);
165 extern void *iommu_group_get_iommudata(struct iommu_group *group);
166 extern void iommu_group_set_iommudata(struct iommu_group *group,
168 void (*release)(void *iommu_data));
169 extern int iommu_group_set_name(struct iommu_group *group, const char *name);
170 extern int iommu_group_add_device(struct iommu_group *group,
172 extern void iommu_group_remove_device(struct device *dev);
173 extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
174 int (*fn)(struct device *, void *));
175 extern struct iommu_group *iommu_group_get(struct device *dev);
176 extern void iommu_group_put(struct iommu_group *group);
177 extern int iommu_group_register_notifier(struct iommu_group *group,
178 struct notifier_block *nb);
179 extern int iommu_group_unregister_notifier(struct iommu_group *group,
180 struct notifier_block *nb);
181 extern int iommu_group_id(struct iommu_group *group);
183 extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
185 extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
188 /* Window handling function prototypes */
189 extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
190 phys_addr_t offset, u64 size,
192 extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr);
194 * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
195 * @domain: the iommu domain where the fault has happened
196 * @dev: the device where the fault has happened
197 * @iova: the faulting address
198 * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
200 * This function should be called by the low-level IOMMU implementations
201 * whenever IOMMU faults happen, to allow high-level users, that are
202 * interested in such events, to know about them.
204 * This event may be useful for several possible use cases:
205 * - mere logging of the event
206 * - dynamic TLB/PTE loading
207 * - if restarting of the faulting device is required
209 * Returns 0 on success and an appropriate error code otherwise (if dynamic
210 * PTE/TLB loading will one day be supported, implementations will be able
211 * to tell whether it succeeded or not according to this return value).
213 * Specifically, -ENOSYS is returned if a fault handler isn't installed
214 * (though fault handlers can also return -ENOSYS, in case they want to
215 * elicit the default behavior of the IOMMU drivers).
217 static inline int report_iommu_fault(struct iommu_domain *domain,
218 struct device *dev, unsigned long iova, int flags)
223 * if upper layers showed interest and installed a fault handler,
227 ret = domain->handler(domain, dev, iova, flags,
228 domain->handler_token);
233 #else /* CONFIG_IOMMU_API */
236 struct iommu_group {};
238 static inline bool iommu_present(struct bus_type *bus)
243 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
248 static inline void iommu_domain_free(struct iommu_domain *domain)
252 static inline int iommu_attach_device(struct iommu_domain *domain,
258 static inline void iommu_detach_device(struct iommu_domain *domain,
263 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
264 phys_addr_t paddr, int gfp_order, int prot)
269 static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
275 static inline int iommu_domain_window_enable(struct iommu_domain *domain,
276 u32 wnd_nr, phys_addr_t paddr,
282 static inline void iommu_domain_window_disable(struct iommu_domain *domain,
287 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
292 static inline int domain_has_cap(struct iommu_domain *domain,
298 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
299 iommu_fault_handler_t handler, void *token)
303 static inline int iommu_attach_group(struct iommu_domain *domain,
304 struct iommu_group *group)
309 static inline void iommu_detach_group(struct iommu_domain *domain,
310 struct iommu_group *group)
314 static inline struct iommu_group *iommu_group_alloc(void)
316 return ERR_PTR(-ENODEV);
319 static inline void *iommu_group_get_iommudata(struct iommu_group *group)
324 static inline void iommu_group_set_iommudata(struct iommu_group *group,
326 void (*release)(void *iommu_data))
330 static inline int iommu_group_set_name(struct iommu_group *group,
336 static inline int iommu_group_add_device(struct iommu_group *group,
342 static inline void iommu_group_remove_device(struct device *dev)
346 static inline int iommu_group_for_each_dev(struct iommu_group *group,
348 int (*fn)(struct device *, void *))
353 static inline struct iommu_group *iommu_group_get(struct device *dev)
358 static inline void iommu_group_put(struct iommu_group *group)
362 static inline int iommu_group_register_notifier(struct iommu_group *group,
363 struct notifier_block *nb)
368 static inline int iommu_group_unregister_notifier(struct iommu_group *group,
369 struct notifier_block *nb)
374 static inline int iommu_group_id(struct iommu_group *group)
379 static inline int iommu_domain_get_attr(struct iommu_domain *domain,
380 enum iommu_attr attr, void *data)
385 static inline int iommu_domain_set_attr(struct iommu_domain *domain,
386 enum iommu_attr attr, void *data)
391 #endif /* CONFIG_IOMMU_API */
393 #endif /* __LINUX_IOMMU_H */