Code Scrub for Status Code PEIM.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8186 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 65 insertions, 74 deletions

diff --git a/IntelFrameworkModulePkg/Universal/StatusCode/Pei/PeiStatusCode.h b/IntelFrameworkModulePkg/Universal/StatusCode/Pei/PeiStatusCode.h
index 9493a49c07..a609393e99 100644
--- a/IntelFrameworkModulePkg/Universal/StatusCode/Pei/PeiStatusCode.h
+++ b/IntelFrameworkModulePkg/Universal/StatusCode/Pei/PeiStatusCode.h
@@ -1,7 +1,7 @@
 /** @file

-  Heade file of status code PEIM

+  Internal include file for Status Code PEIM.

 

-  Copyright (c) 2006, Intel Corporation

+  Copyright (c) 2006 - 2009, Intel Corporation

   All rights reserved. This program and the accompanying materials

   are licensed and made available under the terms and conditions of the BSD License

   which accompanies this distribution.  The full text of the license may be found at

@@ -38,47 +38,39 @@
 /**

   Convert status code value and extended data to readable ASCII string, send string to serial I/O device.

 

-  @param  CodeType      Indicates the type of status code being reported.  Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.

-

-  @param  Value         Describes the current status of a hardware or software entity.

-                        This included information about the class and subclass that is used to classify the entity

-                        as well as an operation.  For progress codes, the operation is the current activity.

-                        For error codes, it is the exception.  For debug codes, it is not defined at this time.

-                        Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.

-                        Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.

-

-  @param  Instance      The enumeration of a hardware or software entity within the system.

-                        A system may contain multiple entities that match a class/subclass pairing.

-                        The instance differentiates between them.  An instance of 0 indicates that instance information is unavailable,

-                        not meaningful, or not relevant.  Valid instance numbers start with 1.

-

-

-  @param  CallerId      This optional parameter may be used to identify the caller.

-                        This parameter allows the status code driver to apply different rules to different callers.

-                        Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0 Specification.

-

-

-  @param  Data          This optional parameter may be used to pass additional data

-

-  @return               The function always return EFI_SUCCESS.

+  @param  CodeType         Indicates the type of status code being reported.

+  @param  Value            Describes the current status of a hardware or

+                           software entity. This includes information about the class and

+                           subclass that is used to classify the entity as well as an operation.

+                           For progress codes, the operation is the current activity.

+                           For error codes, it is the exception.For debug codes,it is not defined at this time.

+  @param  Instance         The enumeration of a hardware or software entity within

+                           the system. A system may contain multiple entities that match a class/subclass

+                           pairing. The instance differentiates between them. An instance of 0 indicates

+                           that instance information is unavailable, not meaningful, or not relevant.

+                           Valid instance numbers start with 1.

+  @param  CallerId         This optional parameter may be used to identify the caller.

+                           This parameter allows the status code driver to apply different rules to

+                           different callers.

+  @param  Data             This optional parameter may be used to pass additional data.

+

+  @retval EFI_SUCCESS      Status code reported to serial I/O successfully.

 

 **/

 EFI_STATUS

 SerialStatusCodeReportWorker (

-  IN EFI_STATUS_CODE_TYPE     CodeType,

-  IN EFI_STATUS_CODE_VALUE    Value,

-  IN UINT32                   Instance,

+  IN EFI_STATUS_CODE_TYPE           CodeType,

+  IN EFI_STATUS_CODE_VALUE          Value,

+  IN UINT32                         Instance,

   IN CONST EFI_GUID                 *CallerId,

   IN CONST EFI_STATUS_CODE_DATA     *Data OPTIONAL

   );

 

 

 /**

-  Initialize memory status code.

-  Create one GUID'ed HOB with PCD defined size. If create required size

-  GUID'ed HOB failed, then ASSERT().

+  Create the first memory status code GUID'ed HOB as initialization for memory status code worker.

 

-  @return           The function always return EFI_SUCCESS

+  @retval EFI_SUCCESS  The GUID'ed HOB is created successfully.

 

 **/

 EFI_STATUS

