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