xinb
/
alder_lake_bios
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
alder_lake_bios/Intel/AlderLake/ClientOneSiliconPkg/Library/TraceHubStatusCodeHandlerLib/PeiTraceHubStatusCodeHandle...

272 lines
8.8 KiB
C
Raw Permalink Blame History

//
// This file contains 'Framework Code' and is licensed as such
// under the terms of your license agreement with Intel or your
// vendor. This file may not be modified, except as allowed by
// additional terms of your license agreement.
//
/** @file
TraceHub status code reporting worker.
INTEL CONFIDENTIAL
Copyright (c) 2014 - 2021, Intel Corporation. All rights reserved.<BR>
This software and associated documentation (if any) is furnished
under a license and may only be used or copied in accordance
with the terms of the license. Except as permitted by such
license, no part of this software or documentation may be
reproduced, stored in a retrieval system, or transmitted in any
form or by any means without the express written consent of
Intel Corporation.
**/
#include <Ppi/ReportStatusCodeHandler.h>
#include <Library/DebugLib.h>
#include <Library/ReportStatusCodeLib.h>
#include <Library/PeiServicesLib.h>
#include <Library/PeimEntryPoint.h>
#include <Library/PcdLib.h>
#include <Library/TraceHubDebugLib.h>
#include <Guid/StatusCodeDataTypeId.h>
#include <Library/BaseMemoryLib.h>
#include <Library/PrintLib.h>
#include <Library/DebugPrintErrorLevelLib.h>
/**
Convert status code value and extended data to readable ASCII string, send string to TraceHub device.
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
@param CodeType Indicates the type of status code being reported.
@param Value Describes the current status of a hardware or
software entity. This includes information about the class and
subclass that is used to classify the entity as well as an operation.
For progress codes, the operation is the current activity.
For error codes, it is the exception.For debug codes,it is not defined at this time.
@param Instance The enumeration of a hardware or software entity within
the system. A system may contain multiple entities that match a class/subclass
pairing. The instance differentiates between them. An instance of 0 indicates
that instance information is unavailable, not meaningful, or not relevant.
Valid instance numbers start with 1.
@param CallerId This optional parameter may be used to identify the caller.
This parameter allows the status code driver to apply different rules to
different callers.
@param Data This optional parameter may be used to pass additional data.
@retval EFI_SUCCESS Status code reported to TraceHub successfully.
**/
EFI_STATUS
EFIAPI
TraceHubStatusCodeReportWorker (
IN CONST EFI_PEI_SERVICES **PeiServices,
IN EFI_STATUS_CODE_TYPE CodeType,
IN EFI_STATUS_CODE_VALUE Value,
IN UINT32 Instance,
IN CONST EFI_GUID *CallerId,
IN CONST EFI_STATUS_CODE_DATA *Data OPTIONAL
)
{
CHAR8 *Filename;
CHAR8 *Description;
CHAR8 *Format;
CHAR8 Buffer[EFI_STATUS_CODE_DATA_MAX_SIZE];
UINT32 ErrorLevel;
UINT32 LineNumber;
UINTN CharCount;
BASE_LIST Marker;
UINT32 DebugPrintErrorLevel;
TRACE_HUB_SEVERITY_TYPE TraceHubSeverityLevel;
Buffer[0] = '\0';
DebugPrintErrorLevel = GetDebugPrintErrorLevel ();
if (Data != NULL &&
CompareGuid (&Data->Type, &gEfiStatusCodeDataTypeStringGuid) &&
((EFI_STATUS_CODE_STRING_DATA *) Data)->StringType == EfiStringAscii) {
if ((Instance & DebugPrintErrorLevel) == 0) {
return EFI_SUCCESS;
}
//
// Print String Data.
//
TraceHubSeverityLevel = SeverityNormal;
TraceHubDebugWrite (
TraceHubSeverityLevel,
(UINT8 *) (((EFI_STATUS_CODE_STRING_DATA *) Data)->String.Ascii),
((EFI_STATUS_CODE_STRING_DATA *) Data)->DataHeader.Size
);
return EFI_SUCCESS;
} else if (Data != NULL &&
ReportStatusCodeExtractAssertInfo (CodeType, Value, Data, &Filename, &Description, &LineNumber)) {
if ((EFI_D_ERROR & DebugPrintErrorLevel) == 0) {
return EFI_SUCCESS;
}
//
// Print ASSERT() information into output buffer.
//
CharCount = AsciiSPrint (
Buffer,
sizeof (Buffer),
"\n\rPEI_ASSERT!: %a (%d): %a\n\r",
Filename,
LineNumber,
Description
);
TraceHubSeverityLevel = SeverityFatal;
} else if (Data != NULL &&
ReportStatusCodeExtractDebugInfo (Data, &ErrorLevel, &Marker, &Format)) {
if ((ErrorLevel & DebugPrintErrorLevel) == 0) {
return EFI_SUCCESS;
}
//
// Print DEBUG() information into output buffer.
//
CharCount = AsciiBSPrint (
Buffer,
sizeof (Buffer),
Format,
Marker
);
if (ErrorLevel == EFI_D_WARN) {
TraceHubSeverityLevel = SeverityNormal;
} else if (ErrorLevel == EFI_D_ERROR) {
TraceHubSeverityLevel = SeverityError;
} else {
TraceHubSeverityLevel = SeverityNormal;
}
} else if ((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) {
if ((EFI_D_ERROR & DebugPrintErrorLevel) == 0) {
return EFI_SUCCESS;
}
//
// Print ERROR information into output buffer.
//
CharCount = AsciiSPrint (
Buffer,
sizeof (Buffer),
"ERROR: C%08x:V%08x I%x",
CodeType,
Value,
Instance
);
ASSERT(CharCount > 0);
if (CallerId != NULL) {
CharCount += AsciiSPrint (
&Buffer[CharCount],
(sizeof (Buffer) - (sizeof (Buffer[0]) * CharCount)),
" %g",
CallerId
);
}
if (Data != NULL) {
CharCount += AsciiSPrint (
&Buffer[CharCount],
(sizeof (Buffer) - (sizeof (Buffer[0]) * CharCount)),
" %x",
Data
);
}
CharCount += AsciiSPrint (
&Buffer[CharCount],
(sizeof (Buffer) - (sizeof (Buffer[0]) * CharCount)),
"\n\r"
);
TraceHubSeverityLevel = SeverityError;
} else if ((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) {
if ((EFI_D_INFO & DebugPrintErrorLevel) == 0) {
return EFI_SUCCESS;
}
//
// Print PROGRESS information into output buffer.
//
CharCount = AsciiSPrint (
Buffer,
sizeof (Buffer),
"PROGRESS CODE: V%08x I%x\n\r",
Value,
Instance
);
TraceHubSeverityLevel = SeverityNormal;
#if FixedPcdGetBool (PcdTraceHubCatalogEnable) == 1
TraceHubWriteCataLog64_0 (TraceHubSeverityLevel, Value);
return EFI_SUCCESS;
#endif
} else {
if ((EFI_D_INFO & DebugPrintErrorLevel) == 0) {
return EFI_SUCCESS;
}
//
// Code type is not defined.
//
CharCount = AsciiSPrint (
Buffer,
sizeof (Buffer),
"Undefined: C%08x:V%08x I%x\n\r",
CodeType,
Value,
Instance
);
TraceHubSeverityLevel = SeverityNone;
}
//
// Call TraceHub Lib function to do print.
//
TraceHubDebugWrite (TraceHubSeverityLevel, (UINT8 *) Buffer, CharCount);
return EFI_SUCCESS;
}
/**
Constructor function of PeiPostCodeStatusCodeHandlerLib.
This function is the constructor function of this PostCode Status Code Handler Library for PEI Phase.
It check whether need beep, and register it to gEfiPeiRscHandlerPpiGuid.
@param FileHandle Handle of the file being invoked.
@param PeiServices Describes the list of possible PEI Services.
@retval EFI_SUCESS The entry point of DXE IPL PEIM executes successfully.
**/
RETURN_STATUS
EFIAPI
PeiTraceHubStatusCodeHandlerLibConstructor (
IN EFI_PEI_FILE_HANDLE FileHandle,
IN CONST EFI_PEI_SERVICES **PeiServices
)
{
EFI_STATUS Status;
EFI_PEI_RSC_HANDLER_PPI *RscHandlerPpi;
if (!PcdGetBool (PcdStatusCodeUseTraceHub)) {
return RETURN_SUCCESS;
}
Status = PeiServicesLocatePpi (
&gEfiPeiRscHandlerPpiGuid,
0,
NULL,
(VOID **) &RscHandlerPpi
);
ASSERT_EFI_ERROR (Status);
Status = RscHandlerPpi->Register (TraceHubStatusCodeReportWorker);
ASSERT_EFI_ERROR (Status);
return RETURN_SUCCESS;
}
Reference in New Issue View Git Blame Copy Permalink