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

/** @file\r
  Provide generic extract guided section functions for PEI phase.\r
\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
\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 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   The 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
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_DECODE_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
    *InfoPointer = NULL;\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_DECODE_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 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
  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
    *ExtractHandlerGuidTable = NULL;\r
    return 0;\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 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  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_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
  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
  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 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
  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
b9d5a7f1	4	Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
19388d29	5	This program and the accompanying materials\r
8069d49e LG	6	are licensed and made available under the terms and conditions of the BSD License\r
8069d49e LG	7	which accompanies this distribution. The full text of the license may be found at\r
2fc59a00	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
07636730	23	#define PEI_EXTRACT_HANDLER_INFO_SIGNATURE SIGNATURE_32 ('P', 'E', 'H', 'I')\r
0fa00159 LG	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
2fc59a00	37	@param[in, out] InfoPointer The pointer to pei handler info structure.\r
0fa00159	38	\r
3e5c3238	39	@retval RETURN_SUCCESS Build Guid hob for the global memory space to store guid and function tables.\r
4754c98b	40	@retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.\r
0fa00159 LG	41	**/\r
0fa00159 LG	42	RETURN_STATUS\r
0fa00159 LG	43	PeiGetExtractGuidedSectionHandlerInfo (\r
	44	IN OUT PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO **InfoPointer\r
	45	)\r
	46	{\r
	47	PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;\r
	48	EFI_PEI_HOB_POINTERS Hob;\r
	49	\r
	50	//\r
	51	// First try to get handler info from guid hob specified by CallerId.\r
	52	//\r
	53	Hob.Raw = GetNextHob (EFI_HOB_TYPE_GUID_EXTENSION, GetHobList ());\r
	54	while (Hob.Raw != NULL) {\r
	55	if (CompareGuid (&(Hob.Guid->Name), &gEfiCallerIdGuid)) {\r
	56	HandlerInfo = (PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *) GET_GUID_HOB_DATA (Hob.Guid);\r
	57	if (HandlerInfo->Signature == PEI_EXTRACT_HANDLER_INFO_SIGNATURE) {\r
e111752c LG	58	//\r
	59	// Update Table Pointer when hob start address is changed.\r
	60	//\r
	61	if (HandlerInfo->ExtractHandlerGuidTable != (GUID *) (HandlerInfo + 1)) {\r
	62	HandlerInfo->ExtractHandlerGuidTable = (GUID *) (HandlerInfo + 1);\r
	63	HandlerInfo->ExtractDecodeHandlerTable = (EXTRACT_GUIDED_SECTION_DECODE_HANDLER *) (\r
	64	(UINT8 *)HandlerInfo->ExtractHandlerGuidTable + \r
	65	PcdGet32 (PcdMaximumGuidedExtractHandler) * sizeof (GUID)\r
	66	);\r
	67	HandlerInfo->ExtractGetInfoHandlerTable = (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *) (\r
	68	(UINT8 *)HandlerInfo->ExtractDecodeHandlerTable + \r
	69	PcdGet32 (PcdMaximumGuidedExtractHandler) * \r
b9d5a7f1	70	sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER)\r
e111752c LG	71	);\r
	72	}\r
	73	//\r
	74	// Return HandlerInfo pointer.\r
	75	//\r
0fa00159 LG	76	*InfoPointer = HandlerInfo;\r
	77	return EFI_SUCCESS;\r
	78	}\r
	79	}\r
	80	Hob.Raw = GET_NEXT_HOB (Hob);\r
	81	Hob.Raw = GetNextHob (EFI_HOB_TYPE_GUID_EXTENSION, Hob.Raw);\r
	82	}\r
	83	\r
	84	//\r
	85	// If Guid Hob is not found, Build CallerId Guid hob to store Handler Info\r
	86	//\r
	87	HandlerInfo = BuildGuidHob (\r
	88	&gEfiCallerIdGuid, \r
	89	sizeof (PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO) +\r
	90	PcdGet32 (PcdMaximumGuidedExtractHandler) * \r
	91	(sizeof (GUID) + sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER) + sizeof (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER))\r
	92	);\r
	93	if (HandlerInfo == NULL) {\r
	94	//\r
	95	// No enough resource to build guid hob.\r
	96	//\r
b9d5a7f1	97	*InfoPointer = NULL;\r
0fa00159 LG	98	return EFI_OUT_OF_RESOURCES;\r
0fa00159 LG	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
b9d5a7f1	113	sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER)\r
0fa00159	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
3e5c3238	130	@param[out] ExtractHandlerGuidTable A pointer to the array of GUIDs that have been registered through\r
f1db45f8	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
0fa00159 LG	151	if (EFI_ERROR (Status)) {\r
b9d5a7f1 LG	152	*ExtractHandlerGuidTable = NULL;\r
b9d5a7f1 LG	153	return 0;\r
0fa00159 LG	154	}\r
0fa00159 LG	155	\r
eceb3a4c LG	156	//\r
	157	// Get GuidTable and Table Number\r
	158	//\r
