ArmVirtPkg: switch to generic ResetSystemRuntimeDxe

For obscure reasons, ARM platforms use a different implementation of
the ResetSystem() runtime service call than other platforms. So let's
switch all ArmVirtPkg platforms to the generic version instead.

Given that all platforms use an implementation of EfiResetSystemLib [as
consumed by the ResetRuntimeDxe in EmbeddedPkg that we are replacing]
which is unlikely to be depended upon by out of tree platforms, let's
simply modify this library into an implementation of ResetSystemLib
instead [which is what the generic driver in MdeModulePkg consumes]

This does mean we need to update all clients at the same time, which
is why all changes are part of the same patch.

As before, warm reset and platform specific reset are mapped onto
cold reset (which is the only thing PSCI implements, at least the
version we depend on). The new library function EnterS3WithImmediateWake()
is left unimplemented, as permitted by the ResetSystemLib library class.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>

diff --git a/ArmVirtPkg/ArmVirt.dsc.inc b/ArmVirtPkg/ArmVirt.dsc.inc
index 5bf53763548868cfbd75b068f7538d4816632a16..0b9b457b5619103dbcd1216d55bbc5d30b41122a 100644 (file)
--- a/ArmVirtPkg/ArmVirt.dsc.inc
+++ b/ArmVirtPkg/ArmVirt.dsc.inc
@@ -101,7 +101,7 @@
 \r
   PlatformPeiLib|ArmVirtPkg/Library/PlatformPeiLib/PlatformPeiLib.inf\r
   MemoryInitPeiLib|ArmVirtPkg/Library/ArmVirtMemoryInitPeiLib/ArmVirtMemoryInitPeiLib.inf\r
 \r
   PlatformPeiLib|ArmVirtPkg/Library/PlatformPeiLib/PlatformPeiLib.inf\r
   MemoryInitPeiLib|ArmVirtPkg/Library/ArmVirtMemoryInitPeiLib/ArmVirtMemoryInitPeiLib.inf\r

-  EfiResetSystemLib|ArmVirtPkg/Library/ArmVirtPsciResetSystemLib/ArmVirtPsciResetSystemLib.inf\r
+  ResetSystemLib|ArmVirtPkg/Library/ArmVirtPsciResetSystemLib/ArmVirtPsciResetSystemLib.inf\r

 \r
   # ARM PL031 RTC Driver\r
   RealTimeClockLib|ArmPlatformPkg/Library/PL031RealTimeClockLib/PL031RealTimeClockLib.inf\r
 \r
   # ARM PL031 RTC Driver\r
   RealTimeClockLib|ArmPlatformPkg/Library/PL031RealTimeClockLib/PL031RealTimeClockLib.inf\r

diff --git a/ArmVirtPkg/ArmVirtQemu.dsc b/ArmVirtPkg/ArmVirtQemu.dsc
index 10de57a4149e9f9e747e98d62d6e9be1bd07d788..e23a6d17bc44334f5c48bc3a013ada2752323d49 100644 (file)
--- a/ArmVirtPkg/ArmVirtQemu.dsc
+++ b/ArmVirtPkg/ArmVirtQemu.dsc
@@ -266,7 +266,7 @@
   MdeModulePkg/Universal/CapsuleRuntimeDxe/CapsuleRuntimeDxe.inf\r
   MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf\r
   MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf\r
   MdeModulePkg/Universal/CapsuleRuntimeDxe/CapsuleRuntimeDxe.inf\r
   MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf\r
   MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf\r

