Fix function comment to follows doxygen format.

[mirror_edk2.git] / MdeModulePkg / Core / Pei / PeiMain / PeiMain.c

diff --git a/MdeModulePkg/Core/Pei/PeiMain/PeiMain.c b/MdeModulePkg/Core/Pei/PeiMain/PeiMain.c
index 85dbbd1a6a3e658dc19e7687266128d2fd127253..056165e689931cbc1469ba281d767615ba787c46 100644 (file)
--- a/MdeModulePkg/Core/Pei/PeiMain/PeiMain.c
+++ b/MdeModulePkg/Core/Pei/PeiMain/PeiMain.c
@@ -1,5 +1,6 @@
 /** @file\r
-\r
+  Pei Core Main Entry Point\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
@@ -9,21 +10,11 @@ http://opensource.org/licenses/bsd-license.php
 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:\r
-\r
-  PeiMain.c\r
-\r
-Abstract:\r
-\r
-  Pei Core Main Entry Point\r
-\r
-Revision History\r
-\r
 **/\r
 \r
 #include <PeiMain.h>\r
 \r
-static EFI_PEI_PPI_DESCRIPTOR mMemoryDiscoveredPpi = {\r
+STATIC EFI_PEI_PPI_DESCRIPTOR mMemoryDiscoveredPpi = {\r
   (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
   &gEfiPeiMemoryDiscoveredPpiGuid,\r
   NULL\r
@@ -33,7 +24,7 @@ static EFI_PEI_PPI_DESCRIPTOR mMemoryDiscoveredPpi = {
 // Pei Core Module Variables\r
 //\r
 //\r
-static EFI_PEI_SERVICES  mPS = {\r
+STATIC EFI_PEI_SERVICES  gPs = {\r
   {\r
     PEI_SERVICES_SIGNATURE,\r
     PEI_SERVICES_REVISION,\r
@@ -74,41 +65,35 @@ static EFI_PEI_SERVICES  mPS = {
   PeiRegisterForShadow\r
 };\r
 \r
-EFI_STATUS\r
-EFIAPI\r
-PeiCore (\r
-  IN CONST EFI_SEC_PEI_HAND_OFF        *SecCoreData,\r
-  IN CONST EFI_PEI_PPI_DESCRIPTOR      *PpiList,\r
-  IN VOID                              *Data\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
 \r
   The entry routine to Pei Core, invoked by PeiMain during transition\r
   from SEC to PEI. After switching stack in the PEI core, it will restart\r
   with the old core data.\r
 \r
-Arguments:\r
 \r
-  SecCoreData          - Points to a data structure containing information about the PEI core's operating\r
+  @param SecCoreData     Points to a data structure containing information about the PEI core's operating\r
                          environment, such as the size and location of temporary RAM, the stack location and\r
                          the BFV location.\r
-  PpiList              - Points to a list of one or more PPI descriptors to be installed initially by the PEI core.\r
+  @param PpiList         Points to a list of one or more PPI descriptors to be installed initially by the PEI core.\r
                          An empty PPI list consists of a single descriptor with the end-tag\r
                          EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. As part of its initialization\r
                          phase, the PEI Foundation will add these SEC-hosted PPIs to its PPI database such\r
                          that both the PEI Foundation and any modules can leverage the associated service\r
                          calls and/or code in these early PPIs\r
-  Data                 - Pointer to old core data that is used to initialize the\r
+  @param Data            Pointer to old core data that is used to initialize the\r
                          core's data areas.\r
 \r
-Returns:\r
+  @retval EFI_NOT_FOUND  Never reach\r
 \r
-  This function never returns\r
-  EFI_NOT_FOUND        - Never reach\r
-\r
---*/\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PeiCore (\r
+  IN CONST EFI_SEC_PEI_HAND_OFF        *SecCoreData,\r
+  IN CONST EFI_PEI_PPI_DESCRIPTOR      *PpiList,\r
+  IN VOID                              *Data\r
+  )\r
 {\r
   PEI_CORE_INSTANCE                                     PrivateData;\r
   EFI_STATUS                                            Status;\r
@@ -144,14 +129,14 @@ Returns:
     CpuIo = (VOID*)PrivateData.ServiceTableShadow.CpuIo;\r
     PciCfg = (VOID*)PrivateData.ServiceTableShadow.PciCfg;\r
     \r
-    CopyMem (&PrivateData.ServiceTableShadow, &mPS, sizeof (mPS));\r
+    CopyMem (&PrivateData.ServiceTableShadow, &gPs, sizeof (gPs));\r
     \r
     PrivateData.ServiceTableShadow.CpuIo  = CpuIo;\r
     PrivateData.ServiceTableShadow.PciCfg = PciCfg;\r
   } else {\r
     ZeroMem (&PrivateData, sizeof (PEI_CORE_INSTANCE));\r
     PrivateData.Signature = PEI_CORE_HANDLE_SIGNATURE;\r
-    CopyMem (&PrivateData.ServiceTableShadow, &mPS, sizeof (mPS));\r
+    CopyMem (&PrivateData.ServiceTableShadow, &gPs, sizeof (gPs));\r
   }\r
 \r
   PrivateData.PS = &PrivateData.ServiceTableShadow;\r