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)
33 #define IOMMU_MMIO (1 << 4) /* e.g. things like MSI doorbells */
35 * This is to make the IOMMU API setup privileged
36 * mapppings accessible by the master only at higher
37 * privileged execution level and inaccessible at
38 * less privileged levels.
40 #define IOMMU_PRIV (1 << 5)
47 struct notifier_block
;
49 /* iommu fault flags */
50 #define IOMMU_FAULT_READ 0x0
51 #define IOMMU_FAULT_WRITE 0x1
53 typedef int (*iommu_fault_handler_t
)(struct iommu_domain
*,
54 struct device
*, unsigned long, int, void *);
56 struct iommu_domain_geometry
{
57 dma_addr_t aperture_start
; /* First address that can be mapped */
58 dma_addr_t aperture_end
; /* Last address that can be mapped */
59 bool force_aperture
; /* DMA only allowed in mappable range? */
62 /* Domain feature flags */
63 #define __IOMMU_DOMAIN_PAGING (1U << 0) /* Support for iommu_map/unmap */
64 #define __IOMMU_DOMAIN_DMA_API (1U << 1) /* Domain for use in DMA-API
66 #define __IOMMU_DOMAIN_PT (1U << 2) /* Domain is identity mapped */
69 * This are the possible domain-types
71 * IOMMU_DOMAIN_BLOCKED - All DMA is blocked, can be used to isolate
73 * IOMMU_DOMAIN_IDENTITY - DMA addresses are system physical addresses
74 * IOMMU_DOMAIN_UNMANAGED - DMA mappings managed by IOMMU-API user, used
76 * IOMMU_DOMAIN_DMA - Internally used for DMA-API implementations.
77 * This flag allows IOMMU drivers to implement
78 * certain optimizations for these domains
80 #define IOMMU_DOMAIN_BLOCKED (0U)
81 #define IOMMU_DOMAIN_IDENTITY (__IOMMU_DOMAIN_PT)
82 #define IOMMU_DOMAIN_UNMANAGED (__IOMMU_DOMAIN_PAGING)
83 #define IOMMU_DOMAIN_DMA (__IOMMU_DOMAIN_PAGING | \
84 __IOMMU_DOMAIN_DMA_API)
88 const struct iommu_ops
*ops
;
89 unsigned long pgsize_bitmap
; /* Bitmap of page sizes in use */
90 iommu_fault_handler_t handler
;
92 struct iommu_domain_geometry geometry
;
97 IOMMU_CAP_CACHE_COHERENCY
, /* IOMMU can enforce cache coherent DMA
99 IOMMU_CAP_INTR_REMAP
, /* IOMMU supports interrupt isolation */
100 IOMMU_CAP_NOEXEC
, /* IOMMU_NOEXEC flag */
104 * Following constraints are specifc to FSL_PAMUV1:
105 * -aperture must be power of 2, and naturally aligned
106 * -number of windows must be power of 2, and address space size
107 * of each window is determined by aperture size / # of windows
108 * -the actual size of the mapped region of a window must be power
109 * of 2 starting with 4KB and physical address must be naturally
111 * DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints.
112 * The caller can invoke iommu_domain_get_attr to check if the underlying
113 * iommu implementation supports these constraints.
117 DOMAIN_ATTR_GEOMETRY
,
120 DOMAIN_ATTR_FSL_PAMU_STASH
,
121 DOMAIN_ATTR_FSL_PAMU_ENABLE
,
122 DOMAIN_ATTR_FSL_PAMUV1
,
123 DOMAIN_ATTR_NESTING
, /* two stages of translation */
127 /* These are the possible reserved region types */
128 #define IOMMU_RESV_DIRECT (1 << 0)
129 #define IOMMU_RESV_RESERVED (1 << 1)
130 #define IOMMU_RESV_MSI (1 << 2)
133 * struct iommu_resv_region - descriptor for a reserved memory region
134 * @list: Linked list pointers
135 * @start: System physical start address of the region
136 * @length: Length of the region in bytes
137 * @prot: IOMMU Protection flags (READ/WRITE/...)
138 * @type: Type of the reserved region
140 struct iommu_resv_region
{
141 struct list_head list
;
148 #ifdef CONFIG_IOMMU_API
151 * struct iommu_ops - iommu ops and capabilities
152 * @capable: check capability
153 * @domain_alloc: allocate iommu domain
154 * @domain_free: free iommu domain
155 * @attach_dev: attach device to an iommu domain
156 * @detach_dev: detach device from an iommu domain
157 * @map: map a physically contiguous memory region to an iommu domain
158 * @unmap: unmap a physically contiguous memory region from an iommu domain
159 * @map_sg: map a scatter-gather list of physically contiguous memory chunks
161 * @iova_to_phys: translate iova to physical address
162 * @add_device: add device to iommu grouping
163 * @remove_device: remove device from iommu grouping
164 * @device_group: find iommu group for a particular device
165 * @domain_get_attr: Query domain attributes
166 * @domain_set_attr: Change domain attributes
167 * @get_resv_regions: Request list of reserved regions for a device
168 * @put_resv_regions: Free list of reserved regions for a device
169 * @apply_resv_region: Temporary helper call-back for iova reserved ranges
170 * @domain_window_enable: Configure and enable a particular window for a domain
171 * @domain_window_disable: Disable a particular window for a domain
172 * @domain_set_windows: Set the number of windows for a domain
173 * @domain_get_windows: Return the number of windows for a domain
174 * @of_xlate: add OF master IDs to iommu grouping
175 * @pgsize_bitmap: bitmap of all possible supported page sizes
178 bool (*capable
)(enum iommu_cap
);
180 /* Domain allocation and freeing by the iommu driver */
181 struct iommu_domain
*(*domain_alloc
)(unsigned iommu_domain_type
);
182 void (*domain_free
)(struct iommu_domain
*);
184 int (*attach_dev
)(struct iommu_domain
*domain
, struct device
*dev
);
185 void (*detach_dev
)(struct iommu_domain
*domain
, struct device
*dev
);
186 int (*map
)(struct iommu_domain
*domain
, unsigned long iova
,
187 phys_addr_t paddr
, size_t size
, int prot
);
188 size_t (*unmap
)(struct iommu_domain
*domain
, unsigned long iova
,
190 size_t (*map_sg
)(struct iommu_domain
*domain
, unsigned long iova
,
191 struct scatterlist
*sg
, unsigned int nents
, int prot
);
192 phys_addr_t (*iova_to_phys
)(struct iommu_domain
*domain
, dma_addr_t iova
);
193 int (*add_device
)(struct device
*dev
);
194 void (*remove_device
)(struct device
*dev
);
195 struct iommu_group
*(*device_group
)(struct device
*dev
);
196 int (*domain_get_attr
)(struct iommu_domain
*domain
,
197 enum iommu_attr attr
, void *data
);
198 int (*domain_set_attr
)(struct iommu_domain
*domain
,
199 enum iommu_attr attr
, void *data
);
201 /* Request/Free a list of reserved regions for a device */
202 void (*get_resv_regions
)(struct device
*dev
, struct list_head
*list
);
203 void (*put_resv_regions
)(struct device
*dev
, struct list_head
*list
);
204 void (*apply_resv_region
)(struct device
*dev
,
205 struct iommu_domain
*domain
,
206 struct iommu_resv_region
*region
);
208 /* Window handling functions */
209 int (*domain_window_enable
)(struct iommu_domain
*domain
, u32 wnd_nr
,
210 phys_addr_t paddr
, u64 size
, int prot
);
211 void (*domain_window_disable
)(struct iommu_domain
*domain
, u32 wnd_nr
);
212 /* Set the number of windows per domain */
213 int (*domain_set_windows
)(struct iommu_domain
*domain
, u32 w_count
);
214 /* Get the number of windows per domain */
215 u32 (*domain_get_windows
)(struct iommu_domain
*domain
);
217 int (*of_xlate
)(struct device
*dev
, struct of_phandle_args
*args
);
219 unsigned long pgsize_bitmap
;
222 #define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
223 #define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
224 #define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
225 #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
226 #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
227 #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
229 extern int bus_set_iommu(struct bus_type
*bus
, const struct iommu_ops
*ops
);
230 extern bool iommu_present(struct bus_type
*bus
);
231 extern bool iommu_capable(struct bus_type
*bus
, enum iommu_cap cap
);
232 extern struct iommu_domain
*iommu_domain_alloc(struct bus_type
*bus
);
233 extern struct iommu_group
*iommu_group_get_by_id(int id
);
234 extern void iommu_domain_free(struct iommu_domain
*domain
);
235 extern int iommu_attach_device(struct iommu_domain
*domain
,
237 extern void iommu_detach_device(struct iommu_domain
*domain
,
239 extern struct iommu_domain
*iommu_get_domain_for_dev(struct device
*dev
);
240 extern int iommu_map(struct iommu_domain
*domain
, unsigned long iova
,
241 phys_addr_t paddr
, size_t size
, int prot
);
242 extern size_t iommu_unmap(struct iommu_domain
*domain
, unsigned long iova
,
244 extern size_t default_iommu_map_sg(struct iommu_domain
*domain
, unsigned long iova
,
245 struct scatterlist
*sg
,unsigned int nents
,
247 extern phys_addr_t
iommu_iova_to_phys(struct iommu_domain
*domain
, dma_addr_t iova
);
248 extern void iommu_set_fault_handler(struct iommu_domain
*domain
,
249 iommu_fault_handler_t handler
, void *token
);
251 extern void iommu_get_resv_regions(struct device
*dev
, struct list_head
*list
);
252 extern void iommu_put_resv_regions(struct device
*dev
, struct list_head
*list
);
253 extern int iommu_request_dm_for_dev(struct device
*dev
);
254 extern struct iommu_resv_region
*
255 iommu_alloc_resv_region(phys_addr_t start
, size_t length
, int prot
, int type
);
256 extern int iommu_get_group_resv_regions(struct iommu_group
*group
,
257 struct list_head
*head
);
259 extern int iommu_attach_group(struct iommu_domain
*domain
,
260 struct iommu_group
*group
);
261 extern void iommu_detach_group(struct iommu_domain
*domain
,
262 struct iommu_group
*group
);
263 extern struct iommu_group
*iommu_group_alloc(void);
264 extern void *iommu_group_get_iommudata(struct iommu_group
*group
);
265 extern void iommu_group_set_iommudata(struct iommu_group
*group
,
267 void (*release
)(void *iommu_data
));
268 extern int iommu_group_set_name(struct iommu_group
*group
, const char *name
);
269 extern int iommu_group_add_device(struct iommu_group
*group
,
271 extern void iommu_group_remove_device(struct device
*dev
);
272 extern int iommu_group_for_each_dev(struct iommu_group
*group
, void *data
,
273 int (*fn
)(struct device
*, void *));
274 extern struct iommu_group
*iommu_group_get(struct device
*dev
);
275 extern struct iommu_group
*iommu_group_ref_get(struct iommu_group
*group
);
276 extern void iommu_group_put(struct iommu_group
*group
);
277 extern int iommu_group_register_notifier(struct iommu_group
*group
,
278 struct notifier_block
*nb
);
279 extern int iommu_group_unregister_notifier(struct iommu_group
*group
,
280 struct notifier_block
*nb
);
281 extern int iommu_group_id(struct iommu_group
*group
);
282 extern struct iommu_group
*iommu_group_get_for_dev(struct device
*dev
);
283 extern struct iommu_domain
*iommu_group_default_domain(struct iommu_group
*);
285 extern int iommu_domain_get_attr(struct iommu_domain
*domain
, enum iommu_attr
,
287 extern int iommu_domain_set_attr(struct iommu_domain
*domain
, enum iommu_attr
,
289 struct device
*iommu_device_create(struct device
*parent
, void *drvdata
,
290 const struct attribute_group
**groups
,
291 const char *fmt
, ...) __printf(4, 5);
292 void iommu_device_destroy(struct device
*dev
);
293 int iommu_device_link(struct device
*dev
, struct device
*link
);
294 void iommu_device_unlink(struct device
*dev
, struct device
*link
);
296 /* Window handling function prototypes */
297 extern int iommu_domain_window_enable(struct iommu_domain
*domain
, u32 wnd_nr
,
298 phys_addr_t offset
, u64 size
,
300 extern void iommu_domain_window_disable(struct iommu_domain
*domain
, u32 wnd_nr
);
302 * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
303 * @domain: the iommu domain where the fault has happened
304 * @dev: the device where the fault has happened
305 * @iova: the faulting address
306 * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
308 * This function should be called by the low-level IOMMU implementations
309 * whenever IOMMU faults happen, to allow high-level users, that are
310 * interested in such events, to know about them.
312 * This event may be useful for several possible use cases:
313 * - mere logging of the event
314 * - dynamic TLB/PTE loading
315 * - if restarting of the faulting device is required
317 * Returns 0 on success and an appropriate error code otherwise (if dynamic
318 * PTE/TLB loading will one day be supported, implementations will be able
319 * to tell whether it succeeded or not according to this return value).
321 * Specifically, -ENOSYS is returned if a fault handler isn't installed
322 * (though fault handlers can also return -ENOSYS, in case they want to
323 * elicit the default behavior of the IOMMU drivers).
325 static inline int report_iommu_fault(struct iommu_domain
*domain
,
326 struct device
*dev
, unsigned long iova
, int flags
)
331 * if upper layers showed interest and installed a fault handler,
335 ret
= domain
->handler(domain
, dev
, iova
, flags
,
336 domain
->handler_token
);
338 trace_io_page_fault(dev
, iova
, flags
);
342 static inline size_t iommu_map_sg(struct iommu_domain
*domain
,
343 unsigned long iova
, struct scatterlist
*sg
,
344 unsigned int nents
, int prot
)
346 return domain
->ops
->map_sg(domain
, iova
, sg
, nents
, prot
);
349 /* PCI device grouping function */
350 extern struct iommu_group
*pci_device_group(struct device
*dev
);
351 /* Generic device grouping function */
352 extern struct iommu_group
*generic_device_group(struct device
*dev
);
355 * struct iommu_fwspec - per-device IOMMU instance data
356 * @ops: ops for this device's IOMMU
357 * @iommu_fwnode: firmware handle for this device's IOMMU
358 * @iommu_priv: IOMMU driver private data for this device
359 * @num_ids: number of associated device IDs
360 * @ids: IDs which this device may present to the IOMMU
362 struct iommu_fwspec
{
363 const struct iommu_ops
*ops
;
364 struct fwnode_handle
*iommu_fwnode
;
366 unsigned int num_ids
;
370 int iommu_fwspec_init(struct device
*dev
, struct fwnode_handle
*iommu_fwnode
,
371 const struct iommu_ops
*ops
);
372 void iommu_fwspec_free(struct device
*dev
);
373 int iommu_fwspec_add_ids(struct device
*dev
, u32
*ids
, int num_ids
);
374 void iommu_register_instance(struct fwnode_handle
*fwnode
,
375 const struct iommu_ops
*ops
);
376 const struct iommu_ops
*iommu_get_instance(struct fwnode_handle
*fwnode
);
378 #else /* CONFIG_IOMMU_API */
381 struct iommu_group
{};
382 struct iommu_fwspec
{};
384 static inline bool iommu_present(struct bus_type
*bus
)
389 static inline bool iommu_capable(struct bus_type
*bus
, enum iommu_cap cap
)
394 static inline struct iommu_domain
*iommu_domain_alloc(struct bus_type
*bus
)
399 static inline struct iommu_group
*iommu_group_get_by_id(int id
)
404 static inline void iommu_domain_free(struct iommu_domain
*domain
)
408 static inline int iommu_attach_device(struct iommu_domain
*domain
,
414 static inline void iommu_detach_device(struct iommu_domain
*domain
,
419 static inline struct iommu_domain
*iommu_get_domain_for_dev(struct device
*dev
)
424 static inline int iommu_map(struct iommu_domain
*domain
, unsigned long iova
,
425 phys_addr_t paddr
, int gfp_order
, int prot
)
430 static inline int iommu_unmap(struct iommu_domain
*domain
, unsigned long iova
,
436 static inline size_t iommu_map_sg(struct iommu_domain
*domain
,
437 unsigned long iova
, struct scatterlist
*sg
,
438 unsigned int nents
, int prot
)
443 static inline int iommu_domain_window_enable(struct iommu_domain
*domain
,
444 u32 wnd_nr
, phys_addr_t paddr
,
450 static inline void iommu_domain_window_disable(struct iommu_domain
*domain
,
455 static inline phys_addr_t
iommu_iova_to_phys(struct iommu_domain
*domain
, dma_addr_t iova
)
460 static inline void iommu_set_fault_handler(struct iommu_domain
*domain
,
461 iommu_fault_handler_t handler
, void *token
)
465 static inline void iommu_get_resv_regions(struct device
*dev
,
466 struct list_head
*list
)
470 static inline void iommu_put_resv_regions(struct device
*dev
,
471 struct list_head
*list
)
475 static inline int iommu_get_group_resv_regions(struct iommu_group
*group
,
476 struct list_head
*head
)
481 static inline int iommu_request_dm_for_dev(struct device
*dev
)
486 static inline int iommu_attach_group(struct iommu_domain
*domain
,
487 struct iommu_group
*group
)
492 static inline void iommu_detach_group(struct iommu_domain
*domain
,
493 struct iommu_group
*group
)
497 static inline struct iommu_group
*iommu_group_alloc(void)
499 return ERR_PTR(-ENODEV
);
502 static inline void *iommu_group_get_iommudata(struct iommu_group
*group
)
507 static inline void iommu_group_set_iommudata(struct iommu_group
*group
,
509 void (*release
)(void *iommu_data
))
513 static inline int iommu_group_set_name(struct iommu_group
*group
,
519 static inline int iommu_group_add_device(struct iommu_group
*group
,
525 static inline void iommu_group_remove_device(struct device
*dev
)
529 static inline int iommu_group_for_each_dev(struct iommu_group
*group
,
531 int (*fn
)(struct device
*, void *))
536 static inline struct iommu_group
*iommu_group_get(struct device
*dev
)
541 static inline void iommu_group_put(struct iommu_group
*group
)
545 static inline int iommu_group_register_notifier(struct iommu_group
*group
,
546 struct notifier_block
*nb
)
551 static inline int iommu_group_unregister_notifier(struct iommu_group
*group
,
552 struct notifier_block
*nb
)
557 static inline int iommu_group_id(struct iommu_group
*group
)
562 static inline int iommu_domain_get_attr(struct iommu_domain
*domain
,
563 enum iommu_attr attr
, void *data
)
568 static inline int iommu_domain_set_attr(struct iommu_domain
*domain
,
569 enum iommu_attr attr
, void *data
)
574 static inline struct device
*iommu_device_create(struct device
*parent
,
576 const struct attribute_group
**groups
,
577 const char *fmt
, ...)
579 return ERR_PTR(-ENODEV
);
582 static inline void iommu_device_destroy(struct device
*dev
)
586 static inline int iommu_device_link(struct device
*dev
, struct device
*link
)
591 static inline void iommu_device_unlink(struct device
*dev
, struct device
*link
)
595 static inline int iommu_fwspec_init(struct device
*dev
,
596 struct fwnode_handle
*iommu_fwnode
,
597 const struct iommu_ops
*ops
)
602 static inline void iommu_fwspec_free(struct device
*dev
)
606 static inline int iommu_fwspec_add_ids(struct device
*dev
, u32
*ids
,
612 static inline void iommu_register_instance(struct fwnode_handle
*fwnode
,
613 const struct iommu_ops
*ops
)
618 const struct iommu_ops
*iommu_get_instance(struct fwnode_handle
*fwnode
)
623 #endif /* CONFIG_IOMMU_API */
625 #endif /* __LINUX_IOMMU_H */