MdePkg/Library/UefiDebugLibStdErr/DebugLib.c File Reference


Defines

#define MAX_DEBUG_MESSAGE_LENGTH   0x100

Functions

VOID EFIAPI DebugPrint (IN UINTN ErrorLevel, IN CONST CHAR8 *Format,...)
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)

Detailed Description

UEFI Debug Lib that sends messages to the Standard Error Device in the EFI System Table.

Copyright (c) 2006 - 2015, 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 http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Define Documentation

#define MAX_DEBUG_MESSAGE_LENGTH   0x100


Function Documentation

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 PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask 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.

Parameters:
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.

References CpuBreakpoint(), CpuDeadLoop(), DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED, DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED, gST, MAX_DEBUG_MESSAGE_LENGTH, NULL, _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL::OutputString, PcdGet8, EFI_SYSTEM_TABLE::StdErr, and UnicodeSPrintAsciiFormat().

BOOLEAN EFIAPI DebugAssertEnabled ( VOID   ) 

Returns TRUE if ASSERT() macros are enabled.

This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set. Otherwise FALSE is returned.

Return values:
TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.

References DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED, and PcdGet8.

VOID* EFIAPI DebugClearMemory ( OUT VOID *  Buffer,
IN UINTN  Length 
)

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().

Parameters:
Buffer The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.
Length The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
Returns:
Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue.

References ASSERT, NULL, PcdGet8, and SetMem().

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 PcdDebugProperyMask is set. Otherwise FALSE is returned.

Return values:
TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.

References DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED, and PcdGet8.

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 PcdDebugProperyMask is set. Otherwise FALSE is returned.

Return values:
TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.

References DEBUG_PROPERTY_DEBUG_CODE_ENABLED, and PcdGet8.

VOID EFIAPI DebugPrint ( IN UINTN  ErrorLevel,
IN CONST CHAR8 Format,
  ... 
)

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().

Parameters:
ErrorLevel The error level of the debug message.
Format The format string for the debug message to print.
... The variable argument list whose contents are accessed based on the format string specified by Format.

References ASSERT, GetDebugPrintErrorLevel(), gST, MAX_DEBUG_MESSAGE_LENGTH, NULL, _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL::OutputString, EFI_SYSTEM_TABLE::StdErr, UnicodeVSPrintAsciiFormat(), VA_END, and VA_START.

BOOLEAN EFIAPI DebugPrintEnabled ( VOID   ) 

Returns TRUE if DEBUG() macros are enabled.

This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set. Otherwise FALSE is returned.

Return values:
TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.

References DEBUG_PROPERTY_DEBUG_PRINT_ENABLED, and PcdGet8.

BOOLEAN EFIAPI DebugPrintLevelEnabled ( IN CONST UINTN  ErrorLevel  ) 

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.

Return values:
TRUE Current ErrorLevel is supported.
FALSE Current ErrorLevel is not supported.

References PcdGet32.


Generated on Thu Sep 24 23:14:21 2015 for MdePkg[ALL] by  doxygen 1.5.7.1