#include <PiPei.h>
#include <Ppi/GuidedSectionExtraction.h>
#include <Library/DebugLib.h>
#include <Library/ExtractGuidedSectionLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/PeiServicesLib.h>

Functions
EFI_STATUS EFIAPI	CustomGuidedSectionExtract (IN CONST EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI This, IN CONST VOID InputSection, OUT VOID *OutputBuffer, OUT UINTN OutputSize, OUT UINT32 *AuthenticationStatus)

EFI_STATUS EFIAPI	SectionExtractionPeiEntry (IN EFI_PEI_FILE_HANDLE FileHandle, IN CONST EFI_PEI_SERVICES **PeiServices)

Variables
CONST EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI	mCustomGuidedSectionExtractionPpi

Detailed Description

Section Extraction PEIM

Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file SectionExtractionPei.c.

Function Documentation

◆ CustomGuidedSectionExtract()

EFI_STATUS EFIAPI CustomGuidedSectionExtract	(	IN CONST EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *	This,
		IN CONST VOID *	InputSection,
		OUT VOID **	OutputBuffer,
		OUT UINTN *	OutputSize,
		OUT UINT32 *	AuthenticationStatus
	)

The ExtractSection() function processes the input section and returns a pointer to the section contents. If the section being extracted does not require processing (if the section GuidedSectionHeader.Attributes has the EFI_GUIDED_SECTION_PROCESSING_REQUIRED field cleared), then OutputBuffer is just updated to point to the start of the section's contents. Otherwise, *Buffer must be allocated from PEI permanent memory.

Parameters

This	Indicates the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI instance. Buffer containing the input GUIDed section to be processed. OutputBuffer OutputBuffer is allocated from PEI permanent memory and contains the new section stream.
InputSection	A pointer to the input buffer, which contains the input section to be processed.
OutputBuffer	A pointer to a caller-allocated buffer, whose size is specified by the contents of OutputSize.
OutputSize	A pointer to a caller-allocated UINTN in which the size of *OutputBuffer allocation is stored. If the function returns anything other than EFI_SUCCESS, the value of OutputSize is undefined.
AuthenticationStatus	A pointer to a caller-allocated UINT32 that indicates the authentication status of the output buffer. If the input section's GuidedSectionHeader. Attributes field has the EFI_GUIDED_SECTION_AUTH_STATUS_VALID bit as clear, AuthenticationStatus must return zero. These bits reflect the status of the extraction operation. If the function returns anything other than EFI_SUCCESS, the value of AuthenticationStatus is undefined.

Return values

EFI_SUCCESS	The InputSection was successfully processed and the section contents were returned.
EFI_OUT_OF_RESOURCES	The system has insufficient resources to process the request.
EFI_INVALID_PARAMETER	The GUID in InputSection does not match this instance of the GUIDed Section Extraction PPI.

Definition at line 143 of file SectionExtractionPei.c.

◆ SectionExtractionPeiEntry()

EFI_STATUS EFIAPI SectionExtractionPeiEntry	(	IN EFI_PEI_FILE_HANDLE	FileHandle,
		IN CONST EFI_PEI_SERVICES **	PeiServices
	)

Main entry for Section Extraction PEIM driver.

This routine registers the Section Extraction PPIs that have been registered with the Section Extraction Library.

Parameters

FileHandle	Handle of the file being invoked.
PeiServices	Describes the list of possible PEI Services.

Return values

EFI_SUCCESS	The entry point is executed successfully.
other	Some error occurs when executing this entry point.

Definition at line 233 of file SectionExtractionPei.c.

Variable Documentation

◆ mCustomGuidedSectionExtractionPpi

CONST EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI mCustomGuidedSectionExtractionPpi

Initial value:

= {
  CustomGuidedSectionExtract
}

Definition at line 83 of file SectionExtractionPei.c.