Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
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/iova_bitmap.h>
17#include <uapi/linux/iommufd.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 iommu_domain_ops;
41struct iommu_dirty_ops;
42struct notifier_block;
43struct iommu_sva;
44struct iommu_dma_cookie;
45struct iommu_dma_msi_cookie;
46struct iommu_fault_param;
47struct iommufd_ctx;
48struct iommufd_viommu;
49struct msi_desc;
50struct msi_msg;
51
52#define IOMMU_FAULT_PERM_READ (1 << 0) /* read */
53#define IOMMU_FAULT_PERM_WRITE (1 << 1) /* write */
54#define IOMMU_FAULT_PERM_EXEC (1 << 2) /* exec */
55#define IOMMU_FAULT_PERM_PRIV (1 << 3) /* privileged */
56
57/* Generic fault types, can be expanded IRQ remapping fault */
58enum iommu_fault_type {
59 IOMMU_FAULT_PAGE_REQ = 1, /* page request fault */
60};
61
62/**
63 * struct iommu_fault_page_request - Page Request data
64 * @flags: encodes whether the corresponding fields are valid and whether this
65 * is the last page in group (IOMMU_FAULT_PAGE_REQUEST_* values).
66 * When IOMMU_FAULT_PAGE_RESPONSE_NEEDS_PASID is set, the page response
67 * must have the same PASID value as the page request. When it is clear,
68 * the page response should not have a PASID.
69 * @pasid: Process Address Space ID
70 * @grpid: Page Request Group Index
71 * @perm: requested page permissions (IOMMU_FAULT_PERM_* values)
72 * @addr: page address
73 * @private_data: device-specific private information
74 */
75struct iommu_fault_page_request {
76#define IOMMU_FAULT_PAGE_REQUEST_PASID_VALID (1 << 0)
77#define IOMMU_FAULT_PAGE_REQUEST_LAST_PAGE (1 << 1)
78#define IOMMU_FAULT_PAGE_RESPONSE_NEEDS_PASID (1 << 2)
79 u32 flags;
80 u32 pasid;
81 u32 grpid;
82 u32 perm;
83 u64 addr;
84 u64 private_data[2];
85};
86
87/**
88 * struct iommu_fault - Generic fault data
89 * @type: fault type from &enum iommu_fault_type
90 * @prm: Page Request message, when @type is %IOMMU_FAULT_PAGE_REQ
91 */
92struct iommu_fault {
93 u32 type;
94 struct iommu_fault_page_request prm;
95};
96
97/**
98 * enum iommu_page_response_code - Return status of fault handlers
99 * @IOMMU_PAGE_RESP_SUCCESS: Fault has been handled and the page tables
100 * populated, retry the access. This is "Success" in PCI PRI.
101 * @IOMMU_PAGE_RESP_FAILURE: General error. Drop all subsequent faults from
102 * this device if possible. This is "Response Failure" in PCI PRI.
103 * @IOMMU_PAGE_RESP_INVALID: Could not handle this fault, don't retry the
104 * access. This is "Invalid Request" in PCI PRI.
105 */
106enum iommu_page_response_code {
107 IOMMU_PAGE_RESP_SUCCESS = 0,
108 IOMMU_PAGE_RESP_INVALID,
109 IOMMU_PAGE_RESP_FAILURE,
110};
111
112/**
113 * struct iommu_page_response - Generic page response information
114 * @pasid: Process Address Space ID
115 * @grpid: Page Request Group Index
116 * @code: response code from &enum iommu_page_response_code
117 */
118struct iommu_page_response {
119 u32 pasid;
120 u32 grpid;
121 u32 code;
122};
123
124struct iopf_fault {
125 struct iommu_fault fault;
126 /* node for pending lists */
127 struct list_head list;
128};
129
130struct iopf_group {
131 struct iopf_fault last_fault;
132 struct list_head faults;
133 size_t fault_count;
134 /* list node for iommu_fault_param::faults */
135 struct list_head pending_node;
136 struct work_struct work;
137 struct iommu_attach_handle *attach_handle;
138 /* The device's fault data parameter. */
139 struct iommu_fault_param *fault_param;
140 /* Used by handler provider to hook the group on its own lists. */
141 struct list_head node;
142 u32 cookie;
143};
144
145/**
146 * struct iopf_queue - IO Page Fault queue
147 * @wq: the fault workqueue
148 * @devices: devices attached to this queue
149 * @lock: protects the device list
150 */
151struct iopf_queue {
152 struct workqueue_struct *wq;
153 struct list_head devices;
154 struct mutex lock;
155};
156
157/* iommu fault flags */
158#define IOMMU_FAULT_READ 0x0
159#define IOMMU_FAULT_WRITE 0x1
160
161typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
162 struct device *, unsigned long, int, void *);
163
164struct iommu_domain_geometry {
165 dma_addr_t aperture_start; /* First address that can be mapped */
166 dma_addr_t aperture_end; /* Last address that can be mapped */
167 bool force_aperture; /* DMA only allowed in mappable range? */
168};
169
170enum iommu_domain_cookie_type {
171 IOMMU_COOKIE_NONE,
172 IOMMU_COOKIE_DMA_IOVA,
173 IOMMU_COOKIE_DMA_MSI,
174 IOMMU_COOKIE_FAULT_HANDLER,
175 IOMMU_COOKIE_SVA,
176 IOMMU_COOKIE_IOMMUFD,
177};
178
179/* Domain feature flags */
180#define __IOMMU_DOMAIN_PAGING (1U << 0) /* Support for iommu_map/unmap */
181#define __IOMMU_DOMAIN_DMA_API (1U << 1) /* Domain for use in DMA-API
182 implementation */
183#define __IOMMU_DOMAIN_PT (1U << 2) /* Domain is identity mapped */
184#define __IOMMU_DOMAIN_DMA_FQ (1U << 3) /* DMA-API uses flush queue */
185
186#define __IOMMU_DOMAIN_SVA (1U << 4) /* Shared process address space */
187#define __IOMMU_DOMAIN_PLATFORM (1U << 5)
188
189#define __IOMMU_DOMAIN_NESTED (1U << 6) /* User-managed address space nested
190 on a stage-2 translation */
191
192#define IOMMU_DOMAIN_ALLOC_FLAGS ~__IOMMU_DOMAIN_DMA_FQ
193/*
194 * This are the possible domain-types
195 *
196 * IOMMU_DOMAIN_BLOCKED - All DMA is blocked, can be used to isolate
197 * devices
198 * IOMMU_DOMAIN_IDENTITY - DMA addresses are system physical addresses
199 * IOMMU_DOMAIN_UNMANAGED - DMA mappings managed by IOMMU-API user, used
200 * for VMs
201 * IOMMU_DOMAIN_DMA - Internally used for DMA-API implementations.
202 * This flag allows IOMMU drivers to implement
203 * certain optimizations for these domains
204 * IOMMU_DOMAIN_DMA_FQ - As above, but definitely using batched TLB
205 * invalidation.
206 * IOMMU_DOMAIN_SVA - DMA addresses are shared process addresses
207 * represented by mm_struct's.
208 * IOMMU_DOMAIN_PLATFORM - Legacy domain for drivers that do their own
209 * dma_api stuff. Do not use in new drivers.
210 */
211#define IOMMU_DOMAIN_BLOCKED (0U)
212#define IOMMU_DOMAIN_IDENTITY (__IOMMU_DOMAIN_PT)
213#define IOMMU_DOMAIN_UNMANAGED (__IOMMU_DOMAIN_PAGING)
214#define IOMMU_DOMAIN_DMA (__IOMMU_DOMAIN_PAGING | \
215 __IOMMU_DOMAIN_DMA_API)
216#define IOMMU_DOMAIN_DMA_FQ (__IOMMU_DOMAIN_PAGING | \
217 __IOMMU_DOMAIN_DMA_API | \
218 __IOMMU_DOMAIN_DMA_FQ)
219#define IOMMU_DOMAIN_SVA (__IOMMU_DOMAIN_SVA)
220#define IOMMU_DOMAIN_PLATFORM (__IOMMU_DOMAIN_PLATFORM)
221#define IOMMU_DOMAIN_NESTED (__IOMMU_DOMAIN_NESTED)
222
223struct iommu_domain {
224 unsigned type;
225 enum iommu_domain_cookie_type cookie_type;
226 bool is_iommupt;
227 const struct iommu_domain_ops *ops;
228 const struct iommu_dirty_ops *dirty_ops;
229 const struct iommu_ops *owner; /* Whose domain_alloc we came from */
230 unsigned long pgsize_bitmap; /* Bitmap of page sizes in use */
231 struct iommu_domain_geometry geometry;
232 int (*iopf_handler)(struct iopf_group *group);
233
234 union { /* cookie */
235 struct iommu_dma_cookie *iova_cookie;
236 struct iommu_dma_msi_cookie *msi_cookie;
237 struct iommufd_hw_pagetable *iommufd_hwpt;
238 struct {
239 iommu_fault_handler_t handler;
240 void *handler_token;
241 };
242 struct { /* IOMMU_DOMAIN_SVA */
243 struct mm_struct *mm;
244 int users;
245 /*
246 * Next iommu_domain in mm->iommu_mm->sva-domains list
247 * protected by iommu_sva_lock.
248 */
249 struct list_head next;
250 };
251 };
252};
253
254static inline bool iommu_is_dma_domain(struct iommu_domain *domain)
255{
256 return domain->type & __IOMMU_DOMAIN_DMA_API;
257}
258
259enum iommu_cap {
260 IOMMU_CAP_CACHE_COHERENCY, /* IOMMU_CACHE is supported */
261 IOMMU_CAP_NOEXEC, /* IOMMU_NOEXEC flag */
262 IOMMU_CAP_PRE_BOOT_PROTECTION, /* Firmware says it used the IOMMU for
263 DMA protection and we should too */
264 /*
265 * Per-device flag indicating if enforce_cache_coherency() will work on
266 * this device.
267 */
268 IOMMU_CAP_ENFORCE_CACHE_COHERENCY,
269 /*
270 * IOMMU driver does not issue TLB maintenance during .unmap, so can
271 * usefully support the non-strict DMA flush queue.
272 */
273 IOMMU_CAP_DEFERRED_FLUSH,
274 IOMMU_CAP_DIRTY_TRACKING, /* IOMMU supports dirty tracking */
275 /* ATS is supported and may be enabled for this device */
276 IOMMU_CAP_PCI_ATS_SUPPORTED,
277};
278
279/* These are the possible reserved region types */
280enum iommu_resv_type {
281 /* Memory regions which must be mapped 1:1 at all times */
282 IOMMU_RESV_DIRECT,
283 /*
284 * Memory regions which are advertised to be 1:1 but are
285 * commonly considered relaxable in some conditions,
286 * for instance in device assignment use case (USB, Graphics)
287 */
288 IOMMU_RESV_DIRECT_RELAXABLE,
289 /* Arbitrary "never map this or give it to a device" address ranges */
290 IOMMU_RESV_RESERVED,
291 /* Hardware MSI region (untranslated) */
292 IOMMU_RESV_MSI,
293 /* Software-managed MSI translation window */
294 IOMMU_RESV_SW_MSI,
295};
296
297/**
298 * struct iommu_resv_region - descriptor for a reserved memory region
299 * @list: Linked list pointers
300 * @start: System physical start address of the region
301 * @length: Length of the region in bytes
302 * @prot: IOMMU Protection flags (READ/WRITE/...)
303 * @type: Type of the reserved region
304 * @free: Callback to free associated memory allocations
305 */
306struct iommu_resv_region {
307 struct list_head list;
308 phys_addr_t start;
309 size_t length;
310 int prot;
311 enum iommu_resv_type type;
312 void (*free)(struct device *dev, struct iommu_resv_region *region);
313};
314
315struct iommu_iort_rmr_data {
316 struct iommu_resv_region rr;
317
318 /* Stream IDs associated with IORT RMR entry */
319 const u32 *sids;
320 u32 num_sids;
321};
322
323#define IOMMU_NO_PASID (0U) /* Reserved for DMA w/o PASID */
324#define IOMMU_FIRST_GLOBAL_PASID (1U) /*starting range for allocation */
325#define IOMMU_PASID_INVALID (-1U)
326typedef unsigned int ioasid_t;
327
328/* Read but do not clear any dirty bits */
329#define IOMMU_DIRTY_NO_CLEAR (1 << 0)
330
331/*
332 * Pages allocated through iommu_alloc_pages_node_sz() can be placed on this
333 * list using iommu_pages_list_add(). Note: ONLY pages from
334 * iommu_alloc_pages_node_sz() can be used this way!
335 */
336struct iommu_pages_list {
337 struct list_head pages;
338};
339
340#define IOMMU_PAGES_LIST_INIT(name) \
341 ((struct iommu_pages_list){ .pages = LIST_HEAD_INIT(name.pages) })
342
343#ifdef CONFIG_IOMMU_API
344
345/**
346 * struct iommu_iotlb_gather - Range information for a pending IOTLB flush
347 *
348 * @start: IOVA representing the start of the range to be flushed
349 * @end: IOVA representing the end of the range to be flushed (inclusive)
350 * @pgsize: The interval at which to perform the flush
351 * @freelist: Removed pages to free after sync
352 * @queued: Indicates that the flush will be queued
353 *
354 * This structure is intended to be updated by multiple calls to the
355 * ->unmap() function in struct iommu_ops before eventually being passed
356 * into ->iotlb_sync(). Drivers can add pages to @freelist to be freed after
357 * ->iotlb_sync() or ->iotlb_flush_all() have cleared all cached references to
358 * them. @queued is set to indicate when ->iotlb_flush_all() will be called
359 * later instead of ->iotlb_sync(), so drivers may optimise accordingly.
360 */
361struct iommu_iotlb_gather {
362 unsigned long start;
363 unsigned long end;
364 size_t pgsize;
365 struct iommu_pages_list freelist;
366 bool queued;
367};
368
369/**
370 * struct iommu_dirty_bitmap - Dirty IOVA bitmap state
371 * @bitmap: IOVA bitmap
372 * @gather: Range information for a pending IOTLB flush
373 */
374struct iommu_dirty_bitmap {
375 struct iova_bitmap *bitmap;
376 struct iommu_iotlb_gather *gather;
377};
378
379/**
380 * struct iommu_dirty_ops - domain specific dirty tracking operations
381 * @set_dirty_tracking: Enable or Disable dirty tracking on the iommu domain
382 * @read_and_clear_dirty: Walk IOMMU page tables for dirtied PTEs marshalled
383 * into a bitmap, with a bit represented as a page.
384 * Reads the dirty PTE bits and clears it from IO
385 * pagetables.
386 */
387struct iommu_dirty_ops {
388 int (*set_dirty_tracking)(struct iommu_domain *domain, bool enabled);
389 int (*read_and_clear_dirty)(struct iommu_domain *domain,
390 unsigned long iova, size_t size,
391 unsigned long flags,
392 struct iommu_dirty_bitmap *dirty);
393};
394
395/**
396 * struct iommu_user_data - iommu driver specific user space data info
397 * @type: The data type of the user buffer
398 * @uptr: Pointer to the user buffer for copy_from_user()
399 * @len: The length of the user buffer in bytes
400 *
401 * A user space data is an uAPI that is defined in include/uapi/linux/iommufd.h
402 * @type, @uptr and @len should be just copied from an iommufd core uAPI struct.
403 */
404struct iommu_user_data {
405 unsigned int type;
406 void __user *uptr;
407 size_t len;
408};
409
410/**
411 * struct iommu_user_data_array - iommu driver specific user space data array
412 * @type: The data type of all the entries in the user buffer array
413 * @uptr: Pointer to the user buffer array
414 * @entry_len: The fixed-width length of an entry in the array, in bytes
415 * @entry_num: The number of total entries in the array
416 *
417 * The user buffer includes an array of requests with format defined in
418 * include/uapi/linux/iommufd.h
419 */
420struct iommu_user_data_array {
421 unsigned int type;
422 void __user *uptr;
423 size_t entry_len;
424 u32 entry_num;
425};
426
427/**
428 * __iommu_copy_struct_from_user - Copy iommu driver specific user space data
429 * @dst_data: Pointer to an iommu driver specific user data that is defined in
430 * include/uapi/linux/iommufd.h
431 * @src_data: Pointer to a struct iommu_user_data for user space data info
432 * @data_type: The data type of the @dst_data. Must match with @src_data.type
433 * @data_len: Length of current user data structure, i.e. sizeof(struct _dst)
434 * @min_len: Initial length of user data structure for backward compatibility.
435 * This should be offsetofend using the last member in the user data
436 * struct that was initially added to include/uapi/linux/iommufd.h
437 */
438static inline int __iommu_copy_struct_from_user(
439 void *dst_data, const struct iommu_user_data *src_data,
440 unsigned int data_type, size_t data_len, size_t min_len)
441{
442 if (WARN_ON(!dst_data || !src_data))
443 return -EINVAL;
444 if (src_data->type != data_type)
445 return -EINVAL;
446 if (src_data->len < min_len || data_len < src_data->len)
447 return -EINVAL;
448 return copy_struct_from_user(dst_data, data_len, src_data->uptr,
449 src_data->len);
450}
451
452/**
453 * iommu_copy_struct_from_user - Copy iommu driver specific user space data
454 * @kdst: Pointer to an iommu driver specific user data that is defined in
455 * include/uapi/linux/iommufd.h
456 * @user_data: Pointer to a struct iommu_user_data for user space data info
457 * @data_type: The data type of the @kdst. Must match with @user_data->type
458 * @min_last: The last member of the data structure @kdst points in the initial
459 * version.
460 * Return 0 for success, otherwise -error.
461 */
462#define iommu_copy_struct_from_user(kdst, user_data, data_type, min_last) \
463 __iommu_copy_struct_from_user(kdst, user_data, data_type, \
464 sizeof(*kdst), \
465 offsetofend(typeof(*kdst), min_last))
466
467/**
468 * __iommu_copy_struct_from_user_array - Copy iommu driver specific user space
469 * data from an iommu_user_data_array
470 * @dst_data: Pointer to an iommu driver specific user data that is defined in
471 * include/uapi/linux/iommufd.h
472 * @src_array: Pointer to a struct iommu_user_data_array for a user space array
473 * @data_type: The data type of the @dst_data. Must match with @src_array.type
474 * @index: Index to the location in the array to copy user data from
475 * @data_len: Length of current user data structure, i.e. sizeof(struct _dst)
476 * @min_len: Initial length of user data structure for backward compatibility.
477 * This should be offsetofend using the last member in the user data
478 * struct that was initially added to include/uapi/linux/iommufd.h
479 */
480static inline int __iommu_copy_struct_from_user_array(
481 void *dst_data, const struct iommu_user_data_array *src_array,
482 unsigned int data_type, unsigned int index, size_t data_len,
483 size_t min_len)
484{
485 struct iommu_user_data src_data;
486
487 if (WARN_ON(!src_array || index >= src_array->entry_num))
488 return -EINVAL;
489 if (!src_array->entry_num)
490 return -EINVAL;
491 src_data.uptr = src_array->uptr + src_array->entry_len * index;
492 src_data.len = src_array->entry_len;
493 src_data.type = src_array->type;
494
495 return __iommu_copy_struct_from_user(dst_data, &src_data, data_type,
496 data_len, min_len);
497}
498
499/**
500 * iommu_copy_struct_from_user_array - Copy iommu driver specific user space
501 * data from an iommu_user_data_array
502 * @kdst: Pointer to an iommu driver specific user data that is defined in
503 * include/uapi/linux/iommufd.h
504 * @user_array: Pointer to a struct iommu_user_data_array for a user space
505 * array
506 * @data_type: The data type of the @kdst. Must match with @user_array->type
507 * @index: Index to the location in the array to copy user data from
508 * @min_last: The last member of the data structure @kdst points in the
509 * initial version.
510 *
511 * Copy a single entry from a user array. Return 0 for success, otherwise
512 * -error.
513 */
514#define iommu_copy_struct_from_user_array(kdst, user_array, data_type, index, \
515 min_last) \
516 __iommu_copy_struct_from_user_array( \
517 kdst, user_array, data_type, index, sizeof(*(kdst)), \
518 offsetofend(typeof(*(kdst)), min_last))
519
520/**
521 * iommu_copy_struct_from_full_user_array - Copy iommu driver specific user
522 * space data from an iommu_user_data_array
523 * @kdst: Pointer to an iommu driver specific user data that is defined in
524 * include/uapi/linux/iommufd.h
525 * @kdst_entry_size: sizeof(*kdst)
526 * @user_array: Pointer to a struct iommu_user_data_array for a user space
527 * array
528 * @data_type: The data type of the @kdst. Must match with @user_array->type
529 *
530 * Copy the entire user array. kdst must have room for kdst_entry_size *
531 * user_array->entry_num bytes. Return 0 for success, otherwise -error.
532 */
533static inline int
534iommu_copy_struct_from_full_user_array(void *kdst, size_t kdst_entry_size,
535 struct iommu_user_data_array *user_array,
536 unsigned int data_type)
537{
538 unsigned int i;
539 int ret;
540
541 if (user_array->type != data_type)
542 return -EINVAL;
543 if (!user_array->entry_num)
544 return -EINVAL;
545 if (likely(user_array->entry_len == kdst_entry_size)) {
546 if (copy_from_user(kdst, user_array->uptr,
547 user_array->entry_num *
548 user_array->entry_len))
549 return -EFAULT;
550 }
551
552 /* Copy item by item */
553 for (i = 0; i != user_array->entry_num; i++) {
554 ret = copy_struct_from_user(
555 kdst + kdst_entry_size * i, kdst_entry_size,
556 user_array->uptr + user_array->entry_len * i,
557 user_array->entry_len);
558 if (ret)
559 return ret;
560 }
561 return 0;
562}
563
564/**
565 * __iommu_copy_struct_to_user - Report iommu driver specific user space data
566 * @dst_data: Pointer to a struct iommu_user_data for user space data location
567 * @src_data: Pointer to an iommu driver specific user data that is defined in
568 * include/uapi/linux/iommufd.h
569 * @data_type: The data type of the @src_data. Must match with @dst_data.type
570 * @data_len: Length of current user data structure, i.e. sizeof(struct _src)
571 * @min_len: Initial length of user data structure for backward compatibility.
572 * This should be offsetofend using the last member in the user data
573 * struct that was initially added to include/uapi/linux/iommufd.h
574 */
575static inline int
576__iommu_copy_struct_to_user(const struct iommu_user_data *dst_data,
577 void *src_data, unsigned int data_type,
578 size_t data_len, size_t min_len)
579{
580 if (WARN_ON(!dst_data || !src_data))
581 return -EINVAL;
582 if (dst_data->type != data_type)
583 return -EINVAL;
584 if (dst_data->len < min_len || data_len < dst_data->len)
585 return -EINVAL;
586 return copy_struct_to_user(dst_data->uptr, dst_data->len, src_data,
587 data_len, NULL);
588}
589
590/**
591 * iommu_copy_struct_to_user - Report iommu driver specific user space data
592 * @user_data: Pointer to a struct iommu_user_data for user space data location
593 * @ksrc: Pointer to an iommu driver specific user data that is defined in
594 * include/uapi/linux/iommufd.h
595 * @data_type: The data type of the @ksrc. Must match with @user_data->type
596 * @min_last: The last member of the data structure @ksrc points in the initial
597 * version.
598 * Return 0 for success, otherwise -error.
599 */
600#define iommu_copy_struct_to_user(user_data, ksrc, data_type, min_last) \
601 __iommu_copy_struct_to_user(user_data, ksrc, data_type, sizeof(*ksrc), \
602 offsetofend(typeof(*ksrc), min_last))
603
604/**
605 * struct iommu_ops - iommu ops and capabilities
606 * @capable: check capability
607 * @hw_info: report iommu hardware information. The data buffer returned by this
608 * op is allocated in the iommu driver and freed by the caller after
609 * use. @type can input a requested type and output a supported type.
610 * Driver should reject an unsupported data @type input
611 * @domain_alloc: Do not use in new drivers
612 * @domain_alloc_identity: allocate an IDENTITY domain. Drivers should prefer to
613 * use identity_domain instead. This should only be used
614 * if dynamic logic is necessary.
615 * @domain_alloc_paging_flags: Allocate an iommu domain corresponding to the
616 * input parameters as defined in
617 * include/uapi/linux/iommufd.h. The @user_data can be
618 * optionally provided, the new domain must support
619 * __IOMMU_DOMAIN_PAGING. Upon failure, ERR_PTR must be
620 * returned.
621 * @domain_alloc_paging: Allocate an iommu_domain that can be used for
622 * UNMANAGED, DMA, and DMA_FQ domain types. This is the
623 * same as invoking domain_alloc_paging_flags() with
624 * @flags=0, @user_data=NULL. A driver should implement
625 * only one of the two ops.
626 * @domain_alloc_sva: Allocate an iommu_domain for Shared Virtual Addressing.
627 * @domain_alloc_nested: Allocate an iommu_domain for nested translation.
628 * @probe_device: Add device to iommu driver handling
629 * @release_device: Remove device from iommu driver handling
630 * @probe_finalize: Do final setup work after the device is added to an IOMMU
631 * group and attached to the groups domain
632 * @device_group: find iommu group for a particular device
633 * @get_resv_regions: Request list of reserved regions for a device
634 * @of_xlate: add OF master IDs to iommu grouping
635 * @is_attach_deferred: Check if domain attach should be deferred from iommu
636 * driver init to device driver init (default no)
637 * @page_response: handle page request response
638 * @def_domain_type: device default domain type, return value:
639 * - IOMMU_DOMAIN_IDENTITY: must use an identity domain
640 * - IOMMU_DOMAIN_DMA: must use a dma domain
641 * - 0: use the default setting
642 * @default_domain_ops: the default ops for domains
643 * @get_viommu_size: Get the size of a driver-level vIOMMU structure for a given
644 * @dev corresponding to @viommu_type. Driver should return 0
645 * if vIOMMU isn't supported accordingly. It is required for
646 * driver to use the VIOMMU_STRUCT_SIZE macro to sanitize the
647 * driver-level vIOMMU structure related to the core one
648 * @viommu_init: Init the driver-level struct of an iommufd_viommu on a physical
649 * IOMMU instance @viommu->iommu_dev, as the set of virtualization
650 * resources shared/passed to user space IOMMU instance. Associate
651 * it with a nesting @parent_domain. It is required for driver to
652 * set @viommu->ops pointing to its own viommu_ops
653 * @owner: Driver module providing these ops
654 * @identity_domain: An always available, always attachable identity
655 * translation.
656 * @blocked_domain: An always available, always attachable blocking
657 * translation.
658 * @default_domain: If not NULL this will always be set as the default domain.
659 * This should be an IDENTITY/BLOCKED/PLATFORM domain.
660 * Do not use in new drivers.
661 * @user_pasid_table: IOMMU driver supports user-managed PASID table. There is
662 * no user domain for each PASID and the I/O page faults are
663 * forwarded through the user domain attached to the device
664 * RID.
665 */
666struct iommu_ops {
667 bool (*capable)(struct device *dev, enum iommu_cap);
668 void *(*hw_info)(struct device *dev, u32 *length,
669 enum iommu_hw_info_type *type);
670
671 /* Domain allocation and freeing by the iommu driver */
672#if IS_ENABLED(CONFIG_FSL_PAMU)
673 struct iommu_domain *(*domain_alloc)(unsigned iommu_domain_type);
674#endif
675 struct iommu_domain *(*domain_alloc_identity)(struct device *dev);
676 struct iommu_domain *(*domain_alloc_paging_flags)(
677 struct device *dev, u32 flags,
678 const struct iommu_user_data *user_data);
679 struct iommu_domain *(*domain_alloc_paging)(struct device *dev);
680 struct iommu_domain *(*domain_alloc_sva)(struct device *dev,
681 struct mm_struct *mm);
682 struct iommu_domain *(*domain_alloc_nested)(
683 struct device *dev, struct iommu_domain *parent, u32 flags,
684 const struct iommu_user_data *user_data);
685
686 struct iommu_device *(*probe_device)(struct device *dev);
687 void (*release_device)(struct device *dev);
688 void (*probe_finalize)(struct device *dev);
689 struct iommu_group *(*device_group)(struct device *dev);
690
691 /* Request/Free a list of reserved regions for a device */
692 void (*get_resv_regions)(struct device *dev, struct list_head *list);
693
694 int (*of_xlate)(struct device *dev, const struct of_phandle_args *args);
695 bool (*is_attach_deferred)(struct device *dev);
696
697 /* Per device IOMMU features */
698 void (*page_response)(struct device *dev, struct iopf_fault *evt,
699 struct iommu_page_response *msg);
700
701 int (*def_domain_type)(struct device *dev);
702
703 size_t (*get_viommu_size)(struct device *dev,
704 enum iommu_viommu_type viommu_type);
705 int (*viommu_init)(struct iommufd_viommu *viommu,
706 struct iommu_domain *parent_domain,
707 const struct iommu_user_data *user_data);
708
709 const struct iommu_domain_ops *default_domain_ops;
710 struct module *owner;
711 struct iommu_domain *identity_domain;
712 struct iommu_domain *blocked_domain;
713 struct iommu_domain *release_domain;
714 struct iommu_domain *default_domain;
715 u8 user_pasid_table:1;
716};
717
718/**
719 * struct iommu_domain_ops - domain specific operations
720 * @attach_dev: attach an iommu domain to a device
721 * Return:
722 * * 0 - success
723 * * EINVAL - can indicate that device and domain are incompatible due to
724 * some previous configuration of the domain, in which case the
725 * driver shouldn't log an error, since it is legitimate for a
726 * caller to test reuse of existing domains. Otherwise, it may
727 * still represent some other fundamental problem
728 * * ENOMEM - out of memory
729 * * ENOSPC - non-ENOMEM type of resource allocation failures
730 * * EBUSY - device is attached to a domain and cannot be changed
731 * * ENODEV - device specific errors, not able to be attached
732 * * <others> - treated as ENODEV by the caller. Use is discouraged
733 * @set_dev_pasid: set or replace an iommu domain to a pasid of device. The pasid of
734 * the device should be left in the old config in error case.
735 * @map_pages: map a physically contiguous set of pages of the same size to
736 * an iommu domain.
737 * @unmap_pages: unmap a number of pages of the same size from an iommu domain
738 * @flush_iotlb_all: Synchronously flush all hardware TLBs for this domain
739 * @iotlb_sync_map: Sync mappings created recently using @map to the hardware
740 * @iotlb_sync: Flush all queued ranges from the hardware TLBs and empty flush
741 * queue
742 * @cache_invalidate_user: Flush hardware cache for user space IO page table.
743 * The @domain must be IOMMU_DOMAIN_NESTED. The @array
744 * passes in the cache invalidation requests, in form
745 * of a driver data structure. The driver must update
746 * array->entry_num to report the number of handled
747 * invalidation requests. The driver data structure
748 * must be defined in include/uapi/linux/iommufd.h
749 * @iova_to_phys: translate iova to physical address
750 * @enforce_cache_coherency: Prevent any kind of DMA from bypassing IOMMU_CACHE,
751 * including no-snoop TLPs on PCIe or other platform
752 * specific mechanisms.
753 * @set_pgtable_quirks: Set io page table quirks (IO_PGTABLE_QUIRK_*)
754 * @free: Release the domain after use.
755 */
756struct iommu_domain_ops {
757 int (*attach_dev)(struct iommu_domain *domain, struct device *dev,
758 struct iommu_domain *old);
759 int (*set_dev_pasid)(struct iommu_domain *domain, struct device *dev,
760 ioasid_t pasid, struct iommu_domain *old);
761
762 int (*map_pages)(struct iommu_domain *domain, unsigned long iova,
763 phys_addr_t paddr, size_t pgsize, size_t pgcount,
764 int prot, gfp_t gfp, size_t *mapped);
765 size_t (*unmap_pages)(struct iommu_domain *domain, unsigned long iova,
766 size_t pgsize, size_t pgcount,
767 struct iommu_iotlb_gather *iotlb_gather);
768
769 void (*flush_iotlb_all)(struct iommu_domain *domain);
770 int (*iotlb_sync_map)(struct iommu_domain *domain, unsigned long iova,
771 size_t size);
772 void (*iotlb_sync)(struct iommu_domain *domain,
773 struct iommu_iotlb_gather *iotlb_gather);
774 int (*cache_invalidate_user)(struct iommu_domain *domain,
775 struct iommu_user_data_array *array);
776
777 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain,
778 dma_addr_t iova);
779
780 bool (*enforce_cache_coherency)(struct iommu_domain *domain);
781 int (*set_pgtable_quirks)(struct iommu_domain *domain,
782 unsigned long quirks);
783
784 void (*free)(struct iommu_domain *domain);
785};
786
787/**
788 * struct iommu_device - IOMMU core representation of one IOMMU hardware
789 * instance
790 * @list: Used by the iommu-core to keep a list of registered iommus
791 * @ops: iommu-ops for talking to this iommu
792 * @dev: struct device for sysfs handling
793 * @singleton_group: Used internally for drivers that have only one group
794 * @max_pasids: number of supported PASIDs
795 * @ready: set once iommu_device_register() has completed successfully
796 */
797struct iommu_device {
798 struct list_head list;
799 const struct iommu_ops *ops;
800 struct fwnode_handle *fwnode;
801 struct device *dev;
802 struct iommu_group *singleton_group;
803 u32 max_pasids;
804 bool ready;
805};
806
807/**
808 * struct iommu_fault_param - per-device IOMMU fault data
809 * @lock: protect pending faults list
810 * @users: user counter to manage the lifetime of the data
811 * @rcu: rcu head for kfree_rcu()
812 * @dev: the device that owns this param
813 * @queue: IOPF queue
814 * @queue_list: index into queue->devices
815 * @partial: faults that are part of a Page Request Group for which the last
816 * request hasn't been submitted yet.
817 * @faults: holds the pending faults which need response
818 */
819struct iommu_fault_param {
820 struct mutex lock;
821 refcount_t users;
822 struct rcu_head rcu;
823
824 struct device *dev;
825 struct iopf_queue *queue;
826 struct list_head queue_list;
827
828 struct list_head partial;
829 struct list_head faults;
830};
831
832/**
833 * struct dev_iommu - Collection of per-device IOMMU data
834 *
835 * @fault_param: IOMMU detected device fault reporting data
836 * @fwspec: IOMMU fwspec data
837 * @iommu_dev: IOMMU device this device is linked to
838 * @priv: IOMMU Driver private data
839 * @max_pasids: number of PASIDs this device can consume
840 * @attach_deferred: the dma domain attachment is deferred
841 * @pci_32bit_workaround: Limit DMA allocations to 32-bit IOVAs
842 * @require_direct: device requires IOMMU_RESV_DIRECT regions
843 * @shadow_on_flush: IOTLB flushes are used to sync shadow tables
844 *
845 * TODO: migrate other per device data pointers under iommu_dev_data, e.g.
846 * struct iommu_group *iommu_group;
847 */
848struct dev_iommu {
849 struct mutex lock;
850 struct iommu_fault_param __rcu *fault_param;
851 struct iommu_fwspec *fwspec;
852 struct iommu_device *iommu_dev;
853 void *priv;
854 u32 max_pasids;
855 u32 attach_deferred:1;
856 u32 pci_32bit_workaround:1;
857 u32 require_direct:1;
858 u32 shadow_on_flush:1;
859};
860
861int iommu_device_register(struct iommu_device *iommu,
862 const struct iommu_ops *ops,
863 struct device *hwdev);
864void iommu_device_unregister(struct iommu_device *iommu);
865int iommu_device_sysfs_add(struct iommu_device *iommu,
866 struct device *parent,
867 const struct attribute_group **groups,
868 const char *fmt, ...) __printf(4, 5);
869void iommu_device_sysfs_remove(struct iommu_device *iommu);
870int iommu_device_link(struct iommu_device *iommu, struct device *link);
871void iommu_device_unlink(struct iommu_device *iommu, struct device *link);
872int iommu_deferred_attach(struct device *dev, struct iommu_domain *domain);
873
874static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
875{
876 return (struct iommu_device *)dev_get_drvdata(dev);
877}
878
879/**
880 * iommu_get_iommu_dev - Get iommu_device for a device
881 * @dev: an end-point device
882 *
883 * Note that this function must be called from the iommu_ops
884 * to retrieve the iommu_device for a device, which the core code
885 * guarentees it will not invoke the op without an attached iommu.
886 */
887static inline struct iommu_device *__iommu_get_iommu_dev(struct device *dev)
888{
889 return dev->iommu->iommu_dev;
890}
891
892#define iommu_get_iommu_dev(dev, type, member) \
893 container_of(__iommu_get_iommu_dev(dev), type, member)
894
895static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather)
896{
897 *gather = (struct iommu_iotlb_gather) {
898 .start = ULONG_MAX,
899 .freelist = IOMMU_PAGES_LIST_INIT(gather->freelist),
900 };
901}
902
903extern bool device_iommu_capable(struct device *dev, enum iommu_cap cap);
904extern bool iommu_group_has_isolated_msi(struct iommu_group *group);
905struct iommu_domain *iommu_paging_domain_alloc_flags(struct device *dev, unsigned int flags);
906static inline struct iommu_domain *iommu_paging_domain_alloc(struct device *dev)
907{
908 return iommu_paging_domain_alloc_flags(dev, 0);
909}
910extern void iommu_domain_free(struct iommu_domain *domain);
911extern int iommu_attach_device(struct iommu_domain *domain,
912 struct device *dev);
913extern void iommu_detach_device(struct iommu_domain *domain,
914 struct device *dev);
915extern struct iommu_domain *iommu_get_domain_for_dev(struct device *dev);
916struct iommu_domain *iommu_driver_get_domain_for_dev(struct device *dev);
917extern struct iommu_domain *iommu_get_dma_domain(struct device *dev);
918extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
919 phys_addr_t paddr, size_t size, int prot, gfp_t gfp);
920int iommu_map_nosync(struct iommu_domain *domain, unsigned long iova,
921 phys_addr_t paddr, size_t size, int prot, gfp_t gfp);
922int iommu_sync_map(struct iommu_domain *domain, unsigned long iova,
923 size_t size);
924extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
925 size_t size);
926extern size_t iommu_unmap_fast(struct iommu_domain *domain,
927 unsigned long iova, size_t size,
928 struct iommu_iotlb_gather *iotlb_gather);
929extern ssize_t iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
930 struct scatterlist *sg, unsigned int nents,
931 int prot, gfp_t gfp);
932extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
933extern void iommu_set_fault_handler(struct iommu_domain *domain,
934 iommu_fault_handler_t handler, void *token);
935
936extern void iommu_get_resv_regions(struct device *dev, struct list_head *list);
937extern void iommu_put_resv_regions(struct device *dev, struct list_head *list);
938extern void iommu_set_default_passthrough(bool cmd_line);
939extern void iommu_set_default_translated(bool cmd_line);
940extern bool iommu_default_passthrough(void);
941extern struct iommu_resv_region *
942iommu_alloc_resv_region(phys_addr_t start, size_t length, int prot,
943 enum iommu_resv_type type, gfp_t gfp);
944extern int iommu_get_group_resv_regions(struct iommu_group *group,
945 struct list_head *head);
946
947extern int iommu_attach_group(struct iommu_domain *domain,
948 struct iommu_group *group);
949extern void iommu_detach_group(struct iommu_domain *domain,
950 struct iommu_group *group);
951extern struct iommu_group *iommu_group_alloc(void);
952extern void *iommu_group_get_iommudata(struct iommu_group *group);
953extern void iommu_group_set_iommudata(struct iommu_group *group,
954 void *iommu_data,
955 void (*release)(void *iommu_data));
956extern int iommu_group_set_name(struct iommu_group *group, const char *name);
957extern int iommu_group_add_device(struct iommu_group *group,
958 struct device *dev);
959extern void iommu_group_remove_device(struct device *dev);
960extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
961 int (*fn)(struct device *, void *));
962extern struct iommu_group *iommu_group_get(struct device *dev);
963extern struct iommu_group *iommu_group_ref_get(struct iommu_group *group);
964extern void iommu_group_put(struct iommu_group *group);
965
966extern int iommu_group_id(struct iommu_group *group);
967extern struct iommu_domain *iommu_group_default_domain(struct iommu_group *);
968
969int iommu_set_pgtable_quirks(struct iommu_domain *domain,
970 unsigned long quirks);
971
972void iommu_set_dma_strict(void);
973
974extern int report_iommu_fault(struct iommu_domain *domain, struct device *dev,
975 unsigned long iova, int flags);
976
977static inline void iommu_flush_iotlb_all(struct iommu_domain *domain)
978{
979 if (domain->ops->flush_iotlb_all)
980 domain->ops->flush_iotlb_all(domain);
981}
982
983static inline void iommu_iotlb_sync(struct iommu_domain *domain,
984 struct iommu_iotlb_gather *iotlb_gather)
985{
986 if (domain->ops->iotlb_sync &&
987 likely(iotlb_gather->start < iotlb_gather->end))
988 domain->ops->iotlb_sync(domain, iotlb_gather);
989
990 iommu_iotlb_gather_init(iotlb_gather);
991}
992
993/**
994 * iommu_iotlb_gather_is_disjoint - Checks whether a new range is disjoint
995 *
996 * @gather: TLB gather data
997 * @iova: start of page to invalidate
998 * @size: size of page to invalidate
999 *
1000 * Helper for IOMMU drivers to check whether a new range and the gathered range
1001 * are disjoint. For many IOMMUs, flushing the IOMMU in this case is better
1002 * than merging the two, which might lead to unnecessary invalidations.
1003 */
1004static inline
1005bool iommu_iotlb_gather_is_disjoint(struct iommu_iotlb_gather *gather,
1006 unsigned long iova, size_t size)
1007{
1008 unsigned long start = iova, end = start + size - 1;
1009
1010 return gather->end != 0 &&
1011 (end + 1 < gather->start || start > gather->end + 1);
1012}
1013
1014
1015/**
1016 * iommu_iotlb_gather_add_range - Gather for address-based TLB invalidation
1017 * @gather: TLB gather data
1018 * @iova: start of page to invalidate
1019 * @size: size of page to invalidate
1020 *
1021 * Helper for IOMMU drivers to build arbitrarily-sized invalidation commands
1022 * where only the address range matters, and simply minimising intermediate
1023 * syncs is preferred.
1024 */
1025static inline void iommu_iotlb_gather_add_range(struct iommu_iotlb_gather *gather,
1026 unsigned long iova, size_t size)
1027{
1028 unsigned long end = iova + size - 1;
1029
1030 if (gather->start > iova)
1031 gather->start = iova;
1032 if (gather->end < end)
1033 gather->end = end;
1034}
1035
1036/**
1037 * iommu_iotlb_gather_add_page - Gather for page-based TLB invalidation
1038 * @domain: IOMMU domain to be invalidated
1039 * @gather: TLB gather data
1040 * @iova: start of page to invalidate
1041 * @size: size of page to invalidate
1042 *
1043 * Helper for IOMMU drivers to build invalidation commands based on individual
1044 * pages, or with page size/table level hints which cannot be gathered if they
1045 * differ.
1046 */
1047static inline void iommu_iotlb_gather_add_page(struct iommu_domain *domain,
1048 struct iommu_iotlb_gather *gather,
1049 unsigned long iova, size_t size)
1050{
1051 /*
1052 * If the new page is disjoint from the current range or is mapped at
1053 * a different granularity, then sync the TLB so that the gather
1054 * structure can be rewritten.
1055 */
1056 if ((gather->pgsize && gather->pgsize != size) ||
1057 iommu_iotlb_gather_is_disjoint(gather, iova, size))
1058 iommu_iotlb_sync(domain, gather);
1059
1060 gather->pgsize = size;
1061 iommu_iotlb_gather_add_range(gather, iova, size);
1062}
1063
1064static inline bool iommu_iotlb_gather_queued(struct iommu_iotlb_gather *gather)
1065{
1066 return gather && gather->queued;
1067}
1068
1069static inline void iommu_dirty_bitmap_init(struct iommu_dirty_bitmap *dirty,
1070 struct iova_bitmap *bitmap,
1071 struct iommu_iotlb_gather *gather)
1072{
1073 if (gather)
1074 iommu_iotlb_gather_init(gather);
1075
1076 dirty->bitmap = bitmap;
1077 dirty->gather = gather;
1078}
1079
1080static inline void iommu_dirty_bitmap_record(struct iommu_dirty_bitmap *dirty,
1081 unsigned long iova,
1082 unsigned long length)
1083{
1084 if (dirty->bitmap)
1085 iova_bitmap_set(dirty->bitmap, iova, length);
1086
1087 if (dirty->gather)
1088 iommu_iotlb_gather_add_range(dirty->gather, iova, length);
1089}
1090
1091/* PCI device grouping function */
1092extern struct iommu_group *pci_device_group(struct device *dev);
1093/* Generic device grouping function */
1094extern struct iommu_group *generic_device_group(struct device *dev);
1095/* FSL-MC device grouping function */
1096struct iommu_group *fsl_mc_device_group(struct device *dev);
1097extern struct iommu_group *generic_single_device_group(struct device *dev);
1098
1099/**
1100 * struct iommu_fwspec - per-device IOMMU instance data
1101 * @iommu_fwnode: firmware handle for this device's IOMMU
1102 * @flags: IOMMU_FWSPEC_* flags
1103 * @num_ids: number of associated device IDs
1104 * @ids: IDs which this device may present to the IOMMU
1105 *
1106 * Note that the IDs (and any other information, really) stored in this structure should be
1107 * considered private to the IOMMU device driver and are not to be used directly by IOMMU
1108 * consumers.
1109 */
1110struct iommu_fwspec {
1111 struct fwnode_handle *iommu_fwnode;
1112 u32 flags;
1113 unsigned int num_ids;
1114 u32 ids[];
1115};
1116
1117/* ATS is supported */
1118#define IOMMU_FWSPEC_PCI_RC_ATS (1 << 0)
1119/* CANWBS is supported */
1120#define IOMMU_FWSPEC_PCI_RC_CANWBS (1 << 1)
1121
1122/*
1123 * An iommu attach handle represents a relationship between an iommu domain
1124 * and a PASID or RID of a device. It is allocated and managed by the component
1125 * that manages the domain and is stored in the iommu group during the time the
1126 * domain is attached.
1127 */
1128struct iommu_attach_handle {
1129 struct iommu_domain *domain;
1130};
1131
1132/**
1133 * struct iommu_sva - handle to a device-mm bond
1134 */
1135struct iommu_sva {
1136 struct iommu_attach_handle handle;
1137 struct device *dev;
1138 refcount_t users;
1139};
1140
1141struct iommu_mm_data {
1142 u32 pasid;
1143 struct mm_struct *mm;
1144 struct list_head sva_domains;
1145 struct list_head mm_list_elm;
1146};
1147
1148int iommu_fwspec_init(struct device *dev, struct fwnode_handle *iommu_fwnode);
1149int iommu_fwspec_add_ids(struct device *dev, const u32 *ids, int num_ids);
1150
1151static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev)
1152{
1153 if (dev->iommu)
1154 return dev->iommu->fwspec;
1155 else
1156 return NULL;
1157}
1158
1159static inline void dev_iommu_fwspec_set(struct device *dev,
1160 struct iommu_fwspec *fwspec)
1161{
1162 dev->iommu->fwspec = fwspec;
1163}
1164
1165static inline void *dev_iommu_priv_get(struct device *dev)
1166{
1167 if (dev->iommu)
1168 return dev->iommu->priv;
1169 else
1170 return NULL;
1171}
1172
1173void dev_iommu_priv_set(struct device *dev, void *priv);
1174
1175extern struct mutex iommu_probe_device_lock;
1176int iommu_probe_device(struct device *dev);
1177
1178int iommu_device_use_default_domain(struct device *dev);
1179void iommu_device_unuse_default_domain(struct device *dev);
1180
1181int iommu_group_claim_dma_owner(struct iommu_group *group, void *owner);
1182void iommu_group_release_dma_owner(struct iommu_group *group);
1183bool iommu_group_dma_owner_claimed(struct iommu_group *group);
1184
1185int iommu_device_claim_dma_owner(struct device *dev, void *owner);
1186void iommu_device_release_dma_owner(struct device *dev);
1187
1188int iommu_attach_device_pasid(struct iommu_domain *domain,
1189 struct device *dev, ioasid_t pasid,
1190 struct iommu_attach_handle *handle);
1191void iommu_detach_device_pasid(struct iommu_domain *domain,
1192 struct device *dev, ioasid_t pasid);
1193ioasid_t iommu_alloc_global_pasid(struct device *dev);
1194void iommu_free_global_pasid(ioasid_t pasid);
1195
1196/* PCI device reset functions */
1197int pci_dev_reset_iommu_prepare(struct pci_dev *pdev);
1198void pci_dev_reset_iommu_done(struct pci_dev *pdev);
1199#else /* CONFIG_IOMMU_API */
1200
1201struct iommu_ops {};
1202struct iommu_group {};
1203struct iommu_fwspec {};
1204struct iommu_device {};
1205struct iommu_fault_param {};
1206struct iommu_iotlb_gather {};
1207struct iommu_dirty_bitmap {};
1208struct iommu_dirty_ops {};
1209
1210static inline bool device_iommu_capable(struct device *dev, enum iommu_cap cap)
1211{
1212 return false;
1213}
1214
1215static inline struct iommu_domain *iommu_paging_domain_alloc_flags(struct device *dev,
1216 unsigned int flags)
1217{
1218 return ERR_PTR(-ENODEV);
1219}
1220
1221static inline struct iommu_domain *iommu_paging_domain_alloc(struct device *dev)
1222{
1223 return ERR_PTR(-ENODEV);
1224}
1225
1226static inline void iommu_domain_free(struct iommu_domain *domain)
1227{
1228}
1229
1230static inline int iommu_attach_device(struct iommu_domain *domain,
1231 struct device *dev)
1232{
1233 return -ENODEV;
1234}
1235
1236static inline void iommu_detach_device(struct iommu_domain *domain,
1237 struct device *dev)
1238{
1239}
1240
1241static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
1242{
1243 return NULL;
1244}
1245
1246static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
1247 phys_addr_t paddr, size_t size, int prot, gfp_t gfp)
1248{
1249 return -ENODEV;
1250}
1251
1252static inline size_t iommu_unmap(struct iommu_domain *domain,
1253 unsigned long iova, size_t size)
1254{
1255 return 0;
1256}
1257
1258static inline size_t iommu_unmap_fast(struct iommu_domain *domain,
1259 unsigned long iova, int gfp_order,
1260 struct iommu_iotlb_gather *iotlb_gather)
1261{
1262 return 0;
1263}
1264
1265static inline ssize_t iommu_map_sg(struct iommu_domain *domain,
1266 unsigned long iova, struct scatterlist *sg,
1267 unsigned int nents, int prot, gfp_t gfp)
1268{
1269 return -ENODEV;
1270}
1271
1272static inline void iommu_flush_iotlb_all(struct iommu_domain *domain)
1273{
1274}
1275
1276static inline void iommu_iotlb_sync(struct iommu_domain *domain,
1277 struct iommu_iotlb_gather *iotlb_gather)
1278{
1279}
1280
1281static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
1282{
1283 return 0;
1284}
1285
1286static inline void iommu_set_fault_handler(struct iommu_domain *domain,
1287 iommu_fault_handler_t handler, void *token)
1288{
1289}
1290
1291static inline void iommu_get_resv_regions(struct device *dev,
1292 struct list_head *list)
1293{
1294}
1295
1296static inline void iommu_put_resv_regions(struct device *dev,
1297 struct list_head *list)
1298{
1299}
1300
1301static inline int iommu_get_group_resv_regions(struct iommu_group *group,
1302 struct list_head *head)
1303{
1304 return -ENODEV;
1305}
1306
1307static inline void iommu_set_default_passthrough(bool cmd_line)
1308{
1309}
1310
1311static inline void iommu_set_default_translated(bool cmd_line)
1312{
1313}
1314
1315static inline bool iommu_default_passthrough(void)
1316{
1317 return true;
1318}
1319
1320static inline int iommu_attach_group(struct iommu_domain *domain,
1321 struct iommu_group *group)
1322{
1323 return -ENODEV;
1324}
1325
1326static inline void iommu_detach_group(struct iommu_domain *domain,
1327 struct iommu_group *group)
1328{
1329}
1330
1331static inline struct iommu_group *iommu_group_alloc(void)
1332{
1333 return ERR_PTR(-ENODEV);
1334}
1335
1336static inline void *iommu_group_get_iommudata(struct iommu_group *group)
1337{
1338 return NULL;
1339}
1340
1341static inline void iommu_group_set_iommudata(struct iommu_group *group,
1342 void *iommu_data,
1343 void (*release)(void *iommu_data))
1344{
1345}
1346
1347static inline int iommu_group_set_name(struct iommu_group *group,
1348 const char *name)
1349{
1350 return -ENODEV;
1351}
1352
1353static inline int iommu_group_add_device(struct iommu_group *group,
1354 struct device *dev)
1355{
1356 return -ENODEV;
1357}
1358
1359static inline void iommu_group_remove_device(struct device *dev)
1360{
1361}
1362
1363static inline int iommu_group_for_each_dev(struct iommu_group *group,
1364 void *data,
1365 int (*fn)(struct device *, void *))
1366{
1367 return -ENODEV;
1368}
1369
1370static inline struct iommu_group *iommu_group_get(struct device *dev)
1371{
1372 return NULL;
1373}
1374
1375static inline void iommu_group_put(struct iommu_group *group)
1376{
1377}
1378
1379static inline int iommu_group_id(struct iommu_group *group)
1380{
1381 return -ENODEV;
1382}
1383
1384static inline int iommu_set_pgtable_quirks(struct iommu_domain *domain,
1385 unsigned long quirks)
1386{
1387 return 0;
1388}
1389
1390static inline int iommu_device_register(struct iommu_device *iommu,
1391 const struct iommu_ops *ops,
1392 struct device *hwdev)
1393{
1394 return -ENODEV;
1395}
1396
1397static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
1398{
1399 return NULL;
1400}
1401
1402static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather)
1403{
1404}
1405
1406static inline void iommu_iotlb_gather_add_page(struct iommu_domain *domain,
1407 struct iommu_iotlb_gather *gather,
1408 unsigned long iova, size_t size)
1409{
1410}
1411
1412static inline bool iommu_iotlb_gather_queued(struct iommu_iotlb_gather *gather)
1413{
1414 return false;
1415}
1416
1417static inline void iommu_dirty_bitmap_init(struct iommu_dirty_bitmap *dirty,
1418 struct iova_bitmap *bitmap,
1419 struct iommu_iotlb_gather *gather)
1420{
1421}
1422
1423static inline void iommu_dirty_bitmap_record(struct iommu_dirty_bitmap *dirty,
1424 unsigned long iova,
1425 unsigned long length)
1426{
1427}
1428
1429static inline void iommu_device_unregister(struct iommu_device *iommu)
1430{
1431}
1432
1433static inline int iommu_device_sysfs_add(struct iommu_device *iommu,
1434 struct device *parent,
1435 const struct attribute_group **groups,
1436 const char *fmt, ...)
1437{
1438 return -ENODEV;
1439}
1440
1441static inline void iommu_device_sysfs_remove(struct iommu_device *iommu)
1442{
1443}
1444
1445static inline int iommu_device_link(struct device *dev, struct device *link)
1446{
1447 return -EINVAL;
1448}
1449
1450static inline void iommu_device_unlink(struct device *dev, struct device *link)
1451{
1452}
1453
1454static inline int iommu_fwspec_init(struct device *dev,
1455 struct fwnode_handle *iommu_fwnode)
1456{
1457 return -ENODEV;
1458}
1459
1460static inline int iommu_fwspec_add_ids(struct device *dev, u32 *ids,
1461 int num_ids)
1462{
1463 return -ENODEV;
1464}
1465
1466static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev)
1467{
1468 return NULL;
1469}
1470
1471static inline int iommu_device_use_default_domain(struct device *dev)
1472{
1473 return 0;
1474}
1475
1476static inline void iommu_device_unuse_default_domain(struct device *dev)
1477{
1478}
1479
1480static inline int
1481iommu_group_claim_dma_owner(struct iommu_group *group, void *owner)
1482{
1483 return -ENODEV;
1484}
1485
1486static inline void iommu_group_release_dma_owner(struct iommu_group *group)
1487{
1488}
1489
1490static inline bool iommu_group_dma_owner_claimed(struct iommu_group *group)
1491{
1492 return false;
1493}
1494
1495static inline void iommu_device_release_dma_owner(struct device *dev)
1496{
1497}
1498
1499static inline int iommu_device_claim_dma_owner(struct device *dev, void *owner)
1500{
1501 return -ENODEV;
1502}
1503
1504static inline int iommu_attach_device_pasid(struct iommu_domain *domain,
1505 struct device *dev, ioasid_t pasid,
1506 struct iommu_attach_handle *handle)
1507{
1508 return -ENODEV;
1509}
1510
1511static inline void iommu_detach_device_pasid(struct iommu_domain *domain,
1512 struct device *dev, ioasid_t pasid)
1513{
1514}
1515
1516static inline ioasid_t iommu_alloc_global_pasid(struct device *dev)
1517{
1518 return IOMMU_PASID_INVALID;
1519}
1520
1521static inline void iommu_free_global_pasid(ioasid_t pasid) {}
1522
1523static inline int pci_dev_reset_iommu_prepare(struct pci_dev *pdev)
1524{
1525 return 0;
1526}
1527
1528static inline void pci_dev_reset_iommu_done(struct pci_dev *pdev)
1529{
1530}
1531#endif /* CONFIG_IOMMU_API */
1532
1533#ifdef CONFIG_IRQ_MSI_IOMMU
1534#ifdef CONFIG_IOMMU_API
1535int iommu_dma_prepare_msi(struct msi_desc *desc, phys_addr_t msi_addr);
1536#else
1537static inline int iommu_dma_prepare_msi(struct msi_desc *desc,
1538 phys_addr_t msi_addr)
1539{
1540 return 0;
1541}
1542#endif /* CONFIG_IOMMU_API */
1543#endif /* CONFIG_IRQ_MSI_IOMMU */
1544
1545#if IS_ENABLED(CONFIG_LOCKDEP) && IS_ENABLED(CONFIG_IOMMU_API)
1546void iommu_group_mutex_assert(struct device *dev);
1547#else
1548static inline void iommu_group_mutex_assert(struct device *dev)
1549{
1550}
1551#endif
1552
1553/**
1554 * iommu_map_sgtable - Map the given buffer to the IOMMU domain
1555 * @domain: The IOMMU domain to perform the mapping
1556 * @iova: The start address to map the buffer
1557 * @sgt: The sg_table object describing the buffer
1558 * @prot: IOMMU protection bits
1559 *
1560 * Creates a mapping at @iova for the buffer described by a scatterlist
1561 * stored in the given sg_table object in the provided IOMMU domain.
1562 */
1563static inline ssize_t iommu_map_sgtable(struct iommu_domain *domain,
1564 unsigned long iova, struct sg_table *sgt, int prot)
1565{
1566 return iommu_map_sg(domain, iova, sgt->sgl, sgt->orig_nents, prot,
1567 GFP_KERNEL);
1568}
1569
1570#ifdef CONFIG_IOMMU_DEBUGFS
1571extern struct dentry *iommu_debugfs_dir;
1572void iommu_debugfs_setup(void);
1573#else
1574static inline void iommu_debugfs_setup(void) {}
1575#endif
1576
1577#ifdef CONFIG_IOMMU_DMA
1578int iommu_get_msi_cookie(struct iommu_domain *domain, dma_addr_t base);
1579#else /* CONFIG_IOMMU_DMA */
1580static inline int iommu_get_msi_cookie(struct iommu_domain *domain, dma_addr_t base)
1581{
1582 return -ENODEV;
1583}
1584#endif /* CONFIG_IOMMU_DMA */
1585
1586/*
1587 * Newer generations of Tegra SoCs require devices' stream IDs to be directly programmed into
1588 * some registers. These are always paired with a Tegra SMMU or ARM SMMU, for which the contents
1589 * of the struct iommu_fwspec are known. Use this helper to formalize access to these internals.
1590 */
1591#define TEGRA_STREAM_ID_BYPASS 0x7f
1592
1593static inline bool tegra_dev_iommu_get_stream_id(struct device *dev, u32 *stream_id)
1594{
1595#ifdef CONFIG_IOMMU_API
1596 struct iommu_fwspec *fwspec = dev_iommu_fwspec_get(dev);
1597
1598 if (fwspec && fwspec->num_ids == 1) {
1599 *stream_id = fwspec->ids[0] & 0xffff;
1600 return true;
1601 }
1602#endif
1603
1604 return false;
1605}
1606
1607#ifdef CONFIG_IOMMU_MM_DATA
1608static inline void mm_pasid_init(struct mm_struct *mm)
1609{
1610 /*
1611 * During dup_mm(), a new mm will be memcpy'd from an old one and that makes
1612 * the new mm and the old one point to a same iommu_mm instance. When either
1613 * one of the two mms gets released, the iommu_mm instance is freed, leaving
1614 * the other mm running into a use-after-free/double-free problem. To avoid
1615 * the problem, zeroing the iommu_mm pointer of a new mm is needed here.
1616 */
1617 mm->iommu_mm = NULL;
1618}
1619
1620static inline bool mm_valid_pasid(struct mm_struct *mm)
1621{
1622 return READ_ONCE(mm->iommu_mm);
1623}
1624
1625static inline u32 mm_get_enqcmd_pasid(struct mm_struct *mm)
1626{
1627 struct iommu_mm_data *iommu_mm = READ_ONCE(mm->iommu_mm);
1628
1629 if (!iommu_mm)
1630 return IOMMU_PASID_INVALID;
1631 return iommu_mm->pasid;
1632}
1633
1634void mm_pasid_drop(struct mm_struct *mm);
1635struct iommu_sva *iommu_sva_bind_device(struct device *dev,
1636 struct mm_struct *mm);
1637void iommu_sva_unbind_device(struct iommu_sva *handle);
1638u32 iommu_sva_get_pasid(struct iommu_sva *handle);
1639void iommu_sva_invalidate_kva_range(unsigned long start, unsigned long end);
1640#else
1641static inline struct iommu_sva *
1642iommu_sva_bind_device(struct device *dev, struct mm_struct *mm)
1643{
1644 return ERR_PTR(-ENODEV);
1645}
1646
1647static inline void iommu_sva_unbind_device(struct iommu_sva *handle)
1648{
1649}
1650
1651static inline u32 iommu_sva_get_pasid(struct iommu_sva *handle)
1652{
1653 return IOMMU_PASID_INVALID;
1654}
1655static inline void mm_pasid_init(struct mm_struct *mm) {}
1656static inline bool mm_valid_pasid(struct mm_struct *mm) { return false; }
1657
1658static inline u32 mm_get_enqcmd_pasid(struct mm_struct *mm)
1659{
1660 return IOMMU_PASID_INVALID;
1661}
1662
1663static inline void mm_pasid_drop(struct mm_struct *mm) {}
1664static inline void iommu_sva_invalidate_kva_range(unsigned long start, unsigned long end) {}
1665#endif /* CONFIG_IOMMU_SVA */
1666
1667#ifdef CONFIG_IOMMU_IOPF
1668int iopf_queue_add_device(struct iopf_queue *queue, struct device *dev);
1669void iopf_queue_remove_device(struct iopf_queue *queue, struct device *dev);
1670int iopf_queue_flush_dev(struct device *dev);
1671struct iopf_queue *iopf_queue_alloc(const char *name);
1672void iopf_queue_free(struct iopf_queue *queue);
1673int iopf_queue_discard_partial(struct iopf_queue *queue);
1674void iopf_free_group(struct iopf_group *group);
1675int iommu_report_device_fault(struct device *dev, struct iopf_fault *evt);
1676void iopf_group_response(struct iopf_group *group,
1677 enum iommu_page_response_code status);
1678#else
1679static inline int
1680iopf_queue_add_device(struct iopf_queue *queue, struct device *dev)
1681{
1682 return -ENODEV;
1683}
1684
1685static inline void
1686iopf_queue_remove_device(struct iopf_queue *queue, struct device *dev)
1687{
1688}
1689
1690static inline int iopf_queue_flush_dev(struct device *dev)
1691{
1692 return -ENODEV;
1693}
1694
1695static inline struct iopf_queue *iopf_queue_alloc(const char *name)
1696{
1697 return NULL;
1698}
1699
1700static inline void iopf_queue_free(struct iopf_queue *queue)
1701{
1702}
1703
1704static inline int iopf_queue_discard_partial(struct iopf_queue *queue)
1705{
1706 return -ENODEV;
1707}
1708
1709static inline void iopf_free_group(struct iopf_group *group)
1710{
1711}
1712
1713static inline int
1714iommu_report_device_fault(struct device *dev, struct iopf_fault *evt)
1715{
1716 return -ENODEV;
1717}
1718
1719static inline void iopf_group_response(struct iopf_group *group,
1720 enum iommu_page_response_code status)
1721{
1722}
1723#endif /* CONFIG_IOMMU_IOPF */
1724#endif /* __LINUX_IOMMU_H */