/** @file\r
- Generic PeiStatusCode Module.\r
+ Status code PEIM which produces Status Code PPI.\r
\r
- Copyright (c) 2006, Intel Corporation\r
+ Copyright (c) 2006 - 2009, 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
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.c\r
-\r
**/\r
\r
#include "PeiStatusCode.h"\r
\r
-EFI_PEI_PROGRESS_CODE_PPI mStatusCodePpi = {\r
+EFI_PEI_PROGRESS_CODE_PPI mStatusCodePpi = {\r
ReportDispatcher\r
};\r
\r
};\r
\r
/**\r
- Report status code to all supported device.\r
-\r
-\r
- @param PeiServices\r
-\r
- @param CodeType 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
- 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
- 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
- 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
- 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
+ Publishes an interface that allows PEIMs to report status codes.\r
+\r
+ This function implements EFI_PEI_PROGRESS_CODE_PPI.ReportStatusCode().\r
+ It publishes an interface that allows PEIMs to report status codes.\r
+\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+ @param CodeType Indicates the type of status code being reported.\r
+ @param Value Describes the current status of a hardware or\r
+ software entity. This includes information about the class and\r
+ subclass that is used to classify the entity as well as an operation.\r
+ 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
+ @param Instance The enumeration of a hardware or software entity within\r
+ the system. A system may contain multiple entities that match a class/subclass\r
+ pairing. The instance differentiates between them. An instance of 0 indicates\r
+ that instance information is unavailable, not meaningful, or not relevant.\r
+ Valid instance numbers start with 1.\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\r
+ different callers.\r
+ @param Data This optional parameter may be used to pass additional data.\r
+\r
+ @retval EFI_SUCCESS The function completed successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
ReportDispatcher (\r
IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN EFI_STATUS_CODE_TYPE CodeType,\r
- IN EFI_STATUS_CODE_VALUE Value,\r
- IN UINT32 Instance,\r
+ IN EFI_STATUS_CODE_TYPE CodeType,\r
+ IN EFI_STATUS_CODE_VALUE Value,\r
+ IN UINT32 Instance,\r
IN CONST EFI_GUID *CallerId OPTIONAL,\r
IN CONST EFI_STATUS_CODE_DATA *Data OPTIONAL\r
)\r
);\r
}\r
if (FeaturePcdGet (PcdStatusCodeUseOEM)) {\r
+ //\r
+ // Call OEM hook status code library API to report status code to OEM device\r
+ //\r
OemHookStatusCodeReport (\r
CodeType,\r
Value,\r
}\r
\r
/**\r
- Initialize PEI status codes and publish the status code\r
- PPI.\r
+ Entry point of Status Code PEIM.\r
+ \r
+ This function is the entry point of this Status Code PEIM.\r
+ It initializes supported status code devices according to PCD settings,\r
+ and installs Status Code PPI.\r
\r
@param FileHandle Handle of the file being invoked.\r
@param PeiServices Describes the list of possible PEI Services.\r
\r
- @return The function always returns success.\r
+ @retval EFI_SUCESS The entry point of DXE IPL PEIM executes successfully.\r
\r
**/\r
EFI_STATUS\r
}\r
\r
//\r
- // Install PeiStatusCodePpi.\r
- // PeiServices use this Ppi to output status code.\r
- // use library\r
+ // Install Status Code PPI.\r
+ // It serves the PEI Service ReportStatusCode.\r
+ //\r
Status = PeiServicesInstallPpi (&mStatusCodePpiDescriptor);\r
ASSERT_EFI_ERROR (Status);\r
\r
projects / mirror_edk2.git / blobdiff