MdeModulePkg: Clean up source files

[mirror_edk2.git] / MdeModulePkg / Library / PeiRecoveryLibNull / PeiRecoveryLibNull.c

diff --git a/MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.c b/MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.c
index 26389556886f1bb1cbe1e3dee0625a55ed02957b..f39a21b711673d7d042d58061111c433e894b12d 100644 (file)
--- a/MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.c
+++ b/MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.c
@@ -1,8 +1,12 @@
-/**@file\r
-  Recovery Library. This library class defines a set of methods related do recovery.\r
+/** @file\r
+  Null Recovery Library instance does nothing and returns unsupported status.\r
 \r
-Copyright (c) 2006 - 2007 Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+  This library instance is no longer used and module using this library\r
+  class should update to directly locate EFI_PEI_RECOVERY_MODULE_PPI defined\r
+  in PI 1.2 specification.\r
+\r
+Copyright (c) 2006 - 2018, 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
@@ -12,16 +16,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 #include <PiPei.h>\r
+#include <Library/RecoveryLib.h>\r
 \r
 /**\r
-  Calling this function causes the system do recovery.\r
-  \r
-  @retval EFI_SUCESS   Sucess to do recovery.\r
-  @retval Others       Fail to do recovery.\r
+  Calling this function causes the system do recovery boot path.\r
+\r
+  @retval EFI_UNSUPPORTED       Recovery is not supported.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
-Recovery (\r
+PeiRecoverFirmware (\r
   VOID\r
   )\r
 {\r