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 <trace/events/iommu.h>
27 #define IOMMU_READ (1 << 0)
28 #define IOMMU_WRITE (1 << 1)
29 #define IOMMU_CACHE (1 << 2) /* DMA cache coherency */
30 #define IOMMU_EXEC (1 << 3)
37 struct notifier_block
;
39 /* iommu fault flags */
40 #define IOMMU_FAULT_READ 0x0
41 #define IOMMU_FAULT_WRITE 0x1
43 typedef int (*iommu_fault_handler_t
)(struct iommu_domain
*,
44 struct device
*, unsigned long, int, void *);
46 struct iommu_domain_geometry
{
47 dma_addr_t aperture_start
; /* First address that can be mapped */
48 dma_addr_t aperture_end
; /* Last address that can be mapped */
49 bool force_aperture
; /* DMA only allowed in mappable range? */
53 const struct iommu_ops
*ops
;
55 iommu_fault_handler_t handler
;
57 struct iommu_domain_geometry geometry
;
61 IOMMU_CAP_CACHE_COHERENCY
, /* IOMMU can enforce cache coherent DMA
63 IOMMU_CAP_INTR_REMAP
, /* IOMMU supports interrupt isolation */
67 * Following constraints are specifc to FSL_PAMUV1:
68 * -aperture must be power of 2, and naturally aligned
69 * -number of windows must be power of 2, and address space size
70 * of each window is determined by aperture size / # of windows
71 * -the actual size of the mapped region of a window must be power
72 * of 2 starting with 4KB and physical address must be naturally
74 * DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints.
75 * The caller can invoke iommu_domain_get_attr to check if the underlying
76 * iommu implementation supports these constraints.
83 DOMAIN_ATTR_FSL_PAMU_STASH
,
84 DOMAIN_ATTR_FSL_PAMU_ENABLE
,
85 DOMAIN_ATTR_FSL_PAMUV1
,
86 DOMAIN_ATTR_NESTING
, /* two stages of translation */
90 #ifdef CONFIG_IOMMU_API
93 * struct iommu_ops - iommu ops and capabilities
94 * @domain_init: init iommu domain
95 * @domain_destroy: destroy iommu domain
96 * @attach_dev: attach device to an iommu domain
97 * @detach_dev: detach device from an iommu domain
98 * @map: map a physically contiguous memory region to an iommu domain
99 * @unmap: unmap a physically contiguous memory region from an iommu domain
100 * @iova_to_phys: translate iova to physical address
101 * @add_device: add device to iommu grouping
102 * @remove_device: remove device from iommu grouping
103 * @domain_get_attr: Query domain attributes
104 * @domain_set_attr: Change domain attributes
105 * @pgsize_bitmap: bitmap of supported page sizes
108 bool (*capable
)(enum iommu_cap
);
109 int (*domain_init
)(struct iommu_domain
*domain
);
110 void (*domain_destroy
)(struct iommu_domain
*domain
);
111 int (*attach_dev
)(struct iommu_domain
*domain
, struct device
*dev
);
112 void (*detach_dev
)(struct iommu_domain
*domain
, struct device
*dev
);
113 int (*map
)(struct iommu_domain
*domain
, unsigned long iova
,
114 phys_addr_t paddr
, size_t size
, int prot
);
115 size_t (*unmap
)(struct iommu_domain
*domain
, unsigned long iova
,
117 phys_addr_t (*iova_to_phys
)(struct iommu_domain
*domain
, dma_addr_t iova
);
118 int (*add_device
)(struct device
*dev
);
119 void (*remove_device
)(struct device
*dev
);
120 int (*device_group
)(struct device
*dev
, unsigned int *groupid
);
121 int (*domain_get_attr
)(struct iommu_domain
*domain
,
122 enum iommu_attr attr
, void *data
);
123 int (*domain_set_attr
)(struct iommu_domain
*domain
,
124 enum iommu_attr attr
, void *data
);
126 /* Window handling functions */
127 int (*domain_window_enable
)(struct iommu_domain
*domain
, u32 wnd_nr
,
128 phys_addr_t paddr
, u64 size
, int prot
);
129 void (*domain_window_disable
)(struct iommu_domain
*domain
, u32 wnd_nr
);
130 /* Set the numer of window per domain */
131 int (*domain_set_windows
)(struct iommu_domain
*domain
, u32 w_count
);
132 /* Get the numer of window per domain */
133 u32 (*domain_get_windows
)(struct iommu_domain
*domain
);
135 unsigned long pgsize_bitmap
;
138 #define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
139 #define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
140 #define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
141 #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
142 #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
143 #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
145 extern int bus_set_iommu(struct bus_type
*bus
, const struct iommu_ops
*ops
);
146 extern bool iommu_present(struct bus_type
*bus
);
147 extern bool iommu_capable(struct bus_type
*bus
, enum iommu_cap cap
);
148 extern struct iommu_domain
*iommu_domain_alloc(struct bus_type
*bus
);
149 extern struct iommu_group
*iommu_group_get_by_id(int id
);
150 extern void iommu_domain_free(struct iommu_domain
*domain
);
151 extern int iommu_attach_device(struct iommu_domain
*domain
,
153 extern void iommu_detach_device(struct iommu_domain
*domain
,
155 extern int iommu_map(struct iommu_domain
*domain
, unsigned long iova
,
156 phys_addr_t paddr
, size_t size
, int prot
);
157 extern size_t iommu_unmap(struct iommu_domain
*domain
, unsigned long iova
,
159 extern phys_addr_t
iommu_iova_to_phys(struct iommu_domain
*domain
, dma_addr_t iova
);
160 extern void iommu_set_fault_handler(struct iommu_domain
*domain
,
161 iommu_fault_handler_t handler
, void *token
);
163 extern int iommu_attach_group(struct iommu_domain
*domain
,
164 struct iommu_group
*group
);
165 extern void iommu_detach_group(struct iommu_domain
*domain
,
166 struct iommu_group
*group
);
167 extern struct iommu_group
*iommu_group_alloc(void);
168 extern void *iommu_group_get_iommudata(struct iommu_group
*group
);
169 extern void iommu_group_set_iommudata(struct iommu_group
*group
,
171 void (*release
)(void *iommu_data
));
172 extern int iommu_group_set_name(struct iommu_group
*group
, const char *name
);
173 extern int iommu_group_add_device(struct iommu_group
*group
,
175 extern void iommu_group_remove_device(struct device
*dev
);
176 extern int iommu_group_for_each_dev(struct iommu_group
*group
, void *data
,
177 int (*fn
)(struct device
*, void *));
178 extern struct iommu_group
*iommu_group_get(struct device
*dev
);
179 extern void iommu_group_put(struct iommu_group
*group
);
180 extern int iommu_group_register_notifier(struct iommu_group
*group
,
181 struct notifier_block
*nb
);
182 extern int iommu_group_unregister_notifier(struct iommu_group
*group
,
183 struct notifier_block
*nb
);
184 extern int iommu_group_id(struct iommu_group
*group
);
185 extern struct iommu_group
*iommu_group_get_for_dev(struct device
*dev
);
187 extern int iommu_domain_get_attr(struct iommu_domain
*domain
, enum iommu_attr
,
189 extern int iommu_domain_set_attr(struct iommu_domain
*domain
, enum iommu_attr
,
191 struct device
*iommu_device_create(struct device
*parent
, void *drvdata
,
192 const struct attribute_group
**groups
,
193 const char *fmt
, ...);
194 void iommu_device_destroy(struct device
*dev
);
195 int iommu_device_link(struct device
*dev
, struct device
*link
);
196 void iommu_device_unlink(struct device
*dev
, struct device
*link
);
198 /* Window handling function prototypes */
199 extern int iommu_domain_window_enable(struct iommu_domain
*domain
, u32 wnd_nr
,
200 phys_addr_t offset
, u64 size
,
202 extern void iommu_domain_window_disable(struct iommu_domain
*domain
, u32 wnd_nr
);
204 * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
205 * @domain: the iommu domain where the fault has happened
206 * @dev: the device where the fault has happened
207 * @iova: the faulting address
208 * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
210 * This function should be called by the low-level IOMMU implementations
211 * whenever IOMMU faults happen, to allow high-level users, that are
212 * interested in such events, to know about them.
214 * This event may be useful for several possible use cases:
215 * - mere logging of the event
216 * - dynamic TLB/PTE loading
217 * - if restarting of the faulting device is required
219 * Returns 0 on success and an appropriate error code otherwise (if dynamic
220 * PTE/TLB loading will one day be supported, implementations will be able
221 * to tell whether it succeeded or not according to this return value).
223 * Specifically, -ENOSYS is returned if a fault handler isn't installed
224 * (though fault handlers can also return -ENOSYS, in case they want to
225 * elicit the default behavior of the IOMMU drivers).
227 static inline int report_iommu_fault(struct iommu_domain
*domain
,
228 struct device
*dev
, unsigned long iova
, int flags
)
233 * if upper layers showed interest and installed a fault handler,
237 ret
= domain
->handler(domain
, dev
, iova
, flags
,
238 domain
->handler_token
);
240 trace_io_page_fault(dev
, iova
, flags
);
244 #else /* CONFIG_IOMMU_API */
247 struct iommu_group
{};
249 static inline bool iommu_present(struct bus_type
*bus
)
254 static inline bool iommu_capable(struct bus_type
*bus
, enum iommu_cap cap
)
259 static inline struct iommu_domain
*iommu_domain_alloc(struct bus_type
*bus
)
264 static inline struct iommu_group
*iommu_group_get_by_id(int id
)
269 static inline void iommu_domain_free(struct iommu_domain
*domain
)
273 static inline int iommu_attach_device(struct iommu_domain
*domain
,
279 static inline void iommu_detach_device(struct iommu_domain
*domain
,
284 static inline int iommu_map(struct iommu_domain
*domain
, unsigned long iova
,
285 phys_addr_t paddr
, int gfp_order
, int prot
)
290 static inline int iommu_unmap(struct iommu_domain
*domain
, unsigned long iova
,
296 static inline int iommu_domain_window_enable(struct iommu_domain
*domain
,
297 u32 wnd_nr
, phys_addr_t paddr
,
303 static inline void iommu_domain_window_disable(struct iommu_domain
*domain
,
308 static inline phys_addr_t
iommu_iova_to_phys(struct iommu_domain
*domain
, dma_addr_t iova
)
313 static inline void iommu_set_fault_handler(struct iommu_domain
*domain
,
314 iommu_fault_handler_t handler
, void *token
)
318 static inline int iommu_attach_group(struct iommu_domain
*domain
,
319 struct iommu_group
*group
)
324 static inline void iommu_detach_group(struct iommu_domain
*domain
,
325 struct iommu_group
*group
)
329 static inline struct iommu_group
*iommu_group_alloc(void)
331 return ERR_PTR(-ENODEV
);
334 static inline void *iommu_group_get_iommudata(struct iommu_group
*group
)
339 static inline void iommu_group_set_iommudata(struct iommu_group
*group
,
341 void (*release
)(void *iommu_data
))
345 static inline int iommu_group_set_name(struct iommu_group
*group
,
351 static inline int iommu_group_add_device(struct iommu_group
*group
,
357 static inline void iommu_group_remove_device(struct device
*dev
)
361 static inline int iommu_group_for_each_dev(struct iommu_group
*group
,
363 int (*fn
)(struct device
*, void *))
368 static inline struct iommu_group
*iommu_group_get(struct device
*dev
)
373 static inline void iommu_group_put(struct iommu_group
*group
)
377 static inline int iommu_group_register_notifier(struct iommu_group
*group
,
378 struct notifier_block
*nb
)
383 static inline int iommu_group_unregister_notifier(struct iommu_group
*group
,
384 struct notifier_block
*nb
)
389 static inline int iommu_group_id(struct iommu_group
*group
)
394 static inline int iommu_domain_get_attr(struct iommu_domain
*domain
,
395 enum iommu_attr attr
, void *data
)
400 static inline int iommu_domain_set_attr(struct iommu_domain
*domain
,
401 enum iommu_attr attr
, void *data
)
406 static inline struct device
*iommu_device_create(struct device
*parent
,
408 const struct attribute_group
**groups
,
409 const char *fmt
, ...)
411 return ERR_PTR(-ENODEV
);
414 static inline void iommu_device_destroy(struct device
*dev
)
418 static inline int iommu_device_link(struct device
*dev
, struct device
*link
)
423 static inline void iommu_device_unlink(struct device
*dev
, struct device
*link
)
427 #endif /* CONFIG_IOMMU_API */
429 #endif /* __LINUX_IOMMU_H */