EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index
Functions | Variables

EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Library/SmmRuntimeDxeReportStatusCodeLib/ReportStatusCodeLib.c File Reference

#include "ReportStatusCodeLibInternal.h"

Go to the source code of this file.

Functions

EFI_STATUS InternalReportStatusCode (IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value, IN UINT32 Instance, IN CONST EFI_GUID *CallerId OPTIONAL, IN EFI_STATUS_CODE_DATA *Data OPTIONAL)
UINTN InternalReportStatusCodeDevicePathSize (IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath)
BOOLEAN EFIAPI GlueCodeTypeToPostCode (IN EFI_STATUS_CODE_TYPE CodeType, IN EFI_STATUS_CODE_VALUE Value, OUT UINT8 *PostCode)
BOOLEAN EFIAPI GlueReportStatusCodeExtractAssertInfo (IN EFI_STATUS_CODE_TYPE CodeType, IN EFI_STATUS_CODE_VALUE Value, IN CONST EFI_STATUS_CODE_DATA *Data, OUT CHAR8 **Filename, OUT CHAR8 **Description, OUT UINT32 *LineNumber)
BOOLEAN EFIAPI GlueReportStatusCodeExtractDebugInfo (IN CONST EFI_STATUS_CODE_DATA *Data, OUT UINT32 *ErrorLevel, OUT VA_LIST *Marker, OUT CHAR8 **Format)
EFI_STATUS EFIAPI GlueReportStatusCode (IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value)
EFI_STATUS EFIAPI GlueReportStatusCodeWithDevicePath (IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value, IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath)
EFI_STATUS EFIAPI GlueReportStatusCodeWithExtendedData (IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value, IN CONST VOID *ExtendedData, IN UINTN ExtendedDataSize)
EFI_STATUS EFIAPI GlueReportStatusCodeEx (IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value, IN UINT32 Instance, IN CONST EFI_GUID *CallerId OPTIONAL, IN CONST EFI_GUID *ExtendedDataGuid OPTIONAL, IN CONST VOID *ExtendedData OPTIONAL, IN UINTN ExtendedDataSize)
BOOLEAN EFIAPI GlueReportProgressCodeEnabled (VOID)
BOOLEAN EFIAPI GlueReportErrorCodeEnabled (VOID)
BOOLEAN EFIAPI GlueReportDebugCodeEnabled (VOID)

Variables

EFI_REPORT_STATUS_CODE mReportStatusCode = NULL

Function Documentation

BOOLEAN EFIAPI GlueCodeTypeToPostCode ( IN EFI_STATUS_CODE_TYPE  CodeType,
IN EFI_STATUS_CODE_VALUE  Value,
OUT UINT8 PostCode 
)

Converts a status code to an 8-bit POST code value.

Converts the status code specified by CodeType and Value to an 8-bit POST code and returns the 8-bit POST code in PostCode. If CodeType is an EFI_PROGRESS_CODE or CodeType is an EFI_ERROR_CODE, then bits 0..4 of PostCode are set to bits 16..20 of Value, and bits 5..7 of PostCode are set to bits 24..26 of Value., and TRUE is returned. Otherwise, FALSE is returned.

If PostCode is NULL, then ASSERT().

Parameters:
CodeTypeThe type of status code being converted.
ValueThe status code value being converted.
PostCodeA pointer to the 8-bit POST code value to return.
Return values:
TRUEThe status code specified by CodeType and Value was converted to an 8-bit POST code and returned in PostCode.
FALSEThe status code specified by CodeType and Value could not be converted to an 8-bit POST code value.

Definition at line 132 of file ReportStatusCodeLib.c.

BOOLEAN EFIAPI GlueReportDebugCodeEnabled ( VOID  )

Returns TRUE if status codes of type EFI_DEBUG_CODE are enabled

This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.

Return values:
TRUEThe REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is set.
FALSEThe REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is clear.

Definition at line 557 of file ReportStatusCodeLib.c.

