+++ /dev/null
-/** @file\r
- Provide generic extract guided section functions for SEC phase.\r
-\r
- Copyright (c) 2007 - 2009, Intel Corporation. All rights reserved.<BR>\r
- This program and the accompanying materials\r
- are licensed and made available under the terms and conditions of the BSD License\r
- which accompanies this distribution. The full text of the license may be found at\r
- http://opensource.org/licenses/bsd-license.php\r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
-**/\r
-\r
-#include <PiPei.h>\r
-\r
-#include <Library/DebugLib.h>\r
-#include <Library/PcdLib.h>\r
-#include <Library/BaseMemoryLib.h>\r
-#include <Library/ExtractGuidedSectionLib.h>\r
-\r
-#define EXTRACT_HANDLER_INFO_SIGNATURE SIGNATURE_32 ('E', 'G', 'S', 'I')\r
-\r
-typedef struct {\r
- UINT32 Signature;\r
- UINT32 NumberOfExtractHandler;\r
- GUID *ExtractHandlerGuidTable;\r
- EXTRACT_GUIDED_SECTION_DECODE_HANDLER *ExtractDecodeHandlerTable;\r
- EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *ExtractGetInfoHandlerTable;\r
-} EXTRACT_GUIDED_SECTION_HANDLER_INFO;\r
-\r
-STATIC EXTRACT_GUIDED_SECTION_HANDLER_INFO mHandlerInfo = {\r
- 0, // Signature;\r
-};\r
-\r
-/**\r
- Check if the info structure can be used. If it can be used, but it\r
- is not currently initialized, then it will be initialized.\r
-\r
- @param[in] Info Pointer to handler info structure.\r
-\r
- @retval RETURN_SUCCESS The info structure is initialized\r
- @retval EFI_WRITE_PROTECTED The info structure could not be written to.\r
-**/\r
-STATIC\r
-RETURN_STATUS\r
-CheckOrInitializeHandlerInfo (\r
- IN volatile EXTRACT_GUIDED_SECTION_HANDLER_INFO *Info\r
- )\r
-{\r
- //\r
- // First try access the handler info structure as a global variable\r
- //\r
- if (Info->Signature == EXTRACT_HANDLER_INFO_SIGNATURE) {\r
- //\r
- // The global variable version of the handler info has been initialized\r
- //\r
- return EFI_SUCCESS;\r
- }\r
-\r
- //\r
- // Try to initialize the handler info structure\r
- //\r
- Info->Signature = EXTRACT_HANDLER_INFO_SIGNATURE;\r
- if (Info->Signature != EXTRACT_HANDLER_INFO_SIGNATURE) {\r
- //\r
- // The structure was not writeable\r
- //\r
- return EFI_WRITE_PROTECTED;\r
- }\r
-\r
- Info->NumberOfExtractHandler = 0;\r
- Info->ExtractHandlerGuidTable = (GUID*) (Info + 1);\r
- Info->ExtractDecodeHandlerTable =\r
- (EXTRACT_GUIDED_SECTION_DECODE_HANDLER*)\r
- &(Info->ExtractHandlerGuidTable [PcdGet32 (PcdMaximumGuidedExtractHandler)]);\r
- Info->ExtractGetInfoHandlerTable =\r
- (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER*)\r
- &(Info->ExtractDecodeHandlerTable [PcdGet32 (PcdMaximumGuidedExtractHandler)]);\r
- \r
- return EFI_SUCCESS;\r
-}\r
-\r
-\r
-/**\r
- Build guid hob for the global memory to store the registered guid and Handler list.\r
- If GuidHob exists, HandlerInfo will be directly got from Guid hob data.\r
-\r
- @param[in, out] InfoPointer Pointer to pei handler info structure.\r
-\r
- @retval RETURN_SUCCESS Build Guid hob for the global memory space to store guid and function tables.\r
- @retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.\r
-**/\r
-RETURN_STATUS\r
-GetExtractGuidedSectionHandlerInfo (\r
- IN OUT EXTRACT_GUIDED_SECTION_HANDLER_INFO **InfoPointer\r
- )\r
-{\r
- STATIC EXTRACT_GUIDED_SECTION_HANDLER_INFO* PotentialInfoLocations[] = {\r
- //\r
- // This entry will work if the global variables in the module are\r
- // writeable.\r
- //\r
- &mHandlerInfo,\r
-\r
- //\r
- // This entry will work if the system memory is already initialized\r
- // and ready for use. (For example, in a virtual machine, the memory\r
- // will not require initialization.)\r
- //\r
- (EXTRACT_GUIDED_SECTION_HANDLER_INFO*)(VOID*)(UINTN) 0x1000,\r
- };\r
- UINTN Loop;\r
-\r
- for (Loop = 0;\r
- Loop < sizeof (PotentialInfoLocations) / sizeof (PotentialInfoLocations[0]);\r
- Loop ++\r
- ) {\r
- //\r
- // First try access the handler info structure as a global variable\r
- //\r
- if (!EFI_ERROR (CheckOrInitializeHandlerInfo (PotentialInfoLocations[Loop]))) {\r
- //\r
- // The global variable version of the handler info has been initialized\r
- //\r
- *InfoPointer = PotentialInfoLocations[Loop];\r
- return EFI_SUCCESS;\r
- }\r
- }\r
-\r
- *InfoPointer = (EXTRACT_GUIDED_SECTION_HANDLER_INFO*) NULL;\r
- return RETURN_OUT_OF_RESOURCES;\r
-}\r
-\r
-/**\r
- Retrieve the list GUIDs that have been registered through ExtractGuidedSectionRegisterHandlers().\r
-\r
- Sets ExtractHandlerGuidTable so it points at a callee allocated array of registered GUIDs.\r
- The total number of GUIDs in the array are returned. Since the array of GUIDs is callee allocated\r
- and caller must treat this array of GUIDs as read-only data. \r
- If ExtractHandlerGuidTable is NULL, then ASSERT().\r
-\r
- @param[out] ExtractHandlerGuidTable A pointer to the array of GUIDs that have been registered through\r
- ExtractGuidedSectionRegisterHandlers().\r
-\r
- @return the number of the supported extract guided Handler.\r
-\r
-**/\r
-UINTN\r
-EFIAPI\r
-ExtractGuidedSectionGetGuidList (\r
- OUT GUID **ExtractHandlerGuidTable\r
- )\r
-{\r
- EFI_STATUS Status;\r
- EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;\r
-\r
- ASSERT (ExtractHandlerGuidTable != NULL);\r
-\r
- //\r
- // Get all registered handler information\r
- //\r
- Status = GetExtractGuidedSectionHandlerInfo (&HandlerInfo);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- //\r
- // Get GuidTable and Table Number\r
- //\r
- *ExtractHandlerGuidTable = HandlerInfo->ExtractHandlerGuidTable;\r
- return HandlerInfo->NumberOfExtractHandler;\r
-}\r
-\r
-/**\r
- Registers handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and EXTRACT_GUIDED_SECTION_DECODE_HANDLER\r
- for a specific GUID section type.\r
-\r
- Registers the handlers specified by GetInfoHandler and DecodeHandler with the GUID specified by SectionGuid.\r
- If the GUID value specified by SectionGuid has already been registered, then return RETURN_ALREADY_STARTED.\r
- If there are not enough resources available to register the handlers then RETURN_OUT_OF_RESOURCES is returned.\r
- \r
- If SectionGuid is NULL, then ASSERT().\r
- If GetInfoHandler is NULL, then ASSERT().\r
- If DecodeHandler is NULL, then ASSERT().\r
-\r
- @param[in] SectionGuid A pointer to the GUID associated with the the handlers\r
- of the GUIDed section type being registered.\r
- @param[in] GetInfoHandler Pointer to a function that examines a GUIDed section and returns the\r
- size of the decoded buffer and the size of an optional scratch buffer\r
- required to actually decode the data in a GUIDed section.\r
- @param[in] DecodeHandler Pointer to a function that decodes a GUIDed section into a caller\r
- allocated output buffer. \r
-\r
- @retval RETURN_SUCCESS The handlers were registered.\r
- @retval RETURN_OUT_OF_RESOURCES There are not enough resources available to register the handlers.\r
-\r
-**/\r
-RETURN_STATUS\r
-EFIAPI\r
-ExtractGuidedSectionRegisterHandlers (\r
- IN CONST GUID *SectionGuid,\r
- IN EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER GetInfoHandler,\r
- IN EXTRACT_GUIDED_SECTION_DECODE_HANDLER DecodeHandler\r
- )\r
-{\r
- EFI_STATUS Status;\r
- UINT32 Index;\r
- EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;\r
-\r
- //\r
- // Check input paramter\r
- //\r
- ASSERT (SectionGuid != NULL);\r
- ASSERT (GetInfoHandler != NULL);\r
- ASSERT (DecodeHandler != NULL);\r
-\r
- //\r
- // Get the registered handler information\r
- //\r
- Status = GetExtractGuidedSectionHandlerInfo (&HandlerInfo);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- //\r
- // Search the match registered GetInfo handler for the input guided section.\r
- //\r
- for (Index = 0; Index < HandlerInfo->NumberOfExtractHandler; Index ++) {\r
- if (CompareGuid (HandlerInfo->ExtractHandlerGuidTable + Index, SectionGuid)) {\r
- //\r
- // If the guided handler has been registered before, only update its handler.\r
- //\r
- HandlerInfo->ExtractDecodeHandlerTable [Index] = DecodeHandler;\r
- HandlerInfo->ExtractGetInfoHandlerTable [Index] = GetInfoHandler;\r
- return RETURN_SUCCESS;\r
- }\r
- }\r
-\r
- //\r
- // Check the global table is enough to contain new Handler.\r
- //\r
- if (HandlerInfo->NumberOfExtractHandler >= PcdGet32 (PcdMaximumGuidedExtractHandler)) {\r
- return RETURN_OUT_OF_RESOURCES;\r
- }\r
- \r
- //\r
- // Register new Handler and guid value.\r
- //\r
- CopyGuid (HandlerInfo->ExtractHandlerGuidTable + HandlerInfo->NumberOfExtractHandler, SectionGuid);\r
- HandlerInfo->ExtractDecodeHandlerTable [HandlerInfo->NumberOfExtractHandler] = DecodeHandler;\r
- HandlerInfo->ExtractGetInfoHandlerTable [HandlerInfo->NumberOfExtractHandler++] = GetInfoHandler;\r
-\r
- return RETURN_SUCCESS;\r
-}\r
-\r
-/**\r
- Retrieves a GUID from a GUIDed section and uses that GUID to select an associated handler of type\r
- EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers().\r
- The selected handler is used to retrieve and return the size of the decoded buffer and the size of an\r
- optional scratch buffer required to actually decode the data in a GUIDed section.\r
-\r
- Examines a GUIDed section specified by InputSection. \r
- If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(),\r
- then RETURN_UNSUPPORTED is returned. \r
- If the GUID of InputSection does match the GUID that this handler supports, then the the associated handler \r
- of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()\r
- is used to retrieve the OututBufferSize, ScratchSize, and Attributes values. The return status from the handler of\r
- type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER is returned.\r
- \r
- If InputSection is NULL, then ASSERT().\r
- If OutputBufferSize is NULL, then ASSERT().\r
- If ScratchBufferSize is NULL, then ASSERT().\r
- If SectionAttribute is NULL, then ASSERT().\r
-\r
- @param[in] InputSection A pointer to a GUIDed section of an FFS formatted file.\r
- @param[out] OutputBufferSize A pointer to the size, in bytes, of an output buffer required if the buffer\r
- specified by InputSection were decoded.\r
- @param[out] ScratchBufferSize A pointer to the size, in bytes, required as scratch space if the buffer specified by\r
- InputSection were decoded.\r
- @param[out] SectionAttribute A pointer to the attributes of the GUIDed section. See the Attributes field of\r
- EFI_GUID_DEFINED_SECTION in the PI Specification.\r
-\r
- @retval RETURN_SUCCESS Get the required information successfully.\r
- @retval RETURN_UNSUPPORTED The GUID from the section specified by InputSection does not match any of\r
- the GUIDs registered with ExtractGuidedSectionRegisterHandlers().\r
- @retval Others The return status from the handler associated with the GUID retrieved from\r
- the section specified by InputSection.\r
-\r
-**/\r
-RETURN_STATUS\r
-EFIAPI\r
-ExtractGuidedSectionGetInfo (\r
- IN CONST VOID *InputSection,\r
- OUT UINT32 *OutputBufferSize,\r
- OUT UINT32 *ScratchBufferSize,\r
- OUT UINT16 *SectionAttribute \r
- )\r
-{\r
- UINT32 Index;\r
- EFI_STATUS Status;\r
- EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;\r
- \r
- //\r
- // Check input paramter\r
- //\r
- ASSERT (InputSection != NULL);\r
- ASSERT (OutputBufferSize != NULL);\r
- ASSERT (ScratchBufferSize != NULL);\r
- ASSERT (SectionAttribute != NULL);\r
-\r
- //\r
- // Get all registered handler information.\r
- //\r
- Status = GetExtractGuidedSectionHandlerInfo (&HandlerInfo);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- //\r
- // Search the match registered GetInfo handler for the input guided section.\r
- //\r
- for (Index = 0; Index < HandlerInfo->NumberOfExtractHandler; Index ++) {\r
- if (CompareGuid (HandlerInfo->ExtractHandlerGuidTable + Index, &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {\r
- //\r
- // Call the match handler to get info for the input section data.\r
- //\r
- return HandlerInfo->ExtractGetInfoHandlerTable [Index] (\r
- InputSection,\r
- OutputBufferSize,\r
- ScratchBufferSize,\r
- SectionAttribute\r
- );\r
- }\r
- }\r
-\r
- //\r
- // Not found, the input guided section is not supported. \r
- //\r
- return RETURN_UNSUPPORTED;\r
-}\r
-\r
-/**\r
- Retrieves the GUID from a GUIDed section and uses that GUID to select an associated handler of type\r
- EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers().\r
- The selected handler is used to decode the data in a GUIDed section and return the result in a caller\r
- allocated output buffer.\r
-\r
- Decodes the GUIDed section specified by InputSection. \r
- If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(),\r
- then RETURN_UNSUPPORTED is returned. \r
- If the GUID of InputSection does match the GUID that this handler supports, then the the associated handler\r
- of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()\r
- is used to decode InputSection into the buffer specified by OutputBuffer and the authentication status of this\r
- decode operation is returned in AuthenticationStatus. If the decoded buffer is identical to the data in InputSection,\r
- then OutputBuffer is set to point at the data in InputSection. Otherwise, the decoded data will be placed in caller\r
- allocated buffer specified by OutputBuffer. This function is responsible for computing the EFI_AUTH_STATUS_PLATFORM_OVERRIDE\r
- bit of in AuthenticationStatus. The return status from the handler of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER is returned. \r
- \r
- If InputSection is NULL, then ASSERT().\r
- If OutputBuffer is NULL, then ASSERT().\r
- If ScratchBuffer is NULL and this decode operation requires a scratch buffer, then ASSERT().\r
- If AuthenticationStatus is NULL, then ASSERT(). \r
-\r
- @param[in] InputSection A pointer to a GUIDed section of an FFS formatted file.\r
- @param[out] OutputBuffer A pointer to a buffer that contains the result of a decode operation. \r
- @param[in] ScratchBuffer A caller allocated buffer that may be required by this function as a scratch buffer to perform the decode operation. \r
- @param[out] AuthenticationStatus \r
- A pointer to the authentication status of the decoded output buffer. See the definition\r
- of authentication status in the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI section of the PI\r
- Specification.\r
-\r
- @retval RETURN_SUCCESS The buffer specified by InputSection was decoded.\r
- @retval RETURN_UNSUPPORTED The section specified by InputSection does not match the GUID this handler supports.\r
- @retval RETURN_INVALID_PARAMETER The section specified by InputSection can not be decoded.\r
-\r
-**/\r
-RETURN_STATUS\r
-EFIAPI\r
-ExtractGuidedSectionDecode (\r
- IN CONST VOID *InputSection,\r
- OUT VOID **OutputBuffer,\r
- IN VOID *ScratchBuffer, OPTIONAL\r
- OUT UINT32 *AuthenticationStatus \r
- )\r
-{\r
- UINT32 Index;\r
- EFI_STATUS Status;\r
- EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;\r
- \r
- //\r
- // Check input parameter\r
- //\r
- ASSERT (InputSection != NULL);\r
- ASSERT (OutputBuffer != NULL);\r
- ASSERT (AuthenticationStatus != NULL);\r
-\r
- //\r
- // Get all registered handler information.\r
- // \r
- Status = GetExtractGuidedSectionHandlerInfo (&HandlerInfo);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- //\r
- // Search the match registered Extract handler for the input guided section.\r
- //\r
- for (Index = 0; Index < HandlerInfo->NumberOfExtractHandler; Index ++) {\r
- if (CompareGuid (HandlerInfo->ExtractHandlerGuidTable + Index, &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {\r
- //\r
- // Call the match handler to extract raw data for the input guided section.\r
- //\r
- return HandlerInfo->ExtractDecodeHandlerTable [Index] (\r
- InputSection,\r
- OutputBuffer,\r
- ScratchBuffer,\r
- AuthenticationStatus\r
- );\r
- }\r
- }\r
-\r
- //\r
- // Not found, the input guided section is not supported. \r
- //\r
- return RETURN_UNSUPPORTED;\r
-}\r
projects / mirror_edk2.git / commitdiff