OcLogAggregatorLibNull.c File Reference

#include <Uefi.h>
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>
#include <Library/DevicePathLib.h>
#include <Library/OcDebugLogLib.h>

Go to the source code of this file.

Functions
VOID EFIAPI	OcPrintScreen (IN CONST CHAR16 *Format,...)
APPLE_DEBUG_LOG_PROTOCOL *	OcAppleDebugLogInstallProtocol (IN BOOLEAN Reinstall)
VOID	OcAppleDebugLogConfigure (IN BOOLEAN Enable)
VOID	OcAppleDebugLogPerfAllocated (IN OUT VOID *PerfBuffer, IN UINTN PerfBufferSize)
EFI_STATUS	OcConfigureLogProtocol (IN OC_LOG_OPTIONS Options, IN CONST CHAR8 *LogModules, IN UINT32 DisplayDelay, IN UINTN DisplayLevel, IN UINTN HaltLevel, IN CONST CHAR16 *LogPrefixPath OPTIONAL, IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *LogFileSystem OPTIONAL)

Detailed Description

Null OcLogAggregatorLib instance.

Copyright (c) 2023, Mike Beaton. All rights reserved.
SPDX-License-Identifier: BSD-3-Clause

Definition in file OcLogAggregatorLibNull.c.

Function Documentation

OcAppleDebugLogConfigure()

VOID OcAppleDebugLogConfigure

(

IN BOOLEAN

Enable

)

Configure Apple Debug Log protocol.

Parameters

[in]

Enable

Enable logging to OcLog.

Definition at line 33 of file OcLogAggregatorLibNull.c.

OcAppleDebugLogInstallProtocol()

APPLE_DEBUG_LOG_PROTOCOL * OcAppleDebugLogInstallProtocol

(

IN BOOLEAN

Reinstall

)

Install and initialise the Apple Debug Log protocol.

Parameters

[in]

Reinstall

Replace any installed protocol.

Returns

Installed or located protocol.

Return values

NULL	There was an error locating or installing the protocol.

Definition at line 25 of file OcLogAggregatorLibNull.c.

OcAppleDebugLogPerfAllocated()

VOID OcAppleDebugLogPerfAllocated	(	IN OUT VOID *	PerfBuffer,
		IN UINTN	PerfBufferSize )

Configure Apple performance log location.

Parameters

[in,out]	PerfBuffer	Performance buffer location.
[in]	PerfBufferSize	Performance buffer size.

Definition at line 40 of file OcLogAggregatorLibNull.c.

OcConfigureLogProtocol()

EFI_STATUS OcConfigureLogProtocol	(	IN OC_LOG_OPTIONS	Options,
		IN CONST CHAR8 *	LogModules,
		IN UINT32	DisplayDelay,
		IN UINTN	DisplayLevel,
		IN UINTN	HaltLevel,
		IN CONST CHAR16 *LogPrefixPath	OPTIONAL,
		IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *LogFileSystem	OPTIONAL )

Install or update the OcLog protocol with specified options.

Parameters

[in]	Options	Logging options.
[in]	DisplayDelay	Delay in microseconds after each log entry.
[in]	DisplayLevel	Console visible error level.
[in]	HaltLevel	Error level causing CPU halt.
[in]	LogPrefixPath	Log path (without timestamp).
[in]	LogFileSystem	Log filesystem, optional.

Note: If LogFileSystem is specified, and it is not writable, then the first writable file system is chosen.

Return values

EFI_SUCCESS

The entry point is executed successfully.

Definition at line 48 of file OcLogAggregatorLibNull.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 17 of file OcLogAggregatorLibNull.c.