MdeModulePkg: Deprecate EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS

[mirror_edk2.git] / MdeModulePkg / Include / Library / RecoveryLib.h

diff --git a/MdeModulePkg/Include/Library/RecoveryLib.h b/MdeModulePkg/Include/Library/RecoveryLib.h
index 6ec4c58b8bf46bd9a346ed0d83bcb9d8cf93f74f..f49394a8224c237e7004c66e7adc6ff14037e6ba 100644 (file)
--- a/MdeModulePkg/Include/Library/RecoveryLib.h
+++ b/MdeModulePkg/Include/Library/RecoveryLib.h
@@ -1,14 +1,16 @@
 /** @file\r
-  Recovery Library. This library class defines a set of methods related recovery mode.\r
+  Recovery library class defines a set of methods related recovery boot mode. \r
+  This library class is no longer used and modules using this library should\r
+  directly locate EFI_PEI_RECOVERY_MODULE_PPI, defined in the PI 1.2 specification.\r
 \r
-  Copyright (c) 2005 - 2007, 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
-  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) 2005 - 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+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
 \r
 **/\r
 \r
@@ -16,17 +18,17 @@
 #define __RECOVERY_LIB_H__\r
 \r
 /**\r
-  Calling this function causes the system do recovery.\r
+  Calling this function causes the system to carry out a recovery boot path.\r
   \r
-  @retval EFI_SUCESS   Sucess to do recovery.\r
-  @retval Others       Fail to do recovery.\r
+  @retval EFI_SUCCESS   Recovery boot path succeeded.\r
+  @retval Others        Recovery boot path failure.\r
+\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
-Recovery (\r
+PeiRecoverFirmware (\r
   VOID\r
-  )\r
-;\r
+  );\r
 \r
 #endif\r
 \r