Update to use DOS format

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6318 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
qhuang8 2008-10-31 03:39:53 +00:00
parent 95f484c920
commit 4754c98b06
2 changed files with 40 additions and 40 deletions

View File

@ -26,14 +26,14 @@ UINT32 mNumberOfExtractHandler = 0;
EXTRACT_GUIDED_SECTION_DECODE_HANDLER *mExtractDecodeHandlerTable; EXTRACT_GUIDED_SECTION_DECODE_HANDLER *mExtractDecodeHandlerTable;
EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *mExtractGetInfoHandlerTable; EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *mExtractGetInfoHandlerTable;
/** /**
Construtor allocates the global memory to store the registered guid and Handler list. Construtor allocates the global memory to store the registered guid and Handler list.
@param ImageHandle The firmware allocated handle for the EFI image. @param ImageHandle The firmware allocated handle for the EFI image.
@param SystemTable A pointer to the EFI System Table. @param SystemTable A pointer to the EFI System Table.
@retval RETURN_SUCCESS Allocate the global memory space to store guid and funciton tables. @retval RETURN_SUCCESS Allocate the global memory space to store guid and funciton tables.
@retval RETURN_OUT_OF_RESOURCES No enough memory to allocated. @retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.
**/ **/
RETURN_STATUS RETURN_STATUS
EFIAPI EFIAPI
@ -66,15 +66,15 @@ DxeExtractGuidedSectionLibConstructor (
return RETURN_SUCCESS; return RETURN_SUCCESS;
} }
/** /**
Get the supported exract guided section Handler guid table, which is maintained Get the supported exract guided section Handler guid table, which is maintained
by library. The caller can directly get the guid table by library. The caller can directly get the guid table
without responsibility to allocate or free this table buffer. without responsibility to allocate or free this table buffer.
It will ASSERT () if ExtractHandlerGuidTable = NULL. 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 UINTN
EFIAPI EFIAPI
@ -88,14 +88,14 @@ ExtractGuidedSectionGetGuidList (
return mNumberOfExtractHandler; return mNumberOfExtractHandler;
} }
/** /**
Register Guided Section Extract and GetInfo handler. Register Guided Section Extract and GetInfo handler.
@param[in] SectionGuid The guid matches this Extraction function. @param[in] SectionGuid The guid matches this Extraction function.
@param[in] GetInfoHandler Function to get info from guided section. @param[in] GetInfoHandler Function to get info from guided section.
@param[in] DecodeHandler Function to extract guided section. @param[in] DecodeHandler Function to extract guided section.
@retval RETURN_SUCCESS Register Guided Section Extract function successfully. @retval RETURN_SUCCESS Register Guided Section Extract function successfully.
@retval RETURN_OUT_OF_RESOURCES Resource is not enough to register new function. @retval RETURN_OUT_OF_RESOURCES Resource is not enough to register new function.
@retval RETURN_INVALID_PARAMETER Input pointer to Guid value is not valid. @retval RETURN_INVALID_PARAMETER Input pointer to Guid value is not valid.
**/ **/
@ -146,7 +146,7 @@ ExtractGuidedSectionRegisterHandlers (
return RETURN_SUCCESS; return RETURN_SUCCESS;
} }
/** /**
Get information from the guided section. This function first gets the guid value 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 from guided section header, then match this guid in the registered extract Handler list
to its corresponding getinfo Handler. to its corresponding getinfo Handler.
@ -154,14 +154,14 @@ ExtractGuidedSectionRegisterHandlers (
If found, it will call the getinfo Handler to get the required size and attribute. 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 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. It will ASSERT () if the pointer to SectionAttribute is NULL.
@param[in] InputSection Buffer containing the input GUIDed section to be processed. @param[in] InputSection Buffer containing the input GUIDed section to be processed.
@param[out] OutputBufferSize The size of OutputBuffer. @param[out] OutputBufferSize The size of OutputBuffer.
@param[out] ScratchBufferSize The size of ScratchBuffer. @param[out] ScratchBufferSize The size of ScratchBuffer.
@param[out] SectionAttribute The attribute of the input guided section. @param[out] SectionAttribute The attribute of the input guided section.
@retval RETURN_SUCCESS Get the required information successfully. @retval RETURN_SUCCESS Get the required information successfully.
@retval RETURN_UNSUPPORTED Guided section data is not supported. @retval RETURN_UNSUPPORTED Guided section data is not supported.
@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.
@ -209,12 +209,12 @@ ExtractGuidedSectionGetInfo (
return RETURN_UNSUPPORTED; return RETURN_UNSUPPORTED;
} }
/** /**
Extract data from the guided section. This function first gets the guid value 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 from guided section header, then match this guid in the registered extract Handler list
to its corresponding extract Handler. to its corresponding extract Handler.
If not found, RETURN_INVALID_PARAMETER will be return. If not found, RETURN_INVALID_PARAMETER 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 OutputBuffer is NULL.
It will ASSERT () if the pointer to AuthenticationStatus is NULL. It will ASSERT () if the pointer to AuthenticationStatus is NULL.
@ -227,12 +227,12 @@ ExtractGuidedSectionGetInfo (
@param[out] ScratchBuffer A pointer to a caller-allocated buffer for function internal use. @param[out] ScratchBuffer A pointer to a caller-allocated buffer for function internal use.
@param[out] AuthenticationStatus @param[out] AuthenticationStatus
A pointer to a caller-allocated UINT32 that indicates the 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_SUCCESS Get the output data and AuthenticationStatus successfully.
@retval RETURN_UNSUPPORTED Guided section data is not supported to be decoded. @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 RETURN_STATUS
EFIAPI EFIAPI

View File

@ -30,14 +30,14 @@ typedef struct {
EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *ExtractGetInfoHandlerTable; EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *ExtractGetInfoHandlerTable;
} PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO; } PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO;
/** /**
Build guid hob for the global memory to store the registered guid and Handler list. Build guid hob for the global memory to store the registered guid and Handler list.
If GuidHob exists, HandlerInfo will be directly got from Guid hob data. If GuidHob exists, HandlerInfo will be directly got from Guid hob data.
@param[in, out] InfoPointer Pointer to pei handler info structure. @param[in, out] InfoPointer Pointer to pei handler info structure.
@retval RETURN_SUCCESS Build Guid hob for the global memory space to store guid and funciton tables. @retval RETURN_SUCCESS Build Guid hob for the global memory space to store guid and funciton tables.
@retval RETURN_OUT_OF_RESOURCES No enough memory to allocated. @retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.
**/ **/
RETURN_STATUS RETURN_STATUS
EFIAPI EFIAPI
@ -119,13 +119,13 @@ PeiGetExtractGuidedSectionHandlerInfo (
return EFI_SUCCESS; return EFI_SUCCESS;
} }
/** /**
Get the supported exract guided section Handler guid list. Get the supported exract guided section Handler guid list.
If ExtractHandlerGuidTable = NULL, then ASSERT. If ExtractHandlerGuidTable = NULL, then ASSERT.
@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 UINTN
EFIAPI EFIAPI
@ -153,14 +153,14 @@ ExtractGuidedSectionGetGuidList (
return HandlerInfo->NumberOfExtractHandler; return HandlerInfo->NumberOfExtractHandler;
} }
/** /**
Register Guided Section Extract and GetInfo handler. Register Guided Section Extract and GetInfo handler.
@param[in] SectionGuid The guid matches this Extraction function. @param[in] SectionGuid The guid matches this Extraction function.
@param[in] GetInfoHandler Function to get info from guided section. @param[in] GetInfoHandler Function to get info from guided section.
@param[in] DecodeHandler Function to extract guided section. @param[in] DecodeHandler Function to extract guided section.
@retval RETURN_SUCCESS Register Guided Section Extract function successfully. @retval RETURN_SUCCESS Register Guided Section Extract function successfully.
@retval RETURN_OUT_OF_RESOURCES Resource is not enough to register new function. @retval RETURN_OUT_OF_RESOURCES Resource is not enough to register new function.
@retval RETURN_INVALID_PARAMETER Input pointer to Guid value is not valid. @retval RETURN_INVALID_PARAMETER Input pointer to Guid value is not valid.
**/ **/
@ -222,7 +222,7 @@ ExtractGuidedSectionRegisterHandlers (
return RETURN_SUCCESS; return RETURN_SUCCESS;
} }
/** /**
Get information from the guided section. This function first gets the guid value 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 from guided section header, then match this guid in the registered extract Handler list
to its corresponding getinfo Handler. to its corresponding getinfo Handler.
@ -230,14 +230,14 @@ ExtractGuidedSectionRegisterHandlers (
If found, it will call the getinfo Handler to get the required size and attribute. 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 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. It will ASSERT () if the pointer to SectionAttribute is NULL.
@param[in] InputSection Buffer containing the input GUIDed section to be processed. @param[in] InputSection Buffer containing the input GUIDed section to be processed.
@param[out] OutputBufferSize The size of OutputBuffer. @param[out] OutputBufferSize The size of OutputBuffer.
@param[out] ScratchBufferSize The size of ScratchBuffer. @param[out] ScratchBufferSize The size of ScratchBuffer.
@param[out] SectionAttribute The attribute of the input guided section. @param[out] SectionAttribute The attribute of the input guided section.
@retval RETURN_SUCCESS Get the required information successfully. @retval RETURN_SUCCESS Get the required information successfully.
@retval RETURN_UNSUPPORTED Guided section data is not supported. @retval RETURN_UNSUPPORTED Guided section data is not supported.
@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.
@ -298,12 +298,12 @@ ExtractGuidedSectionGetInfo (
return RETURN_UNSUPPORTED; return RETURN_UNSUPPORTED;
} }
/** /**
Extract data from the guided section. This function first gets the guid value 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 from guided section header, then match this guid in the registered extract Handler list
to its corresponding extract Handler. to its corresponding extract Handler.
If not found, RETURN_INVALID_PARAMETER will be return. If not found, RETURN_INVALID_PARAMETER 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 OutputBuffer is NULL.
It will ASSERT () if the pointer to AuthenticationStatus is NULL. It will ASSERT () if the pointer to AuthenticationStatus is NULL.
@ -316,12 +316,12 @@ ExtractGuidedSectionGetInfo (
@param[out] ScratchBuffer A pointer to a caller-allocated buffer for function internal use. @param[out] ScratchBuffer A pointer to a caller-allocated buffer for function internal use.
@param[out] AuthenticationStatus @param[out] AuthenticationStatus
A pointer to a caller-allocated UINT32 that indicates the 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, size and AuthenticationStatus successfully. @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_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 RETURN_STATUS
EFIAPI EFIAPI