[PATCH v4 0/8] Add Variable Flash Info HOB

public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed

* [PATCH v4 0/8] Add Variable Flash Info HOB
@ 2022-04-12 16:29 Michael Kubacki
  2022-04-12 16:29 ` [PATCH v4 1/8] MdeModulePkg: " Michael Kubacki
                   ` (9 more replies)
  0 siblings, 10 replies; 20+ messages in thread
From: Michael Kubacki @ 2022-04-12 16:29 UTC (permalink / raw)
  To: devel
  Cc: Abner Chang, Andrew Fish, Anthony Perard, Ard Biesheuvel,
	Benjamin You, Brijesh Singh, Erdem Aktas, Gerd Hoffmann, Guo Dong,
	Hao A Wu, James Bottomley, Jian J Wang, Jiewen Yao, Jordan Justen,
	Julien Grall, Leif Lindholm, Liming Gao, Maurice Ma, Min Xu,
	Nickle Wang, Peter Grehan, Ray Ni, Rebecca Cran, Sami Mujawar,
	Sean Rhodes, Sebastien Boeuf, Tom Lendacky

From: Michael Kubacki <michael.kubacki@microsoft.com>

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

The UEFI variable drivers such as VariableRuntimeDxe, VariableSmm,
VariableStandaloneMm, etc. (and their dependent protocol/library
stack), typically acquire UEFI variable store flash information
with PCDs declared in MdeModulePkg.

For example:
[Pcd]
  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase
  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase64
  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize

These PCDs work as-is in the StandaloneMm driver if they are not
dynamic such as Dynamic or DynamicEx because PCD services are not
readily available in the Standalone MM environment. Platforms that
use Standalone MM today, must define these PCDs as FixedAtBuild in
their platform build. However, the PCDs do allow platforms to treat
the PCDs as Dynamic/DynamicEx and being able to support that is
currently a gap for Standalone MM.

This patch series introduces a HOB that can be produced by the
platform to provide the same information. The HOB list is
available to Standalone MM.

The PCD declarations are left as-is in MdeModulePkg for backward
compatibility. This means unless a platform wants to use the HOB,
their code will continue to work with no change (they do not need
to produce the HOB). Only if the HOB is found, is its value used
instead of the PCDs.

Due to the large number of consumers of this information, access
to the base address and size values is abstracted in a new library
class (as requested in the v1 series) called VariableFlashInfoLib.

The API of VariableFlashInfoLib does not bind the underlying data
structure to the information returned to library users to allow
flexibility in the library implementation in the future.

V4 changes:
1. Add a UINT32 "Reserved" field to VARIABLE_FLASH_INFO.
2. Add a descriptive comment to VariableFlashInfo.h to explain
   HOB usage.

V3 changes:
1. To better clarify usage, renamed the members
   "NvStorageBaseAddress" and "NvStorageLength" in
   "VARIABLE_FLASH_INFO" to "NvVariableBaseAddress" and
   "NvVariableLength".
2. Added description comments to the fields in "VARIABLE_FLASH_INFO".

V2 changes:
1. Abstracted flash info data access with VariableFlashInfoLib.
2. Updated package builds in the repo that build the variable and
   FTW drivers to include VariableFlashInfoLib.
3. Removed a redundant variable assignment in VariableSmm.c.
4. Updated comments in FtwMisc.c and FaultTolerantWritePei.c to
   indicate driver assumption is UINTN (not UINT32)
5. Added a version field to the VARIABLE_FLASH_INFO structure.

Cc: Abner Chang <abner.chang@hpe.com>
Cc: Andrew Fish <afish@apple.com>
Cc: Anthony Perard <anthony.perard@citrix.com>
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Benjamin You <benjamin.you@intel.com>
Cc: Brijesh Singh <brijesh.singh@amd.com>
Cc: Erdem Aktas <erdemaktas@google.com>
Cc: Gerd Hoffmann <kraxel@redhat.com>
Cc: Guo Dong <guo.dong@intel.com>
Cc: Hao A Wu <hao.a.wu@intel.com>
Cc: James Bottomley <jejb@linux.ibm.com>
Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Jordan Justen <jordan.l.justen@intel.com>
Cc: Julien Grall <julien@xen.org>
Cc: Leif Lindholm <quic_llindhol@quicinc.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Maurice Ma <maurice.ma@intel.com>
Cc: Min Xu <min.m.xu@intel.com>
Cc: Nickle Wang <nickle.wang@hpe.com>
Cc: Peter Grehan <grehan@freebsd.org>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Rebecca Cran <rebecca@bsdio.com>
Cc: Sami Mujawar <sami.mujawar@arm.com>
Cc: Sean Rhodes <sean@starlabs.systems>
Cc: Sebastien Boeuf <sebastien.boeuf@intel.com>
Cc: Tom Lendacky <thomas.lendacky@amd.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>

Michael Kubacki (8):
  MdeModulePkg: Add Variable Flash Info HOB
  MdeModulePkg/VariableFlashInfoLib: Add initial library
  MdeModulePkg/Variable: Consume Variable Flash Info
  MdeModulePkg/FaultTolerantWrite: Consume Variable Flash Info
  ArmVirtPkg/ArmVirt.dsc.inc: Add VariableFlashInfoLib
  EmulatorPkg: Add VariableFlashInfoLib
  OvmfPkg: Add VariableFlashInfoLib
  UefiPayloadPkg: Add VariableFlashInfoLib

 MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.c        | 178 ++++++++++++++++++++
 MdeModulePkg/Universal/FaultTolerantWriteDxe/FtwMisc.c                          |  41 +++--
 MdeModulePkg/Universal/FaultTolerantWriteDxe/UpdateWorkingBlock.c               |   7 +-
 MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.c            |  28 +--
 MdeModulePkg/Universal/Variable/Pei/Variable.c                                  |  14 +-
 MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c                        |  16 +-
 MdeModulePkg/Universal/Variable/RuntimeDxe/VariableNonVolatile.c                |  14 +-
 MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c                        |  17 +-
 ArmVirtPkg/ArmVirt.dsc.inc                                                      |   1 +
 EmulatorPkg/EmulatorPkg.dsc                                                     |   1 +
 MdeModulePkg/Include/Guid/VariableFlashInfo.h                                   | 111 ++++++++++++
 MdeModulePkg/Include/Library/VariableFlashInfoLib.h                             |  68 ++++++++
 MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf      |  48 ++++++
 MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.uni      |  12 ++
 MdeModulePkg/MdeModulePkg.dec                                                   |   8 +
 MdeModulePkg/MdeModulePkg.dsc                                                   |   2 +
 MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.h               |   7 +-
 MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf          |  10 +-
 MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.inf          |  10 +-
 MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteStandaloneMm.inf |  10 +-
 MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.inf          |  10 +-
 MdeModulePkg/Universal/Variable/Pei/Variable.h                                  |   2 +
 MdeModulePkg/Universal/Variable/Pei/VariablePei.inf                             |   5 +-
 MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h                           |   7 +-
 MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf               |   5 +-
 MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf                      |   5 +-
 MdeModulePkg/Universal/Variable/RuntimeDxe/VariableStandaloneMm.inf             |   5 +-
 OvmfPkg/AmdSev/AmdSevX64.dsc                                                    |   1 +
 OvmfPkg/Bhyve/BhyveX64.dsc                                                      |   1 +
 OvmfPkg/CloudHv/CloudHvX64.dsc                                                  |   1 +
 OvmfPkg/IntelTdx/IntelTdxX64.dsc                                                |   1 +
 OvmfPkg/Microvm/MicrovmX64.dsc                                                  |   1 +
 OvmfPkg/OvmfPkgIa32.dsc                                                         |   1 +
 OvmfPkg/OvmfPkgIa32X64.dsc                                                      |   1 +
 OvmfPkg/OvmfPkgX64.dsc                                                          |   1 +
 OvmfPkg/OvmfXen.dsc                                                             |   1 +
 UefiPayloadPkg/UefiPayloadPkg.dsc                                               |   1 +
 37 files changed, 558 insertions(+), 94 deletions(-)
 create mode 100644 MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.c
 create mode 100644 MdeModulePkg/Include/Guid/VariableFlashInfo.h
 create mode 100644 MdeModulePkg/Include/Library/VariableFlashInfoLib.h
 create mode 100644 MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
 create mode 100644 MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.uni

-- 
2.28.0.windows.1


^ permalink raw reply	[flat|nested] 20+ messages in thread

* [PATCH v4 1/8] MdeModulePkg: Add Variable Flash Info HOB
  2022-04-12 16:29 [PATCH v4 0/8] Add Variable Flash Info HOB Michael Kubacki
@ 2022-04-12 16:29 ` Michael Kubacki
  2022-04-25 16:05   ` [edk2-devel] " Sami Mujawar
  2022-04-12 16:29 ` [PATCH v4 2/8] MdeModulePkg/VariableFlashInfoLib: Add initial library Michael Kubacki
                   ` (8 subsequent siblings)
  9 siblings, 1 reply; 20+ messages in thread
From: Michael Kubacki @ 2022-04-12 16:29 UTC (permalink / raw)
  To: devel; +Cc: Jian J Wang, Hao A Wu, Liming Gao

From: Michael Kubacki <michael.kubacki@microsoft.com>

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

Adds a new GUID that is used to identify a HOB that passes variable
flash information to UEFI variable drivers in HOB consumption phases
such as DXE, Traditional MM, and Standalone MM.

This information was previously passed directly with PCDs such
as EfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase
and gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize.

However, the Standalone MM variable driver instance does not have
direct access to the PCD database. Therefore, this HOB will first
be considered as the source for variable flash information and
if platforms do not produce the HOB, reading the information from
the PCDs directly will be a backup to provide backward
compatibility.

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>
---
 MdeModulePkg/Include/Guid/VariableFlashInfo.h | 111 ++++++++++++++++++++
 MdeModulePkg/MdeModulePkg.dec                 |   4 +
 2 files changed, 115 insertions(+)

diff --git a/MdeModulePkg/Include/Guid/VariableFlashInfo.h b/MdeModulePkg/Include/Guid/VariableFlashInfo.h
new file mode 100644
index 000000000000..992a0dcdd384
--- /dev/null
+++ b/MdeModulePkg/Include/Guid/VariableFlashInfo.h
@@ -0,0 +1,111 @@
+/** @file
+  This file defines the GUID and data structure used to pass information about
+  a variable store mapped on flash (i.e. a MMIO firmware volume) to the modules
+  that consume that information such as the DXE and MM UEFI variable drivers.
+
+  The HOB described in this file is currently optional. It is primarily provided
+  to allow a platform to dynamically describe the flash information to environments
+  such as Standalone MM that cannot access the prior method using dynamic PCDs.
+
+  Even for platforms that use Standalone MM, if the information is only stored
+  statically such as with FixedAtBuild PCDs, the HOB is not required.
+
+  Every point of consumption in this package that uses the PCDs will first check
+  for the HOB and use its value if present.
+
+  Early modules such as the PEI UEFI variable driver might also consume this
+  information. For modules such as these, that execute early in the boot flow,
+  at least two approaches are possible depending on platform design.
+
+  1. If the information in the HOB exactly matches the information in the PCDs,
+     (i.e. the HOB values are set using the PCD values), let the driver read
+     the information from the PCD and produce the HOB later in boot.
+
+  2. Produce the HOB very early in boot. For example, the earliest point the HOB
+     is currently consumed is in FaultTolerantWritePei. Note that FaultTolerantWritePei
+     produces gEdkiiFaultTolerantWriteGuid which is a dependency for VariablePei.
+
+     Therefore, attaching a NULL class library to FaultTolerantWritePei with a
+     constructor that produces the HOB will guarantee it is produced before the first
+     point of consumption as the constructor is executed before the module entry point.
+
+  Copyright (c) Microsoft Corporation.<BR>
+
+  SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#ifndef VARIABLE_FLASH_INFO_H_
+#define VARIABLE_FLASH_INFO_H_
+
+#define VARIABLE_FLASH_INFO_HOB_GUID \
+  { 0x5d11c653, 0x8154, 0x4ac3, { 0xa8, 0xc2, 0xfb, 0xa2, 0x89, 0x20, 0xfc, 0x90 }}
+
+#define VARIABLE_FLASH_INFO_HOB_VERSION  1
+
+extern EFI_GUID  gVariableFlashInfoHobGuid;
+
+#pragma pack (push, 1)
+
+///
+/// This structure can be used to describe UEFI variable
+/// flash information.
+///
+typedef struct {
+  ///
+  /// Version of this structure.
+  ///
+  /// Increment the value when the structure is modified.
+  ///
+  UINT32                  Version;
+  ///
+  /// Reserved field.
+  ///
+  /// Currently reserved for natural alignment.
+  ///
+  UINT32                  Reserved;
+  ///
+  /// Base address of the non-volatile variable range in the flash device.
+  ///
+  /// Note that this address should align with the block size requirements of the flash device.
+  ///
+  EFI_PHYSICAL_ADDRESS    NvVariableBaseAddress;
+  ///
+  /// Size of the non-volatile variable range in the flash device.
+  ///
+  /// Note that this value should be less than or equal to FtwSpareLength to support reclaim of
+  /// entire variable store area.
+  /// Note that this address should align with the block size requirements of the flash device.
+  ///
+  UINT64                  NvVariableLength;
+  ///
+  /// Base address of the FTW spare block range in the flash device.
+  ///
+  /// Note that this address should align with the block size requirements of the flash device.
+  ///
+  EFI_PHYSICAL_ADDRESS    FtwSpareBaseAddress;
+  ///
+  /// Size of the FTW spare block range in the flash device.
+  ///
+  /// Note that this value should be greater than or equal to NvVariableLength.
+  /// Note that this address should align with the block size requirements of the flash device.
+  ///
+  UINT64                  FtwSpareLength;
+  ///
+  /// Base address of the FTW working block range in the flash device.
+  ///
+  /// Note that if FtwWorkingLength is larger than on block size, this value should be block size aligned.
+  ///
+  EFI_PHYSICAL_ADDRESS    FtwWorkingBaseAddress;
+  ///
+  /// Size of the FTW working block range in the flash device.
+  ///
+  /// Note that if the value is less than on block size, the range should not span blocks.
+  /// Note that if the value is larger than one block size, this value should be block size aligned.
+  ///
+  UINT64                  FtwWorkingLength;
+} VARIABLE_FLASH_INFO;
+
+#pragma pack (pop)
+
+#endif
diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec
index cf79292ec877..4e82f5836096 100644
--- a/MdeModulePkg/MdeModulePkg.dec
+++ b/MdeModulePkg/MdeModulePkg.dec
@@ -226,6 +226,10 @@ [Guids]
   #  Include/Guid/SmmVariableCommon.h
   gSmmVariableWriteGuid  = { 0x93ba1826, 0xdffb, 0x45dd, { 0x82, 0xa7, 0xe7, 0xdc, 0xaa, 0x3b, 0xbd, 0xf3 }}
 
+  ## Guid of the variable flash information HOB.
+  #  Include/Guid/VariableFlashInfo.h
+  gVariableFlashInfoHobGuid = { 0x5d11c653, 0x8154, 0x4ac3, { 0xa8, 0xc2, 0xfb, 0xa2, 0x89, 0x20, 0xfc, 0x90 }}
+
   ## Performance protocol guid that also acts as the performance HOB guid and performance variable GUID
   #  Include/Guid/Performance.h
   gPerformanceProtocolGuid       = { 0x76B6BDFA, 0x2ACD, 0x4462, { 0x9E, 0x3F, 0xCB, 0x58, 0xC9, 0x69, 0xD9, 0x37 } }
-- 
2.28.0.windows.1


^ permalink raw reply related	[flat|nested] 20+ messages in thread

* [PATCH v4 2/8] MdeModulePkg/VariableFlashInfoLib: Add initial library
  2022-04-12 16:29 [PATCH v4 0/8] Add Variable Flash Info HOB Michael Kubacki
  2022-04-12 16:29 ` [PATCH v4 1/8] MdeModulePkg: " Michael Kubacki
@ 2022-04-12 16:29 ` Michael Kubacki
  2022-04-25 16:05   ` [edk2-devel] " Sami Mujawar
  2022-04-12 16:29 ` [PATCH v4 3/8] MdeModulePkg/Variable: Consume Variable Flash Info Michael Kubacki
                   ` (7 subsequent siblings)
  9 siblings, 1 reply; 20+ messages in thread
From: Michael Kubacki @ 2022-04-12 16:29 UTC (permalink / raw)
  To: devel; +Cc: Jian J Wang, Hao A Wu, Liming Gao

From: Michael Kubacki <michael.kubacki@microsoft.com>

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

Adds a new library class VariableFlashInfoLib that abstracts access
to variable flash information. The instance provided first attempts
to retrieve information from the Variable Flash Info HOB. If that
HOB is not present, it falls back to the PCDs defined in
MdeModulePkg.

This fall back behavior provides backward compatibility for platforms
that only provide PCDs but also allows platforms that need to
dynamically provide the information using the Variable Flash Info HOB
to do so at runtime.

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>
---
 MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.c   | 178 ++++++++++++++++++++
 MdeModulePkg/Include/Library/VariableFlashInfoLib.h                        |  68 ++++++++
 MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf |  48 ++++++
 MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.uni |  12 ++
 MdeModulePkg/MdeModulePkg.dec                                              |   4 +
 MdeModulePkg/MdeModulePkg.dsc                                              |   2 +
 6 files changed, 312 insertions(+)

diff --git a/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.c b/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.c
new file mode 100644
index 000000000000..a1db97bdf218
--- /dev/null
+++ b/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.c
@@ -0,0 +1,178 @@
+/** @file
+  Variable Flash Information Library
+
+  Copyright (c) Microsoft Corporation<BR>
+
+  SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#include <Uefi.h>
+#include <Pi/PiMultiPhase.h>
+#include <Guid/VariableFlashInfo.h>
+#include <Library/DebugLib.h>
+#include <Library/HobLib.h>
+#include <Library/VariableFlashInfoLib.h>
+
+/**
+  Get the HOB that contains variable flash information.
+
+  @param[out] VariableFlashInfo   Pointer to a pointer to set to the variable flash information structure.
+
+  @retval EFI_SUCCESS             Variable flash information was found successfully.
+  @retval EFI_INVALID_PARAMETER   The VariableFlashInfo pointer given is NULL.
+  @retval EFI_NOT_FOUND           Variable flash information could not be found.
+
+**/
+EFI_STATUS
+GetVariableFlashInfoFromHob (
+  OUT VARIABLE_FLASH_INFO  **VariableFlashInfo
+  )
+{
+  EFI_HOB_GUID_TYPE  *GuidHob;
+
+  if (VariableFlashInfo == NULL) {
+    return EFI_INVALID_PARAMETER;
+  }
+
+  GuidHob = GetFirstGuidHob (&gVariableFlashInfoHobGuid);
+  if (GuidHob == NULL) {
+    return EFI_NOT_FOUND;
+  }
+
+  *VariableFlashInfo = GET_GUID_HOB_DATA (GuidHob);
+
+  //
+  // Assert if more than one variable flash information HOB is present.
+  //
+  DEBUG_CODE (
+    if ((GetNextGuidHob (&gVariableFlashInfoHobGuid, GET_NEXT_HOB (GuidHob)) != NULL)) {
+    DEBUG ((DEBUG_ERROR, "ERROR: Found two variable flash information HOBs\n"));
+    ASSERT (FALSE);
+  }
+
+    );
+
+  return EFI_SUCCESS;
+}
+
+/**
+  Get the base address and size for the NV storage area used for UEFI variable storage.
+
+  @param[out] BaseAddress    The NV storage base address.
+  @param[out] Length         The NV storage length in bytes.
+
+  @retval EFI_SUCCESS             NV storage information was found successfully.
+  @retval EFI_INVALID_PARAMETER   A required pointer parameter is NULL.
+
+**/
+EFI_STATUS
+EFIAPI
+GetVariableFlashNvStorageInfo (
+  OUT EFI_PHYSICAL_ADDRESS  *BaseAddress,
+  OUT UINT64                *Length
+  )
+{
+  EFI_STATUS           Status;
+  VARIABLE_FLASH_INFO  *VariableFlashInfo;
+
+  if ((BaseAddress == NULL) || (Length == NULL)) {
+    return EFI_INVALID_PARAMETER;
+  }
+
+  Status = GetVariableFlashInfoFromHob (&VariableFlashInfo);
+  if (!EFI_ERROR (Status)) {
+    *BaseAddress = VariableFlashInfo->NvVariableBaseAddress;
+    *Length      = VariableFlashInfo->NvVariableLength;
+  } else {
+    *BaseAddress = (EFI_PHYSICAL_ADDRESS)(PcdGet64 (PcdFlashNvStorageVariableBase64) != 0 ?
+                                          PcdGet64 (PcdFlashNvStorageVariableBase64) :
+                                          PcdGet32 (PcdFlashNvStorageVariableBase)
+                                          );
+    *Length = (UINT64)PcdGet32 (PcdFlashNvStorageVariableSize);
+  }
+
+  return EFI_SUCCESS;
+}
+
+/**
+  Get the base address and size for the fault tolerant write (FTW) spare
+  area used for UEFI variable storage.
+
+  @param[out] BaseAddress    The FTW spare base address.
+  @param[out] Length         The FTW spare length in bytes.
+
+  @retval EFI_SUCCESS             FTW spare information was found successfully.
+  @retval EFI_INVALID_PARAMETER   A required pointer parameter is NULL.
+  @retval EFI_NOT_FOUND           FTW spare information could not be found.
+
+**/
+EFI_STATUS
+EFIAPI
+GetVariableFlashFtwSpareInfo (
+  OUT EFI_PHYSICAL_ADDRESS  *BaseAddress,
+  OUT UINT64                *Length
+  )
+{
+  EFI_STATUS           Status;
+  VARIABLE_FLASH_INFO  *VariableFlashInfo;
+
+  if ((BaseAddress == NULL) || (Length == NULL)) {
+    return EFI_INVALID_PARAMETER;
+  }
+
+  Status = GetVariableFlashInfoFromHob (&VariableFlashInfo);
+  if (!EFI_ERROR (Status)) {
+    *BaseAddress = VariableFlashInfo->FtwSpareBaseAddress;
+    *Length      = VariableFlashInfo->FtwSpareLength;
+  } else {
+    *BaseAddress = (EFI_PHYSICAL_ADDRESS)(PcdGet64 (PcdFlashNvStorageFtwSpareBase64) != 0 ?
+                                          PcdGet64 (PcdFlashNvStorageFtwSpareBase64) :
+                                          PcdGet32 (PcdFlashNvStorageFtwSpareBase)
+                                          );
+    *Length = (UINT64)PcdGet32 (PcdFlashNvStorageFtwSpareSize);
+  }
+
+  return EFI_SUCCESS;
+}
+
+/**
+  Get the base address and size for the fault tolerant write (FTW) working
+  area used for UEFI variable storage.
+
+  @param[out] BaseAddress    The FTW working area base address.
+  @param[out] Length         The FTW working area length in bytes.
+
+  @retval EFI_SUCCESS             FTW working information was found successfully.
+  @retval EFI_INVALID_PARAMETER   A required pointer parameter is NULL.
+  @retval EFI_NOT_FOUND           FTW working information could not be found.
+
+**/
+EFI_STATUS
+EFIAPI
+GetVariableFlashFtwWorkingInfo (
+  OUT EFI_PHYSICAL_ADDRESS  *BaseAddress,
+  OUT UINT64                *Length
+  )
+{
+  EFI_STATUS           Status;
+  VARIABLE_FLASH_INFO  *VariableFlashInfo;
+
+  if ((BaseAddress == NULL) || (Length == NULL)) {
+    return EFI_INVALID_PARAMETER;
+  }
+
+  Status = GetVariableFlashInfoFromHob (&VariableFlashInfo);
+  if (!EFI_ERROR (Status)) {
+    *BaseAddress = VariableFlashInfo->FtwWorkingBaseAddress;
+    *Length      = VariableFlashInfo->FtwWorkingLength;
+  } else {
+    *BaseAddress = (EFI_PHYSICAL_ADDRESS)(PcdGet64 (PcdFlashNvStorageFtwWorkingBase64) != 0 ?
+                                          PcdGet64 (PcdFlashNvStorageFtwWorkingBase64) :
+                                          PcdGet32 (PcdFlashNvStorageFtwWorkingBase)
+                                          );
+    *Length = (UINT64)PcdGet32 (PcdFlashNvStorageFtwWorkingSize);
+  }
+
+  return EFI_SUCCESS;
+}
diff --git a/MdeModulePkg/Include/Library/VariableFlashInfoLib.h b/MdeModulePkg/Include/Library/VariableFlashInfoLib.h
new file mode 100644
index 000000000000..1367be9376ea
--- /dev/null
+++ b/MdeModulePkg/Include/Library/VariableFlashInfoLib.h
@@ -0,0 +1,68 @@
+/** @file
+  Variable Flash Information Library
+
+Copyright (c) Microsoft Corporation<BR>
+SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#ifndef VARIABLE_FLASH_INFO_LIB_H_
+#define VARIABLE_FLASH_INFO_LIB_H_
+
+/**
+  Get the base address and size for the NV storage area used for UEFI variable storage.
+
+  @param[out] BaseAddress    The NV storage base address.
+  @param[out] Length         The NV storage length in bytes.
+
+  @retval EFI_SUCCESS             NV storage information was found successfully.
+  @retval EFI_INVALID_PARAMETER   A required pointer parameter is NULL.
+  @retval EFI_NOT_FOUND           NV storage information could not be found.
+
+**/
+EFI_STATUS
+EFIAPI
+GetVariableFlashNvStorageInfo (
+  OUT EFI_PHYSICAL_ADDRESS  *BaseAddress,
+  OUT UINT64                *Length
+  );
+
+/**
+  Get the base address and size for the fault tolerant write (FTW) spare
+  area used for UEFI variable storage.
+
+  @param[out] BaseAddress    The FTW spare base address.
+  @param[out] Length         The FTW spare length in bytes.
+
+  @retval EFI_SUCCESS             FTW spare information was found successfully.
+  @retval EFI_INVALID_PARAMETER   A required pointer parameter is NULL.
+  @retval EFI_NOT_FOUND           FTW spare information could not be found.
+
+**/
+EFI_STATUS
+EFIAPI
+GetVariableFlashFtwSpareInfo (
+  OUT EFI_PHYSICAL_ADDRESS  *BaseAddress,
+  OUT UINT64                *Length
+  );
+
+/**
+  Get the base address and size for the fault tolerant write (FTW) working
+  area used for UEFI variable storage.
+
+  @param[out] BaseAddress    The FTW working area base address.
+  @param[out] Length         The FTW working area length in bytes.
+
+  @retval EFI_SUCCESS             FTW working information was found successfully.
+  @retval EFI_INVALID_PARAMETER   A required pointer parameter is NULL.
+  @retval EFI_NOT_FOUND           FTW working information could not be found.
+
+**/
+EFI_STATUS
+EFIAPI
+GetVariableFlashFtwWorkingInfo (
+  OUT EFI_PHYSICAL_ADDRESS  *BaseAddress,
+  OUT UINT64                *Length
+  );
+
+#endif
diff --git a/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf b/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
new file mode 100644
index 000000000000..70175e75f9b1
--- /dev/null
+++ b/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
@@ -0,0 +1,48 @@
+## @file
+#  Variable Flash Information Library
+#
+#  Provides services to access UEFI variable flash information.
+#
+#  Copyright (c) Microsoft Corporation<BR>
+#  SPDX-License-Identifier: BSD-2-Clause-Patent
+##
+
+[Defines]
+  INF_VERSION       = 0x00010005
+  BASE_NAME         = BaseVariableFlashInfoLib
+  MODULE_UNI_FILE   = BaseVariableFlashInfoLib.uni
+  FILE_GUID         = DEC426C9-C92E-4BAD-8E93-3F61C261118B
+  MODULE_TYPE       = BASE
+  VERSION_STRING    = 1.0
+  LIBRARY_CLASS     = VariableFlashInfoLib
+
+#
+# The following information is for reference only and not required by the build tools.
+#
+#  VALID_ARCHITECTURES           = ANY
+#
+
+[Sources]
+  BaseVariableFlashInfoLib.c
+
+[Packages]
+  MdePkg/MdePkg.dec
+  MdeModulePkg/MdeModulePkg.dec
+
+[LibraryClasses]
+  DebugLib
+  HobLib
+
+[Guids]
+  gVariableFlashInfoHobGuid     ## CONSUMES     ## HOB
+
+[Pcd]
+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase      ## SOMETIMES_CONSUMES
+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase64    ## SOMETIMES_CONSUMES
+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize      ## SOMETIMES_CONSUMES
+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase      ## SOMETIMES_CONSUMES
+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase64    ## SOMETIMES_CONSUMES
+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize      ## SOMETIMES_CONSUMES
+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase    ## SOMETIMES_CONSUMES
+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase64  ## SOMETIMES_CONSUMES
+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize    ## SOMETIMES_CONSUMES
diff --git a/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.uni b/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.uni
new file mode 100644
index 000000000000..9a5348fa02a0
--- /dev/null
+++ b/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.uni
@@ -0,0 +1,12 @@
+// /** @file
+// Variable Flash Information Library
+//
+// Copyright (c) Microsoft Corporation<BR>
+//
+// SPDX-License-Identifier: BSD-2-Clause-Patent
+//
+// **/
+
+#string STR_MODULE_ABSTRACT     #language en-US "UEFI variable flash information library"
+
+#string STR_MODULE_DESCRIPTION  #language en-US "Provides services to access UEFI variable flash information."
diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec
index 4e82f5836096..2bcb9f9453af 100644
--- a/MdeModulePkg/MdeModulePkg.dec
+++ b/MdeModulePkg/MdeModulePkg.dec
@@ -154,6 +154,10 @@ [LibraryClasses]
   #
   VariablePolicyHelperLib|Include/Library/VariablePolicyHelperLib.h
 
+  ##  @libraryclass  Provides services to access UEFI variable flash information.
+  #
+  VariableFlashInfoLib|Include/Library/VariableFlashInfoLib.h
+
 [Guids]
   ## MdeModule package token space guid
   # Include/Guid/MdeModulePkgTokenSpace.h
diff --git a/MdeModulePkg/MdeModulePkg.dsc b/MdeModulePkg/MdeModulePkg.dsc
index b1d83461865e..90a0a7ec4a7c 100644
--- a/MdeModulePkg/MdeModulePkg.dsc
+++ b/MdeModulePkg/MdeModulePkg.dsc
@@ -103,6 +103,7 @@ [LibraryClasses]
   DisplayUpdateProgressLib|MdeModulePkg/Library/DisplayUpdateProgressLibGraphics/DisplayUpdateProgressLibGraphics.inf
   VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
   MmUnblockMemoryLib|MdePkg/Library/MmUnblockMemoryLib/MmUnblockMemoryLibNull.inf
+  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
 
 [LibraryClasses.EBC.PEIM]
   IoLib|MdePkg/Library/PeiIoLibCpuIo/PeiIoLibCpuIo.inf
@@ -440,6 +441,7 @@ [Components]
   MdeModulePkg/Library/FmpAuthenticationLibNull/FmpAuthenticationLibNull.inf
   MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.inf
   MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.inf
+  MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
 
 [Components.IA32, Components.X64, Components.AARCH64]
   MdeModulePkg/Universal/EbcDxe/EbcDxe.inf
-- 
2.28.0.windows.1


^ permalink raw reply related	[flat|nested] 20+ messages in thread

* [PATCH v4 3/8] MdeModulePkg/Variable: Consume Variable Flash Info
  2022-04-12 16:29 [PATCH v4 0/8] Add Variable Flash Info HOB Michael Kubacki
  2022-04-12 16:29 ` [PATCH v4 1/8] MdeModulePkg: " Michael Kubacki
  2022-04-12 16:29 ` [PATCH v4 2/8] MdeModulePkg/VariableFlashInfoLib: Add initial library Michael Kubacki
@ 2022-04-12 16:29 ` Michael Kubacki
  2022-04-25 16:05   ` [edk2-devel] " Sami Mujawar
  2022-04-12 16:29 ` [PATCH v4 4/8] MdeModulePkg/FaultTolerantWrite: " Michael Kubacki
                   ` (6 subsequent siblings)
  9 siblings, 1 reply; 20+ messages in thread
From: Michael Kubacki @ 2022-04-12 16:29 UTC (permalink / raw)
  To: devel; +Cc: Jian J Wang, Hao A Wu, Liming Gao

From: Michael Kubacki <michael.kubacki@microsoft.com>

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.

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>
---
 MdeModulePkg/Universal/Variable/Pei/Variable.c                      | 14 +++++++++-----
 MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c            | 16 ++++++++++++----
 MdeModulePkg/Universal/Variable/RuntimeDxe/VariableNonVolatile.c    | 14 ++++++++++----
 MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c            | 17 +++++++++++++----
 MdeModulePkg/Universal/Variable/Pei/Variable.h                      |  2 ++
 MdeModulePkg/Universal/Variable/Pei/VariablePei.inf                 |  5 ++---
 MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h               |  7 ++-----
 MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf   |  5 ++---
 MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf          |  5 ++---
 MdeModulePkg/Universal/Variable/RuntimeDxe/VariableStandaloneMm.inf |  5 ++---
 10 files changed, 56 insertions(+), 34 deletions(-)

diff --git a/MdeModulePkg/Universal/Variable/Pei/Variable.c b/MdeModulePkg/Universal/Variable/Pei/Variable.c
index b36dd0de67b2..26a4c73b45a5 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/RuntimeDxe/VariableDxe.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
index 03fec3048dc4..d5c409c914d1 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 5e9d40b67ac2..9e2d8fe0fe0c 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/VariableSmm.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c
index 517cae7b00f8..5253c328dcd9 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/Pei/Variable.h b/MdeModulePkg/Universal/Variable/Pei/Variable.h
index 7f9ad5bfc357..51effbf79987 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 7cbdd2385e8f..7264a24bdf71 100644
--- a/MdeModulePkg/Universal/Variable/Pei/VariablePei.inf
+++ b/MdeModulePkg/Universal/Variable/Pei/VariablePei.inf
@@ -39,6 +39,8 @@ [LibraryClasses]
   DebugLib
   PeiServicesTablePointerLib
   PeiServicesLib
+  SafeIntLib
+  VariableFlashInfoLib
 
 [Guids]
   ## CONSUMES             ## GUID # Variable store header
@@ -59,9 +61,6 @@ [Ppis]
   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 31e408976a35..a668abb82b15 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/VariableRuntimeDxe.inf b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
index c9434df631ee..3858adf6739d 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
@@ -71,8 +71,10 @@ [LibraryClasses]
   TpmMeasurementLib
   AuthVariableLib
   VarCheckLib
+  VariableFlashInfoLib
   VariablePolicyLib
   VariablePolicyHelperLib
+  SafeIntLib
 
 [Protocols]
   gEfiFirmwareVolumeBlockProtocolGuid           ## CONSUMES
@@ -125,9 +127,6 @@ [Guids]
   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.inf b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf
index eaa97a01c6e5..8c552b87e080 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf
@@ -80,8 +80,10 @@ [LibraryClasses]
   AuthVariableLib
   VarCheckLib
   UefiBootServicesTableLib
+  VariableFlashInfoLib
   VariablePolicyLib
   VariablePolicyHelperLib
+  SafeIntLib
 
 [Protocols]
   gEfiSmmFirmwareVolumeBlockProtocolGuid        ## CONSUMES
@@ -127,9 +129,6 @@ [Guids]
   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 d8c4f77e7f1f..f09bed40cf51 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableStandaloneMm.inf
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableStandaloneMm.inf
@@ -73,9 +73,11 @@ [LibraryClasses]
   HobLib
   MemoryAllocationLib
   MmServicesTableLib
+  SafeIntLib
   StandaloneMmDriverEntryPoint
   SynchronizationLib
   VarCheckLib
+  VariableFlashInfoLib
   VariablePolicyLib
   VariablePolicyHelperLib
 
@@ -120,9 +122,6 @@ [Guids]
   gEdkiiVarErrorFlagGuid
 
 [Pcd]
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase       ## SOMETIMES_CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase64     ## CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize       ## CONSUMES
   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize                  ## CONSUMES
   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxAuthVariableSize              ## CONSUMES
   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVolatileVariableSize          ## CONSUMES
-- 
2.28.0.windows.1


^ permalink raw reply related	[flat|nested] 20+ messages in thread

* [PATCH v4 4/8] MdeModulePkg/FaultTolerantWrite: Consume Variable Flash Info
  2022-04-12 16:29 [PATCH v4 0/8] Add Variable Flash Info HOB Michael Kubacki
                   ` (2 preceding siblings ...)
  2022-04-12 16:29 ` [PATCH v4 3/8] MdeModulePkg/Variable: Consume Variable Flash Info Michael Kubacki
@ 2022-04-12 16:29 ` Michael Kubacki
  2022-04-25 16:05   ` [edk2-devel] " Sami Mujawar
  2022-04-12 16:29 ` [PATCH v4 5/8] ArmVirtPkg/ArmVirt.dsc.inc: Add VariableFlashInfoLib Michael Kubacki
                   ` (5 subsequent siblings)
  9 siblings, 1 reply; 20+ messages in thread
From: Michael Kubacki @ 2022-04-12 16:29 UTC (permalink / raw)
  To: devel; +Cc: Jian J Wang, Hao A Wu, Liming Gao

From: Michael Kubacki <michael.kubacki@microsoft.com>

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

Adds support to the UEFI variable fault tolerant write (FTW) drivers
to receive FTW base and size information dynamically via the Variable
Flash Information library.

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>
---
 MdeModulePkg/Universal/FaultTolerantWriteDxe/FtwMisc.c                          | 41 +++++++++++++-------
 MdeModulePkg/Universal/FaultTolerantWriteDxe/UpdateWorkingBlock.c               |  7 +++-
 MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.c            | 28 ++++++++-----
 MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.h               |  7 +++-
 MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf          | 10 +----
 MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.inf          | 10 +----
 MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteStandaloneMm.inf | 10 +----
 MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.inf          | 10 +----
 8 files changed, 63 insertions(+), 60 deletions(-)

diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FtwMisc.c b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FtwMisc.c
index 661e1487673b..f1335870e797 100644
--- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FtwMisc.c
+++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FtwMisc.c
@@ -987,22 +987,43 @@ InitFtwDevice (
   OUT EFI_FTW_DEVICE  **FtwData
   )
 {
-  EFI_FTW_DEVICE  *FtwDevice;
+  EFI_STATUS            Status;
+  EFI_PHYSICAL_ADDRESS  WorkSpaceAddress;
+  UINT64                Size;
+  UINTN                 FtwWorkingSize;
+  EFI_FTW_DEVICE        *FtwDevice;
+
+  FtwWorkingSize = 0;
+
+  Status = GetVariableFlashFtwWorkingInfo (&WorkSpaceAddress, &Size);
+  ASSERT_EFI_ERROR (Status);
+
+  Status = SafeUint64ToUintn (Size, &FtwWorkingSize);
+  // This driver currently assumes the size will be UINTN so assert the value is safe for now.
+  ASSERT_EFI_ERROR (Status);
 
   //
   // Allocate private data of this driver,
   // Including the FtwWorkSpace[FTW_WORK_SPACE_SIZE].
   //
-  FtwDevice = AllocateZeroPool (sizeof (EFI_FTW_DEVICE) + PcdGet32 (PcdFlashNvStorageFtwWorkingSize));
+  FtwDevice = AllocateZeroPool (sizeof (EFI_FTW_DEVICE) + FtwWorkingSize);
   if (FtwDevice == NULL) {
     return EFI_OUT_OF_RESOURCES;
   }
 
+  FtwDevice->WorkSpaceAddress = WorkSpaceAddress;
+  FtwDevice->WorkSpaceLength  = FtwWorkingSize;
+
+  Status = GetVariableFlashFtwSpareInfo (&FtwDevice->SpareAreaAddress, &Size);
+  ASSERT_EFI_ERROR (Status);
+
+  Status = SafeUint64ToUintn (Size, &FtwDevice->SpareAreaLength);
+  // This driver currently assumes the size will be UINTN so assert the value is safe for now.
+  ASSERT_EFI_ERROR (Status);
+
   //
   // Initialize other parameters, and set WorkSpace as FTW_ERASED_BYTE.
   //
-  FtwDevice->WorkSpaceLength = (UINTN)PcdGet32 (PcdFlashNvStorageFtwWorkingSize);
-  FtwDevice->SpareAreaLength = (UINTN)PcdGet32 (PcdFlashNvStorageFtwSpareSize);
   if ((FtwDevice->WorkSpaceLength == 0) || (FtwDevice->SpareAreaLength == 0)) {
     DEBUG ((DEBUG_ERROR, "Ftw: Workspace or Spare block does not exist!\n"));
     FreePool (FtwDevice);
@@ -1015,16 +1036,6 @@ InitFtwDevice (
   FtwDevice->FtwWorkSpaceLba = (EFI_LBA)(-1);
   FtwDevice->FtwSpareLba     = (EFI_LBA)(-1);
 
-  FtwDevice->WorkSpaceAddress = (EFI_PHYSICAL_ADDRESS)PcdGet64 (PcdFlashNvStorageFtwWorkingBase64);
-  if (FtwDevice->WorkSpaceAddress == 0) {
-    FtwDevice->WorkSpaceAddress = (EFI_PHYSICAL_ADDRESS)PcdGet32 (PcdFlashNvStorageFtwWorkingBase);
-  }
-
-  FtwDevice->SpareAreaAddress = (EFI_PHYSICAL_ADDRESS)PcdGet64 (PcdFlashNvStorageFtwSpareBase64);
-  if (FtwDevice->SpareAreaAddress == 0) {
-    FtwDevice->SpareAreaAddress = (EFI_PHYSICAL_ADDRESS)PcdGet32 (PcdFlashNvStorageFtwSpareBase);
-  }
-
   *FtwData = FtwDevice;
   return EFI_SUCCESS;
 }
@@ -1277,7 +1288,7 @@ InitFtwProtocol (
   FtwDevice->FtwLastWriteHeader = NULL;
   FtwDevice->FtwLastWriteRecord = NULL;
 
-  InitializeLocalWorkSpaceHeader ();
+  InitializeLocalWorkSpaceHeader (FtwDevice->WorkSpaceLength);
 
   //
   // Refresh the working space data from working block
diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/UpdateWorkingBlock.c b/MdeModulePkg/Universal/FaultTolerantWriteDxe/UpdateWorkingBlock.c
index 61e7a92ccea1..fd563643eb63 100644
--- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/UpdateWorkingBlock.c
+++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/UpdateWorkingBlock.c
@@ -16,10 +16,13 @@ EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER  mWorkingBlockHeader = { ZERO_GUID, 0, 0
 
   Since Signature and WriteQueueSize have been known, Crc can be calculated out,
   then the work space header will be fixed.
+
+  @param[in]  WorkSpaceLength     Length in bytes of the FTW workspace area.
+
 **/
 VOID
 InitializeLocalWorkSpaceHeader (
-  VOID
+  IN  UINTN  WorkSpaceLength
   )
 {
   //
@@ -46,7 +49,7 @@ InitializeLocalWorkSpaceHeader (
     &gEdkiiWorkingBlockSignatureGuid,
     sizeof (EFI_GUID)
     );
-  mWorkingBlockHeader.WriteQueueSize = PcdGet32 (PcdFlashNvStorageFtwWorkingSize) - sizeof (EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER);
+  mWorkingBlockHeader.WriteQueueSize = WorkSpaceLength - sizeof (EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER);
 
   //
   // Crc is calculated with all the fields except Crc and STATE, so leave them as FTW_ERASED_BYTE.
diff --git a/MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.c b/MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.c
index 15543f12ed29..8c152dcbad98 100644
--- a/MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.c
+++ b/MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.c
@@ -16,6 +16,8 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 #include <Library/DebugLib.h>
 #include <Library/BaseMemoryLib.h>
 #include <Library/HobLib.h>
+#include <Library/SafeIntLib.h>
+#include <Library/VariableFlashInfoLib.h>
 
 EFI_PEI_PPI_DESCRIPTOR  mPpiListVariable = {
   (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
@@ -212,25 +214,31 @@ PeimFaultTolerantWriteInitialize (
   EFI_PHYSICAL_ADDRESS                     SpareAreaAddress;
   UINTN                                    SpareAreaLength;
   EFI_PHYSICAL_ADDRESS                     WorkSpaceInSpareArea;
+  UINT64                                   Size;
   FAULT_TOLERANT_WRITE_LAST_WRITE_DATA     FtwLastWrite;
 
   FtwWorkingBlockHeader = NULL;
   FtwLastWriteHeader    = NULL;
   FtwLastWriteRecord    = NULL;
 
-  WorkSpaceAddress = (EFI_PHYSICAL_ADDRESS)PcdGet64 (PcdFlashNvStorageFtwWorkingBase64);
-  if (WorkSpaceAddress == 0) {
-    WorkSpaceAddress = (EFI_PHYSICAL_ADDRESS)PcdGet32 (PcdFlashNvStorageFtwWorkingBase);
-  }
+  SpareAreaAddress = 0;
+  SpareAreaLength  = 0;
+  WorkSpaceAddress = 0;
+  WorkSpaceLength  = 0;
 
-  WorkSpaceLength = (UINTN)PcdGet32 (PcdFlashNvStorageFtwWorkingSize);
+  Status = GetVariableFlashFtwWorkingInfo (&WorkSpaceAddress, &Size);
+  ASSERT_EFI_ERROR (Status);
 
-  SpareAreaAddress = (EFI_PHYSICAL_ADDRESS)PcdGet64 (PcdFlashNvStorageFtwSpareBase64);
-  if (SpareAreaAddress == 0) {
-    SpareAreaAddress = (EFI_PHYSICAL_ADDRESS)PcdGet32 (PcdFlashNvStorageFtwSpareBase);
-  }
+  Status = SafeUint64ToUintn (Size, &WorkSpaceLength);
+  // This driver currently assumes the size will be UINTN so assert the value is safe for now.
+  ASSERT_EFI_ERROR (Status);
 
-  SpareAreaLength = (UINTN)PcdGet32 (PcdFlashNvStorageFtwSpareSize);
+  Status = GetVariableFlashFtwSpareInfo (&SpareAreaAddress, &Size);
+  ASSERT_EFI_ERROR (Status);
+
+  Status = SafeUint64ToUintn (Size, &SpareAreaLength);
+  // This driver currently assumes the size will be UINTN so assert the value is safe for now.
+  ASSERT_EFI_ERROR (Status);
 
   //
   // The address of FTW working base and spare base must not be 0.
diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.h b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.h
index c14e47b5c7b2..5b84d062c294 100644
--- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.h
+++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.h
@@ -26,6 +26,8 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 #include <Library/BaseMemoryLib.h>
 #include <Library/MemoryAllocationLib.h>
 #include <Library/ReportStatusCodeLib.h>
+#include <Library/SafeIntLib.h>
+#include <Library/VariableFlashInfoLib.h>
 
 //
 // Flash erase polarity is 1
@@ -708,10 +710,13 @@ InitFtwProtocol (
 
   Since Signature and WriteQueueSize have been known, Crc can be calculated out,
   then the work space header will be fixed.
+
+  @param[in]  WorkSpaceLength     Length in bytes of the FTW workspace area.
+
 **/
 VOID
 InitializeLocalWorkSpaceHeader (
-  VOID
+  IN  UINTN  WorkSpaceLength
   );
 
 /**
diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf
index 96165614d178..d524e1849a2e 100644
--- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf
+++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf
@@ -46,6 +46,8 @@ [LibraryClasses]
   UefiLib
   PcdLib
   ReportStatusCodeLib
+  SafeIntLib
+  VariableFlashInfoLib
 
 [Guids]
   #
@@ -65,14 +67,6 @@ [Protocols]
 [FeaturePcd]
   gEfiMdeModulePkgTokenSpaceGuid.PcdFullFtwServiceEnable    ## CONSUMES
 
-[Pcd]
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase    ## SOMETIMES_CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase64  ## CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize    ## CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase      ## SOMETIMES_CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase64    ## CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize      ## CONSUMES
-
 #
 # gBS->CalculateCrc32() is consumed in EntryPoint.
 # PI spec said: When the DXE Foundation is notified that the EFI_RUNTIME_ARCH_PROTOCOL
diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.inf b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.inf
index 8cc6028470d8..8a4b9ad24657 100644
--- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.inf
+++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.inf
@@ -52,6 +52,8 @@ [LibraryClasses]
   ReportStatusCodeLib
   SmmMemLib
   BaseLib
+  SafeIntLib
+  VariableFlashInfoLib
 
 [Guids]
   #
@@ -74,14 +76,6 @@ [Protocols]
 [FeaturePcd]
   gEfiMdeModulePkgTokenSpaceGuid.PcdFullFtwServiceEnable    ## CONSUMES
 
-[Pcd]
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase    ## SOMETIMES_CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase64  ## CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize    ## CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase      ## SOMETIMES_CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase64    ## CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize      ## CONSUMES
-
 #
 # gBS->CalculateCrc32() is consumed in EntryPoint.
 # PI spec said: When the DXE Foundation is notified that the EFI_RUNTIME_ARCH_PROTOCOL
diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteStandaloneMm.inf b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteStandaloneMm.inf
index d0fab7d9414f..0ac6edf771ab 100644
--- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteStandaloneMm.inf
+++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteStandaloneMm.inf
@@ -50,7 +50,9 @@ [LibraryClasses]
   MmServicesTableLib
   PcdLib
   ReportStatusCodeLib
+  SafeIntLib
   StandaloneMmDriverEntryPoint
+  VariableFlashInfoLib
 
 [Guids]
   #
@@ -73,13 +75,5 @@ [Protocols]
 [FeaturePcd]
   gEfiMdeModulePkgTokenSpaceGuid.PcdFullFtwServiceEnable    ## CONSUMES
 
-[Pcd]
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase    ## SOMETIMES_CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase64  ## CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize    ## CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase      ## SOMETIMES_CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase64    ## CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize      ## CONSUMES
-
 [Depex]
   TRUE
diff --git a/MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.inf b/MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.inf
index f90892ad4493..230138272c3a 100644
--- a/MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.inf
+++ b/MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.inf
@@ -39,6 +39,8 @@ [LibraryClasses]
   HobLib
   BaseMemoryLib
   PcdLib
+  SafeIntLib
+  VariableFlashInfoLib
 
 [Guids]
   ## SOMETIMES_PRODUCES   ## HOB
@@ -47,14 +49,6 @@ [Guids]
   gEdkiiWorkingBlockSignatureGuid               ## SOMETIMES_CONSUMES   ## GUID
   gEfiSystemNvDataFvGuid                        ## SOMETIMES_CONSUMES   ## GUID
 
-[Pcd]
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase    ## SOMETIMES_CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase64  ## CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize    ## CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase      ## SOMETIMES_CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase64    ## CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize      ## CONSUMES
-
 [Depex]
   TRUE
 
-- 
2.28.0.windows.1


^ permalink raw reply related	[flat|nested] 20+ messages in thread

* [PATCH v4 5/8] ArmVirtPkg/ArmVirt.dsc.inc: Add VariableFlashInfoLib
  2022-04-12 16:29 [PATCH v4 0/8] Add Variable Flash Info HOB Michael Kubacki
                   ` (3 preceding siblings ...)
  2022-04-12 16:29 ` [PATCH v4 4/8] MdeModulePkg/FaultTolerantWrite: " Michael Kubacki
@ 2022-04-12 16:29 ` Michael Kubacki
  2022-04-25 16:06   ` Sami Mujawar
  2022-04-12 16:29 ` [PATCH v4 6/8] EmulatorPkg: " Michael Kubacki
                   ` (4 subsequent siblings)
  9 siblings, 1 reply; 20+ messages in thread
From: Michael Kubacki @ 2022-04-12 16:29 UTC (permalink / raw)
  To: devel
  Cc: Ard Biesheuvel, Leif Lindholm, Sami Mujawar, Gerd Hoffmann,
	Julien Grall

From: Michael Kubacki <michael.kubacki@microsoft.com>

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

Adds an instance of VariableFlashInfoLib to the platform build as
it is a new library class introduced in MdeModulePkg.

Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Leif Lindholm <quic_llindhol@quicinc.com>
Cc: Sami Mujawar <sami.mujawar@arm.com>
Cc: Gerd Hoffmann <kraxel@redhat.com>
Cc: Julien Grall <julien@xen.org>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
 ArmVirtPkg/ArmVirt.dsc.inc | 1 +
 1 file changed, 1 insertion(+)

diff --git a/ArmVirtPkg/ArmVirt.dsc.inc b/ArmVirtPkg/ArmVirt.dsc.inc
index ba711deac025..988c1eb75529 100644
--- a/ArmVirtPkg/ArmVirt.dsc.inc
+++ b/ArmVirtPkg/ArmVirt.dsc.inc
@@ -177,6 +177,7 @@ [LibraryClasses.common]
   AuthVariableLib|MdeModulePkg/Library/AuthVariableLibNull/AuthVariableLibNull.inf
 !endif
   VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
+  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
   VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
   VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
   UefiBootManagerLib|MdeModulePkg/Library/UefiBootManagerLib/UefiBootManagerLib.inf
-- 
2.28.0.windows.1


^ permalink raw reply related	[flat|nested] 20+ messages in thread

* [PATCH v4 6/8] EmulatorPkg: Add VariableFlashInfoLib
  2022-04-12 16:29 [PATCH v4 0/8] Add Variable Flash Info HOB Michael Kubacki
                   ` (4 preceding siblings ...)
  2022-04-12 16:29 ` [PATCH v4 5/8] ArmVirtPkg/ArmVirt.dsc.inc: Add VariableFlashInfoLib Michael Kubacki
@ 2022-04-12 16:29 ` Michael Kubacki
  2022-04-12 16:29 ` [PATCH v4 7/8] OvmfPkg: " Michael Kubacki
                   ` (3 subsequent siblings)
  9 siblings, 0 replies; 20+ messages in thread
From: Michael Kubacki @ 2022-04-12 16:29 UTC (permalink / raw)
  To: devel; +Cc: Andrew Fish, Ray Ni, Abner Chang, Nickle Wang

From: Michael Kubacki <michael.kubacki@microsoft.com>

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

Adds an instance of VariableFlashInfoLib to the platform build as
it is a new library class introduced in MdeModulePkg.

Cc: Andrew Fish <afish@apple.com>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Abner Chang <abner.chang@hpe.com>
Cc: Nickle Wang <nickle.wang@hpe.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
 EmulatorPkg/EmulatorPkg.dsc | 1 +
 1 file changed, 1 insertion(+)

diff --git a/EmulatorPkg/EmulatorPkg.dsc b/EmulatorPkg/EmulatorPkg.dsc
index 554c13ddb500..4cf886b9eac7 100644
--- a/EmulatorPkg/EmulatorPkg.dsc
+++ b/EmulatorPkg/EmulatorPkg.dsc
@@ -122,6 +122,7 @@ [LibraryClasses]
   VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
   VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLibRuntimeDxe.inf
   VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
+  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
   SortLib|MdeModulePkg/Library/BaseSortLib/BaseSortLib.inf
   ShellLib|ShellPkg/Library/UefiShellLib/UefiShellLib.inf
   FileHandleLib|MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.inf
-- 
2.28.0.windows.1


^ permalink raw reply related	[flat|nested] 20+ messages in thread

* [PATCH v4 7/8] OvmfPkg: Add VariableFlashInfoLib
  2022-04-12 16:29 [PATCH v4 0/8] Add Variable Flash Info HOB Michael Kubacki
                   ` (5 preceding siblings ...)
  2022-04-12 16:29 ` [PATCH v4 6/8] EmulatorPkg: " Michael Kubacki
@ 2022-04-12 16:29 ` Michael Kubacki
  2022-04-19 19:26   ` Rebecca Cran
  2022-04-12 16:29 ` [PATCH v4 8/8] UefiPayloadPkg: " Michael Kubacki
                   ` (2 subsequent siblings)
  9 siblings, 1 reply; 20+ messages in thread
From: Michael Kubacki @ 2022-04-12 16:29 UTC (permalink / raw)
  To: devel
  Cc: Anthony Perard, Ard Biesheuvel, Brijesh Singh, Erdem Aktas,
	Gerd Hoffmann, James Bottomley, Jiewen Yao, Jordan Justen,
	Julien Grall, Min Xu, Peter Grehan, Rebecca Cran, Sebastien Boeuf,
	Tom Lendacky

From: Michael Kubacki <michael.kubacki@microsoft.com>

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

Adds an instance of VariableFlashInfoLib to the platform build as
it is a new library class introduced in MdeModulePkg.

Cc: Anthony Perard <anthony.perard@citrix.com>
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Brijesh Singh <brijesh.singh@amd.com>
Cc: Erdem Aktas <erdemaktas@google.com>
Cc: Gerd Hoffmann <kraxel@redhat.com>
Cc: James Bottomley <jejb@linux.ibm.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Jordan Justen <jordan.l.justen@intel.com>
Cc: Julien Grall <julien@xen.org>
Cc: Min Xu <min.m.xu@intel.com>
Cc: Peter Grehan <grehan@freebsd.org>
Cc: Rebecca Cran <rebecca@bsdio.com>
Cc: Sebastien Boeuf <sebastien.boeuf@intel.com>
Cc: Tom Lendacky <thomas.lendacky@amd.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
 OvmfPkg/AmdSev/AmdSevX64.dsc     | 1 +
 OvmfPkg/Bhyve/BhyveX64.dsc       | 1 +
 OvmfPkg/CloudHv/CloudHvX64.dsc   | 1 +
 OvmfPkg/IntelTdx/IntelTdxX64.dsc | 1 +
 OvmfPkg/Microvm/MicrovmX64.dsc   | 1 +
 OvmfPkg/OvmfPkgIa32.dsc          | 1 +
 OvmfPkg/OvmfPkgIa32X64.dsc       | 1 +
 OvmfPkg/OvmfPkgX64.dsc           | 1 +
 OvmfPkg/OvmfXen.dsc              | 1 +
 9 files changed, 9 insertions(+)

diff --git a/OvmfPkg/AmdSev/AmdSevX64.dsc b/OvmfPkg/AmdSev/AmdSevX64.dsc
index fcdc3efab204..3868c577fe39 100644
--- a/OvmfPkg/AmdSev/AmdSevX64.dsc
+++ b/OvmfPkg/AmdSev/AmdSevX64.dsc
@@ -195,6 +195,7 @@ [LibraryClasses]
   VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
   VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
   VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
+  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
 
 !if $(BUILD_SHELL) == TRUE
   ShellLib|ShellPkg/Library/UefiShellLib/UefiShellLib.inf
diff --git a/OvmfPkg/Bhyve/BhyveX64.dsc b/OvmfPkg/Bhyve/BhyveX64.dsc
index e1b6b8e15f36..3df49e54de8a 100644
--- a/OvmfPkg/Bhyve/BhyveX64.dsc
+++ b/OvmfPkg/Bhyve/BhyveX64.dsc
@@ -206,6 +206,7 @@ [LibraryClasses]
   VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
   VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
   VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
+  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
 
   #
   # Network libraries
diff --git a/OvmfPkg/CloudHv/CloudHvX64.dsc b/OvmfPkg/CloudHv/CloudHvX64.dsc
index 20f3bc340807..19b84275eba3 100644
--- a/OvmfPkg/CloudHv/CloudHvX64.dsc
+++ b/OvmfPkg/CloudHv/CloudHvX64.dsc
@@ -216,6 +216,7 @@ [LibraryClasses]
   VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
   VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
   VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
+  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
 
 
   #
diff --git a/OvmfPkg/IntelTdx/IntelTdxX64.dsc b/OvmfPkg/IntelTdx/IntelTdxX64.dsc
index 245155d41b30..f21a33ed6ba3 100644
--- a/OvmfPkg/IntelTdx/IntelTdxX64.dsc
+++ b/OvmfPkg/IntelTdx/IntelTdxX64.dsc
@@ -184,6 +184,7 @@ [LibraryClasses]
   VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
   VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
   VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
+  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
 
   ShellLib|ShellPkg/Library/UefiShellLib/UefiShellLib.inf
   ShellCEntryLib|ShellPkg/Library/UefiShellCEntryLib/UefiShellCEntryLib.inf
diff --git a/OvmfPkg/Microvm/MicrovmX64.dsc b/OvmfPkg/Microvm/MicrovmX64.dsc
index 59580ccd4691..d8603f016a0c 100644
--- a/OvmfPkg/Microvm/MicrovmX64.dsc
+++ b/OvmfPkg/Microvm/MicrovmX64.dsc
@@ -206,6 +206,7 @@ [LibraryClasses]
   VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
   VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
   VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
+  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
 
 
   #
diff --git a/OvmfPkg/OvmfPkgIa32.dsc b/OvmfPkg/OvmfPkgIa32.dsc
index e4218b01f0fc..c689d4707046 100644
--- a/OvmfPkg/OvmfPkgIa32.dsc
+++ b/OvmfPkg/OvmfPkgIa32.dsc
@@ -213,6 +213,7 @@ [LibraryClasses]
   VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
   VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
   VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
+  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
 
 
   #
diff --git a/OvmfPkg/OvmfPkgIa32X64.dsc b/OvmfPkg/OvmfPkgIa32X64.dsc
index a80cdaacb8bc..44c75639aa5d 100644
--- a/OvmfPkg/OvmfPkgIa32X64.dsc
+++ b/OvmfPkg/OvmfPkgIa32X64.dsc
@@ -217,6 +217,7 @@ [LibraryClasses]
   VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
   VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
   VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
+  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
 
 
   #
diff --git a/OvmfPkg/OvmfPkgX64.dsc b/OvmfPkg/OvmfPkgX64.dsc
index fb2899f8a1be..60e7e3724a6b 100644
--- a/OvmfPkg/OvmfPkgX64.dsc
+++ b/OvmfPkg/OvmfPkgX64.dsc
@@ -225,6 +225,7 @@ [LibraryClasses]
   VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
   VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
   VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
+  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
 
 
   #
diff --git a/OvmfPkg/OvmfXen.dsc b/OvmfPkg/OvmfXen.dsc
index 7bd594c6e263..01d832323585 100644
--- a/OvmfPkg/OvmfXen.dsc
+++ b/OvmfPkg/OvmfXen.dsc
@@ -195,6 +195,7 @@ [LibraryClasses]
   VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
   VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
   VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
+  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
 
 
   #
-- 
2.28.0.windows.1


^ permalink raw reply related	[flat|nested] 20+ messages in thread

* [PATCH v4 8/8] UefiPayloadPkg: Add VariableFlashInfoLib
  2022-04-12 16:29 [PATCH v4 0/8] Add Variable Flash Info HOB Michael Kubacki
                   ` (6 preceding siblings ...)
  2022-04-12 16:29 ` [PATCH v4 7/8] OvmfPkg: " Michael Kubacki
@ 2022-04-12 16:29 ` Michael Kubacki
  2022-04-14  3:02   ` [edk2-devel] " Guo Dong
  2022-04-20  7:43 ` [PATCH v4 0/8] Add Variable Flash Info HOB Ard Biesheuvel
       [not found] ` <16E5331AC6E8EA6F.9041@groups.io>
  9 siblings, 1 reply; 20+ messages in thread
From: Michael Kubacki @ 2022-04-12 16:29 UTC (permalink / raw)
  To: devel; +Cc: Guo Dong, Ray Ni, Maurice Ma, Benjamin You, Sean Rhodes

From: Michael Kubacki <michael.kubacki@microsoft.com>

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

Adds an instance of VariableFlashInfoLib to the platform build as
it is a new library class introduced in MdeModulePkg.

Cc: Guo Dong <guo.dong@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Maurice Ma <maurice.ma@intel.com>
Cc: Benjamin You <benjamin.you@intel.com>
Cc: Sean Rhodes <sean@starlabs.systems>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
 UefiPayloadPkg/UefiPayloadPkg.dsc | 1 +
 1 file changed, 1 insertion(+)

diff --git a/UefiPayloadPkg/UefiPayloadPkg.dsc b/UefiPayloadPkg/UefiPayloadPkg.dsc
index 17b30589e77c..4d9bbc80c866 100644
--- a/UefiPayloadPkg/UefiPayloadPkg.dsc
+++ b/UefiPayloadPkg/UefiPayloadPkg.dsc
@@ -272,6 +272,7 @@ [LibraryClasses]
   VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
   VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
   VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
+  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
   VmgExitLib|UefiCpuPkg/Library/VmgExitLibNull/VmgExitLibNull.inf
   ReportStatusCodeLib|MdeModulePkg/Library/DxeReportStatusCodeLib/DxeReportStatusCodeLib.inf
 
-- 
2.28.0.windows.1


^ permalink raw reply related	[flat|nested] 20+ messages in thread

* Re: [edk2-devel] [PATCH v4 8/8] UefiPayloadPkg: Add VariableFlashInfoLib
  2022-04-12 16:29 ` [PATCH v4 8/8] UefiPayloadPkg: " Michael Kubacki
@ 2022-04-14  3:02   ` Guo Dong
  0 siblings, 0 replies; 20+ messages in thread
From: Guo Dong @ 2022-04-14  3:02 UTC (permalink / raw)
  To: devel@edk2.groups.io, mikuback@linux.microsoft.com
  Cc: Ni, Ray, Ma, Maurice, You, Benjamin, Rhodes, Sean


Reviewed-by: Guo Dong <guo.dong@intel.com>

-----Original Message-----
From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Michael Kubacki
Sent: Tuesday, April 12, 2022 9:30 AM
To: devel@edk2.groups.io
Cc: Dong, Guo <guo.dong@intel.com>; Ni, Ray <ray.ni@intel.com>; Ma, Maurice <maurice.ma@intel.com>; You, Benjamin <benjamin.you@intel.com>; Rhodes, Sean <sean@starlabs.systems>
Subject: [edk2-devel] [PATCH v4 8/8] UefiPayloadPkg: Add VariableFlashInfoLib

From: Michael Kubacki <michael.kubacki@microsoft.com>

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

Adds an instance of VariableFlashInfoLib to the platform build as it is a new library class introduced in MdeModulePkg.

Cc: Guo Dong <guo.dong@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Maurice Ma <maurice.ma@intel.com>
Cc: Benjamin You <benjamin.you@intel.com>
Cc: Sean Rhodes <sean@starlabs.systems>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
 UefiPayloadPkg/UefiPayloadPkg.dsc | 1 +
 1 file changed, 1 insertion(+)

diff --git a/UefiPayloadPkg/UefiPayloadPkg.dsc b/UefiPayloadPkg/UefiPayloadPkg.dsc
index 17b30589e77c..4d9bbc80c866 100644
--- a/UefiPayloadPkg/UefiPayloadPkg.dsc
+++ b/UefiPayloadPkg/UefiPayloadPkg.dsc
@@ -272,6 +272,7 @@ [LibraryClasses]
   VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
   VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
   VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
+  
+ VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/Bas
+ eVariableFlashInfoLib.inf
   VmgExitLib|UefiCpuPkg/Library/VmgExitLibNull/VmgExitLibNull.inf
   ReportStatusCodeLib|MdeModulePkg/Library/DxeReportStatusCodeLib/DxeReportStatusCodeLib.inf
 
--
2.28.0.windows.1



-=-=-=-=-=-=
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#88795): https://edk2.groups.io/g/devel/message/88795
Mute This Topic: https://groups.io/mt/90421985/1781375
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [guo.dong@intel.com]
-=-=-=-=-=-=



^ permalink raw reply related	[flat|nested] 20+ messages in thread

* Re: [PATCH v4 7/8] OvmfPkg: Add VariableFlashInfoLib
  2022-04-12 16:29 ` [PATCH v4 7/8] OvmfPkg: " Michael Kubacki
@ 2022-04-19 19:26   ` Rebecca Cran
  0 siblings, 0 replies; 20+ messages in thread
From: Rebecca Cran @ 2022-04-19 19:26 UTC (permalink / raw)
  To: mikuback, devel
  Cc: Anthony Perard, Ard Biesheuvel, Brijesh Singh, Erdem Aktas,
	Gerd Hoffmann, James Bottomley, Jiewen Yao, Jordan Justen,
	Julien Grall, Min Xu, Peter Grehan, Sebastien Boeuf, Tom Lendacky

Reviewed-by: Rebecca Cran <rebecca@bsdio.com>


On 4/12/22 10:29, mikuback@linux.microsoft.com wrote:
> From: Michael Kubacki <michael.kubacki@microsoft.com>
>
> REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3479
>
> Adds an instance of VariableFlashInfoLib to the platform build as
> it is a new library class introduced in MdeModulePkg.
>
> Cc: Anthony Perard <anthony.perard@citrix.com>
> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
> Cc: Brijesh Singh <brijesh.singh@amd.com>
> Cc: Erdem Aktas <erdemaktas@google.com>
> Cc: Gerd Hoffmann <kraxel@redhat.com>
> Cc: James Bottomley <jejb@linux.ibm.com>
> Cc: Jiewen Yao <jiewen.yao@intel.com>
> Cc: Jordan Justen <jordan.l.justen@intel.com>
> Cc: Julien Grall <julien@xen.org>
> Cc: Min Xu <min.m.xu@intel.com>
> Cc: Peter Grehan <grehan@freebsd.org>
> Cc: Rebecca Cran <rebecca@bsdio.com>
> Cc: Sebastien Boeuf <sebastien.boeuf@intel.com>
> Cc: Tom Lendacky <thomas.lendacky@amd.com>
> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
> ---
>   OvmfPkg/AmdSev/AmdSevX64.dsc     | 1 +
>   OvmfPkg/Bhyve/BhyveX64.dsc       | 1 +
>   OvmfPkg/CloudHv/CloudHvX64.dsc   | 1 +
>   OvmfPkg/IntelTdx/IntelTdxX64.dsc | 1 +
>   OvmfPkg/Microvm/MicrovmX64.dsc   | 1 +
>   OvmfPkg/OvmfPkgIa32.dsc          | 1 +
>   OvmfPkg/OvmfPkgIa32X64.dsc       | 1 +
>   OvmfPkg/OvmfPkgX64.dsc           | 1 +
>   OvmfPkg/OvmfXen.dsc              | 1 +
>   9 files changed, 9 insertions(+)
>
> diff --git a/OvmfPkg/AmdSev/AmdSevX64.dsc b/OvmfPkg/AmdSev/AmdSevX64.dsc
> index fcdc3efab204..3868c577fe39 100644
> --- a/OvmfPkg/AmdSev/AmdSevX64.dsc
> +++ b/OvmfPkg/AmdSev/AmdSevX64.dsc
> @@ -195,6 +195,7 @@ [LibraryClasses]
>     VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
>     VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
>     VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
> +  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
>   
>   !if $(BUILD_SHELL) == TRUE
>     ShellLib|ShellPkg/Library/UefiShellLib/UefiShellLib.inf
> diff --git a/OvmfPkg/Bhyve/BhyveX64.dsc b/OvmfPkg/Bhyve/BhyveX64.dsc
> index e1b6b8e15f36..3df49e54de8a 100644
> --- a/OvmfPkg/Bhyve/BhyveX64.dsc
> +++ b/OvmfPkg/Bhyve/BhyveX64.dsc
> @@ -206,6 +206,7 @@ [LibraryClasses]
>     VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
>     VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
>     VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
> +  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
>   
>     #
>     # Network libraries
> diff --git a/OvmfPkg/CloudHv/CloudHvX64.dsc b/OvmfPkg/CloudHv/CloudHvX64.dsc
> index 20f3bc340807..19b84275eba3 100644
> --- a/OvmfPkg/CloudHv/CloudHvX64.dsc
> +++ b/OvmfPkg/CloudHv/CloudHvX64.dsc
> @@ -216,6 +216,7 @@ [LibraryClasses]
>     VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
>     VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
>     VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
> +  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
>   
>   
>     #
> diff --git a/OvmfPkg/IntelTdx/IntelTdxX64.dsc b/OvmfPkg/IntelTdx/IntelTdxX64.dsc
> index 245155d41b30..f21a33ed6ba3 100644
> --- a/OvmfPkg/IntelTdx/IntelTdxX64.dsc
> +++ b/OvmfPkg/IntelTdx/IntelTdxX64.dsc
> @@ -184,6 +184,7 @@ [LibraryClasses]
>     VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
>     VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
>     VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
> +  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
>   
>     ShellLib|ShellPkg/Library/UefiShellLib/UefiShellLib.inf
>     ShellCEntryLib|ShellPkg/Library/UefiShellCEntryLib/UefiShellCEntryLib.inf
> diff --git a/OvmfPkg/Microvm/MicrovmX64.dsc b/OvmfPkg/Microvm/MicrovmX64.dsc
> index 59580ccd4691..d8603f016a0c 100644
> --- a/OvmfPkg/Microvm/MicrovmX64.dsc
> +++ b/OvmfPkg/Microvm/MicrovmX64.dsc
> @@ -206,6 +206,7 @@ [LibraryClasses]
>     VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
>     VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
>     VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
> +  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
>   
>   
>     #
> diff --git a/OvmfPkg/OvmfPkgIa32.dsc b/OvmfPkg/OvmfPkgIa32.dsc
> index e4218b01f0fc..c689d4707046 100644
> --- a/OvmfPkg/OvmfPkgIa32.dsc
> +++ b/OvmfPkg/OvmfPkgIa32.dsc
> @@ -213,6 +213,7 @@ [LibraryClasses]
>     VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
>     VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
>     VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
> +  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
>   
>   
>     #
> diff --git a/OvmfPkg/OvmfPkgIa32X64.dsc b/OvmfPkg/OvmfPkgIa32X64.dsc
> index a80cdaacb8bc..44c75639aa5d 100644
> --- a/OvmfPkg/OvmfPkgIa32X64.dsc
> +++ b/OvmfPkg/OvmfPkgIa32X64.dsc
> @@ -217,6 +217,7 @@ [LibraryClasses]
>     VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
>     VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
>     VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
> +  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
>   
>   
>     #
> diff --git a/OvmfPkg/OvmfPkgX64.dsc b/OvmfPkg/OvmfPkgX64.dsc
> index fb2899f8a1be..60e7e3724a6b 100644
> --- a/OvmfPkg/OvmfPkgX64.dsc
> +++ b/OvmfPkg/OvmfPkgX64.dsc
> @@ -225,6 +225,7 @@ [LibraryClasses]
>     VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
>     VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
>     VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
> +  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
>   
>   
>     #
> diff --git a/OvmfPkg/OvmfXen.dsc b/OvmfPkg/OvmfXen.dsc
> index 7bd594c6e263..01d832323585 100644
> --- a/OvmfPkg/OvmfXen.dsc
> +++ b/OvmfPkg/OvmfXen.dsc
> @@ -195,6 +195,7 @@ [LibraryClasses]
>     VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
>     VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
>     VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
> +  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
>   
>   
>     #

^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [PATCH v4 0/8] Add Variable Flash Info HOB
  2022-04-12 16:29 [PATCH v4 0/8] Add Variable Flash Info HOB Michael Kubacki
                   ` (7 preceding siblings ...)
  2022-04-12 16:29 ` [PATCH v4 8/8] UefiPayloadPkg: " Michael Kubacki
@ 2022-04-20  7:43 ` Ard Biesheuvel
       [not found] ` <16E5331AC6E8EA6F.9041@groups.io>
  9 siblings, 0 replies; 20+ messages in thread
From: Ard Biesheuvel @ 2022-04-20  7:43 UTC (permalink / raw)
  To: Michael Kubacki
  Cc: edk2-devel-groups-io, Abner Chang, Andrew Fish, Anthony Perard,
	Ard Biesheuvel, Benjamin You, Brijesh Singh, Erdem Aktas,
	Gerd Hoffmann, Guo Dong, Hao A Wu, James Bottomley, Jian J Wang,
	Jiewen Yao, Jordan Justen, Julien Grall, Leif Lindholm,
	Liming Gao, Maurice Ma, Min Xu, Nickle Wang, Peter Grehan, Ray Ni,
	Rebecca Cran, Sami Mujawar, Sean Rhodes, Sebastien Boeuf,
	Tom Lendacky

On Tue, 12 Apr 2022 at 18:30, <mikuback@linux.microsoft.com> wrote:
>
> From: Michael Kubacki <michael.kubacki@microsoft.com>
>
> REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3479
>
> The UEFI variable drivers such as VariableRuntimeDxe, VariableSmm,
> VariableStandaloneMm, etc. (and their dependent protocol/library
> stack), typically acquire UEFI variable store flash information
> with PCDs declared in MdeModulePkg.
>
> For example:
> [Pcd]
>   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase
>   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase64
>   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize
>
> These PCDs work as-is in the StandaloneMm driver if they are not
> dynamic such as Dynamic or DynamicEx because PCD services are not
> readily available in the Standalone MM environment. Platforms that
> use Standalone MM today, must define these PCDs as FixedAtBuild in
> their platform build. However, the PCDs do allow platforms to treat
> the PCDs as Dynamic/DynamicEx and being able to support that is
> currently a gap for Standalone MM.
>
> This patch series introduces a HOB that can be produced by the
> platform to provide the same information. The HOB list is
> available to Standalone MM.
>
> The PCD declarations are left as-is in MdeModulePkg for backward
> compatibility. This means unless a platform wants to use the HOB,
> their code will continue to work with no change (they do not need
> to produce the HOB). Only if the HOB is found, is its value used
> instead of the PCDs.
>
> Due to the large number of consumers of this information, access
> to the base address and size values is abstracted in a new library
> class (as requested in the v1 series) called VariableFlashInfoLib.
>
> The API of VariableFlashInfoLib does not bind the underlying data
> structure to the information returned to library users to allow
> flexibility in the library implementation in the future.
>
> V4 changes:
> 1. Add a UINT32 "Reserved" field to VARIABLE_FLASH_INFO.
> 2. Add a descriptive comment to VariableFlashInfo.h to explain
>    HOB usage.
>
> V3 changes:
> 1. To better clarify usage, renamed the members
>    "NvStorageBaseAddress" and "NvStorageLength" in
>    "VARIABLE_FLASH_INFO" to "NvVariableBaseAddress" and
>    "NvVariableLength".
> 2. Added description comments to the fields in "VARIABLE_FLASH_INFO".
>
> V2 changes:
> 1. Abstracted flash info data access with VariableFlashInfoLib.
> 2. Updated package builds in the repo that build the variable and
>    FTW drivers to include VariableFlashInfoLib.
> 3. Removed a redundant variable assignment in VariableSmm.c.
> 4. Updated comments in FtwMisc.c and FaultTolerantWritePei.c to
>    indicate driver assumption is UINTN (not UINT32)
> 5. Added a version field to the VARIABLE_FLASH_INFO structure.
>
> Cc: Abner Chang <abner.chang@hpe.com>
> Cc: Andrew Fish <afish@apple.com>
> Cc: Anthony Perard <anthony.perard@citrix.com>
> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
> Cc: Benjamin You <benjamin.you@intel.com>
> Cc: Brijesh Singh <brijesh.singh@amd.com>
> Cc: Erdem Aktas <erdemaktas@google.com>
> Cc: Gerd Hoffmann <kraxel@redhat.com>
> Cc: Guo Dong <guo.dong@intel.com>
> Cc: Hao A Wu <hao.a.wu@intel.com>
> Cc: James Bottomley <jejb@linux.ibm.com>
> Cc: Jian J Wang <jian.j.wang@intel.com>
> Cc: Jiewen Yao <jiewen.yao@intel.com>
> Cc: Jordan Justen <jordan.l.justen@intel.com>
> Cc: Julien Grall <julien@xen.org>
> Cc: Leif Lindholm <quic_llindhol@quicinc.com>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Cc: Maurice Ma <maurice.ma@intel.com>
> Cc: Min Xu <min.m.xu@intel.com>
> Cc: Nickle Wang <nickle.wang@hpe.com>
> Cc: Peter Grehan <grehan@freebsd.org>
> Cc: Ray Ni <ray.ni@intel.com>
> Cc: Rebecca Cran <rebecca@bsdio.com>
> Cc: Sami Mujawar <sami.mujawar@arm.com>
> Cc: Sean Rhodes <sean@starlabs.systems>
> Cc: Sebastien Boeuf <sebastien.boeuf@intel.com>
> Cc: Tom Lendacky <thomas.lendacky@amd.com>
> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
>
> Michael Kubacki (8):
>   MdeModulePkg: Add Variable Flash Info HOB
>   MdeModulePkg/VariableFlashInfoLib: Add initial library
>   MdeModulePkg/Variable: Consume Variable Flash Info
>   MdeModulePkg/FaultTolerantWrite: Consume Variable Flash Info
>   ArmVirtPkg/ArmVirt.dsc.inc: Add VariableFlashInfoLib
>   EmulatorPkg: Add VariableFlashInfoLib
>   OvmfPkg: Add VariableFlashInfoLib
>   UefiPayloadPkg: Add VariableFlashInfoLib
>

For the series,

Acked-by: Ard Biesheuvel <ardb@kernel.org>

>  MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.c        | 178 ++++++++++++++++++++
>  MdeModulePkg/Universal/FaultTolerantWriteDxe/FtwMisc.c                          |  41 +++--
>  MdeModulePkg/Universal/FaultTolerantWriteDxe/UpdateWorkingBlock.c               |   7 +-
>  MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.c            |  28 +--
>  MdeModulePkg/Universal/Variable/Pei/Variable.c                                  |  14 +-
>  MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c                        |  16 +-
>  MdeModulePkg/Universal/Variable/RuntimeDxe/VariableNonVolatile.c                |  14 +-
>  MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c                        |  17 +-
>  ArmVirtPkg/ArmVirt.dsc.inc                                                      |   1 +
>  EmulatorPkg/EmulatorPkg.dsc                                                     |   1 +
>  MdeModulePkg/Include/Guid/VariableFlashInfo.h                                   | 111 ++++++++++++
>  MdeModulePkg/Include/Library/VariableFlashInfoLib.h                             |  68 ++++++++
>  MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf      |  48 ++++++
>  MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.uni      |  12 ++
>  MdeModulePkg/MdeModulePkg.dec                                                   |   8 +
>  MdeModulePkg/MdeModulePkg.dsc                                                   |   2 +
>  MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.h               |   7 +-
>  MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf          |  10 +-
>  MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.inf          |  10 +-
>  MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteStandaloneMm.inf |  10 +-
>  MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.inf          |  10 +-
>  MdeModulePkg/Universal/Variable/Pei/Variable.h                                  |   2 +
>  MdeModulePkg/Universal/Variable/Pei/VariablePei.inf                             |   5 +-
>  MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h                           |   7 +-
>  MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf               |   5 +-
>  MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf                      |   5 +-
>  MdeModulePkg/Universal/Variable/RuntimeDxe/VariableStandaloneMm.inf             |   5 +-
>  OvmfPkg/AmdSev/AmdSevX64.dsc                                                    |   1 +
>  OvmfPkg/Bhyve/BhyveX64.dsc                                                      |   1 +
>  OvmfPkg/CloudHv/CloudHvX64.dsc                                                  |   1 +
>  OvmfPkg/IntelTdx/IntelTdxX64.dsc                                                |   1 +
>  OvmfPkg/Microvm/MicrovmX64.dsc                                                  |   1 +
>  OvmfPkg/OvmfPkgIa32.dsc                                                         |   1 +
>  OvmfPkg/OvmfPkgIa32X64.dsc                                                      |   1 +
>  OvmfPkg/OvmfPkgX64.dsc                                                          |   1 +
>  OvmfPkg/OvmfXen.dsc                                                             |   1 +
>  UefiPayloadPkg/UefiPayloadPkg.dsc                                               |   1 +
>  37 files changed, 558 insertions(+), 94 deletions(-)
>  create mode 100644 MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.c
>  create mode 100644 MdeModulePkg/Include/Guid/VariableFlashInfo.h
>  create mode 100644 MdeModulePkg/Include/Library/VariableFlashInfoLib.h
>  create mode 100644 MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
>  create mode 100644 MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.uni
>
> --
> 2.28.0.windows.1
>

^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [edk2-devel] [PATCH v4 6/8] EmulatorPkg: Add VariableFlashInfoLib
       [not found] ` <16E5331AC6E8EA6F.9041@groups.io>
@ 2022-04-20 22:51   ` Michael Kubacki
  2022-04-21  1:51     ` Abner Chang
  0 siblings, 1 reply; 20+ messages in thread
From: Michael Kubacki @ 2022-04-20 22:51 UTC (permalink / raw)
  To: devel, Andrew Fish, Ray Ni, Abner Chang, Nickle Wang

Hi EmulatorPkg maintainers,

This is the only package in the series that has not given a review yet. 
Can you please help review it?

Thanks,
Michael

On 4/12/2022 12:29 PM, Michael Kubacki wrote:
> From: Michael Kubacki <michael.kubacki@microsoft.com>
> 
> REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3479
> 
> Adds an instance of VariableFlashInfoLib to the platform build as
> it is a new library class introduced in MdeModulePkg.
> 
> Cc: Andrew Fish <afish@apple.com>
> Cc: Ray Ni <ray.ni@intel.com>
> Cc: Abner Chang <abner.chang@hpe.com>
> Cc: Nickle Wang <nickle.wang@hpe.com>
> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
> ---
>   EmulatorPkg/EmulatorPkg.dsc | 1 +
>   1 file changed, 1 insertion(+)
> 
> diff --git a/EmulatorPkg/EmulatorPkg.dsc b/EmulatorPkg/EmulatorPkg.dsc
> index 554c13ddb500..4cf886b9eac7 100644
> --- a/EmulatorPkg/EmulatorPkg.dsc
> +++ b/EmulatorPkg/EmulatorPkg.dsc
> @@ -122,6 +122,7 @@ [LibraryClasses]
>     VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
>     VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLibRuntimeDxe.inf
>     VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
> +  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
>     SortLib|MdeModulePkg/Library/BaseSortLib/BaseSortLib.inf
>     ShellLib|ShellPkg/Library/UefiShellLib/UefiShellLib.inf
>     FileHandleLib|MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.inf

^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [edk2-devel] [PATCH v4 6/8] EmulatorPkg: Add VariableFlashInfoLib
  2022-04-20 22:51   ` [edk2-devel] [PATCH v4 6/8] EmulatorPkg: Add VariableFlashInfoLib Michael Kubacki
@ 2022-04-21  1:51     ` Abner Chang
  0 siblings, 0 replies; 20+ messages in thread
From: Abner Chang @ 2022-04-21  1:51 UTC (permalink / raw)
  To: devel@edk2.groups.io, mikuback@linux.microsoft.com, Andrew Fish,
	Ray Ni, Wang, Nickle (Server BIOS)

I am not the reviewer for the changes under EmulatorPkg other than Redfish stuff. However, I have no problem with the entire patch set, so does the change under for EmulatorPkg.

Reviewed-by: Abner Chang <abner.chang@hpe.com>

> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Michael
> Kubacki
> Sent: Thursday, April 21, 2022 6:52 AM
> To: devel@edk2.groups.io; Andrew Fish <afish@apple.com>; Ray Ni
> <ray.ni@intel.com>; Chang, Abner (HPS SW/FW Technologist)
> <abner.chang@hpe.com>; Wang, Nickle (Server BIOS)
> <nickle.wang@hpe.com>
> Subject: Re: [edk2-devel] [PATCH v4 6/8] EmulatorPkg: Add
> VariableFlashInfoLib
> 
> Hi EmulatorPkg maintainers,
> 
> This is the only package in the series that has not given a review yet.
> Can you please help review it?
> 
> Thanks,
> Michael
> 
> On 4/12/2022 12:29 PM, Michael Kubacki wrote:
> > From: Michael Kubacki <michael.kubacki@microsoft.com>
> >
> >
> REF:INVALID URI REMOVED.
> cgi?id=3479__;!!NpxR!3XNUZ5NC9M4mSbD7tIR6y_88TLasCu1rZ5-dyKIh2qyl-
> RQ7xt-gSz5UZ-tm4Zs$
> >
> > Adds an instance of VariableFlashInfoLib to the platform build as
> > it is a new library class introduced in MdeModulePkg.
> >
> > Cc: Andrew Fish <afish@apple.com>
> > Cc: Ray Ni <ray.ni@intel.com>
> > Cc: Abner Chang <abner.chang@hpe.com>
> > Cc: Nickle Wang <nickle.wang@hpe.com>
> > Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
> > ---
> >   EmulatorPkg/EmulatorPkg.dsc | 1 +
> >   1 file changed, 1 insertion(+)
> >
> > diff --git a/EmulatorPkg/EmulatorPkg.dsc b/EmulatorPkg/EmulatorPkg.dsc
> > index 554c13ddb500..4cf886b9eac7 100644
> > --- a/EmulatorPkg/EmulatorPkg.dsc
> > +++ b/EmulatorPkg/EmulatorPkg.dsc
> > @@ -122,6 +122,7 @@ [LibraryClasses]
> >     VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
> >
> VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLi
> bRuntimeDxe.inf
> >
> VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/Va
> riablePolicyHelperLib.inf
> > +
> VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/Base
> VariableFlashInfoLib.inf
> >     SortLib|MdeModulePkg/Library/BaseSortLib/BaseSortLib.inf
> >     ShellLib|ShellPkg/Library/UefiShellLib/UefiShellLib.inf
> >     FileHandleLib|MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.inf
> 
> 
> 
> 


^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [edk2-devel] [PATCH v4 2/8] MdeModulePkg/VariableFlashInfoLib: Add initial library
  2022-04-12 16:29 ` [PATCH v4 2/8] MdeModulePkg/VariableFlashInfoLib: Add initial library Michael Kubacki
@ 2022-04-25 16:05   ` Sami Mujawar
  2022-04-25 22:21     ` Michael Kubacki
  0 siblings, 1 reply; 20+ messages in thread
From: Sami Mujawar @ 2022-04-25 16:05 UTC (permalink / raw)
  To: devel, mikuback; +Cc: Jian J Wang, Hao A Wu, Liming Gao, nd

Hi Michael,

I have a minor suggestion marked inline as [SAMI].

Otherwise this patch looks good to me.

Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>

Regards,

Sami Mujawar

On 12/04/2022 05:29 pm, Michael Kubacki via groups.io wrote:
> From: Michael Kubacki <michael.kubacki@microsoft.com>
>
> REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3479
>
> Adds a new library class VariableFlashInfoLib that abstracts access
> to variable flash information. The instance provided first attempts
> to retrieve information from the Variable Flash Info HOB. If that
> HOB is not present, it falls back to the PCDs defined in
> MdeModulePkg.
>
> This fall back behavior provides backward compatibility for platforms
> that only provide PCDs but also allows platforms that need to
> dynamically provide the information using the Variable Flash Info HOB
> to do so at runtime.
>
> 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>
> ---
>   MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.c   | 178 ++++++++++++++++++++
>   MdeModulePkg/Include/Library/VariableFlashInfoLib.h                        |  68 ++++++++
>   MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf |  48 ++++++
>   MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.uni |  12 ++
>   MdeModulePkg/MdeModulePkg.dec                                              |   4 +
>   MdeModulePkg/MdeModulePkg.dsc                                              |   2 +
>   6 files changed, 312 insertions(+)
>
> diff --git a/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.c b/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.c
> new file mode 100644
> index 000000000000..a1db97bdf218
> --- /dev/null
> +++ b/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.c
> @@ -0,0 +1,178 @@
> +/** @file
> +  Variable Flash Information Library
> +
> +  Copyright (c) Microsoft Corporation<BR>
> +
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
> +
> +**/
> +
> +#include <Uefi.h>
> +#include <Pi/PiMultiPhase.h>
> +#include <Guid/VariableFlashInfo.h>
> +#include <Library/DebugLib.h>
> +#include <Library/HobLib.h>
> +#include <Library/VariableFlashInfoLib.h>
> +
> +/**
> +  Get the HOB that contains variable flash information.
> +
> +  @param[out] VariableFlashInfo   Pointer to a pointer to set to the variable flash information structure.
> +
> +  @retval EFI_SUCCESS             Variable flash information was found successfully.
> +  @retval EFI_INVALID_PARAMETER   The VariableFlashInfo pointer given is NULL.
> +  @retval EFI_NOT_FOUND           Variable flash information could not be found.
> +
> +**/
> +EFI_STATUS
> +GetVariableFlashInfoFromHob (
> +  OUT VARIABLE_FLASH_INFO  **VariableFlashInfo
> +  )
[SAMI] Can this function be made STATIC, please?
> +{
> +  EFI_HOB_GUID_TYPE  *GuidHob;
> +
> +  if (VariableFlashInfo == NULL) {
> +    return EFI_INVALID_PARAMETER;
> +  }
> +
> +  GuidHob = GetFirstGuidHob (&gVariableFlashInfoHobGuid);
> +  if (GuidHob == NULL) {
> +    return EFI_NOT_FOUND;
> +  }
> +
> +  *VariableFlashInfo = GET_GUID_HOB_DATA (GuidHob);
> +
> +  //
> +  // Assert if more than one variable flash information HOB is present.
> +  //
> +  DEBUG_CODE (
> +    if ((GetNextGuidHob (&gVariableFlashInfoHobGuid, GET_NEXT_HOB (GuidHob)) != NULL)) {
> +    DEBUG ((DEBUG_ERROR, "ERROR: Found two variable flash information HOBs\n"));
> +    ASSERT (FALSE);
> +  }
> +
> +    );
> +
> +  return EFI_SUCCESS;
> +}
> +
> +/**
> +  Get the base address and size for the NV storage area used for UEFI variable storage.
> +
> +  @param[out] BaseAddress    The NV storage base address.
> +  @param[out] Length         The NV storage length in bytes.
> +
> +  @retval EFI_SUCCESS             NV storage information was found successfully.
> +  @retval EFI_INVALID_PARAMETER   A required pointer parameter is NULL.
> +
> +**/
> +EFI_STATUS
> +EFIAPI
> +GetVariableFlashNvStorageInfo (
> +  OUT EFI_PHYSICAL_ADDRESS  *BaseAddress,
> +  OUT UINT64                *Length
> +  )
> +{
> +  EFI_STATUS           Status;
> +  VARIABLE_FLASH_INFO  *VariableFlashInfo;
> +
> +  if ((BaseAddress == NULL) || (Length == NULL)) {
> +    return EFI_INVALID_PARAMETER;
> +  }
> +
> +  Status = GetVariableFlashInfoFromHob (&VariableFlashInfo);
> +  if (!EFI_ERROR (Status)) {
> +    *BaseAddress = VariableFlashInfo->NvVariableBaseAddress;
> +    *Length      = VariableFlashInfo->NvVariableLength;
> +  } else {
> +    *BaseAddress = (EFI_PHYSICAL_ADDRESS)(PcdGet64 (PcdFlashNvStorageVariableBase64) != 0 ?
> +                                          PcdGet64 (PcdFlashNvStorageVariableBase64) :
> +                                          PcdGet32 (PcdFlashNvStorageVariableBase)
> +                                          );
> +    *Length = (UINT64)PcdGet32 (PcdFlashNvStorageVariableSize);
> +  }
> +
> +  return EFI_SUCCESS;
> +}
> +
> +/**
> +  Get the base address and size for the fault tolerant write (FTW) spare
> +  area used for UEFI variable storage.
> +
> +  @param[out] BaseAddress    The FTW spare base address.
> +  @param[out] Length         The FTW spare length in bytes.
> +
> +  @retval EFI_SUCCESS             FTW spare information was found successfully.
> +  @retval EFI_INVALID_PARAMETER   A required pointer parameter is NULL.
> +  @retval EFI_NOT_FOUND           FTW spare information could not be found.
> +
> +**/
> +EFI_STATUS
> +EFIAPI
> +GetVariableFlashFtwSpareInfo (
> +  OUT EFI_PHYSICAL_ADDRESS  *BaseAddress,
> +  OUT UINT64                *Length
> +  )
> +{
> +  EFI_STATUS           Status;
> +  VARIABLE_FLASH_INFO  *VariableFlashInfo;
> +
> +  if ((BaseAddress == NULL) || (Length == NULL)) {
> +    return EFI_INVALID_PARAMETER;
> +  }
> +
> +  Status = GetVariableFlashInfoFromHob (&VariableFlashInfo);
> +  if (!EFI_ERROR (Status)) {
> +    *BaseAddress = VariableFlashInfo->FtwSpareBaseAddress;
> +    *Length      = VariableFlashInfo->FtwSpareLength;
> +  } else {
> +    *BaseAddress = (EFI_PHYSICAL_ADDRESS)(PcdGet64 (PcdFlashNvStorageFtwSpareBase64) != 0 ?
> +                                          PcdGet64 (PcdFlashNvStorageFtwSpareBase64) :
> +                                          PcdGet32 (PcdFlashNvStorageFtwSpareBase)
> +                                          );
> +    *Length = (UINT64)PcdGet32 (PcdFlashNvStorageFtwSpareSize);
> +  }
> +
> +  return EFI_SUCCESS;
> +}
> +
> +/**
> +  Get the base address and size for the fault tolerant write (FTW) working
> +  area used for UEFI variable storage.
> +
> +  @param[out] BaseAddress    The FTW working area base address.
> +  @param[out] Length         The FTW working area length in bytes.
> +
> +  @retval EFI_SUCCESS             FTW working information was found successfully.
> +  @retval EFI_INVALID_PARAMETER   A required pointer parameter is NULL.
> +  @retval EFI_NOT_FOUND           FTW working information could not be found.
> +
> +**/
> +EFI_STATUS
> +EFIAPI
> +GetVariableFlashFtwWorkingInfo (
> +  OUT EFI_PHYSICAL_ADDRESS  *BaseAddress,
> +  OUT UINT64                *Length
> +  )
> +{
> +  EFI_STATUS           Status;
> +  VARIABLE_FLASH_INFO  *VariableFlashInfo;
> +
> +  if ((BaseAddress == NULL) || (Length == NULL)) {
> +    return EFI_INVALID_PARAMETER;
> +  }
> +
> +  Status = GetVariableFlashInfoFromHob (&VariableFlashInfo);
> +  if (!EFI_ERROR (Status)) {
> +    *BaseAddress = VariableFlashInfo->FtwWorkingBaseAddress;
> +    *Length      = VariableFlashInfo->FtwWorkingLength;
> +  } else {
> +    *BaseAddress = (EFI_PHYSICAL_ADDRESS)(PcdGet64 (PcdFlashNvStorageFtwWorkingBase64) != 0 ?
> +                                          PcdGet64 (PcdFlashNvStorageFtwWorkingBase64) :
> +                                          PcdGet32 (PcdFlashNvStorageFtwWorkingBase)
> +                                          );
> +    *Length = (UINT64)PcdGet32 (PcdFlashNvStorageFtwWorkingSize);
> +  }
> +
> +  return EFI_SUCCESS;
> +}
> diff --git a/MdeModulePkg/Include/Library/VariableFlashInfoLib.h b/MdeModulePkg/Include/Library/VariableFlashInfoLib.h
> new file mode 100644
> index 000000000000..1367be9376ea
> --- /dev/null
> +++ b/MdeModulePkg/Include/Library/VariableFlashInfoLib.h
> @@ -0,0 +1,68 @@
> +/** @file
> +  Variable Flash Information Library
> +
> +Copyright (c) Microsoft Corporation<BR>
> +SPDX-License-Identifier: BSD-2-Clause-Patent
> +
> +**/
> +
> +#ifndef VARIABLE_FLASH_INFO_LIB_H_
> +#define VARIABLE_FLASH_INFO_LIB_H_
> +
> +/**
> +  Get the base address and size for the NV storage area used for UEFI variable storage.
> +
> +  @param[out] BaseAddress    The NV storage base address.
> +  @param[out] Length         The NV storage length in bytes.
> +
> +  @retval EFI_SUCCESS             NV storage information was found successfully.
> +  @retval EFI_INVALID_PARAMETER   A required pointer parameter is NULL.
> +  @retval EFI_NOT_FOUND           NV storage information could not be found.
> +
> +**/
> +EFI_STATUS
> +EFIAPI
> +GetVariableFlashNvStorageInfo (
> +  OUT EFI_PHYSICAL_ADDRESS  *BaseAddress,
> +  OUT UINT64                *Length
> +  );
> +
> +/**
> +  Get the base address and size for the fault tolerant write (FTW) spare
> +  area used for UEFI variable storage.
> +
> +  @param[out] BaseAddress    The FTW spare base address.
> +  @param[out] Length         The FTW spare length in bytes.
> +
> +  @retval EFI_SUCCESS             FTW spare information was found successfully.
> +  @retval EFI_INVALID_PARAMETER   A required pointer parameter is NULL.
> +  @retval EFI_NOT_FOUND           FTW spare information could not be found.
> +
> +**/
> +EFI_STATUS
> +EFIAPI
> +GetVariableFlashFtwSpareInfo (
> +  OUT EFI_PHYSICAL_ADDRESS  *BaseAddress,
> +  OUT UINT64                *Length
> +  );
> +
> +/**
> +  Get the base address and size for the fault tolerant write (FTW) working
> +  area used for UEFI variable storage.
> +
> +  @param[out] BaseAddress    The FTW working area base address.
> +  @param[out] Length         The FTW working area length in bytes.
> +
> +  @retval EFI_SUCCESS             FTW working information was found successfully.
> +  @retval EFI_INVALID_PARAMETER   A required pointer parameter is NULL.
> +  @retval EFI_NOT_FOUND           FTW working information could not be found.
> +
> +**/
> +EFI_STATUS
> +EFIAPI
> +GetVariableFlashFtwWorkingInfo (
> +  OUT EFI_PHYSICAL_ADDRESS  *BaseAddress,
> +  OUT UINT64                *Length
> +  );
> +
> +#endif
> diff --git a/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf b/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
> new file mode 100644
> index 000000000000..70175e75f9b1
> --- /dev/null
> +++ b/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
> @@ -0,0 +1,48 @@
> +## @file
> +#  Variable Flash Information Library
> +#
> +#  Provides services to access UEFI variable flash information.
> +#
> +#  Copyright (c) Microsoft Corporation<BR>
> +#  SPDX-License-Identifier: BSD-2-Clause-Patent
> +##
> +
> +[Defines]
> +  INF_VERSION       = 0x00010005
> +  BASE_NAME         = BaseVariableFlashInfoLib
> +  MODULE_UNI_FILE   = BaseVariableFlashInfoLib.uni
> +  FILE_GUID         = DEC426C9-C92E-4BAD-8E93-3F61C261118B
> +  MODULE_TYPE       = BASE
> +  VERSION_STRING    = 1.0
> +  LIBRARY_CLASS     = VariableFlashInfoLib
> +
> +#
> +# The following information is for reference only and not required by the build tools.
> +#
> +#  VALID_ARCHITECTURES           = ANY
> +#
> +
> +[Sources]
> +  BaseVariableFlashInfoLib.c
> +
> +[Packages]
> +  MdePkg/MdePkg.dec
> +  MdeModulePkg/MdeModulePkg.dec
> +
> +[LibraryClasses]
> +  DebugLib
> +  HobLib
> +
> +[Guids]
> +  gVariableFlashInfoHobGuid     ## CONSUMES     ## HOB
> +
> +[Pcd]
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase      ## SOMETIMES_CONSUMES
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase64    ## SOMETIMES_CONSUMES
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize      ## SOMETIMES_CONSUMES
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase      ## SOMETIMES_CONSUMES
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase64    ## SOMETIMES_CONSUMES
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize      ## SOMETIMES_CONSUMES
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase    ## SOMETIMES_CONSUMES
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase64  ## SOMETIMES_CONSUMES
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize    ## SOMETIMES_CONSUMES
> diff --git a/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.uni b/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.uni
> new file mode 100644
> index 000000000000..9a5348fa02a0
> --- /dev/null
> +++ b/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.uni
> @@ -0,0 +1,12 @@
> +// /** @file
> +// Variable Flash Information Library
> +//
> +// Copyright (c) Microsoft Corporation<BR>
> +//
> +// SPDX-License-Identifier: BSD-2-Clause-Patent
> +//
> +// **/
> +
> +#string STR_MODULE_ABSTRACT     #language en-US "UEFI variable flash information library"
> +
> +#string STR_MODULE_DESCRIPTION  #language en-US "Provides services to access UEFI variable flash information."
> diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec
> index 4e82f5836096..2bcb9f9453af 100644
> --- a/MdeModulePkg/MdeModulePkg.dec
> +++ b/MdeModulePkg/MdeModulePkg.dec
> @@ -154,6 +154,10 @@ [LibraryClasses]
>     #
>     VariablePolicyHelperLib|Include/Library/VariablePolicyHelperLib.h
>   
> +  ##  @libraryclass  Provides services to access UEFI variable flash information.
> +  #
> +  VariableFlashInfoLib|Include/Library/VariableFlashInfoLib.h
> +
>   [Guids]
>     ## MdeModule package token space guid
>     # Include/Guid/MdeModulePkgTokenSpace.h
> diff --git a/MdeModulePkg/MdeModulePkg.dsc b/MdeModulePkg/MdeModulePkg.dsc
> index b1d83461865e..90a0a7ec4a7c 100644
> --- a/MdeModulePkg/MdeModulePkg.dsc
> +++ b/MdeModulePkg/MdeModulePkg.dsc
> @@ -103,6 +103,7 @@ [LibraryClasses]
>     DisplayUpdateProgressLib|MdeModulePkg/Library/DisplayUpdateProgressLibGraphics/DisplayUpdateProgressLibGraphics.inf
>     VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
>     MmUnblockMemoryLib|MdePkg/Library/MmUnblockMemoryLib/MmUnblockMemoryLibNull.inf
> +  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
>   
>   [LibraryClasses.EBC.PEIM]
>     IoLib|MdePkg/Library/PeiIoLibCpuIo/PeiIoLibCpuIo.inf
> @@ -440,6 +441,7 @@ [Components]
>     MdeModulePkg/Library/FmpAuthenticationLibNull/FmpAuthenticationLibNull.inf
>     MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.inf
>     MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.inf
> +  MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
>   
>   [Components.IA32, Components.X64, Components.AARCH64]
>     MdeModulePkg/Universal/EbcDxe/EbcDxe.inf

^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [edk2-devel] [PATCH v4 1/8] MdeModulePkg: Add Variable Flash Info HOB
  2022-04-12 16:29 ` [PATCH v4 1/8] MdeModulePkg: " Michael Kubacki
@ 2022-04-25 16:05   ` Sami Mujawar
  0 siblings, 0 replies; 20+ messages in thread
From: Sami Mujawar @ 2022-04-25 16:05 UTC (permalink / raw)
  To: devel, mikuback; +Cc: Jian J Wang, Hao A Wu, Liming Gao, nd

Hi Michael,

Thank you for this patch.

These changes look good to me.

Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>

Regards,

Sami Mujawar

On 12/04/2022 05:29 pm, Michael Kubacki via groups.io wrote:
> From: Michael Kubacki <michael.kubacki@microsoft.com>
>
> REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3479
>
> Adds a new GUID that is used to identify a HOB that passes variable
> flash information to UEFI variable drivers in HOB consumption phases
> such as DXE, Traditional MM, and Standalone MM.
>
> This information was previously passed directly with PCDs such
> as EfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase
> and gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize.
>
> However, the Standalone MM variable driver instance does not have
> direct access to the PCD database. Therefore, this HOB will first
> be considered as the source for variable flash information and
> if platforms do not produce the HOB, reading the information from
> the PCDs directly will be a backup to provide backward
> compatibility.
>
> 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>
> ---
>   MdeModulePkg/Include/Guid/VariableFlashInfo.h | 111 ++++++++++++++++++++
>   MdeModulePkg/MdeModulePkg.dec                 |   4 +
>   2 files changed, 115 insertions(+)
>
> diff --git a/MdeModulePkg/Include/Guid/VariableFlashInfo.h b/MdeModulePkg/Include/Guid/VariableFlashInfo.h
> new file mode 100644
> index 000000000000..992a0dcdd384
> --- /dev/null
> +++ b/MdeModulePkg/Include/Guid/VariableFlashInfo.h
> @@ -0,0 +1,111 @@
> +/** @file
> +  This file defines the GUID and data structure used to pass information about
> +  a variable store mapped on flash (i.e. a MMIO firmware volume) to the modules
> +  that consume that information such as the DXE and MM UEFI variable drivers.
> +
> +  The HOB described in this file is currently optional. It is primarily provided
> +  to allow a platform to dynamically describe the flash information to environments
> +  such as Standalone MM that cannot access the prior method using dynamic PCDs.
> +
> +  Even for platforms that use Standalone MM, if the information is only stored
> +  statically such as with FixedAtBuild PCDs, the HOB is not required.
> +
> +  Every point of consumption in this package that uses the PCDs will first check
> +  for the HOB and use its value if present.
> +
> +  Early modules such as the PEI UEFI variable driver might also consume this
> +  information. For modules such as these, that execute early in the boot flow,
> +  at least two approaches are possible depending on platform design.
> +
> +  1. If the information in the HOB exactly matches the information in the PCDs,
> +     (i.e. the HOB values are set using the PCD values), let the driver read
> +     the information from the PCD and produce the HOB later in boot.
> +
> +  2. Produce the HOB very early in boot. For example, the earliest point the HOB
> +     is currently consumed is in FaultTolerantWritePei. Note that FaultTolerantWritePei
> +     produces gEdkiiFaultTolerantWriteGuid which is a dependency for VariablePei.
> +
> +     Therefore, attaching a NULL class library to FaultTolerantWritePei with a
> +     constructor that produces the HOB will guarantee it is produced before the first
> +     point of consumption as the constructor is executed before the module entry point.
> +
> +  Copyright (c) Microsoft Corporation.<BR>
> +
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
> +
> +**/
> +
> +#ifndef VARIABLE_FLASH_INFO_H_
> +#define VARIABLE_FLASH_INFO_H_
> +
> +#define VARIABLE_FLASH_INFO_HOB_GUID \
> +  { 0x5d11c653, 0x8154, 0x4ac3, { 0xa8, 0xc2, 0xfb, 0xa2, 0x89, 0x20, 0xfc, 0x90 }}
> +
> +#define VARIABLE_FLASH_INFO_HOB_VERSION  1
> +
> +extern EFI_GUID  gVariableFlashInfoHobGuid;
> +
> +#pragma pack (push, 1)
> +
> +///
> +/// This structure can be used to describe UEFI variable
> +/// flash information.
> +///
> +typedef struct {
> +  ///
> +  /// Version of this structure.
> +  ///
> +  /// Increment the value when the structure is modified.
> +  ///
> +  UINT32                  Version;
> +  ///
> +  /// Reserved field.
> +  ///
> +  /// Currently reserved for natural alignment.
> +  ///
> +  UINT32                  Reserved;
> +  ///
> +  /// Base address of the non-volatile variable range in the flash device.
> +  ///
> +  /// Note that this address should align with the block size requirements of the flash device.
> +  ///
> +  EFI_PHYSICAL_ADDRESS    NvVariableBaseAddress;
> +  ///
> +  /// Size of the non-volatile variable range in the flash device.
> +  ///
> +  /// Note that this value should be less than or equal to FtwSpareLength to support reclaim of
> +  /// entire variable store area.
> +  /// Note that this address should align with the block size requirements of the flash device.
> +  ///
> +  UINT64                  NvVariableLength;
> +  ///
> +  /// Base address of the FTW spare block range in the flash device.
> +  ///
> +  /// Note that this address should align with the block size requirements of the flash device.
> +  ///
> +  EFI_PHYSICAL_ADDRESS    FtwSpareBaseAddress;
> +  ///
> +  /// Size of the FTW spare block range in the flash device.
> +  ///
> +  /// Note that this value should be greater than or equal to NvVariableLength.
> +  /// Note that this address should align with the block size requirements of the flash device.
> +  ///
> +  UINT64                  FtwSpareLength;
> +  ///
> +  /// Base address of the FTW working block range in the flash device.
> +  ///
> +  /// Note that if FtwWorkingLength is larger than on block size, this value should be block size aligned.
> +  ///
> +  EFI_PHYSICAL_ADDRESS    FtwWorkingBaseAddress;
> +  ///
> +  /// Size of the FTW working block range in the flash device.
> +  ///
> +  /// Note that if the value is less than on block size, the range should not span blocks.
> +  /// Note that if the value is larger than one block size, this value should be block size aligned.
> +  ///
> +  UINT64                  FtwWorkingLength;
> +} VARIABLE_FLASH_INFO;
> +
> +#pragma pack (pop)
> +
> +#endif
> diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec
> index cf79292ec877..4e82f5836096 100644
> --- a/MdeModulePkg/MdeModulePkg.dec
> +++ b/MdeModulePkg/MdeModulePkg.dec
> @@ -226,6 +226,10 @@ [Guids]
>     #  Include/Guid/SmmVariableCommon.h
>     gSmmVariableWriteGuid  = { 0x93ba1826, 0xdffb, 0x45dd, { 0x82, 0xa7, 0xe7, 0xdc, 0xaa, 0x3b, 0xbd, 0xf3 }}
>   
> +  ## Guid of the variable flash information HOB.
> +  #  Include/Guid/VariableFlashInfo.h
> +  gVariableFlashInfoHobGuid = { 0x5d11c653, 0x8154, 0x4ac3, { 0xa8, 0xc2, 0xfb, 0xa2, 0x89, 0x20, 0xfc, 0x90 }}
> +
>     ## Performance protocol guid that also acts as the performance HOB guid and performance variable GUID
>     #  Include/Guid/Performance.h
>     gPerformanceProtocolGuid       = { 0x76B6BDFA, 0x2ACD, 0x4462, { 0x9E, 0x3F, 0xCB, 0x58, 0xC9, 0x69, 0xD9, 0x37 } }

^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [edk2-devel] [PATCH v4 3/8] MdeModulePkg/Variable: Consume Variable Flash Info
  2022-04-12 16:29 ` [PATCH v4 3/8] MdeModulePkg/Variable: Consume Variable Flash Info Michael Kubacki
@ 2022-04-25 16:05   ` Sami Mujawar
  0 siblings, 0 replies; 20+ messages in thread
From: Sami Mujawar @ 2022-04-25 16:05 UTC (permalink / raw)
  To: devel, mikuback; +Cc: Jian J Wang, Hao A Wu, Liming Gao, nd

Hi Michael,

Thank you for this patch.

These changes look good to me.

Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>

Regards,

Sami Mujawar

On 12/04/2022 05:29 pm, Michael Kubacki via groups.io wrote:
> From: Michael Kubacki <michael.kubacki@microsoft.com>
>
> 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.
>
> 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>
> ---
>   MdeModulePkg/Universal/Variable/Pei/Variable.c                      | 14 +++++++++-----
>   MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c            | 16 ++++++++++++----
>   MdeModulePkg/Universal/Variable/RuntimeDxe/VariableNonVolatile.c    | 14 ++++++++++----
>   MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c            | 17 +++++++++++++----
>   MdeModulePkg/Universal/Variable/Pei/Variable.h                      |  2 ++
>   MdeModulePkg/Universal/Variable/Pei/VariablePei.inf                 |  5 ++---
>   MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h               |  7 ++-----
>   MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf   |  5 ++---
>   MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf          |  5 ++---
>   MdeModulePkg/Universal/Variable/RuntimeDxe/VariableStandaloneMm.inf |  5 ++---
>   10 files changed, 56 insertions(+), 34 deletions(-)
>
> diff --git a/MdeModulePkg/Universal/Variable/Pei/Variable.c b/MdeModulePkg/Universal/Variable/Pei/Variable.c
> index b36dd0de67b2..26a4c73b45a5 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/RuntimeDxe/VariableDxe.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
> index 03fec3048dc4..d5c409c914d1 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 5e9d40b67ac2..9e2d8fe0fe0c 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/VariableSmm.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c
> index 517cae7b00f8..5253c328dcd9 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/Pei/Variable.h b/MdeModulePkg/Universal/Variable/Pei/Variable.h
> index 7f9ad5bfc357..51effbf79987 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 7cbdd2385e8f..7264a24bdf71 100644
> --- a/MdeModulePkg/Universal/Variable/Pei/VariablePei.inf
> +++ b/MdeModulePkg/Universal/Variable/Pei/VariablePei.inf
> @@ -39,6 +39,8 @@ [LibraryClasses]
>     DebugLib
>     PeiServicesTablePointerLib
>     PeiServicesLib
> +  SafeIntLib
> +  VariableFlashInfoLib
>   
>   [Guids]
>     ## CONSUMES             ## GUID # Variable store header
> @@ -59,9 +61,6 @@ [Ppis]
>     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 31e408976a35..a668abb82b15 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/VariableRuntimeDxe.inf b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
> index c9434df631ee..3858adf6739d 100644
> --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
> +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
> @@ -71,8 +71,10 @@ [LibraryClasses]
>     TpmMeasurementLib
>     AuthVariableLib
>     VarCheckLib
> +  VariableFlashInfoLib
>     VariablePolicyLib
>     VariablePolicyHelperLib
> +  SafeIntLib
>   
>   [Protocols]
>     gEfiFirmwareVolumeBlockProtocolGuid           ## CONSUMES
> @@ -125,9 +127,6 @@ [Guids]
>     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.inf b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf
> index eaa97a01c6e5..8c552b87e080 100644
> --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf
> +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf
> @@ -80,8 +80,10 @@ [LibraryClasses]
>     AuthVariableLib
>     VarCheckLib
>     UefiBootServicesTableLib
> +  VariableFlashInfoLib
>     VariablePolicyLib
>     VariablePolicyHelperLib
> +  SafeIntLib
>   
>   [Protocols]
>     gEfiSmmFirmwareVolumeBlockProtocolGuid        ## CONSUMES
> @@ -127,9 +129,6 @@ [Guids]
>     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 d8c4f77e7f1f..f09bed40cf51 100644
> --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableStandaloneMm.inf
> +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableStandaloneMm.inf
> @@ -73,9 +73,11 @@ [LibraryClasses]
>     HobLib
>     MemoryAllocationLib
>     MmServicesTableLib
> +  SafeIntLib
>     StandaloneMmDriverEntryPoint
>     SynchronizationLib
>     VarCheckLib
> +  VariableFlashInfoLib
>     VariablePolicyLib
>     VariablePolicyHelperLib
>   
> @@ -120,9 +122,6 @@ [Guids]
>     gEdkiiVarErrorFlagGuid
>   
>   [Pcd]
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase       ## SOMETIMES_CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase64     ## CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize       ## CONSUMES
>     gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize                  ## CONSUMES
>     gEfiMdeModulePkgTokenSpaceGuid.PcdMaxAuthVariableSize              ## CONSUMES
>     gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVolatileVariableSize          ## CONSUMES

^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [edk2-devel] [PATCH v4 4/8] MdeModulePkg/FaultTolerantWrite: Consume Variable Flash Info
  2022-04-12 16:29 ` [PATCH v4 4/8] MdeModulePkg/FaultTolerantWrite: " Michael Kubacki
@ 2022-04-25 16:05   ` Sami Mujawar
  0 siblings, 0 replies; 20+ messages in thread
From: Sami Mujawar @ 2022-04-25 16:05 UTC (permalink / raw)
  To: devel, mikuback; +Cc: Jian J Wang, Hao A Wu, Liming Gao, nd

Hi Michael,

Thank you for this patch.

These changes look good to me.

Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>

Regards,

Sami Mujawar

On 12/04/2022 05:29 pm, Michael Kubacki via groups.io wrote:
> From: Michael Kubacki <michael.kubacki@microsoft.com>
>
> REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3479
>
> Adds support to the UEFI variable fault tolerant write (FTW) drivers
> to receive FTW base and size information dynamically via the Variable
> Flash Information library.
>
> 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>
> ---
>   MdeModulePkg/Universal/FaultTolerantWriteDxe/FtwMisc.c                          | 41 +++++++++++++-------
>   MdeModulePkg/Universal/FaultTolerantWriteDxe/UpdateWorkingBlock.c               |  7 +++-
>   MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.c            | 28 ++++++++-----
>   MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.h               |  7 +++-
>   MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf          | 10 +----
>   MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.inf          | 10 +----
>   MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteStandaloneMm.inf | 10 +----
>   MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.inf          | 10 +----
>   8 files changed, 63 insertions(+), 60 deletions(-)
>
> diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FtwMisc.c b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FtwMisc.c
> index 661e1487673b..f1335870e797 100644
> --- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FtwMisc.c
> +++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FtwMisc.c
> @@ -987,22 +987,43 @@ InitFtwDevice (
>     OUT EFI_FTW_DEVICE  **FtwData
>     )
>   {
> -  EFI_FTW_DEVICE  *FtwDevice;
> +  EFI_STATUS            Status;
> +  EFI_PHYSICAL_ADDRESS  WorkSpaceAddress;
> +  UINT64                Size;
> +  UINTN                 FtwWorkingSize;
> +  EFI_FTW_DEVICE        *FtwDevice;
> +
> +  FtwWorkingSize = 0;
> +
> +  Status = GetVariableFlashFtwWorkingInfo (&WorkSpaceAddress, &Size);
> +  ASSERT_EFI_ERROR (Status);
> +
> +  Status = SafeUint64ToUintn (Size, &FtwWorkingSize);
> +  // This driver currently assumes the size will be UINTN so assert the value is safe for now.
> +  ASSERT_EFI_ERROR (Status);
>   
>     //
>     // Allocate private data of this driver,
>     // Including the FtwWorkSpace[FTW_WORK_SPACE_SIZE].
>     //
> -  FtwDevice = AllocateZeroPool (sizeof (EFI_FTW_DEVICE) + PcdGet32 (PcdFlashNvStorageFtwWorkingSize));
> +  FtwDevice = AllocateZeroPool (sizeof (EFI_FTW_DEVICE) + FtwWorkingSize);
>     if (FtwDevice == NULL) {
>       return EFI_OUT_OF_RESOURCES;
>     }
>   
> +  FtwDevice->WorkSpaceAddress = WorkSpaceAddress;
> +  FtwDevice->WorkSpaceLength  = FtwWorkingSize;
> +
> +  Status = GetVariableFlashFtwSpareInfo (&FtwDevice->SpareAreaAddress, &Size);
> +  ASSERT_EFI_ERROR (Status);
> +
> +  Status = SafeUint64ToUintn (Size, &FtwDevice->SpareAreaLength);
> +  // This driver currently assumes the size will be UINTN so assert the value is safe for now.
> +  ASSERT_EFI_ERROR (Status);
> +
>     //
>     // Initialize other parameters, and set WorkSpace as FTW_ERASED_BYTE.
>     //
> -  FtwDevice->WorkSpaceLength = (UINTN)PcdGet32 (PcdFlashNvStorageFtwWorkingSize);
> -  FtwDevice->SpareAreaLength = (UINTN)PcdGet32 (PcdFlashNvStorageFtwSpareSize);
>     if ((FtwDevice->WorkSpaceLength == 0) || (FtwDevice->SpareAreaLength == 0)) {
>       DEBUG ((DEBUG_ERROR, "Ftw: Workspace or Spare block does not exist!\n"));
>       FreePool (FtwDevice);
> @@ -1015,16 +1036,6 @@ InitFtwDevice (
>     FtwDevice->FtwWorkSpaceLba = (EFI_LBA)(-1);
>     FtwDevice->FtwSpareLba     = (EFI_LBA)(-1);
>   
> -  FtwDevice->WorkSpaceAddress = (EFI_PHYSICAL_ADDRESS)PcdGet64 (PcdFlashNvStorageFtwWorkingBase64);
> -  if (FtwDevice->WorkSpaceAddress == 0) {
> -    FtwDevice->WorkSpaceAddress = (EFI_PHYSICAL_ADDRESS)PcdGet32 (PcdFlashNvStorageFtwWorkingBase);
> -  }
> -
> -  FtwDevice->SpareAreaAddress = (EFI_PHYSICAL_ADDRESS)PcdGet64 (PcdFlashNvStorageFtwSpareBase64);
> -  if (FtwDevice->SpareAreaAddress == 0) {
> -    FtwDevice->SpareAreaAddress = (EFI_PHYSICAL_ADDRESS)PcdGet32 (PcdFlashNvStorageFtwSpareBase);
> -  }
> -
>     *FtwData = FtwDevice;
>     return EFI_SUCCESS;
>   }
> @@ -1277,7 +1288,7 @@ InitFtwProtocol (
>     FtwDevice->FtwLastWriteHeader = NULL;
>     FtwDevice->FtwLastWriteRecord = NULL;
>   
> -  InitializeLocalWorkSpaceHeader ();
> +  InitializeLocalWorkSpaceHeader (FtwDevice->WorkSpaceLength);
>   
>     //
>     // Refresh the working space data from working block
> diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/UpdateWorkingBlock.c b/MdeModulePkg/Universal/FaultTolerantWriteDxe/UpdateWorkingBlock.c
> index 61e7a92ccea1..fd563643eb63 100644
> --- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/UpdateWorkingBlock.c
> +++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/UpdateWorkingBlock.c
> @@ -16,10 +16,13 @@ EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER  mWorkingBlockHeader = { ZERO_GUID, 0, 0
>   
>     Since Signature and WriteQueueSize have been known, Crc can be calculated out,
>     then the work space header will be fixed.
> +
> +  @param[in]  WorkSpaceLength     Length in bytes of the FTW workspace area.
> +
>   **/
>   VOID
>   InitializeLocalWorkSpaceHeader (
> -  VOID
> +  IN  UINTN  WorkSpaceLength
>     )
>   {
>     //
> @@ -46,7 +49,7 @@ InitializeLocalWorkSpaceHeader (
>       &gEdkiiWorkingBlockSignatureGuid,
>       sizeof (EFI_GUID)
>       );
> -  mWorkingBlockHeader.WriteQueueSize = PcdGet32 (PcdFlashNvStorageFtwWorkingSize) - sizeof (EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER);
> +  mWorkingBlockHeader.WriteQueueSize = WorkSpaceLength - sizeof (EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER);
>   
>     //
>     // Crc is calculated with all the fields except Crc and STATE, so leave them as FTW_ERASED_BYTE.
> diff --git a/MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.c b/MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.c
> index 15543f12ed29..8c152dcbad98 100644
> --- a/MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.c
> +++ b/MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.c
> @@ -16,6 +16,8 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
>   #include <Library/DebugLib.h>
>   #include <Library/BaseMemoryLib.h>
>   #include <Library/HobLib.h>
> +#include <Library/SafeIntLib.h>
> +#include <Library/VariableFlashInfoLib.h>
>   
>   EFI_PEI_PPI_DESCRIPTOR  mPpiListVariable = {
>     (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
> @@ -212,25 +214,31 @@ PeimFaultTolerantWriteInitialize (
>     EFI_PHYSICAL_ADDRESS                     SpareAreaAddress;
>     UINTN                                    SpareAreaLength;
>     EFI_PHYSICAL_ADDRESS                     WorkSpaceInSpareArea;
> +  UINT64                                   Size;
>     FAULT_TOLERANT_WRITE_LAST_WRITE_DATA     FtwLastWrite;
>   
>     FtwWorkingBlockHeader = NULL;
>     FtwLastWriteHeader    = NULL;
>     FtwLastWriteRecord    = NULL;
>   
> -  WorkSpaceAddress = (EFI_PHYSICAL_ADDRESS)PcdGet64 (PcdFlashNvStorageFtwWorkingBase64);
> -  if (WorkSpaceAddress == 0) {
> -    WorkSpaceAddress = (EFI_PHYSICAL_ADDRESS)PcdGet32 (PcdFlashNvStorageFtwWorkingBase);
> -  }
> +  SpareAreaAddress = 0;
> +  SpareAreaLength  = 0;
> +  WorkSpaceAddress = 0;
> +  WorkSpaceLength  = 0;
>   
> -  WorkSpaceLength = (UINTN)PcdGet32 (PcdFlashNvStorageFtwWorkingSize);
> +  Status = GetVariableFlashFtwWorkingInfo (&WorkSpaceAddress, &Size);
> +  ASSERT_EFI_ERROR (Status);
>   
> -  SpareAreaAddress = (EFI_PHYSICAL_ADDRESS)PcdGet64 (PcdFlashNvStorageFtwSpareBase64);
> -  if (SpareAreaAddress == 0) {
> -    SpareAreaAddress = (EFI_PHYSICAL_ADDRESS)PcdGet32 (PcdFlashNvStorageFtwSpareBase);
> -  }
> +  Status = SafeUint64ToUintn (Size, &WorkSpaceLength);
> +  // This driver currently assumes the size will be UINTN so assert the value is safe for now.
> +  ASSERT_EFI_ERROR (Status);
>   
> -  SpareAreaLength = (UINTN)PcdGet32 (PcdFlashNvStorageFtwSpareSize);
> +  Status = GetVariableFlashFtwSpareInfo (&SpareAreaAddress, &Size);
> +  ASSERT_EFI_ERROR (Status);
> +
> +  Status = SafeUint64ToUintn (Size, &SpareAreaLength);
> +  // This driver currently assumes the size will be UINTN so assert the value is safe for now.
> +  ASSERT_EFI_ERROR (Status);
>   
>     //
>     // The address of FTW working base and spare base must not be 0.
> diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.h b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.h
> index c14e47b5c7b2..5b84d062c294 100644
> --- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.h
> +++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.h
> @@ -26,6 +26,8 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
>   #include <Library/BaseMemoryLib.h>
>   #include <Library/MemoryAllocationLib.h>
>   #include <Library/ReportStatusCodeLib.h>
> +#include <Library/SafeIntLib.h>
> +#include <Library/VariableFlashInfoLib.h>
>   
>   //
>   // Flash erase polarity is 1
> @@ -708,10 +710,13 @@ InitFtwProtocol (
>   
>     Since Signature and WriteQueueSize have been known, Crc can be calculated out,
>     then the work space header will be fixed.
> +
> +  @param[in]  WorkSpaceLength     Length in bytes of the FTW workspace area.
> +
>   **/
>   VOID
>   InitializeLocalWorkSpaceHeader (
> -  VOID
> +  IN  UINTN  WorkSpaceLength
>     );
>   
>   /**
> diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf
> index 96165614d178..d524e1849a2e 100644
> --- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf
> +++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf
> @@ -46,6 +46,8 @@ [LibraryClasses]
>     UefiLib
>     PcdLib
>     ReportStatusCodeLib
> +  SafeIntLib
> +  VariableFlashInfoLib
>   
>   [Guids]
>     #
> @@ -65,14 +67,6 @@ [Protocols]
>   [FeaturePcd]
>     gEfiMdeModulePkgTokenSpaceGuid.PcdFullFtwServiceEnable    ## CONSUMES
>   
> -[Pcd]
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase    ## SOMETIMES_CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase64  ## CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize    ## CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase      ## SOMETIMES_CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase64    ## CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize      ## CONSUMES
> -
>   #
>   # gBS->CalculateCrc32() is consumed in EntryPoint.
>   # PI spec said: When the DXE Foundation is notified that the EFI_RUNTIME_ARCH_PROTOCOL
> diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.inf b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.inf
> index 8cc6028470d8..8a4b9ad24657 100644
> --- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.inf
> +++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.inf
> @@ -52,6 +52,8 @@ [LibraryClasses]
>     ReportStatusCodeLib
>     SmmMemLib
>     BaseLib
> +  SafeIntLib
> +  VariableFlashInfoLib
>   
>   [Guids]
>     #
> @@ -74,14 +76,6 @@ [Protocols]
>   [FeaturePcd]
>     gEfiMdeModulePkgTokenSpaceGuid.PcdFullFtwServiceEnable    ## CONSUMES
>   
> -[Pcd]
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase    ## SOMETIMES_CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase64  ## CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize    ## CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase      ## SOMETIMES_CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase64    ## CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize      ## CONSUMES
> -
>   #
>   # gBS->CalculateCrc32() is consumed in EntryPoint.
>   # PI spec said: When the DXE Foundation is notified that the EFI_RUNTIME_ARCH_PROTOCOL
> diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteStandaloneMm.inf b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteStandaloneMm.inf
> index d0fab7d9414f..0ac6edf771ab 100644
> --- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteStandaloneMm.inf
> +++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteStandaloneMm.inf
> @@ -50,7 +50,9 @@ [LibraryClasses]
>     MmServicesTableLib
>     PcdLib
>     ReportStatusCodeLib
> +  SafeIntLib
>     StandaloneMmDriverEntryPoint
> +  VariableFlashInfoLib
>   
>   [Guids]
>     #
> @@ -73,13 +75,5 @@ [Protocols]
>   [FeaturePcd]
>     gEfiMdeModulePkgTokenSpaceGuid.PcdFullFtwServiceEnable    ## CONSUMES
>   
> -[Pcd]
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase    ## SOMETIMES_CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase64  ## CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize    ## CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase      ## SOMETIMES_CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase64    ## CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize      ## CONSUMES
> -
>   [Depex]
>     TRUE
> diff --git a/MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.inf b/MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.inf
> index f90892ad4493..230138272c3a 100644
> --- a/MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.inf
> +++ b/MdeModulePkg/Universal/FaultTolerantWritePei/FaultTolerantWritePei.inf
> @@ -39,6 +39,8 @@ [LibraryClasses]
>     HobLib
>     BaseMemoryLib
>     PcdLib
> +  SafeIntLib
> +  VariableFlashInfoLib
>   
>   [Guids]
>     ## SOMETIMES_PRODUCES   ## HOB
> @@ -47,14 +49,6 @@ [Guids]
>     gEdkiiWorkingBlockSignatureGuid               ## SOMETIMES_CONSUMES   ## GUID
>     gEfiSystemNvDataFvGuid                        ## SOMETIMES_CONSUMES   ## GUID
>   
> -[Pcd]
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase    ## SOMETIMES_CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase64  ## CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize    ## CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase      ## SOMETIMES_CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase64    ## CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize      ## CONSUMES
> -
>   [Depex]
>     TRUE
>   

^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [PATCH v4 5/8] ArmVirtPkg/ArmVirt.dsc.inc: Add VariableFlashInfoLib
  2022-04-12 16:29 ` [PATCH v4 5/8] ArmVirtPkg/ArmVirt.dsc.inc: Add VariableFlashInfoLib Michael Kubacki
@ 2022-04-25 16:06   ` Sami Mujawar
  0 siblings, 0 replies; 20+ messages in thread
From: Sami Mujawar @ 2022-04-25 16:06 UTC (permalink / raw)
  To: mikuback, devel
  Cc: Ard Biesheuvel, Leif Lindholm, Gerd Hoffmann, Julien Grall, nd

Hi Michael,

Thank you for this patch.

These changes look good to me.

Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>

Regards,

Sami Mujawar

On 12/04/2022 05:29 pm, mikuback@linux.microsoft.com wrote:
> From: Michael Kubacki <michael.kubacki@microsoft.com>
>
> REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3479
>
> Adds an instance of VariableFlashInfoLib to the platform build as
> it is a new library class introduced in MdeModulePkg.
>
> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
> Cc: Leif Lindholm <quic_llindhol@quicinc.com>
> Cc: Sami Mujawar <sami.mujawar@arm.com>
> Cc: Gerd Hoffmann <kraxel@redhat.com>
> Cc: Julien Grall <julien@xen.org>
> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
> ---
>   ArmVirtPkg/ArmVirt.dsc.inc | 1 +
>   1 file changed, 1 insertion(+)
>
> diff --git a/ArmVirtPkg/ArmVirt.dsc.inc b/ArmVirtPkg/ArmVirt.dsc.inc
> index ba711deac025..988c1eb75529 100644
> --- a/ArmVirtPkg/ArmVirt.dsc.inc
> +++ b/ArmVirtPkg/ArmVirt.dsc.inc
> @@ -177,6 +177,7 @@ [LibraryClasses.common]
>     AuthVariableLib|MdeModulePkg/Library/AuthVariableLibNull/AuthVariableLibNull.inf
>   !endif
>     VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
> +  VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf
>     VariablePolicyLib|MdeModulePkg/Library/VariablePolicyLib/VariablePolicyLib.inf
>     VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf
>     UefiBootManagerLib|MdeModulePkg/Library/UefiBootManagerLib/UefiBootManagerLib.inf

^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [edk2-devel] [PATCH v4 2/8] MdeModulePkg/VariableFlashInfoLib: Add initial library
  2022-04-25 16:05   ` [edk2-devel] " Sami Mujawar
@ 2022-04-25 22:21     ` Michael Kubacki
  0 siblings, 0 replies; 20+ messages in thread
From: Michael Kubacki @ 2022-04-25 22:21 UTC (permalink / raw)
  To: devel, sami.mujawar; +Cc: Jian J Wang, Hao A Wu, Liming Gao, nd

Thanks for your review. I will make that change.

Regards,
Michael

On 4/25/2022 12:05 PM, Sami Mujawar wrote:
> Hi Michael,
> 
> I have a minor suggestion marked inline as [SAMI].
> 
> Otherwise this patch looks good to me.
> 
> Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
> 
> Regards,
> 
> Sami Mujawar
> 
> On 12/04/2022 05:29 pm, Michael Kubacki via groups.io wrote:
>> From: Michael Kubacki <michael.kubacki@microsoft.com>
>>
>> REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3479
>>
>> Adds a new library class VariableFlashInfoLib that abstracts access
>> to variable flash information. The instance provided first attempts
>> to retrieve information from the Variable Flash Info HOB. If that
>> HOB is not present, it falls back to the PCDs defined in
>> MdeModulePkg.
>>
>> This fall back behavior provides backward compatibility for platforms
>> that only provide PCDs but also allows platforms that need to
>> dynamically provide the information using the Variable Flash Info HOB
>> to do so at runtime.
>>
>> 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>
>> ---
>>   
>> MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.c   
>> | 178 ++++++++++++++++++++
>>   
>> MdeModulePkg/Include/Library/VariableFlashInfoLib.h                        
>> |  68 ++++++++
>>   
>> MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf 
>> |  48 ++++++
>>   
>> MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.uni 
>> |  12 ++
>>   
>> MdeModulePkg/MdeModulePkg.dec                                              
>> |   4 +
>>   
>> MdeModulePkg/MdeModulePkg.dsc                                              
>> |   2 +
>>   6 files changed, 312 insertions(+)
>>
>> diff --git 
>> a/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.c 
>> b/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.c 
>>
>> new file mode 100644
>> index 000000000000..a1db97bdf218
>> --- /dev/null
>> +++ 
>> b/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.c 
>>
>> @@ -0,0 +1,178 @@
>> +/** @file
>> +  Variable Flash Information Library
>> +
>> +  Copyright (c) Microsoft Corporation<BR>
>> +
>> +  SPDX-License-Identifier: BSD-2-Clause-Patent
>> +
>> +**/
>> +
>> +#include <Uefi.h>
>> +#include <Pi/PiMultiPhase.h>
>> +#include <Guid/VariableFlashInfo.h>
>> +#include <Library/DebugLib.h>
>> +#include <Library/HobLib.h>
>> +#include <Library/VariableFlashInfoLib.h>
>> +
>> +/**
>> +  Get the HOB that contains variable flash information.
>> +
>> +  @param[out] VariableFlashInfo   Pointer to a pointer to set to the 
>> variable flash information structure.
>> +
>> +  @retval EFI_SUCCESS             Variable flash information was 
>> found successfully.
>> +  @retval EFI_INVALID_PARAMETER   The VariableFlashInfo pointer given 
>> is NULL.
>> +  @retval EFI_NOT_FOUND           Variable flash information could 
>> not be found.
>> +
>> +**/
>> +EFI_STATUS
>> +GetVariableFlashInfoFromHob (
>> +  OUT VARIABLE_FLASH_INFO  **VariableFlashInfo
>> +  )
> [SAMI] Can this function be made STATIC, please?
>> +{
>> +  EFI_HOB_GUID_TYPE  *GuidHob;
>> +
>> +  if (VariableFlashInfo == NULL) {
>> +    return EFI_INVALID_PARAMETER;
>> +  }
>> +
>> +  GuidHob = GetFirstGuidHob (&gVariableFlashInfoHobGuid);
>> +  if (GuidHob == NULL) {
>> +    return EFI_NOT_FOUND;
>> +  }
>> +
>> +  *VariableFlashInfo = GET_GUID_HOB_DATA (GuidHob);
>> +
>> +  //
>> +  // Assert if more than one variable flash information HOB is present.
>> +  //
>> +  DEBUG_CODE (
>> +    if ((GetNextGuidHob (&gVariableFlashInfoHobGuid, GET_NEXT_HOB 
>> (GuidHob)) != NULL)) {
>> +    DEBUG ((DEBUG_ERROR, "ERROR: Found two variable flash information 
>> HOBs\n"));
>> +    ASSERT (FALSE);
>> +  }
>> +
>> +    );
>> +
>> +  return EFI_SUCCESS;
>> +}
>> +
>> +/**
>> +  Get the base address and size for the NV storage area used for UEFI 
>> variable storage.
>> +
>> +  @param[out] BaseAddress    The NV storage base address.
>> +  @param[out] Length         The NV storage length in bytes.
>> +
>> +  @retval EFI_SUCCESS             NV storage information was found 
>> successfully.
>> +  @retval EFI_INVALID_PARAMETER   A required pointer parameter is NULL.
>> +
>> +**/
>> +EFI_STATUS
>> +EFIAPI
>> +GetVariableFlashNvStorageInfo (
>> +  OUT EFI_PHYSICAL_ADDRESS  *BaseAddress,
>> +  OUT UINT64                *Length
>> +  )
>> +{
>> +  EFI_STATUS           Status;
>> +  VARIABLE_FLASH_INFO  *VariableFlashInfo;
>> +
>> +  if ((BaseAddress == NULL) || (Length == NULL)) {
>> +    return EFI_INVALID_PARAMETER;
>> +  }
>> +
>> +  Status = GetVariableFlashInfoFromHob (&VariableFlashInfo);
>> +  if (!EFI_ERROR (Status)) {
>> +    *BaseAddress = VariableFlashInfo->NvVariableBaseAddress;
>> +    *Length      = VariableFlashInfo->NvVariableLength;
>> +  } else {
>> +    *BaseAddress = (EFI_PHYSICAL_ADDRESS)(PcdGet64 
>> (PcdFlashNvStorageVariableBase64) != 0 ?
>> +                                          PcdGet64 
>> (PcdFlashNvStorageVariableBase64) :
>> +                                          PcdGet32 
>> (PcdFlashNvStorageVariableBase)
>> +                                          );
>> +    *Length = (UINT64)PcdGet32 (PcdFlashNvStorageVariableSize);
>> +  }
>> +
>> +  return EFI_SUCCESS;
>> +}
>> +
>> +/**
>> +  Get the base address and size for the fault tolerant write (FTW) spare
>> +  area used for UEFI variable storage.
>> +
>> +  @param[out] BaseAddress    The FTW spare base address.
>> +  @param[out] Length         The FTW spare length in bytes.
>> +
>> +  @retval EFI_SUCCESS             FTW spare information was found 
>> successfully.
>> +  @retval EFI_INVALID_PARAMETER   A required pointer parameter is NULL.
>> +  @retval EFI_NOT_FOUND           FTW spare information could not be 
>> found.
>> +
>> +**/
>> +EFI_STATUS
>> +EFIAPI
>> +GetVariableFlashFtwSpareInfo (
>> +  OUT EFI_PHYSICAL_ADDRESS  *BaseAddress,
>> +  OUT UINT64                *Length
>> +  )
>> +{
>> +  EFI_STATUS           Status;
>> +  VARIABLE_FLASH_INFO  *VariableFlashInfo;
>> +
>> +  if ((BaseAddress == NULL) || (Length == NULL)) {
>> +    return EFI_INVALID_PARAMETER;
>> +  }
>> +
>> +  Status = GetVariableFlashInfoFromHob (&VariableFlashInfo);
>> +  if (!EFI_ERROR (Status)) {
>> +    *BaseAddress = VariableFlashInfo->FtwSpareBaseAddress;
>> +    *Length      = VariableFlashInfo->FtwSpareLength;
>> +  } else {
>> +    *BaseAddress = (EFI_PHYSICAL_ADDRESS)(PcdGet64 
>> (PcdFlashNvStorageFtwSpareBase64) != 0 ?
>> +                                          PcdGet64 
>> (PcdFlashNvStorageFtwSpareBase64) :
>> +                                          PcdGet32 
>> (PcdFlashNvStorageFtwSpareBase)
>> +                                          );
>> +    *Length = (UINT64)PcdGet32 (PcdFlashNvStorageFtwSpareSize);
>> +  }
>> +
>> +  return EFI_SUCCESS;
>> +}
>> +
>> +/**
>> +  Get the base address and size for the fault tolerant write (FTW) 
>> working
>> +  area used for UEFI variable storage.
>> +
>> +  @param[out] BaseAddress    The FTW working area base address.
>> +  @param[out] Length         The FTW working area length in bytes.
>> +
>> +  @retval EFI_SUCCESS             FTW working information was found 
>> successfully.
>> +  @retval EFI_INVALID_PARAMETER   A required pointer parameter is NULL.
>> +  @retval EFI_NOT_FOUND           FTW working information could not 
>> be found.
>> +
>> +**/
>> +EFI_STATUS
>> +EFIAPI
>> +GetVariableFlashFtwWorkingInfo (
>> +  OUT EFI_PHYSICAL_ADDRESS  *BaseAddress,
>> +  OUT UINT64                *Length
>> +  )
>> +{
>> +  EFI_STATUS           Status;
>> +  VARIABLE_FLASH_INFO  *VariableFlashInfo;
>> +
>> +  if ((BaseAddress == NULL) || (Length == NULL)) {
>> +    return EFI_INVALID_PARAMETER;
>> +  }
>> +
>> +  Status = GetVariableFlashInfoFromHob (&VariableFlashInfo);
>> +  if (!EFI_ERROR (Status)) {
>> +    *BaseAddress = VariableFlashInfo->FtwWorkingBaseAddress;
>> +    *Length      = VariableFlashInfo->FtwWorkingLength;
>> +  } else {
>> +    *BaseAddress = (EFI_PHYSICAL_ADDRESS)(PcdGet64 
>> (PcdFlashNvStorageFtwWorkingBase64) != 0 ?
>> +                                          PcdGet64 
>> (PcdFlashNvStorageFtwWorkingBase64) :
>> +                                          PcdGet32 
>> (PcdFlashNvStorageFtwWorkingBase)
>> +                                          );
>> +    *Length = (UINT64)PcdGet32 (PcdFlashNvStorageFtwWorkingSize);
>> +  }
>> +
>> +  return EFI_SUCCESS;
>> +}
>> diff --git a/MdeModulePkg/Include/Library/VariableFlashInfoLib.h 
>> b/MdeModulePkg/Include/Library/VariableFlashInfoLib.h
>> new file mode 100644
>> index 000000000000..1367be9376ea
>> --- /dev/null
>> +++ b/MdeModulePkg/Include/Library/VariableFlashInfoLib.h
>> @@ -0,0 +1,68 @@
>> +/** @file
>> +  Variable Flash Information Library
>> +
>> +Copyright (c) Microsoft Corporation<BR>
>> +SPDX-License-Identifier: BSD-2-Clause-Patent
>> +
>> +**/
>> +
>> +#ifndef VARIABLE_FLASH_INFO_LIB_H_
>> +#define VARIABLE_FLASH_INFO_LIB_H_
>> +
>> +/**
>> +  Get the base address and size for the NV storage area used for UEFI 
>> variable storage.
>> +
>> +  @param[out] BaseAddress    The NV storage base address.
>> +  @param[out] Length         The NV storage length in bytes.
>> +
>> +  @retval EFI_SUCCESS             NV storage information was found 
>> successfully.
>> +  @retval EFI_INVALID_PARAMETER   A required pointer parameter is NULL.
>> +  @retval EFI_NOT_FOUND           NV storage information could not be 
>> found.
>> +
>> +**/
>> +EFI_STATUS
>> +EFIAPI
>> +GetVariableFlashNvStorageInfo (
>> +  OUT EFI_PHYSICAL_ADDRESS  *BaseAddress,
>> +  OUT UINT64                *Length
>> +  );
>> +
>> +/**
>> +  Get the base address and size for the fault tolerant write (FTW) spare
>> +  area used for UEFI variable storage.
>> +
>> +  @param[out] BaseAddress    The FTW spare base address.
>> +  @param[out] Length         The FTW spare length in bytes.
>> +
>> +  @retval EFI_SUCCESS             FTW spare information was found 
>> successfully.
>> +  @retval EFI_INVALID_PARAMETER   A required pointer parameter is NULL.
>> +  @retval EFI_NOT_FOUND           FTW spare information could not be 
>> found.
>> +
>> +**/
>> +EFI_STATUS
>> +EFIAPI
>> +GetVariableFlashFtwSpareInfo (
>> +  OUT EFI_PHYSICAL_ADDRESS  *BaseAddress,
>> +  OUT UINT64                *Length
>> +  );
>> +
>> +/**
>> +  Get the base address and size for the fault tolerant write (FTW) 
>> working
>> +  area used for UEFI variable storage.
>> +
>> +  @param[out] BaseAddress    The FTW working area base address.
>> +  @param[out] Length         The FTW working area length in bytes.
>> +
>> +  @retval EFI_SUCCESS             FTW working information was found 
>> successfully.
>> +  @retval EFI_INVALID_PARAMETER   A required pointer parameter is NULL.
>> +  @retval EFI_NOT_FOUND           FTW working information could not 
>> be found.
>> +
>> +**/
>> +EFI_STATUS
>> +EFIAPI
>> +GetVariableFlashFtwWorkingInfo (
>> +  OUT EFI_PHYSICAL_ADDRESS  *BaseAddress,
>> +  OUT UINT64                *Length
>> +  );
>> +
>> +#endif
>> diff --git 
>> a/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf 
>> b/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf 
>>
>> new file mode 100644
>> index 000000000000..70175e75f9b1
>> --- /dev/null
>> +++ 
>> b/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf 
>>
>> @@ -0,0 +1,48 @@
>> +## @file
>> +#  Variable Flash Information Library
>> +#
>> +#  Provides services to access UEFI variable flash information.
>> +#
>> +#  Copyright (c) Microsoft Corporation<BR>
>> +#  SPDX-License-Identifier: BSD-2-Clause-Patent
>> +##
>> +
>> +[Defines]
>> +  INF_VERSION       = 0x00010005
>> +  BASE_NAME         = BaseVariableFlashInfoLib
>> +  MODULE_UNI_FILE   = BaseVariableFlashInfoLib.uni
>> +  FILE_GUID         = DEC426C9-C92E-4BAD-8E93-3F61C261118B
>> +  MODULE_TYPE       = BASE
>> +  VERSION_STRING    = 1.0
>> +  LIBRARY_CLASS     = VariableFlashInfoLib
>> +
>> +#
>> +# The following information is for reference only and not required by 
>> the build tools.
>> +#
>> +#  VALID_ARCHITECTURES           = ANY
>> +#
>> +
>> +[Sources]
>> +  BaseVariableFlashInfoLib.c
>> +
>> +[Packages]
>> +  MdePkg/MdePkg.dec
>> +  MdeModulePkg/MdeModulePkg.dec
>> +
>> +[LibraryClasses]
>> +  DebugLib
>> +  HobLib
>> +
>> +[Guids]
>> +  gVariableFlashInfoHobGuid     ## CONSUMES     ## HOB
>> +
>> +[Pcd]
>> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase      
>> ## SOMETIMES_CONSUMES
>> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase64    
>> ## SOMETIMES_CONSUMES
>> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize      
>> ## SOMETIMES_CONSUMES
>> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase      
>> ## SOMETIMES_CONSUMES
>> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase64    
>> ## SOMETIMES_CONSUMES
>> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize      
>> ## SOMETIMES_CONSUMES
>> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase    
>> ## SOMETIMES_CONSUMES
>> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase64  
>> ## SOMETIMES_CONSUMES
>> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize    
>> ## SOMETIMES_CONSUMES
>> diff --git 
>> a/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.uni 
>> b/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.uni 
>>
>> new file mode 100644
>> index 000000000000..9a5348fa02a0
>> --- /dev/null
>> +++ 
>> b/MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.uni 
>>
>> @@ -0,0 +1,12 @@
>> +// /** @file
>> +// Variable Flash Information Library
>> +//
>> +// Copyright (c) Microsoft Corporation<BR>
>> +//
>> +// SPDX-License-Identifier: BSD-2-Clause-Patent
>> +//
>> +// **/
>> +
>> +#string STR_MODULE_ABSTRACT     #language en-US "UEFI variable flash 
>> information library"
>> +
>> +#string STR_MODULE_DESCRIPTION  #language en-US "Provides services to 
>> access UEFI variable flash information."
>> diff --git a/MdeModulePkg/MdeModulePkg.dec 
>> b/MdeModulePkg/MdeModulePkg.dec
>> index 4e82f5836096..2bcb9f9453af 100644
>> --- a/MdeModulePkg/MdeModulePkg.dec
>> +++ b/MdeModulePkg/MdeModulePkg.dec
>> @@ -154,6 +154,10 @@ [LibraryClasses]
>>     #
>>     VariablePolicyHelperLib|Include/Library/VariablePolicyHelperLib.h
>> +  ##  @libraryclass  Provides services to access UEFI variable flash 
>> information.
>> +  #
>> +  VariableFlashInfoLib|Include/Library/VariableFlashInfoLib.h
>> +
>>   [Guids]
>>     ## MdeModule package token space guid
>>     # Include/Guid/MdeModulePkgTokenSpace.h
>> diff --git a/MdeModulePkg/MdeModulePkg.dsc 
>> b/MdeModulePkg/MdeModulePkg.dsc
>> index b1d83461865e..90a0a7ec4a7c 100644
>> --- a/MdeModulePkg/MdeModulePkg.dsc
>> +++ b/MdeModulePkg/MdeModulePkg.dsc
>> @@ -103,6 +103,7 @@ [LibraryClasses]
>>     
>> DisplayUpdateProgressLib|MdeModulePkg/Library/DisplayUpdateProgressLibGraphics/DisplayUpdateProgressLibGraphics.inf 
>>
>>     
>> VariablePolicyHelperLib|MdeModulePkg/Library/VariablePolicyHelperLib/VariablePolicyHelperLib.inf 
>>
>>     
>> MmUnblockMemoryLib|MdePkg/Library/MmUnblockMemoryLib/MmUnblockMemoryLibNull.inf 
>>
>> +  
>> VariableFlashInfoLib|MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf 
>>
>>   [LibraryClasses.EBC.PEIM]
>>     IoLib|MdePkg/Library/PeiIoLibCpuIo/PeiIoLibCpuIo.inf
>> @@ -440,6 +441,7 @@ [Components]
>>     
>> MdeModulePkg/Library/FmpAuthenticationLibNull/FmpAuthenticationLibNull.inf 
>>
>>     MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.inf
>>     MdeModulePkg/Library/DxeCapsuleLibFmp/DxeRuntimeCapsuleLib.inf
>> +  
>> MdeModulePkg/Library/BaseVariableFlashInfoLib/BaseVariableFlashInfoLib.inf 
>>
>>   [Components.IA32, Components.X64, Components.AARCH64]
>>     MdeModulePkg/Universal/EbcDxe/EbcDxe.inf
> 
> 
> 
> 

^ permalink raw reply	[flat|nested] 20+ messages in thread

end of thread, other threads:[~2022-04-25 22:21 UTC | newest]

Thread overview: 20+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-04-12 16:29 [PATCH v4 0/8] Add Variable Flash Info HOB Michael Kubacki
2022-04-12 16:29 ` [PATCH v4 1/8] MdeModulePkg: " Michael Kubacki
2022-04-25 16:05   ` [edk2-devel] " Sami Mujawar
2022-04-12 16:29 ` [PATCH v4 2/8] MdeModulePkg/VariableFlashInfoLib: Add initial library Michael Kubacki
2022-04-25 16:05   ` [edk2-devel] " Sami Mujawar
2022-04-25 22:21     ` Michael Kubacki
2022-04-12 16:29 ` [PATCH v4 3/8] MdeModulePkg/Variable: Consume Variable Flash Info Michael Kubacki
2022-04-25 16:05   ` [edk2-devel] " Sami Mujawar
2022-04-12 16:29 ` [PATCH v4 4/8] MdeModulePkg/FaultTolerantWrite: " Michael Kubacki
2022-04-25 16:05   ` [edk2-devel] " Sami Mujawar
2022-04-12 16:29 ` [PATCH v4 5/8] ArmVirtPkg/ArmVirt.dsc.inc: Add VariableFlashInfoLib Michael Kubacki
2022-04-25 16:06   ` Sami Mujawar
2022-04-12 16:29 ` [PATCH v4 6/8] EmulatorPkg: " Michael Kubacki
2022-04-12 16:29 ` [PATCH v4 7/8] OvmfPkg: " Michael Kubacki
2022-04-19 19:26   ` Rebecca Cran
2022-04-12 16:29 ` [PATCH v4 8/8] UefiPayloadPkg: " Michael Kubacki
2022-04-14  3:02   ` [edk2-devel] " Guo Dong
2022-04-20  7:43 ` [PATCH v4 0/8] Add Variable Flash Info HOB Ard Biesheuvel
     [not found] ` <16E5331AC6E8EA6F.9041@groups.io>
2022-04-20 22:51   ` [edk2-devel] [PATCH v4 6/8] EmulatorPkg: Add VariableFlashInfoLib Michael Kubacki
2022-04-21  1:51     ` Abner Chang

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox