[mirror_edk2.git] / MdeModulePkg / Include / Library / S3Lib.h

/** @file\r
  S3 library class defines a set of methods related to S3 boot mode.\r
  This library class is no longer used and modules using this library should\r
  directly locate EFI_PEI_S3_RESUME_PPI, defined in the PI 1.2 specification.\r
\r
Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __S3_LIB_H__\r
#define __S3_LIB_H__\r
\r
/**\r
  This function is responsible for calling the S3 resume vector in the ACPI Tables.\r
\r
  @retval EFI_SUCCESS   Successfully restored the configuration from S3.\r
  @retval Others       Failed to restore the configuration from S3.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AcpiS3ResumeOs (\r
  VOID\r
  );\r
\r
#endif\r
\r
Commit	Line	Data
4fb31c2c	1	/** @file\r
e9b67286	2	S3 library class defines a set of methods related to S3 boot mode.\r
5933acc3	3	This library class is no longer used and modules using this library should\r
64a80549	4	directly locate EFI_PEI_S3_RESUME_PPI, defined in the PI 1.2 specification.\r
4fb31c2c	5	\r
d1102dba	6	Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>\r
9d510e61	7	SPDX-License-Identifier: BSD-2-Clause-Patent\r
4fb31c2c	8	\r
	9	**/\r
	10	\r
	11	#ifndef __S3_LIB_H__\r
	12	#define __S3_LIB_H__\r
	13	\r
	14	/**\r
e8da1266	15	This function is responsible for calling the S3 resume vector in the ACPI Tables.\r
d1102dba	16	\r
64a80549	17	@retval EFI_SUCCESS Successfully restored the configuration from S3.\r
64a80549	18	@retval Others Failed to restore the configuration from S3.\r
1e354c03	19	\r
4fb31c2c	20	**/\r
	21	EFI_STATUS\r
	22	EFIAPI\r
e8da1266	23	AcpiS3ResumeOs (\r
4fb31c2c	24	VOID\r
ed66e1bc	25	);\r
4fb31c2c	26	\r
	27	#endif\r
	28	\r