BOOLEAN EFIAPI GlueReportErrorCodeEnabled ( VOID  )

Returns TRUE if status codes of type EFI_ERROR_CODE are enabled

This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.

Return values:
TRUEThe REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is set.
FALSEThe REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is clear.

Definition at line 535 of file ReportStatusCodeLib.c.

BOOLEAN EFIAPI GlueReportProgressCodeEnabled ( VOID  )

Returns TRUE if status codes of type EFI_PROGRESS_CODE are enabled

This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.

Return values:
TRUEThe REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is set.
FALSEThe REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is clear.

Definition at line 513 of file ReportStatusCodeLib.c.

EFI_STATUS EFIAPI GlueReportStatusCode ( IN EFI_STATUS_CODE_TYPE  Type,
IN EFI_STATUS_CODE_VALUE  Value 
)

Reports a status code.

Reports the status code specified by the parameters Type and Value. Status code also require an instance, caller ID, and extended data. This function passed in a zero instance, NULL extended data, and a caller ID of gEfiCallerIdGuid, which is the GUID for the module.

ReportStatusCode()must actively prevent recusrsion. If ReportStatusCode() is called while processing another any other Report Status Code Library function, then ReportStatusCode() must return immediately.

Parameters:
TypeStatus code type.
ValueStatus code value.
Return values:
EFI_SUCCESSThe status code was reported.
EFI_DEVICE_ERRORThere status code could not be reported due to a device error.
EFI_UNSUPPORTEDReport status code is not supported

Definition at line 318 of file ReportStatusCodeLib.c.

EFI_STATUS EFIAPI GlueReportStatusCodeEx ( IN EFI_STATUS_CODE_TYPE  Type,
IN EFI_STATUS_CODE_VALUE  Value,
IN UINT32  Instance,
IN CONST EFI_GUID *CallerId  OPTIONAL,
IN CONST EFI_GUID *ExtendedDataGuid  OPTIONAL,
IN CONST VOID *ExtendedData  OPTIONAL,
IN UINTN  ExtendedDataSize 
)

Reports a status code with full parameters.

The function reports a status code. If ExtendedData is NULL and ExtendedDataSize is 0, then an extended data buffer is not reported. If ExtendedData is not NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated. ExtendedData is assumed not have the standard status code header, so this function is responsible for allocating a buffer large enough for the standard header and the extended data passed into this function. The standard header is filled in with a GUID specified by ExtendedDataGuid. If ExtendedDataGuid is NULL, then a GUID of gEfiStatusCodeSpecificDatauid is used. The status code is reported with an instance specified by Instance and a caller ID specified by CallerId. If CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.

ReportStatusCodeEx()must actively prevent recursion. If ReportStatusCodeEx() is called while processing another any other Report Status Code Library function, then ReportStatusCodeEx() must return EFI_DEVICE_ERROR immediately.

If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT(). If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().

Parameters:
TypeStatus code type.
ValueStatus code value.
InstanceStatus code instance number.
CallerIdPointer to a GUID that identifies the caller of this function. If this parameter is NULL, then a caller ID of gEfiCallerIdGuid is used.
ExtendedDataGuidPointer to the GUID for the extended data buffer. If this parameter is NULL, then a the status code standard header is filled in with gEfiStatusCodeSpecificDataGuid.
ExtendedDataPointer to the extended data buffer. This is an optional parameter that may be NULL.
ExtendedDataSizeThe size, in bytes, of the extended data buffer.
Return values:
EFI_SUCCESSThe status code was reported.
EFI_OUT_OF_RESOURCESThere were not enough resources to allocate the extended data section if it was specified.
EFI_UNSUPPORTEDReport status code is not supported

Definition at line 473 of file ReportStatusCodeLib.c.

BOOLEAN EFIAPI GlueReportStatusCodeExtractAssertInfo ( IN EFI_STATUS_CODE_TYPE  CodeType,
IN EFI_STATUS_CODE_VALUE  Value,
IN CONST EFI_STATUS_CODE_DATA Data,
OUT CHAR8 **  Filename,
OUT CHAR8 **  Description,
OUT UINT32 LineNumber 
)

