EXTRACT_GUIDED_SECTION_DECODE_HANDLER *mExtractDecodeHandlerTable;\r
EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *mExtractGetInfoHandlerTable;\r
\r
-/**
+/**\r
Construtor allocates the global memory to store the registered guid and Handler list.\r
\r
@param ImageHandle The firmware allocated handle for the EFI image.\r
- @param SystemTable A pointer to the EFI System Table.
+ @param SystemTable A pointer to the EFI System Table.\r
\r
@retval RETURN_SUCCESS Allocate the global memory space to store guid and funciton tables.\r
- @retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.
+ @retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.\r
**/\r
RETURN_STATUS\r
EFIAPI\r
return RETURN_SUCCESS;\r
}\r
\r
-/**
+/**\r
Get the supported exract guided section Handler guid table, which is maintained\r
by library. The caller can directly get the guid table \r
without responsibility to allocate or free this table buffer. \r
It will ASSERT () if ExtractHandlerGuidTable = NULL.\r
\r
- @param[out] ExtractHandlerGuidTable The extract Handler guid pointer list.
+ @param[out] ExtractHandlerGuidTable The extract Handler guid pointer list.\r
\r
- @return the number of the supported extract guided Handler.
+ @return the number of the supported extract guided Handler.\r
**/\r
UINTN\r
EFIAPI\r
return mNumberOfExtractHandler;\r
}\r
\r
-/**
+/**\r
Register Guided Section Extract and GetInfo handler.\r
\r
- @param[in] SectionGuid The guid matches this Extraction function.
+ @param[in] SectionGuid The guid matches this Extraction function.\r
@param[in] GetInfoHandler Function to get info from guided section.\r
- @param[in] DecodeHandler Function to extract guided section.
-
- @retval RETURN_SUCCESS Register Guided Section Extract function successfully.
+ @param[in] DecodeHandler Function to extract guided section.\r
+\r
+ @retval RETURN_SUCCESS Register Guided Section Extract function successfully.\r
@retval RETURN_OUT_OF_RESOURCES Resource is not enough to register new function. \r
@retval RETURN_INVALID_PARAMETER Input pointer to Guid value is not valid.\r
**/\r
return RETURN_SUCCESS;\r
}\r
\r
-/**
+/**\r
Get information from the guided section. This function first gets the guid value\r
from guided section header, then match this guid in the registered extract Handler list\r
to its corresponding getinfo Handler. \r
If found, it will call the getinfo Handler to get the required size and attribute.\r
\r
It will ASSERT () if the pointer to OutputBufferSize is NULL.\r
- It will ASSERT () if the pointer to ScratchBufferSize is NULL.
+ It will ASSERT () if the pointer to ScratchBufferSize is NULL.\r
It will ASSERT () if the pointer to SectionAttribute is NULL.\r
\r
@param[in] InputSection Buffer containing the input GUIDed section to be processed. \r
@param[out] OutputBufferSize The size of OutputBuffer.\r
@param[out] ScratchBufferSize The size of ScratchBuffer. \r
@param[out] SectionAttribute The attribute of the input guided section.\r
-
+\r
@retval RETURN_SUCCESS Get the required information successfully.\r
@retval RETURN_UNSUPPORTED Guided section data is not supported.\r
@retval RETURN_INVALID_PARAMETER The input data is not the valid guided section.\r
return RETURN_UNSUPPORTED;\r
}\r
\r
-/**
+/**\r
Extract data from the guided section. This function first gets the guid value\r
from guided section header, then match this guid in the registered extract Handler list\r
to its corresponding extract Handler. \r
If not found, RETURN_INVALID_PARAMETER will be return. \r
- If found, it will call this extract Handler to get output data and AuthenticationStatus.
+ If found, it will call this extract Handler to get output data and AuthenticationStatus.\r
\r
It will ASSERT () if the pointer to OutputBuffer is NULL.\r
It will ASSERT () if the pointer to AuthenticationStatus is NULL.\r
@param[out] ScratchBuffer A pointer to a caller-allocated buffer for function internal use. \r
@param[out] AuthenticationStatus \r
A pointer to a caller-allocated UINT32 that indicates the\r
- authentication status of the output buffer.
-
+ authentication status of the output buffer. \r
+\r
@retval RETURN_SUCCESS Get the output data and AuthenticationStatus successfully.\r
@retval RETURN_UNSUPPORTED Guided section data is not supported to be decoded.\r
- @retval RETURN_INVALID_PARAMETER The input data is not the valid guided section.
-
+ @retval RETURN_INVALID_PARAMETER The input data is not the valid guided section.\r
+\r
**/\r
RETURN_STATUS\r
EFIAPI\r
EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *ExtractGetInfoHandlerTable;\r
} PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO;\r
\r
-/**
+/**\r
Build guid hob for the global memory to store the registered guid and Handler list.\r
If GuidHob exists, HandlerInfo will be directly got from Guid hob data.\r
\r
- @param[in, out] InfoPointer Pointer to pei handler info structure.
+ @param[in, out] InfoPointer Pointer to pei handler info structure.\r
\r
@retval RETURN_SUCCESS Build Guid hob for the global memory space to store guid and funciton tables.\r
- @retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.
+ @retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.\r
**/\r
RETURN_STATUS\r
EFIAPI\r
return EFI_SUCCESS;\r
}\r
\r
-/**
+/**\r
Get the supported exract guided section Handler guid list.\r
If ExtractHandlerGuidTable = NULL, then ASSERT.\r
\r
- @param[out] ExtractHandlerGuidTable The extract Handler guid pointer list.
+ @param[out] ExtractHandlerGuidTable The extract Handler guid pointer list.\r
\r
- @return the number of the supported extract guided Handler.
+ @return the number of the supported extract guided Handler.\r
**/\r
UINTN\r
EFIAPI\r
return HandlerInfo->NumberOfExtractHandler;\r
}\r
\r
-/**
+/**\r
Register Guided Section Extract and GetInfo handler.\r
\r
- @param[in] SectionGuid The guid matches this Extraction function.
+ @param[in] SectionGuid The guid matches this Extraction function.\r
@param[in] GetInfoHandler Function to get info from guided section.\r
- @param[in] DecodeHandler Function to extract guided section.
-
- @retval RETURN_SUCCESS Register Guided Section Extract function successfully.
+ @param[in] DecodeHandler Function to extract guided section.\r
+\r
+ @retval RETURN_SUCCESS Register Guided Section Extract function successfully.\r
@retval RETURN_OUT_OF_RESOURCES Resource is not enough to register new function. \r
@retval RETURN_INVALID_PARAMETER Input pointer to Guid value is not valid.\r
**/\r
return RETURN_SUCCESS;\r
}\r
\r
-/**
+/**\r
Get information from the guided section. This function first gets the guid value\r
from guided section header, then match this guid in the registered extract Handler list\r
to its corresponding getinfo Handler. \r
If found, it will call the getinfo Handler to get the required size and attribute.\r
\r
It will ASSERT () if the pointer to OutputBufferSize is NULL.\r
- It will ASSERT () if the pointer to ScratchBufferSize is NULL.
+ It will ASSERT () if the pointer to ScratchBufferSize is NULL.\r
It will ASSERT () if the pointer to SectionAttribute is NULL.\r
\r
@param[in] InputSection Buffer containing the input GUIDed section to be processed. \r
@param[out] OutputBufferSize The size of OutputBuffer.\r
@param[out] ScratchBufferSize The size of ScratchBuffer. \r
@param[out] SectionAttribute The attribute of the input guided section.\r
-
+\r
@retval RETURN_SUCCESS Get the required information successfully.\r
@retval RETURN_UNSUPPORTED Guided section data is not supported.\r
@retval RETURN_INVALID_PARAMETER The input data is not the valid guided section.\r
return RETURN_UNSUPPORTED;\r
}\r
\r
-/**
+/**\r
Extract data from the guided section. This function first gets the guid value\r
from guided section header, then match this guid in the registered extract Handler list\r
to its corresponding extract Handler. \r
If not found, RETURN_INVALID_PARAMETER will be return. \r
- If found, it will call this extract Handler to get output data and AuthenticationStatus.
+ If found, it will call this extract Handler to get output data and AuthenticationStatus.\r
\r
It will ASSERT () if the pointer to OutputBuffer is NULL.\r
It will ASSERT () if the pointer to AuthenticationStatus is NULL.\r
@param[out] ScratchBuffer A pointer to a caller-allocated buffer for function internal use. \r
@param[out] AuthenticationStatus \r
A pointer to a caller-allocated UINT32 that indicates the\r
- authentication status of the output buffer.
-
+ authentication status of the output buffer. \r
+\r
@retval RETURN_SUCCESS Get the output data, size and AuthenticationStatus successfully.\r
@retval RETURN_UNSUPPORTED Guided section data is not supported to be decoded.\r
- @retval RETURN_INVALID_PARAMETER The input data is not the valid guided section.
-
+ @retval RETURN_INVALID_PARAMETER The input data is not the valid guided section.\r
+\r
**/\r
RETURN_STATUS\r
EFIAPI\r
projects / mirror_edk2.git / commitdiff