#include <PiPei.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/ExtractGuidedSectionLib.h>
#include <Library/PcdLib.h>
#include <Library/PrePiLib.h>

Data Structures
struct	PRE_PI_EXTRACT_GUIDED_SECTION_DATA

Macros
#define	PRE_PI_EXTRACT_GUIDED_SECTION_DATA_GUID { 0x385A982C, 0x2F49, 0x4043, { 0xA5, 0x1E, 0x49, 0x01, 0x02, 0x5C, 0x8B, 0x6B }}

Functions
PRE_PI_EXTRACT_GUIDED_SECTION_DATA *	GetSavedData (VOID)

RETURN_STATUS EFIAPI	ExtractGuidedSectionRegisterHandlers (IN CONST GUID *SectionGuid, IN EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER GetInfoHandler, IN EXTRACT_GUIDED_SECTION_DECODE_HANDLER DecodeHandler)

UINTN EFIAPI	ExtractGuidedSectionGetGuidList (IN OUT GUID **ExtractHandlerGuidTable)

RETURN_STATUS EFIAPI	ExtractGuidedSectionGetInfo (IN CONST VOID InputSection, OUT UINT32 OutputBufferSize, OUT UINT32 ScratchBufferSize, OUT UINT16 SectionAttribute)

RETURN_STATUS EFIAPI	ExtractGuidedSectionDecode (IN CONST VOID InputSection, OUT VOID OutputBuffer, OUT VOID ScratchBuffer OPTIONAL, OUT UINT32 *AuthenticationStatus)

RETURN_STATUS EFIAPI	ExtractGuidedSectionLibConstructor (VOID)

Detailed Description

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file PrePiExtractGuidedSectionLib.c.

Macro Definition Documentation

◆ PRE_PI_EXTRACT_GUIDED_SECTION_DATA_GUID

#define PRE_PI_EXTRACT_GUIDED_SECTION_DATA_GUID { 0x385A982C, 0x2F49, 0x4043, { 0xA5, 0x1E, 0x49, 0x01, 0x02, 0x5C, 0x8B, 0x6B }}

Definition at line 16 of file PrePiExtractGuidedSectionLib.c.

Function Documentation

◆ ExtractGuidedSectionDecode()

RETURN_STATUS EFIAPI ExtractGuidedSectionDecode	(	IN CONST VOID *	InputSection,
		OUT VOID **	OutputBuffer,
		OUT VOID *ScratchBuffer	OPTIONAL,
		OUT UINT32 *	AuthenticationStatus
	)

Definition at line 168 of file PrePiExtractGuidedSectionLib.c.

◆ ExtractGuidedSectionGetGuidList()

UINTN EFIAPI ExtractGuidedSectionGetGuidList ( IN OUT GUID ** ExtractHandlerGuidTable )

Definition at line 96 of file PrePiExtractGuidedSectionLib.c.

◆ ExtractGuidedSectionGetInfo()

RETURN_STATUS EFIAPI ExtractGuidedSectionGetInfo	(	IN CONST VOID *	InputSection,
		OUT UINT32 *	OutputBufferSize,
		OUT UINT32 *	ScratchBufferSize,
		OUT UINT16 *	SectionAttribute
	)

Retrieves a GUID from a GUIDed section and uses that GUID to select an associated handler of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers(). The selected handler is used to retrieve and return the size of the decoded buffer and the size of an optional scratch buffer required to actually decode the data in a GUIDed section.

Examines a GUIDed section specified by InputSection. If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(), then RETURN_UNSUPPORTED is returned. If the GUID of InputSection does match the GUID that this handler supports, then the the associated handler of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers() is used to retrieve the OututBufferSize, ScratchSize, and Attributes values. The return status from the handler of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER is returned.

If InputSection is NULL, then ASSERT(). If OutputBufferSize is NULL, then ASSERT(). If ScratchBufferSize is NULL, then ASSERT(). If SectionAttribute is NULL, then ASSERT().

Parameters

[in]	InputSection	A pointer to a GUIDed section of an FFS formatted file.
[out]	OutputBufferSize	A pointer to the size, in bytes, of an output buffer required if the buffer specified by InputSection were decoded.
[out]	ScratchBufferSize	A pointer to the size, in bytes, required as scratch space if the buffer specified by InputSection were decoded.
[out]	SectionAttribute	A pointer to the attributes of the GUIDed section. See the Attributes field of EFI_GUID_DEFINED_SECTION in the PI Specification.

Return values

RETURN_SUCCESS	Get the required information successfully.
RETURN_UNSUPPORTED	The GUID from the section specified by InputSection does not match any of the GUIDs registered with ExtractGuidedSectionRegisterHandlers().
Others	The return status from the handler associated with the GUID retrieved from the section specified by InputSection.

Definition at line 112 of file PrePiExtractGuidedSectionLib.c.

◆ ExtractGuidedSectionLibConstructor()

RETURN_STATUS EFIAPI ExtractGuidedSectionLibConstructor ( VOID )

Definition at line 223 of file PrePiExtractGuidedSectionLib.c.

◆ ExtractGuidedSectionRegisterHandlers()

RETURN_STATUS EFIAPI ExtractGuidedSectionRegisterHandlers	(	IN CONST GUID *	SectionGuid,
		IN EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER	GetInfoHandler,
		IN EXTRACT_GUIDED_SECTION_DECODE_HANDLER	DecodeHandler
	)

Registers handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and EXTRACT_GUIDED_SECTION_DECODE_HANDLER for a specific GUID section type.

Registers the handlers specified by GetInfoHandler and DecodeHandler with the GUID specified by SectionGuid. If the GUID value specified by SectionGuid has already been registered, then return RETURN_ALREADY_STARTED. If there are not enough resources available to register the handlers then RETURN_OUT_OF_RESOURCES is returned.

If SectionGuid is NULL, then ASSERT(). If GetInfoHandler is NULL, then ASSERT(). If DecodeHandler is NULL, then ASSERT().

Parameters

[in]	SectionGuid	A pointer to the GUID associated with the the handlers of the GUIDed section type being registered.
[in]	GetInfoHandler	Pointer to a function that examines a GUIDed section and returns the size of the decoded buffer and the size of an optional scratch buffer required to actually decode the data in a GUIDed section.
[in]	DecodeHandler	Pointer to a function that decodes a GUIDed section into a caller allocated output buffer.

Return values

RETURN_SUCCESS	The handlers were registered.
RETURN_OUT_OF_RESOURCES	There are not enough resources available to register the handlers.

Definition at line 41 of file PrePiExtractGuidedSectionLib.c.

◆ GetSavedData()

PRE_PI_EXTRACT_GUIDED_SECTION_DATA * GetSavedData ( VOID )

Definition at line 26 of file PrePiExtractGuidedSectionLib.c.

Data Structures

Macros

Functions