MdeModulePkg/Include/Library/S3Lib.h

   1 /** @file
   2   S3 library class defines a set of methods related to S3 boot mode.
   3   This library class is no longer used and modules using this library should
   4   directly locate EFI_PEI_S3_RESUME_PPI, defined in the PI 1.2 specification.
   5
   6 Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>
   7 This program and the accompanying materials are licensed and made available under
   8 the terms and conditions of the BSD License that accompanies this distribution.
   9 The full text of the license may be found at
  10 http://opensource.org/licenses/bsd-license.php.
  11
  12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15 **/
  16
  17 #ifndef __S3_LIB_H__
  18 #define __S3_LIB_H__
  19
  20 /**
  21   This function is responsible for calling the S3 resume vector in the ACPI Tables.
  22
  23   @retval EFI_SUCCESS   Successfully restored the configuration from S3.
  24   @retval Others       Failed to restore the configuration from S3.
  25
  26 **/
  27 EFI_STATUS
  28 EFIAPI
  29 AcpiS3ResumeOs (
  30   VOID
  31   );
  32
  33 #endif
  34