/** @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 - 2008, 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
\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/PiMultiPhase.h>\r
#include <Protocol/DevicePath.h>\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
Converts a status code to an 8-bit POST code value.\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
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
@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_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
@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_DEVICE_ERROR A call to a Report Status Code Library function\r
+ is already in progress.\r
\r
**/\r
EFI_STATUS\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 \r
the extended data section if it was specified.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
+ @retval EFI_UNSUPPORTED 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
@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_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
@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_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
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_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_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