X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdeModulePkg%2FInclude%2FLibrary%2FS3Lib.h;h=2a309034fac9b910df7f8da05faa9f900e56573e;hp=ede541ab6c27c43cb1dd710401672b20699965c6;hb=9917def3294bac4d14cd86ba382652aa41c6c1d6;hpb=e8da1266b93d62d1998f73a7ec34bd54a074dbcf

diff --git a/MdeModulePkg/Include/Library/S3Lib.h b/MdeModulePkg/Include/Library/S3Lib.h
index ede541ab6c..2a309034fa 100644
--- a/MdeModulePkg/Include/Library/S3Lib.h
+++ b/MdeModulePkg/Include/Library/S3Lib.h
@@ -1,14 +1,16 @@
 /** @file
-  S3 Library. This library class defines a set of methods related do S3 mode.
+  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 the PI 1.2 specification.
 
-  Copyright (c) 2005 - 2007, Intel Corporation
-  All rights reserved. This program and the accompanying materials
-  are licensed and made available under the terms and conditions of the BSD License
-  which accompanies this distribution.  The full text of the license may be found at
-  http://opensource.org/licenses/bsd-license.php
-  
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>
+This program and the accompanying materials are licensed and made available under
+the terms and conditions of the BSD License that accompanies this distribution.
+The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php.
+
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
 **/
 
@@ -17,16 +19,16 @@
 
 /**
   This function is responsible for calling the S3 resume vector in the ACPI Tables.
-  
-  @retval EFI_SUCESS   Sucess to restore config from S3.
-  @retval Others       Fail to restore config from S3.
+
+  @retval EFI_SUCCESS   Successfully restored the configuration from S3.
+  @retval Others       Failed to restore the configuration from S3.
+
 **/
 EFI_STATUS
 EFIAPI
 AcpiS3ResumeOs (
   VOID
-  )
-;
+  );
 
 #endif