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>
24 #define IOMMU_READ (1)
25 #define IOMMU_WRITE (2)
26 #define IOMMU_CACHE (4) /* DMA cache coherency */
33 /* iommu fault flags */
34 #define IOMMU_FAULT_READ 0x0
35 #define IOMMU_FAULT_WRITE 0x1
37 typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
38 struct device *, unsigned long, int);
41 struct iommu_ops *ops;
43 iommu_fault_handler_t handler;
46 #define IOMMU_CAP_CACHE_COHERENCY 0x1
47 #define IOMMU_CAP_INTR_REMAP 0x2 /* isolates device intrs */
49 #ifdef CONFIG_IOMMU_API
52 * struct iommu_ops - iommu ops and capabilities
53 * @domain_init: init iommu domain
54 * @domain_destroy: destroy iommu domain
55 * @attach_dev: attach device to an iommu domain
56 * @detach_dev: detach device from an iommu domain
57 * @map: map a physically contiguous memory region to an iommu domain
58 * @unmap: unmap a physically contiguous memory region from an iommu domain
59 * @iova_to_phys: translate iova to physical address
60 * @domain_has_cap: domain capabilities query
61 * @commit: commit iommu domain
62 * @pgsize_bitmap: bitmap of supported page sizes
65 int (*domain_init)(struct iommu_domain *domain);
66 void (*domain_destroy)(struct iommu_domain *domain);
67 int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
68 void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
69 int (*map)(struct iommu_domain *domain, unsigned long iova,
70 phys_addr_t paddr, size_t size, int prot);
71 size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
73 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain,
75 int (*domain_has_cap)(struct iommu_domain *domain,
77 unsigned long pgsize_bitmap;
80 extern int bus_set_iommu(struct bus_type *bus, struct iommu_ops *ops);
81 extern bool iommu_present(struct bus_type *bus);
82 extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
83 extern void iommu_domain_free(struct iommu_domain *domain);
84 extern int iommu_attach_device(struct iommu_domain *domain,
86 extern void iommu_detach_device(struct iommu_domain *domain,
88 extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
89 phys_addr_t paddr, size_t size, int prot);
90 extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
92 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain,
94 extern int iommu_domain_has_cap(struct iommu_domain *domain,
96 extern void iommu_set_fault_handler(struct iommu_domain *domain,
97 iommu_fault_handler_t handler);
100 * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
101 * @domain: the iommu domain where the fault has happened
102 * @dev: the device where the fault has happened
103 * @iova: the faulting address
104 * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
106 * This function should be called by the low-level IOMMU implementations
107 * whenever IOMMU faults happen, to allow high-level users, that are
108 * interested in such events, to know about them.
110 * This event may be useful for several possible use cases:
111 * - mere logging of the event
112 * - dynamic TLB/PTE loading
113 * - if restarting of the faulting device is required
115 * Returns 0 on success and an appropriate error code otherwise (if dynamic
116 * PTE/TLB loading will one day be supported, implementations will be able
117 * to tell whether it succeeded or not according to this return value).
119 * Specifically, -ENOSYS is returned if a fault handler isn't installed
120 * (though fault handlers can also return -ENOSYS, in case they want to
121 * elicit the default behavior of the IOMMU drivers).
123 static inline int report_iommu_fault(struct iommu_domain *domain,
124 struct device *dev, unsigned long iova, int flags)
129 * if upper layers showed interest and installed a fault handler,
133 ret = domain->handler(domain, dev, iova, flags);
138 #else /* CONFIG_IOMMU_API */
142 static inline bool iommu_present(struct bus_type *bus)
147 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
152 static inline void iommu_domain_free(struct iommu_domain *domain)
156 static inline int iommu_attach_device(struct iommu_domain *domain,
162 static inline void iommu_detach_device(struct iommu_domain *domain,
167 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
168 phys_addr_t paddr, int gfp_order, int prot)
173 static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
179 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain,
185 static inline int domain_has_cap(struct iommu_domain *domain,
191 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
192 iommu_fault_handler_t handler)
196 #endif /* CONFIG_IOMMU_API */
198 #endif /* __LINUX_IOMMU_H */