Silicon/SynQuacer: implement 'clear NVRAM' feature using a DIP switch

Ordinary computers typically have a physical switch or jumper on the
board that allows non-volatile settings to be cleared. Let's implement
the same using DIP switch #1 on block #3, and clear the EFI variable
store if it is set to ON at boot time.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

6 files changed, 41 insertions, 1 deletions

diff --git a/Platform/Socionext/DeveloperBox/DeveloperBox.dsc b/Platform/Socionext/DeveloperBox/DeveloperBox.dsc
index 10d0707..af978db 100644
--- a/Platform/Socionext/DeveloperBox/DeveloperBox.dsc
+++ b/Platform/Socionext/DeveloperBox/DeveloperBox.dsc
@@ -381,6 +381,9 @@
   gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultCreatorId|0x4f524e4c # LNRO

   gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultCreatorRevision|1

 

+  # set DIP switch DSW3-PIN1 to clear the varstore

+  gSynQuacerTokenSpaceGuid.PcdClearSettingsGpioPin|0

+

 [PcdsPatchableInModule]

   gEfiMdeModulePkgTokenSpaceGuid.PcdVideoHorizontalResolution|0

   gEfiMdeModulePkgTokenSpaceGuid.PcdVideoVerticalResolution|0

@@ -418,6 +421,7 @@
   MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.inf

   MdeModulePkg/Universal/Variable/Pei/VariablePei.inf

   MdeModulePkg/Universal/CapsulePei/CapsulePei.inf

