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