sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update MdePkg/Include/Ppi according to code review comments.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5818 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
xli24
2008-09-04 09:15:21 +00:00
parent e6422a369a
commit dafa11b191
9 changed files with 414 additions and 473 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
MdePkg/Include/Ppi/GuidedSectionExtraction.h
View File

@@ -51,75 +51,54 @@ typedef struct _EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI EFI_PEI_GUIDED_SECTION_E
section's contents. Otherwise, *Buffer must be allocated
from PEI permanent memory.
@param 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.
@param This Indicates the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI
instance.
@param InputSection Buffer containing the input GUIDed section to be
processed.
@param OutputBuffer *OutputBuffer is allocated from PEI permanent memory
and contains the new section stream.
@param 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.
@param 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.
@param 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.
@param 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.
@retval EFI_SUCCESS The InputSection was
successfully processed and the
@retval EFI_SUCCESS The InputSection was successfully processed and the
section contents were returned.
@retval EFI_OUT_OF_RESOURCES The system has insufficient
resources to process the request.
@retval EFI_INVALID_PARAMETER The GUID in InputSection does
not match this instance of the
@retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process the request.
@retval EFI_INVALID_PARAMETER The GUID in InputSection does not match this instance of the
GUIDed Section Extraction PPI.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_PEI_EXTRACT_GUIDED_SECTION)(
IN CONST EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *This,
IN CONST VOID *InputSection,
OUT VOID **OutputBuffer,
OUT UINTN *OutputSize,
OUT UINT32 *AuthenticationStatus
IN CONST EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *This,
IN CONST VOID *InputSection,
OUT VOID **OutputBuffer,
OUT UINTN *OutputSize,
OUT UINT32 *AuthenticationStatus
);
/**
@par Ppi Description:
If a GUID-defined section is encountered when doing section extraction,
the PEI Foundation or the EFI_PEI_FILE_LOADER_PPI instance
calls the appropriate instance of the GUIDed Section
Extraction PPI to extract the section stream contained
therein.
@param ExtractSection Takes the GUIDed section as input and
produces the section stream data. See
the ExtractSection() function
description.
**/
///
/// If a GUID-defined section is encountered when doing section extraction,
/// the PEI Foundation or the EFI_PEI_FILE_LOADER_PPI instance
/// calls the appropriate instance of the GUIDed Section
/// Extraction PPI to extract the section stream contained
/// therein.
///
struct _EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI {
///
/// Takes the GUIDed section as input and
/// produces the section stream data.
///
EFI_PEI_EXTRACT_GUIDED_SECTION ExtractSection;
};