1 // SPDX-License-Identifier: GPL-2.0-only
3 * CPU-agnostic ARM page table allocator.
5 * Copyright (C) 2014 ARM Limited
10 #define pr_fmt(fmt) "arm-lpae io-pgtable: " fmt
12 #include <linux/atomic.h>
13 #include <linux/bitops.h>
14 #include <linux/io-pgtable.h>
15 #include <linux/kernel.h>
16 #include <linux/sizes.h>
17 #include <linux/slab.h>
18 #include <linux/types.h>
19 #include <linux/dma-mapping.h>
21 #include <asm/barrier.h>
23 #define ARM_LPAE_MAX_ADDR_BITS 52
24 #define ARM_LPAE_S2_MAX_CONCAT_PAGES 16
25 #define ARM_LPAE_MAX_LEVELS 4
27 /* Struct accessors */
28 #define io_pgtable_to_data(x) \
29 container_of((x), struct arm_lpae_io_pgtable, iop)
31 #define io_pgtable_ops_to_data(x) \
32 io_pgtable_to_data(io_pgtable_ops_to_pgtable(x))
35 * For consistency with the architecture, we always consider
36 * ARM_LPAE_MAX_LEVELS levels, with the walk starting at level n >=0
38 #define ARM_LPAE_START_LVL(d) (ARM_LPAE_MAX_LEVELS - (d)->levels)
41 * Calculate the right shift amount to get to the portion describing level l
42 * in a virtual address mapped by the pagetable in d.
44 #define ARM_LPAE_LVL_SHIFT(l,d) \
45 ((((d)->levels - ((l) - ARM_LPAE_START_LVL(d) + 1)) \
46 * (d)->bits_per_level) + (d)->pg_shift)
48 #define ARM_LPAE_GRANULE(d) (1UL << (d)->pg_shift)
50 #define ARM_LPAE_PAGES_PER_PGD(d) \
51 DIV_ROUND_UP((d)->pgd_size, ARM_LPAE_GRANULE(d))
54 * Calculate the index at level l used to map virtual address a using the
57 #define ARM_LPAE_PGD_IDX(l,d) \
58 ((l) == ARM_LPAE_START_LVL(d) ? ilog2(ARM_LPAE_PAGES_PER_PGD(d)) : 0)
60 #define ARM_LPAE_LVL_IDX(a,l,d) \
61 (((u64)(a) >> ARM_LPAE_LVL_SHIFT(l,d)) & \
62 ((1 << ((d)->bits_per_level + ARM_LPAE_PGD_IDX(l,d))) - 1))
64 /* Calculate the block/page mapping size at level l for pagetable in d. */
65 #define ARM_LPAE_BLOCK_SIZE(l,d) \
66 (1ULL << (ilog2(sizeof(arm_lpae_iopte)) + \
67 ((ARM_LPAE_MAX_LEVELS - (l)) * (d)->bits_per_level)))
70 #define ARM_LPAE_PTE_TYPE_SHIFT 0
71 #define ARM_LPAE_PTE_TYPE_MASK 0x3
73 #define ARM_LPAE_PTE_TYPE_BLOCK 1
74 #define ARM_LPAE_PTE_TYPE_TABLE 3
75 #define ARM_LPAE_PTE_TYPE_PAGE 3
77 #define ARM_LPAE_PTE_ADDR_MASK GENMASK_ULL(47,12)
79 #define ARM_LPAE_PTE_NSTABLE (((arm_lpae_iopte)1) << 63)
80 #define ARM_LPAE_PTE_XN (((arm_lpae_iopte)3) << 53)
81 #define ARM_LPAE_PTE_AF (((arm_lpae_iopte)1) << 10)
82 #define ARM_LPAE_PTE_SH_NS (((arm_lpae_iopte)0) << 8)
83 #define ARM_LPAE_PTE_SH_OS (((arm_lpae_iopte)2) << 8)
84 #define ARM_LPAE_PTE_SH_IS (((arm_lpae_iopte)3) << 8)
85 #define ARM_LPAE_PTE_NS (((arm_lpae_iopte)1) << 5)
86 #define ARM_LPAE_PTE_VALID (((arm_lpae_iopte)1) << 0)
88 #define ARM_LPAE_PTE_ATTR_LO_MASK (((arm_lpae_iopte)0x3ff) << 2)
89 /* Ignore the contiguous bit for block splitting */
90 #define ARM_LPAE_PTE_ATTR_HI_MASK (((arm_lpae_iopte)6) << 52)
91 #define ARM_LPAE_PTE_ATTR_MASK (ARM_LPAE_PTE_ATTR_LO_MASK | \
92 ARM_LPAE_PTE_ATTR_HI_MASK)
93 /* Software bit for solving coherency races */
94 #define ARM_LPAE_PTE_SW_SYNC (((arm_lpae_iopte)1) << 55)
97 #define ARM_LPAE_PTE_AP_UNPRIV (((arm_lpae_iopte)1) << 6)
98 #define ARM_LPAE_PTE_AP_RDONLY (((arm_lpae_iopte)2) << 6)
99 #define ARM_LPAE_PTE_ATTRINDX_SHIFT 2
100 #define ARM_LPAE_PTE_nG (((arm_lpae_iopte)1) << 11)
103 #define ARM_LPAE_PTE_HAP_FAULT (((arm_lpae_iopte)0) << 6)
104 #define ARM_LPAE_PTE_HAP_READ (((arm_lpae_iopte)1) << 6)
105 #define ARM_LPAE_PTE_HAP_WRITE (((arm_lpae_iopte)2) << 6)
106 #define ARM_LPAE_PTE_MEMATTR_OIWB (((arm_lpae_iopte)0xf) << 2)
107 #define ARM_LPAE_PTE_MEMATTR_NC (((arm_lpae_iopte)0x5) << 2)
108 #define ARM_LPAE_PTE_MEMATTR_DEV (((arm_lpae_iopte)0x1) << 2)
111 #define ARM_32_LPAE_TCR_EAE (1 << 31)
112 #define ARM_64_LPAE_S2_TCR_RES1 (1 << 31)
114 #define ARM_LPAE_TCR_EPD1 (1 << 23)
116 #define ARM_LPAE_TCR_TG0_4K (0 << 14)
117 #define ARM_LPAE_TCR_TG0_64K (1 << 14)
118 #define ARM_LPAE_TCR_TG0_16K (2 << 14)
120 #define ARM_LPAE_TCR_SH0_SHIFT 12
121 #define ARM_LPAE_TCR_SH0_MASK 0x3
122 #define ARM_LPAE_TCR_SH_NS 0
123 #define ARM_LPAE_TCR_SH_OS 2
124 #define ARM_LPAE_TCR_SH_IS 3
126 #define ARM_LPAE_TCR_ORGN0_SHIFT 10
127 #define ARM_LPAE_TCR_IRGN0_SHIFT 8
128 #define ARM_LPAE_TCR_RGN_MASK 0x3
129 #define ARM_LPAE_TCR_RGN_NC 0
130 #define ARM_LPAE_TCR_RGN_WBWA 1
131 #define ARM_LPAE_TCR_RGN_WT 2
132 #define ARM_LPAE_TCR_RGN_WB 3
134 #define ARM_LPAE_TCR_SL0_SHIFT 6
135 #define ARM_LPAE_TCR_SL0_MASK 0x3
137 #define ARM_LPAE_TCR_T0SZ_SHIFT 0
138 #define ARM_LPAE_TCR_SZ_MASK 0xf
140 #define ARM_LPAE_TCR_PS_SHIFT 16
141 #define ARM_LPAE_TCR_PS_MASK 0x7
143 #define ARM_LPAE_TCR_IPS_SHIFT 32
144 #define ARM_LPAE_TCR_IPS_MASK 0x7
146 #define ARM_LPAE_TCR_PS_32_BIT 0x0ULL
147 #define ARM_LPAE_TCR_PS_36_BIT 0x1ULL
148 #define ARM_LPAE_TCR_PS_40_BIT 0x2ULL
149 #define ARM_LPAE_TCR_PS_42_BIT 0x3ULL
150 #define ARM_LPAE_TCR_PS_44_BIT 0x4ULL
151 #define ARM_LPAE_TCR_PS_48_BIT 0x5ULL
152 #define ARM_LPAE_TCR_PS_52_BIT 0x6ULL
154 #define ARM_LPAE_MAIR_ATTR_SHIFT(n) ((n) << 3)
155 #define ARM_LPAE_MAIR_ATTR_MASK 0xff
156 #define ARM_LPAE_MAIR_ATTR_DEVICE 0x04
157 #define ARM_LPAE_MAIR_ATTR_NC 0x44
158 #define ARM_LPAE_MAIR_ATTR_INC_OWBRWA 0xf4
159 #define ARM_LPAE_MAIR_ATTR_WBRWA 0xff
160 #define ARM_LPAE_MAIR_ATTR_IDX_NC 0
161 #define ARM_LPAE_MAIR_ATTR_IDX_CACHE 1
162 #define ARM_LPAE_MAIR_ATTR_IDX_DEV 2
163 #define ARM_LPAE_MAIR_ATTR_IDX_INC_OCACHE 3
165 #define ARM_MALI_LPAE_TTBR_ADRMODE_TABLE (3u << 0)
166 #define ARM_MALI_LPAE_TTBR_READ_INNER BIT(2)
167 #define ARM_MALI_LPAE_TTBR_SHARE_OUTER BIT(4)
169 #define ARM_MALI_LPAE_MEMATTR_IMP_DEF 0x88ULL
170 #define ARM_MALI_LPAE_MEMATTR_WRITE_ALLOC 0x8DULL
172 /* IOPTE accessors */
173 #define iopte_deref(pte,d) __va(iopte_to_paddr(pte, d))
175 #define iopte_type(pte,l) \
176 (((pte) >> ARM_LPAE_PTE_TYPE_SHIFT) & ARM_LPAE_PTE_TYPE_MASK)
178 #define iopte_prot(pte) ((pte) & ARM_LPAE_PTE_ATTR_MASK)
180 struct arm_lpae_io_pgtable {
181 struct io_pgtable iop;
185 unsigned long pg_shift;
186 unsigned long bits_per_level;
191 typedef u64 arm_lpae_iopte;
193 static inline bool iopte_leaf(arm_lpae_iopte pte, int lvl,
194 enum io_pgtable_fmt fmt)
196 if (lvl == (ARM_LPAE_MAX_LEVELS - 1) && fmt != ARM_MALI_LPAE)
197 return iopte_type(pte, lvl) == ARM_LPAE_PTE_TYPE_PAGE;
199 return iopte_type(pte, lvl) == ARM_LPAE_PTE_TYPE_BLOCK;
202 static arm_lpae_iopte paddr_to_iopte(phys_addr_t paddr,
203 struct arm_lpae_io_pgtable *data)
205 arm_lpae_iopte pte = paddr;
207 /* Of the bits which overlap, either 51:48 or 15:12 are always RES0 */
208 return (pte | (pte >> (48 - 12))) & ARM_LPAE_PTE_ADDR_MASK;
211 static phys_addr_t iopte_to_paddr(arm_lpae_iopte pte,
212 struct arm_lpae_io_pgtable *data)
214 u64 paddr = pte & ARM_LPAE_PTE_ADDR_MASK;
216 if (data->pg_shift < 16)
219 /* Rotate the packed high-order bits back to the top */
220 return (paddr | (paddr << (48 - 12))) & (ARM_LPAE_PTE_ADDR_MASK << 4);
223 static bool selftest_running = false;
225 static dma_addr_t __arm_lpae_dma_addr(void *pages)
227 return (dma_addr_t)virt_to_phys(pages);
230 static void *__arm_lpae_alloc_pages(size_t size, gfp_t gfp,
231 struct io_pgtable_cfg *cfg)
233 struct device *dev = cfg->iommu_dev;
234 int order = get_order(size);
239 VM_BUG_ON((gfp & __GFP_HIGHMEM));
240 p = alloc_pages_node(dev ? dev_to_node(dev) : NUMA_NO_NODE,
241 gfp | __GFP_ZERO, order);
245 pages = page_address(p);
246 if (!cfg->coherent_walk) {
247 dma = dma_map_single(dev, pages, size, DMA_TO_DEVICE);
248 if (dma_mapping_error(dev, dma))
251 * We depend on the IOMMU being able to work with any physical
252 * address directly, so if the DMA layer suggests otherwise by
253 * translating or truncating them, that bodes very badly...
255 if (dma != virt_to_phys(pages))
262 dev_err(dev, "Cannot accommodate DMA translation for IOMMU page tables\n");
263 dma_unmap_single(dev, dma, size, DMA_TO_DEVICE);
265 __free_pages(p, order);
269 static void __arm_lpae_free_pages(void *pages, size_t size,
270 struct io_pgtable_cfg *cfg)
272 if (!cfg->coherent_walk)
273 dma_unmap_single(cfg->iommu_dev, __arm_lpae_dma_addr(pages),
274 size, DMA_TO_DEVICE);
275 free_pages((unsigned long)pages, get_order(size));
278 static void __arm_lpae_sync_pte(arm_lpae_iopte *ptep,
279 struct io_pgtable_cfg *cfg)
281 dma_sync_single_for_device(cfg->iommu_dev, __arm_lpae_dma_addr(ptep),
282 sizeof(*ptep), DMA_TO_DEVICE);
285 static void __arm_lpae_set_pte(arm_lpae_iopte *ptep, arm_lpae_iopte pte,
286 struct io_pgtable_cfg *cfg)
290 if (!cfg->coherent_walk)
291 __arm_lpae_sync_pte(ptep, cfg);
294 static size_t __arm_lpae_unmap(struct arm_lpae_io_pgtable *data,
295 struct iommu_iotlb_gather *gather,
296 unsigned long iova, size_t size, int lvl,
297 arm_lpae_iopte *ptep);
299 static void __arm_lpae_init_pte(struct arm_lpae_io_pgtable *data,
300 phys_addr_t paddr, arm_lpae_iopte prot,
301 int lvl, arm_lpae_iopte *ptep)
303 arm_lpae_iopte pte = prot;
305 if (data->iop.cfg.quirks & IO_PGTABLE_QUIRK_ARM_NS)
306 pte |= ARM_LPAE_PTE_NS;
308 if (data->iop.fmt != ARM_MALI_LPAE && lvl == ARM_LPAE_MAX_LEVELS - 1)
309 pte |= ARM_LPAE_PTE_TYPE_PAGE;
311 pte |= ARM_LPAE_PTE_TYPE_BLOCK;
313 if (data->iop.fmt != ARM_MALI_LPAE)
314 pte |= ARM_LPAE_PTE_AF;
315 pte |= ARM_LPAE_PTE_SH_IS;
316 pte |= paddr_to_iopte(paddr, data);
318 __arm_lpae_set_pte(ptep, pte, &data->iop.cfg);
321 static int arm_lpae_init_pte(struct arm_lpae_io_pgtable *data,
322 unsigned long iova, phys_addr_t paddr,
323 arm_lpae_iopte prot, int lvl,
324 arm_lpae_iopte *ptep)
326 arm_lpae_iopte pte = *ptep;
328 if (iopte_leaf(pte, lvl, data->iop.fmt)) {
329 /* We require an unmap first */
330 WARN_ON(!selftest_running);
332 } else if (iopte_type(pte, lvl) == ARM_LPAE_PTE_TYPE_TABLE) {
334 * We need to unmap and free the old table before
335 * overwriting it with a block entry.
337 arm_lpae_iopte *tblp;
338 size_t sz = ARM_LPAE_BLOCK_SIZE(lvl, data);
340 tblp = ptep - ARM_LPAE_LVL_IDX(iova, lvl, data);
341 if (__arm_lpae_unmap(data, NULL, iova, sz, lvl, tblp) != sz) {
347 __arm_lpae_init_pte(data, paddr, prot, lvl, ptep);
351 static arm_lpae_iopte arm_lpae_install_table(arm_lpae_iopte *table,
352 arm_lpae_iopte *ptep,
354 struct io_pgtable_cfg *cfg)
356 arm_lpae_iopte old, new;
358 new = __pa(table) | ARM_LPAE_PTE_TYPE_TABLE;
359 if (cfg->quirks & IO_PGTABLE_QUIRK_ARM_NS)
360 new |= ARM_LPAE_PTE_NSTABLE;
363 * Ensure the table itself is visible before its PTE can be.
364 * Whilst we could get away with cmpxchg64_release below, this
365 * doesn't have any ordering semantics when !CONFIG_SMP.
369 old = cmpxchg64_relaxed(ptep, curr, new);
371 if (cfg->coherent_walk || (old & ARM_LPAE_PTE_SW_SYNC))
374 /* Even if it's not ours, there's no point waiting; just kick it */
375 __arm_lpae_sync_pte(ptep, cfg);
377 WRITE_ONCE(*ptep, new | ARM_LPAE_PTE_SW_SYNC);
382 static int __arm_lpae_map(struct arm_lpae_io_pgtable *data, unsigned long iova,
383 phys_addr_t paddr, size_t size, arm_lpae_iopte prot,
384 int lvl, arm_lpae_iopte *ptep)
386 arm_lpae_iopte *cptep, pte;
387 size_t block_size = ARM_LPAE_BLOCK_SIZE(lvl, data);
388 size_t tblsz = ARM_LPAE_GRANULE(data);
389 struct io_pgtable_cfg *cfg = &data->iop.cfg;
391 /* Find our entry at the current level */
392 ptep += ARM_LPAE_LVL_IDX(iova, lvl, data);
394 /* If we can install a leaf entry at this level, then do so */
395 if (size == block_size && (size & cfg->pgsize_bitmap))
396 return arm_lpae_init_pte(data, iova, paddr, prot, lvl, ptep);
398 /* We can't allocate tables at the final level */
399 if (WARN_ON(lvl >= ARM_LPAE_MAX_LEVELS - 1))
402 /* Grab a pointer to the next level */
403 pte = READ_ONCE(*ptep);
405 cptep = __arm_lpae_alloc_pages(tblsz, GFP_ATOMIC, cfg);
409 pte = arm_lpae_install_table(cptep, ptep, 0, cfg);
411 __arm_lpae_free_pages(cptep, tblsz, cfg);
412 } else if (!cfg->coherent_walk && !(pte & ARM_LPAE_PTE_SW_SYNC)) {
413 __arm_lpae_sync_pte(ptep, cfg);
416 if (pte && !iopte_leaf(pte, lvl, data->iop.fmt)) {
417 cptep = iopte_deref(pte, data);
419 /* We require an unmap first */
420 WARN_ON(!selftest_running);
425 return __arm_lpae_map(data, iova, paddr, size, prot, lvl + 1, cptep);
428 static arm_lpae_iopte arm_lpae_prot_to_pte(struct arm_lpae_io_pgtable *data,
433 if (data->iop.fmt == ARM_64_LPAE_S1 ||
434 data->iop.fmt == ARM_32_LPAE_S1) {
435 pte = ARM_LPAE_PTE_nG;
436 if (!(prot & IOMMU_WRITE) && (prot & IOMMU_READ))
437 pte |= ARM_LPAE_PTE_AP_RDONLY;
438 if (!(prot & IOMMU_PRIV))
439 pte |= ARM_LPAE_PTE_AP_UNPRIV;
441 pte = ARM_LPAE_PTE_HAP_FAULT;
442 if (prot & IOMMU_READ)
443 pte |= ARM_LPAE_PTE_HAP_READ;
444 if (prot & IOMMU_WRITE)
445 pte |= ARM_LPAE_PTE_HAP_WRITE;
449 * Note that this logic is structured to accommodate Mali LPAE
450 * having stage-1-like attributes but stage-2-like permissions.
452 if (data->iop.fmt == ARM_64_LPAE_S2 ||
453 data->iop.fmt == ARM_32_LPAE_S2) {
454 if (prot & IOMMU_MMIO)
455 pte |= ARM_LPAE_PTE_MEMATTR_DEV;
456 else if (prot & IOMMU_CACHE)
457 pte |= ARM_LPAE_PTE_MEMATTR_OIWB;
459 pte |= ARM_LPAE_PTE_MEMATTR_NC;
461 if (prot & IOMMU_MMIO)
462 pte |= (ARM_LPAE_MAIR_ATTR_IDX_DEV
463 << ARM_LPAE_PTE_ATTRINDX_SHIFT);
464 else if (prot & IOMMU_CACHE)
465 pte |= (ARM_LPAE_MAIR_ATTR_IDX_CACHE
466 << ARM_LPAE_PTE_ATTRINDX_SHIFT);
467 else if (prot & IOMMU_QCOM_SYS_CACHE)
468 pte |= (ARM_LPAE_MAIR_ATTR_IDX_INC_OCACHE
469 << ARM_LPAE_PTE_ATTRINDX_SHIFT);
472 if (prot & IOMMU_NOEXEC)
473 pte |= ARM_LPAE_PTE_XN;
478 static int arm_lpae_map(struct io_pgtable_ops *ops, unsigned long iova,
479 phys_addr_t paddr, size_t size, int iommu_prot)
481 struct arm_lpae_io_pgtable *data = io_pgtable_ops_to_data(ops);
482 arm_lpae_iopte *ptep = data->pgd;
483 int ret, lvl = ARM_LPAE_START_LVL(data);
486 /* If no access, then nothing to do */
487 if (!(iommu_prot & (IOMMU_READ | IOMMU_WRITE)))
490 if (WARN_ON(iova >= (1ULL << data->iop.cfg.ias) ||
491 paddr >= (1ULL << data->iop.cfg.oas)))
494 prot = arm_lpae_prot_to_pte(data, iommu_prot);
495 ret = __arm_lpae_map(data, iova, paddr, size, prot, lvl, ptep);
497 * Synchronise all PTE updates for the new mapping before there's
498 * a chance for anything to kick off a table walk for the new iova.
505 static void __arm_lpae_free_pgtable(struct arm_lpae_io_pgtable *data, int lvl,
506 arm_lpae_iopte *ptep)
508 arm_lpae_iopte *start, *end;
509 unsigned long table_size;
511 if (lvl == ARM_LPAE_START_LVL(data))
512 table_size = data->pgd_size;
514 table_size = ARM_LPAE_GRANULE(data);
518 /* Only leaf entries at the last level */
519 if (lvl == ARM_LPAE_MAX_LEVELS - 1)
522 end = (void *)ptep + table_size;
524 while (ptep != end) {
525 arm_lpae_iopte pte = *ptep++;
527 if (!pte || iopte_leaf(pte, lvl, data->iop.fmt))
530 __arm_lpae_free_pgtable(data, lvl + 1, iopte_deref(pte, data));
533 __arm_lpae_free_pages(start, table_size, &data->iop.cfg);
536 static void arm_lpae_free_pgtable(struct io_pgtable *iop)
538 struct arm_lpae_io_pgtable *data = io_pgtable_to_data(iop);
540 __arm_lpae_free_pgtable(data, ARM_LPAE_START_LVL(data), data->pgd);
544 static size_t arm_lpae_split_blk_unmap(struct arm_lpae_io_pgtable *data,
545 struct iommu_iotlb_gather *gather,
546 unsigned long iova, size_t size,
547 arm_lpae_iopte blk_pte, int lvl,
548 arm_lpae_iopte *ptep)
550 struct io_pgtable_cfg *cfg = &data->iop.cfg;
551 arm_lpae_iopte pte, *tablep;
552 phys_addr_t blk_paddr;
553 size_t tablesz = ARM_LPAE_GRANULE(data);
554 size_t split_sz = ARM_LPAE_BLOCK_SIZE(lvl, data);
555 int i, unmap_idx = -1;
557 if (WARN_ON(lvl == ARM_LPAE_MAX_LEVELS))
560 tablep = __arm_lpae_alloc_pages(tablesz, GFP_ATOMIC, cfg);
562 return 0; /* Bytes unmapped */
564 if (size == split_sz)
565 unmap_idx = ARM_LPAE_LVL_IDX(iova, lvl, data);
567 blk_paddr = iopte_to_paddr(blk_pte, data);
568 pte = iopte_prot(blk_pte);
570 for (i = 0; i < tablesz / sizeof(pte); i++, blk_paddr += split_sz) {
575 __arm_lpae_init_pte(data, blk_paddr, pte, lvl, &tablep[i]);
578 pte = arm_lpae_install_table(tablep, ptep, blk_pte, cfg);
579 if (pte != blk_pte) {
580 __arm_lpae_free_pages(tablep, tablesz, cfg);
582 * We may race against someone unmapping another part of this
583 * block, but anything else is invalid. We can't misinterpret
584 * a page entry here since we're never at the last level.
586 if (iopte_type(pte, lvl - 1) != ARM_LPAE_PTE_TYPE_TABLE)
589 tablep = iopte_deref(pte, data);
590 } else if (unmap_idx >= 0) {
591 io_pgtable_tlb_add_page(&data->iop, gather, iova, size);
595 return __arm_lpae_unmap(data, gather, iova, size, lvl, tablep);
598 static size_t __arm_lpae_unmap(struct arm_lpae_io_pgtable *data,
599 struct iommu_iotlb_gather *gather,
600 unsigned long iova, size_t size, int lvl,
601 arm_lpae_iopte *ptep)
604 struct io_pgtable *iop = &data->iop;
606 /* Something went horribly wrong and we ran out of page table */
607 if (WARN_ON(lvl == ARM_LPAE_MAX_LEVELS))
610 ptep += ARM_LPAE_LVL_IDX(iova, lvl, data);
611 pte = READ_ONCE(*ptep);
615 /* If the size matches this level, we're in the right place */
616 if (size == ARM_LPAE_BLOCK_SIZE(lvl, data)) {
617 __arm_lpae_set_pte(ptep, 0, &iop->cfg);
619 if (!iopte_leaf(pte, lvl, iop->fmt)) {
620 /* Also flush any partial walks */
621 io_pgtable_tlb_flush_walk(iop, iova, size,
622 ARM_LPAE_GRANULE(data));
623 ptep = iopte_deref(pte, data);
624 __arm_lpae_free_pgtable(data, lvl + 1, ptep);
625 } else if (iop->cfg.quirks & IO_PGTABLE_QUIRK_NON_STRICT) {
627 * Order the PTE update against queueing the IOVA, to
628 * guarantee that a flush callback from a different CPU
629 * has observed it before the TLBIALL can be issued.
633 io_pgtable_tlb_add_page(iop, gather, iova, size);
637 } else if (iopte_leaf(pte, lvl, iop->fmt)) {
639 * Insert a table at the next level to map the old region,
640 * minus the part we want to unmap
642 return arm_lpae_split_blk_unmap(data, gather, iova, size, pte,
646 /* Keep on walkin' */
647 ptep = iopte_deref(pte, data);
648 return __arm_lpae_unmap(data, gather, iova, size, lvl + 1, ptep);
651 static size_t arm_lpae_unmap(struct io_pgtable_ops *ops, unsigned long iova,
652 size_t size, struct iommu_iotlb_gather *gather)
654 struct arm_lpae_io_pgtable *data = io_pgtable_ops_to_data(ops);
655 arm_lpae_iopte *ptep = data->pgd;
656 int lvl = ARM_LPAE_START_LVL(data);
658 if (WARN_ON(iova >= (1ULL << data->iop.cfg.ias)))
661 return __arm_lpae_unmap(data, gather, iova, size, lvl, ptep);
664 static phys_addr_t arm_lpae_iova_to_phys(struct io_pgtable_ops *ops,
667 struct arm_lpae_io_pgtable *data = io_pgtable_ops_to_data(ops);
668 arm_lpae_iopte pte, *ptep = data->pgd;
669 int lvl = ARM_LPAE_START_LVL(data);
672 /* Valid IOPTE pointer? */
676 /* Grab the IOPTE we're interested in */
677 ptep += ARM_LPAE_LVL_IDX(iova, lvl, data);
678 pte = READ_ONCE(*ptep);
685 if (iopte_leaf(pte, lvl, data->iop.fmt))
686 goto found_translation;
688 /* Take it to the next level */
689 ptep = iopte_deref(pte, data);
690 } while (++lvl < ARM_LPAE_MAX_LEVELS);
692 /* Ran out of page tables to walk */
696 iova &= (ARM_LPAE_BLOCK_SIZE(lvl, data) - 1);
697 return iopte_to_paddr(pte, data) | iova;
700 static void arm_lpae_restrict_pgsizes(struct io_pgtable_cfg *cfg)
702 unsigned long granule, page_sizes;
703 unsigned int max_addr_bits = 48;
706 * We need to restrict the supported page sizes to match the
707 * translation regime for a particular granule. Aim to match
708 * the CPU page size if possible, otherwise prefer smaller sizes.
709 * While we're at it, restrict the block sizes to match the
712 if (cfg->pgsize_bitmap & PAGE_SIZE)
714 else if (cfg->pgsize_bitmap & ~PAGE_MASK)
715 granule = 1UL << __fls(cfg->pgsize_bitmap & ~PAGE_MASK);
716 else if (cfg->pgsize_bitmap & PAGE_MASK)
717 granule = 1UL << __ffs(cfg->pgsize_bitmap & PAGE_MASK);
723 page_sizes = (SZ_4K | SZ_2M | SZ_1G);
726 page_sizes = (SZ_16K | SZ_32M);
730 page_sizes = (SZ_64K | SZ_512M);
732 page_sizes |= 1ULL << 42; /* 4TB */
738 cfg->pgsize_bitmap &= page_sizes;
739 cfg->ias = min(cfg->ias, max_addr_bits);
740 cfg->oas = min(cfg->oas, max_addr_bits);
743 static struct arm_lpae_io_pgtable *
744 arm_lpae_alloc_pgtable(struct io_pgtable_cfg *cfg)
746 unsigned long va_bits, pgd_bits;
747 struct arm_lpae_io_pgtable *data;
749 arm_lpae_restrict_pgsizes(cfg);
751 if (!(cfg->pgsize_bitmap & (SZ_4K | SZ_16K | SZ_64K)))
754 if (cfg->ias > ARM_LPAE_MAX_ADDR_BITS)
757 if (cfg->oas > ARM_LPAE_MAX_ADDR_BITS)
760 if (!selftest_running && cfg->iommu_dev->dma_pfn_offset) {
761 dev_err(cfg->iommu_dev, "Cannot accommodate DMA offset for IOMMU page tables\n");
765 data = kmalloc(sizeof(*data), GFP_KERNEL);
769 data->pg_shift = __ffs(cfg->pgsize_bitmap);
770 data->bits_per_level = data->pg_shift - ilog2(sizeof(arm_lpae_iopte));
772 va_bits = cfg->ias - data->pg_shift;
773 data->levels = DIV_ROUND_UP(va_bits, data->bits_per_level);
775 /* Calculate the actual size of our pgd (without concatenation) */
776 pgd_bits = va_bits - (data->bits_per_level * (data->levels - 1));
777 data->pgd_size = 1UL << (pgd_bits + ilog2(sizeof(arm_lpae_iopte)));
779 data->iop.ops = (struct io_pgtable_ops) {
781 .unmap = arm_lpae_unmap,
782 .iova_to_phys = arm_lpae_iova_to_phys,
788 static struct io_pgtable *
789 arm_64_lpae_alloc_pgtable_s1(struct io_pgtable_cfg *cfg, void *cookie)
792 struct arm_lpae_io_pgtable *data;
794 if (cfg->quirks & ~(IO_PGTABLE_QUIRK_ARM_NS |
795 IO_PGTABLE_QUIRK_NON_STRICT))
798 data = arm_lpae_alloc_pgtable(cfg);
803 if (cfg->coherent_walk) {
804 reg = (ARM_LPAE_TCR_SH_IS << ARM_LPAE_TCR_SH0_SHIFT) |
805 (ARM_LPAE_TCR_RGN_WBWA << ARM_LPAE_TCR_IRGN0_SHIFT) |
806 (ARM_LPAE_TCR_RGN_WBWA << ARM_LPAE_TCR_ORGN0_SHIFT);
808 reg = (ARM_LPAE_TCR_SH_OS << ARM_LPAE_TCR_SH0_SHIFT) |
809 (ARM_LPAE_TCR_RGN_NC << ARM_LPAE_TCR_IRGN0_SHIFT) |
810 (ARM_LPAE_TCR_RGN_NC << ARM_LPAE_TCR_ORGN0_SHIFT);
813 switch (ARM_LPAE_GRANULE(data)) {
815 reg |= ARM_LPAE_TCR_TG0_4K;
818 reg |= ARM_LPAE_TCR_TG0_16K;
821 reg |= ARM_LPAE_TCR_TG0_64K;
827 reg |= (ARM_LPAE_TCR_PS_32_BIT << ARM_LPAE_TCR_IPS_SHIFT);
830 reg |= (ARM_LPAE_TCR_PS_36_BIT << ARM_LPAE_TCR_IPS_SHIFT);
833 reg |= (ARM_LPAE_TCR_PS_40_BIT << ARM_LPAE_TCR_IPS_SHIFT);
836 reg |= (ARM_LPAE_TCR_PS_42_BIT << ARM_LPAE_TCR_IPS_SHIFT);
839 reg |= (ARM_LPAE_TCR_PS_44_BIT << ARM_LPAE_TCR_IPS_SHIFT);
842 reg |= (ARM_LPAE_TCR_PS_48_BIT << ARM_LPAE_TCR_IPS_SHIFT);
845 reg |= (ARM_LPAE_TCR_PS_52_BIT << ARM_LPAE_TCR_IPS_SHIFT);
851 reg |= (64ULL - cfg->ias) << ARM_LPAE_TCR_T0SZ_SHIFT;
853 /* Disable speculative walks through TTBR1 */
854 reg |= ARM_LPAE_TCR_EPD1;
855 cfg->arm_lpae_s1_cfg.tcr = reg;
858 reg = (ARM_LPAE_MAIR_ATTR_NC
859 << ARM_LPAE_MAIR_ATTR_SHIFT(ARM_LPAE_MAIR_ATTR_IDX_NC)) |
860 (ARM_LPAE_MAIR_ATTR_WBRWA
861 << ARM_LPAE_MAIR_ATTR_SHIFT(ARM_LPAE_MAIR_ATTR_IDX_CACHE)) |
862 (ARM_LPAE_MAIR_ATTR_DEVICE
863 << ARM_LPAE_MAIR_ATTR_SHIFT(ARM_LPAE_MAIR_ATTR_IDX_DEV)) |
864 (ARM_LPAE_MAIR_ATTR_INC_OWBRWA
865 << ARM_LPAE_MAIR_ATTR_SHIFT(ARM_LPAE_MAIR_ATTR_IDX_INC_OCACHE));
867 cfg->arm_lpae_s1_cfg.mair[0] = reg;
868 cfg->arm_lpae_s1_cfg.mair[1] = 0;
870 /* Looking good; allocate a pgd */
871 data->pgd = __arm_lpae_alloc_pages(data->pgd_size, GFP_KERNEL, cfg);
875 /* Ensure the empty pgd is visible before any actual TTBR write */
879 cfg->arm_lpae_s1_cfg.ttbr[0] = virt_to_phys(data->pgd);
880 cfg->arm_lpae_s1_cfg.ttbr[1] = 0;
888 static struct io_pgtable *
889 arm_64_lpae_alloc_pgtable_s2(struct io_pgtable_cfg *cfg, void *cookie)
892 struct arm_lpae_io_pgtable *data;
894 /* The NS quirk doesn't apply at stage 2 */
895 if (cfg->quirks & ~(IO_PGTABLE_QUIRK_NON_STRICT))
898 data = arm_lpae_alloc_pgtable(cfg);
903 * Concatenate PGDs at level 1 if possible in order to reduce
904 * the depth of the stage-2 walk.
906 if (data->levels == ARM_LPAE_MAX_LEVELS) {
907 unsigned long pgd_pages;
909 pgd_pages = data->pgd_size >> ilog2(sizeof(arm_lpae_iopte));
910 if (pgd_pages <= ARM_LPAE_S2_MAX_CONCAT_PAGES) {
911 data->pgd_size = pgd_pages << data->pg_shift;
917 reg = ARM_64_LPAE_S2_TCR_RES1 |
918 (ARM_LPAE_TCR_SH_IS << ARM_LPAE_TCR_SH0_SHIFT) |
919 (ARM_LPAE_TCR_RGN_WBWA << ARM_LPAE_TCR_IRGN0_SHIFT) |
920 (ARM_LPAE_TCR_RGN_WBWA << ARM_LPAE_TCR_ORGN0_SHIFT);
922 sl = ARM_LPAE_START_LVL(data);
924 switch (ARM_LPAE_GRANULE(data)) {
926 reg |= ARM_LPAE_TCR_TG0_4K;
927 sl++; /* SL0 format is different for 4K granule size */
930 reg |= ARM_LPAE_TCR_TG0_16K;
933 reg |= ARM_LPAE_TCR_TG0_64K;
939 reg |= (ARM_LPAE_TCR_PS_32_BIT << ARM_LPAE_TCR_PS_SHIFT);
942 reg |= (ARM_LPAE_TCR_PS_36_BIT << ARM_LPAE_TCR_PS_SHIFT);
945 reg |= (ARM_LPAE_TCR_PS_40_BIT << ARM_LPAE_TCR_PS_SHIFT);
948 reg |= (ARM_LPAE_TCR_PS_42_BIT << ARM_LPAE_TCR_PS_SHIFT);
951 reg |= (ARM_LPAE_TCR_PS_44_BIT << ARM_LPAE_TCR_PS_SHIFT);
954 reg |= (ARM_LPAE_TCR_PS_48_BIT << ARM_LPAE_TCR_PS_SHIFT);
957 reg |= (ARM_LPAE_TCR_PS_52_BIT << ARM_LPAE_TCR_PS_SHIFT);
963 reg |= (64ULL - cfg->ias) << ARM_LPAE_TCR_T0SZ_SHIFT;
964 reg |= (~sl & ARM_LPAE_TCR_SL0_MASK) << ARM_LPAE_TCR_SL0_SHIFT;
965 cfg->arm_lpae_s2_cfg.vtcr = reg;
967 /* Allocate pgd pages */
968 data->pgd = __arm_lpae_alloc_pages(data->pgd_size, GFP_KERNEL, cfg);
972 /* Ensure the empty pgd is visible before any actual TTBR write */
976 cfg->arm_lpae_s2_cfg.vttbr = virt_to_phys(data->pgd);
984 static struct io_pgtable *
985 arm_32_lpae_alloc_pgtable_s1(struct io_pgtable_cfg *cfg, void *cookie)
987 struct io_pgtable *iop;
989 if (cfg->ias > 32 || cfg->oas > 40)
992 cfg->pgsize_bitmap &= (SZ_4K | SZ_2M | SZ_1G);
993 iop = arm_64_lpae_alloc_pgtable_s1(cfg, cookie);
995 cfg->arm_lpae_s1_cfg.tcr |= ARM_32_LPAE_TCR_EAE;
996 cfg->arm_lpae_s1_cfg.tcr &= 0xffffffff;
1002 static struct io_pgtable *
1003 arm_32_lpae_alloc_pgtable_s2(struct io_pgtable_cfg *cfg, void *cookie)
1005 struct io_pgtable *iop;
1007 if (cfg->ias > 40 || cfg->oas > 40)
1010 cfg->pgsize_bitmap &= (SZ_4K | SZ_2M | SZ_1G);
1011 iop = arm_64_lpae_alloc_pgtable_s2(cfg, cookie);
1013 cfg->arm_lpae_s2_cfg.vtcr &= 0xffffffff;
1018 static struct io_pgtable *
1019 arm_mali_lpae_alloc_pgtable(struct io_pgtable_cfg *cfg, void *cookie)
1021 struct arm_lpae_io_pgtable *data;
1023 /* No quirks for Mali (hopefully) */
1027 if (cfg->ias > 48 || cfg->oas > 40)
1030 cfg->pgsize_bitmap &= (SZ_4K | SZ_2M | SZ_1G);
1032 data = arm_lpae_alloc_pgtable(cfg);
1036 /* Mali seems to need a full 4-level table regardless of IAS */
1037 if (data->levels < ARM_LPAE_MAX_LEVELS) {
1038 data->levels = ARM_LPAE_MAX_LEVELS;
1039 data->pgd_size = sizeof(arm_lpae_iopte);
1042 * MEMATTR: Mali has no actual notion of a non-cacheable type, so the
1043 * best we can do is mimic the out-of-tree driver and hope that the
1044 * "implementation-defined caching policy" is good enough. Similarly,
1045 * we'll use it for the sake of a valid attribute for our 'device'
1046 * index, although callers should never request that in practice.
1048 cfg->arm_mali_lpae_cfg.memattr =
1049 (ARM_MALI_LPAE_MEMATTR_IMP_DEF
1050 << ARM_LPAE_MAIR_ATTR_SHIFT(ARM_LPAE_MAIR_ATTR_IDX_NC)) |
1051 (ARM_MALI_LPAE_MEMATTR_WRITE_ALLOC
1052 << ARM_LPAE_MAIR_ATTR_SHIFT(ARM_LPAE_MAIR_ATTR_IDX_CACHE)) |
1053 (ARM_MALI_LPAE_MEMATTR_IMP_DEF
1054 << ARM_LPAE_MAIR_ATTR_SHIFT(ARM_LPAE_MAIR_ATTR_IDX_DEV));
1056 data->pgd = __arm_lpae_alloc_pages(data->pgd_size, GFP_KERNEL, cfg);
1060 /* Ensure the empty pgd is visible before TRANSTAB can be written */
1063 cfg->arm_mali_lpae_cfg.transtab = virt_to_phys(data->pgd) |
1064 ARM_MALI_LPAE_TTBR_READ_INNER |
1065 ARM_MALI_LPAE_TTBR_ADRMODE_TABLE;
1073 struct io_pgtable_init_fns io_pgtable_arm_64_lpae_s1_init_fns = {
1074 .alloc = arm_64_lpae_alloc_pgtable_s1,
1075 .free = arm_lpae_free_pgtable,
1078 struct io_pgtable_init_fns io_pgtable_arm_64_lpae_s2_init_fns = {
1079 .alloc = arm_64_lpae_alloc_pgtable_s2,
1080 .free = arm_lpae_free_pgtable,
1083 struct io_pgtable_init_fns io_pgtable_arm_32_lpae_s1_init_fns = {
1084 .alloc = arm_32_lpae_alloc_pgtable_s1,
1085 .free = arm_lpae_free_pgtable,
1088 struct io_pgtable_init_fns io_pgtable_arm_32_lpae_s2_init_fns = {
1089 .alloc = arm_32_lpae_alloc_pgtable_s2,
1090 .free = arm_lpae_free_pgtable,
1093 struct io_pgtable_init_fns io_pgtable_arm_mali_lpae_init_fns = {
1094 .alloc = arm_mali_lpae_alloc_pgtable,
1095 .free = arm_lpae_free_pgtable,
1098 #ifdef CONFIG_IOMMU_IO_PGTABLE_LPAE_SELFTEST
1100 static struct io_pgtable_cfg *cfg_cookie;
1102 static void dummy_tlb_flush_all(void *cookie)
1104 WARN_ON(cookie != cfg_cookie);
1107 static void dummy_tlb_flush(unsigned long iova, size_t size, size_t granule,
1110 WARN_ON(cookie != cfg_cookie);
1111 WARN_ON(!(size & cfg_cookie->pgsize_bitmap));
1114 static void dummy_tlb_add_page(struct iommu_iotlb_gather *gather,
1115 unsigned long iova, size_t granule, void *cookie)
1117 dummy_tlb_flush(iova, granule, granule, cookie);
1120 static const struct iommu_flush_ops dummy_tlb_ops __initconst = {
1121 .tlb_flush_all = dummy_tlb_flush_all,
1122 .tlb_flush_walk = dummy_tlb_flush,
1123 .tlb_flush_leaf = dummy_tlb_flush,
1124 .tlb_add_page = dummy_tlb_add_page,
1127 static void __init arm_lpae_dump_ops(struct io_pgtable_ops *ops)
1129 struct arm_lpae_io_pgtable *data = io_pgtable_ops_to_data(ops);
1130 struct io_pgtable_cfg *cfg = &data->iop.cfg;
1132 pr_err("cfg: pgsize_bitmap 0x%lx, ias %u-bit\n",
1133 cfg->pgsize_bitmap, cfg->ias);
1134 pr_err("data: %d levels, 0x%zx pgd_size, %lu pg_shift, %lu bits_per_level, pgd @ %p\n",
1135 data->levels, data->pgd_size, data->pg_shift,
1136 data->bits_per_level, data->pgd);
1139 #define __FAIL(ops, i) ({ \
1140 WARN(1, "selftest: test failed for fmt idx %d\n", (i)); \
1141 arm_lpae_dump_ops(ops); \
1142 selftest_running = false; \
1146 static int __init arm_lpae_run_tests(struct io_pgtable_cfg *cfg)
1148 static const enum io_pgtable_fmt fmts[] = {
1156 struct io_pgtable_ops *ops;
1158 selftest_running = true;
1160 for (i = 0; i < ARRAY_SIZE(fmts); ++i) {
1162 ops = alloc_io_pgtable_ops(fmts[i], cfg, cfg);
1164 pr_err("selftest: failed to allocate io pgtable ops\n");
1169 * Initial sanity checks.
1170 * Empty page tables shouldn't provide any translations.
1172 if (ops->iova_to_phys(ops, 42))
1173 return __FAIL(ops, i);
1175 if (ops->iova_to_phys(ops, SZ_1G + 42))
1176 return __FAIL(ops, i);
1178 if (ops->iova_to_phys(ops, SZ_2G + 42))
1179 return __FAIL(ops, i);
1182 * Distinct mappings of different granule sizes.
1185 for_each_set_bit(j, &cfg->pgsize_bitmap, BITS_PER_LONG) {
1188 if (ops->map(ops, iova, iova, size, IOMMU_READ |
1192 return __FAIL(ops, i);
1194 /* Overlapping mappings */
1195 if (!ops->map(ops, iova, iova + size, size,
1196 IOMMU_READ | IOMMU_NOEXEC))
1197 return __FAIL(ops, i);
1199 if (ops->iova_to_phys(ops, iova + 42) != (iova + 42))
1200 return __FAIL(ops, i);
1206 size = 1UL << __ffs(cfg->pgsize_bitmap);
1207 if (ops->unmap(ops, SZ_1G + size, size, NULL) != size)
1208 return __FAIL(ops, i);
1210 /* Remap of partial unmap */
1211 if (ops->map(ops, SZ_1G + size, size, size, IOMMU_READ))
1212 return __FAIL(ops, i);
1214 if (ops->iova_to_phys(ops, SZ_1G + size + 42) != (size + 42))
1215 return __FAIL(ops, i);
1219 for_each_set_bit(j, &cfg->pgsize_bitmap, BITS_PER_LONG) {
1222 if (ops->unmap(ops, iova, size, NULL) != size)
1223 return __FAIL(ops, i);
1225 if (ops->iova_to_phys(ops, iova + 42))
1226 return __FAIL(ops, i);
1228 /* Remap full block */
1229 if (ops->map(ops, iova, iova, size, IOMMU_WRITE))
1230 return __FAIL(ops, i);
1232 if (ops->iova_to_phys(ops, iova + 42) != (iova + 42))
1233 return __FAIL(ops, i);
1238 free_io_pgtable_ops(ops);
1241 selftest_running = false;
1245 static int __init arm_lpae_do_selftests(void)
1247 static const unsigned long pgsize[] = {
1248 SZ_4K | SZ_2M | SZ_1G,
1253 static const unsigned int ias[] = {
1254 32, 36, 40, 42, 44, 48,
1257 int i, j, pass = 0, fail = 0;
1258 struct io_pgtable_cfg cfg = {
1259 .tlb = &dummy_tlb_ops,
1261 .coherent_walk = true,
1264 for (i = 0; i < ARRAY_SIZE(pgsize); ++i) {
1265 for (j = 0; j < ARRAY_SIZE(ias); ++j) {
1266 cfg.pgsize_bitmap = pgsize[i];
1268 pr_info("selftest: pgsize_bitmap 0x%08lx, IAS %u\n",
1270 if (arm_lpae_run_tests(&cfg))
1277 pr_info("selftest: completed with %d PASS %d FAIL\n", pass, fail);
1278 return fail ? -EFAULT : 0;
1280 subsys_initcall(arm_lpae_do_selftests);