diff options
| -rw-r--r-- | MdePkg/Include/Library/ExtractGuidedSectionLib.h | 46 |
1 files changed, 23 insertions, 23 deletions
diff --git a/MdePkg/Include/Library/ExtractGuidedSectionLib.h b/MdePkg/Include/Library/ExtractGuidedSectionLib.h index 72e979d..63595ee 100644 --- a/MdePkg/Include/Library/ExtractGuidedSectionLib.h +++ b/MdePkg/Include/Library/ExtractGuidedSectionLib.h @@ -15,17 +15,17 @@ #ifndef __EXTRACT_GUIDED_SECTION_H__
#define __EXTRACT_GUIDED_SECTION_H__
-/** +/**
Get information 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 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_INVALID_PARAMETER The input data is not the valid guided section.
@@ -39,8 +39,8 @@ RETURN_STATUS OUT UINT16 *SectionAttribute
);
-/** - Extract data and Auth from the specific guided section. +/**
+ Extract data and Auth from the specific guided section.
It will ASSERT () if the pointer to OutputBuffer is NULL.
It will ASSERT () if the pointer to AuthenticationStatus is NULL.
@@ -51,8 +51,8 @@ RETURN_STATUS @param[out] ScratchBuffer A pointer to a caller-allocated buffer for function internal use.
@param[out] AuthenticationStatus
A pointer to a caller-allocated UINT32 that indicates the
- authentication status of the output buffer. - + authentication status of the output buffer.
+
@retval RETURN_SUCCESS Get the output data and AuthenticationStatus successfully.
@retval RETURN_INVALID_PARAMETER The input data is not the valid guided section.
@@ -66,14 +66,14 @@ RETURN_STATUS OUT UINT32 *AuthenticationStatus
);
-/** +/**
Register Guided Section Extract and GetInfo Handler.
- @param[in] SectionGuid The guid matches this Extraction Handler. + @param[in] SectionGuid The guid matches this Extraction Handler.
@param[in] GetInfoHandler Handler to get information from guided section.
- @param[in] DecodeHandler Handler to extract guided section. - - @retval RETURN_SUCCESS Register Guided Section Extract Handler successfully. + @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 Pointer to Guid value is not valid.
@@ -86,15 +86,15 @@ 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 the guid table
without responsibility to allocate or free this table buffer.
It will ASSERT () if ExtractHandlerGuidTable = NULL.
- @param[out] ExtractHandlerGuidTable The extract Handler guid pointer list. + @param[out] ExtractHandlerGuidTable The extract Handler guid pointer list.
- @return the number of the supported extract guided Handler. + @return the number of the supported extract guided Handler.
**/
UINTN
EFIAPI
@@ -102,7 +102,7 @@ ExtractGuidedSectionGetGuidList ( 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.
@@ -110,14 +110,14 @@ ExtractGuidedSectionGetGuidList ( 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 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 is not the valid guided section.
@@ -132,12 +132,12 @@ 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. + 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.
@@ -150,11 +150,11 @@ ExtractGuidedSectionGetInfo ( @param[out] ScratchBuffer A pointer to a caller-allocated buffer for function internal use.
@param[out] AuthenticationStatus
A pointer to a caller-allocated UINT32 that indicates the
- authentication status of the output buffer. - + authentication status of the output buffer.
+
@retval RETURN_SUCCESS Get the output data and AuthenticationStatus successfully.
@retval RETURN_UNSUPPORTED Guided section data is not supported to be decoded.
- @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.
**/
RETURN_STATUS
EFIAPI
|