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

/** @file\r
  System reset Library Services.  This library class defines a set of\r
  methods that reset the whole system.\r
\r
Copyright (c) 2005 - 2010, 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 __RESET_SYSTEM_LIB_H__\r
#define __RESET_SYSTEM_LIB_H__\r
\r
/**\r
  This function causes a system-wide reset (cold reset), in which\r
  all circuitry within the system returns to its initial state. This type of reset \r
  is asynchronous to system operation and operates without regard to \r
  cycle boundaries.\r
\r
  If this function returns, it means that the system does not support cold reset. \r
**/\r
VOID\r
EFIAPI\r
ResetCold (\r
  VOID\r
  );\r
\r
/**\r
  This function causes a system-wide initialization (warm reset), in which all processors \r
  are set to their initial state. Pending cycles are not corrupted.\r
\r
  If this function returns, it means that the system does not support warm reset.\r
**/\r
VOID\r
EFIAPI\r
ResetWarm (\r
  VOID\r
  );\r
\r
/**\r
  This function causes the system to enter a power state equivalent \r
  to the ACPI G2/S5 or G3 states.\r
  \r
  If this function returns, it means that the system does not support shutdown reset.\r
**/\r
VOID\r
EFIAPI\r
ResetShutdown (\r
  VOID\r
  );\r
\r
/**\r
  This function causes the system to enter S3 and then wake up immediately.\r
  \r
  If this function returns, it means that the system does not support S3 feature.\r
**/\r
VOID\r
EFIAPI\r
EnterS3WithImmediateWake (\r
  VOID\r
  );\r
  \r
#endif\r
Commit	Line	Data
	1	/** @file\r
	2	System reset Library Services. This library class defines a set of\r
	3	methods that reset the whole system.\r
	4	\r
	5	Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved.<BR>\r
	6	This program and the accompanying materials are licensed and made available under \r
	7	the terms and conditions of the BSD License that accompanies this distribution. \r
	8	The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php. \r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	**/\r
	15	\r
	16	#ifndef __RESET_SYSTEM_LIB_H__\r
	17	#define __RESET_SYSTEM_LIB_H__\r
	18	\r
	19	/**\r
	20	This function causes a system-wide reset (cold reset), in which\r
	21	all circuitry within the system returns to its initial state. This type of reset \r
	22	is asynchronous to system operation and operates without regard to \r
	23	cycle boundaries.\r
	24	\r
	25	If this function returns, it means that the system does not support cold reset. \r
	26	**/\r
	27	VOID\r
	28	EFIAPI\r
	29	ResetCold (\r
	30	VOID\r
	31	);\r
	32	\r
	33	/**\r
	34	This function causes a system-wide initialization (warm reset), in which all processors \r
	35	are set to their initial state. Pending cycles are not corrupted.\r
	36	\r
	37	If this function returns, it means that the system does not support warm reset.\r
	38	**/\r
	39	VOID\r
	40	EFIAPI\r
	41	ResetWarm (\r
	42	VOID\r
	43	);\r
	44	\r
	45	/**\r
	46	This function causes the system to enter a power state equivalent \r
	47	to the ACPI G2/S5 or G3 states.\r
	48	\r
	49	If this function returns, it means that the system does not support shutdown reset.\r
	50	**/\r
	51	VOID\r
	52	EFIAPI\r
	53	ResetShutdown (\r
	54	VOID\r
	55	);\r
	56	\r
	57	/**\r
	58	This function causes the system to enter S3 and then wake up immediately.\r
	59	\r
	60	If this function returns, it means that the system does not support S3 feature.\r
	61	**/\r
	62	VOID\r
	63	EFIAPI\r
	64	EnterS3WithImmediateWake (\r
	65	VOID\r
	66	);\r
	67	\r
	68	#endif\r