]> git.proxmox.com Git - mirror_edk2.git/blobdiff - ArmPlatformPkg/ArmVExpressPkg/Library/ResetSystemLib/ResetSystemLib.c
ArmPlatformPkg: remove NorFlashArmVExpressLib
[mirror_edk2.git] / ArmPlatformPkg / ArmVExpressPkg / Library / ResetSystemLib / ResetSystemLib.c
index b96e7e096f65089d9c114573faa8bdc7eac0250d..d2bc4a88fa5a99d5ce84f5ce493b7c09502d84e1 100644 (file)
@@ -1,11 +1,12 @@
 /** @file\r
   Template library implementation to support ResetSystem Runtime call.\r
-  \r
-  Fill in the templates with what ever makes you system reset.\r
 \r
+  Fill in the templates with what ever makes you system reset.\r
 \r
   Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
-  \r
+  Copyright (c) 2013, ARM Ltd. All rights reserved.<BR>\r
+  Copyright (c) 2017, Linaro Ltd. All rights reserved.<BR>\r
+\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
 \r
 **/\r
 \r
-#include <PiDxe.h>\r
+#include <Base.h>\r
 \r
-#include <Library/BaseLib.h>\r
-#include <Library/DebugLib.h>\r
-#include <Library/EfiResetSystemLib.h>\r
 #include <Library/ArmPlatformSysConfigLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/ResetSystemLib.h>\r
 \r
 #include <ArmPlatform.h>\r
 \r
 /**\r
-  Resets the entire platform.\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\r
+  reset 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\r
+  reset.\r
+**/\r
+VOID\r
+EFIAPI\r
+ResetCold (\r
+  VOID\r
+  )\r
+{\r
+  ArmPlatformSysConfigSet (SYS_CFG_REBOOT, 0);\r
+}\r
+\r
+/**\r
+  This function causes a system-wide initialization (warm reset), in which all\r
+  processors are set to their initial state. Pending cycles are not corrupted.\r
 \r
-  @param  ResetType             The type of reset to perform.\r
-  @param  ResetStatus           The status code for the reset.\r
-  @param  DataSize              The size, in bytes, of WatchdogData.\r
-  @param  ResetData             For a ResetType of EfiResetCold, EfiResetWarm, or\r
-                                EfiResetShutdown the data buffer starts with a Null-terminated\r
-                                Unicode string, optionally followed by additional binary data.\r
+  If this function returns, it means that the system does not support warm\r
+  reset.\r
+**/\r
+VOID\r
+EFIAPI\r
+ResetWarm (\r
+  VOID\r
+  )\r
+{\r
+  ResetCold ();\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 shut down reset.\r
 **/\r
-EFI_STATUS\r
+VOID\r
 EFIAPI\r
-LibResetSystem (\r
-  IN EFI_RESET_TYPE   ResetType,\r
-  IN EFI_STATUS       ResetStatus,\r
-  IN UINTN            DataSize,\r
-  IN CHAR16           *ResetData OPTIONAL\r
+ResetShutdown (\r
+  VOID\r
   )\r
 {\r
-  switch (ResetType) {\r
-  case EfiResetWarm:\r
-    // Map a warm reset into a cold reset\r
-  case EfiResetCold:\r
-    // Send the REBOOT function to the platform microcontroller\r
-    ArmPlatformSysConfigSet (SYS_CFG_REBOOT, 0);\r
-\r
-    // We should never be here\r
-    while(1);\r
-  case EfiResetShutdown:\r
-    // Send the SHUTDOWN function to the platform microcontroller\r
-    ArmPlatformSysConfigSet (SYS_CFG_SHUTDOWN, 0);\r
-\r
-    // We should never be here\r
-    while(1);\r
-  }\r
-\r
-  ASSERT(FALSE);\r
-  return EFI_UNSUPPORTED;\r
+  ArmPlatformSysConfigSet (SYS_CFG_SHUTDOWN, 0);\r
 }\r
 \r
 /**\r
-  Initialize any infrastructure required for LibResetSystem () to function.\r
+  This function causes the system to enter S3 and then wake up immediately.\r
 \r
-  @param  ImageHandle   The firmware allocated handle for the EFI image.\r
-  @param  SystemTable   A pointer to the EFI System Table.\r
-  \r
-  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
+  If this function returns, it means that the system does not support S3\r
+  feature.\r
+**/\r
+VOID\r
+EFIAPI\r
+EnterS3WithImmediateWake (\r
+  VOID\r
+  )\r
+{\r
+  // not implemented\r
+}\r
 \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 passed\r
+  into ResetData. If the platform does not recognize the EFI_GUID in ResetData\r
+  the platform must pick a supported reset type to perform.The platform may\r
+  optionally log the parameters from any non-normal reset that 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
-EFI_STATUS\r
+VOID\r
 EFIAPI\r
-LibInitializeResetSystem (\r
-  IN EFI_HANDLE        ImageHandle,\r
-  IN EFI_SYSTEM_TABLE  *SystemTable\r
+ResetPlatformSpecific (\r
+  IN UINTN   DataSize,\r
+  IN VOID    *ResetData\r
   )\r
 {\r
-  return EFI_SUCCESS;\r
+  ResetCold ();\r
 }\r