0fa00159 LG	159	*ExtractHandlerGuidTable = HandlerInfo->ExtractHandlerGuidTable;\r
	160	return HandlerInfo->NumberOfExtractHandler;\r
	161	}\r
	162	\r
4754c98b	163	/**\r
f1db45f8	164	Registers handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and EXTRACT_GUIDED_SECTION_DECODE_HANDLER\r
	165	for a specific GUID section type.\r
	166	\r
3e5c3238	167	Registers the handlers specified by GetInfoHandler and DecodeHandler with the GUID specified by SectionGuid.\r
f1db45f8	168	If the GUID value specified by SectionGuid has already been registered, then return RETURN_ALREADY_STARTED.\r
f1db45f8	169	If there are not enough resources available to register the handlers then RETURN_OUT_OF_RESOURCES is returned.\r
3e5c3238	170	\r
f1db45f8	171	If SectionGuid is NULL, then ASSERT().\r
	172	If GetInfoHandler is NULL, then ASSERT().\r
	173	If DecodeHandler is NULL, then ASSERT().\r
	174	\r
	175	@param[in] SectionGuid A pointer to the GUID associated with the the handlers\r
	176	of the GUIDed section type being registered.\r
2fc59a00	177	@param[in] GetInfoHandler The pointer to a function that examines a GUIDed section and returns the\r
f1db45f8	178	size of the decoded buffer and the size of an optional scratch buffer\r
f1db45f8	179	required to actually decode the data in a GUIDed section.\r
2fc59a00	180	@param[in] DecodeHandler The pointer to a function that decodes a GUIDed section into a caller\r
f1db45f8	181	allocated output buffer. \r
	182	\r
	183	@retval RETURN_SUCCESS The handlers were registered.\r
f1db45f8	184	@retval RETURN_OUT_OF_RESOURCES There are not enough resources available to register the handlers.\r
4754c98b	185	\r
0fa00159 LG	186	**/\r
	187	RETURN_STATUS\r
	188	EFIAPI\r
	189	ExtractGuidedSectionRegisterHandlers (\r
	190	IN CONST GUID *SectionGuid,\r
	191	IN EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER GetInfoHandler,\r
	192	IN EXTRACT_GUIDED_SECTION_DECODE_HANDLER DecodeHandler\r
	193	)\r
	194	{\r
	195	EFI_STATUS Status;\r
e2701217	196	UINT32 Index;\r
0fa00159 LG	197	PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;\r
	198	\r
	199	//\r
f1db45f8	200	// Check input paramter\r
0fa00159	201	//\r
f1db45f8	202	ASSERT (SectionGuid != NULL);\r
	203	ASSERT (GetInfoHandler != NULL);\r
	204	ASSERT (DecodeHandler != NULL);\r
	205	\r
	206	\r
0fa00159 LG	207	\r
	208	//\r
	209	// Get the registered handler information\r
	210	//\r
	211	Status = PeiGetExtractGuidedSectionHandlerInfo (&HandlerInfo);\r
	212	if (EFI_ERROR (Status)) {\r
	213	return Status;\r
	214	}\r
e2701217 LG	215	\r
	216	//\r
	217	// Search the match registered GetInfo handler for the input guided section.\r
	218	//\r
	219	for (Index = 0; Index < HandlerInfo->NumberOfExtractHandler; Index ++) {\r
e111752c	220	if (CompareGuid (HandlerInfo->ExtractHandlerGuidTable + Index, SectionGuid)) {\r
b911d09f LG	221	//\r
	222	// If the guided handler has been registered before, only update its handler.\r
	223	//\r
	224	HandlerInfo->ExtractDecodeHandlerTable [Index] = DecodeHandler;\r
	225	HandlerInfo->ExtractGetInfoHandlerTable [Index] = GetInfoHandler;\r
	226	return RETURN_SUCCESS;\r
e2701217 LG	227	}\r
	228	}\r
	229	\r
0fa00159 LG	230	//\r
	231	// Check the global table is enough to contain new Handler.\r
	232	//\r
	233	if (HandlerInfo->NumberOfExtractHandler >= PcdGet32 (PcdMaximumGuidedExtractHandler)) {\r
	234	return RETURN_OUT_OF_RESOURCES;\r
	235	}\r
	236	\r
	237	//\r
	238	// Register new Handler and guid value.\r
	239	//\r
e111752c	240	CopyGuid (HandlerInfo->ExtractHandlerGuidTable + HandlerInfo->NumberOfExtractHandler, SectionGuid);\r
0fa00159 LG	241	HandlerInfo->ExtractDecodeHandlerTable [HandlerInfo->NumberOfExtractHandler] = DecodeHandler;\r
0fa00159 LG	242	HandlerInfo->ExtractGetInfoHandlerTable [HandlerInfo->NumberOfExtractHandler++] = GetInfoHandler;\r
b9d5a7f1	243	\r
0fa00159 LG	244	return RETURN_SUCCESS;\r
	245	}\r
	246	\r
