]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - include/linux/iommu.h
vfio/type1: Fix error return code in vfio_iommu_type1_attach_group()
[mirror_ubuntu-artful-kernel.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 #include <linux/err.h>
24 #include <linux/of.h>
25 #include <linux/types.h>
26 #include <linux/scatterlist.h>
27 #include <trace/events/iommu.h>
28
29 #define IOMMU_READ (1 << 0)
30 #define IOMMU_WRITE (1 << 1)
31 #define IOMMU_CACHE (1 << 2) /* DMA cache coherency */
32 #define IOMMU_NOEXEC (1 << 3)
33 #define IOMMU_MMIO (1 << 4) /* e.g. things like MSI doorbells */
34 /*
35 * This is to make the IOMMU API setup privileged
36 * mapppings accessible by the master only at higher
37 * privileged execution level and inaccessible at
38 * less privileged levels.
39 */
40 #define IOMMU_PRIV (1 << 5)
41
42 struct iommu_ops;
43 struct iommu_group;
44 struct bus_type;
45 struct device;
46 struct iommu_domain;
47 struct notifier_block;
48
49 /* iommu fault flags */
50 #define IOMMU_FAULT_READ 0x0
51 #define IOMMU_FAULT_WRITE 0x1
52
53 typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
54 struct device *, unsigned long, int, void *);
55
56 struct iommu_domain_geometry {
57 dma_addr_t aperture_start; /* First address that can be mapped */
58 dma_addr_t aperture_end; /* Last address that can be mapped */
59 bool force_aperture; /* DMA only allowed in mappable range? */
60 };
61
62 /* Domain feature flags */
63 #define __IOMMU_DOMAIN_PAGING (1U << 0) /* Support for iommu_map/unmap */
64 #define __IOMMU_DOMAIN_DMA_API (1U << 1) /* Domain for use in DMA-API
65 implementation */
66 #define __IOMMU_DOMAIN_PT (1U << 2) /* Domain is identity mapped */
67
68 /*
69 * This are the possible domain-types
70 *
71 * IOMMU_DOMAIN_BLOCKED - All DMA is blocked, can be used to isolate
72 * devices
73 * IOMMU_DOMAIN_IDENTITY - DMA addresses are system physical addresses
74 * IOMMU_DOMAIN_UNMANAGED - DMA mappings managed by IOMMU-API user, used
75 * for VMs
76 * IOMMU_DOMAIN_DMA - Internally used for DMA-API implementations.
77 * This flag allows IOMMU drivers to implement
78 * certain optimizations for these domains
79 */
80 #define IOMMU_DOMAIN_BLOCKED (0U)
81 #define IOMMU_DOMAIN_IDENTITY (__IOMMU_DOMAIN_PT)
82 #define IOMMU_DOMAIN_UNMANAGED (__IOMMU_DOMAIN_PAGING)
83 #define IOMMU_DOMAIN_DMA (__IOMMU_DOMAIN_PAGING | \
84 __IOMMU_DOMAIN_DMA_API)
85
86 struct iommu_domain {
87 unsigned type;
88 const struct iommu_ops *ops;
89 unsigned long pgsize_bitmap; /* Bitmap of page sizes in use */
90 iommu_fault_handler_t handler;
91 void *handler_token;
92 struct iommu_domain_geometry geometry;
93 void *iova_cookie;
94 };
95
96 enum iommu_cap {
97 IOMMU_CAP_CACHE_COHERENCY, /* IOMMU can enforce cache coherent DMA
98 transactions */
99 IOMMU_CAP_INTR_REMAP, /* IOMMU supports interrupt isolation */
100 IOMMU_CAP_NOEXEC, /* IOMMU_NOEXEC flag */
101 };
102
103 /*
104 * Following constraints are specifc to FSL_PAMUV1:
105 * -aperture must be power of 2, and naturally aligned
106 * -number of windows must be power of 2, and address space size
107 * of each window is determined by aperture size / # of windows
108 * -the actual size of the mapped region of a window must be power
109 * of 2 starting with 4KB and physical address must be naturally
110 * aligned.
111 * DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints.
112 * The caller can invoke iommu_domain_get_attr to check if the underlying
113 * iommu implementation supports these constraints.
114 */
115
116 enum iommu_attr {
117 DOMAIN_ATTR_GEOMETRY,
118 DOMAIN_ATTR_PAGING,
119 DOMAIN_ATTR_WINDOWS,
120 DOMAIN_ATTR_FSL_PAMU_STASH,
121 DOMAIN_ATTR_FSL_PAMU_ENABLE,
122 DOMAIN_ATTR_FSL_PAMUV1,
123 DOMAIN_ATTR_NESTING, /* two stages of translation */
124 DOMAIN_ATTR_MAX,
125 };
126
127 /* These are the possible reserved region types */
128 #define IOMMU_RESV_DIRECT (1 << 0)
129 #define IOMMU_RESV_RESERVED (1 << 1)
130 #define IOMMU_RESV_MSI (1 << 2)
131
132 /**
133 * struct iommu_resv_region - descriptor for a reserved memory region
134 * @list: Linked list pointers
135 * @start: System physical start address of the region
136 * @length: Length of the region in bytes
137 * @prot: IOMMU Protection flags (READ/WRITE/...)
138 * @type: Type of the reserved region
139 */
140 struct iommu_resv_region {
141 struct list_head list;
142 phys_addr_t start;
143 size_t length;
144 int prot;
145 int type;
146 };
147
148 #ifdef CONFIG_IOMMU_API
149
150 /**
151 * struct iommu_ops - iommu ops and capabilities
152 * @capable: check capability
153 * @domain_alloc: allocate iommu domain
154 * @domain_free: free iommu domain
155 * @attach_dev: attach device to an iommu domain
156 * @detach_dev: detach device from an iommu domain
157 * @map: map a physically contiguous memory region to an iommu domain
158 * @unmap: unmap a physically contiguous memory region from an iommu domain
159 * @map_sg: map a scatter-gather list of physically contiguous memory chunks
160 * to an iommu domain
161 * @iova_to_phys: translate iova to physical address
162 * @add_device: add device to iommu grouping
163 * @remove_device: remove device from iommu grouping
164 * @device_group: find iommu group for a particular device
165 * @domain_get_attr: Query domain attributes
166 * @domain_set_attr: Change domain attributes
167 * @get_resv_regions: Request list of reserved regions for a device
168 * @put_resv_regions: Free list of reserved regions for a device
169 * @apply_resv_region: Temporary helper call-back for iova reserved ranges
170 * @domain_window_enable: Configure and enable a particular window for a domain
171 * @domain_window_disable: Disable a particular window for a domain
172 * @domain_set_windows: Set the number of windows for a domain
173 * @domain_get_windows: Return the number of windows for a domain
174 * @of_xlate: add OF master IDs to iommu grouping
175 * @pgsize_bitmap: bitmap of all possible supported page sizes
176 */
177 struct iommu_ops {
178 bool (*capable)(enum iommu_cap);
179
180 /* Domain allocation and freeing by the iommu driver */
181 struct iommu_domain *(*domain_alloc)(unsigned iommu_domain_type);
182 void (*domain_free)(struct iommu_domain *);
183
184 int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
185 void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
186 int (*map)(struct iommu_domain *domain, unsigned long iova,
187 phys_addr_t paddr, size_t size, int prot);
188 size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
189 size_t size);
190 size_t (*map_sg)(struct iommu_domain *domain, unsigned long iova,
191 struct scatterlist *sg, unsigned int nents, int prot);
192 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova);
193 int (*add_device)(struct device *dev);
194 void (*remove_device)(struct device *dev);
195 struct iommu_group *(*device_group)(struct device *dev);
196 int (*domain_get_attr)(struct iommu_domain *domain,
197 enum iommu_attr attr, void *data);
198 int (*domain_set_attr)(struct iommu_domain *domain,
199 enum iommu_attr attr, void *data);
200
201 /* Request/Free a list of reserved regions for a device */
202 void (*get_resv_regions)(struct device *dev, struct list_head *list);
203 void (*put_resv_regions)(struct device *dev, struct list_head *list);
204 void (*apply_resv_region)(struct device *dev,
205 struct iommu_domain *domain,
206 struct iommu_resv_region *region);
207
208 /* Window handling functions */
209 int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr,
210 phys_addr_t paddr, u64 size, int prot);
211 void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr);
212 /* Set the number of windows per domain */
213 int (*domain_set_windows)(struct iommu_domain *domain, u32 w_count);
214 /* Get the number of windows per domain */
215 u32 (*domain_get_windows)(struct iommu_domain *domain);
216
217 int (*of_xlate)(struct device *dev, struct of_phandle_args *args);
218
219 unsigned long pgsize_bitmap;
220 };
221
222 #define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
223 #define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
224 #define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
225 #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
226 #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
227 #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
228
229 extern int bus_set_iommu(struct bus_type *bus, const struct iommu_ops *ops);
230 extern bool iommu_present(struct bus_type *bus);
231 extern bool iommu_capable(struct bus_type *bus, enum iommu_cap cap);
232 extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
233 extern struct iommu_group *iommu_group_get_by_id(int id);
234 extern void iommu_domain_free(struct iommu_domain *domain);
235 extern int iommu_attach_device(struct iommu_domain *domain,
236 struct device *dev);
237 extern void iommu_detach_device(struct iommu_domain *domain,
238 struct device *dev);
239 extern struct iommu_domain *iommu_get_domain_for_dev(struct device *dev);
240 extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
241 phys_addr_t paddr, size_t size, int prot);
242 extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
243 size_t size);
244 extern size_t default_iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
245 struct scatterlist *sg,unsigned int nents,
246 int prot);
247 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
248 extern void iommu_set_fault_handler(struct iommu_domain *domain,
249 iommu_fault_handler_t handler, void *token);
250
251 extern void iommu_get_resv_regions(struct device *dev, struct list_head *list);
252 extern void iommu_put_resv_regions(struct device *dev, struct list_head *list);
253 extern int iommu_request_dm_for_dev(struct device *dev);
254 extern struct iommu_resv_region *
255 iommu_alloc_resv_region(phys_addr_t start, size_t length, int prot, int type);
256 extern int iommu_get_group_resv_regions(struct iommu_group *group,
257 struct list_head *head);
258
259 extern int iommu_attach_group(struct iommu_domain *domain,
260 struct iommu_group *group);
261 extern void iommu_detach_group(struct iommu_domain *domain,
262 struct iommu_group *group);
263 extern struct iommu_group *iommu_group_alloc(void);
264 extern void *iommu_group_get_iommudata(struct iommu_group *group);
265 extern void iommu_group_set_iommudata(struct iommu_group *group,
266 void *iommu_data,
267 void (*release)(void *iommu_data));
268 extern int iommu_group_set_name(struct iommu_group *group, const char *name);
269 extern int iommu_group_add_device(struct iommu_group *group,
270 struct device *dev);
271 extern void iommu_group_remove_device(struct device *dev);
272 extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
273 int (*fn)(struct device *, void *));
274 extern struct iommu_group *iommu_group_get(struct device *dev);
275 extern struct iommu_group *iommu_group_ref_get(struct iommu_group *group);
276 extern void iommu_group_put(struct iommu_group *group);
277 extern int iommu_group_register_notifier(struct iommu_group *group,
278 struct notifier_block *nb);
279 extern int iommu_group_unregister_notifier(struct iommu_group *group,
280 struct notifier_block *nb);
281 extern int iommu_group_id(struct iommu_group *group);
282 extern struct iommu_group *iommu_group_get_for_dev(struct device *dev);
283 extern struct iommu_domain *iommu_group_default_domain(struct iommu_group *);
284
285 extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
286 void *data);
287 extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
288 void *data);
289 struct device *iommu_device_create(struct device *parent, void *drvdata,
290 const struct attribute_group **groups,
291 const char *fmt, ...) __printf(4, 5);
292 void iommu_device_destroy(struct device *dev);
293 int iommu_device_link(struct device *dev, struct device *link);
294 void iommu_device_unlink(struct device *dev, struct device *link);
295
296 /* Window handling function prototypes */
297 extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
298 phys_addr_t offset, u64 size,
299 int prot);
300 extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr);
301 /**
302 * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
303 * @domain: the iommu domain where the fault has happened
304 * @dev: the device where the fault has happened
305 * @iova: the faulting address
306 * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
307 *
308 * This function should be called by the low-level IOMMU implementations
309 * whenever IOMMU faults happen, to allow high-level users, that are
310 * interested in such events, to know about them.
311 *
312 * This event may be useful for several possible use cases:
313 * - mere logging of the event
314 * - dynamic TLB/PTE loading
315 * - if restarting of the faulting device is required
316 *
317 * Returns 0 on success and an appropriate error code otherwise (if dynamic
318 * PTE/TLB loading will one day be supported, implementations will be able
319 * to tell whether it succeeded or not according to this return value).
320 *
321 * Specifically, -ENOSYS is returned if a fault handler isn't installed
322 * (though fault handlers can also return -ENOSYS, in case they want to
323 * elicit the default behavior of the IOMMU drivers).
324 */
325 static inline int report_iommu_fault(struct iommu_domain *domain,
326 struct device *dev, unsigned long iova, int flags)
327 {
328 int ret = -ENOSYS;
329
330 /*
331 * if upper layers showed interest and installed a fault handler,
332 * invoke it.
333 */
334 if (domain->handler)
335 ret = domain->handler(domain, dev, iova, flags,
336 domain->handler_token);
337
338 trace_io_page_fault(dev, iova, flags);
339 return ret;
340 }
341
342 static inline size_t iommu_map_sg(struct iommu_domain *domain,
343 unsigned long iova, struct scatterlist *sg,
344 unsigned int nents, int prot)
345 {
346 return domain->ops->map_sg(domain, iova, sg, nents, prot);
347 }
348
349 /* PCI device grouping function */
350 extern struct iommu_group *pci_device_group(struct device *dev);
351 /* Generic device grouping function */
352 extern struct iommu_group *generic_device_group(struct device *dev);
353
354 /**
355 * struct iommu_fwspec - per-device IOMMU instance data
356 * @ops: ops for this device's IOMMU
357 * @iommu_fwnode: firmware handle for this device's IOMMU
358 * @iommu_priv: IOMMU driver private data for this device
359 * @num_ids: number of associated device IDs
360 * @ids: IDs which this device may present to the IOMMU
361 */
362 struct iommu_fwspec {
363 const struct iommu_ops *ops;
364 struct fwnode_handle *iommu_fwnode;
365 void *iommu_priv;
366 unsigned int num_ids;
367 u32 ids[1];
368 };
369
370 int iommu_fwspec_init(struct device *dev, struct fwnode_handle *iommu_fwnode,
371 const struct iommu_ops *ops);
372 void iommu_fwspec_free(struct device *dev);
373 int iommu_fwspec_add_ids(struct device *dev, u32 *ids, int num_ids);
374 void iommu_register_instance(struct fwnode_handle *fwnode,
375 const struct iommu_ops *ops);
376 const struct iommu_ops *iommu_get_instance(struct fwnode_handle *fwnode);
377
378 #else /* CONFIG_IOMMU_API */
379
380 struct iommu_ops {};
381 struct iommu_group {};
382 struct iommu_fwspec {};
383
384 static inline bool iommu_present(struct bus_type *bus)
385 {
386 return false;
387 }
388
389 static inline bool iommu_capable(struct bus_type *bus, enum iommu_cap cap)
390 {
391 return false;
392 }
393
394 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
395 {
396 return NULL;
397 }
398
399 static inline struct iommu_group *iommu_group_get_by_id(int id)
400 {
401 return NULL;
402 }
403
404 static inline void iommu_domain_free(struct iommu_domain *domain)
405 {
406 }
407
408 static inline int iommu_attach_device(struct iommu_domain *domain,
409 struct device *dev)
410 {
411 return -ENODEV;
412 }
413
414 static inline void iommu_detach_device(struct iommu_domain *domain,
415 struct device *dev)
416 {
417 }
418
419 static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
420 {
421 return NULL;
422 }
423
424 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
425 phys_addr_t paddr, int gfp_order, int prot)
426 {
427 return -ENODEV;
428 }
429
430 static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
431 int gfp_order)
432 {
433 return -ENODEV;
434 }
435
436 static inline size_t iommu_map_sg(struct iommu_domain *domain,
437 unsigned long iova, struct scatterlist *sg,
438 unsigned int nents, int prot)
439 {
440 return -ENODEV;
441 }
442
443 static inline int iommu_domain_window_enable(struct iommu_domain *domain,
444 u32 wnd_nr, phys_addr_t paddr,
445 u64 size, int prot)
446 {
447 return -ENODEV;
448 }
449
450 static inline void iommu_domain_window_disable(struct iommu_domain *domain,
451 u32 wnd_nr)
452 {
453 }
454
455 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
456 {
457 return 0;
458 }
459
460 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
461 iommu_fault_handler_t handler, void *token)
462 {
463 }
464
465 static inline void iommu_get_resv_regions(struct device *dev,
466 struct list_head *list)
467 {
468 }
469
470 static inline void iommu_put_resv_regions(struct device *dev,
471 struct list_head *list)
472 {
473 }
474
475 static inline int iommu_get_group_resv_regions(struct iommu_group *group,
476 struct list_head *head)
477 {
478 return -ENODEV;
479 }
480
481 static inline int iommu_request_dm_for_dev(struct device *dev)
482 {
483 return -ENODEV;
484 }
485
486 static inline int iommu_attach_group(struct iommu_domain *domain,
487 struct iommu_group *group)
488 {
489 return -ENODEV;
490 }
491
492 static inline void iommu_detach_group(struct iommu_domain *domain,
493 struct iommu_group *group)
494 {
495 }
496
497 static inline struct iommu_group *iommu_group_alloc(void)
498 {
499 return ERR_PTR(-ENODEV);
500 }
501
502 static inline void *iommu_group_get_iommudata(struct iommu_group *group)
503 {
504 return NULL;
505 }
506
507 static inline void iommu_group_set_iommudata(struct iommu_group *group,
508 void *iommu_data,
509 void (*release)(void *iommu_data))
510 {
511 }
512
513 static inline int iommu_group_set_name(struct iommu_group *group,
514 const char *name)
515 {
516 return -ENODEV;
517 }
518
519 static inline int iommu_group_add_device(struct iommu_group *group,
520 struct device *dev)
521 {
522 return -ENODEV;
523 }
524
525 static inline void iommu_group_remove_device(struct device *dev)
526 {
527 }
528
529 static inline int iommu_group_for_each_dev(struct iommu_group *group,
530 void *data,
531 int (*fn)(struct device *, void *))
532 {
533 return -ENODEV;
534 }
535
536 static inline struct iommu_group *iommu_group_get(struct device *dev)
537 {
538 return NULL;
539 }
540
541 static inline void iommu_group_put(struct iommu_group *group)
542 {
543 }
544
545 static inline int iommu_group_register_notifier(struct iommu_group *group,
546 struct notifier_block *nb)
547 {
548 return -ENODEV;
549 }
550
551 static inline int iommu_group_unregister_notifier(struct iommu_group *group,
552 struct notifier_block *nb)
553 {
554 return 0;
555 }
556
557 static inline int iommu_group_id(struct iommu_group *group)
558 {
559 return -ENODEV;
560 }
561
562 static inline int iommu_domain_get_attr(struct iommu_domain *domain,
563 enum iommu_attr attr, void *data)
564 {
565 return -EINVAL;
566 }
567
568 static inline int iommu_domain_set_attr(struct iommu_domain *domain,
569 enum iommu_attr attr, void *data)
570 {
571 return -EINVAL;
572 }
573
574 static inline struct device *iommu_device_create(struct device *parent,
575 void *drvdata,
576 const struct attribute_group **groups,
577 const char *fmt, ...)
578 {
579 return ERR_PTR(-ENODEV);
580 }
581
582 static inline void iommu_device_destroy(struct device *dev)
583 {
584 }
585
586 static inline int iommu_device_link(struct device *dev, struct device *link)
587 {
588 return -EINVAL;
589 }
590
591 static inline void iommu_device_unlink(struct device *dev, struct device *link)
592 {
593 }
594
595 static inline int iommu_fwspec_init(struct device *dev,
596 struct fwnode_handle *iommu_fwnode,
597 const struct iommu_ops *ops)
598 {
599 return -ENODEV;
600 }
601
602 static inline void iommu_fwspec_free(struct device *dev)
603 {
604 }
605
606 static inline int iommu_fwspec_add_ids(struct device *dev, u32 *ids,
607 int num_ids)
608 {
609 return -ENODEV;
610 }
611
612 static inline void iommu_register_instance(struct fwnode_handle *fwnode,
613 const struct iommu_ops *ops)
614 {
615 }
616
617 static inline
618 const struct iommu_ops *iommu_get_instance(struct fwnode_handle *fwnode)
619 {
620 return NULL;
621 }
622
623 #endif /* CONFIG_IOMMU_API */
624
625 #endif /* __LINUX_IOMMU_H */