/** @file\r
Heade file of status code PEIM\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
- \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
+ 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
+\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: PeiStatusCode.h\r
\r
\r
\r
//\r
-// Include common header file for this module.\r
+// The package level header files this module uses\r
+//\r
+#include <FrameworkPei.h>\r
+//\r
+// The protocols, PPI and GUID defintions for this module\r
+//\r
+#include <Guid/MemoryStatusCodeRecord.h>\r
+#include <Guid/StatusCodeDataTypeId.h>\r
+#include <Ppi/StatusCode.h>\r
+//\r
+// The Library classes this module consumes\r
//\r
-#include "CommonHeader.h"\r
+#include <Library/BaseLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/PrintLib.h>\r
+#include <Library/ReportStatusCodeLib.h>\r
+#include <Library/SerialPortLib.h>\r
+#include <Library/HobLib.h>\r
+#include <Library/PcdLib.h>\r
+#include <Library/PeiServicesLib.h>\r
+#include <Library/OemHookStatusCodeLib.h>\r
+#include <Library/PeimEntryPoint.h>\r
\r
/**\r
Convert status code value and extended data to readable ASCII string, send string to serial I/O device.\r
- \r
+\r
@param CodeType Indicates the type of status code being reported. Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
- \r
- @param Value Describes the current status of a hardware or software entity. \r
- This included information about the class and subclass that is used to classify the entity \r
- as well as an operation. For progress codes, the operation is the current activity. \r
- For error codes, it is the exception. For debug codes, it is not defined at this time. \r
- Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. \r
+\r
+ @param Value Describes the current status of a hardware or software entity.\r
+ This included information about the class and subclass that is used to classify the entity\r
+ as well as an operation. For progress codes, the operation is the current activity.\r
+ For error codes, it is the exception. For debug codes, it is not defined at this time.\r
+ Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.\r
Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r
- \r
- @param Instance The enumeration of a hardware or software entity within the system. \r
- A system may contain multiple entities that match a class/subclass pairing. \r
- The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, \r
+\r
+ @param Instance The enumeration of a hardware or software entity within the system.\r
+ A system may contain multiple entities that match a class/subclass pairing.\r
+ The instance differentiates between them. An instance of 0 indicates that instance information is unavailable,\r
not meaningful, or not relevant. Valid instance numbers start with 1.\r
\r
\r
- @param CallerId This optional parameter may be used to identify the caller. \r
- This parameter allows the status code driver to apply different rules to different callers. \r
+ @param CallerId This optional parameter may be used to identify the caller.\r
+ This parameter allows the status code driver to apply different rules to different callers.\r
Type EFI_GUID is defined in InstallProtocolInterface() in the EFI 1.10 Specification.\r
\r
\r
@param Data This optional parameter may be used to pass additional data\r
- \r
+\r
@return The function always return EFI_SUCCESS.\r
\r
**/\r
\r
/**\r
Initialize memory status code.\r
- Create one GUID'ed HOB with PCD defined size. If create required size \r
+ Create one GUID'ed HOB with PCD defined size. If create required size\r
GUID'ed HOB failed, then ASSERT().\r
- \r
+\r
@return The function always return EFI_SUCCESS\r
\r
**/\r
\r
/**\r
Report status code into GUID'ed HOB.\r
- \r
+\r
@param CodeType Indicates the type of status code being reported. Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
- \r
- @param Value Describes the current status of a hardware or software entity. \r
- This included information about the class and subclass that is used to classify the entity \r
- as well as an operation. For progress codes, the operation is the current activity. \r
- For error codes, it is the exception. For debug codes, it is not defined at this time. \r
- Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. \r
+\r
+ @param Value Describes the current status of a hardware or software entity.\r
+ This included information about the class and subclass that is used to classify the entity\r
+ as well as an operation. For progress codes, the operation is the current activity.\r
+ For error codes, it is the exception. For debug codes, it is not defined at this time.\r
+ Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.\r
Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r
- \r
- @param Instance The enumeration of a hardware or software entity within the system. \r
- A system may contain multiple entities that match a class/subclass pairing. \r
- The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, \r
+\r
+ @param Instance The enumeration of a hardware or software entity within the system.\r
+ A system may contain multiple entities that match a class/subclass pairing.\r
+ The instance differentiates between them. An instance of 0 indicates that instance information is unavailable,\r
not meaningful, or not relevant. Valid instance numbers start with 1.\r
- \r
+\r
@return The function always return EFI_SUCCESS.\r
\r
**/\r
\r
/**\r
Report status code to all supported device.\r
- \r
- \r
+\r
+\r
@param PeiServices\r
\r
- @param Type Indicates the type of status code being reported. \r
+ @param Type Indicates the type of status code being reported.\r
The type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
- @param Value Describes the current status of a hardware or software entity. \r
- This includes information about the class and subclass that is used to classify the entity \r
- as well as an operation. For progress codes, the operation is the current activity. \r
- For error codes, it is the exception. For debug codes, it is not defined at this time. \r
- Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. \r
+ @param Value Describes the current status of a hardware or software entity.\r
+ This includes information about the class and subclass that is used to classify the entity\r
+ as well as an operation. For progress codes, the operation is the current activity.\r
+ For error codes, it is the exception. For debug codes, it is not defined at this time.\r
+ Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.\r
Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r
- @param Instance The enumeration of a hardware or software entity within the system. \r
- A system may contain multiple entities that match a class/subclass pairing. \r
- The instance differentiates between them. An instance of 0 indicates that instance \r
+ @param Instance The enumeration of a hardware or software entity within the system.\r
+ A system may contain multiple entities that match a class/subclass pairing.\r
+ The instance differentiates between them. An instance of 0 indicates that instance\r
information is unavailable, not meaningful, or not relevant. Valid instance numbers start with 1.\r
- @param CallerId This optional parameter may be used to identify the caller. \r
+ @param CallerId This optional parameter may be used to identify the caller.\r
This parameter allows the status code driver to apply different rules to different callers.\r
- @param Data This optional parameter may be used to pass additional data. \r
- Type EFI_STATUS_CODE_DATA is defined in "Related Definitions" below. \r
- The contents of this data type may have additional GUID-specific data. The standard GUIDs and \r
+ @param Data This optional parameter may be used to pass additional data.\r
+ Type EFI_STATUS_CODE_DATA is defined in "Related Definitions" below.\r
+ The contents of this data type may have additional GUID-specific data. The standard GUIDs and\r
their associated data structures are defined in the Intel? Platform Innovation Framework for EFI Status Codes Specification.\r
\r
@return Always return EFI_SUCCESS.\r
projects / mirror_edk2.git / blobdiff