blob: f3b99e1c1042ac4073b681ee30ff7ea1f0f9a3a3 [file] [log] [blame]
Joerg Roedel4a77a6c2008-11-26 17:02:33 +01001/*
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
Laura Abbott74315cc2011-06-08 17:29:11 -040022#include <linux/errno.h>
Thierry Reding76582d02012-07-25 16:24:49 +020023#include <linux/types.h>
Laura Abbott74315cc2011-06-08 17:29:11 -040024
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010025#define IOMMU_READ (1)
26#define IOMMU_WRITE (2)
Sheng Yang9cf066972009-03-18 15:33:07 +080027#define IOMMU_CACHE (4) /* DMA cache coherency */
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010028
Joerg Roedel905d66c2011-09-06 16:03:26 +020029struct iommu_ops;
Alex Williamsond72e31c2012-05-30 14:18:53 -060030struct iommu_group;
Joerg Roedelff217762011-08-26 16:48:26 +020031struct bus_type;
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010032struct device;
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -040033struct iommu_domain;
Joerg Roedelba1eabfa2012-08-03 15:55:41 +020034struct notifier_block;
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -040035
36/* iommu fault flags */
37#define IOMMU_FAULT_READ 0x0
38#define IOMMU_FAULT_WRITE 0x1
39
40typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +030041 struct device *, unsigned long, int, void *);
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010042
Joerg Roedel0ff64f82012-01-26 19:40:53 +010043struct iommu_domain_geometry {
44 dma_addr_t aperture_start; /* First address that can be mapped */
45 dma_addr_t aperture_end; /* Last address that can be mapped */
46 bool force_aperture; /* DMA only allowed in mappable range? */
47};
48
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010049struct iommu_domain {
Joerg Roedel905d66c2011-09-06 16:03:26 +020050 struct iommu_ops *ops;
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010051 void *priv;
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -040052 iommu_fault_handler_t handler;
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +030053 void *handler_token;
Joerg Roedel0ff64f82012-01-26 19:40:53 +010054 struct iommu_domain_geometry geometry;
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010055};
56
Sheng Yangdbb9fd82009-03-18 15:33:06 +080057#define IOMMU_CAP_CACHE_COHERENCY 0x1
Tom Lyon323f99c2010-07-02 16:56:14 -040058#define IOMMU_CAP_INTR_REMAP 0x2 /* isolates device intrs */
Sheng Yangdbb9fd82009-03-18 15:33:06 +080059
Joerg Roedel0cd76dd2012-01-26 19:40:52 +010060enum iommu_attr {
61 DOMAIN_ATTR_MAX,
Joerg Roedel0ff64f82012-01-26 19:40:53 +010062 DOMAIN_ATTR_GEOMETRY,
Joerg Roedel0cd76dd2012-01-26 19:40:52 +010063};
64
Joerg Roedel39d4ebb2011-09-06 16:48:40 +020065#ifdef CONFIG_IOMMU_API
66
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +020067/**
68 * struct iommu_ops - iommu ops and capabilities
69 * @domain_init: init iommu domain
70 * @domain_destroy: destroy iommu domain
71 * @attach_dev: attach device to an iommu domain
72 * @detach_dev: detach device from an iommu domain
73 * @map: map a physically contiguous memory region to an iommu domain
74 * @unmap: unmap a physically contiguous memory region from an iommu domain
75 * @iova_to_phys: translate iova to physical address
76 * @domain_has_cap: domain capabilities query
Alex Williamsond72e31c2012-05-30 14:18:53 -060077 * @add_device: add device to iommu grouping
78 * @remove_device: remove device from iommu grouping
Joerg Roedel0cd76dd2012-01-26 19:40:52 +010079 * @domain_get_attr: Query domain attributes
80 * @domain_set_attr: Change domain attributes
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +020081 * @pgsize_bitmap: bitmap of supported page sizes
82 */
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010083struct iommu_ops {
84 int (*domain_init)(struct iommu_domain *domain);
85 void (*domain_destroy)(struct iommu_domain *domain);
86 int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
87 void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
Joerg Roedel67651782010-01-21 16:32:27 +010088 int (*map)(struct iommu_domain *domain, unsigned long iova,
Ohad Ben-Cohen50090652011-11-10 11:32:25 +020089 phys_addr_t paddr, size_t size, int prot);
90 size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
91 size_t size);
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010092 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain,
93 unsigned long iova);
Sheng Yangdbb9fd82009-03-18 15:33:06 +080094 int (*domain_has_cap)(struct iommu_domain *domain,
95 unsigned long cap);
Alex Williamsond72e31c2012-05-30 14:18:53 -060096 int (*add_device)(struct device *dev);
97 void (*remove_device)(struct device *dev);
Alex Williamson14604322011-10-21 15:56:05 -040098 int (*device_group)(struct device *dev, unsigned int *groupid);
Joerg Roedel0cd76dd2012-01-26 19:40:52 +010099 int (*domain_get_attr)(struct iommu_domain *domain,
100 enum iommu_attr attr, void *data);
101 int (*domain_set_attr)(struct iommu_domain *domain,
102 enum iommu_attr attr, void *data);
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200103 unsigned long pgsize_bitmap;
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100104};
105
Alex Williamsond72e31c2012-05-30 14:18:53 -0600106#define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
107#define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
108#define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
109#define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
110#define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
111#define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
112
Joerg Roedelff217762011-08-26 16:48:26 +0200113extern int bus_set_iommu(struct bus_type *bus, struct iommu_ops *ops);
Joerg Roedela1b60c12011-09-06 18:46:34 +0200114extern bool iommu_present(struct bus_type *bus);
Joerg Roedel905d66c2011-09-06 16:03:26 +0200115extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100116extern void iommu_domain_free(struct iommu_domain *domain);
117extern int iommu_attach_device(struct iommu_domain *domain,
118 struct device *dev);
119extern void iommu_detach_device(struct iommu_domain *domain,
120 struct device *dev);
Joerg Roedelcefc53c2010-01-08 13:35:09 +0100121extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200122 phys_addr_t paddr, size_t size, int prot);
123extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
124 size_t size);
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100125extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain,
126 unsigned long iova);
Sheng Yangdbb9fd82009-03-18 15:33:06 +0800127extern int iommu_domain_has_cap(struct iommu_domain *domain,
128 unsigned long cap);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400129extern void iommu_set_fault_handler(struct iommu_domain *domain,
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +0300130 iommu_fault_handler_t handler, void *token);
Alex Williamsond72e31c2012-05-30 14:18:53 -0600131
132extern int iommu_attach_group(struct iommu_domain *domain,
133 struct iommu_group *group);
134extern void iommu_detach_group(struct iommu_domain *domain,
135 struct iommu_group *group);
136extern struct iommu_group *iommu_group_alloc(void);
137extern void *iommu_group_get_iommudata(struct iommu_group *group);
138extern void iommu_group_set_iommudata(struct iommu_group *group,
139 void *iommu_data,
140 void (*release)(void *iommu_data));
141extern int iommu_group_set_name(struct iommu_group *group, const char *name);
142extern int iommu_group_add_device(struct iommu_group *group,
143 struct device *dev);
144extern void iommu_group_remove_device(struct device *dev);
145extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
146 int (*fn)(struct device *, void *));
147extern struct iommu_group *iommu_group_get(struct device *dev);
148extern void iommu_group_put(struct iommu_group *group);
149extern int iommu_group_register_notifier(struct iommu_group *group,
150 struct notifier_block *nb);
151extern int iommu_group_unregister_notifier(struct iommu_group *group,
152 struct notifier_block *nb);
153extern int iommu_group_id(struct iommu_group *group);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400154
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100155extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
156 void *data);
157extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
158 void *data);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400159
160/**
161 * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
162 * @domain: the iommu domain where the fault has happened
163 * @dev: the device where the fault has happened
164 * @iova: the faulting address
165 * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
166 *
167 * This function should be called by the low-level IOMMU implementations
168 * whenever IOMMU faults happen, to allow high-level users, that are
169 * interested in such events, to know about them.
170 *
171 * This event may be useful for several possible use cases:
172 * - mere logging of the event
173 * - dynamic TLB/PTE loading
174 * - if restarting of the faulting device is required
175 *
176 * Returns 0 on success and an appropriate error code otherwise (if dynamic
177 * PTE/TLB loading will one day be supported, implementations will be able
178 * to tell whether it succeeded or not according to this return value).
Ohad Ben-Cohen0ed6d2d2011-09-27 07:36:40 -0400179 *
180 * Specifically, -ENOSYS is returned if a fault handler isn't installed
181 * (though fault handlers can also return -ENOSYS, in case they want to
182 * elicit the default behavior of the IOMMU drivers).
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400183 */
184static inline int report_iommu_fault(struct iommu_domain *domain,
185 struct device *dev, unsigned long iova, int flags)
186{
Ohad Ben-Cohen0ed6d2d2011-09-27 07:36:40 -0400187 int ret = -ENOSYS;
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400188
189 /*
190 * if upper layers showed interest and installed a fault handler,
191 * invoke it.
192 */
193 if (domain->handler)
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +0300194 ret = domain->handler(domain, dev, iova, flags,
195 domain->handler_token);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400196
197 return ret;
198}
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100199
200#else /* CONFIG_IOMMU_API */
201
Joerg Roedel39d4ebb2011-09-06 16:48:40 +0200202struct iommu_ops {};
Alex Williamsond72e31c2012-05-30 14:18:53 -0600203struct iommu_group {};
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100204
Joerg Roedela1b60c12011-09-06 18:46:34 +0200205static inline bool iommu_present(struct bus_type *bus)
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100206{
207 return false;
208}
209
Joerg Roedel905d66c2011-09-06 16:03:26 +0200210static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100211{
212 return NULL;
213}
214
215static inline void iommu_domain_free(struct iommu_domain *domain)
216{
217}
218
219static inline int iommu_attach_device(struct iommu_domain *domain,
220 struct device *dev)
221{
222 return -ENODEV;
223}
224
225static inline void iommu_detach_device(struct iommu_domain *domain,
226 struct device *dev)
227{
228}
229
Joerg Roedelcefc53c2010-01-08 13:35:09 +0100230static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
231 phys_addr_t paddr, int gfp_order, int prot)
232{
233 return -ENODEV;
234}
235
236static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
237 int gfp_order)
238{
239 return -ENODEV;
240}
241
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100242static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain,
243 unsigned long iova)
244{
245 return 0;
246}
247
Sheng Yangdbb9fd82009-03-18 15:33:06 +0800248static inline int domain_has_cap(struct iommu_domain *domain,
249 unsigned long cap)
250{
251 return 0;
252}
253
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400254static inline void iommu_set_fault_handler(struct iommu_domain *domain,
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +0300255 iommu_fault_handler_t handler, void *token)
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400256{
257}
258
Alex Williamsonbef83de2012-09-24 21:23:25 -0600259static inline int iommu_attach_group(struct iommu_domain *domain,
260 struct iommu_group *group)
Alex Williamson14604322011-10-21 15:56:05 -0400261{
262 return -ENODEV;
263}
264
Alex Williamsonbef83de2012-09-24 21:23:25 -0600265static inline void iommu_detach_group(struct iommu_domain *domain,
266 struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600267{
268}
269
Alex Williamsonbef83de2012-09-24 21:23:25 -0600270static inline struct iommu_group *iommu_group_alloc(void)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600271{
272 return ERR_PTR(-ENODEV);
273}
274
Alex Williamsonbef83de2012-09-24 21:23:25 -0600275static inline void *iommu_group_get_iommudata(struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600276{
277 return NULL;
278}
279
Alex Williamsonbef83de2012-09-24 21:23:25 -0600280static inline void iommu_group_set_iommudata(struct iommu_group *group,
281 void *iommu_data,
282 void (*release)(void *iommu_data))
Alex Williamsond72e31c2012-05-30 14:18:53 -0600283{
284}
285
Alex Williamsonbef83de2012-09-24 21:23:25 -0600286static inline int iommu_group_set_name(struct iommu_group *group,
287 const char *name)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600288{
289 return -ENODEV;
290}
291
Alex Williamsonbef83de2012-09-24 21:23:25 -0600292static inline int iommu_group_add_device(struct iommu_group *group,
293 struct device *dev)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600294{
295 return -ENODEV;
296}
297
Alex Williamsonbef83de2012-09-24 21:23:25 -0600298static inline void iommu_group_remove_device(struct device *dev)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600299{
300}
301
Alex Williamsonbef83de2012-09-24 21:23:25 -0600302static inline int iommu_group_for_each_dev(struct iommu_group *group,
303 void *data,
304 int (*fn)(struct device *, void *))
Alex Williamsond72e31c2012-05-30 14:18:53 -0600305{
306 return -ENODEV;
307}
308
Alex Williamsonbef83de2012-09-24 21:23:25 -0600309static inline struct iommu_group *iommu_group_get(struct device *dev)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600310{
311 return NULL;
312}
313
Alex Williamsonbef83de2012-09-24 21:23:25 -0600314static inline void iommu_group_put(struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600315{
316}
317
Alex Williamsonbef83de2012-09-24 21:23:25 -0600318static inline int iommu_group_register_notifier(struct iommu_group *group,
319 struct notifier_block *nb)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600320{
321 return -ENODEV;
322}
323
Alex Williamsonbef83de2012-09-24 21:23:25 -0600324static inline int iommu_group_unregister_notifier(struct iommu_group *group,
325 struct notifier_block *nb)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600326{
327 return 0;
328}
329
Alex Williamsonbef83de2012-09-24 21:23:25 -0600330static inline int iommu_group_id(struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600331{
332 return -ENODEV;
333}
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100334
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100335static inline int iommu_domain_get_attr(struct iommu_domain *domain,
336 enum iommu_attr attr, void *data)
337{
338 return -EINVAL;
339}
340
341static inline int iommu_domain_set_attr(struct iommu_domain *domain,
342 enum iommu_attr attr, void *data)
343{
344 return -EINVAL;
345}
346
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100347#endif /* CONFIG_IOMMU_API */
348
349#endif /* __LINUX_IOMMU_H */