@@ -89,21 +81,22 @@ MemoryStatusCodeInitializeWorker (
 /**

   Report status code into GUID'ed HOB.

 

-  @param  CodeType      Indicates the type of status code being reported.  Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.

+  This function reports status code into GUID'ed HOB. If not all packets are full, then

+  write status code into available entry. Otherwise, create a new packet for it.

 

-  @param  Value         Describes the current status of a hardware or software entity.

-                        This included information about the class and subclass that is used to classify the entity

-                        as well as an operation.  For progress codes, the operation is the current activity.

-                        For error codes, it is the exception.  For debug codes, it is not defined at this time.

-                        Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.

-                        Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.

+  @param  CodeType         Indicates the type of status code being reported.

+  @param  Value            Describes the current status of a hardware or

+                           software entity. This includes information about the class and

+                           subclass that is used to classify the entity as well as an operation.

+                           For progress codes, the operation is the current activity.

+                           For error codes, it is the exception.For debug codes,it is not defined at this time.

+  @param  Instance         The enumeration of a hardware or software entity within

+                           the system. A system may contain multiple entities that match a class/subclass

+                           pairing. The instance differentiates between them. An instance of 0 indicates

+                           that instance information is unavailable, not meaningful, or not relevant.

+                           Valid instance numbers start with 1.

 

-  @param  Instance      The enumeration of a hardware or software entity within the system.

-                        A system may contain multiple entities that match a class/subclass pairing.

-                        The instance differentiates between them.  An instance of 0 indicates that instance information is unavailable,

-                        not meaningful, or not relevant.  Valid instance numbers start with 1.

-

-  @return               The function always return EFI_SUCCESS.

+  @retval EFI_SUCCESS      The function always return EFI_SUCCESS.

 

 **/

 EFI_STATUS

@@ -114,44 +107,42 @@ MemoryStatusCodeReportWorker (
   );

 

 /**

-  Report status code to all supported device.

-

-

-  @param  PeiServices

-

-  @param  Type          Indicates the type of status code being reported.

-                        The type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.

-  @param  Value         Describes the current status of a hardware or software entity.

-                        This includes information about the class and subclass that is used to classify the entity

-                        as well as an operation.  For progress codes, the operation is the current activity.

-                        For error codes, it is the exception.  For debug codes, it is not defined at this time.

-                        Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.

-                        Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.

-  @param  Instance      The enumeration of a hardware or software entity within the system.

-                        A system may contain multiple entities that match a class/subclass pairing.

-                        The instance differentiates between them.  An instance of 0 indicates that instance

-                        information is unavailable, not meaningful, or not relevant.  Valid instance numbers start with 1.

-  @param  CallerId      This optional parameter may be used to identify the caller.

-                        This parameter allows the status code driver to apply different rules to different callers.

-  @param  Data          This optional parameter may be used to pass additional data.

-                        Type EFI_STATUS_CODE_DATA is defined in "Related Definitions" below.

-                        The contents of this data type may have additional GUID-specific data.  The standard GUIDs and

-                        their associated data structures are defined in the Intel? Platform Innovation Framework for EFI Status Codes Specification.

-

-  @return               Always return EFI_SUCCESS.

+  Publishes an interface that allows PEIMs to report status codes.

+

+  This function implements EFI_PEI_PROGRESS_CODE_PPI.ReportStatusCode().

+  It publishes an interface that allows PEIMs to report status codes.

+

+  @param  PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.

+  @param  CodeType         Indicates the type of status code being reported.

+  @param  Value            Describes the current status of a hardware or

+                           software entity. This includes information about the class and

+                           subclass that is used to classify the entity as well as an operation.

+                           For progress codes, the operation is the current activity.

+                           For error codes, it is the exception.For debug codes,it is not defined at this time.

+  @param  Instance         The enumeration of a hardware or software entity within

+                           the system. A system may contain multiple entities that match a class/subclass

+                           pairing. The instance differentiates between them. An instance of 0 indicates

+                           that instance information is unavailable, not meaningful, or not relevant.

+                           Valid instance numbers start with 1.

+  @param  CallerId         This optional parameter may be used to identify the caller.

+                           This parameter allows the status code driver to apply different rules to

+                           different callers.

+  @param  Data             This optional parameter may be used to pass additional data.

+

+  @retval EFI_SUCCESS      The function completed successfully.

 

 **/

 EFI_STATUS

 EFIAPI

 ReportDispatcher (

   IN CONST EFI_PEI_SERVICES         **PeiServices,

-  IN EFI_STATUS_CODE_TYPE     Type,

-  IN EFI_STATUS_CODE_VALUE    Value,

-  IN UINT32                   Instance,

+  IN EFI_STATUS_CODE_TYPE           CodeType,

+  IN EFI_STATUS_CODE_VALUE          Value,

+  IN UINT32                         Instance,

   IN CONST EFI_GUID                 *CallerId OPTIONAL,

   IN CONST EFI_STATUS_CODE_DATA     *Data OPTIONAL

   );

 

-#endif //__PEI_STATUS_CODE_H__

+#endif