]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Include/Library/ResetSystemLib.h
Committing changes to the comments, to improve code documentation.
[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
5 Copyright (c) 2005 - 2007, Intel Corporation\r
6 All rights reserved. This program and the accompanying materials\r
7 are licensed and made available under the terms and conditions of the BSD License\r
8 which accompanies this distribution. 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
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
e9b67286 49 If this function returns, it means the system does \r
30143b15 50 not support shut down reset.\r
51**/\r
52VOID\r
53EFIAPI\r
54ResetShutdown (\r
55 VOID\r
56 );\r
57\r
58/**\r
e9b67286 59 This function causes the system to enter S3 and then\r
30143b15 60 wake up immediately.\r
61 \r
e9b67286 62 If this function returns, it means the\r
63 system does not support the feature.\r
30143b15 64**/\r
65VOID\r
66EFIAPI\r
67EnterS3WithImmediateWake (\r
68 VOID\r
69 );\r
70#endif\r