#include <Uefi.h>
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>
#include <Library/DevicePathLib.h>
#include <Library/OcLogAggregatorLib.h>
#include <Library/PrintLib.h>
#include <Library/PcdLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/SerialPortLib.h>
#include <Library/DebugPrintErrorLevelLib.h>

Macros
#define	MAX_DEBUG_MESSAGE_LENGTH 0x100

Functions
RETURN_STATUS EFIAPI	BaseDebugLibSerialPortConstructor (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 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)

VOID	DebugBreak (VOID)

VOID	WaitForKeyPress (CONST CHAR16 *Message)

VOID	DebugPrintDevicePath (IN UINTN ErrorLevel, IN CONST CHAR8 Message, IN EFI_DEVICE_PATH_PROTOCOL DevicePath OPTIONAL)

VOID	DebugPrintDevicePathForHandle (IN UINTN ErrorLevel, IN CONST CHAR8 *Message, IN EFI_HANDLE Handle OPTIONAL)

VOID	DebugPrintHexDump (IN UINTN ErrorLevel, IN CONST CHAR8 Message, IN UINT8 Bytes, IN UINTN Size)

Variables
VA_LIST	mVaListNull

Detailed Description

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.

Definition in file OcDebugLibSerial.c.

Macro Definition Documentation

◆ MAX_DEBUG_MESSAGE_LENGTH

#define MAX_DEBUG_MESSAGE_LENGTH 0x100

Definition at line 31 of file OcDebugLibSerial.c.

Function Documentation

◆ BaseDebugLibSerialPortConstructor()

RETURN_STATUS EFIAPI BaseDebugLibSerialPortConstructor ( VOID )

The constructor function initialize the Serial Port Library

Return values

EFI_SUCCESS The constructor always returns RETURN_SUCCESS.

Definition at line 47 of file OcDebugLibSerial.c.

◆ 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 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.

Definition at line 216 of file OcDebugLibSerial.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 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.

Definition at line 288 of file OcDebugLibSerial.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 182 of file OcDebugLibSerial.c.

◆ DebugBreak()

VOID DebugBreak ( VOID )

Pointer debug kit. Dummy function that debuggers may break on.

Definition at line 374 of file OcDebugLibSerial.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 260 of file OcDebugLibSerial.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 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.

Definition at line 345 of file OcDebugLibSerial.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 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.

Definition at line 326 of file OcDebugLibSerial.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 70 of file OcDebugLibSerial.c.

◆ DebugPrintDevicePath()

VOID DebugPrintDevicePath	(	IN UINTN	ErrorLevel,
		IN CONST CHAR8 *	Message,
		IN EFI_DEVICE_PATH_PROTOCOL *DevicePath	OPTIONAL )

Print Device Path to log.

Parameters

[in]	ErrorLevel	Debug error level.
[in]	Message	Prefixed message.
[in]	DevicePath	Device path to print.

Definition at line 390 of file OcDebugLibSerial.c.

◆ DebugPrintDevicePathForHandle()

VOID DebugPrintDevicePathForHandle	(	IN UINTN	ErrorLevel,
		IN CONST CHAR8 *	Message,
		IN EFI_HANDLE Handle	OPTIONAL )

Print Device Path corresponding to EFI Handle to log.

Parameters

[in]	ErrorLevel	Debug error level.
[in]	Message	Prefixed message.
[in]	Handle	Handle corresponding to Device path to print.

Definition at line 399 of file OcDebugLibSerial.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 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.

Definition at line 307 of file OcDebugLibSerial.c.

◆ DebugPrintHexDump()

VOID DebugPrintHexDump	(	IN UINTN	ErrorLevel,
		IN CONST CHAR8 *	Message,
		IN UINT8 *	Bytes,
		IN UINTN	Size )

Print hex dump to log.

Parameters

[in]	ErrorLevel	Debug error level.
[in]	Message	Prefixed message.
[in]	Bytes	Byte sequence.
[in]	Size	Byte sequence size.

Definition at line 408 of file OcDebugLibSerial.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 363 of file OcDebugLibSerial.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 101 of file OcDebugLibSerial.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 154 of file OcDebugLibSerial.c.

◆ WaitForKeyPress()

VOID WaitForKeyPress ( CONST CHAR16 * Message )

Definition at line 383 of file OcDebugLibSerial.c.

Variable Documentation

◆ mVaListNull

VA_LIST mVaListNull

Definition at line 37 of file OcDebugLibSerial.c.

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ MAX_DEBUG_MESSAGE_LENGTH

Function Documentation

◆ BaseDebugLibSerialPortConstructor()

◆ DebugAssert()

◆ DebugAssertEnabled()

◆ DebugBPrint()

◆ DebugBreak()

◆ DebugClearMemory()

◆ DebugClearMemoryEnabled()

◆ DebugCodeEnabled()

◆ DebugPrint()

◆ DebugPrintDevicePath()

◆ DebugPrintDevicePathForHandle()

◆ DebugPrintEnabled()

◆ DebugPrintHexDump()

◆ DebugPrintLevelEnabled()

◆ DebugPrintMarker()

◆ DebugVPrint()

◆ WaitForKeyPress()

Variable Documentation

◆ mVaListNull