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>
25 #include <linux/types.h>
26 #include <linux/scatterlist.h>
27 #include <trace/events/iommu.h>
29 #define IOMMU_READ (1 << 0)
30 #define IOMMU_WRITE (1 << 1)
31 #define IOMMU_CACHE (1 << 2) /* DMA cache coherency */
32 #define IOMMU_NOEXEC (1 << 3)
39 struct notifier_block
;
41 /* iommu fault flags */
42 #define IOMMU_FAULT_READ 0x0
43 #define IOMMU_FAULT_WRITE 0x1
45 typedef int (*iommu_fault_handler_t
)(struct iommu_domain
*,
46 struct device
*, unsigned long, int, void *);
48 struct iommu_domain_geometry
{
49 dma_addr_t aperture_start
; /* First address that can be mapped */
50 dma_addr_t aperture_end
; /* Last address that can be mapped */
51 bool force_aperture
; /* DMA only allowed in mappable range? */
55 const struct iommu_ops
*ops
;
57 iommu_fault_handler_t handler
;
59 struct iommu_domain_geometry geometry
;
63 IOMMU_CAP_CACHE_COHERENCY
, /* IOMMU can enforce cache coherent DMA
65 IOMMU_CAP_INTR_REMAP
, /* IOMMU supports interrupt isolation */
66 IOMMU_CAP_NOEXEC
, /* IOMMU_NOEXEC flag */
70 * Following constraints are specifc to FSL_PAMUV1:
71 * -aperture must be power of 2, and naturally aligned
72 * -number of windows must be power of 2, and address space size
73 * of each window is determined by aperture size / # of windows
74 * -the actual size of the mapped region of a window must be power
75 * of 2 starting with 4KB and physical address must be naturally
77 * DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints.
78 * The caller can invoke iommu_domain_get_attr to check if the underlying
79 * iommu implementation supports these constraints.
86 DOMAIN_ATTR_FSL_PAMU_STASH
,
87 DOMAIN_ATTR_FSL_PAMU_ENABLE
,
88 DOMAIN_ATTR_FSL_PAMUV1
,
89 DOMAIN_ATTR_NESTING
, /* two stages of translation */
93 #ifdef CONFIG_IOMMU_API
96 * struct iommu_ops - iommu ops and capabilities
97 * @domain_init: init iommu domain
98 * @domain_destroy: destroy iommu domain
99 * @attach_dev: attach device to an iommu domain
100 * @detach_dev: detach device from an iommu domain
101 * @map: map a physically contiguous memory region to an iommu domain
102 * @unmap: unmap a physically contiguous memory region from an iommu domain
103 * @map_sg: map a scatter-gather list of physically contiguous memory chunks
105 * @iova_to_phys: translate iova to physical address
106 * @add_device: add device to iommu grouping
107 * @remove_device: remove device from iommu grouping
108 * @domain_get_attr: Query domain attributes
109 * @domain_set_attr: Change domain attributes
110 * @of_xlate: add OF master IDs to iommu grouping
111 * @pgsize_bitmap: bitmap of supported page sizes
112 * @priv: per-instance data private to the iommu driver
115 bool (*capable
)(enum iommu_cap
);
116 int (*domain_init
)(struct iommu_domain
*domain
);
117 void (*domain_destroy
)(struct iommu_domain
*domain
);
118 int (*attach_dev
)(struct iommu_domain
*domain
, struct device
*dev
);
119 void (*detach_dev
)(struct iommu_domain
*domain
, struct device
*dev
);
120 int (*map
)(struct iommu_domain
*domain
, unsigned long iova
,
121 phys_addr_t paddr
, size_t size
, int prot
);
122 size_t (*unmap
)(struct iommu_domain
*domain
, unsigned long iova
,
124 size_t (*map_sg
)(struct iommu_domain
*domain
, unsigned long iova
,
125 struct scatterlist
*sg
, unsigned int nents
, int prot
);
126 phys_addr_t (*iova_to_phys
)(struct iommu_domain
*domain
, dma_addr_t iova
);
127 int (*add_device
)(struct device
*dev
);
128 void (*remove_device
)(struct device
*dev
);
129 int (*device_group
)(struct device
*dev
, unsigned int *groupid
);
130 int (*domain_get_attr
)(struct iommu_domain
*domain
,
131 enum iommu_attr attr
, void *data
);
132 int (*domain_set_attr
)(struct iommu_domain
*domain
,
133 enum iommu_attr attr
, void *data
);
135 /* Window handling functions */
136 int (*domain_window_enable
)(struct iommu_domain
*domain
, u32 wnd_nr
,
137 phys_addr_t paddr
, u64 size
, int prot
);
138 void (*domain_window_disable
)(struct iommu_domain
*domain
, u32 wnd_nr
);
139 /* Set the numer of window per domain */
140 int (*domain_set_windows
)(struct iommu_domain
*domain
, u32 w_count
);
141 /* Get the numer of window per domain */
142 u32 (*domain_get_windows
)(struct iommu_domain
*domain
);
144 #ifdef CONFIG_OF_IOMMU
145 int (*of_xlate
)(struct device
*dev
, struct of_phandle_args
*args
);
148 unsigned long pgsize_bitmap
;
152 #define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
153 #define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
154 #define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
155 #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
156 #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
157 #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
159 extern int bus_set_iommu(struct bus_type
*bus
, const struct iommu_ops
*ops
);
160 extern bool iommu_present(struct bus_type
*bus
);
161 extern bool iommu_capable(struct bus_type
*bus
, enum iommu_cap cap
);
162 extern struct iommu_domain
*iommu_domain_alloc(struct bus_type
*bus
);
163 extern struct iommu_group
*iommu_group_get_by_id(int id
);
164 extern void iommu_domain_free(struct iommu_domain
*domain
);
165 extern int iommu_attach_device(struct iommu_domain
*domain
,
167 extern void iommu_detach_device(struct iommu_domain
*domain
,
169 extern int iommu_map(struct iommu_domain
*domain
, unsigned long iova
,
170 phys_addr_t paddr
, size_t size
, int prot
);
171 extern size_t iommu_unmap(struct iommu_domain
*domain
, unsigned long iova
,
173 extern size_t default_iommu_map_sg(struct iommu_domain
*domain
, unsigned long iova
,
174 struct scatterlist
*sg
,unsigned int nents
,
176 extern phys_addr_t
iommu_iova_to_phys(struct iommu_domain
*domain
, dma_addr_t iova
);
177 extern void iommu_set_fault_handler(struct iommu_domain
*domain
,
178 iommu_fault_handler_t handler
, void *token
);
180 extern int iommu_attach_group(struct iommu_domain
*domain
,
181 struct iommu_group
*group
);
182 extern void iommu_detach_group(struct iommu_domain
*domain
,
183 struct iommu_group
*group
);
184 extern struct iommu_group
*iommu_group_alloc(void);
185 extern void *iommu_group_get_iommudata(struct iommu_group
*group
);
186 extern void iommu_group_set_iommudata(struct iommu_group
*group
,
188 void (*release
)(void *iommu_data
));
189 extern int iommu_group_set_name(struct iommu_group
*group
, const char *name
);
190 extern int iommu_group_add_device(struct iommu_group
*group
,
192 extern void iommu_group_remove_device(struct device
*dev
);
193 extern int iommu_group_for_each_dev(struct iommu_group
*group
, void *data
,
194 int (*fn
)(struct device
*, void *));
195 extern struct iommu_group
*iommu_group_get(struct device
*dev
);
196 extern void iommu_group_put(struct iommu_group
*group
);
197 extern int iommu_group_register_notifier(struct iommu_group
*group
,
198 struct notifier_block
*nb
);
199 extern int iommu_group_unregister_notifier(struct iommu_group
*group
,
200 struct notifier_block
*nb
);
201 extern int iommu_group_id(struct iommu_group
*group
);
202 extern struct iommu_group
*iommu_group_get_for_dev(struct device
*dev
);
204 extern int iommu_domain_get_attr(struct iommu_domain
*domain
, enum iommu_attr
,
206 extern int iommu_domain_set_attr(struct iommu_domain
*domain
, enum iommu_attr
,
208 struct device
*iommu_device_create(struct device
*parent
, void *drvdata
,
209 const struct attribute_group
**groups
,
210 const char *fmt
, ...);
211 void iommu_device_destroy(struct device
*dev
);
212 int iommu_device_link(struct device
*dev
, struct device
*link
);
213 void iommu_device_unlink(struct device
*dev
, struct device
*link
);
215 /* Window handling function prototypes */
216 extern int iommu_domain_window_enable(struct iommu_domain
*domain
, u32 wnd_nr
,
217 phys_addr_t offset
, u64 size
,
219 extern void iommu_domain_window_disable(struct iommu_domain
*domain
, u32 wnd_nr
);
221 * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
222 * @domain: the iommu domain where the fault has happened
223 * @dev: the device where the fault has happened
224 * @iova: the faulting address
225 * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
227 * This function should be called by the low-level IOMMU implementations
228 * whenever IOMMU faults happen, to allow high-level users, that are
229 * interested in such events, to know about them.
231 * This event may be useful for several possible use cases:
232 * - mere logging of the event
233 * - dynamic TLB/PTE loading
234 * - if restarting of the faulting device is required
236 * Returns 0 on success and an appropriate error code otherwise (if dynamic
237 * PTE/TLB loading will one day be supported, implementations will be able
238 * to tell whether it succeeded or not according to this return value).
240 * Specifically, -ENOSYS is returned if a fault handler isn't installed
241 * (though fault handlers can also return -ENOSYS, in case they want to
242 * elicit the default behavior of the IOMMU drivers).
244 static inline int report_iommu_fault(struct iommu_domain
*domain
,
245 struct device
*dev
, unsigned long iova
, int flags
)
250 * if upper layers showed interest and installed a fault handler,
254 ret
= domain
->handler(domain
, dev
, iova
, flags
,
255 domain
->handler_token
);
257 trace_io_page_fault(dev
, iova
, flags
);
261 static inline size_t iommu_map_sg(struct iommu_domain
*domain
,
262 unsigned long iova
, struct scatterlist
*sg
,
263 unsigned int nents
, int prot
)
265 return domain
->ops
->map_sg(domain
, iova
, sg
, nents
, prot
);
268 #else /* CONFIG_IOMMU_API */
271 struct iommu_group
{};
273 static inline bool iommu_present(struct bus_type
*bus
)
278 static inline bool iommu_capable(struct bus_type
*bus
, enum iommu_cap cap
)
283 static inline struct iommu_domain
*iommu_domain_alloc(struct bus_type
*bus
)
288 static inline struct iommu_group
*iommu_group_get_by_id(int id
)
293 static inline void iommu_domain_free(struct iommu_domain
*domain
)
297 static inline int iommu_attach_device(struct iommu_domain
*domain
,
303 static inline void iommu_detach_device(struct iommu_domain
*domain
,
308 static inline int iommu_map(struct iommu_domain
*domain
, unsigned long iova
,
309 phys_addr_t paddr
, int gfp_order
, int prot
)
314 static inline int iommu_unmap(struct iommu_domain
*domain
, unsigned long iova
,
320 static inline size_t iommu_map_sg(struct iommu_domain
*domain
,
321 unsigned long iova
, struct scatterlist
*sg
,
322 unsigned int nents
, int prot
)
327 static inline int iommu_domain_window_enable(struct iommu_domain
*domain
,
328 u32 wnd_nr
, phys_addr_t paddr
,
334 static inline void iommu_domain_window_disable(struct iommu_domain
*domain
,
339 static inline phys_addr_t
iommu_iova_to_phys(struct iommu_domain
*domain
, dma_addr_t iova
)
344 static inline void iommu_set_fault_handler(struct iommu_domain
*domain
,
345 iommu_fault_handler_t handler
, void *token
)
349 static inline int iommu_attach_group(struct iommu_domain
*domain
,
350 struct iommu_group
*group
)
355 static inline void iommu_detach_group(struct iommu_domain
*domain
,
356 struct iommu_group
*group
)
360 static inline struct iommu_group
*iommu_group_alloc(void)
362 return ERR_PTR(-ENODEV
);
365 static inline void *iommu_group_get_iommudata(struct iommu_group
*group
)
370 static inline void iommu_group_set_iommudata(struct iommu_group
*group
,
372 void (*release
)(void *iommu_data
))
376 static inline int iommu_group_set_name(struct iommu_group
*group
,
382 static inline int iommu_group_add_device(struct iommu_group
*group
,
388 static inline void iommu_group_remove_device(struct device
*dev
)
392 static inline int iommu_group_for_each_dev(struct iommu_group
*group
,
394 int (*fn
)(struct device
*, void *))
399 static inline struct iommu_group
*iommu_group_get(struct device
*dev
)
404 static inline void iommu_group_put(struct iommu_group
*group
)
408 static inline int iommu_group_register_notifier(struct iommu_group
*group
,
409 struct notifier_block
*nb
)
414 static inline int iommu_group_unregister_notifier(struct iommu_group
*group
,
415 struct notifier_block
*nb
)
420 static inline int iommu_group_id(struct iommu_group
*group
)
425 static inline int iommu_domain_get_attr(struct iommu_domain
*domain
,
426 enum iommu_attr attr
, void *data
)
431 static inline int iommu_domain_set_attr(struct iommu_domain
*domain
,
432 enum iommu_attr attr
, void *data
)
437 static inline struct device
*iommu_device_create(struct device
*parent
,
439 const struct attribute_group
**groups
,
440 const char *fmt
, ...)
442 return ERR_PTR(-ENODEV
);
445 static inline void iommu_device_destroy(struct device
*dev
)
449 static inline int iommu_device_link(struct device
*dev
, struct device
*link
)
454 static inline void iommu_device_unlink(struct device
*dev
, struct device
*link
)
458 #endif /* CONFIG_IOMMU_API */
460 #endif /* __LINUX_IOMMU_H */