Extracts ASSERT() information from a status code structure.

Converts the status code specified by CodeType, Value, and Data to the ASSERT() arguments specified by Filename, Description, and LineNumber. If CodeType is an EFI_ERROR_CODE, and CodeType has a severity of EFI_ERROR_UNRECOVERED, and Value has an operation mask of EFI_SW_EC_ILLEGAL_SOFTWARE_STATE, extract Filename, Description, and LineNumber from the optional data area of the status code buffer specified by Data. The optional data area of Data contains a Null-terminated ASCII string for the FileName, followed by a Null-terminated ASCII string for the Description, followed by a 32-bit LineNumber. If the ASSERT() information could be extracted from Data, then return TRUE. Otherwise, FALSE is returned.

If Data is NULL, then ASSERT(). If Filename is NULL, then ASSERT(). If Description is NULL, then ASSERT(). If LineNumber is NULL, then ASSERT().

Parameters:
CodeTypeThe type of status code being converted.
ValueThe status code value being converted.
DataPointer to status code data buffer.
FilenamePointer to the source file name that generated the ASSERT().
DescriptionPointer to the description of the ASSERT().
LineNumberPointer to source line number that generated the ASSERT().
Return values:
TRUEThe status code specified by CodeType, Value, and Data was converted ASSERT() arguments specified by Filename, Description, and LineNumber.
FALSEThe status code specified by CodeType, Value, and Data could not be converted to ASSERT() arguments.

Definition at line 191 of file ReportStatusCodeLib.c.

BOOLEAN EFIAPI GlueReportStatusCodeExtractDebugInfo ( IN CONST EFI_STATUS_CODE_DATA Data,
OUT UINT32 ErrorLevel,
OUT VA_LIST Marker,
OUT CHAR8 **  Format 
)

Extracts DEBUG() information from a status code structure.

Converts the status code specified by Data to the DEBUG() arguments specified by ErrorLevel, Marker, and Format. If type GUID in Data is EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID, then extract ErrorLevel, Marker, and Format from the optional data area of the status code buffer specified by Data. The optional data area of Data contains a 32-bit ErrorLevel followed by Marker which is 12 UINTN parameters, followed by a Null-terminated ASCII string for the Format. If the DEBUG() information could be extracted from Data, then return TRUE. Otherwise, FALSE is returned.

If Data is NULL, then ASSERT(). If ErrorLevel is NULL, then ASSERT(). If Marker is NULL, then ASSERT(). If Format is NULL, then ASSERT().

Parameters:
DataPointer to status code data buffer.
ErrorLevelPointer to error level mask for a debug message.
MarkerPointer to the variable argument list associated with Format.
FormatPointer to a Null-terminated ASCII format string of a debug message.
Return values:
TRUEThe status code specified by Data was converted DEBUG() arguments specified by ErrorLevel, Marker, and Format.
FALSEThe status code specified by Data could not be converted to DEBUG() arguments.

Definition at line 251 of file ReportStatusCodeLib.c.

EFI_STATUS EFIAPI GlueReportStatusCodeWithDevicePath ( IN EFI_STATUS_CODE_TYPE  Type,
IN EFI_STATUS_CODE_VALUE  Value,
IN CONST EFI_DEVICE_PATH_PROTOCOL DevicePath 
)

Reports a status code with a Device Path Protocol as the extended data.

Allocates and fills in the extended data section of a status code with the Device Path Protocol specified by DevicePath. This function is responsible for allocating a buffer large enough for the standard header and the device path. The standard header is filled in with a GUID of gEfiStatusCodeSpecificDataGuid. The status code is reported with a zero instance and a caller ID of gEfiCallerIdGuid.

ReportStatusCodeWithDevicePath()must actively prevent recursion. If ReportStatusCodeWithDevicePath() is called while processing another any other Report Status Code Library function, then ReportStatusCodeWithDevicePath() must return EFI_DEVICE_ERROR immediately.

