/** @file\r
Provide generic extract guided section functions for PEI phase.\r
\r
- Copyright (c) 2007 - 2008, Intel Corporation<BR>\r
- All rights reserved. This program and the accompanying materials\r
+ Copyright (c) 2007 - 2010, 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
+ 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
#include <Library/HobLib.h>\r
#include <Library/ExtractGuidedSectionLib.h>\r
\r
-#define PEI_EXTRACT_HANDLER_INFO_SIGNATURE EFI_SIGNATURE_32 ('P', 'E', 'H', 'I')\r
+#define PEI_EXTRACT_HANDLER_INFO_SIGNATURE SIGNATURE_32 ('P', 'E', 'H', 'I')\r
\r
typedef struct {\r
UINT32 Signature;\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
+ @param[in, out] InfoPointer The pointer to pei handler information structure.\r
\r
- @retval RETURN_SUCCESS Build Guid hob for the global memory space to store guid and funciton tables.\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
-EFIAPI\r
PeiGetExtractGuidedSectionHandlerInfo (\r
IN OUT PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO **InfoPointer\r
)\r
EFI_PEI_HOB_POINTERS Hob;\r
\r
//\r
- // First try to get handler info from guid hob specified by CallerId.\r
+ // First try to get handler information from guid hob specified by CallerId.\r
//\r
Hob.Raw = GetNextHob (EFI_HOB_TYPE_GUID_EXTENSION, GetHobList ());\r
while (Hob.Raw != NULL) {\r
HandlerInfo->ExtractGetInfoHandlerTable = (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *) (\r
(UINT8 *)HandlerInfo->ExtractDecodeHandlerTable + \r
PcdGet32 (PcdMaximumGuidedExtractHandler) * \r
- sizeof (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER)\r
+ sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER)\r
);\r
}\r
//\r
//\r
// No enough resource to build guid hob.\r
//\r
+ *InfoPointer = NULL;\r
return EFI_OUT_OF_RESOURCES;\r
}\r
//\r
HandlerInfo->ExtractGetInfoHandlerTable = (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *) (\r
(UINT8 *)HandlerInfo->ExtractDecodeHandlerTable + \r
PcdGet32 (PcdMaximumGuidedExtractHandler) * \r
- sizeof (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER)\r
+ sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER)\r
);\r
//\r
// return the created HandlerInfo.\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 tht have been registerd through\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
Status = PeiGetExtractGuidedSectionHandlerInfo (&HandlerInfo);\r
if (EFI_ERROR (Status)) {\r
- return Status;\r
+ *ExtractHandlerGuidTable = NULL;\r
+ return 0;\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 witg the GUID specified by SectionGuid.\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
+ @param[in] GetInfoHandler The 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
+ @param[in] DecodeHandler The 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_ALREADY_STARTED Handlers have already been registered for the GUID specified by SectionGuid. \r
@retval RETURN_OUT_OF_RESOURCES There are not enough resources available to register the handlers.\r
\r
**/\r
CopyGuid (HandlerInfo->ExtractHandlerGuidTable + HandlerInfo->NumberOfExtractHandler, SectionGuid);\r
HandlerInfo->ExtractDecodeHandlerTable [HandlerInfo->NumberOfExtractHandler] = DecodeHandler;\r
HandlerInfo->ExtractGetInfoHandlerTable [HandlerInfo->NumberOfExtractHandler++] = GetInfoHandler;\r
- \r
+\r
return RETURN_SUCCESS;\r
}\r
\r
/**\r
- Retrives a GUID from a GUIDed section and uses that GUID to select an associated handler of type\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
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
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 getinfo for the input section data.\r
+ // Call the match handler to get information for the input section data.\r
//\r
return HandlerInfo->ExtractGetInfoHandlerTable [Index] (\r
InputSection,\r
}\r
\r
/**\r
- Retrives the GUID from a GUIDed section and uses that GUID to select an associated handler of type\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
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
+ 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
//\r
return RETURN_UNSUPPORTED;\r
}\r
+\r
+/**\r
+ Retrieves handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and \r
+ EXTRACT_GUIDED_SECTION_DECODE_HANDLER for a specific GUID section type.\r
+ \r
+ Retrieves the handlers associated with SectionGuid and returns them in \r
+ GetInfoHandler and DecodeHandler.\r
+\r
+ If the GUID value specified by SectionGuid has not been registered, then \r
+ return RETURN_NOT_FOUND.\r
+ \r
+ If SectionGuid is NULL, then ASSERT().\r
+\r
+ @param[in] SectionGuid A pointer to the GUID associated with the handlersof the GUIDed \r
+ section type being retrieved.\r
+ @param[out] GetInfoHandler Pointer to a function that examines a GUIDed section and returns \r
+ the size of the decoded buffer and the size of an optional scratch \r
+ buffer required to actually decode the data in a GUIDed section. \r
+ This is an optional parameter that may be NULL. If it is NULL, then \r
+ the previously registered handler is not returned.\r
+ @param[out] DecodeHandler Pointer to a function that decodes a GUIDed section into a caller\r
+ allocated output buffer. This is an optional parameter that may be NULL.\r
+ If it is NULL, then the previously registered handler is not returned.\r
+\r
+ @retval RETURN_SUCCESS The handlers were retrieved.\r
+ @retval RETURN_NOT_FOUND No handlers have been registered with the specified GUID.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+ExtractGuidedSectionGetHandlers (\r
+ IN CONST GUID *SectionGuid,\r
+ OUT EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *GetInfoHandler, OPTIONAL\r
+ OUT EXTRACT_GUIDED_SECTION_DECODE_HANDLER *DecodeHandler OPTIONAL\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ UINT32 Index;\r
+ PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;\r
+\r
+ //\r
+ // Check input parameter\r
+ //\r
+ ASSERT (SectionGuid != NULL);\r
+\r
+ //\r
+ // Get the registered handler information\r
+ //\r
+ Status = PeiGetExtractGuidedSectionHandlerInfo (&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
+ ASSERT (HandlerInfo != NULL);\r
+ for (Index = 0; Index < HandlerInfo->NumberOfExtractHandler; Index ++) {\r
+ if (CompareGuid (HandlerInfo->ExtractHandlerGuidTable + Index, SectionGuid)) {\r
+\r
+ //\r
+ // If the guided handler has been registered before, then return the registered handlers.\r
+ //\r
+ if (GetInfoHandler != NULL) {\r
+ *GetInfoHandler = HandlerInfo->ExtractGetInfoHandlerTable[Index];\r
+ }\r
+ if (DecodeHandler != NULL) {\r
+ *DecodeHandler = HandlerInfo->ExtractDecodeHandlerTable[Index];\r
+ }\r
+ return RETURN_SUCCESS;\r
+ }\r
+ }\r
+ return RETURN_NOT_FOUND;\r
+}\r