Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * Copyright (C) 2007-2008 Advanced Micro Devices, Inc.
4 * Author: Joerg Roedel <joerg.roedel@amd.com>
5 */
6
7#ifndef __LINUX_IOMMU_H
8#define __LINUX_IOMMU_H
9
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>
15#include <linux/of.h>
16#include <linux/ioasid.h>
17#include <uapi/linux/iommu.h>
18
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 */
24/*
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.
32 */
33#define IOMMU_PRIV (1 << 5)
34
35struct iommu_ops;
36struct iommu_group;
37struct bus_type;
38struct device;
39struct iommu_domain;
40struct notifier_block;
41struct iommu_sva;
42struct iommu_fault_event;
43
44/* iommu fault flags */
45#define IOMMU_FAULT_READ 0x0
46#define IOMMU_FAULT_WRITE 0x1
47
48typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
49 struct device *, unsigned long, int, void *);
50typedef int (*iommu_dev_fault_handler_t)(struct iommu_fault *, void *);
51
52struct 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? */
56};
57
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
61 implementation */
62#define __IOMMU_DOMAIN_PT (1U << 2) /* Domain is identity mapped */
63
64/*
65 * This are the possible domain-types
66 *
67 * IOMMU_DOMAIN_BLOCKED - All DMA is blocked, can be used to isolate
68 * devices
69 * IOMMU_DOMAIN_IDENTITY - DMA addresses are system physical addresses
70 * IOMMU_DOMAIN_UNMANAGED - DMA mappings managed by IOMMU-API user, used
71 * for VMs
72 * IOMMU_DOMAIN_DMA - Internally used for DMA-API implementations.
73 * This flag allows IOMMU drivers to implement
74 * certain optimizations for these domains
75 */
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)
81
82struct iommu_domain {
83 unsigned type;
84 const struct iommu_ops *ops;
85 unsigned long pgsize_bitmap; /* Bitmap of page sizes in use */
86 iommu_fault_handler_t handler;
87 void *handler_token;
88 struct iommu_domain_geometry geometry;
89 void *iova_cookie;
90};
91
92enum iommu_cap {
93 IOMMU_CAP_CACHE_COHERENCY, /* IOMMU can enforce cache coherent DMA
94 transactions */
95 IOMMU_CAP_INTR_REMAP, /* IOMMU supports interrupt isolation */
96 IOMMU_CAP_NOEXEC, /* IOMMU_NOEXEC flag */
97};
98
99/*
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
106 * aligned.
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.
110 */
111
112enum iommu_attr {
113 DOMAIN_ATTR_GEOMETRY,
114 DOMAIN_ATTR_PAGING,
115 DOMAIN_ATTR_WINDOWS,
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,
122 DOMAIN_ATTR_MAX,
123};
124
125/* These are the possible reserved region types */
126enum iommu_resv_type {
127 /* Memory regions which must be mapped 1:1 at all times */
128 IOMMU_RESV_DIRECT,
129 /*
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)
133 */
134 IOMMU_RESV_DIRECT_RELAXABLE,
135 /* Arbitrary "never map this or give it to a device" address ranges */
136 IOMMU_RESV_RESERVED,
137 /* Hardware MSI region (untranslated) */
138 IOMMU_RESV_MSI,
139 /* Software-managed MSI translation window */
140 IOMMU_RESV_SW_MSI,
141};
142
143/**
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
150 */
151struct iommu_resv_region {
152 struct list_head list;
153 phys_addr_t start;
154 size_t length;
155 int prot;
156 enum iommu_resv_type type;
157};
158
159/* Per device IOMMU features */
160enum iommu_dev_features {
161 IOMMU_DEV_FEAT_AUX, /* Aux-domain feature */
162 IOMMU_DEV_FEAT_SVA, /* Shared Virtual Addresses */
163};
164
165#define IOMMU_PASID_INVALID (-1U)
166
167#ifdef CONFIG_IOMMU_API
168
169/**
170 * struct iommu_iotlb_gather - Range information for a pending IOTLB flush
171 *
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 *
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().
179 */
180struct iommu_iotlb_gather {
181 unsigned long start;
182 unsigned long end;
183 size_t pgsize;
184 struct page *freelist;
185};
186
187/**
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
199 * queue
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
234 */
235struct iommu_ops {
236 bool (*capable)(enum iommu_cap);
237
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 *);
241
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, unsigned long iova,
250 size_t size);
251 void (*iotlb_sync)(struct iommu_domain *domain,
252 struct iommu_iotlb_gather *iotlb_gather);
253 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova);
254 struct iommu_device *(*probe_device)(struct device *dev);
255 void (*release_device)(struct device *dev);
256 void (*probe_finalize)(struct device *dev);
257 struct iommu_group *(*device_group)(struct device *dev);
258 int (*domain_get_attr)(struct iommu_domain *domain,
259 enum iommu_attr attr, void *data);
260 int (*domain_set_attr)(struct iommu_domain *domain,
261 enum iommu_attr attr, void *data);
262
263 /* Request/Free a list of reserved regions for a device */
264 void (*get_resv_regions)(struct device *dev, struct list_head *list);
265 void (*put_resv_regions)(struct device *dev, struct list_head *list);
266 void (*apply_resv_region)(struct device *dev,
267 struct iommu_domain *domain,
268 struct iommu_resv_region *region);
269
270 /* Window handling functions */
271 int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr,
272 phys_addr_t paddr, u64 size, int prot);
273 void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr);
274
275 int (*of_xlate)(struct device *dev, struct of_phandle_args *args);
276 bool (*is_attach_deferred)(struct iommu_domain *domain, struct device *dev);
277
278 /* Per device IOMMU features */
279 bool (*dev_has_feat)(struct device *dev, enum iommu_dev_features f);
280 bool (*dev_feat_enabled)(struct device *dev, enum iommu_dev_features f);
281 int (*dev_enable_feat)(struct device *dev, enum iommu_dev_features f);
282 int (*dev_disable_feat)(struct device *dev, enum iommu_dev_features f);
283
284 /* Aux-domain specific attach/detach entries */
285 int (*aux_attach_dev)(struct iommu_domain *domain, struct device *dev);
286 void (*aux_detach_dev)(struct iommu_domain *domain, struct device *dev);
287 int (*aux_get_pasid)(struct iommu_domain *domain, struct device *dev);
288
289 struct iommu_sva *(*sva_bind)(struct device *dev, struct mm_struct *mm,
290 void *drvdata);
291 void (*sva_unbind)(struct iommu_sva *handle);
292 u32 (*sva_get_pasid)(struct iommu_sva *handle);
293
294 int (*page_response)(struct device *dev,
295 struct iommu_fault_event *evt,
296 struct iommu_page_response *msg);
297 int (*cache_invalidate)(struct iommu_domain *domain, struct device *dev,
298 struct iommu_cache_invalidate_info *inv_info);
299 int (*sva_bind_gpasid)(struct iommu_domain *domain,
300 struct device *dev, struct iommu_gpasid_bind_data *data);
301
302 int (*sva_unbind_gpasid)(struct device *dev, u32 pasid);
303
304 int (*def_domain_type)(struct device *dev);
305
306 unsigned long pgsize_bitmap;
307 struct module *owner;
308};
309
310/**
311 * struct iommu_device - IOMMU core representation of one IOMMU hardware
312 * instance
313 * @list: Used by the iommu-core to keep a list of registered iommus
314 * @ops: iommu-ops for talking to this iommu
315 * @dev: struct device for sysfs handling
316 */
317struct iommu_device {
318 struct list_head list;
319 const struct iommu_ops *ops;
320 struct fwnode_handle *fwnode;
321 struct device *dev;
322};
323
324/**
325 * struct iommu_fault_event - Generic fault event
326 *
327 * Can represent recoverable faults such as a page requests or
328 * unrecoverable faults such as DMA or IRQ remapping faults.
329 *
330 * @fault: fault descriptor
331 * @list: pending fault event list, used for tracking responses
332 */
333struct iommu_fault_event {
334 struct iommu_fault fault;
335 struct list_head list;
336};
337
338/**
339 * struct iommu_fault_param - per-device IOMMU fault data
340 * @handler: Callback function to handle IOMMU faults at device level
341 * @data: handler private data
342 * @faults: holds the pending faults which needs response
343 * @lock: protect pending faults list
344 */
345struct iommu_fault_param {
346 iommu_dev_fault_handler_t handler;
347 void *data;
348 struct list_head faults;
349 struct mutex lock;
350};
351
352/**
353 * struct dev_iommu - Collection of per-device IOMMU data
354 *
355 * @fault_param: IOMMU detected device fault reporting data
356 * @fwspec: IOMMU fwspec data
357 * @iommu_dev: IOMMU device this device is linked to
358 * @priv: IOMMU Driver private data
359 *
360 * TODO: migrate other per device data pointers under iommu_dev_data, e.g.
361 * struct iommu_group *iommu_group;
362 */
363struct dev_iommu {
364 struct mutex lock;
365 struct iommu_fault_param *fault_param;
366 struct iommu_fwspec *fwspec;
367 struct iommu_device *iommu_dev;
368 void *priv;
369};
370
371int iommu_device_register(struct iommu_device *iommu);
372void iommu_device_unregister(struct iommu_device *iommu);
373int iommu_device_sysfs_add(struct iommu_device *iommu,
374 struct device *parent,
375 const struct attribute_group **groups,
376 const char *fmt, ...) __printf(4, 5);
377void iommu_device_sysfs_remove(struct iommu_device *iommu);
378int iommu_device_link(struct iommu_device *iommu, struct device *link);
379void iommu_device_unlink(struct iommu_device *iommu, struct device *link);
380int iommu_deferred_attach(struct device *dev, struct iommu_domain *domain);
381
382static inline void __iommu_device_set_ops(struct iommu_device *iommu,
383 const struct iommu_ops *ops)
384{
385 iommu->ops = ops;
386}
387
388#define iommu_device_set_ops(iommu, ops) \
389do { \
390 struct iommu_ops *__ops = (struct iommu_ops *)(ops); \
391 __ops->owner = THIS_MODULE; \
392 __iommu_device_set_ops(iommu, __ops); \
393} while (0)
394
395static inline void iommu_device_set_fwnode(struct iommu_device *iommu,
396 struct fwnode_handle *fwnode)
397{
398 iommu->fwnode = fwnode;
399}
400
401static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
402{
403 return (struct iommu_device *)dev_get_drvdata(dev);
404}
405
406static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather)
407{
408 *gather = (struct iommu_iotlb_gather) {
409 .start = ULONG_MAX,
410 };
411}
412
413#define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
414#define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
415#define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
416#define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
417#define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
418#define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
419
420extern int bus_set_iommu(struct bus_type *bus, const struct iommu_ops *ops);
421extern int bus_iommu_probe(struct bus_type *bus);
422extern bool iommu_present(struct bus_type *bus);
423extern bool iommu_capable(struct bus_type *bus, enum iommu_cap cap);
424extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
425extern struct iommu_group *iommu_group_get_by_id(int id);
426extern void iommu_domain_free(struct iommu_domain *domain);
427extern int iommu_attach_device(struct iommu_domain *domain,
428 struct device *dev);
429extern void iommu_detach_device(struct iommu_domain *domain,
430 struct device *dev);
431extern int iommu_uapi_cache_invalidate(struct iommu_domain *domain,
432 struct device *dev,
433 void __user *uinfo);
434
435extern int iommu_uapi_sva_bind_gpasid(struct iommu_domain *domain,
436 struct device *dev, void __user *udata);
437extern int iommu_uapi_sva_unbind_gpasid(struct iommu_domain *domain,
438 struct device *dev, void __user *udata);
439extern int iommu_sva_unbind_gpasid(struct iommu_domain *domain,
440 struct device *dev, ioasid_t pasid);
441extern struct iommu_domain *iommu_get_domain_for_dev(struct device *dev);
442extern struct iommu_domain *iommu_get_dma_domain(struct device *dev);
443extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
444 phys_addr_t paddr, size_t size, int prot);
445extern int iommu_map_atomic(struct iommu_domain *domain, unsigned long iova,
446 phys_addr_t paddr, size_t size, int prot);
447extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
448 size_t size);
449extern size_t iommu_unmap_fast(struct iommu_domain *domain,
450 unsigned long iova, size_t size,
451 struct iommu_iotlb_gather *iotlb_gather);
452extern size_t iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
453 struct scatterlist *sg,unsigned int nents, int prot);
454extern size_t iommu_map_sg_atomic(struct iommu_domain *domain,
455 unsigned long iova, struct scatterlist *sg,
456 unsigned int nents, int prot);
457extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
458extern void iommu_set_fault_handler(struct iommu_domain *domain,
459 iommu_fault_handler_t handler, void *token);
460
461extern void iommu_get_resv_regions(struct device *dev, struct list_head *list);
462extern void iommu_put_resv_regions(struct device *dev, struct list_head *list);
463extern void generic_iommu_put_resv_regions(struct device *dev,
464 struct list_head *list);
465extern void iommu_set_default_passthrough(bool cmd_line);
466extern void iommu_set_default_translated(bool cmd_line);
467extern bool iommu_default_passthrough(void);
468extern struct iommu_resv_region *
469iommu_alloc_resv_region(phys_addr_t start, size_t length, int prot,
470 enum iommu_resv_type type);
471extern int iommu_get_group_resv_regions(struct iommu_group *group,
472 struct list_head *head);
473
474extern int iommu_attach_group(struct iommu_domain *domain,
475 struct iommu_group *group);
476extern void iommu_detach_group(struct iommu_domain *domain,
477 struct iommu_group *group);
478extern struct iommu_group *iommu_group_alloc(void);
479extern void *iommu_group_get_iommudata(struct iommu_group *group);
480extern void iommu_group_set_iommudata(struct iommu_group *group,
481 void *iommu_data,
482 void (*release)(void *iommu_data));
483extern int iommu_group_set_name(struct iommu_group *group, const char *name);
484extern int iommu_group_add_device(struct iommu_group *group,
485 struct device *dev);
486extern void iommu_group_remove_device(struct device *dev);
487extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
488 int (*fn)(struct device *, void *));
489extern struct iommu_group *iommu_group_get(struct device *dev);
490extern struct iommu_group *iommu_group_ref_get(struct iommu_group *group);
491extern void iommu_group_put(struct iommu_group *group);
492extern int iommu_group_register_notifier(struct iommu_group *group,
493 struct notifier_block *nb);
494extern int iommu_group_unregister_notifier(struct iommu_group *group,
495 struct notifier_block *nb);
496extern int iommu_register_device_fault_handler(struct device *dev,
497 iommu_dev_fault_handler_t handler,
498 void *data);
499
500extern int iommu_unregister_device_fault_handler(struct device *dev);
501
502extern int iommu_report_device_fault(struct device *dev,
503 struct iommu_fault_event *evt);
504extern int iommu_page_response(struct device *dev,
505 struct iommu_page_response *msg);
506
507extern int iommu_group_id(struct iommu_group *group);
508extern struct iommu_domain *iommu_group_default_domain(struct iommu_group *);
509
510extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
511 void *data);
512extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
513 void *data);
514
515/* Window handling function prototypes */
516extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
517 phys_addr_t offset, u64 size,
518 int prot);
519
520extern int report_iommu_fault(struct iommu_domain *domain, struct device *dev,
521 unsigned long iova, int flags);
522
523static inline void iommu_flush_iotlb_all(struct iommu_domain *domain)
524{
525 if (domain->ops->flush_iotlb_all)
526 domain->ops->flush_iotlb_all(domain);
527}
528
529static inline void iommu_iotlb_sync(struct iommu_domain *domain,
530 struct iommu_iotlb_gather *iotlb_gather)
531{
532 if (domain->ops->iotlb_sync)
533 domain->ops->iotlb_sync(domain, iotlb_gather);
534
535 iommu_iotlb_gather_init(iotlb_gather);
536}
537
538static inline void iommu_iotlb_gather_add_page(struct iommu_domain *domain,
539 struct iommu_iotlb_gather *gather,
540 unsigned long iova, size_t size)
541{
542 unsigned long start = iova, end = start + size - 1;
543
544 /*
545 * If the new page is disjoint from the current range or is mapped at
546 * a different granularity, then sync the TLB so that the gather
547 * structure can be rewritten.
548 */
549 if (gather->pgsize != size ||
550 end < gather->start || start > gather->end) {
551 if (gather->pgsize)
552 iommu_iotlb_sync(domain, gather);
553 gather->pgsize = size;
554 }
555
556 if (gather->end < end)
557 gather->end = end;
558
559 if (gather->start > start)
560 gather->start = start;
561}
562
563/* PCI device grouping function */
564extern struct iommu_group *pci_device_group(struct device *dev);
565/* Generic device grouping function */
566extern struct iommu_group *generic_device_group(struct device *dev);
567/* FSL-MC device grouping function */
568struct iommu_group *fsl_mc_device_group(struct device *dev);
569
570/**
571 * struct iommu_fwspec - per-device IOMMU instance data
572 * @ops: ops for this device's IOMMU
573 * @iommu_fwnode: firmware handle for this device's IOMMU
574 * @iommu_priv: IOMMU driver private data for this device
575 * @num_pasid_bits: number of PASID bits supported by this device
576 * @num_ids: number of associated device IDs
577 * @ids: IDs which this device may present to the IOMMU
578 */
579struct iommu_fwspec {
580 const struct iommu_ops *ops;
581 struct fwnode_handle *iommu_fwnode;
582 u32 flags;
583 u32 num_pasid_bits;
584 unsigned int num_ids;
585 u32 ids[];
586};
587
588/* ATS is supported */
589#define IOMMU_FWSPEC_PCI_RC_ATS (1 << 0)
590
591/**
592 * struct iommu_sva - handle to a device-mm bond
593 */
594struct iommu_sva {
595 struct device *dev;
596};
597
598int iommu_fwspec_init(struct device *dev, struct fwnode_handle *iommu_fwnode,
599 const struct iommu_ops *ops);
600void iommu_fwspec_free(struct device *dev);
601int iommu_fwspec_add_ids(struct device *dev, u32 *ids, int num_ids);
602const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode);
603
604static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev)
605{
606 if (dev->iommu)
607 return dev->iommu->fwspec;
608 else
609 return NULL;
610}
611
612static inline void dev_iommu_fwspec_set(struct device *dev,
613 struct iommu_fwspec *fwspec)
614{
615 dev->iommu->fwspec = fwspec;
616}
617
618static inline void *dev_iommu_priv_get(struct device *dev)
619{
620 if (dev->iommu)
621 return dev->iommu->priv;
622 else
623 return NULL;
624}
625
626static inline void dev_iommu_priv_set(struct device *dev, void *priv)
627{
628 dev->iommu->priv = priv;
629}
630
631int iommu_probe_device(struct device *dev);
632void iommu_release_device(struct device *dev);
633
634int iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features f);
635int iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features f);
636bool iommu_dev_feature_enabled(struct device *dev, enum iommu_dev_features f);
637int iommu_aux_attach_device(struct iommu_domain *domain, struct device *dev);
638void iommu_aux_detach_device(struct iommu_domain *domain, struct device *dev);
639int iommu_aux_get_pasid(struct iommu_domain *domain, struct device *dev);
640
641struct iommu_sva *iommu_sva_bind_device(struct device *dev,
642 struct mm_struct *mm,
643 void *drvdata);
644void iommu_sva_unbind_device(struct iommu_sva *handle);
645u32 iommu_sva_get_pasid(struct iommu_sva *handle);
646
647#else /* CONFIG_IOMMU_API */
648
649struct iommu_ops {};
650struct iommu_group {};
651struct iommu_fwspec {};
652struct iommu_device {};
653struct iommu_fault_param {};
654struct iommu_iotlb_gather {};
655
656static inline bool iommu_present(struct bus_type *bus)
657{
658 return false;
659}
660
661static inline bool iommu_capable(struct bus_type *bus, enum iommu_cap cap)
662{
663 return false;
664}
665
666static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
667{
668 return NULL;
669}
670
671static inline struct iommu_group *iommu_group_get_by_id(int id)
672{
673 return NULL;
674}
675
676static inline void iommu_domain_free(struct iommu_domain *domain)
677{
678}
679
680static inline int iommu_attach_device(struct iommu_domain *domain,
681 struct device *dev)
682{
683 return -ENODEV;
684}
685
686static inline void iommu_detach_device(struct iommu_domain *domain,
687 struct device *dev)
688{
689}
690
691static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
692{
693 return NULL;
694}
695
696static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
697 phys_addr_t paddr, size_t size, int prot)
698{
699 return -ENODEV;
700}
701
702static inline int iommu_map_atomic(struct iommu_domain *domain,
703 unsigned long iova, phys_addr_t paddr,
704 size_t size, int prot)
705{
706 return -ENODEV;
707}
708
709static inline size_t iommu_unmap(struct iommu_domain *domain,
710 unsigned long iova, size_t size)
711{
712 return 0;
713}
714
715static inline size_t iommu_unmap_fast(struct iommu_domain *domain,
716 unsigned long iova, int gfp_order,
717 struct iommu_iotlb_gather *iotlb_gather)
718{
719 return 0;
720}
721
722static inline size_t iommu_map_sg(struct iommu_domain *domain,
723 unsigned long iova, struct scatterlist *sg,
724 unsigned int nents, int prot)
725{
726 return 0;
727}
728
729static inline size_t iommu_map_sg_atomic(struct iommu_domain *domain,
730 unsigned long iova, struct scatterlist *sg,
731 unsigned int nents, int prot)
732{
733 return 0;
734}
735
736static inline void iommu_flush_iotlb_all(struct iommu_domain *domain)
737{
738}
739
740static inline void iommu_iotlb_sync(struct iommu_domain *domain,
741 struct iommu_iotlb_gather *iotlb_gather)
742{
743}
744
745static inline int iommu_domain_window_enable(struct iommu_domain *domain,
746 u32 wnd_nr, phys_addr_t paddr,
747 u64 size, int prot)
748{
749 return -ENODEV;
750}
751
752static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
753{
754 return 0;
755}
756
757static inline void iommu_set_fault_handler(struct iommu_domain *domain,
758 iommu_fault_handler_t handler, void *token)
759{
760}
761
762static inline void iommu_get_resv_regions(struct device *dev,
763 struct list_head *list)
764{
765}
766
767static inline void iommu_put_resv_regions(struct device *dev,
768 struct list_head *list)
769{
770}
771
772static inline int iommu_get_group_resv_regions(struct iommu_group *group,
773 struct list_head *head)
774{
775 return -ENODEV;
776}
777
778static inline void iommu_set_default_passthrough(bool cmd_line)
779{
780}
781
782static inline void iommu_set_default_translated(bool cmd_line)
783{
784}
785
786static inline bool iommu_default_passthrough(void)
787{
788 return true;
789}
790
791static inline int iommu_attach_group(struct iommu_domain *domain,
792 struct iommu_group *group)
793{
794 return -ENODEV;
795}
796
797static inline void iommu_detach_group(struct iommu_domain *domain,
798 struct iommu_group *group)
799{
800}
801
802static inline struct iommu_group *iommu_group_alloc(void)
803{
804 return ERR_PTR(-ENODEV);
805}
806
807static inline void *iommu_group_get_iommudata(struct iommu_group *group)
808{
809 return NULL;
810}
811
812static inline void iommu_group_set_iommudata(struct iommu_group *group,
813 void *iommu_data,
814 void (*release)(void *iommu_data))
815{
816}
817
818static inline int iommu_group_set_name(struct iommu_group *group,
819 const char *name)
820{
821 return -ENODEV;
822}
823
824static inline int iommu_group_add_device(struct iommu_group *group,
825 struct device *dev)
826{
827 return -ENODEV;
828}
829
830static inline void iommu_group_remove_device(struct device *dev)
831{
832}
833
834static inline int iommu_group_for_each_dev(struct iommu_group *group,
835 void *data,
836 int (*fn)(struct device *, void *))
837{
838 return -ENODEV;
839}
840
841static inline struct iommu_group *iommu_group_get(struct device *dev)
842{
843 return NULL;
844}
845
846static inline void iommu_group_put(struct iommu_group *group)
847{
848}
849
850static inline int iommu_group_register_notifier(struct iommu_group *group,
851 struct notifier_block *nb)
852{
853 return -ENODEV;
854}
855
856static inline int iommu_group_unregister_notifier(struct iommu_group *group,
857 struct notifier_block *nb)
858{
859 return 0;
860}
861
862static inline
863int iommu_register_device_fault_handler(struct device *dev,
864 iommu_dev_fault_handler_t handler,
865 void *data)
866{
867 return -ENODEV;
868}
869
870static inline int iommu_unregister_device_fault_handler(struct device *dev)
871{
872 return 0;
873}
874
875static inline
876int iommu_report_device_fault(struct device *dev, struct iommu_fault_event *evt)
877{
878 return -ENODEV;
879}
880
881static inline int iommu_page_response(struct device *dev,
882 struct iommu_page_response *msg)
883{
884 return -ENODEV;
885}
886
887static inline int iommu_group_id(struct iommu_group *group)
888{
889 return -ENODEV;
890}
891
892static inline int iommu_domain_get_attr(struct iommu_domain *domain,
893 enum iommu_attr attr, void *data)
894{
895 return -EINVAL;
896}
897
898static inline int iommu_domain_set_attr(struct iommu_domain *domain,
899 enum iommu_attr attr, void *data)
900{
901 return -EINVAL;
902}
903
904static inline int iommu_device_register(struct iommu_device *iommu)
905{
906 return -ENODEV;
907}
908
909static inline void iommu_device_set_ops(struct iommu_device *iommu,
910 const struct iommu_ops *ops)
911{
912}
913
914static inline void iommu_device_set_fwnode(struct iommu_device *iommu,
915 struct fwnode_handle *fwnode)
916{
917}
918
919static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
920{
921 return NULL;
922}
923
924static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather)
925{
926}
927
928static inline void iommu_iotlb_gather_add_page(struct iommu_domain *domain,
929 struct iommu_iotlb_gather *gather,
930 unsigned long iova, size_t size)
931{
932}
933
934static inline void iommu_device_unregister(struct iommu_device *iommu)
935{
936}
937
938static inline int iommu_device_sysfs_add(struct iommu_device *iommu,
939 struct device *parent,
940 const struct attribute_group **groups,
941 const char *fmt, ...)
942{
943 return -ENODEV;
944}
945
946static inline void iommu_device_sysfs_remove(struct iommu_device *iommu)
947{
948}
949
950static inline int iommu_device_link(struct device *dev, struct device *link)
951{
952 return -EINVAL;
953}
954
955static inline void iommu_device_unlink(struct device *dev, struct device *link)
956{
957}
958
959static inline int iommu_fwspec_init(struct device *dev,
960 struct fwnode_handle *iommu_fwnode,
961 const struct iommu_ops *ops)
962{
963 return -ENODEV;
964}
965
966static inline void iommu_fwspec_free(struct device *dev)
967{
968}
969
970static inline int iommu_fwspec_add_ids(struct device *dev, u32 *ids,
971 int num_ids)
972{
973 return -ENODEV;
974}
975
976static inline
977const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode)
978{
979 return NULL;
980}
981
982static inline bool
983iommu_dev_feature_enabled(struct device *dev, enum iommu_dev_features feat)
984{
985 return false;
986}
987
988static inline int
989iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features feat)
990{
991 return -ENODEV;
992}
993
994static inline int
995iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features feat)
996{
997 return -ENODEV;
998}
999
1000static inline int
1001iommu_aux_attach_device(struct iommu_domain *domain, struct device *dev)
1002{
1003 return -ENODEV;
1004}
1005
1006static inline void
1007iommu_aux_detach_device(struct iommu_domain *domain, struct device *dev)
1008{
1009}
1010
1011static inline int
1012iommu_aux_get_pasid(struct iommu_domain *domain, struct device *dev)
1013{
1014 return -ENODEV;
1015}
1016
1017static inline struct iommu_sva *
1018iommu_sva_bind_device(struct device *dev, struct mm_struct *mm, void *drvdata)
1019{
1020 return NULL;
1021}
1022
1023static inline void iommu_sva_unbind_device(struct iommu_sva *handle)
1024{
1025}
1026
1027static inline u32 iommu_sva_get_pasid(struct iommu_sva *handle)
1028{
1029 return IOMMU_PASID_INVALID;
1030}
1031
1032static inline int
1033iommu_uapi_cache_invalidate(struct iommu_domain *domain,
1034 struct device *dev,
1035 struct iommu_cache_invalidate_info *inv_info)
1036{
1037 return -ENODEV;
1038}
1039
1040static inline int iommu_uapi_sva_bind_gpasid(struct iommu_domain *domain,
1041 struct device *dev, void __user *udata)
1042{
1043 return -ENODEV;
1044}
1045
1046static inline int iommu_uapi_sva_unbind_gpasid(struct iommu_domain *domain,
1047 struct device *dev, void __user *udata)
1048{
1049 return -ENODEV;
1050}
1051
1052static inline int iommu_sva_unbind_gpasid(struct iommu_domain *domain,
1053 struct device *dev,
1054 ioasid_t pasid)
1055{
1056 return -ENODEV;
1057}
1058
1059static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev)
1060{
1061 return NULL;
1062}
1063#endif /* CONFIG_IOMMU_API */
1064
1065/**
1066 * iommu_map_sgtable - Map the given buffer to the IOMMU domain
1067 * @domain: The IOMMU domain to perform the mapping
1068 * @iova: The start address to map the buffer
1069 * @sgt: The sg_table object describing the buffer
1070 * @prot: IOMMU protection bits
1071 *
1072 * Creates a mapping at @iova for the buffer described by a scatterlist
1073 * stored in the given sg_table object in the provided IOMMU domain.
1074 */
1075static inline size_t iommu_map_sgtable(struct iommu_domain *domain,
1076 unsigned long iova, struct sg_table *sgt, int prot)
1077{
1078 return iommu_map_sg(domain, iova, sgt->sgl, sgt->orig_nents, prot);
1079}
1080
1081#ifdef CONFIG_IOMMU_DEBUGFS
1082extern struct dentry *iommu_debugfs_dir;
1083void iommu_debugfs_setup(void);
1084#else
1085static inline void iommu_debugfs_setup(void) {}
1086#endif
1087
1088#endif /* __LINUX_IOMMU_H */