]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Library/ReportStatusCodeLib.h
Code have been checked with spec
[mirror_edk2.git] / MdePkg / Include / Library / ReportStatusCodeLib.h
index 6b32ddb1379623d522c3b322b2511f4035f539aa..8b71274d7382b4af9cf425328eb7238b63b031b7 100644 (file)
@@ -1,20 +1,23 @@
 /** @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 <Pi/PiMultiPhase.h>\r
+#include <Protocol/DevicePath.h>\r
+\r
 //\r
 // Declare bits for PcdReportStatusCodePropertyMask\r
 //\r
 // Extended Data structure definitions with EFI_STATUS_CODE_DATA headers removed\r
 //\r
 \r
-///\r
-/// Voltage Extended Error Data\r
-///\r
-typedef struct {\r
-  EFI_EXP_BASE10_DATA   Voltage;\r
-  EFI_EXP_BASE10_DATA   Threshold;\r
-} REPORT_STATUS_CODE_LIBRARY_COMPUTING_UNIT_VOLTAGE_ERROR_DATA;\r
-\r
-///\r
-/// Microcode Update Extended Error Data\r
-///\r
-typedef struct {\r
-  UINT32                Version;\r
-} REPORT_STATUS_CODE_LIBRARY_COMPUTING_UNIT_MICROCODE_UPDATE_ERROR_DATA;\r
-\r
-///\r
-/// Asynchronous Timer Extended Error Data\r
-///\r
-typedef struct {\r
-  EFI_EXP_BASE10_DATA   TimerLimit;\r
-} REPORT_STATUS_CODE_LIBRARY_COMPUTING_UNIT_TIMER_EXPIRED_ERROR_DATA;\r
-\r
-///\r
-/// Host Processor Mismatch Extended Error Data\r
-///\r
-typedef struct {\r
-  UINT32                Instance;\r
-  UINT16                Attributes;\r
-} REPORT_STATUS_CODE_LIBRARY_HOST_PROCESSOR_MISMATCH_ERROR_DATA;\r
-\r
-///\r
-/// Thermal Extended Error Data\r
-///\r
-typedef struct {\r
-  EFI_EXP_BASE10_DATA   Temperature;\r
-  EFI_EXP_BASE10_DATA   Threshold;\r
-} REPORT_STATUS_CODE_LIBRARY_COMPUTING_UNIT_THERMAL_ERROR_DATA;\r
-\r
-///\r
-/// Processor Disabled Extended Error Data\r
-///\r
-typedef struct {\r
-  UINT32                Cause;\r
-  BOOLEAN               SoftwareDisabled;\r
-} REPORT_STATUS_CODE_LIBRARY_COMPUTING_UNIT_CPU_DISABLED_ERROR_DATA;\r
-\r
-///\r
-/// Embedded cache init extended data\r
-///\r
-typedef struct {\r
-  UINT32                Level;\r
-  EFI_INIT_CACHE_TYPE   Type;\r
-} REPORT_STATUS_CODE_LIBRARY_CACHE_INIT_DATA;\r
-\r
-///\r
-/// Memory Extended Error Data\r
-///\r
-typedef struct {\r
-  EFI_MEMORY_ERROR_GRANULARITY  Granularity;\r
-  EFI_MEMORY_ERROR_OPERATION    Operation;\r
-  UINTN                         Syndrome;\r
-  EFI_PHYSICAL_ADDRESS          Address;\r
-  UINTN                         Resolution;\r
-} REPORT_STATUS_CODE_LIBRARY_MEMORY_EXTENDED_ERROR_DATA;\r
-\r
-///\r
-/// DIMM number\r
-///\r
-typedef struct {\r
-  UINT16                Array;\r
-  UINT16                Device;\r
-} REPORT_STATUS_CODE_LIBRARY_STATUS_CODE_DIMM_NUMBER;\r
-\r
-///\r
-/// Memory Module Mismatch Extended Error Data\r
-///\r
-typedef struct {\r
-  EFI_STATUS_CODE_DIMM_NUMBER Instance;\r
-} REPORT_STATUS_CODE_LIBRARY_MEMORY_MODULE_MISMATCH_ERROR_DATA;\r
-\r
-///\r
-/// Memory Range Extended Data\r
-///\r
-typedef struct {\r
-  EFI_PHYSICAL_ADDRESS  Start;\r
-  EFI_PHYSICAL_ADDRESS  Length;\r
-} REPORT_STATUS_CODE_LIBRARY_MEMORY_RANGE_EXTENDED_DATA;\r
-\r
-///\r
-/// Device handle Extended Data. Used for many\r
-/// errors and progress codes to point to the device.\r
-///\r
-typedef struct {\r
-  EFI_HANDLE            Handle;\r
-} REPORT_STATUS_CODE_LIBRARY_DEVICE_HANDLE_EXTENDED_DATA;\r
-\r
-typedef struct {\r
-  UINT8                                *DevicePath;\r
-} REPORT_STATUS_CODE_LIBRARY_DEVICE_PATH_EXTENDED_DATA;\r
-\r
-typedef struct {\r
-  EFI_HANDLE                     ControllerHandle;\r
-  EFI_HANDLE                     DriverBindingHandle;\r
-  UINT16                         DevicePathSize;\r
-  UINT8                          *RemainingDevicePath;\r
-} REPORT_STATUS_CODE_LIBRARY_STATUS_CODE_START_EXTENDED_DATA;\r
-\r
-///\r
-/// Resource Allocation Failure Extended Error Data\r
-///\r
-typedef struct {\r
-  UINT32                             Bar;\r
-  UINT16                             DevicePathSize;\r
-  UINT16                             ReqResSize;\r
-  UINT16                             AllocResSize;\r
-  UINT8                              *DevicePath;\r
-  UINT8                              *ReqRes;\r
-  UINT8                              *AllocRes;\r
-} REPORT_STATUS_CODE_LIBRARY_RESOURCE_ALLOC_FAILURE_ERROR_DATA;\r
-\r
-///\r
-/// Extended Error Data for Assert\r
-///\r
-typedef struct {\r
-  UINT32                      LineNumber;\r
-  UINT32                      FileNameSize;\r
-  EFI_STATUS_CODE_STRING_DATA *FileName;\r
-} REPORT_STATUS_CODE_LIBRARY_DEBUG_ASSERT_DATA;\r
-\r
-///\r
-/// System Context Data EBC/IA32/IPF\r
-///\r
-typedef struct {\r
-  EFI_STATUS_CODE_EXCEP_SYSTEM_CONTEXT  Context;\r
-} REPORT_STATUS_CODE_LIBRARY_STATUS_CODE_EXCEP_EXTENDED_DATA;\r
-\r
-///\r
-/// Legacy Oprom extended data\r
-///\r
-typedef struct {\r
-  EFI_HANDLE            DeviceHandle;\r
-  EFI_PHYSICAL_ADDRESS  RomImageBase;\r
-} REPORT_STATUS_CODE_LIBRARY_LEGACY_OPROM_EXTENDED_DATA;\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
@@ -344,6 +198,8 @@ ReportStatusCode (
   @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
@@ -386,6 +242,8 @@ ReportStatusCodeWithDevicePath (
   @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
@@ -436,7 +294,9 @@ ReportStatusCodeWithExtendedData (
   @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
@@ -551,6 +411,8 @@ ReportDebugCodeEnabled (
   @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
@@ -582,6 +444,8 @@ ReportDebugCodeEnabled (
   @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
@@ -618,6 +482,8 @@ ReportDebugCodeEnabled (
   @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