[mirror_edk2.git] / MdePkg / Library / PeiExtractGuidedSectionLib / PeiExtractGuidedSectionLib.c

/** @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
  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/HobLib.h>\r
#include <Library/ExtractGuidedSectionLib.h>\r
\r
#define PEI_EXTRACT_HANDLER_INFO_SIGNATURE EFI_SIGNATURE_32 ('P', 'E', 'H', '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
} PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO;\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 funciton 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
{\r
  PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;\r
  EFI_PEI_HOB_POINTERS                    Hob;\r
  \r
  //\r
  // First try to get handler info from guid hob specified by CallerId.\r
  //\r
  Hob.Raw = GetNextHob (EFI_HOB_TYPE_GUID_EXTENSION, GetHobList ());\r
  while (Hob.Raw != NULL) {\r
    if (CompareGuid (&(Hob.Guid->Name), &gEfiCallerIdGuid)) {\r
      HandlerInfo = (PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *) GET_GUID_HOB_DATA (Hob.Guid);\r
      if (HandlerInfo->Signature == PEI_EXTRACT_HANDLER_INFO_SIGNATURE) {\r
        //\r
        // Update Table Pointer when hob start address is changed.\r
        //\r
        if (HandlerInfo->ExtractHandlerGuidTable != (GUID *) (HandlerInfo + 1)) {\r
          HandlerInfo->ExtractHandlerGuidTable    = (GUID *) (HandlerInfo + 1);\r
          HandlerInfo->ExtractDecodeHandlerTable  = (EXTRACT_GUIDED_SECTION_DECODE_HANDLER *) (\r
                                                      (UINT8 *)HandlerInfo->ExtractHandlerGuidTable + \r
                                                      PcdGet32 (PcdMaximumGuidedExtractHandler) * sizeof (GUID)\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
                                                     );\r
        }\r
        //\r
        // Return HandlerInfo pointer.\r
        //\r
        *InfoPointer = HandlerInfo;\r
        return EFI_SUCCESS;\r
      }\r
    }\r
    Hob.Raw = GET_NEXT_HOB (Hob);\r
    Hob.Raw = GetNextHob (EFI_HOB_TYPE_GUID_EXTENSION, Hob.Raw);\r
  }\r
  \r
  //\r
  // If Guid Hob is not found, Build CallerId Guid hob to store Handler Info\r
  //\r
  HandlerInfo = BuildGuidHob (\r
                 &gEfiCallerIdGuid, \r
                 sizeof (PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO) +\r
                 PcdGet32 (PcdMaximumGuidedExtractHandler) * \r
                 (sizeof (GUID) + sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER) + sizeof (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER))\r
                );\r
  if (HandlerInfo == NULL) {\r
    //\r
    // No enough resource to build guid hob.\r
    //\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  //\r
  // Init HandlerInfo structure\r
  //\r
  HandlerInfo->Signature = PEI_EXTRACT_HANDLER_INFO_SIGNATURE;\r
  HandlerInfo->NumberOfExtractHandler     = 0;\r
  HandlerInfo->ExtractHandlerGuidTable    = (GUID *) (HandlerInfo + 1);\r
  HandlerInfo->ExtractDecodeHandlerTable  = (EXTRACT_GUIDED_SECTION_DECODE_HANDLER *) (\r
                                              (UINT8 *)HandlerInfo->ExtractHandlerGuidTable + \r
                                              PcdGet32 (PcdMaximumGuidedExtractHandler) * sizeof (GUID)\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
                                             );\r
  //\r
  // return the created HandlerInfo.\r
  //\r
  *InfoPointer = HandlerInfo;\r
  return EFI_SUCCESS;\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 tht have been registerd 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
  PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;\r
\r
  ASSERT (ExtractHandlerGuidTable != NULL);\r
\r
  //\r
  // Get all registered handler information\r
  //\r
  Status = PeiGetExtractGuidedSectionHandlerInfo (&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 witg 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
  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_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
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
  PEI_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
\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
  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
  Retrives 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
  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
  PEI_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 = 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
  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
      //\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
  Retrives 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
  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
  PEI_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 = PeiGetExtractGuidedSectionHandlerInfo (&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
Commit	Line	Data
8069d49e	1	/** @file\r
eceb3a4c	2	Provide generic extract guided section functions for PEI phase.\r
0fa00159	3	\r
eceb3a4c	4	Copyright (c) 2007 - 2008, Intel Corporation<BR>\r
8069d49e LG	5	All rights reserved. This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
0fa00159	9	\r
8069d49e LG	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
8069d49e LG	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
0fa00159	12	\r
8069d49e	13	**/\r
0fa00159 LG	14	\r
	15	#include <PiPei.h>\r
	16	\r
	17	#include <Library/DebugLib.h>\r
	18	#include <Library/PcdLib.h>\r
	19	#include <Library/BaseMemoryLib.h>\r
	20	#include <Library/HobLib.h>\r
	21	#include <Library/ExtractGuidedSectionLib.h>\r
	22	\r
	23	#define PEI_EXTRACT_HANDLER_INFO_SIGNATURE EFI_SIGNATURE_32 ('P', 'E', 'H', 'I')\r
	24	\r
	25	typedef struct {\r
	26	UINT32 Signature;\r
	27	UINT32 NumberOfExtractHandler;\r
	28	GUID *ExtractHandlerGuidTable;\r
	29	EXTRACT_GUIDED_SECTION_DECODE_HANDLER *ExtractDecodeHandlerTable;\r
	30	EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *ExtractGetInfoHandlerTable;\r
	31	} PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO;\r
	32	\r
