#include <Uefi.h>
#include <Library/DebugLib.h>
#include <Library/PrintLib.h>
#include <Library/PcdLib.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugPrintErrorLevelLib.h>
#include <Protocol/DebugPort.h>

Macros
#define	MAX_DEBUG_MESSAGE_LENGTH 0x100

#define	WRITE_TIMEOUT 1000

Functions
VOID	UefiDebugLibDebugPortProtocolWrite (IN CONST CHAR8 *Buffer, IN UINTN BufferLength)

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 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
EFI_DEBUGPORT_PROTOCOL *	mDebugPort = NULL

VA_LIST	mVaListNull

BOOLEAN	mPostEBS

EFI_BOOT_SERVICES *	mDebugBS

Detailed Description

UEFI Debug Library that sends messages to EFI_DEBUGPORT_PROTOCOL.Write.

Copyright (c) 2015 - 2019, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file DebugLib.c.

Macro Definition Documentation

◆ MAX_DEBUG_MESSAGE_LENGTH

#define MAX_DEBUG_MESSAGE_LENGTH 0x100

Definition at line 23 of file DebugLib.c.

◆ WRITE_TIMEOUT

#define WRITE_TIMEOUT 1000

Definition at line 28 of file DebugLib.c.

Function Documentation

◆ DebugAssert()

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.

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.

Definition at line 255 of file DebugLib.c.

◆ DebugAssertEnabled()

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.

Return values

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 338 of file DebugLib.c.

◆ DebugBPrint()

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

Parameters

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 221 of file DebugLib.c.

◆ DebugClearMemory()

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.

Definition at line 310 of file DebugLib.c.

◆ DebugClearMemoryEnabled()

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.

Return values

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 395 of file DebugLib.c.

◆ DebugCodeEnabled()

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.

Return values

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 376 of file DebugLib.c.

◆ DebugPrint()

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	Format string for the debug message to print.
...	A variable argument list whose contents are accessed based on the format string specified by Format.

Definition at line 107 of file DebugLib.c.

◆ DebugPrintEnabled()

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.

Return values

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 357 of file DebugLib.c.

◆ DebugPrintLevelEnabled()

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.

Definition at line 413 of file DebugLib.c.

◆ DebugPrintMarker()

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

Parameters

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 138 of file DebugLib.c.

◆ DebugVPrint()

VOID EFIAPI DebugVPrint	(	IN UINTN	ErrorLevel,
		IN CONST CHAR8 *	Format,
		IN VA_LIST	VaListMarker
	)

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	Format string for the debug message to print.
VaListMarker	VA_LIST marker for the variable argument list.

Definition at line 193 of file DebugLib.c.

◆ UefiDebugLibDebugPortProtocolWrite()

VOID UefiDebugLibDebugPortProtocolWrite	(	IN CONST CHAR8 *	Buffer,
		IN UINTN	BufferLength
	)

Send message to DebugPort Protocol.

If mDebugPort is NULL, i.e. EFI_DEBUGPORT_PROTOCOL is not located, EFI_DEBUGPORT_PROTOCOL is located first. Then, Buffer is sent via EFI_DEBUGPORT_PROTOCOL.Write.

Parameters

Buffer	The message to be sent.
BufferLength	The byte length of Buffer.

Definition at line 52 of file DebugLib.c.

Variable Documentation

◆ mDebugBS

EFI_BOOT_SERVICES* mDebugBS

extern

Definition at line 27 of file DebugLibConstructor.c.

◆ mDebugPort

EFI_DEBUGPORT_PROTOCOL* mDebugPort = NULL

Definition at line 30 of file DebugLib.c.

◆ mPostEBS

BOOLEAN mPostEBS

extern

Definition at line 18 of file DebugLibConstructor.c.

◆ mVaListNull

VA_LIST mVaListNull

Definition at line 36 of file DebugLib.c.

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ MAX_DEBUG_MESSAGE_LENGTH

◆ WRITE_TIMEOUT

Function Documentation

◆ DebugAssert()

◆ DebugAssertEnabled()

◆ DebugBPrint()

◆ DebugClearMemory()

◆ DebugClearMemoryEnabled()

◆ DebugCodeEnabled()

◆ DebugPrint()

◆ DebugPrintEnabled()

◆ DebugPrintLevelEnabled()

◆ DebugPrintMarker()

◆ DebugVPrint()

◆ UefiDebugLibDebugPortProtocolWrite()

Variable Documentation

◆ mDebugBS

◆ mDebugPort

◆ mPostEBS

◆ mVaListNull