MdeModulePkg/Variable: Consume Variable Flash Info

REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3479

Updates VariableRuntimeDxe, VariableSmm, and VariableStandaloneMm
to acquire variable flash information from the Variable Flash
Information library.

Note: This introduces a dependency on VariableFlashInfoLib in these
modules. Therefore, a platform building the variable modules must
specify an instance of VariableFlashInfoLib in their platform build.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Hao A Wu <hao.a.wu@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Acked-by: Ard Biesheuvel <ardb@kernel.org>
Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>

10 files changed, 56 insertions, 34 deletions

diff --git a/MdeModulePkg/Universal/Variable/Pei/Variable.c b/MdeModulePkg/Universal/Variable/Pei/Variable.c
index b36dd0de67..26a4c73b45 100644
--- a/MdeModulePkg/Universal/Variable/Pei/Variable.c
+++ b/MdeModulePkg/Universal/Variable/Pei/Variable.c
@@ -567,11 +567,13 @@ GetVariableStore (
   OUT VARIABLE_STORE_INFO  *StoreInfo

   )

 {

+  EFI_STATUS                            Status;

   EFI_HOB_GUID_TYPE                     *GuidHob;

   EFI_FIRMWARE_VOLUME_HEADER            *FvHeader;

   VARIABLE_STORE_HEADER                 *VariableStoreHeader;

   EFI_PHYSICAL_ADDRESS                  NvStorageBase;

   UINT32                                NvStorageSize;

+  UINT64                                NvStorageSize64;

   FAULT_TOLERANT_WRITE_LAST_WRITE_DATA  *FtwLastWriteData;

   UINT32                                BackUpOffset;

 

@@ -591,11 +593,13 @@ GetVariableStore (
         // Emulated non-volatile variable mode is not enabled.

         //

 

-        NvStorageSize = PcdGet32 (PcdFlashNvStorageVariableSize);

-        NvStorageBase = (EFI_PHYSICAL_ADDRESS)(PcdGet64 (PcdFlashNvStorageVariableBase64) != 0 ?

-                                               PcdGet64 (PcdFlashNvStorageVariableBase64) :

-                                               PcdGet32 (PcdFlashNvStorageVariableBase)

-                                               );

+        Status = GetVariableFlashNvStorageInfo (&NvStorageBase, &NvStorageSize64);

+        ASSERT_EFI_ERROR (Status);

+

+        Status = SafeUint64ToUint32 (NvStorageSize64, &NvStorageSize);

+        // This driver currently assumes the size will be UINT32 so assert the value is safe for now.

+        ASSERT_EFI_ERROR (Status);

+

         ASSERT (NvStorageBase != 0);

 

         //

diff --git a/MdeModulePkg/Universal/Variable/Pei/Variable.h b/MdeModulePkg/Universal/Variable/Pei/Variable.h
index 7f9ad5bfc3..51effbf799 100644
--- a/MdeModulePkg/Universal/Variable/Pei/Variable.h
+++ b/MdeModulePkg/Universal/Variable/Pei/Variable.h
@@ -20,6 +20,8 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 #include <Library/BaseMemoryLib.h>

 #include <Library/PeiServicesTablePointerLib.h>

 #include <Library/PeiServicesLib.h>

+#include <Library/SafeIntLib.h>

+#include <Library/VariableFlashInfoLib.h>

 

 #include <Guid/VariableFormat.h>

 #include <Guid/VariableIndexTable.h>

diff --git a/MdeModulePkg/Universal/Variable/Pei/VariablePei.inf b/MdeModulePkg/Universal/Variable/Pei/VariablePei.inf
index 7cbdd2385e..7264a24bdf 100644
--- a/MdeModulePkg/Universal/Variable/Pei/VariablePei.inf
+++ b/MdeModulePkg/Universal/Variable/Pei/VariablePei.inf
@@ -39,6 +39,8 @@
   DebugLib

   PeiServicesTablePointerLib

   PeiServicesLib

+  SafeIntLib

+  VariableFlashInfoLib

 

 [Guids]

   ## CONSUMES             ## GUID # Variable store header

@@ -59,9 +61,6 @@
   gEfiPeiReadOnlyVariable2PpiGuid   ## PRODUCES

 

 [Pcd]

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase      ## SOMETIMES_CONSUMES

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase64    ## CONSUMES

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize      ## CONSUMES

   gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvModeEnable         ## SOMETIMES_CONSUMES

 

 [Depex]

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h
index 31e408976a..a668abb82b 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h
@@ -31,6 +31,8 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 #include <Library/MemoryAllocationLib.h>

 #include <Library/AuthVariableLib.h>

 #include <Library/VarCheckLib.h>

+#include <Library/VariableFlashInfoLib.h>

+#include <Library/SafeIntLib.h>

 #include <Guid/GlobalVariable.h>

 #include <Guid/EventGroup.h>

 #include <Guid/VariableFormat.h>

@@ -40,11 +42,6 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 

 #include "PrivilegePolymorphic.h"

 

-#define NV_STORAGE_VARIABLE_BASE  (EFI_PHYSICAL_ADDRESS)\

-                                   (PcdGet64 (PcdFlashNvStorageVariableBase64) != 0 ? \

-                                    PcdGet64 (PcdFlashNvStorageVariableBase64) : \

-                                    PcdGet32 (PcdFlashNvStorageVariableBase))

-

 #define EFI_VARIABLE_ATTRIBUTES_MASK  (EFI_VARIABLE_NON_VOLATILE |\

                                       EFI_VARIABLE_BOOTSERVICE_ACCESS | \

                                       EFI_VARIABLE_RUNTIME_ACCESS | \

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
index 03fec3048d..d5c409c914 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
@@ -423,6 +423,8 @@ FtwNotificationEvent (
   EFI_PHYSICAL_ADDRESS                VariableStoreBase;

   UINT64                              VariableStoreLength;

   UINTN                               FtwMaxBlockSize;

+  UINT32                              NvStorageVariableSize;

+  UINT64                              NvStorageVariableSize64;

 

   //

   // Ensure FTW protocol is installed.

@@ -432,14 +434,20 @@ FtwNotificationEvent (
     return;

   }

 

+  Status = GetVariableFlashNvStorageInfo (&NvStorageVariableBase, &NvStorageVariableSize64);

+  ASSERT_EFI_ERROR (Status);

+

+  Status = SafeUint64ToUint32 (NvStorageVariableSize64, &NvStorageVariableSize);

+  // This driver currently assumes the size will be UINT32 so assert the value is safe for now.

+  ASSERT_EFI_ERROR (Status);

+

+  VariableStoreBase = NvStorageVariableBase + mNvFvHeaderCache->HeaderLength;

+

   Status = FtwProtocol->GetMaxBlockSize (FtwProtocol, &FtwMaxBlockSize);

   if (!EFI_ERROR (Status)) {

-    ASSERT (PcdGet32 (PcdFlashNvStorageVariableSize) <= FtwMaxBlockSize);

+    ASSERT (NvStorageVariableSize <= FtwMaxBlockSize);

   }

 

-  NvStorageVariableBase = NV_STORAGE_VARIABLE_BASE;

-  VariableStoreBase     = NvStorageVariableBase + mNvFvHeaderCache->HeaderLength;

-

   //

   // Let NonVolatileVariableBase point to flash variable store base directly after FTW ready.

   //

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableNonVolatile.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableNonVolatile.c
index 5e9d40b67a..9e2d8fe0fe 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableNonVolatile.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableNonVolatile.c
@@ -142,6 +142,7 @@ InitRealNonVolatileVariableStore (
   EFI_PHYSICAL_ADDRESS                  NvStorageBase;

   UINT8                                 *NvStorageData;

   UINT32                                NvStorageSize;

+  UINT64                                NvStorageSize64;

   FAULT_TOLERANT_WRITE_LAST_WRITE_DATA  *FtwLastWriteData;

   UINT32                                BackUpOffset;

   UINT32                                BackUpSize;

@@ -153,19 +154,24 @@ InitRealNonVolatileVariableStore (
 

   mVariableModuleGlobal->FvbInstance = NULL;

 

+  Status = GetVariableFlashNvStorageInfo (&NvStorageBase, &NvStorageSize64);

+  ASSERT_EFI_ERROR (Status);

+

+  Status = SafeUint64ToUint32 (NvStorageSize64, &NvStorageSize);

+  // This driver currently assumes the size will be UINT32 so assert the value is safe for now.

+  ASSERT_EFI_ERROR (Status);

+

+  ASSERT (NvStorageBase != 0);

+

   //

   // Allocate runtime memory used for a memory copy of the FLASH region.

   // Keep the memory and the FLASH in sync as updates occur.

   //

-  NvStorageSize = PcdGet32 (PcdFlashNvStorageVariableSize);

   NvStorageData = AllocateRuntimeZeroPool (NvStorageSize);

   if (NvStorageData == NULL) {

     return EFI_OUT_OF_RESOURCES;

   }

 

-  NvStorageBase = NV_STORAGE_VARIABLE_BASE;

-  ASSERT (NvStorageBase != 0);

-

   //

   // Copy NV storage data to the memory buffer.

   //

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
index c9434df631..3858adf673 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
@@ -71,8 +71,10 @@
   TpmMeasurementLib

   AuthVariableLib

   VarCheckLib

+  VariableFlashInfoLib

   VariablePolicyLib

   VariablePolicyHelperLib

+  SafeIntLib

 

 [Protocols]

   gEfiFirmwareVolumeBlockProtocolGuid           ## CONSUMES

@@ -125,9 +127,6 @@
   gEfiImageSecurityDatabaseGuid

 

 [Pcd]

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize      ## CONSUMES

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase      ## SOMETIMES_CONSUMES

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase64    ## CONSUMES

   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize                 ## CONSUMES

   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxAuthVariableSize             ## CONSUMES

   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVolatileVariableSize         ## CONSUMES

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c
index 517cae7b00..5253c328dc 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c
@@ -1084,6 +1084,8 @@ SmmFtwNotificationEvent (
   EFI_SMM_FAULT_TOLERANT_WRITE_PROTOCOL   *FtwProtocol;

   EFI_PHYSICAL_ADDRESS                    NvStorageVariableBase;

   UINTN                                   FtwMaxBlockSize;

+  UINT32                                  NvStorageVariableSize;

+  UINT64                                  NvStorageVariableSize64;

 

   if (mVariableModuleGlobal->FvbInstance != NULL) {

     return EFI_SUCCESS;

@@ -1097,14 +1099,21 @@ SmmFtwNotificationEvent (
     return Status;

   }

 

+  Status = GetVariableFlashNvStorageInfo (&NvStorageVariableBase, &NvStorageVariableSize64);

+  ASSERT_EFI_ERROR (Status);

+

+  Status = SafeUint64ToUint32 (NvStorageVariableSize64, &NvStorageVariableSize);

+  // This driver currently assumes the size will be UINT32 so assert the value is safe for now.

+  ASSERT_EFI_ERROR (Status);

+

+  ASSERT (NvStorageVariableBase != 0);

+  VariableStoreBase = NvStorageVariableBase + mNvFvHeaderCache->HeaderLength;

+

   Status = FtwProtocol->GetMaxBlockSize (FtwProtocol, &FtwMaxBlockSize);

   if (!EFI_ERROR (Status)) {

-    ASSERT (PcdGet32 (PcdFlashNvStorageVariableSize) <= FtwMaxBlockSize);

+    ASSERT (NvStorageVariableSize <= FtwMaxBlockSize);

   }

 

-  NvStorageVariableBase = NV_STORAGE_VARIABLE_BASE;

-  VariableStoreBase     = NvStorageVariableBase + mNvFvHeaderCache->HeaderLength;

-

   //

   // Let NonVolatileVariableBase point to flash variable store base directly after FTW ready.

   //

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf
index eaa97a01c6..8c552b87e0 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf
@@ -80,8 +80,10 @@
   AuthVariableLib

   VarCheckLib

   UefiBootServicesTableLib

+  VariableFlashInfoLib

   VariablePolicyLib

   VariablePolicyHelperLib

+  SafeIntLib

 

 [Protocols]

   gEfiSmmFirmwareVolumeBlockProtocolGuid        ## CONSUMES

@@ -127,9 +129,6 @@
   gEdkiiVarErrorFlagGuid

 

 [Pcd]

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize       ## CONSUMES

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase       ## SOMETIMES_CONSUMES

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase64     ## CONSUMES

   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize                  ## CONSUMES

   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxAuthVariableSize              ## CONSUMES

   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVolatileVariableSize          ## CONSUMES

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableStandaloneMm.inf b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableStandaloneMm.inf
index d8c4f77e7f..f09bed40cf 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableStandaloneMm.inf
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableStandaloneMm.inf
@@ -73,9 +73,11 @@
   HobLib

   MemoryAllocationLib

   MmServicesTableLib

+  SafeIntLib

   StandaloneMmDriverEntryPoint

   SynchronizationLib

   VarCheckLib

+  VariableFlashInfoLib

   VariablePolicyLib

   VariablePolicyHelperLib

 

@@ -120,9 +122,6 @@
   gEdkiiVarErrorFlagGuid

 

 [Pcd]

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase       ## SOMETIMES_CONSUMES

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase64     ## CONSUMES

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize       ## CONSUMES

   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize                  ## CONSUMES

   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxAuthVariableSize              ## CONSUMES

   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVolatileVariableSize          ## CONSUMES