Merge branches 'iommu/fixes', 'arm/omap' and 'x86/amd' into next
[~shefty/rdma-dev.git] / include / linux / iommu.h
1 /*
2  * Copyright (C) 2007-2008 Advanced Micro Devices, Inc.
3  * Author: Joerg Roedel <joerg.roedel@amd.com>
4  *
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.
8  *
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.
13  *
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
17  */
18
19 #ifndef __LINUX_IOMMU_H
20 #define __LINUX_IOMMU_H
21
22 #include <linux/errno.h>
23
24 #define IOMMU_READ      (1)
25 #define IOMMU_WRITE     (2)
26 #define IOMMU_CACHE     (4) /* DMA cache coherency */
27
28 struct iommu_ops;
29 struct bus_type;
30 struct device;
31 struct iommu_domain;
32
33 /* iommu fault flags */
34 #define IOMMU_FAULT_READ        0x0
35 #define IOMMU_FAULT_WRITE       0x1
36
37 typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
38                                 struct device *, unsigned long, int);
39
40 struct iommu_domain {
41         struct iommu_ops *ops;
42         void *priv;
43         iommu_fault_handler_t handler;
44 };
45
46 #define IOMMU_CAP_CACHE_COHERENCY       0x1
47 #define IOMMU_CAP_INTR_REMAP            0x2     /* isolates device intrs */
48
49 #ifdef CONFIG_IOMMU_API
50
51 /**
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
63  */
64 struct iommu_ops {
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,
72                      size_t size);
73         phys_addr_t (*iova_to_phys)(struct iommu_domain *domain,
74                                     unsigned long iova);
75         int (*domain_has_cap)(struct iommu_domain *domain,
76                               unsigned long cap);
77         unsigned long pgsize_bitmap;
78 };
79
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,
85                                struct device *dev);
86 extern void iommu_detach_device(struct iommu_domain *domain,
87                                 struct device *dev);
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,
91                        size_t size);
92 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain,
93                                       unsigned long iova);
94 extern int iommu_domain_has_cap(struct iommu_domain *domain,
95                                 unsigned long cap);
96 extern void iommu_set_fault_handler(struct iommu_domain *domain,
97                                         iommu_fault_handler_t handler);
98
99 /**
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/...)
105  *
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.
109  *
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
114  *
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).
118  *
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).
122  */
123 static inline int report_iommu_fault(struct iommu_domain *domain,
124                 struct device *dev, unsigned long iova, int flags)
125 {
126         int ret = -ENOSYS;
127
128         /*
129          * if upper layers showed interest and installed a fault handler,
130          * invoke it.
131          */
132         if (domain->handler)
133                 ret = domain->handler(domain, dev, iova, flags);
134
135         return ret;
136 }
137
138 #else /* CONFIG_IOMMU_API */
139
140 struct iommu_ops {};
141
142 static inline bool iommu_present(struct bus_type *bus)
143 {
144         return false;
145 }
146
147 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
148 {
149         return NULL;
150 }
151
152 static inline void iommu_domain_free(struct iommu_domain *domain)
153 {
154 }
155
156 static inline int iommu_attach_device(struct iommu_domain *domain,
157                                       struct device *dev)
158 {
159         return -ENODEV;
160 }
161
162 static inline void iommu_detach_device(struct iommu_domain *domain,
163                                        struct device *dev)
164 {
165 }
166
167 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
168                             phys_addr_t paddr, int gfp_order, int prot)
169 {
170         return -ENODEV;
171 }
172
173 static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
174                               int gfp_order)
175 {
176         return -ENODEV;
177 }
178
179 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain,
180                                              unsigned long iova)
181 {
182         return 0;
183 }
184
185 static inline int domain_has_cap(struct iommu_domain *domain,
186                                  unsigned long cap)
187 {
188         return 0;
189 }
190
191 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
192                                         iommu_fault_handler_t handler)
193 {
194 }
195
196 #endif /* CONFIG_IOMMU_API */
197
198 #endif /* __LINUX_IOMMU_H */