If DevicePath is NULL, then ASSERT().

Parameters:
TypeStatus code type.
ValueStatus code value.
DevicePathPointer to the Device Path Protocol to be reported.
Return values:
EFI_SUCCESSThe status code was reported with the extended data specified by DevicePath.
EFI_OUT_OF_RESOURCESThere were not enough resources to allocate the extended data section.
EFI_UNSUPPORTEDReport status code is not supported

Definition at line 357 of file ReportStatusCodeLib.c.

EFI_STATUS EFIAPI GlueReportStatusCodeWithExtendedData ( IN EFI_STATUS_CODE_TYPE  Type,
IN EFI_STATUS_CODE_VALUE  Value,
IN CONST VOID *  ExtendedData,
IN UINTN  ExtendedDataSize 
)

Reports a status code with an extended data buffer.

Allocates and fills in the extended data section of a status code with the extended data specified by ExtendedData and ExtendedDataSize. ExtendedData is assumed to be one of the data structures specified in Related Definitions. These data structure do not have the standard header, so this function is responsible for allocating a buffer large enough for the standard header and the extended data passed into this function. The standard header is filled in with a GUID of gEfiStatusCodeSpecificDataGuid. The status code is reported with a zero instance and a caller ID of gEfiCallerIdGuid.

ReportStatusCodeWithExtendedData()must actively prevent recursion. If ReportStatusCodeWithExtendedData() is called while processing another any other Report Status Code Library function, then ReportStatusCodeWithExtendedData() must return EFI_DEVICE_ERROR immediately.

If ExtendedData is NULL, then ASSERT(). If ExtendedDataSize is 0, then ASSERT().

Parameters:
TypeStatus code type.
ValueStatus code value.
ExtendedDataPointer to the extended data buffer to be reported.
ExtendedDataSizeThe size, in bytes, of the extended data buffer to be reported.
Return values:
EFI_SUCCESSThe status code was reported with the extended data specified by ExtendedData and ExtendedDataSize.
EFI_OUT_OF_RESOURCESThere were not enough resources to allocate the extended data section.
EFI_UNSUPPORTEDReport status code is not supported

Definition at line 408 of file ReportStatusCodeLib.c.

EFI_STATUS InternalReportStatusCode ( IN EFI_STATUS_CODE_TYPE  Type,
IN EFI_STATUS_CODE_VALUE  Value,
IN UINT32  Instance,
IN CONST EFI_GUID *CallerId  OPTIONAL,
IN EFI_STATUS_CODE_DATA *Data  OPTIONAL 
)

Internal worker function that reports a status code through the Status Code Protocol

This function checks to see if a Status Code Protocol is present in the handle database. If a Status Code Protocol is not present, then EFI_UNSUPPORTED is returned. If a Status Code Protocol is present, then it is cached in gStatusCode, and the ReportStatusCode() service of the Status Code Protocol is called passing in Type, Value, Instance, CallerId, and Data. The result of this call is returned.

Parameters:
TypeStatus code type.
ValueStatus code value.
InstanceStatus code instance number.
CallerIdPointer to a GUID that identifies the caller of this function. This is an optional parameter that may be NULL.
DataPointer to the extended data buffer. This is an optional parameter that may be NULL.
Return values:
EFI_SUCCESSThe status code was reported.
EFI_OUT_OF_RESOURCESThere were not enough resources to report the status code.
EFI_UNSUPPORTEDStatus Code Protocol is not available.

Definition at line 52 of file ReportStatusCodeLib.c.

UINTN InternalReportStatusCodeDevicePathSize ( IN CONST EFI_DEVICE_PATH_PROTOCOL DevicePath)

Computes and returns the size, in bytes, of a device path.

Parameters:
DevicePathA pointer to a device path.
Returns:
The size, in bytes, of DevicePath.

Definition at line 88 of file ReportStatusCodeLib.c.


Variable Documentation

Definition at line 26 of file ReportStatusCodeLib.c.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines