/** @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
+ 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 - 2008, Intel Corporation. All rights reserved.<BR>\r
+ Copyright (c) 2006 - 2011, 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
#include <Library/PcdLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/SerialPortLib.h>\r
+#include <Library/DebugPrintErrorLevelLib.h>\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
- If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print \r
- the message specified by Format and the associated variable argument list to \r
- the debug output device.\r
+ If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function \r
+ GetDebugPrintErrorLevel (), then print the message specified by Format and the \r
+ associated variable argument list to the debug output device.\r
\r
If Format is NULL, then ASSERT().\r
\r
//\r
// Check driver debug mask value and global mask\r
//\r
- if ((ErrorLevel & PcdGet32(PcdDebugPrintErrorLevel)) == 0) {\r
+ if ((ErrorLevel & GetDebugPrintErrorLevel ()) == 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
If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.\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
//\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
If Buffer is NULL, then ASSERT().\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 Pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
+ @return Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
\r
**/\r
VOID *\r
{\r
return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);\r
}\r
+\r
+/**\r
+ Returns TRUE if any one of the bit is set both in ErrorLevel and PcdFixedDebugPrintErrorLevel.\r
+\r
+ This function compares the bit mask of ErrorLevel and PcdFixedDebugPrintErrorLevel.\r
+\r
+ @retval TRUE Current ErrorLevel is supported.\r
+ @retval FALSE Current ErrorLevel is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+DebugPrintLevelEnabled (\r
+ IN CONST UINTN ErrorLevel\r
+ )\r
+{\r
+ return (BOOLEAN) ((ErrorLevel & PcdGet32(PcdFixedDebugPrintErrorLevel)) != 0);\r
+}\r
+\r