MdePkg: Apply uncrustify changes

[mirror_edk2.git] / MdePkg / Library / PeimEntryPoint / PeimEntryPoint.c

diff --git a/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c b/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c
index 286c2df9e8b9e08d03ae16c8ce61ecded6428dfa..42aab62f5d5dfe3b2f6586c69bbd68277052c129 100644 (file)
--- a/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c
+++ b/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c
@@ -1,39 +1,34 @@
 /** @file\r
   Entry point to a PEIM.\r
 \r
-Copyright (c) 2006, Intel Corporation<BR>\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 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
-\r
 #include <PiPei.h>\r
 \r
-\r
 #include <Library/PeimEntryPoint.h>\r
 #include <Library/DebugLib.h>\r
 \r
 /**\r
-  Image entry point of Peim.\r
+  The entry point of PE/COFF Image for a PEIM.\r
 \r
-  @param  FileHandle  Handle of the file being invoked. \r
-                      Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().\r
-  @param  PeiServices Describes the list of possible PEI Services.\r
+  This function is the entry point for a PEIM.  This function must call ProcessLibraryConstructorList()\r
+  and ProcessModuleEntryPointList().  The return value from ProcessModuleEntryPointList() is returned.\r
+  If _gPeimRevision is not zero and PeiServices->Hdr.Revision is less than _gPeimRevison, then ASSERT().\r
 \r
-  @return  Status returned by entry points of Peims.\r
+  @param  FileHandle  Handle of the file being invoked.\r
+  @param  PeiServices Describes the list of possible PEI Services.\r
 \r
+  @retval  EFI_SUCCESS   The PEIM executed normally.\r
+  @retval  !EFI_SUCCESS  The PEIM failed to execute normally.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
 _ModuleEntryPoint (\r
-  IN EFI_PEI_FILE_HANDLE       FileHandle,\r
-  IN CONST EFI_PEI_SERVICES    **PeiServices\r
+  IN EFI_PEI_FILE_HANDLE     FileHandle,\r
+  IN CONST EFI_PEI_SERVICES  **PeiServices\r
   )\r
 {\r
   if (_gPeimRevision != 0) {\r
@@ -54,22 +49,23 @@ _ModuleEntryPoint (
   return ProcessModuleEntryPointList (FileHandle, PeiServices);\r
 }\r
 \r
-\r
 /**\r
-  Wrapper of Peim image entry point.\r
+  Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().\r
+\r
+  This function is required to call _ModuleEntryPoint() passing in FileHandle and PeiServices.\r
 \r
-  @param  FileHandle  Handle of the file being invoked. \r
-                      Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().\r
+  @param  FileHandle  Handle of the file being invoked.\r
   @param  PeiServices Describes the list of possible PEI Services.\r
 \r
-  @return  Status returned by entry points of Peims.\r
+  @retval EFI_SUCCESS  The PEIM executed normally.\r
+  @retval !EFI_SUCCESS The PEIM failed to execute normally.\r
 \r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
 EfiMain (\r
-  IN EFI_PEI_FILE_HANDLE      FileHandle,\r
-  IN CONST EFI_PEI_SERVICES   **PeiServices\r
+  IN EFI_PEI_FILE_HANDLE     FileHandle,\r
+  IN CONST EFI_PEI_SERVICES  **PeiServices\r
   )\r
 {\r
   return _ModuleEntryPoint (FileHandle, PeiServices);\r