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 int (*domain_init)(struct iommu_domain *domain);
53 void (*domain_destroy)(struct iommu_domain *domain);
54 int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
55 void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
56 int (*map)(struct iommu_domain *domain, unsigned long iova,
57 phys_addr_t paddr, int gfp_order, int prot);
58 int (*unmap)(struct iommu_domain *domain, unsigned long iova,
60 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain,
62 int (*domain_has_cap)(struct iommu_domain *domain,
64 int (*device_group)(struct device *dev, unsigned int *groupid);
67 extern int bus_set_iommu(struct bus_type *bus, struct iommu_ops *ops);
68 extern bool iommu_present(struct bus_type *bus);
69 extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
70 extern void iommu_domain_free(struct iommu_domain *domain);
71 extern int iommu_attach_device(struct iommu_domain *domain,
73 extern void iommu_detach_device(struct iommu_domain *domain,
75 extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
76 phys_addr_t paddr, int gfp_order, int prot);
77 extern int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
79 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain,
81 extern int iommu_domain_has_cap(struct iommu_domain *domain,
83 extern void iommu_set_fault_handler(struct iommu_domain *domain,
84 iommu_fault_handler_t handler);
85 extern int iommu_device_group(struct device *dev, unsigned int *groupid);
88 * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
89 * @domain: the iommu domain where the fault has happened
90 * @dev: the device where the fault has happened
91 * @iova: the faulting address
92 * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
94 * This function should be called by the low-level IOMMU implementations
95 * whenever IOMMU faults happen, to allow high-level users, that are
96 * interested in such events, to know about them.
98 * This event may be useful for several possible use cases:
99 * - mere logging of the event
100 * - dynamic TLB/PTE loading
101 * - if restarting of the faulting device is required
103 * Returns 0 on success and an appropriate error code otherwise (if dynamic
104 * PTE/TLB loading will one day be supported, implementations will be able
105 * to tell whether it succeeded or not according to this return value).
107 * Specifically, -ENOSYS is returned if a fault handler isn't installed
108 * (though fault handlers can also return -ENOSYS, in case they want to
109 * elicit the default behavior of the IOMMU drivers).
111 static inline int report_iommu_fault(struct iommu_domain *domain,
112 struct device *dev, unsigned long iova, int flags)
117 * if upper layers showed interest and installed a fault handler,
121 ret = domain->handler(domain, dev, iova, flags);
126 #else /* CONFIG_IOMMU_API */
130 static inline bool iommu_present(struct bus_type *bus)
135 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
140 static inline void iommu_domain_free(struct iommu_domain *domain)
144 static inline int iommu_attach_device(struct iommu_domain *domain,
150 static inline void iommu_detach_device(struct iommu_domain *domain,
155 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
156 phys_addr_t paddr, int gfp_order, int prot)
161 static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
167 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain,
173 static inline int domain_has_cap(struct iommu_domain *domain,
179 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
180 iommu_fault_handler_t handler)
184 static inline int iommu_device_group(struct device *dev, unsigned int *groupid)
189 #endif /* CONFIG_IOMMU_API */
191 #endif /* __LINUX_IOMMU_H */