-  EmbeddedPkg/ResetRuntimeDxe/ResetRuntimeDxe.inf\r
+  MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystemRuntimeDxe.inf\r

   EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClockRuntimeDxe.inf {\r
     <LibraryClasses>\r
       NULL|ArmVirtPkg/Library/ArmVirtPL031FdtClientLib/ArmVirtPL031FdtClientLib.inf\r
   EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClockRuntimeDxe.inf {\r
     <LibraryClasses>\r
       NULL|ArmVirtPkg/Library/ArmVirtPL031FdtClientLib/ArmVirtPL031FdtClientLib.inf\r

diff --git a/ArmVirtPkg/ArmVirtQemuFvMain.fdf.inc b/ArmVirtPkg/ArmVirtQemuFvMain.fdf.inc
index ba2e7157cf2c762cee007a472b17d0d01bda8eee..237b2d03a714afef5af94abedaa135e65f29d9a3 100644 (file)
--- a/ArmVirtPkg/ArmVirtQemuFvMain.fdf.inc
+++ b/ArmVirtPkg/ArmVirtQemuFvMain.fdf.inc
@@ -63,7 +63,7 @@ READ_LOCK_STATUS   = TRUE
   INF SecurityPkg/VariableAuthenticated/SecureBootConfigDxe/SecureBootConfigDxe.inf\r
 !endif\r
   INF MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf\r
   INF SecurityPkg/VariableAuthenticated/SecureBootConfigDxe/SecureBootConfigDxe.inf\r
 !endif\r
   INF MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf\r

-  INF EmbeddedPkg/ResetRuntimeDxe/ResetRuntimeDxe.inf\r
+  INF MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystemRuntimeDxe.inf\r

   INF EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClockRuntimeDxe.inf\r
   INF EmbeddedPkg/MetronomeDxe/MetronomeDxe.inf\r
   INF MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabaseDxe.inf\r
   INF EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClockRuntimeDxe.inf\r
   INF EmbeddedPkg/MetronomeDxe/MetronomeDxe.inf\r
   INF MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabaseDxe.inf\r

diff --git a/ArmVirtPkg/ArmVirtQemuKernel.dsc b/ArmVirtPkg/ArmVirtQemuKernel.dsc
index 93ccb6df37e1fcb8ce249654baff5568cc83733f..aa01debfda6914bb3364df37ccdf39fae1b91d82 100644 (file)
--- a/ArmVirtPkg/ArmVirtQemuKernel.dsc
+++ b/ArmVirtPkg/ArmVirtQemuKernel.dsc
@@ -257,7 +257,7 @@
   MdeModulePkg/Universal/CapsuleRuntimeDxe/CapsuleRuntimeDxe.inf\r
   MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf\r
   MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf\r
   MdeModulePkg/Universal/CapsuleRuntimeDxe/CapsuleRuntimeDxe.inf\r
   MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf\r
   MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf\r

-  EmbeddedPkg/ResetRuntimeDxe/ResetRuntimeDxe.inf\r
+  MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystemRuntimeDxe.inf\r

   EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClockRuntimeDxe.inf {\r
     <LibraryClasses>\r
       NULL|ArmVirtPkg/Library/ArmVirtPL031FdtClientLib/ArmVirtPL031FdtClientLib.inf\r
   EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClockRuntimeDxe.inf {\r
     <LibraryClasses>\r
       NULL|ArmVirtPkg/Library/ArmVirtPL031FdtClientLib/ArmVirtPL031FdtClientLib.inf\r

diff --git a/ArmVirtPkg/ArmVirtXen.dsc b/ArmVirtPkg/ArmVirtXen.dsc
index f832b3fb64f44b19a62f6891443afaec13b4ab70..eb37137f271e6204249b791252869a841a34ec33 100644 (file)
--- a/ArmVirtPkg/ArmVirtXen.dsc
+++ b/ArmVirtPkg/ArmVirtXen.dsc
@@ -167,7 +167,7 @@
   MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf\r
 \r
   MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf\r
   MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf\r
 \r
   MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf\r

-  EmbeddedPkg/ResetRuntimeDxe/ResetRuntimeDxe.inf\r
+  MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystemRuntimeDxe.inf\r

   EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClockRuntimeDxe.inf\r
   EmbeddedPkg/MetronomeDxe/MetronomeDxe.inf\r
 \r
   EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClockRuntimeDxe.inf\r
   EmbeddedPkg/MetronomeDxe/MetronomeDxe.inf\r
 \r

diff --git a/ArmVirtPkg/ArmVirtXen.fdf b/ArmVirtPkg/ArmVirtXen.fdf
index b591818f0b422e1677a834cac7a101ec76b90cf1..67fde73e696dfb1524f87bfb9b95552b303ffab4 100644 (file)
--- a/ArmVirtPkg/ArmVirtXen.fdf
+++ b/ArmVirtPkg/ArmVirtXen.fdf
@@ -140,7 +140,7 @@ READ_LOCK_STATUS   = TRUE
   INF MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf\r
 \r
   INF MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf\r
   INF MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf\r
 \r
   INF MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf\r

-  INF EmbeddedPkg/ResetRuntimeDxe/ResetRuntimeDxe.inf\r
+  INF MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystemRuntimeDxe.inf\r

   INF EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClockRuntimeDxe.inf\r
   INF EmbeddedPkg/MetronomeDxe/MetronomeDxe.inf\r
   INF MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabaseDxe.inf\r
   INF EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClockRuntimeDxe.inf\r
   INF EmbeddedPkg/MetronomeDxe/MetronomeDxe.inf\r
   INF MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabaseDxe.inf\r

diff --git a/ArmVirtPkg/Library/ArmVirtPsciResetSystemLib/ArmVirtPsciResetSystemLib.c b/ArmVirtPkg/Library/ArmVirtPsciResetSystemLib/ArmVirtPsciResetSystemLib.c
index b94d1b0090c69a3a5f743869d2b907b2aef4ff8a..4b0db206e92030c160286f90ca7f17531d376e4c 100644 (file)
--- a/ArmVirtPkg/Library/ArmVirtPsciResetSystemLib/ArmVirtPsciResetSystemLib.c
+++ b/ArmVirtPkg/Library/ArmVirtPsciResetSystemLib/ArmVirtPsciResetSystemLib.c
@@ -23,7 +23,7 @@
 \r
 #include <Library/BaseLib.h>\r
 #include <Library/DebugLib.h>\r
 \r
 #include <Library/BaseLib.h>\r
 #include <Library/DebugLib.h>\r

-#include <Library/EfiResetSystemLib.h>\r
+#include <Library/ResetSystemLib.h>\r

 #include <Library/ArmSmcLib.h>\r
 #include <Library/ArmHvcLib.h>\r
 #include <Library/UefiBootServicesTableLib.h>\r
 #include <Library/ArmSmcLib.h>\r
 #include <Library/ArmHvcLib.h>\r
 #include <Library/UefiBootServicesTableLib.h>\r


@@ -67,48 +67,74 @@ ArmPsciResetSystemLibConstructor (
 }\r
 \r
 /**\r
 }\r
 \r
 /**\r

-  Resets the entire platform.\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
+  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 reset\r
+  is asynchronous to system operation and operates without regard to\r
+  cycle boundaries.\r

 \r
 \r

+  If this function returns, it means that the system does not support cold reset.\r

 **/\r
 **/\r

-EFI_STATUS\r
+VOID\r

 EFIAPI\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
+ResetCold (\r
+  VOID\r

   )\r
 {\r
   ARM_SMC_ARGS ArmSmcArgs;\r
   ARM_HVC_ARGS ArmHvcArgs;\r
 \r
   )\r
 {\r
   ARM_SMC_ARGS ArmSmcArgs;\r
   ARM_HVC_ARGS ArmHvcArgs;\r
 \r

-  switch (ResetType) {\r
+  // Send a PSCI 0.2 SYSTEM_RESET command\r
+  ArmSmcArgs.Arg0 = ARM_SMC_ID_PSCI_SYSTEM_RESET;\r
+  ArmHvcArgs.Arg0 = ARM_SMC_ID_PSCI_SYSTEM_RESET;\r

 \r
 \r

-  case EfiResetPlatformSpecific:\r
-    // Map the platform specific reset as reboot\r
-  case EfiResetWarm:\r
-    // Map a warm reset into a cold reset\r
-  case EfiResetCold:\r
-    // Send a PSCI 0.2 SYSTEM_RESET command\r
-    ArmSmcArgs.Arg0 = ARM_SMC_ID_PSCI_SYSTEM_RESET;\r
-    ArmHvcArgs.Arg0 = ARM_SMC_ID_PSCI_SYSTEM_RESET;\r
+  switch (mArmPsciMethod) {\r
+  case 1:\r
+    ArmCallHvc (&ArmHvcArgs);\r

     break;\r
     break;\r

-  case EfiResetShutdown:\r
-    // Send a PSCI 0.2 SYSTEM_OFF command\r
-    ArmSmcArgs.Arg0 = ARM_SMC_ID_PSCI_SYSTEM_OFF;\r
-    ArmHvcArgs.Arg0 = ARM_SMC_ID_PSCI_SYSTEM_OFF;\r
+\r
+  case 2:\r
+    ArmCallSmc (&ArmSmcArgs);\r

     break;\r
     break;\r

+\r

   default:\r
   default:\r

-    ASSERT (FALSE);\r
-    return EFI_UNSUPPORTED;\r
+    DEBUG ((EFI_D_ERROR, "%a: no PSCI method defined\n", __FUNCTION__));\r

   }\r
   }\r

+}\r
+\r
+/**\r
+  This function causes a system-wide initialization (warm reset), in which all processors\r
+  are set to their initial state. Pending cycles are not corrupted.\r
+\r
+  If this function returns, it means that the system does not support warm reset.\r
+**/\r
+VOID\r
+EFIAPI\r
+ResetWarm (\r
+  VOID\r
+  )\r
+{\r
+  // Map a warm reset into a cold reset\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 shutdown reset.\r
+**/\r
+VOID\r
+EFIAPI\r
+ResetShutdown (\r
+  VOID\r
+  )\r
+{\r
+  ARM_SMC_ARGS ArmSmcArgs;\r
+  ARM_HVC_ARGS ArmHvcArgs;\r
+\r
+  // Send a PSCI 0.2 SYSTEM_OFF command\r
+  ArmSmcArgs.Arg0 = ARM_SMC_ID_PSCI_SYSTEM_OFF;\r
+  ArmHvcArgs.Arg0 = ARM_SMC_ID_PSCI_SYSTEM_OFF;\r

 \r
   switch (mArmPsciMethod) {\r
   case 1:\r
 \r
   switch (mArmPsciMethod) {\r
   case 1:\r


@@ -121,30 +147,41 @@ LibResetSystem (
 \r
   default:\r
     DEBUG ((EFI_D_ERROR, "%a: no PSCI method defined\n", __FUNCTION__));\r
 \r
   default:\r
     DEBUG ((EFI_D_ERROR, "%a: no PSCI method defined\n", __FUNCTION__));\r

-    return EFI_UNSUPPORTED;\r

   }\r
   }\r

-\r
-  // We should never be here\r
-  DEBUG ((EFI_D_ERROR, "%a: PSCI Reset failed\n", __FUNCTION__));\r
-  CpuDeadLoop ();\r
-  return EFI_UNSUPPORTED;\r

 }\r
 \r
 /**\r
 }\r
 \r
 /**\r

-  Initialize any infrastructure required for LibResetSystem () to function.\r
-\r
-  @param  ImageHandle   The firmware allocated handle for the EFI image.\r
-  @param  SystemTable   A pointer to the EFI System Table.\r
+  This function causes the system to enter S3 and then wake up immediately.\r

 \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 feature.\r
+**/\r
+VOID\r
+EFIAPI\r
+EnterS3WithImmediateWake (\r
+  VOID\r
+  )\r
+{\r
+  // not implemented\r
+}\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
 **/\r

-EFI_STATUS\r
+VOID\r

 EFIAPI\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
   )\r
 {\r

-  return EFI_SUCCESS;\r
+  // Map the platform specific reset as reboot\r
+  ResetCold ();\r

 }\r
 }\r

diff --git a/ArmVirtPkg/Library/ArmVirtPsciResetSystemLib/ArmVirtPsciResetSystemLib.inf b/ArmVirtPkg/Library/ArmVirtPsciResetSystemLib/ArmVirtPsciResetSystemLib.inf
index 9dc515aee52b0b288d9dee940eb6ed8d8185fd37..f28aed3fb1c20e88490032be503ecc4aabd21433 100644 (file)
--- a/ArmVirtPkg/Library/ArmVirtPsciResetSystemLib/ArmVirtPsciResetSystemLib.inf
+++ b/ArmVirtPkg/Library/ArmVirtPsciResetSystemLib/ArmVirtPsciResetSystemLib.inf
@@ -20,7 +20,7 @@
   FILE_GUID                      = c81d76ed-66fa-44a3-ac4a-f163120187a9\r
   MODULE_TYPE                    = BASE\r
   VERSION_STRING                 = 1.0\r
   FILE_GUID                      = c81d76ed-66fa-44a3-ac4a-f163120187a9\r
   MODULE_TYPE                    = BASE\r
   VERSION_STRING                 = 1.0\r

-  LIBRARY_CLASS                  = EfiResetSystemLib|DXE_DRIVER DXE_RUNTIME_DRIVER\r
+  LIBRARY_CLASS                  = ResetSystemLib|DXE_DRIVER DXE_RUNTIME_DRIVER\r

   CONSTRUCTOR                    = ArmPsciResetSystemLibConstructor\r
 \r
 [Sources]\r
   CONSTRUCTOR                    = ArmPsciResetSystemLibConstructor\r
 \r
 [Sources]\r


@@ -29,8 +29,8 @@
 [Packages]\r
   ArmPkg/ArmPkg.dec\r
   ArmVirtPkg/ArmVirtPkg.dec\r
 [Packages]\r
   ArmPkg/ArmPkg.dec\r
   ArmVirtPkg/ArmVirtPkg.dec\r

+  MdeModulePkg/MdeModulePkg.dec\r

   MdePkg/MdePkg.dec\r
   MdePkg/MdePkg.dec\r

-  EmbeddedPkg/EmbeddedPkg.dec\r

 \r
 [LibraryClasses]\r
   ArmSmcLib\r
 \r
 [LibraryClasses]\r
   ArmSmcLib\r