GitBucket
Newer
Ajax Dong
// ====================================================================
// StatusCodeSmm.c
// SMM Status Code Reporting Driver
// Module: StatusCodeSmm (Index 0255)
// Source: AmiModulePkg/AmiStatusCode/StatusCodeSmm
// Arch: x86-64 | Image Size: 0x54E0 (21.7 KB)
// ====================================================================
// Decompiled and reconstructed from IDA Pro analysis of the
// Lenovo HR650X BIOS UEFI firmware image. All functions have been
// identified and renamed for clarity.
//
// This SMM driver provides status code reporting infrastructure
// within System Management Mode. It intercepts SMI events triggered
// by status code writes and routes them to configurable output
// channels (serial, port 80 POST codes) and registered callbacks.
// ====================================================================
#include "StatusCodeSmm.h"
//
// Global variable storage
// (These are placed in .data section at well-known offsets)
//
EFI_HANDLE gImageHandle;
EFI_SYSTEM_TABLE *gST;
EFI_BOOT_SERVICES *gBS;
EFI_RUNTIME_SERVICES *gRT;
EFI_SMM_SYSTEM_TABLE2 *gSmst;
volatile UINT64 gStatusCodeStatus = 0x8000000000000001ULL;
UINT32 gStatusCodeErrorLevel;
UINT8 gDispatchInProgress;
BASE_LIBRARY_JUMP_BUFFER gJumpBuffer;
EFI_PHYSICAL_ADDRESS gPciExpressBaseAddress;
EFI_SMRAM_DESCRIPTOR *mSmramRanges;
UINTN mSmramRangeCount;
CHAR8 gSerialOutputBuffer[0x800];
UINT32 gCallbackCount;
UINT64 gCallbackTable[10];
UINT8 gReentrancyGuard;
//
// Static data tables (defined in .rdata)
// Error code lookup table.
// Each entry: {UINT32 StatusCode, UINT32 StringOffset}
// Terminated by {0, 0}.
STATIC CONST UINT32 gErrorCodeTable[] = {
0x00051002, 0x00002F78, // Correctable memory error
0x00051003, 0x00002F98, // Uncorrectable memory error
0x00011006, 0x00002FB8, // CPU thermal error
0x00011007, 0x00002FD0, // CPU low voltage
0x00011008, 0x00002FE0, // CPU high voltage
0x0001100B, 0x00002FF8, // Correctable CPU ECC error
0x0001100C, 0x00003018, // Uncorrectable CPU ECC error
0, 0 // terminator
};
// ====================================================================
// Module Entry Point (_ModuleEntryPoint at 0x500)
// ====================================================================
// Standard UEFI driver entry. Initializes SMM environment, registers
// SMI handlers with error recovery via SetJump/LongJump.
//
EFI_STATUS
EFIAPI
ModuleEntryPoint (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
EFI_STATUS Status;
SmmStatusCodeDriverInit ((UINT64)ImageHandle, SystemTable);
gStatusCodeStatus = 0x8000000000000001ULL;
if (!SetJump (&gJumpBuffer)) {
Status = SmmStatusCodeRegisterProtocols (0, SystemTable);
if (Status >= 0 || gStatusCodeStatus < 0) {
gStatusCodeStatus = Status;
}
SetJumpValidate (&gJumpBuffer);
LongJump (&gJumpBuffer, (UINTN)-1);
// These ASSERTs fire only if LongJump fails (should never happen)
ASSERT (FALSE);
ASSERT (FALSE);
}
Status = (EFI_STATUS)gStatusCodeStatus;
if (gStatusCodeStatus < 0) {
SmmFreePool ();
}
return Status;
}
// ====================================================================
// SmmStatusCodeDriverInit (0x5B4)
// ====================================================================
// Initializes the SMM driver environment:
// - Saves ImageHandle, SystemTable, BootServices, RuntimeServices
// - Locates SMM Base2 protocol to obtain gSmst
// - Locates SMM Access2 protocol to query SMRAM ranges
// - Allocates mSmramRanges array via SmmAllocatePool
// - Gets PCD protocol to read PCI Express base address (token 5)
// - Gets HOB list pointer for firmware volume location
// - Configures LPC device (B0/D31/F0) serial port registers
// - Performs TCO timer delay (port 0x508, ~357 timer ticks)
// - Saves and restores interrupt state around timing loop
//
VOID
SmmStatusCodeDriverInit (
IN UINT64 ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
EFI_BOOT_SERVICES *BootServices;
UINT64 Address;
UINT8 *Register;
UINT16 CallerEflags;
BOOLEAN InterruptsEnabled;
UINT32 TcoBase;
UINT64 SmmAccess2;
UINT64 SmramSize;
VOID *Pool;
UINT64 PcdProtocol;
// Save global pointers
gImageHandle = (EFI_HANDLE)ImageHandle;
ASSERT (gImageHandle != NULL);
gST = SystemTable;
ASSERT (gST != NULL);
gBS = SystemTable->BootServices;
ASSERT (gBS != NULL);
gRT = SystemTable->RuntimeServices;
ASSERT (gRT != NULL);
// Locate SMM Base2 protocol
BootServices = SystemTable->BootServices;
SmmAccess2 = 0;
Status = BootServices->LocateProtocol (&gEfiSmmBase2ProtocolGuid, NULL, &SmmAccess2);
ASSERT_EFI_ERROR (Status);
ASSERT (SmmAccess2 != NULL);
((EFI_SMM_BASE2_PROTOCOL *)SmmAccess2)->GetSmstLocation (SmmAccess2, &gSmst);
ASSERT (gSmst != NULL);
// Locate SMM Access2 protocol to get SMRAM sizes
Status = gBS->LocateProtocol (&gEfiSmmAccess2ProtocolGuid, NULL, &SmmAccess2);
ASSERT_EFI_ERROR (Status);
SmramSize = 0;
Status = ((EFI_SMM_ACCESS2_PROTOCOL *)SmmAccess2)->GetCapabilities (
SmmAccess2,
&SmramSize,
NULL
);
ASSERT (Status == EFI_BUFFER_TOO_SMALL);
Pool = SmmAllocatePool (EfiRuntimeServicesData, SmramSize);
mSmramRanges = (EFI_SMRAM_DESCRIPTOR *)Pool;
ASSERT (mSmramRanges != NULL);
Status = ((EFI_SMM_ACCESS2_PROTOCOL *)SmmAccess2)->GetCapabilities (
SmmAccess2,
&SmramSize,
(EFI_SMRAM_DESCRIPTOR *)Pool
);
ASSERT_EFI_ERROR (Status);
mSmramRangeCount = SmramSize >> 5;
// Read PCI Express base address from PCD
PcdProtocol = GetPcdProtocol ();
gPciExpressBaseAddress = ((EFI_PCD_PROTOCOL *)PcdProtocol)->Get64 (PCI_EXPRESS_BASE_TOKEN);
// Locate HOB list
GetHobList ();
// Configure LPC serial port (if enabled)
// PCI config address 0xFA004 = LPC command register (B0/D31/F0/Reg4)
// PCI config address 0xFA000 = LPC vendor/device ID register
if (*(INT8 *)PciExpressGetAddress (0xFA004) >= 0) {
// Set I/O base to 0x500
Address = PciExpressGetAddress (0xFA000);
IoWrite16 ((UINT16)Address, 0x500);
// Enable memory space (bit 1 of command register)
Register = (UINT8 *)PciExpressGetAddress (0xFA004);
*Register |= 0x80;
}
// Wait for TCO timer to stabilize
// Port 0x508 is the TCO I/O base register
CallerEflags = GetCallerEflags ();
DisableInterrupts ();
InterruptsEnabled = (CallerEflags & 0x200) != 0;
TcoBase = IoRead32 (TCO_TIMER_PORT) & 0xFFFFFF;
ReadTsc ();
while (((TcoBase + TCO_TIMEOUT_TICKS - IoRead32 (TCO_TIMER_PORT)) & 0x800000) == NULL) {
CpuPause ();
}
ReadTsc ();
// Restore interrupt state
if (InterruptsEnabled) {
EnableInterrupts ();
} else {
DisableInterrupts ();
}
}
// ====================================================================
// SmmStatusCodeRegisterProtocols (0xCD0)
// ====================================================================
// Registers three SMM handlers:
// 1) Main handler via EFI_SMM_CPU_IO2_PROTOCOL {
// 441FFA18-8714-421E-8C95-587080796FEE}
// -> SmmStatusCodeHandler (status code SMI handler)
//
// 2) ASSERT handler via AMI_SMM_ASSERT_PROTOCOL {
// 2FF29FA7-5E80-4ED9-B380-017D3C554FF4}
// -> SmmStatusCodeRegisterCallback + SmmStatusCodeUnregisterCallback
// (provides callback registration interface)
//
// 3) Progress handler via AMI_SMM_STATUS_CODE_PROTOCOL {
// 6AFD2B77-98C1-4ACD-A6F9-8A9439DE0FB1}
// -> SmmStatusCodeProgress
// (provides progress status code reporting)
//
EFI_STATUS
SmmStatusCodeRegisterProtocols (
IN UINT64 UnknownParam,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
EFI_HANDLE Handle1 = NULL;
EFI_HANDLE Handle2 = NULL;
if (gST == NULL) {
gST = SystemTable;
gRT = SystemTable->RuntimeServices;
}
// Handler #1: Register SmmStatusCodeHandler via EFI_SMM_CPU_IO2_PROTOCOL
// This causes the handler to fire on CPU I/O operations that generate
// status code SMI events.
Handle1 = NULL;
gSmmStatusCodeHandlerPtr = (UINT64)SmmStatusCodeHandler;
gSmmStatusCodeAssertHandlerPtr = (UINT64)SmmStatusCodeAssertHandler;
gSmst->SmiHandlerRegister (
&Handle1,
&gEfiSmmCpuIo2ProtocolGuid,
0,
(EFI_SMM_HANDLER_ENTRY_POINT2)SmmStatusCodeHandler
); // via gSmmStatusCodeHandlerPtr
gCallbackCount = 0;
// Handler #2: Register callback management protocol
gSmst->SmiHandlerRegister (
&Handle2,
&gAmiSmmAssertProtocolGuid,
0,
(EFI_SMM_HANDLER_ENTRY_POINT2)&mAssertProtocolTable
);
// Handler #3: Register progress/status code protocol
return gSmst->SmiHandlerRegister (
&Handle2,
&gAmiSmmStatusCodeProtocolGuid,
0,
(EFI_SMM_HANDLER_ENTRY_POINT2)&mStatusCodeProtocolTable
);
}
// ====================================================================
// SmmStatusCodeRegisterCallback (0x8F0)
// ====================================================================
// Registers a callback function pointer in the callback table.
// Callbacks are invoked when status code events occur.
//
// @param CallbackFunction Function pointer to register
// @return EFI_SUCCESS Callback registered
// @return EFI_INVALID_PARAMETER CallbackFunction is NULL
// @return EFI_ALREADY_STARTED Callback already registered
// @return EFI_OUT_OF_RESOURCES Table full (max 10 entries)
// @return EFI_NOT_FOUND Unused when registering (internal)
//
UINT64
SmmStatusCodeRegisterCallback (
IN UINT64 CallbackFunction
)
{
INT32 Slot;
UINT64 CurrentEntry;
UINT32 Index;
Slot = -1;
if (CallbackFunction == 0) {
return EFI_INVALID_PARAMETER; // RETURN_INVALID_PARAMETER
}
if (gCallbackCount > 0) {
Index = 0;
do {
CurrentEntry = gCallbackTable[Index];
if (CurrentEntry == CallbackFunction) {
return EFI_ALREADY_STARTED; // RETURN_ALREADY_STARTED
}
if (CurrentEntry == 0 && Slot == -1) {
Slot = Index; // Reuse empty slot
}
Index++;
} while (Index < gCallbackCount);
if (Slot != -1) {
goto InstallSlot;
}
if (gCallbackCount >= MAX_CALLBACKS) {
return EFI_OUT_OF_RESOURCES; // RETURN_OUT_OF_RESOURCES
}
Slot = Index;
gCallbackCount++;
} else {
gCallbackCount = 1;
Slot = 0;
}
InstallSlot:
gCallbackTable[Slot] = CallbackFunction;
return EFI_SUCCESS;
}
// ====================================================================
// SmmStatusCodeUnregisterCallback (0x8A8)
// ====================================================================
// Removes a callback function pointer from the callback table.
//
// @param CallbackFunction Function pointer to remove
// @return EFI_SUCCESS Callback removed
// @return EFI_INVALID_PARAMETER CallbackFunction is NULL
// @return EFI_NOT_FOUND Callback not registered
//
UINT64
SmmStatusCodeUnregisterCallback (
IN UINT64 CallbackFunction
)
{
UINT32 Index;
if (CallbackFunction == 0) {
return EFI_INVALID_PARAMETER;
}
if (gCallbackCount == 0) {
return EFI_NOT_FOUND;
}
Index = 0;
do {
if (gCallbackTable[Index] == CallbackFunction) {
gCallbackTable[Index] = 0;
return EFI_SUCCESS;
}
Index++;
} while (Index < gCallbackCount);
return EFI_NOT_FOUND;
}
// ====================================================================
// SmmStatusCodeDispatchCallbacks (0x988)
// ====================================================================
// Iterates all registered callback functions and invokes each with
// the status code parameters.
//
// Uses a reentrancy guard (gReentrancyGuard) to prevent recursive
// callback dispatch.
//
// @return EFI_NOT_READY If no callbacks registered or dispatch
// is already in progress
// @return EFI_SUCCESS Dispatch completed
//
UINT64
SmmStatusCodeDispatchCallbacks (
IN UINT32 Type,
IN UINT32 Value,
IN UINT32 Instance,
IN UINT64 CallerId,
IN UINTN DataLength
)
{
UINT32 Index;
UINT32 Count;
VOID (*Callback)(UINT32, UINT32, UINT32, UINT64, UINTN);
Count = gCallbackCount;
if (Count == 0) {
return EFI_NOT_READY;
}
if (gReentrancyGuard == 0) {
gReentrancyGuard = 1;
} else if (gReentrancyGuard == 1) {
return EFI_NOT_READY;
}
for (Index = 0; Index < Count; Index++) {
Callback = (VOID (*)(UINT32, UINT32, UINT32, UINT64, UINTN))gCallbackTable[Index];
if (Callback != NULL) {
Callback (Type, Value, Instance, CallerId, DataLength);
Count = gCallbackCount;
}
}
if (gReentrancyGuard == 1) {
gReentrancyGuard = 0;
}
return EFI_SUCCESS;
}
// ====================================================================
// SmmStatusCodeHandler (0xB84)
// ====================================================================
// The main SMI status code handler. Called when a status code SMI
// fires. Formats the status data string, records the error level,
// dispatches registered callbacks, and outputs to serial.
//
// @param ErrorLevel SMI error level / context
// @param StatusCodeData Raw status code data bytes
// @param VarArgs Variable arguments for format string
//
VOID
SmmStatusCodeHandler (
IN UINT64 ErrorLevel,
IN UINT8 *StatusCodeData,
IN UINT16 *VarArgs
)
{
VOID (*Callback)(CHAR8 *, UINT64);
UINT32 Index;
if (StatusCodeData != NULL) {
AsciiSPrint (
gSerialOutputBuffer,
sizeof (gSerialOutputBuffer),
0,
StatusCodeData,
VarArgs,
0
);
gStatusCodeErrorLevel = (UINT32)ErrorLevel;
SmmStatusCodeDispatchCallbacks (3, 0x03050000, 0, 0, (UINTN)&gSerialOutputBuffer);
// Invoke per-status-code callbacks
Index = 0;
Callback = gStatusCodeCallbacks[0];
while (Callback != NULL) {
Callback (gSerialOutputBuffer, ErrorLevel);
Index++;
Callback = gStatusCodeCallbacks[Index];
}
StatusCodeReportToSerial (0, gSerialOutputBuffer);
}
}
// ====================================================================
// SmmStatusCodeAssertHandler (0xC24)
// ====================================================================
// Invoked when an ASSERT condition fires in SMM. Formats the assert
// message with file/line info, dispatches assert-specific callbacks,
// and outputs via serial.
//
// @param FileName Text string of the assert file
// @param LineNumber Line number of the assert
// @param Description Text description of the assert
//
UINT64
SmmStatusCodeAssertHandler (
IN UINT64 FileName,
IN UINT64 LineNumber,
IN UINT64 Description,
IN DOUBLE StackDouble
)
{
VOID (*Callback)(UINT64 *, UINT64, UINT64);
UINT32 Index;
DebugAssert (
(UINT64)gSerialOutputBuffer,
sizeof (gSerialOutputBuffer),
"ASSERT %a(%d): %a\n Press any key to continue. \n",
(UINT64)StackDouble,
FileName,
Description
);
gStatusCodeErrorLevel = 0x80000000;
SmmStatusCodeDispatchCallbacks (3, 0x03050000, 0, 0, (UINTN)&gSerialOutputBuffer);
// Invoke assert-specific callbacks
Index = 0;
Callback = gAssertCallbacks[0];
while (Callback != NULL) {
Callback (&gSerialOutputBuffer, FileName, LineNumber);
Index++;
Callback = gAssertCallbacks[Index];
}
return StatusCodeReportToSerial (0, gSerialOutputBuffer);
}
// ====================================================================
// SmmStatusCodeProgress (0xA58)
// ====================================================================
// Handles status code progress (type 1) and error (type 2) events.
// Dispatches registered callbacks, runs enable/disable checks,
// formats the status string, outputs to serial, and handles
// progress-type specific dispatch.
//
// For EFI progress codes (type == 2), also queries a progress function
// table for matching dispatch.
//
UINT64
SmmStatusCodeProgress (
IN UINT64 Unknown,
IN UINT32 Type,
IN UINT32 Value,
IN UINT32 Instance,
IN UINT64 CallerId,
IN UINTN DataLength
)
{
VOID (*FilterCallback)(UINT64, UINT64, INT32);
VOID (*ProgressCallback)(UINT64, UINT64, UINT64, UINT64, UINT64, UINTN);
VOID (*FoundCallback)(UINT64, UINT32);
UINT32 Index;
char *Entry;
SmmStatusCodeDispatchCallbacks (Type, Value, Instance, CallerId, DataLength);
// Run enable/disable filter check callbacks
Index = 0;
FilterCallback = (VOID (*)(UINT64, UINT64, INT32))StatusCodeCheckAndEnable;
while (FilterCallback != NULL) {
FilterCallback (0, Type, Value);
Index++;
FilterCallback = gFilterCallbacks[Index];
}
gSerialOutputBuffer[0] = 0;
StatusCodeFormatString ((UINT8)Type, Value, DataLength, gSerialOutputBuffer);
if (gSerialOutputBuffer[0] != 0) {
StatusCodeReportToSerial (0, gSerialOutputBuffer);
}
// Run progress-specific callbacks
Index = 0;
ProgressCallback = gProgressCallbacks[0];
while (ProgressCallback != NULL) {
ProgressCallback (0, Type, Value, Instance, CallerId, DataLength);
Index++;
ProgressCallback = gProgressCallbacks[Index];
}
// For progress type 2, dispatch via progress function table
if ((UINT8)Type == 2) {
Entry = (char *)&mProgressFunctionTable2;
if ((UINT8)gProgressCallbacks[0] == 0) {
Entry = (char *)&mProgressFunctionTable1;
}
while (*(UINT32 *)Entry != 0) {
if (*(UINT32 *)Entry == Value && *((UINT64 *)Entry + 1) != 0) {
FoundCallback = (VOID (*)(UINT64, UINT32))*((UINT64 *)Entry + 1);
FoundCallback (0, Value);
return 0;
}
Entry += 16;
}
}
return 0;
}
// ====================================================================
// StatusCodeFormatString (0xE1C)
// ====================================================================
// Examines the status code data GUID to determine its type and
// formats the output string accordingly:
//
// GUID-matched:
// {92D11080-496F-4D95-BE7E-037488382B0A} -> Raw string (ASCII/Unicode)
// Extracts text from data payload, converts Unicode to ASCII
//
// {9A4E9246-D553-11D5-87E2-00062945C3B9} -> gEfiStatusCodeDataTypeStringGuid
// Uses format string from offset +120 and args from offset +24
//
// {335984BD-E805-409A-B8F8-D27ECE5FF7A6} -> AMI DataHub ASSERT
// Reads line number and file/description from payload.
// Requires type=2, class=0x90, subclass=7.
// Format: "ASSERT in %s on %i: %s\n"
//
// {DA571595-4D99-487C-827C-2622677D3307} -> AMI ASSERT GUID
// Reads line number at offset +60 and file at offset +80.
// Format: "ASSERT in %s on %i: %s\n"
//
// No GUID match + Type 2: delegates to StatusCodeReportError
// No GUID match + other types: returns 0 (no output)
//
UINT64
StatusCodeFormatString (
IN UINT8 Type,
IN UINT32 Value,
IN UINTN DataLength,
OUT CHAR8 *OutputBuffer
)
{
UINT16 Index;
EFI_GUID *DataGuid;
CHAR8 *StringBuffer;
CHAR8 *Src;
INT32 CharSize;
CHAR8 Ch;
UINT16 Step;
UINT32 LineNumber;
CONST CHAR8 *FileName;
UINT64 StrLen;
Index = 0;
if (DataLength == 0) {
goto NoMatch;
}
DataGuid = (EFI_GUID *)(DataLength + 4); // Skip header to get GUID
// Check #1: Plain string data GUID
if (!CompareMem (DataGuid, &mAmiStatusCodePlainStringGuid, DataLength)) {
// Copy string from payload
StringBuffer = *(CHAR8 **)(DataLength + 24);
Src = StringBuffer;
for (;;) {
CharSize = *(INT32 *)(DataLength + 20);
if ((CharSize != 0 || *StringBuffer == 0) &&
(CharSize != 1 || *(UINT16 *)Src == 0)) {
break;
}
if (Index >= 0x7FF) break;
if (CharSize == 1) {
Ch = *StringBuffer++;
OutputBuffer[Index] = Ch;
Step = 1;
} else {
Ch = *Src;
Src += 2;
OutputBuffer[Index] = Ch;
Step = 2;
}
Index += Step;
}
OutputBuffer[Index] = 0;
return 0;
}
// Check #2: Standard string type GUID
if (!CompareMem (DataGuid, &gEfiStatusCodeDataTypeStringGuid, DataLength)) {
AsciiSPrint (OutputBuffer, 0x800, 0,
(CHAR8 *)(DataLength + 120),
(UINT16 *)(DataLength + 24),
0);
return 0;
}
// Check #3: AMI DataHub ASSERT GUID
if (!CompareMem (DataGuid, &mAmiStatusCodeDatahubAssertGuid, DataLength)) {
if ((UINT8)Type != 2) return 0;
if ((Value & 0xFF000000) == 0x90000000 && (UINT16)Value == 7) {
LineNumber = *(UINT32 *)(DataLength + 40);
FileName = (CONST CHAR8 *)(DataLength + 60);
StrLen = 0;
if (*(UINT8 *)(DataLength + 60) != 0) {
do { StrLen++; } while (FileName[StrLen] != 0);
}
goto FormatAssert;
}
goto FormatError;
}
// Check #4: AMI ASSERT GUID
if (!CompareMem (DataGuid, &mAmiStatusCodeAssertDataGuid, DataLength)) {
LineNumber = *(UINT32 *)(DataLength + 60);
FileName = (CONST CHAR8 *)(DataLength + 80);
StrLen = 0;
if (*(UINT8 *)(DataLength + 80) != 0) {
do { StrLen++; } while (FileName[StrLen] != 0);
}
// Fall through to FormatAssert
FormatAssert:
AsciiSPrintUnsafe (
OutputBuffer, 2048,
"ASSERT in %s on %i: %s\n",
FileName, LineNumber, &FileName[StrLen + 1]
);
return 0;
}
NoMatch:
if ((UINT8)Type != 2) return 0;
FormatError:
StatusCodeReportError (Value, OutputBuffer, DataLength, *(UINT64 *)(DataLength + 4));
return 0;
}
// ====================================================================
// StatusCodeReportError (0xD94)
// ====================================================================
// Looks up a status code in the known error code table (gErrorCodeTable).
// If the code is found, formats "ERROR: %a" with the error description
// string from the status code data payload.
//
// If the code is not found (or table empty), formats the raw status
// code as three hex fields: "ERROR: Class:%X; Subclass:%X; Operation: %X\n"
//
UINT64
StatusCodeReportError (
IN UINT32 Value,
OUT CHAR8 *OutputBuffer,
IN UINTN DataLength,
IN UINT64 ErrorText
)
{
UINT32 Code;
UINT32 Index;
Index = 0;
Code = gErrorCodeTable[Index];
if (Code != 0) {
while (Code != Value) {
Index += 2;
Code = gErrorCodeTable[Index];
if (Code == 0) {
goto NotFound;
}
}
// Found in table - format with string from data payload
AsciiSPrintUnsafe (OutputBuffer, 2048, "ERROR: %a\n", ErrorText);
} else {
NotFound:
// Not found - format raw hex values
AsciiSPrintUnsafe (
OutputBuffer, 2048,
"ERROR: Class:%X; Subclass:%X; Operation: %X\n",
Value & 0xFF000000,
Value & 0xFF0000,
(UINT16)Value
);
}
return 0;
}
// ====================================================================
// StatusCodeWriteSerial (0xFE8)
// ====================================================================
// Writes a string to the serial port with proper CR/LF handling.
// - "\r\n" is passed through as-is (2 bytes)
// - Bare "\n" (no preceding "\r") triggers a "\r\n" sequence
// - Text is accumulated and flushed at newlines or end-of-string
//
UINT64
StatusCodeWriteSerial (
IN UINT64 Unknown,
IN UINT8 *String
)
{
UINTN NumberOfBytes;
CHAR8 *Current;
NumberOfBytes = 0;
if (String == NULL || *String == 0) return 0;
do {
Current = (CHAR8 *)&String[NumberOfBytes];
if (String[NumberOfBytes] == 13 && Current[1] == 10) {
// "\r\n" - skip both bytes (accumulate and flush)
NumberOfBytes += 2;
} else if (*Current == 10) {
// Bare "\n" - flush accumulated prefix and emit "\r\n"
if (NumberOfBytes != 0) {
SerialPortWrite (String, NumberOfBytes);
}
SerialPortWrite ((UINT8 *)"\r\n", 2);
String = (UINT8 *)(Current + 1);
NumberOfBytes = 0;
} else {
NumberOfBytes++;
}
} while (String[NumberOfBytes] != 0);
if (NumberOfBytes != 0) {
SerialPortWrite (String, NumberOfBytes);
}
return 0;
}
// ====================================================================
// StatusCodeReportToSerial (0x105C)
// ====================================================================
// Dispatches to StatusCodeWriteSerial (primary) and any additional
// output handlers registered in the output callback table.
//
UINT64
StatusCodeReportToSerial (
IN UINT64 Unknown,
IN UINT8 *String
)
{
UINT64 Index;
UINT64 (*Handler)(UINT64, UINT8 *);
Index = 0;
Handler = StatusCodeWriteSerial; // Primary serial output
while (Handler != NULL) {
Handler (0, String);
Index++;
Handler = (VOID *(*)(UINT64, UINT8 *))gOutputCallbacks[Index];
}
return (UINT64)Handler;
}
// ====================================================================
// StatusCodeWritePort80 (0x109C)
// ====================================================================
// Writes a byte to the hardware POST code display port (0x80).
// Used for debug POST cards or BMC POST code capture.
//
UINT64
StatusCodeWritePort80 (
IN UINT64 Unknown,
IN UINT8 Value
)
{
__outbyte (POST_CODE_PORT, Value);
return Value;
}
// ====================================================================
// StatusCodeCheckAndEnable (0x10A8)
// ====================================================================
// For type 1 (progress) and type 2 (error), looks up the status code
// value in the enable/disable table. If the code is enabled, invokes
// the port 80 write callbacks (including StatusCodeWritePort80).
//
UINT64
StatusCodeCheckAndEnable (
IN UINT64 Unknown,
IN UINT64 Type,
IN INT32 Value
)
{
UINT32 TypeIndex;
UINT32 *Table;
UINT8 Enabled;
UINT32 Index;
VOID (*Callback)(UINT64, UINT64);
TypeIndex = (UINT8)Type - 1;
if (TypeIndex < 2) {
// Walk the enable table for this type
Table = (UINT32 *)mEnableTables[TypeIndex];
for (;; Table += 2) {
if (Table[0] == 0) {
Enabled = 0;
goto CheckDone;
}
if (Table[0] == (UINT32)Value) {
Enabled = (UINT8)Table[1];
break;
}
}
CheckDone:
if (Enabled != 0) {
Index = 0;
Callback = StatusCodeWritePort80;
while (Callback != NULL) {
Callback (Unknown, (UINT64)Enabled);
Index++;
Callback = (VOID (*)(UINT64, UINT64))gPort80Callbacks[Index];
}
}
}
return 0;
}
// ====================================================================
// ===== UEFI Library Functions ======================================
// ====================================================================
// These are standard UEFI library implementations compiled into this
// module by the build system (MdePkg BaseLib, BasePrintLib, etc.).
// They are documented here for completeness.
// ====================================================================
// SetJump (0x2C0) / LongJump (0x360)
// ====================================================================
// Save/restore execution context for error recovery.
// SetJump saves: RBP, stack pointer, return address, XMM regs,
// MXCSR, and XMM6-XMM15. Returns 0 after save.
// LongJump restores context and jumps to the saved return point.
// ====================================================================
// SetJumpValidate (0x1130)
// ====================================================================
// Validates the jump buffer alignment (must be 8-byte aligned).
// ====================================================================
// DebugAssert (0x132C)
// ====================================================================
// Formats an ASSERT message string using AsciiSPrint.
// ====================================================================
// DebugAssertWorker (0x1210)
// ====================================================================
// Callback to the standard error interface (via protocol at 0x3ED0).
// If the protocol is available, formats: file, line, message.
// ====================================================================
// GetStandardErrorInterface (0x1178)
// ====================================================================
// Locates the SMM standard error protocol (GUID at 0x3ED0) and caches
// it in qword_4F68.
// ====================================================================
// DebugPrint (0x11C8)
// ====================================================================
// Conditional debug print: checks error level against current setting
// (read from CMOS index 0x4C via GetDebugPrintErrorLevel), then
// invokes the standard error interface if enabled.
// ====================================================================
// GetDebugPrintErrorLevel (0x2AC8)
// ====================================================================
// Reads the debug print error level from CMOS offset 0x4C.
// If the CMOS value is out of range, checks a memory-mapped
// location (0xFDAF0490) for the BMC-preserved value.
// Returns 0 (disabled), 0x80000004 (level 1), or 0x80000006 (level 2+).
// ====================================================================
// SerialPortWrite (0x2A18)
// ====================================================================
// Detects Super I/O type via SIO port 0x72/0x73:
// - If SIO ID byte at 0x73 == 0x33 -> NCT6776F (SIO index 760)
// - Otherwise -> generic SIO (index 1016)
// Writes bytes to serial port data register at (base + 0).
// Waits for THR empty (LSR bit 6). Bursts up to 16 bytes per
// transmitter-ready wait loop.
// ====================================================================
// AsciiSPrint (0x1404) - ~3573 bytes (0xDF5)
// ====================================================================
// Full UEFI AsciiSPrint implementation from BasePrintLib.
// Supports format specifiers:
// %s, %a - ASCII string, %S - Unicode string
// %c - character
// %d, %i - signed decimal, %x, %X, %p - hex
// %r - EFI_STATUS to string via StatusToString
// %g, %G - GUID format (%08x-%04x-%04x-%02x%02x-...)
// %02x, %04x - zero-padded width
// %l - 64-bit prefix for integer/hex
// %% - literal percent
// String length limited to 0xF4240 (1,000,000) characters.
// ====================================================================
// AsciiSPrintUnsafe (0x2984)
// ====================================================================
// Thin wrapper that va_start's and calls SPrint.
// ====================================================================
// SPrint (0x2544) - Unicode-aware printf
// ====================================================================
// Full SPrint implementation from PrintLibInternal.c supporting
// all standard format specifiers documented above.
// ====================================================================
// StatusToString (0x247C)
// ====================================================================
// Converts EFI_STATUS value to human-readable string:
// EFI_SUCCESS (0) -> "EFI_SUCCESS"
// Warning codes (0x2xxxxxxx) -> "EFI_WARN_..."
// Error codes (0x8xxxxxxx) -> various error strings
// Interrupt codes (0xAxxxxxxx) -> "EFI_INTERRUPT_PENDING_..."
// Unrecognized values -> NULL
// String table is embedded in .rdata at known offsets.
// ====================================================================
// ValueToString (0x2334)
// ====================================================================
// Converts integer value to ASCII string in given base (10 or 16).
// Supports negative values for base 10.
// ====================================================================
// AsciiStrDecimalToUintn (0x23A8)
// ====================================================================
// Parses a decimal string to UINTN. Skips leading whitespace,
// handles +/- sign. Supports hex digits a-f/A-F (returns base-10).
// ====================================================================
// AsciiStrSetChar (0x1358)
// ====================================================================
// Fills a buffer with repeated character (1-byte ASCII or 2-byte Unicode).
// ====================================================================
// Uint64ToAsciiString (0x138C)
// ====================================================================
// Converts UINT64 to ASCII hex string using LookupTable "0123456789ABCDEF".
// ====================================================================
// CompareMem (0x29A4)
// ====================================================================
// Memory compare. Compares byte-by-byte with qword optimization for
// aligned sections.
// ====================================================================
// IsAddressInSmram (0x1250)
// ====================================================================
// Checks if an address falls within any known SMRAM descriptor range.
// ====================================================================
// SmmAllocatePool (0x1294)
// ====================================================================
// Allocates SMM pool memory via gSmst->SmmAllocatePool.
// ====================================================================
// SmmFreePool (0x12C4)
// ====================================================================
// Frees memory via gSmst->SmmFreePool if in SMRAM, or gBS->FreePool
// if not. Used during module unload or error cleanup.
// ====================================================================
// IsHobGuidType (0x2BF4)
// ====================================================================
// Checks if a HOB entry matches a known GUID type by comparing
// the Buffer_ and Buffer__0 GUIDs.
// ====================================================================
// GetHobList (0x225C)
// ====================================================================
// Walks the System Table firmware volume HOB entries to find the
// HOB matching known GUIDs. Caches result in qword_4F78.
// ====================================================================
// GetPcdProtocol (0x2CD4)
// ====================================================================
// Locates the EFI_PCD_PROTOCOL (GUID {11B34006-...})
// via gBS->LocateProtocol. Caches result in qword_4F90.
// ====================================================================
// PciExpressGetAddress (0x2220)
// ====================================================================
// Calculates the MMIO address for a PCI config space register:
// result = Address + gPciExpressBaseAddress
// Requires Address < 0x10000000.
// ====================================================================
// PciExpressWrite8 (0x21FC)
// ====================================================================
// Writes a byte to PCI config space via the PCIe MMIO address window.
// (The IDA decompiler gives odd output due to function overlap with
// PciExpressGetAddress.)
// ====================================================================
// AsciiCharToUpper, etc.
// ====================================================================
// Standard UEFI BaseLib string utility functions.
// ====================================================================
// CpuPause (0x3E0), ReadTsc (0x3F0)
// EnableInterrupts (0x400), DisableInterrupts (0x410)
// GetCallerEflags (0x420)
// ====================================================================
// Intrinsic functions:
// CpuPause = _mm_pause()
// ReadTsc = __rdtsc()
// EnableInterrupts = _enable() (STI)
// DisableInterrupts = _disable() (CLI)
// GetCallerEflags = __getcallerseflags() (PUSHFQ)
//
// IoWrite16 (0x2C64) - Write 16-bit value to I/O port
// IoRead32 (0x2CA4) - Read 32-bit value from I/O port
// ReadUnaligned16 (0x2B18) - Read 16-bit from potentially unaligned addr
// ReadUnaligned64 (0x2B48) - Read 64-bit from potentially unaligned addr
// StrLen (0x2B78) - Unicode string length
// AsciiStrLen (0x2BD0) - ASCII string length
//