/** @file\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 - 2008, Intel Corporation<BR>\r
- All rights reserved. This program and the accompanying materials \r
+ \r
+ NOTE: If the Serial Port library enables hardware flow control, then a call \r
+ to DebugPrint() or DebugAssert() may hang if writes to the serial port are \r
+ being blocked. This may occur if a key(s) are pressed in a terminal emulator\r
+ used to monitor the DEBUG() and ASSERT() messages. \r
+\r
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+ 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
- http://opensource.org/licenses/bsd-license.php \r
+ http://opensource.org/licenses/bsd-license.php. \r
\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
#include <Library/BaseMemoryLib.h>\r
#include <Library/SerialPortLib.h>\r
\r
-\r
//\r
// Define the maximum debug and assert message length that this library supports \r
//\r
#define MAX_DEBUG_MESSAGE_LENGTH 0x100\r
\r
+/**\r
+ The constructor function initialize the Serial Port Library\r
+\r
+ @retval EFI_SUCCESS The constructor always returns RETURN_SUCCESS.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+BaseDebugLibSerialPortConstructor (\r
+ VOID\r
+ )\r
+{\r
+ return SerialPortInitialize ();\r
+}\r
\r
/**\r
Prints a debug message to the debug output device if the specified error level is enabled.\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
+ @param ... Variable argument list whose contents are accessed \r
+ based on the format string specified by Format.\r
\r
**/\r
VOID\r
//\r
// Check driver debug mask value and global mask\r
//\r
- if ((ErrorLevel & PcdGet32(PcdDebugPrintErrorLevel)) == 0) {\r
+ if ((ErrorLevel & PcdGet32 (PcdDebugPrintErrorLevel)) == 0) {\r
return;\r
}\r
\r
//\r
// Send the print string to a Serial Port \r
//\r
- SerialPortWrite ((UINT8 *) Buffer, AsciiStrLen(Buffer));\r
+ SerialPortWrite ((UINT8 *)Buffer, AsciiStrLen (Buffer));\r
}\r
\r
\r
Prints an assert message containing a filename, line number, and description. \r
This may be followed by a breakpoint or a dead loop.\r
\r
- Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n" \r
+ Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"\r
to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of \r
PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if \r
DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then \r
CpuDeadLoop() is called. If neither of these bits are set, then this function \r
returns immediately after the message is printed to the debug output device.\r
- DebugAssert() must actively prevent recusrsion. If DebugAssert() is called while\r
+ DebugAssert() must actively prevent recursion. If DebugAssert() is called while\r
processing another DebugAssert(), then DebugAssert() must return immediately.\r
\r
If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.\r
-\r
If Description is NULL, then a <Description> string of "(NULL) Description" is printed.\r
\r
- @param FileName Pointer to the name of the source file that generated the assert condition.\r
+ @param FileName The pointer to the name of the source file that generated the assert condition.\r
@param LineNumber The line number in the source file that generated the assert condition\r
- @param Description Pointer to the description of the assert condition.\r
+ @param Description The pointer to the description of the assert condition.\r
\r
**/\r
VOID\r
CHAR8 Buffer[MAX_DEBUG_MESSAGE_LENGTH];\r
\r
//\r
- // Generate the ASSERT() message in Unicode format\r
+ // Generate the ASSERT() message in Ascii format\r
//\r
AsciiSPrint (Buffer, sizeof (Buffer), "ASSERT %a(%d): %a\n", FileName, LineNumber, Description);\r
\r
//\r
// Send the print string to the Console Output device\r
//\r
- SerialPortWrite ((UINT8 *) Buffer, AsciiStrLen(Buffer));\r
+ SerialPortWrite ((UINT8 *)Buffer, AsciiStrLen (Buffer));\r
\r
//\r
// Generate a Breakpoint, DeadLoop, or NOP based on PCD settings\r
PcdDebugClearMemoryValue, and returns Buffer.\r
\r
If Buffer is NULL, then ASSERT().\r
-\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
\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
+ @param Buffer The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r
+ @param Length The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
\r
- @return Buffer filled with PcdDebugClearMemoryValue.\r
+ @return Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
\r
**/\r
VOID *\r
}\r
\r
\r
-/**\r
- Returns TRUE if the DEBUG() macro is enabled.\r
+/** \r
+ Returns TRUE if DEBUG() macros are enabled.\r
\r
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of \r
PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
}\r
\r
\r
-/**\r
- Returns TRUE if the DEBUG_CODE() macros are enabled.\r
+/** \r
+ Returns TRUE if DEBUG_CODE() macros are enabled.\r
\r
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of \r
PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
}\r
\r
\r
-/**\r
- Returns TRUE if the DEBUG_CLEAR_MEMORY() macro is enabled.\r
+/** \r
+ Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.\r
\r
This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of \r
PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
projects / mirror_edk2.git / blobdiff