MdePkg: Clean up source files
1. Do not use tab characters 2. No trailing white space in one line 3. All files must end with CRLF Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Liming Gao <liming.gao@intel.com>
This commit is contained in:
@@ -1,16 +1,16 @@
|
||||
/** @file
|
||||
This library provides common functions to process the different guided section data.
|
||||
|
||||
This library provides functions to process GUIDed sections of FFS files. Handlers may
|
||||
be registered to decode GUIDed sections of FFS files. Services are provided to determine
|
||||
the set of supported section GUIDs, collection information about a specific GUIDed section,
|
||||
and decode a specific GUIDed section.
|
||||
|
||||
A library instance that produces this library class may be used to produce a
|
||||
EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI or a EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL
|
||||
This library provides common functions to process the different guided section data.
|
||||
|
||||
This library provides functions to process GUIDed sections of FFS files. Handlers may
|
||||
be registered to decode GUIDed sections of FFS files. Services are provided to determine
|
||||
the set of supported section GUIDs, collection information about a specific GUIDed section,
|
||||
and decode a specific GUIDed section.
|
||||
|
||||
A library instance that produces this library class may be used to produce a
|
||||
EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI or a EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL
|
||||
providing a simple method to extend the number of GUIDed sections types a platform supports.
|
||||
|
||||
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
|
||||
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
||||
This program and the accompanying materials
|
||||
are licensed and made available under the terms and conditions of the BSD License
|
||||
which accompanies this distribution. The full text of the license may be found at
|
||||
@@ -27,16 +27,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
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.
|
||||
|
||||
Examines a GUIDed section specified by InputSection.
|
||||
Examines a GUIDed section specified by InputSection.
|
||||
If GUID for InputSection does not match the GUID that this handler supports,
|
||||
then RETURN_UNSUPPORTED is returned.
|
||||
then RETURN_UNSUPPORTED is returned.
|
||||
If the required information can not be retrieved from InputSection,
|
||||
then RETURN_INVALID_PARAMETER is returned.
|
||||
If the GUID of InputSection does match the GUID that this handler supports,
|
||||
then the size required to hold the decoded buffer is returned in OututBufferSize,
|
||||
the size of an optional scratch buffer is returned in ScratchSize, and the Attributes field
|
||||
from EFI_GUID_DEFINED_SECTION header of InputSection is returned in SectionAttribute.
|
||||
|
||||
|
||||
If InputSection is NULL, then ASSERT().
|
||||
If OutputBufferSize is NULL, then ASSERT().
|
||||
If ScratchBufferSize is NULL, then ASSERT().
|
||||
@@ -67,16 +67,16 @@ RETURN_STATUS
|
||||
|
||||
/**
|
||||
Decodes a GUIDed section into a caller allocated output buffer.
|
||||
|
||||
Decodes the GUIDed section specified by InputSection.
|
||||
If GUID for InputSection does not match the GUID that this handler supports, then RETURN_UNSUPPORTED is returned.
|
||||
|
||||
Decodes the GUIDed section specified by InputSection.
|
||||
If GUID for InputSection does not match the GUID that this handler supports, then RETURN_UNSUPPORTED is returned.
|
||||
If the data in InputSection can not be decoded, then RETURN_INVALID_PARAMETER is returned.
|
||||
If the GUID of InputSection does match the GUID that this handler supports, then InputSection
|
||||
is decoded into the buffer specified by OutputBuffer and the authentication status of this
|
||||
decode operation is returned in AuthenticationStatus. If the decoded buffer is identical to the
|
||||
data in InputSection, then OutputBuffer is set to point at the data in InputSection. Otherwise,
|
||||
the decoded data will be placed in caller allocated buffer specified by OutputBuffer.
|
||||
|
||||
|
||||
If InputSection is NULL, then ASSERT().
|
||||
If OutputBuffer is NULL, then ASSERT().
|
||||
If ScratchBuffer is NULL and this decode operation requires a scratch buffer, then ASSERT().
|
||||
@@ -84,10 +84,10 @@ RETURN_STATUS
|
||||
|
||||
|
||||
@param[in] InputSection A pointer to a GUIDed section of an FFS formatted file.
|
||||
@param[out] OutputBuffer A pointer to a buffer that contains the result of a decode operation.
|
||||
@param[out] OutputBuffer A pointer to a buffer that contains the result of a decode operation.
|
||||
@param[out] ScratchBuffer A caller allocated buffer that may be required by this function
|
||||
as a scratch buffer to perform the decode operation.
|
||||
@param[out] AuthenticationStatus
|
||||
as a scratch buffer to perform the decode operation.
|
||||
@param[out] AuthenticationStatus
|
||||
A pointer to the authentication status of the decoded output buffer.
|
||||
See the definition of authentication status in the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI
|
||||
section of the PI Specification. EFI_AUTH_STATUS_PLATFORM_OVERRIDE must
|
||||
@@ -114,7 +114,7 @@ RETURN_STATUS
|
||||
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().
|
||||
@@ -125,7 +125,7 @@ RETURN_STATUS
|
||||
size of the decoded buffer and the size of an optional scratch buffer
|
||||
required to actually decode the data in a GUIDed section.
|
||||
@param[in] DecodeHandler Pointer to a function that decodes a GUIDed section into a caller
|
||||
allocated output buffer.
|
||||
allocated output buffer.
|
||||
|
||||
@retval RETURN_SUCCESS The handlers were registered.
|
||||
@retval RETURN_OUT_OF_RESOURCES There are not enough resources available to register the handlers.
|
||||
@@ -144,7 +144,7 @@ ExtractGuidedSectionRegisterHandlers (
|
||||
|
||||
Sets ExtractHandlerGuidTable so it points at a callee allocated array of registered GUIDs.
|
||||
The total number of GUIDs in the array are returned. Since the array of GUIDs is callee allocated
|
||||
and caller must treat this array of GUIDs as read-only data.
|
||||
and caller must treat this array of GUIDs as read-only data.
|
||||
If ExtractHandlerGuidTable is NULL, then ASSERT().
|
||||
|
||||
@param[out] ExtractHandlerGuidTable A pointer to the array of GUIDs that have been registered through
|
||||
@@ -165,14 +165,14 @@ ExtractGuidedSectionGetGuidList (
|
||||
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.
|
||||
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
|
||||
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().
|
||||
@@ -199,7 +199,7 @@ ExtractGuidedSectionGetInfo (
|
||||
IN CONST VOID *InputSection,
|
||||
OUT UINT32 *OutputBufferSize,
|
||||
OUT UINT32 *ScratchBufferSize,
|
||||
OUT UINT16 *SectionAttribute
|
||||
OUT UINT16 *SectionAttribute
|
||||
);
|
||||
|
||||
/**
|
||||
@@ -208,26 +208,26 @@ ExtractGuidedSectionGetInfo (
|
||||
The selected handler is used to decode the data in a GUIDed section and return the result in a caller
|
||||
allocated output buffer.
|
||||
|
||||
Decodes the GUIDed section specified by InputSection.
|
||||
Decodes the GUIDed section specified by InputSection.
|
||||
If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(),
|
||||
then RETURN_UNSUPPORTED is returned.
|
||||
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_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()
|
||||
is used to decode InputSection into the buffer specified by OutputBuffer and the authentication status of this
|
||||
decode operation is returned in AuthenticationStatus. If the decoded buffer is identical to the data in InputSection,
|
||||
then OutputBuffer is set to point at the data in InputSection. Otherwise, the decoded data will be placed in caller
|
||||
allocated buffer specified by OutputBuffer. This function is responsible for computing the EFI_AUTH_STATUS_PLATFORM_OVERRIDE
|
||||
bit of in AuthenticationStatus. The return status from the handler of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER is returned.
|
||||
|
||||
bit of in AuthenticationStatus. The return status from the handler of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER is returned.
|
||||
|
||||
If InputSection is NULL, then ASSERT().
|
||||
If OutputBuffer is NULL, then ASSERT().
|
||||
If ScratchBuffer is NULL and this decode operation requires a scratch buffer, then ASSERT().
|
||||
If AuthenticationStatus is NULL, then ASSERT().
|
||||
If AuthenticationStatus is NULL, then ASSERT().
|
||||
|
||||
@param[in] InputSection A pointer to a GUIDed section of an FFS formatted file.
|
||||
@param[out] OutputBuffer A pointer to a buffer that contains the result of a decode operation.
|
||||
@param[in] ScratchBuffer A caller allocated buffer that may be required by this function as a scratch buffer to perform the decode operation.
|
||||
@param[out] AuthenticationStatus
|
||||
@param[out] OutputBuffer A pointer to a buffer that contains the result of a decode operation.
|
||||
@param[in] ScratchBuffer A caller allocated buffer that may be required by this function as a scratch buffer to perform the decode operation.
|
||||
@param[out] AuthenticationStatus
|
||||
A pointer to the authentication status of the decoded output buffer. See the definition
|
||||
of authentication status in the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI section of the PI
|
||||
Specification.
|
||||
@@ -243,27 +243,27 @@ ExtractGuidedSectionDecode (
|
||||
IN CONST VOID *InputSection,
|
||||
OUT VOID **OutputBuffer,
|
||||
IN VOID *ScratchBuffer, OPTIONAL
|
||||
OUT UINT32 *AuthenticationStatus
|
||||
OUT UINT32 *AuthenticationStatus
|
||||
);
|
||||
|
||||
/**
|
||||
Retrieves handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and
|
||||
Retrieves handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and
|
||||
EXTRACT_GUIDED_SECTION_DECODE_HANDLER for a specific GUID section type.
|
||||
|
||||
Retrieves the handlers associated with SectionGuid and returns them in
|
||||
|
||||
Retrieves the handlers associated with SectionGuid and returns them in
|
||||
GetInfoHandler and DecodeHandler.
|
||||
|
||||
If the GUID value specified by SectionGuid has not been registered, then
|
||||
If the GUID value specified by SectionGuid has not been registered, then
|
||||
return RETURN_NOT_FOUND.
|
||||
|
||||
|
||||
If SectionGuid is NULL, then ASSERT().
|
||||
|
||||
@param[in] SectionGuid A pointer to the GUID associated with the handlersof the GUIDed
|
||||
@param[in] SectionGuid A pointer to the GUID associated with the handlersof the GUIDed
|
||||
section type being retrieved.
|
||||
@param[out] 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.
|
||||
This is an optional parameter that may be NULL. If it is NULL, then
|
||||
@param[out] 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.
|
||||
This is an optional parameter that may be NULL. If it is NULL, then
|
||||
the previously registered handler is not returned.
|
||||
@param[out] DecodeHandler Pointer to a function that decodes a GUIDed section into a caller
|
||||
allocated output buffer. This is an optional parameter that may be NULL.
|
||||
|
Reference in New Issue
Block a user