IntelFrameworkModulePkg: Replace BSD License with BSD+Patent License

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

/** @file\r
  This library provides API to invoke the S3 resume vector in the APCI Table in S3 resume mode.\r
\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 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <PiPei.h>\r
#include <Library/PeiServicesLib.h>\r
#include <Library/PeiServicesTablePointerLib.h>\r
#include <Library/DebugLib.h>\r
\r
#include <Ppi/S3Resume.h>\r
\r
/**\r
  This function is responsible for calling the S3 resume vector in the ACPI Tables.\r
\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
AcpiS3ResumeOs (\r
  VOID\r
  )\r
{\r
  EFI_STATUS              Status;\r
  EFI_PEI_S3_RESUME_PPI   *S3Resume;\r
\r
  Status = PeiServicesLocatePpi (\r
             &gEfiPeiS3ResumePpiGuid,\r
             0,\r
             NULL,\r
             (VOID **)&S3Resume\r
             );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return S3Resume->S3RestoreConfig ((EFI_PEI_SERVICES  **) GetPeiServicesTablePointer());\r
}\r
\r