-/*++\r
+/** @file\r
+ Provide generic extract guided section functions for Dxe phase.\r
\r
-Copyright (c) 2007, Intel Corporation\r
-All rights reserved. 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
+ Copyright (c) 2007 - 2008, 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
+ 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
-Module Name:\r
-\r
- DxeExtractGuidedSectionLib.c\r
-\r
-Abstract:\r
-\r
- Provide generic extract guided section functions. \r
-\r
---*/\r
+**/\r
\r
#include <PiDxe.h>\r
\r
#include <Library/DebugLib.h>\r
-#include <Library/PcdLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/ExtractGuidedSectionLib.h>\r
\r
-STATIC GUID *mExtractHandlerGuidTable;\r
-STATIC UINT32 mNumberOfExtractHandler;\r
+#define EXTRACT_HANDLER_TABLE_SIZE 0x10\r
\r
-STATIC EXTRACT_GUIDED_SECTION_DECODE_HANDLER *mExtractDecodeHandlerTable;\r
-STATIC EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *mExtractGetInfoHandlerTable;\r
+UINT32 mNumberOfExtractHandler = 0;\r
+UINT32 mMaxNumberOfExtractHandler = 0;\r
\r
-/**
- Construtor allocates the global memory to store the registered guid and Handler list.\r
+GUID *mExtractHandlerGuidTable = NULL;\r
+EXTRACT_GUIDED_SECTION_DECODE_HANDLER *mExtractDecodeHandlerTable = NULL;\r
+EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *mExtractGetInfoHandlerTable = NULL;\r
\r
- @param ImageHandle The firmware allocated handle for the EFI image.\r
- @param SystemTable A pointer to the EFI System Table.
+/**\r
+ Reallocates more global memory to store the registered guid and Handler list.\r
\r
- @retval RETURN_SUCCESS Allocate the global memory space to store guid and funciton tables.\r
- @retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.
+ @retval RETURN_SUCCESS Reallocate more 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
EFIAPI\r
-DxeExtractGuidedSectionLibConstructor (\r
- IN EFI_HANDLE ImageHandle,\r
- IN EFI_SYSTEM_TABLE *SystemTable\r
+ReallocateExtractHandlerTable (\r
)\r
-{\r
+{ \r
//\r
- // Allocate global pool space to store the registered handler and its guid value.\r
+ // Reallocate memory for GuidTable\r
//\r
- mExtractHandlerGuidTable = (GUID *) AllocatePool (PcdGet32 (PcdMaximumGuidedExtractHandler) * sizeof (GUID));\r
+ mExtractHandlerGuidTable = ReallocatePool (\r
+ mMaxNumberOfExtractHandler * sizeof (GUID), \r
+ (mMaxNumberOfExtractHandler + EXTRACT_HANDLER_TABLE_SIZE) * sizeof (GUID), \r
+ mExtractHandlerGuidTable\r
+ );\r
+\r
if (mExtractHandlerGuidTable == NULL) {\r
- return RETURN_OUT_OF_RESOURCES;\r
+ goto Done;\r
}\r
- \r
- mExtractDecodeHandlerTable = (EXTRACT_GUIDED_SECTION_DECODE_HANDLER *) AllocatePool (PcdGet32 (PcdMaximumGuidedExtractHandler) * sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER));\r
+\r
+ //\r
+ // Reallocate memory for Decode handler Table\r
+ //\r
+ mExtractDecodeHandlerTable = ReallocatePool (\r
+ mMaxNumberOfExtractHandler * sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER), \r
+ (mMaxNumberOfExtractHandler + EXTRACT_HANDLER_TABLE_SIZE) * sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER), \r
+ mExtractDecodeHandlerTable\r
+ );\r
+\r
if (mExtractDecodeHandlerTable == NULL) {\r
- return RETURN_OUT_OF_RESOURCES;\r
+ goto Done;\r
}\r
\r
- mExtractGetInfoHandlerTable = (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *) AllocatePool (PcdGet32 (PcdMaximumGuidedExtractHandler) * sizeof (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER));\r
+ //\r
+ // Reallocate memory for GetInfo handler Table\r
+ //\r
+ mExtractGetInfoHandlerTable = ReallocatePool (\r
+ mMaxNumberOfExtractHandler * sizeof (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER), \r
+ (mMaxNumberOfExtractHandler + EXTRACT_HANDLER_TABLE_SIZE) * sizeof (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER), \r
+ mExtractGetInfoHandlerTable\r
+ );\r
+\r
if (mExtractGetInfoHandlerTable == NULL) {\r
- return RETURN_OUT_OF_RESOURCES;\r
+ goto Done;\r
}\r
\r
//\r
- // the initialized number is Zero.\r
+ // Increase max handler number\r
//\r
- mNumberOfExtractHandler = 0;\r
- \r
+ mMaxNumberOfExtractHandler = mMaxNumberOfExtractHandler + EXTRACT_HANDLER_TABLE_SIZE;\r
return RETURN_SUCCESS;\r
+\r
+Done:\r
+ if (mExtractHandlerGuidTable != NULL) {\r
+ FreePool (mExtractHandlerGuidTable);\r
+ }\r
+ if (mExtractDecodeHandlerTable != NULL) {\r
+ FreePool (mExtractDecodeHandlerTable);\r
+ }\r
+ if (mExtractGetInfoHandlerTable != NULL) {\r
+ FreePool (mExtractGetInfoHandlerTable);\r
+ }\r
+ \r
+ return RETURN_OUT_OF_RESOURCES;\r
+}\r
+/**\r
+ Constructor allocates the global memory to store the registered guid and Handler list.\r
+\r
+ @param ImageHandle The firmware allocated handle for the EFI image.\r
+ @param SystemTable A pointer to the EFI System Table.\r
+\r
+ @retval RETURN_SUCCESS Allocate 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
+EFIAPI\r
+DxeExtractGuidedSectionLibConstructor (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+{\r
+ return ReallocateExtractHandlerTable ();\r
}\r
\r
-/**
- Get the supported exract guided section Handler guid list.\r
- If ExtractHandlerGuidTable = NULL, then ASSERT.\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
- @param[in, out] ExtractHandlerGuidTable The extract Handler guid pointer list.
+ @return the number of the supported extract guided Handler.\r
\r
- @retval return the number of the supported extract guided Handler.
**/\r
UINTN\r
EFIAPI\r
ExtractGuidedSectionGetGuidList (\r
- IN OUT GUID **ExtractHandlerGuidTable\r
+ OUT GUID **ExtractHandlerGuidTable\r
)\r
{\r
ASSERT (ExtractHandlerGuidTable != NULL);\r
return mNumberOfExtractHandler;\r
}\r
\r
-/**
- Register Guided Section Extract and GetInfo handler.\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
- @param[in] SectionGuid The guid matches this Extraction function.
- @param[in] GetInfoHandler Function to get info from guided section.\r
- @param[in] DecodeHandler Function to extract guided section.
-
- @retval RETURN_SUCCESS Register Guided Section Extract function successfully.
- @retval RETURN_OUT_OF_RESOURCES Resource is not enough to register new function. \r
- @retval RETURN_INVALID_PARAMETER Input pointer to Guid value is not valid.\r
**/\r
RETURN_STATUS\r
EFIAPI\r
IN EXTRACT_GUIDED_SECTION_DECODE_HANDLER DecodeHandler\r
)\r
{\r
+ UINT32 Index;\r
//\r
// Check input paramter.\r
//\r
- if (SectionGuid == NULL) {\r
- return RETURN_INVALID_PARAMETER;\r
+ ASSERT (SectionGuid != NULL);\r
+ ASSERT (GetInfoHandler != NULL);\r
+ ASSERT (DecodeHandler != NULL);\r
+\r
+ //\r
+ // Search the match registered GetInfo handler for the input guided section.\r
+ //\r
+ for (Index = 0; Index < mNumberOfExtractHandler; Index ++) {\r
+ if (CompareGuid (&mExtractHandlerGuidTable[Index], SectionGuid)) {\r
+ //\r
+ // If the guided handler has been registered before, only update its handler.\r
+ //\r
+ mExtractDecodeHandlerTable [Index] = DecodeHandler;\r
+ mExtractGetInfoHandlerTable [Index] = GetInfoHandler;\r
+ return RETURN_SUCCESS;\r
+ }\r
}\r
+ \r
//\r
// Check the global table is enough to contain new Handler.\r
//\r
- if (mNumberOfExtractHandler >= PcdGet32 (PcdMaximumGuidedExtractHandler)) {\r
- return RETURN_OUT_OF_RESOURCES;\r
+ if (mNumberOfExtractHandler >= mMaxNumberOfExtractHandler) {\r
+ if (ReallocateExtractHandlerTable () != RETURN_SUCCESS) {\r
+ return RETURN_OUT_OF_RESOURCES;\r
+ }\r
}\r
\r
//\r
return RETURN_SUCCESS;\r
}\r
\r
-/**
- Get information from the guided section. This function first gets the guid value\r
- from guided section header, then match this guid in the registered extract Handler list\r
- to its corresponding getinfo Handler. \r
- If not found, RETURN_INVALID_PARAMETER will be return. \r
- If found, it will call the getinfo Handler to get the required size and attribute.\r
-\r
- It will ASSERT () if the pointer to OutputBufferSize is NULL.\r
- It will ASSERT () if the pointer to ScratchBufferSize is NULL.
- It will ASSERT () if the pointer to SectionAttribute is NULL.\r
-\r
- @param[in] InputSection Buffer containing the input GUIDed section to be processed. \r
- @param[out] OutputBufferSize The size of OutputBuffer.\r
- @param[out] ScratchBufferSize The size of ScratchBuffer. \r
- @param[out] SectionAttribute The attribute of the input guided section.\r
-
- @retval RETURN_SUCCESS Get the required information successfully.\r
- @retval RETURN_INVALID_PARAMETER The input data can't be parsed correctly. \r
- The GUID in InputSection does not match any registered guid list.\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
)\r
{\r
UINT32 Index;\r
- \r
- if (InputSection == NULL) {\r
- return RETURN_INVALID_PARAMETER;\r
- }\r
- \r
+\r
+ ASSERT (InputSection != NULL); \r
ASSERT (OutputBufferSize != NULL);\r
ASSERT (ScratchBufferSize != NULL);\r
ASSERT (SectionAttribute != NULL);\r
//\r
for (Index = 0; Index < mNumberOfExtractHandler; Index ++) {\r
if (CompareGuid (&mExtractHandlerGuidTable[Index], &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {\r
- break;\r
+ //\r
+ // Call the match handler to getinfo for the input section data.\r
+ //\r
+ return mExtractGetInfoHandlerTable [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
- if (Index == mNumberOfExtractHandler) {\r
- return RETURN_INVALID_PARAMETER;\r
- }\r
-\r
- //\r
- // Call the match handler to getinfo for the input section data.\r
- //\r
- return mExtractGetInfoHandlerTable [Index] (\r
- InputSection,\r
- OutputBufferSize,\r
- ScratchBufferSize,\r
- SectionAttribute\r
- );\r
+ return RETURN_UNSUPPORTED;\r
}\r
\r
-/**
- Extract data from the guided section. This function first gets the guid value\r
- from guided section header, then match this guid in the registered extract Handler list\r
- to its corresponding extract Handler. \r
- If not found, RETURN_INVALID_PARAMETER will be return. \r
- If found, it will call this extract Handler to get output data and AuthenticationStatus.
-\r
- It will ASSERT () if the pointer to OutputBuffer is NULL.\r
- It will ASSERT () if the pointer to AuthenticationStatus is NULL.\r
-\r
- @param[in] InputSection Buffer containing the input GUIDed section to be processed. \r
- @param[out] OutputBuffer OutputBuffer to point the start of the section's contents \r
- if guided data is not required prcessing. Otherwise,\r
- OutputBuffer to contain the output data, which is \r
- allocated by the caller.\r
- @param[out] ScratchBuffer A pointer to a caller-allocated buffer for function internal use. \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 a caller-allocated UINT32 that indicates the\r
- authentication status of the output buffer.
-
- @retval RETURN_SUCCESS Get the output data, size and AuthenticationStatus successfully.\r
- @retval RETURN_INVALID_PARAMETER The input data can't be parsed correctly. \r
- The GUID in InputSection does not match any registered guid.\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
- OUT VOID *ScratchBuffer, OPTIONAL\r
+ IN VOID *ScratchBuffer, OPTIONAL\r
OUT UINT32 *AuthenticationStatus \r
)\r
{\r
UINT32 Index;\r
\r
- if (InputSection == NULL) {\r
- return RETURN_INVALID_PARAMETER;\r
- }\r
- \r
+ //\r
+ // Check the input parameters\r
+ //\r
+ ASSERT (InputSection != NULL);\r
ASSERT (OutputBuffer != NULL);\r
ASSERT (AuthenticationStatus != NULL);\r
\r
//\r
- // Search the match registered GetInfo handler for the input guided section.\r
+ // Search the match registered extract handler for the input guided section.\r
//\r
for (Index = 0; Index < mNumberOfExtractHandler; Index ++) {\r
if (CompareGuid (&mExtractHandlerGuidTable[Index], &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {\r
- break;\r
+ //\r
+ // Call the match handler to extract raw data for the input section data.\r
+ //\r
+ return mExtractDecodeHandlerTable [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
- if (Index == mNumberOfExtractHandler) {\r
- return RETURN_INVALID_PARAMETER;\r
- }\r
-\r
- //\r
- // Call the match handler to getinfo for the input section data.\r
- //\r
- return mExtractDecodeHandlerTable [Index] (\r
- InputSection,\r
- OutputBuffer,\r
- ScratchBuffer,\r
- AuthenticationStatus\r
- );\r
+ return RETURN_UNSUPPORTED;\r
}\r
projects / mirror_edk2.git / blobdiff