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

Macros
#define	OC_LOG_BUFFER_SIZE (2 * EFI_PAGE_SIZE)

Functions
STATIC OC_LOG_PROTOCOL *	InternalGetOcLog (VOID)

STATIC VOID EFIAPI	LogProtocolArrivedNotify (IN EFI_EVENT Event, IN VOID *Context)

STATIC VOID	OcBufferEarlyLog (IN UINTN ErrorLevel, IN CONST CHAR16 *Buffer)

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)

VOID EFIAPI	OcPrintScreen (IN CONST CHAR16 *Format,...)

Variables
STATIC UINT8 *	mLogBuffer = NULL

STATIC UINT8 *	mLogWalker = NULL

STATIC UINTN	mLogCount = 0

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 OcDebugLibProtocol.c.

Macro Definition Documentation

◆ OC_LOG_BUFFER_SIZE

#define OC_LOG_BUFFER_SIZE (2 * EFI_PAGE_SIZE)

Definition at line 29 of file OcDebugLibProtocol.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 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 268 of file OcDebugLibProtocol.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 340 of file OcDebugLibProtocol.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 312 of file OcDebugLibProtocol.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 397 of file OcDebugLibProtocol.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 378 of file OcDebugLibProtocol.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 206 of file OcDebugLibProtocol.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 359 of file OcDebugLibProtocol.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 415 of file OcDebugLibProtocol.c.

◆ InternalGetOcLog()

STATIC OC_LOG_PROTOCOL * InternalGetOcLog ( VOID )

Definition at line 37 of file OcDebugLibProtocol.c.

◆ LogProtocolArrivedNotify()

STATIC VOID EFIAPI LogProtocolArrivedNotify	(	IN EFI_EVENT	Event,
		IN VOID *	Context )

Definition at line 63 of file OcDebugLibProtocol.c.

◆ OcBufferEarlyLog()

STATIC VOID OcBufferEarlyLog	(	IN UINTN	ErrorLevel,
		IN CONST CHAR16 *	Buffer )

Definition at line 125 of file OcDebugLibProtocol.c.

◆ OcPrintScreen()

VOID EFIAPI OcPrintScreen	(	IN CONST CHAR16 *	Format,
			... )

Prints via gST->ConOut without any pool allocations. Otherwise equivalent to Print. Note: EFIAPI must be present for VA_ARGS forwarding (causes bugs with gcc).

Parameters

[in] Format Formatted string.

Definition at line 431 of file OcDebugLibProtocol.c.

Variable Documentation

◆ mLogBuffer

STATIC UINT8* mLogBuffer = NULL

Definition at line 31 of file OcDebugLibProtocol.c.

◆ mLogCount

STATIC UINTN mLogCount = 0

Definition at line 33 of file OcDebugLibProtocol.c.

◆ mLogWalker

STATIC UINT8* mLogWalker = NULL

Definition at line 32 of file OcDebugLibProtocol.c.

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ OC_LOG_BUFFER_SIZE

Function Documentation

◆ DebugAssert()

◆ DebugAssertEnabled()

◆ DebugClearMemory()

◆ DebugClearMemoryEnabled()

◆ DebugCodeEnabled()

◆ DebugPrint()

◆ DebugPrintEnabled()

◆ DebugPrintLevelEnabled()

◆ InternalGetOcLog()

◆ LogProtocolArrivedNotify()

◆ OcBufferEarlyLog()

◆ OcPrintScreen()

Variable Documentation

◆ mLogBuffer

◆ mLogCount

◆ mLogWalker