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 */
40 struct notifier_block
;
42 /* iommu fault flags */
43 #define IOMMU_FAULT_READ 0x0
44 #define IOMMU_FAULT_WRITE 0x1
46 typedef int (*iommu_fault_handler_t
)(struct iommu_domain
*,
47 struct device
*, unsigned long, int, void *);
49 struct iommu_domain_geometry
{
50 dma_addr_t aperture_start
; /* First address that can be mapped */
51 dma_addr_t aperture_end
; /* Last address that can be mapped */
52 bool force_aperture
; /* DMA only allowed in mappable range? */
55 /* Domain feature flags */
56 #define __IOMMU_DOMAIN_PAGING (1U << 0) /* Support for iommu_map/unmap */
57 #define __IOMMU_DOMAIN_DMA_API (1U << 1) /* Domain for use in DMA-API
59 #define __IOMMU_DOMAIN_PT (1U << 2) /* Domain is identity mapped */
62 * This are the possible domain-types
64 * IOMMU_DOMAIN_BLOCKED - All DMA is blocked, can be used to isolate
66 * IOMMU_DOMAIN_IDENTITY - DMA addresses are system physical addresses
67 * IOMMU_DOMAIN_UNMANAGED - DMA mappings managed by IOMMU-API user, used
69 * IOMMU_DOMAIN_DMA - Internally used for DMA-API implementations.
70 * This flag allows IOMMU drivers to implement
71 * certain optimizations for these domains
73 #define IOMMU_DOMAIN_BLOCKED (0U)
74 #define IOMMU_DOMAIN_IDENTITY (__IOMMU_DOMAIN_PT)
75 #define IOMMU_DOMAIN_UNMANAGED (__IOMMU_DOMAIN_PAGING)
76 #define IOMMU_DOMAIN_DMA (__IOMMU_DOMAIN_PAGING | \
77 __IOMMU_DOMAIN_DMA_API)
81 const struct iommu_ops
*ops
;
82 unsigned long pgsize_bitmap
; /* Bitmap of page sizes in use */
83 iommu_fault_handler_t handler
;
85 struct iommu_domain_geometry geometry
;
90 IOMMU_CAP_CACHE_COHERENCY
, /* IOMMU can enforce cache coherent DMA
92 IOMMU_CAP_INTR_REMAP
, /* IOMMU supports interrupt isolation */
93 IOMMU_CAP_NOEXEC
, /* IOMMU_NOEXEC flag */
97 * Following constraints are specifc to FSL_PAMUV1:
98 * -aperture must be power of 2, and naturally aligned
99 * -number of windows must be power of 2, and address space size
100 * of each window is determined by aperture size / # of windows
101 * -the actual size of the mapped region of a window must be power
102 * of 2 starting with 4KB and physical address must be naturally
104 * DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints.
105 * The caller can invoke iommu_domain_get_attr to check if the underlying
106 * iommu implementation supports these constraints.
110 DOMAIN_ATTR_GEOMETRY
,
113 DOMAIN_ATTR_FSL_PAMU_STASH
,
114 DOMAIN_ATTR_FSL_PAMU_ENABLE
,
115 DOMAIN_ATTR_FSL_PAMUV1
,
116 DOMAIN_ATTR_NESTING
, /* two stages of translation */
120 /* These are the possible reserved region types */
121 #define IOMMU_RESV_DIRECT (1 << 0)
122 #define IOMMU_RESV_RESERVED (1 << 1)
123 #define IOMMU_RESV_MSI (1 << 2)
126 * struct iommu_resv_region - descriptor for a reserved memory region
127 * @list: Linked list pointers
128 * @start: System physical start address of the region
129 * @length: Length of the region in bytes
130 * @prot: IOMMU Protection flags (READ/WRITE/...)
131 * @type: Type of the reserved region
133 struct iommu_resv_region
{
134 struct list_head list
;
141 #ifdef CONFIG_IOMMU_API
144 * struct iommu_ops - iommu ops and capabilities
145 * @capable: check capability
146 * @domain_alloc: allocate iommu domain
147 * @domain_free: free iommu domain
148 * @attach_dev: attach device to an iommu domain
149 * @detach_dev: detach device from an iommu domain
150 * @map: map a physically contiguous memory region to an iommu domain
151 * @unmap: unmap a physically contiguous memory region from an iommu domain
152 * @map_sg: map a scatter-gather list of physically contiguous memory chunks
154 * @iova_to_phys: translate iova to physical address
155 * @add_device: add device to iommu grouping
156 * @remove_device: remove device from iommu grouping
157 * @device_group: find iommu group for a particular device
158 * @domain_get_attr: Query domain attributes
159 * @domain_set_attr: Change domain attributes
160 * @get_resv_regions: Request list of reserved regions for a device
161 * @put_resv_regions: Free list of reserved regions for a device
162 * @apply_resv_region: Temporary helper call-back for iova reserved ranges
163 * @domain_window_enable: Configure and enable a particular window for a domain
164 * @domain_window_disable: Disable a particular window for a domain
165 * @domain_set_windows: Set the number of windows for a domain
166 * @domain_get_windows: Return the number of windows for a domain
167 * @of_xlate: add OF master IDs to iommu grouping
168 * @pgsize_bitmap: bitmap of all possible supported page sizes
171 bool (*capable
)(enum iommu_cap
);
173 /* Domain allocation and freeing by the iommu driver */
174 struct iommu_domain
*(*domain_alloc
)(unsigned iommu_domain_type
);
175 void (*domain_free
)(struct iommu_domain
*);
177 int (*attach_dev
)(struct iommu_domain
*domain
, struct device
*dev
);
178 void (*detach_dev
)(struct iommu_domain
*domain
, struct device
*dev
);
179 int (*map
)(struct iommu_domain
*domain
, unsigned long iova
,
180 phys_addr_t paddr
, size_t size
, int prot
);
181 size_t (*unmap
)(struct iommu_domain
*domain
, unsigned long iova
,
183 size_t (*map_sg
)(struct iommu_domain
*domain
, unsigned long iova
,
184 struct scatterlist
*sg
, unsigned int nents
, int prot
);
185 phys_addr_t (*iova_to_phys
)(struct iommu_domain
*domain
, dma_addr_t iova
);
186 int (*add_device
)(struct device
*dev
);
187 void (*remove_device
)(struct device
*dev
);
188 struct iommu_group
*(*device_group
)(struct device
*dev
);
189 int (*domain_get_attr
)(struct iommu_domain
*domain
,
190 enum iommu_attr attr
, void *data
);
191 int (*domain_set_attr
)(struct iommu_domain
*domain
,
192 enum iommu_attr attr
, void *data
);
194 /* Request/Free a list of reserved regions for a device */
195 void (*get_resv_regions
)(struct device
*dev
, struct list_head
*list
);
196 void (*put_resv_regions
)(struct device
*dev
, struct list_head
*list
);
197 void (*apply_resv_region
)(struct device
*dev
,
198 struct iommu_domain
*domain
,
199 struct iommu_resv_region
*region
);
201 /* Window handling functions */
202 int (*domain_window_enable
)(struct iommu_domain
*domain
, u32 wnd_nr
,
203 phys_addr_t paddr
, u64 size
, int prot
);
204 void (*domain_window_disable
)(struct iommu_domain
*domain
, u32 wnd_nr
);
205 /* Set the number of windows per domain */
206 int (*domain_set_windows
)(struct iommu_domain
*domain
, u32 w_count
);
207 /* Get the number of windows per domain */
208 u32 (*domain_get_windows
)(struct iommu_domain
*domain
);
210 int (*of_xlate
)(struct device
*dev
, struct of_phandle_args
*args
);
212 unsigned long pgsize_bitmap
;
216 * struct iommu_device - IOMMU core representation of one IOMMU hardware
218 * @list: Used by the iommu-core to keep a list of registered iommus
219 * @ops: iommu-ops for talking to this iommu
220 * @dev: struct device for sysfs handling
222 struct iommu_device
{
223 struct list_head list
;
224 const struct iommu_ops
*ops
;
225 struct fwnode_handle
*fwnode
;
229 int iommu_device_register(struct iommu_device
*iommu
);
230 void iommu_device_unregister(struct iommu_device
*iommu
);
231 int iommu_device_sysfs_add(struct iommu_device
*iommu
,
232 struct device
*parent
,
233 const struct attribute_group
**groups
,
234 const char *fmt
, ...) __printf(4, 5);
235 void iommu_device_sysfs_remove(struct iommu_device
*iommu
);
236 int iommu_device_link(struct iommu_device
*iommu
, struct device
*link
);
237 void iommu_device_unlink(struct iommu_device
*iommu
, struct device
*link
);
239 static inline void iommu_device_set_ops(struct iommu_device
*iommu
,
240 const struct iommu_ops
*ops
)
245 static inline void iommu_device_set_fwnode(struct iommu_device
*iommu
,
246 struct fwnode_handle
*fwnode
)
248 iommu
->fwnode
= fwnode
;
251 #define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
252 #define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
253 #define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
254 #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
255 #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
256 #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
258 extern int bus_set_iommu(struct bus_type
*bus
, const struct iommu_ops
*ops
);
259 extern bool iommu_present(struct bus_type
*bus
);
260 extern bool iommu_capable(struct bus_type
*bus
, enum iommu_cap cap
);
261 extern struct iommu_domain
*iommu_domain_alloc(struct bus_type
*bus
);
262 extern struct iommu_group
*iommu_group_get_by_id(int id
);
263 extern void iommu_domain_free(struct iommu_domain
*domain
);
264 extern int iommu_attach_device(struct iommu_domain
*domain
,
266 extern void iommu_detach_device(struct iommu_domain
*domain
,
268 extern struct iommu_domain
*iommu_get_domain_for_dev(struct device
*dev
);
269 extern int iommu_map(struct iommu_domain
*domain
, unsigned long iova
,
270 phys_addr_t paddr
, size_t size
, int prot
);
271 extern size_t iommu_unmap(struct iommu_domain
*domain
, unsigned long iova
,
273 extern size_t default_iommu_map_sg(struct iommu_domain
*domain
, unsigned long iova
,
274 struct scatterlist
*sg
,unsigned int nents
,
276 extern phys_addr_t
iommu_iova_to_phys(struct iommu_domain
*domain
, dma_addr_t iova
);
277 extern void iommu_set_fault_handler(struct iommu_domain
*domain
,
278 iommu_fault_handler_t handler
, void *token
);
280 extern void iommu_get_resv_regions(struct device
*dev
, struct list_head
*list
);
281 extern void iommu_put_resv_regions(struct device
*dev
, struct list_head
*list
);
282 extern int iommu_request_dm_for_dev(struct device
*dev
);
283 extern struct iommu_resv_region
*
284 iommu_alloc_resv_region(phys_addr_t start
, size_t length
, int prot
, int type
);
285 extern int iommu_get_group_resv_regions(struct iommu_group
*group
,
286 struct list_head
*head
);
288 extern int iommu_attach_group(struct iommu_domain
*domain
,
289 struct iommu_group
*group
);
290 extern void iommu_detach_group(struct iommu_domain
*domain
,
291 struct iommu_group
*group
);
292 extern struct iommu_group
*iommu_group_alloc(void);
293 extern void *iommu_group_get_iommudata(struct iommu_group
*group
);
294 extern void iommu_group_set_iommudata(struct iommu_group
*group
,
296 void (*release
)(void *iommu_data
));
297 extern int iommu_group_set_name(struct iommu_group
*group
, const char *name
);
298 extern int iommu_group_add_device(struct iommu_group
*group
,
300 extern void iommu_group_remove_device(struct device
*dev
);
301 extern int iommu_group_for_each_dev(struct iommu_group
*group
, void *data
,
302 int (*fn
)(struct device
*, void *));
303 extern struct iommu_group
*iommu_group_get(struct device
*dev
);
304 extern struct iommu_group
*iommu_group_ref_get(struct iommu_group
*group
);
305 extern void iommu_group_put(struct iommu_group
*group
);
306 extern int iommu_group_register_notifier(struct iommu_group
*group
,
307 struct notifier_block
*nb
);
308 extern int iommu_group_unregister_notifier(struct iommu_group
*group
,
309 struct notifier_block
*nb
);
310 extern int iommu_group_id(struct iommu_group
*group
);
311 extern struct iommu_group
*iommu_group_get_for_dev(struct device
*dev
);
312 extern struct iommu_domain
*iommu_group_default_domain(struct iommu_group
*);
314 extern int iommu_domain_get_attr(struct iommu_domain
*domain
, enum iommu_attr
,
316 extern int iommu_domain_set_attr(struct iommu_domain
*domain
, enum iommu_attr
,
319 /* Window handling function prototypes */
320 extern int iommu_domain_window_enable(struct iommu_domain
*domain
, u32 wnd_nr
,
321 phys_addr_t offset
, u64 size
,
323 extern void iommu_domain_window_disable(struct iommu_domain
*domain
, u32 wnd_nr
);
325 * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
326 * @domain: the iommu domain where the fault has happened
327 * @dev: the device where the fault has happened
328 * @iova: the faulting address
329 * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
331 * This function should be called by the low-level IOMMU implementations
332 * whenever IOMMU faults happen, to allow high-level users, that are
333 * interested in such events, to know about them.
335 * This event may be useful for several possible use cases:
336 * - mere logging of the event
337 * - dynamic TLB/PTE loading
338 * - if restarting of the faulting device is required
340 * Returns 0 on success and an appropriate error code otherwise (if dynamic
341 * PTE/TLB loading will one day be supported, implementations will be able
342 * to tell whether it succeeded or not according to this return value).
344 * Specifically, -ENOSYS is returned if a fault handler isn't installed
345 * (though fault handlers can also return -ENOSYS, in case they want to
346 * elicit the default behavior of the IOMMU drivers).
348 static inline int report_iommu_fault(struct iommu_domain
*domain
,
349 struct device
*dev
, unsigned long iova
, int flags
)
354 * if upper layers showed interest and installed a fault handler,
358 ret
= domain
->handler(domain
, dev
, iova
, flags
,
359 domain
->handler_token
);
361 trace_io_page_fault(dev
, iova
, flags
);
365 static inline size_t iommu_map_sg(struct iommu_domain
*domain
,
366 unsigned long iova
, struct scatterlist
*sg
,
367 unsigned int nents
, int prot
)
369 return domain
->ops
->map_sg(domain
, iova
, sg
, nents
, prot
);
372 /* PCI device grouping function */
373 extern struct iommu_group
*pci_device_group(struct device
*dev
);
374 /* Generic device grouping function */
375 extern struct iommu_group
*generic_device_group(struct device
*dev
);
378 * struct iommu_fwspec - per-device IOMMU instance data
379 * @ops: ops for this device's IOMMU
380 * @iommu_fwnode: firmware handle for this device's IOMMU
381 * @iommu_priv: IOMMU driver private data for this device
382 * @num_ids: number of associated device IDs
383 * @ids: IDs which this device may present to the IOMMU
385 struct iommu_fwspec
{
386 const struct iommu_ops
*ops
;
387 struct fwnode_handle
*iommu_fwnode
;
389 unsigned int num_ids
;
393 int iommu_fwspec_init(struct device
*dev
, struct fwnode_handle
*iommu_fwnode
,
394 const struct iommu_ops
*ops
);
395 void iommu_fwspec_free(struct device
*dev
);
396 int iommu_fwspec_add_ids(struct device
*dev
, u32
*ids
, int num_ids
);
397 void iommu_register_instance(struct fwnode_handle
*fwnode
,
398 const struct iommu_ops
*ops
);
399 const struct iommu_ops
*iommu_ops_from_fwnode(struct fwnode_handle
*fwnode
);
401 #else /* CONFIG_IOMMU_API */
404 struct iommu_group
{};
405 struct iommu_fwspec
{};
406 struct iommu_device
{};
408 static inline bool iommu_present(struct bus_type
*bus
)
413 static inline bool iommu_capable(struct bus_type
*bus
, enum iommu_cap cap
)
418 static inline struct iommu_domain
*iommu_domain_alloc(struct bus_type
*bus
)
423 static inline struct iommu_group
*iommu_group_get_by_id(int id
)
428 static inline void iommu_domain_free(struct iommu_domain
*domain
)
432 static inline int iommu_attach_device(struct iommu_domain
*domain
,
438 static inline void iommu_detach_device(struct iommu_domain
*domain
,
443 static inline struct iommu_domain
*iommu_get_domain_for_dev(struct device
*dev
)
448 static inline int iommu_map(struct iommu_domain
*domain
, unsigned long iova
,
449 phys_addr_t paddr
, int gfp_order
, int prot
)
454 static inline int iommu_unmap(struct iommu_domain
*domain
, unsigned long iova
,
460 static inline size_t iommu_map_sg(struct iommu_domain
*domain
,
461 unsigned long iova
, struct scatterlist
*sg
,
462 unsigned int nents
, int prot
)
467 static inline int iommu_domain_window_enable(struct iommu_domain
*domain
,
468 u32 wnd_nr
, phys_addr_t paddr
,
474 static inline void iommu_domain_window_disable(struct iommu_domain
*domain
,
479 static inline phys_addr_t
iommu_iova_to_phys(struct iommu_domain
*domain
, dma_addr_t iova
)
484 static inline void iommu_set_fault_handler(struct iommu_domain
*domain
,
485 iommu_fault_handler_t handler
, void *token
)
489 static inline void iommu_get_resv_regions(struct device
*dev
,
490 struct list_head
*list
)
494 static inline void iommu_put_resv_regions(struct device
*dev
,
495 struct list_head
*list
)
499 static inline int iommu_get_group_resv_regions(struct iommu_group
*group
,
500 struct list_head
*head
)
505 static inline int iommu_request_dm_for_dev(struct device
*dev
)
510 static inline int iommu_attach_group(struct iommu_domain
*domain
,
511 struct iommu_group
*group
)
516 static inline void iommu_detach_group(struct iommu_domain
*domain
,
517 struct iommu_group
*group
)
521 static inline struct iommu_group
*iommu_group_alloc(void)
523 return ERR_PTR(-ENODEV
);
526 static inline void *iommu_group_get_iommudata(struct iommu_group
*group
)
531 static inline void iommu_group_set_iommudata(struct iommu_group
*group
,
533 void (*release
)(void *iommu_data
))
537 static inline int iommu_group_set_name(struct iommu_group
*group
,
543 static inline int iommu_group_add_device(struct iommu_group
*group
,
549 static inline void iommu_group_remove_device(struct device
*dev
)
553 static inline int iommu_group_for_each_dev(struct iommu_group
*group
,
555 int (*fn
)(struct device
*, void *))
560 static inline struct iommu_group
*iommu_group_get(struct device
*dev
)
565 static inline void iommu_group_put(struct iommu_group
*group
)
569 static inline int iommu_group_register_notifier(struct iommu_group
*group
,
570 struct notifier_block
*nb
)
575 static inline int iommu_group_unregister_notifier(struct iommu_group
*group
,
576 struct notifier_block
*nb
)
581 static inline int iommu_group_id(struct iommu_group
*group
)
586 static inline int iommu_domain_get_attr(struct iommu_domain
*domain
,
587 enum iommu_attr attr
, void *data
)
592 static inline int iommu_domain_set_attr(struct iommu_domain
*domain
,
593 enum iommu_attr attr
, void *data
)
598 static inline int iommu_device_register(struct iommu_device
*iommu
)
603 static inline void iommu_device_set_ops(struct iommu_device
*iommu
,
604 const struct iommu_ops
*ops
)
608 static inline void iommu_device_set_fwnode(struct iommu_device
*iommu
,
609 struct fwnode_handle
*fwnode
)
613 static inline void iommu_device_unregister(struct iommu_device
*iommu
)
617 static inline int iommu_device_sysfs_add(struct iommu_device
*iommu
,
618 struct device
*parent
,
619 const struct attribute_group
**groups
,
620 const char *fmt
, ...)
625 static inline void iommu_device_sysfs_remove(struct iommu_device
*iommu
)
629 static inline int iommu_device_link(struct device
*dev
, struct device
*link
)
634 static inline void iommu_device_unlink(struct device
*dev
, struct device
*link
)
638 static inline int iommu_fwspec_init(struct device
*dev
,
639 struct fwnode_handle
*iommu_fwnode
,
640 const struct iommu_ops
*ops
)
645 static inline void iommu_fwspec_free(struct device
*dev
)
649 static inline int iommu_fwspec_add_ids(struct device
*dev
, u32
*ids
,
655 static inline void iommu_register_instance(struct fwnode_handle
*fwnode
,
656 const struct iommu_ops
*ops
)
661 const struct iommu_ops
*iommu_ops_from_fwnode(struct fwnode_handle
*fwnode
)
666 #endif /* CONFIG_IOMMU_API */
668 #endif /* __LINUX_IOMMU_H */