1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Copyright (C) 2007-2008 Advanced Micro Devices, Inc.
4 * Author: Joerg Roedel <joerg.roedel@amd.com>
7 #ifndef __LINUX_IOMMU_H
8 #define __LINUX_IOMMU_H
10 #include <linux/scatterlist.h>
11 #include <linux/device.h>
12 #include <linux/types.h>
13 #include <linux/errno.h>
14 #include <linux/err.h>
16 #include <linux/ioasid.h>
17 #include <uapi/linux/iommu.h>
19 #define IOMMU_READ (1 << 0)
20 #define IOMMU_WRITE (1 << 1)
21 #define IOMMU_CACHE (1 << 2) /* DMA cache coherency */
22 #define IOMMU_NOEXEC (1 << 3)
23 #define IOMMU_MMIO (1 << 4) /* e.g. things like MSI doorbells */
25 * Where the bus hardware includes a privilege level as part of its access type
26 * markings, and certain devices are capable of issuing transactions marked as
27 * either 'supervisor' or 'user', the IOMMU_PRIV flag requests that the other
28 * given permission flags only apply to accesses at the higher privilege level,
29 * and that unprivileged transactions should have as little access as possible.
30 * This would usually imply the same permissions as kernel mappings on the CPU,
31 * if the IOMMU page table format is equivalent.
33 #define IOMMU_PRIV (1 << 5)
40 struct iommu_domain_ops;
41 struct notifier_block;
43 struct iommu_fault_event;
44 struct iommu_dma_cookie;
46 /* iommu fault flags */
47 #define IOMMU_FAULT_READ 0x0
48 #define IOMMU_FAULT_WRITE 0x1
50 typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
51 struct device *, unsigned long, int, void *);
52 typedef int (*iommu_dev_fault_handler_t)(struct iommu_fault *, void *);
54 struct iommu_domain_geometry {
55 dma_addr_t aperture_start; /* First address that can be mapped */
56 dma_addr_t aperture_end; /* Last address that can be mapped */
57 bool force_aperture; /* DMA only allowed in mappable range? */
60 /* Domain feature flags */
61 #define __IOMMU_DOMAIN_PAGING (1U << 0) /* Support for iommu_map/unmap */
62 #define __IOMMU_DOMAIN_DMA_API (1U << 1) /* Domain for use in DMA-API
64 #define __IOMMU_DOMAIN_PT (1U << 2) /* Domain is identity mapped */
65 #define __IOMMU_DOMAIN_DMA_FQ (1U << 3) /* DMA-API uses flush queue */
68 * This are the possible domain-types
70 * IOMMU_DOMAIN_BLOCKED - All DMA is blocked, can be used to isolate
72 * IOMMU_DOMAIN_IDENTITY - DMA addresses are system physical addresses
73 * IOMMU_DOMAIN_UNMANAGED - DMA mappings managed by IOMMU-API user, used
75 * IOMMU_DOMAIN_DMA - Internally used for DMA-API implementations.
76 * This flag allows IOMMU drivers to implement
77 * certain optimizations for these domains
78 * IOMMU_DOMAIN_DMA_FQ - As above, but definitely using batched TLB
81 #define IOMMU_DOMAIN_BLOCKED (0U)
82 #define IOMMU_DOMAIN_IDENTITY (__IOMMU_DOMAIN_PT)
83 #define IOMMU_DOMAIN_UNMANAGED (__IOMMU_DOMAIN_PAGING)
84 #define IOMMU_DOMAIN_DMA (__IOMMU_DOMAIN_PAGING | \
85 __IOMMU_DOMAIN_DMA_API)
86 #define IOMMU_DOMAIN_DMA_FQ (__IOMMU_DOMAIN_PAGING | \
87 __IOMMU_DOMAIN_DMA_API | \
88 __IOMMU_DOMAIN_DMA_FQ)
92 const struct iommu_domain_ops *ops;
93 unsigned long pgsize_bitmap; /* Bitmap of page sizes in use */
94 iommu_fault_handler_t handler;
96 struct iommu_domain_geometry geometry;
97 struct iommu_dma_cookie *iova_cookie;
100 static inline bool iommu_is_dma_domain(struct iommu_domain *domain)
102 return domain->type & __IOMMU_DOMAIN_DMA_API;
106 IOMMU_CAP_CACHE_COHERENCY, /* IOMMU_CACHE is supported */
107 IOMMU_CAP_INTR_REMAP, /* IOMMU supports interrupt isolation */
108 IOMMU_CAP_NOEXEC, /* IOMMU_NOEXEC flag */
109 IOMMU_CAP_PRE_BOOT_PROTECTION, /* Firmware says it used the IOMMU for
110 DMA protection and we should too */
113 /* These are the possible reserved region types */
114 enum iommu_resv_type {
115 /* Memory regions which must be mapped 1:1 at all times */
118 * Memory regions which are advertised to be 1:1 but are
119 * commonly considered relaxable in some conditions,
120 * for instance in device assignment use case (USB, Graphics)
122 IOMMU_RESV_DIRECT_RELAXABLE,
123 /* Arbitrary "never map this or give it to a device" address ranges */
125 /* Hardware MSI region (untranslated) */
127 /* Software-managed MSI translation window */
132 * struct iommu_resv_region - descriptor for a reserved memory region
133 * @list: Linked list pointers
134 * @start: System physical start address of the region
135 * @length: Length of the region in bytes
136 * @prot: IOMMU Protection flags (READ/WRITE/...)
137 * @type: Type of the reserved region
139 struct iommu_resv_region {
140 struct list_head list;
144 enum iommu_resv_type type;
148 * enum iommu_dev_features - Per device IOMMU features
149 * @IOMMU_DEV_FEAT_SVA: Shared Virtual Addresses
150 * @IOMMU_DEV_FEAT_IOPF: I/O Page Faults such as PRI or Stall. Generally
151 * enabling %IOMMU_DEV_FEAT_SVA requires
152 * %IOMMU_DEV_FEAT_IOPF, but some devices manage I/O Page
153 * Faults themselves instead of relying on the IOMMU. When
154 * supported, this feature must be enabled before and
155 * disabled after %IOMMU_DEV_FEAT_SVA.
157 * Device drivers query whether a feature is supported using
158 * iommu_dev_has_feature(), and enable it using iommu_dev_enable_feature().
160 enum iommu_dev_features {
165 #define IOMMU_PASID_INVALID (-1U)
167 #ifdef CONFIG_IOMMU_API
170 * struct iommu_iotlb_gather - Range information for a pending IOTLB flush
172 * @start: IOVA representing the start of the range to be flushed
173 * @end: IOVA representing the end of the range to be flushed (inclusive)
174 * @pgsize: The interval at which to perform the flush
175 * @freelist: Removed pages to free after sync
176 * @queued: Indicates that the flush will be queued
178 * This structure is intended to be updated by multiple calls to the
179 * ->unmap() function in struct iommu_ops before eventually being passed
180 * into ->iotlb_sync(). Drivers can add pages to @freelist to be freed after
181 * ->iotlb_sync() or ->iotlb_flush_all() have cleared all cached references to
182 * them. @queued is set to indicate when ->iotlb_flush_all() will be called
183 * later instead of ->iotlb_sync(), so drivers may optimise accordingly.
185 struct iommu_iotlb_gather {
189 struct list_head freelist;
194 * struct iommu_ops - iommu ops and capabilities
195 * @capable: check capability
196 * @domain_alloc: allocate iommu domain
197 * @probe_device: Add device to iommu driver handling
198 * @release_device: Remove device from iommu driver handling
199 * @probe_finalize: Do final setup work after the device is added to an IOMMU
200 * group and attached to the groups domain
201 * @device_group: find iommu group for a particular device
202 * @get_resv_regions: Request list of reserved regions for a device
203 * @put_resv_regions: Free list of reserved regions for a device
204 * @of_xlate: add OF master IDs to iommu grouping
205 * @is_attach_deferred: Check if domain attach should be deferred from iommu
206 * driver init to device driver init (default no)
207 * @dev_has/enable/disable_feat: per device entries to check/enable/disable
208 * iommu specific features.
209 * @dev_feat_enabled: check enabled feature
210 * @sva_bind: Bind process address space to device
211 * @sva_unbind: Unbind process address space from device
212 * @sva_get_pasid: Get PASID associated to a SVA handle
213 * @page_response: handle page request response
214 * @def_domain_type: device default domain type, return value:
215 * - IOMMU_DOMAIN_IDENTITY: must use an identity domain
216 * - IOMMU_DOMAIN_DMA: must use a dma domain
217 * - 0: use the default setting
218 * @default_domain_ops: the default ops for domains
219 * @pgsize_bitmap: bitmap of all possible supported page sizes
220 * @owner: Driver module providing these ops
223 bool (*capable)(enum iommu_cap);
225 /* Domain allocation and freeing by the iommu driver */
226 struct iommu_domain *(*domain_alloc)(unsigned iommu_domain_type);
228 struct iommu_device *(*probe_device)(struct device *dev);
229 void (*release_device)(struct device *dev);
230 void (*probe_finalize)(struct device *dev);
231 struct iommu_group *(*device_group)(struct device *dev);
233 /* Request/Free a list of reserved regions for a device */
234 void (*get_resv_regions)(struct device *dev, struct list_head *list);
235 void (*put_resv_regions)(struct device *dev, struct list_head *list);
237 int (*of_xlate)(struct device *dev, struct of_phandle_args *args);
238 bool (*is_attach_deferred)(struct device *dev);
240 /* Per device IOMMU features */
241 bool (*dev_has_feat)(struct device *dev, enum iommu_dev_features f);
242 bool (*dev_feat_enabled)(struct device *dev, enum iommu_dev_features f);
243 int (*dev_enable_feat)(struct device *dev, enum iommu_dev_features f);
244 int (*dev_disable_feat)(struct device *dev, enum iommu_dev_features f);
246 struct iommu_sva *(*sva_bind)(struct device *dev, struct mm_struct *mm,
248 void (*sva_unbind)(struct iommu_sva *handle);
249 u32 (*sva_get_pasid)(struct iommu_sva *handle);
251 int (*page_response)(struct device *dev,
252 struct iommu_fault_event *evt,
253 struct iommu_page_response *msg);
255 int (*def_domain_type)(struct device *dev);
257 const struct iommu_domain_ops *default_domain_ops;
258 unsigned long pgsize_bitmap;
259 struct module *owner;
263 * struct iommu_domain_ops - domain specific operations
264 * @attach_dev: attach an iommu domain to a device
265 * @detach_dev: detach an iommu domain from a device
266 * @map: map a physically contiguous memory region to an iommu domain
267 * @map_pages: map a physically contiguous set of pages of the same size to
269 * @unmap: unmap a physically contiguous memory region from an iommu domain
270 * @unmap_pages: unmap a number of pages of the same size from an iommu domain
271 * @flush_iotlb_all: Synchronously flush all hardware TLBs for this domain
272 * @iotlb_sync_map: Sync mappings created recently using @map to the hardware
273 * @iotlb_sync: Flush all queued ranges from the hardware TLBs and empty flush
275 * @iova_to_phys: translate iova to physical address
276 * @enforce_cache_coherency: Prevent any kind of DMA from bypassing IOMMU_CACHE,
277 * including no-snoop TLPs on PCIe or other platform
278 * specific mechanisms.
279 * @enable_nesting: Enable nesting
280 * @set_pgtable_quirks: Set io page table quirks (IO_PGTABLE_QUIRK_*)
281 * @free: Release the domain after use.
283 struct iommu_domain_ops {
284 int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
285 void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
287 int (*map)(struct iommu_domain *domain, unsigned long iova,
288 phys_addr_t paddr, size_t size, int prot, gfp_t gfp);
289 int (*map_pages)(struct iommu_domain *domain, unsigned long iova,
290 phys_addr_t paddr, size_t pgsize, size_t pgcount,
291 int prot, gfp_t gfp, size_t *mapped);
292 size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
293 size_t size, struct iommu_iotlb_gather *iotlb_gather);
294 size_t (*unmap_pages)(struct iommu_domain *domain, unsigned long iova,
295 size_t pgsize, size_t pgcount,
296 struct iommu_iotlb_gather *iotlb_gather);
298 void (*flush_iotlb_all)(struct iommu_domain *domain);
299 void (*iotlb_sync_map)(struct iommu_domain *domain, unsigned long iova,
301 void (*iotlb_sync)(struct iommu_domain *domain,
302 struct iommu_iotlb_gather *iotlb_gather);
304 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain,
307 bool (*enforce_cache_coherency)(struct iommu_domain *domain);
308 int (*enable_nesting)(struct iommu_domain *domain);
309 int (*set_pgtable_quirks)(struct iommu_domain *domain,
310 unsigned long quirks);
312 void (*free)(struct iommu_domain *domain);
316 * struct iommu_device - IOMMU core representation of one IOMMU hardware
318 * @list: Used by the iommu-core to keep a list of registered iommus
319 * @ops: iommu-ops for talking to this iommu
320 * @dev: struct device for sysfs handling
322 struct iommu_device {
323 struct list_head list;
324 const struct iommu_ops *ops;
325 struct fwnode_handle *fwnode;
330 * struct iommu_fault_event - Generic fault event
332 * Can represent recoverable faults such as a page requests or
333 * unrecoverable faults such as DMA or IRQ remapping faults.
335 * @fault: fault descriptor
336 * @list: pending fault event list, used for tracking responses
338 struct iommu_fault_event {
339 struct iommu_fault fault;
340 struct list_head list;
344 * struct iommu_fault_param - per-device IOMMU fault data
345 * @handler: Callback function to handle IOMMU faults at device level
346 * @data: handler private data
347 * @faults: holds the pending faults which needs response
348 * @lock: protect pending faults list
350 struct iommu_fault_param {
351 iommu_dev_fault_handler_t handler;
353 struct list_head faults;
358 * struct dev_iommu - Collection of per-device IOMMU data
360 * @fault_param: IOMMU detected device fault reporting data
361 * @iopf_param: I/O Page Fault queue and data
362 * @fwspec: IOMMU fwspec data
363 * @iommu_dev: IOMMU device this device is linked to
364 * @priv: IOMMU Driver private data
366 * TODO: migrate other per device data pointers under iommu_dev_data, e.g.
367 * struct iommu_group *iommu_group;
371 struct iommu_fault_param *fault_param;
372 struct iopf_device_param *iopf_param;
373 struct iommu_fwspec *fwspec;
374 struct iommu_device *iommu_dev;
378 int iommu_device_register(struct iommu_device *iommu,
379 const struct iommu_ops *ops,
380 struct device *hwdev);
381 void iommu_device_unregister(struct iommu_device *iommu);
382 int iommu_device_sysfs_add(struct iommu_device *iommu,
383 struct device *parent,
384 const struct attribute_group **groups,
385 const char *fmt, ...) __printf(4, 5);
386 void iommu_device_sysfs_remove(struct iommu_device *iommu);
387 int iommu_device_link(struct iommu_device *iommu, struct device *link);
388 void iommu_device_unlink(struct iommu_device *iommu, struct device *link);
389 int iommu_deferred_attach(struct device *dev, struct iommu_domain *domain);
391 static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
393 return (struct iommu_device *)dev_get_drvdata(dev);
396 static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather)
398 *gather = (struct iommu_iotlb_gather) {
400 .freelist = LIST_HEAD_INIT(gather->freelist),
404 static inline const struct iommu_ops *dev_iommu_ops(struct device *dev)
407 * Assume that valid ops must be installed if iommu_probe_device()
408 * has succeeded. The device ops are essentially for internal use
409 * within the IOMMU subsystem itself, so we should be able to trust
410 * ourselves not to misuse the helper.
412 return dev->iommu->iommu_dev->ops;
415 extern int bus_set_iommu(struct bus_type *bus, const struct iommu_ops *ops);
416 extern int bus_iommu_probe(struct bus_type *bus);
417 extern bool iommu_present(struct bus_type *bus);
418 extern bool device_iommu_capable(struct device *dev, enum iommu_cap cap);
419 extern bool iommu_capable(struct bus_type *bus, enum iommu_cap cap);
420 extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
421 extern struct iommu_group *iommu_group_get_by_id(int id);
422 extern void iommu_domain_free(struct iommu_domain *domain);
423 extern int iommu_attach_device(struct iommu_domain *domain,
425 extern void iommu_detach_device(struct iommu_domain *domain,
427 extern int iommu_sva_unbind_gpasid(struct iommu_domain *domain,
428 struct device *dev, ioasid_t pasid);
429 extern struct iommu_domain *iommu_get_domain_for_dev(struct device *dev);
430 extern struct iommu_domain *iommu_get_dma_domain(struct device *dev);
431 extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
432 phys_addr_t paddr, size_t size, int prot);
433 extern int iommu_map_atomic(struct iommu_domain *domain, unsigned long iova,
434 phys_addr_t paddr, size_t size, int prot);
435 extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
437 extern size_t iommu_unmap_fast(struct iommu_domain *domain,
438 unsigned long iova, size_t size,
439 struct iommu_iotlb_gather *iotlb_gather);
440 extern ssize_t iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
441 struct scatterlist *sg, unsigned int nents, int prot);
442 extern ssize_t iommu_map_sg_atomic(struct iommu_domain *domain,
443 unsigned long iova, struct scatterlist *sg,
444 unsigned int nents, int prot);
445 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
446 extern void iommu_set_fault_handler(struct iommu_domain *domain,
447 iommu_fault_handler_t handler, void *token);
449 extern void iommu_get_resv_regions(struct device *dev, struct list_head *list);
450 extern void iommu_put_resv_regions(struct device *dev, struct list_head *list);
451 extern void generic_iommu_put_resv_regions(struct device *dev,
452 struct list_head *list);
453 extern void iommu_set_default_passthrough(bool cmd_line);
454 extern void iommu_set_default_translated(bool cmd_line);
455 extern bool iommu_default_passthrough(void);
456 extern struct iommu_resv_region *
457 iommu_alloc_resv_region(phys_addr_t start, size_t length, int prot,
458 enum iommu_resv_type type);
459 extern int iommu_get_group_resv_regions(struct iommu_group *group,
460 struct list_head *head);
462 extern int iommu_attach_group(struct iommu_domain *domain,
463 struct iommu_group *group);
464 extern void iommu_detach_group(struct iommu_domain *domain,
465 struct iommu_group *group);
466 extern struct iommu_group *iommu_group_alloc(void);
467 extern void *iommu_group_get_iommudata(struct iommu_group *group);
468 extern void iommu_group_set_iommudata(struct iommu_group *group,
470 void (*release)(void *iommu_data));
471 extern int iommu_group_set_name(struct iommu_group *group, const char *name);
472 extern int iommu_group_add_device(struct iommu_group *group,
474 extern void iommu_group_remove_device(struct device *dev);
475 extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
476 int (*fn)(struct device *, void *));
477 extern struct iommu_group *iommu_group_get(struct device *dev);
478 extern struct iommu_group *iommu_group_ref_get(struct iommu_group *group);
479 extern void iommu_group_put(struct iommu_group *group);
480 extern int iommu_register_device_fault_handler(struct device *dev,
481 iommu_dev_fault_handler_t handler,
484 extern int iommu_unregister_device_fault_handler(struct device *dev);
486 extern int iommu_report_device_fault(struct device *dev,
487 struct iommu_fault_event *evt);
488 extern int iommu_page_response(struct device *dev,
489 struct iommu_page_response *msg);
491 extern int iommu_group_id(struct iommu_group *group);
492 extern struct iommu_domain *iommu_group_default_domain(struct iommu_group *);
494 int iommu_enable_nesting(struct iommu_domain *domain);
495 int iommu_set_pgtable_quirks(struct iommu_domain *domain,
496 unsigned long quirks);
498 void iommu_set_dma_strict(void);
500 extern int report_iommu_fault(struct iommu_domain *domain, struct device *dev,
501 unsigned long iova, int flags);
503 static inline void iommu_flush_iotlb_all(struct iommu_domain *domain)
505 if (domain->ops->flush_iotlb_all)
506 domain->ops->flush_iotlb_all(domain);
509 static inline void iommu_iotlb_sync(struct iommu_domain *domain,
510 struct iommu_iotlb_gather *iotlb_gather)
512 if (domain->ops->iotlb_sync)
513 domain->ops->iotlb_sync(domain, iotlb_gather);
515 iommu_iotlb_gather_init(iotlb_gather);
519 * iommu_iotlb_gather_is_disjoint - Checks whether a new range is disjoint
521 * @gather: TLB gather data
522 * @iova: start of page to invalidate
523 * @size: size of page to invalidate
525 * Helper for IOMMU drivers to check whether a new range and the gathered range
526 * are disjoint. For many IOMMUs, flushing the IOMMU in this case is better
527 * than merging the two, which might lead to unnecessary invalidations.
530 bool iommu_iotlb_gather_is_disjoint(struct iommu_iotlb_gather *gather,
531 unsigned long iova, size_t size)
533 unsigned long start = iova, end = start + size - 1;
535 return gather->end != 0 &&
536 (end + 1 < gather->start || start > gather->end + 1);
541 * iommu_iotlb_gather_add_range - Gather for address-based TLB invalidation
542 * @gather: TLB gather data
543 * @iova: start of page to invalidate
544 * @size: size of page to invalidate
546 * Helper for IOMMU drivers to build arbitrarily-sized invalidation commands
547 * where only the address range matters, and simply minimising intermediate
548 * syncs is preferred.
550 static inline void iommu_iotlb_gather_add_range(struct iommu_iotlb_gather *gather,
551 unsigned long iova, size_t size)
553 unsigned long end = iova + size - 1;
555 if (gather->start > iova)
556 gather->start = iova;
557 if (gather->end < end)
562 * iommu_iotlb_gather_add_page - Gather for page-based TLB invalidation
563 * @domain: IOMMU domain to be invalidated
564 * @gather: TLB gather data
565 * @iova: start of page to invalidate
566 * @size: size of page to invalidate
568 * Helper for IOMMU drivers to build invalidation commands based on individual
569 * pages, or with page size/table level hints which cannot be gathered if they
572 static inline void iommu_iotlb_gather_add_page(struct iommu_domain *domain,
573 struct iommu_iotlb_gather *gather,
574 unsigned long iova, size_t size)
577 * If the new page is disjoint from the current range or is mapped at
578 * a different granularity, then sync the TLB so that the gather
579 * structure can be rewritten.
581 if ((gather->pgsize && gather->pgsize != size) ||
582 iommu_iotlb_gather_is_disjoint(gather, iova, size))
583 iommu_iotlb_sync(domain, gather);
585 gather->pgsize = size;
586 iommu_iotlb_gather_add_range(gather, iova, size);
589 static inline bool iommu_iotlb_gather_queued(struct iommu_iotlb_gather *gather)
591 return gather && gather->queued;
594 /* PCI device grouping function */
595 extern struct iommu_group *pci_device_group(struct device *dev);
596 /* Generic device grouping function */
597 extern struct iommu_group *generic_device_group(struct device *dev);
598 /* FSL-MC device grouping function */
599 struct iommu_group *fsl_mc_device_group(struct device *dev);
602 * struct iommu_fwspec - per-device IOMMU instance data
603 * @ops: ops for this device's IOMMU
604 * @iommu_fwnode: firmware handle for this device's IOMMU
605 * @flags: IOMMU_FWSPEC_* flags
606 * @num_ids: number of associated device IDs
607 * @ids: IDs which this device may present to the IOMMU
609 struct iommu_fwspec {
610 const struct iommu_ops *ops;
611 struct fwnode_handle *iommu_fwnode;
613 unsigned int num_ids;
617 /* ATS is supported */
618 #define IOMMU_FWSPEC_PCI_RC_ATS (1 << 0)
621 * struct iommu_sva - handle to a device-mm bond
627 int iommu_fwspec_init(struct device *dev, struct fwnode_handle *iommu_fwnode,
628 const struct iommu_ops *ops);
629 void iommu_fwspec_free(struct device *dev);
630 int iommu_fwspec_add_ids(struct device *dev, u32 *ids, int num_ids);
631 const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode);
633 static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev)
636 return dev->iommu->fwspec;
641 static inline void dev_iommu_fwspec_set(struct device *dev,
642 struct iommu_fwspec *fwspec)
644 dev->iommu->fwspec = fwspec;
647 static inline void *dev_iommu_priv_get(struct device *dev)
650 return dev->iommu->priv;
655 static inline void dev_iommu_priv_set(struct device *dev, void *priv)
657 dev->iommu->priv = priv;
660 int iommu_probe_device(struct device *dev);
661 void iommu_release_device(struct device *dev);
663 int iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features f);
664 int iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features f);
665 bool iommu_dev_feature_enabled(struct device *dev, enum iommu_dev_features f);
667 struct iommu_sva *iommu_sva_bind_device(struct device *dev,
668 struct mm_struct *mm,
670 void iommu_sva_unbind_device(struct iommu_sva *handle);
671 u32 iommu_sva_get_pasid(struct iommu_sva *handle);
673 int iommu_device_use_default_domain(struct device *dev);
674 void iommu_device_unuse_default_domain(struct device *dev);
676 int iommu_group_claim_dma_owner(struct iommu_group *group, void *owner);
677 void iommu_group_release_dma_owner(struct iommu_group *group);
678 bool iommu_group_dma_owner_claimed(struct iommu_group *group);
680 #else /* CONFIG_IOMMU_API */
683 struct iommu_group {};
684 struct iommu_fwspec {};
685 struct iommu_device {};
686 struct iommu_fault_param {};
687 struct iommu_iotlb_gather {};
689 static inline bool iommu_present(struct bus_type *bus)
694 static inline bool device_iommu_capable(struct device *dev, enum iommu_cap cap)
699 static inline bool iommu_capable(struct bus_type *bus, enum iommu_cap cap)
704 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
709 static inline struct iommu_group *iommu_group_get_by_id(int id)
714 static inline void iommu_domain_free(struct iommu_domain *domain)
718 static inline int iommu_attach_device(struct iommu_domain *domain,
724 static inline void iommu_detach_device(struct iommu_domain *domain,
729 static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
734 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
735 phys_addr_t paddr, size_t size, int prot)
740 static inline int iommu_map_atomic(struct iommu_domain *domain,
741 unsigned long iova, phys_addr_t paddr,
742 size_t size, int prot)
747 static inline size_t iommu_unmap(struct iommu_domain *domain,
748 unsigned long iova, size_t size)
753 static inline size_t iommu_unmap_fast(struct iommu_domain *domain,
754 unsigned long iova, int gfp_order,
755 struct iommu_iotlb_gather *iotlb_gather)
760 static inline ssize_t iommu_map_sg(struct iommu_domain *domain,
761 unsigned long iova, struct scatterlist *sg,
762 unsigned int nents, int prot)
767 static inline ssize_t iommu_map_sg_atomic(struct iommu_domain *domain,
768 unsigned long iova, struct scatterlist *sg,
769 unsigned int nents, int prot)
774 static inline void iommu_flush_iotlb_all(struct iommu_domain *domain)
778 static inline void iommu_iotlb_sync(struct iommu_domain *domain,
779 struct iommu_iotlb_gather *iotlb_gather)
783 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
788 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
789 iommu_fault_handler_t handler, void *token)
793 static inline void iommu_get_resv_regions(struct device *dev,
794 struct list_head *list)
798 static inline void iommu_put_resv_regions(struct device *dev,
799 struct list_head *list)
803 static inline int iommu_get_group_resv_regions(struct iommu_group *group,
804 struct list_head *head)
809 static inline void iommu_set_default_passthrough(bool cmd_line)
813 static inline void iommu_set_default_translated(bool cmd_line)
817 static inline bool iommu_default_passthrough(void)
822 static inline int iommu_attach_group(struct iommu_domain *domain,
823 struct iommu_group *group)
828 static inline void iommu_detach_group(struct iommu_domain *domain,
829 struct iommu_group *group)
833 static inline struct iommu_group *iommu_group_alloc(void)
835 return ERR_PTR(-ENODEV);
838 static inline void *iommu_group_get_iommudata(struct iommu_group *group)
843 static inline void iommu_group_set_iommudata(struct iommu_group *group,
845 void (*release)(void *iommu_data))
849 static inline int iommu_group_set_name(struct iommu_group *group,
855 static inline int iommu_group_add_device(struct iommu_group *group,
861 static inline void iommu_group_remove_device(struct device *dev)
865 static inline int iommu_group_for_each_dev(struct iommu_group *group,
867 int (*fn)(struct device *, void *))
872 static inline struct iommu_group *iommu_group_get(struct device *dev)
877 static inline void iommu_group_put(struct iommu_group *group)
882 int iommu_register_device_fault_handler(struct device *dev,
883 iommu_dev_fault_handler_t handler,
889 static inline int iommu_unregister_device_fault_handler(struct device *dev)
895 int iommu_report_device_fault(struct device *dev, struct iommu_fault_event *evt)
900 static inline int iommu_page_response(struct device *dev,
901 struct iommu_page_response *msg)
906 static inline int iommu_group_id(struct iommu_group *group)
911 static inline int iommu_set_pgtable_quirks(struct iommu_domain *domain,
912 unsigned long quirks)
917 static inline int iommu_device_register(struct iommu_device *iommu,
918 const struct iommu_ops *ops,
919 struct device *hwdev)
924 static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
929 static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather)
933 static inline void iommu_iotlb_gather_add_page(struct iommu_domain *domain,
934 struct iommu_iotlb_gather *gather,
935 unsigned long iova, size_t size)
939 static inline bool iommu_iotlb_gather_queued(struct iommu_iotlb_gather *gather)
944 static inline void iommu_device_unregister(struct iommu_device *iommu)
948 static inline int iommu_device_sysfs_add(struct iommu_device *iommu,
949 struct device *parent,
950 const struct attribute_group **groups,
951 const char *fmt, ...)
956 static inline void iommu_device_sysfs_remove(struct iommu_device *iommu)
960 static inline int iommu_device_link(struct device *dev, struct device *link)
965 static inline void iommu_device_unlink(struct device *dev, struct device *link)
969 static inline int iommu_fwspec_init(struct device *dev,
970 struct fwnode_handle *iommu_fwnode,
971 const struct iommu_ops *ops)
976 static inline void iommu_fwspec_free(struct device *dev)
980 static inline int iommu_fwspec_add_ids(struct device *dev, u32 *ids,
987 const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode)
993 iommu_dev_feature_enabled(struct device *dev, enum iommu_dev_features feat)
999 iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features feat)
1005 iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features feat)
1010 static inline struct iommu_sva *
1011 iommu_sva_bind_device(struct device *dev, struct mm_struct *mm, void *drvdata)
1016 static inline void iommu_sva_unbind_device(struct iommu_sva *handle)
1020 static inline u32 iommu_sva_get_pasid(struct iommu_sva *handle)
1022 return IOMMU_PASID_INVALID;
1025 static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev)
1030 static inline int iommu_device_use_default_domain(struct device *dev)
1035 static inline void iommu_device_unuse_default_domain(struct device *dev)
1040 iommu_group_claim_dma_owner(struct iommu_group *group, void *owner)
1045 static inline void iommu_group_release_dma_owner(struct iommu_group *group)
1049 static inline bool iommu_group_dma_owner_claimed(struct iommu_group *group)
1053 #endif /* CONFIG_IOMMU_API */
1056 * iommu_map_sgtable - Map the given buffer to the IOMMU domain
1057 * @domain: The IOMMU domain to perform the mapping
1058 * @iova: The start address to map the buffer
1059 * @sgt: The sg_table object describing the buffer
1060 * @prot: IOMMU protection bits
1062 * Creates a mapping at @iova for the buffer described by a scatterlist
1063 * stored in the given sg_table object in the provided IOMMU domain.
1065 static inline size_t iommu_map_sgtable(struct iommu_domain *domain,
1066 unsigned long iova, struct sg_table *sgt, int prot)
1068 return iommu_map_sg(domain, iova, sgt->sgl, sgt->orig_nents, prot);
1071 #ifdef CONFIG_IOMMU_DEBUGFS
1072 extern struct dentry *iommu_debugfs_dir;
1073 void iommu_debugfs_setup(void);
1075 static inline void iommu_debugfs_setup(void) {}
1078 #endif /* __LINUX_IOMMU_H */