/** @file\r
- Report Status Code Library public .h file\r
+ Provides services to log status code records.\r
\r
- Copyright (c) 2006, Intel Corporation \r
- All rights reserved. This program and the accompanying materials \r
- are licensed and made available under the terms and conditions of the BSD License \r
- which accompanies this distribution. The full text of the license may be found at \r
- http://opensource.org/licenses/bsd-license.php \r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php.\r
\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __REPORT_STATUS_CODE_LIB_H__\r
#define __REPORT_STATUS_CODE_LIB_H__\r
\r
+#include <Uefi/UefiBaseType.h>\r
+#include <Pi/PiStatusCode.h>\r
#include <Protocol/DevicePath.h>\r
\r
//\r
#define REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED 0x00000002\r
#define REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED 0x00000004\r
\r
-//\r
-// Extended Data structure definitions with EFI_STATUS_CODE_DATA headers removed\r
-//\r
-\r
-//\r
-// Extern for the modules Caller ID GUID\r
-//\r
-extern EFI_GUID gEfiCallerIdGuid;\r
-\r
/**\r
Converts a status code to an 8-bit POST code value.\r
\r
@param PostCode A pointer to the 8-bit POST code value to return. \r
\r
@retval TRUE The status code specified by CodeType and Value was converted \r
- to an 8-bit POST code and returned in PostCode.\r
+ to an 8-bit POST code and returned in PostCode.\r
@retval FALSE The status code specified by CodeType and Value could not be \r
converted to an 8-bit POST code value.\r
\r
\r
@param CodeType The type of status code being converted.\r
@param Value The status code value being converted.\r
- @param Data Pointer to status code data buffer. \r
- @param Filename Pointer to the source file name that generated the ASSERT().\r
- @param Description Pointer to the description of the ASSERT().\r
- @param LineNumber Pointer to source line number that generated the ASSERT().\r
+ @param Data The pointer to status code data buffer. \r
+ @param Filename The pointer to the source file name that generated the ASSERT().\r
+ @param Description The pointer to the description of the ASSERT().\r
+ @param LineNumber The pointer to source line number that generated the ASSERT().\r
\r
@retval TRUE The status code specified by CodeType, Value, and Data was \r
converted ASSERT() arguments specified by Filename, Description, \r
If Marker is NULL, then ASSERT().\r
If Format is NULL, then ASSERT().\r
\r
- @param Data Pointer to status code data buffer. \r
- @param ErrorLevel Pointer to error level mask for a debug message.\r
- @param Marker Pointer to the variable argument list associated with Format.\r
- @param Format Pointer to a Null-terminated ASCII format string of a \r
+ @param Data The pointer to status code data buffer. \r
+ @param ErrorLevel The pointer to error level mask for a debug message.\r
+ @param Marker The pointer to the variable argument list associated with Format.\r
+ @param Format The pointer to a Null-terminated ASCII format string of a \r
debug message.\r
\r
@retval TRUE The status code specified by Data was converted DEBUG() arguments \r
ReportStatusCodeExtractDebugInfo (\r
IN CONST EFI_STATUS_CODE_DATA *Data, \r
OUT UINT32 *ErrorLevel,\r
- OUT VA_LIST *Marker,\r
+ OUT BASE_LIST *Marker,\r
OUT CHAR8 **Format\r
);\r
\r
passed in a zero instance, NULL extended data, and a caller ID of \r
gEfiCallerIdGuid, which is the GUID for the module. \r
\r
- ReportStatusCode()must actively prevent recusrsion. If ReportStatusCode() \r
+ ReportStatusCode()must actively prevent recursion. If ReportStatusCode() \r
is called while processing another any other Report Status Code Library function,\r
then ReportStatusCode() must return immediately.\r
\r
@retval EFI_SUCCESS The status code was reported.\r
@retval EFI_DEVICE_ERROR There status code could not be reported due to a \r
device error.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
+ @retval EFI_UNSUPPORTED The report status code is not supported.\r
\r
**/\r
EFI_STATUS\r
Allocates and fills in the extended data section of a status code with the \r
Device Path Protocol specified by DevicePath. This function is responsible \r
for allocating a buffer large enough for the standard header and the device \r
- path. The standard header is filled in with a GUID of \r
- gEfiStatusCodeSpecificDataGuid. The status code is reported with a zero \r
- instance and a caller ID of gEfiCallerIdGuid.\r
+ path. The standard header is filled in with an implementation dependent GUID.\r
+ The status code is reported with a zero instance and a caller ID of gEfiCallerIdGuid.\r
\r
ReportStatusCodeWithDevicePath()must actively prevent recursion. If \r
ReportStatusCodeWithDevicePath() is called while processing another any other \r
\r
If DevicePath is NULL, then ASSERT().\r
\r
- @param Type Status code type. \r
- @param Value Status code value.\r
- @param DevicePath Pointer to the Device Path Protocol to be reported.\r
+ @param Type The status code type. \r
+ @param Value The status code value.\r
+ @param DevicePath The pointer to the Device Path Protocol to be reported.\r
\r
@retval EFI_SUCCESS The status code was reported with the extended \r
data specified by DevicePath.\r
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the \r
extended data section.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
+ @retval EFI_UNSUPPORTED The report status code is not supported.\r
+ @retval EFI_DEVICE_ERROR A call to a Report Status Code Library function\r
+ is already in progress.\r
\r
**/\r
EFI_STATUS\r
These data structure do not have the standard header, so this function is \r
responsible for allocating a buffer large enough for the standard header and \r
the extended data passed into this function. The standard header is filled \r
- in with a GUID of gEfiStatusCodeSpecificDataGuid. The status code is reported \r
+ in with an implementation dependent GUID. The status code is reported \r
with a zero instance and a caller ID of gEfiCallerIdGuid.\r
\r
ReportStatusCodeWithExtendedData()must actively prevent recursion. If \r
If ExtendedData is NULL, then ASSERT().\r
If ExtendedDataSize is 0, then ASSERT().\r
\r
- @param Type Status code type. \r
- @param Value Status code value.\r
- @param ExtendedData Pointer to the extended data buffer to be reported.\r
+ @param Type The status code type. \r
+ @param Value The status code value.\r
+ @param ExtendedData The pointer to the extended data buffer to be reported.\r
@param ExtendedDataSize The size, in bytes, of the extended data buffer to \r
be reported.\r
\r
data specified by ExtendedData and ExtendedDataSize.\r
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the \r
extended data section.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
+ @retval EFI_UNSUPPORTED The report status code is not supported.\r
+ @retval EFI_DEVICE_ERROR A call to a Report Status Code Library function\r
+ is already in progress.\r
\r
**/\r
EFI_STATUS\r
is responsible for allocating a buffer large enough for the standard header and \r
the extended data passed into this function. The standard header is filled in \r
with a GUID specified by ExtendedDataGuid. If ExtendedDataGuid is NULL, then a \r
- GUID of gEfiStatusCodeSpecificDatauid is used. The status code is reported with \r
+ GUID of gEfiStatusCodeSpecificDataGuid is used. The status code is reported with \r
an instance specified by Instance and a caller ID specified by CallerId. If \r
CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.\r
\r
If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().\r
If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().\r
\r
- @param Type Status code type. \r
- @param Value Status code value.\r
- @param Instance Status code instance number.\r
- @param CallerId Pointer to a GUID that identifies the caller of this \r
+ @param Type The status code type. \r
+ @param Value The status code value.\r
+ @param Instance The status code instance number.\r
+ @param CallerId The pointer to a GUID that identifies the caller of this \r
function. If this parameter is NULL, then a caller \r
ID of gEfiCallerIdGuid is used.\r
- @param ExtendedDataGuid Pointer to the GUID for the extended data buffer. \r
+ @param ExtendedDataGuid The pointer to the GUID for the extended data buffer. \r
If this parameter is NULL, then a the status code \r
- standard header is filled in with \r
- gEfiStatusCodeSpecificDataGuid.\r
- @param ExtendedData Pointer to the extended data buffer. This is an \r
+ standard header is filled in with an implementation dependent GUID.\r
+ @param ExtendedData The pointer to the extended data buffer. This is an \r
optional parameter that may be NULL.\r
@param ExtendedDataSize The size, in bytes, of the extended data buffer.\r
\r
@retval EFI_SUCCESS The status code was reported.\r
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate \r
the extended data section if it was specified.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
+ @retval EFI_UNSUPPORTED The report status code is not supported.\r
+ @retval EFI_DEVICE_ERROR A call to a Report Status Code Library function\r
+ is already in progress.\r
\r
**/\r
EFI_STATUS\r
Returns TRUE if status codes of type EFI_ERROR_CODE are enabled\r
\r
This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED \r
- bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.\r
+ bit of PcdReportStatusCodeProperyMask is set. Otherwise, FALSE is returned.\r
\r
@retval TRUE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of \r
PcdReportStatusCodeProperyMask is set.\r
PcdReportStatusCodeProperyMask, then call ReportStatusCode() passing in Type \r
and Value.\r
\r
- @param Type Status code type. \r
- @param Value Status code value.\r
+ @param Type The status code type. \r
+ @param Value The status code value.\r
\r
@retval EFI_SUCCESS The status code was reported.\r
@retval EFI_DEVICE_ERROR There status code could not be reported due to a device error.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
+ @retval EFI_UNSUPPORTED Report status code is not supported.\r
\r
**/\r
#define REPORT_STATUS_CODE(Type,Value) \\r
PcdReportStatusCodeProperyMask, then call ReportStatusCodeWithDevicePath() \r
passing in Type, Value, and DevicePath.\r
\r
- @param Type Status code type. \r
- @param Value Status code value.\r
+ @param Type The status code type. \r
+ @param Value The status code value.\r
@param DevicePath Pointer to the Device Path Protocol to be reported.\r
\r
@retval EFI_SUCCESS The status code was reported with the extended \r
data specified by DevicePath.\r
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the \r
extended data section.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
+ @retval EFI_UNSUPPORTED The report status code is not supported.\r
+ @retval EFI_DEVICE_ERROR A call to a Report Status Code Library function\r
+ is already in progress.\r
\r
**/\r
#define REPORT_STATUS_CODE_WITH_DEVICE_PATH(Type,Value,DevicePathParameter) \\r
PcdReportStatusCodeProperyMask, then call ReportStatusCodeWithExtendedData() \r
passing in Type, Value, ExtendedData, and ExtendedDataSize.\r
\r
- @param Type Status code type. \r
- @param Value Status code value.\r
- @param ExtendedData Pointer to the extended data buffer to be reported.\r
+ @param Type The status code type. \r
+ @param Value The status code value.\r
+ @param ExtendedData The pointer to the extended data buffer to be reported.\r
@param ExtendedDataSize The size, in bytes, of the extended data buffer to\r
be reported.\r
\r
data specified by ExtendedData and ExtendedDataSize.\r
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the \r
extended data section.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
+ @retval EFI_UNSUPPORTED The report status code is not supported.\r
+ @retval EFI_DEVICE_ERROR A call to a Report Status Code Library function\r
+ is already in progress.\r
\r
**/\r
#define REPORT_STATUS_CODE_WITH_EXTENDED_DATA(Type,Value,ExtendedData,ExtendedDataSize) \\r
PcdReportStatusCodeProperyMask, then call ReportStatusCodeEx() passing in Type, \r
Value, Instance, CallerId, ExtendedDataGuid, ExtendedData, and ExtendedDataSize.\r
\r
- @param Type Status code type. \r
- @param Value Status code value.\r
- @param Instance Status code instance number.\r
- @param CallerId Pointer to a GUID that identifies the caller of this \r
+ @param Type The status code type. \r
+ @param Value The status code value.\r
+ @param Instance The status code instance number.\r
+ @param CallerId The pointer to a GUID that identifies the caller of this \r
function. If this parameter is NULL, then a caller \r
ID of gEfiCallerIdGuid is used.\r
@param ExtendedDataGuid Pointer to the GUID for the extended data buffer. \r
If this parameter is NULL, then a the status code \r
- standard header is filled in with \r
- gEfiStatusCodeSpecificDataGuid.\r
+ standard header is filled in with an implementation dependent GUID.\r
@param ExtendedData Pointer to the extended data buffer. This is an \r
optional parameter that may be NULL.\r
@param ExtendedDataSize The size, in bytes, of the extended data buffer.\r
@retval EFI_SUCCESS The status code was reported.\r
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the \r
extended data section if it was specified.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
+ @retval EFI_UNSUPPORTED The report status code is not supported.\r
+ @retval EFI_DEVICE_ERROR A call to a Report Status Code Library function\r
+ is already in progress.\r
\r
**/\r
#define REPORT_STATUS_CODE_EX(Type,Value,Instance,CallerId,ExtendedDataGuid,ExtendedData,ExtendedDataSize) \\r
projects / mirror_edk2.git / blobdiff