diff options
author | qhuang8 <qhuang8@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-08-11 15:51:48 +0000 |
---|---|---|
committer | qhuang8 <qhuang8@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-08-11 15:51:48 +0000 |
commit | 5933acc3cb1ac1a344a34342d0ac46d3afed929a (patch) | |
tree | 111ffb2d3aee97dfed6ea2dfd92bcb5ec12d9c21 /MdeModulePkg | |
parent | 28efc722c49a974e8d77f4a8d4782b4e1a0a2f5f (diff) | |
download | edk2-platforms-5933acc3cb1ac1a344a34342d0ac46d3afed929a.tar.xz |
Update the comments for S3Lib and RecoveryLib class and instance to state that they are deprecated.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9047 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg')
6 files changed, 23 insertions, 7 deletions
diff --git a/MdeModulePkg/Include/Library/RecoveryLib.h b/MdeModulePkg/Include/Library/RecoveryLib.h index 484ff76c3a..a04b19ab65 100644 --- a/MdeModulePkg/Include/Library/RecoveryLib.h +++ b/MdeModulePkg/Include/Library/RecoveryLib.h @@ -1,5 +1,7 @@ /** @file
- Recovery library class defines a set of methods related recovery boot mode.
+ Recovery library class defines a set of methods related recovery boot mode.
+ This library class is no longer used and modules using this library should
+ directly locate EFI_PEI_RECOVERY_MODULE_PPI defined in PI 1.2 specification.
Copyright (c) 2005 - 2008, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
diff --git a/MdeModulePkg/Include/Library/S3Lib.h b/MdeModulePkg/Include/Library/S3Lib.h index f97b6b5460..6eda9f6022 100644 --- a/MdeModulePkg/Include/Library/S3Lib.h +++ b/MdeModulePkg/Include/Library/S3Lib.h @@ -1,5 +1,7 @@ /** @file
S3 library class defines a set of methods related to S3 boot mode.
+ This library class is no longer used and modules using this library should
+ directly locate EFI_PEI_S3_RESUME_PPI defined in PI 1.2 specification.
Copyright (c) 2005 - 2008, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
diff --git a/MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.c b/MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.c index 1f60871a66..62d629577e 100644 --- a/MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.c +++ b/MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.c @@ -1,5 +1,9 @@ /** @file
- Null Recovery Library instance does nothing and returns unsupport status.
+ Null Recovery Library instance does nothing and returns unsupported status.
+
+ This library instance is no longer used and module using this library
+ class should update to directly locate EFI_PEI_RECOVERY_MODULE_PPI defined
+ in PI 1.2 specification.
Copyright (c) 2006 - 2008, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
diff --git a/MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.inf b/MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.inf index cdfbb49af5..d169fabb09 100644 --- a/MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.inf +++ b/MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.inf @@ -1,7 +1,9 @@ #/** @file
#
# Null Recovery library instance for PEIM module
-# It can make core modules pass package level build.
+# This library instance is no longer used and module using this library
+# class should update to directly locate EFI_PEI_RECOVERY_MODULE_PPI defined
+# in PI 1.2 specification.
#
# Copyright (c) 2006 - 2008, Intel Corporation. <BR>
# All rights reserved. This program and the accompanying materials
diff --git a/MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.c b/MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.c index 096a6af885..51f618d769 100644 --- a/MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.c +++ b/MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.c @@ -1,5 +1,9 @@ /** @file
- Null S3 Library instance does nothing and returns unsupport status.
+ Null S3 Library instance does nothing and returns unsupported status.
+
+ This library instance is no longer used and module using this library
+ class should update to directly locate EFI_PEI_S3_RESUME_PPI defined
+ in PI 1.2 specification.
Copyright (c) 2006 - 2008, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
@@ -17,7 +21,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /**
This function is responsible for calling the S3 resume vector in the ACPI Tables.
- @retval EFI_SUCESS Sucess to restore config from S3.
+ @retval EFI_SUCESS Success to restore config from S3.
@retval Others Fail to restore config from S3.
**/
EFI_STATUS
diff --git a/MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.inf b/MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.inf index df99874b38..eff10d1d01 100644 --- a/MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.inf +++ b/MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.inf @@ -1,7 +1,9 @@ #/** @file
#
-# Null S3 library instance for PEIM module
-# It can make core modules pass package level build.
+# Null S3 library instance for PEIM module.
+# This library instance is no longer used and module using this library
+# class should update to directly locate EFI_PEI_S3_RESUME_PPI defined
+# in PI 1.2 specification.
#
# Copyright (c) 2006 - 2008, Intel Corporation.
#
|