TianoCore EDK2 master
|
#include <Base.h>
#include <Library/DebugLib.h>
#include <Library/BaseLib.h>
#include <Library/PrintLib.h>
#include <Library/PcdLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/SerialPortLib.h>
#include <Library/DebugDeviceLib.h>
#include <Library/DebugPrintErrorLevelLib.h>
Go to the source code of this file.
Macros | |
#define | MAX_DEBUG_MESSAGE_LENGTH 0x100 |
Functions | |
UINTN *EFIAPI | GetStackFramePointer (VOID) |
VOID EFIAPI | DebugPrint (IN UINTN ErrorLevel, IN CONST CHAR8 *Format,...) |
VOID | DebugPrintMarker (IN UINTN ErrorLevel, IN CONST CHAR8 *Format, IN VA_LIST VaListMarker, IN BASE_LIST BaseListMarker) |
VOID EFIAPI | DebugVPrint (IN UINTN ErrorLevel, IN CONST CHAR8 *Format, IN VA_LIST VaListMarker) |
VOID EFIAPI | DebugBPrint (IN UINTN ErrorLevel, IN CONST CHAR8 *Format, IN BASE_LIST BaseListMarker) |
VOID | FillHex (UINTN Value, CHAR8 *Buffer) |
VOID | DebugAssertInternal (VOID) |
VOID EFIAPI | DebugAssert (IN CONST CHAR8 *FileName, IN UINTN LineNumber, IN CONST CHAR8 *Description) |
VOID *EFIAPI | DebugClearMemory (OUT VOID *Buffer, IN UINTN Length) |
BOOLEAN EFIAPI | DebugAssertEnabled (VOID) |
BOOLEAN EFIAPI | DebugPrintEnabled (VOID) |
BOOLEAN EFIAPI | DebugCodeEnabled (VOID) |
BOOLEAN EFIAPI | DebugClearMemoryEnabled (VOID) |
BOOLEAN EFIAPI | DebugPrintLevelEnabled (IN CONST UINTN ErrorLevel) |
Variables | |
CONST CHAR8 * | mHexTable = "0123456789ABCDEF" |
VA_LIST | mVaListNull |
Copyright (c) 2014 - 2019, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
Definition in file DebugLib.c.
#define MAX_DEBUG_MESSAGE_LENGTH 0x100 |
Definition at line 21 of file DebugLib.c.
VOID EFIAPI DebugAssert | ( | IN CONST CHAR8 * | FileName, |
IN UINTN | LineNumber, | ||
IN CONST CHAR8 * | Description | ||
) |
Prints an assert message containing a filename, line number, and description. This may be followed by a breakpoint or a dead loop.
Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n" to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of PcdDebugPropertyMask is set then CpuBreakpoint() is called. Otherwise, if DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugPropertyMask is set then CpuDeadLoop() is called. If neither of these bits are set, then this function returns immediately after the message is printed to the debug output device. DebugAssert() must actively prevent recursion. If DebugAssert() is called while processing another DebugAssert(), then DebugAssert() must return immediately.
If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed. If Description is NULL, then a string of "(NULL) Description" is printed.
FileName | The pointer to the name of the source file that generated the assert condition. |
LineNumber | The line number in the source file that generated the assert condition |
Description | The pointer to the description of the assert condition. |
Definition at line 295 of file DebugLib.c.
BOOLEAN EFIAPI DebugAssertEnabled | ( | VOID | ) |
Returns TRUE if ASSERT() macros are enabled.
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugPropertyMask is set. Otherwise FALSE is returned.
TRUE | The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugPropertyMask is set. |
FALSE | The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugPropertyMask is clear. |
Definition at line 341 of file DebugLib.c.
VOID DebugAssertInternal | ( | VOID | ) |
Prints an assert message containing a filename, line number, and description. This may be followed by a breakpoint or a dead loop.
Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n" to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of PcdDebugPropertyMask is set then CpuBreakpoint() is called. Otherwise, if DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugPropertyMask is set then CpuDeadLoop() is called. If neither of these bits are set, then this function returns immediately after the message is printed to the debug output device. DebugAssert() must actively prevent recursion. If DebugAssert() is called while processing another DebugAssert(), then DebugAssert() must return immediately.
If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed. If Description is NULL, then a string of "(NULL) Description" is printed.
Definition at line 226 of file DebugLib.c.
VOID EFIAPI DebugBPrint | ( | IN UINTN | ErrorLevel, |
IN CONST CHAR8 * | Format, | ||
IN BASE_LIST | BaseListMarker | ||
) |
Prints a debug message to the debug output device if the specified error level is enabled. This function use BASE_LIST which would provide a more compatible service than VA_LIST.
If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function GetDebugPrintErrorLevel (), then print the message specified by Format and the associated variable argument list to the debug output device.
If Format is NULL, then ASSERT().
ErrorLevel | The error level of the debug message. |
Format | Format string for the debug message to print. |
BaseListMarker | BASE_LIST marker for the variable argument list. |
Definition at line 178 of file DebugLib.c.
Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
This function fills Length bytes of Buffer with the value specified by PcdDebugClearMemoryValue, and returns Buffer.
If Buffer is NULL, then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
Buffer | The pointer to the target buffer to be filled with PcdDebugClearMemoryValue. |
Length | The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. |
Definition at line 321 of file DebugLib.c.
BOOLEAN EFIAPI DebugClearMemoryEnabled | ( | VOID | ) |
Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.
This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugPropertyMask is set. Otherwise FALSE is returned.
TRUE | The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugPropertyMask is set. |
FALSE | The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugPropertyMask is clear. |
Definition at line 398 of file DebugLib.c.
BOOLEAN EFIAPI DebugCodeEnabled | ( | VOID | ) |
Returns TRUE if DEBUG_CODE() macros are enabled.
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugPropertyMask is set. Otherwise FALSE is returned.
TRUE | The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugPropertyMask is set. |
FALSE | The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugPropertyMask is clear. |
Definition at line 379 of file DebugLib.c.
Prints a debug message to the debug output device if the specified error level is enabled.
If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function GetDebugPrintErrorLevel (), then print the message specified by Format and the associated variable argument list to the debug output device.
If Format is NULL, then ASSERT().
ErrorLevel | The error level of the debug message. |
Format | Format string for the debug message to print. |
... | Variable argument list whose contents are accessed based on the format string specified by Format. |
Definition at line 59 of file DebugLib.c.
BOOLEAN EFIAPI DebugPrintEnabled | ( | VOID | ) |
Returns TRUE if DEBUG() macros are enabled.
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugPropertyMask is set. Otherwise FALSE is returned.
TRUE | The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugPropertyMask is set. |
FALSE | The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugPropertyMask is clear. |
Definition at line 360 of file DebugLib.c.
Returns TRUE if any one of the bit is set both in ErrorLevel and PcdFixedDebugPrintErrorLevel.
This function compares the bit mask of ErrorLevel and PcdFixedDebugPrintErrorLevel.
TRUE | Current ErrorLevel is supported. |
FALSE | Current ErrorLevel is not supported. |
Definition at line 416 of file DebugLib.c.
VOID DebugPrintMarker | ( | IN UINTN | ErrorLevel, |
IN CONST CHAR8 * | Format, | ||
IN VA_LIST | VaListMarker, | ||
IN BASE_LIST | BaseListMarker | ||
) |
Prints a debug message to the debug output device if the specified error level is enabled base on Null-terminated format string and a VA_LIST argument list or a BASE_LIST argument list.
If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function GetDebugPrintErrorLevel (), then print the message specified by Format and the associated variable argument list to the debug output device.
If Format is NULL, then ASSERT().
ErrorLevel | The error level of the debug message. |
Format | Format string for the debug message to print. |
VaListMarker | VA_LIST marker for the variable argument list. |
BaseListMarker | BASE_LIST marker for the variable argument list. |
Definition at line 90 of file DebugLib.c.
Prints a debug message to the debug output device if the specified error level is enabled.
If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function GetDebugPrintErrorLevel (), then print the message specified by Format and the associated variable argument list to the debug output device.
If Format is NULL, then ASSERT().
ErrorLevel | The error level of the debug message. |
Format | Format string for the debug message to print. |
VaListMarker | VA_LIST marker for the variable argument list. |
Definition at line 150 of file DebugLib.c.
VOID FillHex | ( | UINTN | Value, |
CHAR8 * | Buffer | ||
) |
Convert an UINT32 value into HEX string specified by Buffer.
Value | The HEX value to convert to string |
Buffer | The pointer to the target buffer to be filled with HEX string |
Definition at line 195 of file DebugLib.c.
UINTN *EFIAPI GetStackFramePointer | ( | VOID | ) |
Get stack frame pointer of function call.
CONST CHAR8* mHexTable = "0123456789ABCDEF" |
Definition at line 23 of file DebugLib.c.
VA_LIST mVaListNull |
Definition at line 29 of file DebugLib.c.