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