/** @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
+ providing a simple method to extend the number of GUIDed sections types a platform supports.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2010, 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
http://opensource.org/licenses/bsd-license.php\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
If InputSection is NULL, then ASSERT().\r
If OutputBufferSize is NULL, then ASSERT().\r
If ScratchBufferSize is NULL, then ASSERT().\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
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
never be set by this handler.\r
\r
@retval RETURN_SUCCESS The buffer specified by InputSection was decoded.\r
- @retval RETURN_UNSPPORTED The section specified by InputSection does not match the GUID this handler supports.\r
+ @retval RETURN_UNSUPPORTED The section specified by InputSection does not match the GUID this handler supports.\r
@retval RETURN_INVALID_PARAMETER The section specified by InputSection can not be decoded.\r
\r
**/\r
Registers handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and EXTRACT_GUIDED_SECTION_DECODE_HANDLER\r
for a specific GUID section type.\r
\r
- Registers the handlers specified by GetInfoHandler and DecodeHandler witg the GUID specified by SectionGuid.\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
If SectionGuid is NULL, then ASSERT().\r
If GetInfoHandler is NULL, then ASSERT().\r
If DecodeHandler is NULL, then ASSERT().\r
allocated output buffer. \r
\r
@retval RETURN_SUCCESS The handlers were registered.\r
- @retval RETURN_ALREADY_STARTED Handlers have already been registered for the GUID specified by SectionGuid. \r
@retval RETURN_OUT_OF_RESOURCES There are not enough resources available to register the handlers.\r
\r
**/\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 tht have been registerd through\r
+ @param[out] ExtractHandlerGuidTable A pointer to the array of GUIDs that have been registered through\r
ExtractGuidedSectionRegisterHandlers().\r
\r
@return the number of the supported extract guided Handler.\r
);\r
\r
/**\r
- Retrives a GUID from a GUIDed section and uses that GUID to select an associated handler of type\r
+ Retrieves a GUID from a GUIDed section and uses that GUID to select an associated handler of type\r
EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers().\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
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
If InputSection is NULL, then ASSERT().\r
If OutputBufferSize is NULL, then ASSERT().\r
If ScratchBufferSize is NULL, then ASSERT().\r
);\r
\r
/**\r
- Retrives the GUID from a GUIDed section and uses that GUID to select an associated handler of type\r
+ Retrieves the GUID from a GUIDed section and uses that GUID to select an associated handler of type\r
EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers().\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
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
+ 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
OUT UINT32 *AuthenticationStatus \r
);\r
\r
+/**\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
+ GetInfoHandler and DecodeHandler.\r
+\r
+ If the GUID value specified by SectionGuid has not been registered, then \r
+ return RETURN_NOT_FOUND.\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
+ 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
+ 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
+ If it is NULL, then the previously registered handler is not returned.\r
+\r
+ @retval RETURN_SUCCESS The handlers were retrieved.\r
+ @retval RETURN_NOT_FOUND No handlers have been registered with the specified GUID.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+ExtractGuidedSectionGetHandlers (\r
+ IN CONST GUID *SectionGuid,\r
+ OUT EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *GetInfoHandler, OPTIONAL\r
+ OUT EXTRACT_GUIDED_SECTION_DECODE_HANDLER *DecodeHandler OPTIONAL\r
+ );\r
+\r
#endif\r
projects / mirror_edk2.git / blobdiff