1. Correct File header to ## @file

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

diff --git a/MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.c b/MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.c
index 5bf65f9377c70f0955d50a96ea199a48c6bf5052..51f618d7693a7a5a0cf9c303d2a71987983f5787 100644 (file)
--- a/MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.c
+++ b/MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.c
@@ -1,7 +1,11 @@
-/**@file\r
-  S3 Library. This library class defines a set of methods related do S3 mode\r
+/** @file\r
+  Null S3 Library instance does nothing and returns unsupported status.\r
 \r
-Copyright (c) 2006 - 2007 Intel Corporation\r
+  This library instance is no longer used and module using this library\r
+  class should update to directly locate EFI_PEI_S3_RESUME_PPI defined\r
+  in PI 1.2 specification. \r
+\r
+Copyright (c) 2006 - 2008, 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
@@ -12,16 +16,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 #include <PiPei.h>\r
+#include <Library/S3Lib.h>\r
 \r
 /**\r
-  Calling this function causes the system restore config from S3.\r
+  This function is responsible for calling the S3 resume vector in the ACPI Tables.\r
   \r
-  @retval EFI_SUCESS   Sucess to restore config from S3.\r
+  @retval EFI_SUCESS   Success to restore config from S3.\r
   @retval Others       Fail to restore config from S3.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
-S3RestoreConfig (\r
+AcpiS3ResumeOs (\r
   VOID\r
   )\r
 {\r