MdeModulePkg: add error handling when DXE IPL PPI is not found.

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

diff --git a/MdeModulePkg/Core/Pei/StatusCode/StatusCode.c b/MdeModulePkg/Core/Pei/StatusCode/StatusCode.c
index 9112c45dc91aacf2ba961c6ee287e34cc6bb631a..a7fb524ff4072dcf2bdebb282dfe2f56af38b2d2 100644 (file)
--- a/MdeModulePkg/Core/Pei/StatusCode/StatusCode.c
+++ b/MdeModulePkg/Core/Pei/StatusCode/StatusCode.c
@@ -1,7 +1,8 @@
-/*++\r
-\r
-Copyright (c) 2006, Intel Corporation                                                         \r
-All rights reserved. This program and the accompanying materials                          \r
+/** @file\r
+  Pei Core Status Code Support\r
+  \r
+Copyright (c) 2006, Intel Corporation. All rights reserved.<BR>\r
+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
@@ -9,68 +10,42 @@ 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
 \r
-  StatusCode.c\r
+#include "PeiMain.h"\r
 \r
-Abstract:\r
+/**\r
 \r
-  Pei Core Status Code Support\r
-\r
-Revision History\r
+  Core version of the Status Code reporter\r
 \r
---*/\r
 \r
-//\r
-// Include common header file for this module.\r
-//\r
-#include "CommonHeader.h"\r
+  @param PeiServices     An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param CodeType        Type of Status Code.\r
+  @param Value           Value to output for Status Code.\r
+  @param Instance        Instance Number of this status code.\r
+  @param CallerId        ID of the caller of this status code.\r
+  @param Data            Optional data associated with this status code.\r
 \r
-#include <PeiMain.h>\r
+  @retval EFI_SUCCESS             if status code is successfully reported\r
+  @retval EFI_NOT_AVAILABLE_YET   if StatusCodePpi has not been installed\r
 \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 PeiReportStatusCode (\r
-  IN 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_GUID                 *CallerId,\r
-  IN EFI_STATUS_CODE_DATA     *Data OPTIONAL\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 CONST EFI_GUID                 *CallerId,\r
+  IN CONST EFI_STATUS_CODE_DATA     *Data OPTIONAL\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Core version of the Status Code reporter\r
-\r
-Arguments:\r
-\r
-  PeiServices - The PEI core services table.\r
-  \r
-  CodeType    - Type of Status Code.\r
-  \r
-  Value       - Value to output for Status Code.\r
-  \r
-  Instance    - Instance Number of this status code.\r
-  \r
-  CallerId    - ID of the caller of this status code.\r
-  \r
-  Data        - Optional data associated with this status code.\r
-\r
-Returns:\r
-\r
-  Status  - EFI_SUCCESS             if status code is successfully reported\r
-          - EFI_NOT_AVAILABLE_YET   if StatusCodePpi has not been installed\r
-\r
---*/\r
 {\r
   EFI_STATUS                Status;\r
   EFI_PEI_PROGRESS_CODE_PPI *StatusCodePpi;\r
-  \r
 \r
   //\r
-  //Locate StatusCode Ppi.\r
+  // Locate StatusCode Ppi.\r
   //\r
   Status = PeiServicesLocatePpi (\r
              &gEfiPeiStatusCodePpiGuid,         \r
@@ -92,7 +67,6 @@ Returns:
    return Status;   \r
   } \r
   \r
-  \r
   return  EFI_NOT_AVAILABLE_YET; \r
 }\r
 \r