/** @file\r
- This library provides common functions to process the different guided section data. \r
- \r
- This library provides functions to process GUIDed sections of FFS files. Handlers may \r
- be registered to decode GUIDed sections of FFS files. Services are provided to determine \r
- the set of supported section GUIDs, collection information about a specific GUIDed section, \r
- and decode a specific GUIDed section. \r
- \r
- A library instance that produces this library class may be used to produce a \r
- EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI or a EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL \r
+ This library provides common functions to process the different guided section data.\r
+\r
+ This library provides functions to process GUIDed sections of FFS files. Handlers may\r
+ be registered to decode GUIDed sections of FFS files. Services are provided to determine\r
+ the set of supported section GUIDs, collection information about a specific GUIDed section,\r
+ and decode a specific GUIDed section.\r
+\r
+ A library instance that produces this library class may be used to produce a\r
+ EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI or a EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL\r
providing a simple method to extend the number of GUIDed sections types a platform supports.\r
\r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2018, 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
Examines a GUIDed section and returns the size of the decoded buffer and the\r
size of an optional scratch buffer required to actually decode the data in a GUIDed section.\r
\r
- Examines a GUIDed section specified by InputSection. \r
+ Examines a GUIDed section specified by InputSection.\r
If GUID for InputSection does not match the GUID that this handler supports,\r
- then RETURN_UNSUPPORTED is returned. \r
+ then RETURN_UNSUPPORTED is returned.\r
If the required information can not be retrieved from InputSection,\r
then RETURN_INVALID_PARAMETER is returned.\r
If the GUID of InputSection does match the GUID that this handler supports,\r
then the size required to hold the decoded buffer is returned in OututBufferSize,\r
the size of an optional scratch buffer is returned in ScratchSize, and the Attributes field\r
from EFI_GUID_DEFINED_SECTION header of InputSection is returned in SectionAttribute.\r
- \r
+\r
If InputSection is NULL, then ASSERT().\r
If OutputBufferSize is NULL, then ASSERT().\r
If ScratchBufferSize is NULL, then ASSERT().\r
\r
/**\r
Decodes a GUIDed section into a caller allocated output buffer.\r
- \r
- Decodes the GUIDed section specified by InputSection. \r
- If GUID for InputSection does not match the GUID that this handler supports, then RETURN_UNSUPPORTED is returned. \r
+\r
+ Decodes the GUIDed section specified by InputSection.\r
+ If GUID for InputSection does not match the GUID that this handler supports, then RETURN_UNSUPPORTED is returned.\r
If the data in InputSection can not be decoded, then RETURN_INVALID_PARAMETER is returned.\r
If the GUID of InputSection does match the GUID that this handler supports, then InputSection\r
is decoded 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\r
data in InputSection, then OutputBuffer is set to point at the data in InputSection. Otherwise,\r
the decoded data will be placed in caller allocated buffer specified by OutputBuffer.\r
- \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
\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[out] OutputBuffer A pointer to a buffer that contains the result of a decode operation.\r
@param[out] ScratchBuffer A caller allocated buffer that may be required by this function\r
- as a scratch buffer to perform the decode operation. \r
- @param[out] AuthenticationStatus \r
+ 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.\r
See the definition of authentication status in the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI\r
section of the PI Specification. EFI_AUTH_STATUS_PLATFORM_OVERRIDE must\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
+\r
If SectionGuid is NULL, then ASSERT().\r
If GetInfoHandler is NULL, then ASSERT().\r
If DecodeHandler is NULL, then ASSERT().\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
+ 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
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
+ 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
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
+ 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
+ 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
+\r
If InputSection is NULL, then ASSERT().\r
If OutputBufferSize is NULL, then ASSERT().\r
If ScratchBufferSize is NULL, then ASSERT().\r
IN CONST VOID *InputSection,\r
OUT UINT32 *OutputBufferSize,\r
OUT UINT32 *ScratchBufferSize,\r
- OUT UINT16 *SectionAttribute \r
+ OUT UINT16 *SectionAttribute\r
);\r
\r
/**\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
+ 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
+ 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
+ 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
+ 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
+ @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
IN CONST VOID *InputSection,\r
OUT VOID **OutputBuffer,\r
IN VOID *ScratchBuffer, OPTIONAL\r
- OUT UINT32 *AuthenticationStatus \r
+ OUT UINT32 *AuthenticationStatus\r
);\r
\r
/**\r
- Retrieves handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and \r
+ Retrieves handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and\r
EXTRACT_GUIDED_SECTION_DECODE_HANDLER for a specific GUID section type.\r
- \r
- Retrieves the handlers associated with SectionGuid and returns them in \r
+\r
+ Retrieves the handlers associated with SectionGuid and returns them in\r
GetInfoHandler and DecodeHandler.\r
\r
- If the GUID value specified by SectionGuid has not been registered, then \r
+ If the GUID value specified by SectionGuid has not been registered, then\r
return RETURN_NOT_FOUND.\r
- \r
+\r
If SectionGuid is NULL, then ASSERT().\r
\r
- @param[in] SectionGuid A pointer to the GUID associated with the handlersof the GUIDed \r
+ @param[in] SectionGuid A pointer to the GUID associated with the handlersof the GUIDed\r
section type being retrieved.\r
- @param[out] GetInfoHandler Pointer to a function that examines a GUIDed section and returns \r
- the size of the decoded buffer and the size of an optional scratch \r
- buffer required to actually decode the data in a GUIDed section. \r
- This is an optional parameter that may be NULL. If it is NULL, then \r
+ @param[out] GetInfoHandler Pointer to a function that examines a GUIDed section and returns\r
+ the size of the decoded buffer and the size of an optional scratch\r
+ buffer required to actually decode the data in a GUIDed section.\r
+ This is an optional parameter that may be NULL. If it is NULL, then\r
the previously registered handler is not returned.\r
@param[out] DecodeHandler Pointer to a function that decodes a GUIDed section into a caller\r
allocated output buffer. This is an optional parameter that may be NULL.\r
projects / mirror_edk2.git / blobdiff