+  Silicon/Socionext/SynQuacer/Drivers/SynQuacerGpioPei/SynQuacerGpioPei.inf

   MdeModulePkg/Core/DxeIplPeim/DxeIpl.inf {

     <LibraryClasses>

       NULL|MdeModulePkg/Library/LzmaCustomDecompressLib/LzmaCustomDecompressLib.inf

diff --git a/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc b/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc
index 4630d78..4034bcf 100644
--- a/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc
+++ b/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.dsc
@@ -369,6 +369,9 @@
   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase|0x08420000

   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize|0x00010000

 

+  # set DIP switch DSW3-PIN1 to clear the varstore

+  gSynQuacerTokenSpaceGuid.PcdClearSettingsGpioPin|0

+

 [PcdsPatchableInModule]

   gEfiMdeModulePkgTokenSpaceGuid.PcdVideoHorizontalResolution|0

   gEfiMdeModulePkgTokenSpaceGuid.PcdVideoVerticalResolution|0

@@ -406,6 +409,7 @@
   MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.inf

   MdeModulePkg/Universal/Variable/Pei/VariablePei.inf

   MdeModulePkg/Universal/CapsulePei/CapsulePei.inf

+  Silicon/Socionext/SynQuacer/Drivers/SynQuacerGpioPei/SynQuacerGpioPei.inf

   MdeModulePkg/Core/DxeIplPeim/DxeIpl.inf {

     <LibraryClasses>

       NULL|MdeModulePkg/Library/LzmaCustomDecompressLib/LzmaCustomDecompressLib.inf

diff --git a/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.fdf b/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.fdf
index 365085c..4577bd3 100644
--- a/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.fdf
+++ b/Platform/Socionext/SynQuacerEvalBoard/SynQuacerEvalBoard.fdf
@@ -248,6 +248,7 @@ READ_LOCK_STATUS   = TRUE
   INF MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.inf

   INF MdeModulePkg/Universal/Variable/Pei/VariablePei.inf

   INF MdeModulePkg/Universal/CapsulePei/CapsulePei.inf

+  INF Silicon/Socionext/SynQuacer/Drivers/SynQuacerGpioPei/SynQuacerGpioPei.inf

   INF RuleOverride = FMP_IMAGE_DESC Platform/Socionext/SynQuacerEvalBoard/SystemFirmwareDescriptor/SystemFirmwareDescriptor.inf

   INF MdeModulePkg/Core/DxeIplPeim/DxeIpl.inf

 

diff --git a/Silicon/Socionext/SynQuacer/Library/SynQuacerPlatformPeiLib/SynQuacerPlatformPeiLib.c b/Silicon/Socionext/SynQuacer/Library/SynQuacerPlatformPeiLib/SynQuacerPlatformPeiLib.c
index 358dd5a..bd8ee7a 100644
--- a/Silicon/Socionext/SynQuacer/Library/SynQuacerPlatformPeiLib/SynQuacerPlatformPeiLib.c
+++ b/Silicon/Socionext/SynQuacer/Library/SynQuacerPlatformPeiLib/SynQuacerPlatformPeiLib.c
@@ -21,6 +21,7 @@
 #include <Library/PeiServicesLib.h>

 #include <Platform/DramInfo.h>

 #include <Ppi/DramInfo.h>

+#include <Ppi/EmbeddedGpio.h>

 #include <Ppi/MemoryDiscovered.h>

 

 STATIC

@@ -103,10 +104,32 @@ PlatformPeim (
   VOID

   )

 {

-  EFI_STATUS      Status;

+  EMBEDDED_GPIO_PPI   *Gpio;

+  EFI_STATUS          Status;

+  UINTN               Value;

 

   ASSERT (mDramInfo->NumRegions > 0);

 

+  Status = PeiServicesLocatePpi (&gEdkiiEmbeddedGpioPpiGuid, 0, NULL,

+             (VOID **)&Gpio);

+  ASSERT_EFI_ERROR (Status);

+

+  Status = Gpio->Set (Gpio, FixedPcdGet32 (PcdClearSettingsGpioPin),

+                   GPIO_MODE_INPUT);

+  if (EFI_ERROR (Status)) {

+    DEBUG ((DEBUG_WARN, "%a: failed to set GPIO as input - %r\n", __FUNCTION__,

+      Status));

+  } else {

+    Status = Gpio->Get (Gpio, FixedPcdGet32 (PcdClearSettingsGpioPin), &Value);

+    if (EFI_ERROR (Status)) {

+      DEBUG ((DEBUG_WARN, "%a: failed to get GPIO state - %r\n", __FUNCTION__,

+        Status));

+    } else if (Value > 0) {

+      DEBUG ((DEBUG_INFO, "%a: clearing NVRAM\n", __FUNCTION__));

+      PeiServicesSetBootMode (BOOT_WITH_DEFAULT_SETTINGS);

+    }

+  }

+

   //

   // Record the first region into PcdSystemMemoryBase and PcdSystemMemorySize.

   // This is the region we will use for UEFI itself.

diff --git a/Silicon/Socionext/SynQuacer/Library/SynQuacerPlatformPeiLib/SynQuacerPlatformPeiLib.inf b/Silicon/Socionext/SynQuacer/Library/SynQuacerPlatformPeiLib/SynQuacerPlatformPeiLib.inf
index 70eb715..a6501fb 100644
--- a/Silicon/Socionext/SynQuacer/Library/SynQuacerPlatformPeiLib/SynQuacerPlatformPeiLib.inf
+++ b/Silicon/Socionext/SynQuacer/Library/SynQuacerPlatformPeiLib/SynQuacerPlatformPeiLib.inf
@@ -25,6 +25,7 @@
 

 [Packages]

   ArmPkg/ArmPkg.dec

+  EmbeddedPkg/EmbeddedPkg.dec

   MdePkg/MdePkg.dec

   MdeModulePkg/MdeModulePkg.dec

   Silicon/Socionext/SynQuacer/SynQuacer.dec

@@ -40,11 +41,16 @@
 [FixedPcd]

   gArmTokenSpaceGuid.PcdFvBaseAddress

   gArmTokenSpaceGuid.PcdFvSize

+  gSynQuacerTokenSpaceGuid.PcdClearSettingsGpioPin

   gSynQuacerTokenSpaceGuid.PcdDramInfoBase

 

 [Ppis]

+  gEdkiiEmbeddedGpioPpiGuid             ## CONSUMES

   gSynQuacerDramInfoPpiGuid             ## PRODUCES

 

 [Pcd]

   gArmTokenSpaceGuid.PcdSystemMemoryBase

   gArmTokenSpaceGuid.PcdSystemMemorySize

+

+[Depex]

+  gEdkiiEmbeddedGpioPpiGuid

diff --git a/Silicon/Socionext/SynQuacer/SynQuacer.dec b/Silicon/Socionext/SynQuacer/SynQuacer.dec
index 1a683b8..c115504 100644
--- a/Silicon/Socionext/SynQuacer/SynQuacer.dec
+++ b/Silicon/Socionext/SynQuacer/SynQuacer.dec
@@ -30,3 +30,5 @@
 

   gSynQuacerTokenSpaceGuid.PcdNetsecEepromBase|0|UINT32|0x00000002

   gSynQuacerTokenSpaceGuid.PcdNetsecPhyAddress|0|UINT8|0x00000003

+

+  gSynQuacerTokenSpaceGuid.PcdClearSettingsGpioPin|0|UINT32|0x00000004