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;
223 * struct iommu_device - IOMMU core representation of one IOMMU hardware
225 * @list: Used by the iommu-core to keep a list of registered iommus
226 * @ops: iommu-ops for talking to this iommu
227 * @dev: struct device for sysfs handling
229 struct iommu_device {
230 struct list_head list;
231 const struct iommu_ops *ops;
232 struct fwnode_handle *fwnode;
236 int iommu_device_register(struct iommu_device *iommu);
237 void iommu_device_unregister(struct iommu_device *iommu);
238 int iommu_device_sysfs_add(struct iommu_device *iommu,
239 struct device *parent,
240 const struct attribute_group **groups,
241 const char *fmt, ...) __printf(4, 5);
242 void iommu_device_sysfs_remove(struct iommu_device *iommu);
243 int iommu_device_link(struct iommu_device *iommu, struct device *link);
244 void iommu_device_unlink(struct iommu_device *iommu, struct device *link);
246 static inline void iommu_device_set_ops(struct iommu_device *iommu,
247 const struct iommu_ops *ops)
252 static inline void iommu_device_set_fwnode(struct iommu_device *iommu,
253 struct fwnode_handle *fwnode)
255 iommu->fwnode = fwnode;
258 #define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
259 #define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
260 #define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
261 #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
262 #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
263 #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
265 extern int bus_set_iommu(struct bus_type *bus, const struct iommu_ops *ops);
266 extern bool iommu_present(struct bus_type *bus);
267 extern bool iommu_capable(struct bus_type *bus, enum iommu_cap cap);
268 extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
269 extern struct iommu_group *iommu_group_get_by_id(int id);
270 extern void iommu_domain_free(struct iommu_domain *domain);
271 extern int iommu_attach_device(struct iommu_domain *domain,
273 extern void iommu_detach_device(struct iommu_domain *domain,
275 extern struct iommu_domain *iommu_get_domain_for_dev(struct device *dev);
276 extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
277 phys_addr_t paddr, size_t size, int prot);
278 extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
280 extern size_t default_iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
281 struct scatterlist *sg,unsigned int nents,
283 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
284 extern void iommu_set_fault_handler(struct iommu_domain *domain,
285 iommu_fault_handler_t handler, void *token);
287 extern void iommu_get_resv_regions(struct device *dev, struct list_head *list);
288 extern void iommu_put_resv_regions(struct device *dev, struct list_head *list);
289 extern int iommu_request_dm_for_dev(struct device *dev);
290 extern struct iommu_resv_region *
291 iommu_alloc_resv_region(phys_addr_t start, size_t length, int prot, int type);
292 extern int iommu_get_group_resv_regions(struct iommu_group *group,
293 struct list_head *head);
295 extern int iommu_attach_group(struct iommu_domain *domain,
296 struct iommu_group *group);
297 extern void iommu_detach_group(struct iommu_domain *domain,
298 struct iommu_group *group);
299 extern struct iommu_group *iommu_group_alloc(void);
300 extern void *iommu_group_get_iommudata(struct iommu_group *group);
301 extern void iommu_group_set_iommudata(struct iommu_group *group,
303 void (*release)(void *iommu_data));
304 extern int iommu_group_set_name(struct iommu_group *group, const char *name);
305 extern int iommu_group_add_device(struct iommu_group *group,
307 extern void iommu_group_remove_device(struct device *dev);
308 extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
309 int (*fn)(struct device *, void *));
310 extern struct iommu_group *iommu_group_get(struct device *dev);
311 extern struct iommu_group *iommu_group_ref_get(struct iommu_group *group);
312 extern void iommu_group_put(struct iommu_group *group);
313 extern int iommu_group_register_notifier(struct iommu_group *group,
314 struct notifier_block *nb);
315 extern int iommu_group_unregister_notifier(struct iommu_group *group,
316 struct notifier_block *nb);
317 extern int iommu_group_id(struct iommu_group *group);
318 extern struct iommu_group *iommu_group_get_for_dev(struct device *dev);
319 extern struct iommu_domain *iommu_group_default_domain(struct iommu_group *);
321 extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
323 extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
326 /* Window handling function prototypes */
327 extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
328 phys_addr_t offset, u64 size,
330 extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr);
332 * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
333 * @domain: the iommu domain where the fault has happened
334 * @dev: the device where the fault has happened
335 * @iova: the faulting address
336 * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
338 * This function should be called by the low-level IOMMU implementations
339 * whenever IOMMU faults happen, to allow high-level users, that are
340 * interested in such events, to know about them.
342 * This event may be useful for several possible use cases:
343 * - mere logging of the event
344 * - dynamic TLB/PTE loading
345 * - if restarting of the faulting device is required
347 * Returns 0 on success and an appropriate error code otherwise (if dynamic
348 * PTE/TLB loading will one day be supported, implementations will be able
349 * to tell whether it succeeded or not according to this return value).
351 * Specifically, -ENOSYS is returned if a fault handler isn't installed
352 * (though fault handlers can also return -ENOSYS, in case they want to
353 * elicit the default behavior of the IOMMU drivers).
355 static inline int report_iommu_fault(struct iommu_domain *domain,
356 struct device *dev, unsigned long iova, int flags)
361 * if upper layers showed interest and installed a fault handler,
365 ret = domain->handler(domain, dev, iova, flags,
366 domain->handler_token);
368 trace_io_page_fault(dev, iova, flags);
372 static inline size_t iommu_map_sg(struct iommu_domain *domain,
373 unsigned long iova, struct scatterlist *sg,
374 unsigned int nents, int prot)
376 return domain->ops->map_sg(domain, iova, sg, nents, prot);
379 /* PCI device grouping function */
380 extern struct iommu_group *pci_device_group(struct device *dev);
381 /* Generic device grouping function */
382 extern struct iommu_group *generic_device_group(struct device *dev);
385 * struct iommu_fwspec - per-device IOMMU instance data
386 * @ops: ops for this device's IOMMU
387 * @iommu_fwnode: firmware handle for this device's IOMMU
388 * @iommu_priv: IOMMU driver private data for this device
389 * @num_ids: number of associated device IDs
390 * @ids: IDs which this device may present to the IOMMU
392 struct iommu_fwspec {
393 const struct iommu_ops *ops;
394 struct fwnode_handle *iommu_fwnode;
396 unsigned int num_ids;
400 int iommu_fwspec_init(struct device *dev, struct fwnode_handle *iommu_fwnode,
401 const struct iommu_ops *ops);
402 void iommu_fwspec_free(struct device *dev);
403 int iommu_fwspec_add_ids(struct device *dev, u32 *ids, int num_ids);
404 const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode);
406 #else /* CONFIG_IOMMU_API */
409 struct iommu_group {};
410 struct iommu_fwspec {};
411 struct iommu_device {};
413 static inline bool iommu_present(struct bus_type *bus)
418 static inline bool iommu_capable(struct bus_type *bus, enum iommu_cap cap)
423 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
428 static inline struct iommu_group *iommu_group_get_by_id(int id)
433 static inline void iommu_domain_free(struct iommu_domain *domain)
437 static inline int iommu_attach_device(struct iommu_domain *domain,
443 static inline void iommu_detach_device(struct iommu_domain *domain,
448 static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
453 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
454 phys_addr_t paddr, int gfp_order, int prot)
459 static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
465 static inline size_t iommu_map_sg(struct iommu_domain *domain,
466 unsigned long iova, struct scatterlist *sg,
467 unsigned int nents, int prot)
472 static inline int iommu_domain_window_enable(struct iommu_domain *domain,
473 u32 wnd_nr, phys_addr_t paddr,
479 static inline void iommu_domain_window_disable(struct iommu_domain *domain,
484 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
489 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
490 iommu_fault_handler_t handler, void *token)
494 static inline void iommu_get_resv_regions(struct device *dev,
495 struct list_head *list)
499 static inline void iommu_put_resv_regions(struct device *dev,
500 struct list_head *list)
504 static inline int iommu_get_group_resv_regions(struct iommu_group *group,
505 struct list_head *head)
510 static inline int iommu_request_dm_for_dev(struct device *dev)
515 static inline int iommu_attach_group(struct iommu_domain *domain,
516 struct iommu_group *group)
521 static inline void iommu_detach_group(struct iommu_domain *domain,
522 struct iommu_group *group)
526 static inline struct iommu_group *iommu_group_alloc(void)
528 return ERR_PTR(-ENODEV);
531 static inline void *iommu_group_get_iommudata(struct iommu_group *group)
536 static inline void iommu_group_set_iommudata(struct iommu_group *group,
538 void (*release)(void *iommu_data))
542 static inline int iommu_group_set_name(struct iommu_group *group,
548 static inline int iommu_group_add_device(struct iommu_group *group,
554 static inline void iommu_group_remove_device(struct device *dev)
558 static inline int iommu_group_for_each_dev(struct iommu_group *group,
560 int (*fn)(struct device *, void *))
565 static inline struct iommu_group *iommu_group_get(struct device *dev)
570 static inline void iommu_group_put(struct iommu_group *group)
574 static inline int iommu_group_register_notifier(struct iommu_group *group,
575 struct notifier_block *nb)
580 static inline int iommu_group_unregister_notifier(struct iommu_group *group,
581 struct notifier_block *nb)
586 static inline int iommu_group_id(struct iommu_group *group)
591 static inline int iommu_domain_get_attr(struct iommu_domain *domain,
592 enum iommu_attr attr, void *data)
597 static inline int iommu_domain_set_attr(struct iommu_domain *domain,
598 enum iommu_attr attr, void *data)
603 static inline int iommu_device_register(struct iommu_device *iommu)
608 static inline void iommu_device_set_ops(struct iommu_device *iommu,
609 const struct iommu_ops *ops)
613 static inline void iommu_device_set_fwnode(struct iommu_device *iommu,
614 struct fwnode_handle *fwnode)
618 static inline void iommu_device_unregister(struct iommu_device *iommu)
622 static inline int iommu_device_sysfs_add(struct iommu_device *iommu,
623 struct device *parent,
624 const struct attribute_group **groups,
625 const char *fmt, ...)
630 static inline void iommu_device_sysfs_remove(struct iommu_device *iommu)
634 static inline int iommu_device_link(struct device *dev, struct device *link)
639 static inline void iommu_device_unlink(struct device *dev, struct device *link)
643 static inline int iommu_fwspec_init(struct device *dev,
644 struct fwnode_handle *iommu_fwnode,
645 const struct iommu_ops *ops)
650 static inline void iommu_fwspec_free(struct device *dev)
654 static inline int iommu_fwspec_add_ids(struct device *dev, u32 *ids,
661 const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode)
666 #endif /* CONFIG_IOMMU_API */
668 #endif /* __LINUX_IOMMU_H */