]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Library/PeiResetSystemLib/PeiResetSystemLib.c
UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm
[mirror_edk2.git] / MdeModulePkg / Library / PeiResetSystemLib / PeiResetSystemLib.c
CommitLineData
ce3cd892
MK
1/** @file\r
2 PEI Reset System Library instance that calls the ResetSystem2() PEI Service.\r
3\r
049974bd 4 Copyright (c) 2017 - 2019, Intel Corporation. All rights reserved.<BR>\r
9d510e61 5 SPDX-License-Identifier: BSD-2-Clause-Patent\r
ce3cd892
MK
6\r
7**/\r
8\r
9#include <PiPei.h>\r
10#include <Library/ResetSystemLib.h>\r
11#include <Library/PeiServicesLib.h>\r
12\r
13/**\r
14 This function causes a system-wide reset (cold reset), in which\r
d1102dba 15 all circuitry within the system returns to its initial state. This type of reset\r
ce3cd892
MK
16 is asynchronous to system operation and operates without regard to\r
17 cycle boundaries.\r
18\r
d1102dba 19 If this function returns, it means that the system does not support cold reset.\r
ce3cd892
MK
20**/\r
21VOID\r
22EFIAPI\r
23ResetCold (\r
24 VOID\r
25 )\r
26{\r
27 PeiServicesResetSystem2 (EfiResetCold, EFI_SUCCESS, 0, NULL);\r
28}\r
29\r
30/**\r
d1102dba 31 This function causes a system-wide initialization (warm reset), in which all processors\r
ce3cd892
MK
32 are set to their initial state. Pending cycles are not corrupted.\r
33\r
34 If this function returns, it means that the system does not support warm reset.\r
35**/\r
36VOID\r
37EFIAPI\r
38ResetWarm (\r
39 VOID\r
40 )\r
41{\r
42 PeiServicesResetSystem2 (EfiResetWarm, EFI_SUCCESS, 0, NULL);\r
43}\r
44\r
45/**\r
d1102dba 46 This function causes the system to enter a power state equivalent\r
ce3cd892
MK
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 shut down reset.\r
50**/\r
51VOID\r
52EFIAPI\r
53ResetShutdown (\r
54 VOID\r
55 )\r
56{\r
57 PeiServicesResetSystem2 (EfiResetShutdown, EFI_SUCCESS, 0, NULL);\r
58}\r
59\r
ce3cd892
MK
60/**\r
61 This function causes a systemwide reset. The exact type of the reset is\r
62 defined by the EFI_GUID that follows the Null-terminated Unicode string passed\r
63 into ResetData. If the platform does not recognize the EFI_GUID in ResetData\r
64 the platform must pick a supported reset type to perform.The platform may\r
65 optionally log the parameters from any non-normal reset that occurs.\r
66\r
67 @param[in] DataSize The size, in bytes, of ResetData.\r
68 @param[in] ResetData The data buffer starts with a Null-terminated string,\r
69 followed by the EFI_GUID.\r
70**/\r
71VOID\r
72EFIAPI\r
73ResetPlatformSpecific (\r
1436aea4
MK
74 IN UINTN DataSize,\r
75 IN VOID *ResetData\r
ce3cd892
MK
76 )\r
77{\r
78 PeiServicesResetSystem2 (EfiResetPlatformSpecific, EFI_SUCCESS, DataSize, ResetData);\r
79}\r
049974bd
ZG
80\r
81/**\r
82 The ResetSystem function resets the entire platform.\r
83\r
84 @param[in] ResetType The type of reset to perform.\r
85 @param[in] ResetStatus The status code for the reset.\r
86 @param[in] DataSize The size, in bytes, of ResetData.\r
87 @param[in] ResetData For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown\r
88 the data buffer starts with a Null-terminated string, optionally\r
89 followed by additional binary data. The string is a description\r
90 that the caller may use to further indicate the reason for the\r
99d7570a 91 system reset.\r
049974bd
ZG
92**/\r
93VOID\r
94EFIAPI\r
95ResetSystem (\r
1436aea4
MK
96 IN EFI_RESET_TYPE ResetType,\r
97 IN EFI_STATUS ResetStatus,\r
98 IN UINTN DataSize,\r
99 IN VOID *ResetData OPTIONAL\r
049974bd
ZG
100 )\r
101{\r
102 PeiServicesResetSystem2 (ResetType, ResetStatus, DataSize, ResetData);\r
103}\r