xref: /linux/arch/arc/include/asm/pgtable-levels.h (revision cb8fef4b07f71da01843457b66e579ad248a625e)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright (C) 2020 Synopsys, Inc. (www.synopsys.com)
4  */
5 
6 /*
7  * Helpers for implemenintg paging levels
8  */
9 
10 #ifndef _ASM_ARC_PGTABLE_LEVELS_H
11 #define _ASM_ARC_PGTABLE_LEVELS_H
12 
13 #if CONFIG_PGTABLE_LEVELS == 2
14 
15 /*
16  * 2 level paging setup for software walked MMUv3 (ARC700) and MMUv4 (HS)
17  *
18  * [31]            32 bit virtual address              [0]
19  * -------------------------------------------------------
20  * |               | <---------- PGDIR_SHIFT ----------> |
21  * |               |                | <-- PAGE_SHIFT --> |
22  * -------------------------------------------------------
23  *       |                  |                |
24  *       |                  |                --> off in page frame
25  *       |                  ---> index into Page Table
26  *       ----> index into Page Directory
27  *
28  * Given software walk, the vaddr split is arbitrary set to 11:8:13
29  * However enabling of super page in a 2 level regime pegs PGDIR_SHIFT to
30  * super page size.
31  */
32 
33 #if defined(CONFIG_ARC_HUGEPAGE_16M)
34 #define PGDIR_SHIFT		24
35 #elif defined(CONFIG_ARC_HUGEPAGE_2M)
36 #define PGDIR_SHIFT		21
37 #else
38 /*
39  * No Super page case
40  * Default value provides 11:8:13 (8K), 10:10:12 (4K)
41  * Limits imposed by pgtable_t only PAGE_SIZE long
42  * (so 4K page can only have 1K entries: or 10 bits)
43  */
44 #ifdef CONFIG_ARC_PAGE_SIZE_4K
45 #define PGDIR_SHIFT		22
46 #else
47 #define PGDIR_SHIFT		21
48 #endif
49 
50 #endif
51 
52 #else /* CONFIG_PGTABLE_LEVELS != 2 */
53 
54 /*
55  * A default 3 level paging testing setup in software walked MMU
56  *   MMUv4 (8K page): <4> : <7> : <8> : <13>
57  * A default 4 level paging testing setup in software walked MMU
58  *   MMUv4 (8K page): <4> : <3> : <4> : <8> : <13>
59  */
60 #define PGDIR_SHIFT		28
61 #if CONFIG_PGTABLE_LEVELS > 3
62 #define PUD_SHIFT		25
63 #endif
64 #if CONFIG_PGTABLE_LEVELS > 2
65 #define PMD_SHIFT		21
66 #endif
67 
68 #endif /* CONFIG_PGTABLE_LEVELS */
69 
70 #define PGDIR_SIZE		BIT(PGDIR_SHIFT)
71 #define PGDIR_MASK		(~(PGDIR_SIZE - 1))
72 #define PTRS_PER_PGD		BIT(32 - PGDIR_SHIFT)
73 
74 #if CONFIG_PGTABLE_LEVELS > 3
75 #define PUD_SIZE		BIT(PUD_SHIFT)
76 #define PUD_MASK		(~(PUD_SIZE - 1))
77 #define PTRS_PER_PUD		BIT(PGDIR_SHIFT - PUD_SHIFT)
78 #endif
79 
80 #if CONFIG_PGTABLE_LEVELS > 2
81 #define PMD_SIZE		BIT(PMD_SHIFT)
82 #define PMD_MASK		(~(PMD_SIZE - 1))
83 #define PTRS_PER_PMD		BIT(PUD_SHIFT - PMD_SHIFT)
84 #endif
85 
86 #define PTRS_PER_PTE		BIT(PMD_SHIFT - PAGE_SHIFT)
87 
88 #ifndef __ASSEMBLER__
89 
90 #if CONFIG_PGTABLE_LEVELS > 3
91 #include <asm-generic/pgtable-nop4d.h>
92 #elif CONFIG_PGTABLE_LEVELS > 2
93 #include <asm-generic/pgtable-nopud.h>
94 #else
95 #include <asm-generic/pgtable-nopmd.h>
96 #endif
97 
98 /*
99  * 1st level paging: pgd
100  */
101 
102 #if CONFIG_PGTABLE_LEVELS > 3
103 
104 /* In 4 level paging, p4d_* macros work on pgd */
105 #define p4d_none(x)		(!p4d_val(x))
106 #define p4d_bad(x)		((p4d_val(x) & ~PAGE_MASK))
107 #define p4d_present(x)		(p4d_val(x))
108 #define p4d_clear(xp)		do { p4d_val(*(xp)) = 0; } while (0)
109 #define p4d_pgtable(p4d)	((pud_t *)(p4d_val(p4d) & PAGE_MASK))
110 #define p4d_page(p4d)		virt_to_page(p4d_pgtable(p4d))
111 #define set_p4d(p4dp, p4d)	(*(p4dp) = p4d)
112 
113 /*
114  * 2nd level paging: pud
115  */
116 #endif
117 
118 #if CONFIG_PGTABLE_LEVELS > 2
119 
120 /*
121  * In 3 level paging, pud_* macros work on pgd
122  * In 4 level paging, pud_* macros work on pud
123  */
124 #define pud_none(x)		(!pud_val(x))
125 #define pud_bad(x)		((pud_val(x) & ~PAGE_MASK))
126 #define pud_present(x)		(pud_val(x))
127 #define pud_clear(xp)		do { pud_val(*(xp)) = 0; } while (0)
128 #define pud_pgtable(pud)	((pmd_t *)(pud_val(pud) & PAGE_MASK))
129 #define pud_page(pud)		virt_to_page(pud_pgtable(pud))
130 #define set_pud(pudp, pud)	(*(pudp) = pud)
131 
132 /*
133  * 3rd level paging: pmd
134  */
135 #define pmd_pfn(pmd)		((pmd_val(pmd) & PMD_MASK) >> PAGE_SHIFT)
136 #define pfn_pmd(pfn,prot)	__pmd(((pfn) << PAGE_SHIFT) | pgprot_val(prot))
137 
138 #endif
139 
140 /*
141  * Due to the strange way generic pgtable level folding works, the pmd_* macros
142  *  - are valid even for 2 levels (which supposedly only has pgd - pte)
143  *  - behave differently for 2 vs. 3
144  * In 2  level paging        (pgd -> pte), pmd_* macros work on pgd
145  * In 3+ level paging (pgd -> pmd -> pte), pmd_* macros work on pmd
146  */
147 #define pmd_none(x)		(!pmd_val(x))
148 #define pmd_bad(x)		((pmd_val(x) & ~PAGE_MASK))
149 #define pmd_present(x)		(pmd_val(x))
150 #define pmd_clear(xp)		do { pmd_val(*(xp)) = 0; } while (0)
151 #define pmd_page_vaddr(pmd)	(pmd_val(pmd) & PAGE_MASK)
152 #define pmd_pfn(pmd)		((pmd_val(pmd) & PAGE_MASK) >> PAGE_SHIFT)
153 #define pmd_page(pmd)		virt_to_page((void *)pmd_page_vaddr(pmd))
154 #define set_pmd(pmdp, pmd)	(*(pmdp) = pmd)
155 #define pmd_pgtable(pmd)	((pgtable_t) pmd_page(pmd))
156 
157 /*
158  * 4th level paging: pte
159  */
160 #define PFN_PTE_SHIFT		PAGE_SHIFT
161 #define pte_none(x)		(!pte_val(x))
162 #define pte_present(x)		(pte_val(x) & _PAGE_PRESENT)
163 #define pte_clear(mm,addr,ptep)	set_pte_at(mm, addr, ptep, __pte(0))
164 #define pte_page(pte)		pfn_to_page(pte_pfn(pte))
165 #define set_pte(ptep, pte)	((*(ptep)) = (pte))
166 #define pte_pfn(pte)		(pte_val(pte) >> PAGE_SHIFT)
167 #define pfn_pte(pfn, prot)	__pte(__pfn_to_phys(pfn) | pgprot_val(prot))
168 
169 #ifdef CONFIG_ISA_ARCV2
170 #define pmd_leaf(x)		(pmd_val(x) & _PAGE_HW_SZ)
171 #endif
172 
173 #endif	/* !__ASSEMBLER__ */
174 
175 #endif
176