4754c98b	247	/**\r
3e5c3238	248	Retrieves a GUID from a GUIDed section and uses that GUID to select an associated handler of type\r
f1db45f8	249	EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers().\r
	250	The selected handler is used to retrieve and return the size of the decoded buffer and the size of an\r
	251	optional scratch buffer required to actually decode the data in a GUIDed section.\r
	252	\r
	253	Examines a GUIDed section specified by InputSection. \r
	254	If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(),\r
	255	then RETURN_UNSUPPORTED is returned. \r
	256	If the GUID of InputSection does match the GUID that this handler supports, then the the associated handler \r
	257	of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()\r
	258	is used to retrieve the OututBufferSize, ScratchSize, and Attributes values. The return status from the handler of\r
	259	type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER is returned.\r
3e5c3238	260	\r
f1db45f8	261	If InputSection is NULL, then ASSERT().\r
	262	If OutputBufferSize is NULL, then ASSERT().\r
	263	If ScratchBufferSize is NULL, then ASSERT().\r
	264	If SectionAttribute is NULL, then ASSERT().\r
	265	\r
	266	@param[in] InputSection A pointer to a GUIDed section of an FFS formatted file.\r
	267	@param[out] OutputBufferSize A pointer to the size, in bytes, of an output buffer required if the buffer\r
	268	specified by InputSection were decoded.\r
	269	@param[out] ScratchBufferSize A pointer to the size, in bytes, required as scratch space if the buffer specified by\r
	270	InputSection were decoded.\r
	271	@param[out] SectionAttribute A pointer to the attributes of the GUIDed section. See the Attributes field of\r
	272	EFI_GUID_DEFINED_SECTION in the PI Specification.\r
	273	\r
	274	@retval RETURN_SUCCESS Get the required information successfully.\r
	275	@retval RETURN_UNSUPPORTED The GUID from the section specified by InputSection does not match any of\r
	276	the GUIDs registered with ExtractGuidedSectionRegisterHandlers().\r
	277	@retval Others The return status from the handler associated with the GUID retrieved from\r
	278	the section specified by InputSection.\r
0fa00159 LG	279	\r
	280	**/\r
	281	RETURN_STATUS\r
	282	EFIAPI\r
	283	ExtractGuidedSectionGetInfo (\r
	284	IN CONST VOID *InputSection,\r
	285	OUT UINT32 *OutputBufferSize,\r
	286	OUT UINT32 *ScratchBufferSize,\r
	287	OUT UINT16 *SectionAttribute \r
	288	)\r
	289	{\r
	290	UINT32 Index;\r
	291	EFI_STATUS Status;\r
	292	PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;\r
	293	\r
	294	//\r
	295	// Check input paramter\r
	296	//\r
f1db45f8	297	ASSERT (InputSection != NULL);\r
0fa00159 LG	298	ASSERT (OutputBufferSize != NULL);\r
	299	ASSERT (ScratchBufferSize != NULL);\r
	300	ASSERT (SectionAttribute != NULL);\r
	301	\r
	302	//\r
eceb3a4c	303	// Get all registered handler information.\r
0fa00159 LG	304	//\r
	305	Status = PeiGetExtractGuidedSectionHandlerInfo (&HandlerInfo);\r
	306	if (EFI_ERROR (Status)) {\r
	307	return Status;\r
	308	}\r
	309	\r
	310	//\r
	311	// Search the match registered GetInfo handler for the input guided section.\r
	312	//\r
	313	for (Index = 0; Index < HandlerInfo->NumberOfExtractHandler; Index ++) {\r
e111752c	314	if (CompareGuid (HandlerInfo->ExtractHandlerGuidTable + Index, &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {\r
b911d09f	315	//\r
3e5c3238	316	// Call the match handler to get info for the input section data.\r
b911d09f LG	317	//\r
	318	return HandlerInfo->ExtractGetInfoHandlerTable [Index] (\r
	319	InputSection,\r
	320	OutputBufferSize,\r
	321	ScratchBufferSize,\r
	322	SectionAttribute\r
	323	);\r
0fa00159 LG	324	}\r
	325	}\r
	326	\r
	327	//\r
	328	// Not found, the input guided section is not supported. \r
	329	//\r
b911d09f	330	return RETURN_UNSUPPORTED;\r
0fa00159 LG	331	}\r
0fa00159 LG	332	\r
4754c98b	333	/**\r
3e5c3238	334	Retrieves the GUID from a GUIDed section and uses that GUID to select an associated handler of type\r
f1db45f8	335	EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers().\r
	336	The selected handler is used to decode the data in a GUIDed section and return the result in a caller\r
	337	allocated output buffer.\r
	338	\r
	339	Decodes the GUIDed section specified by InputSection. \r
	340	If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(),\r
	341	then RETURN_UNSUPPORTED is returned. \r
	342	If the GUID of InputSection does match the GUID that this handler supports, then the the associated handler\r
	343	of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()\r
	344	is used to decode InputSection into the buffer specified by OutputBuffer and the authentication status of this\r
	345	decode operation is returned in AuthenticationStatus. If the decoded buffer is identical to the data in InputSection,\r
	346	then OutputBuffer is set to point at the data in InputSection. Otherwise, the decoded data will be placed in caller\r
	347	allocated buffer specified by OutputBuffer. This function is responsible for computing the EFI_AUTH_STATUS_PLATFORM_OVERRIDE\r
3e5c3238	348	bit of in AuthenticationStatus. The return status from the handler of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER is returned. \r
3e5c3238	349	\r
f1db45f8	350	If InputSection is NULL, then ASSERT().\r
	351	If OutputBuffer is NULL, then ASSERT().\r
	352	If ScratchBuffer is NULL and this decode operation requires a scratch buffer, then ASSERT().\r
	353	If AuthenticationStatus is NULL, then ASSERT(). \r
	354	\r
	355	@param[in] InputSection A pointer to a GUIDed section of an FFS formatted file.\r
	356	@param[out] OutputBuffer A pointer to a buffer that contains the result of a decode operation. \r
	357	@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	358	@param[out] AuthenticationStatus \r
f1db45f8	359	A pointer to the authentication status of the decoded output buffer. See the definition\r
	360	of authentication status in the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI section of the PI\r
	361	Specification.\r
4754c98b	362	\r
f1db45f8	363	@retval RETURN_SUCCESS The buffer specified by InputSection was decoded.\r
	364	@retval RETURN_UNSUPPORTED The section specified by InputSection does not match the GUID this handler supports.\r
	365	@retval RETURN_INVALID_PARAMETER The section specified by InputSection can not be decoded.\r
4754c98b	366	\r
0fa00159 LG	367	**/\r
	368	RETURN_STATUS\r
	369	EFIAPI\r
	370	ExtractGuidedSectionDecode (\r
	371	IN CONST VOID *InputSection,\r
	372	OUT VOID **OutputBuffer,\r
f1db45f8	373	IN VOID *ScratchBuffer, OPTIONAL\r
0fa00159 LG	374	OUT UINT32 *AuthenticationStatus \r
	375	)\r
	376	{\r
	377	UINT32 Index;\r
	378	EFI_STATUS Status;\r
	379	PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;\r
	380	\r
eceb3a4c LG	381	//\r
	382	// Check input parameter\r
	383	//\r
f1db45f8	384	ASSERT (InputSection != NULL);\r
0fa00159 LG	385	ASSERT (OutputBuffer != NULL);\r
0fa00159 LG	386	ASSERT (AuthenticationStatus != NULL);\r
eceb3a4c LG	387	\r
	388	//\r
	389	// Get all registered handler information.\r
	390	// \r
0fa00159 LG	391	Status = PeiGetExtractGuidedSectionHandlerInfo (&HandlerInfo);\r
	392	if (EFI_ERROR (Status)) {\r
	393	return Status;\r
	394	}\r
	395	\r
	396	//\r
eceb3a4c	397	// Search the match registered Extract handler for the input guided section.\r
0fa00159 LG	398	//\r
0fa00159 LG	399	for (Index = 0; Index < HandlerInfo->NumberOfExtractHandler; Index ++) {\r
e111752c	400	if (CompareGuid (HandlerInfo->ExtractHandlerGuidTable + Index, &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {\r
b911d09f LG	401	//\r
	402	// Call the match handler to extract raw data for the input guided section.\r
	403	//\r
	404	return HandlerInfo->ExtractDecodeHandlerTable [Index] (\r
	405	InputSection,\r
	406	OutputBuffer,\r
	407	ScratchBuffer,\r
	408	AuthenticationStatus\r
	409	);\r
0fa00159 LG	410	}\r
	411	}\r
	412	\r
	413	//\r
	414	// Not found, the input guided section is not supported. \r
	415	//\r
b911d09f	416	return RETURN_UNSUPPORTED;\r
0fa00159	417	}\r