4754c98b	33	/**\r
0fa00159 LG	34	Build guid hob for the global memory to store the registered guid and Handler list.\r
	35	If GuidHob exists, HandlerInfo will be directly got from Guid hob data.\r
	36	\r
4754c98b	37	@param[in, out] InfoPointer Pointer to pei handler info structure.\r
0fa00159 LG	38	\r
0fa00159 LG	39	@retval RETURN_SUCCESS Build Guid hob for the global memory space to store guid and funciton tables.\r
4754c98b	40	@retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.\r
0fa00159 LG	41	**/\r
	42	RETURN_STATUS\r
	43	EFIAPI\r
	44	PeiGetExtractGuidedSectionHandlerInfo (\r
	45	IN OUT PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO **InfoPointer\r
	46	)\r
	47	{\r
	48	PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;\r
	49	EFI_PEI_HOB_POINTERS Hob;\r
	50	\r
	51	//\r
	52	// First try to get handler info from guid hob specified by CallerId.\r
	53	//\r
	54	Hob.Raw = GetNextHob (EFI_HOB_TYPE_GUID_EXTENSION, GetHobList ());\r
	55	while (Hob.Raw != NULL) {\r
	56	if (CompareGuid (&(Hob.Guid->Name), &gEfiCallerIdGuid)) {\r
	57	HandlerInfo = (PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *) GET_GUID_HOB_DATA (Hob.Guid);\r
	58	if (HandlerInfo->Signature == PEI_EXTRACT_HANDLER_INFO_SIGNATURE) {\r
e111752c LG	59	//\r
	60	// Update Table Pointer when hob start address is changed.\r
	61	//\r
	62	if (HandlerInfo->ExtractHandlerGuidTable != (GUID *) (HandlerInfo + 1)) {\r
	63	HandlerInfo->ExtractHandlerGuidTable = (GUID *) (HandlerInfo + 1);\r
	64	HandlerInfo->ExtractDecodeHandlerTable = (EXTRACT_GUIDED_SECTION_DECODE_HANDLER *) (\r
	65	(UINT8 *)HandlerInfo->ExtractHandlerGuidTable + \r
	66	PcdGet32 (PcdMaximumGuidedExtractHandler) * sizeof (GUID)\r
	67	);\r
	68	HandlerInfo->ExtractGetInfoHandlerTable = (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *) (\r
	69	(UINT8 *)HandlerInfo->ExtractDecodeHandlerTable + \r
	70	PcdGet32 (PcdMaximumGuidedExtractHandler) * \r
	71	sizeof (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER)\r
	72	);\r
	73	}\r
	74	//\r
	75	// Return HandlerInfo pointer.\r
	76	//\r
0fa00159 LG	77	*InfoPointer = HandlerInfo;\r
	78	return EFI_SUCCESS;\r
	79	}\r
	80	}\r
	81	Hob.Raw = GET_NEXT_HOB (Hob);\r
	82	Hob.Raw = GetNextHob (EFI_HOB_TYPE_GUID_EXTENSION, Hob.Raw);\r
	83	}\r
	84	\r
	85	//\r
	86	// If Guid Hob is not found, Build CallerId Guid hob to store Handler Info\r
	87	//\r
	88	HandlerInfo = BuildGuidHob (\r
	89	&gEfiCallerIdGuid, \r
	90	sizeof (PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO) +\r
	91	PcdGet32 (PcdMaximumGuidedExtractHandler) * \r
	92	(sizeof (GUID) + sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER) + sizeof (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER))\r
	93	);\r
	94	if (HandlerInfo == NULL) {\r
	95	//\r
	96	// No enough resource to build guid hob.\r
	97	//\r
	98	return EFI_OUT_OF_RESOURCES;\r
	99	}\r
