X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FInclude%2FLibrary%2FExtractGuidedSectionLib.h;h=539b98d41a2c9b4c2d3d38f17669ca4513c13571;hb=f405c0674aef0fb8bff34acb0011c47f7cd38ea6;hp=193acc3280ccd23b14170c8e595ca09e4bfdf6e0;hpb=0fa0015900e6c736fdc489ecb54b03f204f10b02;p=mirror_edk2.git diff --git a/MdePkg/Include/Library/ExtractGuidedSectionLib.h b/MdePkg/Include/Library/ExtractGuidedSectionLib.h index 193acc3280..539b98d41a 100644 --- a/MdePkg/Include/Library/ExtractGuidedSectionLib.h +++ b/MdePkg/Include/Library/ExtractGuidedSectionLib.h @@ -1,33 +1,59 @@ /** @file - Extract Guided Section Library class + 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) 2007, Intel Corporation - All rights reserved. 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 - http://opensource.org/licenses/bsd-license.php +Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.
+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 +http://opensource.org/licenses/bsd-license.php - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - ExtractGuidedSectionLib.h **/ #ifndef __EXTRACT_GUIDED_SECTION_H__ #define __EXTRACT_GUIDED_SECTION_H__ -/** - Get information Handler for the input guided section data. - It will ASSERT () if the pointer to OutputBufferSize is NULL. - It will ASSERT () if the pointer to ScratchBufferSize is NULL. - It will ASSERT () if the pointer to SectionAttribute is NULL. +/** + 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. - @param[in] InputSection Buffer containing the input GUIDed section to be processed. - @param[out] OutputBufferSize The size of OutputBuffer. - @param[out] ScratchBufferSize The size of ScratchBuffer. - @param[out] SectionAttribute The attribute of the input guided section. - - @retval RETURN_SUCCESS Get the required information successfully. - @retval RETURN_INVALID_PARAMETER The input data can't be parsed correctly. + 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. + 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(). + If SectionAttribute is NULL, then ASSERT(). + + + @param[in] InputSection A pointer to a GUIDed section of an FFS formatted file. + @param[out] OutputBufferSize A pointer to the size, in bytes, of an output buffer required + if the buffer specified by InputSection were decoded. + @param[out] ScratchBufferSize A pointer to the size, in bytes, required as scratch space + if the buffer specified by InputSection were decoded. + @param[out] SectionAttribute A pointer to the attributes of the GUIDed section. See the Attributes + field of EFI_GUID_DEFINED_SECTION in the PI Specification. + + @retval RETURN_SUCCESS The information about InputSection was returned. + @retval RETURN_UNSUPPORTED The section specified by InputSection does not match the GUID this handler supports. + @retval RETURN_INVALID_PARAMETER The information can not be retrieved from the section specified by InputSection. **/ typedef @@ -39,22 +65,37 @@ RETURN_STATUS OUT UINT16 *SectionAttribute ); -/** - Extract data Handler for one specific guided section. - It will ASSERT () if the pointer to OutputBuffer is NULL. - It will ASSERT () if the pointer to AuthenticationStatus is NULL. +/** + 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. + 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(). + If AuthenticationStatus is NULL, then ASSERT(). + - @param[in] InputSection Buffer containing the input GUIDed section to be processed. - @param[out] OutputBuffer OutputBuffer to point to the start of the section's contents. - if guided data is not prcessed. Otherwise, - OutputBuffer to contain the output data, which is allocated by the caller. - @param[out] ScratchBuffer A pointer to a caller-allocated buffer for function internal use. + @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] 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 a caller-allocated UINT32 that indicates the - authentication status of the output buffer. - - @retval RETURN_SUCCESS Get the output data and AuthenticationStatus successfully. - @retval RETURN_INVALID_PARAMETER The input data can't be parsed correctly. + 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 + never be set by this handler. + + @retval RETURN_SUCCESS The buffer specified by InputSection was decoded. + @retval RETURN_UNSUPPORTED The section specified by InputSection does not match the GUID this handler supports. + @retval RETURN_INVALID_PARAMETER The section specified by InputSection can not be decoded. **/ typedef @@ -66,16 +107,28 @@ RETURN_STATUS OUT UINT32 *AuthenticationStatus ); -/** - Register Guided Section Extract and GetInfo Handler. +/** + Registers handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and EXTRACT_GUIDED_SECTION_DECODE_HANDLER + for a specific GUID section type. + + 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(). + + @param[in] SectionGuid A pointer to the GUID associated with the the handlers + of the GUIDed section type being registered. + @param[in] 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. + @param[in] DecodeHandler Pointer to a function that decodes a GUIDed section into a caller + allocated output buffer. - @param[in] SectionGuid The guid matches this Extraction Handler. - @param[in] GetInfoHandler Handler to get info from guided section. - @param[in] DecodeHandler Handler to extract guided section. - - @retval RETURN_SUCCESS Register Guided Section Extract Handler successfully. - @retval RETURN_OUT_OF_RESOURCES Resource is not enough to register new Handler. - @retval RETURN_INVALID_PARAMETER Input pointer to Guid value is not valid. + @retval RETURN_SUCCESS The handlers were registered. + @retval RETURN_OUT_OF_RESOURCES There are not enough resources available to register the handlers. **/ RETURN_STATUS @@ -86,41 +139,58 @@ ExtractGuidedSectionRegisterHandlers ( IN EXTRACT_GUIDED_SECTION_DECODE_HANDLER DecodeHandler ); -/** - Get the supported exract guided section Handler guid table, which is maintained - by library. The caller can directly get this guid table pointer - without responsibility to allocate or free this table buffer. - It will ASSERT () if ExtractHandlerGuidTable = NULL. +/** + Retrieve the list GUIDs that have been registered through ExtractGuidedSectionRegisterHandlers(). - @param[in, out] ExtractHandlerGuidTable The extract Handler guid pointer list. + 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. + If ExtractHandlerGuidTable is NULL, then ASSERT(). + + @param[out] ExtractHandlerGuidTable A pointer to the array of GUIDs that have been registered through + ExtractGuidedSectionRegisterHandlers(). + + @return the number of the supported extract guided Handler. - @retval return the number of the supported extract guided Handler. **/ UINTN EFIAPI ExtractGuidedSectionGetGuidList ( - IN OUT GUID **ExtractHandlerGuidTable + OUT GUID **ExtractHandlerGuidTable ); -/** - Get information from the guided section. This function first gets the guid value - from guided section header, then match this guid in the registered extract Handler list - to its corresponding getinfo Handler. - If not found, RETURN_UNSUPPORTED will be return. - If found, it will call the getinfo Handler to get the required size and attribute. - - It will ASSERT () if the pointer to OutputBufferSize is NULL. - It will ASSERT () if the pointer to ScratchBufferSize is NULL. - It will ASSERT () if the pointer to SectionAttribute is NULL. - - @param[in] InputSection Buffer containing the input GUIDed section to be processed. - @param[out] OutputBufferSize The size of OutputBuffer. - @param[out] ScratchBufferSize The size of ScratchBuffer. - @param[out] SectionAttribute The attribute of the input guided section. - - @retval RETURN_SUCCESS Get the required information successfully. - @retval RETURN_UNSUPPORTED Guided section data is not supported. - @retval RETURN_INVALID_PARAMETER The input data can't be parsed correctly. +/** + Retrieves a GUID from a GUIDed section and uses that GUID to select an associated handler of type + EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers(). + 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. + 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 + 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(). + If SectionAttribute is NULL, then ASSERT(). + + @param[in] InputSection A pointer to a GUIDed section of an FFS formatted file. + @param[out] OutputBufferSize A pointer to the size, in bytes, of an output buffer required if the buffer + specified by InputSection were decoded. + @param[out] ScratchBufferSize A pointer to the size, in bytes, required as scratch space if the buffer specified by + InputSection were decoded. + @param[out] SectionAttribute A pointer to the attributes of the GUIDed section. See the Attributes field of + EFI_GUID_DEFINED_SECTION in the PI Specification. + + @retval RETURN_SUCCESS Get the required information successfully. + @retval RETURN_UNSUPPORTED The GUID from the section specified by InputSection does not match any of + the GUIDs registered with ExtractGuidedSectionRegisterHandlers(). + @retval Others The return status from the handler associated with the GUID retrieved from + the section specified by InputSection. **/ RETURN_STATUS @@ -132,37 +202,83 @@ ExtractGuidedSectionGetInfo ( OUT UINT16 *SectionAttribute ); -/** - Extract data from the guided section. This function first gets the guid value - from guided section header, then match this guid in the registered extract Handler list - to its corresponding extract Handler. - If not found, RETURN_UNSUPPORTED will be return. - If found, it will call this extract Handler to get output data and AuthenticationStatus. - - It will ASSERT () if the pointer to OutputBuffer is NULL. - It will ASSERT () if the pointer to AuthenticationStatus is NULL. - - @param[in] InputSection Buffer containing the input GUIDed section to be processed. - @param[out] OutputBuffer OutputBuffer to point the start of the section's contents - if guided data is not required prcessing. Otherwise, - OutputBuffer to contain the output data, which is - allocated by the caller. - @param[out] ScratchBuffer A pointer to a caller-allocated buffer for function internal use. +/** + Retrieves the GUID from a GUIDed section and uses that GUID to select an associated handler of type + EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers(). + 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. + 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 + 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. + + 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(). + + @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 - A pointer to a caller-allocated UINT32 that indicates the - authentication status of the output buffer. - - @retval RETURN_SUCCESS Get the output data, size and AuthenticationStatus successfully. - @retval RETURN_UNSUPPORTED Guided section data is not supported to be decoded. - @retval RETURN_INVALID_PARAMETER The input data can't be parsed correctly. + 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. + + @retval RETURN_SUCCESS The buffer specified by InputSection was decoded. + @retval RETURN_UNSUPPORTED The section specified by InputSection does not match the GUID this handler supports. + @retval RETURN_INVALID_PARAMETER The section specified by InputSection can not be decoded. + **/ RETURN_STATUS EFIAPI ExtractGuidedSectionDecode ( IN CONST VOID *InputSection, OUT VOID **OutputBuffer, - OUT VOID *ScratchBuffer, OPTIONAL + IN VOID *ScratchBuffer, OPTIONAL OUT UINT32 *AuthenticationStatus ); +/** + 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 + GetInfoHandler and DecodeHandler. + + 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 + 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 + 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. + If it is NULL, then the previously registered handler is not returned. + + @retval RETURN_SUCCESS The handlers were retrieved. + @retval RETURN_NOT_FOUND No handlers have been registered with the specified GUID. + +**/ +RETURN_STATUS +EFIAPI +ExtractGuidedSectionGetHandlers ( + IN CONST GUID *SectionGuid, + OUT EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *GetInfoHandler, OPTIONAL + OUT EXTRACT_GUIDED_SECTION_DECODE_HANDLER *DecodeHandler OPTIONAL + ); + #endif