StatusCodeHandlerPei.h File Reference

#include <Ppi/ReportStatusCodeHandler.h>
#include <Guid/MemoryStatusCodeRecord.h>
#include <Guid/StatusCodeDataTypeId.h>
#include <Guid/StatusCodeDataTypeDebug.h>
#include <Library/DebugLib.h>
#include <Library/PrintLib.h>
#include <Library/ReportStatusCodeLib.h>
#include <Library/SerialPortLib.h>
#include <Library/HobLib.h>
#include <Library/PcdLib.h>
#include <Library/PeiServicesLib.h>
#include <Library/PeimEntryPoint.h>
#include <Library/BaseMemoryLib.h>

Go to the source code of this file.

Macros
#define	MAX_DEBUG_MESSAGE_LENGTH   0x100

Functions
EFI_STATUS EFIAPI	SerialStatusCodeReportWorker (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)
EFI_STATUS	MemoryStatusCodeInitializeWorker (VOID)
EFI_STATUS EFIAPI	MemoryStatusCodeReportWorker (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)

Detailed Description

Internal include file for Status Code Handler PEIM.

Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file StatusCodeHandlerPei.h.

Macro Definition Documentation

MAX_DEBUG_MESSAGE_LENGTH

#define MAX_DEBUG_MESSAGE_LENGTH   0x100

Definition at line 31 of file StatusCodeHandlerPei.h.

Function Documentation

MemoryStatusCodeInitializeWorker()

EFI_STATUS MemoryStatusCodeInitializeWorker

(

VOID

)

Create the first memory status code GUID'ed HOB as initialization for memory status code worker.

Return values

EFI_SUCCESS

The GUID'ed HOB is created successfully.

Initialize MM memory status code table as initialization for memory status code worker

Return values

EFI_SUCCESS	MM memory status code table successfully initialized.
others	Errors from gMmst->MmInstallConfigurationTable().

Definition at line 18 of file MemoryStausCodeWorker.c.

MemoryStatusCodeReportWorker()

EFI_STATUS EFIAPI MemoryStatusCodeReportWorker	(	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
	)

Report status code into GUID'ed HOB.

This function reports status code into GUID'ed HOB. If not all packets are full, then write status code into available entry. Otherwise, create a new packet for it.

Parameters

PeiServices	An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
CodeType	Indicates the type of status code being reported.
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.
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.
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.
Data	This optional parameter may be used to pass additional data.

Return values

EFI_SUCCESS

The function always return EFI_SUCCESS.

Definition at line 71 of file MemoryStausCodeWorker.c.

SerialStatusCodeReportWorker()

EFI_STATUS EFIAPI SerialStatusCodeReportWorker	(	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
	)

Convert status code value and extended data to readable ASCII string, send string to serial I/O device.

Parameters

PeiServices	An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
CodeType	Indicates the type of status code being reported.
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.
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.
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.
Data	This optional parameter may be used to pass additional data.

Return values

EFI_SUCCESS

Status code reported to serial I/O successfully.

Definition at line 35 of file SerialStatusCodeWorker.c.