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, void *);
41 struct iommu_ops
*ops
;
43 iommu_fault_handler_t handler
;
47 #define IOMMU_CAP_CACHE_COHERENCY 0x1
48 #define IOMMU_CAP_INTR_REMAP 0x2 /* isolates device intrs */
50 #ifdef CONFIG_IOMMU_API
53 * struct iommu_ops - iommu ops and capabilities
54 * @domain_init: init iommu domain
55 * @domain_destroy: destroy iommu domain
56 * @attach_dev: attach device to an iommu domain
57 * @detach_dev: detach device from an iommu domain
58 * @map: map a physically contiguous memory region to an iommu domain
59 * @unmap: unmap a physically contiguous memory region from an iommu domain
60 * @iova_to_phys: translate iova to physical address
61 * @domain_has_cap: domain capabilities query
62 * @commit: commit iommu domain
63 * @pgsize_bitmap: bitmap of supported page sizes
66 int (*domain_init
)(struct iommu_domain
*domain
);
67 void (*domain_destroy
)(struct iommu_domain
*domain
);
68 int (*attach_dev
)(struct iommu_domain
*domain
, struct device
*dev
);
69 void (*detach_dev
)(struct iommu_domain
*domain
, struct device
*dev
);
70 int (*map
)(struct iommu_domain
*domain
, unsigned long iova
,
71 phys_addr_t paddr
, size_t size
, int prot
);
72 size_t (*unmap
)(struct iommu_domain
*domain
, unsigned long iova
,
74 phys_addr_t (*iova_to_phys
)(struct iommu_domain
*domain
,
76 int (*domain_has_cap
)(struct iommu_domain
*domain
,
78 int (*device_group
)(struct device
*dev
, unsigned int *groupid
);
79 unsigned long pgsize_bitmap
;
82 extern int bus_set_iommu(struct bus_type
*bus
, struct iommu_ops
*ops
);
83 extern bool iommu_present(struct bus_type
*bus
);
84 extern struct iommu_domain
*iommu_domain_alloc(struct bus_type
*bus
);
85 extern void iommu_domain_free(struct iommu_domain
*domain
);
86 extern int iommu_attach_device(struct iommu_domain
*domain
,
88 extern void iommu_detach_device(struct iommu_domain
*domain
,
90 extern int iommu_map(struct iommu_domain
*domain
, unsigned long iova
,
91 phys_addr_t paddr
, size_t size
, int prot
);
92 extern size_t iommu_unmap(struct iommu_domain
*domain
, unsigned long iova
,
94 extern phys_addr_t
iommu_iova_to_phys(struct iommu_domain
*domain
,
96 extern int iommu_domain_has_cap(struct iommu_domain
*domain
,
98 extern void iommu_set_fault_handler(struct iommu_domain
*domain
,
99 iommu_fault_handler_t handler
, void *token
);
100 extern int iommu_device_group(struct device
*dev
, unsigned int *groupid
);
103 * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
104 * @domain: the iommu domain where the fault has happened
105 * @dev: the device where the fault has happened
106 * @iova: the faulting address
107 * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
109 * This function should be called by the low-level IOMMU implementations
110 * whenever IOMMU faults happen, to allow high-level users, that are
111 * interested in such events, to know about them.
113 * This event may be useful for several possible use cases:
114 * - mere logging of the event
115 * - dynamic TLB/PTE loading
116 * - if restarting of the faulting device is required
118 * Returns 0 on success and an appropriate error code otherwise (if dynamic
119 * PTE/TLB loading will one day be supported, implementations will be able
120 * to tell whether it succeeded or not according to this return value).
122 * Specifically, -ENOSYS is returned if a fault handler isn't installed
123 * (though fault handlers can also return -ENOSYS, in case they want to
124 * elicit the default behavior of the IOMMU drivers).
126 static inline int report_iommu_fault(struct iommu_domain
*domain
,
127 struct device
*dev
, unsigned long iova
, int flags
)
132 * if upper layers showed interest and installed a fault handler,
136 ret
= domain
->handler(domain
, dev
, iova
, flags
,
137 domain
->handler_token
);
142 #else /* CONFIG_IOMMU_API */
146 static inline bool iommu_present(struct bus_type
*bus
)
151 static inline struct iommu_domain
*iommu_domain_alloc(struct bus_type
*bus
)
156 static inline void iommu_domain_free(struct iommu_domain
*domain
)
160 static inline int iommu_attach_device(struct iommu_domain
*domain
,
166 static inline void iommu_detach_device(struct iommu_domain
*domain
,
171 static inline int iommu_map(struct iommu_domain
*domain
, unsigned long iova
,
172 phys_addr_t paddr
, int gfp_order
, int prot
)
177 static inline int iommu_unmap(struct iommu_domain
*domain
, unsigned long iova
,
183 static inline phys_addr_t
iommu_iova_to_phys(struct iommu_domain
*domain
,
189 static inline int domain_has_cap(struct iommu_domain
*domain
,
195 static inline void iommu_set_fault_handler(struct iommu_domain
*domain
,
196 iommu_fault_handler_t handler
, void *token
)
200 static inline int iommu_device_group(struct device
*dev
, unsigned int *groupid
)
205 #endif /* CONFIG_IOMMU_API */
207 #endif /* __LINUX_IOMMU_H */