diff options
Diffstat (limited to 'Core/EM/StatusCode/StatusCodeCommon.c')
| -rw-r--r-- | Core/EM/StatusCode/StatusCodeCommon.c | 1142 |
1 files changed, 1142 insertions, 0 deletions
diff --git a/Core/EM/StatusCode/StatusCodeCommon.c b/Core/EM/StatusCode/StatusCodeCommon.c new file mode 100644 index 0000000..e694c8c --- /dev/null +++ b/Core/EM/StatusCode/StatusCodeCommon.c @@ -0,0 +1,1142 @@ +//********************************************************************** +//********************************************************************** +//** ** +//** (C)Copyright 1985-2011, American Megatrends, Inc. ** +//** ** +//** All Rights Reserved. ** +//** ** +//** 5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093 ** +//** ** +//** Phone: (770)-246-8600 ** +//** ** +//********************************************************************** +//********************************************************************** + +//********************************************************************** +// $Header: /Alaska/BIN/Modules/StatusCode/StatusCodeCommon.c 7 6/23/11 6:10p Oleksiyy $ +// +// $Revision: 7 $ +// +// $Date: 6/23/11 6:10p $ +//********************************************************************** +// Revision History +// ---------------- +// $Log: /Alaska/BIN/Modules/StatusCode/StatusCodeCommon.c $ +// +// 7 6/23/11 6:10p Oleksiyy +// [TAG] EIP56644 +// [Category] New Feature +// [Description] Implemented PPI and Protocols, described in a PI 1.2 +// Report Status Code Router specification. +// [Files] StatusCodePei.c, StatusCodeDxe.c, StatusCodeInt.h, +// StatusCodeCommon.c and StatusCodeRuntime.c +// +// 6 10/06/10 4:34p Oleksiyy +// Issue Number: 39752 +// +// Category: Improvement +// +// Description: Runtime Staus Code support is added. +// +// Files: Uart1.asl, Tokens.c, Runtime.c, GenericSio.c, EfiLib.c, +// CsmLib.c, AmiDxeLib.h and StatusCode eModule. +// +// 5 8/12/09 2:09p Felixp +// 1. Replace Sprintf calls with Sprint_s (to protect from buffer +// overflow). +// 2. Fix format string in ReportData function. +// +// 4 7/30/09 10:51a Felixp +// Minor Bug fix: EIP 24740. ReportData updated to extract status code +// type from the 'Type' parameter. +// +// 3 7/28/09 5:11p Vyacheslava +// Bug fix. EIP#24453: Synopsis: CPU exception when printing long +// debug messages. +// +// 2 7/09/09 5:18p Oleksiyy +// Files clean-up some headers added +// +// 1 3/05/09 1:40p Felixp +// +//********************************************************************** +//<AMI_FHDR_START> +// +// Name: StatusCodeCommon.c +// +// Description: +// This file contains routines used in PEI and DXE status code modules. +// It contains two main function groups: +// - Status Code Library (functions utilized throughout the component). +// - Status Code initialization code. The initialization code enables +// support of the multiple eLinks exposed by the status code module. +// The eLinks are described in the AMI Aptio 4.x StatusCode Porting Guide. +// +//<AMI_FHDR_END> +//********************************************************************** +#include <AmiLib.h> +#include <Token.h> +#include <StatusCodeELinks.h> +#include "StatusCodeInt.h" +#if PI_SPECIFICATION_VERSION >= 0x00010014 + +BOOLEAN RouterRecurciveStatus = FALSE; +#ifndef PEI_STATUS_CODE +extern BOOLEAN InRscHandlerNotification; +#include <Protocol/ReportStatusCodeHandler.h> + +extern EFI_BOOT_SERVICES *pBS; +ROUTER_STRUCT_HEADER *RouterCallbackStr = NULL; + +BOOLEAN SmmRouter = FALSE; +#endif +#endif +//------------------------------RouterEnd +BOOLEAN StatusRuntime = FALSE; +#ifdef PEI_STATUS_CODE +#define PEI(x) x +#define DXE(x) DUMMY_HANDLER +#define RUNTIME(x) DUMMY_HANDLER +#elif defined(DXE_STATUS_CODE) +#define PEI(x) DUMMY_HANDLER +#define DXE(x) x +#define RUNTIME(x) DUMMY_HANDLER +#endif + +#pragma pack(1) +typedef struct +{ + UINT32 ErrorLevel; + // 12 * sizeof (UINT64) Var Arg stack + // ascii EFI_DEBUG () Format string +} EFI_DEBUG_INFO; +#pragma pack() +#ifdef PEI_STATUS_CODE +#define EFI_MAX_STRING_LENGTH 256 +#else +#define EFI_MAX_STRING_LENGTH 2048 +#endif + +//---------------------------------------------------------------------------- +// GUID Definitions +#define EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID \ + {0x9A4E9246, 0xD553, 0x11D5, 0x87, 0xE2, 0x00, 0x06, 0x29, 0x45, 0xC3, 0xb9} +#define EFI_STATUS_CODE_DATA_TYPE_ASSERT_GUID \ + {0xDA571595, 0x4D99, 0x487C, 0x82, 0x7C, 0x26, 0x22, 0x67, 0x7D, 0x33, 0x07} +static EFI_GUID gEfiStatusCodeDataTypeDebugGuid = EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID; +static EFI_GUID gEfiStatusCodeDataTypeAssertGuid = EFI_STATUS_CODE_DATA_TYPE_ASSERT_GUID; +EFI_GUID gDataTypeStringGuid = EFI_STATUS_CODE_DATA_TYPE_STRING_GUID; +EFI_GUID gSpecificDataGuid = EFI_STATUS_CODE_SPECIFIC_DATA_GUID; + + +//********************************************************************** +// Status Code Library (functions used throughout the module) +//********************************************************************** +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: FindByteCode +// +// Description: Match "Value" to Map->Value and return Map->Byte. +// +// Input: +// STATUS_CODE_TO_BYTE_MAP *Map - Pointer to a table (array of structures) that maps status code value (EFI_STATUS_CODE_VALUE) to a byte (UINT8) domain specific value. +// EFI_STATUS_CODE_VALUE Value - status code to map +// +// Output: +// UINT8 - domain specific mapping of the Value +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +UINT8 FindByteCode(STATUS_CODE_TO_BYTE_MAP *Map, EFI_STATUS_CODE_VALUE Value) +{ + while (Map->Value!=0) + { + if (Map->Value==Value) + { + return Map->Byte; + } + + Map++; + } + + return 0; +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: ReportAssertString +// +// Description: This function creates a string from the ASSERT data +// +// Input: +// IN EFI_STATUS_CODE_DATA *Data - Pointer to the beginning of the ASSERT data +// OUT UINT8 *String - Pointer to the beginning of a byte String array +// +// Output: *String - Contains information from the ASSERT data +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +EFI_STATUS ReportAssertString(IN EFI_STATUS_CODE_DATA *Data, OUT UINT8 *String) +{ + EFI_DEBUG_ASSERT_DATA *AssertData; + CHAR8 *FileName; + UINT32 LineNum; + CHAR8 *Desc; + + // gather the data for the different parts of the Assert Info + AssertData = (EFI_DEBUG_ASSERT_DATA *)Data; + +// TODO: Change this to use the FileName member of the data structure +// be aware that the FileName member is another data structure + // get filename +// FileName = AssertData->FileName.String; + FileName = (CHAR8 *) (AssertData + 1); + + // get line number + LineNum = AssertData->LineNumber; + +// TODO: Change this to use the FileNameSize in the Data Structure. +// Intel does not fill this in their worker function, so it is a junk value + + // get description +// Desc = Filename + AssertData->FileNameSize; + Desc = FileName + Strlen(FileName) + 1; + + Sprintf_s(String, EFI_MAX_STRING_LENGTH, "ASSERT: %s, (%d) - %s", FileName, LineNum, Desc); + return EFI_SUCCESS; +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: ReportData +// +// Description: This function creates a string for error types that have not +// been predefined by the spec. This string contains the information in +// the Type and Value parameters. +// +// Input: +// IN EFI_STATUS_CODE_TYPE Type - Contains the type and severity of the error +// IN EFI_STATUS_CODE_VALUE Value - Contains the Class, SubClass, and Operation that caused +// the error +// IN EFI_STATUS_CODE_DATA *Data - Data field that contains strings and values to be reported +// OUT UINT8 *String - Pointer to the beginning of a byte String array +// +// Output: EFI_STATUS +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +EFI_STATUS ReportData( + IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value, + IN EFI_STATUS_CODE_DATA *Data, OUT UINT8 *String +) +{ + if (STATUS_CODE_TYPE(Type)!=EFI_ERROR_CODE) return EFI_UNSUPPORTED; + + Sprintf_s( + String, EFI_MAX_STRING_LENGTH, + "ERROR: Type:%X; Severity:%X; Class:%X; Subclass:%X; Operation: %X\n", + Type&0xFF, Type>>24, Value >> 24, (Value >> 16)& 0xFF, Value & 0xFFFF + ); + return EFI_SUCCESS; +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: ReportDebugInfo +// +// Description: This function creates a string from the debug informatoin packaged into +// Intel-specific(not defined in the standard spec) EFI_DEBUG_INFO structure. +// +// Input: IN EFI_STATUS_CODE_DATA *Data - Pointer to the beginning of the ASSERT data +// +// Output: OUT UINT8 *String - Contains information in the ASSERT data +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +EFI_STATUS ReportDebugInfo(IN EFI_STATUS_CODE_DATA *Data, OUT UINT8 *String) +{ + va_list Marker; + CHAR8 *Format; + EFI_DEBUG_INFO *DebugInfo = (EFI_DEBUG_INFO *)(Data + 1); + + // The first 12 * UINTN bytes of the string are really an + // argument stack to support varargs on the Format string. + Marker = (va_list) (DebugInfo + 1); + Format = (CHAR8 *)(((UINT64 *)Marker) + 12); + + Sprintf_s_va_list(String, EFI_MAX_STRING_LENGTH, Format, Marker); + return EFI_SUCCESS; +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: CreateString +// +// Description: This function converts the Type, Value, and Data into a string +// that can be easily output to any console: serial, screen, data storage, etc. +// +// Input: +// IN EFI_STATUS_CODE_TYPE Type - Contains the type and severity of the error +// IN EFI_STATUS_CODE_VALUE Value - Contains the Class, SubClass, and Operation that caused +// the error +// IN EFI_STATUS_CODE_DATA *Data - Data field that contains strings and values to be reported +// OUT UINT8 *String - Pointer to the beginning of a byte String array +// +// Output: EFI_STATUS +// *String - points to the string that was created +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +EFI_STATUS CreateString( + IN EFI_STATUS_CODE_TYPE Type, + IN EFI_STATUS_CODE_VALUE Value, + IN EFI_STATUS_CODE_DATA *Data, + OUT UINT8 *String +) +{ + EFI_STATUS_CODE_STRING_DATA *StrData; + CHAR8 *StrAscii; + CHAR16 *StrUnicode; + UINT16 Count = 0; + + if (Data != NULL) + { + // Check to see if the optional Data parameter is a standard string or + // if it is a more complex data structure + if (!guidcmp(&(Data->Type), &gDataTypeStringGuid)) + { + // set pointers to different parts of the data structure for + // easier access to the data it contains + StrData = ( EFI_STATUS_CODE_STRING_DATA *)Data; + + // Set up pointer to the beginning of both parts of the union + StrAscii = StrData->String.Ascii; + StrUnicode = StrData->String.Unicode; + + // check for end of string or max length of output string + while ( ( ((StrData->StringType == EfiStringAscii) + && (*StrAscii != '\0')) + || ((StrData->StringType == EfiStringUnicode) + && (*StrUnicode != '\0')) ) + && (Count < (EFI_MAX_STRING_LENGTH -1)) + ) + { + if (StrData->StringType == EfiStringAscii) + { + String[Count++] = *(StrAscii++); + } + + else if (StrData->StringType == EfiStringUnicode) + { + String[Count] = (UINT8)(*(StrUnicode++)); + // advance to the next character in the string + Count+=2; + } + + else + { + return EFI_UNSUPPORTED; + } + } + + String[Count] = '\0'; + return EFI_SUCCESS; + } + + else if ( !guidcmp (&Data->Type, &gEfiStatusCodeDataTypeDebugGuid) ) + { + ReportDebugInfo(Data, String); + } + + else if (!guidcmp(&(Data->Type), &gSpecificDataGuid)) + { + // This checks for an assert statement. Make a string of the data + // field + if ( ((Type & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) + && ((Type & EFI_STATUS_CODE_SEVERITY_MASK) == EFI_ERROR_UNRECOVERED) + && ((Value & EFI_STATUS_CODE_OPERATION_MASK)== EFI_SW_EC_ILLEGAL_SOFTWARE_STATE) + && (Data != NULL) + ) + { + ReportAssertString(Data, String); + } + + else + { + ReportData(Type, Value, Data, String); + } + } + + else if ( !guidcmp (&Data->Type, &gEfiStatusCodeDataTypeAssertGuid) ) + { + //this is Intel specific GUID + //we have to use Data+1 because of Intel specific bug + ReportAssertString(Data+1, String); + } + + else + { + ReportData(Type, Value, Data, String); + } + } + + else // if (Data != NULL) + { + // If Data is NULL just report required data + ReportData(Type, Value, NULL, String); + } + + return EFI_SUCCESS; +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: Halt +// +// Description: Error Code Action. +// Halts the execution. +// +// Input: +// VOID *PeiServices - not used +// EFI_STATUS_CODE_VALUE Value - Value of the error code that triggered the action. +// +// Output: +// VOID +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +VOID Halt( + IN VOID *PeiServices, IN EFI_STATUS_CODE_VALUE Value +) +{ + EFI_DEADLOOP(); +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: ResetOrHalt +// +// Description: Error Code Action. +// Attempts to perform a system reset. If reset fails, halts the execution (calls Halt function). +// +// Input: +// VOID *PeiServices - not used +// EFI_STATUS_CODE_VALUE Value - Value of the error code that triggered the action. +// +// Output: +// VOID +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +VOID ResetOrHalt( + IN VOID *PeiServices, IN EFI_STATUS_CODE_VALUE Value +) +{ + ResetOrResume(PeiServices,Value); + Halt(PeiServices, Value); +} + +//********************************************************************** +// Status Code Initialization +//********************************************************************** +typedef EFI_STATUS (INIT_FUNCTION)(IN VOID *ImageHandler, IN VOID *ServicesTable); +typedef EFI_STATUS (STRING_FUNCTION)(IN VOID *PeiServices, IN CHAR8 *String); +typedef EFI_STATUS (SIMPLE_FUNCTION)( + IN VOID *PeiServices, + IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value +); +typedef EFI_STATUS (MISC_FUNCTION)( + IN VOID *PeiServices, + IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value, + IN UINT32 Instance, IN EFI_GUID *CallerId OPTIONAL, + IN EFI_STATUS_CODE_DATA *Data OPTIONAL +); +typedef VOID (CHECKPOINT_FUNCTION)(IN VOID *PeiServices, IN UINT8 Checkpoint); + +EFI_STATUS DummyInitHandler(IN VOID *ImageHandler, IN VOID *ServicesTable) {return EFI_SUCCESS;} +EFI_STATUS DummyStringHandler(IN VOID *PeiServices, IN CHAR8 *String) {return EFI_SUCCESS;} +EFI_STATUS DummySimpleHandler( + IN VOID *PeiServices, + IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value +) {return EFI_SUCCESS;} +EFI_STATUS DummyMiscHandler( + IN VOID *PeiServices, + IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value, + IN UINT32 Instance, IN EFI_GUID *CallerId OPTIONAL, + IN EFI_STATUS_CODE_DATA *Data OPTIONAL +) {return EFI_SUCCESS;} +VOID DummyCheckpointHandler(IN VOID *PeiServices, IN UINT8 Checkpoint) {} + +#define DUMMY_HANDLER DummyInitHandler +extern INIT_FUNCTION INIT_LIST EndOfInitList; +INIT_FUNCTION* InitPartsList[] = {INIT_LIST NULL}; +#undef DUMMY_HANDLER + +#define DUMMY_HANDLER DummyStringHandler +extern STRING_FUNCTION STRING_LIST EndOfStringList; +STRING_FUNCTION* StringList[] = {STRING_LIST NULL}; +#undef DUMMY_HANDLER + +#define DUMMY_HANDLER DummySimpleHandler +extern SIMPLE_FUNCTION SIMPLE_LIST EndOfSimpleList; +SIMPLE_FUNCTION* SimpleList[] = {SIMPLE_LIST NULL}; +#undef DUMMY_HANDLER + +#define DUMMY_HANDLER DummyMiscHandler +extern MISC_FUNCTION MISC_LIST EndOfMiscList; +MISC_FUNCTION* MiscList[] = {MISC_LIST NULL}; +#undef DUMMY_HANDLER + +#define DUMMY_HANDLER DummyCheckpointHandler +extern CHECKPOINT_FUNCTION CHECKPOINT_LIST EndOfCheckpointList; +CHECKPOINT_FUNCTION* CheckpointList[] = {CHECKPOINT_LIST NULL}; +#undef DUMMY_HANDLER + +typedef STATUS_CODE_TO_BYTE_MAP STATUS_CODE_TO_BYTE_MAP_ARRAY[]; + +extern STATUS_CODE_TO_BYTE_MAP_ARRAY +CHECKPOINT_PROGRESS_CODES_MAP, CHECKPOINT_ERROR_CODES_MAP, +BEEP_PROGRESS_CODES_MAP, BEEP_ERROR_CODES_MAP +; + +STATUS_CODE_TO_BYTE_MAP* CheckPointStatusCodes[] = +{ + //#define EFI_PROGRESS_CODE 0x00000001 + CHECKPOINT_PROGRESS_CODES_MAP, + //#define EFI_ERROR_CODE 0x00000002 + CHECKPOINT_ERROR_CODES_MAP + //#define EFI_DEBUG_CODE 0x00000003 +}; + +STATUS_CODE_TO_BYTE_MAP* BeepStatusCodes[] = +{ + //#define EFI_PROGRESS_CODE 0x00000001 + BEEP_PROGRESS_CODES_MAP, + //#define EFI_ERROR_CODE 0x00000002 + BEEP_ERROR_CODES_MAP + //#define EFI_DEBUG_CODE 0x00000003 +}; + +#define ERROR_ACTION(Value,Action) Action +#ifdef PEI_STATUS_CODE +extern ERROR_CODE_ACTION PEI_ERROR_CODE_ACTIONS EndOfActionList; +#else +extern ERROR_CODE_ACTION DXE_ERROR_CODE_ACTIONS EndOfActionList; +#endif +#undef ERROR_ACTION +#define ERROR_ACTION(Value,Action) {Value,&Action} + +ERROR_CODE_ACTION_MAP ErrorCodeActions[] = +{ +#ifdef PEI_STATUS_CODE + PEI_ERROR_CODE_ACTIONS +#endif +#ifdef DXE_STATUS_CODE + DXE_ERROR_CODE_ACTIONS +#endif + {0,0} +}; + + +#undef PEI +#undef DXE +#undef RUNTIME + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: InitStatusCodeParts +// +// Description: calls initialization routines of status code subcomponents +// registered under StatusCodeInitialize eLink. +// +// Input: +// IN VOID *ImageHandler +// IN VOID *ServicesTable +// +// Output: VOID +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +VOID InitStatusCodeParts(IN VOID *ImageHandler, IN VOID *ServicesTable) +{ + UINTN i; + + for (i=0; InitPartsList[i]; i++) InitPartsList[i](ImageHandler,ServicesTable); +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: StringStatusReport +// +// Description: Calls the string satus code handlers registered under ReportStringStatus eLink. +// +// Input: +// IN EFI_FFS_FILE_HEADER *FfsHeader +// IN CHAR8 *String +// +// Output: VOID +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +VOID StringStatusReport(IN VOID *PeiServices, IN CHAR8 *String) +{ + UINTN i; + + for (i=0; StringList[i]; i++) StringList[i](PeiServices,String); +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: SimpleStatusReport +// +// Description: Calls simple status code handlers registered under ReportSimpleStatus eLink +// +// Input: +// IN EFI_PEI_SERVICES *PeiServices - pointer to Pei Services +// IN EFI_STATUS_CODE_TYPE Type - Contains the type and severity of the error +// IN EFI_STATUS_CODE_VALUE Value - Contains the Class, SubClass, and Operation that caused +// the error +// +// Output: VOID +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +VOID SimpleStatusReport( + IN VOID *PeiServices, + IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value +) +{ + UINTN i; + + for (i=0; SimpleList[i]; i++) SimpleList[i](PeiServices,Type,Value); +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: MiscStatusReport +// +// Description: Calls Misc. status code handlers +// (handlers that consume all available status code data) +// registered under ReportMiscStatus eLink +// +// Input: +// IN EFI_PEI_SERVICES *PeiServices - pointer to Pei Services +// IN EFI_STATUS_CODE_TYPE Type - Contains the type and severity of the error +// IN EFI_STATUS_CODE_VALUE Value - Contains the Class, SubClass, and Operation that caused +// the error +// IN UINT32 Instance - Instance +// IN EFI_GUID *CallerId OPTIONAL - The GUID of the caller function +// IN EFI_STATUS_CODE_DATA *Data OPTIONAL - the extended data field that contains additional info +// +// Output: VOID +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +VOID MiscStatusReport( + IN VOID *PeiServices, + IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value, + IN UINT32 Instance, IN EFI_GUID *CallerId OPTIONAL, + IN EFI_STATUS_CODE_DATA *Data OPTIONAL +) +{ + UINTN i; + + for (i=0; MiscList[i]; i++) MiscList[i](PeiServices,Type,Value,Instance,CallerId,Data); +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: CheckpointStatusReport +// +// Description: Calls checkpoint status code handlers registered under ReportCheckpoint eLink. +// +// Input: +// IN EFI_PEI_SERVICES *PeiServices - pointer to Pei Services +// IN UINT8 Checkpoint - checkpoint +// +// Output: VOID +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +VOID CheckpointStatusReport(IN VOID *PeiServices, IN UINT8 Checkpoint) +{ + UINTN i; + + for (i=0; CheckpointList[i]; i++) CheckpointList[i](PeiServices,Checkpoint); +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: PerformErrorCodeAction +// +// Description: +// Scans list of error actions defined by the PeiErrorCodeActions/DxeErrorCodeActions lists. +// If action corresponding to the passed in Value is found, performs the action. +// +// Input: +// IN EFI_PEI_SERVICES *PeiServices - pointer to Pei Services +// IN EFI_STATUS_CODE_TYPE Type - Contains the type and severity of the error +// IN EFI_STATUS_CODE_VALUE Value - Contains the Class, SubClass, and Operation that caused +// the error +// +// Output: VOID +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +VOID PerformErrorCodeAction( + IN VOID *PeiServices, + IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value +) +{ + ERROR_CODE_ACTION_MAP *Map = ErrorCodeActions; + + while (Map->Value!=0) + { + if (Map->Value==Value) + { + if (Map->Action!=NULL) + { + Map->Action(PeiServices,Value); + return; + } + } + + Map++; + } +} + +#if PI_SPECIFICATION_VERSION >= 0x00010014 + +BOOLEAN IsItRecursiveCall ( + IN OUT BOOLEAN *Value, + IN BOOLEAN CompareWith, + IN BOOLEAN SvitchTo + ) +{ + if (*Value == CompareWith) + { + *Value = SvitchTo; + return CompareWith; + } + else return *Value; + +} + +#ifndef PEI_STATUS_CODE +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: ReportDxeAndRtRouter +// +// Description: +// Top level status code reporting routine exposed by the status code protocol/PPI. +// Calls the various types of status code handlers +// (SimpleStatusReport, StringStatusReport, MiscStatusReport, PerformErrorCodeAction) +// Generates string from the status code data to pass to StringStatusReport function. +// +// Input: +// IN VOID *PeiServices - pointer to the PEI Boot Services table +// IN EFI_STATUS_CODE_TYPE Type - the type and severity of the error that occurred +// IN EFI_STATUS_CODE_VALUE Value - the Class, subclass and Operation that caused the error +// IN UINT32 Instance - +// IN EFI_GUI *CallerId OPTIONAL - The GUID of the caller function +// IN EFI_STATUS_CODE_DATA *Data OPTIONAL - the extended data field that contains additional info +// +// Output: EFI_STATUS +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +EFI_STATUS ReportDxeAndRtRouter ( + IN EFI_STATUS_CODE_TYPE Type, + IN EFI_STATUS_CODE_VALUE Value, + IN UINT32 Instance, + IN EFI_GUID *CallerId OPTIONAL, + IN EFI_STATUS_CODE_DATA *Data OPTIONAL + ) +{ + + RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry; + RSC_DATA_ENTRY *RscData; + EFI_STATUS Status; + VOID *NewBuffer = NULL, *Ptr; + EFI_TPL CurrentTpl = TPL_HIGH_LEVEL; + UINT32 i; + + if ((RouterCallbackStr == NULL) || (IsItRecursiveCall (&RouterRecurciveStatus, FALSE, TRUE) == TRUE)) + return EFI_ACCESS_DENIED; + for (i = 0; i != RouterCallbackStr->RegisteredEntries; i++) + { + + if (i == 0) + Ptr = (UINT8*) RouterCallbackStr + sizeof (ROUTER_STRUCT_HEADER); + else + Ptr = (UINT8*) Ptr + sizeof (RSC_HANDLER_CALLBACK_ENTRY); + CallbackEntry = Ptr; + + if (CallbackEntry->RscHandlerCallback == NULL) continue;//Unregistered function + + if (!StatusRuntime) + { + CurrentTpl = pBS->RaiseTPL (TPL_HIGH_LEVEL); + pBS->RestoreTPL (CurrentTpl); + } + + if ((CallbackEntry->Tpl >= CurrentTpl) || StatusRuntime) + { + CallbackEntry->RscHandlerCallback (Type, Value, Instance, CallerId, Data); + continue; + } + + + // If callback is registered with TPL lower than TPL_HIGH_LEVEL, event must be signaled at boot time to possibly wait for + // allowed TPL to report status code. Related data should also be stored in data buffer. + + RscData = (RSC_DATA_ENTRY *) (UINTN) CallbackEntry->EndPointer; + CallbackEntry->EndPointer += sizeof (RSC_DATA_ENTRY); + if (Data != NULL) + CallbackEntry->EndPointer += Data->Size; + + + // If data buffer is about to be used up (7/8 here), try to reallocate a buffer with double size, if not at TPL_HIGH_LEVEL. + + if (CallbackEntry->EndPointer > (CallbackEntry->StatusCodeDataBuffer + (CallbackEntry->BufferSize / 8) * 7)) + { + if ((CurrentTpl < TPL_HIGH_LEVEL) && !InRscHandlerNotification) + { + Status = pBS->AllocatePool (EfiRuntimeServicesData, CallbackEntry->BufferSize * 2, &NewBuffer); + //ASSERT_EFI_ERROR (Status); + if (NewBuffer != NULL && CallbackEntry->StatusCodeDataBuffer != NULL) + { + pBS->SetMem(NewBuffer, CallbackEntry->BufferSize * 2, 0); + MemCpy (NewBuffer, (VOID*)CallbackEntry->StatusCodeDataBuffer, CallbackEntry->BufferSize); + pBS->FreePool ((VOID *) (UINTN) CallbackEntry->StatusCodeDataBuffer); + } + + if (NewBuffer != NULL) + { + CallbackEntry->EndPointer = (EFI_PHYSICAL_ADDRESS) (UINTN) NewBuffer + (CallbackEntry->EndPointer - CallbackEntry->StatusCodeDataBuffer); + CallbackEntry->StatusCodeDataBuffer = (EFI_PHYSICAL_ADDRESS) (UINTN) NewBuffer; + CallbackEntry->BufferSize *= 2; + } + } + } + + + // If data buffer is used up, do not report for this time. + + if (CallbackEntry->EndPointer > (CallbackEntry->StatusCodeDataBuffer + CallbackEntry->BufferSize)) + continue; + + RscData->Type = Type; + RscData->Value = Value; + RscData->Instance = Instance; + if (CallerId != NULL) + MemCpy (&RscData->CallerId, CallerId, sizeof (EFI_GUID)); + + if (Data != NULL) + MemCpy (&RscData->Data, Data, Data->HeaderSize + Data->Size); + + Status = pBS->SignalEvent (CallbackEntry->Event); + + } + // Restore the Recursive status of report + + IsItRecursiveCall (&RouterRecurciveStatus, TRUE, FALSE); + return EFI_SUCCESS; +} +#endif +#endif +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: ReportStatusCode +// +// Description: +// Top level status code reporting routine exposed by the status code protocol/PPI. +// Calls the various types of status code handlers +// (SimpleStatusReport, StringStatusReport, MiscStatusReport, PerformErrorCodeAction) +// Generates string from the status code data to pass to StringStatusReport function. +// +// Input: +// IN VOID *PeiServices - pointer to the PEI Boot Services table +// IN EFI_STATUS_CODE_TYPE Type - the type and severity of the error that occurred +// IN EFI_STATUS_CODE_VALUE Value - the Class, subclass and Operation that caused the error +// IN UINT32 Instance - +// IN EFI_GUI *CallerId OPTIONAL - The GUID of the caller function +// IN EFI_STATUS_CODE_DATA *Data OPTIONAL - the extended data field that contains additional info +// +// Output: EFI_STATUS +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +EFI_STATUS ReportStatusCode ( + IN VOID *PeiServices, + IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value, + IN UINT32 Instance, IN EFI_GUID *CallerId OPTIONAL, + IN EFI_STATUS_CODE_DATA *Data OPTIONAL +) +{ +#if STRING_STATUS_SUPPORT + UINT8 String[EFI_MAX_STRING_LENGTH]; +#endif + SimpleStatusReport(PeiServices,Type,Value); +#if STRING_STATUS_SUPPORT + String[0] = '\0'; + CreateString(Type, Value, Data, String); + + // step through the useable data and display information as needed + // Serial data + if (String[0] != '\0') StringStatusReport(PeiServices,String); + +#endif + MiscStatusReport(PeiServices,Type,Value,Instance,CallerId,Data); + + if (STATUS_CODE_TYPE(Type)==EFI_ERROR_CODE) + PerformErrorCodeAction(PeiServices,Type,Value); +#ifndef PEI_STATUS_CODE +#if PI_SPECIFICATION_VERSION >= 0x00010014 + if ((PeiServices == NULL) && !SmmRouter) + ReportDxeAndRtRouter(Type, Value, Instance, CallerId, Data); +#endif +#endif + return EFI_SUCCESS; +} + +//********************************************************************** +// Status Code Transports +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: Port80Checkpoint +// +// Description: Outputs checkpoint value to port 0x80 +// To support different checkpoint displaying hardware do not port this function. +// Use ReportCheckpoint eLink based interface instead. +// +// Input: +// VOID *PeiServices - pointer to the PEI Boot Services table, +// IN UINTN Checkpoint - checkpoint to display +// +// Output: +// EFI_STATUS +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +VOID Port80Checkpoint(IN VOID *PeiServices, IN UINT8 Checkpoint) +{ + checkpoint(Checkpoint); +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: CheckPointStatus +// +// Description: +// Looks up the checkpoint for the given status code Type +// and Value and calls CheckpointStatusReport function to invoke all checkpoint handlers. +// +// Input: +// IN VOID *PeiServices - pointer to the PEI Boot Services table +// IN EFI_STATUS_CODE_TYPE Type - the type and severity of the error that occurred +// IN EFI_STATUS_CODE_VALUE Value - the Class, subclass and Operation that caused the error +// +// Output: +// EFI_STATUS +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +EFI_STATUS CheckPointStatus( + IN VOID *PeiServices, + IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value +) +{ + UINT8 n; + UINT32 CodeTypeIndex = STATUS_CODE_TYPE(Type) - 1; + + if (CodeTypeIndex >= sizeof(CheckPointStatusCodes)/sizeof(STATUS_CODE_TO_BYTE_MAP*) ) + return EFI_SUCCESS; + + n=FindByteCode(CheckPointStatusCodes[CodeTypeIndex],Value); + + if (n>0) CheckpointStatusReport(PeiServices,n); + + return EFI_SUCCESS; +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: BeepOn +// +// Description: Initiates generation of the sound corresponding +// to the passed in musical note/octave pair using legacy PC/AT speaker. +// +// Input: +// UINT8 note - a note to play +// UINT8 octave - an octave for the note +// +// Output: +// VOID +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +VOID BeepOn(UINT8 note, UINT8 octave) +{ + // beep tones +#define note(x) ((119318200+(x)/2)/(x)) + UINT16 tones[8]={note(26163),note(29366),note(32963),note(34923),note(39200),note(44000),note(49388),note(26163*2)}; + UINT16 Frequency=tones[(note%8)]; + + if (octave-1>=0) Frequency>>=octave-1; + else Frequency<<=1-octave; + + //set up channel 1 (used for delays) + IoWrite8(0x43,0x54); + IoWrite8(0x41,0x12); + //set up channel 2 (used by speaker) + IoWrite8(0x43,0xb6); + IoWrite8(0x42,(UINT8)Frequency); + IoWrite8(0x42,(UINT8)(Frequency>>8)); + //turn the speaker on + IoWrite8(0x61,IoRead8(0x61)|3); +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: BeepOff +// +// Description: Stops generation of the legacy PC/AT speaker sound started by the BeepOn routine. +// +// Input: +// VOID +// +// Output: +// VOID +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +VOID BeepOff() +{ + IoWrite8(0x61,IoRead8(0x61)&0xfc); +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: Beep +// +// Description: Generates sound of the specified duration corresponding +// to the passed in musical note/octave pair using legacy PC/AT speaker. +// Control flow: +// BeepOn +// Delay +// BeepOff +// +// Input: +// VOID *PeiServices - pointer to the PEI Boot Services table +// UINT8 note - a note to play +// UINT8 octave - an octave for the note +// UINT32 duration - sound duration in microseconds. +// +// Output: +// VOID +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +VOID Beep(VOID *PeiServices, UINT8 note, UINT8 octave, UINT32 duration) +{ + BeepOn(note,octave); + Delay(PeiServices, duration); + BeepOff(); +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: BeepStatus +// +// Description: Simple Status Code handler that generates beep codes for a certain types of +// progress and error codes defined by the BEEP_PROGRESS_CODES_MAP and BEEP_ERROR_CODES_MAP mapping tables. +// +// Input: +// EFI_PEI_SERVICES *PeiServices, - pointer to the PEI Boot Services table +// IN EFI_STATUS_CODE_TYPE Type - the type and severity of the error that occurred +// IN EFI_STATUS_CODE_VALUE Value - the Class, subclass and Operation that caused the error +// +// Output: +// EFI_STATUS +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +EFI_STATUS BeepStatus( + IN VOID *PeiServices, + IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value +) +{ + UINT32 CodeTypeIndex = STATUS_CODE_TYPE(Type) - 1; + UINT8 i,n; + + if (CodeTypeIndex >= sizeof(BeepStatusCodes)/sizeof(STATUS_CODE_TO_BYTE_MAP*) ) return EFI_SUCCESS; + + n = FindByteCode(BeepStatusCodes[CodeTypeIndex],Value); + + if (n>0) + { + for (i=0; i<n; i++) + { + Beep(PeiServices,1,2,400000); + Delay(PeiServices,100000); + } + } + + return EFI_SUCCESS; +} + +//<AMI_PHDR_START> +//---------------------------------------------------------------------------- +// Procedure: BeepService +// +// Description: +// This function plays Value quantity of beeps +// +// Input: +// IN VOID *PeiServices - pointer to the PEI Boot Services table +// IN EFI_STATUS_CODE_TYPE Type - the type and severity of the error that occurred +// IN EFI_STATUS_CODE_VALUE Value - the Class, subclass and Operation that caused the error +// IN UINT32 Instance - +// IN EFI_GUI *CallerId OPTIONAL - The GUID of the caller function +// IN EFI_STATUS_CODE_DATA *Data OPTIONAL - the extended data field that contains additional info +// +// Output: EFI_STATUS +// +//---------------------------------------------------------------------------- +//<AMI_PHDR_END> +EFI_STATUS BeepService( + IN VOID *PeiServices, + IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value, + IN UINT32 Instance, IN EFI_GUID *CallerId OPTIONAL, + IN EFI_STATUS_CODE_DATA *Data OPTIONAL +) +{ + UINT8 n; + + if ((Value&0xFF00)!=AMI_STATUS_CODE_BEEP_CLASS) return EFI_SUCCESS; + + n = (UINT8)Value; + + if (n) + { + UINT8 i; + + for (i=0; i<n; i++) { Beep(PeiServices,0,4,40000); Delay(PeiServices,100000);} + } + + return EFI_SUCCESS; +} +//********************************************************************** +//********************************************************************** +//** ** +//** (C)Copyright 1985-2011, American Megatrends, Inc. ** +//** ** +//** All Rights Reserved. ** +//** ** +//** 5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093 ** +//** ** +//** Phone: (770)-246-8600 ** +//** ** +//********************************************************************** +//**********************************************************************
\ No newline at end of file |