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;
104 * @alloc: Custom page allocator.
106 * Optional hook used to allocate page tables. If this function is NULL,
107 * @free must be NULL too.
109 * Memory returned should be zeroed and suitable for dma_map_single() and
112 * Not all formats support custom page allocators. Before considering
113 * passing a non-NULL value, make sure the chosen page format supports
116 void *(*alloc)(void *cookie, size_t size, gfp_t gfp);
119 * @free: Custom page de-allocator.
121 * Optional hook used to free page tables allocated with the @alloc
122 * hook. Must be non-NULL if @alloc is not NULL, must be NULL
125 void (*free)(void *cookie, void *pages, size_t size);
127 /* Low-level data specific to the table format */
175 * struct io_pgtable_ops - Page table manipulation API for IOMMU drivers.
177 * @map_pages: Map a physically contiguous range of pages of the same size.
178 * @unmap_pages: Unmap a range of virtually contiguous pages of the same size.
179 * @iova_to_phys: Translate iova to physical address.
181 * These functions map directly onto the iommu_ops member functions with
184 struct io_pgtable_ops {
185 int (*map_pages)(struct io_pgtable_ops *ops, unsigned long iova,
186 phys_addr_t paddr, size_t pgsize, size_t pgcount,
187 int prot, gfp_t gfp, size_t *mapped);
188 size_t (*unmap_pages)(struct io_pgtable_ops *ops, unsigned long iova,
189 size_t pgsize, size_t pgcount,
190 struct iommu_iotlb_gather *gather);
191 phys_addr_t (*iova_to_phys)(struct io_pgtable_ops *ops,
193 int (*read_and_clear_dirty)(struct io_pgtable_ops *ops,
194 unsigned long iova, size_t size,
196 struct iommu_dirty_bitmap *dirty);
200 * alloc_io_pgtable_ops() - Allocate a page table allocator for use by an IOMMU.
202 * @fmt: The page table format.
203 * @cfg: The page table configuration. This will be modified to represent
204 * the configuration actually provided by the allocator (e.g. the
205 * pgsize_bitmap may be restricted).
206 * @cookie: An opaque token provided by the IOMMU driver and passed back to
207 * the callback routines in cfg->tlb.
209 struct io_pgtable_ops *alloc_io_pgtable_ops(enum io_pgtable_fmt fmt,
210 struct io_pgtable_cfg *cfg,
214 * free_io_pgtable_ops() - Free an io_pgtable_ops structure. The caller
215 * *must* ensure that the page table is no longer
216 * live, but the TLB can be dirty.
218 * @ops: The ops returned from alloc_io_pgtable_ops.
220 void free_io_pgtable_ops(struct io_pgtable_ops *ops);
224 * Internal structures for page table allocator implementations.
228 * struct io_pgtable - Internal structure describing a set of page tables.
230 * @fmt: The page table format.
231 * @cookie: An opaque token provided by the IOMMU driver and passed back to
232 * any callback routines.
233 * @cfg: A copy of the page table configuration.
234 * @ops: The page table operations in use for this set of page tables.
237 enum io_pgtable_fmt fmt;
239 struct io_pgtable_cfg cfg;
240 struct io_pgtable_ops ops;
243 #define io_pgtable_ops_to_pgtable(x) container_of((x), struct io_pgtable, ops)
245 static inline void io_pgtable_tlb_flush_all(struct io_pgtable *iop)
247 if (iop->cfg.tlb && iop->cfg.tlb->tlb_flush_all)
248 iop->cfg.tlb->tlb_flush_all(iop->cookie);
252 io_pgtable_tlb_flush_walk(struct io_pgtable *iop, unsigned long iova,
253 size_t size, size_t granule)
255 if (iop->cfg.tlb && iop->cfg.tlb->tlb_flush_walk)
256 iop->cfg.tlb->tlb_flush_walk(iova, size, granule, iop->cookie);
260 io_pgtable_tlb_add_page(struct io_pgtable *iop,
261 struct iommu_iotlb_gather * gather, unsigned long iova,
264 if (iop->cfg.tlb && iop->cfg.tlb->tlb_add_page)
265 iop->cfg.tlb->tlb_add_page(gather, iova, granule, iop->cookie);
269 * enum io_pgtable_caps - IO page table backend capabilities.
271 enum io_pgtable_caps {
272 /** @IO_PGTABLE_CAP_CUSTOM_ALLOCATOR: Backend accepts custom page table allocators. */
273 IO_PGTABLE_CAP_CUSTOM_ALLOCATOR = BIT(0),
277 * struct io_pgtable_init_fns - Alloc/free a set of page tables for a
280 * @alloc: Allocate a set of page tables described by cfg.
281 * @free: Free the page tables associated with iop.
282 * @caps: Combination of @io_pgtable_caps flags encoding the backend capabilities.
284 struct io_pgtable_init_fns {
285 struct io_pgtable *(*alloc)(struct io_pgtable_cfg *cfg, void *cookie);
286 void (*free)(struct io_pgtable *iop);
290 extern struct io_pgtable_init_fns io_pgtable_arm_32_lpae_s1_init_fns;
291 extern struct io_pgtable_init_fns io_pgtable_arm_32_lpae_s2_init_fns;
292 extern struct io_pgtable_init_fns io_pgtable_arm_64_lpae_s1_init_fns;
293 extern struct io_pgtable_init_fns io_pgtable_arm_64_lpae_s2_init_fns;
294 extern struct io_pgtable_init_fns io_pgtable_arm_v7s_init_fns;
295 extern struct io_pgtable_init_fns io_pgtable_arm_mali_lpae_init_fns;
296 extern struct io_pgtable_init_fns io_pgtable_amd_iommu_v1_init_fns;
297 extern struct io_pgtable_init_fns io_pgtable_amd_iommu_v2_init_fns;
298 extern struct io_pgtable_init_fns io_pgtable_apple_dart_init_fns;
300 #endif /* __IO_PGTABLE_H */