Update the copyright notice format

[mirror_edk2.git] / IntelFrameworkModulePkg / Library / PeiS3Lib / PeiS3Lib.c

diff --git a/IntelFrameworkModulePkg/Library/PeiS3Lib/PeiS3Lib.c b/IntelFrameworkModulePkg/Library/PeiS3Lib/PeiS3Lib.c
index 875e1169f2301c3abe724c2c1e8b2d8b93c33222..d16e3cac24e11d1a4e472730cf0137de0644d8eb 100644 (file)
--- a/IntelFrameworkModulePkg/Library/PeiS3Lib/PeiS3Lib.c
+++ b/IntelFrameworkModulePkg/Library/PeiS3Lib/PeiS3Lib.c
@@ -1,8 +1,12 @@
-/**@file\r
-  S3 Library. This library class defines a set of methods related do S3 mode\r
+/** @file\r
+  This library provides API to invoke the S3 resume vector in the APCI Table in S3 resume mode. \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_S3_RESUME_PPI defined\r
+  in PI 1.2 specification. \r
+\r
+Copyright (c) 2006 - 2008, 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
@@ -11,7 +15,8 @@ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
-#include <FrameworkPei.h>\r
+\r
+#include <PiPei.h>\r
 #include <Library/PeiServicesLib.h>\r
 #include <Library/PeiServicesTablePointerLib.h>\r
 #include <Library/DebugLib.h>\r
@@ -19,14 +24,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Ppi/S3Resume.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
@@ -41,6 +46,6 @@ S3RestoreConfig (
              );\r
   ASSERT_EFI_ERROR (Status);\r
 \r
-  return S3Resume->S3RestoreConfig (GetPeiServicesTablePointer()); \r
+  return S3Resume->S3RestoreConfig ((EFI_PEI_SERVICES  **) GetPeiServicesTablePointer()); \r
 }\r
 \r