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

/** @file\r
  Provide generic extract guided section functions for Dxe phase.\r
\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
\r
**/\r
\r
#include <PiDxe.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/ExtractGuidedSectionLib.h>\r
\r
#define EXTRACT_HANDLER_TABLE_SIZE   0x10\r
\r
UINT32               mNumberOfExtractHandler = 0;\r
UINT32               mMaxNumberOfExtractHandler = 0;\r
\r
GUID                 *mExtractHandlerGuidTable = NULL;\r
EXTRACT_GUIDED_SECTION_DECODE_HANDLER   *mExtractDecodeHandlerTable = NULL;\r
EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *mExtractGetInfoHandlerTable = NULL;\r
\r
/**\r
  Reallocates more global memory to store the registered guid and Handler list.\r
\r
  @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
ReallocateExtractHandlerTable (\r
  )\r
{ \r
  //\r
  // Reallocate memory for GuidTable\r
  //\r
  mExtractHandlerGuidTable = ReallocatePool (\r
                               mMaxNumberOfExtractHandler * sizeof (GUID), \r
                               (mMaxNumberOfExtractHandler + EXTRACT_HANDLER_TABLE_SIZE) * sizeof (GUID), \r
                               mExtractHandlerGuidTable\r
                             );\r
\r
  if (mExtractHandlerGuidTable == NULL) {\r
    goto Done;\r
  }\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
    goto Done;\r
  }\r
\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
    goto Done;\r
  }\r
  \r
  //\r
  // Increase max handler number\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
/**\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
  ASSERT (ExtractHandlerGuidTable != NULL);\r
\r
  *ExtractHandlerGuidTable = mExtractHandlerGuidTable;\r
  return mNumberOfExtractHandler;\r
}\r
\r
/**\r
  Registers handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and EXTRACT_GUIDED_SECTION_DECODE_HANDLER\r
  for a specific GUID section type.\r
\r
  Registers the handlers specified by GetInfoHandler and DecodeHandler with the GUID specified by SectionGuid.\r
  If the GUID value specified by SectionGuid has already been registered, then return RETURN_ALREADY_STARTED.\r
  If there are not enough resources available to register the handlers  then RETURN_OUT_OF_RESOURCES is returned.\r
  \r
  If SectionGuid is NULL, then ASSERT().\r
  If GetInfoHandler is NULL, then ASSERT().\r
  If DecodeHandler is NULL, then ASSERT().\r
\r
  @param[in]  SectionGuid    A pointer to the GUID associated with the the handlers\r
                             of the GUIDed section type being registered.\r
  @param[in]  GetInfoHandler Pointer to a function that examines a GUIDed section and returns the\r
                             size of the decoded buffer and the size of an optional scratch buffer\r
                             required to actually decode the data in a GUIDed section.\r
  @param[in]  DecodeHandler  Pointer to a function that decodes a GUIDed section into a caller\r
                             allocated output buffer. \r
\r
  @retval  RETURN_SUCCESS           The handlers were registered.\r
  @retval  RETURN_OUT_OF_RESOURCES  There are not enough resources available to register the handlers.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
ExtractGuidedSectionRegisterHandlers (\r
  IN CONST  GUID                                     *SectionGuid,\r
  IN        EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER  GetInfoHandler,\r
  IN        EXTRACT_GUIDED_SECTION_DECODE_HANDLER    DecodeHandler\r
  )\r
{\r
  UINT32 Index;\r
  //\r
  // Check input paramter.\r
  //\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 >= mMaxNumberOfExtractHandler) {\r
    if (ReallocateExtractHandlerTable () != RETURN_SUCCESS) {\r
      return RETURN_OUT_OF_RESOURCES;\r
    }\r
  }\r
  \r
  //\r
  // Register new Handler and guid value.\r
  //\r
  CopyGuid (&mExtractHandlerGuidTable [mNumberOfExtractHandler], SectionGuid);\r
  mExtractDecodeHandlerTable [mNumberOfExtractHandler] = DecodeHandler;\r
  mExtractGetInfoHandlerTable [mNumberOfExtractHandler++] = 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
\r
  ASSERT (InputSection != NULL);  \r
  ASSERT (OutputBufferSize != NULL);\r
  ASSERT (ScratchBufferSize != NULL);\r
  ASSERT (SectionAttribute != 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], &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {\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
  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
  \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 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
      //\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
  return RETURN_UNSUPPORTED;\r
}\r
Commit	Line	Data
	1	/** @file\r
	2	Provide generic extract guided section functions for Dxe phase.\r
	3	\r
	4	Copyright (c) 2007 - 2008, Intel Corporation. All rights reserved.<BR>\r
	5	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
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
	13	**/\r
	14	\r
	15	#include <PiDxe.h>\r
	16	\r
	17	#include <Library/DebugLib.h>\r
	18	#include <Library/BaseMemoryLib.h>\r
	19	#include <Library/MemoryAllocationLib.h>\r
	20	#include <Library/ExtractGuidedSectionLib.h>\r
	21	\r
	22	#define EXTRACT_HANDLER_TABLE_SIZE 0x10\r
	23	\r
	24	UINT32 mNumberOfExtractHandler = 0;\r
	25	UINT32 mMaxNumberOfExtractHandler = 0;\r
	26	\r
	27	GUID *mExtractHandlerGuidTable = NULL;\r
	28	EXTRACT_GUIDED_SECTION_DECODE_HANDLER *mExtractDecodeHandlerTable = NULL;\r
	29	EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *mExtractGetInfoHandlerTable = NULL;\r
	30	\r
	31	/**\r
	32	Reallocates more global memory to store the registered guid and Handler list.\r
	33	\r
	34	@retval RETURN_SUCCESS Reallocate more global memory space to store guid and function tables.\r
	35	@retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.\r
	36	**/\r
	37	RETURN_STATUS\r
	38	EFIAPI\r
	39	ReallocateExtractHandlerTable (\r
	40	)\r
	41	{ \r
	42	//\r
	43	// Reallocate memory for GuidTable\r
	44	//\r
	45	mExtractHandlerGuidTable = ReallocatePool (\r
	46	mMaxNumberOfExtractHandler * sizeof (GUID), \r
	47	(mMaxNumberOfExtractHandler + EXTRACT_HANDLER_TABLE_SIZE) * sizeof (GUID), \r
	48	mExtractHandlerGuidTable\r
	49	);\r
	50	\r
	51	if (mExtractHandlerGuidTable == NULL) {\r
	52	goto Done;\r
	53	}\r
	54	\r
	55	//\r
	56	// Reallocate memory for Decode handler Table\r
	57	//\r
	58	mExtractDecodeHandlerTable = ReallocatePool (\r
	59	mMaxNumberOfExtractHandler * sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER), \r
	60	(mMaxNumberOfExtractHandler + EXTRACT_HANDLER_TABLE_SIZE) * sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER), \r
	61	mExtractDecodeHandlerTable\r
	62	);\r
	63	\r
	64	if (mExtractDecodeHandlerTable == NULL) {\r
	65	goto Done;\r
	66	}\r
	67	\r
	68	//\r
	69	// Reallocate memory for GetInfo handler Table\r
	70	//\r
	71	mExtractGetInfoHandlerTable = ReallocatePool (\r
	72	mMaxNumberOfExtractHandler * sizeof (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER), \r
	73	(mMaxNumberOfExtractHandler + EXTRACT_HANDLER_TABLE_SIZE) * sizeof (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER), \r
	74	mExtractGetInfoHandlerTable\r
	75	);\r
	76	\r
	77	if (mExtractGetInfoHandlerTable == NULL) {\r
	78	goto Done;\r
	79	}\r
	80	\r
	81	//\r
	82	// Increase max handler number\r
	83	//\r
	84	mMaxNumberOfExtractHandler = mMaxNumberOfExtractHandler + EXTRACT_HANDLER_TABLE_SIZE;\r
	85	return RETURN_SUCCESS;\r
	86	\r
	87	Done:\r
	88	if (mExtractHandlerGuidTable != NULL) {\r
	89	FreePool (mExtractHandlerGuidTable);\r
	90	}\r
	91	if (mExtractDecodeHandlerTable != NULL) {\r
	92	FreePool (mExtractDecodeHandlerTable);\r
	93	}\r
	94	if (mExtractGetInfoHandlerTable != NULL) {\r
	95	FreePool (mExtractGetInfoHandlerTable);\r
	96	}\r
	97	\r
	98	return RETURN_OUT_OF_RESOURCES;\r
	99	}\r
	100	/**\r
	101	Constructor allocates the global memory to store the registered guid and Handler list.\r
	102	\r
	103	@param ImageHandle The firmware allocated handle for the EFI image.\r
	104	@param SystemTable A pointer to the EFI System Table.\r
	105	\r
	106	@retval RETURN_SUCCESS Allocate the global memory space to store guid and function tables.\r
	107	@retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.\r
	108	**/\r
	109	RETURN_STATUS\r
	110	EFIAPI\r
	111	DxeExtractGuidedSectionLibConstructor (\r
	112	IN EFI_HANDLE ImageHandle,\r
	113	IN EFI_SYSTEM_TABLE *SystemTable\r
	114	)\r
	115	{\r
	116	return ReallocateExtractHandlerTable ();\r
	117	}\r
	118	\r
	119	/**\r
	120	Retrieve the list GUIDs that have been registered through ExtractGuidedSectionRegisterHandlers().\r
	121	\r
	122	Sets ExtractHandlerGuidTable so it points at a callee allocated array of registered GUIDs.\r
	123	The total number of GUIDs in the array are returned. Since the array of GUIDs is callee allocated\r
	124	and caller must treat this array of GUIDs as read-only data. \r
	125	If ExtractHandlerGuidTable is NULL, then ASSERT().\r
	126	\r
	127	@param[out] ExtractHandlerGuidTable A pointer to the array of GUIDs that have been registered through\r
	128	ExtractGuidedSectionRegisterHandlers().\r
	129	\r
	130	@return the number of the supported extract guided Handler.\r
	131	\r
	132	**/\r
	133	UINTN\r
	134	EFIAPI\r
	135	ExtractGuidedSectionGetGuidList (\r
	136	OUT GUID **ExtractHandlerGuidTable\r
	137	)\r
	138	{\r
	139	ASSERT (ExtractHandlerGuidTable != NULL);\r
	140	\r
	141	*ExtractHandlerGuidTable = mExtractHandlerGuidTable;\r
	142	return mNumberOfExtractHandler;\r
	143	}\r
	144	\r
	145	/**\r
	146	Registers handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and EXTRACT_GUIDED_SECTION_DECODE_HANDLER\r
	147	for a specific GUID section type.\r
	148	\r
	149	Registers the handlers specified by GetInfoHandler and DecodeHandler with the GUID specified by SectionGuid.\r
	150	If the GUID value specified by SectionGuid has already been registered, then return RETURN_ALREADY_STARTED.\r
	151	If there are not enough resources available to register the handlers then RETURN_OUT_OF_RESOURCES is returned.\r
	152	\r
	153	If SectionGuid is NULL, then ASSERT().\r
	154	If GetInfoHandler is NULL, then ASSERT().\r
	155	If DecodeHandler is NULL, then ASSERT().\r
	156	\r
	157	@param[in] SectionGuid A pointer to the GUID associated with the the handlers\r
	158	of the GUIDed section type being registered.\r
	159	@param[in] GetInfoHandler Pointer to a function that examines a GUIDed section and returns the\r
	160	size of the decoded buffer and the size of an optional scratch buffer\r
	161	required to actually decode the data in a GUIDed section.\r
	162	@param[in] DecodeHandler Pointer to a function that decodes a GUIDed section into a caller\r
	163	allocated output buffer. \r
	164	\r
	165	@retval RETURN_SUCCESS The handlers were registered.\r
	166	@retval RETURN_OUT_OF_RESOURCES There are not enough resources available to register the handlers.\r
	167	\r
	168	**/\r
	169	RETURN_STATUS\r
	170	EFIAPI\r
	171	ExtractGuidedSectionRegisterHandlers (\r
	172	IN CONST GUID *SectionGuid,\r
	173	IN EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER GetInfoHandler,\r
	174	IN EXTRACT_GUIDED_SECTION_DECODE_HANDLER DecodeHandler\r
	175	)\r
	176	{\r
	177	UINT32 Index;\r
	178	//\r
	179	// Check input paramter.\r
	180	//\r
	181	ASSERT (SectionGuid != NULL);\r
	182	ASSERT (GetInfoHandler != NULL);\r
	183	ASSERT (DecodeHandler != NULL);\r
	184	\r
	185	//\r
	186	// Search the match registered GetInfo handler for the input guided section.\r
	187	//\r
	188	for (Index = 0; Index < mNumberOfExtractHandler; Index ++) {\r
	189	if (CompareGuid (&mExtractHandlerGuidTable[Index], SectionGuid)) {\r
	190	//\r
	191	// If the guided handler has been registered before, only update its handler.\r
	192	//\r
	193	mExtractDecodeHandlerTable [Index] = DecodeHandler;\r
	194	mExtractGetInfoHandlerTable [Index] = GetInfoHandler;\r
	195	return RETURN_SUCCESS;\r
	196	}\r
	197	}\r
	198	\r
	199	//\r
	200	// Check the global table is enough to contain new Handler.\r
	201	//\r
	202	if (mNumberOfExtractHandler >= mMaxNumberOfExtractHandler) {\r
	203	if (ReallocateExtractHandlerTable () != RETURN_SUCCESS) {\r
	204	return RETURN_OUT_OF_RESOURCES;\r
	205	}\r
	206	}\r
	207	\r
	208	//\r
	209	// Register new Handler and guid value.\r
	210	//\r
	211	CopyGuid (&mExtractHandlerGuidTable [mNumberOfExtractHandler], SectionGuid);\r
	212	mExtractDecodeHandlerTable [mNumberOfExtractHandler] = DecodeHandler;\r
	213	mExtractGetInfoHandlerTable [mNumberOfExtractHandler++] = GetInfoHandler;\r
	214	\r
	215	return RETURN_SUCCESS;\r
	216	}\r
	217	\r
	218	/**\r
	219	Retrieves a GUID from a GUIDed section and uses that GUID to select an associated handler of type\r
	220	EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers().\r
	221	The selected handler is used to retrieve and return the size of the decoded buffer and the size of an\r
	222	optional scratch buffer required to actually decode the data in a GUIDed section.\r
	223	\r
	224	Examines a GUIDed section specified by InputSection. \r
	225	If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(),\r
	226	then RETURN_UNSUPPORTED is returned. \r
	227	If the GUID of InputSection does match the GUID that this handler supports, then the the associated handler \r
	228	of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()\r
	229	is used to retrieve the OututBufferSize, ScratchSize, and Attributes values. The return status from the handler of\r
	230	type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER is returned.\r
	231	\r
	232	If InputSection is NULL, then ASSERT().\r
	233	If OutputBufferSize is NULL, then ASSERT().\r
	234	If ScratchBufferSize is NULL, then ASSERT().\r
	235	If SectionAttribute is NULL, then ASSERT().\r
	236	\r
	237	@param[in] InputSection A pointer to a GUIDed section of an FFS formatted file.\r
	238	@param[out] OutputBufferSize A pointer to the size, in bytes, of an output buffer required if the buffer\r
	239	specified by InputSection were decoded.\r
	240	@param[out] ScratchBufferSize A pointer to the size, in bytes, required as scratch space if the buffer specified by\r
	241	InputSection were decoded.\r
	242	@param[out] SectionAttribute A pointer to the attributes of the GUIDed section. See the Attributes field of\r
	243	EFI_GUID_DEFINED_SECTION in the PI Specification.\r
	244	\r
	245	@retval RETURN_SUCCESS Get the required information successfully.\r
	246	@retval RETURN_UNSUPPORTED The GUID from the section specified by InputSection does not match any of\r
	247	the GUIDs registered with ExtractGuidedSectionRegisterHandlers().\r
	248	@retval Others The return status from the handler associated with the GUID retrieved from\r
	249	the section specified by InputSection.\r
	250	\r
	251	**/\r
	252	RETURN_STATUS\r
	253	EFIAPI\r
	254	ExtractGuidedSectionGetInfo (\r
	255	IN CONST VOID *InputSection,\r
	256	OUT UINT32 *OutputBufferSize,\r
	257	OUT UINT32 *ScratchBufferSize,\r
	258	OUT UINT16 *SectionAttribute \r
	259	)\r
	260	{\r
	261	UINT32 Index;\r
	262	\r
	263	ASSERT (InputSection != NULL); \r
	264	ASSERT (OutputBufferSize != NULL);\r
	265	ASSERT (ScratchBufferSize != NULL);\r
	266	ASSERT (SectionAttribute != NULL);\r
	267	\r
	268	//\r
	269	// Search the match registered GetInfo handler for the input guided section.\r
	270	//\r
	271	for (Index = 0; Index < mNumberOfExtractHandler; Index ++) {\r
	272	if (CompareGuid (&mExtractHandlerGuidTable[Index], &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {\r
	273	//\r
	274	// Call the match handler to getinfo for the input section data.\r
	275	//\r
	276	return mExtractGetInfoHandlerTable [Index] (\r
	277	InputSection,\r
	278	OutputBufferSize,\r
	279	ScratchBufferSize,\r
	280	SectionAttribute\r
	281	);\r
	282	}\r
	283	}\r
	284	\r
	285	//\r
	286	// Not found, the input guided section is not supported. \r
	287	//\r
	288	return RETURN_UNSUPPORTED;\r
	289	}\r
	290	\r
	291	/**\r
	292	Retrieves the GUID from a GUIDed section and uses that GUID to select an associated handler of type\r
	293	EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers().\r
	294	The selected handler is used to decode the data in a GUIDed section and return the result in a caller\r
	295	allocated output buffer.\r
	296	\r
	297	Decodes the GUIDed section specified by InputSection. \r
	298	If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(),\r
	299	then RETURN_UNSUPPORTED is returned. \r
	300	If the GUID of InputSection does match the GUID that this handler supports, then the the associated handler\r
	301	of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()\r
	302	is used to decode InputSection into the buffer specified by OutputBuffer and the authentication status of this\r
	303	decode operation is returned in AuthenticationStatus. If the decoded buffer is identical to the data in InputSection,\r
	304	then OutputBuffer is set to point at the data in InputSection. Otherwise, the decoded data will be placed in caller\r
	305	allocated buffer specified by OutputBuffer. This function is responsible for computing the EFI_AUTH_STATUS_PLATFORM_OVERRIDE\r
	306	bit of in AuthenticationStatus. The return status from the handler of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER is returned. \r
	307	\r
	308	If InputSection is NULL, then ASSERT().\r
	309	If OutputBuffer is NULL, then ASSERT().\r
	310	If ScratchBuffer is NULL and this decode operation requires a scratch buffer, then ASSERT().\r
	311	If AuthenticationStatus is NULL, then ASSERT(). \r
	312	\r
	313	@param[in] InputSection A pointer to a GUIDed section of an FFS formatted file.\r
	314	@param[out] OutputBuffer A pointer to a buffer that contains the result of a decode operation. \r
	315	@param[in] ScratchBuffer A caller allocated buffer that may be required by this function as a scratch buffer to perform the decode operation. \r
	316	@param[out] AuthenticationStatus \r
	317	A pointer to the authentication status of the decoded output buffer. See the definition\r
	318	of authentication status in the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI section of the PI\r
	319	Specification.\r
	320	\r
	321	@retval RETURN_SUCCESS The buffer specified by InputSection was decoded.\r
	322	@retval RETURN_UNSUPPORTED The section specified by InputSection does not match the GUID this handler supports.\r
	323	@retval RETURN_INVALID_PARAMETER The section specified by InputSection can not be decoded.\r
	324	\r
	325	**/\r
	326	RETURN_STATUS\r
	327	EFIAPI\r
	328	ExtractGuidedSectionDecode (\r
	329	IN CONST VOID *InputSection,\r
	330	OUT VOID **OutputBuffer,\r
	331	IN VOID *ScratchBuffer, OPTIONAL\r
	332	OUT UINT32 *AuthenticationStatus \r
	333	)\r
	334	{\r
	335	UINT32 Index;\r
	336	\r
	337	//\r
	338	// Check the input parameters\r
	339	//\r
	340	ASSERT (InputSection != NULL);\r
	341	ASSERT (OutputBuffer != NULL);\r
	342	ASSERT (AuthenticationStatus != NULL);\r
	343	\r
	344	//\r
	345	// Search the match registered extract handler for the input guided section.\r
	346	//\r
	347	for (Index = 0; Index < mNumberOfExtractHandler; Index ++) {\r
	348	if (CompareGuid (&mExtractHandlerGuidTable[Index], &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {\r
	349	//\r
	350	// Call the match handler to extract raw data for the input section data.\r
	351	//\r
	352	return mExtractDecodeHandlerTable [Index] (\r
	353	InputSection,\r
	354	OutputBuffer,\r
	355	ScratchBuffer,\r
	356	AuthenticationStatus\r
	357	);\r
	358	}\r
	359	}\r
	360	\r
	361	//\r
	362	// Not found, the input guided section is not supported. \r
	363	//\r
	364	return RETURN_UNSUPPORTED;\r
	365	}\r