Skip to content

Update Adv Logger Info to V6 [Rebase & FF] #826

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
makubacki merged 2 commits into from
Feb 10, 2026
Merged

Update Adv Logger Info to V6 [Rebase & FF] #826

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8afbd53
AdvLoggerPkg: Define a single advanced logger info version
makubacki Feb 6, 2026
b752c6b
AdvLoggerPkg: Bump ADVANCED_LOGGER_INFO_VER to 6
makubacki Feb 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 54 additions & 14 deletions AdvLoggerPkg/Application/DecodeUefiLog/DecodeUefiLog.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,9 +216,34 @@ class AdvLogParser ():
# EFI_PHYSICAL_ADDRESS NewLoggerInfoAddress; // If non-zero, this field holds the address of new logger info (added in later V5 revision, may not be present in older logs)
# } ADVANCED_LOGGER_INFO;
V5_LOGGER_INFO_SIZE = 80
V5_LOGGER_INFO_SIZE_WITH_NEW_ADDRESS = 88
V5_LOGGER_INFO_SIZE_WITH_NEW_ADDRESS = 88 # Note: This was shortly released in V5 but soon after in v6
V5_LOGGER_INFO_VERSION = 5

# typedef volatile struct {
# UINT32 Signature; // Signature 'ALOG'
# UINT16 Version; // Current Version
# UINT16 Reserved[3]; // Reserved for future
# UINT32 LogBufferOffset; // Offset from LoggerInfo to start of log, expected to be the size of this structure, 8 byte aligned
# UINT32 Reserved4;
# UINT32 LogCurrentOffset; // Offset from LoggerInfo to where to store next log entry.
# UINT32 DiscardedSize; // Number of bytes of messages missed
# UINT32 LogBufferSize; // Size of allocated buffer
# BOOLEAN InPermanentRAM; // Log in permanent RAM
# BOOLEAN AtRuntime; // After ExitBootServices
# BOOLEAN GoneVirtual; // After VirtualAddressChange
# BOOLEAN HdwPortInitialized; // HdwPort initialized
# BOOLEAN HdwPortDisabled; // HdwPort is Disabled
# BOOLEAN Reserved2[3]; //
# UINT64 TimerFrequency; // Ticks per second for log timing
# UINT64 TicksAtTime; // Ticks when Time Acquired
# EFI_TIME Time; // Uefi Time Field
# UINT32 HwPrintLevel; // Logging level to be printed at hw port
# UINT32 Reserved3; //
# EFI_PHYSICAL_ADDRESS NewLoggerInfoAddress; // If non-zero, this field holds the address of new logger info
# } ADVANCED_LOGGER_INFO;
V6_LOGGER_INFO_SIZE = 88
V6_LOGGER_INFO_VERSION = 6

# ---------------------------------------------------------------------- #
#
#
Expand Down Expand Up @@ -458,26 +483,40 @@ def _InitializeLoggerInfo(self, InFile, StartLine):
if InFile.tell() != (Size):
raise Exception('Error initializing logger info. AmountRead: %d' % InFile.tell())

elif Version == self.V5_LOGGER_INFO_VERSION:
InFile.read(4) # skip over rest of reserved section
# V5 can be either 80 bytes or 88 bytes (minor version 1 update with NewLoggerInfoAddress)
elif (Version == self.V5_LOGGER_INFO_VERSION or
Version == self.V6_LOGGER_INFO_VERSION):
# skip over rest of reserved section
InFile.read(4)

# V5 can be either 80 bytes or 88 bytes
LoggerInfo["LogBufferOffset"] = struct.unpack(
"=I", InFile.read(4))[0]

BaseAddress = 0
LoggerInfo["LogBufferOffset"] = struct.unpack("=I", InFile.read(4))[0]
Size = LoggerInfo["LogBufferOffset"]

# Determine if this has the NewLoggerInfoAddress field based on structure size
if Size == self.V5_LOGGER_INFO_SIZE:
HasNewLoggerInfoAddress = False
elif Size == self.V5_LOGGER_INFO_SIZE_WITH_NEW_ADDRESS:
print("Logger Info:")
print(f" Version: {Version}")
print(f" Size: {Size}")

