OcLogAggregatorLib.h File Reference

#include <Library/DebugLib.h>
#include <Protocol/OcLog.h>
#include <Protocol/AppleDebugLog.h>

Go to the source code of this file.

Functions
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)
APPLE_DEBUG_LOG_PROTOCOL *	OcAppleDebugLogInstallProtocol (IN BOOLEAN Reinstall)
VOID	OcAppleDebugLogConfigure (IN BOOLEAN Enable)
VOID	OcAppleDebugLogPerfAllocated (IN OUT VOID *PerfBuffer, IN UINTN PerfBufferSize)
VOID EFIAPI	OcPrintScreen (IN CONST CHAR16 *Format,...)

Detailed Description

Copyright (C) 2019, vit9696. All rights reserved.

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.

Definition in file OcLogAggregatorLib.h.

Function Documentation

OcAppleDebugLogConfigure()

VOID OcAppleDebugLogConfigure

(

IN BOOLEAN

Enable

)

Configure Apple Debug Log protocol.

Parameters

[in]

Enable

Enable logging to OcLog.

Definition at line 295 of file OcAppleLog.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 252 of file OcAppleLog.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 303 of file OcAppleLog.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 599 of file OcLog.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.