Modules clean up.

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

1 files changed, 73 insertions, 53 deletions

diff --git a/IntelFrameworkModulePkg/Universal/StatusCode/Pei/PeiStatusCode.h b/IntelFrameworkModulePkg/Universal/StatusCode/Pei/PeiStatusCode.h
index c8c004d6cd..48675056e1 100644
--- a/IntelFrameworkModulePkg/Universal/StatusCode/Pei/PeiStatusCode.h
+++ b/IntelFrameworkModulePkg/Universal/StatusCode/Pei/PeiStatusCode.h
@@ -2,14 +2,14 @@
 /** @file

   Heade file of status code PEIM

 

-  Copyright (c) 2006, 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        

-  http://opensource.org/licenses/bsd-license.php                                            

-                                                                                            

-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+  Copyright (c) 2006, 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

+  http://opensource.org/licenses/bsd-license.php

+

+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

   Module Name:  PeiStatusCode.h

 

@@ -20,35 +20,55 @@
 

 

 //

-// Include common header file for this module.

+// The package level header files this module uses

+//

+#include <FrameworkPei.h>

+//

+// The protocols, PPI and GUID defintions for this module

+//

+#include <Guid/MemoryStatusCodeRecord.h>

+#include <Guid/StatusCodeDataTypeId.h>

+#include <Ppi/StatusCode.h>

+//

+// The Library classes this module consumes

 //

-#include "CommonHeader.h"

+#include <Library/BaseLib.h>

+#include <Library/BaseMemoryLib.h>

+#include <Library/DebugLib.h>

+#include <Library/PrintLib.h>

+#include <Library/ReportStatusCodeLib.h>

+#include <Library/SerialPortLib.h>

+#include <Library/HobLib.h>

+#include <Library/PcdLib.h>

+#include <Library/PeiServicesLib.h>

+#include <Library/OemHookStatusCodeLib.h>

+#include <Library/PeimEntryPoint.h>

 

 /**

   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.  

+

+  @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, 

+

+  @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  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 EFI 1.10 Specification.

 

 

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

- 

+

   @return               The function always return EFI_SUCCESS.

 

 **/

@@ -64,9 +84,9 @@ SerialStatusCodeReportWorker (
 

 /**

   Initialize memory status code.

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

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

   GUID'ed HOB failed, then ASSERT().

- 

+

   @return           The function always return EFI_SUCCESS

 

 **/

@@ -77,21 +97,21 @@ 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.

- 

-  @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.  

+

+  @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, 

+

+  @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.

 

 **/

@@ -104,27 +124,27 @@ MemoryStatusCodeReportWorker (
 

 /**

   Report status code to all supported device.

-  

-  

+

+

   @param  PeiServices

 

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

+  @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.  

+  @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 

+  @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. 

+  @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 

+  @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.