# For V5, determine if this has the NewLoggerInfoAddress field
# based on structure size
if Version == self.V5_LOGGER_INFO_VERSION:
if Size == self.V5_LOGGER_INFO_SIZE:
HasNewLoggerInfoAddress = False
elif Size == self.V5_LOGGER_INFO_SIZE_WITH_NEW_ADDRESS:
HasNewLoggerInfoAddress = True
else:
raise Exception(
'Error initializing logger info. '
'Unexpected V5 structure size: %d' % Size)
if Version == self.V6_LOGGER_INFO_VERSION:
HasNewLoggerInfoAddress = True
else:
raise Exception('Error initializing logger info. Unexpected V5 structure size: %d' % Size)
assert Size == self.V6_LOGGER_INFO_SIZE

# we no longer have this field in the struct but for compatibility can calculate it
# to be used
LoggerInfo["LogBuffer"] = Size
# this is only used to calculate LogCurrent as an offset, but V5 uses
# LogCurrentOffset already, so we do this just to share the common code
InFile.read(4) # skip over reserved4 field
LoggerInfo["LogCurrentOffset"] = struct.unpack("=I", InFile.read(4))[0]
# we don't have this field anymore, but to share the common code we
Expand Down Expand Up @@ -522,6 +561,7 @@ def _InitializeLoggerInfo(self, InFile, StartLine):
if InFile.tell() != (Size):
raise Exception('Error initializing logger info. AmountRead: %d, Expected: %d' % (InFile.tell(), Size))


else:
raise Exception('Error initializing logger info. Unsupported version: 0x%X' % LoggerInfo["Version"])

Expand Down Expand Up @@ -698,7 +738,7 @@ def _GetTimeInNanoSecond(self, Ticks, Frequency):
Nanosecond = int((Ticks / Frequency) * 1000000000)
else:
Nanosecond = 0

return Nanosecond

#
Expand Down
12 changes: 6 additions & 6 deletions AdvLoggerPkg/Include/AdvancedLoggerInternal.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,14 @@
#define ADVANCED_LOGGER_SIGNATURE SIGNATURE_32('A','L','O','G')

//
// Advanced Logger Hardware Port Level Support Version
// Advanced Logger Information Structure Version
//
// Writing to hardware port based on message DebugLevel is supported
// (AdvancedLoggerHdwPortWrite()).
#define ADVANCED_LOGGER_INFO_VER 6

//
// The Advanced Logger Information Structure Version that supports HW_LVL logging
//
#define ADVANCED_LOGGER_HW_LVL_VER 5
#define ADVANCED_LOGGER_INFO_HW_LVL_SUPPORTED_VER 5

//
// Advanced Logger Message structure versions
Expand All @@ -30,8 +32,6 @@
#define ADVANCED_LOGGER_MSG_MAJ_VER 2
#define ADVANCED_LOGGER_MSG_MIN_VER 1

#define ADVANCED_LOGGER_VERSION ADVANCED_LOGGER_HW_LVL_VER

