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 notifier_block
;
42 struct iommu_fault_event
;
44 /* iommu fault flags */
45 #define IOMMU_FAULT_READ 0x0
46 #define IOMMU_FAULT_WRITE 0x1
48 typedef int (*iommu_fault_handler_t
)(struct iommu_domain
*,
49 struct device
*, unsigned long, int, void *);
50 typedef int (*iommu_dev_fault_handler_t
)(struct iommu_fault
*, void *);
52 struct iommu_domain_geometry
{
53 dma_addr_t aperture_start
; /* First address that can be mapped */
54 dma_addr_t aperture_end
; /* Last address that can be mapped */
55 bool force_aperture
; /* DMA only allowed in mappable range? */
58 /* Domain feature flags */
59 #define __IOMMU_DOMAIN_PAGING (1U << 0) /* Support for iommu_map/unmap */
60 #define __IOMMU_DOMAIN_DMA_API (1U << 1) /* Domain for use in DMA-API
62 #define __IOMMU_DOMAIN_PT (1U << 2) /* Domain is identity mapped */
65 * This are the possible domain-types
67 * IOMMU_DOMAIN_BLOCKED - All DMA is blocked, can be used to isolate
69 * IOMMU_DOMAIN_IDENTITY - DMA addresses are system physical addresses
70 * IOMMU_DOMAIN_UNMANAGED - DMA mappings managed by IOMMU-API user, used
72 * IOMMU_DOMAIN_DMA - Internally used for DMA-API implementations.
73 * This flag allows IOMMU drivers to implement
74 * certain optimizations for these domains
76 #define IOMMU_DOMAIN_BLOCKED (0U)
77 #define IOMMU_DOMAIN_IDENTITY (__IOMMU_DOMAIN_PT)
78 #define IOMMU_DOMAIN_UNMANAGED (__IOMMU_DOMAIN_PAGING)
79 #define IOMMU_DOMAIN_DMA (__IOMMU_DOMAIN_PAGING | \
80 __IOMMU_DOMAIN_DMA_API)
84 const struct iommu_ops
*ops
;
85 unsigned long pgsize_bitmap
; /* Bitmap of page sizes in use */
86 iommu_fault_handler_t handler
;
88 struct iommu_domain_geometry geometry
;
93 IOMMU_CAP_CACHE_COHERENCY
, /* IOMMU can enforce cache coherent DMA
95 IOMMU_CAP_INTR_REMAP
, /* IOMMU supports interrupt isolation */
96 IOMMU_CAP_NOEXEC
, /* IOMMU_NOEXEC flag */
100 * Following constraints are specifc to FSL_PAMUV1:
101 * -aperture must be power of 2, and naturally aligned
102 * -number of windows must be power of 2, and address space size
103 * of each window is determined by aperture size / # of windows
104 * -the actual size of the mapped region of a window must be power
105 * of 2 starting with 4KB and physical address must be naturally
107 * DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints.
108 * The caller can invoke iommu_domain_get_attr to check if the underlying
109 * iommu implementation supports these constraints.
113 DOMAIN_ATTR_GEOMETRY
,
116 DOMAIN_ATTR_FSL_PAMU_STASH
,
117 DOMAIN_ATTR_FSL_PAMU_ENABLE
,
118 DOMAIN_ATTR_FSL_PAMUV1
,
119 DOMAIN_ATTR_NESTING
, /* two stages of translation */
120 DOMAIN_ATTR_DMA_USE_FLUSH_QUEUE
,
121 DOMAIN_ATTR_IO_PGTABLE_CFG
,
125 /* These are the possible reserved region types */
126 enum iommu_resv_type
{
127 /* Memory regions which must be mapped 1:1 at all times */
130 * Memory regions which are advertised to be 1:1 but are
131 * commonly considered relaxable in some conditions,
132 * for instance in device assignment use case (USB, Graphics)
134 IOMMU_RESV_DIRECT_RELAXABLE
,
135 /* Arbitrary "never map this or give it to a device" address ranges */
137 /* Hardware MSI region (untranslated) */
139 /* Software-managed MSI translation window */
144 * struct iommu_resv_region - descriptor for a reserved memory region
145 * @list: Linked list pointers
146 * @start: System physical start address of the region
147 * @length: Length of the region in bytes
148 * @prot: IOMMU Protection flags (READ/WRITE/...)
149 * @type: Type of the reserved region
151 struct iommu_resv_region
{
152 struct list_head list
;
156 enum iommu_resv_type type
;
159 /* Per device IOMMU features */
160 enum iommu_dev_features
{
161 IOMMU_DEV_FEAT_AUX
, /* Aux-domain feature */
162 IOMMU_DEV_FEAT_SVA
, /* Shared Virtual Addresses */
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
176 * This structure is intended to be updated by multiple calls to the
177 * ->unmap() function in struct iommu_ops before eventually being passed
178 * into ->iotlb_sync().
180 struct iommu_iotlb_gather
{
184 struct page
*freelist
;
188 * struct iommu_ops - iommu ops and capabilities
189 * @capable: check capability
190 * @domain_alloc: allocate iommu domain
191 * @domain_free: free iommu domain
192 * @attach_dev: attach device to an iommu domain
193 * @detach_dev: detach device from an iommu domain
194 * @map: map a physically contiguous memory region to an iommu domain
195 * @unmap: unmap a physically contiguous memory region from an iommu domain
196 * @flush_iotlb_all: Synchronously flush all hardware TLBs for this domain
197 * @iotlb_sync_map: Sync mappings created recently using @map to the hardware
198 * @iotlb_sync: Flush all queued ranges from the hardware TLBs and empty flush
200 * @iova_to_phys: translate iova to physical address
201 * @probe_device: Add device to iommu driver handling
202 * @release_device: Remove device from iommu driver handling
203 * @probe_finalize: Do final setup work after the device is added to an IOMMU
204 * group and attached to the groups domain
205 * @device_group: find iommu group for a particular device
206 * @domain_get_attr: Query domain attributes
207 * @domain_set_attr: Change domain attributes
208 * @get_resv_regions: Request list of reserved regions for a device
209 * @put_resv_regions: Free list of reserved regions for a device
210 * @apply_resv_region: Temporary helper call-back for iova reserved ranges
211 * @domain_window_enable: Configure and enable a particular window for a domain
212 * @domain_window_disable: Disable a particular window for a domain
213 * @of_xlate: add OF master IDs to iommu grouping
214 * @is_attach_deferred: Check if domain attach should be deferred from iommu
215 * driver init to device driver init (default no)
216 * @dev_has/enable/disable_feat: per device entries to check/enable/disable
217 * iommu specific features.
218 * @dev_feat_enabled: check enabled feature
219 * @aux_attach/detach_dev: aux-domain specific attach/detach entries.
220 * @aux_get_pasid: get the pasid given an aux-domain
221 * @sva_bind: Bind process address space to device
222 * @sva_unbind: Unbind process address space from device
223 * @sva_get_pasid: Get PASID associated to a SVA handle
224 * @page_response: handle page request response
225 * @cache_invalidate: invalidate translation caches
226 * @sva_bind_gpasid: bind guest pasid and mm
227 * @sva_unbind_gpasid: unbind guest pasid and mm
228 * @def_domain_type: device default domain type, return value:
229 * - IOMMU_DOMAIN_IDENTITY: must use an identity domain
230 * - IOMMU_DOMAIN_DMA: must use a dma domain
231 * - 0: use the default setting
232 * @pgsize_bitmap: bitmap of all possible supported page sizes
233 * @owner: Driver module providing these ops
236 bool (*capable
)(enum iommu_cap
);
238 /* Domain allocation and freeing by the iommu driver */
239 struct iommu_domain
*(*domain_alloc
)(unsigned iommu_domain_type
);
240 void (*domain_free
)(struct iommu_domain
*);
242 int (*attach_dev
)(struct iommu_domain
*domain
, struct device
*dev
);
243 void (*detach_dev
)(struct iommu_domain
*domain
, struct device
*dev
);
244 int (*map
)(struct iommu_domain
*domain
, unsigned long iova
,
245 phys_addr_t paddr
, size_t size
, int prot
, gfp_t gfp
);
246 size_t (*unmap
)(struct iommu_domain
*domain
, unsigned long iova
,
247 size_t size
, struct iommu_iotlb_gather
*iotlb_gather
);
248 void (*flush_iotlb_all
)(struct iommu_domain
*domain
);
249 void (*iotlb_sync_map
)(struct iommu_domain
*domain
);
250 void (*iotlb_sync
)(struct iommu_domain
*domain
,
251 struct iommu_iotlb_gather
*iotlb_gather
);
252 phys_addr_t (*iova_to_phys
)(struct iommu_domain
*domain
, dma_addr_t iova
);
253 struct iommu_device
*(*probe_device
)(struct device
*dev
);
254 void (*release_device
)(struct device
*dev
);
255 void (*probe_finalize
)(struct device
*dev
);
256 struct iommu_group
*(*device_group
)(struct device
*dev
);
257 int (*domain_get_attr
)(struct iommu_domain
*domain
,
258 enum iommu_attr attr
, void *data
);
259 int (*domain_set_attr
)(struct iommu_domain
*domain
,
260 enum iommu_attr attr
, void *data
);
262 /* Request/Free a list of reserved regions for a device */
263 void (*get_resv_regions
)(struct device
*dev
, struct list_head
*list
);
264 void (*put_resv_regions
)(struct device
*dev
, struct list_head
*list
);
265 void (*apply_resv_region
)(struct device
*dev
,
266 struct iommu_domain
*domain
,
267 struct iommu_resv_region
*region
);
269 /* Window handling functions */
270 int (*domain_window_enable
)(struct iommu_domain
*domain
, u32 wnd_nr
,
271 phys_addr_t paddr
, u64 size
, int prot
);
272 void (*domain_window_disable
)(struct iommu_domain
*domain
, u32 wnd_nr
);
274 int (*of_xlate
)(struct device
*dev
, struct of_phandle_args
*args
);
275 bool (*is_attach_deferred
)(struct iommu_domain
*domain
, struct device
*dev
);
277 /* Per device IOMMU features */
278 bool (*dev_has_feat
)(struct device
*dev
, enum iommu_dev_features f
);
279 bool (*dev_feat_enabled
)(struct device
*dev
, enum iommu_dev_features f
);
280 int (*dev_enable_feat
)(struct device
*dev
, enum iommu_dev_features f
);
281 int (*dev_disable_feat
)(struct device
*dev
, enum iommu_dev_features f
);
283 /* Aux-domain specific attach/detach entries */
284 int (*aux_attach_dev
)(struct iommu_domain
*domain
, struct device
*dev
);
285 void (*aux_detach_dev
)(struct iommu_domain
*domain
, struct device
*dev
);
286 int (*aux_get_pasid
)(struct iommu_domain
*domain
, struct device
*dev
);
288 struct iommu_sva
*(*sva_bind
)(struct device
*dev
, struct mm_struct
*mm
,
290 void (*sva_unbind
)(struct iommu_sva
*handle
);
291 u32 (*sva_get_pasid
)(struct iommu_sva
*handle
);
293 int (*page_response
)(struct device
*dev
,
294 struct iommu_fault_event
*evt
,
295 struct iommu_page_response
*msg
);
296 int (*cache_invalidate
)(struct iommu_domain
*domain
, struct device
*dev
,
297 struct iommu_cache_invalidate_info
*inv_info
);
298 int (*sva_bind_gpasid
)(struct iommu_domain
*domain
,
299 struct device
*dev
, struct iommu_gpasid_bind_data
*data
);
301 int (*sva_unbind_gpasid
)(struct device
*dev
, u32 pasid
);
303 int (*def_domain_type
)(struct device
*dev
);
305 unsigned long pgsize_bitmap
;
306 struct module
*owner
;
310 * struct iommu_device - IOMMU core representation of one IOMMU hardware
312 * @list: Used by the iommu-core to keep a list of registered iommus
313 * @ops: iommu-ops for talking to this iommu
314 * @dev: struct device for sysfs handling
316 struct iommu_device
{
317 struct list_head list
;
318 const struct iommu_ops
*ops
;
319 struct fwnode_handle
*fwnode
;
324 * struct iommu_fault_event - Generic fault event
326 * Can represent recoverable faults such as a page requests or
327 * unrecoverable faults such as DMA or IRQ remapping faults.
329 * @fault: fault descriptor
330 * @list: pending fault event list, used for tracking responses
332 struct iommu_fault_event
{
333 struct iommu_fault fault
;
334 struct list_head list
;
338 * struct iommu_fault_param - per-device IOMMU fault data
339 * @handler: Callback function to handle IOMMU faults at device level
340 * @data: handler private data
341 * @faults: holds the pending faults which needs response
342 * @lock: protect pending faults list
344 struct iommu_fault_param
{
345 iommu_dev_fault_handler_t handler
;
347 struct list_head faults
;
352 * struct dev_iommu - Collection of per-device IOMMU data
354 * @fault_param: IOMMU detected device fault reporting data
355 * @fwspec: IOMMU fwspec data
356 * @iommu_dev: IOMMU device this device is linked to
357 * @priv: IOMMU Driver private data
359 * TODO: migrate other per device data pointers under iommu_dev_data, e.g.
360 * struct iommu_group *iommu_group;
364 struct iommu_fault_param
*fault_param
;
365 struct iommu_fwspec
*fwspec
;
366 struct iommu_device
*iommu_dev
;
370 int iommu_device_register(struct iommu_device
*iommu
);
371 void iommu_device_unregister(struct iommu_device
*iommu
);
372 int iommu_device_sysfs_add(struct iommu_device
*iommu
,
373 struct device
*parent
,
374 const struct attribute_group
**groups
,
375 const char *fmt
, ...) __printf(4, 5);
376 void iommu_device_sysfs_remove(struct iommu_device
*iommu
);
377 int iommu_device_link(struct iommu_device
*iommu
, struct device
*link
);
378 void iommu_device_unlink(struct iommu_device
*iommu
, struct device
*link
);
380 static inline void __iommu_device_set_ops(struct iommu_device
*iommu
,
381 const struct iommu_ops
*ops
)
386 #define iommu_device_set_ops(iommu, ops) \
388 struct iommu_ops *__ops = (struct iommu_ops *)(ops); \
389 __ops->owner = THIS_MODULE; \
390 __iommu_device_set_ops(iommu, __ops); \
393 static inline void iommu_device_set_fwnode(struct iommu_device
*iommu
,
394 struct fwnode_handle
*fwnode
)
396 iommu
->fwnode
= fwnode
;
399 static inline struct iommu_device
*dev_to_iommu_device(struct device
*dev
)
401 return (struct iommu_device
*)dev_get_drvdata(dev
);
404 static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather
*gather
)
406 *gather
= (struct iommu_iotlb_gather
) {
411 #define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
412 #define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
413 #define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
414 #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
415 #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
416 #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
418 extern int bus_set_iommu(struct bus_type
*bus
, const struct iommu_ops
*ops
);
419 extern int bus_iommu_probe(struct bus_type
*bus
);
420 extern bool iommu_present(struct bus_type
*bus
);
421 extern bool iommu_capable(struct bus_type
*bus
, enum iommu_cap cap
);
422 extern struct iommu_domain
*iommu_domain_alloc(struct bus_type
*bus
);
423 extern struct iommu_group
*iommu_group_get_by_id(int id
);
424 extern void iommu_domain_free(struct iommu_domain
*domain
);
425 extern int iommu_attach_device(struct iommu_domain
*domain
,
427 extern void iommu_detach_device(struct iommu_domain
*domain
,
429 extern int iommu_uapi_cache_invalidate(struct iommu_domain
*domain
,
433 extern int iommu_uapi_sva_bind_gpasid(struct iommu_domain
*domain
,
434 struct device
*dev
, void __user
*udata
);
435 extern int iommu_uapi_sva_unbind_gpasid(struct iommu_domain
*domain
,
436 struct device
*dev
, void __user
*udata
);
437 extern int iommu_sva_unbind_gpasid(struct iommu_domain
*domain
,
438 struct device
*dev
, ioasid_t pasid
);
439 extern struct iommu_domain
*iommu_get_domain_for_dev(struct device
*dev
);
440 extern struct iommu_domain
*iommu_get_dma_domain(struct device
*dev
);
441 extern int iommu_map(struct iommu_domain
*domain
, unsigned long iova
,
442 phys_addr_t paddr
, size_t size
, int prot
);
443 extern int iommu_map_atomic(struct iommu_domain
*domain
, unsigned long iova
,
444 phys_addr_t paddr
, size_t size
, int prot
);
445 extern size_t iommu_unmap(struct iommu_domain
*domain
, unsigned long iova
,
447 extern size_t iommu_unmap_fast(struct iommu_domain
*domain
,
448 unsigned long iova
, size_t size
,
449 struct iommu_iotlb_gather
*iotlb_gather
);
450 extern size_t iommu_map_sg(struct iommu_domain
*domain
, unsigned long iova
,
451 struct scatterlist
*sg
,unsigned int nents
, int prot
);
452 extern size_t iommu_map_sg_atomic(struct iommu_domain
*domain
,
453 unsigned long iova
, struct scatterlist
*sg
,
454 unsigned int nents
, int prot
);
455 extern phys_addr_t
iommu_iova_to_phys(struct iommu_domain
*domain
, dma_addr_t iova
);
456 extern void iommu_set_fault_handler(struct iommu_domain
*domain
,
457 iommu_fault_handler_t handler
, void *token
);
459 extern void iommu_get_resv_regions(struct device
*dev
, struct list_head
*list
);
460 extern void iommu_put_resv_regions(struct device
*dev
, struct list_head
*list
);
461 extern void generic_iommu_put_resv_regions(struct device
*dev
,
462 struct list_head
*list
);
463 extern void iommu_set_default_passthrough(bool cmd_line
);
464 extern void iommu_set_default_translated(bool cmd_line
);
465 extern bool iommu_default_passthrough(void);
466 extern struct iommu_resv_region
*
467 iommu_alloc_resv_region(phys_addr_t start
, size_t length
, int prot
,
468 enum iommu_resv_type type
);
469 extern int iommu_get_group_resv_regions(struct iommu_group
*group
,
470 struct list_head
*head
);
472 extern int iommu_attach_group(struct iommu_domain
*domain
,
473 struct iommu_group
*group
);
474 extern void iommu_detach_group(struct iommu_domain
*domain
,
475 struct iommu_group
*group
);
476 extern struct iommu_group
*iommu_group_alloc(void);
477 extern void *iommu_group_get_iommudata(struct iommu_group
*group
);
478 extern void iommu_group_set_iommudata(struct iommu_group
*group
,
480 void (*release
)(void *iommu_data
));
481 extern int iommu_group_set_name(struct iommu_group
*group
, const char *name
);
482 extern int iommu_group_add_device(struct iommu_group
*group
,
484 extern void iommu_group_remove_device(struct device
*dev
);
485 extern int iommu_group_for_each_dev(struct iommu_group
*group
, void *data
,
486 int (*fn
)(struct device
*, void *));
487 extern struct iommu_group
*iommu_group_get(struct device
*dev
);
488 extern struct iommu_group
*iommu_group_ref_get(struct iommu_group
*group
);
489 extern void iommu_group_put(struct iommu_group
*group
);
490 extern int iommu_group_register_notifier(struct iommu_group
*group
,
491 struct notifier_block
*nb
);
492 extern int iommu_group_unregister_notifier(struct iommu_group
*group
,
493 struct notifier_block
*nb
);
494 extern int iommu_register_device_fault_handler(struct device
*dev
,
495 iommu_dev_fault_handler_t handler
,
498 extern int iommu_unregister_device_fault_handler(struct device
*dev
);
500 extern int iommu_report_device_fault(struct device
*dev
,
501 struct iommu_fault_event
*evt
);
502 extern int iommu_page_response(struct device
*dev
,
503 struct iommu_page_response
*msg
);
505 extern int iommu_group_id(struct iommu_group
*group
);
506 extern struct iommu_domain
*iommu_group_default_domain(struct iommu_group
*);
508 extern int iommu_domain_get_attr(struct iommu_domain
*domain
, enum iommu_attr
,
510 extern int iommu_domain_set_attr(struct iommu_domain
*domain
, enum iommu_attr
,
513 /* Window handling function prototypes */
514 extern int iommu_domain_window_enable(struct iommu_domain
*domain
, u32 wnd_nr
,
515 phys_addr_t offset
, u64 size
,
517 extern void iommu_domain_window_disable(struct iommu_domain
*domain
, u32 wnd_nr
);
519 extern int report_iommu_fault(struct iommu_domain
*domain
, struct device
*dev
,
520 unsigned long iova
, int flags
);
522 static inline void iommu_flush_iotlb_all(struct iommu_domain
*domain
)
524 if (domain
->ops
->flush_iotlb_all
)
525 domain
->ops
->flush_iotlb_all(domain
);
528 static inline void iommu_iotlb_sync(struct iommu_domain
*domain
,
529 struct iommu_iotlb_gather
*iotlb_gather
)
531 if (domain
->ops
->iotlb_sync
)
532 domain
->ops
->iotlb_sync(domain
, iotlb_gather
);
534 iommu_iotlb_gather_init(iotlb_gather
);
537 static inline void iommu_iotlb_gather_add_page(struct iommu_domain
*domain
,
538 struct iommu_iotlb_gather
*gather
,
539 unsigned long iova
, size_t size
)
541 unsigned long start
= iova
, end
= start
+ size
- 1;
544 * If the new page is disjoint from the current range or is mapped at
545 * a different granularity, then sync the TLB so that the gather
546 * structure can be rewritten.
548 if (gather
->pgsize
!= size
||
549 end
+ 1 < gather
->start
|| start
> gather
->end
+ 1) {
551 iommu_iotlb_sync(domain
, gather
);
552 gather
->pgsize
= size
;
555 if (gather
->end
< end
)
558 if (gather
->start
> start
)
559 gather
->start
= start
;
562 /* PCI device grouping function */
563 extern struct iommu_group
*pci_device_group(struct device
*dev
);
564 /* Generic device grouping function */
565 extern struct iommu_group
*generic_device_group(struct device
*dev
);
566 /* FSL-MC device grouping function */
567 struct iommu_group
*fsl_mc_device_group(struct device
*dev
);
570 * struct iommu_fwspec - per-device IOMMU instance data
571 * @ops: ops for this device's IOMMU
572 * @iommu_fwnode: firmware handle for this device's IOMMU
573 * @iommu_priv: IOMMU driver private data for this device
574 * @num_pasid_bits: number of PASID bits supported by this device
575 * @num_ids: number of associated device IDs
576 * @ids: IDs which this device may present to the IOMMU
578 struct iommu_fwspec
{
579 const struct iommu_ops
*ops
;
580 struct fwnode_handle
*iommu_fwnode
;
583 unsigned int num_ids
;
587 /* ATS is supported */
588 #define IOMMU_FWSPEC_PCI_RC_ATS (1 << 0)
591 * struct iommu_sva - handle to a device-mm bond
597 int iommu_fwspec_init(struct device
*dev
, struct fwnode_handle
*iommu_fwnode
,
598 const struct iommu_ops
*ops
);
599 void iommu_fwspec_free(struct device
*dev
);
600 int iommu_fwspec_add_ids(struct device
*dev
, u32
*ids
, int num_ids
);
601 const struct iommu_ops
*iommu_ops_from_fwnode(struct fwnode_handle
*fwnode
);
603 static inline struct iommu_fwspec
*dev_iommu_fwspec_get(struct device
*dev
)
606 return dev
->iommu
->fwspec
;
611 static inline void dev_iommu_fwspec_set(struct device
*dev
,
612 struct iommu_fwspec
*fwspec
)
614 dev
->iommu
->fwspec
= fwspec
;
617 static inline void *dev_iommu_priv_get(struct device
*dev
)
620 return dev
->iommu
->priv
;
625 static inline void dev_iommu_priv_set(struct device
*dev
, void *priv
)
627 dev
->iommu
->priv
= priv
;
630 int iommu_probe_device(struct device
*dev
);
631 void iommu_release_device(struct device
*dev
);
633 bool iommu_dev_has_feature(struct device
*dev
, enum iommu_dev_features f
);
634 int iommu_dev_enable_feature(struct device
*dev
, enum iommu_dev_features f
);
635 int iommu_dev_disable_feature(struct device
*dev
, enum iommu_dev_features f
);
636 bool iommu_dev_feature_enabled(struct device
*dev
, enum iommu_dev_features f
);
637 int iommu_aux_attach_device(struct iommu_domain
*domain
, struct device
*dev
);
638 void iommu_aux_detach_device(struct iommu_domain
*domain
, struct device
*dev
);
639 int iommu_aux_get_pasid(struct iommu_domain
*domain
, struct device
*dev
);
641 struct iommu_sva
*iommu_sva_bind_device(struct device
*dev
,
642 struct mm_struct
*mm
,
644 void iommu_sva_unbind_device(struct iommu_sva
*handle
);
645 u32
iommu_sva_get_pasid(struct iommu_sva
*handle
);
647 #else /* CONFIG_IOMMU_API */
650 struct iommu_group
{};
651 struct iommu_fwspec
{};
652 struct iommu_device
{};
653 struct iommu_fault_param
{};
654 struct iommu_iotlb_gather
{};
656 static inline bool iommu_present(struct bus_type
*bus
)
661 static inline bool iommu_capable(struct bus_type
*bus
, enum iommu_cap cap
)
666 static inline struct iommu_domain
*iommu_domain_alloc(struct bus_type
*bus
)
671 static inline struct iommu_group
*iommu_group_get_by_id(int id
)
676 static inline void iommu_domain_free(struct iommu_domain
*domain
)
680 static inline int iommu_attach_device(struct iommu_domain
*domain
,
686 static inline void iommu_detach_device(struct iommu_domain
*domain
,
691 static inline struct iommu_domain
*iommu_get_domain_for_dev(struct device
*dev
)
696 static inline int iommu_map(struct iommu_domain
*domain
, unsigned long iova
,
697 phys_addr_t paddr
, size_t size
, int prot
)
702 static inline int iommu_map_atomic(struct iommu_domain
*domain
,
703 unsigned long iova
, phys_addr_t paddr
,
704 size_t size
, int prot
)
709 static inline size_t iommu_unmap(struct iommu_domain
*domain
,
710 unsigned long iova
, size_t size
)
715 static inline size_t iommu_unmap_fast(struct iommu_domain
*domain
,
716 unsigned long iova
, int gfp_order
,
717 struct iommu_iotlb_gather
*iotlb_gather
)
722 static inline size_t iommu_map_sg(struct iommu_domain
*domain
,
723 unsigned long iova
, struct scatterlist
*sg
,
724 unsigned int nents
, int prot
)
729 static inline size_t iommu_map_sg_atomic(struct iommu_domain
*domain
,
730 unsigned long iova
, struct scatterlist
*sg
,
731 unsigned int nents
, int prot
)
736 static inline void iommu_flush_iotlb_all(struct iommu_domain
*domain
)
740 static inline void iommu_iotlb_sync(struct iommu_domain
*domain
,
741 struct iommu_iotlb_gather
*iotlb_gather
)
745 static inline int iommu_domain_window_enable(struct iommu_domain
*domain
,
746 u32 wnd_nr
, phys_addr_t paddr
,
752 static inline void iommu_domain_window_disable(struct iommu_domain
*domain
,
757 static inline phys_addr_t
iommu_iova_to_phys(struct iommu_domain
*domain
, dma_addr_t iova
)
762 static inline void iommu_set_fault_handler(struct iommu_domain
*domain
,
763 iommu_fault_handler_t handler
, void *token
)
767 static inline void iommu_get_resv_regions(struct device
*dev
,
768 struct list_head
*list
)
772 static inline void iommu_put_resv_regions(struct device
*dev
,
773 struct list_head
*list
)
777 static inline int iommu_get_group_resv_regions(struct iommu_group
*group
,
778 struct list_head
*head
)
783 static inline void iommu_set_default_passthrough(bool cmd_line
)
787 static inline void iommu_set_default_translated(bool cmd_line
)
791 static inline bool iommu_default_passthrough(void)
796 static inline int iommu_attach_group(struct iommu_domain
*domain
,
797 struct iommu_group
*group
)
802 static inline void iommu_detach_group(struct iommu_domain
*domain
,
803 struct iommu_group
*group
)
807 static inline struct iommu_group
*iommu_group_alloc(void)
809 return ERR_PTR(-ENODEV
);
812 static inline void *iommu_group_get_iommudata(struct iommu_group
*group
)
817 static inline void iommu_group_set_iommudata(struct iommu_group
*group
,
819 void (*release
)(void *iommu_data
))
823 static inline int iommu_group_set_name(struct iommu_group
*group
,
829 static inline int iommu_group_add_device(struct iommu_group
*group
,
835 static inline void iommu_group_remove_device(struct device
*dev
)
839 static inline int iommu_group_for_each_dev(struct iommu_group
*group
,
841 int (*fn
)(struct device
*, void *))
846 static inline struct iommu_group
*iommu_group_get(struct device
*dev
)
851 static inline void iommu_group_put(struct iommu_group
*group
)
855 static inline int iommu_group_register_notifier(struct iommu_group
*group
,
856 struct notifier_block
*nb
)
861 static inline int iommu_group_unregister_notifier(struct iommu_group
*group
,
862 struct notifier_block
*nb
)
868 int iommu_register_device_fault_handler(struct device
*dev
,
869 iommu_dev_fault_handler_t handler
,
875 static inline int iommu_unregister_device_fault_handler(struct device
*dev
)
881 int iommu_report_device_fault(struct device
*dev
, struct iommu_fault_event
*evt
)
886 static inline int iommu_page_response(struct device
*dev
,
887 struct iommu_page_response
*msg
)
892 static inline int iommu_group_id(struct iommu_group
*group
)
897 static inline int iommu_domain_get_attr(struct iommu_domain
*domain
,
898 enum iommu_attr attr
, void *data
)
903 static inline int iommu_domain_set_attr(struct iommu_domain
*domain
,
904 enum iommu_attr attr
, void *data
)
909 static inline int iommu_device_register(struct iommu_device
*iommu
)
914 static inline void iommu_device_set_ops(struct iommu_device
*iommu
,
915 const struct iommu_ops
*ops
)
919 static inline void iommu_device_set_fwnode(struct iommu_device
*iommu
,
920 struct fwnode_handle
*fwnode
)
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 void iommu_device_unregister(struct iommu_device
*iommu
)
943 static inline int iommu_device_sysfs_add(struct iommu_device
*iommu
,
944 struct device
*parent
,
945 const struct attribute_group
**groups
,
946 const char *fmt
, ...)
951 static inline void iommu_device_sysfs_remove(struct iommu_device
*iommu
)
955 static inline int iommu_device_link(struct device
*dev
, struct device
*link
)
960 static inline void iommu_device_unlink(struct device
*dev
, struct device
*link
)
964 static inline int iommu_fwspec_init(struct device
*dev
,
965 struct fwnode_handle
*iommu_fwnode
,
966 const struct iommu_ops
*ops
)
971 static inline void iommu_fwspec_free(struct device
*dev
)
975 static inline int iommu_fwspec_add_ids(struct device
*dev
, u32
*ids
,
982 const struct iommu_ops
*iommu_ops_from_fwnode(struct fwnode_handle
*fwnode
)
988 iommu_dev_has_feature(struct device
*dev
, enum iommu_dev_features feat
)
994 iommu_dev_feature_enabled(struct device
*dev
, enum iommu_dev_features feat
)
1000 iommu_dev_enable_feature(struct device
*dev
, enum iommu_dev_features feat
)
1006 iommu_dev_disable_feature(struct device
*dev
, enum iommu_dev_features feat
)
1012 iommu_aux_attach_device(struct iommu_domain
*domain
, struct device
*dev
)
1018 iommu_aux_detach_device(struct iommu_domain
*domain
, struct device
*dev
)
1023 iommu_aux_get_pasid(struct iommu_domain
*domain
, struct device
*dev
)
1028 static inline struct iommu_sva
*
1029 iommu_sva_bind_device(struct device
*dev
, struct mm_struct
*mm
, void *drvdata
)
1034 static inline void iommu_sva_unbind_device(struct iommu_sva
*handle
)
1038 static inline u32
iommu_sva_get_pasid(struct iommu_sva
*handle
)
1040 return IOMMU_PASID_INVALID
;
1044 iommu_uapi_cache_invalidate(struct iommu_domain
*domain
,
1046 struct iommu_cache_invalidate_info
*inv_info
)
1051 static inline int iommu_uapi_sva_bind_gpasid(struct iommu_domain
*domain
,
1052 struct device
*dev
, void __user
*udata
)
1057 static inline int iommu_uapi_sva_unbind_gpasid(struct iommu_domain
*domain
,
1058 struct device
*dev
, void __user
*udata
)
1063 static inline int iommu_sva_unbind_gpasid(struct iommu_domain
*domain
,
1070 static inline struct iommu_fwspec
*dev_iommu_fwspec_get(struct device
*dev
)
1074 #endif /* CONFIG_IOMMU_API */
1077 * iommu_map_sgtable - Map the given buffer to the IOMMU domain
1078 * @domain: The IOMMU domain to perform the mapping
1079 * @iova: The start address to map the buffer
1080 * @sgt: The sg_table object describing the buffer
1081 * @prot: IOMMU protection bits
1083 * Creates a mapping at @iova for the buffer described by a scatterlist
1084 * stored in the given sg_table object in the provided IOMMU domain.
1086 static inline size_t iommu_map_sgtable(struct iommu_domain
*domain
,
1087 unsigned long iova
, struct sg_table
*sgt
, int prot
)
1089 return iommu_map_sg(domain
, iova
, sgt
->sgl
, sgt
->orig_nents
, prot
);
1092 #ifdef CONFIG_IOMMU_DEBUGFS
1093 extern struct dentry
*iommu_debugfs_dir
;
1094 void iommu_debugfs_setup(void);
1096 static inline void iommu_debugfs_setup(void) {}
1099 #endif /* __LINUX_IOMMU_H */