From: Taylor Beebe <tabe...@microsoft.com> Much of the MMU logic was written without function headers. This patch adds function headers where absent and updates function headers which do not match the EDK2 standard.
Cc: Leif Lindholm <quic_llind...@quicinc.com> Cc: Ard Biesheuvel <ardb+tianoc...@kernel.org> Signed-off-by: Taylor Beebe <t...@taylorbeebe.com> --- ArmPkg/Drivers/CpuDxe/AArch64/Mmu.c | 92 ++++++++++++++++++++++++++++- ArmPkg/Drivers/CpuDxe/Arm/Mmu.c | 86 ++++++++++++++++++++++++--- 2 files changed, 169 insertions(+), 9 deletions(-) diff --git a/ArmPkg/Drivers/CpuDxe/AArch64/Mmu.c b/ArmPkg/Drivers/CpuDxe/AArch64/Mmu.c index d9d386dbed6b..e14eb47ce4c6 100644 --- a/ArmPkg/Drivers/CpuDxe/AArch64/Mmu.c +++ b/ArmPkg/Drivers/CpuDxe/AArch64/Mmu.c @@ -18,6 +18,14 @@ SPDX-License-Identifier: BSD-2-Clause-Patent #define MIN_T0SZ 16 #define BITS_PER_LEVEL 9 +/** + Parses T0SZ to determine the level and number of entries at the root + of the translation table. + + @param T0SZ The T0SZ value to be parsed. + @param RootTableLevel The level of the root table. + @param RootTableEntryCount The number of entries in the root table. +**/ STATIC VOID GetRootTranslationTableInfo ( @@ -30,6 +38,13 @@ GetRootTranslationTableInfo ( *RootTableEntryCount = TT_ENTRY_COUNT >> (T0SZ - MIN_T0SZ) % BITS_PER_LEVEL; } +/** + Converts ARM translation table attributes to GCD attributes. + + @param PageAttributes The translation table attributes to be converted. + + @retval The analogous GCD attributes. +**/ STATIC UINT64 PageAttributeToGcdAttribute ( @@ -100,6 +115,14 @@ RegionAttributeToGcdAttribute ( return PageAttributeToGcdAttribute (PageAttributes); } +/** + Retrieves the attribute of the first page entry in the translation table. + + @param[in] FirstLevelTableAddress The base address of the translation table. + @param[in] TableLevel The current level being traversed. + + @retval The attributes of the first page entry found, or INVALID_ENTRY. +**/ STATIC UINT64 GetFirstPageAttribute ( @@ -126,6 +149,19 @@ GetFirstPageAttribute ( } } +/** + This function recursively traverses the translation table heirarchy to + synchronise the GCD with the translation table. + + @param[in] TableAddress The address of the table being processed. + @param[in] EntryCount The number of entries in the current level of the table. + @param[in] TableLevel The current level of the memory table being processed. + @param[in] BaseAddress The starting address of the region. + @param[in, out] PrevEntryAttribute The attributes of the previous region. + @param[in, out] StartGcdRegion The start of the GCD region. + + @retval The address at the end of the last region processed. +**/ STATIC UINT64 GetNextEntryAttribute ( @@ -220,6 +256,15 @@ GetNextEntryAttribute ( return BaseAddress + (EntryCount * TT_ADDRESS_AT_LEVEL (TableLevel)); } +/** + Sync the GCD memory space attributes with the translation table. + + @param[in] CpuProtocol The CPU architectural protocol instance. + + @retval EFI_SUCCESS The GCD memory space attributes are synced with + the MMU page table. + @retval Others The return value of GetMemorySpaceMap(). +**/ EFI_STATUS SyncCacheConfig ( IN EFI_CPU_ARCH_PROTOCOL *CpuProtocol @@ -298,6 +343,13 @@ SyncCacheConfig ( return EFI_SUCCESS; } +/** + Convert EFI memory attributes to ARM translation table attributes. + + @param[in] EfiAttributes EFI memory attributes. + + @retval The analogous translation table attributes. +**/ UINT64 EfiAttributeToArmAttribute ( IN UINT64 EfiAttributes @@ -345,8 +397,25 @@ EfiAttributeToArmAttribute ( return ArmAttributes; } -// This function will recursively go down the page table to find the first block address linked to 'BaseAddress'. -// And then the function will identify the size of the region that has the same page table attribute. +/** + This function returns the attributes of the memory region containing the + specified address. + + RegionLength and RegionAttributes are only valid if the result is EFI_SUCCESS. + + @param[in] TranslationTable The translation table base address. + @param[in] TableLevel The level of the translation table. + @param[in] LastBlockEntry The last block address of the table level. + @param[in, out] BaseAddress The base address of the memory region. + @param[out] RegionLength The length of the memory region. + @param[out] RegionAttributes The attributes of the memory region. + + @retval EFI_SUCCESS The attributes of the memory region were + returned successfully. + @retval EFI_NOT_FOUND The memory region was not found. + @retval EFI_NO_MAPPING The translation table entry associated with + BaseAddress is invalid. +**/ EFI_STATUS GetMemoryRegionRec ( IN UINT64 *TranslationTable, @@ -423,6 +492,25 @@ GetMemoryRegionRec ( return EFI_NOT_FOUND; } +/** + Retrieves a memory region from a given base address. + + This function retrieves a memory region starting from a given base address. + + @param[in, out] BaseAddress The base address from which to retrieve + the memory region. On successful return, this is + updated to the end address of the retrieved region. + @param[out] RegionLength The length of the retrieved memory region. + @param[out] RegionAttributes The attributes of the retrieved memory region. + + @retval EFI_STATUS Returns EFI_SUCCESS if the memory region is + retrieved successfully, or the status of the + recursive call to GetMemoryRegionRec. + @retval EFI_NOT_FOUND The memory region was not found. + @retval EFI_NO_MAPPING The translation table entry associated with + BaseAddress is invalid. + @retval EFI_INVALID_PARAMETER One of the input parameters was NULL. +**/ EFI_STATUS GetMemoryRegion ( IN OUT UINTN *BaseAddress, diff --git a/ArmPkg/Drivers/CpuDxe/Arm/Mmu.c b/ArmPkg/Drivers/CpuDxe/Arm/Mmu.c index 5a2f36d06086..8c4de284e160 100644 --- a/ArmPkg/Drivers/CpuDxe/Arm/Mmu.c +++ b/ArmPkg/Drivers/CpuDxe/Arm/Mmu.c @@ -17,9 +17,12 @@ SPDX-License-Identifier: BSD-2-Clause-Patent Convert a set of ARM short descriptor section attributes into a mask of EFI_MEMORY_xx constants. - @param SectionAttributes The set of page attributes. - @param GcdAttributes Pointer to the return value. + @param[in] SectionAttributes The set of page attributes. + @param[out] GcdAttributes Pointer to the return value. + @retval EFI_SUCCESS The attributes were converted successfully. + @retval EFI_UNSUPPORTED The section attributes did not have a + GCD transation. **/ STATIC EFI_STATUS @@ -87,10 +90,11 @@ SectionToGcdAttributes ( Convert an arch specific set of page attributes into a mask of EFI_MEMORY_xx constants. - @param PageAttributes The set of page attributes. - - @retval The mask of EFI_MEMORY_xx constants. + @param[in] PageAttributes The set of page attributes. + @retval EFI_SUCCESS The attributes were converted successfully. + @retval EFI_UNSUPPORTED The section attributes did not have a + GCD transation. **/ UINT64 RegionAttributeToGcdAttribute ( @@ -107,9 +111,11 @@ RegionAttributeToGcdAttribute ( Convert a set of ARM short descriptor page attributes into a mask of EFI_MEMORY_xx constants. - @param PageAttributes The set of page attributes. - @param GcdAttributes Pointer to the return value. + @param[in] PageAttributes The set of page attributes. + @param[out] GcdAttributes Pointer to the return value. + @retval EFI_SUCCESS The attributes were converted successfully. + @retval EFI_UNSUPPORTED The page attributes did not have a GCD transation. **/ STATIC EFI_STATUS @@ -173,6 +179,23 @@ PageToGcdAttributes ( return EFI_SUCCESS; } +/** + Synchronizes the GCD with the translation table for a specified page. + + This function synchronizes cache configuration for a given page based on its section index + and the first level descriptor. It traverses the second level table entries of the page and + updates the GCD attributes accordingly for each entry. + + @param[in] SectionIndex The index of the section where the page resides. + @param[in] FirstLevelDescriptor The first translation table level of the page. + @param[in] NumberOfDescriptors The number of descriptors in the GCD memory space map. + @param[in] MemorySpaceMap The GCD memory space descriptor. + @param[in, out] NextRegionBase The next region base address. + @param[in, out] NextRegionLength The next region length. + @param[in, out] NextSectionAttributes The next section attributes. + + @retval EFI_STATUS Always return success +**/ EFI_STATUS SyncCacheConfigPage ( IN UINT32 SectionIndex, @@ -258,6 +281,14 @@ SyncCacheConfigPage ( return EFI_SUCCESS; } +/** + Sync the GCD memory space attributes with the translation table. + + @param[in] CpuProtocol The CPU architectural protocol instance. + + @retval EFI_SUCCESS The GCD memory space attributes are synced with the MMU page table. + @retval Others The return value of GetMemorySpaceMap(). +**/ EFI_STATUS SyncCacheConfig ( IN EFI_CPU_ARCH_PROTOCOL *CpuProtocol @@ -395,6 +426,13 @@ SyncCacheConfig ( return EFI_SUCCESS; } +/** + Convert EFI memory attributes to ARM translation table attributes. + + @param[in] EfiAttributes EFI memory attributes. + + @retval The analogous translation table attributes. +**/ UINT64 EfiAttributeToArmAttribute ( IN UINT64 EfiAttributes @@ -448,6 +486,22 @@ EfiAttributeToArmAttribute ( return ArmAttributes; } +/** + This function finds the end of a memory region in a translation table. A + memory region is defined as a contiguous set of pages with the same attributes. + + @param[in] PageTable The translation table to traverse. + @param[in] BaseAddress The address from which to start the search + @param[in] RegionAttributes The attributes of the start of the region. + @param[out] RegionLength The length of the region found. + + @retval EFI_SUCCESS The region was found. + @retval EFI_NOT_FOUND The end of the region was not found. + @retval EFI_NO_MAPPING The region specified by BaseAddress is not mapped + in the input translation table. + @retval EFI_UNSUPPORTED Large pages are not supported. +**/ +STATIC EFI_STATUS GetMemoryRegionPage ( IN UINT32 *PageTable, @@ -496,6 +550,24 @@ GetMemoryRegionPage ( return Status; } +/** + Get the memory region that contains the specified address. A memory region is defined + as a contiguous set of pages with the same attributes. + + RegionLength and RegionAttributes are only valid if EFI_SUCCESS is returned. + + @param[in, out] BaseAddress On input, the address to search for. + On output, the base address of the region found. + @param[out] RegionLength The length of the region found. + @param[out] RegionAttributes The attributes of the region found. + + @retval EFI_SUCCESS Region found + @retval EFI_NOT_FOUND Region not found + @retval EFI_UNSUPPORTED Large pages are unsupported + @retval EFI_NO_MAPPING The page specified by BaseAddress is unmapped + @retval EFI_INVALID_PARAMETER The BaseAddress exceeds the addressable range of + the translation table. +**/ EFI_STATUS GetMemoryRegion ( IN OUT UINTN *BaseAddress, -- 2.41.0.windows.1 -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#106521): https://edk2.groups.io/g/devel/message/106521 Mute This Topic: https://groups.io/mt/99854268/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
