1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __IO_PGTABLE_H
3 #define __IO_PGTABLE_H
4
5 #include <linux/bitops.h>
6 #include <linux/iommu.h>
7
8 /*
9 * Public API for use by IOMMU drivers
10 */
11 enum io_pgtable_fmt {
12 ARM_32_LPAE_S1,
13 ARM_32_LPAE_S2,
14 ARM_64_LPAE_S1,
15 ARM_64_LPAE_S2,
16 ARM_V7S,
17 ARM_MALI_LPAE,
18 IO_PGTABLE_NUM_FMTS,
19 };
20
21 /**
22 * struct iommu_flush_ops - IOMMU callbacks for TLB and page table management.
23 *
24 * @tlb_flush_all: Synchronously invalidate the entire TLB context.
25 * @tlb_flush_walk: Synchronously invalidate all intermediate TLB state
26 * (sometimes referred to as the "walk cache") for a virtual
27 * address range.
28 * @tlb_add_page: Optional callback to queue up leaf TLB invalidation for a
29 * single page. IOMMUs that cannot batch TLB invalidation
30 * operations efficiently will typically issue them here, but
31 * others may decide to update the iommu_iotlb_gather structure
32 * and defer the invalidation until iommu_iotlb_sync() instead.
33 *
34 * Note that these can all be called in atomic context and must therefore
35 * not block.
36 */
37 struct iommu_flush_ops {
38 void (*tlb_flush_all)(void *cookie);
39 void (*tlb_flush_walk)(unsigned long iova, size_t size, size_t granule,
40 void *cookie);
41 void (*tlb_add_page)(struct iommu_iotlb_gather *gather,
42 unsigned long iova, size_t granule, void *cookie);
43 };
44
45 /**
46 * struct io_pgtable_cfg - Configuration data for a set of page tables.
47 *
48 * @quirks: A bitmap of hardware quirks that require some special
49 * action by the low-level page table allocator.
50 * @pgsize_bitmap: A bitmap of page sizes supported by this set of page
51 * tables.
52 * @ias: Input address (iova) size, in bits.
53 * @oas: Output address (paddr) size, in bits.
54 * @coherent_walk A flag to indicate whether or not page table walks made
55 * by the IOMMU are coherent with the CPU caches.
56 * @tlb: TLB management callbacks for this set of tables.
57 * @iommu_dev: The device representing the DMA configuration for the
58 * page table walker.
59 */
60 struct io_pgtable_cfg {
61 /*
62 * IO_PGTABLE_QUIRK_ARM_NS: (ARM formats) Set NS and NSTABLE bits in
63 * stage 1 PTEs, for hardware which insists on validating them
64 * even in non-secure state where they should normally be ignored.
65 *
66 * IO_PGTABLE_QUIRK_NO_PERMS: Ignore the IOMMU_READ, IOMMU_WRITE and
67 * IOMMU_NOEXEC flags and map everything with full access, for
68 * hardware which does not implement the permissions of a given
69 * format, and/or requires some format-specific default value.
70 *
71 * IO_PGTABLE_QUIRK_ARM_MTK_EXT: (ARM v7s format) MediaTek IOMMUs extend
72 * to support up to 35 bits PA where the bit32, bit33 and bit34 are
73 * encoded in the bit9, bit4 and bit5 of the PTE respectively.
74 *
75 * IO_PGTABLE_QUIRK_NON_STRICT: Skip issuing synchronous leaf TLBIs
76 * on unmap, for DMA domains using the flush queue mechanism for
77 * delayed invalidation.
78 *
79 * IO_PGTABLE_QUIRK_ARM_TTBR1: (ARM LPAE format) Configure the table
80 * for use in the upper half of a split address space.
81 */
82 #define IO_PGTABLE_QUIRK_ARM_NS BIT(0)
83 #define IO_PGTABLE_QUIRK_NO_PERMS BIT(1)
84 #define IO_PGTABLE_QUIRK_ARM_MTK_EXT BIT(3)
85 #define IO_PGTABLE_QUIRK_NON_STRICT BIT(4)
86 #define IO_PGTABLE_QUIRK_ARM_TTBR1 BIT(5)
87 unsigned long quirks;
88 unsigned long pgsize_bitmap;
89 unsigned int ias;
90 unsigned int oas;
91 bool coherent_walk;
92 const struct iommu_flush_ops *tlb;
93 struct device *iommu_dev;
94
95 /* Low-level data specific to the table format */
96 union {
97 struct {
98 u64 ttbr;
99 struct {
100 u32 ips:3;
101 u32 tg:2;
102 u32 sh:2;
103 u32 orgn:2;
104 u32 irgn:2;
105 u32 tsz:6;
106 } tcr;
107 u64 mair;
108 } arm_lpae_s1_cfg;
109
110 struct {
111 u64 vttbr;
112 struct {
113 u32 ps:3;
114 u32 tg:2;
115 u32 sh:2;
116 u32 orgn:2;
117 u32 irgn:2;
118 u32 sl:2;
119 u32 tsz:6;
120 } vtcr;
121 } arm_lpae_s2_cfg;
122
123 struct {
124 u32 ttbr;
125 u32 tcr;
126 u32 nmrr;
127 u32 prrr;
128 } arm_v7s_cfg;
129
130 struct {
131 u64 transtab;
132 u64 memattr;
133 } arm_mali_lpae_cfg;
134 };
135 };
136
137 /**
138 * struct io_pgtable_ops - Page table manipulation API for IOMMU drivers.
139 *
140 * @map: Map a physically contiguous memory region.
141 * @map_pages: Map a physically contiguous range of pages of the same size.
142 * @map_sg: Map a scatter-gather list of physically contiguous memory
143 * chunks. The mapped pointer argument is used to store how
144 * many bytes are mapped.
145 * @unmap: Unmap a physically contiguous memory region.
146 * @unmap_pages: Unmap a range of virtually contiguous pages of the same size.
147 * @iova_to_phys: Translate iova to physical address.
148 *
149 * These functions map directly onto the iommu_ops member functions with
150 * the same names.
151 */
152 struct io_pgtable_ops {
153 int (*map)(struct io_pgtable_ops *ops, unsigned long iova,
154 phys_addr_t paddr, size_t size, int prot, gfp_t gfp);
155 int (*map_pages)(struct io_pgtable_ops *ops, unsigned long iova,
156 phys_addr_t paddr, size_t pgsize, size_t pgcount,
157 int prot, gfp_t gfp, size_t *mapped);
158 int (*map_sg)(struct io_pgtable_ops *ops, unsigned long iova,
159 struct scatterlist *sg, unsigned int nents, int prot,
160 gfp_t gfp, size_t *mapped);
161 size_t (*unmap)(struct io_pgtable_ops *ops, unsigned long iova,
162 size_t size, struct iommu_iotlb_gather *gather);
163 size_t (*unmap_pages)(struct io_pgtable_ops *ops, unsigned long iova,
164 size_t pgsize, size_t pgcount,
165 struct iommu_iotlb_gather *gather);
166 phys_addr_t (*iova_to_phys)(struct io_pgtable_ops *ops,
167 unsigned long iova);
168 };
169
170 /**
171 * alloc_io_pgtable_ops() - Allocate a page table allocator for use by an IOMMU.
172 *
173 * @fmt: The page table format.
174 * @cfg: The page table configuration. This will be modified to represent
175 * the configuration actually provided by the allocator (e.g. the
176 * pgsize_bitmap may be restricted).
177 * @cookie: An opaque token provided by the IOMMU driver and passed back to
178 * the callback routines in cfg->tlb.
179 */
180 struct io_pgtable_ops *alloc_io_pgtable_ops(enum io_pgtable_fmt fmt,
181 struct io_pgtable_cfg *cfg,
182 void *cookie);
183
184 /**
185 * free_io_pgtable_ops() - Free an io_pgtable_ops structure. The caller
186 * *must* ensure that the page table is no longer
187 * live, but the TLB can be dirty.
188 *
189 * @ops: The ops returned from alloc_io_pgtable_ops.
190 */
191 void free_io_pgtable_ops(struct io_pgtable_ops *ops);
192
193
194 /*
195 * Internal structures for page table allocator implementations.
196 */
197
198 /**
199 * struct io_pgtable - Internal structure describing a set of page tables.
200 *
201 * @fmt: The page table format.
202 * @cookie: An opaque token provided by the IOMMU driver and passed back to
203 * any callback routines.
204 * @cfg: A copy of the page table configuration.
205 * @ops: The page table operations in use for this set of page tables.
206 */
207 struct io_pgtable {
208 enum io_pgtable_fmt fmt;
209 void *cookie;
210 struct io_pgtable_cfg cfg;
211 struct io_pgtable_ops ops;
212 };
213
214 #define io_pgtable_ops_to_pgtable(x) container_of((x), struct io_pgtable, ops)
215
io_pgtable_tlb_flush_all(struct io_pgtable * iop)216 static inline void io_pgtable_tlb_flush_all(struct io_pgtable *iop)
217 {
218 if (iop->cfg.tlb && iop->cfg.tlb->tlb_flush_all)
219 iop->cfg.tlb->tlb_flush_all(iop->cookie);
220 }
221
222 static inline void
io_pgtable_tlb_flush_walk(struct io_pgtable * iop,unsigned long iova,size_t size,size_t granule)223 io_pgtable_tlb_flush_walk(struct io_pgtable *iop, unsigned long iova,
224 size_t size, size_t granule)
225 {
226 if (iop->cfg.tlb && iop->cfg.tlb->tlb_flush_walk)
227 iop->cfg.tlb->tlb_flush_walk(iova, size, granule, iop->cookie);
228 }
229
230 static inline void
io_pgtable_tlb_add_page(struct io_pgtable * iop,struct iommu_iotlb_gather * gather,unsigned long iova,size_t granule)231 io_pgtable_tlb_add_page(struct io_pgtable *iop,
232 struct iommu_iotlb_gather * gather, unsigned long iova,
233 size_t granule)
234 {
235 if (iop->cfg.tlb && iop->cfg.tlb->tlb_add_page)
236 iop->cfg.tlb->tlb_add_page(gather, iova, granule, iop->cookie);
237 }
238
239 /**
240 * struct io_pgtable_init_fns - Alloc/free a set of page tables for a
241 * particular format.
242 *
243 * @alloc: Allocate a set of page tables described by cfg.
244 * @free: Free the page tables associated with iop.
245 */
246 struct io_pgtable_init_fns {
247 struct io_pgtable *(*alloc)(struct io_pgtable_cfg *cfg, void *cookie);
248 void (*free)(struct io_pgtable *iop);
249 };
250
251 extern struct io_pgtable_init_fns io_pgtable_arm_32_lpae_s1_init_fns;
252 extern struct io_pgtable_init_fns io_pgtable_arm_32_lpae_s2_init_fns;
253 extern struct io_pgtable_init_fns io_pgtable_arm_64_lpae_s1_init_fns;
254 extern struct io_pgtable_init_fns io_pgtable_arm_64_lpae_s2_init_fns;
255 extern struct io_pgtable_init_fns io_pgtable_arm_v7s_init_fns;
256 extern struct io_pgtable_init_fns io_pgtable_arm_mali_lpae_init_fns;
257
258 #endif /* __IO_PGTABLE_H */
259