048653817af9927b1d22ea654e369e73c8d8148f
[linux-2.6.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 struct iommu_ops {
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,
59                      int gfp_order);
60         phys_addr_t (*iova_to_phys)(struct iommu_domain *domain,
61                                     unsigned long iova);
62         int (*domain_has_cap)(struct iommu_domain *domain,
63                               unsigned long cap);
64 };
65
66 extern void register_iommu(struct iommu_ops *ops);
67 extern int bus_set_iommu(struct bus_type *bus, struct iommu_ops *ops);
68 extern bool iommu_found(void);
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,
72                                struct device *dev);
73 extern void iommu_detach_device(struct iommu_domain *domain,
74                                 struct device *dev);
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,
78                        int gfp_order);
79 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain,
80                                       unsigned long iova);
81 extern int iommu_domain_has_cap(struct iommu_domain *domain,
82                                 unsigned long cap);
83 extern void iommu_set_fault_handler(struct iommu_domain *domain,
84                                         iommu_fault_handler_t handler);
85
86 /**
87  * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
88  * @domain: the iommu domain where the fault has happened
89  * @dev: the device where the fault has happened
90  * @iova: the faulting address
91  * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
92  *
93  * This function should be called by the low-level IOMMU implementations
94  * whenever IOMMU faults happen, to allow high-level users, that are
95  * interested in such events, to know about them.
96  *
97  * This event may be useful for several possible use cases:
98  * - mere logging of the event
99  * - dynamic TLB/PTE loading
100  * - if restarting of the faulting device is required
101  *
102  * Returns 0 on success and an appropriate error code otherwise (if dynamic
103  * PTE/TLB loading will one day be supported, implementations will be able
104  * to tell whether it succeeded or not according to this return value).
105  *
106  * Specifically, -ENOSYS is returned if a fault handler isn't installed
107  * (though fault handlers can also return -ENOSYS, in case they want to
108  * elicit the default behavior of the IOMMU drivers).
109  */
110 static inline int report_iommu_fault(struct iommu_domain *domain,
111                 struct device *dev, unsigned long iova, int flags)
112 {
113         int ret = -ENOSYS;
114
115         /*
116          * if upper layers showed interest and installed a fault handler,
117          * invoke it.
118          */
119         if (domain->handler)
120                 ret = domain->handler(domain, dev, iova, flags);
121
122         return ret;
123 }
124
125 #else /* CONFIG_IOMMU_API */
126
127 struct iommu_ops {};
128
129 static inline bool iommu_found(void)
130 {
131         return false;
132 }
133
134 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
135 {
136         return NULL;
137 }
138
139 static inline void iommu_domain_free(struct iommu_domain *domain)
140 {
141 }
142
143 static inline int iommu_attach_device(struct iommu_domain *domain,
144                                       struct device *dev)
145 {
146         return -ENODEV;
147 }
148
149 static inline void iommu_detach_device(struct iommu_domain *domain,
150                                        struct device *dev)
151 {
152 }
153
154 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
155                             phys_addr_t paddr, int gfp_order, int prot)
156 {
157         return -ENODEV;
158 }
159
160 static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
161                               int gfp_order)
162 {
163         return -ENODEV;
164 }
165
166 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain,
167                                              unsigned long iova)
168 {
169         return 0;
170 }
171
172 static inline int domain_has_cap(struct iommu_domain *domain,
173                                  unsigned long cap)
174 {
175         return 0;
176 }
177
178 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
179                                         iommu_fault_handler_t handler)
180 {
181 }
182
183 #endif /* CONFIG_IOMMU_API */
184
185 #endif /* __LINUX_IOMMU_H */