eceb3a4c LG	100	//\r
	101	// Init HandlerInfo structure\r
	102	//\r
0fa00159 LG	103	HandlerInfo->Signature = PEI_EXTRACT_HANDLER_INFO_SIGNATURE;\r
	104	HandlerInfo->NumberOfExtractHandler = 0;\r
	105	HandlerInfo->ExtractHandlerGuidTable = (GUID *) (HandlerInfo + 1);\r
	106	HandlerInfo->ExtractDecodeHandlerTable = (EXTRACT_GUIDED_SECTION_DECODE_HANDLER *) (\r
	107	(UINT8 *)HandlerInfo->ExtractHandlerGuidTable + \r
	108	PcdGet32 (PcdMaximumGuidedExtractHandler) * sizeof (GUID)\r
	109	);\r
	110	HandlerInfo->ExtractGetInfoHandlerTable = (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *) (\r
	111	(UINT8 *)HandlerInfo->ExtractDecodeHandlerTable + \r
	112	PcdGet32 (PcdMaximumGuidedExtractHandler) * \r
	113	sizeof (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER)\r
	114	);\r
eceb3a4c LG	115	//\r
	116	// return the created HandlerInfo.\r
	117	//\r
0fa00159 LG	118	*InfoPointer = HandlerInfo;\r
	119	return EFI_SUCCESS;\r
	120	}\r
	121	\r
4754c98b	122	/**\r
f1db45f8	123	Retrieve the list GUIDs that have been registered through ExtractGuidedSectionRegisterHandlers().\r
0fa00159	124	\r
f1db45f8	125	Sets ExtractHandlerGuidTable so it points at a callee allocated array of registered GUIDs.\r
	126	The total number of GUIDs in the array are returned. Since the array of GUIDs is callee allocated\r
	127	and caller must treat this array of GUIDs as read-only data. \r
	128	If ExtractHandlerGuidTable is NULL, then ASSERT().\r
	129	\r
	130	@param[out] ExtractHandlerGuidTable A pointer to the array of GUIDs tht have been registerd through\r
	131	ExtractGuidedSectionRegisterHandlers().\r
0fa00159	132	\r
4754c98b	133	@return the number of the supported extract guided Handler.\r
f1db45f8	134	\r
0fa00159 LG	135	**/\r
	136	UINTN\r
	137	EFIAPI\r
	138	ExtractGuidedSectionGetGuidList (\r
eceb3a4c	139	OUT GUID **ExtractHandlerGuidTable\r
0fa00159 LG	140	)\r
	141	{\r
	142	EFI_STATUS Status;\r
	143	PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;\r
	144	\r
	145	ASSERT (ExtractHandlerGuidTable != NULL);\r
	146	\r
eceb3a4c LG	147	//\r
	148	// Get all registered handler information\r
	149	//\r
0fa00159 LG	150	Status = PeiGetExtractGuidedSectionHandlerInfo (&HandlerInfo);\r
	151	if (EFI_ERROR (Status)) {\r
	152	return Status;\r
	153	}\r
	154	\r
eceb3a4c LG	155	//\r
	156	// Get GuidTable and Table Number\r
	157	//\r
0fa00159 LG	158	*ExtractHandlerGuidTable = HandlerInfo->ExtractHandlerGuidTable;\r
	159	return HandlerInfo->NumberOfExtractHandler;\r
	160	}\r
	161	\r
