1 /* SPDX-License-Identifier: GPL-2.0 */
5 #include <linux/bitops.h>
6 #include <linux/iommu.h>
9 * Public API for use by IOMMU drivers
26 * struct iommu_flush_ops - IOMMU callbacks for TLB and page table management.
28 * @tlb_flush_all: Synchronously invalidate the entire TLB context.
29 * @tlb_flush_walk: Synchronously invalidate all intermediate TLB state
30 * (sometimes referred to as the "walk cache") for a virtual
32 * @tlb_add_page: Optional callback to queue up leaf TLB invalidation for a
33 * single page. IOMMUs that cannot batch TLB invalidation
34 * operations efficiently will typically issue them here, but
35 * others may decide to update the iommu_iotlb_gather structure
36 * and defer the invalidation until iommu_iotlb_sync() instead.
38 * Note that these can all be called in atomic context and must therefore
41 struct iommu_flush_ops {
42 void (*tlb_flush_all)(void *cookie);
43 void (*tlb_flush_walk)(unsigned long iova, size_t size, size_t granule,
45 void (*tlb_add_page)(struct iommu_iotlb_gather *gather,
46 unsigned long iova, size_t granule, void *cookie);
50 * struct io_pgtable_cfg - Configuration data for a set of page tables.
52 * @quirks: A bitmap of hardware quirks that require some special
53 * action by the low-level page table allocator.
54 * @pgsize_bitmap: A bitmap of page sizes supported by this set of page
56 * @ias: Input address (iova) size, in bits.
57 * @oas: Output address (paddr) size, in bits.
58 * @coherent_walk A flag to indicate whether or not page table walks made
59 * by the IOMMU are coherent with the CPU caches.
60 * @tlb: TLB management callbacks for this set of tables.
61 * @iommu_dev: The device representing the DMA configuration for the
64 struct io_pgtable_cfg {
66 * IO_PGTABLE_QUIRK_ARM_NS: (ARM formats) Set NS and NSTABLE bits in
67 * stage 1 PTEs, for hardware which insists on validating them
68 * even in non-secure state where they should normally be ignored.
70 * IO_PGTABLE_QUIRK_NO_PERMS: Ignore the IOMMU_READ, IOMMU_WRITE and
71 * IOMMU_NOEXEC flags and map everything with full access, for
72 * hardware which does not implement the permissions of a given
73 * format, and/or requires some format-specific default value.
75 * IO_PGTABLE_QUIRK_ARM_MTK_EXT: (ARM v7s format) MediaTek IOMMUs extend
76 * to support up to 35 bits PA where the bit32, bit33 and bit34 are
77 * encoded in the bit9, bit4 and bit5 of the PTE respectively.
79 * IO_PGTABLE_QUIRK_ARM_MTK_TTBR_EXT: (ARM v7s format) MediaTek IOMMUs
80 * extend the translation table base support up to 35 bits PA, the
81 * encoding format is same with IO_PGTABLE_QUIRK_ARM_MTK_EXT.
83 * IO_PGTABLE_QUIRK_ARM_TTBR1: (ARM LPAE format) Configure the table
84 * for use in the upper half of a split address space.
86 * IO_PGTABLE_QUIRK_ARM_OUTER_WBWA: Override the outer-cacheability
87 * attributes set in the TCR for a non-coherent page-table walker.
89 #define IO_PGTABLE_QUIRK_ARM_NS BIT(0)
90 #define IO_PGTABLE_QUIRK_NO_PERMS BIT(1)
91 #define IO_PGTABLE_QUIRK_ARM_MTK_EXT BIT(3)
92 #define IO_PGTABLE_QUIRK_ARM_MTK_TTBR_EXT BIT(4)
93 #define IO_PGTABLE_QUIRK_ARM_TTBR1 BIT(5)
94 #define IO_PGTABLE_QUIRK_ARM_OUTER_WBWA BIT(6)
96 unsigned long pgsize_bitmap;
100 const struct iommu_flush_ops *tlb;
101 struct device *iommu_dev;
103 /* Low-level data specific to the table format */
151 * struct io_pgtable_ops - Page table manipulation API for IOMMU drivers.
153 * @map_pages: Map a physically contiguous range of pages of the same size.
154 * @unmap_pages: Unmap a range of virtually contiguous pages of the same size.
155 * @iova_to_phys: Translate iova to physical address.
157 * These functions map directly onto the iommu_ops member functions with
160 struct io_pgtable_ops {
161 int (*map_pages)(struct io_pgtable_ops *ops, unsigned long iova,
162 phys_addr_t paddr, size_t pgsize, size_t pgcount,
163 int prot, gfp_t gfp, size_t *mapped);
164 size_t (*unmap_pages)(struct io_pgtable_ops *ops, unsigned long iova,
165 size_t pgsize, size_t pgcount,
166 struct iommu_iotlb_gather *gather);
167 phys_addr_t (*iova_to_phys)(struct io_pgtable_ops *ops,
172 * alloc_io_pgtable_ops() - Allocate a page table allocator for use by an IOMMU.
174 * @fmt: The page table format.
175 * @cfg: The page table configuration. This will be modified to represent
176 * the configuration actually provided by the allocator (e.g. the
177 * pgsize_bitmap may be restricted).
178 * @cookie: An opaque token provided by the IOMMU driver and passed back to
179 * the callback routines in cfg->tlb.
181 struct io_pgtable_ops *alloc_io_pgtable_ops(enum io_pgtable_fmt fmt,
182 struct io_pgtable_cfg *cfg,
186 * free_io_pgtable_ops() - Free an io_pgtable_ops structure. The caller
187 * *must* ensure that the page table is no longer
188 * live, but the TLB can be dirty.
190 * @ops: The ops returned from alloc_io_pgtable_ops.
192 void free_io_pgtable_ops(struct io_pgtable_ops *ops);
196 * Internal structures for page table allocator implementations.
200 * struct io_pgtable - Internal structure describing a set of page tables.
202 * @fmt: The page table format.
203 * @cookie: An opaque token provided by the IOMMU driver and passed back to
204 * any callback routines.
205 * @cfg: A copy of the page table configuration.
206 * @ops: The page table operations in use for this set of page tables.
209 enum io_pgtable_fmt fmt;
211 struct io_pgtable_cfg cfg;
212 struct io_pgtable_ops ops;
215 #define io_pgtable_ops_to_pgtable(x) container_of((x), struct io_pgtable, ops)
217 static inline void io_pgtable_tlb_flush_all(struct io_pgtable *iop)
219 if (iop->cfg.tlb && iop->cfg.tlb->tlb_flush_all)
220 iop->cfg.tlb->tlb_flush_all(iop->cookie);
224 io_pgtable_tlb_flush_walk(struct io_pgtable *iop, unsigned long iova,
225 size_t size, size_t granule)
227 if (iop->cfg.tlb && iop->cfg.tlb->tlb_flush_walk)
228 iop->cfg.tlb->tlb_flush_walk(iova, size, granule, iop->cookie);
232 io_pgtable_tlb_add_page(struct io_pgtable *iop,
233 struct iommu_iotlb_gather * gather, unsigned long iova,
236 if (iop->cfg.tlb && iop->cfg.tlb->tlb_add_page)
237 iop->cfg.tlb->tlb_add_page(gather, iova, granule, iop->cookie);
241 * struct io_pgtable_init_fns - Alloc/free a set of page tables for a
244 * @alloc: Allocate a set of page tables described by cfg.
245 * @free: Free the page tables associated with iop.
247 struct io_pgtable_init_fns {
248 struct io_pgtable *(*alloc)(struct io_pgtable_cfg *cfg, void *cookie);
249 void (*free)(struct io_pgtable *iop);
252 extern struct io_pgtable_init_fns io_pgtable_arm_32_lpae_s1_init_fns;
253 extern struct io_pgtable_init_fns io_pgtable_arm_32_lpae_s2_init_fns;
254 extern struct io_pgtable_init_fns io_pgtable_arm_64_lpae_s1_init_fns;
255 extern struct io_pgtable_init_fns io_pgtable_arm_64_lpae_s2_init_fns;
256 extern struct io_pgtable_init_fns io_pgtable_arm_v7s_init_fns;
257 extern struct io_pgtable_init_fns io_pgtable_arm_mali_lpae_init_fns;
258 extern struct io_pgtable_init_fns io_pgtable_amd_iommu_v1_init_fns;
259 extern struct io_pgtable_init_fns io_pgtable_amd_iommu_v2_init_fns;
260 extern struct io_pgtable_init_fns io_pgtable_apple_dart_init_fns;
262 #endif /* __IO_PGTABLE_H */