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