From 734b795b4f04ef9147cf7242e196c8c607ac06dd Mon Sep 17 00:00:00 2001 From: Levi Yun Date: Thu, 26 Sep 2024 14:23:01 +0100 Subject: [PATCH] StandaloneMmPkg: introduce StandaloneMmExtractGuidedSectionLib The default ExtractGuidedSectionLib used by Standalone MM is the implementation in EmbeddedPkg. However, the ExtractGuidedSectionLib implementation in EmbeddedPkg builds HOBs to save the extract handler information. Since StandaloneMm is consumer of HOB, not a HOB producer, introduce a StandaloneMmExtraGuidedSectionLib implementation that saves the extract handler information in the ConfigurationTable. This StandaloneMmExtraGuidedSectionLib can be used by MM_STANDALONE and MM_CORE_STANDALONE modules. Signed-off-by: Levi Yun --- .../StandaloneMmExtractGuidedSectionLib.c | 406 ++++++++++++++++++ .../StandaloneMmExtractGuidedSectionLib.inf | 37 ++ StandaloneMmPkg/StandaloneMmPkg.dec | 1 + StandaloneMmPkg/StandaloneMmPkg.dsc | 3 +- 4 files changed, 446 insertions(+), 1 deletion(-) create mode 100644 StandaloneMmPkg/Library/StandaloneMmExtractGuidedSectionLib/StandaloneMmExtractGuidedSectionLib.c create mode 100644 StandaloneMmPkg/Library/StandaloneMmExtractGuidedSectionLib/StandaloneMmExtractGuidedSectionLib.inf diff --git a/StandaloneMmPkg/Library/StandaloneMmExtractGuidedSectionLib/StandaloneMmExtractGuidedSectionLib.c b/StandaloneMmPkg/Library/StandaloneMmExtractGuidedSectionLib/StandaloneMmExtractGuidedSectionLib.c new file mode 100644 index 000000000000..610527a7e016 --- /dev/null +++ b/StandaloneMmPkg/Library/StandaloneMmExtractGuidedSectionLib/StandaloneMmExtractGuidedSectionLib.c @@ -0,0 +1,406 @@ +/** @file + + Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.
+ Copyright (c) 2024, Arm Ltd. All rights reserved.
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include +#include + +#include +#include +#include +#include +#include +#include + +/** + Extract guided section handler info. + */ +typedef struct { + /// Number of handlers. + UINT32 NumberOfExtractHandler; + + /// Padding. + UINT32 Padding; + + /// Guid table of handlers + GUID *ExtractHandlerGuidTable; + + /// Handler table for decoding correspond guided section. + EXTRACT_GUIDED_SECTION_DECODE_HANDLER *ExtractDecodeHandlerTable; + + /// Handler table for getting information about correspond guided section. + EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *ExtractGetInfoHandlerTable; +} EXTRACT_GUIDED_SECTION_HANDLER_INFO; + +STATIC EXTRACT_GUIDED_SECTION_HANDLER_INFO *mHandlerInfo; + +/** + Registers handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and EXTRACT_GUIDED_SECTION_DECODE_HANDLER + for a specific GUID section type. + + Registers the handlers specified by GetInfoHandler and DecodeHandler with the GUID specified by SectionGuid. + If the GUID value specified by SectionGuid has already been registered, then return RETURN_ALREADY_STARTED. + If there are not enough resources available to register the handlers then RETURN_OUT_OF_RESOURCES is returned. + + If SectionGuid is NULL, then ASSERT(). + If GetInfoHandler is NULL, then ASSERT(). + If DecodeHandler is NULL, then ASSERT(). + + @param[in] SectionGuid A pointer to the GUID associated with the the handlers + of the GUIDed section type being registered. + @param[in] GetInfoHandler Pointer to a function that examines a GUIDed section and returns the + size of the decoded buffer and the size of an optional scratch buffer + required to actually decode the data in a GUIDed section. + @param[in] DecodeHandler Pointer to a function that decodes a GUIDed section into a caller + allocated output buffer. + + @retval RETURN_SUCCESS The handlers were registered. + @retval RETURN_OUT_OF_RESOURCES There are not enough resources available to register the handlers. + +**/ +RETURN_STATUS +EFIAPI +ExtractGuidedSectionRegisterHandlers ( + IN CONST GUID *SectionGuid, + IN EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER GetInfoHandler, + IN EXTRACT_GUIDED_SECTION_DECODE_HANDLER DecodeHandler + ) +{ + UINT32 Index; + + // + // Check input parameter. + // + if (SectionGuid == NULL) { + return RETURN_INVALID_PARAMETER; + } + + if (mHandlerInfo == NULL) { + return RETURN_NOT_READY; + } + + // + // Search the match registered GetInfo handler for the input guided section. + // + for (Index = 0; Index < mHandlerInfo->NumberOfExtractHandler; Index++) { + if (CompareGuid (&mHandlerInfo->ExtractHandlerGuidTable[Index], SectionGuid)) { + break; + } + } + + // + // If the guided handler has been registered before, only update its handler. + // + if (Index < mHandlerInfo->NumberOfExtractHandler) { + mHandlerInfo->ExtractDecodeHandlerTable[Index] = DecodeHandler; + mHandlerInfo->ExtractGetInfoHandlerTable[Index] = GetInfoHandler; + return RETURN_SUCCESS; + } + + // + // Check the global table is enough to contain new Handler. + // + if (mHandlerInfo->NumberOfExtractHandler >= PcdGet32 (PcdMaximumGuidedExtractHandler)) { + return RETURN_OUT_OF_RESOURCES; + } + + // + // Register new Handler and guid value. + // + CopyGuid (&mHandlerInfo->ExtractHandlerGuidTable[mHandlerInfo->NumberOfExtractHandler], SectionGuid); + mHandlerInfo->ExtractDecodeHandlerTable[mHandlerInfo->NumberOfExtractHandler] = DecodeHandler; + mHandlerInfo->ExtractGetInfoHandlerTable[mHandlerInfo->NumberOfExtractHandler++] = GetInfoHandler; + + return RETURN_SUCCESS; +} + +/** + Retrieve the list GUIDs that have been registered through ExtractGuidedSectionRegisterHandlers(). + + Sets ExtractHandlerGuidTable so it points at a callee allocated array of registered GUIDs. + The total number of GUIDs in the array are returned. Since the array of GUIDs is callee allocated + and caller must treat this array of GUIDs as read-only data. + If ExtractHandlerGuidTable is NULL, then ASSERT(). + + @param[out] ExtractHandlerGuidTable A pointer to the array of GUIDs that have been registered through + ExtractGuidedSectionRegisterHandlers(). + + @return the number of the supported extract guided Handler. + +**/ +UINTN +EFIAPI +ExtractGuidedSectionGetGuidList ( + IN OUT GUID **ExtractHandlerGuidTable + ) +{ + ASSERT (ExtractHandlerGuidTable != NULL); + ASSERT (mHandlerInfo != NULL); + + *ExtractHandlerGuidTable = mHandlerInfo->ExtractHandlerGuidTable; + + return mHandlerInfo->NumberOfExtractHandler; +} + +/** + Retrieves a GUID from a GUIDed section and uses that GUID to select an associated handler of type + EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers(). + The selected handler is used to retrieve and return the size of the decoded buffer and the size of an + optional scratch buffer required to actually decode the data in a GUIDed section. + + Examines a GUIDed section specified by InputSection. + If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(), + then RETURN_UNSUPPORTED is returned. + If the GUID of InputSection does match the GUID that this handler supports, then the the associated handler + of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers() + is used to retrieve the OututBufferSize, ScratchSize, and Attributes values. The return status from the handler of + type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER is returned. + + If InputSection is NULL, then ASSERT(). + If OutputBufferSize is NULL, then ASSERT(). + If ScratchBufferSize is NULL, then ASSERT(). + If SectionAttribute is NULL, then ASSERT(). + + @param[in] InputSection A pointer to a GUIDed section of an FFS formatted file. + @param[out] OutputBufferSize A pointer to the size, in bytes, of an output buffer required if the buffer + specified by InputSection were decoded. + @param[out] ScratchBufferSize A pointer to the size, in bytes, required as scratch space if the buffer specified by + InputSection were decoded. + @param[out] SectionAttribute A pointer to the attributes of the GUIDed section. See the Attributes field of + EFI_GUID_DEFINED_SECTION in the PI Specification. + + @retval RETURN_SUCCESS Get the required information successfully. + @retval RETURN_UNSUPPORTED The GUID from the section specified by InputSection does not match any of + the GUIDs registered with ExtractGuidedSectionRegisterHandlers(). + @retval Others The return status from the handler associated with the GUID retrieved from + the section specified by InputSection. + +**/ +RETURN_STATUS +EFIAPI +ExtractGuidedSectionGetInfo ( + IN CONST VOID *InputSection, + OUT UINT32 *OutputBufferSize, + OUT UINT32 *ScratchBufferSize, + OUT UINT16 *SectionAttribute + ) +{ + UINT32 Index; + EFI_GUID *SectionDefinitionGuid; + + if (InputSection == NULL) { + return RETURN_INVALID_PARAMETER; + } + + ASSERT (OutputBufferSize != NULL); + ASSERT (ScratchBufferSize != NULL); + ASSERT (SectionAttribute != NULL); + + if (IS_SECTION2 (InputSection)) { + SectionDefinitionGuid = &(((EFI_GUID_DEFINED_SECTION2 *)InputSection)->SectionDefinitionGuid); + } else { + SectionDefinitionGuid = &(((EFI_GUID_DEFINED_SECTION *)InputSection)->SectionDefinitionGuid); + } + + // + // Search the match registered GetInfo handler for the input guided section. + // + for (Index = 0; Index < mHandlerInfo->NumberOfExtractHandler; Index++) { + if (CompareGuid (&mHandlerInfo->ExtractHandlerGuidTable[Index], SectionDefinitionGuid)) { + break; + } + } + + // + // Not found, the input guided section is not supported. + // + if (Index == mHandlerInfo->NumberOfExtractHandler) { + return RETURN_INVALID_PARAMETER; + } + + // + // Call the match handler to getinfo for the input section data. + // + return mHandlerInfo->ExtractGetInfoHandlerTable[Index]( + InputSection, + OutputBufferSize, + ScratchBufferSize, + SectionAttribute + ); +} + +/** + Retrieves the GUID from a GUIDed section and uses that GUID to select an associated handler of type + EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers(). + The selected handler is used to decode the data in a GUIDed section and return the result in a caller + allocated output buffer. + + Decodes the GUIDed section specified by InputSection. + If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(), + then RETURN_UNSUPPORTED is returned. + If the GUID of InputSection does match the GUID that this handler supports, then the the associated handler + of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers() + is used to decode InputSection into the buffer specified by OutputBuffer and the authentication status of this + decode operation is returned in AuthenticationStatus. If the decoded buffer is identical to the data in InputSection, + then OutputBuffer is set to point at the data in InputSection. Otherwise, the decoded data will be placed in caller + allocated buffer specified by OutputBuffer. This function is responsible for computing the EFI_AUTH_STATUS_PLATFORM_OVERRIDE + bit of in AuthenticationStatus. The return status from the handler of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER is returned. + + If InputSection is NULL, then ASSERT(). + If OutputBuffer is NULL, then ASSERT(). + If ScratchBuffer is NULL and this decode operation requires a scratch buffer, then ASSERT(). + If AuthenticationStatus is NULL, then ASSERT(). + + @param[in] InputSection A pointer to a GUIDed section of an FFS formatted file. + @param[out] OutputBuffer A pointer to a buffer that contains the result of a decode operation. + @param[in] ScratchBuffer A caller allocated buffer that may be required by this function as a scratch buffer to perform the decode operation. + @param[out] AuthenticationStatus + A pointer to the authentication status of the decoded output buffer. See the definition + of authentication status in the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI section of the PI + Specification. + + @retval RETURN_SUCCESS The buffer specified by InputSection was decoded. + @retval RETURN_UNSUPPORTED The section specified by InputSection does not match the GUID this handler supports. + @retval RETURN_INVALID_PARAMETER The section specified by InputSection can not be decoded. + +**/ +RETURN_STATUS +EFIAPI +ExtractGuidedSectionDecode ( + IN CONST VOID *InputSection, + OUT VOID **OutputBuffer, + OUT VOID *ScratchBuffer OPTIONAL, + OUT UINT32 *AuthenticationStatus + ) +{ + UINT32 Index; + EFI_GUID *SectionDefinitionGuid; + + if (InputSection == NULL) { + return RETURN_INVALID_PARAMETER; + } + + ASSERT (OutputBuffer != NULL); + ASSERT (AuthenticationStatus != NULL); + + if (IS_SECTION2 (InputSection)) { + SectionDefinitionGuid = &(((EFI_GUID_DEFINED_SECTION2 *)InputSection)->SectionDefinitionGuid); + } else { + SectionDefinitionGuid = &(((EFI_GUID_DEFINED_SECTION *)InputSection)->SectionDefinitionGuid); + } + + // + // Search the match registered GetInfo handler for the input guided section. + // + for (Index = 0; Index < mHandlerInfo->NumberOfExtractHandler; Index++) { + if (CompareGuid (&mHandlerInfo->ExtractHandlerGuidTable[Index], SectionDefinitionGuid)) { + break; + } + } + + // + // Not found, the input guided section is not supported. + // + if (Index == mHandlerInfo->NumberOfExtractHandler) { + return RETURN_INVALID_PARAMETER; + } + + // + // Call the match handler to getinfo for the input section data. + // + return mHandlerInfo->ExtractDecodeHandlerTable[Index]( + InputSection, + OutputBuffer, + ScratchBuffer, + AuthenticationStatus + ); +} + +/** + ExtraGuidSectionLib constructor for StandaloneMmCore. + + @param [in] ImageHandle The firmware allocated handle for the EFI image. + @param [in] MmSystemTable A pointer to the Management mode System Table. + + @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS. + +**/ +RETURN_STATUS +EFIAPI +StandaloneMmExtractGuidedSectionLibConstructor ( + IN EFI_HANDLE ImageHandle, + IN EFI_MM_SYSTEM_TABLE *MmSystemTable + ) +{ + RETURN_STATUS Status; + UINTN Idx; + EFI_CONFIGURATION_TABLE *ConfigurationTable; + UINT8 *Buffer; + UINTN HandlerInfoSize; + + Status = RETURN_NOT_FOUND; + + // Find ExtraGuidedSectionHandlerInfo in ConfigurationTable. + ConfigurationTable = MmSystemTable->MmConfigurationTable; + for (Idx = 0; Idx < MmSystemTable->NumberOfTableEntries; Idx++) { + if (CompareGuid (&gExtraGuidedSectionHandlerInfoGuid, &ConfigurationTable[Idx].VendorGuid)) { + Status = RETURN_SUCCESS; + break; + } + } + + if (!RETURN_ERROR (Status)) { + mHandlerInfo = ConfigurationTable[Idx].VendorTable; + return RETURN_SUCCESS; + } + + /// Allocate new ExtraGuidedSectionHandlerInfo and install in ConfigurationTable. + HandlerInfoSize = (sizeof (EXTRACT_GUIDED_SECTION_HANDLER_INFO) + + (PcdGet32 (PcdMaximumGuidedExtractHandler) * + ((sizeof (GUID) + + sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER) + + sizeof (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER))) + )); + + Buffer = AllocateZeroPool (HandlerInfoSize); + if (Buffer == NULL) { + DEBUG ((DEBUG_ERROR, "%a: Failed to allocate HandlerInfo...\n", __func__)); + return RETURN_OUT_OF_RESOURCES; + } + + mHandlerInfo = (EXTRACT_GUIDED_SECTION_HANDLER_INFO *)Buffer; + + Buffer += sizeof (EXTRACT_GUIDED_SECTION_HANDLER_INFO); + mHandlerInfo->ExtractHandlerGuidTable = (GUID *)Buffer; + + Buffer += (sizeof (GUID) * PcdGet32 (PcdMaximumGuidedExtractHandler)); + mHandlerInfo->ExtractDecodeHandlerTable = (EXTRACT_GUIDED_SECTION_DECODE_HANDLER *)Buffer; + + Buffer += (sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER) * PcdGet32 (PcdMaximumGuidedExtractHandler)); + mHandlerInfo->ExtractGetInfoHandlerTable = (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *)Buffer; + + Status = MmSystemTable->MmInstallConfigurationTable ( + MmSystemTable, + &gExtraGuidedSectionHandlerInfoGuid, + mHandlerInfo, + HandlerInfoSize + ); + if (RETURN_ERROR (Status)) { + DEBUG (( + DEBUG_ERROR, + "%a: Failed to install ExtraGuidedSection Handler Info... (%r)\n", + __func__, + Status + )); + FreePool (mHandlerInfo); + mHandlerInfo = NULL; + return Status; + } + + return RETURN_SUCCESS; +} diff --git a/StandaloneMmPkg/Library/StandaloneMmExtractGuidedSectionLib/StandaloneMmExtractGuidedSectionLib.inf b/StandaloneMmPkg/Library/StandaloneMmExtractGuidedSectionLib/StandaloneMmExtractGuidedSectionLib.inf new file mode 100644 index 000000000000..bd53f3787bbc --- /dev/null +++ b/StandaloneMmPkg/Library/StandaloneMmExtractGuidedSectionLib/StandaloneMmExtractGuidedSectionLib.inf @@ -0,0 +1,37 @@ +#/** @file +# +# Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.
+# Copyright (c) 2024, Arm Ltd. All rights reserved.
+# +# SPDX-License-Identifier: BSD-2-Clause-Patent +# +#**/ + +[Defines] + INF_VERSION = 0x0001001B + BASE_NAME = StandaloneMmExtractGuidedSectionLib + FILE_GUID = 3b2564c2-7bf7-11ef-a7c5-6b16a362823f + MODULE_TYPE = MM_STANDALONE + VERSION_STRING = 1.0 + PI_SPECIFICATION_VERSION = 0x00010032 + LIBRARY_CLASS = ExtractGuidedSectionLib|MM_STANDALONE MM_CORE_STANDALONE + CONSTRUCTOR = StandaloneMmExtractGuidedSectionLibConstructor + +[Sources.common] + StandaloneMmExtractGuidedSectionLib.c + +[Packages] + MdePkg/MdePkg.dec + StandaloneMmPkg/StandaloneMmPkg.dec + +[LibraryClasses] + BaseLib + BaseMemoryLib + DebugLib + MemoryAllocationLib + +[Guids] + gExtraGuidedSectionHandlerInfoGuid + +[FixedPcd.common] + gEfiMdePkgTokenSpaceGuid.PcdMaximumGuidedExtractHandler diff --git a/StandaloneMmPkg/StandaloneMmPkg.dec b/StandaloneMmPkg/StandaloneMmPkg.dec index 0b7bd24074c0..bc4286c36bdf 100644 --- a/StandaloneMmPkg/StandaloneMmPkg.dec +++ b/StandaloneMmPkg/StandaloneMmPkg.dec @@ -47,6 +47,7 @@ gEfiMmPeiMmramMemoryReserveGuid = { 0x0703f912, 0xbf8d, 0x4e2a, { 0xbe, 0x07, 0xab, 0x27, 0x25, 0x25, 0xc5, 0x92 }} gEfiStandaloneMmNonSecureBufferGuid = { 0xf00497e3, 0xbfa2, 0x41a1, { 0x9d, 0x29, 0x54, 0xc2, 0xe9, 0x37, 0x21, 0xc5 }} + gExtraGuidedSectionHandlerInfoGuid = { 0xa558d266, 0x7bfc, 0x11ef, { 0xb4, 0xf0, 0x5f, 0x7b, 0x86, 0xa7, 0xfb, 0x80 }} gEventMmDispatchGuid = { 0x7e6efffa, 0x69b4, 0x4c1b, { 0xa4, 0xc7, 0xaf, 0xf9, 0xc9, 0x24, 0x4f, 0xee }} diff --git a/StandaloneMmPkg/StandaloneMmPkg.dsc b/StandaloneMmPkg/StandaloneMmPkg.dsc index 91e24e6c04b5..dcffeb27250f 100644 --- a/StandaloneMmPkg/StandaloneMmPkg.dsc +++ b/StandaloneMmPkg/StandaloneMmPkg.dsc @@ -44,7 +44,7 @@ CacheMaintenanceLib|MdePkg/Library/BaseCacheMaintenanceLib/BaseCacheMaintenanceLib.inf DebugLib|MdePkg/Library/BaseDebugLibNull/BaseDebugLibNull.inf DebugPrintErrorLevelLib|MdePkg/Library/BaseDebugPrintErrorLevelLib/BaseDebugPrintErrorLevelLib.inf - ExtractGuidedSectionLib|EmbeddedPkg/Library/PrePiExtractGuidedSectionLib/PrePiExtractGuidedSectionLib.inf + ExtractGuidedSectionLib|StandaloneMmPkg/Library/StandaloneMmExtractGuidedSectionLib/StandaloneMmExtractGuidedSectionLib.inf FvLib|StandaloneMmPkg/Library/FvLib/FvLib.inf HobLib|StandaloneMmPkg/Library/StandaloneMmHobLib/StandaloneMmHobLib.inf IoLib|MdePkg/Library/BaseIoLibIntrinsic/BaseIoLibIntrinsic.inf @@ -145,6 +145,7 @@ StandaloneMmPkg/Library/SmmLockBoxMmDependency/SmmLockBoxMmDependency.inf StandaloneMmPkg/Library/MmPlatformHobProducerLibNull/MmPlatformHobProducerLibNull.inf StandaloneMmPkg/Drivers/MmCommunicationDxe/MmCommunicationDxe.inf + StandaloneMmPkg/Library/StandaloneMmExtractGuidedSectionLib/StandaloneMmExtractGuidedSectionLib.inf [Components.AARCH64, Components.ARM] StandaloneMmPkg/Drivers/StandaloneMmCpu/StandaloneMmCpu.inf