4754c98b	162	/**\r
f1db45f8	163	Registers handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and EXTRACT_GUIDED_SECTION_DECODE_HANDLER\r
	164	for a specific GUID section type.\r
	165	\r
	166	Registers the handlers specified by GetInfoHandler and DecodeHandler witg the GUID specified by SectionGuid.\r
	167	If the GUID value specified by SectionGuid has already been registered, then return RETURN_ALREADY_STARTED.\r
	168	If there are not enough resources available to register the handlers then RETURN_OUT_OF_RESOURCES is returned.\r
	169	If SectionGuid is NULL, then ASSERT().\r
	170	If GetInfoHandler is NULL, then ASSERT().\r
	171	If DecodeHandler is NULL, then ASSERT().\r
	172	\r
	173	@param[in] SectionGuid A pointer to the GUID associated with the the handlers\r
	174	of the GUIDed section type being registered.\r
	175	@param[in] GetInfoHandler Pointer to a function that examines a GUIDed section and returns the\r
	176	size of the decoded buffer and the size of an optional scratch buffer\r
	177	required to actually decode the data in a GUIDed section.\r
	178	@param[in] DecodeHandler Pointer to a function that decodes a GUIDed section into a caller\r
	179	allocated output buffer. \r
	180	\r
	181	@retval RETURN_SUCCESS The handlers were registered.\r
	182	@retval RETURN_ALREADY_STARTED Handlers have already been registered for the GUID specified by SectionGuid. \r
	183	@retval RETURN_OUT_OF_RESOURCES There are not enough resources available to register the handlers.\r
4754c98b	184	\r
0fa00159 LG	185	**/\r
	186	RETURN_STATUS\r
	187	EFIAPI\r
	188	ExtractGuidedSectionRegisterHandlers (\r
	189	IN CONST GUID *SectionGuid,\r
	190	IN EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER GetInfoHandler,\r
	191	IN EXTRACT_GUIDED_SECTION_DECODE_HANDLER DecodeHandler\r
	192	)\r
	193	{\r
	194	EFI_STATUS Status;\r
e2701217	195	UINT32 Index;\r
0fa00159 LG	196	PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;\r
	197	\r
	198	//\r
f1db45f8	199	// Check input paramter\r
0fa00159	200	//\r
f1db45f8	201	ASSERT (SectionGuid != NULL);\r
	202	ASSERT (GetInfoHandler != NULL);\r
	203	ASSERT (DecodeHandler != NULL);\r
	204	\r
	205	\r
0fa00159 LG	206	\r
	207	//\r
	208	// Get the registered handler information\r
	209	//\r
	210	Status = PeiGetExtractGuidedSectionHandlerInfo (&HandlerInfo);\r
	211	if (EFI_ERROR (Status)) {\r
	212	return Status;\r
	213	}\r
e2701217 LG	214	\r
	215	//\r
	216	// Search the match registered GetInfo handler for the input guided section.\r
	217	//\r
	218	for (Index = 0; Index < HandlerInfo->NumberOfExtractHandler; Index ++) {\r
e111752c	219	if (CompareGuid (HandlerInfo->ExtractHandlerGuidTable + Index, SectionGuid)) {\r
b911d09f LG	220	//\r
	221	// If the guided handler has been registered before, only update its handler.\r
	222	//\r
	223	HandlerInfo->ExtractDecodeHandlerTable [Index] = DecodeHandler;\r
	224	HandlerInfo->ExtractGetInfoHandlerTable [Index] = GetInfoHandler;\r
	225	return RETURN_SUCCESS;\r
e2701217 LG	226	}\r
	227	}\r
	228	\r
0fa00159 LG	229	//\r
	230	// Check the global table is enough to contain new Handler.\r
	231	//\r
	232	if (HandlerInfo->NumberOfExtractHandler >= PcdGet32 (PcdMaximumGuidedExtractHandler)) {\r
	233	return RETURN_OUT_OF_RESOURCES;\r
	234	}\r
	235	\r
	236	//\r
	237	// Register new Handler and guid value.\r
	238	//\r
e111752c	239	CopyGuid (HandlerInfo->ExtractHandlerGuidTable + HandlerInfo->NumberOfExtractHandler, SectionGuid);\r
0fa00159 LG	240	HandlerInfo->ExtractDecodeHandlerTable [HandlerInfo->NumberOfExtractHandler] = DecodeHandler;\r
	241	HandlerInfo->ExtractGetInfoHandlerTable [HandlerInfo->NumberOfExtractHandler++] = GetInfoHandler;\r
	242	\r
	243	return RETURN_SUCCESS;\r
	244	}\r
	245	\r
