Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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#include <linux/err.h>
24#include <linux/types.h>
25#include <trace/events/iommu.h>
26
27#define IOMMU_READ (1)
28#define IOMMU_WRITE (2)
29#define IOMMU_CACHE (4) /* DMA cache coherency */
30
31struct iommu_ops;
32struct iommu_group;
33struct bus_type;
34struct device;
35struct iommu_domain;
36struct notifier_block;
37
38/* iommu fault flags */
39#define IOMMU_FAULT_READ 0x0
40#define IOMMU_FAULT_WRITE 0x1
41
42typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
43 struct device *, unsigned long, int, void *);
44
45struct iommu_domain_geometry {
46 dma_addr_t aperture_start; /* First address that can be mapped */
47 dma_addr_t aperture_end; /* Last address that can be mapped */
48 bool force_aperture; /* DMA only allowed in mappable range? */
49};
50
51struct iommu_domain {
52 struct iommu_ops *ops;
53 void *priv;
54 iommu_fault_handler_t handler;
55 void *handler_token;
56 struct iommu_domain_geometry geometry;
57};
58
59#define IOMMU_CAP_CACHE_COHERENCY 0x1
60#define IOMMU_CAP_INTR_REMAP 0x2 /* isolates device intrs */
61
62/*
63 * Following constraints are specifc to FSL_PAMUV1:
64 * -aperture must be power of 2, and naturally aligned
65 * -number of windows must be power of 2, and address space size
66 * of each window is determined by aperture size / # of windows
67 * -the actual size of the mapped region of a window must be power
68 * of 2 starting with 4KB and physical address must be naturally
69 * aligned.
70 * DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints.
71 * The caller can invoke iommu_domain_get_attr to check if the underlying
72 * iommu implementation supports these constraints.
73 */
74
75enum iommu_attr {
76 DOMAIN_ATTR_GEOMETRY,
77 DOMAIN_ATTR_PAGING,
78 DOMAIN_ATTR_WINDOWS,
79 DOMAIN_ATTR_FSL_PAMU_STASH,
80 DOMAIN_ATTR_FSL_PAMU_ENABLE,
81 DOMAIN_ATTR_FSL_PAMUV1,
82 DOMAIN_ATTR_MAX,
83};
84
85#ifdef CONFIG_IOMMU_API
86
87/**
88 * struct iommu_ops - iommu ops and capabilities
89 * @domain_init: init iommu domain
90 * @domain_destroy: destroy iommu domain
91 * @attach_dev: attach device to an iommu domain
92 * @detach_dev: detach device from an iommu domain
93 * @map: map a physically contiguous memory region to an iommu domain
94 * @unmap: unmap a physically contiguous memory region from an iommu domain
95 * @iova_to_phys: translate iova to physical address
96 * @domain_has_cap: domain capabilities query
97 * @add_device: add device to iommu grouping
98 * @remove_device: remove device from iommu grouping
99 * @domain_get_attr: Query domain attributes
100 * @domain_set_attr: Change domain attributes
101 * @pgsize_bitmap: bitmap of supported page sizes
102 */
103struct iommu_ops {
104 int (*domain_init)(struct iommu_domain *domain);
105 void (*domain_destroy)(struct iommu_domain *domain);
106 int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
107 void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
108 int (*map)(struct iommu_domain *domain, unsigned long iova,
109 phys_addr_t paddr, size_t size, int prot);
110 size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
111 size_t size);
112 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova);
113 int (*domain_has_cap)(struct iommu_domain *domain,
114 unsigned long cap);
115 int (*add_device)(struct device *dev);
116 void (*remove_device)(struct device *dev);
117 int (*device_group)(struct device *dev, unsigned int *groupid);
118 int (*domain_get_attr)(struct iommu_domain *domain,
119 enum iommu_attr attr, void *data);
120 int (*domain_set_attr)(struct iommu_domain *domain,
121 enum iommu_attr attr, void *data);
122
123 /* Window handling functions */
124 int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr,
125 phys_addr_t paddr, u64 size, int prot);
126 void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr);
127 /* Set the numer of window per domain */
128 int (*domain_set_windows)(struct iommu_domain *domain, u32 w_count);
129 /* Get the numer of window per domain */
130 u32 (*domain_get_windows)(struct iommu_domain *domain);
131
132 unsigned long pgsize_bitmap;
133};
134
135#define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
136#define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
137#define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
138#define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
139#define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
140#define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
141
142extern int bus_set_iommu(struct bus_type *bus, struct iommu_ops *ops);
143extern bool iommu_present(struct bus_type *bus);
144extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
145extern struct iommu_group *iommu_group_get_by_id(int id);
146extern void iommu_domain_free(struct iommu_domain *domain);
147extern int iommu_attach_device(struct iommu_domain *domain,
148 struct device *dev);
149extern void iommu_detach_device(struct iommu_domain *domain,
150 struct device *dev);
151extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
152 phys_addr_t paddr, size_t size, int prot);
153extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
154 size_t size);
155extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
156extern int iommu_domain_has_cap(struct iommu_domain *domain,
157 unsigned long cap);
158extern void iommu_set_fault_handler(struct iommu_domain *domain,
159 iommu_fault_handler_t handler, void *token);
160
161extern int iommu_attach_group(struct iommu_domain *domain,
162 struct iommu_group *group);
163extern void iommu_detach_group(struct iommu_domain *domain,
164 struct iommu_group *group);
165extern struct iommu_group *iommu_group_alloc(void);
166extern void *iommu_group_get_iommudata(struct iommu_group *group);
167extern void iommu_group_set_iommudata(struct iommu_group *group,
168 void *iommu_data,
169 void (*release)(void *iommu_data));
170extern int iommu_group_set_name(struct iommu_group *group, const char *name);
171extern int iommu_group_add_device(struct iommu_group *group,
172 struct device *dev);
173extern void iommu_group_remove_device(struct device *dev);
174extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
175 int (*fn)(struct device *, void *));
176extern struct iommu_group *iommu_group_get(struct device *dev);
177extern void iommu_group_put(struct iommu_group *group);
178extern int iommu_group_register_notifier(struct iommu_group *group,
179 struct notifier_block *nb);
180extern int iommu_group_unregister_notifier(struct iommu_group *group,
181 struct notifier_block *nb);
182extern int iommu_group_id(struct iommu_group *group);
183
184extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
185 void *data);
186extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
187 void *data);
188
189/* Window handling function prototypes */
190extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
191 phys_addr_t offset, u64 size,
192 int prot);
193extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr);
194/**
195 * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
196 * @domain: the iommu domain where the fault has happened
197 * @dev: the device where the fault has happened
198 * @iova: the faulting address
199 * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
200 *
201 * This function should be called by the low-level IOMMU implementations
202 * whenever IOMMU faults happen, to allow high-level users, that are
203 * interested in such events, to know about them.
204 *
205 * This event may be useful for several possible use cases:
206 * - mere logging of the event
207 * - dynamic TLB/PTE loading
208 * - if restarting of the faulting device is required
209 *
210 * Returns 0 on success and an appropriate error code otherwise (if dynamic
211 * PTE/TLB loading will one day be supported, implementations will be able
212 * to tell whether it succeeded or not according to this return value).
213 *
214 * Specifically, -ENOSYS is returned if a fault handler isn't installed
215 * (though fault handlers can also return -ENOSYS, in case they want to
216 * elicit the default behavior of the IOMMU drivers).
217 */
218static inline int report_iommu_fault(struct iommu_domain *domain,
219 struct device *dev, unsigned long iova, int flags)
220{
221 int ret = -ENOSYS;
222
223 /*
224 * if upper layers showed interest and installed a fault handler,
225 * invoke it.
226 */
227 if (domain->handler)
228 ret = domain->handler(domain, dev, iova, flags,
229 domain->handler_token);
230
231 trace_io_page_fault(dev, iova, flags);
232 return ret;
233}
234
235#else /* CONFIG_IOMMU_API */
236
237struct iommu_ops {};
238struct iommu_group {};
239
240static inline bool iommu_present(struct bus_type *bus)
241{
242 return false;
243}
244
245static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
246{
247 return NULL;
248}
249
250static inline void iommu_domain_free(struct iommu_domain *domain)
251{
252}
253
254static inline int iommu_attach_device(struct iommu_domain *domain,
255 struct device *dev)
256{
257 return -ENODEV;
258}
259
260static inline void iommu_detach_device(struct iommu_domain *domain,
261 struct device *dev)
262{
263}
264
265static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
266 phys_addr_t paddr, int gfp_order, int prot)
267{
268 return -ENODEV;
269}
270
271static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
272 int gfp_order)
273{
274 return -ENODEV;
275}
276
277static inline int iommu_domain_window_enable(struct iommu_domain *domain,
278 u32 wnd_nr, phys_addr_t paddr,
279 u64 size, int prot)
280{
281 return -ENODEV;
282}
283
284static inline void iommu_domain_window_disable(struct iommu_domain *domain,
285 u32 wnd_nr)
286{
287}
288
289static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
290{
291 return 0;
292}
293
294static inline int domain_has_cap(struct iommu_domain *domain,
295 unsigned long cap)
296{
297 return 0;
298}
299
300static inline void iommu_set_fault_handler(struct iommu_domain *domain,
301 iommu_fault_handler_t handler, void *token)
302{
303}
304
305static inline int iommu_attach_group(struct iommu_domain *domain,
306 struct iommu_group *group)
307{
308 return -ENODEV;
309}
310
311static inline void iommu_detach_group(struct iommu_domain *domain,
312 struct iommu_group *group)
313{
314}
315
316static inline struct iommu_group *iommu_group_alloc(void)
317{
318 return ERR_PTR(-ENODEV);
319}
320
321static inline void *iommu_group_get_iommudata(struct iommu_group *group)
322{
323 return NULL;
324}
325
326static inline void iommu_group_set_iommudata(struct iommu_group *group,
327 void *iommu_data,
328 void (*release)(void *iommu_data))
329{
330}
331
332static inline int iommu_group_set_name(struct iommu_group *group,
333 const char *name)
334{
335 return -ENODEV;
336}
337
338static inline int iommu_group_add_device(struct iommu_group *group,
339 struct device *dev)
340{
341 return -ENODEV;
342}
343
344static inline void iommu_group_remove_device(struct device *dev)
345{
346}
347
348static inline int iommu_group_for_each_dev(struct iommu_group *group,
349 void *data,
350 int (*fn)(struct device *, void *))
351{
352 return -ENODEV;
353}
354
355static inline struct iommu_group *iommu_group_get(struct device *dev)
356{
357 return NULL;
358}
359
360static inline void iommu_group_put(struct iommu_group *group)
361{
362}
363
364static inline int iommu_group_register_notifier(struct iommu_group *group,
365 struct notifier_block *nb)
366{
367 return -ENODEV;
368}
369
370static inline int iommu_group_unregister_notifier(struct iommu_group *group,
371 struct notifier_block *nb)
372{
373 return 0;
374}
375
376static inline int iommu_group_id(struct iommu_group *group)
377{
378 return -ENODEV;
379}
380
381static inline int iommu_domain_get_attr(struct iommu_domain *domain,
382 enum iommu_attr attr, void *data)
383{
384 return -EINVAL;
385}
386
387static inline int iommu_domain_set_attr(struct iommu_domain *domain,
388 enum iommu_attr attr, void *data)
389{
390 return -EINVAL;
391}
392
393#endif /* CONFIG_IOMMU_API */
394
395#endif /* __LINUX_IOMMU_H */