Remove "Module Name:" from include file headers.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Framework / StatusCode.h

diff --git a/IntelFrameworkPkg/Include/Framework/StatusCode.h b/IntelFrameworkPkg/Include/Framework/StatusCode.h
index 91b9d08a080852e25a7f798f9cb1eb2c7fa1f784..cdd9d44c19300c7c59133b10b0836e26677a9dba 100644 (file)
--- a/IntelFrameworkPkg/Include/Framework/StatusCode.h
+++ b/IntelFrameworkPkg/Include/Framework/StatusCode.h
@@ -6,13 +6,12 @@
 \r
 <pre>\r
   Section:    Contents:\r
 \r
 <pre>\r
   Section:    Contents:\r

-  1           General Status Code Definitions\r
-  2           Class definitions\r
-  3           Computing Unit Subclasses, Progress and Error Codes\r
-  4           Peripheral Subclasses, Progress and Error Codes.\r
-  5           IO Bus Subclasses, Progress and Error Codes.\r
-  6           Software Subclasses, Progress and Error Codes.\r
-  7           Debug Codes\r
+  1           Class definitions\r
+  2           Computing Unit Subclasses, Progress and Error Codes\r
+  3           Peripheral Subclasses, Progress and Error Codes.\r
+  4           IO Bus Subclasses, Progress and Error Codes.\r
+  5           Software Subclasses, Progress and Error Codes.\r
+  6           Debug Codes\r

 </pre>\r
 \r
   Copyright (c) 2007, Intel Corporation\r
 </pre>\r
 \r
   Copyright (c) 2007, Intel Corporation\r


@@ -24,9 +23,8 @@
   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
   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

-  Module Name:  StatusCode.h\r
-\r

   @par Revision Reference:\r
   @par Revision Reference:\r

+  Intel Platform Innovation Framework for EFI Status Codes Specification\r

   Version 0.92.\r
 \r
 **/\r
   Version 0.92.\r
 \r
 **/\r


@@ -34,13 +32,8 @@
 #ifndef _FRAMEWORK_STATUS_CODE_H_\r
 #define _FRAMEWORK_STATUS_CODE_H_\r
 \r
 #ifndef _FRAMEWORK_STATUS_CODE_H_\r
 #define _FRAMEWORK_STATUS_CODE_H_\r
 \r

-#include <PiPei.h>\r
-\r

 //\r
 //\r

-// /////////////////////////////////////////////////////////////////////////////\r

 // Section 1\r
 // Section 1\r

-///////////////////////////////////////////////////////////////////////////////\r
-//\r

 // Class definitions\r
 // Values of 4-127 are reserved for future use by this\r
 // specification.\r
 // Class definitions\r
 // Values of 4-127 are reserved for future use by this\r
 // specification.\r


@@ -60,11 +53,8 @@
 #define EFI_SUBCLASS_SPECIFIC 0x1000\r
 #define EFI_OEM_SPECIFIC      0x8000\r
 \r
 #define EFI_SUBCLASS_SPECIFIC 0x1000\r
 #define EFI_OEM_SPECIFIC      0x8000\r
 \r

-//\r
-// /////////////////////////////////////////////////////////////////////////////\r
+// \r

 // Section 2\r
 // Section 2\r

-///////////////////////////////////////////////////////////////////////////////\r
-//\r

 // Computing Unit Subclass definitions.\r
 // Values of 8-127 are reserved for future use by this\r
 // specification.\r
 // Computing Unit Subclass definitions.\r
 // Values of 8-127 are reserved for future use by this\r
 // specification.\r


@@ -85,6 +75,21 @@
 #define EFI_CU_PC_INIT_BEGIN  0x00000000\r
 #define EFI_CU_PC_INIT_END    0x00000001\r
 \r
 #define EFI_CU_PC_INIT_BEGIN  0x00000000\r
 #define EFI_CU_PC_INIT_END    0x00000001\r
 \r

+//\r
+// The reason that the processor was disabled.\r
+//\r
+#define EFI_CPU_CAUSE_NOT_DISABLED              0x0000\r
+#define EFI_CPU_CAUSE_INTERNAL_ERROR            0x0001\r
+#define EFI_CPU_CAUSE_THERMAL_ERROR             0x0002\r
+#define EFI_CPU_CAUSE_SELFTEST_FAILURE          0x0004\r
+#define EFI_CPU_CAUSE_PREBOOT_TIMEOUT           0x0008\r
+#define EFI_CPU_CAUSE_FAILED_TO_START           0x0010\r
+#define EFI_CPU_CAUSE_CONFIG_ERROR              0x0020\r
+#define EFI_CPU_CAUSE_USER_SELECTION            0x0080\r
+#define EFI_CPU_CAUSE_BY_ASSOCIATION            0x0100\r
+#define EFI_CPU_CAUSE_UNSPECIFIED               0x8000\r
+\r
+typedef UINT32                                  EFI_CPU_STATE_CHANGE_CAUSE;\r

 //\r
 // Computing Unit Unspecified Subclass Progress Code definitions.\r
 //\r
 //\r
 // Computing Unit Unspecified Subclass Progress Code definitions.\r
 //\r


@@ -195,10 +200,8 @@
 // Computing Unit Chipset Subclass Error Code definitions.\r
 //\r
 \r
 // Computing Unit Chipset Subclass Error Code definitions.\r
 //\r
 \r

-///////////////////////////////////////////////////////////////////////////////\r
-// Section 4\r
-///////////////////////////////////////////////////////////////////////////////\r

 //\r
 //\r

