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 SPDX-License-Identifier: BSD-2-Clause-Patent
   8
   9 **/
  10
  11 #ifndef __S3_LIB_H__
  12 #define __S3_LIB_H__
  13
  14 /**
  15   This function is responsible for calling the S3 resume vector in the ACPI Tables.
  16
  17   @retval EFI_SUCCESS   Successfully restored the configuration from S3.
  18   @retval Others       Failed to restore the configuration from S3.
  19
  20 **/
  21 EFI_STATUS
  22 EFIAPI
  23 AcpiS3ResumeOs (
  24   VOID
  25   );
  26
  27 #endif
  28