]> git.proxmox.com Git - mirror_edk2.git/blob - ArmPkg/Include/Chipset/ArmV7Mmu.h
UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm
[mirror_edk2.git] / ArmPkg / Include / Chipset / ArmV7Mmu.h
1 /** @file
2 *
3 * Copyright (c) 2011-2013, ARM Limited. All rights reserved.
4 *
5 * SPDX-License-Identifier: BSD-2-Clause-Patent
6 *
7 **/
8
9 #ifndef ARMV7_MMU_H_
10 #define ARMV7_MMU_H_
11
12 #define TTBR_NOT_OUTER_SHAREABLE BIT5
13 #define TTBR_RGN_OUTER_NON_CACHEABLE 0
14 #define TTBR_RGN_OUTER_WRITE_BACK_ALLOC BIT3
15 #define TTBR_RGN_OUTER_WRITE_THROUGH BIT4
16 #define TTBR_RGN_OUTER_WRITE_BACK_NO_ALLOC (BIT3|BIT4)
17 #define TTBR_SHAREABLE BIT1
18 #define TTBR_NON_SHAREABLE 0
19 #define TTBR_INNER_CACHEABLE BIT0
20 #define TTBR_INNER_NON_CACHEABLE 0
21 #define TTBR_RGN_INNER_NON_CACHEABLE 0
22 #define TTBR_RGN_INNER_WRITE_BACK_ALLOC BIT6
23 #define TTBR_RGN_INNER_WRITE_THROUGH BIT0
24 #define TTBR_RGN_INNER_WRITE_BACK_NO_ALLOC (BIT0|BIT6)
25
26 #define TTBR_WRITE_THROUGH ( TTBR_RGN_OUTER_WRITE_THROUGH | TTBR_INNER_CACHEABLE | TTBR_SHAREABLE)
27 #define TTBR_WRITE_BACK_NO_ALLOC ( TTBR_RGN_OUTER_WRITE_BACK_NO_ALLOC | TTBR_INNER_CACHEABLE | TTBR_SHAREABLE)
28 #define TTBR_NON_CACHEABLE ( TTBR_RGN_OUTER_NON_CACHEABLE | TTBR_INNER_NON_CACHEABLE )
29 #define TTBR_WRITE_BACK_ALLOC ( TTBR_RGN_OUTER_WRITE_BACK_ALLOC | TTBR_INNER_CACHEABLE | TTBR_SHAREABLE)
30
31 #define TTBR_MP_WRITE_THROUGH ( TTBR_RGN_OUTER_WRITE_THROUGH | TTBR_RGN_INNER_WRITE_THROUGH | TTBR_SHAREABLE)
32 #define TTBR_MP_WRITE_BACK_NO_ALLOC ( TTBR_RGN_OUTER_WRITE_BACK_NO_ALLOC | TTBR_RGN_INNER_WRITE_BACK_NO_ALLOC | TTBR_SHAREABLE)
33 #define TTBR_MP_NON_CACHEABLE ( TTBR_RGN_OUTER_NON_CACHEABLE | TTBR_RGN_INNER_NON_CACHEABLE )
34 #define TTBR_MP_WRITE_BACK_ALLOC ( TTBR_RGN_OUTER_WRITE_BACK_ALLOC | TTBR_RGN_INNER_WRITE_BACK_ALLOC | TTBR_SHAREABLE)
35
36 #define TRANSLATION_TABLE_SECTION_COUNT 4096
37 #define TRANSLATION_TABLE_SECTION_SIZE (sizeof(UINT32) * TRANSLATION_TABLE_SECTION_COUNT)
38 #define TRANSLATION_TABLE_SECTION_ALIGNMENT (sizeof(UINT32) * TRANSLATION_TABLE_SECTION_COUNT)
39 #define TRANSLATION_TABLE_SECTION_ALIGNMENT_MASK (TRANSLATION_TABLE_SECTION_ALIGNMENT - 1)
40
41 #define TRANSLATION_TABLE_PAGE_COUNT 256
42 #define TRANSLATION_TABLE_PAGE_SIZE (sizeof(UINT32) * TRANSLATION_TABLE_PAGE_COUNT)
43 #define TRANSLATION_TABLE_PAGE_ALIGNMENT (sizeof(UINT32) * TRANSLATION_TABLE_PAGE_COUNT)
44 #define TRANSLATION_TABLE_PAGE_ALIGNMENT_MASK (TRANSLATION_TABLE_PAGE_ALIGNMENT - 1)
45
46 #define TRANSLATION_TABLE_ENTRY_FOR_VIRTUAL_ADDRESS(table, address) ((UINT32 *)(table) + (((UINTN)(address)) >> 20))
47
48 // Translation table descriptor types
49 #define TT_DESCRIPTOR_SECTION_TYPE_MASK ((1UL << 18) | (3UL << 0))
50 #define TT_DESCRIPTOR_SECTION_TYPE_FAULT (0UL << 0)
51 #define TT_DESCRIPTOR_SECTION_TYPE_PAGE_TABLE (1UL << 0)
52 #define TT_DESCRIPTOR_SECTION_TYPE_SECTION ((0UL << 18) | (2UL << 0))
53 #define TT_DESCRIPTOR_SECTION_TYPE_SUPERSECTION ((1UL << 18) | (2UL << 0))
54 #define TT_DESCRIPTOR_SECTION_TYPE_IS_PAGE_TABLE(Desc) (((Desc) & 3UL) == TT_DESCRIPTOR_SECTION_TYPE_PAGE_TABLE)
55
56 // Translation table descriptor types
57 #define TT_DESCRIPTOR_PAGE_TYPE_MASK (3UL << 0)
58 #define TT_DESCRIPTOR_PAGE_TYPE_FAULT (0UL << 0)
59 #define TT_DESCRIPTOR_PAGE_TYPE_PAGE (2UL << 0)
60 #define TT_DESCRIPTOR_PAGE_TYPE_PAGE_XN (3UL << 0)
61 #define TT_DESCRIPTOR_PAGE_TYPE_LARGEPAGE (1UL << 0)
62
63 // Section descriptor definitions
64 #define TT_DESCRIPTOR_SECTION_SIZE (0x00100000)
65
66 #define TT_DESCRIPTOR_SECTION_NS_MASK (1UL << 19)
67 #define TT_DESCRIPTOR_SECTION_NS (1UL << 19)
68
69 #define TT_DESCRIPTOR_SECTION_NG_MASK (1UL << 17)
70 #define TT_DESCRIPTOR_SECTION_NG_GLOBAL (0UL << 17)
71 #define TT_DESCRIPTOR_SECTION_NG_LOCAL (1UL << 17)
72
73 #define TT_DESCRIPTOR_PAGE_NG_MASK (1UL << 11)
74 #define TT_DESCRIPTOR_PAGE_NG_GLOBAL (0UL << 11)
75 #define TT_DESCRIPTOR_PAGE_NG_LOCAL (1UL << 11)
76
77 #define TT_DESCRIPTOR_SECTION_S_MASK (1UL << 16)
78 #define TT_DESCRIPTOR_SECTION_S_NOT_SHARED (0UL << 16)
79 #define TT_DESCRIPTOR_SECTION_S_SHARED (1UL << 16)
80
81 #define TT_DESCRIPTOR_PAGE_S_MASK (1UL << 10)
82 #define TT_DESCRIPTOR_PAGE_S_NOT_SHARED (0UL << 10)
83 #define TT_DESCRIPTOR_PAGE_S_SHARED (1UL << 10)
84
85 #define TT_DESCRIPTOR_SECTION_AP_MASK ((1UL << 15) | (3UL << 10))
86 #define TT_DESCRIPTOR_SECTION_AP_NO_NO ((0UL << 15) | (0UL << 10))
87 #define TT_DESCRIPTOR_SECTION_AP_RW_NO ((0UL << 15) | (1UL << 10))
88 #define TT_DESCRIPTOR_SECTION_AP_RW_RO ((0UL << 15) | (2UL << 10))
89 #define TT_DESCRIPTOR_SECTION_AP_RW_RW ((0UL << 15) | (3UL << 10))
90 #define TT_DESCRIPTOR_SECTION_AP_RO_NO ((1UL << 15) | (1UL << 10))
91 #define TT_DESCRIPTOR_SECTION_AP_RO_RO ((1UL << 15) | (3UL << 10))
92
93 #define TT_DESCRIPTOR_PAGE_AP_MASK ((1UL << 9) | (3UL << 4))
94 #define TT_DESCRIPTOR_PAGE_AP_NO_NO ((0UL << 9) | (0UL << 4))
95 #define TT_DESCRIPTOR_PAGE_AP_RW_NO ((0UL << 9) | (1UL << 4))
96 #define TT_DESCRIPTOR_PAGE_AP_RW_RO ((0UL << 9) | (2UL << 4))
97 #define TT_DESCRIPTOR_PAGE_AP_RW_RW ((0UL << 9) | (3UL << 4))
98 #define TT_DESCRIPTOR_PAGE_AP_RO_NO ((1UL << 9) | (1UL << 4))
99 #define TT_DESCRIPTOR_PAGE_AP_RO_RO ((1UL << 9) | (3UL << 4))
100
101 #define TT_DESCRIPTOR_SECTION_XN_MASK (0x1UL << 4)
102 #define TT_DESCRIPTOR_PAGE_XN_MASK (0x1UL << 0)
103 #define TT_DESCRIPTOR_LARGEPAGE_XN_MASK (0x1UL << 15)
104
105 #define TT_DESCRIPTOR_SECTION_CACHE_POLICY_MASK ((3UL << 12) | (1UL << 3) | (1UL << 2))
106 #define TT_DESCRIPTOR_SECTION_CACHEABLE_MASK (1UL << 3)
107 #define TT_DESCRIPTOR_SECTION_CACHE_POLICY_STRONGLY_ORDERED ((0UL << 12) | (0UL << 3) | (0UL << 2))
108 #define TT_DESCRIPTOR_SECTION_CACHE_POLICY_SHAREABLE_DEVICE ((0UL << 12) | (0UL << 3) | (1UL << 2))
109 #define TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_THROUGH_NO_ALLOC ((0UL << 12) | (1UL << 3) | (0UL << 2))
110 #define TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_BACK_NO_ALLOC ((0UL << 12) | (1UL << 3) | (1UL << 2))
111 #define TT_DESCRIPTOR_SECTION_CACHE_POLICY_NON_CACHEABLE ((1UL << 12) | (0UL << 3) | (0UL << 2))
112 #define TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_BACK_ALLOC ((1UL << 12) | (1UL << 3) | (1UL << 2))
113 #define TT_DESCRIPTOR_SECTION_CACHE_POLICY_NON_SHAREABLE_DEVICE ((2UL << 12) | (0UL << 3) | (0UL << 2))
114
115 #define TT_DESCRIPTOR_PAGE_SIZE (0x00001000)
116
117 #define TT_DESCRIPTOR_PAGE_CACHE_POLICY_MASK ((3UL << 6) | (1UL << 3) | (1UL << 2))
118 #define TT_DESCRIPTOR_PAGE_CACHEABLE_MASK (1UL << 3)
119 #define TT_DESCRIPTOR_PAGE_CACHE_POLICY_STRONGLY_ORDERED ((0UL << 6) | (0UL << 3) | (0UL << 2))
120 #define TT_DESCRIPTOR_PAGE_CACHE_POLICY_SHAREABLE_DEVICE ((0UL << 6) | (0UL << 3) | (1UL << 2))
121 #define TT_DESCRIPTOR_PAGE_CACHE_POLICY_WRITE_THROUGH_NO_ALLOC ((0UL << 6) | (1UL << 3) | (0UL << 2))
122 #define TT_DESCRIPTOR_PAGE_CACHE_POLICY_WRITE_BACK_NO_ALLOC ((0UL << 6) | (1UL << 3) | (1UL << 2))
123 #define TT_DESCRIPTOR_PAGE_CACHE_POLICY_NON_CACHEABLE ((1UL << 6) | (0UL << 3) | (0UL << 2))
124 #define TT_DESCRIPTOR_PAGE_CACHE_POLICY_WRITE_BACK_ALLOC ((1UL << 6) | (1UL << 3) | (1UL << 2))
125 #define TT_DESCRIPTOR_PAGE_CACHE_POLICY_NON_SHAREABLE_DEVICE ((2UL << 6) | (0UL << 3) | (0UL << 2))
126
127 #define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_MASK ((3UL << 12) | (1UL << 3) | (1UL << 2))
128 #define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_STRONGLY_ORDERED ((0UL << 12) | (0UL << 3) | (0UL << 2))
129 #define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_SHAREABLE_DEVICE ((0UL << 12) | (0UL << 3) | (1UL << 2))
130 #define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_WRITE_THROUGH_NO_ALLOC ((0UL << 12) | (1UL << 3) | (0UL << 2))
131 #define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_WRITE_BACK_NO_ALLOC ((0UL << 12) | (1UL << 3) | (1UL << 2))
132 #define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_NON_CACHEABLE ((1UL << 12) | (0UL << 3) | (0UL << 2))
133 #define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_WRITE_BACK_ALLOC ((1UL << 12) | (1UL << 3) | (1UL << 2))
134 #define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_NON_SHAREABLE_DEVICE ((2UL << 12) | (0UL << 3) | (0UL << 2))
135
136 #define TT_DESCRIPTOR_CONVERT_TO_PAGE_AP(Desc) ((((Desc) & TT_DESCRIPTOR_SECTION_AP_MASK) >> 6) & TT_DESCRIPTOR_PAGE_AP_MASK)
137 #define TT_DESCRIPTOR_CONVERT_TO_PAGE_NG(Desc) ((((Desc) & TT_DESCRIPTOR_SECTION_NG_MASK) >> 6) & TT_DESCRIPTOR_PAGE_NG_MASK)
138 #define TT_DESCRIPTOR_CONVERT_TO_PAGE_S(Desc) ((((Desc) & TT_DESCRIPTOR_SECTION_S_MASK) >> 6) & TT_DESCRIPTOR_PAGE_S_MASK)
139 #define TT_DESCRIPTOR_CONVERT_TO_PAGE_XN(Desc, IsLargePage) ((IsLargePage)?\
140 ((((Desc) & TT_DESCRIPTOR_SECTION_XN_MASK) << 11) & TT_DESCRIPTOR_LARGEPAGE_XN_MASK): \
141 ((((Desc) & TT_DESCRIPTOR_SECTION_XN_MASK) >> 4) & TT_DESCRIPTOR_PAGE_XN_MASK))
142 #define TT_DESCRIPTOR_CONVERT_TO_PAGE_CACHE_POLICY(Desc, IsLargePage) (IsLargePage? \
143 (((Desc) & TT_DESCRIPTOR_SECTION_CACHE_POLICY_MASK) & TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_MASK): \
144 (((((Desc) & (0x3 << 12)) >> 6) | (Desc & (0x3 << 2)))))
145
146 #define TT_DESCRIPTOR_CONVERT_TO_SECTION_AP(Desc) ((((Desc) & TT_DESCRIPTOR_PAGE_AP_MASK) << 6) & TT_DESCRIPTOR_SECTION_AP_MASK)
147
148 #define TT_DESCRIPTOR_CONVERT_TO_SECTION_CACHE_POLICY(Desc, IsLargePage) (IsLargePage? \
149 (((Desc) & TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_MASK) & TT_DESCRIPTOR_SECTION_CACHE_POLICY_MASK): \
150 (((((Desc) & (0x3 << 6)) << 6) | (Desc & (0x3 << 2)))))
151
152 #define TT_DESCRIPTOR_SECTION_ATTRIBUTE_MASK (TT_DESCRIPTOR_SECTION_NS_MASK | TT_DESCRIPTOR_SECTION_NG_MASK | \
153 TT_DESCRIPTOR_SECTION_S_MASK | TT_DESCRIPTOR_SECTION_AP_MASK | \
154 TT_DESCRIPTOR_SECTION_XN_MASK | TT_DESCRIPTOR_SECTION_CACHE_POLICY_MASK)
155
156 #define TT_DESCRIPTOR_PAGE_ATTRIBUTE_MASK (TT_DESCRIPTOR_PAGE_NG_MASK | TT_DESCRIPTOR_PAGE_S_MASK | \
157 TT_DESCRIPTOR_PAGE_AP_MASK | TT_DESCRIPTOR_PAGE_XN_MASK | \
158 TT_DESCRIPTOR_PAGE_CACHE_POLICY_MASK)
159
160 #define TT_DESCRIPTOR_SECTION_DOMAIN_MASK (0x0FUL << 5)
161 #define TT_DESCRIPTOR_SECTION_DOMAIN(a) (((a) & 0x0FUL) << 5)
162
163 #define TT_DESCRIPTOR_SECTION_BASE_ADDRESS_MASK (0xFFF00000)
164 #define TT_DESCRIPTOR_SECTION_PAGETABLE_ADDRESS_MASK (0xFFFFFC00)
165 #define TT_DESCRIPTOR_SECTION_BASE_ADDRESS(a) ((a) & TT_DESCRIPTOR_SECTION_BASE_ADDRESS_MASK)
166 #define TT_DESCRIPTOR_SECTION_BASE_SHIFT 20
167
168 #define TT_DESCRIPTOR_PAGE_BASE_ADDRESS_MASK (0xFFFFF000)
169 #define TT_DESCRIPTOR_PAGE_INDEX_MASK (0x000FF000)
170 #define TT_DESCRIPTOR_PAGE_BASE_ADDRESS(a) ((a) & TT_DESCRIPTOR_PAGE_BASE_ADDRESS_MASK)
171 #define TT_DESCRIPTOR_PAGE_BASE_SHIFT 12
172
173 #define TT_DESCRIPTOR_SECTION_WRITE_BACK(NonSecure) (TT_DESCRIPTOR_SECTION_TYPE_SECTION | \
174 ((NonSecure) ? TT_DESCRIPTOR_SECTION_NS : 0) | \
175 TT_DESCRIPTOR_SECTION_NG_GLOBAL | \
176 TT_DESCRIPTOR_SECTION_S_SHARED | \
177 TT_DESCRIPTOR_SECTION_DOMAIN(0) | \
178 TT_DESCRIPTOR_SECTION_AP_RW_RW | \
179 TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_BACK_ALLOC)
180 #define TT_DESCRIPTOR_SECTION_WRITE_THROUGH(NonSecure) (TT_DESCRIPTOR_SECTION_TYPE_SECTION | \
181 ((NonSecure) ? TT_DESCRIPTOR_SECTION_NS : 0) | \
182 TT_DESCRIPTOR_SECTION_NG_GLOBAL | \
183 TT_DESCRIPTOR_SECTION_S_SHARED | \
184 TT_DESCRIPTOR_SECTION_DOMAIN(0) | \
185 TT_DESCRIPTOR_SECTION_AP_RW_RW | \
186 TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_THROUGH_NO_ALLOC)
187 #define TT_DESCRIPTOR_SECTION_DEVICE(NonSecure) (TT_DESCRIPTOR_SECTION_TYPE_SECTION | \
188 ((NonSecure) ? TT_DESCRIPTOR_SECTION_NS : 0) | \
189 TT_DESCRIPTOR_SECTION_NG_GLOBAL | \
190 TT_DESCRIPTOR_SECTION_S_NOT_SHARED | \
191 TT_DESCRIPTOR_SECTION_DOMAIN(0) | \
192 TT_DESCRIPTOR_SECTION_AP_RW_RW | \
193 TT_DESCRIPTOR_SECTION_XN_MASK | \
194 TT_DESCRIPTOR_SECTION_CACHE_POLICY_SHAREABLE_DEVICE)
195 #define TT_DESCRIPTOR_SECTION_UNCACHED(NonSecure) (TT_DESCRIPTOR_SECTION_TYPE_SECTION | \
196 ((NonSecure) ? TT_DESCRIPTOR_SECTION_NS : 0) | \
197 TT_DESCRIPTOR_SECTION_NG_GLOBAL | \
198 TT_DESCRIPTOR_SECTION_S_NOT_SHARED | \
199 TT_DESCRIPTOR_SECTION_DOMAIN(0) | \
200 TT_DESCRIPTOR_SECTION_AP_RW_RW | \
201 TT_DESCRIPTOR_SECTION_CACHE_POLICY_NON_CACHEABLE)
202
203 #define TT_DESCRIPTOR_PAGE_WRITE_BACK (TT_DESCRIPTOR_PAGE_TYPE_PAGE | \
204 TT_DESCRIPTOR_PAGE_NG_GLOBAL | \
205 TT_DESCRIPTOR_PAGE_S_SHARED | \
206 TT_DESCRIPTOR_PAGE_AP_RW_RW | \
207 TT_DESCRIPTOR_PAGE_CACHE_POLICY_WRITE_BACK_ALLOC)
208 #define TT_DESCRIPTOR_PAGE_WRITE_THROUGH (TT_DESCRIPTOR_PAGE_TYPE_PAGE | \
209 TT_DESCRIPTOR_PAGE_NG_GLOBAL | \
210 TT_DESCRIPTOR_PAGE_S_SHARED | \
211 TT_DESCRIPTOR_PAGE_AP_RW_RW | \
212 TT_DESCRIPTOR_PAGE_CACHE_POLICY_WRITE_THROUGH_NO_ALLOC)
213 #define TT_DESCRIPTOR_PAGE_DEVICE (TT_DESCRIPTOR_PAGE_TYPE_PAGE | \
214 TT_DESCRIPTOR_PAGE_NG_GLOBAL | \
215 TT_DESCRIPTOR_PAGE_S_NOT_SHARED | \
216 TT_DESCRIPTOR_PAGE_AP_RW_RW | \
217 TT_DESCRIPTOR_PAGE_XN_MASK | \
218 TT_DESCRIPTOR_PAGE_CACHE_POLICY_SHAREABLE_DEVICE)
219 #define TT_DESCRIPTOR_PAGE_UNCACHED (TT_DESCRIPTOR_PAGE_TYPE_PAGE | \
220 TT_DESCRIPTOR_PAGE_NG_GLOBAL | \
221 TT_DESCRIPTOR_PAGE_S_NOT_SHARED | \
222 TT_DESCRIPTOR_PAGE_AP_RW_RW | \
223 TT_DESCRIPTOR_PAGE_CACHE_POLICY_NON_CACHEABLE)
224
225 // First Level Descriptors
226 typedef UINT32 ARM_FIRST_LEVEL_DESCRIPTOR;
227
228 // Second Level Descriptors
229 typedef UINT32 ARM_PAGE_TABLE_ENTRY;
230
231 UINT32
232 ConvertSectionAttributesToPageAttributes (
233 IN UINT32 SectionAttributes,
234 IN BOOLEAN IsLargePage
235 );
236
237 #endif // ARMV7_MMU_H_