\r
@param ErrorLevel The error level of the debug message.\r
@param Format Format string for the debug message to print.\r
+ @param ... The variable argument list.\r
\r
**/\r
VOID\r
\r
If Length is greater than (MAX_ADDRESS ?Buffer + 1), then ASSERT(). \r
\r
- @param Buffer Pointer to the target buffer to fill with PcdDebugClearMemoryValue.\r
+ @param Buffer Pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r
@param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
\r
- @return Buffer\r
+ @return Buffer Pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
\r
**/\r
VOID *\r
\r
Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.\r
\r
- This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of \r
+ This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of \r
PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
\r
- @retval TRUE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
- @retval FALSE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
+ @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
+ @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
\r
**/\r
BOOLEAN\r
/** @file\r
- Extract Guided Section Library class\r
+ Extract Guided Section Library class defintions, \r
+ which can provide many handlers for the different guided section data.\r
\r
- Copyright (c) 2007, Intel Corporation\r
+ Copyright (c) 2007 - 2008, Intel Corporation\r
All rights reserved. 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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
\r
- ExtractGuidedSectionLib.h\r
**/\r
#ifndef __EXTRACT_GUIDED_SECTION_H__\r
#define __EXTRACT_GUIDED_SECTION_H__\r
\r
/**
- Get information Handler for the input guided section data.\r
+ Get information for the input guided section data.\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 SectionAttribute is NULL.\r
@param[out] SectionAttribute The attribute of the input guided section.\r
@retval RETURN_SUCCESS Get the required information successfully.\r
- @retval RETURN_INVALID_PARAMETER The input data can't be parsed correctly.\r
+ @retval RETURN_INVALID_PARAMETER The input data is not the valid guided section.\r
\r
**/\r
typedef\r
);\r
\r
/**
- Extract data Handler for one specific guided section.
+ Extract data and Auth from the specific guided section.
It will ASSERT () if the pointer to OutputBuffer is NULL.\r
It will ASSERT () if the pointer to AuthenticationStatus is NULL.\r
\r
@param[in] InputSection Buffer containing the input GUIDed section to be processed. \r
- @param[out] OutputBuffer OutputBuffer to point to the start of the section's contents.\r
+ @param[out] OutputBuffer OutputBuffer directly points to the start of the section's contents,\r
if guided data is not prcessed. Otherwise,\r
- OutputBuffer to contain the output data, which is allocated by the caller.\r
+ OutputBuffer contains the output data, which is allocated by the caller.\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.
@retval RETURN_SUCCESS Get the output data and AuthenticationStatus successfully.\r
- @retval RETURN_INVALID_PARAMETER The input data can't be parsed correctly.\r
+ @retval RETURN_INVALID_PARAMETER The input data is not the valid guided section.\r
\r
**/\r
typedef\r
Register Guided Section Extract and GetInfo Handler.\r
\r
@param[in] SectionGuid The guid matches this Extraction Handler.
- @param[in] GetInfoHandler Handler to get info from guided section.\r
+ @param[in] GetInfoHandler Handler to get information from guided section.\r
@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. \r
- @retval RETURN_INVALID_PARAMETER Input pointer to Guid value is not valid.\r
+ @retval RETURN_INVALID_PARAMETER Pointer to Guid value is not valid.\r
\r
**/\r
RETURN_STATUS\r
\r
/**
Get the supported exract guided section Handler guid table, which is maintained\r
- by library. The caller can directly get this guid table pointer \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[in, out] ExtractHandlerGuidTable The extract Handler guid pointer list.
+ @param[out] ExtractHandlerGuidTable The extract Handler guid pointer list.
\r
- @retval return the number of the supported extract guided Handler.
+ @return the number of the supported extract guided Handler.
**/\r
UINTN\r
EFIAPI\r
ExtractGuidedSectionGetGuidList (\r
- IN OUT GUID **ExtractHandlerGuidTable\r
+ OUT GUID **ExtractHandlerGuidTable\r
);\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 can't be parsed correctly.\r
+ @retval RETURN_INVALID_PARAMETER The input data is not the valid guided section.\r
\r
**/\r
RETURN_STATUS\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 can't be parsed correctly.
+ @retval RETURN_INVALID_PARAMETER The input data is not the valid guided section.
**/\r
RETURN_STATUS\r
EFIAPI\r
/** @file\r
- Report Status Code Library public .h file\r
+ Post Code Library functions defintion.\r
\r
- Copyright (c) 2006, Intel Corporation \r
+ Copyright (c) 2006 - 2008, Intel Corporation \r
All rights reserved. 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
display the 32-bit value on the status reporting device.\r
\r
PostCode() must actively prevent recursion. If PostCode() is called while \r
- processing another any other Report Status Code Library function, then \r
+ processing another any other Post Code Library function, then \r
PostCode() must return Value immediately.\r
\r
@param Value The 32-bit value to write to the POST card.\r
\r
- @return Value\r
+ @return Value The 32-bit value to write to the POST card.\r
\r
**/\r
UINT32\r
value on the status reporting device. \r
\r
PostCodeWithDescription()must actively prevent recursion. If \r
- PostCodeWithDescription() is called while processing another any other Report \r
- Status Code Library function, then PostCodeWithDescription() must return Value \r
- immediately.\r
+ PostCodeWithDescription() is called while processing another any other \r
+ Post Code Library function, then PostCodeWithDescription() \r
+ must return Value immediately.\r
\r
@param Value The 32-bit value to write to the POST card.\r
@param Description Pointer to an ASCII string that is a description of the \r
POST code value. This is an optional parameter that may \r
be NULL.\r
\r
- @return Value\r
+ @return Value The 32-bit value to write to the POST card.\r
\r
**/\r
UINT32\r
/**\r
Returns TRUE if POST code descriptions are enabled.\r
\r
- This function returns TRUE if the \r
- POST_CODE_PROPERTY_POST_CODE_ENABLED bit of \r
- PcdPostCodePropertyMask is set. Otherwise FALSE is returned.\r
+ This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED\r
+ bit of PcdPostCodePropertyMask is set. Otherwise FALSE is returned.\r
\r
- @retval TRUE The POST_CODE_PROPERTY_POST_CODE_ENABLED \r
- bit of PcdPostCodeProperyMask is set.\r
- @retval FALSE The POST_CODE_PROPERTY_POST_CODE_ENABLED \r
- bit of PcdPostCodeProperyMask is clear.\r
+ @retval TRUE The POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of\r
+ PcdPostCodeProperyMask is set.\r
+ @retval FALSE The POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of\r
+ PcdPostCodeProperyMask is clear.\r
\r
**/\r
BOOLEAN\r
\r
@param Value The 32-bit value to write to the POST card.\r
\r
- @return Value\r
+ @return Value The 32-bit value to write to the POST card.\r
\r
**/\r
#define POST_CODE(Value) PostCodeEnabled() ? PostCode(Value) : Value\r
@param Description Pointer to an ASCII string that is a description of the \r
POST code value.\r
\r
+ @return Value The 32-bit value to write to the POST card.\r
**/\r
#define POST_CODE_WITH_DESCRIPTION(Value,Description) \\r
PostCodeEnabled() ? \\r
/** @file
- Library that provides print services
+ Library header file that defines print services
- Copyright (c) 2006 - 2007, Intel Corporation
+ Copyright (c) 2006 - 2008, 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
Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param FormatString Null-terminated Unicode format string.
+ @param ... The variable argument list.
@return The number of Unicode characters in the produced output buffer not including the
Null-terminator.
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
- @param FormatString Null-terminated Unicode format string.
+ @param FormatString Null-terminated ASCII format string.
@param Marker VA_LIST marker for the variable argument list.
@return The number of Unicode characters in the produced output buffer not including the
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
- @param FormatString Null-terminated Unicode format string.
+ @param FormatString Null-terminated ASCII format string.
+ @param ... The variable argument list.
@return The number of Unicode characters in the produced output buffer not including the
Null-terminator.
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
ASCII string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
- @param FormatString Null-terminated Unicode format string.
+ @param FormatString Null-terminated ASCII format string.
@param Marker VA_LIST marker for the variable argument list.
@return The number of ASCII characters in the produced output buffer not including the
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
ASCII string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
- @param FormatString Null-terminated Unicode format string.
-
+ @param FormatString Null-terminated ASCII format string.
+ @param ... The variable argument list.
+
@return The number of ASCII characters in the produced output buffer not including the
Null-terminator.
/**
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
- ASCII format string and a VA_LIST argument list.
+ Unicode format string and a VA_LIST argument list.
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer
and BufferSize.
/**
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
- ASCII format string and variable argument list.
+ Unicode format string and variable argument list.
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer
and BufferSize.
ASCII string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param FormatString Null-terminated Unicode format string.
+ @param ... The variable argument list.
@return The number of ASCII characters in the produced output buffer not including the
Null-terminator.
-\r
/** @file\r
- Serial I/O Port library functions with no library constructor/destructor\r
+ Serial I/O Port library functions definition.\r
\r
- Copyright (c) 2006, Intel Corporation\r
+ Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. 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
);\r
\r
/**\r
- Write data to serial device. \r
+ Write data from buffer to serial device. \r
\r
- If the buffer is NULL, then return 0; \r
+ If the Buffer is NULL, then return 0; \r
if NumberOfBytes is zero, then return 0. \r
\r
@param Buffer Point of data buffer which need to be writed.\r
@param NumberOfBytes Number of output bytes which are cached in Buffer.\r
\r
- @retval 0 Write data failed.\r
+ @retval 0 Write data failed, or No data is to be written.\r
@retval !0 Actual number of bytes writed to serial device.\r
\r
**/\r
/**\r
Read data from serial device and save the datas in buffer.\r
\r
- If the buffer is NULL, then return zero;\r
+ If the Buffer is NULL, then return zero;\r
if NumberOfBytes is zero, then return zero.\r
\r
- @param Buffer Point of data buffer which need to be writed.\r
- @param NumberOfBytes Number of output bytes which are cached in Buffer.\r
+ @param Buffer Point of data buffer, which contains the data \r
+ returned from the serial device.\r
+ @param NumberOfBytes Number of bytes which will be read.\r
\r
- @retval 0 Read data failed.\r
+ @retval 0 Read data failed, No data is to be read.\r
@retval !0 Aactual number of bytes read from serial device.\r
\r
**/\r
/** @file\r
- Return UEFI Decompress Protocol \r
+ UEFI Decompress Library Functions defintion\r
\r
- Copyright (c) 2006, Intel Corporation \r
+ The UEFI Decompress Library enables the decompression of objects that \r
+ were compressed using the UEFI compression scheme. The UEFI Decompress \r
+ Library is independent of environment and requires the caller to allocate \r
+ all required memory buffers.\r
+\r
+ Copyright (c) 2006 - 2008, Intel Corporation \r
All rights reserved. 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
#define __UEFI_DECPOMPRESS_LIB_H__\r
\r
/**\r
- Retrieves the size of the uncompressed buffer and the size of the scratch buffer.\r
+ Given a compressed source buffer, this function retrieves the size of \r
+ the uncompressed buffer and the size of the scratch buffer required \r
+ to decompress the compressed source buffer.\r
\r
Retrieves the size of the uncompressed buffer and the temporary scratch buffer \r
required to decompress the buffer specified by Source and SourceSize.\r
is required to decompress the compressed buffer specified \r
by Source and SourceSize.\r
\r
- @retval RETURN_SUCCESS The size of destination buffer and the size of scratch \r
- buffer are successull retrieved.\r
- @retval RETURN_INVALID_PARAMETER The source data is corrupted\r
-\r
+ @retval RETURN_SUCCESS The size of the uncompressed data was returned \r
+ in DestinationSize and the size of the scratch \r
+ buffer was returned in ScratchSize.\r
+ @retval RETURN_INVALID_PARAMETER \r
+ The size of the uncompressed data or the size of \r
+ the scratch buffer cannot be determined from \r
+ the compressed data specified by Source \r
+ and SourceSize.\r
**/\r
RETURN_STATUS\r
EFIAPI\r
/**\r
Decompresses a compressed source buffer.\r
\r
+ Extracts decompressed data to its original form.\r
This function is designed so that the decompression algorithm can be implemented\r
without using any memory services. As a result, this function is not allowed to\r
call any memory allocation services in its implementation. It is the caller's r\r
This is an optional parameter that may be NULL if the \r
required scratch buffer size is 0.\r
\r
- @retval RETURN_SUCCESS Decompression is successfull\r
- @retval RETURN_INVALID_PARAMETER The source data is corrupted\r
-\r
+ @retval RETURN_SUCCESS Decompression completed successfully, and \r
+ the uncompressed buffer is returned in Destination.\r
+ @retval RETURN_INVALID_PARAMETER \r
+ The source buffer specified by Source is corrupted \r
+ (not in a valid compressed format).\r
**/\r
RETURN_STATUS\r
EFIAPI\r
#/** @file\r
-# Component description file for NULL Debug Library\r
+# Null Base Debug Library instance with empty functions.\r
#\r
-# Debug Library with empty functions.\r
-# Copyright (c) 2007, Intel Corporation.\r
+# Copyright (c) 2007 - 2008, Intel Corporation.\r
#\r
# All rights reserved. This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
/** @file\r
- Base Debug Library that uses PrintLib to print messages to a memory buffer.\r
+ Null Base Debug Library instance with empty functions.\r
\r
- Copyright (c) 2006, Intel Corporation\r
+ Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. 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
the message specified by Format and the associated variable argument list to \r
the debug output device.\r
\r
- If Format is NULL, then ASSERT().\r
-\r
@param ErrorLevel The error level of the debug message.\r
@param Format Format string for the debug message to print.\r
+ @param ... The variable argument list.\r
\r
**/\r
VOID\r
\r
Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.\r
\r
- This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of \r
+ This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of \r
PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
\r
- @retval TRUE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
- @retval FALSE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
+ @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
+ @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
\r
@return Always return FALSE.\r
\r
#/** @file\r
-# Component description file for Debug Base Post Code Library.\r
#\r
# Post Code Library that layers on top of a Debug Library instance.\r
-# Copyright (c) 2007, Intel Corporation.\r
+# Copyright (c) 2007 - 2008, Intel Corporation.\r
#\r
# All rights reserved. This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
/** @file\r
- Report Status Code Library Post Code functions for DXE Phase.\r
+ Base Post Code Library instance based on Debug Library.\r
\r
- Copyright (c) 2006, Intel Corporation<BR>\r
+ Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
All rights reserved. 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
display the 32-bit value on the status reporting device.\r
\r
PostCode() must actively prevent recursion. If PostCode() is called while \r
- processing another any other Report Status Code Library function, then \r
+ processing another any other Post Code Library function, then \r
PostCode() must return Value immediately.\r
\r
- @param Value The 32-bit value to write to the POST card.\r
+ @param Value The 32-bit value to write to the POST card.\r
\r
- @return Value\r
+ @return Value The 32-bit value to write to the POST card.\r
\r
**/\r
UINT32\r
value on the status reporting device. \r
\r
PostCodeWithDescription()must actively prevent recursion. If \r
- PostCodeWithDescription() is called while processing another any other Report \r
- Status Code Library function, then PostCodeWithDescription() must return Value \r
+ PostCodeWithDescription() is called while processing another any other Post \r
+ Code Library function, then PostCodeWithDescription() must return Value \r
immediately.\r
\r
@param Value The 32-bit value to write to the POST card.\r
POST code value. This is an optional parameter that may \r
be NULL.\r
\r
- @return Value\r
+ @return Value The 32-bit value to write to the POST card.\r
\r
**/\r
UINT32\r
/**\r
Returns TRUE if POST code descriptions are enabled.\r
\r
- This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_ENABLED\r
+ This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED\r
bit of PcdPostCodePropertyMask is set. Otherwise FALSE is returned.\r
\r
- @retval TRUE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of\r
+ @retval TRUE The POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of\r
PcdPostCodeProperyMask is set.\r
- @retval FALSE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of\r
+ @retval FALSE The POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of\r
PcdPostCodeProperyMask is clear.\r
\r
**/\r
VOID\r
)\r
{\r
- return (BOOLEAN) ((PcdGet8(PcdPostCodePropertyMask) & POST_CODE_PROPERTY_POST_CODE_ENABLED) != 0);\r
+ return (BOOLEAN) ((PcdGet8(PcdPostCodePropertyMask) & POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED) != 0);\r
}\r
/** @file\r
- Report Status Code Library Post Code functions for DXE Phase.\r
+ Post Code Library instance that writes post code values to I/O port 0x80.\r
\r
- Copyright (c) 2006, Intel Corporation<BR>\r
+ Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
All rights reserved. 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
display the 32-bit value on the status reporting device.\r
\r
PostCode() must actively prevent recursion. If PostCode() is called while \r
- processing another any other Report Status Code Library function, then \r
+ processing another any other Post Code Library function, then \r
PostCode() must return Value immediately.\r
\r
@param Value The 32-bit value to write to the POST card.\r
\r
- @return Value\r
+ @return Value The 32-bit value to write to the POST card.\r
\r
**/\r
UINT32\r
value on the status reporting device. \r
\r
PostCodeWithDescription()must actively prevent recursion. If \r
- PostCodeWithDescription() is called while processing another any other Report \r
- Status Code Library function, then PostCodeWithDescription() must return Value \r
+ PostCodeWithDescription() is called while processing another any other Post \r
+ Code Library function, then PostCodeWithDescription() must return Value \r
immediately.\r
\r
@param Value The 32-bit value to write to the POST card.\r
@param Description Pointer to an ASCII string that is a description of the \r
POST code value. This is an optional parameter that may \r
- be NULL.\r
+ be NULL. Ihis parameter is ignored in this implementation. \r
\r
- @return Value\r
+ @return Value The 32-bit value to write to the POST card.\r
\r
**/\r
UINT32\r
/**\r
Returns TRUE if POST code descriptions are enabled.\r
\r
- This function returns TRUE if the \r
- POST_CODE_PROPERTY_POST_CODE_ENABLED bit of \r
- PcdPostCodePropertyMask is set. Otherwise FALSE is returned.\r
+ This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED\r
+ bit of PcdPostCodePropertyMask is set. Otherwise FALSE is returned.\r
\r
- @retval TRUE The POST_CODE_PROPERTY_POST_CODE_ENABLED \r
- bit of PcdPostCodeProperyMask is set.\r
- @retval FALSE The POST_CODE_PROPERTY_POST_CODE_ENABLED \r
- bit of PcdPostCodeProperyMask is clear.\r
+ @retval TRUE The POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of\r
+ PcdPostCodeProperyMask is set.\r
+ @retval FALSE The POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of\r
+ PcdPostCodeProperyMask is clear.\r
\r
**/\r
BOOLEAN\r
VOID\r
)\r
{\r
- return (BOOLEAN) ((PcdGet8(PcdPostCodePropertyMask) & POST_CODE_PROPERTY_POST_CODE_ENABLED) != 0);\r
+ return (BOOLEAN) ((PcdGet8(PcdPostCodePropertyMask) & POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED) != 0);\r
}\r
#/** @file\r
# Component description file for Base Print Library.\r
#\r
-# Print Library implementation.\r
-# Copyright (c) 2007, Intel Corporation.\r
+# Base Print Library instance implementation.\r
+# Copyright (c) 2007 - 2008, Intel Corporation.\r
#\r
# All rights reserved. This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
/** @file\r
- Print Library.\r
+ Base Print Library instance implementation.\r
\r
- Copyright (c) 2006 - 2007, Intel Corporation<BR>\r
+ Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
All rights reserved. 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
#define ERROR_STATUS_NUMBER 24\r
#define ASSERT_UNICODE_BUFFER(Buffer) ASSERT ((((UINTN) (Buffer)) & 0x01) == 0)\r
\r
-GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 *StatusString [] = {\r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 *gStatusString[] = {\r
"Success", // RETURN_SUCCESS = 0\r
"Warning Unknown Glyph", // RETURN_WARN_UNKNOWN_GLYPH = 1\r
"Warning Delete Failure", // RETURN_WARN_DELETE_FAILURE = 2\r
//\r
Index = Status & ~MAX_BIT;\r
if (Index > 0 && Index <= ERROR_STATUS_NUMBER) {\r
- ArgumentString = StatusString [Index + WARNING_STATUS_NUMBER];\r
+ ArgumentString = gStatusString [Index + WARNING_STATUS_NUMBER];\r
}\r
} else {\r
Index = Status;\r
if (Index <= WARNING_STATUS_NUMBER) {\r
- ArgumentString = StatusString [Index];\r
+ ArgumentString = gStatusString [Index];\r
}\r
}\r
if (ArgumentString == ValueBuffer) {\r
VA_LIST is used this rountine allows the nesting of Vararg routines. Thus \r
this is the main print working routine.\r
\r
- @param Buffer Character buffer to print the results of the parsing\r
+ @param StartOfBuffer Character buffer to print the results of the parsing\r
of Format into.\r
@param BufferSize Maximum number of characters to put into buffer.\r
Zero means no limit.\r
@param Flags Intial flags value.\r
Can only have FORMAT_UNICODE and OUTPUT_UNICODE set\r
@param FormatString Null-terminated format string.\r
+ @param ... The variable argument list.\r
\r
@return Number of characters printed not including the Null-terminator.\r
\r
Unicode string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
@param FormatString Null-terminated Unicode format string.\r
- \r
+ @param ... The variable argument list.\r
@return The number of Unicode characters in the produced output buffer not including the\r
Null-terminator.\r
\r
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
Unicode string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
+ @param FormatString Null-terminated ASCII format string.\r
@param Marker VA_LIST marker for the variable argument list.\r
\r
@return The number of Unicode characters in the produced output buffer not including the\r
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
Unicode string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
+ @param FormatString Null-terminated ASCII format string.\r
+ @param ... The variable argument list.\r
\r
@return The number of Unicode characters in the produced output buffer not including the\r
Null-terminator.\r
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
ASCII string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
+ @param FormatString Null-terminated ASCII format string.\r
@param Marker VA_LIST marker for the variable argument list.\r
\r
@return The number of ASCII characters in the produced output buffer not including the\r
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
ASCII string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
+ @param FormatString Null-terminated ASCII format string.\r
+ @param ... The variable argument list.\r
\r
@return The number of ASCII characters in the produced output buffer not including the\r
Null-terminator.\r
\r
/**\r
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
- ASCII format string and a VA_LIST argument list.\r
+ Unicode format string and a VA_LIST argument list.\r
\r
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
and BufferSize.\r
\r
/**\r
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
- ASCII format string and variable argument list.\r
+ Unicode format string and variable argument list.\r
\r
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
and BufferSize.\r
ASCII string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
@param FormatString Null-terminated Unicode format string.\r
+ @param ... The variable argument list.\r
\r
@return The number of ASCII characters in the produced output buffer not including the\r
Null-terminator.\r
/** @file\r
- Print Library worker functions.\r
+ Print Library internal worker functions.\r
\r
- Copyright (c) 2006 - 2007, Intel Corporation<BR>\r
+ Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
All rights reserved. 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
@param Character Character to be placed into Buffer.\r
@param Increment Character increment in Buffer.\r
\r
- @return Number of characters printed.\r
+ @return Buffer Buffer filled with the input Character.\r
\r
**/\r
CHAR8 *\r
BasePrintLibFillBuffer (\r
- CHAR8 *Buffer,\r
- CHAR8 *EndBuffer,\r
- INTN Length,\r
- UINTN Character,\r
- INTN Increment\r
+ OUT CHAR8 *Buffer,\r
+ IN CHAR8 *EndBuffer,\r
+ IN INTN Length,\r
+ IN UINTN Character,\r
+ IN INTN Increment\r
)\r
{\r
INTN Index;\r
\r
**/\r
UINTN\r
-EFIAPI\r
BasePrintLibValueToString (\r
IN OUT CHAR8 *Buffer,\r
IN INT64 Value,\r
*(Buffer++) = mHexStr[Remainder];\r
Digits++;\r
} while (Value != 0);\r
+\r
+ //\r
+ // the length of Buffer string converted from Value\r
+ //\r
return Digits;\r
}\r
\r
UINTN Index;\r
UINTN Radix;\r
\r
+ //\r
+ // Make sure Buffer is not NULL and Width < MAXIMUM\r
+ //\r
ASSERT (Buffer != NULL);\r
ASSERT (Width < MAXIMUM_VALUE_CHARACTERS);\r
//\r
ASSERT (((Flags & COMMA_TYPE) != 0 && (Flags & RADIX_HEX) != 0) == FALSE);\r
\r
OriginalBuffer = Buffer;\r
-\r
+ \r
+ //\r
+ // Width is 0 or COMMA_TYPE is set, PREFIX_ZERO is ignored.\r
+ //\r
if (Width == 0 || (Flags & COMMA_TYPE) != 0) {\r
Flags &= (~PREFIX_ZERO);\r
}\r
-\r
+ //\r
+ // If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
+ //\r
if (Width == 0) {\r
Width = MAXIMUM_VALUE_CHARACTERS - 1;\r
}\r
// Set the tag for the end of the input Buffer.\r
//\r
EndBuffer = Buffer + Width * Increment;\r
-\r
+ \r
+ //\r
+ // Convert decimal negative\r
+ //\r
if ((Value < 0) && ((Flags & RADIX_HEX) == 0)) {\r
Value = -Value;\r
Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, 1, '-', Increment);\r
Width--;\r
}\r
-\r
+ \r
+ //\r
+ // Count the length of the value string.\r
+ //\r
Radix = ((Flags & RADIX_HEX) == 0)? 10 : 16;\r
Count = BasePrintLibValueToString (ValueBuffer, Value, Radix);\r
-\r
+ \r
+ //\r
+ // Append Zero\r
+ //\r
if ((Flags & PREFIX_ZERO) != 0) {\r
Buffer = BasePrintLibFillBuffer (Buffer, EndBuffer, Width - Count, '0', Increment);\r
}\r
-\r
+ \r
+ //\r
+ // Print Comma type for every 3 characters\r
+ //\r
Digits = Count % 3;\r
if (Digits != 0) {\r
Digits = 3 - Digits;\r
}\r
}\r
}\r
-\r
+ \r
+ //\r
+ // Print Null-terminator\r
+ //\r
BasePrintLibFillBuffer (Buffer, EndBuffer + Increment, 1, 0, Increment);\r
\r
return ((Buffer - OriginalBuffer) / Increment);\r
/** @file\r
- Print Library Internal Functions.\r
+ Base Print Library instance Internal Functions definition.\r
\r
- Copyright (c) 2006 - 2007, Intel Corporation\r
+ Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. 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
\r
**/\r
\r
-#ifndef __PRINT_LIB_INTERNAL_H\r
-#define __PRINT_LIB_INTERNAL_H\r
+#ifndef __PRINT_LIB_INTERNAL_H__\r
+#define __PRINT_LIB_INTERNAL_H__\r
\r
#include <Base.h>\r
#include <Library/PrintLib.h>\r
VA_LIST is used this rountine allows the nesting of Vararg routines. Thus \r
this is the main print working routine\r
\r
- @param Buffer Character buffer to print the results of the parsing\r
+ @param StartOfBuffer Character buffer to print the results of the parsing\r
of Format into.\r
@param BufferSize Maximum number of characters to put into buffer.\r
Zero means no limit.\r
@param Flags Intial flags value.\r
Can only have FORMAT_UNICODE and OUTPUT_UNICODE set\r
@param FormatString Null-terminated format string.\r
+ @param ... The variable argument list.\r
\r
@return Number of characters printed.\r
\r
**/\r
UINTN\r
BasePrintLibSPrint (\r
- OUT CHAR8 *Buffer,\r
+ OUT CHAR8 *StartOfBuffer,\r
IN UINTN BufferSize,\r
IN UINTN Flags,\r
IN CONST CHAR8 *FormatString,\r
@param Character Character to be placed into Buffer.\r
@param Increment Character increment in Buffer.\r
\r
- @return Number of characters printed.\r
+ @return Buffer Buffer filled with the input Character.\r
\r
**/\r
CHAR8 *\r
BasePrintLibFillBuffer (\r
- CHAR8 *Buffer,\r
- CHAR8 *EndBuffer,\r
- INTN Length,\r
- UINTN Character,\r
- INTN Increment\r
+ OUT CHAR8 *Buffer,\r
+ IN CHAR8 *EndBuffer,\r
+ IN INTN Length,\r
+ IN UINTN Character,\r
+ IN INTN Increment\r
);\r
\r
/**\r
\r
**/\r
UINTN\r
-EFIAPI\r
BasePrintLibValueToString (\r
IN OUT CHAR8 *Buffer, \r
IN INT64 Value, \r
/** @file\r
- UEFI Decompress Library.\r
+ UEFI Decompress Library implementation refer to UEFI specification.\r
\r
- Copyright (c) 2006, Intel Corporation\r
+ Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. 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
#include "BaseUefiDecompressLibInternals.h"\r
\r
/**\r
- Read NumOfBit of bits from source into mBitBuf\r
+ Read NumOfBit of bits from source into mBitBuf.\r
\r
Shift mBitBuf NumOfBits left. Read in NumOfBits of bits from source.\r
\r
}\r
\r
/**\r
- Get NumOfBits of bits out from mBitBuf\r
+ Get NumOfBits of bits out from mBitBuf.\r
\r
Get NumOfBits of bits out from mBitBuf. Fill mBitBuf with subsequent \r
NumOfBits of bits from source. Returns NumOfBits of bits that are \r
@param NumOfChar Number of symbols in the symbol set\r
@param BitLen Code length array\r
@param TableBits The width of the mapping table\r
- @param Table The table\r
+ @param Table The table to be created\r
\r
@retval 0 OK.\r
@retval BAD_TABLE The table is corrupted.\r
*Pointer = Avail++;\r
}\r
\r
- if (Index3 & Mask) {\r
+ if ((Index3 & Mask) != 0) {\r
Pointer = &Sd->mRight[*Pointer];\r
} else {\r
Pointer = &Sd->mLeft[*Pointer];\r
\r
do {\r
\r
- if (Sd->mBitBuf & Mask) {\r
+ if ((Sd->mBitBuf & Mask) != 0) {\r
Val = Sd->mRight[Val];\r
} else {\r
Val = Sd->mLeft[Val];\r
Mask = 1U << (BITBUFSIZ - 1 - 12);\r
\r
do {\r
- if (Sd->mBitBuf & Mask) {\r
+ if ((Sd->mBitBuf & Mask) != 0) {\r
Index2 = Sd->mRight[Index2];\r
} else {\r
Index2 = Sd->mLeft[Index2];\r
\r
/**\r
Decode the source data and put the resulting data into the destination buffer.\r
-\r
- Decode the source data and put the resulting data into the destination buffer.\r
- \r
+ \r
@param Sd The global scratch data\r
\r
**/\r
}\r
\r
/**\r
- Retrieves the size of the uncompressed buffer and the size of the scratch buffer.\r
+ Given a compressed source buffer, this function retrieves the size of \r
+ the uncompressed buffer and the size of the scratch buffer required \r
+ to decompress the compressed source buffer.\r
\r
Retrieves the size of the uncompressed buffer and the temporary scratch buffer \r
required to decompress the buffer specified by Source and SourceSize.\r
is required to decompress the compressed buffer specified \r
by Source and SourceSize.\r
\r
- @retval RETURN_SUCCESS The size of destination buffer and the size of scratch \r
- buffer are successull retrieved.\r
- @retval RETURN_INVALID_PARAMETER The source data is corrupted\r
-\r
+ @retval RETURN_SUCCESS The size of the uncompressed data was returned \r
+ in DestinationSize and the size of the scratch \r
+ buffer was returned in ScratchSize.\r
+ @retval RETURN_INVALID_PARAMETER \r
+ The size of the uncompressed data or the size of \r
+ the scratch buffer cannot be determined from \r
+ the compressed data specified by Source \r
+ and SourceSize.\r
**/\r
RETURN_STATUS\r
EFIAPI\r
/**\r
Decompresses a compressed source buffer.\r
\r
+ Extracts decompressed data to its original form.\r
This function is designed so that the decompression algorithm can be implemented\r
without using any memory services. As a result, this function is not allowed to\r
call any memory allocation services in its implementation. It is the caller's r\r
This is an optional parameter that may be NULL if the \r
required scratch buffer size is 0.\r
\r
- @retval RETURN_SUCCESS Decompression is successfull\r
- @retval RETURN_INVALID_PARAMETER The source data is corrupted\r
-\r
+ @retval RETURN_SUCCESS Decompression completed successfully, and \r
+ the uncompressed buffer is returned in Destination.\r
+ @retval RETURN_INVALID_PARAMETER \r
+ The source buffer specified by Source is corrupted \r
+ (not in a valid compressed format).\r
**/\r
RETURN_STATUS\r
EFIAPI\r
//\r
// The length of the field 'Position Set Code Length Array Size' in Block Header.\r
// For UEFI 2.0 de/compression algorithm(Version 1), mPBit = 4\r
- // For Tiano de/compression algorithm(Version 2), mPBit = 5\r
//\r
Sd->mPBit = 4;\r
Sd->mSrcBase = (UINT8 *)Src;\r
/** @file\r
- Internal include file for Base UEFI Decompress Libary.\r
+ Internal data structure defintions for Base UEFI Decompress Libary.\r
\r
- Copyright (c) 2006, Intel Corporation\r
+ Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. 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
#endif\r
\r
typedef struct {\r
- UINT8 *mSrcBase; ///< Starting address of compressed data\r
- UINT8 *mDstBase; ///< Starting address of decompressed data\r
+ UINT8 *mSrcBase; // Starting address of compressed data\r
+ UINT8 *mDstBase; // Starting address of decompressed data\r
UINT32 mOutBuf;\r
UINT32 mInBuf;\r
\r
///\r
/// The length of the field 'Position Set Code Length Array Size' in Block Header.\r
/// For UEFI 2.0 de/compression algorithm, mPBit = 4\r
- /// For Tiano de/compression algorithm, mPBit = 5\r
///\r
UINT8 mPBit;\r
} SCRATCH_DATA;\r
\r
/**\r
- Read NumOfBit of bits from source into mBitBuf\r
+ Read NumOfBit of bits from source into mBitBuf.\r
\r
Shift mBitBuf NumOfBits left. Read in NumOfBits of bits from source.\r
\r
);\r
\r
/**\r
- Get NumOfBits of bits out from mBitBuf\r
+ Get NumOfBits of bits out from mBitBuf.\r
\r
Get NumOfBits of bits out from mBitBuf. Fill mBitBuf with subsequent\r
NumOfBits of bits from source. Returns NumOfBits of bits that are\r
@param NumOfChar Number of symbols in the symbol set\r
@param BitLen Code length array\r
@param TableBits The width of the mapping table\r
- @param Table The table\r
+ @param Table The table to be created.\r
\r
@retval 0 OK.\r
@retval BAD_TABLE The table is corrupted.\r
/**\r
Decode the source data and put the resulting data into the destination buffer.\r
\r
- Decode the source data and put the resulting data into the destination buffer.\r
-\r
@param Sd The global scratch data\r
\r
**/\r
/** @file\r
- UEFI Debug Library that uses PrintLib to send messages to CONOUT.\r
+ Base Debug library instance base on Serial Port library.\r
+ It uses PrintLib to send debug messages to serial port device.\r
\r
- Copyright (c) 2006, Intel Corporation<BR>\r
+ Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
All rights reserved. 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
\r
@param ErrorLevel The error level of the debug message.\r
@param Format Format string for the debug message to print.\r
+ @param ... The variable argument list.\r
\r
**/\r
VOID\r
\r
If Length is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT(). \r
\r
- @param Buffer Pointer to the target buffer to fill with PcdDebugClearMemoryValue.\r
+ @param Buffer Pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r
@param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
\r
- @return Buffer\r
+ @return Buffer Pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
\r
**/\r
VOID *\r
\r
Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.\r
\r
- This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of \r
+ This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of \r
PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
\r
- @retval TRUE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
- @retval FALSE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
+ @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
+ @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
\r
**/\r
BOOLEAN\r
#/** @file\r
-# Debug Library for Dxe drivers\r
+# Base Debug library instance base on Serial Port library.\r
+# It uses PrintLib to send debug messages to serial port device.\r
#\r
-# Library to abstract Framework extensions that conflict with UEFI 2.0 Specification\r
-# Copyright (c) 2006 - 2007, Intel Corporation.\r
+# Copyright (c) 2006 - 2008, Intel Corporation.\r
#\r
# All rights reserved. This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
/** @file\r
- Provide generic extract guided section functions.\r
+ Provide generic extract guided section functions for Dxe phase.\r
\r
- Copyright (c) 2007, Intel Corporation<BR>\r
+ Copyright (c) 2007 - 2008, Intel Corporation<BR>\r
All rights reserved. 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
}\r
\r
/**
- Get the supported exract guided section Handler guid list.\r
- If ExtractHandlerGuidTable = NULL, then ASSERT.\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[in, out] ExtractHandlerGuidTable The extract Handler guid pointer list.
+ @param[out] ExtractHandlerGuidTable The extract Handler guid pointer list.
\r
- @retval return the number of the supported extract guided Handler.
+ @return the number of the supported extract guided Handler.
**/\r
UINTN\r
EFIAPI\r
ExtractGuidedSectionGetGuidList (\r
- IN OUT GUID **ExtractHandlerGuidTable\r
+ OUT GUID **ExtractHandlerGuidTable\r
)\r
{\r
ASSERT (ExtractHandlerGuidTable != NULL);\r
@param[out] SectionAttribute The attribute of the input guided section.\r
@retval RETURN_SUCCESS Get the required information successfully.\r
- @retval RETURN_INVALID_PARAMETER The input data can't be parsed correctly. \r
- The GUID in InputSection does not match any registered guid list.\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
\r
**/\r
RETURN_STATUS\r
// Not found, the input guided section is not supported. \r
//\r
if (Index == mNumberOfExtractHandler) {\r
- return RETURN_INVALID_PARAMETER;\r
+ return RETURN_UNSUPPORTED;\r
}\r
\r
//\r
A pointer to a caller-allocated UINT32 that indicates the\r
authentication status of the output buffer.
- @retval RETURN_SUCCESS Get the output data, size and AuthenticationStatus successfully.\r
- @retval RETURN_INVALID_PARAMETER The input data can't be parsed correctly. \r
- The GUID in InputSection does not match any registered guid.\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.
**/\r
RETURN_STATUS\r
{\r
UINT32 Index;\r
\r
+ //\r
+ // Check the input parameters\r
+ //\r
if (InputSection == NULL) {\r
return RETURN_INVALID_PARAMETER;\r
}\r
ASSERT (AuthenticationStatus != NULL);\r
\r
//\r
- // Search the match registered GetInfo handler for the input guided section.\r
+ // Search the match registered extract handler for the input guided section.\r
//\r
for (Index = 0; Index < mNumberOfExtractHandler; Index ++) {\r
if (CompareGuid (&mExtractHandlerGuidTable[Index], &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {\r
// Not found, the input guided section is not supported. \r
//\r
if (Index == mNumberOfExtractHandler) {\r
- return RETURN_INVALID_PARAMETER;\r
+ return RETURN_UNSUPPORTED;\r
}\r
\r
//\r
- // Call the match handler to getinfo for the input section data.\r
+ // Call the match handler to extract raw data for the input section data.\r
//\r
return mExtractDecodeHandlerTable [Index] (\r
InputSection,\r
# Component description file for DXE ExtractGuidedSection Library\r
#\r
# This library provides generic extract guided section functions for DXE module.\r
-# Copyright (c) 2007, Intel Corporation.\r
+# Copyright (c) 2007 - 2008, Intel Corporation.\r
#\r
# All rights reserved. This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
FILE_GUID = f773469b-e265-4b0c-b0a6-2f971fbfe72b\r
MODULE_TYPE = DXE_DRIVER\r
VERSION_STRING = 1.0\r
- LIBRARY_CLASS = ExtractGuidedSectionLib\r
+ LIBRARY_CLASS = ExtractGuidedSectionLib|DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SAL_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER \r
EDK_RELEASE_VERSION = 0x00020000\r
EFI_SPECIFICATION_VERSION = 0x00020000\r
\r
/** @file\r
- Report Status Code Library Post Code functions for DXE Phase.\r
+ Post code library instace bases on report status code library\r
+ PostCode Library for PEIMs and DXE drivers that send PostCode to ReportStatusCode\r
\r
- Copyright (c) 2006, Intel Corporation<BR>\r
+ Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
All rights reserved. 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
display the 32-bit value on the status reporting device.\r
\r
PostCode() must actively prevent recursion. If PostCode() is called while\r
- processing another any other Report Status Code Library function, then\r
+ processing another any other Post Code Library function, then\r
PostCode() must return Value immediately.\r
\r
@param Value The 32-bit value to write to the POST card.\r
\r
- @return Value\r
+ @return Value The 32-bit value to write to the POST card.\r
\r
**/\r
UINT32\r
value on the status reporting device.\r
\r
PostCodeWithDescription()must actively prevent recursion. If\r
- PostCodeWithDescription() is called while processing another any other Report\r
- Status Code Library function, then PostCodeWithDescription() must return Value\r
+ PostCodeWithDescription() is called while processing another any other Post\r
+ Code Library function, then PostCodeWithDescription() must return Value\r
immediately.\r
\r
@param Value The 32-bit value to write to the POST card.\r
POST code value. This is an optional parameter that may\r
be NULL.\r
\r
- @return Value\r
+ @return Value The 32-bit value to write to the POST card.\r
\r
**/\r
UINT32\r
/**\r
Returns TRUE if POST code descriptions are enabled.\r
\r
- This function returns TRUE if the\r
- POST_CODE_PROPERTY_POST_CODE_ENABLED bit of\r
- PcdPostCodePropertyMask is set. Otherwise FALSE is returned.\r
+ This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED\r
+ bit of PcdPostCodePropertyMask is set. Otherwise FALSE is returned.\r
\r
- @retval TRUE The POST_CODE_PROPERTY_POST_CODE_ENABLED\r
- bit of PcdPostCodeProperyMask is set.\r
- @retval FALSE The POST_CODE_PROPERTY_POST_CODE_ENABLED\r
- bit of PcdPostCodeProperyMask is clear.\r
+ @retval TRUE The POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of\r
+ PcdPostCodeProperyMask is set.\r
+ @retval FALSE The POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of\r
+ PcdPostCodeProperyMask is clear.\r
\r
**/\r
BOOLEAN\r
VOID\r
)\r
{\r
- return (BOOLEAN) ((PcdGet8(PcdPostCodePropertyMask) & POST_CODE_PROPERTY_POST_CODE_ENABLED) != 0);\r
+ return (BOOLEAN) ((PcdGet8(PcdPostCodePropertyMask) & POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED) != 0);\r
}\r
+\r
/** @file\r
- Provide generic extract guided section functions.\r
+ Provide generic extract guided section functions for PEI phase.\r
\r
- Copyright (c) 2007, Intel Corporation<BR>\r
+ Copyright (c) 2007 - 2008, Intel Corporation<BR>\r
All rights reserved. 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
//\r
return EFI_OUT_OF_RESOURCES;\r
}\r
+ //\r
+ // Init HandlerInfo structure\r
+ //\r
HandlerInfo->Signature = PEI_EXTRACT_HANDLER_INFO_SIGNATURE;\r
HandlerInfo->NumberOfExtractHandler = 0;\r
HandlerInfo->ExtractHandlerGuidTable = (GUID *) (HandlerInfo + 1);\r
PcdGet32 (PcdMaximumGuidedExtractHandler) * \r
sizeof (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER)\r
);\r
- \r
+ //\r
+ // return the created HandlerInfo.\r
+ //\r
*InfoPointer = HandlerInfo;\r
return EFI_SUCCESS;\r
}\r
Get the supported exract guided section Handler guid list.\r
If ExtractHandlerGuidTable = NULL, then ASSERT.\r
\r
- @param[in, out] ExtractHandlerGuidTable The extract Handler guid pointer list.
+ @param[out] ExtractHandlerGuidTable The extract Handler guid pointer list.
\r
- @retval return the number of the supported extract guided Handler.
+ @return the number of the supported extract guided Handler.
**/\r
UINTN\r
EFIAPI\r
ExtractGuidedSectionGetGuidList (\r
- IN OUT GUID **ExtractHandlerGuidTable\r
+ OUT GUID **ExtractHandlerGuidTable\r
)\r
{\r
EFI_STATUS Status;\r
\r
ASSERT (ExtractHandlerGuidTable != NULL);\r
\r
+ //\r
+ // Get all registered handler information\r
+ //\r
Status = PeiGetExtractGuidedSectionHandlerInfo (&HandlerInfo);\r
if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
\r
+ //\r
+ // Get GuidTable and Table Number\r
+ //\r
*ExtractHandlerGuidTable = HandlerInfo->ExtractHandlerGuidTable;\r
return HandlerInfo->NumberOfExtractHandler;\r
}\r
@param[out] SectionAttribute The attribute of the input guided section.\r
@retval RETURN_SUCCESS Get the required information successfully.\r
- @retval RETURN_INVALID_PARAMETER The input data can't be parsed correctly. \r
- The GUID in InputSection does not match any registered guid list.\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
\r
**/\r
RETURN_STATUS\r
ASSERT (SectionAttribute != NULL);\r
\r
//\r
- // Get the registered handler information.\r
+ // Get all registered handler information.\r
//\r
Status = PeiGetExtractGuidedSectionHandlerInfo (&HandlerInfo);\r
if (EFI_ERROR (Status)) {\r
// Not found, the input guided section is not supported. \r
//\r
if (Index == HandlerInfo->NumberOfExtractHandler) {\r
- return RETURN_INVALID_PARAMETER;\r
+ return RETURN_UNSUPPORTED;\r
}\r
\r
//\r
authentication status of the output buffer.
@retval RETURN_SUCCESS Get the output data, size and AuthenticationStatus successfully.\r
- @retval RETURN_INVALID_PARAMETER The input data can't be parsed correctly. \r
- The GUID in InputSection does not match any registered guid list.\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.
**/\r
RETURN_STATUS\r
EFI_STATUS Status;\r
PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO *HandlerInfo;\r
\r
+ //\r
+ // Check input parameter\r
+ //\r
if (InputSection == NULL) {\r
return RETURN_INVALID_PARAMETER;\r
- }\r
- \r
+ } \r
ASSERT (OutputBuffer != NULL);\r
ASSERT (AuthenticationStatus != NULL);\r
- \r
+\r
+ //\r
+ // Get all registered handler information.\r
+ // \r
Status = PeiGetExtractGuidedSectionHandlerInfo (&HandlerInfo);\r
if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
\r
//\r
- // Search the match registered GetInfo handler for the input guided section.\r
+ // Search the match registered Extract handler for the input guided section.\r
//\r
for (Index = 0; Index < HandlerInfo->NumberOfExtractHandler; Index ++) {\r
if (CompareGuid (HandlerInfo->ExtractHandlerGuidTable + Index, &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {\r
// Not found, the input guided section is not supported. \r
//\r
if (Index == HandlerInfo->NumberOfExtractHandler) {\r
- return RETURN_INVALID_PARAMETER;\r
+ return RETURN_UNSUPPORTED;\r
}\r
\r
//\r
- // Call the match handler to getinfo for the input section data.\r
+ // Call the match handler to extract raw data for the input guided section.\r
//\r
return HandlerInfo->ExtractDecodeHandlerTable [Index] (\r
InputSection,\r
# Component description file for PEIM ExtractGuidedSection Library\r
#\r
# This library provides generic extract guided section functions for PEIM and PEI_CORE module.\r
-# Copyright (c) 2007, Intel Corporation.\r
+# Copyright (c) 2007 - 2008, Intel Corporation.\r
#\r
# All rights reserved. This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
FILE_GUID = 41ddf016-2a11-415f-8880-00d938e9541a\r
MODULE_TYPE = PEIM\r
VERSION_STRING = 1.0\r
- LIBRARY_CLASS = ExtractGuidedSectionLib\r
+ LIBRARY_CLASS = ExtractGuidedSectionLib|PEIM PEI_CORE\r
EDK_RELEASE_VERSION = 0x00020000\r
EFI_SPECIFICATION_VERSION = 0x00020000\r
\r
/** @file\r
- Serial I/O Port library functions with no library constructor/destructor\r
+ Null Serial Port library instance with empty functions.\r
\r
- Copyright (c) 2006, Intel Corporation\r
+ Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. 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
\r
#include <Library/SerialPortLib.h>\r
\r
-/*\r
-\r
+/**\r
Programmed hardware of Serial port.\r
\r
- @return Always return EFI_UNSUPPORTED.\r
+ @return Always return RETURN_UNSUPPORTED.\r
\r
**/\r
RETURN_STATUS\r
@param Buffer Point of data buffer which need to be writed.\r
@param NumberOfBytes Number of output bytes which are cached in Buffer.\r
\r
- @retval 0 Write data failed.\r
- @retval !0 Actual number of bytes writed to serial device.\r
+ @retval 0 No data is to be written.\r
\r
**/\r
UINTN\r
/**\r
Read data from serial device and save the datas in buffer.\r
\r
- @param Buffer Point of data buffer which need to be writed.\r
- @param NumberOfBytes Number of output bytes which are cached in Buffer.\r
+ @param Buffer Point of data buffer, which contains the data \r
+ returned from the serial device.\r
+ @param NumberOfBytes Number of bytes which will be read.\r
\r
- @retval 0 Read data failed.\r
- @retval !0 Aactual number of bytes read from serial device.\r
+ @retval 0 No data is to be read.\r
\r
**/\r
UINTN\r
#/** @file\r
-# Memory Status Code Library for UEFI drivers\r
+# Null Serial Port library instance with empty functions\r
#\r
-# Lib to provide memory journal status code reporting Routines\r
-# Copyright (c) 2006, Intel Corporation.\r
+# Copyright (c) 2006 - 2008, Intel Corporation.\r
#\r
# All rights reserved. This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
INF_VERSION = 0x00010005\r
BASE_NAME = SerialPortLibNull\r
FILE_GUID = E4541241-8897-411a-91F8-7D7E45837146\r
- MODULE_TYPE = PEIM\r
+ MODULE_TYPE = BASE\r
VERSION_STRING = 1.0\r
LIBRARY_CLASS = SerialPortLib\r
EDK_RELEASE_VERSION = 0x00020000\r
/** @file\r
- UEFI Debug Library that uses PrintLib to send messages to CONOUT.\r
+ UEFI Debug Library that sends messages to the Console Output Device in the EFI System Table.\r
\r
- Copyright (c) 2006 - 2007, Intel Corporation<BR>\r
+ Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
All rights reserved. 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
\r
@param ErrorLevel The error level of the debug message.\r
@param Format Format string for the debug message to print.\r
+ @param ... The variable argument list.\r
\r
**/\r
VOID\r
\r
If Length is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT(). \r
\r
- @param Buffer Pointer to the target buffer to fill with PcdDebugClearMemoryValue.\r
+ @param Buffer Pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r
@param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
\r
- @return Buffer\r
+ @return Buffer Pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
\r
**/\r
VOID *\r
\r
Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.\r
\r
- This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of \r
+ This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of \r
PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
\r
- @retval TRUE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
- @retval FALSE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
+ @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
+ @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
\r
**/\r
BOOLEAN\r
#/** @file\r
-# Debug Library for UEFI drivers\r
#\r
-# Library to abstract Framework extensions that conflict with UEFI 2.0 Specification\r
-# Copyright (c) 2007, Intel Corporation.\r
+# Debug Lib that sends messages to the Console Output Device in the EFI System Table.\r
+# Copyright (c) 2007 - 2008, Intel Corporation.\r
#\r
# All rights reserved. This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
/** @file\r
- UEFI Debug Library that uses PrintLib to send messages to STDERR.\r
+ UEFI Debug Lib that sends messages to the Standard Error Device in the EFI System Table.\r
\r
- Copyright (c) 2006 - 2007, Intel Corporation<BR>\r
+ Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
All rights reserved. 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
\r
@param ErrorLevel The error level of the debug message.\r
@param Format Format string for the debug message to print.\r
+ @param ... The variable argument list.\r
\r
**/\r
VOID\r
@param Buffer Pointer to the target buffer to fill with PcdDebugClearMemoryValue.\r
@param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
\r
- @return Buffer\r
+ @return Buffer Pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
\r
**/\r
VOID *\r
\r
Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.\r
\r
- This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of \r
+ This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of \r
PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
\r
- @retval TRUE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
- @retval FALSE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
+ @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
+ @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
\r
**/\r
BOOLEAN\r
#/** @file\r
-# Debug Library for UEFI drivers\r
#\r
-# Library to abstract Framework extensions that conflict with UEFI 2.0 Specification\r
-# Copyright (c) 2007, Intel Corporation.\r
+# UEFI Debug Lib that sends messages to the Standard Error Device in the EFI System Table.\r
+#\r
+# Copyright (c) 2007 - 2008, Intel Corporation.\r
#\r
# All rights reserved. This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
projects / mirror_edk2.git / commitdiff