#define ADVANCED_LOGGER_PHASE_UNSPECIFIED 0
#define ADVANCED_LOGGER_PHASE_SEC 1
#define ADVANCED_LOGGER_PHASE_PEI 2
Expand Down
2 changes: 1 addition & 1 deletion AdvLoggerPkg/Library/AdvancedLoggerLib/AdvancedLoggerCommon.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ AdvancedLoggerWrite (
// if we are at a high enough version to support HW_LVL logging, only call the HdwPortWrite if this DebugLevel
// is asked to be logged
// if we are at an older version, check the PCD to see if we should log this message
if (LoggerInfo->Version >= ADVANCED_LOGGER_HW_LVL_VER) {
if (LoggerInfo->Version >= ADVANCED_LOGGER_INFO_HW_LVL_SUPPORTED_VER) {
if (DebugLevel & LoggerInfo->HwPrintLevel) {
AdvancedLoggerHdwPortWrite (DebugLevel, (UINT8 *)Buffer, NumberOfBytes);
}
Expand Down
2 changes: 1 addition & 1 deletion AdvLoggerPkg/Library/AdvancedLoggerLib/DxeCore/AdvancedLoggerLib.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,7 +383,7 @@ InitializeLoggerInfoStructure (

ZeroMem ((VOID *)LoggerInfo, sizeof (ADVANCED_LOGGER_INFO));
LoggerInfo->Signature = ADVANCED_LOGGER_SIGNATURE;
LoggerInfo->Version = ADVANCED_LOGGER_VERSION;
LoggerInfo->Version = ADVANCED_LOGGER_INFO_VER;
LoggerInfo->LogBufferOffset = EXPECTED_LOG_BUFFER_OFFSET (LoggerInfo);
LoggerInfo->LogBufferSize = EFI_PAGES_TO_SIZE (FixedPcdGet32 (PcdAdvancedLoggerPages)) - sizeof (ADVANCED_LOGGER_INFO);
LoggerInfo->LogCurrentOffset = LoggerInfo->LogBufferOffset;
Expand Down
2 changes: 1 addition & 1 deletion ...oggerPkg/Library/AdvancedLoggerLib/DxeCore/GoogleTest/AdvancedLoggerDxeCoreGoogleTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ class AdvancedLoggerDxeCoreTest : public Test {
mInitialized = FALSE;
ImageHandle = (EFI_HANDLE)0x12345678;
testLoggerInfo.Signature = ADVANCED_LOGGER_SIGNATURE;
testLoggerInfo.Version = ADVANCED_LOGGER_VERSION;
testLoggerInfo.Version = ADVANCED_LOGGER_INFO_VER;
testLoggerInfo.LogBufferOffset = (ALIGN_VALUE (sizeof (testLoggerInfo), 8));
testLoggerInfo.LogCurrentOffset = (ALIGN_VALUE (sizeof (testLoggerInfo), 8));
mLoggerInfo = NULL;
Expand Down
2 changes: 1 addition & 1 deletion AdvLoggerPkg/Library/AdvancedLoggerLib/MmCore/AdvancedLoggerLib.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ ValidateInfoBlock (
return FALSE;
}

if (mLoggerInfo->Version != ADVANCED_LOGGER_VERSION) {
if (mLoggerInfo->Version != ADVANCED_LOGGER_INFO_VER) {
return FALSE;
}

Expand Down
6 changes: 3 additions & 3 deletions AdvLoggerPkg/Library/AdvancedLoggerLib/MmCore/GoogleTest/AdvancedLoggerMmCoreGoogleTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ class AdvancedLoggerMmCoreTest : public Test {
DebugLevel = DEBUG_ERROR;
ImageHandle = (EFI_HANDLE)0x12345678;
testLoggerInfo.Signature = ADVANCED_LOGGER_SIGNATURE;
testLoggerInfo.Version = ADVANCED_LOGGER_VERSION;
testLoggerInfo.Version = ADVANCED_LOGGER_INFO_VER;
testLoggerInfo.LogBufferOffset = (ALIGN_VALUE (sizeof (testLoggerInfo), 8));
testLoggerInfo.LogCurrentOffset = (ALIGN_VALUE (sizeof (testLoggerInfo), 8));
}
Expand All @@ -78,10 +78,10 @@ TEST_F (AdvancedLoggerMmCoreTest, AdvLoggerGetInfoFail) {
mLoggerInfo->Signature = ADVANCED_LOGGER_SIGNATURE;

// Invalid Version
mLoggerInfo->Version = (UINT32)ADVANCED_LOGGER_VERSION + 1;
mLoggerInfo->Version = (UINT32)ADVANCED_LOGGER_INFO_VER + 1;
Status = ValidateInfoBlock ();
EXPECT_EQ (Status, FALSE);
mLoggerInfo->Version = ADVANCED_LOGGER_VERSION;
mLoggerInfo->Version = ADVANCED_LOGGER_INFO_VER;

// Invalid Buffer Offset
mLoggerInfo->LogBufferOffset = (UINT32)0;
Expand Down
4 changes: 2 additions & 2 deletions AdvLoggerPkg/Library/AdvancedLoggerLib/PeiCore/AdvancedLoggerLib.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -512,7 +512,7 @@ AdvancedLoggerGetLoggerInfo (
BufferSize = sizeof (ADVANCED_LOGGER_INFO) + ADVANCED_LOGGER_MAX_MESSAGE_SIZE;
ZeroMem ((VOID *)LoggerInfo, BufferSize);
LoggerInfo->Signature = ADVANCED_LOGGER_SIGNATURE;
LoggerInfo->Version = ADVANCED_LOGGER_VERSION;
LoggerInfo->Version = ADVANCED_LOGGER_INFO_VER;
LoggerInfo->LogBufferOffset = EXPECTED_LOG_BUFFER_OFFSET (LoggerInfo);
LoggerInfo->LogBufferSize = (UINT32)(BufferSize - sizeof (ADVANCED_LOGGER_INFO));
LoggerInfo->LogCurrentOffset = LoggerInfo->LogBufferOffset;
Expand Down Expand Up @@ -565,7 +565,7 @@ AdvancedLoggerGetLoggerInfo (
LoggerInfo = ALI_FROM_PA (NewLoggerInfo);
ZeroMem ((VOID *)LoggerInfo, BufferSize);
LoggerInfo->Signature = ADVANCED_LOGGER_SIGNATURE;
LoggerInfo->Version = ADVANCED_LOGGER_VERSION;
LoggerInfo->Version = ADVANCED_LOGGER_INFO_VER;
LoggerInfo->LogBufferOffset = EXPECTED_LOG_BUFFER_OFFSET (LoggerInfo);
LoggerInfo->LogBufferSize = (UINT32)(BufferSize - sizeof (ADVANCED_LOGGER_INFO));
LoggerInfo->LogCurrentOffset = LoggerInfo->LogBufferOffset;
Expand Down
2 changes: 1 addition & 1 deletion ...oggerPkg/Library/AdvancedLoggerLib/PeiCore/GoogleTest/AdvancedLoggerPeiCoreGoogleTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ class AdvancedLoggerPeiCoreTest : public Test {
DebugLevel = DEBUG_ERROR;
ImageHandle = (EFI_HANDLE)0x12345678;
testLoggerInfo.Signature = ADVANCED_LOGGER_SIGNATURE;
testLoggerInfo.Version = ADVANCED_LOGGER_VERSION;
testLoggerInfo.Version = ADVANCED_LOGGER_INFO_VER;
testLoggerInfo.LogBufferOffset = (ALIGN_VALUE (sizeof (testLoggerInfo), 8));
testLoggerInfo.LogCurrentOffset = (ALIGN_VALUE (sizeof (testLoggerInfo), 8));
ZeroMem (SourceBuf, NumberOfBytes);
Expand Down
2 changes: 1 addition & 1 deletion AdvLoggerPkg/Library/AdvancedLoggerLib/PeilessArm/AdvancedLoggerLib.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ AdvancedLoggerLibConstructor (
if (LoggerInfo != NULL) {
ZeroMem ((VOID *)LoggerInfo, sizeof (ADVANCED_LOGGER_INFO));
LoggerInfo->Signature = ADVANCED_LOGGER_SIGNATURE;
LoggerInfo->Version = ADVANCED_LOGGER_VERSION;
LoggerInfo->Version = ADVANCED_LOGGER_INFO_VER;
LoggerInfo->LogBufferSize = (UINT32)(LogBufferSize - sizeof (ADVANCED_LOGGER_INFO));
LoggerInfo->LogBufferOffset = EXPECTED_LOG_BUFFER_OFFSET (LoggerInfo);
LoggerInfo->LogCurrentOffset = LoggerInfo->LogBufferOffset;
Expand Down
2 changes: 1 addition & 1 deletion AdvLoggerPkg/Library/DebugAgent/Sec/AdvancedLoggerSecDebugAgent.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ InitializeDebugAgent (
LoggerInfo = ALI_FROM_PA (NewLogBuffer);
ZeroMem ((VOID *)LoggerInfo, sizeof (ADVANCED_LOGGER_INFO));
LoggerInfo->Signature = ADVANCED_LOGGER_SIGNATURE;
LoggerInfo->Version = ADVANCED_LOGGER_VERSION;
LoggerInfo->Version = ADVANCED_LOGGER_INFO_VER;
LoggerInfo->LogBufferSize = (UINT32)(LogBufferSize - sizeof (ADVANCED_LOGGER_INFO));
LoggerInfo->LogBufferOffset = EXPECTED_LOG_BUFFER_OFFSET (LoggerInfo);
LoggerInfo->LogCurrentOffset = LoggerInfo->LogBufferOffset;
Expand Down