2 * File managing the MMU for ARMv8 architecture
4 * Copyright (c) 2011-2014, ARM Limited. All rights reserved.
6 * This program and the accompanying materials
7 * are licensed and made available under the terms and conditions of the BSD License
8 * which accompanies this distribution. The full text of the license may be found at
9 * http://opensource.org/licenses/bsd-license.php
11 * THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include <Chipset/AArch64.h>
18 #include <Library/BaseMemoryLib.h>
19 #include <Library/MemoryAllocationLib.h>
20 #include <Library/ArmLib.h>
21 #include <Library/BaseLib.h>
22 #include <Library/DebugLib.h>
23 #include "AArch64Lib.h"
24 #include "ArmLibPrivate.h"
26 // We use this index definition to define an invalid block entry
27 #define TT_ATTR_INDX_INVALID ((UINT32)~0)
31 ArmMemoryAttributeToPageAttribute (
32 IN ARM_MEMORY_REGION_ATTRIBUTES Attributes
36 case ARM_MEMORY_REGION_ATTRIBUTE_WRITE_BACK
:
37 return TT_ATTR_INDX_MEMORY_WRITE_BACK
;
38 case ARM_MEMORY_REGION_ATTRIBUTE_WRITE_THROUGH
:
39 return TT_ATTR_INDX_MEMORY_WRITE_THROUGH
;
40 case ARM_MEMORY_REGION_ATTRIBUTE_DEVICE
:
41 return TT_ATTR_INDX_DEVICE_MEMORY
;
42 case ARM_MEMORY_REGION_ATTRIBUTE_UNCACHED_UNBUFFERED
:
43 return TT_ATTR_INDX_MEMORY_NON_CACHEABLE
;
44 case ARM_MEMORY_REGION_ATTRIBUTE_NONSECURE_WRITE_BACK
:
45 return TT_ATTR_INDX_MEMORY_WRITE_BACK
;
46 case ARM_MEMORY_REGION_ATTRIBUTE_NONSECURE_WRITE_THROUGH
:
47 return TT_ATTR_INDX_MEMORY_WRITE_THROUGH
;
48 case ARM_MEMORY_REGION_ATTRIBUTE_NONSECURE_DEVICE
:
49 return TT_ATTR_INDX_DEVICE_MEMORY
;
50 case ARM_MEMORY_REGION_ATTRIBUTE_NONSECURE_UNCACHED_UNBUFFERED
:
51 return TT_ATTR_INDX_MEMORY_NON_CACHEABLE
;
54 return TT_ATTR_INDX_DEVICE_MEMORY
;
59 PageAttributeToGcdAttribute (
60 IN UINT64 PageAttributes
65 switch (PageAttributes
& TT_ATTR_INDX_MASK
) {
66 case TT_ATTR_INDX_DEVICE_MEMORY
:
67 GcdAttributes
= EFI_MEMORY_UC
;
69 case TT_ATTR_INDX_MEMORY_NON_CACHEABLE
:
70 GcdAttributes
= EFI_MEMORY_WC
;
72 case TT_ATTR_INDX_MEMORY_WRITE_THROUGH
:
73 GcdAttributes
= EFI_MEMORY_WT
;
75 case TT_ATTR_INDX_MEMORY_WRITE_BACK
:
76 GcdAttributes
= EFI_MEMORY_WB
;
79 DEBUG ((EFI_D_ERROR
, "PageAttributeToGcdAttribute: PageAttributes:0x%lX not supported.\n", PageAttributes
));
81 // The Global Coherency Domain (GCD) value is defined as a bit set.
82 // Returning 0 means no attribute has been set.
86 // Determine protection attributes
87 if (((PageAttributes
& TT_AP_MASK
) == TT_AP_NO_RO
) || ((PageAttributes
& TT_AP_MASK
) == TT_AP_RO_RO
)) {
88 // Read only cases map to write-protect
89 GcdAttributes
|= EFI_MEMORY_WP
;
92 // Process eXecute Never attribute
93 if ((PageAttributes
& (TT_PXN_MASK
| TT_UXN_MASK
)) != 0 ) {
94 GcdAttributes
|= EFI_MEMORY_XP
;
101 GcdAttributeToPageAttribute (
102 IN UINT64 GcdAttributes
105 UINT64 PageAttributes
;
107 switch (GcdAttributes
& 0xFF) {
109 PageAttributes
= TT_ATTR_INDX_DEVICE_MEMORY
;
112 PageAttributes
= TT_ATTR_INDX_MEMORY_NON_CACHEABLE
;
115 PageAttributes
= TT_ATTR_INDX_MEMORY_WRITE_THROUGH
;
118 PageAttributes
= TT_ATTR_INDX_MEMORY_WRITE_BACK
;
121 DEBUG ((EFI_D_ERROR
, "GcdAttributeToPageAttribute: 0x%X attributes is not supported.\n", GcdAttributes
));
123 // If no match has been found then we mark the memory as device memory.
124 // The only side effect of using device memory should be a slow down in the performance.
125 PageAttributes
= TT_ATTR_INDX_DEVICE_MEMORY
;
128 // Determine protection attributes
129 if (GcdAttributes
& EFI_MEMORY_WP
) {
130 // Read only cases map to write-protect
131 PageAttributes
|= TT_AP_RO_RO
;
134 // Process eXecute Never attribute
135 if (GcdAttributes
& EFI_MEMORY_XP
) {
136 PageAttributes
|= (TT_PXN_MASK
| TT_UXN_MASK
);
139 return PageAttributes
;
142 ARM_MEMORY_REGION_ATTRIBUTES
143 GcdAttributeToArmAttribute (
144 IN UINT64 GcdAttributes
147 switch (GcdAttributes
& 0xFF) {
149 return ARM_MEMORY_REGION_ATTRIBUTE_DEVICE
;
151 return ARM_MEMORY_REGION_ATTRIBUTE_UNCACHED_UNBUFFERED
;
153 return ARM_MEMORY_REGION_ATTRIBUTE_WRITE_THROUGH
;
155 return ARM_MEMORY_REGION_ATTRIBUTE_WRITE_BACK
;
157 DEBUG ((EFI_D_ERROR
, "GcdAttributeToArmAttribute: 0x%lX attributes is not supported.\n", GcdAttributes
));
159 return ARM_MEMORY_REGION_ATTRIBUTE_DEVICE
;
163 // Describe the T0SZ values for each translation table level
167 UINTN LargestT0SZ
; // Generally (MaxT0SZ == LargestT0SZ) but at the Level3 Table
168 // the MaxT0SZ is not at the boundary of the table
169 } T0SZ_DESCRIPTION_PER_LEVEL
;
171 // Map table for the corresponding Level of Table
172 STATIC CONST T0SZ_DESCRIPTION_PER_LEVEL T0SZPerTableLevel
[] = {
173 { 16, 24, 24 }, // Table Level 0
174 { 25, 33, 33 }, // Table Level 1
175 { 34, 39, 42 } // Table Level 2
179 GetRootTranslationTableInfo (
181 OUT UINTN
*TableLevel
,
182 OUT UINTN
*TableEntryCount
187 // Identify the level of the root table from the given T0SZ
188 for (Index
= 0; Index
< sizeof (T0SZPerTableLevel
) / sizeof (T0SZ_DESCRIPTION_PER_LEVEL
); Index
++) {
189 if (T0SZ
<= T0SZPerTableLevel
[Index
].MaxT0SZ
) {
194 // If we have not found the corresponding maximum T0SZ then we use the last one
195 if (Index
== sizeof (T0SZPerTableLevel
) / sizeof (T0SZ_DESCRIPTION_PER_LEVEL
)) {
199 // Get the level of the root table
204 // The Size of the Table is 2^(T0SZ-LargestT0SZ)
205 if (TableEntryCount
) {
206 *TableEntryCount
= 1 << (T0SZPerTableLevel
[Index
].LargestT0SZ
- T0SZ
+ 1);
212 LookupAddresstoRootTable (
213 IN UINT64 MaxAddress
,
215 OUT UINTN
*TableEntryCount
220 // Check the parameters are not NULL
221 ASSERT ((T0SZ
!= NULL
) && (TableEntryCount
!= NULL
));
223 // Look for the highest bit set in MaxAddress
224 for (TopBit
= 63; TopBit
!= 0; TopBit
--) {
225 if ((1ULL << TopBit
) & MaxAddress
) {
226 // MaxAddress top bit is found
231 ASSERT (TopBit
!= 0);
233 // Calculate T0SZ from the top bit of the MaxAddress
236 // Get the Table info from T0SZ
237 GetRootTranslationTableInfo (*T0SZ
, NULL
, TableEntryCount
);
242 GetBlockEntryListFromAddress (
243 IN UINT64
*RootTable
,
244 IN UINT64 RegionStart
,
245 OUT UINTN
*TableLevel
,
246 IN OUT UINT64
*BlockEntrySize
,
247 IN OUT UINT64
**LastBlockEntry
250 UINTN RootTableLevel
;
251 UINTN RootTableEntryCount
;
252 UINT64
*TranslationTable
;
254 UINT64 BlockEntryAddress
;
255 UINTN BaseAddressAlignment
;
261 UINT64 TableAttributes
;
263 // Initialize variable
266 // Ensure the parameters are valid
267 if (!(TableLevel
&& BlockEntrySize
&& LastBlockEntry
)) {
268 ASSERT_EFI_ERROR (EFI_INVALID_PARAMETER
);
272 // Ensure the Region is aligned on 4KB boundary
273 if ((RegionStart
& (SIZE_4KB
- 1)) != 0) {
274 ASSERT_EFI_ERROR (EFI_INVALID_PARAMETER
);
278 // Ensure the required size is aligned on 4KB boundary
279 if ((*BlockEntrySize
& (SIZE_4KB
- 1)) != 0) {
280 ASSERT_EFI_ERROR (EFI_INVALID_PARAMETER
);
285 // Calculate LastBlockEntry from T0SZ - this is the last block entry of the root Translation table
287 T0SZ
= ArmGetTCR () & TCR_T0SZ_MASK
;
288 // Get the Table info from T0SZ
289 GetRootTranslationTableInfo (T0SZ
, &RootTableLevel
, &RootTableEntryCount
);
290 // The last block of the root table depends on the number of entry in this table
291 *LastBlockEntry
= TT_LAST_BLOCK_ADDRESS(RootTable
, RootTableEntryCount
);
293 // If the start address is 0x0 then we use the size of the region to identify the alignment
294 if (RegionStart
== 0) {
295 // Identify the highest possible alignment for the Region Size
296 for (BaseAddressAlignment
= 0; BaseAddressAlignment
< 64; BaseAddressAlignment
++) {
297 if ((1 << BaseAddressAlignment
) & *BlockEntrySize
) {
302 // Identify the highest possible alignment for the Base Address
303 for (BaseAddressAlignment
= 0; BaseAddressAlignment
< 64; BaseAddressAlignment
++) {
304 if ((1 << BaseAddressAlignment
) & RegionStart
) {
310 // Identify the Page Level the RegionStart must belongs to
311 PageLevel
= 3 - ((BaseAddressAlignment
- 12) / 9);
313 // If the required size is smaller than the current block size then we need to go to the page below.
314 // The PageLevel was calculated on the Base Address alignment but did not take in account the alignment
315 // of the allocation size
316 if (*BlockEntrySize
< TT_BLOCK_ENTRY_SIZE_AT_LEVEL (PageLevel
)) {
317 // It does not fit so we need to go a page level above
321 // Expose the found PageLevel to the caller
322 *TableLevel
= PageLevel
;
324 // Now, we have the Table Level we can get the Block Size associated to this table
325 *BlockEntrySize
= TT_BLOCK_ENTRY_SIZE_AT_LEVEL (PageLevel
);
328 // Get the Table Descriptor for the corresponding PageLevel. We need to decompose RegionStart to get appropriate entries
331 TranslationTable
= RootTable
;
332 for (IndexLevel
= RootTableLevel
; IndexLevel
<= PageLevel
; IndexLevel
++) {
333 BlockEntry
= (UINT64
*)TT_GET_ENTRY_FOR_ADDRESS (TranslationTable
, IndexLevel
, RegionStart
);
335 if ((IndexLevel
!= 3) && ((*BlockEntry
& TT_TYPE_MASK
) == TT_TYPE_TABLE_ENTRY
)) {
336 // Go to the next table
337 TranslationTable
= (UINT64
*)(*BlockEntry
& TT_ADDRESS_MASK_DESCRIPTION_TABLE
);
339 // If we are at the last level then update the output
340 if (IndexLevel
== PageLevel
) {
341 // And get the appropriate BlockEntry at the next level
342 BlockEntry
= (UINT64
*)TT_GET_ENTRY_FOR_ADDRESS (TranslationTable
, IndexLevel
+ 1, RegionStart
);
344 // Set the last block for this new table
345 *LastBlockEntry
= TT_LAST_BLOCK_ADDRESS(TranslationTable
, TT_ENTRY_COUNT
);
347 } else if ((*BlockEntry
& TT_TYPE_MASK
) == TT_TYPE_BLOCK_ENTRY
) {
348 // If we are not at the last level then we need to split this BlockEntry
349 if (IndexLevel
!= PageLevel
) {
350 // Retrieve the attributes from the block entry
351 Attributes
= *BlockEntry
& TT_ATTRIBUTES_MASK
;
353 // Convert the block entry attributes into Table descriptor attributes
354 TableAttributes
= TT_TABLE_AP_NO_PERMISSION
;
355 if (Attributes
& TT_PXN_MASK
) {
356 TableAttributes
= TT_TABLE_PXN
;
358 if (Attributes
& TT_UXN_MASK
) {
359 TableAttributes
= TT_TABLE_XN
;
361 if (Attributes
& TT_NS
) {
362 TableAttributes
= TT_TABLE_NS
;
365 // Get the address corresponding at this entry
366 BlockEntryAddress
= RegionStart
;
367 BlockEntryAddress
= BlockEntryAddress
>> TT_ADDRESS_OFFSET_AT_LEVEL(IndexLevel
);
368 // Shift back to right to set zero before the effective address
369 BlockEntryAddress
= BlockEntryAddress
<< TT_ADDRESS_OFFSET_AT_LEVEL(IndexLevel
);
371 // Set the correct entry type for the next page level
372 if ((IndexLevel
+ 1) == 3) {
373 Attributes
|= TT_TYPE_BLOCK_ENTRY_LEVEL3
;
375 Attributes
|= TT_TYPE_BLOCK_ENTRY
;
378 // Create a new translation table
379 TranslationTable
= (UINT64
*)AllocatePages (EFI_SIZE_TO_PAGES((TT_ENTRY_COUNT
* sizeof(UINT64
)) + TT_ALIGNMENT_DESCRIPTION_TABLE
));
380 if (TranslationTable
== NULL
) {
383 TranslationTable
= (UINT64
*)((UINTN
)TranslationTable
& TT_ADDRESS_MASK_DESCRIPTION_TABLE
);
385 // Fill the BlockEntry with the new TranslationTable
386 *BlockEntry
= ((UINTN
)TranslationTable
& TT_ADDRESS_MASK_DESCRIPTION_TABLE
) | TableAttributes
| TT_TYPE_TABLE_ENTRY
;
387 // Update the last block entry with the newly created translation table
388 *LastBlockEntry
= TT_LAST_BLOCK_ADDRESS(TranslationTable
, TT_ENTRY_COUNT
);
390 // Populate the newly created lower level table
391 BlockEntry
= TranslationTable
;
392 for (Index
= 0; Index
< TT_ENTRY_COUNT
; Index
++) {
393 *BlockEntry
= Attributes
| (BlockEntryAddress
+ (Index
<< TT_ADDRESS_OFFSET_AT_LEVEL(IndexLevel
+ 1)));
396 // Block Entry points at the beginning of the Translation Table
397 BlockEntry
= TranslationTable
;
400 if (IndexLevel
!= PageLevel
) {
402 // Case when we have an Invalid Entry and we are at a page level above of the one targetted.
405 // Create a new translation table
406 TranslationTable
= (UINT64
*)AllocatePages (EFI_SIZE_TO_PAGES((TT_ENTRY_COUNT
* sizeof(UINT64
)) + TT_ALIGNMENT_DESCRIPTION_TABLE
));
407 if (TranslationTable
== NULL
) {
410 TranslationTable
= (UINT64
*)((UINTN
)TranslationTable
& TT_ADDRESS_MASK_DESCRIPTION_TABLE
);
412 ZeroMem (TranslationTable
, TT_ENTRY_COUNT
* sizeof(UINT64
));
414 // Fill the new BlockEntry with the TranslationTable
415 *BlockEntry
= ((UINTN
)TranslationTable
& TT_ADDRESS_MASK_DESCRIPTION_TABLE
) | TT_TYPE_TABLE_ENTRY
;
416 // Update the last block entry with the newly created translation table
417 *LastBlockEntry
= TT_LAST_BLOCK_ADDRESS(TranslationTable
, TT_ENTRY_COUNT
);
420 // Case when the new region is part of an existing page table
422 *LastBlockEntry
= TT_LAST_BLOCK_ADDRESS(TranslationTable
, TT_ENTRY_COUNT
);
432 FillTranslationTable (
433 IN UINT64
*RootTable
,
434 IN ARM_MEMORY_REGION_DESCRIPTOR
*MemoryRegion
440 UINT64 RemainingRegionLength
;
442 UINT64
*LastBlockEntry
;
443 UINT64 BlockEntrySize
;
446 // Ensure the Length is aligned on 4KB boundary
447 if ((MemoryRegion
->Length
== 0) || ((MemoryRegion
->Length
& (SIZE_4KB
- 1)) != 0)) {
448 ASSERT_EFI_ERROR (EFI_INVALID_PARAMETER
);
449 return RETURN_INVALID_PARAMETER
;
452 // Variable initialization
453 Attributes
= ArmMemoryAttributeToPageAttribute (MemoryRegion
->Attributes
) | TT_AF
;
454 RemainingRegionLength
= MemoryRegion
->Length
;
455 RegionStart
= MemoryRegion
->VirtualBase
;
458 // Get the first Block Entry that matches the Virtual Address and also the information on the Table Descriptor
459 // such as the the size of the Block Entry and the address of the last BlockEntry of the Table Descriptor
460 BlockEntrySize
= RemainingRegionLength
;
461 BlockEntry
= GetBlockEntryListFromAddress (RootTable
, RegionStart
, &TableLevel
, &BlockEntrySize
, &LastBlockEntry
);
462 if (BlockEntry
== NULL
) {
463 // GetBlockEntryListFromAddress() return NULL when it fails to allocate new pages from the Translation Tables
464 return RETURN_OUT_OF_RESOURCES
;
467 if (TableLevel
!= 3) {
468 Type
= TT_TYPE_BLOCK_ENTRY
;
470 Type
= TT_TYPE_BLOCK_ENTRY_LEVEL3
;
474 // Fill the Block Entry with attribute and output block address
475 *BlockEntry
= (RegionStart
& TT_ADDRESS_MASK_BLOCK_ENTRY
) | Attributes
| Type
;
477 // Go to the next BlockEntry
478 RegionStart
+= BlockEntrySize
;
479 RemainingRegionLength
-= BlockEntrySize
;
481 } while ((RemainingRegionLength
>= BlockEntrySize
) && (BlockEntry
<= LastBlockEntry
));
482 } while (RemainingRegionLength
!= 0);
484 return RETURN_SUCCESS
;
488 SetMemoryAttributes (
489 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
491 IN UINT64 Attributes
,
492 IN EFI_PHYSICAL_ADDRESS VirtualMask
495 RETURN_STATUS Status
;
496 ARM_MEMORY_REGION_DESCRIPTOR MemoryRegion
;
497 UINT64
*TranslationTable
;
499 MemoryRegion
.PhysicalBase
= BaseAddress
;
500 MemoryRegion
.VirtualBase
= BaseAddress
;
501 MemoryRegion
.Length
= Length
;
502 MemoryRegion
.Attributes
= GcdAttributeToArmAttribute (Attributes
);
504 TranslationTable
= ArmGetTTBR0BaseAddress ();
506 Status
= FillTranslationTable (TranslationTable
, &MemoryRegion
);
507 if (RETURN_ERROR (Status
)) {
511 // Flush d-cache so descriptors make it back to uncached memory for subsequent table walks
512 // flush and invalidate pages
513 ArmCleanInvalidateDataCache ();
515 ArmInvalidateInstructionCache ();
517 // Invalidate all TLB entries so changes are synced
520 return RETURN_SUCCESS
;
526 IN ARM_MEMORY_REGION_DESCRIPTOR
*MemoryTable
,
527 OUT VOID
**TranslationTableBase OPTIONAL
,
528 OUT UINTN
*TranslationTableSize OPTIONAL
531 VOID
* TranslationTable
;
532 UINTN TranslationTablePageCount
;
533 UINT32 TranslationTableAttribute
;
534 ARM_MEMORY_REGION_DESCRIPTOR
*MemoryTableEntry
;
538 UINTN RootTableEntryCount
;
540 RETURN_STATUS Status
;
542 if(MemoryTable
== NULL
) {
543 ASSERT (MemoryTable
!= NULL
);
544 return RETURN_INVALID_PARAMETER
;
547 // Identify the highest address of the memory table
548 MaxAddress
= MemoryTable
->PhysicalBase
+ MemoryTable
->Length
- 1;
549 MemoryTableEntry
= MemoryTable
;
550 while (MemoryTableEntry
->Length
!= 0) {
551 TopAddress
= MemoryTableEntry
->PhysicalBase
+ MemoryTableEntry
->Length
- 1;
552 if (TopAddress
> MaxAddress
) {
553 MaxAddress
= TopAddress
;
558 // Lookup the Table Level to get the information
559 LookupAddresstoRootTable (MaxAddress
, &T0SZ
, &RootTableEntryCount
);
562 // Set TCR that allows us to retrieve T0SZ in the subsequent functions
564 // Ideally we will be running at EL2, but should support EL1 as well.
565 // UEFI should not run at EL3.
566 if (ArmReadCurrentEL () == AARCH64_EL2
) {
567 //Note: Bits 23 and 31 are reserved(RES1) bits in TCR_EL2
568 TCR
= T0SZ
| (1UL << 31) | (1UL << 23) | TCR_TG0_4KB
;
570 // Set the Physical Address Size using MaxAddress
571 if (MaxAddress
< SIZE_4GB
) {
573 } else if (MaxAddress
< SIZE_64GB
) {
575 } else if (MaxAddress
< SIZE_1TB
) {
577 } else if (MaxAddress
< SIZE_4TB
) {
579 } else if (MaxAddress
< SIZE_16TB
) {
581 } else if (MaxAddress
< SIZE_256TB
) {
584 DEBUG ((EFI_D_ERROR
, "ArmConfigureMmu: The MaxAddress 0x%lX is not supported by this MMU configuration.\n", MaxAddress
));
585 ASSERT (0); // Bigger than 48-bit memory space are not supported
586 return RETURN_UNSUPPORTED
;
588 } else if (ArmReadCurrentEL () == AARCH64_EL1
) {
589 TCR
= T0SZ
| TCR_TG0_4KB
;
591 // Set the Physical Address Size using MaxAddress
592 if (MaxAddress
< SIZE_4GB
) {
594 } else if (MaxAddress
< SIZE_64GB
) {
596 } else if (MaxAddress
< SIZE_1TB
) {
598 } else if (MaxAddress
< SIZE_4TB
) {
600 } else if (MaxAddress
< SIZE_16TB
) {
602 } else if (MaxAddress
< SIZE_256TB
) {
603 TCR
|= TCR_IPS_256TB
;
605 DEBUG ((EFI_D_ERROR
, "ArmConfigureMmu: The MaxAddress 0x%lX is not supported by this MMU configuration.\n", MaxAddress
));
606 ASSERT (0); // Bigger than 48-bit memory space are not supported
607 return RETURN_UNSUPPORTED
;
610 ASSERT (0); // UEFI is only expected to run at EL2 and EL1, not EL3.
611 return RETURN_UNSUPPORTED
;
617 // Allocate pages for translation table
618 TranslationTablePageCount
= EFI_SIZE_TO_PAGES((RootTableEntryCount
* sizeof(UINT64
)) + TT_ALIGNMENT_DESCRIPTION_TABLE
);
619 TranslationTable
= AllocatePages (TranslationTablePageCount
);
620 if (TranslationTable
== NULL
) {
621 return RETURN_OUT_OF_RESOURCES
;
623 TranslationTable
= (VOID
*)((UINTN
)TranslationTable
& TT_ADDRESS_MASK_DESCRIPTION_TABLE
);
624 // We set TTBR0 just after allocating the table to retrieve its location from the subsequent
625 // functions without needing to pass this value across the functions. The MMU is only enabled
626 // after the translation tables are populated.
627 ArmSetTTBR0 (TranslationTable
);
629 if (TranslationTableBase
!= NULL
) {
630 *TranslationTableBase
= TranslationTable
;
633 if (TranslationTableSize
!= NULL
) {
634 *TranslationTableSize
= RootTableEntryCount
* sizeof(UINT64
);
637 ZeroMem (TranslationTable
, RootTableEntryCount
* sizeof(UINT64
));
639 // Disable MMU and caches. ArmDisableMmu() also invalidates the TLBs
641 ArmDisableDataCache ();
642 ArmDisableInstructionCache ();
644 // Make sure nothing sneaked into the cache
645 ArmCleanInvalidateDataCache ();
646 ArmInvalidateInstructionCache ();
648 TranslationTableAttribute
= TT_ATTR_INDX_INVALID
;
649 while (MemoryTable
->Length
!= 0) {
650 // Find the memory attribute for the Translation Table
651 if (((UINTN
)TranslationTable
>= MemoryTable
->PhysicalBase
) &&
652 ((UINTN
)TranslationTable
<= MemoryTable
->PhysicalBase
- 1 + MemoryTable
->Length
)) {
653 TranslationTableAttribute
= MemoryTable
->Attributes
;
656 Status
= FillTranslationTable (TranslationTable
, MemoryTable
);
657 if (RETURN_ERROR (Status
)) {
658 goto FREE_TRANSLATION_TABLE
;
663 // Translate the Memory Attributes into Translation Table Register Attributes
664 if ((TranslationTableAttribute
== ARM_MEMORY_REGION_ATTRIBUTE_UNCACHED_UNBUFFERED
) ||
665 (TranslationTableAttribute
== ARM_MEMORY_REGION_ATTRIBUTE_NONSECURE_UNCACHED_UNBUFFERED
)) {
666 TCR
|= TCR_SH_NON_SHAREABLE
| TCR_RGN_OUTER_NON_CACHEABLE
| TCR_RGN_INNER_NON_CACHEABLE
;
667 } else if ((TranslationTableAttribute
== ARM_MEMORY_REGION_ATTRIBUTE_WRITE_BACK
) ||
668 (TranslationTableAttribute
== ARM_MEMORY_REGION_ATTRIBUTE_NONSECURE_WRITE_BACK
)) {
669 TCR
|= TCR_SH_INNER_SHAREABLE
| TCR_RGN_OUTER_WRITE_BACK_ALLOC
| TCR_RGN_INNER_WRITE_BACK_ALLOC
;
670 } else if ((TranslationTableAttribute
== ARM_MEMORY_REGION_ATTRIBUTE_WRITE_THROUGH
) ||
671 (TranslationTableAttribute
== ARM_MEMORY_REGION_ATTRIBUTE_NONSECURE_WRITE_THROUGH
)) {
672 TCR
|= TCR_SH_NON_SHAREABLE
| TCR_RGN_OUTER_WRITE_THROUGH
| TCR_RGN_INNER_WRITE_THROUGH
;
674 // If we failed to find a mapping that contains the root translation table then it probably means the translation table
675 // is not mapped in the given memory map.
677 Status
= RETURN_UNSUPPORTED
;
678 goto FREE_TRANSLATION_TABLE
;
681 // Set again TCR after getting the Translation Table attributes
684 ArmSetMAIR (MAIR_ATTR(TT_ATTR_INDX_DEVICE_MEMORY
, MAIR_ATTR_DEVICE_MEMORY
) | // mapped to EFI_MEMORY_UC
685 MAIR_ATTR(TT_ATTR_INDX_MEMORY_NON_CACHEABLE
, MAIR_ATTR_NORMAL_MEMORY_NON_CACHEABLE
) | // mapped to EFI_MEMORY_WC
686 MAIR_ATTR(TT_ATTR_INDX_MEMORY_WRITE_THROUGH
, MAIR_ATTR_NORMAL_MEMORY_WRITE_THROUGH
) | // mapped to EFI_MEMORY_WT
687 MAIR_ATTR(TT_ATTR_INDX_MEMORY_WRITE_BACK
, MAIR_ATTR_NORMAL_MEMORY_WRITE_BACK
)); // mapped to EFI_MEMORY_WB
689 ArmDisableAlignmentCheck ();
690 ArmEnableInstructionCache ();
691 ArmEnableDataCache ();
694 return RETURN_SUCCESS
;
696 FREE_TRANSLATION_TABLE
:
697 FreePages (TranslationTable
, TranslationTablePageCount
);