+// Section 3\r

 // Peripheral Subclass definitions.\r
 // Values of 12-127 are reserved for future use by this\r
 // specification.\r
 // Peripheral Subclass definitions.\r
 // Values of 12-127 are reserved for future use by this\r
 // specification.\r


@@ -336,10 +339,8 @@
 // Peripheral Class Network Subclass Error Code definitions.\r
 //\r
 \r
 // Peripheral Class Network Subclass Error Code definitions.\r
 //\r
 \r

-///////////////////////////////////////////////////////////////////////////////\r
-// Section 5\r
-///////////////////////////////////////////////////////////////////////////////\r

 //\r
 //\r

+// Section 4\r

 // IO Bus Subclass definitions.\r
 // Values of 14-127 are reserved for future use by this\r
 // specification.\r
 // IO Bus Subclass definitions.\r
 // Values of 14-127 are reserved for future use by this\r
 // specification.\r


@@ -475,10 +476,8 @@
 // IO Bus Class I2C Subclass Error Code definitions.\r
 //\r
 \r
 // IO Bus Class I2C Subclass Error Code definitions.\r
 //\r
 \r

-///////////////////////////////////////////////////////////////////////////////\r
-// Section 6\r
-///////////////////////////////////////////////////////////////////////////////\r

 //\r
 //\r

+// Section 5\r

 // Software Subclass definitions.\r
 // Values of 14-127 are reserved for future use by this\r
 // specification.\r
 // Software Subclass definitions.\r
 // Values of 14-127 are reserved for future use by this\r
 // specification.\r


@@ -559,9 +558,20 @@
 #define EFI_SW_DXE_BS_PC_LEGACY_BOOT_EVENT            (EFI_SUBCLASS_SPECIFIC | 0x00000002)\r
 #define EFI_SW_DXE_BS_PC_EXIT_BOOT_SERVICES_EVENT     (EFI_SUBCLASS_SPECIFIC | 0x00000003)\r
 #define EFI_SW_DXE_BS_PC_VIRTUAL_ADDRESS_CHANGE_EVENT (EFI_SUBCLASS_SPECIFIC | 0x00000004)\r
 #define EFI_SW_DXE_BS_PC_LEGACY_BOOT_EVENT            (EFI_SUBCLASS_SPECIFIC | 0x00000002)\r
 #define EFI_SW_DXE_BS_PC_EXIT_BOOT_SERVICES_EVENT     (EFI_SUBCLASS_SPECIFIC | 0x00000003)\r
 #define EFI_SW_DXE_BS_PC_VIRTUAL_ADDRESS_CHANGE_EVENT (EFI_SUBCLASS_SPECIFIC | 0x00000004)\r

+///\r
+/// Inconsistent with specification here: \r
+/// In Framework Spec, Status0.92, no following two macro. And it is expectable that\r
+/// to add the definitions to Framework Spec.\r
+///\r

 #define EFI_SW_DXE_BS_PC_BEGIN_CONNECTING_DRIVERS     (EFI_SUBCLASS_SPECIFIC | 0x00000005)\r
 #define EFI_SW_DXE_BS_PC_VERIFYING_PASSWORD           (EFI_SUBCLASS_SPECIFIC | 0x00000006)\r
 \r
 #define EFI_SW_DXE_BS_PC_BEGIN_CONNECTING_DRIVERS     (EFI_SUBCLASS_SPECIFIC | 0x00000005)\r
 #define EFI_SW_DXE_BS_PC_VERIFYING_PASSWORD           (EFI_SUBCLASS_SPECIFIC | 0x00000006)\r
 \r

+///\r
+/// Inconsistent with specification here: \r
+/// In Framework Spec, Status0.92, no following two macro. And it is expectable that\r
+/// to add the definitions to Framework Spec.\r
+///\r
+\r

 //\r
 // Software Class DXE RT Driver Subclass Progress Code definitions.\r
 //\r
 //\r
 // Software Class DXE RT Driver Subclass Progress Code definitions.\r
 //\r


@@ -815,6 +825,12 @@
 #define EFI_SW_EC_IA32_MACHINE_CHECK    EXCEPT_IA32_MACHINE_CHECK\r
 #define EFI_SW_EC_IA32_SIMD             EXCEPT_IA32_SIMD\r
 \r
 #define EFI_SW_EC_IA32_MACHINE_CHECK    EXCEPT_IA32_MACHINE_CHECK\r
 #define EFI_SW_EC_IA32_SIMD             EXCEPT_IA32_SIMD\r
 \r

+///\r
+/// Inconsistent with specification here: \r
+/// In Framework Spec, Status0.92, no following two macro. And it is expectable that\r
+/// to add the definitions to Framework Spec.\r
+///\r
+\r

 //\r
 // Software Class X64 Exception Subclass Error Code definitions.\r
 // These exceptions are derived from the debug protocol definitions in the EFI\r
 //\r
 // Software Class X64 Exception Subclass Error Code definitions.\r
 // These exceptions are derived from the debug protocol definitions in the EFI\r


@@ -870,10 +886,8 @@
 // Software Class EFI DXE Service Subclass Error Code definitions.\r
 //\r
 \r
 // Software Class EFI DXE Service Subclass Error Code definitions.\r
 //\r
 \r

-///////////////////////////////////////////////////////////////////////////////\r
-// Section 7\r
-///////////////////////////////////////////////////////////////////////////////\r

 //\r
 //\r

+// Section 6\r

 // Debug Code definitions for all classes and subclass\r
 // Only one debug code is defined at this point and should\r
 // be used for anything that gets sent to debug stream.\r
 // Debug Code definitions for all classes and subclass\r
 // Only one debug code is defined at this point and should\r
 // be used for anything that gets sent to debug stream.\r