ReportStatusCodeLib.h File Reference

Macros
#define	REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED   0x00000001
#define	REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED   0x00000002
#define	REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED   0x00000004
#define	REPORT_STATUS_CODE(Type, Value)
#define	REPORT_STATUS_CODE_WITH_DEVICE_PATH(Type, Value, DevicePathParameter)
#define	REPORT_STATUS_CODE_WITH_EXTENDED_DATA(Type, Value, ExtendedData, ExtendedDataSize)
#define	REPORT_STATUS_CODE_EX(Type, Value, Instance, CallerId, ExtendedDataGuid, ExtendedData, ExtendedDataSize)

Functions
BOOLEAN EFIAPI	CodeTypeToPostCode (IN EFI_STATUS_CODE_TYPE CodeType, IN EFI_STATUS_CODE_VALUE Value, OUT UINT8 *PostCode)
BOOLEAN EFIAPI	ReportStatusCodeExtractAssertInfo (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	ReportStatusCodeExtractDebugInfo (IN CONST EFI_STATUS_CODE_DATA *Data, OUT UINT32 *ErrorLevel, OUT BASE_LIST *Marker, OUT CHAR8 **Format)
EFI_STATUS EFIAPI	ReportStatusCode (IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value)
EFI_STATUS EFIAPI	ReportStatusCodeWithDevicePath (IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value, IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath)
EFI_STATUS EFIAPI	ReportStatusCodeWithExtendedData (IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value, IN CONST VOID *ExtendedData, IN UINTN ExtendedDataSize)
EFI_STATUS EFIAPI	ReportStatusCodeEx (IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value, IN UINT32 Instance, IN CONST EFI_GUID *CallerId, IN CONST EFI_GUID *ExtendedDataGuid, IN CONST VOID *ExtendedData, IN UINTN ExtendedDataSize)
BOOLEAN EFIAPI	ReportProgressCodeEnabled (VOID)
BOOLEAN EFIAPI	ReportErrorCodeEnabled (VOID)
BOOLEAN EFIAPI	ReportDebugCodeEnabled (VOID)

Detailed Description

Provides services to log status code records.

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

Macro Definition Documentation

#define REPORT_STATUS_CODE	(		Type,
			Value
	)

Value:

(ReportProgressCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) ?  \
  ReportStatusCode(Type,Value)                                                               :  \
  (ReportErrorCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE)       ?  \
  ReportStatusCode(Type,Value)                                                               :  \
  (ReportDebugCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_DEBUG_CODE)       ?  \
  ReportStatusCode(Type,Value)                                                               :  \
  EFI_UNSUPPORTED

Reports a status code with minimal parameters if the status code type is enabled.

If the status code type specified by Type is enabled in PcdReportStatusCodeProperyMask, then call ReportStatusCode() passing in Type and Value.

Parameters

Type	The status code type.
Value	The status code value.

Return values

EFI_SUCCESS	The status code was reported.
EFI_DEVICE_ERROR	There status code could not be reported due to a device error.
EFI_UNSUPPORTED	Report status code is not supported.

#define REPORT_STATUS_CODE_EX	(		Type,
			Value,
			Instance,
			CallerId,
			ExtendedDataGuid,
			ExtendedData,
			ExtendedDataSize
	)

Value:

(ReportProgressCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE)             ?  \
  ReportStatusCodeEx(Type,Value,Instance,CallerId,ExtendedDataGuid,ExtendedData,ExtendedDataSize)        :  \
  (ReportErrorCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE)                   ?  \
  ReportStatusCodeEx(Type,Value,Instance,CallerId,ExtendedDataGuid,ExtendedData,ExtendedDataSize)        :  \
  (ReportDebugCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_DEBUG_CODE)                   ?  \
  ReportStatusCodeEx(Type,Value,Instance,CallerId,ExtendedDataGuid,ExtendedData,ExtendedDataSize)        :  \
  EFI_UNSUPPORTED

Reports a status code specifying all parameters if the status code type is enabled.

If the status code type specified by Type is enabled in PcdReportStatusCodeProperyMask, then call ReportStatusCodeEx() passing in Type, Value, Instance, CallerId, ExtendedDataGuid, ExtendedData, and ExtendedDataSize.

Parameters

