/** @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
+\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
+ used to monitor the DEBUG() and ASSERT() messages.\r
\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
- http://opensource.org/licenses/bsd-license.php. \r
+ Copyright (c) 2006 - 2018, 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
\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
+ 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
**/\r
\r
#include <Library/DebugPrintErrorLevelLib.h>\r
\r
//\r
-// Define the maximum debug and assert message length that this library supports \r
+// Define the maximum debug and assert message length that this library supports\r
//\r
#define MAX_DEBUG_MESSAGE_LENGTH 0x100\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 DebugPrintErrorLevelLib function \r
- GetDebugPrintErrorLevel (), then print the message specified by Format and the \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
@param ErrorLevel The error level of the debug message.\r
@param Format Format string for the debug message to print.\r
- @param ... Variable argument list whose contents are accessed \r
+ @param ... Variable argument list whose contents are accessed\r
based on the format string specified by Format.\r
\r
**/\r
VA_END (Marker);\r
\r
//\r
- // Send the print string to a Serial Port \r
+ // Send the print string to a Serial Port\r
//\r
SerialPortWrite ((UINT8 *)Buffer, AsciiStrLen (Buffer));\r
}\r
\r
\r
/**\r
- Prints an assert message containing a filename, line number, and description. \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
- 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
+ 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 recursion. If DebugAssert() is called while\r
processing another DebugAssert(), then DebugAssert() must return immediately.\r
/**\r
Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.\r
\r
- This function fills Length bytes of Buffer with the value specified by \r
+ This function fills Length bytes of Buffer with the value specified by\r
PcdDebugClearMemoryValue, and returns Buffer.\r
\r
If Buffer is NULL, then ASSERT().\r
- If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
+ If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\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
+ @param Length The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.\r
\r
@return Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
\r
/**\r
Returns TRUE if ASSERT() macros are enabled.\r
\r
- This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of \r
+ This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of\r
PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
\r
@retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.\r
}\r
\r
\r
-/** \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
+ This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of\r
PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
\r
@retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.\r
}\r
\r
\r
-/** \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
+ This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of\r
PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
\r
@retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.\r
}\r
\r
\r
-/** \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
+ 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_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
projects / mirror_edk2.git / blobdiff