4754c98b	246	/**\r
f1db45f8	247	Retrives a GUID from a GUIDed section and uses that GUID to select an associated handler of type\r
	248	EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers().\r
	249	The selected handler is used to retrieve and return the size of the decoded buffer and the size of an\r
	250	optional scratch buffer required to actually decode the data in a GUIDed section.\r
	251	\r
	252	Examines a GUIDed section specified by InputSection. \r
	253	If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(),\r
	254	then RETURN_UNSUPPORTED is returned. \r
	255	If the GUID of InputSection does match the GUID that this handler supports, then the the associated handler \r
	256	of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()\r
	257	is used to retrieve the OututBufferSize, ScratchSize, and Attributes values. The return status from the handler of\r
	258	type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER is returned.\r
	259	If InputSection is NULL, then ASSERT().\r
	260	If OutputBufferSize is NULL, then ASSERT().\r
	261	If ScratchBufferSize is NULL, then ASSERT().\r
	262	If SectionAttribute is NULL, then ASSERT().\r
	263	\r
	264	@param[in] InputSection A pointer to a GUIDed section of an FFS formatted file.\r
	265	@param[out] OutputBufferSize A pointer to the size, in bytes, of an output buffer required if the buffer\r
	266	specified by InputSection were decoded.\r
	267	@param[out] ScratchBufferSize A pointer to the size, in bytes, required as scratch space if the buffer specified by\r
	268	InputSection were decoded.\r
	269	@param[out] SectionAttribute A pointer to the attributes of the GUIDed section. See the Attributes field of\r
	270	EFI_GUID_DEFINED_SECTION in the PI Specification.\r
	271	\r
	272	@retval RETURN_SUCCESS Get the required information successfully.\r
	273	@retval RETURN_UNSUPPORTED The GUID from the section specified by InputSection does not match any of\r
	274	the GUIDs registered with ExtractGuidedSectionRegisterHandlers().\r
	275	@retval Others The return status from the handler associated with the GUID retrieved from\r
	276	the section specified by InputSection.\r
0fa00159 LG	277	\r
	278	**/\r
	279	RETURN_STATUS\r
	280	EFIAPI\r
	281	ExtractGuidedSectionGetInfo (\r
	282	IN CONST VOID *InputSection,\r
	283	OUT UINT32 *OutputBufferSize,\r
	284	OUT UINT32 *ScratchBufferSize,\r
	285	OUT UINT16 *SectionAttribute \r
	286	)\r
	287	{\r
	288	UINT32 Index;\r
	289	EFI_STATUS Status;\r
	290	PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;\r
	291	\r
	292	//\r
	293	// Check input paramter\r
	294	//\r
f1db45f8	295	ASSERT (InputSection != NULL);\r
0fa00159 LG	296	ASSERT (OutputBufferSize != NULL);\r
	297	ASSERT (ScratchBufferSize != NULL);\r
	298	ASSERT (SectionAttribute != NULL);\r
	299	\r
	300	//\r
eceb3a4c	301	// Get all registered handler information.\r
0fa00159 LG	302	//\r
	303	Status = PeiGetExtractGuidedSectionHandlerInfo (&HandlerInfo);\r
	304	if (EFI_ERROR (Status)) {\r
	305	return Status;\r
	306	}\r
	307	\r
	308	//\r
	309	// Search the match registered GetInfo handler for the input guided section.\r
	310	//\r
	311	for (Index = 0; Index < HandlerInfo->NumberOfExtractHandler; Index ++) {\r
e111752c	312	if (CompareGuid (HandlerInfo->ExtractHandlerGuidTable + Index, &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {\r
b911d09f LG	313	//\r
	314	// Call the match handler to getinfo for the input section data.\r
	315	//\r
	316	return HandlerInfo->ExtractGetInfoHandlerTable [Index] (\r
	317	InputSection,\r
	318	OutputBufferSize,\r
	319	ScratchBufferSize,\r
	320	SectionAttribute\r
	321	);\r
0fa00159 LG	322	}\r
	323	}\r
	324	\r
	325	//\r
	326	// Not found, the input guided section is not supported. \r
	327	//\r
b911d09f	328	return RETURN_UNSUPPORTED;\r
0fa00159 LG	329	}\r
0fa00159 LG	330	\r
4754c98b	331	/**\r
f1db45f8	332	Retrives the GUID from a GUIDed section and uses that GUID to select an associated handler of type\r
	333	EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers().\r
	334	The selected handler is used to decode the data in a GUIDed section and return the result in a caller\r
	335	allocated output buffer.\r
	336	\r
	337	Decodes the GUIDed section specified by InputSection. \r
	338	If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(),\r
	339	then RETURN_UNSUPPORTED is returned. \r
	340	If the GUID of InputSection does match the GUID that this handler supports, then the the associated handler\r
	341	of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()\r
	342	is used to decode InputSection into the buffer specified by OutputBuffer and the authentication status of this\r
	343	decode operation is returned in AuthenticationStatus. If the decoded buffer is identical to the data in InputSection,\r
	344	then OutputBuffer is set to point at the data in InputSection. Otherwise, the decoded data will be placed in caller\r
	345	allocated buffer specified by OutputBuffer. This function is responsible for computing the EFI_AUTH_STATUS_PLATFORM_OVERRIDE\r
	346	bit of in AuthenticationStatus. The return status from the handler of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER is returned. \r
	347	If InputSection is NULL, then ASSERT().\r
	348	If OutputBuffer is NULL, then ASSERT().\r
	349	If ScratchBuffer is NULL and this decode operation requires a scratch buffer, then ASSERT().\r
	350	If AuthenticationStatus is NULL, then ASSERT(). \r
	351	\r
	352	@param[in] InputSection A pointer to a GUIDed section of an FFS formatted file.\r
	353	@param[out] OutputBuffer A pointer to a buffer that contains the result of a decode operation. \r
	354	@param[in] ScratchBuffer A caller allocated buffer that may be required by this function as a scratch buffer to perform the decode operation. \r
0fa00159	355	@param[out] AuthenticationStatus \r
f1db45f8	356	A pointer to the authentication status of the decoded output buffer. See the definition\r
	357	of authentication status in the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI section of the PI\r
	358	Specification.\r
4754c98b	359	\r
f1db45f8	360	@retval RETURN_SUCCESS The buffer specified by InputSection was decoded.\r
	361	@retval RETURN_UNSUPPORTED The section specified by InputSection does not match the GUID this handler supports.\r
	362	@retval RETURN_INVALID_PARAMETER The section specified by InputSection can not be decoded.\r
4754c98b	363	\r
0fa00159 LG	364	**/\r
	365	RETURN_STATUS\r
	366	EFIAPI\r
	367	ExtractGuidedSectionDecode (\r
	368	IN CONST VOID *InputSection,\r
	369	OUT VOID **OutputBuffer,\r
f1db45f8	370	IN VOID *ScratchBuffer, OPTIONAL\r
0fa00159 LG	371	OUT UINT32 *AuthenticationStatus \r
	372	)\r
	373	{\r
	374	UINT32 Index;\r
	375	EFI_STATUS Status;\r
	376	PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;\r
	377	\r
eceb3a4c LG	378	//\r
	379	// Check input parameter\r
	380	//\r
f1db45f8	381	ASSERT (InputSection != NULL);\r
0fa00159 LG	382	ASSERT (OutputBuffer != NULL);\r
0fa00159 LG	383	ASSERT (AuthenticationStatus != NULL);\r
eceb3a4c LG	384	\r
	385	//\r
	386	// Get all registered handler information.\r
	387	// \r
0fa00159 LG	388	Status = PeiGetExtractGuidedSectionHandlerInfo (&HandlerInfo);\r
	389	if (EFI_ERROR (Status)) {\r
	390	return Status;\r
	391	}\r
	392	\r
	393	//\r
eceb3a4c	394	// Search the match registered Extract handler for the input guided section.\r
0fa00159 LG	395	//\r
0fa00159 LG	396	for (Index = 0; Index < HandlerInfo->NumberOfExtractHandler; Index ++) {\r
e111752c	397	if (CompareGuid (HandlerInfo->ExtractHandlerGuidTable + Index, &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {\r
b911d09f LG	398	//\r
	399	// Call the match handler to extract raw data for the input guided section.\r
	400	//\r
	401	return HandlerInfo->ExtractDecodeHandlerTable [Index] (\r
	402	InputSection,\r
	403	OutputBuffer,\r
	404	ScratchBuffer,\r
	405	AuthenticationStatus\r
	406	);\r
0fa00159 LG	407	}\r
	408	}\r
	409	\r
	410	//\r
	411	// Not found, the input guided section is not supported. \r
	412	//\r
b911d09f	413	return RETURN_UNSUPPORTED;\r
0fa00159	414	}\r