Type	The status code type.
Value	The status code value.
Instance	The status code instance number.
CallerId	The pointer to a GUID that identifies the caller of this function. If this parameter is NULL, then a caller ID of gEfiCallerIdGuid is used.
ExtendedDataGuid	Pointer to the GUID for the extended data buffer. If this parameter is NULL, then a the status code standard header is filled in with an implementation dependent GUID.
ExtendedData	Pointer to the extended data buffer. This is an optional parameter that may be NULL.
ExtendedDataSize	The size, in bytes, of the extended data buffer.

Return values

EFI_SUCCESS	The status code was reported.
EFI_OUT_OF_RESOURCES	There were not enough resources to allocate the extended data section if it was specified.
EFI_UNSUPPORTED	The report status code is not supported.
EFI_DEVICE_ERROR	A call to a Report Status Code Library function is already in progress.

#define REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED   0x00000004

#define REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED   0x00000002

#define REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED   0x00000001

#define REPORT_STATUS_CODE_WITH_DEVICE_PATH	(		Type,
			Value,
			DevicePathParameter
	)

Value:

(ReportProgressCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) ?  \
  ReportStatusCodeWithDevicePath(Type,Value,DevicePathParameter)                             :  \
  (ReportErrorCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE)       ?  \
  ReportStatusCodeWithDevicePath(Type,Value,DevicePathParameter)                             :  \
  (ReportDebugCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_DEBUG_CODE)       ?  \
  ReportStatusCodeWithDevicePath(Type,Value,DevicePathParameter)                             :  \
  EFI_UNSUPPORTED

Reports a status code with a Device Path Protocol as the extended data if the status code type is enabled.

If the status code type specified by Type is enabled in PcdReportStatusCodeProperyMask, then call ReportStatusCodeWithDevicePath() passing in Type, Value, and DevicePath.

Parameters

Type	The status code type.
Value	The status code value.
DevicePath	Pointer to the Device Path Protocol to be reported.

Return values

EFI_SUCCESS	The status code was reported with the extended data specified by DevicePath.
EFI_OUT_OF_RESOURCES	There were not enough resources to allocate the extended data section.
EFI_UNSUPPORTED	The report status code is not supported.
EFI_DEVICE_ERROR	A call to a Report Status Code Library function is already in progress.

#define REPORT_STATUS_CODE_WITH_EXTENDED_DATA	(		Type,
			Value,
			ExtendedData,
			ExtendedDataSize
	)

Value:

(ReportProgressCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) ?  \
  ReportStatusCodeWithExtendedData(Type,Value,ExtendedData,ExtendedDataSize)                 :  \
  (ReportErrorCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE)       ?  \
  ReportStatusCodeWithExtendedData(Type,Value,ExtendedData,ExtendedDataSize)                 :  \
  (ReportDebugCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_DEBUG_CODE)       ?  \
  ReportStatusCodeWithExtendedData(Type,Value,ExtendedData,ExtendedDataSize)                 :  \
  EFI_UNSUPPORTED

Reports a status code with an extended data buffer if the status code type is enabled.

If the status code type specified by Type is enabled in PcdReportStatusCodeProperyMask, then call ReportStatusCodeWithExtendedData() passing in Type, Value, ExtendedData, and ExtendedDataSize.

Parameters

Type	The status code type.
Value	The status code value.
ExtendedData	The pointer to the extended data buffer to be reported.
ExtendedDataSize	The size, in bytes, of the extended data buffer to be reported.

Return values

EFI_SUCCESS	The status code was reported with the extended data specified by ExtendedData and ExtendedDataSize.
EFI_OUT_OF_RESOURCES	There were not enough resources to allocate the extended data section.
EFI_UNSUPPORTED	The report status code is not supported.
EFI_DEVICE_ERROR	A call to a Report Status Code Library function is already in progress.

Function Documentation

