OvmfPkg/ResetSystemLib: factor out ResetShutdown()

[mirror_edk2.git] / OvmfPkg / Library / ResetSystemLib / ResetSystemLib.c

diff --git a/OvmfPkg/Library/ResetSystemLib/ResetSystemLib.c b/OvmfPkg/Library/ResetSystemLib/ResetSystemLib.c
index 308a6002149dcb05884f46890c46c102ce47d972..fe51f53d1df2d057aeb959fb7161e579b4359f13 100644 (file)
--- a/OvmfPkg/Library/ResetSystemLib/ResetSystemLib.c
+++ b/OvmfPkg/Library/ResetSystemLib/ResetSystemLib.c
@@ -1,37 +1,17 @@
 /** @file\r
   Reset System Library functions for OVMF\r
 \r
-  Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>\r
-  This program and the accompanying materials\r
-  are licensed and made available under the terms and conditions of the BSD License\r
-  which accompanies this distribution.  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
+  Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
-#include <Base.h>\r
-\r
-#include <Library/BaseLib.h>\r
-#include <Library/DebugLib.h>\r
-#include <Library/IoLib.h>\r
-#include <Library/TimerLib.h>\r
-\r
-#include <OvmfPlatforms.h>\r
-\r
-VOID\r
-AcpiPmControl (\r
-  UINTN SuspendType\r
-  )\r
-{\r
-  ASSERT (SuspendType < 6);\r
+#include <Base.h>                   // BIT1\r
 \r
-  IoBitFieldWrite16 (PIIX4_PMBA_VALUE + 4, 10, 13, (UINT16) SuspendType);\r
-  IoOr16 (PIIX4_PMBA_VALUE + 4, BIT13);\r
-  CpuDeadLoop ();\r
-}\r
+#include <Library/BaseLib.h>        // CpuDeadLoop()\r
+#include <Library/IoLib.h>          // IoWrite8()\r
+#include <Library/ResetSystemLib.h> // ResetCold()\r
+#include <Library/TimerLib.h>       // MicroSecondDelay()\r
 \r
 /**\r
   Calling this function causes a system-wide reset. This sets\r
@@ -72,38 +52,69 @@ ResetWarm (
   CpuDeadLoop ();\r
 }\r
 \r
-/**\r
-  Calling this function causes the system to enter a power state equivalent\r
-  to the ACPI G2/S5 or G3 states.\r
 \r
-  System shutdown should not return, if it returns, it means the system does\r
-  not support shut down reset.\r
+/**\r
+  This function causes a systemwide reset. The exact type of the reset is\r
+  defined by the EFI_GUID that follows the Null-terminated Unicode string\r
+  passed into ResetData. If the platform does not recognize the EFI_GUID in\r
+  ResetData the platform must pick a supported reset type to perform.The\r
+  platform may optionally log the parameters from any non-normal reset that\r
+  occurs.\r
+\r
+  @param[in]  DataSize   The size, in bytes, of ResetData.\r
+  @param[in]  ResetData  The data buffer starts with a Null-terminated string,\r
+                         followed by the EFI_GUID.\r
 **/\r
 VOID\r
 EFIAPI\r
-ResetShutdown (\r
-  VOID\r
+ResetPlatformSpecific (\r
+  IN UINTN   DataSize,\r
+  IN VOID    *ResetData\r
   )\r
 {\r
-  AcpiPmControl (0);\r
-  ASSERT (FALSE);\r
+  ResetCold ();\r
 }\r
 \r
-\r
 /**\r
-  Calling this function causes the system to enter a power state for capsule\r
-  update.\r
-\r
-  Reset update should not return, if it returns, it means the system does\r
-  not support capsule update.\r
-\r
+  The ResetSystem function resets the entire platform.\r
+\r
+  @param[in] ResetType      The type of reset to perform.\r
+  @param[in] ResetStatus    The status code for the reset.\r
+  @param[in] DataSize       The size, in bytes, of ResetData.\r
+  @param[in] ResetData      For a ResetType of EfiResetCold, EfiResetWarm, or\r
+                            EfiResetShutdown the data buffer starts with a\r
+                            Null-terminated string, optionally followed by\r
+                            additional binary data. The string is a description\r
+                            that the caller may use to further indicate the\r
+                            reason for the system reset.\r
 **/\r
 VOID\r
 EFIAPI\r
-EnterS3WithImmediateWake (\r
-  VOID\r
+ResetSystem (\r
+  IN EFI_RESET_TYPE               ResetType,\r
+  IN EFI_STATUS                   ResetStatus,\r
+  IN UINTN                        DataSize,\r
+  IN VOID                         *ResetData OPTIONAL\r
   )\r
 {\r
-  AcpiPmControl (1);\r
-  ASSERT (FALSE);\r
+  switch (ResetType) {\r
+  case EfiResetWarm:\r
+    ResetWarm ();\r
+    break;\r
+\r
+  case EfiResetCold:\r
+    ResetCold ();\r
+    break;\r
+\r
+  case EfiResetShutdown:\r
+    ResetShutdown ();\r
+    break;\r
+\r
+  case EfiResetPlatformSpecific:\r
+    ResetPlatformSpecific (DataSize, ResetData);\r
+    break;\r
+\r
+  default:\r
+    break;\r
+  }\r
 }\r