BOOLEAN EFIAPI CodeTypeToPostCode	(	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

CodeType	The type of status code being converted.
Value	The status code value being converted.
PostCode	A pointer to the 8-bit POST code value to return.

Return values

TRUE	The status code specified by CodeType and Value was converted to an 8-bit POST code and returned in PostCode.
FALSE	The status code specified by CodeType and Value could not be converted to an 8-bit POST code value.

BOOLEAN EFIAPI ReportDebugCodeEnabled

(

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

TRUE	The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is set.
FALSE	The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is clear.

BOOLEAN EFIAPI ReportErrorCodeEnabled

(

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

TRUE	The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is set.
FALSE	The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is clear.

BOOLEAN EFIAPI ReportProgressCodeEnabled

(

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

TRUE	The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is set.
FALSE	The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of PcdReportStatusCodeProperyMask is clear.

EFI_STATUS EFIAPI ReportStatusCode	(	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 recursion. If ReportStatusCode() is called while processing another any other Report Status Code Library function, then ReportStatusCode() must return immediately.

Parameters

Type	Status code type.
Value	Status code value.

Return values

EFI_SUCCESS	The status code was reported.
EFI_DEVICE_ERROR	There status code could not be reported due to a device error.
EFI_UNSUPPORTED	The report status code is not supported.

EFI_STATUS EFIAPI ReportStatusCodeEx	(	IN EFI_STATUS_CODE_TYPE	Type,
		IN EFI_STATUS_CODE_VALUE	Value,
		IN UINT32	Instance,
		IN CONST EFI_GUID *	CallerId,
		IN CONST EFI_GUID *	ExtendedDataGuid,
		IN CONST VOID *	ExtendedData,
		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 gEfiStatusCodeSpecificDataGuid 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

Type	The status code type.
Value	The status code value.
Instance	The status code instance number.
CallerId	The pointer to a GUID that identifies the caller of this function. If this parameter is NULL, then a caller ID of gEfiCallerIdGuid is used.
ExtendedDataGuid	The pointer to the GUID for the extended data buffer. If this parameter is NULL, then a the status code standard header is filled in with an implementation dependent GUID.
ExtendedData	The pointer to the extended data buffer. This is an optional parameter that may be NULL.
ExtendedDataSize	The size, in bytes, of the extended data buffer.

Return values

EFI_SUCCESS	The status code was reported.
EFI_OUT_OF_RESOURCES	There were not enough resources to allocate the extended data section if it was specified.
EFI_UNSUPPORTED	The report status code is not supported.
EFI_DEVICE_ERROR	A call to a Report Status Code Library function is already in progress.

BOOLEAN EFIAPI ReportStatusCodeExtractAssertInfo	(	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

CodeType	The type of status code being converted.
Value	The status code value being converted.
Data	The pointer to status code data buffer.
Filename	The pointer to the source file name that generated the ASSERT().
Description	The pointer to the description of the ASSERT().
LineNumber	The pointer to source line number that generated the ASSERT().

Return values

TRUE	The status code specified by CodeType, Value, and Data was converted ASSERT() arguments specified by Filename, Description, and LineNumber.
FALSE	The status code specified by CodeType, Value, and Data could not be converted to ASSERT() arguments.

BOOLEAN EFIAPI ReportStatusCodeExtractDebugInfo	(	IN CONST EFI_STATUS_CODE_DATA *	Data,
		OUT UINT32 *	ErrorLevel,
		OUT BASE_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

Data	The pointer to status code data buffer.
ErrorLevel	The pointer to error level mask for a debug message.
Marker	The pointer to the variable argument list associated with Format.
Format	The pointer to a Null-terminated ASCII format string of a debug message.

Return values

TRUE	The status code specified by Data was converted DEBUG() arguments specified by ErrorLevel, Marker, and Format.
FALSE	The status code specified by Data could not be converted to DEBUG() arguments.

EFI_STATUS EFIAPI ReportStatusCodeWithDevicePath	(	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 an implementation dependent GUID. 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

Type	The status code type.
Value	The status code value.
DevicePath	The pointer to the Device Path Protocol to be reported.

Return values

EFI_SUCCESS	The status code was reported with the extended data specified by DevicePath.
EFI_OUT_OF_RESOURCES	There were not enough resources to allocate the extended data section.
EFI_UNSUPPORTED	The report status code is not supported.
EFI_DEVICE_ERROR	A call to a Report Status Code Library function is already in progress.

EFI_STATUS EFIAPI ReportStatusCodeWithExtendedData	(	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 an implementation dependent GUID. 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

Type	The status code type.
Value	The status code value.
ExtendedData	The pointer to the extended data buffer to be reported.
ExtendedDataSize	The size, in bytes, of the extended data buffer to be reported.

Return values

EFI_SUCCESS	The status code was reported with the extended data specified by ExtendedData and ExtendedDataSize.
EFI_OUT_OF_RESOURCES	There were not enough resources to allocate the extended data section.
EFI_UNSUPPORTED	The report status code is not supported.
EFI_DEVICE_ERROR	A call to a Report Status Code Library function is already in progress.