[PATCH 00/12] Merge EmuVariable and Real variable driver

[PATCH 00/12] Merge EmuVariable and Real variable driver

[Star Zeng]

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

Repo: git@github.com:lzeng14/edk2.git
Branch: MergedVariableDriver_EmuNvMode

Purpose:
1. Add emulated variable NV mode support in
   MdeModulePkg\Universal\Variable\RuntimeDxe.
   Platform can configure PCD statically (build time) or
   dynamically (boot time) to support emulated variable NV mode.
2. Remove MdeModulePkg\Universal\Variable\EmuRuntimeDxe whose
   most codes are duplicated.

Patches 1~5: Preparation
Patch 6~7: Real work
Patch 8~12: Migration for platforms and cleanup

Test done:
Build code with VS2012, VS2015 and GCC49.
Regression: Boot Nt32, Ovmf (including 32, 3264 and 64 with no SMM) to UEFI SHELL.
            Boot some internal platform to UEFI SHELL and Windows.
Functionality: Boot Nt32, Ovmf (including 32, 3264 and 64 with no SMM) to UEFI SHELL
               with PcdEmuVariableNvModeEnable == TRUE.

More test will be welcome and appreciated. :)

Patches to update edk2-platforms Repo will be sent out separately.

Star Zeng (12):
  MdeModulePkg Variable: Add some missing changes for 9b18845
  MdeModulePkg Variable: Abstract InitRealNonVolatileVariableStore
  MdeModulePkg Variable: Not get NV PCD in
    VariableWriteServiceInitialize
  MdeModulePkg Variable: Abstract VariableWriteServiceInitializeDxe/Smm
  MdeModulePkg: Add PcdEmuVariableNvModeEnable in dsc
  MdeModulePkg Variable: Add emulated variable NV mode support
  MdeModulePkg VariablePei: Don't check BOOT_IN_RECOVERY_MODE
  ArmVirtXen: Use merged variable driver for emulated NV mode
  BeagleBoardPkg: Use merged variable driver for emulated NV mode
  QuarkMin: Use merged variable driver for emulated NV mode
  CorebootPayloadPkg: Use merged variable driver for emulated NV mode
  MdeModule: Remove EmuVariableRuntimeDxe

 ArmVirtPkg/ArmVirtXen.dsc                          |   11 +-
 ArmVirtPkg/ArmVirtXen.fdf                          |    4 +-
 BeagleBoardPkg/BeagleBoardPkg.dsc                  |   11 +-
 BeagleBoardPkg/BeagleBoardPkg.fdf                  |    4 +-
 CorebootPayloadPkg/CorebootPayloadPkg.fdf          |    4 +-
 CorebootPayloadPkg/CorebootPayloadPkgIa32.dsc      |   11 +-
 CorebootPayloadPkg/CorebootPayloadPkgIa32X64.dsc   |   11 +-
 MdeModulePkg/MdeModulePkg.dec                      |   10 +-
 MdeModulePkg/MdeModulePkg.dsc                      |    5 +-
 MdeModulePkg/MdeModulePkg.uni                      |   10 +-
 .../Universal/Variable/EmuRuntimeDxe/EmuVariable.c | 1820 --------------------
 .../EmuRuntimeDxe/EmuVariableRuntimeDxe.inf        |   88 -
 .../EmuRuntimeDxe/EmuVariableRuntimeDxe.uni        |   22 -
 .../EmuRuntimeDxe/EmuVariableRuntimeDxeExtra.uni   |   19 -
 .../Variable/EmuRuntimeDxe/InitVariable.c          |  259 ---
 .../Universal/Variable/EmuRuntimeDxe/Variable.h    |  277 ---
 MdeModulePkg/Universal/Variable/Pei/Variable.c     |    8 +-
 .../Universal/Variable/Pei/VariablePei.inf         |    3 +-
 .../Universal/Variable/RuntimeDxe/Variable.c       |  431 +++--
 .../Universal/Variable/RuntimeDxe/Variable.h       |   10 +-
 .../Universal/Variable/RuntimeDxe/VariableDxe.c    |  100 +-
 .../Variable/RuntimeDxe/VariableRuntimeDxe.inf     |    4 +-
 .../Universal/Variable/RuntimeDxe/VariableSmm.c    |   88 +-
 .../Universal/Variable/RuntimeDxe/VariableSmm.inf  |    4 +-
 QuarkPlatformPkg/QuarkMin.dsc                      |    7 +-
 QuarkPlatformPkg/QuarkMin.fdf                      |    4 +-
 26 files changed, 501 insertions(+), 2724 deletions(-)
 delete mode 100644 MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariable.c
 delete mode 100644 MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf
 delete mode 100644 MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.uni
 delete mode 100644 MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxeExtra.uni
 delete mode 100644 MdeModulePkg/Universal/Variable/EmuRuntimeDxe/InitVariable.c
 delete mode 100644 MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h

-- 
2.7.0.windows.1

[PATCH 01/12] MdeModulePkg Variable: Add some missing changes for 9b18845

[Star Zeng]

9b18845a4b4cd1d2cf004cbc1cadf8a93ccb37ea changed the code
which read from physical MMIO address to read from memory cache.

The patch adds some missing changes for it.

I found them when updating code for
https://bugzilla.tianocore.org/show_bug.cgi?id=1323
Merge EmuVariable and Real variable driver.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Hao Wu <hao.a.wu@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
---
 MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c    | 12 +++++-------
 MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c |  6 +++---
 2 files changed, 8 insertions(+), 10 deletions(-)

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
index 443cf07144a1..99d487adac9e 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
@@ -16,7 +16,7 @@
   VariableServiceSetVariable() should also check authenticate data to avoid buffer overflow,
   integer overflow. It should also check attribute to avoid authentication bypass.
 
-Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
 (C) Copyright 2015-2018 Hewlett Packard Enterprise Development LP<BR>
 This program and the accompanying materials
 are licensed and made available under the terms and conditions of the BSD License
@@ -262,13 +262,12 @@ UpdateVariableStore (
   UINT8                       *CurrBuffer;
   EFI_LBA                     LbaNumber;
   UINTN                       Size;
-  EFI_FIRMWARE_VOLUME_HEADER  *FwVolHeader;
   VARIABLE_STORE_HEADER       *VolatileBase;
   EFI_PHYSICAL_ADDRESS        FvVolHdr;
   EFI_PHYSICAL_ADDRESS        DataPtr;
   EFI_STATUS                  Status;
 
-  FwVolHeader = NULL;
+  FvVolHdr    = 0;
   DataPtr     = DataPtrIndex;
 
   //
@@ -281,7 +280,6 @@ UpdateVariableStore (
     Status = Fvb->GetPhysicalAddress(Fvb, &FvVolHdr);
     ASSERT_EFI_ERROR (Status);
 
-    FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *) ((UINTN) FvVolHdr);
     //
     // Data Pointer should point to the actual Address where data is to be
     // written.
@@ -290,7 +288,7 @@ UpdateVariableStore (
       DataPtr += mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase;
     }
 
-    if ((DataPtr + DataSize) > ((EFI_PHYSICAL_ADDRESS) (UINTN) ((UINT8 *) FwVolHeader + FwVolHeader->FvLength))) {
+    if ((DataPtr + DataSize) > (FvVolHdr + mNvFvHeaderCache->FvLength)) {
       return EFI_OUT_OF_RESOURCES;
     }
   } else {
@@ -317,7 +315,7 @@ UpdateVariableStore (
   //
   // If we are here we are dealing with Non-Volatile Variables.
   //
-  LinearOffset  = (UINTN) FwVolHeader;
+  LinearOffset  = (UINTN) FvVolHdr;
   CurrWritePtr  = (UINTN) DataPtr;
   CurrWriteSize = DataSize;
   CurrBuffer    = Buffer;
@@ -2739,7 +2737,7 @@ UpdateVariable (
       }
     }
 
-    State = Variable->CurrPtr->State;
+    State = CacheVariable->CurrPtr->State;
     State &= VAR_DELETED;
 
     Status = UpdateVariableStore (
diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
index 23186176be75..f7185df3a7eb 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
@@ -3,7 +3,7 @@
   and volatile storage space and install variable architecture protocol.
 
 Copyright (C) 2013, Red Hat, Inc.
-Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
 (C) Copyright 2015 Hewlett Packard Enterprise Development LP<BR>
 This program and the accompanying materials
 are licensed and made available under the terms and conditions of the BSD License
@@ -402,8 +402,8 @@ FtwNotificationEvent (
   //
   // Mark the variable storage region of the FLASH as RUNTIME.
   //
-  VariableStoreBase   = NvStorageVariableBase + (((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)(NvStorageVariableBase))->HeaderLength);
-  VariableStoreLength = ((VARIABLE_STORE_HEADER *)(UINTN)VariableStoreBase)->Size;
+  VariableStoreBase   = NvStorageVariableBase + mNvFvHeaderCache->HeaderLength;
+  VariableStoreLength = mNvVariableCache->Size;
   BaseAddress = VariableStoreBase & (~EFI_PAGE_MASK);
   Length      = VariableStoreLength + (VariableStoreBase - BaseAddress);
   Length      = (Length + EFI_PAGE_SIZE - 1) & (~EFI_PAGE_MASK);
-- 
2.7.0.windows.1

Re: [PATCH 01/12] MdeModulePkg Variable: Add some missing changes for 9b18845

[Laszlo Ersek]

Hi Star,

On 01/13/19 16:37, Star Zeng wrote:
> 9b18845a4b4cd1d2cf004cbc1cadf8a93ccb37ea changed the code
> which read from physical MMIO address to read from memory cache.
> 
> The patch adds some missing changes for it.
> 
> I found them when updating code for
> https://bugzilla.tianocore.org/show_bug.cgi?id=1323
> Merge EmuVariable and Real variable driver.
> 
> Cc: Jian J Wang <jian.j.wang@intel.com>
> Cc: Hao Wu <hao.a.wu@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.0
> Signed-off-by: Star Zeng <star.zeng@intel.com>
> ---
>  MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c    | 12 +++++-------
>  MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c |  6 +++---
>  2 files changed, 8 insertions(+), 10 deletions(-)

Please update the commit message to clarify the change.

Commit 9b18845a4b4c ("MdeModulePkg Variable: Enhance variable
performance by reading from existed memory cache.", 2015-10-23) was a
performance optimization. Therefore, there can be two issues with it:

(a) it may have missed another opportunity for performance improvement,

(b) it may have introduced a regression.

Can you please clarify the issue? The explanation should be part of the
commit message.

Dependent on (a) vs. (b), the impact of this change could differ greatly.

Thanks!
Laszlo


> 
> diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
> index 443cf07144a1..99d487adac9e 100644
> --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
> +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
> @@ -16,7 +16,7 @@
>    VariableServiceSetVariable() should also check authenticate data to avoid buffer overflow,
>    integer overflow. It should also check attribute to avoid authentication bypass.
>  
> -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
> +Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
>  (C) Copyright 2015-2018 Hewlett Packard Enterprise Development LP<BR>
>  This program and the accompanying materials
>  are licensed and made available under the terms and conditions of the BSD License
> @@ -262,13 +262,12 @@ UpdateVariableStore (
>    UINT8                       *CurrBuffer;
>    EFI_LBA                     LbaNumber;
>    UINTN                       Size;
> -  EFI_FIRMWARE_VOLUME_HEADER  *FwVolHeader;
>    VARIABLE_STORE_HEADER       *VolatileBase;
>    EFI_PHYSICAL_ADDRESS        FvVolHdr;
>    EFI_PHYSICAL_ADDRESS        DataPtr;
>    EFI_STATUS                  Status;
>  
> -  FwVolHeader = NULL;
> +  FvVolHdr    = 0;
>    DataPtr     = DataPtrIndex;
>  
>    //
> @@ -281,7 +280,6 @@ UpdateVariableStore (
>      Status = Fvb->GetPhysicalAddress(Fvb, &FvVolHdr);
>      ASSERT_EFI_ERROR (Status);
>  
> -    FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *) ((UINTN) FvVolHdr);
>      //
>      // Data Pointer should point to the actual Address where data is to be
>      // written.
> @@ -290,7 +288,7 @@ UpdateVariableStore (
>        DataPtr += mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase;
>      }
>  
> -    if ((DataPtr + DataSize) > ((EFI_PHYSICAL_ADDRESS) (UINTN) ((UINT8 *) FwVolHeader + FwVolHeader->FvLength))) {
> +    if ((DataPtr + DataSize) > (FvVolHdr + mNvFvHeaderCache->FvLength)) {
>        return EFI_OUT_OF_RESOURCES;
>      }
>    } else {
> @@ -317,7 +315,7 @@ UpdateVariableStore (
>    //
>    // If we are here we are dealing with Non-Volatile Variables.
>    //
> -  LinearOffset  = (UINTN) FwVolHeader;
> +  LinearOffset  = (UINTN) FvVolHdr;
>    CurrWritePtr  = (UINTN) DataPtr;
>    CurrWriteSize = DataSize;
>    CurrBuffer    = Buffer;
> @@ -2739,7 +2737,7 @@ UpdateVariable (
>        }
>      }
>  
> -    State = Variable->CurrPtr->State;
> +    State = CacheVariable->CurrPtr->State;
>      State &= VAR_DELETED;
>  
>      Status = UpdateVariableStore (
> diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
> index 23186176be75..f7185df3a7eb 100644
> --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
> +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
> @@ -3,7 +3,7 @@
>    and volatile storage space and install variable architecture protocol.
>  
>  Copyright (C) 2013, Red Hat, Inc.
> -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
> +Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
>  (C) Copyright 2015 Hewlett Packard Enterprise Development LP<BR>
>  This program and the accompanying materials
>  are licensed and made available under the terms and conditions of the BSD License
> @@ -402,8 +402,8 @@ FtwNotificationEvent (
>    //
>    // Mark the variable storage region of the FLASH as RUNTIME.
>    //
> -  VariableStoreBase   = NvStorageVariableBase + (((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)(NvStorageVariableBase))->HeaderLength);
> -  VariableStoreLength = ((VARIABLE_STORE_HEADER *)(UINTN)VariableStoreBase)->Size;
> +  VariableStoreBase   = NvStorageVariableBase + mNvFvHeaderCache->HeaderLength;
> +  VariableStoreLength = mNvVariableCache->Size;
>    BaseAddress = VariableStoreBase & (~EFI_PAGE_MASK);
>    Length      = VariableStoreLength + (VariableStoreBase - BaseAddress);
>    Length      = (Length + EFI_PAGE_SIZE - 1) & (~EFI_PAGE_MASK);
> 

Re: [PATCH 01/12] MdeModulePkg Variable: Add some missing changes for 9b18845

[Zeng, Star]

Hi Laszlo,

On 2019/1/14 18:15, Laszlo Ersek wrote:
> Hi Star,
> 
> On 01/13/19 16:37, Star Zeng wrote:
>> 9b18845a4b4cd1d2cf004cbc1cadf8a93ccb37ea changed the code
>> which read from physical MMIO address to read from memory cache.
>>
>> The patch adds some missing changes for it.
>>
>> I found them when updating code for
>> https://bugzilla.tianocore.org/show_bug.cgi?id=1323
>> Merge EmuVariable and Real variable driver.
>>
>> Cc: Jian J Wang <jian.j.wang@intel.com>
>> Cc: Hao Wu <hao.a.wu@intel.com>
>> Contributed-under: TianoCore Contribution Agreement 1.0
>> Signed-off-by: Star Zeng <star.zeng@intel.com>
>> ---
>>   MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c    | 12 +++++-------
>>   MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c |  6 +++---
>>   2 files changed, 8 insertions(+), 10 deletions(-)
> 
> Please update the commit message to clarify the change.
> 
> Commit 9b18845a4b4c ("MdeModulePkg Variable: Enhance variable
> performance by reading from existed memory cache.", 2015-10-23) was a
> performance optimization. Therefore, there can be two issues with it:
> 
> (a) it may have missed another opportunity for performance improvement,
> 
> (b) it may have introduced a regression.
> 
> Can you please clarify the issue? The explanation should be part of the
> commit message.
> 
> Dependent on (a) vs. (b), the impact of this change could differ greatly.

Oh, got your point. :)
(a) is the issue, I can add it to be part of the commit message.
If V2 patch series is needed, it will be included in that series.

Thanks,
Star

> 
> Thanks!
> Laszlo
> 
> 
>>
>> diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
>> index 443cf07144a1..99d487adac9e 100644
>> --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
>> +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
>> @@ -16,7 +16,7 @@
>>     VariableServiceSetVariable() should also check authenticate data to avoid buffer overflow,
>>     integer overflow. It should also check attribute to avoid authentication bypass.
>>   
>> -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
>> +Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
>>   (C) Copyright 2015-2018 Hewlett Packard Enterprise Development LP<BR>
>>   This program and the accompanying materials
>>   are licensed and made available under the terms and conditions of the BSD License
>> @@ -262,13 +262,12 @@ UpdateVariableStore (
>>     UINT8                       *CurrBuffer;
>>     EFI_LBA                     LbaNumber;
>>     UINTN                       Size;
>> -  EFI_FIRMWARE_VOLUME_HEADER  *FwVolHeader;
>>     VARIABLE_STORE_HEADER       *VolatileBase;
>>     EFI_PHYSICAL_ADDRESS        FvVolHdr;
>>     EFI_PHYSICAL_ADDRESS        DataPtr;
>>     EFI_STATUS                  Status;
>>   
>> -  FwVolHeader = NULL;
>> +  FvVolHdr    = 0;
>>     DataPtr     = DataPtrIndex;
>>   
>>     //
>> @@ -281,7 +280,6 @@ UpdateVariableStore (
>>       Status = Fvb->GetPhysicalAddress(Fvb, &FvVolHdr);
>>       ASSERT_EFI_ERROR (Status);
>>   
>> -    FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *) ((UINTN) FvVolHdr);
>>       //
>>       // Data Pointer should point to the actual Address where data is to be
>>       // written.
>> @@ -290,7 +288,7 @@ UpdateVariableStore (
>>         DataPtr += mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase;
>>       }
>>   
>> -    if ((DataPtr + DataSize) > ((EFI_PHYSICAL_ADDRESS) (UINTN) ((UINT8 *) FwVolHeader + FwVolHeader->FvLength))) {
>> +    if ((DataPtr + DataSize) > (FvVolHdr + mNvFvHeaderCache->FvLength)) {
>>         return EFI_OUT_OF_RESOURCES;
>>       }
>>     } else {
>> @@ -317,7 +315,7 @@ UpdateVariableStore (
>>     //
>>     // If we are here we are dealing with Non-Volatile Variables.
>>     //
>> -  LinearOffset  = (UINTN) FwVolHeader;
>> +  LinearOffset  = (UINTN) FvVolHdr;
>>     CurrWritePtr  = (UINTN) DataPtr;
>>     CurrWriteSize = DataSize;
>>     CurrBuffer    = Buffer;
>> @@ -2739,7 +2737,7 @@ UpdateVariable (
>>         }
>>       }
>>   
>> -    State = Variable->CurrPtr->State;
>> +    State = CacheVariable->CurrPtr->State;
>>       State &= VAR_DELETED;
>>   
>>       Status = UpdateVariableStore (
>> diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
>> index 23186176be75..f7185df3a7eb 100644
>> --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
>> +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
>> @@ -3,7 +3,7 @@
>>     and volatile storage space and install variable architecture protocol.
>>   
>>   Copyright (C) 2013, Red Hat, Inc.
>> -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
>> +Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
>>   (C) Copyright 2015 Hewlett Packard Enterprise Development LP<BR>
>>   This program and the accompanying materials
>>   are licensed and made available under the terms and conditions of the BSD License
>> @@ -402,8 +402,8 @@ FtwNotificationEvent (
>>     //
>>     // Mark the variable storage region of the FLASH as RUNTIME.
>>     //
>> -  VariableStoreBase   = NvStorageVariableBase + (((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)(NvStorageVariableBase))->HeaderLength);
>> -  VariableStoreLength = ((VARIABLE_STORE_HEADER *)(UINTN)VariableStoreBase)->Size;
>> +  VariableStoreBase   = NvStorageVariableBase + mNvFvHeaderCache->HeaderLength;
>> +  VariableStoreLength = mNvVariableCache->Size;
>>     BaseAddress = VariableStoreBase & (~EFI_PAGE_MASK);
>>     Length      = VariableStoreLength + (VariableStoreBase - BaseAddress);
>>     Length      = (Length + EFI_PAGE_SIZE - 1) & (~EFI_PAGE_MASK);
>>

[PATCH 02/12] MdeModulePkg Variable: Abstract InitRealNonVolatileVariableStore

[Star Zeng]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1323
Merge EmuVariable and Real variable driver.

Abstract InitRealNonVolatileVariableStore from
InitNonVolatileVariableStore.

This patch prepares for adding emulated variable NV mode
support in VariableRuntimeDxe.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Hao Wu <hao.a.wu@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Star Zeng <star.zeng@intel.com>
---
 .../Universal/Variable/RuntimeDxe/Variable.c       | 86 +++++++++++++++-------
 1 file changed, 58 insertions(+), 28 deletions(-)

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
index 99d487adac9e..0b675c8f36df 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
@@ -3728,9 +3728,9 @@ GetMaxVariableSize (
 }
 
 /**
-  Init non-volatile variable store.
+  Init real non-volatile variable store.
 
-  @param[out] NvFvHeader        Output pointer to non-volatile FV header address.
+  @param[out] VariableStoreBase Output pointer to real non-volatile variable store base.
 
   @retval EFI_SUCCESS           Function successfully executed.
   @retval EFI_OUT_OF_RESOURCES  Fail to allocate enough memory resource.
@@ -3738,16 +3738,13 @@ GetMaxVariableSize (
 
 **/
 EFI_STATUS
-InitNonVolatileVariableStore (
-  OUT EFI_FIRMWARE_VOLUME_HEADER    **NvFvHeader
+InitRealNonVolatileVariableStore (
+  OUT EFI_PHYSICAL_ADDRESS              *VariableStoreBase
   )
 {
   EFI_FIRMWARE_VOLUME_HEADER            *FvHeader;
-  VARIABLE_HEADER                       *Variable;
-  VARIABLE_HEADER                       *NextVariable;
-  EFI_PHYSICAL_ADDRESS                  VariableStoreBase;
-  UINT64                                VariableStoreLength;
-  UINTN                                 VariableSize;
+  VARIABLE_STORE_HEADER                 *VariableStore;
+  UINT32                                VariableStoreLength;
   EFI_HOB_GUID_TYPE                     *GuidHob;
   EFI_PHYSICAL_ADDRESS                  NvStorageBase;
   UINT8                                 *NvStorageData;
@@ -3777,6 +3774,8 @@ InitNonVolatileVariableStore (
   if (NvStorageBase == 0) {
     NvStorageBase = (EFI_PHYSICAL_ADDRESS) PcdGet32 (PcdFlashNvStorageVariableBase);
   }
+  ASSERT (NvStorageBase != 0);
+
   //
   // Copy NV storage data to the memory buffer.
   //
@@ -3826,24 +3825,23 @@ InitNonVolatileVariableStore (
     return EFI_VOLUME_CORRUPTED;
   }
 
-  VariableStoreBase = (UINTN) FvHeader + FvHeader->HeaderLength;
+  VariableStore = (VARIABLE_STORE_HEADER *) ((UINTN) FvHeader + FvHeader->HeaderLength);
   VariableStoreLength = NvStorageSize - FvHeader->HeaderLength;
+  ASSERT (sizeof (VARIABLE_STORE_HEADER) <= VariableStoreLength);
+  ASSERT (VariableStore->Size == VariableStoreLength);
 
-  mNvFvHeaderCache = FvHeader;
-  mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase = VariableStoreBase;
-  mNvVariableCache = (VARIABLE_STORE_HEADER *) (UINTN) VariableStoreBase;
-  if (GetVariableStoreStatus (mNvVariableCache) != EfiValid) {
+  //
+  // Check if the Variable Store header is not corrupted
+  //
+  if (GetVariableStoreStatus (VariableStore) != EfiValid) {
     FreePool (NvStorageData);
-    mNvFvHeaderCache = NULL;
-    mNvVariableCache = NULL;
     DEBUG((EFI_D_ERROR, "Variable Store header is corrupted\n"));
     return EFI_VOLUME_CORRUPTED;
   }
-  ASSERT(mNvVariableCache->Size == VariableStoreLength);
 
-  ASSERT (sizeof (VARIABLE_STORE_HEADER) <= VariableStoreLength);
+  mNvFvHeaderCache = FvHeader;
 
-  mVariableModuleGlobal->VariableGlobal.AuthFormat = (BOOLEAN)(CompareGuid (&mNvVariableCache->Signature, &gEfiAuthenticatedVariableGuid));
+  *VariableStoreBase = (EFI_PHYSICAL_ADDRESS) (UINTN) VariableStore;
 
   HwErrStorageSize = PcdGet32 (PcdHwErrStorageSize);
   MaxUserNvVariableSpaceSize = PcdGet32 (PcdMaxUserNvVariableSpaceSize);
@@ -3878,14 +3876,45 @@ InitNonVolatileVariableStore (
   //
   ASSERT (GetNonVolatileMaxVariableSize () < (VariableStoreLength - sizeof (VARIABLE_STORE_HEADER)));
 
+  return EFI_SUCCESS;
+}
+
+/**
+  Init non-volatile variable store.
+
+  @retval EFI_SUCCESS           Function successfully executed.
+  @retval EFI_OUT_OF_RESOURCES  Fail to allocate enough memory resource.
+  @retval EFI_VOLUME_CORRUPTED  Variable Store or Firmware Volume for Variable Store is corrupted.
+
+**/
+EFI_STATUS
+InitNonVolatileVariableStore (
+  VOID
+  )
+{
+  VARIABLE_HEADER                       *Variable;
+  VARIABLE_HEADER                       *NextVariable;
+  EFI_PHYSICAL_ADDRESS                  VariableStoreBase;
+  UINTN                                 VariableSize;
+  EFI_STATUS                            Status;
+
+  Status = InitRealNonVolatileVariableStore (&VariableStoreBase);
+  if (EFI_ERROR (Status)) {
+    return Status;
+  }
+
+  mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase = VariableStoreBase;
+  mNvVariableCache = (VARIABLE_STORE_HEADER *) (UINTN) VariableStoreBase;
+  mVariableModuleGlobal->VariableGlobal.AuthFormat = (BOOLEAN)(CompareGuid (&mNvVariableCache->Signature, &gEfiAuthenticatedVariableGuid));
+
   mVariableModuleGlobal->MaxVariableSize = PcdGet32 (PcdMaxVariableSize);
   mVariableModuleGlobal->MaxAuthVariableSize = ((PcdGet32 (PcdMaxAuthVariableSize) != 0) ? PcdGet32 (PcdMaxAuthVariableSize) : mVariableModuleGlobal->MaxVariableSize);
 
   //
   // Parse non-volatile variable data and get last variable offset.
   //
-  Variable  = GetStartPointer ((VARIABLE_STORE_HEADER *)(UINTN)VariableStoreBase);
-  while (IsValidVariableHeader (Variable, GetEndPointer ((VARIABLE_STORE_HEADER *)(UINTN)VariableStoreBase))) {
+  Variable  = GetStartPointer (mNvVariableCache);
+  while (IsValidVariableHeader (Variable, GetEndPointer (mNvVariableCache))) {
     NextVariable = GetNextVariablePtr (Variable);
     VariableSize = (UINTN) NextVariable - (UINTN) Variable;
     if ((Variable->Attributes & (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) == (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {
@@ -3896,9 +3925,8 @@ InitNonVolatileVariableStore (
 
     Variable = NextVariable;
   }
-  mVariableModuleGlobal->NonVolatileLastVariableOffset = (UINTN) Variable - (UINTN) VariableStoreBase;
+  mVariableModuleGlobal->NonVolatileLastVariableOffset = (UINTN) Variable - (UINTN) mNvVariableCache;
 
-  *NvFvHeader = FvHeader;
   return EFI_SUCCESS;
 }
 
@@ -4303,7 +4331,6 @@ VariableCommonInitialize (
   VARIABLE_STORE_HEADER           *VolatileVariableStore;
   UINTN                           ScratchSize;
   EFI_GUID                        *VariableGuid;
-  EFI_FIRMWARE_VOLUME_HEADER      *NvFvHeader;
 
   //
   // Allocate runtime memory for variable driver global structure.
@@ -4318,8 +4345,7 @@ VariableCommonInitialize (
   //
   // Init non-volatile variable store.
   //
-  NvFvHeader = NULL;
-  Status = InitNonVolatileVariableStore (&NvFvHeader);
+  Status = InitNonVolatileVariableStore ();
   if (EFI_ERROR (Status)) {
     FreePool (mVariableModuleGlobal);
     return Status;
@@ -4347,7 +4373,9 @@ VariableCommonInitialize (
   //
   Status = GetHobVariableStore (VariableGuid);
   if (EFI_ERROR (Status)) {
-    FreePool (NvFvHeader);
+    if (mNvFvHeaderCache != NULL) {
+      FreePool (mNvFvHeaderCache);
+    }
     FreePool (mVariableModuleGlobal);
     return Status;
   }
@@ -4366,7 +4394,9 @@ VariableCommonInitialize (
     if (mVariableModuleGlobal->VariableGlobal.HobVariableBase != 0) {
       FreePool ((VOID *) (UINTN) mVariableModuleGlobal->VariableGlobal.HobVariableBase);
     }
-    FreePool (NvFvHeader);
+    if (mNvFvHeaderCache != NULL) {
+      FreePool (mNvFvHeaderCache);
+    }
     FreePool (mVariableModuleGlobal);
     return EFI_OUT_OF_RESOURCES;
   }
-- 
2.7.0.windows.1

[PATCH 03/12] MdeModulePkg Variable: Not get NV PCD in VariableWriteServiceInitialize

[Star Zeng]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1323
Merge EmuVariable and Real variable driver.

Add macro NV_STORAGE_VARIABLE_BASE.
Not get NV PCD in VariableWriteServiceInitialize, but in
FtwNotificationEvent/SmmFtwNotificationEvent, then
VariableWriteServiceInitialize could be not aware the NV
storage is real or emulated.

This patch prepares for adding emulated variable NV mode
support in VariableRuntimeDxe.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Hao Wu <hao.a.wu@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Star Zeng <star.zeng@intel.com>
---
 .../Universal/Variable/RuntimeDxe/Variable.c         | 20 ++------------------
 .../Universal/Variable/RuntimeDxe/Variable.h         |  9 +++++++--
 .../Universal/Variable/RuntimeDxe/VariableDxe.c      | 12 ++++++++----
 .../Universal/Variable/RuntimeDxe/VariableSmm.c      | 16 +++++++++++-----
 4 files changed, 28 insertions(+), 29 deletions(-)

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
index 0b675c8f36df..424f92a53757 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
@@ -3770,10 +3770,7 @@ InitRealNonVolatileVariableStore (
     return EFI_OUT_OF_RESOURCES;
   }
 
-  NvStorageBase = (EFI_PHYSICAL_ADDRESS) PcdGet64 (PcdFlashNvStorageVariableBase64);
-  if (NvStorageBase == 0) {
-    NvStorageBase = (EFI_PHYSICAL_ADDRESS) PcdGet32 (PcdFlashNvStorageVariableBase);
-  }
+  NvStorageBase = NV_STORAGE_VARIABLE_BASE;
   ASSERT (NvStorageBase != 0);
 
   //
@@ -4027,7 +4024,7 @@ FlushHobVariableToFlash (
 }
 
 /**
-  Initializes variable write service after FTW was ready.
+  Initializes variable write service.
 
   @retval EFI_SUCCESS          Function successfully executed.
   @retval Others               Fail to initialize the variable service.
@@ -4041,23 +4038,10 @@ VariableWriteServiceInitialize (
   EFI_STATUS                      Status;
   UINTN                           Index;
   UINT8                           Data;
-  EFI_PHYSICAL_ADDRESS            VariableStoreBase;
-  EFI_PHYSICAL_ADDRESS            NvStorageBase;
   VARIABLE_ENTRY_PROPERTY         *VariableEntry;
 
   AcquireLockOnlyAtBootTime(&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);
 
-  NvStorageBase = (EFI_PHYSICAL_ADDRESS) PcdGet64 (PcdFlashNvStorageVariableBase64);
-  if (NvStorageBase == 0) {
-    NvStorageBase = (EFI_PHYSICAL_ADDRESS) PcdGet32 (PcdFlashNvStorageVariableBase);
-  }
-  VariableStoreBase = NvStorageBase + (mNvFvHeaderCache->HeaderLength);
-
-  //
-  // Let NonVolatileVariableBase point to flash variable store base directly after FTW ready.
-  //
-  mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase = VariableStoreBase;
-
   //
   // Check if the free area is really free.
   //
diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h
index 938eb5de61fa..566e7268d187 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h
@@ -2,7 +2,7 @@
   The internal header file includes the common header files, defines
   internal structure and functions used by Variable modules.
 
-Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
 This program and the accompanying materials
 are licensed and made available under the terms and conditions of the BSD License
 which accompanies this distribution.  The full text of the license may be found at
@@ -46,6 +46,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
 #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 | \
@@ -473,7 +478,7 @@ GetMaxVariableSize (
   );
 
 /**
-  Initializes variable write service after FVB was ready.
+  Initializes variable write service.
 
   @retval EFI_SUCCESS          Function successfully executed.
   @retval Others               Fail to initialize the variable service.
diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
index f7185df3a7eb..baba6729c1c2 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
@@ -386,13 +386,17 @@ FtwNotificationEvent (
     ASSERT (PcdGet32 (PcdFlashNvStorageVariableSize) <= FtwMaxBlockSize);
   }
 
+  NvStorageVariableBase = NV_STORAGE_VARIABLE_BASE;
+  VariableStoreBase = NvStorageVariableBase + (mNvFvHeaderCache->HeaderLength);
+
+  //
+  // Let NonVolatileVariableBase point to flash variable store base directly after FTW ready.
+  //
+  mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase = VariableStoreBase;
+
   //
   // Find the proper FVB protocol for variable.
   //
-  NvStorageVariableBase = (EFI_PHYSICAL_ADDRESS) PcdGet64 (PcdFlashNvStorageVariableBase64);
-  if (NvStorageVariableBase == 0) {
-    NvStorageVariableBase = (EFI_PHYSICAL_ADDRESS) PcdGet32 (PcdFlashNvStorageVariableBase);
-  }
   Status = GetFvbInfoByAddress (NvStorageVariableBase, NULL, &FvbProtocol);
   if (EFI_ERROR (Status)) {
     return ;
diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c
index 8c53f84ff6e8..018587ed7373 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c
@@ -14,7 +14,7 @@
   VariableServiceSetVariable(), VariableServiceQueryVariableInfo(), ReclaimForOS(),
   SmmVariableGetStatistics() should also do validation based on its own knowledge.
 
-Copyright (c) 2010 - 2016, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2010 - 2019, Intel Corporation. All rights reserved.<BR>
 This program and the accompanying materials
 are licensed and made available under the terms and conditions of the BSD License
 which accompanies this distribution.  The full text of the license may be found at
@@ -37,6 +37,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Guid/SmmVariableCommon.h>
 #include "Variable.h"
 
+extern EFI_FIRMWARE_VOLUME_HEADER                    *mNvFvHeaderCache;
 extern VARIABLE_INFO_ENTRY                           *gVariableInfo;
 EFI_HANDLE                                           mSmmVariableHandle      = NULL;
 EFI_HANDLE                                           mVariableHandle         = NULL;
@@ -867,6 +868,7 @@ SmmFtwNotificationEvent (
   )
 {
   EFI_STATUS                              Status;
+  EFI_PHYSICAL_ADDRESS                    VariableStoreBase;
   EFI_SMM_FIRMWARE_VOLUME_BLOCK_PROTOCOL  *FvbProtocol;
   EFI_SMM_FAULT_TOLERANT_WRITE_PROTOCOL   *FtwProtocol;
   EFI_PHYSICAL_ADDRESS                    NvStorageVariableBase;
@@ -889,13 +891,17 @@ SmmFtwNotificationEvent (
     ASSERT (PcdGet32 (PcdFlashNvStorageVariableSize) <= FtwMaxBlockSize);
   }
 
+  NvStorageVariableBase = NV_STORAGE_VARIABLE_BASE;
+  VariableStoreBase = NvStorageVariableBase + (mNvFvHeaderCache->HeaderLength);
+
+  //
+  // Let NonVolatileVariableBase point to flash variable store base directly after FTW ready.
+  //
+  mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase = VariableStoreBase;
+
   //
   // Find the proper FVB protocol for variable.
   //
-  NvStorageVariableBase = (EFI_PHYSICAL_ADDRESS) PcdGet64 (PcdFlashNvStorageVariableBase64);
-  if (NvStorageVariableBase == 0) {
-    NvStorageVariableBase = (EFI_PHYSICAL_ADDRESS) PcdGet32 (PcdFlashNvStorageVariableBase);
-  }
   Status = GetFvbInfoByAddress (NvStorageVariableBase, NULL, &FvbProtocol);
   if (EFI_ERROR (Status)) {
     return EFI_NOT_FOUND;
-- 
2.7.0.windows.1

[PATCH 04/12] MdeModulePkg Variable: Abstract VariableWriteServiceInitializeDxe/Smm

[Star Zeng]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1323
Merge EmuVariable and Real variable driver.

Abstract VariableWriteServiceInitializeDxe/Smm from
FtwNotificationEvent/SmmFtwNotificationEvent, then
VariableWriteServiceInitializeDxe/Smm could be not aware
the NV storage is real or emulated.

This patch prepares for adding emulated variable NV mode
support in VariableRuntimeDxe.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Hao Wu <hao.a.wu@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Star Zeng <star.zeng@intel.com>
---
 .../Universal/Variable/RuntimeDxe/VariableDxe.c    | 55 ++++++++++++++--------
 .../Universal/Variable/RuntimeDxe/VariableSmm.c    | 43 ++++++++++++-----
 2 files changed, 66 insertions(+), 32 deletions(-)

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
index baba6729c1c2..5131e6f351e4 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
@@ -346,6 +346,40 @@ OnEndOfDxe (
 }
 
 /**
+  Initializes variable write service for DXE.
+
+**/
+VOID
+VariableWriteServiceInitializeDxe (
+  VOID
+  )
+{
+  EFI_STATUS    Status;
+
+  Status = VariableWriteServiceInitialize ();
+  if (EFI_ERROR (Status)) {
+    DEBUG ((DEBUG_ERROR, "Variable write service initialization failed. Status = %r\n", Status));
+  }
+
+  //
+  // Some Secure Boot Policy Var (SecureBoot, etc) updates following other
+  // Secure Boot Policy Variable change. Record their initial value.
+  //
+  RecordSecureBootPolicyVarData();
+
+  //
+  // Install the Variable Write Architectural protocol.
+  //
+  Status = gBS->InstallProtocolInterface (
+                  &mHandle,
+                  &gEfiVariableWriteArchProtocolGuid,
+                  EFI_NATIVE_INTERFACE,
+                  NULL
+                  );
+  ASSERT_EFI_ERROR (Status);
+}
+
+/**
   Fault Tolerant Write protocol notification event handler.
 
   Non-Volatile variable write may needs FTW protocol to reclaim when
@@ -428,27 +462,10 @@ FtwNotificationEvent (
     }
   }
 
-  Status = VariableWriteServiceInitialize ();
-  if (EFI_ERROR (Status)) {
-    DEBUG ((DEBUG_ERROR, "Variable write service initialization failed. Status = %r\n", Status));
-  }
-
   //
-  // Some Secure Boot Policy Var (SecureBoot, etc) updates following other
-  // Secure Boot Policy Variable change. Record their initial value.
+  // Initializes variable write service after FTW was ready.
   //
-  RecordSecureBootPolicyVarData();
-
-  //
-  // Install the Variable Write Architectural protocol.
-  //
-  Status = gBS->InstallProtocolInterface (
-                  &mHandle,
-                  &gEfiVariableWriteArchProtocolGuid,
-                  EFI_NATIVE_INTERFACE,
-                  NULL
-                  );
-  ASSERT_EFI_ERROR (Status);
+  VariableWriteServiceInitializeDxe ();
 
   //
   // Close the notify event to avoid install gEfiVariableWriteArchProtocolGuid again.
diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c
index 018587ed7373..e63af812534e 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c
@@ -846,6 +846,34 @@ SmmEndOfDxeCallback (
 }
 
 /**
+  Initializes variable write service for SMM.
+
+**/
+VOID
+VariableWriteServiceInitializeSmm (
+  VOID
+  )
+{
+  EFI_STATUS    Status;
+
+  Status = VariableWriteServiceInitialize ();
+  if (EFI_ERROR (Status)) {
+    DEBUG ((DEBUG_ERROR, "Variable write service initialization failed. Status = %r\n", Status));
+  }
+
+  //
+  // Notify the variable wrapper driver the variable write service is ready
+  //
+  Status = gBS->InstallProtocolInterface (
+                  &mSmmVariableHandle,
+                  &gSmmVariableWriteGuid,
+                  EFI_NATIVE_INTERFACE,
+                  NULL
+                  );
+  ASSERT_EFI_ERROR (Status);
+}
+
+/**
   SMM Fault Tolerant Write protocol notification event handler.
 
   Non-Volatile variable write may needs FTW protocol to reclaim when
@@ -909,21 +937,10 @@ SmmFtwNotificationEvent (
 
   mVariableModuleGlobal->FvbInstance = FvbProtocol;
 
-  Status = VariableWriteServiceInitialize ();
-  if (EFI_ERROR (Status)) {
-    DEBUG ((DEBUG_ERROR, "Variable write service initialization failed. Status = %r\n", Status));
-  }
-
   //
-  // Notify the variable wrapper driver the variable write service is ready
+  // Initializes variable write service after FTW was ready.
   //
-  Status = gBS->InstallProtocolInterface (
-                  &mSmmVariableHandle,
-                  &gSmmVariableWriteGuid,
-                  EFI_NATIVE_INTERFACE,
-                  NULL
-                  );
-  ASSERT_EFI_ERROR (Status);
+  VariableWriteServiceInitializeSmm ();
 
   return EFI_SUCCESS;
 }
-- 
2.7.0.windows.1

[PATCH 05/12] MdeModulePkg: Add PcdEmuVariableNvModeEnable in dsc

[Star Zeng]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1323
Merge EmuVariable and Real variable driver.

Add PcdEmuVariableNvModeEnable (support both static and
dynamic) to indicate if Variable driver will enable
emulated variable NV mode.

This patch prepares for adding emulated variable NV mode
support in VariableRuntimeDxe.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Hao Wu <hao.a.wu@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Star Zeng <star.zeng@intel.com>
---
 MdeModulePkg/MdeModulePkg.dec | 10 ++++++++--
 MdeModulePkg/MdeModulePkg.uni | 10 ++++++++--
 2 files changed, 16 insertions(+), 4 deletions(-)

diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec
index 217ede1f7163..8fbc0af61365 100644
--- a/MdeModulePkg/MdeModulePkg.dec
+++ b/MdeModulePkg/MdeModulePkg.dec
@@ -3,7 +3,7 @@
 # It also provides the definitions(including PPIs/PROTOCOLs/GUIDs and library classes)
 # and libraries instances, which are used for those modules.
 #
-# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
+# Copyright (c) 2007 - 2019, Intel Corporation. All rights reserved.<BR>
 # Copyright (c) 2016, Linaro Ltd. All rights reserved.<BR>
 # (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
 # Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>
@@ -1586,7 +1586,13 @@ [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
   # @Prompt 64-bit Base address of flash FTW working block range.
   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase64|0x0|UINT64|0x80000010
 
-  ## This PCD defines a reserved memory range for the EMU Variable driver's NV Variable Store.
+  ## Indicates if Variable driver will enable emulated variable NV mode.<BR><BR>
+  #   TRUE  - An EMU variable NV storage will be allocated or reserved for NV variables.<BR>
+  #   FALSE - No EMU variable NV storage will be allocated or reserved for NV variables.<BR>
+  # @Prompt EMU variable NV mode enable.
+  gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvModeEnable|FALSE|BOOLEAN|0x01100001
+
+  ## This PCD defines a reserved memory range for EMU variable NV storage.
   #  The range is valid if non-zero. The memory range size must be PcdVariableStoreSize.
   # @Prompt Reserved memory range for EMU variable NV storage.
   gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvStoreReserved|0|UINT64|0x40000008
diff --git a/MdeModulePkg/MdeModulePkg.uni b/MdeModulePkg/MdeModulePkg.uni
index 35af744d89be..9c413a98f65d 100644
--- a/MdeModulePkg/MdeModulePkg.uni
+++ b/MdeModulePkg/MdeModulePkg.uni
@@ -4,7 +4,7 @@
 // It also provides the definitions(including PPIs/PROTOCOLs/GUIDs and library classes)
 // and libraries instances, which are used for those modules.
 //
-// Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
+// Copyright (c) 2007 - 2019, Intel Corporation. All rights reserved.<BR>
 //
 // This program and the accompanying materials are licensed and made available under
 // the terms and conditions of the BSD License that accompanies this distribution.
@@ -389,9 +389,15 @@
 
 #string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdFlashNvStorageFtwWorkingBase64_HELP  #language en-US "64-bit Base address of the FTW working block range in flash device. If PcdFlashNvStorageFtwWorkingSize is larger than one block size, this value should be block size aligned."
 
+#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdEmuVariableNvModeEnable_PROMPT  #language en-US "EMU variable NV mode enable"
+
+#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdEmuVariableNvModeEnable_HELP  #language en-US "Indicates if Variable driver will enable emulated variable NV mode.<BR><BR>"
+                                                                                  "TRUE  - An EMU variable NV storage will be allocated or reserved for NV variables.<BR>"
+                                                                                  "FALSE - No EMU variable NV storage will be allocated or reserved for NV variables.<BR>"
+
 #string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdEmuVariableNvStoreReserved_PROMPT  #language en-US "Reserved memory range for EMU variable NV storage"
 
-#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdEmuVariableNvStoreReserved_HELP  #language en-US "This PCD defines a reserved memory range for the EMU Variable driver's NV Variable Store. The range is valid if non-zero. The memory range size must be PcdVariableStoreSize."
+#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdEmuVariableNvStoreReserved_HELP  #language en-US "This PCD defines a reserved memory range for EMU variable NV storage. The range is valid if non-zero. The memory range size must be PcdVariableStoreSize."
 
 #string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdHelloWorldPrintTimes_PROMPT  #language en-US "HelloWorld print times"
 
-- 
2.7.0.windows.1

Re: [PATCH 05/12] MdeModulePkg: Add PcdEmuVariableNvModeEnable in dsc

[Laszlo Ersek]

Hi Star,


On 01/13/19 16:37, Star Zeng wrote:
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1323
> Merge EmuVariable and Real variable driver.
> 
> Add PcdEmuVariableNvModeEnable (support both static and
> dynamic) to indicate if Variable driver will enable
> emulated variable NV mode.
> 
> This patch prepares for adding emulated variable NV mode
> support in VariableRuntimeDxe.
> 
> Cc: Jian J Wang <jian.j.wang@intel.com>
> Cc: Hao Wu <hao.a.wu@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Star Zeng <star.zeng@intel.com>
> ---
>  MdeModulePkg/MdeModulePkg.dec | 10 ++++++++--
>  MdeModulePkg/MdeModulePkg.uni | 10 ++++++++--
>  2 files changed, 16 insertions(+), 4 deletions(-)

(1) the subject line should say "in dec", not "in dsc".

Otherwise, this patch looks OK to me; in particular the FALSE default.

With the subject fixed:

Reviewed-by: Laszlo Ersek <lersek@redhat.com>

Thanks,
Laszlo

> diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec
> index 217ede1f7163..8fbc0af61365 100644
> --- a/MdeModulePkg/MdeModulePkg.dec
> +++ b/MdeModulePkg/MdeModulePkg.dec
> @@ -3,7 +3,7 @@
>  # It also provides the definitions(including PPIs/PROTOCOLs/GUIDs and library classes)
>  # and libraries instances, which are used for those modules.
>  #
> -# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
> +# Copyright (c) 2007 - 2019, Intel Corporation. All rights reserved.<BR>
>  # Copyright (c) 2016, Linaro Ltd. All rights reserved.<BR>
>  # (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
>  # Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>
> @@ -1586,7 +1586,13 @@ [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
>    # @Prompt 64-bit Base address of flash FTW working block range.
>    gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase64|0x0|UINT64|0x80000010
>  
> -  ## This PCD defines a reserved memory range for the EMU Variable driver's NV Variable Store.
> +  ## Indicates if Variable driver will enable emulated variable NV mode.<BR><BR>
> +  #   TRUE  - An EMU variable NV storage will be allocated or reserved for NV variables.<BR>
> +  #   FALSE - No EMU variable NV storage will be allocated or reserved for NV variables.<BR>
> +  # @Prompt EMU variable NV mode enable.
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvModeEnable|FALSE|BOOLEAN|0x01100001
> +
> +  ## This PCD defines a reserved memory range for EMU variable NV storage.
>    #  The range is valid if non-zero. The memory range size must be PcdVariableStoreSize.
>    # @Prompt Reserved memory range for EMU variable NV storage.
>    gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvStoreReserved|0|UINT64|0x40000008
> diff --git a/MdeModulePkg/MdeModulePkg.uni b/MdeModulePkg/MdeModulePkg.uni
> index 35af744d89be..9c413a98f65d 100644
> --- a/MdeModulePkg/MdeModulePkg.uni
> +++ b/MdeModulePkg/MdeModulePkg.uni
> @@ -4,7 +4,7 @@
>  // It also provides the definitions(including PPIs/PROTOCOLs/GUIDs and library classes)
>  // and libraries instances, which are used for those modules.
>  //
> -// Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
> +// Copyright (c) 2007 - 2019, Intel Corporation. All rights reserved.<BR>
>  //
>  // This program and the accompanying materials are licensed and made available under
>  // the terms and conditions of the BSD License that accompanies this distribution.
> @@ -389,9 +389,15 @@
>  
>  #string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdFlashNvStorageFtwWorkingBase64_HELP  #language en-US "64-bit Base address of the FTW working block range in flash device. If PcdFlashNvStorageFtwWorkingSize is larger than one block size, this value should be block size aligned."
>  
> +#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdEmuVariableNvModeEnable_PROMPT  #language en-US "EMU variable NV mode enable"
> +
> +#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdEmuVariableNvModeEnable_HELP  #language en-US "Indicates if Variable driver will enable emulated variable NV mode.<BR><BR>"
> +                                                                                  "TRUE  - An EMU variable NV storage will be allocated or reserved for NV variables.<BR>"
> +                                                                                  "FALSE - No EMU variable NV storage will be allocated or reserved for NV variables.<BR>"
> +
>  #string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdEmuVariableNvStoreReserved_PROMPT  #language en-US "Reserved memory range for EMU variable NV storage"
>  
> -#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdEmuVariableNvStoreReserved_HELP  #language en-US "This PCD defines a reserved memory range for the EMU Variable driver's NV Variable Store. The range is valid if non-zero. The memory range size must be PcdVariableStoreSize."
> +#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdEmuVariableNvStoreReserved_HELP  #language en-US "This PCD defines a reserved memory range for EMU variable NV storage. The range is valid if non-zero. The memory range size must be PcdVariableStoreSize."
>  
>  #string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdHelloWorldPrintTimes_PROMPT  #language en-US "HelloWorld print times"
>  
> 

Re: [PATCH 05/12] MdeModulePkg: Add PcdEmuVariableNvModeEnable in dsc

[Zeng, Star]

Hi Laszlo,

On 2019/1/14 18:22, Laszlo Ersek wrote:
> Hi Star,
> 
> 
> On 01/13/19 16:37, Star Zeng wrote:
>> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1323
>> Merge EmuVariable and Real variable driver.
>>
>> Add PcdEmuVariableNvModeEnable (support both static and
>> dynamic) to indicate if Variable driver will enable
>> emulated variable NV mode.
>>
>> This patch prepares for adding emulated variable NV mode
>> support in VariableRuntimeDxe.
>>
>> Cc: Jian J Wang <jian.j.wang@intel.com>
>> Cc: Hao Wu <hao.a.wu@intel.com>
>> Contributed-under: TianoCore Contribution Agreement 1.1
>> Signed-off-by: Star Zeng <star.zeng@intel.com>
>> ---
>>   MdeModulePkg/MdeModulePkg.dec | 10 ++++++++--
>>   MdeModulePkg/MdeModulePkg.uni | 10 ++++++++--
>>   2 files changed, 16 insertions(+), 4 deletions(-)
> 
> (1) the subject line should say "in dec", not "in dsc".

Oh, good catch.

> 
> Otherwise, this patch looks OK to me; in particular the FALSE default.
> 
> With the subject fixed:
> 
> Reviewed-by: Laszlo Ersek <lersek@redhat.com>

Thanks for the RB. :)

Thanks,
Star

> 
> Thanks,
> Laszlo
> 
>> diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec
>> index 217ede1f7163..8fbc0af61365 100644
>> --- a/MdeModulePkg/MdeModulePkg.dec
>> +++ b/MdeModulePkg/MdeModulePkg.dec
>> @@ -3,7 +3,7 @@
>>   # It also provides the definitions(including PPIs/PROTOCOLs/GUIDs and library classes)
>>   # and libraries instances, which are used for those modules.
>>   #
>> -# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
>> +# Copyright (c) 2007 - 2019, Intel Corporation. All rights reserved.<BR>
>>   # Copyright (c) 2016, Linaro Ltd. All rights reserved.<BR>
>>   # (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
>>   # Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>
>> @@ -1586,7 +1586,13 @@ [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
>>     # @Prompt 64-bit Base address of flash FTW working block range.
>>     gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase64|0x0|UINT64|0x80000010
>>   
>> -  ## This PCD defines a reserved memory range for the EMU Variable driver's NV Variable Store.
>> +  ## Indicates if Variable driver will enable emulated variable NV mode.<BR><BR>
>> +  #   TRUE  - An EMU variable NV storage will be allocated or reserved for NV variables.<BR>
>> +  #   FALSE - No EMU variable NV storage will be allocated or reserved for NV variables.<BR>
>> +  # @Prompt EMU variable NV mode enable.
>> +  gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvModeEnable|FALSE|BOOLEAN|0x01100001
>> +
>> +  ## This PCD defines a reserved memory range for EMU variable NV storage.
>>     #  The range is valid if non-zero. The memory range size must be PcdVariableStoreSize.
>>     # @Prompt Reserved memory range for EMU variable NV storage.
>>     gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvStoreReserved|0|UINT64|0x40000008
>> diff --git a/MdeModulePkg/MdeModulePkg.uni b/MdeModulePkg/MdeModulePkg.uni
>> index 35af744d89be..9c413a98f65d 100644
>> --- a/MdeModulePkg/MdeModulePkg.uni
>> +++ b/MdeModulePkg/MdeModulePkg.uni
>> @@ -4,7 +4,7 @@
>>   // It also provides the definitions(including PPIs/PROTOCOLs/GUIDs and library classes)
>>   // and libraries instances, which are used for those modules.
>>   //
>> -// Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
>> +// Copyright (c) 2007 - 2019, Intel Corporation. All rights reserved.<BR>
>>   //
>>   // This program and the accompanying materials are licensed and made available under
>>   // the terms and conditions of the BSD License that accompanies this distribution.
>> @@ -389,9 +389,15 @@
>>   
>>   #string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdFlashNvStorageFtwWorkingBase64_HELP  #language en-US "64-bit Base address of the FTW working block range in flash device. If PcdFlashNvStorageFtwWorkingSize is larger than one block size, this value should be block size aligned."
>>   
>> +#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdEmuVariableNvModeEnable_PROMPT  #language en-US "EMU variable NV mode enable"
>> +
>> +#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdEmuVariableNvModeEnable_HELP  #language en-US "Indicates if Variable driver will enable emulated variable NV mode.<BR><BR>"
>> +                                                                                  "TRUE  - An EMU variable NV storage will be allocated or reserved for NV variables.<BR>"
>> +                                                                                  "FALSE - No EMU variable NV storage will be allocated or reserved for NV variables.<BR>"
>> +
>>   #string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdEmuVariableNvStoreReserved_PROMPT  #language en-US "Reserved memory range for EMU variable NV storage"
>>   
>> -#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdEmuVariableNvStoreReserved_HELP  #language en-US "This PCD defines a reserved memory range for the EMU Variable driver's NV Variable Store. The range is valid if non-zero. The memory range size must be PcdVariableStoreSize."
>> +#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdEmuVariableNvStoreReserved_HELP  #language en-US "This PCD defines a reserved memory range for EMU variable NV storage. The range is valid if non-zero. The memory range size must be PcdVariableStoreSize."
>>   
>>   #string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdHelloWorldPrintTimes_PROMPT  #language en-US "HelloWorld print times"
>>   
>>

[PATCH 06/12] MdeModulePkg Variable: Add emulated variable NV mode support

[Star Zeng]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1323
Merge EmuVariable and Real variable driver.

Add emulated variable NV mode support in real variable driver.
Platform can configure PcdEmuVariableNvModeEnable statically
(build time) or dynamically (boot time) to support emulated
variable NV mode.

Then EmuVariableRuntimeDxe could be removed, the removal of
EmuVariableRuntimeDxe will be done after platforms are migrated
to use the merged variable driver.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Hao Wu <hao.a.wu@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Star Zeng <star.zeng@intel.com>
---
 .../Universal/Variable/RuntimeDxe/Variable.c       | 319 +++++++++++++++------
 .../Universal/Variable/RuntimeDxe/Variable.h       |   1 +
 .../Universal/Variable/RuntimeDxe/VariableDxe.c    |  27 +-
 .../Variable/RuntimeDxe/VariableRuntimeDxe.inf     |   4 +-
 .../Universal/Variable/RuntimeDxe/VariableSmm.c    |  29 +-
 .../Universal/Variable/RuntimeDxe/VariableSmm.inf  |   4 +-
 6 files changed, 271 insertions(+), 113 deletions(-)

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
index 424f92a53757..845276d891ae 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
@@ -34,6 +34,7 @@ VARIABLE_MODULE_GLOBAL  *mVariableModuleGlobal;
 
 ///
 /// Define a memory cache that improves the search performance for a variable.
+/// For EmuNvMode == TRUE, it will be equal to NonVolatileVariableBase.
 ///
 VARIABLE_STORE_HEADER  *mNvVariableCache      = NULL;
 
@@ -273,7 +274,7 @@ UpdateVariableStore (
   //
   // Check if the Data is Volatile.
   //
-  if (!Volatile) {
+  if (!Volatile && !mVariableModuleGlobal->VariableGlobal.EmuNvMode) {
     if (Fvb == NULL) {
       return EFI_UNSUPPORTED;
     }
@@ -296,17 +297,30 @@ UpdateVariableStore (
     // Data Pointer should point to the actual Address where data is to be
     // written.
     //
-    VolatileBase = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.VolatileVariableBase);
-    if (SetByIndex) {
-      DataPtr += mVariableModuleGlobal->VariableGlobal.VolatileVariableBase;
-    }
+    if (Volatile) {
+      VolatileBase = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.VolatileVariableBase);
+      if (SetByIndex) {
+        DataPtr += mVariableModuleGlobal->VariableGlobal.VolatileVariableBase;
+      }
 
-    if ((DataPtr + DataSize) > ((UINTN) ((UINT8 *) VolatileBase + VolatileBase->Size))) {
-      return EFI_OUT_OF_RESOURCES;
+      if ((DataPtr + DataSize) > ((UINTN) VolatileBase + VolatileBase->Size)) {
+        return EFI_OUT_OF_RESOURCES;
+      }
+    } else {
+      //
+      // Emulated non-volatile variable mode.
+      //
+      if (SetByIndex) {
+        DataPtr += (UINTN) mNvVariableCache;
+      }
+
+      if ((DataPtr + DataSize) > ((UINTN) mNvVariableCache + mNvVariableCache->Size)) {
+        return EFI_OUT_OF_RESOURCES;
+      }
     }
 
     //
-    // If Volatile Variable just do a simple mem copy.
+    // If Volatile/Emulated Non-volatile Variable just do a simple mem copy.
     //
     CopyMem ((UINT8 *)(UINTN)DataPtr, Buffer, DataSize);
     return EFI_SUCCESS;
@@ -987,7 +1001,7 @@ Reclaim (
   CommonUserVariableTotalSize = 0;
   HwErrVariableTotalSize  = 0;
 
-  if (IsVolatile) {
+  if (IsVolatile || mVariableModuleGlobal->VariableGlobal.EmuNvMode) {
     //
     // Start Pointers for the variable.
     //
@@ -1155,13 +1169,21 @@ Reclaim (
     CurrPtr += NewVariableSize;
   }
 
-  if (IsVolatile) {
+  if (IsVolatile || mVariableModuleGlobal->VariableGlobal.EmuNvMode) {
     //
-    // If volatile variable store, just copy valid buffer.
+    // If volatile/emulated non-volatile variable store, just copy valid buffer.
     //
     SetMem ((UINT8 *) (UINTN) VariableBase, VariableStoreHeader->Size, 0xff);
     CopyMem ((UINT8 *) (UINTN) VariableBase, ValidBuffer, (UINTN) CurrPtr - (UINTN) ValidBuffer);
     *LastVariableOffset = (UINTN) CurrPtr - (UINTN) ValidBuffer;
+    if (!IsVolatile) {
+      //
+      // Emulated non-volatile variable mode.
+      //
+      mVariableModuleGlobal->HwErrVariableTotalSize = HwErrVariableTotalSize;
+      mVariableModuleGlobal->CommonVariableTotalSize = CommonVariableTotalSize;
+      mVariableModuleGlobal->CommonUserVariableTotalSize = CommonUserVariableTotalSize;
+    }
     Status  = EFI_SUCCESS;
   } else {
     //
@@ -1200,7 +1222,7 @@ Reclaim (
   }
 
 Done:
-  if (IsVolatile) {
+  if (IsVolatile || mVariableModuleGlobal->VariableGlobal.EmuNvMode) {
     FreePool (ValidBuffer);
   } else {
     //
@@ -2139,7 +2161,6 @@ UpdateVariable (
   VARIABLE_POINTER_TRACK              *Variable;
   VARIABLE_POINTER_TRACK              NvVariable;
   VARIABLE_STORE_HEADER               *VariableStoreHeader;
-  UINTN                               CacheOffset;
   UINT8                               *BufferForMerge;
   UINTN                               MergedBufSize;
   BOOLEAN                             DataReady;
@@ -2148,7 +2169,7 @@ UpdateVariable (
   BOOLEAN                             IsCommonUserVariable;
   AUTHENTICATED_VARIABLE_HEADER       *AuthVariable;
 
-  if (mVariableModuleGlobal->FvbInstance == NULL) {
+  if (mVariableModuleGlobal->FvbInstance == NULL && !mVariableModuleGlobal->VariableGlobal.EmuNvMode) {
     //
     // The FVB protocol is not ready, so the EFI_VARIABLE_WRITE_ARCH_PROTOCOL is not installed.
     //
@@ -2567,80 +2588,105 @@ UpdateVariable (
       }
       goto Done;
     }
-    //
-    // Four steps
-    // 1. Write variable header
-    // 2. Set variable state to header valid
-    // 3. Write variable data
-    // 4. Set variable state to valid
-    //
-    //
-    // Step 1:
-    //
-    CacheOffset = mVariableModuleGlobal->NonVolatileLastVariableOffset;
-    Status = UpdateVariableStore (
-               &mVariableModuleGlobal->VariableGlobal,
-               FALSE,
-               TRUE,
-               Fvb,
-               mVariableModuleGlobal->NonVolatileLastVariableOffset,
-               (UINT32) GetVariableHeaderSize (),
-               (UINT8 *) NextVariable
-               );
 
-    if (EFI_ERROR (Status)) {
-      goto Done;
-    }
+    if (!mVariableModuleGlobal->VariableGlobal.EmuNvMode) {
+      //
+      // Four steps
+      // 1. Write variable header
+      // 2. Set variable state to header valid
+      // 3. Write variable data
+      // 4. Set variable state to valid
+      //
+      //
+      // Step 1:
+      //
+      Status = UpdateVariableStore (
+                 &mVariableModuleGlobal->VariableGlobal,
+                 FALSE,
+                 TRUE,
+                 Fvb,
+                 mVariableModuleGlobal->NonVolatileLastVariableOffset,
+                 (UINT32) GetVariableHeaderSize (),
+                 (UINT8 *) NextVariable
+                 );
 
-    //
-    // Step 2:
-    //
-    NextVariable->State = VAR_HEADER_VALID_ONLY;
-    Status = UpdateVariableStore (
-               &mVariableModuleGlobal->VariableGlobal,
-               FALSE,
-               TRUE,
-               Fvb,
-               mVariableModuleGlobal->NonVolatileLastVariableOffset + OFFSET_OF (VARIABLE_HEADER, State),
-               sizeof (UINT8),
-               &NextVariable->State
-               );
+      if (EFI_ERROR (Status)) {
+        goto Done;
+      }
 
-    if (EFI_ERROR (Status)) {
-      goto Done;
-    }
-    //
-    // Step 3:
-    //
-    Status = UpdateVariableStore (
-               &mVariableModuleGlobal->VariableGlobal,
-               FALSE,
-               TRUE,
-               Fvb,
-               mVariableModuleGlobal->NonVolatileLastVariableOffset + GetVariableHeaderSize (),
-               (UINT32) (VarSize - GetVariableHeaderSize ()),
-               (UINT8 *) NextVariable + GetVariableHeaderSize ()
-               );
+      //
+      // Step 2:
+      //
+      NextVariable->State = VAR_HEADER_VALID_ONLY;
+      Status = UpdateVariableStore (
+                 &mVariableModuleGlobal->VariableGlobal,
+                 FALSE,
+                 TRUE,
+                 Fvb,
+                 mVariableModuleGlobal->NonVolatileLastVariableOffset + OFFSET_OF (VARIABLE_HEADER, State),
+                 sizeof (UINT8),
+                 &NextVariable->State
+                 );
 
-    if (EFI_ERROR (Status)) {
-      goto Done;
-    }
-    //
-    // Step 4:
-    //
-    NextVariable->State = VAR_ADDED;
-    Status = UpdateVariableStore (
-               &mVariableModuleGlobal->VariableGlobal,
-               FALSE,
-               TRUE,
-               Fvb,
-               mVariableModuleGlobal->NonVolatileLastVariableOffset + OFFSET_OF (VARIABLE_HEADER, State),
-               sizeof (UINT8),
-               &NextVariable->State
-               );
+      if (EFI_ERROR (Status)) {
+        goto Done;
+      }
+      //
+      // Step 3:
+      //
+      Status = UpdateVariableStore (
+                 &mVariableModuleGlobal->VariableGlobal,
+                 FALSE,
+                 TRUE,
+                 Fvb,
+                 mVariableModuleGlobal->NonVolatileLastVariableOffset + GetVariableHeaderSize (),
+                 (UINT32) (VarSize - GetVariableHeaderSize ()),
+                 (UINT8 *) NextVariable + GetVariableHeaderSize ()
+                 );
 
-    if (EFI_ERROR (Status)) {
-      goto Done;
+      if (EFI_ERROR (Status)) {
+        goto Done;
+      }
+      //
+      // Step 4:
+      //
+      NextVariable->State = VAR_ADDED;
+      Status = UpdateVariableStore (
+                 &mVariableModuleGlobal->VariableGlobal,
+                 FALSE,
+                 TRUE,
+                 Fvb,
+                 mVariableModuleGlobal->NonVolatileLastVariableOffset + OFFSET_OF (VARIABLE_HEADER, State),
+                 sizeof (UINT8),
+                 &NextVariable->State
+                 );
+
+      if (EFI_ERROR (Status)) {
+        goto Done;
+      }
+
+      //
+      // update the memory copy of Flash region.
+      //
+      CopyMem ((UINT8 *)mNvVariableCache + mVariableModuleGlobal->NonVolatileLastVariableOffset, (UINT8 *)NextVariable, VarSize);
+    } else {
+      //
+      // Emulated non-volatile variable mode.
+      //
+      NextVariable->State = VAR_ADDED;
+      Status = UpdateVariableStore (
+                 &mVariableModuleGlobal->VariableGlobal,
+                 FALSE,
+                 TRUE,
+                 Fvb,
+                 mVariableModuleGlobal->NonVolatileLastVariableOffset,
+                 (UINT32) VarSize,
+                 (UINT8 *) NextVariable
+                 );
+
+      if (EFI_ERROR (Status)) {
+        goto Done;
+      }
     }
 
     mVariableModuleGlobal->NonVolatileLastVariableOffset += HEADER_ALIGN (VarSize);
@@ -2653,10 +2699,6 @@ UpdateVariable (
         mVariableModuleGlobal->CommonUserVariableTotalSize += HEADER_ALIGN (VarSize);
       }
     }
-    //
-    // update the memory copy of Flash region.
-    //
-    CopyMem ((UINT8 *)mNvVariableCache + CacheOffset, (UINT8 *)NextVariable, VarSize);
   } else {
     //
     // Create a volatile variable.
@@ -3877,6 +3919,93 @@ InitRealNonVolatileVariableStore (
 }
 
 /**
+  Init emulated non-volatile variable store.
+
+  @param[out] VariableStoreBase Output pointer to emulated non-volatile variable store base.
+
+  @retval EFI_SUCCESS           Function successfully executed.
+  @retval EFI_OUT_OF_RESOURCES  Fail to allocate enough memory resource.
+
+**/
+EFI_STATUS
+InitEmuNonVolatileVariableStore (
+  EFI_PHYSICAL_ADDRESS  *VariableStoreBase
+  )
+{
+  VARIABLE_STORE_HEADER *VariableStore;
+  UINT32                VariableStoreLength;
+  BOOLEAN               FullyInitializeStore;
+  UINT32                HwErrStorageSize;
+
+  FullyInitializeStore = TRUE;
+
+  VariableStoreLength = PcdGet32 (PcdVariableStoreSize);
+  ASSERT (sizeof (VARIABLE_STORE_HEADER) <= VariableStoreLength);
+
+  //
+  // Allocate memory for variable store.
+  //
+  if (PcdGet64 (PcdEmuVariableNvStoreReserved) == 0) {
+    VariableStore = (VARIABLE_STORE_HEADER *) AllocateRuntimePool (VariableStoreLength);
+    if (VariableStore == NULL) {
+      return EFI_OUT_OF_RESOURCES;
+    }
+  } else {
+    //
+    // A memory location has been reserved for the NV variable store.  Certain
+    // platforms may be able to preserve a memory range across system resets,
+    // thereby providing better NV variable emulation.
+    //
+    VariableStore =
+      (VARIABLE_STORE_HEADER *)(VOID*)(UINTN)
+        PcdGet64 (PcdEmuVariableNvStoreReserved);
+    if ((VariableStore->Size == VariableStoreLength) &&
+        (CompareGuid (&VariableStore->Signature, &gEfiAuthenticatedVariableGuid) ||
+         CompareGuid (&VariableStore->Signature, &gEfiVariableGuid)) &&
+        (VariableStore->Format == VARIABLE_STORE_FORMATTED) &&
+        (VariableStore->State == VARIABLE_STORE_HEALTHY)) {
+      DEBUG((
+        DEBUG_INFO,
+        "Variable Store reserved at %p appears to be valid\n",
+        VariableStore
+        ));
+      FullyInitializeStore = FALSE;
+    }
+  }
+
+  if (FullyInitializeStore) {
+    SetMem (VariableStore, VariableStoreLength, 0xff);
+    //
+    // Use gEfiAuthenticatedVariableGuid for potential auth variable support.
+    //
+    CopyGuid (&VariableStore->Signature, &gEfiAuthenticatedVariableGuid);
+    VariableStore->Size       = VariableStoreLength;
+    VariableStore->Format     = VARIABLE_STORE_FORMATTED;
+    VariableStore->State      = VARIABLE_STORE_HEALTHY;
+    VariableStore->Reserved   = 0;
+    VariableStore->Reserved1  = 0;
+  }
+
+  *VariableStoreBase = (EFI_PHYSICAL_ADDRESS) (UINTN) VariableStore;
+
+  HwErrStorageSize = PcdGet32 (PcdHwErrStorageSize);
+
+  //
+  // Note that in EdkII variable driver implementation, Hardware Error Record type variable
+  // is stored with common variable in the same NV region. So the platform integrator should
+  // ensure that the value of PcdHwErrStorageSize is less than the value of
+  // (VariableStoreLength - sizeof (VARIABLE_STORE_HEADER)).
+  //
+  ASSERT (HwErrStorageSize < (VariableStoreLength - sizeof (VARIABLE_STORE_HEADER)));
+
+  mVariableModuleGlobal->CommonVariableSpace = ((UINTN) VariableStoreLength - sizeof (VARIABLE_STORE_HEADER) - HwErrStorageSize);
+  mVariableModuleGlobal->CommonMaxUserVariableSpace = mVariableModuleGlobal->CommonVariableSpace;
+  mVariableModuleGlobal->CommonRuntimeVariableSpace = mVariableModuleGlobal->CommonVariableSpace;
+
+  return EFI_SUCCESS;
+}
+
+/**
   Init non-volatile variable store.
 
   @retval EFI_SUCCESS           Function successfully executed.
@@ -3895,9 +4024,19 @@ InitNonVolatileVariableStore (
   UINTN                                 VariableSize;
   EFI_STATUS                            Status;
 
-  Status = InitRealNonVolatileVariableStore (&VariableStoreBase);
-  if (EFI_ERROR (Status)) {
-    return Status;
+  if (!PcdGetBool (PcdEmuVariableNvModeEnable)) {
+    Status = InitRealNonVolatileVariableStore (&VariableStoreBase);
+    if (EFI_ERROR (Status)) {
+      return Status;
+    }
+    mVariableModuleGlobal->VariableGlobal.EmuNvMode = FALSE;
+  } else {
+    Status = InitEmuNonVolatileVariableStore (&VariableStoreBase);
+    if (EFI_ERROR (Status)) {
+      return Status;
+    }
+    mVariableModuleGlobal->VariableGlobal.EmuNvMode = TRUE;
+    DEBUG ((DEBUG_INFO, "Variable driver will work at emulated non-volatile variable mode!\n"));
   }
 
   mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase = VariableStoreBase;
diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h
index 566e7268d187..fdc92b2b017c 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h
@@ -92,6 +92,7 @@ typedef struct {
   UINT32                ReentrantState;
   BOOLEAN               AuthFormat;
   BOOLEAN               AuthSupport;
+  BOOLEAN               EmuNvMode;
 } VARIABLE_GLOBAL;
 
 typedef struct {
diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
index 5131e6f351e4..7d5c8b3f842d 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
@@ -533,16 +533,23 @@ VariableServiceInitialize (
                   );
   ASSERT_EFI_ERROR (Status);
 
-  //
-  // Register FtwNotificationEvent () notify function.
-  //
-  EfiCreateProtocolNotifyEvent (
-    &gEfiFaultTolerantWriteProtocolGuid,
-    TPL_CALLBACK,
-    FtwNotificationEvent,
-    (VOID *)SystemTable,
-    &mFtwRegistration
-    );
+  if (!PcdGetBool (PcdEmuVariableNvModeEnable)) {
+    //
+    // Register FtwNotificationEvent () notify function.
+    //
+    EfiCreateProtocolNotifyEvent (
+      &gEfiFaultTolerantWriteProtocolGuid,
+      TPL_CALLBACK,
+      FtwNotificationEvent,
+      (VOID *)SystemTable,
+      &mFtwRegistration
+      );
+  } else {
+    //
+    // Emulated non-volatile variable mode does not depend on FVB and FTW.
+    //
+    VariableWriteServiceInitializeDxe ();
+  }
 
   Status = gBS->CreateEventEx (
                   EVT_NOTIFY_SIGNAL,
diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
index 7ef8a97f5d6a..273067753c25 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
@@ -9,7 +9,7 @@
 #  This external input must be validated carefully to avoid security issues such as
 #  buffer overflow or integer overflow.
 #
-# Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
+# Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
 # This program and the accompanying materials
 # are licensed and made available under the terms and conditions of the BSD License
 # which accompanies this distribution. The full text of the license may be found at
@@ -131,6 +131,8 @@ [Pcd]
   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxUserNvVariableSpaceSize           ## CONSUMES
   gEfiMdeModulePkgTokenSpaceGuid.PcdBoottimeReservedNvVariableSpaceSize  ## CONSUMES
   gEfiMdeModulePkgTokenSpaceGuid.PcdReclaimVariableSpaceAtEndOfDxe  ## CONSUMES
+  gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvModeEnable         ## SOMETIMES_CONSUMES
+  gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvStoreReserved      ## SOMETIMES_CONSUMES
 
 [FeaturePcd]
   gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics  ## CONSUMES # statistic the information of variable.
diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c
index e63af812534e..d47493c891e5 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c
@@ -1034,17 +1034,24 @@ VariableServiceInitialize (
                     );
   ASSERT_EFI_ERROR (Status);
 
-  //
-  // Register FtwNotificationEvent () notify function.
-  //
-  Status = gSmst->SmmRegisterProtocolNotify (
-                    &gEfiSmmFaultTolerantWriteProtocolGuid,
-                    SmmFtwNotificationEvent,
-                    &SmmFtwRegistration
-                    );
-  ASSERT_EFI_ERROR (Status);
-
-  SmmFtwNotificationEvent (NULL, NULL, NULL);
+  if (!PcdGetBool (PcdEmuVariableNvModeEnable)) {
+    //
+    // Register FtwNotificationEvent () notify function.
+    //
+    Status = gSmst->SmmRegisterProtocolNotify (
+                      &gEfiSmmFaultTolerantWriteProtocolGuid,
+                      SmmFtwNotificationEvent,
+                      &SmmFtwRegistration
+                      );
+    ASSERT_EFI_ERROR (Status);
+
+    SmmFtwNotificationEvent (NULL, NULL, NULL);
+  } else {
+    //
+    // Emulated non-volatile variable mode does not depend on FVB and FTW.
+    //
+    VariableWriteServiceInitializeSmm ();
+  }
 
   return EFI_SUCCESS;
 }
diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf
index db7d220e06df..30d446d06e0d 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf
@@ -18,7 +18,7 @@
 #  may not be modified without authorization. If platform fails to protect these resources,
 #  the authentication service provided in this driver will be broken, and the behavior is undefined.
 #
-# Copyright (c) 2010 - 2016, Intel Corporation. All rights reserved.<BR>
+# Copyright (c) 2010 - 2019, Intel Corporation. All rights reserved.<BR>
 # This program and the accompanying materials
 # are licensed and made available under the terms and conditions of the BSD License
 # which accompanies this distribution. The full text of the license may be found at
@@ -133,6 +133,8 @@ [Pcd]
   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxUserNvVariableSpaceSize           ## CONSUMES
   gEfiMdeModulePkgTokenSpaceGuid.PcdBoottimeReservedNvVariableSpaceSize  ## CONSUMES
   gEfiMdeModulePkgTokenSpaceGuid.PcdReclaimVariableSpaceAtEndOfDxe   ## CONSUMES
+  gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvModeEnable          ## SOMETIMES_CONSUMES
+  gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvStoreReserved       ## SOMETIMES_CONSUMES
 
 [FeaturePcd]
   gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics        ## CONSUMES  # statistic the information of variable.
-- 
2.7.0.windows.1

Re: [PATCH 06/12] MdeModulePkg Variable: Add emulated variable NV mode support

[Laszlo Ersek]

Hi Star,

On 01/13/19 16:37, Star Zeng wrote:
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1323
> Merge EmuVariable and Real variable driver.
> 
> Add emulated variable NV mode support in real variable driver.
> Platform can configure PcdEmuVariableNvModeEnable statically
> (build time) or dynamically (boot time) to support emulated
> variable NV mode.
> 
> Then EmuVariableRuntimeDxe could be removed, the removal of
> EmuVariableRuntimeDxe will be done after platforms are migrated
> to use the merged variable driver.
> 
> Cc: Jian J Wang <jian.j.wang@intel.com>
> Cc: Hao Wu <hao.a.wu@intel.com>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Liming Gao <liming.gao@intel.com>
> Cc: Ray Ni <ray.ni@intel.com>
> Cc: Laszlo Ersek <lersek@redhat.com>
> Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Star Zeng <star.zeng@intel.com>
> ---
>  .../Universal/Variable/RuntimeDxe/Variable.c       | 319 +++++++++++++++------
>  .../Universal/Variable/RuntimeDxe/Variable.h       |   1 +
>  .../Universal/Variable/RuntimeDxe/VariableDxe.c    |  27 +-
>  .../Variable/RuntimeDxe/VariableRuntimeDxe.inf     |   4 +-
>  .../Universal/Variable/RuntimeDxe/VariableSmm.c    |  29 +-
>  .../Universal/Variable/RuntimeDxe/VariableSmm.inf  |   4 +-
>  6 files changed, 271 insertions(+), 113 deletions(-)

What I did for (briefly) reviewing this patch was the following. I
fetched the branch you noted in the blurb, and the ran

  git show --color -W -b 9b509dea1227

Because, a large part of this patch just re-indents existent code, due
to new conditionals.

My main goal with this review was to see whether "EmuNvMode==FALSE"
would imply that the changes are a "no-op". Because OVMF, and the
non-Xen ArmVirt DSC, will inherit the default FALSE setting for the PCD.
So far, things look fine.

However, I noticed two small things that I believe would improve the
readability of the patch. I suggest that you please split them out to
separate patches, in the "preparation" section of the series. Namely:


> 
> diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
> index 424f92a53757..845276d891ae 100644
> --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
> +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
> @@ -34,6 +34,7 @@ VARIABLE_MODULE_GLOBAL  *mVariableModuleGlobal;
>  
>  ///
>  /// Define a memory cache that improves the search performance for a variable.
> +/// For EmuNvMode == TRUE, it will be equal to NonVolatileVariableBase.
>  ///
>  VARIABLE_STORE_HEADER  *mNvVariableCache      = NULL;
>  
> @@ -273,7 +274,7 @@ UpdateVariableStore (
>    //
>    // Check if the Data is Volatile.
>    //
> -  if (!Volatile) {
> +  if (!Volatile && !mVariableModuleGlobal->VariableGlobal.EmuNvMode) {
>      if (Fvb == NULL) {
>        return EFI_UNSUPPORTED;
>      }
> @@ -296,17 +297,30 @@ UpdateVariableStore (
>      // Data Pointer should point to the actual Address where data is to be
>      // written.
>      //
> -    VolatileBase = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.VolatileVariableBase);
> -    if (SetByIndex) {
> -      DataPtr += mVariableModuleGlobal->VariableGlobal.VolatileVariableBase;
> -    }
> +    if (Volatile) {
> +      VolatileBase = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.VolatileVariableBase);
> +      if (SetByIndex) {
> +        DataPtr += mVariableModuleGlobal->VariableGlobal.VolatileVariableBase;
> +      }
>  
> -    if ((DataPtr + DataSize) > ((UINTN) ((UINT8 *) VolatileBase + VolatileBase->Size))) {
> -      return EFI_OUT_OF_RESOURCES;
> +      if ((DataPtr + DataSize) > ((UINTN) VolatileBase + VolatileBase->Size)) {

(1) Here the "if" statement is not just re-indented, but the controlling
expression is also modified. The change looks OK to me (and I understand
why you were motivated to simplify it); however, it would be better to
split this change to a separate refactoring patch. That patch will be
simple to review in isolation, and in turn it will make this patch
easier to read, especially with "git show -b".

> +        return EFI_OUT_OF_RESOURCES;
> +      }
> +    } else {
> +      //
> +      // Emulated non-volatile variable mode.
> +      //
> +      if (SetByIndex) {
> +        DataPtr += (UINTN) mNvVariableCache;
> +      }
> +
> +      if ((DataPtr + DataSize) > ((UINTN) mNvVariableCache + mNvVariableCache->Size)) {
> +        return EFI_OUT_OF_RESOURCES;
> +      }
>      }
>  
>      //
> -    // If Volatile Variable just do a simple mem copy.
> +    // If Volatile/Emulated Non-volatile Variable just do a simple mem copy.
>      //
>      CopyMem ((UINT8 *)(UINTN)DataPtr, Buffer, DataSize);
>      return EFI_SUCCESS;
> @@ -987,7 +1001,7 @@ Reclaim (
>    CommonUserVariableTotalSize = 0;
>    HwErrVariableTotalSize  = 0;
>  
> -  if (IsVolatile) {
> +  if (IsVolatile || mVariableModuleGlobal->VariableGlobal.EmuNvMode) {
>      //
>      // Start Pointers for the variable.
>      //
> @@ -1155,13 +1169,21 @@ Reclaim (
>      CurrPtr += NewVariableSize;
>    }
>  
> -  if (IsVolatile) {
> +  if (IsVolatile || mVariableModuleGlobal->VariableGlobal.EmuNvMode) {
>      //
> -    // If volatile variable store, just copy valid buffer.
> +    // If volatile/emulated non-volatile variable store, just copy valid buffer.
>      //
>      SetMem ((UINT8 *) (UINTN) VariableBase, VariableStoreHeader->Size, 0xff);
>      CopyMem ((UINT8 *) (UINTN) VariableBase, ValidBuffer, (UINTN) CurrPtr - (UINTN) ValidBuffer);
>      *LastVariableOffset = (UINTN) CurrPtr - (UINTN) ValidBuffer;
> +    if (!IsVolatile) {
> +      //
> +      // Emulated non-volatile variable mode.
> +      //
> +      mVariableModuleGlobal->HwErrVariableTotalSize = HwErrVariableTotalSize;
> +      mVariableModuleGlobal->CommonVariableTotalSize = CommonVariableTotalSize;
> +      mVariableModuleGlobal->CommonUserVariableTotalSize = CommonUserVariableTotalSize;
> +    }
>      Status  = EFI_SUCCESS;
>    } else {
>      //
> @@ -1200,7 +1222,7 @@ Reclaim (
>    }
>  
>  Done:
> -  if (IsVolatile) {
> +  if (IsVolatile || mVariableModuleGlobal->VariableGlobal.EmuNvMode) {
>      FreePool (ValidBuffer);
>    } else {
>      //
> @@ -2139,7 +2161,6 @@ UpdateVariable (
>    VARIABLE_POINTER_TRACK              *Variable;
>    VARIABLE_POINTER_TRACK              NvVariable;
>    VARIABLE_STORE_HEADER               *VariableStoreHeader;
> -  UINTN                               CacheOffset;
>    UINT8                               *BufferForMerge;
>    UINTN                               MergedBufSize;
>    BOOLEAN                             DataReady;
> @@ -2148,7 +2169,7 @@ UpdateVariable (
>    BOOLEAN                             IsCommonUserVariable;
>    AUTHENTICATED_VARIABLE_HEADER       *AuthVariable;
>  
> -  if (mVariableModuleGlobal->FvbInstance == NULL) {
> +  if (mVariableModuleGlobal->FvbInstance == NULL && !mVariableModuleGlobal->VariableGlobal.EmuNvMode) {
>      //
>      // The FVB protocol is not ready, so the EFI_VARIABLE_WRITE_ARCH_PROTOCOL is not installed.
>      //
> @@ -2567,80 +2588,105 @@ UpdateVariable (
>        }
>        goto Done;
>      }
> -    //
> -    // Four steps
> -    // 1. Write variable header
> -    // 2. Set variable state to header valid
> -    // 3. Write variable data
> -    // 4. Set variable state to valid
> -    //
> -    //
> -    // Step 1:
> -    //
> -    CacheOffset = mVariableModuleGlobal->NonVolatileLastVariableOffset;
> -    Status = UpdateVariableStore (
> -               &mVariableModuleGlobal->VariableGlobal,
> -               FALSE,
> -               TRUE,
> -               Fvb,
> -               mVariableModuleGlobal->NonVolatileLastVariableOffset,
> -               (UINT32) GetVariableHeaderSize (),
> -               (UINT8 *) NextVariable
> -               );
>  
> -    if (EFI_ERROR (Status)) {
> -      goto Done;
> -    }
> +    if (!mVariableModuleGlobal->VariableGlobal.EmuNvMode) {
> +      //
> +      // Four steps
> +      // 1. Write variable header
> +      // 2. Set variable state to header valid
> +      // 3. Write variable data
> +      // 4. Set variable state to valid
> +      //
> +      //
> +      // Step 1:
> +      //
> +      Status = UpdateVariableStore (
> +                 &mVariableModuleGlobal->VariableGlobal,
> +                 FALSE,
> +                 TRUE,
> +                 Fvb,
> +                 mVariableModuleGlobal->NonVolatileLastVariableOffset,
> +                 (UINT32) GetVariableHeaderSize (),
> +                 (UINT8 *) NextVariable
> +                 );
>  
> -    //
> -    // Step 2:
> -    //
> -    NextVariable->State = VAR_HEADER_VALID_ONLY;
> -    Status = UpdateVariableStore (
> -               &mVariableModuleGlobal->VariableGlobal,
> -               FALSE,
> -               TRUE,
> -               Fvb,
> -               mVariableModuleGlobal->NonVolatileLastVariableOffset + OFFSET_OF (VARIABLE_HEADER, State),
> -               sizeof (UINT8),
> -               &NextVariable->State
> -               );
> +      if (EFI_ERROR (Status)) {
> +        goto Done;
> +      }
>  
> -    if (EFI_ERROR (Status)) {
> -      goto Done;
> -    }
> -    //
> -    // Step 3:
> -    //
> -    Status = UpdateVariableStore (
> -               &mVariableModuleGlobal->VariableGlobal,
> -               FALSE,
> -               TRUE,
> -               Fvb,
> -               mVariableModuleGlobal->NonVolatileLastVariableOffset + GetVariableHeaderSize (),
> -               (UINT32) (VarSize - GetVariableHeaderSize ()),
> -               (UINT8 *) NextVariable + GetVariableHeaderSize ()
> -               );
> +      //
> +      // Step 2:
> +      //
> +      NextVariable->State = VAR_HEADER_VALID_ONLY;
> +      Status = UpdateVariableStore (
> +                 &mVariableModuleGlobal->VariableGlobal,
> +                 FALSE,
> +                 TRUE,
> +                 Fvb,
> +                 mVariableModuleGlobal->NonVolatileLastVariableOffset + OFFSET_OF (VARIABLE_HEADER, State),
> +                 sizeof (UINT8),
> +                 &NextVariable->State
> +                 );
>  
> -    if (EFI_ERROR (Status)) {
> -      goto Done;
> -    }
> -    //
> -    // Step 4:
> -    //
> -    NextVariable->State = VAR_ADDED;
> -    Status = UpdateVariableStore (
> -               &mVariableModuleGlobal->VariableGlobal,
> -               FALSE,
> -               TRUE,
> -               Fvb,
> -               mVariableModuleGlobal->NonVolatileLastVariableOffset + OFFSET_OF (VARIABLE_HEADER, State),
> -               sizeof (UINT8),
> -               &NextVariable->State
> -               );
> +      if (EFI_ERROR (Status)) {
> +        goto Done;
> +      }
> +      //
> +      // Step 3:
> +      //
> +      Status = UpdateVariableStore (
> +                 &mVariableModuleGlobal->VariableGlobal,
> +                 FALSE,
> +                 TRUE,
> +                 Fvb,
> +                 mVariableModuleGlobal->NonVolatileLastVariableOffset + GetVariableHeaderSize (),
> +                 (UINT32) (VarSize - GetVariableHeaderSize ()),
> +                 (UINT8 *) NextVariable + GetVariableHeaderSize ()
> +                 );
>  
> -    if (EFI_ERROR (Status)) {
> -      goto Done;
> +      if (EFI_ERROR (Status)) {
> +        goto Done;
> +      }
> +      //
> +      // Step 4:
> +      //
> +      NextVariable->State = VAR_ADDED;
> +      Status = UpdateVariableStore (
> +                 &mVariableModuleGlobal->VariableGlobal,
> +                 FALSE,
> +                 TRUE,
> +                 Fvb,
> +                 mVariableModuleGlobal->NonVolatileLastVariableOffset + OFFSET_OF (VARIABLE_HEADER, State),
> +                 sizeof (UINT8),
> +                 &NextVariable->State
> +                 );
> +
> +      if (EFI_ERROR (Status)) {
> +        goto Done;
> +      }
> +
> +      //
> +      // update the memory copy of Flash region.
> +      //
> +      CopyMem ((UINT8 *)mNvVariableCache + mVariableModuleGlobal->NonVolatileLastVariableOffset, (UINT8 *)NextVariable, VarSize);

(2) For this function too, please write a separate "prep" patch, that:

(a) removes the "CacheOffset" variable, and

(b) moves the CopyMem() call that currently uses "CacheOffset" to its
final location -- i.e., just above

  NonVolatileLastVariableOffset += HEADER_ALIGN (VarSize);

-- and final parameter list as well. So that *this* patch need at most
reindent the function call, ultimately.

Again, such a patch should not be hard to review in isolation, and it
will improve the readability of this patch a lot.


In summary, I *think* the current changes are all fine, from the
perspective anyway that I mention at the top; but a reviewer's
confidence is higher if the patch is easier to read.

Thanks,
Laszlo


> +    } else {
> +      //
> +      // Emulated non-volatile variable mode.
> +      //
> +      NextVariable->State = VAR_ADDED;
> +      Status = UpdateVariableStore (
> +                 &mVariableModuleGlobal->VariableGlobal,
> +                 FALSE,
> +                 TRUE,
> +                 Fvb,
> +                 mVariableModuleGlobal->NonVolatileLastVariableOffset,
> +                 (UINT32) VarSize,
> +                 (UINT8 *) NextVariable
> +                 );
> +
> +      if (EFI_ERROR (Status)) {
> +        goto Done;
> +      }
>      }
>  
>      mVariableModuleGlobal->NonVolatileLastVariableOffset += HEADER_ALIGN (VarSize);
> @@ -2653,10 +2699,6 @@ UpdateVariable (
>          mVariableModuleGlobal->CommonUserVariableTotalSize += HEADER_ALIGN (VarSize);
>        }
>      }
> -    //
> -    // update the memory copy of Flash region.
> -    //
> -    CopyMem ((UINT8 *)mNvVariableCache + CacheOffset, (UINT8 *)NextVariable, VarSize);
>    } else {
>      //
>      // Create a volatile variable.
> @@ -3877,6 +3919,93 @@ InitRealNonVolatileVariableStore (
>  }
>  
>  /**
> +  Init emulated non-volatile variable store.
> +
> +  @param[out] VariableStoreBase Output pointer to emulated non-volatile variable store base.
> +
> +  @retval EFI_SUCCESS           Function successfully executed.
> +  @retval EFI_OUT_OF_RESOURCES  Fail to allocate enough memory resource.
> +
> +**/
> +EFI_STATUS
> +InitEmuNonVolatileVariableStore (
> +  EFI_PHYSICAL_ADDRESS  *VariableStoreBase
> +  )
> +{
> +  VARIABLE_STORE_HEADER *VariableStore;
> +  UINT32                VariableStoreLength;
> +  BOOLEAN               FullyInitializeStore;
> +  UINT32                HwErrStorageSize;
> +
> +  FullyInitializeStore = TRUE;
> +
> +  VariableStoreLength = PcdGet32 (PcdVariableStoreSize);
> +  ASSERT (sizeof (VARIABLE_STORE_HEADER) <= VariableStoreLength);
> +
> +  //
> +  // Allocate memory for variable store.
> +  //
> +  if (PcdGet64 (PcdEmuVariableNvStoreReserved) == 0) {
> +    VariableStore = (VARIABLE_STORE_HEADER *) AllocateRuntimePool (VariableStoreLength);
> +    if (VariableStore == NULL) {
> +      return EFI_OUT_OF_RESOURCES;
> +    }
> +  } else {
> +    //
> +    // A memory location has been reserved for the NV variable store.  Certain
> +    // platforms may be able to preserve a memory range across system resets,
> +    // thereby providing better NV variable emulation.
> +    //
> +    VariableStore =
> +      (VARIABLE_STORE_HEADER *)(VOID*)(UINTN)
> +        PcdGet64 (PcdEmuVariableNvStoreReserved);
> +    if ((VariableStore->Size == VariableStoreLength) &&
> +        (CompareGuid (&VariableStore->Signature, &gEfiAuthenticatedVariableGuid) ||
> +         CompareGuid (&VariableStore->Signature, &gEfiVariableGuid)) &&
> +        (VariableStore->Format == VARIABLE_STORE_FORMATTED) &&
> +        (VariableStore->State == VARIABLE_STORE_HEALTHY)) {
> +      DEBUG((
> +        DEBUG_INFO,
> +        "Variable Store reserved at %p appears to be valid\n",
> +        VariableStore
> +        ));
> +      FullyInitializeStore = FALSE;
> +    }
> +  }
> +
> +  if (FullyInitializeStore) {
> +    SetMem (VariableStore, VariableStoreLength, 0xff);
> +    //
> +    // Use gEfiAuthenticatedVariableGuid for potential auth variable support.
> +    //
> +    CopyGuid (&VariableStore->Signature, &gEfiAuthenticatedVariableGuid);
> +    VariableStore->Size       = VariableStoreLength;
> +    VariableStore->Format     = VARIABLE_STORE_FORMATTED;
> +    VariableStore->State      = VARIABLE_STORE_HEALTHY;
> +    VariableStore->Reserved   = 0;
> +    VariableStore->Reserved1  = 0;
> +  }
> +
> +  *VariableStoreBase = (EFI_PHYSICAL_ADDRESS) (UINTN) VariableStore;
> +
> +  HwErrStorageSize = PcdGet32 (PcdHwErrStorageSize);
> +
> +  //
> +  // Note that in EdkII variable driver implementation, Hardware Error Record type variable
> +  // is stored with common variable in the same NV region. So the platform integrator should
> +  // ensure that the value of PcdHwErrStorageSize is less than the value of
> +  // (VariableStoreLength - sizeof (VARIABLE_STORE_HEADER)).
> +  //
> +  ASSERT (HwErrStorageSize < (VariableStoreLength - sizeof (VARIABLE_STORE_HEADER)));
> +
> +  mVariableModuleGlobal->CommonVariableSpace = ((UINTN) VariableStoreLength - sizeof (VARIABLE_STORE_HEADER) - HwErrStorageSize);
> +  mVariableModuleGlobal->CommonMaxUserVariableSpace = mVariableModuleGlobal->CommonVariableSpace;
> +  mVariableModuleGlobal->CommonRuntimeVariableSpace = mVariableModuleGlobal->CommonVariableSpace;
> +
> +  return EFI_SUCCESS;
> +}
> +
> +/**
>    Init non-volatile variable store.
>  
>    @retval EFI_SUCCESS           Function successfully executed.
> @@ -3895,9 +4024,19 @@ InitNonVolatileVariableStore (
>    UINTN                                 VariableSize;
>    EFI_STATUS                            Status;
>  
> -  Status = InitRealNonVolatileVariableStore (&VariableStoreBase);
> -  if (EFI_ERROR (Status)) {
> -    return Status;
> +  if (!PcdGetBool (PcdEmuVariableNvModeEnable)) {
> +    Status = InitRealNonVolatileVariableStore (&VariableStoreBase);
> +    if (EFI_ERROR (Status)) {
> +      return Status;
> +    }
> +    mVariableModuleGlobal->VariableGlobal.EmuNvMode = FALSE;
> +  } else {
> +    Status = InitEmuNonVolatileVariableStore (&VariableStoreBase);
> +    if (EFI_ERROR (Status)) {
> +      return Status;
> +    }
> +    mVariableModuleGlobal->VariableGlobal.EmuNvMode = TRUE;
> +    DEBUG ((DEBUG_INFO, "Variable driver will work at emulated non-volatile variable mode!\n"));
>    }
>  
>    mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase = VariableStoreBase;
> diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h
> index 566e7268d187..fdc92b2b017c 100644
> --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h
> +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h
> @@ -92,6 +92,7 @@ typedef struct {
>    UINT32                ReentrantState;
>    BOOLEAN               AuthFormat;
>    BOOLEAN               AuthSupport;
> +  BOOLEAN               EmuNvMode;
>  } VARIABLE_GLOBAL;
>  
>  typedef struct {
> diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
> index 5131e6f351e4..7d5c8b3f842d 100644
> --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
> +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
> @@ -533,16 +533,23 @@ VariableServiceInitialize (
>                    );
>    ASSERT_EFI_ERROR (Status);
>  
> -  //
> -  // Register FtwNotificationEvent () notify function.
> -  //
> -  EfiCreateProtocolNotifyEvent (
> -    &gEfiFaultTolerantWriteProtocolGuid,
> -    TPL_CALLBACK,
> -    FtwNotificationEvent,
> -    (VOID *)SystemTable,
> -    &mFtwRegistration
> -    );
> +  if (!PcdGetBool (PcdEmuVariableNvModeEnable)) {
> +    //
> +    // Register FtwNotificationEvent () notify function.
> +    //
> +    EfiCreateProtocolNotifyEvent (
> +      &gEfiFaultTolerantWriteProtocolGuid,
> +      TPL_CALLBACK,
> +      FtwNotificationEvent,
> +      (VOID *)SystemTable,
> +      &mFtwRegistration
> +      );
> +  } else {
> +    //
> +    // Emulated non-volatile variable mode does not depend on FVB and FTW.
> +    //
> +    VariableWriteServiceInitializeDxe ();
> +  }
>  
>    Status = gBS->CreateEventEx (
>                    EVT_NOTIFY_SIGNAL,
> diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
> index 7ef8a97f5d6a..273067753c25 100644
> --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
> +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
> @@ -9,7 +9,7 @@
>  #  This external input must be validated carefully to avoid security issues such as
>  #  buffer overflow or integer overflow.
>  #
> -# Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
> +# Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
>  # This program and the accompanying materials
>  # are licensed and made available under the terms and conditions of the BSD License
>  # which accompanies this distribution. The full text of the license may be found at
> @@ -131,6 +131,8 @@ [Pcd]
>    gEfiMdeModulePkgTokenSpaceGuid.PcdMaxUserNvVariableSpaceSize           ## CONSUMES
>    gEfiMdeModulePkgTokenSpaceGuid.PcdBoottimeReservedNvVariableSpaceSize  ## CONSUMES
>    gEfiMdeModulePkgTokenSpaceGuid.PcdReclaimVariableSpaceAtEndOfDxe  ## CONSUMES
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvModeEnable         ## SOMETIMES_CONSUMES
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvStoreReserved      ## SOMETIMES_CONSUMES
>  
>  [FeaturePcd]
>    gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics  ## CONSUMES # statistic the information of variable.
> diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c
> index e63af812534e..d47493c891e5 100644
> --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c
> +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c
> @@ -1034,17 +1034,24 @@ VariableServiceInitialize (
>                      );
>    ASSERT_EFI_ERROR (Status);
>  
> -  //
> -  // Register FtwNotificationEvent () notify function.
> -  //
> -  Status = gSmst->SmmRegisterProtocolNotify (
> -                    &gEfiSmmFaultTolerantWriteProtocolGuid,
> -                    SmmFtwNotificationEvent,
> -                    &SmmFtwRegistration
> -                    );
> -  ASSERT_EFI_ERROR (Status);
> -
> -  SmmFtwNotificationEvent (NULL, NULL, NULL);
> +  if (!PcdGetBool (PcdEmuVariableNvModeEnable)) {
> +    //
> +    // Register FtwNotificationEvent () notify function.
> +    //
> +    Status = gSmst->SmmRegisterProtocolNotify (
> +                      &gEfiSmmFaultTolerantWriteProtocolGuid,
> +                      SmmFtwNotificationEvent,
> +                      &SmmFtwRegistration
> +                      );
> +    ASSERT_EFI_ERROR (Status);
> +
> +    SmmFtwNotificationEvent (NULL, NULL, NULL);
> +  } else {
> +    //
> +    // Emulated non-volatile variable mode does not depend on FVB and FTW.
> +    //
> +    VariableWriteServiceInitializeSmm ();
> +  }
>  
>    return EFI_SUCCESS;
>  }
> diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf
> index db7d220e06df..30d446d06e0d 100644
> --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf
> +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf
> @@ -18,7 +18,7 @@
>  #  may not be modified without authorization. If platform fails to protect these resources,
>  #  the authentication service provided in this driver will be broken, and the behavior is undefined.
>  #
> -# Copyright (c) 2010 - 2016, Intel Corporation. All rights reserved.<BR>
> +# Copyright (c) 2010 - 2019, Intel Corporation. All rights reserved.<BR>
>  # This program and the accompanying materials
>  # are licensed and made available under the terms and conditions of the BSD License
>  # which accompanies this distribution. The full text of the license may be found at
> @@ -133,6 +133,8 @@ [Pcd]
>    gEfiMdeModulePkgTokenSpaceGuid.PcdMaxUserNvVariableSpaceSize           ## CONSUMES
>    gEfiMdeModulePkgTokenSpaceGuid.PcdBoottimeReservedNvVariableSpaceSize  ## CONSUMES
>    gEfiMdeModulePkgTokenSpaceGuid.PcdReclaimVariableSpaceAtEndOfDxe   ## CONSUMES
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvModeEnable          ## SOMETIMES_CONSUMES
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvStoreReserved       ## SOMETIMES_CONSUMES
>  
>  [FeaturePcd]
>    gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics        ## CONSUMES  # statistic the information of variable.
> 

Re: [PATCH 06/12] MdeModulePkg Variable: Add emulated variable NV mode support

[Zeng, Star]

Hi Laszlo,

Yes, agree with the suggestions.
Two patches have been separated from this patch in V2 patch series at 
https://lists.01.org/pipermail/edk2-devel/2019-January/035015.html.


Thanks,
Star

On 2019/1/14 18:57, Laszlo Ersek wrote:
> Hi Star,
> 
> On 01/13/19 16:37, Star Zeng wrote:
>> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1323
>> Merge EmuVariable and Real variable driver.
>>
>> Add emulated variable NV mode support in real variable driver.
>> Platform can configure PcdEmuVariableNvModeEnable statically
>> (build time) or dynamically (boot time) to support emulated
>> variable NV mode.
>>
>> Then EmuVariableRuntimeDxe could be removed, the removal of
>> EmuVariableRuntimeDxe will be done after platforms are migrated
>> to use the merged variable driver.
>>
>> Cc: Jian J Wang <jian.j.wang@intel.com>
>> Cc: Hao Wu <hao.a.wu@intel.com>
>> Cc: Michael D Kinney <michael.d.kinney@intel.com>
>> Cc: Liming Gao <liming.gao@intel.com>
>> Cc: Ray Ni <ray.ni@intel.com>
>> Cc: Laszlo Ersek <lersek@redhat.com>
>> Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
>> Contributed-under: TianoCore Contribution Agreement 1.1
>> Signed-off-by: Star Zeng <star.zeng@intel.com>
>> ---
>>   .../Universal/Variable/RuntimeDxe/Variable.c       | 319 +++++++++++++++------
>>   .../Universal/Variable/RuntimeDxe/Variable.h       |   1 +
>>   .../Universal/Variable/RuntimeDxe/VariableDxe.c    |  27 +-
>>   .../Variable/RuntimeDxe/VariableRuntimeDxe.inf     |   4 +-
>>   .../Universal/Variable/RuntimeDxe/VariableSmm.c    |  29 +-
>>   .../Universal/Variable/RuntimeDxe/VariableSmm.inf  |   4 +-
>>   6 files changed, 271 insertions(+), 113 deletions(-)
> 
> What I did for (briefly) reviewing this patch was the following. I
> fetched the branch you noted in the blurb, and the ran
> 
>    git show --color -W -b 9b509dea1227
> 
> Because, a large part of this patch just re-indents existent code, due
> to new conditionals.
> 
> My main goal with this review was to see whether "EmuNvMode==FALSE"
> would imply that the changes are a "no-op". Because OVMF, and the
> non-Xen ArmVirt DSC, will inherit the default FALSE setting for the PCD.
> So far, things look fine.
> 
> However, I noticed two small things that I believe would improve the
> readability of the patch. I suggest that you please split them out to
> separate patches, in the "preparation" section of the series. Namely:
> 
> 
>>
>> diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
>> index 424f92a53757..845276d891ae 100644
>> --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
>> +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
>> @@ -34,6 +34,7 @@ VARIABLE_MODULE_GLOBAL  *mVariableModuleGlobal;
>>   
>>   ///
>>   /// Define a memory cache that improves the search performance for a variable.
>> +/// For EmuNvMode == TRUE, it will be equal to NonVolatileVariableBase.
>>   ///
>>   VARIABLE_STORE_HEADER  *mNvVariableCache      = NULL;
>>   
>> @@ -273,7 +274,7 @@ UpdateVariableStore (
>>     //
>>     // Check if the Data is Volatile.
>>     //
>> -  if (!Volatile) {
>> +  if (!Volatile && !mVariableModuleGlobal->VariableGlobal.EmuNvMode) {
>>       if (Fvb == NULL) {
>>         return EFI_UNSUPPORTED;
>>       }
>> @@ -296,17 +297,30 @@ UpdateVariableStore (
>>       // Data Pointer should point to the actual Address where data is to be
>>       // written.
>>       //
>> -    VolatileBase = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.VolatileVariableBase);
>> -    if (SetByIndex) {
>> -      DataPtr += mVariableModuleGlobal->VariableGlobal.VolatileVariableBase;
>> -    }
>> +    if (Volatile) {
>> +      VolatileBase = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.VolatileVariableBase);
>> +      if (SetByIndex) {
>> +        DataPtr += mVariableModuleGlobal->VariableGlobal.VolatileVariableBase;
>> +      }
>>   
>> -    if ((DataPtr + DataSize) > ((UINTN) ((UINT8 *) VolatileBase + VolatileBase->Size))) {
>> -      return EFI_OUT_OF_RESOURCES;
>> +      if ((DataPtr + DataSize) > ((UINTN) VolatileBase + VolatileBase->Size)) {
> 
> (1) Here the "if" statement is not just re-indented, but the controlling
> expression is also modified. The change looks OK to me (and I understand
> why you were motivated to simplify it); however, it would be better to
> split this change to a separate refactoring patch. That patch will be
> simple to review in isolation, and in turn it will make this patch
> easier to read, especially with "git show -b".
> 
>> +        return EFI_OUT_OF_RESOURCES;
>> +      }
>> +    } else {
>> +      //
>> +      // Emulated non-volatile variable mode.
>> +      //
>> +      if (SetByIndex) {
>> +        DataPtr += (UINTN) mNvVariableCache;
>> +      }
>> +
>> +      if ((DataPtr + DataSize) > ((UINTN) mNvVariableCache + mNvVariableCache->Size)) {
>> +        return EFI_OUT_OF_RESOURCES;
>> +      }
>>       }
>>   
>>       //
>> -    // If Volatile Variable just do a simple mem copy.
>> +    // If Volatile/Emulated Non-volatile Variable just do a simple mem copy.
>>       //
>>       CopyMem ((UINT8 *)(UINTN)DataPtr, Buffer, DataSize);
>>       return EFI_SUCCESS;
>> @@ -987,7 +1001,7 @@ Reclaim (
>>     CommonUserVariableTotalSize = 0;
>>     HwErrVariableTotalSize  = 0;
>>   
>> -  if (IsVolatile) {
>> +  if (IsVolatile || mVariableModuleGlobal->VariableGlobal.EmuNvMode) {
>>       //
>>       // Start Pointers for the variable.
>>       //
>> @@ -1155,13 +1169,21 @@ Reclaim (
>>       CurrPtr += NewVariableSize;
>>     }
>>   
>> -  if (IsVolatile) {
>> +  if (IsVolatile || mVariableModuleGlobal->VariableGlobal.EmuNvMode) {
>>       //
>> -    // If volatile variable store, just copy valid buffer.
>> +    // If volatile/emulated non-volatile variable store, just copy valid buffer.
>>       //
>>       SetMem ((UINT8 *) (UINTN) VariableBase, VariableStoreHeader->Size, 0xff);
>>       CopyMem ((UINT8 *) (UINTN) VariableBase, ValidBuffer, (UINTN) CurrPtr - (UINTN) ValidBuffer);
>>       *LastVariableOffset = (UINTN) CurrPtr - (UINTN) ValidBuffer;
>> +    if (!IsVolatile) {
>> +      //
>> +      // Emulated non-volatile variable mode.
>> +      //
>> +      mVariableModuleGlobal->HwErrVariableTotalSize = HwErrVariableTotalSize;
>> +      mVariableModuleGlobal->CommonVariableTotalSize = CommonVariableTotalSize;
>> +      mVariableModuleGlobal->CommonUserVariableTotalSize = CommonUserVariableTotalSize;
>> +    }
>>       Status  = EFI_SUCCESS;
>>     } else {
>>       //
>> @@ -1200,7 +1222,7 @@ Reclaim (
>>     }
>>   
>>   Done:
>> -  if (IsVolatile) {
>> +  if (IsVolatile || mVariableModuleGlobal->VariableGlobal.EmuNvMode) {
>>       FreePool (ValidBuffer);
>>     } else {
>>       //
>> @@ -2139,7 +2161,6 @@ UpdateVariable (
>>     VARIABLE_POINTER_TRACK              *Variable;
>>     VARIABLE_POINTER_TRACK              NvVariable;
>>     VARIABLE_STORE_HEADER               *VariableStoreHeader;
>> -  UINTN                               CacheOffset;
>>     UINT8                               *BufferForMerge;
>>     UINTN                               MergedBufSize;
>>     BOOLEAN                             DataReady;
>> @@ -2148,7 +2169,7 @@ UpdateVariable (
>>     BOOLEAN                             IsCommonUserVariable;
>>     AUTHENTICATED_VARIABLE_HEADER       *AuthVariable;
>>   
>> -  if (mVariableModuleGlobal->FvbInstance == NULL) {
>> +  if (mVariableModuleGlobal->FvbInstance == NULL && !mVariableModuleGlobal->VariableGlobal.EmuNvMode) {
>>       //
>>       // The FVB protocol is not ready, so the EFI_VARIABLE_WRITE_ARCH_PROTOCOL is not installed.
>>       //
>> @@ -2567,80 +2588,105 @@ UpdateVariable (
>>         }
>>         goto Done;
>>       }
>> -    //
>> -    // Four steps
>> -    // 1. Write variable header
>> -    // 2. Set variable state to header valid
>> -    // 3. Write variable data
>> -    // 4. Set variable state to valid
>> -    //
>> -    //
>> -    // Step 1:
>> -    //
>> -    CacheOffset = mVariableModuleGlobal->NonVolatileLastVariableOffset;
>> -    Status = UpdateVariableStore (
>> -               &mVariableModuleGlobal->VariableGlobal,
>> -               FALSE,
>> -               TRUE,
>> -               Fvb,
>> -               mVariableModuleGlobal->NonVolatileLastVariableOffset,
>> -               (UINT32) GetVariableHeaderSize (),
>> -               (UINT8 *) NextVariable
>> -               );
>>   
>> -    if (EFI_ERROR (Status)) {
>> -      goto Done;
>> -    }
>> +    if (!mVariableModuleGlobal->VariableGlobal.EmuNvMode) {
>> +      //
>> +      // Four steps
>> +      // 1. Write variable header
>> +      // 2. Set variable state to header valid
>> +      // 3. Write variable data
>> +      // 4. Set variable state to valid
>> +      //
>> +      //
>> +      // Step 1:
>> +      //
>> +      Status = UpdateVariableStore (
>> +                 &mVariableModuleGlobal->VariableGlobal,
>> +                 FALSE,
>> +                 TRUE,
>> +                 Fvb,
>> +                 mVariableModuleGlobal->NonVolatileLastVariableOffset,
>> +                 (UINT32) GetVariableHeaderSize (),
>> +                 (UINT8 *) NextVariable
>> +                 );
>>   
>> -    //
>> -    // Step 2:
>> -    //
>> -    NextVariable->State = VAR_HEADER_VALID_ONLY;
>> -    Status = UpdateVariableStore (
>> -               &mVariableModuleGlobal->VariableGlobal,
>> -               FALSE,
>> -               TRUE,
>> -               Fvb,
>> -               mVariableModuleGlobal->NonVolatileLastVariableOffset + OFFSET_OF (VARIABLE_HEADER, State),
>> -               sizeof (UINT8),
>> -               &NextVariable->State
>> -               );
>> +      if (EFI_ERROR (Status)) {
>> +        goto Done;
>> +      }
>>   
>> -    if (EFI_ERROR (Status)) {
>> -      goto Done;
>> -    }
>> -    //
>> -    // Step 3:
>> -    //
>> -    Status = UpdateVariableStore (
>> -               &mVariableModuleGlobal->VariableGlobal,
>> -               FALSE,
>> -               TRUE,
>> -               Fvb,
>> -               mVariableModuleGlobal->NonVolatileLastVariableOffset + GetVariableHeaderSize (),
>> -               (UINT32) (VarSize - GetVariableHeaderSize ()),
>> -               (UINT8 *) NextVariable + GetVariableHeaderSize ()
>> -               );
>> +      //
>> +      // Step 2:
>> +      //
>> +      NextVariable->State = VAR_HEADER_VALID_ONLY;
>> +      Status = UpdateVariableStore (
>> +                 &mVariableModuleGlobal->VariableGlobal,
>> +                 FALSE,
>> +                 TRUE,
>> +                 Fvb,
>> +                 mVariableModuleGlobal->NonVolatileLastVariableOffset + OFFSET_OF (VARIABLE_HEADER, State),
>> +                 sizeof (UINT8),
>> +                 &NextVariable->State
>> +                 );
>>   
>> -    if (EFI_ERROR (Status)) {
>> -      goto Done;
>> -    }
>> -    //
>> -    // Step 4:
>> -    //
>> -    NextVariable->State = VAR_ADDED;
>> -    Status = UpdateVariableStore (
>> -               &mVariableModuleGlobal->VariableGlobal,
>> -               FALSE,
>> -               TRUE,
>> -               Fvb,
>> -               mVariableModuleGlobal->NonVolatileLastVariableOffset + OFFSET_OF (VARIABLE_HEADER, State),
>> -               sizeof (UINT8),
>> -               &NextVariable->State
>> -               );
>> +      if (EFI_ERROR (Status)) {
>> +        goto Done;
>> +      }
>> +      //
>> +      // Step 3:
>> +      //
>> +      Status = UpdateVariableStore (
>> +                 &mVariableModuleGlobal->VariableGlobal,
>> +                 FALSE,
>> +                 TRUE,
>> +                 Fvb,
>> +                 mVariableModuleGlobal->NonVolatileLastVariableOffset + GetVariableHeaderSize (),
>> +                 (UINT32) (VarSize - GetVariableHeaderSize ()),
>> +                 (UINT8 *) NextVariable + GetVariableHeaderSize ()
>> +                 );
>>   
>> -    if (EFI_ERROR (Status)) {
>> -      goto Done;
>> +      if (EFI_ERROR (Status)) {
>> +        goto Done;
>> +      }
>> +      //
>> +      // Step 4:
>> +      //
>> +      NextVariable->State = VAR_ADDED;
>> +      Status = UpdateVariableStore (
>> +                 &mVariableModuleGlobal->VariableGlobal,
>> +                 FALSE,
>> +                 TRUE,
>> +                 Fvb,
>> +                 mVariableModuleGlobal->NonVolatileLastVariableOffset + OFFSET_OF (VARIABLE_HEADER, State),
>> +                 sizeof (UINT8),
>> +                 &NextVariable->State
>> +                 );
>> +
>> +      if (EFI_ERROR (Status)) {
>> +        goto Done;
>> +      }
>> +
>> +      //
>> +      // update the memory copy of Flash region.
>> +      //
>> +      CopyMem ((UINT8 *)mNvVariableCache + mVariableModuleGlobal->NonVolatileLastVariableOffset, (UINT8 *)NextVariable, VarSize);
> 
> (2) For this function too, please write a separate "prep" patch, that:
> 
> (a) removes the "CacheOffset" variable, and
> 
> (b) moves the CopyMem() call that currently uses "CacheOffset" to its
> final location -- i.e., just above
> 
>    NonVolatileLastVariableOffset += HEADER_ALIGN (VarSize);
> 
> -- and final parameter list as well. So that *this* patch need at most
> reindent the function call, ultimately.
> 
> Again, such a patch should not be hard to review in isolation, and it
> will improve the readability of this patch a lot.
> 
> 
> In summary, I *think* the current changes are all fine, from the
> perspective anyway that I mention at the top; but a reviewer's
> confidence is higher if the patch is easier to read.
> 
> Thanks,
> Laszlo
> 
> 
>> +    } else {
>> +      //
>> +      // Emulated non-volatile variable mode.
>> +      //
>> +      NextVariable->State = VAR_ADDED;
>> +      Status = UpdateVariableStore (
>> +                 &mVariableModuleGlobal->VariableGlobal,
>> +                 FALSE,
>> +                 TRUE,
>> +                 Fvb,
>> +                 mVariableModuleGlobal->NonVolatileLastVariableOffset,
>> +                 (UINT32) VarSize,
>> +                 (UINT8 *) NextVariable
>> +                 );
>> +
>> +      if (EFI_ERROR (Status)) {
>> +        goto Done;
>> +      }
>>       }
>>   
>>       mVariableModuleGlobal->NonVolatileLastVariableOffset += HEADER_ALIGN (VarSize);
>> @@ -2653,10 +2699,6 @@ UpdateVariable (
>>           mVariableModuleGlobal->CommonUserVariableTotalSize += HEADER_ALIGN (VarSize);
>>         }
>>       }
>> -    //
>> -    // update the memory copy of Flash region.
>> -    //
>> -    CopyMem ((UINT8 *)mNvVariableCache + CacheOffset, (UINT8 *)NextVariable, VarSize);
>>     } else {
>>       //
>>       // Create a volatile variable.
>> @@ -3877,6 +3919,93 @@ InitRealNonVolatileVariableStore (
>>   }
>>   
>>   /**
>> +  Init emulated non-volatile variable store.
>> +
>> +  @param[out] VariableStoreBase Output pointer to emulated non-volatile variable store base.
>> +
>> +  @retval EFI_SUCCESS           Function successfully executed.
>> +  @retval EFI_OUT_OF_RESOURCES  Fail to allocate enough memory resource.
>> +
>> +**/
>> +EFI_STATUS
>> +InitEmuNonVolatileVariableStore (
>> +  EFI_PHYSICAL_ADDRESS  *VariableStoreBase
>> +  )
>> +{
>> +  VARIABLE_STORE_HEADER *VariableStore;
>> +  UINT32                VariableStoreLength;
>> +  BOOLEAN               FullyInitializeStore;
>> +  UINT32                HwErrStorageSize;
>> +
>> +  FullyInitializeStore = TRUE;
>> +
>> +  VariableStoreLength = PcdGet32 (PcdVariableStoreSize);
>> +  ASSERT (sizeof (VARIABLE_STORE_HEADER) <= VariableStoreLength);
>> +
>> +  //
>> +  // Allocate memory for variable store.
>> +  //
>> +  if (PcdGet64 (PcdEmuVariableNvStoreReserved) == 0) {
>> +    VariableStore = (VARIABLE_STORE_HEADER *) AllocateRuntimePool (VariableStoreLength);
>> +    if (VariableStore == NULL) {
>> +      return EFI_OUT_OF_RESOURCES;
>> +    }
>> +  } else {
>> +    //
>> +    // A memory location has been reserved for the NV variable store.  Certain
>> +    // platforms may be able to preserve a memory range across system resets,
>> +    // thereby providing better NV variable emulation.
>> +    //
>> +    VariableStore =
>> +      (VARIABLE_STORE_HEADER *)(VOID*)(UINTN)
>> +        PcdGet64 (PcdEmuVariableNvStoreReserved);
>> +    if ((VariableStore->Size == VariableStoreLength) &&
>> +        (CompareGuid (&VariableStore->Signature, &gEfiAuthenticatedVariableGuid) ||
>> +         CompareGuid (&VariableStore->Signature, &gEfiVariableGuid)) &&
>> +        (VariableStore->Format == VARIABLE_STORE_FORMATTED) &&
>> +        (VariableStore->State == VARIABLE_STORE_HEALTHY)) {
>> +      DEBUG((
>> +        DEBUG_INFO,
>> +        "Variable Store reserved at %p appears to be valid\n",
>> +        VariableStore
>> +        ));
>> +      FullyInitializeStore = FALSE;
>> +    }
>> +  }
>> +
>> +  if (FullyInitializeStore) {
>> +    SetMem (VariableStore, VariableStoreLength, 0xff);
>> +    //
>> +    // Use gEfiAuthenticatedVariableGuid for potential auth variable support.
>> +    //
>> +    CopyGuid (&VariableStore->Signature, &gEfiAuthenticatedVariableGuid);
>> +    VariableStore->Size       = VariableStoreLength;
>> +    VariableStore->Format     = VARIABLE_STORE_FORMATTED;
>> +    VariableStore->State      = VARIABLE_STORE_HEALTHY;
>> +    VariableStore->Reserved   = 0;
>> +    VariableStore->Reserved1  = 0;
>> +  }
>> +
>> +  *VariableStoreBase = (EFI_PHYSICAL_ADDRESS) (UINTN) VariableStore;
>> +
>> +  HwErrStorageSize = PcdGet32 (PcdHwErrStorageSize);
>> +
>> +  //
>> +  // Note that in EdkII variable driver implementation, Hardware Error Record type variable
>> +  // is stored with common variable in the same NV region. So the platform integrator should
>> +  // ensure that the value of PcdHwErrStorageSize is less than the value of
>> +  // (VariableStoreLength - sizeof (VARIABLE_STORE_HEADER)).
>> +  //
>> +  ASSERT (HwErrStorageSize < (VariableStoreLength - sizeof (VARIABLE_STORE_HEADER)));
>> +
>> +  mVariableModuleGlobal->CommonVariableSpace = ((UINTN) VariableStoreLength - sizeof (VARIABLE_STORE_HEADER) - HwErrStorageSize);
>> +  mVariableModuleGlobal->CommonMaxUserVariableSpace = mVariableModuleGlobal->CommonVariableSpace;
>> +  mVariableModuleGlobal->CommonRuntimeVariableSpace = mVariableModuleGlobal->CommonVariableSpace;
>> +
>> +  return EFI_SUCCESS;
>> +}
>> +
>> +/**
>>     Init non-volatile variable store.
>>   
>>     @retval EFI_SUCCESS           Function successfully executed.
>> @@ -3895,9 +4024,19 @@ InitNonVolatileVariableStore (
>>     UINTN                                 VariableSize;
>>     EFI_STATUS                            Status;
>>   
>> -  Status = InitRealNonVolatileVariableStore (&VariableStoreBase);
>> -  if (EFI_ERROR (Status)) {
>> -    return Status;
>> +  if (!PcdGetBool (PcdEmuVariableNvModeEnable)) {
>> +    Status = InitRealNonVolatileVariableStore (&VariableStoreBase);
>> +    if (EFI_ERROR (Status)) {
>> +      return Status;
>> +    }
>> +    mVariableModuleGlobal->VariableGlobal.EmuNvMode = FALSE;
>> +  } else {
>> +    Status = InitEmuNonVolatileVariableStore (&VariableStoreBase);
>> +    if (EFI_ERROR (Status)) {
>> +      return Status;
>> +    }
>> +    mVariableModuleGlobal->VariableGlobal.EmuNvMode = TRUE;
>> +    DEBUG ((DEBUG_INFO, "Variable driver will work at emulated non-volatile variable mode!\n"));
>>     }
>>   
>>     mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase = VariableStoreBase;
>> diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h
>> index 566e7268d187..fdc92b2b017c 100644
>> --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h
>> +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h
>> @@ -92,6 +92,7 @@ typedef struct {
>>     UINT32                ReentrantState;
>>     BOOLEAN               AuthFormat;
>>     BOOLEAN               AuthSupport;
>> +  BOOLEAN               EmuNvMode;
>>   } VARIABLE_GLOBAL;
>>   
>>   typedef struct {
>> diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
>> index 5131e6f351e4..7d5c8b3f842d 100644
>> --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
>> +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
>> @@ -533,16 +533,23 @@ VariableServiceInitialize (
>>                     );
>>     ASSERT_EFI_ERROR (Status);
>>   
>> -  //
>> -  // Register FtwNotificationEvent () notify function.
>> -  //
>> -  EfiCreateProtocolNotifyEvent (
>> -    &gEfiFaultTolerantWriteProtocolGuid,
>> -    TPL_CALLBACK,
>> -    FtwNotificationEvent,
>> -    (VOID *)SystemTable,
>> -    &mFtwRegistration
>> -    );
>> +  if (!PcdGetBool (PcdEmuVariableNvModeEnable)) {
>> +    //
>> +    // Register FtwNotificationEvent () notify function.
>> +    //
>> +    EfiCreateProtocolNotifyEvent (
>> +      &gEfiFaultTolerantWriteProtocolGuid,
>> +      TPL_CALLBACK,
>> +      FtwNotificationEvent,
>> +      (VOID *)SystemTable,
>> +      &mFtwRegistration
>> +      );
>> +  } else {
>> +    //
>> +    // Emulated non-volatile variable mode does not depend on FVB and FTW.
>> +    //
>> +    VariableWriteServiceInitializeDxe ();
>> +  }
>>   
>>     Status = gBS->CreateEventEx (
>>                     EVT_NOTIFY_SIGNAL,
>> diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
>> index 7ef8a97f5d6a..273067753c25 100644
>> --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
>> +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
>> @@ -9,7 +9,7 @@
>>   #  This external input must be validated carefully to avoid security issues such as
>>   #  buffer overflow or integer overflow.
>>   #
>> -# Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
>> +# Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
>>   # This program and the accompanying materials
>>   # are licensed and made available under the terms and conditions of the BSD License
>>   # which accompanies this distribution. The full text of the license may be found at
>> @@ -131,6 +131,8 @@ [Pcd]
>>     gEfiMdeModulePkgTokenSpaceGuid.PcdMaxUserNvVariableSpaceSize           ## CONSUMES
>>     gEfiMdeModulePkgTokenSpaceGuid.PcdBoottimeReservedNvVariableSpaceSize  ## CONSUMES
>>     gEfiMdeModulePkgTokenSpaceGuid.PcdReclaimVariableSpaceAtEndOfDxe  ## CONSUMES
>> +  gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvModeEnable         ## SOMETIMES_CONSUMES
>> +  gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvStoreReserved      ## SOMETIMES_CONSUMES
>>   
>>   [FeaturePcd]
>>     gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics  ## CONSUMES # statistic the information of variable.
>> diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c
>> index e63af812534e..d47493c891e5 100644
>> --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c
>> +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c
>> @@ -1034,17 +1034,24 @@ VariableServiceInitialize (
>>                       );
>>     ASSERT_EFI_ERROR (Status);
>>   
>> -  //
>> -  // Register FtwNotificationEvent () notify function.
>> -  //
>> -  Status = gSmst->SmmRegisterProtocolNotify (
>> -                    &gEfiSmmFaultTolerantWriteProtocolGuid,
>> -                    SmmFtwNotificationEvent,
>> -                    &SmmFtwRegistration
>> -                    );
>> -  ASSERT_EFI_ERROR (Status);
>> -
>> -  SmmFtwNotificationEvent (NULL, NULL, NULL);
>> +  if (!PcdGetBool (PcdEmuVariableNvModeEnable)) {
>> +    //
>> +    // Register FtwNotificationEvent () notify function.
>> +    //
>> +    Status = gSmst->SmmRegisterProtocolNotify (
>> +                      &gEfiSmmFaultTolerantWriteProtocolGuid,
>> +                      SmmFtwNotificationEvent,
>> +                      &SmmFtwRegistration
>> +                      );
>> +    ASSERT_EFI_ERROR (Status);
>> +
>> +    SmmFtwNotificationEvent (NULL, NULL, NULL);
>> +  } else {
>> +    //
>> +    // Emulated non-volatile variable mode does not depend on FVB and FTW.
>> +    //
>> +    VariableWriteServiceInitializeSmm ();
>> +  }
>>   
>>     return EFI_SUCCESS;
>>   }
>> diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf
>> index db7d220e06df..30d446d06e0d 100644
>> --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf
>> +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf
>> @@ -18,7 +18,7 @@
>>   #  may not be modified without authorization. If platform fails to protect these resources,
>>   #  the authentication service provided in this driver will be broken, and the behavior is undefined.
>>   #
>> -# Copyright (c) 2010 - 2016, Intel Corporation. All rights reserved.<BR>
>> +# Copyright (c) 2010 - 2019, Intel Corporation. All rights reserved.<BR>
>>   # This program and the accompanying materials
>>   # are licensed and made available under the terms and conditions of the BSD License
>>   # which accompanies this distribution. The full text of the license may be found at
>> @@ -133,6 +133,8 @@ [Pcd]
>>     gEfiMdeModulePkgTokenSpaceGuid.PcdMaxUserNvVariableSpaceSize           ## CONSUMES
>>     gEfiMdeModulePkgTokenSpaceGuid.PcdBoottimeReservedNvVariableSpaceSize  ## CONSUMES
>>     gEfiMdeModulePkgTokenSpaceGuid.PcdReclaimVariableSpaceAtEndOfDxe   ## CONSUMES
>> +  gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvModeEnable          ## SOMETIMES_CONSUMES
>> +  gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvStoreReserved       ## SOMETIMES_CONSUMES
>>   
>>   [FeaturePcd]
>>     gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics        ## CONSUMES  # statistic the information of variable.
>>

[PATCH 07/12] MdeModulePkg VariablePei: Don't check BOOT_IN_RECOVERY_MODE

[Star Zeng]

Don't check BOOT_IN_RECOVERY_MODE, but check PcdEmuVariableNvModeEnable
which platform can configure flexibly.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Hao Wu <hao.a.wu@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Star Zeng <star.zeng@intel.com>
---
 MdeModulePkg/Universal/Variable/Pei/Variable.c      | 8 +++++---
 MdeModulePkg/Universal/Variable/Pei/VariablePei.inf | 3 ++-
 2 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/MdeModulePkg/Universal/Variable/Pei/Variable.c b/MdeModulePkg/Universal/Variable/Pei/Variable.c
index 77b3eaeb210d..148c1cfefd90 100644
--- a/MdeModulePkg/Universal/Variable/Pei/Variable.c
+++ b/MdeModulePkg/Universal/Variable/Pei/Variable.c
@@ -2,7 +2,7 @@
   Implement ReadOnly Variable Services required by PEIM and install
   PEI ReadOnly Varaiable2 PPI. These services operates the non volatile storage space.
 
-Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
 This program and the accompanying materials
 are licensed and made available under the terms and conditions of the BSD License
 which accompanies this distribution.  The full text of the license may be found at
@@ -584,9 +584,9 @@ GetVariableStore (
       break;
 
     case VariableStoreTypeNv:
-      if (GetBootModeHob () != BOOT_IN_RECOVERY_MODE) {
+      if (!PcdGetBool (PcdEmuVariableNvModeEnable)) {
         //
-        // The content of NV storage for variable is not reliable in recovery boot mode.
+        // Emulated non-volatile variable mode is not enabled.
         //
 
         NvStorageSize = PcdGet32 (PcdFlashNvStorageVariableSize);
@@ -594,6 +594,8 @@ GetVariableStore (
                                                 PcdGet64 (PcdFlashNvStorageVariableBase64) :
                                                 PcdGet32 (PcdFlashNvStorageVariableBase)
                                                );
+        ASSERT (NvStorageBase != 0);
+
         //
         // First let FvHeader point to NV storage base.
         //
diff --git a/MdeModulePkg/Universal/Variable/Pei/VariablePei.inf b/MdeModulePkg/Universal/Variable/Pei/VariablePei.inf
index 565efdc02116..3161617a56c2 100644
--- a/MdeModulePkg/Universal/Variable/Pei/VariablePei.inf
+++ b/MdeModulePkg/Universal/Variable/Pei/VariablePei.inf
@@ -3,7 +3,7 @@
 #
 #  This module implements ReadOnly Variable Services required by PEIM and installs PEI ReadOnly Varaiable2 PPI.
 #
-#  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
+#  Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
 #  This program and the accompanying materials
 #  are licensed and made available under the terms and conditions of the BSD License
 #  which accompanies this distribution. The full text of the license may be found at
@@ -68,6 +68,7 @@ [Pcd]
   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase      ## SOMETIMES_CONSUMES
   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase64    ## CONSUMES
   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize      ## CONSUMES
+  gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvModeEnable         ## SOMETIMES_CONSUMES
 
 [Depex]
   gEdkiiFaultTolerantWriteGuid
-- 
2.7.0.windows.1

[PATCH 08/12] ArmVirtXen: Use merged variable driver for emulated NV mode

[Star Zeng]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1323
Merge EmuVariable and Real variable driver.

The real variable driver has been updated to support emulated
variable NV mode and the EmuVariableRuntimeDxe will be removed
later, so use merged variable driver for emulated NV mode.

Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Star Zeng <star.zeng@intel.com>
---
 ArmVirtPkg/ArmVirtXen.dsc | 11 +++++++++--
 ArmVirtPkg/ArmVirtXen.fdf |  4 ++--
 2 files changed, 11 insertions(+), 4 deletions(-)

diff --git a/ArmVirtPkg/ArmVirtXen.dsc b/ArmVirtPkg/ArmVirtXen.dsc
index a29d8a4ae717..126782372a58 100644
--- a/ArmVirtPkg/ArmVirtXen.dsc
+++ b/ArmVirtPkg/ArmVirtXen.dsc
@@ -1,7 +1,7 @@
 #
 #  Copyright (c) 2011-2015, ARM Limited. All rights reserved.
 #  Copyright (c) 2014, Linaro Limited. All rights reserved.
-#  Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>
+#  Copyright (c) 2015 - 2019, Intel Corporation. All rights reserved.<BR>
 #
 #  This program and the accompanying materials
 #  are licensed and made available under the terms and conditions of the BSD License
@@ -172,7 +172,14 @@ [Components.common]
   MdeModulePkg/Universal/SecurityStubDxe/SecurityStubDxe.inf
   MdeModulePkg/Universal/CapsuleRuntimeDxe/CapsuleRuntimeDxe.inf
 
-  MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf
+  MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf {
+    <PcdsFixedAtBuild>
+      gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvModeEnable|TRUE
+    <LibraryClasses>
+      AuthVariableLib|MdeModulePkg/Library/AuthVariableLibNull/AuthVariableLibNull.inf
+      TpmMeasurementLib|MdeModulePkg/Library/TpmMeasurementLibNull/TpmMeasurementLibNull.inf
+      VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
+  }
 
   MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf
   MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystemRuntimeDxe.inf
diff --git a/ArmVirtPkg/ArmVirtXen.fdf b/ArmVirtPkg/ArmVirtXen.fdf
index 50e670254d52..5655c0df2926 100644
--- a/ArmVirtPkg/ArmVirtXen.fdf
+++ b/ArmVirtPkg/ArmVirtXen.fdf
@@ -1,7 +1,7 @@
 #
 #  Copyright (c) 2011-2015, ARM Limited. All rights reserved.
 #  Copyright (c) 2014, Linaro Limited. All rights reserved.
-#  Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>
+#  Copyright (c) 2015 - 2019, Intel Corporation. All rights reserved.<BR>
 #
 #  This program and the accompanying materials
 #  are licensed and made available under the terms and conditions of the BSD License
@@ -137,7 +137,7 @@ [FV.FvMain]
   INF MdeModulePkg/Universal/SecurityStubDxe/SecurityStubDxe.inf
   INF MdeModulePkg/Universal/CapsuleRuntimeDxe/CapsuleRuntimeDxe.inf
 
-  INF MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf
+  INF MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
 
   INF MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf
   INF MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystemRuntimeDxe.inf
-- 
2.7.0.windows.1

Re: [PATCH 08/12] ArmVirtXen: Use merged variable driver for emulated NV mode

[Laszlo Ersek]

On 01/13/19 16:37, Star Zeng wrote:
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1323
> Merge EmuVariable and Real variable driver.
> 
> The real variable driver has been updated to support emulated
> variable NV mode and the EmuVariableRuntimeDxe will be removed
> later, so use merged variable driver for emulated NV mode.
> 
> Cc: Laszlo Ersek <lersek@redhat.com>
> Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>

(1) Please CC Julien Grall (I'm adding him now); he's listed as a
Reviewer for ArmVirtPkg in "Maintainers.txt", and we depend on him for
Xen testing.

> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Star Zeng <star.zeng@intel.com>
> ---
>  ArmVirtPkg/ArmVirtXen.dsc | 11 +++++++++--
>  ArmVirtPkg/ArmVirtXen.fdf |  4 ++--
>  2 files changed, 11 insertions(+), 4 deletions(-)
> 
> diff --git a/ArmVirtPkg/ArmVirtXen.dsc b/ArmVirtPkg/ArmVirtXen.dsc
> index a29d8a4ae717..126782372a58 100644
> --- a/ArmVirtPkg/ArmVirtXen.dsc
> +++ b/ArmVirtPkg/ArmVirtXen.dsc
> @@ -1,7 +1,7 @@
>  #
>  #  Copyright (c) 2011-2015, ARM Limited. All rights reserved.
>  #  Copyright (c) 2014, Linaro Limited. All rights reserved.
> -#  Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>
> +#  Copyright (c) 2015 - 2019, Intel Corporation. All rights reserved.<BR>
>  #
>  #  This program and the accompanying materials
>  #  are licensed and made available under the terms and conditions of the BSD License
> @@ -172,7 +172,14 @@ [Components.common]
>    MdeModulePkg/Universal/SecurityStubDxe/SecurityStubDxe.inf
>    MdeModulePkg/Universal/CapsuleRuntimeDxe/CapsuleRuntimeDxe.inf
>  
> -  MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf
> +  MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf {
> +    <PcdsFixedAtBuild>
> +      gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvModeEnable|TRUE
> +    <LibraryClasses>
> +      AuthVariableLib|MdeModulePkg/Library/AuthVariableLibNull/AuthVariableLibNull.inf
> +      TpmMeasurementLib|MdeModulePkg/Library/TpmMeasurementLibNull/TpmMeasurementLibNull.inf
> +      VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
> +  }

OK, I've stared at this long and hard, to see if we should try to unify
it with the ArmVirtQemu* platforms. Ultimately, I don't think so (see
commits 44d71c217ccbd and bf453d581ecff, which don't apply to Xen).
Thus, I agree that adding the "VariableRuntimeDxe.inf" reference
*itself* to "ArmVirtXen.dsc" is fine.

That said, I'd suggest some tweaks:

(1) I think we should add the "PcdEmuVariableNvModeEnable" override
simply to the [PcdsFixedAtBuild.common] section of "ArmVirtXen.dsc". I
think there's no reason to scope the PCD more narrowly than that; so for
clarity, we shouldn't.

(2) The resolutions for the AuthVariableLib, TpmMeasurementLib,
VarCheckLib classes seem superfluous; they are already in effect, from
"ArmVirt.dsc.inc".

(3) The following tweak should be covered in an additional patch:

- In commit 7a9f5b202c7a ("ArmVirtPkg: Link separated VarCheckUefiLib
NULL class library instance", 2015-08-25), you linked VarCheckUefiLib
into VariableRuntimeDxe in ArmVirtQemu.

- In commit 8de84d424221 ("ArmVirtPkg: implement ArmVirtQemuKernel",
2016-02-05), Ard created the ArmVirtQemuKernel platform with
VarCheckUefiLib used at once.

- So I think at this point we should link VarCheckUefiLib into
ArmVirtXen's VariableRuntimeDxe binary as well -- however, because it is
a functional change, and not strictly related to this driver
unification, it should be a separate patch.

If you decide that (3) is out of scope for this work, we can file a BZ
for it and address it separately -- after BZ#1323 is fixed. Otherwise,
if it's not a big burden, you could include the patch in this series
too. Can you please state which approach you prefer, for (3)?

Thank you!
Laszlo

>  
>    MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf
>    MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystemRuntimeDxe.inf
> diff --git a/ArmVirtPkg/ArmVirtXen.fdf b/ArmVirtPkg/ArmVirtXen.fdf
> index 50e670254d52..5655c0df2926 100644
> --- a/ArmVirtPkg/ArmVirtXen.fdf
> +++ b/ArmVirtPkg/ArmVirtXen.fdf
> @@ -1,7 +1,7 @@
>  #
>  #  Copyright (c) 2011-2015, ARM Limited. All rights reserved.
>  #  Copyright (c) 2014, Linaro Limited. All rights reserved.
> -#  Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>
> +#  Copyright (c) 2015 - 2019, Intel Corporation. All rights reserved.<BR>
>  #
>  #  This program and the accompanying materials
>  #  are licensed and made available under the terms and conditions of the BSD License
> @@ -137,7 +137,7 @@ [FV.FvMain]
>    INF MdeModulePkg/Universal/SecurityStubDxe/SecurityStubDxe.inf
>    INF MdeModulePkg/Universal/CapsuleRuntimeDxe/CapsuleRuntimeDxe.inf
>  
> -  INF MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf
> +  INF MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
>  
>    INF MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf
>    INF MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystemRuntimeDxe.inf
> 

Re: [PATCH 08/12] ArmVirtXen: Use merged variable driver for emulated NV mode

[Zeng, Star]

Hi Laszlo,

On 2019/1/14 19:40, Laszlo Ersek wrote:
> On 01/13/19 16:37, Star Zeng wrote:
>> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1323
>> Merge EmuVariable and Real variable driver.
>>
>> The real variable driver has been updated to support emulated
>> variable NV mode and the EmuVariableRuntimeDxe will be removed
>> later, so use merged variable driver for emulated NV mode.
>>
>> Cc: Laszlo Ersek <lersek@redhat.com>
>> Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
> 
> (1) Please CC Julien Grall (I'm adding him now); he's listed as a
> Reviewer for ArmVirtPkg in "Maintainers.txt", and we depend on him for
> Xen testing.
> 
>> Contributed-under: TianoCore Contribution Agreement 1.1
>> Signed-off-by: Star Zeng <star.zeng@intel.com>
>> ---
>>   ArmVirtPkg/ArmVirtXen.dsc | 11 +++++++++--
>>   ArmVirtPkg/ArmVirtXen.fdf |  4 ++--
>>   2 files changed, 11 insertions(+), 4 deletions(-)
>>
>> diff --git a/ArmVirtPkg/ArmVirtXen.dsc b/ArmVirtPkg/ArmVirtXen.dsc
>> index a29d8a4ae717..126782372a58 100644
>> --- a/ArmVirtPkg/ArmVirtXen.dsc
>> +++ b/ArmVirtPkg/ArmVirtXen.dsc
>> @@ -1,7 +1,7 @@
>>   #
>>   #  Copyright (c) 2011-2015, ARM Limited. All rights reserved.
>>   #  Copyright (c) 2014, Linaro Limited. All rights reserved.
>> -#  Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>
>> +#  Copyright (c) 2015 - 2019, Intel Corporation. All rights reserved.<BR>
>>   #
>>   #  This program and the accompanying materials
>>   #  are licensed and made available under the terms and conditions of the BSD License
>> @@ -172,7 +172,14 @@ [Components.common]
>>     MdeModulePkg/Universal/SecurityStubDxe/SecurityStubDxe.inf
>>     MdeModulePkg/Universal/CapsuleRuntimeDxe/CapsuleRuntimeDxe.inf
>>   
>> -  MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf
>> +  MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf {
>> +    <PcdsFixedAtBuild>
>> +      gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvModeEnable|TRUE
>> +    <LibraryClasses>
>> +      AuthVariableLib|MdeModulePkg/Library/AuthVariableLibNull/AuthVariableLibNull.inf
>> +      TpmMeasurementLib|MdeModulePkg/Library/TpmMeasurementLibNull/TpmMeasurementLibNull.inf
>> +      VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
>> +  }
> 
> OK, I've stared at this long and hard, to see if we should try to unify
> it with the ArmVirtQemu* platforms. Ultimately, I don't think so (see
> commits 44d71c217ccbd and bf453d581ecff, which don't apply to Xen).
> Thus, I agree that adding the "VariableRuntimeDxe.inf" reference
> *itself* to "ArmVirtXen.dsc" is fine.
> 
> That said, I'd suggest some tweaks:
> 
> (1) I think we should add the "PcdEmuVariableNvModeEnable" override
> simply to the [PcdsFixedAtBuild.common] section of "ArmVirtXen.dsc". I
> think there's no reason to scope the PCD more narrowly than that; so for
> clarity, we shouldn't.

Agree.

> 
> (2) The resolutions for the AuthVariableLib, TpmMeasurementLib,
> VarCheckLib classes seem superfluous; they are already in effect, from
> "ArmVirt.dsc.inc".

Good information.

> 
> (3) The following tweak should be covered in an additional patch:
> 
> - In commit 7a9f5b202c7a ("ArmVirtPkg: Link separated VarCheckUefiLib
> NULL class library instance", 2015-08-25), you linked VarCheckUefiLib
> into VariableRuntimeDxe in ArmVirtQemu.
> 
> - In commit 8de84d424221 ("ArmVirtPkg: implement ArmVirtQemuKernel",
> 2016-02-05), Ard created the ArmVirtQemuKernel platform with
> VarCheckUefiLib used at once.
> 
> - So I think at this point we should link VarCheckUefiLib into
> ArmVirtXen's VariableRuntimeDxe binary as well -- however, because it is
> a functional change, and not strictly related to this driver
> unification, it should be a separate patch.
> 
> If you decide that (3) is out of scope for this work, we can file a BZ
> for it and address it separately -- after BZ#1323 is fixed. Otherwise,
> if it's not a big burden, you could include the patch in this series
> too. Can you please state which approach you prefer, for (3)?

A new patch has been added for it in V2 patch series at 
https://lists.01.org/pipermail/edk2-devel/2019-January/035015.html.

Thanks,
Star

> 
> Thank you!
> Laszlo
> 
>>   
>>     MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf
>>     MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystemRuntimeDxe.inf
>> diff --git a/ArmVirtPkg/ArmVirtXen.fdf b/ArmVirtPkg/ArmVirtXen.fdf
>> index 50e670254d52..5655c0df2926 100644
>> --- a/ArmVirtPkg/ArmVirtXen.fdf
>> +++ b/ArmVirtPkg/ArmVirtXen.fdf
>> @@ -1,7 +1,7 @@
>>   #
>>   #  Copyright (c) 2011-2015, ARM Limited. All rights reserved.
>>   #  Copyright (c) 2014, Linaro Limited. All rights reserved.
>> -#  Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>
>> +#  Copyright (c) 2015 - 2019, Intel Corporation. All rights reserved.<BR>
>>   #
>>   #  This program and the accompanying materials
>>   #  are licensed and made available under the terms and conditions of the BSD License
>> @@ -137,7 +137,7 @@ [FV.FvMain]
>>     INF MdeModulePkg/Universal/SecurityStubDxe/SecurityStubDxe.inf
>>     INF MdeModulePkg/Universal/CapsuleRuntimeDxe/CapsuleRuntimeDxe.inf
>>   
>> -  INF MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf
>> +  INF MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
>>   
>>     INF MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf
>>     INF MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystemRuntimeDxe.inf
>>

[PATCH 09/12] BeagleBoardPkg: Use merged variable driver for emulated NV mode

[Star Zeng]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1323
Merge EmuVariable and Real variable driver.

The real variable driver has been updated to support emulated
variable NV mode and the EmuVariableRuntimeDxe will be removed
later, so use merged variable driver for emulated NV mode.

Cc: Leif Lindholm <leif.lindholm@linaro.org>
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Star Zeng <star.zeng@intel.com>
---
 BeagleBoardPkg/BeagleBoardPkg.dsc | 11 +++++++++--
 BeagleBoardPkg/BeagleBoardPkg.fdf |  4 ++--
 2 files changed, 11 insertions(+), 4 deletions(-)

diff --git a/BeagleBoardPkg/BeagleBoardPkg.dsc b/BeagleBoardPkg/BeagleBoardPkg.dsc
index 6dabfa905ae9..6b37d02ea19a 100644
--- a/BeagleBoardPkg/BeagleBoardPkg.dsc
+++ b/BeagleBoardPkg/BeagleBoardPkg.dsc
@@ -2,7 +2,7 @@
 # Beagle board package.
 #
 # Copyright (c) 2009 - 2010, Apple Inc. All rights reserved.<BR>
-# Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>
+# Copyright (c) 2015 - 2019, Intel Corporation. All rights reserved.<BR>
 # Copyright (c) 2016, Linaro Ltd. All rights reserved.<BR>
 #
 #    This program and the accompanying materials
@@ -376,7 +376,14 @@ [Components.common]
   MdeModulePkg/Universal/SecurityStubDxe/SecurityStubDxe.inf
   MdeModulePkg/Universal/WatchdogTimerDxe/WatchdogTimer.inf
   MdeModulePkg/Universal/CapsuleRuntimeDxe/CapsuleRuntimeDxe.inf
-  MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf
+  MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf {
+    <PcdsFixedAtBuild>
+      gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvModeEnable|TRUE
+    <LibraryClasses>
+      AuthVariableLib|MdeModulePkg/Library/AuthVariableLibNull/AuthVariableLibNull.inf
+      TpmMeasurementLib|MdeModulePkg/Library/TpmMeasurementLibNull/TpmMeasurementLibNull.inf
+      VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
+  }
   EmbeddedPkg/EmbeddedMonotonicCounter/EmbeddedMonotonicCounter.inf
 
   MdeModulePkg/Universal/Console/ConPlatformDxe/ConPlatformDxe.inf
diff --git a/BeagleBoardPkg/BeagleBoardPkg.fdf b/BeagleBoardPkg/BeagleBoardPkg.fdf
index 83d85fce4070..42d6bad0c73b 100644
--- a/BeagleBoardPkg/BeagleBoardPkg.fdf
+++ b/BeagleBoardPkg/BeagleBoardPkg.fdf
@@ -1,7 +1,7 @@
 # FLASH layout file for Beagle board.
 #
 # Copyright (c) 2009, Apple Inc. All rights reserved.<BR>
-# Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>
+# Copyright (c) 2015 - 2019, Intel Corporation. All rights reserved.<BR>
 # Copyright (c) 2016, Linaro, Ltd. All rights reserved.<BR>
 #
 #    This program and the accompanying materials
@@ -106,7 +106,7 @@ [FV.FvMain]
   INF MdeModulePkg/Universal/SecurityStubDxe/SecurityStubDxe.inf
   INF MdeModulePkg/Universal/WatchdogTimerDxe/WatchdogTimer.inf
   INF MdeModulePkg/Universal/CapsuleRuntimeDxe/CapsuleRuntimeDxe.inf
-  INF MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf
+  INF MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
   INF EmbeddedPkg/EmbeddedMonotonicCounter/EmbeddedMonotonicCounter.inf
 
   INF MdeModulePkg/Universal/Console/ConPlatformDxe/ConPlatformDxe.inf
-- 
2.7.0.windows.1

[PATCH 10/12] QuarkMin: Use merged variable driver for emulated NV mode

[Star Zeng]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1323
Merge EmuVariable and Real variable driver.

The real variable driver has been updated to support emulated
variable NV mode and the EmuVariableRuntimeDxe will be removed
later, so use merged variable driver for emulated NV mode.

Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Kelly Steele <kelly.steele@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Star Zeng <star.zeng@intel.com>
---
 QuarkPlatformPkg/QuarkMin.dsc | 7 +++++--
 QuarkPlatformPkg/QuarkMin.fdf | 4 ++--
 2 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/QuarkPlatformPkg/QuarkMin.dsc b/QuarkPlatformPkg/QuarkMin.dsc
index d7a25686a30b..e3c5db3b6b93 100644
--- a/QuarkPlatformPkg/QuarkMin.dsc
+++ b/QuarkPlatformPkg/QuarkMin.dsc
@@ -2,7 +2,7 @@
 # Clanton Peak CRB platform with 32-bit DXE for 4MB/8MB flash devices.
 #
 # This package provides Clanton Peak CRB platform specific modules.
-# Copyright (c) 2013 - 2018 Intel Corporation.
+# Copyright (c) 2013 - 2019 Intel Corporation.
 #
 # This program and the accompanying materials
 # are licensed and made available under the terms and conditions of the BSD License
@@ -553,7 +553,10 @@ [Components.IA32]
   MdeModulePkg/Universal/Metronome/Metronome.inf
   MdeModulePkg/Universal/WatchdogTimerDxe/WatchdogTimer.inf
   MdeModulePkg/Core/RuntimeDxe/RuntimeDxe.inf
-  MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf
+  MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf {
+    <PcdsFixedAtBuild>
+      gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvModeEnable|TRUE
+  }
   MdeModulePkg/Universal/CapsuleRuntimeDxe/CapsuleRuntimeDxe.inf
   MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf
   MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystemRuntimeDxe.inf
diff --git a/QuarkPlatformPkg/QuarkMin.fdf b/QuarkPlatformPkg/QuarkMin.fdf
index b793fbd9a340..6e5545c16d3b 100644
--- a/QuarkPlatformPkg/QuarkMin.fdf
+++ b/QuarkPlatformPkg/QuarkMin.fdf
@@ -2,7 +2,7 @@
 # FDF file of Clanton Peak CRB platform with 32-bit DXE
 #
 # This package provides QuarkNcSocId platform specific modules.
-# Copyright (c) 2013 - 2017 Intel Corporation.
+# Copyright (c) 2013 - 2019 Intel Corporation.
 #
 # This program and the accompanying materials
 # are licensed and made available under the terms and conditions of the BSD License
@@ -388,7 +388,7 @@ [FV.FVMAIN]
 INF  MdeModulePkg/Universal/Metronome/Metronome.inf
 INF  MdeModulePkg/Universal/WatchdogTimerDxe/WatchdogTimer.inf
 INF  MdeModulePkg/Core/RuntimeDxe/RuntimeDxe.inf
-INF  MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf
+INF  MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
 INF  MdeModulePkg/Universal/CapsuleRuntimeDxe/CapsuleRuntimeDxe.inf
 INF  MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf
 INF  MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystemRuntimeDxe.inf
-- 
2.7.0.windows.1

[PATCH 11/12] CorebootPayloadPkg: Use merged variable driver for emulated NV mode

[Star Zeng]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1323
Merge EmuVariable and Real variable driver.

The real variable driver has been updated to support emulated
variable NV mode and the EmuVariableRuntimeDxe will be removed
later, so use merged variable driver for emulated NV mode.

Cc: Maurice Ma <maurice.ma@intel.com>
Cc: Prince Agyeman <prince.agyeman@intel.com>
Cc: Benjamin You <benjamin.you@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Star Zeng <star.zeng@intel.com>
---
 CorebootPayloadPkg/CorebootPayloadPkg.fdf        |  4 ++--
 CorebootPayloadPkg/CorebootPayloadPkgIa32.dsc    | 11 +++++++++--
 CorebootPayloadPkg/CorebootPayloadPkgIa32X64.dsc | 11 +++++++++--
 3 files changed, 20 insertions(+), 6 deletions(-)

diff --git a/CorebootPayloadPkg/CorebootPayloadPkg.fdf b/CorebootPayloadPkg/CorebootPayloadPkg.fdf
index 741a5c232ed8..0c24f96a1561 100644
--- a/CorebootPayloadPkg/CorebootPayloadPkg.fdf
+++ b/CorebootPayloadPkg/CorebootPayloadPkg.fdf
@@ -3,7 +3,7 @@
 #
 # Provides drivers and definitions to create uefi payload for coreboot.
 #
-# Copyright (c) 2014 - 2017, Intel Corporation. All rights reserved.<BR>
+# Copyright (c) 2014 - 2019, Intel Corporation. All rights reserved.<BR>
 # This program and the accompanying materials are licensed and made available under
 # the terms and conditions of the BSD License that accompanies this distribution.
 # The full text of the license may be found at
@@ -109,7 +109,7 @@ [FV.DXEFV]
 INF MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf
 INF MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystemRuntimeDxe.inf
 INF PcAtChipsetPkg/PcatRealTimeClockRuntimeDxe/PcatRealTimeClockRuntimeDxe.inf
-INF MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf
+INF MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
 
 INF UefiCpuPkg/CpuIo2Dxe/CpuIo2Dxe.inf
 INF MdeModulePkg/Universal/DevicePathDxe/DevicePathDxe.inf
diff --git a/CorebootPayloadPkg/CorebootPayloadPkgIa32.dsc b/CorebootPayloadPkg/CorebootPayloadPkgIa32.dsc
index 467d4fcdb422..2f61bf5f7c0e 100644
--- a/CorebootPayloadPkg/CorebootPayloadPkgIa32.dsc
+++ b/CorebootPayloadPkg/CorebootPayloadPkgIa32.dsc
@@ -3,7 +3,7 @@
 #
 # Provides drivers and definitions to create uefi payload for coreboot.
 #
-# Copyright (c) 2014 - 2017, Intel Corporation. All rights reserved.<BR>
+# Copyright (c) 2014 - 2019, Intel Corporation. All rights reserved.<BR>
 # This program and the accompanying materials are licensed and made available under
 # the terms and conditions of the BSD License that accompanies this distribution.
 # The full text of the license may be found at
@@ -417,7 +417,14 @@ [Components.IA32]
   MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf
   MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystemRuntimeDxe.inf
   PcAtChipsetPkg/PcatRealTimeClockRuntimeDxe/PcatRealTimeClockRuntimeDxe.inf
-  MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf
+  MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf {
+    <PcdsFixedAtBuild>
+      gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvModeEnable|TRUE
+    <LibraryClasses>
+      AuthVariableLib|MdeModulePkg/Library/AuthVariableLibNull/AuthVariableLibNull.inf
+      TpmMeasurementLib|MdeModulePkg/Library/TpmMeasurementLibNull/TpmMeasurementLibNull.inf
+      VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
+  }
 
   #
   # Following are the DXE drivers
diff --git a/CorebootPayloadPkg/CorebootPayloadPkgIa32X64.dsc b/CorebootPayloadPkg/CorebootPayloadPkgIa32X64.dsc
index 673bd26c7973..4d4204e00009 100644
--- a/CorebootPayloadPkg/CorebootPayloadPkgIa32X64.dsc
+++ b/CorebootPayloadPkg/CorebootPayloadPkgIa32X64.dsc
@@ -3,7 +3,7 @@
 #
 # Provides drivers and definitions to create uefi payload for coreboot.
 #
-# Copyright (c) 2014 - 2017, Intel Corporation. All rights reserved.<BR>
+# Copyright (c) 2014 - 2019, Intel Corporation. All rights reserved.<BR>
 # This program and the accompanying materials are licensed and made available under
 # the terms and conditions of the BSD License that accompanies this distribution.
 # The full text of the license may be found at
@@ -418,7 +418,14 @@ [Components.X64]
   MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf
   MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystemRuntimeDxe.inf
   PcAtChipsetPkg/PcatRealTimeClockRuntimeDxe/PcatRealTimeClockRuntimeDxe.inf
-  MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf
+  MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf {
+    <PcdsFixedAtBuild>
+      gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvModeEnable|TRUE
+    <LibraryClasses>
+      AuthVariableLib|MdeModulePkg/Library/AuthVariableLibNull/AuthVariableLibNull.inf
+      TpmMeasurementLib|MdeModulePkg/Library/TpmMeasurementLibNull/TpmMeasurementLibNull.inf
+      VarCheckLib|MdeModulePkg/Library/VarCheckLib/VarCheckLib.inf
+  }
 
   #
   # Following are the DXE drivers
-- 
2.7.0.windows.1

[PATCH 12/12] MdeModule: Remove EmuVariableRuntimeDxe

[Star Zeng]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1323
Merge EmuVariable and Real variable driver.

The real variable driver has been updated to support emulated
variable NV mode.
This patch removes EmuVariableRuntimeDxe after platforms are
migrated to use the merged variable driver.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Hao Wu <hao.a.wu@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Star Zeng <star.zeng@intel.com>
---
 MdeModulePkg/MdeModulePkg.dsc                      |    5 +-
 .../Universal/Variable/EmuRuntimeDxe/EmuVariable.c | 1820 --------------------
 .../EmuRuntimeDxe/EmuVariableRuntimeDxe.inf        |   88 -
 .../EmuRuntimeDxe/EmuVariableRuntimeDxe.uni        |   22 -
 .../EmuRuntimeDxe/EmuVariableRuntimeDxeExtra.uni   |   19 -
 .../Variable/EmuRuntimeDxe/InitVariable.c          |  259 ---
 .../Universal/Variable/EmuRuntimeDxe/Variable.h    |  277 ---
 7 files changed, 1 insertion(+), 2489 deletions(-)
 delete mode 100644 MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariable.c
 delete mode 100644 MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf
 delete mode 100644 MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.uni
 delete mode 100644 MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxeExtra.uni
 delete mode 100644 MdeModulePkg/Universal/Variable/EmuRuntimeDxe/InitVariable.c
 delete mode 100644 MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h

diff --git a/MdeModulePkg/MdeModulePkg.dsc b/MdeModulePkg/MdeModulePkg.dsc
index 5d042be3a862..3186f35a1a48 100644
--- a/MdeModulePkg/MdeModulePkg.dsc
+++ b/MdeModulePkg/MdeModulePkg.dsc
@@ -2,7 +2,7 @@
 # EFI/PI Reference Module Package for All Architectures
 #
 # (C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>
-# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
+# Copyright (c) 2007 - 2019, Intel Corporation. All rights reserved.<BR>
 #
 #    This program and the accompanying materials
 #    are licensed and made available under the terms and conditions of the BSD License
@@ -433,9 +433,6 @@ [Components.IA32, Components.X64, Components.ARM, Components.AARCH64]
       NULL|MdeModulePkg/Library/DxeCrc32GuidedSectionExtractLib/DxeCrc32GuidedSectionExtractLib.inf
   }
 
-[Components.IA32, Components.X64, Components.Ebc]
-  MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf
-
 [Components.IA32, Components.X64]
   MdeModulePkg/Application/SmiHandlerProfileInfo/SmiHandlerProfileInfo.inf
   MdeModulePkg/Core/PiSmmCore/PiSmmIpl.inf
diff --git a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariable.c b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariable.c
deleted file mode 100644
index 1bcf931b96a6..000000000000
--- a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariable.c
+++ /dev/null
@@ -1,1820 +0,0 @@
-/** @file
-
-  Emulation Variable services operate on the runtime volatile memory.
-  The nonvolatile variable space doesn't exist.
-
-Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
-This program and the accompanying materials
-are licensed and made available under the terms and conditions of the BSD License
-which accompanies this distribution.  The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
-**/
-
-#include "Variable.h"
-
-///
-/// Don't use module globals after the SetVirtualAddress map is signaled
-///
-ESAL_VARIABLE_GLOBAL  *mVariableModuleGlobal;
-
-VARIABLE_INFO_ENTRY *gVariableInfo = NULL;
-
-///
-/// The size of a 3 character ISO639 language code.
-///
-#define ISO_639_2_ENTRY_SIZE    3
-
-/**
-  Update the variable region with Variable information. These are the same
-  arguments as the EFI Variable services.
-
-  @param[in] VariableName       Name of variable
-
-  @param[in] VendorGuid         Guid of variable
-
-  @param[in] Data               Variable data
-
-  @param[in] DataSize           Size of data. 0 means delete
-
-  @param[in] Attributes         Attribues of the variable
-
-  @param[in] Variable           The variable information which is used to keep track of variable usage.
-
-  @retval EFI_SUCCESS           The update operation is success.
-
-  @retval EFI_OUT_OF_RESOURCES  Variable region is full, can not write other data into this region.
-
-**/
-EFI_STATUS
-EFIAPI
-UpdateVariable (
-  IN      CHAR16                 *VariableName,
-  IN      EFI_GUID               *VendorGuid,
-  IN      VOID                   *Data,
-  IN      UINTN                  DataSize,
-  IN      UINT32                 Attributes OPTIONAL,
-  IN      VARIABLE_POINTER_TRACK *Variable
-  );
-
-/**
-  Finds variable in storage blocks of volatile and non-volatile storage areas.
-
-  This code finds variable in storage blocks of volatile and non-volatile storage areas.
-  If VariableName is an empty string, then we just return the first
-  qualified variable without comparing VariableName and VendorGuid.
-  Otherwise, VariableName and VendorGuid are compared.
-
-  @param  VariableName                Name of the variable to be found.
-  @param  VendorGuid                  Vendor GUID to be found.
-  @param  PtrTrack                    VARIABLE_POINTER_TRACK structure for output,
-                                      including the range searched and the target position.
-  @param  Global                      Pointer to VARIABLE_GLOBAL structure, including
-                                      base of volatile variable storage area, base of
-                                      NV variable storage area, and a lock.
-
-  @retval EFI_INVALID_PARAMETER       If VariableName is not an empty string, while
-                                      VendorGuid is NULL.
-  @retval EFI_SUCCESS                 Variable successfully found.
-  @retval EFI_NOT_FOUND               Variable not found.
-
-**/
-EFI_STATUS
-FindVariable (
-  IN  CHAR16                  *VariableName,
-  IN  EFI_GUID                *VendorGuid,
-  OUT VARIABLE_POINTER_TRACK  *PtrTrack,
-  IN  VARIABLE_GLOBAL         *Global
-  );
-
-/**
-  Acquires lock only at boot time. Simply returns at runtime.
-
-  This is a temperary function which will be removed when
-  EfiAcquireLock() in UefiLib can handle the call in UEFI
-  Runtimer driver in RT phase.
-  It calls EfiAcquireLock() at boot time, and simply returns
-  at runtime
-
-  @param  Lock         A pointer to the lock to acquire
-
-**/
-VOID
-AcquireLockOnlyAtBootTime (
-  IN EFI_LOCK  *Lock
-  )
-{
-  if (!EfiAtRuntime ()) {
-    EfiAcquireLock (Lock);
-  }
-}
-
-/**
-  Releases lock only at boot time. Simply returns at runtime.
-
-  This is a temperary function which will be removed when
-  EfiReleaseLock() in UefiLib can handle the call in UEFI
-  Runtimer driver in RT phase.
-  It calls EfiReleaseLock() at boot time, and simply returns
-  at runtime
-
-  @param  Lock         A pointer to the lock to release
-
-**/
-VOID
-ReleaseLockOnlyAtBootTime (
-  IN EFI_LOCK  *Lock
-  )
-{
-  if (!EfiAtRuntime ()) {
-    EfiReleaseLock (Lock);
-  }
-}
-
-/**
-  Gets pointer to the variable data.
-
-  This function gets the pointer to the variable data according
-  to the input pointer to the variable header.
-
-  @param  Variable      Pointer to the variable header.
-
-  @return Pointer to variable data
-
-**/
-UINT8 *
-GetVariableDataPtr (
-  IN  VARIABLE_HEADER   *Variable
-  )
-{
-  if (Variable->StartId != VARIABLE_DATA) {
-    return NULL;
-  }
-  //
-  // Be careful about pad size for alignment
-  //
-  return (UINT8 *) ((UINTN) GET_VARIABLE_NAME_PTR (Variable) + Variable->NameSize + GET_PAD_SIZE (Variable->NameSize));
-}
-
-/**
-  Gets pointer to header of the next potential variable.
-
-  This function gets the pointer to the next potential variable header
-  according to the input point to the variable header.  The return value
-  is not a valid variable if the input variable was the last variable
-  in the variabl store.
-
-  @param  Variable      Pointer to header of the next variable
-
-  @return Pointer to next variable header.
-  @retval NULL  Input was not a valid variable header.
-
-**/
-VARIABLE_HEADER *
-GetNextPotentialVariablePtr (
-  IN  VARIABLE_HEADER   *Variable
-  )
-{
-  VARIABLE_HEADER *VarHeader;
-
-  if (Variable->StartId != VARIABLE_DATA) {
-    return NULL;
-  }
-  //
-  // Be careful about pad size for alignment
-  //
-  VarHeader = (VARIABLE_HEADER *) HEADER_ALIGN ((UINTN) GetVariableDataPtr (Variable) + Variable->DataSize + GET_PAD_SIZE (Variable->DataSize));
-
-  return VarHeader;
-}
-
-/**
-  Gets pointer to header of the next variable.
-
-  This function gets the pointer to the next variable header according
-  to the input point to the variable header.
-
-  @param  Variable      Pointer to header of the next variable
-
-  @return Pointer to next variable header.
-
-**/
-VARIABLE_HEADER *
-GetNextVariablePtr (
-  IN  VARIABLE_HEADER   *Variable
-  )
-{
-  VARIABLE_HEADER *VarHeader;
-
-  VarHeader = GetNextPotentialVariablePtr (Variable);
-
-  if ((VarHeader == NULL) || (VarHeader->StartId != VARIABLE_DATA)) {
-    return NULL;
-  }
-
-  return VarHeader;
-}
-
-/**
-  Updates LastVariableOffset variable for the given variable store.
-
-  LastVariableOffset points to the offset to use for the next variable
-  when updating the variable store.
-
-  @param[in]   VariableStore       Pointer to the start of the variable store
-  @param[out]  LastVariableOffset  Offset to put the next new variable in
-
-**/
-VOID
-InitializeLocationForLastVariableOffset (
-  IN  VARIABLE_STORE_HEADER *VariableStore,
-  OUT UINTN                 *LastVariableOffset
-  )
-{
-  VARIABLE_HEADER *VarHeader;
-
-  *LastVariableOffset       = sizeof (VARIABLE_STORE_HEADER);
-  VarHeader = (VARIABLE_HEADER*) ((UINT8*)VariableStore + *LastVariableOffset);
-  while (VarHeader->StartId == VARIABLE_DATA) {
-    VarHeader = GetNextPotentialVariablePtr (VarHeader);
-
-    if (VarHeader != NULL) {
-      *LastVariableOffset = (UINTN) VarHeader - (UINTN) VariableStore;
-    } else {
-      return;
-    }
-  }
-}
-
-/**
-  Gets pointer to the end of the variable storage area.
-
-  This function gets pointer to the end of the variable storage
-  area, according to the input variable store header.
-
-  @param  VolHeader     Pointer to the variale store header
-
-  @return Pointer to the end of the variable storage area.
-
-**/
-VARIABLE_HEADER *
-GetEndPointer (
-  IN VARIABLE_STORE_HEADER       *VolHeader
-  )
-{
-  //
-  // The end of variable store
-  //
-  return (VARIABLE_HEADER *) HEADER_ALIGN ((UINTN) VolHeader + VolHeader->Size);
-}
-
-/**
-  Routine used to track statistical information about variable usage.
-  The data is stored in the EFI system table so it can be accessed later.
-  VariableInfo.efi can dump out the table. Only Boot Services variable
-  accesses are tracked by this code. The PcdVariableCollectStatistics
-  build flag controls if this feature is enabled.
-
-  A read that hits in the cache will have Read and Cache true for
-  the transaction. Data is allocated by this routine, but never
-  freed.
-
-  @param[in] VariableName   Name of the Variable to track
-  @param[in] VendorGuid     Guid of the Variable to track
-  @param[in] Volatile       TRUE if volatile FALSE if non-volatile
-  @param[in] Read           TRUE if GetVariable() was called
-  @param[in] Write          TRUE if SetVariable() was called
-  @param[in] Delete         TRUE if deleted via SetVariable()
-  @param[in] Cache          TRUE for a cache hit.
-
-**/
-VOID
-UpdateVariableInfo (
-  IN  CHAR16                  *VariableName,
-  IN  EFI_GUID                *VendorGuid,
-  IN  BOOLEAN                 Volatile,
-  IN  BOOLEAN                 Read,
-  IN  BOOLEAN                 Write,
-  IN  BOOLEAN                 Delete,
-  IN  BOOLEAN                 Cache
-  )
-{
-  VARIABLE_INFO_ENTRY   *Entry;
-
-  if (FeaturePcdGet (PcdVariableCollectStatistics)) {
-
-    if (EfiAtRuntime ()) {
-      // Don't collect statistics at runtime
-      return;
-    }
-
-    if (gVariableInfo == NULL) {
-      //
-      // on the first call allocate a entry and place a pointer to it in
-      // the EFI System Table
-      //
-      gVariableInfo = AllocateZeroPool (sizeof (VARIABLE_INFO_ENTRY));
-      ASSERT (gVariableInfo != NULL);
-
-      CopyGuid (&gVariableInfo->VendorGuid, VendorGuid);
-      gVariableInfo->Name = AllocateZeroPool (StrSize (VariableName));
-      ASSERT (gVariableInfo->Name != NULL);
-      StrCpyS (gVariableInfo->Name, StrSize(VariableName)/sizeof(CHAR16), VariableName);
-      gVariableInfo->Volatile = Volatile;
-
-      gBS->InstallConfigurationTable (&gEfiVariableGuid, gVariableInfo);
-    }
-
-
-    for (Entry = gVariableInfo; Entry != NULL; Entry = Entry->Next) {
-      if (CompareGuid (VendorGuid, &Entry->VendorGuid)) {
-        if (StrCmp (VariableName, Entry->Name) == 0) {
-          if (Read) {
-            Entry->ReadCount++;
-          }
-          if (Write) {
-            Entry->WriteCount++;
-          }
-          if (Delete) {
-            Entry->DeleteCount++;
-          }
-          if (Cache) {
-            Entry->CacheCount++;
-          }
-
-          return;
-        }
-      }
-
-      if (Entry->Next == NULL) {
-        //
-        // If the entry is not in the table add it.
-        // Next iteration of the loop will fill in the data
-        //
-        Entry->Next = AllocateZeroPool (sizeof (VARIABLE_INFO_ENTRY));
-        ASSERT (Entry->Next != NULL);
-
-        CopyGuid (&Entry->Next->VendorGuid, VendorGuid);
-        Entry->Next->Name = AllocateZeroPool (StrSize (VariableName));
-        ASSERT (Entry->Next->Name != NULL);
-        StrCpyS (Entry->Next->Name, StrSize(VariableName)/sizeof(CHAR16), VariableName);
-        Entry->Next->Volatile = Volatile;
-      }
-
-    }
-  }
-}
-
-/**
-  Get index from supported language codes according to language string.
-
-  This code is used to get corresponding index in supported language codes. It can handle
-  RFC4646 and ISO639 language tags.
-  In ISO639 language tags, take 3-characters as a delimitation to find matched string and calculate the index.
-  In RFC4646 language tags, take semicolon as a delimitation to find matched string and calculate the index.
-
-  For example:
-    SupportedLang  = "engfraengfra"
-    Lang           = "eng"
-    Iso639Language = TRUE
-  The return value is "0".
-  Another example:
-    SupportedLang  = "en;fr;en-US;fr-FR"
-    Lang           = "fr-FR"
-    Iso639Language = FALSE
-  The return value is "3".
-
-  @param  SupportedLang               Platform supported language codes.
-  @param  Lang                        Configured language.
-  @param  Iso639Language              A bool value to signify if the handler is operated on ISO639 or RFC4646.
-
-  @retval the index of language in the language codes.
-
-**/
-UINTN
-GetIndexFromSupportedLangCodes(
-  IN  CHAR8            *SupportedLang,
-  IN  CHAR8            *Lang,
-  IN  BOOLEAN          Iso639Language
-  )
-{
-  UINTN    Index;
-  UINTN    CompareLength;
-  UINTN    LanguageLength;
-
-  if (Iso639Language) {
-    CompareLength = ISO_639_2_ENTRY_SIZE;
-    for (Index = 0; Index < AsciiStrLen (SupportedLang); Index += CompareLength) {
-      if (AsciiStrnCmp (Lang, SupportedLang + Index, CompareLength) == 0) {
-        //
-        // Successfully find the index of Lang string in SupportedLang string.
-        //
-        Index = Index / CompareLength;
-        return Index;
-      }
-    }
-    ASSERT (FALSE);
-    return 0;
-  } else {
-    //
-    // Compare RFC4646 language code
-    //
-    Index = 0;
-    for (LanguageLength = 0; Lang[LanguageLength] != '\0'; LanguageLength++);
-
-    for (Index = 0; *SupportedLang != '\0'; Index++, SupportedLang += CompareLength) {
-      //
-      // Skip ';' characters in SupportedLang
-      //
-      for (; *SupportedLang != '\0' && *SupportedLang == ';'; SupportedLang++);
-      //
-      // Determine the length of the next language code in SupportedLang
-      //
-      for (CompareLength = 0; SupportedLang[CompareLength] != '\0' && SupportedLang[CompareLength] != ';'; CompareLength++);
-
-      if ((CompareLength == LanguageLength) &&
-          (AsciiStrnCmp (Lang, SupportedLang, CompareLength) == 0)) {
-        //
-        // Successfully find the index of Lang string in SupportedLang string.
-        //
-        return Index;
-      }
-    }
-    ASSERT (FALSE);
-    return 0;
-  }
-}
-
-/**
-  Get language string from supported language codes according to index.
-
-  This code is used to get corresponding language string in supported language codes. It can handle
-  RFC4646 and ISO639 language tags.
-  In ISO639 language tags, take 3-characters as a delimitation. Find language string according to the index.
-  In RFC4646 language tags, take semicolon as a delimitation. Find language string according to the index.
-
-  For example:
-    SupportedLang  = "engfraengfra"
-    Index          = "1"
-    Iso639Language = TRUE
-  The return value is "fra".
-  Another example:
-    SupportedLang  = "en;fr;en-US;fr-FR"
-    Index          = "1"
-    Iso639Language = FALSE
-  The return value is "fr".
-
-  @param  SupportedLang               Platform supported language codes.
-  @param  Index                       the index in supported language codes.
-  @param  Iso639Language              A bool value to signify if the handler is operated on ISO639 or RFC4646.
-
-  @retval the language string in the language codes.
-
-**/
-CHAR8 *
-GetLangFromSupportedLangCodes (
-  IN  CHAR8            *SupportedLang,
-  IN  UINTN            Index,
-  IN  BOOLEAN          Iso639Language
-)
-{
-  UINTN    SubIndex;
-  UINTN    CompareLength;
-  CHAR8    *Supported;
-
-  SubIndex  = 0;
-  Supported = SupportedLang;
-  if (Iso639Language) {
-    //
-    // according to the index of Lang string in SupportedLang string to get the language.
-    // As this code will be invoked in RUNTIME, therefore there is not memory allocate/free operation.
-    // In driver entry, it pre-allocates a runtime attribute memory to accommodate this string.
-    //
-    CompareLength = ISO_639_2_ENTRY_SIZE;
-    mVariableModuleGlobal->Lang[CompareLength] = '\0';
-    return CopyMem (mVariableModuleGlobal->Lang, SupportedLang + Index * CompareLength, CompareLength);
-
-  } else {
-    while (TRUE) {
-      //
-      // take semicolon as delimitation, sequentially traverse supported language codes.
-      //
-      for (CompareLength = 0; *Supported != ';' && *Supported != '\0'; CompareLength++) {
-        Supported++;
-      }
-      if ((*Supported == '\0') && (SubIndex != Index)) {
-        //
-        // Have completed the traverse, but not find corrsponding string.
-        // This case is not allowed to happen.
-        //
-        ASSERT(FALSE);
-        return NULL;
-      }
-      if (SubIndex == Index) {
-        //
-        // according to the index of Lang string in SupportedLang string to get the language.
-        // As this code will be invoked in RUNTIME, therefore there is not memory allocate/free operation.
-        // In driver entry, it pre-allocates a runtime attribute memory to accommodate this string.
-        //
-        mVariableModuleGlobal->PlatformLang[CompareLength] = '\0';
-        return CopyMem (mVariableModuleGlobal->PlatformLang, Supported - CompareLength, CompareLength);
-      }
-      SubIndex++;
-
-      //
-      // Skip ';' characters in Supported
-      //
-      for (; *Supported != '\0' && *Supported == ';'; Supported++);
-    }
-  }
-}
-
-/**
-  Returns a pointer to an allocated buffer that contains the best matching language
-  from a set of supported languages.
-
-  This function supports both ISO 639-2 and RFC 4646 language codes, but language
-  code types may not be mixed in a single call to this function. This function
-  supports a variable argument list that allows the caller to pass in a prioritized
-  list of language codes to test against all the language codes in SupportedLanguages.
-
-  If SupportedLanguages is NULL, then ASSERT().
-
-  @param[in]  SupportedLanguages  A pointer to a Null-terminated ASCII string that
-                                  contains a set of language codes in the format
-                                  specified by Iso639Language.
-  @param[in]  Iso639Language      If not zero, then all language codes are assumed to be
-                                  in ISO 639-2 format.  If zero, then all language
-                                  codes are assumed to be in RFC 4646 language format
-  @param[in]  ...                 A variable argument list that contains pointers to
-                                  Null-terminated ASCII strings that contain one or more
-                                  language codes in the format specified by Iso639Language.
-                                  The first language code from each of these language
-                                  code lists is used to determine if it is an exact or
-                                  close match to any of the language codes in
-                                  SupportedLanguages.  Close matches only apply to RFC 4646
-                                  language codes, and the matching algorithm from RFC 4647
-                                  is used to determine if a close match is present.  If
-                                  an exact or close match is found, then the matching
-                                  language code from SupportedLanguages is returned.  If
-                                  no matches are found, then the next variable argument
-                                  parameter is evaluated.  The variable argument list
-                                  is terminated by a NULL.
-
-  @retval NULL   The best matching language could not be found in SupportedLanguages.
-  @retval NULL   There are not enough resources available to return the best matching
-                 language.
-  @retval Other  A pointer to a Null-terminated ASCII string that is the best matching
-                 language in SupportedLanguages.
-
-**/
-CHAR8 *
-EFIAPI
-VariableGetBestLanguage (
-  IN CONST CHAR8  *SupportedLanguages,
-  IN UINTN        Iso639Language,
-  ...
-  )
-{
-  VA_LIST      Args;
-  CHAR8        *Language;
-  UINTN        CompareLength;
-  UINTN        LanguageLength;
-  CONST CHAR8  *Supported;
-  CHAR8        *Buffer;
-
-  ASSERT (SupportedLanguages != NULL);
-
-  VA_START (Args, Iso639Language);
-  while ((Language = VA_ARG (Args, CHAR8 *)) != NULL) {
-    //
-    // Default to ISO 639-2 mode
-    //
-    CompareLength  = 3;
-    LanguageLength = MIN (3, AsciiStrLen (Language));
-
-    //
-    // If in RFC 4646 mode, then determine the length of the first RFC 4646 language code in Language
-    //
-    if (Iso639Language == 0) {
-      for (LanguageLength = 0; Language[LanguageLength] != 0 && Language[LanguageLength] != ';'; LanguageLength++);
-    }
-
-    //
-    // Trim back the length of Language used until it is empty
-    //
-    while (LanguageLength > 0) {
-      //
-      // Loop through all language codes in SupportedLanguages
-      //
-      for (Supported = SupportedLanguages; *Supported != '\0'; Supported += CompareLength) {
-        //
-        // In RFC 4646 mode, then Loop through all language codes in SupportedLanguages
-        //
-        if (Iso639Language == 0) {
-          //
-          // Skip ';' characters in Supported
-          //
-          for (; *Supported != '\0' && *Supported == ';'; Supported++);
-          //
-          // Determine the length of the next language code in Supported
-          //
-          for (CompareLength = 0; Supported[CompareLength] != 0 && Supported[CompareLength] != ';'; CompareLength++);
-          //
-          // If Language is longer than the Supported, then skip to the next language
-          //
-          if (LanguageLength > CompareLength) {
-            continue;
-          }
-        }
-        //
-        // See if the first LanguageLength characters in Supported match Language
-        //
-        if (AsciiStrnCmp (Supported, Language, LanguageLength) == 0) {
-          VA_END (Args);
-
-          Buffer = (Iso639Language != 0) ? mVariableModuleGlobal->Lang : mVariableModuleGlobal->PlatformLang;
-          Buffer[CompareLength] = '\0';
-          return CopyMem (Buffer, Supported, CompareLength);
-        }
-      }
-
-      if (Iso639Language != 0) {
-        //
-        // If ISO 639 mode, then each language can only be tested once
-        //
-        LanguageLength = 0;
-      } else {
-        //
-        // If RFC 4646 mode, then trim Language from the right to the next '-' character
-        //
-        for (LanguageLength--; LanguageLength > 0 && Language[LanguageLength] != '-'; LanguageLength--);
-      }
-    }
-  }
-  VA_END (Args);
-
-  //
-  // No matches were found
-  //
-  return NULL;
-}
-
-/**
-  Hook the operations in PlatformLangCodes, LangCodes, PlatformLang and Lang.
-
-  When setting Lang/LangCodes, simultaneously update PlatformLang/PlatformLangCodes.
-
-  According to UEFI spec, PlatformLangCodes/LangCodes are only set once in firmware initialization,
-  and are read-only. Therefore, in variable driver, only store the original value for other use.
-
-  @param[in] VariableName       Name of variable
-
-  @param[in] Data               Variable data
-
-  @param[in] DataSize           Size of data. 0 means delete
-
-**/
-VOID
-AutoUpdateLangVariable(
-  IN  CHAR16             *VariableName,
-  IN  VOID               *Data,
-  IN  UINTN              DataSize
-  )
-{
-  EFI_STATUS             Status;
-  CHAR8                  *BestPlatformLang;
-  CHAR8                  *BestLang;
-  UINTN                  Index;
-  UINT32                 Attributes;
-  VARIABLE_POINTER_TRACK Variable;
-  BOOLEAN                SetLanguageCodes;
-
-  //
-  // Don't do updates for delete operation
-  //
-  if (DataSize == 0) {
-    return;
-  }
-
-  SetLanguageCodes = FALSE;
-
-  if (StrCmp (VariableName, L"PlatformLangCodes") == 0) {
-    //
-    // PlatformLangCodes is a volatile variable, so it can not be updated at runtime.
-    //
-    if (EfiAtRuntime ()) {
-      return;
-    }
-
-    SetLanguageCodes = TRUE;
-
-    //
-    // According to UEFI spec, PlatformLangCodes is only set once in firmware initialization, and is read-only
-    // Therefore, in variable driver, only store the original value for other use.
-    //
-    if (mVariableModuleGlobal->PlatformLangCodes != NULL) {
-      FreePool (mVariableModuleGlobal->PlatformLangCodes);
-    }
-    mVariableModuleGlobal->PlatformLangCodes = AllocateRuntimeCopyPool (DataSize, Data);
-    ASSERT (mVariableModuleGlobal->PlatformLangCodes != NULL);
-
-    //
-    // PlatformLang holds a single language from PlatformLangCodes,
-    // so the size of PlatformLangCodes is enough for the PlatformLang.
-    //
-    if (mVariableModuleGlobal->PlatformLang != NULL) {
-      FreePool (mVariableModuleGlobal->PlatformLang);
-    }
-    mVariableModuleGlobal->PlatformLang = AllocateRuntimePool (DataSize);
-    ASSERT (mVariableModuleGlobal->PlatformLang != NULL);
-
-  } else if (StrCmp (VariableName, L"LangCodes") == 0) {
-    //
-    // LangCodes is a volatile variable, so it can not be updated at runtime.
-    //
-    if (EfiAtRuntime ()) {
-      return;
-    }
-
-    SetLanguageCodes = TRUE;
-
-    //
-    // According to UEFI spec, LangCodes is only set once in firmware initialization, and is read-only
-    // Therefore, in variable driver, only store the original value for other use.
-    //
-    if (mVariableModuleGlobal->LangCodes != NULL) {
-      FreePool (mVariableModuleGlobal->LangCodes);
-    }
-    mVariableModuleGlobal->LangCodes = AllocateRuntimeCopyPool (DataSize, Data);
-    ASSERT (mVariableModuleGlobal->LangCodes != NULL);
-  }
-
-  if (SetLanguageCodes
-      && (mVariableModuleGlobal->PlatformLangCodes != NULL)
-      && (mVariableModuleGlobal->LangCodes != NULL)) {
-    //
-    // Update Lang if PlatformLang is already set
-    // Update PlatformLang if Lang is already set
-    //
-    Status = FindVariable (L"PlatformLang", &gEfiGlobalVariableGuid, &Variable, (VARIABLE_GLOBAL *) mVariableModuleGlobal);
-    if (!EFI_ERROR (Status)) {
-      //
-      // Update Lang
-      //
-      VariableName = L"PlatformLang";
-      Data         = GetVariableDataPtr (Variable.CurrPtr);
-      DataSize     = Variable.CurrPtr->DataSize;
-    } else {
-      Status = FindVariable (L"Lang", &gEfiGlobalVariableGuid, &Variable, (VARIABLE_GLOBAL *) mVariableModuleGlobal);
-      if (!EFI_ERROR (Status)) {
-        //
-        // Update PlatformLang
-        //
-        VariableName = L"Lang";
-        Data         = GetVariableDataPtr (Variable.CurrPtr);
-        DataSize     = Variable.CurrPtr->DataSize;
-      } else {
-        //
-        // Neither PlatformLang nor Lang is set, directly return
-        //
-        return;
-      }
-    }
-  }
-
-  //
-  // According to UEFI spec, "Lang" and "PlatformLang" is NV|BS|RT attributions.
-  //
-  Attributes = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS;
-
-  if (StrCmp (VariableName, L"PlatformLang") == 0) {
-    //
-    // Update Lang when PlatformLangCodes/LangCodes were set.
-    //
-    if ((mVariableModuleGlobal->PlatformLangCodes != NULL) && (mVariableModuleGlobal->LangCodes != NULL)) {
-      //
-      // When setting PlatformLang, firstly get most matched language string from supported language codes.
-      //
-      BestPlatformLang = VariableGetBestLanguage (mVariableModuleGlobal->PlatformLangCodes, FALSE, Data, NULL);
-      if (BestPlatformLang != NULL) {
-        //
-        // Get the corresponding index in language codes.
-        //
-        Index = GetIndexFromSupportedLangCodes (mVariableModuleGlobal->PlatformLangCodes, BestPlatformLang, FALSE);
-
-        //
-        // Get the corresponding ISO639 language tag according to RFC4646 language tag.
-        //
-        BestLang = GetLangFromSupportedLangCodes (mVariableModuleGlobal->LangCodes, Index, TRUE);
-
-        //
-        // Successfully convert PlatformLang to Lang, and set the BestLang value into Lang variable simultaneously.
-        //
-        FindVariable (L"Lang", &gEfiGlobalVariableGuid, &Variable, (VARIABLE_GLOBAL *)mVariableModuleGlobal);
-
-        Status = UpdateVariable (L"Lang", &gEfiGlobalVariableGuid, BestLang, ISO_639_2_ENTRY_SIZE + 1, Attributes, &Variable);
-
-        DEBUG ((EFI_D_INFO, "Variable Driver Auto Update PlatformLang, PlatformLang:%a, Lang:%a\n", BestPlatformLang, BestLang));
-
-        ASSERT_EFI_ERROR(Status);
-      }
-    }
-
-  } else if (StrCmp (VariableName, L"Lang") == 0) {
-    //
-    // Update PlatformLang when PlatformLangCodes/LangCodes were set.
-    //
-    if ((mVariableModuleGlobal->PlatformLangCodes != NULL) && (mVariableModuleGlobal->LangCodes != NULL)) {
-      //
-      // When setting Lang, firstly get most matched language string from supported language codes.
-      //
-      BestLang = VariableGetBestLanguage (mVariableModuleGlobal->LangCodes, TRUE, Data, NULL);
-      if (BestLang != NULL) {
-        //
-        // Get the corresponding index in language codes.
-        //
-        Index = GetIndexFromSupportedLangCodes (mVariableModuleGlobal->LangCodes, BestLang, TRUE);
-
-        //
-        // Get the corresponding RFC4646 language tag according to ISO639 language tag.
-        //
-        BestPlatformLang = GetLangFromSupportedLangCodes (mVariableModuleGlobal->PlatformLangCodes, Index, FALSE);
-
-        //
-        // Successfully convert Lang to PlatformLang, and set the BestPlatformLang value into PlatformLang variable simultaneously.
-        //
-        FindVariable (L"PlatformLang", &gEfiGlobalVariableGuid, &Variable, (VARIABLE_GLOBAL *)mVariableModuleGlobal);
-
-        Status = UpdateVariable (L"PlatformLang", &gEfiGlobalVariableGuid, BestPlatformLang,
-                                 AsciiStrSize (BestPlatformLang), Attributes, &Variable);
-
-        DEBUG ((EFI_D_INFO, "Variable Driver Auto Update Lang, Lang:%a, PlatformLang:%a\n", BestLang, BestPlatformLang));
-        ASSERT_EFI_ERROR (Status);
-      }
-    }
-  }
-}
-
-/**
-  Update the variable region with Variable information. These are the same
-  arguments as the EFI Variable services.
-
-  @param[in] VariableName       Name of variable
-
-  @param[in] VendorGuid         Guid of variable
-
-  @param[in] Data               Variable data
-
-  @param[in] DataSize           Size of data. 0 means delete
-
-  @param[in] Attributes         Attribues of the variable
-
-  @param[in] Variable           The variable information which is used to keep track of variable usage.
-
-  @retval EFI_SUCCESS           The update operation is success.
-
-  @retval EFI_OUT_OF_RESOURCES  Variable region is full, can not write other data into this region.
-
-**/
-EFI_STATUS
-EFIAPI
-UpdateVariable (
-  IN      CHAR16          *VariableName,
-  IN      EFI_GUID        *VendorGuid,
-  IN      VOID            *Data,
-  IN      UINTN           DataSize,
-  IN      UINT32          Attributes OPTIONAL,
-  IN      VARIABLE_POINTER_TRACK *Variable
-  )
-{
-  EFI_STATUS              Status;
-  VARIABLE_HEADER         *NextVariable;
-  UINTN                   VarNameSize;
-  UINTN                   VarNameOffset;
-  UINTN                   VarDataOffset;
-  UINTN                   VarSize;
-  VARIABLE_GLOBAL         *Global;
-  UINTN                   NonVolatileVarableStoreSize;
-
-  Global = &mVariableModuleGlobal->VariableGlobal[Physical];
-
-  if (Variable->CurrPtr != NULL) {
-    //
-    // Update/Delete existing variable
-    //
-
-    if (EfiAtRuntime ()) {
-      //
-      // If EfiAtRuntime and the variable is Volatile and Runtime Access,
-      // the volatile is ReadOnly, and SetVariable should be aborted and
-      // return EFI_WRITE_PROTECTED.
-      //
-      if (Variable->Volatile) {
-        Status = EFI_WRITE_PROTECTED;
-        goto Done;
-      }
-      //
-      // Only variable have NV attribute can be updated/deleted in Runtime
-      //
-      if ((Variable->CurrPtr->Attributes & EFI_VARIABLE_NON_VOLATILE) == 0) {
-        Status = EFI_INVALID_PARAMETER;
-        goto Done;
-      }
-    }
-
-    //
-    // Setting a data variable with no access, or zero DataSize attributes
-    // specified causes it to be deleted.
-    //
-    if (DataSize == 0 || (Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == 0) {
-      Variable->CurrPtr->State &= VAR_DELETED;
-      UpdateVariableInfo (VariableName, VendorGuid, Variable->Volatile, FALSE, FALSE, TRUE, FALSE);
-      Status = EFI_SUCCESS;
-      goto Done;
-    }
-
-    //
-    // If the variable is marked valid and the same data has been passed in
-    // then return to the caller immediately.
-    //
-    if (Variable->CurrPtr->DataSize == DataSize &&
-        CompareMem (Data, GetVariableDataPtr (Variable->CurrPtr), DataSize) == 0
-          ) {
-      Status = EFI_SUCCESS;
-      goto Done;
-    } else if (Variable->CurrPtr->State == VAR_ADDED) {
-      //
-      // Mark the old variable as in delete transition
-      //
-      Variable->CurrPtr->State &= VAR_IN_DELETED_TRANSITION;
-    }
-
-  } else {
-    //
-    // No found existing variable, Create a new variable
-    //
-
-    //
-    // Make sure we are trying to create a new variable.
-    // Setting a data variable with no access, or zero DataSize attributes means to delete it.
-    //
-    if (DataSize == 0 || (Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == 0) {
-      Status = EFI_NOT_FOUND;
-      goto Done;
-    }
-
-    //
-    // Only variable have NV|RT attribute can be created in Runtime
-    //
-    if (EfiAtRuntime () &&
-        (((Attributes & EFI_VARIABLE_RUNTIME_ACCESS) == 0) || ((Attributes & EFI_VARIABLE_NON_VOLATILE) == 0))) {
-      Status = EFI_INVALID_PARAMETER;
-      goto Done;
-    }
-  }
-
-  //
-  // Function part - create a new variable and copy the data.
-  // Both update a variable and create a variable will come here.
-  //
-
-  VarNameOffset = sizeof (VARIABLE_HEADER);
-  VarNameSize   = StrSize (VariableName);
-  VarDataOffset = VarNameOffset + VarNameSize + GET_PAD_SIZE (VarNameSize);
-  VarSize       = VarDataOffset + DataSize + GET_PAD_SIZE (DataSize);
-
-  if ((Attributes & EFI_VARIABLE_NON_VOLATILE) != 0) {
-    NonVolatileVarableStoreSize = ((VARIABLE_STORE_HEADER *)(UINTN)(Global->NonVolatileVariableBase))->Size;
-    if ((((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != 0)
-      && ((HEADER_ALIGN (VarSize) + mVariableModuleGlobal->HwErrVariableTotalSize) > PcdGet32 (PcdHwErrStorageSize)))
-      || (((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == 0)
-      && ((HEADER_ALIGN (VarSize) + mVariableModuleGlobal->CommonVariableTotalSize) > NonVolatileVarableStoreSize - sizeof (VARIABLE_STORE_HEADER) - PcdGet32 (PcdHwErrStorageSize)))) {
-      Status = EFI_OUT_OF_RESOURCES;
-      goto Done;
-    }
-
-    NextVariable  = (VARIABLE_HEADER *) (UINT8 *) (mVariableModuleGlobal->NonVolatileLastVariableOffset
-                      + (UINTN) Global->NonVolatileVariableBase);
-    mVariableModuleGlobal->NonVolatileLastVariableOffset += HEADER_ALIGN (VarSize);
-
-    if ((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != 0) {
-      mVariableModuleGlobal->HwErrVariableTotalSize += HEADER_ALIGN (VarSize);
-    } else {
-      mVariableModuleGlobal->CommonVariableTotalSize += HEADER_ALIGN (VarSize);
-    }
-  } else {
-    if ((UINT32) (HEADER_ALIGN (VarSize) + mVariableModuleGlobal->VolatileLastVariableOffset) >
-          ((VARIABLE_STORE_HEADER *) ((UINTN) (Global->VolatileVariableBase)))->Size
-          ) {
-      Status = EFI_OUT_OF_RESOURCES;
-      goto Done;
-    }
-
-    NextVariable    = (VARIABLE_HEADER *) (UINT8 *) (mVariableModuleGlobal->VolatileLastVariableOffset
-                        + (UINTN) Global->VolatileVariableBase);
-    mVariableModuleGlobal->VolatileLastVariableOffset += HEADER_ALIGN (VarSize);
-  }
-
-  NextVariable->StartId     = VARIABLE_DATA;
-  NextVariable->Attributes  = Attributes;
-  NextVariable->State       = VAR_ADDED;
-  NextVariable->Reserved    = 0;
-
-  //
-  // There will be pad bytes after Data, the NextVariable->NameSize and
-  // NextVariable->NameSize should not include pad size so that variable
-  // service can get actual size in GetVariable
-  //
-  NextVariable->NameSize  = (UINT32)VarNameSize;
-  NextVariable->DataSize  = (UINT32)DataSize;
-
-  CopyMem (&NextVariable->VendorGuid, VendorGuid, sizeof (EFI_GUID));
-  CopyMem (
-    (UINT8 *) ((UINTN) NextVariable + VarNameOffset),
-    VariableName,
-    VarNameSize
-    );
-  CopyMem (
-    (UINT8 *) ((UINTN) NextVariable + VarDataOffset),
-    Data,
-    DataSize
-    );
-
-  //
-  // Mark the old variable as deleted
-  //
-  if (Variable->CurrPtr != NULL) {
-    Variable->CurrPtr->State &= VAR_DELETED;
-  }
-
-  UpdateVariableInfo (VariableName, VendorGuid, Variable->Volatile, FALSE, TRUE, FALSE, FALSE);
-
-  Status = EFI_SUCCESS;
-
-Done:
-  return Status;
-}
-
-/**
-  Finds variable in storage blocks of volatile and non-volatile storage areas.
-
-  This code finds variable in storage blocks of volatile and non-volatile storage areas.
-  If VariableName is an empty string, then we just return the first
-  qualified variable without comparing VariableName and VendorGuid.
-  Otherwise, VariableName and VendorGuid are compared.
-
-  @param  VariableName                Name of the variable to be found.
-  @param  VendorGuid                  Vendor GUID to be found.
-  @param  PtrTrack                    VARIABLE_POINTER_TRACK structure for output,
-                                      including the range searched and the target position.
-  @param  Global                      Pointer to VARIABLE_GLOBAL structure, including
-                                      base of volatile variable storage area, base of
-                                      NV variable storage area, and a lock.
-
-  @retval EFI_INVALID_PARAMETER       If VariableName is not an empty string, while
-                                      VendorGuid is NULL.
-  @retval EFI_SUCCESS                 Variable successfully found.
-  @retval EFI_NOT_FOUND               Variable not found.
-
-**/
-EFI_STATUS
-FindVariable (
-  IN  CHAR16                  *VariableName,
-  IN  EFI_GUID                *VendorGuid,
-  OUT VARIABLE_POINTER_TRACK  *PtrTrack,
-  IN  VARIABLE_GLOBAL         *Global
-  )
-{
-  VARIABLE_HEADER       *Variable[2];
-  VARIABLE_STORE_HEADER *VariableStoreHeader[2];
-  UINTN                 Index;
-
-  //
-  // 0: Non-Volatile, 1: Volatile
-  //
-  VariableStoreHeader[0]  = (VARIABLE_STORE_HEADER *) ((UINTN) Global->NonVolatileVariableBase);
-  VariableStoreHeader[1]  = (VARIABLE_STORE_HEADER *) ((UINTN) Global->VolatileVariableBase);
-
-  //
-  // Start Pointers for the variable.
-  // Actual Data Pointer where data can be written.
-  //
-  Variable[0] = (VARIABLE_HEADER *) HEADER_ALIGN (VariableStoreHeader[0] + 1);
-  Variable[1] = (VARIABLE_HEADER *) HEADER_ALIGN (VariableStoreHeader[1] + 1);
-
-  if (VariableName[0] != 0 && VendorGuid == NULL) {
-    return EFI_INVALID_PARAMETER;
-  }
-  //
-  // Find the variable by walk through non-volatile and volatile variable store
-  //
-  for (Index = 0; Index < 2; Index++) {
-    PtrTrack->StartPtr  = (VARIABLE_HEADER *) HEADER_ALIGN (VariableStoreHeader[Index] + 1);
-    PtrTrack->EndPtr    = GetEndPointer (VariableStoreHeader[Index]);
-
-    while ((Variable[Index] < GetEndPointer (VariableStoreHeader[Index])) && (Variable[Index] != NULL)) {
-      if (Variable[Index]->StartId == VARIABLE_DATA && Variable[Index]->State == VAR_ADDED) {
-        if (!(EfiAtRuntime () && ((Variable[Index]->Attributes & EFI_VARIABLE_RUNTIME_ACCESS) == 0))) {
-          if (VariableName[0] == 0) {
-            PtrTrack->CurrPtr   = Variable[Index];
-            PtrTrack->Volatile  = (BOOLEAN) Index;
-            return EFI_SUCCESS;
-          } else {
-            if (CompareGuid (VendorGuid, &Variable[Index]->VendorGuid)) {
-              if (CompareMem (VariableName, GET_VARIABLE_NAME_PTR (Variable[Index]), Variable[Index]->NameSize) == 0) {
-                PtrTrack->CurrPtr   = Variable[Index];
-                PtrTrack->Volatile  = (BOOLEAN) Index;
-                return EFI_SUCCESS;
-              }
-            }
-          }
-        }
-      }
-
-      Variable[Index] = GetNextVariablePtr (Variable[Index]);
-    }
-  }
-  PtrTrack->CurrPtr = NULL;
-  return EFI_NOT_FOUND;
-}
-
-/**
-  This code finds variable in storage blocks (Volatile or Non-Volatile).
-
-  @param  VariableName           A Null-terminated Unicode string that is the name of
-                                 the vendor's variable.
-  @param  VendorGuid             A unique identifier for the vendor.
-  @param  Attributes             If not NULL, a pointer to the memory location to return the
-                                 attributes bitmask for the variable.
-  @param  DataSize               Size of Data found. If size is less than the
-                                 data, this value contains the required size.
-  @param  Data                   On input, the size in bytes of the return Data buffer.
-                                 On output, the size of data returned in Data.
-  @param  Global                 Pointer to VARIABLE_GLOBAL structure
-
-  @retval EFI_SUCCESS            The function completed successfully.
-  @retval EFI_NOT_FOUND          The variable was not found.
-  @retval EFI_BUFFER_TOO_SMALL   DataSize is too small for the result.  DataSize has
-                                 been updated with the size needed to complete the request.
-  @retval EFI_INVALID_PARAMETER  VariableName or VendorGuid or DataSize is NULL.
-
-**/
-EFI_STATUS
-EFIAPI
-EmuGetVariable (
-  IN      CHAR16            *VariableName,
-  IN      EFI_GUID          *VendorGuid,
-  OUT     UINT32            *Attributes OPTIONAL,
-  IN OUT  UINTN             *DataSize,
-  OUT     VOID              *Data,
-  IN      VARIABLE_GLOBAL   *Global
-  )
-{
-  VARIABLE_POINTER_TRACK  Variable;
-  UINTN                   VarDataSize;
-  EFI_STATUS              Status;
-  UINT8                   *VariableDataPtr;
-
-  if (VariableName == NULL || VendorGuid == NULL || DataSize == NULL) {
-    return EFI_INVALID_PARAMETER;
-  }
-
-  if (VariableName[0] == 0) {
-    return EFI_NOT_FOUND;
-  }
-
-  AcquireLockOnlyAtBootTime(&Global->VariableServicesLock);
-
-  //
-  // Find existing variable
-  //
-  Status = FindVariable (VariableName, VendorGuid, &Variable, Global);
-
-  if (Variable.CurrPtr == NULL || EFI_ERROR (Status)) {
-    goto Done;
-  }
-  //
-  // Get data size
-  //
-  VarDataSize = Variable.CurrPtr->DataSize;
-  if (*DataSize >= VarDataSize) {
-    if (Data == NULL) {
-      Status = EFI_INVALID_PARAMETER;
-      goto Done;
-    }
-    VariableDataPtr = GetVariableDataPtr (Variable.CurrPtr);
-    ASSERT (VariableDataPtr != NULL);
-
-    CopyMem (Data, VariableDataPtr, VarDataSize);
-    if (Attributes != NULL) {
-      *Attributes = Variable.CurrPtr->Attributes;
-    }
-
-    *DataSize = VarDataSize;
-    UpdateVariableInfo (VariableName, VendorGuid, Variable.Volatile, TRUE, FALSE, FALSE, FALSE);
-    Status = EFI_SUCCESS;
-    goto Done;
-  } else {
-    *DataSize = VarDataSize;
-    Status = EFI_BUFFER_TOO_SMALL;
-    goto Done;
-  }
-
-Done:
-  ReleaseLockOnlyAtBootTime (&Global->VariableServicesLock);
-  return Status;
-}
-
-/**
-
-  This code Finds the Next available variable.
-
-  @param  VariableNameSize       The size of the VariableName buffer. The size must be large enough to fit input
-                                 string supplied in VariableName buffer.
-  @param  VariableName           On input, supplies the last VariableName that was returned by GetNextVariableName().
-                                 On output, returns the Null-terminated Unicode string of the current variable.
-  @param  VendorGuid             On input, supplies the last VendorGuid that was returned by GetNextVariableName().
-                                 On output, returns the VendorGuid of the current variable.
-  @param  Global                 Pointer to VARIABLE_GLOBAL structure.
-
-  @retval EFI_SUCCESS            The function completed successfully.
-  @retval EFI_NOT_FOUND          The next variable was not found.
-  @retval EFI_BUFFER_TOO_SMALL   The VariableNameSize is too small for the result.
-                                 VariableNameSize has been updated with the size needed to complete the request.
-  @retval EFI_INVALID_PARAMETER  VariableNameSize or VariableName or VendorGuid is NULL.
-  @retval EFI_INVALID_PARAMETER  The input values of VariableName and VendorGuid are not a name and
-                                 GUID of an existing variable.
-  @retval EFI_INVALID_PARAMETER  Null-terminator is not found in the first VariableNameSize bytes of
-                                 the input VariableName buffer.
-
-**/
-EFI_STATUS
-EFIAPI
-EmuGetNextVariableName (
-  IN OUT  UINTN             *VariableNameSize,
-  IN OUT  CHAR16            *VariableName,
-  IN OUT  EFI_GUID          *VendorGuid,
-  IN      VARIABLE_GLOBAL   *Global
-  )
-{
-  VARIABLE_POINTER_TRACK  Variable;
-  UINTN                   VarNameSize;
-  EFI_STATUS              Status;
-  UINTN                   MaxLen;
-
-  if (VariableNameSize == NULL || VariableName == NULL || VendorGuid == NULL) {
-    return EFI_INVALID_PARAMETER;
-  }
-
-  //
-  // Calculate the possible maximum length of name string, including the Null terminator.
-  //
-  MaxLen = *VariableNameSize / sizeof (CHAR16);
-  if ((MaxLen == 0) || (StrnLenS (VariableName, MaxLen) == MaxLen)) {
-    //
-    // Null-terminator is not found in the first VariableNameSize bytes of the input VariableName buffer,
-    // follow spec to return EFI_INVALID_PARAMETER.
-    //
-    return EFI_INVALID_PARAMETER;
-  }
-
-  AcquireLockOnlyAtBootTime(&Global->VariableServicesLock);
-
-  Status = FindVariable (VariableName, VendorGuid, &Variable, Global);
-
-  if (Variable.CurrPtr == NULL || EFI_ERROR (Status)) {
-    //
-    // For VariableName is an empty string, FindVariable() will try to find and return
-    // the first qualified variable, and if FindVariable() returns error (EFI_NOT_FOUND)
-    // as no any variable is found, still go to return the error (EFI_NOT_FOUND).
-    //
-    if (VariableName[0] != 0) {
-      //
-      // For VariableName is not an empty string, and FindVariable() returns error as
-      // VariableName and VendorGuid are not a name and GUID of an existing variable,
-      // there is no way to get next variable, follow spec to return EFI_INVALID_PARAMETER.
-      //
-      Status = EFI_INVALID_PARAMETER;
-    }
-    goto Done;
-  }
-
-  while (TRUE) {
-    if (VariableName[0] != 0) {
-      //
-      // If variable name is not NULL, get next variable
-      //
-      Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr);
-    }
-    //
-    // If both volatile and non-volatile variable store are parsed,
-    // return not found
-    //
-    if (Variable.CurrPtr >= Variable.EndPtr || Variable.CurrPtr == NULL) {
-      Variable.Volatile = (BOOLEAN) (Variable.Volatile ^ ((BOOLEAN) 0x1));
-      if (Variable.Volatile) {
-        Variable.StartPtr = (VARIABLE_HEADER *) HEADER_ALIGN ((UINTN) (Global->VolatileVariableBase + sizeof (VARIABLE_STORE_HEADER)));
-        Variable.EndPtr = (VARIABLE_HEADER *) GetEndPointer ((VARIABLE_STORE_HEADER *) ((UINTN) Global->VolatileVariableBase));
-      } else {
-        Status = EFI_NOT_FOUND;
-        goto Done;
-      }
-
-      Variable.CurrPtr = Variable.StartPtr;
-      if (Variable.CurrPtr->StartId != VARIABLE_DATA) {
-        continue;
-      }
-    }
-    //
-    // Variable is found
-    //
-    if (Variable.CurrPtr->StartId == VARIABLE_DATA && Variable.CurrPtr->State == VAR_ADDED) {
-      if (!(EfiAtRuntime () && ((Variable.CurrPtr->Attributes & EFI_VARIABLE_RUNTIME_ACCESS) == 0))) {
-        VarNameSize = Variable.CurrPtr->NameSize;
-        if (VarNameSize <= *VariableNameSize) {
-          CopyMem (
-            VariableName,
-            GET_VARIABLE_NAME_PTR (Variable.CurrPtr),
-            VarNameSize
-            );
-          CopyMem (
-            VendorGuid,
-            &Variable.CurrPtr->VendorGuid,
-            sizeof (EFI_GUID)
-            );
-          Status = EFI_SUCCESS;
-        } else {
-          Status = EFI_BUFFER_TOO_SMALL;
-        }
-
-        *VariableNameSize = VarNameSize;
-        goto Done;
-      }
-    }
-  }
-
-Done:
-  ReleaseLockOnlyAtBootTime (&Global->VariableServicesLock);
-  return Status;
-
-}
-
-/**
-
-  This code sets variable in storage blocks (Volatile or Non-Volatile).
-
-  @param  VariableName           A Null-terminated Unicode string that is the name of the vendor's
-                                 variable.  Each VariableName is unique for each
-                                 VendorGuid.  VariableName must contain 1 or more
-                                 Unicode characters.  If VariableName is an empty Unicode
-                                 string, then EFI_INVALID_PARAMETER is returned.
-  @param  VendorGuid             A unique identifier for the vendor
-  @param  Attributes             Attributes bitmask to set for the variable
-  @param  DataSize               The size in bytes of the Data buffer.  A size of zero causes the
-                                 variable to be deleted.
-  @param  Data                   The contents for the variable
-  @param  Global                 Pointer to VARIABLE_GLOBAL structure
-  @param  VolatileOffset         The offset of last volatile variable
-  @param  NonVolatileOffset      The offset of last non-volatile variable
-
-  @retval EFI_SUCCESS            The firmware has successfully stored the variable and its data as
-                                 defined by the Attributes.
-  @retval EFI_INVALID_PARAMETER  An invalid combination of attribute bits was supplied, or the
-                                 DataSize exceeds the maximum allowed, or VariableName is an empty
-                                 Unicode string, or VendorGuid is NULL.
-  @retval EFI_OUT_OF_RESOURCES   Not enough storage is available to hold the variable and its data.
-  @retval EFI_DEVICE_ERROR       The variable could not be saved due to a hardware failure.
-  @retval EFI_WRITE_PROTECTED    The variable in question is read-only or cannot be deleted.
-  @retval EFI_NOT_FOUND          The variable trying to be updated or deleted was not found.
-
-**/
-EFI_STATUS
-EFIAPI
-EmuSetVariable (
-  IN CHAR16                  *VariableName,
-  IN EFI_GUID                *VendorGuid,
-  IN UINT32                  Attributes,
-  IN UINTN                   DataSize,
-  IN VOID                    *Data,
-  IN VARIABLE_GLOBAL         *Global,
-  IN UINTN                   *VolatileOffset,
-  IN UINTN                   *NonVolatileOffset
-  )
-{
-  VARIABLE_POINTER_TRACK  Variable;
-  EFI_STATUS              Status;
-
-  //
-  // Check input parameters
-  //
-  if (VariableName == NULL || VariableName[0] == 0 || VendorGuid == NULL) {
-    return EFI_INVALID_PARAMETER;
-  }
-
-  if (DataSize != 0 && Data == NULL) {
-    return EFI_INVALID_PARAMETER;
-  }
-
-  //
-  // Not support authenticated variable write yet.
-  //
-  if ((Attributes & EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS) != 0) {
-    return EFI_INVALID_PARAMETER;
-  }
-
-  //
-  //  Make sure if runtime bit is set, boot service bit is set also
-  //
-  if ((Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == EFI_VARIABLE_RUNTIME_ACCESS) {
-    return EFI_INVALID_PARAMETER;
-  }
-
-
-  if ((UINTN)(~0) - DataSize < StrSize(VariableName)){
-    //
-    // Prevent whole variable size overflow
-    //
-    return EFI_INVALID_PARAMETER;
-  }
-
-  //
-  //  The size of the VariableName, including the Unicode Null in bytes plus
-  //  the DataSize is limited to maximum size of PcdGet32 (PcdMaxHardwareErrorVariableSize)
-  //  bytes for HwErrRec, and PcdGet32 (PcdMaxVariableSize) bytes for the others.
-  //
-  if ((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {
-    if (StrSize (VariableName) + DataSize > PcdGet32 (PcdMaxHardwareErrorVariableSize) - sizeof (VARIABLE_HEADER)) {
-      return EFI_INVALID_PARAMETER;
-    }
-    //
-    // According to UEFI spec, HARDWARE_ERROR_RECORD variable name convention should be L"HwErrRecXXXX"
-    //
-    if (StrnCmp(VariableName, L"HwErrRec", StrLen(L"HwErrRec")) != 0) {
-      return EFI_INVALID_PARAMETER;
-    }
-  } else {
-  //
-  //  The size of the VariableName, including the Unicode Null in bytes plus
-  //  the DataSize is limited to maximum size of PcdGet32 (PcdMaxVariableSize) bytes.
-  //
-    if (StrSize (VariableName) + DataSize > PcdGet32 (PcdMaxVariableSize) - sizeof (VARIABLE_HEADER)) {
-      return EFI_INVALID_PARAMETER;
-    }
-  }
-
-  AcquireLockOnlyAtBootTime(&Global->VariableServicesLock);
-
-  //
-  // Check whether the input variable is already existed
-  //
-
-  Status = FindVariable (VariableName, VendorGuid, &Variable, Global);
-
-  //
-  // Hook the operation of setting PlatformLangCodes/PlatformLang and LangCodes/Lang
-  //
-  AutoUpdateLangVariable (VariableName, Data, DataSize);
-
-  Status = UpdateVariable (VariableName, VendorGuid, Data, DataSize, Attributes, &Variable);
-
-  ReleaseLockOnlyAtBootTime (&Global->VariableServicesLock);
-  return Status;
-}
-
-/**
-
-  This code returns information about the EFI variables.
-
-  @param  Attributes                   Attributes bitmask to specify the type of variables
-                                       on which to return information.
-  @param  MaximumVariableStorageSize   On output the maximum size of the storage space available for
-                                       the EFI variables associated with the attributes specified.
-  @param  RemainingVariableStorageSize Returns the remaining size of the storage space available for EFI
-                                       variables associated with the attributes specified.
-  @param  MaximumVariableSize          Returns the maximum size of an individual EFI variable
-                                       associated with the attributes specified.
-  @param  Global                       Pointer to VARIABLE_GLOBAL structure.
-
-  @retval EFI_SUCCESS                  Valid answer returned.
-  @retval EFI_INVALID_PARAMETER        An invalid combination of attribute bits was supplied
-  @retval EFI_UNSUPPORTED              The attribute is not supported on this platform, and the
-                                       MaximumVariableStorageSize, RemainingVariableStorageSize,
-                                       MaximumVariableSize are undefined.
-
-**/
-EFI_STATUS
-EFIAPI
-EmuQueryVariableInfo (
-  IN  UINT32                 Attributes,
-  OUT UINT64                 *MaximumVariableStorageSize,
-  OUT UINT64                 *RemainingVariableStorageSize,
-  OUT UINT64                 *MaximumVariableSize,
-  IN  VARIABLE_GLOBAL        *Global
-  )
-{
-  VARIABLE_HEADER        *Variable;
-  VARIABLE_HEADER        *NextVariable;
-  UINT64                 VariableSize;
-  VARIABLE_STORE_HEADER  *VariableStoreHeader;
-  UINT64                 CommonVariableTotalSize;
-  UINT64                 HwErrVariableTotalSize;
-
-  CommonVariableTotalSize = 0;
-  HwErrVariableTotalSize = 0;
-
-  if(MaximumVariableStorageSize == NULL || RemainingVariableStorageSize == NULL || MaximumVariableSize == NULL || Attributes == 0) {
-    return EFI_INVALID_PARAMETER;
-  }
-
-  if((Attributes & (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) == 0) {
-    //
-    // Make sure the Attributes combination is supported by the platform.
-    //
-    return EFI_UNSUPPORTED;
-  } else if ((Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == EFI_VARIABLE_RUNTIME_ACCESS) {
-    //
-    // Make sure if runtime bit is set, boot service bit is set also.
-    //
-    return EFI_INVALID_PARAMETER;
-  } else if (EfiAtRuntime () && ((Attributes & EFI_VARIABLE_RUNTIME_ACCESS) == 0)) {
-    //
-    //   Make sure RT Attribute is set if we are in Runtime phase.
-    //
-    return EFI_INVALID_PARAMETER;
-  } else if ((Attributes & (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {
-    //
-    // Make sure Hw Attribute is set with NV.
-    //
-    return EFI_INVALID_PARAMETER;
-  } else if ((Attributes & EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS) != 0) {
-    //
-    // Not support authentiated variable write yet.
-    //
-    return EFI_UNSUPPORTED;
-  }
-
-  AcquireLockOnlyAtBootTime(&Global->VariableServicesLock);
-
-  if((Attributes & EFI_VARIABLE_NON_VOLATILE) == 0) {
-    //
-    // Query is Volatile related.
-    //
-    VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINTN) Global->VolatileVariableBase);
-  } else {
-    //
-    // Query is Non-Volatile related.
-    //
-    VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINTN) Global->NonVolatileVariableBase);
-  }
-
-  //
-  // Now let's fill *MaximumVariableStorageSize *RemainingVariableStorageSize
-  // with the storage size (excluding the storage header size)
-  //
-  *MaximumVariableStorageSize   = VariableStoreHeader->Size - sizeof (VARIABLE_STORE_HEADER);
-
-  //
-  // Harware error record variable needs larger size.
-  //
-  if ((Attributes & (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) == (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {
-    *MaximumVariableStorageSize = PcdGet32 (PcdHwErrStorageSize);
-    *MaximumVariableSize = PcdGet32 (PcdMaxHardwareErrorVariableSize) - sizeof (VARIABLE_HEADER);
-  } else {
-    if ((Attributes & EFI_VARIABLE_NON_VOLATILE) != 0) {
-      ASSERT (PcdGet32 (PcdHwErrStorageSize) < VariableStoreHeader->Size);
-      *MaximumVariableStorageSize = VariableStoreHeader->Size - sizeof (VARIABLE_STORE_HEADER) - PcdGet32 (PcdHwErrStorageSize);
-    }
-
-    //
-    // Let *MaximumVariableSize be PcdGet32 (PcdMaxVariableSize) with the exception of the variable header size.
-    //
-    *MaximumVariableSize = PcdGet32 (PcdMaxVariableSize) - sizeof (VARIABLE_HEADER);
-  }
-
-  //
-  // Point to the starting address of the variables.
-  //
-  Variable = (VARIABLE_HEADER *) HEADER_ALIGN (VariableStoreHeader + 1);
-
-  //
-  // Now walk through the related variable store.
-  //
-  while (Variable < GetEndPointer (VariableStoreHeader)) {
-    NextVariable = GetNextVariablePtr(Variable);
-    if (NextVariable == NULL) {
-      break;
-    }
-    VariableSize = (UINT64) (UINTN) NextVariable - (UINT64) (UINTN) Variable;
-
-    if ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {
-      HwErrVariableTotalSize += VariableSize;
-    } else {
-      CommonVariableTotalSize += VariableSize;
-    }
-
-    //
-    // Go to the next one.
-    //
-    Variable = NextVariable;
-  }
-
-  if ((Attributes  & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD){
-    *RemainingVariableStorageSize = *MaximumVariableStorageSize - HwErrVariableTotalSize;
-  } else {
-    *RemainingVariableStorageSize = *MaximumVariableStorageSize - CommonVariableTotalSize;
-  }
-
-  if (*RemainingVariableStorageSize < sizeof (VARIABLE_HEADER)) {
-    *MaximumVariableSize = 0;
-  } else if ((*RemainingVariableStorageSize - sizeof (VARIABLE_HEADER)) < *MaximumVariableSize) {
-    *MaximumVariableSize = *RemainingVariableStorageSize - sizeof (VARIABLE_HEADER);
-  }
-
-  ReleaseLockOnlyAtBootTime (&Global->VariableServicesLock);
-  return EFI_SUCCESS;
-}
-
-/**
-  Initializes variable store area.
-
-  This function allocates memory space for variable store area and initializes its attributes.
-
-  @param  VolatileStore  Indicates if the variable store is volatile.
-
-**/
-EFI_STATUS
-InitializeVariableStore (
-  IN  BOOLEAN               VolatileStore
-  )
-{
-  EFI_STATUS            Status;
-  VARIABLE_STORE_HEADER *VariableStore;
-  BOOLEAN               FullyInitializeStore;
-  EFI_PHYSICAL_ADDRESS  *VariableBase;
-  UINTN                 *LastVariableOffset;
-  VARIABLE_STORE_HEADER *VariableStoreHeader;
-  VARIABLE_HEADER       *Variable;
-  VOID                  *VariableData;
-  EFI_HOB_GUID_TYPE     *GuidHob;
-
-  FullyInitializeStore = TRUE;
-
-  if (VolatileStore) {
-    VariableBase = &mVariableModuleGlobal->VariableGlobal[Physical].VolatileVariableBase;
-    LastVariableOffset = &mVariableModuleGlobal->VolatileLastVariableOffset;
-  } else {
-    VariableBase = &mVariableModuleGlobal->VariableGlobal[Physical].NonVolatileVariableBase;
-    LastVariableOffset = &mVariableModuleGlobal->NonVolatileLastVariableOffset;
-  }
-
-  //
-  // Note that in EdkII variable driver implementation, Hardware Error Record type variable
-  // is stored with common variable in the same NV region. So the platform integrator should
-  // ensure that the value of PcdHwErrStorageSize is less than or equal to the value of
-  // PcdVariableStoreSize.
-  //
-  ASSERT (PcdGet32 (PcdHwErrStorageSize) <= PcdGet32 (PcdVariableStoreSize));
-
-  //
-  // Allocate memory for variable store.
-  //
-  if (VolatileStore || (PcdGet64 (PcdEmuVariableNvStoreReserved) == 0)) {
-    VariableStore = (VARIABLE_STORE_HEADER *) AllocateRuntimePool (PcdGet32 (PcdVariableStoreSize));
-  } else {
-    //
-    // A memory location has been reserved for the NV variable store.  Certain
-    // platforms may be able to preserve a memory range across system resets,
-    // thereby providing better NV variable emulation.
-    //
-    VariableStore =
-      (VARIABLE_STORE_HEADER *)(VOID*)(UINTN)
-        PcdGet64 (PcdEmuVariableNvStoreReserved);
-    if (
-         (VariableStore->Size == PcdGet32 (PcdVariableStoreSize)) &&
-         (VariableStore->Format == VARIABLE_STORE_FORMATTED) &&
-         (VariableStore->State == VARIABLE_STORE_HEALTHY)
-       ) {
-      DEBUG((
-        EFI_D_INFO,
-        "Variable Store reserved at %p appears to be valid\n",
-        VariableStore
-        ));
-      FullyInitializeStore = FALSE;
-    }
-  }
-
-  if (NULL == VariableStore) {
-    return EFI_OUT_OF_RESOURCES;
-  }
-
-  if (FullyInitializeStore) {
-    SetMem (VariableStore, PcdGet32 (PcdVariableStoreSize), 0xff);
-  }
-
-  //
-  // Variable Specific Data
-  //
-  *VariableBase             = (EFI_PHYSICAL_ADDRESS) (UINTN) VariableStore;
-  InitializeLocationForLastVariableOffset (VariableStore, LastVariableOffset);
-
-  CopyGuid (&VariableStore->Signature, &gEfiVariableGuid);
-  VariableStore->Size       = PcdGet32 (PcdVariableStoreSize);
-  VariableStore->Format     = VARIABLE_STORE_FORMATTED;
-  VariableStore->State      = VARIABLE_STORE_HEALTHY;
-  VariableStore->Reserved   = 0;
-  VariableStore->Reserved1  = 0;
-
-  if (!VolatileStore) {
-    //
-    // Get HOB variable store.
-    //
-    GuidHob = GetFirstGuidHob (&gEfiVariableGuid);
-    if (GuidHob != NULL) {
-      VariableStoreHeader = (VARIABLE_STORE_HEADER *) GET_GUID_HOB_DATA (GuidHob);
-      if (CompareGuid (&VariableStoreHeader->Signature, &gEfiVariableGuid) &&
-          (VariableStoreHeader->Format == VARIABLE_STORE_FORMATTED) &&
-          (VariableStoreHeader->State == VARIABLE_STORE_HEALTHY)
-         ) {
-        DEBUG ((EFI_D_INFO, "HOB Variable Store appears to be valid.\n"));
-        //
-        // Flush the HOB variable to Emulation Variable storage.
-        //
-        for ( Variable = (VARIABLE_HEADER *) HEADER_ALIGN (VariableStoreHeader + 1)
-            ; (Variable < GetEndPointer (VariableStoreHeader) && (Variable != NULL))
-            ; Variable = GetNextVariablePtr (Variable)
-            ) {
-          ASSERT (Variable->State == VAR_ADDED);
-          ASSERT ((Variable->Attributes & EFI_VARIABLE_NON_VOLATILE) != 0);
-          VariableData = GetVariableDataPtr (Variable);
-          Status = EmuSetVariable (
-                     GET_VARIABLE_NAME_PTR (Variable),
-                     &Variable->VendorGuid,
-                     Variable->Attributes,
-                     Variable->DataSize,
-                     VariableData,
-                     &mVariableModuleGlobal->VariableGlobal[Physical],
-                     &mVariableModuleGlobal->VolatileLastVariableOffset,
-                     &mVariableModuleGlobal->NonVolatileLastVariableOffset
-                     );
-          ASSERT_EFI_ERROR (Status);
-        }
-      }
-    }
-  }
-
-  return EFI_SUCCESS;
-}
-
-/**
-  Initializes variable store area for non-volatile and volatile variable.
-
-  This function allocates and initializes memory space for global context of ESAL
-  variable service and variable store area for non-volatile and volatile variable.
-
-  @param  ImageHandle           The Image handle of this driver.
-  @param  SystemTable           The pointer of EFI_SYSTEM_TABLE.
-
-  @retval EFI_SUCCESS           Function successfully executed.
-  @retval EFI_OUT_OF_RESOURCES  Fail to allocate enough memory resource.
-
-**/
-EFI_STATUS
-EFIAPI
-VariableCommonInitialize (
-  IN EFI_HANDLE         ImageHandle,
-  IN EFI_SYSTEM_TABLE   *SystemTable
-  )
-{
-  EFI_STATUS  Status;
-
-  //
-  // Allocate memory for mVariableModuleGlobal
-  //
-  mVariableModuleGlobal = (ESAL_VARIABLE_GLOBAL *) AllocateRuntimeZeroPool (
-                                                    sizeof (ESAL_VARIABLE_GLOBAL)
-                                                   );
-  if (NULL == mVariableModuleGlobal) {
-    return EFI_OUT_OF_RESOURCES;
-  }
-
-  EfiInitializeLock(&mVariableModuleGlobal->VariableGlobal[Physical].VariableServicesLock, TPL_NOTIFY);
-
-  //
-  // Intialize volatile variable store
-  //
-  Status = InitializeVariableStore (TRUE);
-  if (EFI_ERROR (Status)) {
-    FreePool(mVariableModuleGlobal);
-    return Status;
-  }
-  //
-  // Intialize non volatile variable store
-  //
-  Status = InitializeVariableStore (FALSE);
-
-  return Status;
-}
diff --git a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf
deleted file mode 100644
index 12d52dd130e3..000000000000
--- a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.inf
+++ /dev/null
@@ -1,88 +0,0 @@
-## @file
-# Emulation Variable for EFI_RUNTIME_SERVICES.
-#
-# This module installs variable arch protocol and variable write arch protocol to provide
-# four EFI_RUNTIME_SERVICES: SetVariable, GetVariable, GetNextVariableName and QueryVariableInfo.
-#
-# Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
-#
-#  This program and the accompanying materials
-#  are licensed and made available under the terms and conditions of the BSD License
-#  which accompanies this distribution. The full text of the license may be found at
-#  http://opensource.org/licenses/bsd-license.php
-#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-#
-#
-##
-
-[Defines]
-  INF_VERSION                    = 0x00010005
-  BASE_NAME                      = EmuVariableRuntimeDxe
-  MODULE_UNI_FILE                = EmuVariableRuntimeDxe.uni
-  FILE_GUID                      = 02B01AD5-7E59-43e8-A6D8-238180613A5A
-  MODULE_TYPE                    = DXE_RUNTIME_DRIVER
-  VERSION_STRING                 = 1.0
-  ENTRY_POINT                    = VariableServiceInitialize
-
-#
-# The following information is for reference only and not required by the build tools.
-#
-#  VALID_ARCHITECTURES           = IA32 X64 EBC
-#
-
-[Sources]
-  InitVariable.c
-  EmuVariable.c
-  Variable.h
-
-
-[Packages]
-  MdePkg/MdePkg.dec
-  MdeModulePkg/MdeModulePkg.dec
-
-
-[LibraryClasses]
-  BaseLib
-  UefiLib
-  UefiBootServicesTableLib
-  UefiDriverEntryPoint
-  UefiRuntimeLib
-  DebugLib
-  MemoryAllocationLib
-  BaseMemoryLib
-  HobLib
-  PcdLib
-
-[Protocols]
-  gEfiVariableArchProtocolGuid                  ## PRODUCES
-  gEfiVariableWriteArchProtocolGuid             ## PRODUCES
-
-[Guids]
-  gEfiEventVirtualAddressChangeGuid             ## CONSUMES             ## Event
-  ## SOMETIMES_CONSUMES   ## Variable:L"PlatformLang"
-  ## SOMETIMES_PRODUCES   ## Variable:L"PlatformLang"
-  ## SOMETIMES_CONSUMES   ## Variable:L"Lang"
-  ## SOMETIMES_PRODUCES   ## Variable:L"Lang"
-  gEfiGlobalVariableGuid
-  ## PRODUCES             ## GUID # Signature of Variable store header
-  ## CONSUMES             ## GUID # Signature of Variable store header
-  ## SOMETIMES_CONSUMES   ## HOB
-  ## SOMETIMES_PRODUCES   ## SystemTable
-  gEfiVariableGuid
-
-[Pcd]
-  gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvStoreReserved      ## CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize                 ## CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdMaxHardwareErrorVariableSize    ## CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdVariableStoreSize               ## CONSUMES
-  gEfiMdeModulePkgTokenSpaceGuid.PcdHwErrStorageSize                ## CONSUMES
-
-[FeaturePcd]
-  gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics   ## CONSUMES # statistic the information of variable.
-
-[Depex]
-  TRUE
-
-[UserExtensions.TianoCore."ExtraFiles"]
-  EmuVariableRuntimeDxeExtra.uni
diff --git a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.uni b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.uni
deleted file mode 100644
index 6ad601812169..000000000000
--- a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.uni
+++ /dev/null
@@ -1,22 +0,0 @@
-// /** @file
-// Emulation Variable for EFI_RUNTIME_SERVICES.
-//
-// This module installs variable arch protocol and variable write arch protocol to provide
-// four EFI_RUNTIME_SERVICES: SetVariable, GetVariable, GetNextVariableName and QueryVariableInfo.
-//
-// Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
-//
-// This program and the accompanying materials
-// are licensed and made available under the terms and conditions of the BSD License
-// which accompanies this distribution. The full text of the license may be found at
-// http://opensource.org/licenses/bsd-license.php
-// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-//
-// **/
-
-
-#string STR_MODULE_ABSTRACT             #language en-US "Emulation Variable for EFI_RUNTIME_SERVICES"
-
-#string STR_MODULE_DESCRIPTION          #language en-US "This module installs variable arch protocol and variable write arch protocol to provide four EFI_RUNTIME_SERVICES: SetVariable, GetVariable, GetNextVariableName and QueryVariableInfo."
-
diff --git a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxeExtra.uni b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxeExtra.uni
deleted file mode 100644
index a5000373733e..000000000000
--- a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxeExtra.uni
+++ /dev/null
@@ -1,19 +0,0 @@
-// /** @file
-// EmuVariableRuntimeDxe Localized Strings and Content
-//
-// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>
-//
-// This program and the accompanying materials
-// are licensed and made available under the terms and conditions of the BSD License
-// which accompanies this distribution. The full text of the license may be found at
-// http://opensource.org/licenses/bsd-license.php
-// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-//
-// **/
-
-#string STR_PROPERTIES_MODULE_NAME
-#language en-US
-"Emulation Variable DXE Driver"
-
-
diff --git a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/InitVariable.c b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/InitVariable.c
deleted file mode 100644
index dac0464253d6..000000000000
--- a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/InitVariable.c
+++ /dev/null
@@ -1,259 +0,0 @@
-/** @file
-
-  Implment all four UEFI runtime variable services and
-  install variable architeture protocol.
-
-Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
-This program and the accompanying materials
-are licensed and made available under the terms and conditions of the BSD License
-which accompanies this distribution.  The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
-**/
-
-#include "Variable.h"
-
-EFI_EVENT   mVirtualAddressChangeEvent = NULL;
-
-/**
-
-  This code finds variable in storage blocks (Volatile or Non-Volatile).
-
-  @param VariableName               Name of Variable to be found.
-  @param VendorGuid                 Variable vendor GUID.
-  @param Attributes                 Attribute value of the variable found.
-  @param DataSize                   Size of Data found. If size is less than the
-                                    data, this value contains the required size.
-  @param Data                       The buffer to return the contents of the variable. May be NULL
-                                    with a zero DataSize in order to determine the size buffer needed.
-
-  @return EFI_INVALID_PARAMETER     Invalid parameter
-  @return EFI_SUCCESS               Find the specified variable
-  @return EFI_NOT_FOUND             Not found
-  @return EFI_BUFFER_TO_SMALL       DataSize is too small for the result
-
-**/
-EFI_STATUS
-EFIAPI
-RuntimeServiceGetVariable (
-  IN CHAR16        *VariableName,
-  IN EFI_GUID      *VendorGuid,
-  OUT UINT32       *Attributes OPTIONAL,
-  IN OUT UINTN     *DataSize,
-  OUT VOID         *Data OPTIONAL
-  )
-{
-  return EmuGetVariable (
-          VariableName,
-          VendorGuid,
-          Attributes OPTIONAL,
-          DataSize,
-          Data,
-          &mVariableModuleGlobal->VariableGlobal[Physical]
-          );
-}
-
-/**
-
-  This code Finds the Next available variable.
-
-  @param  VariableNameSize       The size of the VariableName buffer. The size must be large enough to fit input
-                                 string supplied in VariableName buffer.
-  @param  VariableName           On input, supplies the last VariableName that was returned by GetNextVariableName().
-                                 On output, returns the Null-terminated Unicode string of the current variable.
-  @param  VendorGuid             On input, supplies the last VendorGuid that was returned by GetNextVariableName().
-                                 On output, returns the VendorGuid of the current variable.
-
-  @retval EFI_SUCCESS            The function completed successfully.
-  @retval EFI_NOT_FOUND          The next variable was not found.
-  @retval EFI_BUFFER_TOO_SMALL   The VariableNameSize is too small for the result.
-                                 VariableNameSize has been updated with the size needed to complete the request.
-  @retval EFI_INVALID_PARAMETER  VariableNameSize or VariableName or VendorGuid is NULL.
-  @retval EFI_INVALID_PARAMETER  The input values of VariableName and VendorGuid are not a name and
-                                 GUID of an existing variable.
-  @retval EFI_INVALID_PARAMETER  Null-terminator is not found in the first VariableNameSize bytes of
-                                 the input VariableName buffer.
-
-**/
-EFI_STATUS
-EFIAPI
-RuntimeServiceGetNextVariableName (
-  IN OUT UINTN     *VariableNameSize,
-  IN OUT CHAR16    *VariableName,
-  IN OUT EFI_GUID  *VendorGuid
-  )
-{
-  return EmuGetNextVariableName (
-          VariableNameSize,
-          VariableName,
-          VendorGuid,
-          &mVariableModuleGlobal->VariableGlobal[Physical]
-          );
-}
-
-/**
-
-  This code sets variable in storage blocks (Volatile or Non-Volatile).
-
-  @param VariableName                     Name of Variable to be found
-  @param VendorGuid                       Variable vendor GUID
-  @param Attributes                       Attribute value of the variable found
-  @param DataSize                         Size of Data found. If size is less than the
-                                          data, this value contains the required size.
-  @param Data                             Data pointer
-
-  @return EFI_INVALID_PARAMETER           Invalid parameter
-  @return EFI_SUCCESS                     Set successfully
-  @return EFI_OUT_OF_RESOURCES            Resource not enough to set variable
-  @return EFI_NOT_FOUND                   Not found
-  @return EFI_WRITE_PROTECTED             Variable is read-only
-
-**/
-EFI_STATUS
-EFIAPI
-RuntimeServiceSetVariable (
-  IN CHAR16        *VariableName,
-  IN EFI_GUID      *VendorGuid,
-  IN UINT32        Attributes,
-  IN UINTN         DataSize,
-  IN VOID          *Data
-  )
-{
-  return EmuSetVariable (
-          VariableName,
-          VendorGuid,
-          Attributes,
-          DataSize,
-          Data,
-          &mVariableModuleGlobal->VariableGlobal[Physical],
-          &mVariableModuleGlobal->VolatileLastVariableOffset,
-          &mVariableModuleGlobal->NonVolatileLastVariableOffset
-          );
-}
-
-/**
-
-  This code returns information about the EFI variables.
-
-  @param Attributes                     Attributes bitmask to specify the type of variables
-                                        on which to return information.
-  @param MaximumVariableStorageSize     Pointer to the maximum size of the storage space available
-                                        for the EFI variables associated with the attributes specified.
-  @param RemainingVariableStorageSize   Pointer to the remaining size of the storage space available
-                                        for EFI variables associated with the attributes specified.
-  @param MaximumVariableSize            Pointer to the maximum size of an individual EFI variables
-                                        associated with the attributes specified.
-
-  @return EFI_INVALID_PARAMETER         An invalid combination of attribute bits was supplied.
-  @return EFI_SUCCESS                   Query successfully.
-  @return EFI_UNSUPPORTED               The attribute is not supported on this platform.
-
-**/
-EFI_STATUS
-EFIAPI
-RuntimeServiceQueryVariableInfo (
-  IN  UINT32                 Attributes,
-  OUT UINT64                 *MaximumVariableStorageSize,
-  OUT UINT64                 *RemainingVariableStorageSize,
-  OUT UINT64                 *MaximumVariableSize
-  )
-{
-  return EmuQueryVariableInfo (
-          Attributes,
-          MaximumVariableStorageSize,
-          RemainingVariableStorageSize,
-          MaximumVariableSize,
-          &mVariableModuleGlobal->VariableGlobal[Physical]
-          );
-}
-
-/**
-  Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.
-
-  This is a notification function registered on EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
-  It convers pointer to new virtual address.
-
-  @param  Event        Event whose notification function is being invoked.
-  @param  Context      Pointer to the notification function's context.
-
-**/
-VOID
-EFIAPI
-VariableClassAddressChangeEvent (
-  IN EFI_EVENT        Event,
-  IN VOID             *Context
-  )
-{
-  EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->PlatformLangCodes);
-  EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->LangCodes);
-  EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->PlatformLang);
-  EfiConvertPointer (
-    0x0,
-    (VOID **) &mVariableModuleGlobal->VariableGlobal[Physical].NonVolatileVariableBase
-    );
-  EfiConvertPointer (
-    0x0,
-    (VOID **) &mVariableModuleGlobal->VariableGlobal[Physical].VolatileVariableBase
-    );
-  EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal);
-}
-
-/**
-  EmuVariable Driver main entry point. The Variable driver places the 4 EFI
-  runtime services in the EFI System Table and installs arch protocols
-  for variable read and write services being available. It also registers
-  notification function for EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
-
-  @param[in] ImageHandle    The firmware allocated handle for the EFI image.
-  @param[in] SystemTable    A pointer to the EFI System Table.
-
-  @retval EFI_SUCCESS       Variable service successfully initialized.
-
-**/
-EFI_STATUS
-EFIAPI
-VariableServiceInitialize (
-  IN EFI_HANDLE         ImageHandle,
-  IN EFI_SYSTEM_TABLE   *SystemTable
-  )
-{
-  EFI_HANDLE  NewHandle;
-  EFI_STATUS  Status;
-
-  Status = VariableCommonInitialize (ImageHandle, SystemTable);
-  ASSERT_EFI_ERROR (Status);
-
-  SystemTable->RuntimeServices->GetVariable         = RuntimeServiceGetVariable;
-  SystemTable->RuntimeServices->GetNextVariableName = RuntimeServiceGetNextVariableName;
-  SystemTable->RuntimeServices->SetVariable         = RuntimeServiceSetVariable;
-  SystemTable->RuntimeServices->QueryVariableInfo   = RuntimeServiceQueryVariableInfo;
-
-  //
-  // Now install the Variable Runtime Architectural Protocol on a new handle
-  //
-  NewHandle = NULL;
-  Status = gBS->InstallMultipleProtocolInterfaces (
-                  &NewHandle,
-                  &gEfiVariableArchProtocolGuid,
-                  NULL,
-                  &gEfiVariableWriteArchProtocolGuid,
-                  NULL,
-                  NULL
-                  );
-  ASSERT_EFI_ERROR (Status);
-
-  Status = gBS->CreateEventEx (
-                  EVT_NOTIFY_SIGNAL,
-                  TPL_NOTIFY,
-                  VariableClassAddressChangeEvent,
-                  NULL,
-                  &gEfiEventVirtualAddressChangeGuid,
-                  &mVirtualAddressChangeEvent
-                  );
-  ASSERT_EFI_ERROR (Status);
-
-  return EFI_SUCCESS;
-}
diff --git a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h
deleted file mode 100644
index 2851582d0dc0..000000000000
--- a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h
+++ /dev/null
@@ -1,277 +0,0 @@
-/** @file
-
-  The internal header file includes the common header files, defines
-  internal structure and functions used by EmuVariable module.
-
-Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
-This program and the accompanying materials
-are licensed and made available under the terms and conditions of the BSD License
-which accompanies this distribution.  The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
-**/
-
-#ifndef _VARIABLE_H_
-#define _VARIABLE_H_
-
-#include <Uefi.h>
-
-#include <Protocol/VariableWrite.h>
-#include <Protocol/Variable.h>
-
-#include <Library/BaseMemoryLib.h>
-#include <Library/MemoryAllocationLib.h>
-#include <Library/DebugLib.h>
-#include <Library/UefiRuntimeLib.h>
-#include <Library/UefiDriverEntryPoint.h>
-#include <Library/UefiBootServicesTableLib.h>
-#include <Library/UefiLib.h>
-#include <Library/BaseLib.h>
-#include <Library/PcdLib.h>
-#include <Library/HobLib.h>
-#include <Guid/VariableFormat.h>
-#include <Guid/GlobalVariable.h>
-
-#include <Guid/EventGroup.h>
-
-#define GET_VARIABLE_NAME_PTR(a)  (CHAR16 *) ((UINTN) (a) + sizeof (VARIABLE_HEADER))
-
-///
-/// The size of a 3 character ISO639 language code.
-///
-#define ISO_639_2_ENTRY_SIZE    3
-
-typedef enum {
-  Physical,
-  Virtual
-} VARIABLE_POINTER_TYPE;
-
-typedef struct {
-  VARIABLE_HEADER *CurrPtr;
-  VARIABLE_HEADER *EndPtr;
-  VARIABLE_HEADER *StartPtr;
-  BOOLEAN         Volatile;
-} VARIABLE_POINTER_TRACK;
-
-typedef struct {
-  EFI_PHYSICAL_ADDRESS  VolatileVariableBase;
-  EFI_PHYSICAL_ADDRESS  NonVolatileVariableBase;
-  EFI_LOCK              VariableServicesLock;
-} VARIABLE_GLOBAL;
-
-typedef struct {
-  VARIABLE_GLOBAL VariableGlobal[2];
-  UINTN           VolatileLastVariableOffset;
-  UINTN           NonVolatileLastVariableOffset;
-  UINTN           CommonVariableTotalSize;
-  UINTN           HwErrVariableTotalSize;
-  CHAR8           *PlatformLangCodes;
-  CHAR8           *LangCodes;
-  CHAR8           *PlatformLang;
-  CHAR8           Lang[ISO_639_2_ENTRY_SIZE + 1];
-} ESAL_VARIABLE_GLOBAL;
-
-///
-/// Don't use module globals after the SetVirtualAddress map is signaled
-///
-extern ESAL_VARIABLE_GLOBAL *mVariableModuleGlobal;
-
-/**
-  Initializes variable store area for non-volatile and volatile variable.
-
-  This function allocates and initializes memory space for global context of ESAL
-  variable service and variable store area for non-volatile and volatile variable.
-
-  @param  ImageHandle           The Image handle of this driver.
-  @param  SystemTable           The pointer of EFI_SYSTEM_TABLE.
-
-  @retval EFI_SUCCESS           Function successfully executed.
-  @retval EFI_OUT_OF_RESOURCES  Fail to allocate enough memory resource.
-
-**/
-EFI_STATUS
-EFIAPI
-VariableCommonInitialize (
-  IN EFI_HANDLE         ImageHandle,
-  IN EFI_SYSTEM_TABLE   *SystemTable
-  );
-
-/**
-  Entry point of EmuVariable service module.
-
-  This function is the entry point of EmuVariable service module.
-  It registers all interfaces of Variable Services, initializes
-  variable store for non-volatile and volatile variables, and registers
-  notification function for EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
-
-  @param  ImageHandle   The Image handle of this driver.
-  @param  SystemTable   The pointer of EFI_SYSTEM_TABLE.
-
-  @retval EFI_SUCCESS   Variable service successfully initialized.
-
-**/
-EFI_STATUS
-EFIAPI
-VariableServiceInitialize (
-  IN EFI_HANDLE         ImageHandle,
-  IN EFI_SYSTEM_TABLE   *SystemTable
-  );
-
-/**
-  Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.
-
-  This is a notification function registered on EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
-  It convers pointer to new virtual address.
-
-  @param  Event        Event whose notification function is being invoked.
-  @param  Context      Pointer to the notification function's context.
-
-**/
-VOID
-EFIAPI
-VariableClassAddressChangeEvent (
-  IN EFI_EVENT        Event,
-  IN VOID             *Context
-  );
-
-/**
-  This code finds variable in storage blocks (Volatile or Non-Volatile).
-
-  @param  VariableName           A Null-terminated Unicode string that is the name of
-                                 the vendor's variable.
-  @param  VendorGuid             A unique identifier for the vendor.
-  @param  Attributes             If not NULL, a pointer to the memory location to return the
-                                 attributes bitmask for the variable.
-  @param  DataSize               Size of Data found. If size is less than the
-                                 data, this value contains the required size.
-  @param  Data                   On input, the size in bytes of the return Data buffer.
-                                 On output, the size of data returned in Data.
-  @param  Global                 Pointer to VARIABLE_GLOBAL structure
-
-  @retval EFI_SUCCESS            The function completed successfully.
-  @retval EFI_NOT_FOUND          The variable was not found.
-  @retval EFI_BUFFER_TOO_SMALL   DataSize is too small for the result.  DataSize has
-                                 been updated with the size needed to complete the request.
-  @retval EFI_INVALID_PARAMETER  VariableName or VendorGuid or DataSize is NULL.
-
-**/
-EFI_STATUS
-EFIAPI
-EmuGetVariable (
-  IN      CHAR16            *VariableName,
-  IN      EFI_GUID          *VendorGuid,
-  OUT     UINT32            *Attributes OPTIONAL,
-  IN OUT  UINTN             *DataSize,
-  OUT     VOID              *Data,
-  IN      VARIABLE_GLOBAL   *Global
-  );
-
-/**
-
-  This code finds the next available variable.
-
-  @param  VariableNameSize       The size of the VariableName buffer. The size must be large enough to fit input
-                                 string supplied in VariableName buffer.
-  @param  VariableName           On input, supplies the last VariableName that was returned by GetNextVariableName().
-                                 On output, returns the Null-terminated Unicode string of the current variable.
-  @param  VendorGuid             On input, supplies the last VendorGuid that was returned by GetNextVariableName().
-                                 On output, returns the VendorGuid of the current variable.
-  @param  Global                 Pointer to VARIABLE_GLOBAL structure.
-
-  @retval EFI_SUCCESS            The function completed successfully.
-  @retval EFI_NOT_FOUND          The next variable was not found.
-  @retval EFI_BUFFER_TOO_SMALL   The VariableNameSize is too small for the result.
-                                 VariableNameSize has been updated with the size needed to complete the request.
-  @retval EFI_INVALID_PARAMETER  VariableNameSize or VariableName or VendorGuid is NULL.
-  @retval EFI_INVALID_PARAMETER  The input values of VariableName and VendorGuid are not a name and
-                                 GUID of an existing variable.
-  @retval EFI_INVALID_PARAMETER  Null-terminator is not found in the first VariableNameSize bytes of
-                                 the input VariableName buffer.
-
-**/
-EFI_STATUS
-EFIAPI
-EmuGetNextVariableName (
-  IN OUT  UINTN             *VariableNameSize,
-  IN OUT  CHAR16            *VariableName,
-  IN OUT  EFI_GUID          *VendorGuid,
-  IN      VARIABLE_GLOBAL   *Global
-  );
-
-/**
-
-  This code sets variable in storage blocks (Volatile or Non-Volatile).
-
-  @param  VariableName           A Null-terminated Unicode string that is the name of the vendor's
-                                 variable.  Each VariableName is unique for each
-                                 VendorGuid.  VariableName must contain 1 or more
-                                 Unicode characters.  If VariableName is an empty Unicode
-                                 string, then EFI_INVALID_PARAMETER is returned.
-  @param  VendorGuid             A unique identifier for the vendor
-  @param  Attributes             Attributes bitmask to set for the variable
-  @param  DataSize               The size in bytes of the Data buffer.  A size of zero causes the
-                                 variable to be deleted.
-  @param  Data                   The contents for the variable
-  @param  Global                 Pointer to VARIABLE_GLOBAL structure
-  @param  VolatileOffset         The offset of last volatile variable
-  @param  NonVolatileOffset      The offset of last non-volatile variable
-
-  @retval EFI_SUCCESS            The firmware has successfully stored the variable and its data as
-                                 defined by the Attributes.
-  @retval EFI_INVALID_PARAMETER  An invalid combination of attribute bits was supplied, or the
-                                 DataSize exceeds the maximum allowed, or VariableName is an empty
-                                 Unicode string, or VendorGuid is NULL.
-  @retval EFI_OUT_OF_RESOURCES   Not enough storage is available to hold the variable and its data.
-  @retval EFI_DEVICE_ERROR       The variable could not be saved due to a hardware failure.
-  @retval EFI_WRITE_PROTECTED    The variable in question is read-only or cannot be deleted.
-  @retval EFI_NOT_FOUND          The variable trying to be updated or deleted was not found.
-
-**/
-EFI_STATUS
-EFIAPI
-EmuSetVariable (
-  IN CHAR16                  *VariableName,
-  IN EFI_GUID                *VendorGuid,
-  IN UINT32                  Attributes,
-  IN UINTN                   DataSize,
-  IN VOID                    *Data,
-  IN VARIABLE_GLOBAL         *Global,
-  IN UINTN                   *VolatileOffset,
-  IN UINTN                   *NonVolatileOffset
-  );
-
-/**
-
-  This code returns information about the EFI variables.
-
-  @param  Attributes                   Attributes bitmask to specify the type of variables
-                                       on which to return information.
-  @param  MaximumVariableStorageSize   On output the maximum size of the storage space available for
-                                       the EFI variables associated with the attributes specified.
-  @param  RemainingVariableStorageSize Returns the remaining size of the storage space available for EFI
-                                       variables associated with the attributes specified.
-  @param  MaximumVariableSize          Returns the maximum size of an individual EFI variable
-                                       associated with the attributes specified.
-  @param  Global                       Pointer to VARIABLE_GLOBAL structure.
-
-  @retval EFI_SUCCESS                  Valid answer returned.
-  @retval EFI_INVALID_PARAMETER        An invalid combination of attribute bits was supplied
-  @retval EFI_UNSUPPORTED              The attribute is not supported on this platform, and the
-                                       MaximumVariableStorageSize, RemainingVariableStorageSize,
-                                       MaximumVariableSize are undefined.
-
-**/
-EFI_STATUS
-EFIAPI
-EmuQueryVariableInfo (
-  IN  UINT32                 Attributes,
-  OUT UINT64                 *MaximumVariableStorageSize,
-  OUT UINT64                 *RemainingVariableStorageSize,
-  OUT UINT64                 *MaximumVariableSize,
-  IN  VARIABLE_GLOBAL        *Global
-  );
-
-#endif
-- 
2.7.0.windows.1

Re: [PATCH 12/12] MdeModule: Remove EmuVariableRuntimeDxe

[Wang, Jian J]

Reviewed-by: Jian J Wang <jian.j.wang@intel.com>

> -----Original Message-----
> From: Zeng, Star
> Sent: Sunday, January 13, 2019 11:38 PM
> To: edk2-devel@lists.01.org
> Cc: Zeng, Star <star.zeng@intel.com>; Wang, Jian J <jian.j.wang@intel.com>;
> Wu, Hao A <hao.a.wu@intel.com>
> Subject: [PATCH 12/12] MdeModule: Remove EmuVariableRuntimeDxe
> 
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1323
> Merge EmuVariable and Real variable driver.
> 
> The real variable driver has been updated to support emulated
> variable NV mode.
> This patch removes EmuVariableRuntimeDxe after platforms are
> migrated to use the merged variable driver.
> 
> Cc: Jian J Wang <jian.j.wang@intel.com>
> Cc: Hao Wu <hao.a.wu@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Star Zeng <star.zeng@intel.com>
> ---
>  MdeModulePkg/MdeModulePkg.dsc                      |    5 +-
>  .../Universal/Variable/EmuRuntimeDxe/EmuVariable.c | 1820 --------------------
>  .../EmuRuntimeDxe/EmuVariableRuntimeDxe.inf        |   88 -
>  .../EmuRuntimeDxe/EmuVariableRuntimeDxe.uni        |   22 -
>  .../EmuRuntimeDxe/EmuVariableRuntimeDxeExtra.uni   |   19 -
>  .../Variable/EmuRuntimeDxe/InitVariable.c          |  259 ---
>  .../Universal/Variable/EmuRuntimeDxe/Variable.h    |  277 ---
>  7 files changed, 1 insertion(+), 2489 deletions(-)
>  delete mode 100644
> MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariable.c
>  delete mode 100644
> MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.i
> nf
>  delete mode 100644
> MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.u
> ni
>  delete mode 100644
> MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxeE
> xtra.uni
>  delete mode 100644
> MdeModulePkg/Universal/Variable/EmuRuntimeDxe/InitVariable.c
>  delete mode 100644
> MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h
> 
> diff --git a/MdeModulePkg/MdeModulePkg.dsc
> b/MdeModulePkg/MdeModulePkg.dsc
> index 5d042be3a862..3186f35a1a48 100644
> --- a/MdeModulePkg/MdeModulePkg.dsc
> +++ b/MdeModulePkg/MdeModulePkg.dsc
> @@ -2,7 +2,7 @@
>  # EFI/PI Reference Module Package for All Architectures
>  #
>  # (C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>
> -# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
> +# Copyright (c) 2007 - 2019, Intel Corporation. All rights reserved.<BR>
>  #
>  #    This program and the accompanying materials
>  #    are licensed and made available under the terms and conditions of the BSD
> License
> @@ -433,9 +433,6 @@ [Components.IA32, Components.X64,
> Components.ARM, Components.AARCH64]
> 
> NULL|MdeModulePkg/Library/DxeCrc32GuidedSectionExtractLib/DxeCrc32Guid
> edSectionExtractLib.inf
>    }
> 
> -[Components.IA32, Components.X64, Components.Ebc]
> -
> MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDxe.i
> nf
> -
>  [Components.IA32, Components.X64]
>    MdeModulePkg/Application/SmiHandlerProfileInfo/SmiHandlerProfileInfo.inf
>    MdeModulePkg/Core/PiSmmCore/PiSmmIpl.inf
> diff --git a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariable.c
> b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariable.c
> deleted file mode 100644
> index 1bcf931b96a6..000000000000
> --- a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariable.c
> +++ /dev/null
> @@ -1,1820 +0,0 @@
> -/** @file
> -
> -  Emulation Variable services operate on the runtime volatile memory.
> -  The nonvolatile variable space doesn't exist.
> -
> -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
> -This program and the accompanying materials
> -are licensed and made available under the terms and conditions of the BSD
> License
> -which accompanies this distribution.  The full text of the license may be found
> at
> -http://opensource.org/licenses/bsd-license.php
> -
> -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
> -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS
> OR IMPLIED.
> -
> -**/
> -
> -#include "Variable.h"
> -
> -///
> -/// Don't use module globals after the SetVirtualAddress map is signaled
> -///
> -ESAL_VARIABLE_GLOBAL  *mVariableModuleGlobal;
> -
> -VARIABLE_INFO_ENTRY *gVariableInfo = NULL;
> -
> -///
> -/// The size of a 3 character ISO639 language code.
> -///
> -#define ISO_639_2_ENTRY_SIZE    3
> -
> -/**
> -  Update the variable region with Variable information. These are the same
> -  arguments as the EFI Variable services.
> -
> -  @param[in] VariableName       Name of variable
> -
> -  @param[in] VendorGuid         Guid of variable
> -
> -  @param[in] Data               Variable data
> -
> -  @param[in] DataSize           Size of data. 0 means delete
> -
> -  @param[in] Attributes         Attribues of the variable
> -
> -  @param[in] Variable           The variable information which is used to keep
> track of variable usage.
> -
> -  @retval EFI_SUCCESS           The update operation is success.
> -
> -  @retval EFI_OUT_OF_RESOURCES  Variable region is full, can not write other
> data into this region.
> -
> -**/
> -EFI_STATUS
> -EFIAPI
> -UpdateVariable (
> -  IN      CHAR16                 *VariableName,
> -  IN      EFI_GUID               *VendorGuid,
> -  IN      VOID                   *Data,
> -  IN      UINTN                  DataSize,
> -  IN      UINT32                 Attributes OPTIONAL,
> -  IN      VARIABLE_POINTER_TRACK *Variable
> -  );
> -
> -/**
> -  Finds variable in storage blocks of volatile and non-volatile storage areas.
> -
> -  This code finds variable in storage blocks of volatile and non-volatile storage
> areas.
> -  If VariableName is an empty string, then we just return the first
> -  qualified variable without comparing VariableName and VendorGuid.
> -  Otherwise, VariableName and VendorGuid are compared.
> -
> -  @param  VariableName                Name of the variable to be found.
> -  @param  VendorGuid                  Vendor GUID to be found.
> -  @param  PtrTrack                    VARIABLE_POINTER_TRACK structure for output,
> -                                      including the range searched and the target position.
> -  @param  Global                      Pointer to VARIABLE_GLOBAL structure, including
> -                                      base of volatile variable storage area, base of
> -                                      NV variable storage area, and a lock.
> -
> -  @retval EFI_INVALID_PARAMETER       If VariableName is not an empty string,
> while
> -                                      VendorGuid is NULL.
> -  @retval EFI_SUCCESS                 Variable successfully found.
> -  @retval EFI_NOT_FOUND               Variable not found.
> -
> -**/
> -EFI_STATUS
> -FindVariable (
> -  IN  CHAR16                  *VariableName,
> -  IN  EFI_GUID                *VendorGuid,
> -  OUT VARIABLE_POINTER_TRACK  *PtrTrack,
> -  IN  VARIABLE_GLOBAL         *Global
> -  );
> -
> -/**
> -  Acquires lock only at boot time. Simply returns at runtime.
> -
> -  This is a temperary function which will be removed when
> -  EfiAcquireLock() in UefiLib can handle the call in UEFI
> -  Runtimer driver in RT phase.
> -  It calls EfiAcquireLock() at boot time, and simply returns
> -  at runtime
> -
> -  @param  Lock         A pointer to the lock to acquire
> -
> -**/
> -VOID
> -AcquireLockOnlyAtBootTime (
> -  IN EFI_LOCK  *Lock
> -  )
> -{
> -  if (!EfiAtRuntime ()) {
> -    EfiAcquireLock (Lock);
> -  }
> -}
> -
> -/**
> -  Releases lock only at boot time. Simply returns at runtime.
> -
> -  This is a temperary function which will be removed when
> -  EfiReleaseLock() in UefiLib can handle the call in UEFI
> -  Runtimer driver in RT phase.
> -  It calls EfiReleaseLock() at boot time, and simply returns
> -  at runtime
> -
> -  @param  Lock         A pointer to the lock to release
> -
> -**/
> -VOID
> -ReleaseLockOnlyAtBootTime (
> -  IN EFI_LOCK  *Lock
> -  )
> -{
> -  if (!EfiAtRuntime ()) {
> -    EfiReleaseLock (Lock);
> -  }
> -}
> -
> -/**
> -  Gets pointer to the variable data.
> -
> -  This function gets the pointer to the variable data according
> -  to the input pointer to the variable header.
> -
> -  @param  Variable      Pointer to the variable header.
> -
> -  @return Pointer to variable data
> -
> -**/
> -UINT8 *
> -GetVariableDataPtr (
> -  IN  VARIABLE_HEADER   *Variable
> -  )
> -{
> -  if (Variable->StartId != VARIABLE_DATA) {
> -    return NULL;
> -  }
> -  //
> -  // Be careful about pad size for alignment
> -  //
> -  return (UINT8 *) ((UINTN) GET_VARIABLE_NAME_PTR (Variable) + Variable-
> >NameSize + GET_PAD_SIZE (Variable->NameSize));
> -}
> -
> -/**
> -  Gets pointer to header of the next potential variable.
> -
> -  This function gets the pointer to the next potential variable header
> -  according to the input point to the variable header.  The return value
> -  is not a valid variable if the input variable was the last variable
> -  in the variabl store.
> -
> -  @param  Variable      Pointer to header of the next variable
> -
> -  @return Pointer to next variable header.
> -  @retval NULL  Input was not a valid variable header.
> -
> -**/
> -VARIABLE_HEADER *
> -GetNextPotentialVariablePtr (
> -  IN  VARIABLE_HEADER   *Variable
> -  )
> -{
> -  VARIABLE_HEADER *VarHeader;
> -
> -  if (Variable->StartId != VARIABLE_DATA) {
> -    return NULL;
> -  }
> -  //
> -  // Be careful about pad size for alignment
> -  //
> -  VarHeader = (VARIABLE_HEADER *) HEADER_ALIGN ((UINTN)
> GetVariableDataPtr (Variable) + Variable->DataSize + GET_PAD_SIZE (Variable-
> >DataSize));
> -
> -  return VarHeader;
> -}
> -
> -/**
> -  Gets pointer to header of the next variable.
> -
> -  This function gets the pointer to the next variable header according
> -  to the input point to the variable header.
> -
> -  @param  Variable      Pointer to header of the next variable
> -
> -  @return Pointer to next variable header.
> -
> -**/
> -VARIABLE_HEADER *
> -GetNextVariablePtr (
> -  IN  VARIABLE_HEADER   *Variable
> -  )
> -{
> -  VARIABLE_HEADER *VarHeader;
> -
> -  VarHeader = GetNextPotentialVariablePtr (Variable);
> -
> -  if ((VarHeader == NULL) || (VarHeader->StartId != VARIABLE_DATA)) {
> -    return NULL;
> -  }
> -
> -  return VarHeader;
> -}
> -
> -/**
> -  Updates LastVariableOffset variable for the given variable store.
> -
> -  LastVariableOffset points to the offset to use for the next variable
> -  when updating the variable store.
> -
> -  @param[in]   VariableStore       Pointer to the start of the variable store
> -  @param[out]  LastVariableOffset  Offset to put the next new variable in
> -
> -**/
> -VOID
> -InitializeLocationForLastVariableOffset (
> -  IN  VARIABLE_STORE_HEADER *VariableStore,
> -  OUT UINTN                 *LastVariableOffset
> -  )
> -{
> -  VARIABLE_HEADER *VarHeader;
> -
> -  *LastVariableOffset       = sizeof (VARIABLE_STORE_HEADER);
> -  VarHeader = (VARIABLE_HEADER*) ((UINT8*)VariableStore +
> *LastVariableOffset);
> -  while (VarHeader->StartId == VARIABLE_DATA) {
> -    VarHeader = GetNextPotentialVariablePtr (VarHeader);
> -
> -    if (VarHeader != NULL) {
> -      *LastVariableOffset = (UINTN) VarHeader - (UINTN) VariableStore;
> -    } else {
> -      return;
> -    }
> -  }
> -}
> -
> -/**
> -  Gets pointer to the end of the variable storage area.
> -
> -  This function gets pointer to the end of the variable storage
> -  area, according to the input variable store header.
> -
> -  @param  VolHeader     Pointer to the variale store header
> -
> -  @return Pointer to the end of the variable storage area.
> -
> -**/
> -VARIABLE_HEADER *
> -GetEndPointer (
> -  IN VARIABLE_STORE_HEADER       *VolHeader
> -  )
> -{
> -  //
> -  // The end of variable store
> -  //
> -  return (VARIABLE_HEADER *) HEADER_ALIGN ((UINTN) VolHeader +
> VolHeader->Size);
> -}
> -
> -/**
> -  Routine used to track statistical information about variable usage.
> -  The data is stored in the EFI system table so it can be accessed later.
> -  VariableInfo.efi can dump out the table. Only Boot Services variable
> -  accesses are tracked by this code. The PcdVariableCollectStatistics
> -  build flag controls if this feature is enabled.
> -
> -  A read that hits in the cache will have Read and Cache true for
> -  the transaction. Data is allocated by this routine, but never
> -  freed.
> -
> -  @param[in] VariableName   Name of the Variable to track
> -  @param[in] VendorGuid     Guid of the Variable to track
> -  @param[in] Volatile       TRUE if volatile FALSE if non-volatile
> -  @param[in] Read           TRUE if GetVariable() was called
> -  @param[in] Write          TRUE if SetVariable() was called
> -  @param[in] Delete         TRUE if deleted via SetVariable()
> -  @param[in] Cache          TRUE for a cache hit.
> -
> -**/
> -VOID
> -UpdateVariableInfo (
> -  IN  CHAR16                  *VariableName,
> -  IN  EFI_GUID                *VendorGuid,
> -  IN  BOOLEAN                 Volatile,
> -  IN  BOOLEAN                 Read,
> -  IN  BOOLEAN                 Write,
> -  IN  BOOLEAN                 Delete,
> -  IN  BOOLEAN                 Cache
> -  )
> -{
> -  VARIABLE_INFO_ENTRY   *Entry;
> -
> -  if (FeaturePcdGet (PcdVariableCollectStatistics)) {
> -
> -    if (EfiAtRuntime ()) {
> -      // Don't collect statistics at runtime
> -      return;
> -    }
> -
> -    if (gVariableInfo == NULL) {
> -      //
> -      // on the first call allocate a entry and place a pointer to it in
> -      // the EFI System Table
> -      //
> -      gVariableInfo = AllocateZeroPool (sizeof (VARIABLE_INFO_ENTRY));
> -      ASSERT (gVariableInfo != NULL);
> -
> -      CopyGuid (&gVariableInfo->VendorGuid, VendorGuid);
> -      gVariableInfo->Name = AllocateZeroPool (StrSize (VariableName));
> -      ASSERT (gVariableInfo->Name != NULL);
> -      StrCpyS (gVariableInfo->Name, StrSize(VariableName)/sizeof(CHAR16),
> VariableName);
> -      gVariableInfo->Volatile = Volatile;
> -
> -      gBS->InstallConfigurationTable (&gEfiVariableGuid, gVariableInfo);
> -    }
> -
> -
> -    for (Entry = gVariableInfo; Entry != NULL; Entry = Entry->Next) {
> -      if (CompareGuid (VendorGuid, &Entry->VendorGuid)) {
> -        if (StrCmp (VariableName, Entry->Name) == 0) {
> -          if (Read) {
> -            Entry->ReadCount++;
> -          }
> -          if (Write) {
> -            Entry->WriteCount++;
> -          }
> -          if (Delete) {
> -            Entry->DeleteCount++;
> -          }
> -          if (Cache) {
> -            Entry->CacheCount++;
> -          }
> -
> -          return;
> -        }
> -      }
> -
> -      if (Entry->Next == NULL) {
> -        //
> -        // If the entry is not in the table add it.
> -        // Next iteration of the loop will fill in the data
> -        //
> -        Entry->Next = AllocateZeroPool (sizeof (VARIABLE_INFO_ENTRY));
> -        ASSERT (Entry->Next != NULL);
> -
> -        CopyGuid (&Entry->Next->VendorGuid, VendorGuid);
> -        Entry->Next->Name = AllocateZeroPool (StrSize (VariableName));
> -        ASSERT (Entry->Next->Name != NULL);
> -        StrCpyS (Entry->Next->Name, StrSize(VariableName)/sizeof(CHAR16),
> VariableName);
> -        Entry->Next->Volatile = Volatile;
> -      }
> -
> -    }
> -  }
> -}
> -
> -/**
> -  Get index from supported language codes according to language string.
> -
> -  This code is used to get corresponding index in supported language codes. It
> can handle
> -  RFC4646 and ISO639 language tags.
> -  In ISO639 language tags, take 3-characters as a delimitation to find matched
> string and calculate the index.
> -  In RFC4646 language tags, take semicolon as a delimitation to find matched
> string and calculate the index.
> -
> -  For example:
> -    SupportedLang  = "engfraengfra"
> -    Lang           = "eng"
> -    Iso639Language = TRUE
> -  The return value is "0".
> -  Another example:
> -    SupportedLang  = "en;fr;en-US;fr-FR"
> -    Lang           = "fr-FR"
> -    Iso639Language = FALSE
> -  The return value is "3".
> -
> -  @param  SupportedLang               Platform supported language codes.
> -  @param  Lang                        Configured language.
> -  @param  Iso639Language              A bool value to signify if the handler is
> operated on ISO639 or RFC4646.
> -
> -  @retval the index of language in the language codes.
> -
> -**/
> -UINTN
> -GetIndexFromSupportedLangCodes(
> -  IN  CHAR8            *SupportedLang,
> -  IN  CHAR8            *Lang,
> -  IN  BOOLEAN          Iso639Language
> -  )
> -{
> -  UINTN    Index;
> -  UINTN    CompareLength;
> -  UINTN    LanguageLength;
> -
> -  if (Iso639Language) {
> -    CompareLength = ISO_639_2_ENTRY_SIZE;
> -    for (Index = 0; Index < AsciiStrLen (SupportedLang); Index += CompareLength)
> {
> -      if (AsciiStrnCmp (Lang, SupportedLang + Index, CompareLength) == 0) {
> -        //
> -        // Successfully find the index of Lang string in SupportedLang string.
> -        //
> -        Index = Index / CompareLength;
> -        return Index;
> -      }
> -    }
> -    ASSERT (FALSE);
> -    return 0;
> -  } else {
> -    //
> -    // Compare RFC4646 language code
> -    //
> -    Index = 0;
> -    for (LanguageLength = 0; Lang[LanguageLength] != '\0'; LanguageLength++);
> -
> -    for (Index = 0; *SupportedLang != '\0'; Index++, SupportedLang +=
> CompareLength) {
> -      //
> -      // Skip ';' characters in SupportedLang
> -      //
> -      for (; *SupportedLang != '\0' && *SupportedLang == ';'; SupportedLang++);
> -      //
> -      // Determine the length of the next language code in SupportedLang
> -      //
> -      for (CompareLength = 0; SupportedLang[CompareLength] != '\0' &&
> SupportedLang[CompareLength] != ';'; CompareLength++);
> -
> -      if ((CompareLength == LanguageLength) &&
> -          (AsciiStrnCmp (Lang, SupportedLang, CompareLength) == 0)) {
> -        //
> -        // Successfully find the index of Lang string in SupportedLang string.
> -        //
> -        return Index;
> -      }
> -    }
> -    ASSERT (FALSE);
> -    return 0;
> -  }
> -}
> -
> -/**
> -  Get language string from supported language codes according to index.
> -
> -  This code is used to get corresponding language string in supported language
> codes. It can handle
> -  RFC4646 and ISO639 language tags.
> -  In ISO639 language tags, take 3-characters as a delimitation. Find language
> string according to the index.
> -  In RFC4646 language tags, take semicolon as a delimitation. Find language
> string according to the index.
> -
> -  For example:
> -    SupportedLang  = "engfraengfra"
> -    Index          = "1"
> -    Iso639Language = TRUE
> -  The return value is "fra".
> -  Another example:
> -    SupportedLang  = "en;fr;en-US;fr-FR"
> -    Index          = "1"
> -    Iso639Language = FALSE
> -  The return value is "fr".
> -
> -  @param  SupportedLang               Platform supported language codes.
> -  @param  Index                       the index in supported language codes.
> -  @param  Iso639Language              A bool value to signify if the handler is
> operated on ISO639 or RFC4646.
> -
> -  @retval the language string in the language codes.
> -
> -**/
> -CHAR8 *
> -GetLangFromSupportedLangCodes (
> -  IN  CHAR8            *SupportedLang,
> -  IN  UINTN            Index,
> -  IN  BOOLEAN          Iso639Language
> -)
> -{
> -  UINTN    SubIndex;
> -  UINTN    CompareLength;
> -  CHAR8    *Supported;
> -
> -  SubIndex  = 0;
> -  Supported = SupportedLang;
> -  if (Iso639Language) {
> -    //
> -    // according to the index of Lang string in SupportedLang string to get the
> language.
> -    // As this code will be invoked in RUNTIME, therefore there is not memory
> allocate/free operation.
> -    // In driver entry, it pre-allocates a runtime attribute memory to
> accommodate this string.
> -    //
> -    CompareLength = ISO_639_2_ENTRY_SIZE;
> -    mVariableModuleGlobal->Lang[CompareLength] = '\0';
> -    return CopyMem (mVariableModuleGlobal->Lang, SupportedLang + Index *
> CompareLength, CompareLength);
> -
> -  } else {
> -    while (TRUE) {
> -      //
> -      // take semicolon as delimitation, sequentially traverse supported language
> codes.
> -      //
> -      for (CompareLength = 0; *Supported != ';' && *Supported != '\0';
> CompareLength++) {
> -        Supported++;
> -      }
> -      if ((*Supported == '\0') && (SubIndex != Index)) {
> -        //
> -        // Have completed the traverse, but not find corrsponding string.
> -        // This case is not allowed to happen.
> -        //
> -        ASSERT(FALSE);
> -        return NULL;
> -      }
> -      if (SubIndex == Index) {
> -        //
> -        // according to the index of Lang string in SupportedLang string to get the
> language.
> -        // As this code will be invoked in RUNTIME, therefore there is not memory
> allocate/free operation.
> -        // In driver entry, it pre-allocates a runtime attribute memory to
> accommodate this string.
> -        //
> -        mVariableModuleGlobal->PlatformLang[CompareLength] = '\0';
> -        return CopyMem (mVariableModuleGlobal->PlatformLang, Supported -
> CompareLength, CompareLength);
> -      }
> -      SubIndex++;
> -
> -      //
> -      // Skip ';' characters in Supported
> -      //
> -      for (; *Supported != '\0' && *Supported == ';'; Supported++);
> -    }
> -  }
> -}
> -
> -/**
> -  Returns a pointer to an allocated buffer that contains the best matching
> language
> -  from a set of supported languages.
> -
> -  This function supports both ISO 639-2 and RFC 4646 language codes, but
> language
> -  code types may not be mixed in a single call to this function. This function
> -  supports a variable argument list that allows the caller to pass in a prioritized
> -  list of language codes to test against all the language codes in
> SupportedLanguages.
> -
> -  If SupportedLanguages is NULL, then ASSERT().
> -
> -  @param[in]  SupportedLanguages  A pointer to a Null-terminated ASCII string
> that
> -                                  contains a set of language codes in the format
> -                                  specified by Iso639Language.
> -  @param[in]  Iso639Language      If not zero, then all language codes are
> assumed to be
> -                                  in ISO 639-2 format.  If zero, then all language
> -                                  codes are assumed to be in RFC 4646 language format
> -  @param[in]  ...                 A variable argument list that contains pointers to
> -                                  Null-terminated ASCII strings that contain one or more
> -                                  language codes in the format specified by Iso639Language.
> -                                  The first language code from each of these language
> -                                  code lists is used to determine if it is an exact or
> -                                  close match to any of the language codes in
> -                                  SupportedLanguages.  Close matches only apply to RFC 4646
> -                                  language codes, and the matching algorithm from RFC 4647
> -                                  is used to determine if a close match is present.  If
> -                                  an exact or close match is found, then the matching
> -                                  language code from SupportedLanguages is returned.  If
> -                                  no matches are found, then the next variable argument
> -                                  parameter is evaluated.  The variable argument list
> -                                  is terminated by a NULL.
> -
> -  @retval NULL   The best matching language could not be found in
> SupportedLanguages.
> -  @retval NULL   There are not enough resources available to return the best
> matching
> -                 language.
> -  @retval Other  A pointer to a Null-terminated ASCII string that is the best
> matching
> -                 language in SupportedLanguages.
> -
> -**/
> -CHAR8 *
> -EFIAPI
> -VariableGetBestLanguage (
> -  IN CONST CHAR8  *SupportedLanguages,
> -  IN UINTN        Iso639Language,
> -  ...
> -  )
> -{
> -  VA_LIST      Args;
> -  CHAR8        *Language;
> -  UINTN        CompareLength;
> -  UINTN        LanguageLength;
> -  CONST CHAR8  *Supported;
> -  CHAR8        *Buffer;
> -
> -  ASSERT (SupportedLanguages != NULL);
> -
> -  VA_START (Args, Iso639Language);
> -  while ((Language = VA_ARG (Args, CHAR8 *)) != NULL) {
> -    //
> -    // Default to ISO 639-2 mode
> -    //
> -    CompareLength  = 3;
> -    LanguageLength = MIN (3, AsciiStrLen (Language));
> -
> -    //
> -    // If in RFC 4646 mode, then determine the length of the first RFC 4646
> language code in Language
> -    //
> -    if (Iso639Language == 0) {
> -      for (LanguageLength = 0; Language[LanguageLength] != 0 &&
> Language[LanguageLength] != ';'; LanguageLength++);
> -    }
> -
> -    //
> -    // Trim back the length of Language used until it is empty
> -    //
> -    while (LanguageLength > 0) {
> -      //
> -      // Loop through all language codes in SupportedLanguages
> -      //
> -      for (Supported = SupportedLanguages; *Supported != '\0'; Supported +=
> CompareLength) {
> -        //
> -        // In RFC 4646 mode, then Loop through all language codes in
> SupportedLanguages
> -        //
> -        if (Iso639Language == 0) {
> -          //
> -          // Skip ';' characters in Supported
> -          //
> -          for (; *Supported != '\0' && *Supported == ';'; Supported++);
> -          //
> -          // Determine the length of the next language code in Supported
> -          //
> -          for (CompareLength = 0; Supported[CompareLength] != 0 &&
> Supported[CompareLength] != ';'; CompareLength++);
> -          //
> -          // If Language is longer than the Supported, then skip to the next
> language
> -          //
> -          if (LanguageLength > CompareLength) {
> -            continue;
> -          }
> -        }
> -        //
> -        // See if the first LanguageLength characters in Supported match Language
> -        //
> -        if (AsciiStrnCmp (Supported, Language, LanguageLength) == 0) {
> -          VA_END (Args);
> -
> -          Buffer = (Iso639Language != 0) ? mVariableModuleGlobal->Lang :
> mVariableModuleGlobal->PlatformLang;
> -          Buffer[CompareLength] = '\0';
> -          return CopyMem (Buffer, Supported, CompareLength);
> -        }
> -      }
> -
> -      if (Iso639Language != 0) {
> -        //
> -        // If ISO 639 mode, then each language can only be tested once
> -        //
> -        LanguageLength = 0;
> -      } else {
> -        //
> -        // If RFC 4646 mode, then trim Language from the right to the next '-'
> character
> -        //
> -        for (LanguageLength--; LanguageLength > 0 &&
> Language[LanguageLength] != '-'; LanguageLength--);
> -      }
> -    }
> -  }
> -  VA_END (Args);
> -
> -  //
> -  // No matches were found
> -  //
> -  return NULL;
> -}
> -
> -/**
> -  Hook the operations in PlatformLangCodes, LangCodes, PlatformLang and
> Lang.
> -
> -  When setting Lang/LangCodes, simultaneously update
> PlatformLang/PlatformLangCodes.
> -
> -  According to UEFI spec, PlatformLangCodes/LangCodes are only set once in
> firmware initialization,
> -  and are read-only. Therefore, in variable driver, only store the original value
> for other use.
> -
> -  @param[in] VariableName       Name of variable
> -
> -  @param[in] Data               Variable data
> -
> -  @param[in] DataSize           Size of data. 0 means delete
> -
> -**/
> -VOID
> -AutoUpdateLangVariable(
> -  IN  CHAR16             *VariableName,
> -  IN  VOID               *Data,
> -  IN  UINTN              DataSize
> -  )
> -{
> -  EFI_STATUS             Status;
> -  CHAR8                  *BestPlatformLang;
> -  CHAR8                  *BestLang;
> -  UINTN                  Index;
> -  UINT32                 Attributes;
> -  VARIABLE_POINTER_TRACK Variable;
> -  BOOLEAN                SetLanguageCodes;
> -
> -  //
> -  // Don't do updates for delete operation
> -  //
> -  if (DataSize == 0) {
> -    return;
> -  }
> -
> -  SetLanguageCodes = FALSE;
> -
> -  if (StrCmp (VariableName, L"PlatformLangCodes") == 0) {
> -    //
> -    // PlatformLangCodes is a volatile variable, so it can not be updated at
> runtime.
> -    //
> -    if (EfiAtRuntime ()) {
> -      return;
> -    }
> -
> -    SetLanguageCodes = TRUE;
> -
> -    //
> -    // According to UEFI spec, PlatformLangCodes is only set once in firmware
> initialization, and is read-only
> -    // Therefore, in variable driver, only store the original value for other use.
> -    //
> -    if (mVariableModuleGlobal->PlatformLangCodes != NULL) {
> -      FreePool (mVariableModuleGlobal->PlatformLangCodes);
> -    }
> -    mVariableModuleGlobal->PlatformLangCodes = AllocateRuntimeCopyPool
> (DataSize, Data);
> -    ASSERT (mVariableModuleGlobal->PlatformLangCodes != NULL);
> -
> -    //
> -    // PlatformLang holds a single language from PlatformLangCodes,
> -    // so the size of PlatformLangCodes is enough for the PlatformLang.
> -    //
> -    if (mVariableModuleGlobal->PlatformLang != NULL) {
> -      FreePool (mVariableModuleGlobal->PlatformLang);
> -    }
> -    mVariableModuleGlobal->PlatformLang = AllocateRuntimePool (DataSize);
> -    ASSERT (mVariableModuleGlobal->PlatformLang != NULL);
> -
> -  } else if (StrCmp (VariableName, L"LangCodes") == 0) {
> -    //
> -    // LangCodes is a volatile variable, so it can not be updated at runtime.
> -    //
> -    if (EfiAtRuntime ()) {
> -      return;
> -    }
> -
> -    SetLanguageCodes = TRUE;
> -
> -    //
> -    // According to UEFI spec, LangCodes is only set once in firmware
> initialization, and is read-only
> -    // Therefore, in variable driver, only store the original value for other use.
> -    //
> -    if (mVariableModuleGlobal->LangCodes != NULL) {
> -      FreePool (mVariableModuleGlobal->LangCodes);
> -    }
> -    mVariableModuleGlobal->LangCodes = AllocateRuntimeCopyPool (DataSize,
> Data);
> -    ASSERT (mVariableModuleGlobal->LangCodes != NULL);
> -  }
> -
> -  if (SetLanguageCodes
> -      && (mVariableModuleGlobal->PlatformLangCodes != NULL)
> -      && (mVariableModuleGlobal->LangCodes != NULL)) {
> -    //
> -    // Update Lang if PlatformLang is already set
> -    // Update PlatformLang if Lang is already set
> -    //
> -    Status = FindVariable (L"PlatformLang", &gEfiGlobalVariableGuid, &Variable,
> (VARIABLE_GLOBAL *) mVariableModuleGlobal);
> -    if (!EFI_ERROR (Status)) {
> -      //
> -      // Update Lang
> -      //
> -      VariableName = L"PlatformLang";
> -      Data         = GetVariableDataPtr (Variable.CurrPtr);
> -      DataSize     = Variable.CurrPtr->DataSize;
> -    } else {
> -      Status = FindVariable (L"Lang", &gEfiGlobalVariableGuid, &Variable,
> (VARIABLE_GLOBAL *) mVariableModuleGlobal);
> -      if (!EFI_ERROR (Status)) {
> -        //
> -        // Update PlatformLang
> -        //
> -        VariableName = L"Lang";
> -        Data         = GetVariableDataPtr (Variable.CurrPtr);
> -        DataSize     = Variable.CurrPtr->DataSize;
> -      } else {
> -        //
> -        // Neither PlatformLang nor Lang is set, directly return
> -        //
> -        return;
> -      }
> -    }
> -  }
> -
> -  //
> -  // According to UEFI spec, "Lang" and "PlatformLang" is NV|BS|RT
> attributions.
> -  //
> -  Attributes = EFI_VARIABLE_NON_VOLATILE |
> EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS;
> -
> -  if (StrCmp (VariableName, L"PlatformLang") == 0) {
> -    //
> -    // Update Lang when PlatformLangCodes/LangCodes were set.
> -    //
> -    if ((mVariableModuleGlobal->PlatformLangCodes != NULL) &&
> (mVariableModuleGlobal->LangCodes != NULL)) {
> -      //
> -      // When setting PlatformLang, firstly get most matched language string
> from supported language codes.
> -      //
> -      BestPlatformLang = VariableGetBestLanguage (mVariableModuleGlobal-
> >PlatformLangCodes, FALSE, Data, NULL);
> -      if (BestPlatformLang != NULL) {
> -        //
> -        // Get the corresponding index in language codes.
> -        //
> -        Index = GetIndexFromSupportedLangCodes (mVariableModuleGlobal-
> >PlatformLangCodes, BestPlatformLang, FALSE);
> -
> -        //
> -        // Get the corresponding ISO639 language tag according to RFC4646
> language tag.
> -        //
> -        BestLang = GetLangFromSupportedLangCodes (mVariableModuleGlobal-
> >LangCodes, Index, TRUE);
> -
> -        //
> -        // Successfully convert PlatformLang to Lang, and set the BestLang value
> into Lang variable simultaneously.
> -        //
> -        FindVariable (L"Lang", &gEfiGlobalVariableGuid, &Variable,
> (VARIABLE_GLOBAL *)mVariableModuleGlobal);
> -
> -        Status = UpdateVariable (L"Lang", &gEfiGlobalVariableGuid, BestLang,
> ISO_639_2_ENTRY_SIZE + 1, Attributes, &Variable);
> -
> -        DEBUG ((EFI_D_INFO, "Variable Driver Auto Update PlatformLang,
> PlatformLang:%a, Lang:%a\n", BestPlatformLang, BestLang));
> -
> -        ASSERT_EFI_ERROR(Status);
> -      }
> -    }
> -
> -  } else if (StrCmp (VariableName, L"Lang") == 0) {
> -    //
> -    // Update PlatformLang when PlatformLangCodes/LangCodes were set.
> -    //
> -    if ((mVariableModuleGlobal->PlatformLangCodes != NULL) &&
> (mVariableModuleGlobal->LangCodes != NULL)) {
> -      //
> -      // When setting Lang, firstly get most matched language string from
> supported language codes.
> -      //
> -      BestLang = VariableGetBestLanguage (mVariableModuleGlobal->LangCodes,
> TRUE, Data, NULL);
> -      if (BestLang != NULL) {
> -        //
> -        // Get the corresponding index in language codes.
> -        //
> -        Index = GetIndexFromSupportedLangCodes (mVariableModuleGlobal-
> >LangCodes, BestLang, TRUE);
> -
> -        //
> -        // Get the corresponding RFC4646 language tag according to ISO639
> language tag.
> -        //
> -        BestPlatformLang = GetLangFromSupportedLangCodes
> (mVariableModuleGlobal->PlatformLangCodes, Index, FALSE);
> -
> -        //
> -        // Successfully convert Lang to PlatformLang, and set the
> BestPlatformLang value into PlatformLang variable simultaneously.
> -        //
> -        FindVariable (L"PlatformLang", &gEfiGlobalVariableGuid, &Variable,
> (VARIABLE_GLOBAL *)mVariableModuleGlobal);
> -
> -        Status = UpdateVariable (L"PlatformLang", &gEfiGlobalVariableGuid,
> BestPlatformLang,
> -                                 AsciiStrSize (BestPlatformLang), Attributes, &Variable);
> -
> -        DEBUG ((EFI_D_INFO, "Variable Driver Auto Update Lang, Lang:%a,
> PlatformLang:%a\n", BestLang, BestPlatformLang));
> -        ASSERT_EFI_ERROR (Status);
> -      }
> -    }
> -  }
> -}
> -
> -/**
> -  Update the variable region with Variable information. These are the same
> -  arguments as the EFI Variable services.
> -
> -  @param[in] VariableName       Name of variable
> -
> -  @param[in] VendorGuid         Guid of variable
> -
> -  @param[in] Data               Variable data
> -
> -  @param[in] DataSize           Size of data. 0 means delete
> -
> -  @param[in] Attributes         Attribues of the variable
> -
> -  @param[in] Variable           The variable information which is used to keep
> track of variable usage.
> -
> -  @retval EFI_SUCCESS           The update operation is success.
> -
> -  @retval EFI_OUT_OF_RESOURCES  Variable region is full, can not write other
> data into this region.
> -
> -**/
> -EFI_STATUS
> -EFIAPI
> -UpdateVariable (
> -  IN      CHAR16          *VariableName,
> -  IN      EFI_GUID        *VendorGuid,
> -  IN      VOID            *Data,
> -  IN      UINTN           DataSize,
> -  IN      UINT32          Attributes OPTIONAL,
> -  IN      VARIABLE_POINTER_TRACK *Variable
> -  )
> -{
> -  EFI_STATUS              Status;
> -  VARIABLE_HEADER         *NextVariable;
> -  UINTN                   VarNameSize;
> -  UINTN                   VarNameOffset;
> -  UINTN                   VarDataOffset;
> -  UINTN                   VarSize;
> -  VARIABLE_GLOBAL         *Global;
> -  UINTN                   NonVolatileVarableStoreSize;
> -
> -  Global = &mVariableModuleGlobal->VariableGlobal[Physical];
> -
> -  if (Variable->CurrPtr != NULL) {
> -    //
> -    // Update/Delete existing variable
> -    //
> -
> -    if (EfiAtRuntime ()) {
> -      //
> -      // If EfiAtRuntime and the variable is Volatile and Runtime Access,
> -      // the volatile is ReadOnly, and SetVariable should be aborted and
> -      // return EFI_WRITE_PROTECTED.
> -      //
> -      if (Variable->Volatile) {
> -        Status = EFI_WRITE_PROTECTED;
> -        goto Done;
> -      }
> -      //
> -      // Only variable have NV attribute can be updated/deleted in Runtime
> -      //
> -      if ((Variable->CurrPtr->Attributes & EFI_VARIABLE_NON_VOLATILE) == 0) {
> -        Status = EFI_INVALID_PARAMETER;
> -        goto Done;
> -      }
> -    }
> -
> -    //
> -    // Setting a data variable with no access, or zero DataSize attributes
> -    // specified causes it to be deleted.
> -    //
> -    if (DataSize == 0 || (Attributes & (EFI_VARIABLE_RUNTIME_ACCESS |
> EFI_VARIABLE_BOOTSERVICE_ACCESS)) == 0) {
> -      Variable->CurrPtr->State &= VAR_DELETED;
> -      UpdateVariableInfo (VariableName, VendorGuid, Variable->Volatile, FALSE,
> FALSE, TRUE, FALSE);
> -      Status = EFI_SUCCESS;
> -      goto Done;
> -    }
> -
> -    //
> -    // If the variable is marked valid and the same data has been passed in
> -    // then return to the caller immediately.
> -    //
> -    if (Variable->CurrPtr->DataSize == DataSize &&
> -        CompareMem (Data, GetVariableDataPtr (Variable->CurrPtr), DataSize) ==
> 0
> -          ) {
> -      Status = EFI_SUCCESS;
> -      goto Done;
> -    } else if (Variable->CurrPtr->State == VAR_ADDED) {
> -      //
> -      // Mark the old variable as in delete transition
> -      //
> -      Variable->CurrPtr->State &= VAR_IN_DELETED_TRANSITION;
> -    }
> -
> -  } else {
> -    //
> -    // No found existing variable, Create a new variable
> -    //
> -
> -    //
> -    // Make sure we are trying to create a new variable.
> -    // Setting a data variable with no access, or zero DataSize attributes means
> to delete it.
> -    //
> -    if (DataSize == 0 || (Attributes & (EFI_VARIABLE_RUNTIME_ACCESS |
> EFI_VARIABLE_BOOTSERVICE_ACCESS)) == 0) {
> -      Status = EFI_NOT_FOUND;
> -      goto Done;
> -    }
> -
> -    //
> -    // Only variable have NV|RT attribute can be created in Runtime
> -    //
> -    if (EfiAtRuntime () &&
> -        (((Attributes & EFI_VARIABLE_RUNTIME_ACCESS) == 0) || ((Attributes &
> EFI_VARIABLE_NON_VOLATILE) == 0))) {
> -      Status = EFI_INVALID_PARAMETER;
> -      goto Done;
> -    }
> -  }
> -
> -  //
> -  // Function part - create a new variable and copy the data.
> -  // Both update a variable and create a variable will come here.
> -  //
> -
> -  VarNameOffset = sizeof (VARIABLE_HEADER);
> -  VarNameSize   = StrSize (VariableName);
> -  VarDataOffset = VarNameOffset + VarNameSize + GET_PAD_SIZE
> (VarNameSize);
> -  VarSize       = VarDataOffset + DataSize + GET_PAD_SIZE (DataSize);
> -
> -  if ((Attributes & EFI_VARIABLE_NON_VOLATILE) != 0) {
> -    NonVolatileVarableStoreSize = ((VARIABLE_STORE_HEADER
> *)(UINTN)(Global->NonVolatileVariableBase))->Size;
> -    if ((((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != 0)
> -      && ((HEADER_ALIGN (VarSize) + mVariableModuleGlobal-
> >HwErrVariableTotalSize) > PcdGet32 (PcdHwErrStorageSize)))
> -      || (((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == 0)
> -      && ((HEADER_ALIGN (VarSize) + mVariableModuleGlobal-
> >CommonVariableTotalSize) > NonVolatileVarableStoreSize - sizeof
> (VARIABLE_STORE_HEADER) - PcdGet32 (PcdHwErrStorageSize)))) {
> -      Status = EFI_OUT_OF_RESOURCES;
> -      goto Done;
> -    }
> -
> -    NextVariable  = (VARIABLE_HEADER *) (UINT8 *) (mVariableModuleGlobal-
> >NonVolatileLastVariableOffset
> -                      + (UINTN) Global->NonVolatileVariableBase);
> -    mVariableModuleGlobal->NonVolatileLastVariableOffset += HEADER_ALIGN
> (VarSize);
> -
> -    if ((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != 0) {
> -      mVariableModuleGlobal->HwErrVariableTotalSize += HEADER_ALIGN
> (VarSize);
> -    } else {
> -      mVariableModuleGlobal->CommonVariableTotalSize += HEADER_ALIGN
> (VarSize);
> -    }
> -  } else {
> -    if ((UINT32) (HEADER_ALIGN (VarSize) + mVariableModuleGlobal-
> >VolatileLastVariableOffset) >
> -          ((VARIABLE_STORE_HEADER *) ((UINTN) (Global->VolatileVariableBase)))-
> >Size
> -          ) {
> -      Status = EFI_OUT_OF_RESOURCES;
> -      goto Done;
> -    }
> -
> -    NextVariable    = (VARIABLE_HEADER *) (UINT8 *) (mVariableModuleGlobal-
> >VolatileLastVariableOffset
> -                        + (UINTN) Global->VolatileVariableBase);
> -    mVariableModuleGlobal->VolatileLastVariableOffset += HEADER_ALIGN
> (VarSize);
> -  }
> -
> -  NextVariable->StartId     = VARIABLE_DATA;
> -  NextVariable->Attributes  = Attributes;
> -  NextVariable->State       = VAR_ADDED;
> -  NextVariable->Reserved    = 0;
> -
> -  //
> -  // There will be pad bytes after Data, the NextVariable->NameSize and
> -  // NextVariable->NameSize should not include pad size so that variable
> -  // service can get actual size in GetVariable
> -  //
> -  NextVariable->NameSize  = (UINT32)VarNameSize;
> -  NextVariable->DataSize  = (UINT32)DataSize;
> -
> -  CopyMem (&NextVariable->VendorGuid, VendorGuid, sizeof (EFI_GUID));
> -  CopyMem (
> -    (UINT8 *) ((UINTN) NextVariable + VarNameOffset),
> -    VariableName,
> -    VarNameSize
> -    );
> -  CopyMem (
> -    (UINT8 *) ((UINTN) NextVariable + VarDataOffset),
> -    Data,
> -    DataSize
> -    );
> -
> -  //
> -  // Mark the old variable as deleted
> -  //
> -  if (Variable->CurrPtr != NULL) {
> -    Variable->CurrPtr->State &= VAR_DELETED;
> -  }
> -
> -  UpdateVariableInfo (VariableName, VendorGuid, Variable->Volatile, FALSE,
> TRUE, FALSE, FALSE);
> -
> -  Status = EFI_SUCCESS;
> -
> -Done:
> -  return Status;
> -}
> -
> -/**
> -  Finds variable in storage blocks of volatile and non-volatile storage areas.
> -
> -  This code finds variable in storage blocks of volatile and non-volatile storage
> areas.
> -  If VariableName is an empty string, then we just return the first
> -  qualified variable without comparing VariableName and VendorGuid.
> -  Otherwise, VariableName and VendorGuid are compared.
> -
> -  @param  VariableName                Name of the variable to be found.
> -  @param  VendorGuid                  Vendor GUID to be found.
> -  @param  PtrTrack                    VARIABLE_POINTER_TRACK structure for output,
> -                                      including the range searched and the target position.
> -  @param  Global                      Pointer to VARIABLE_GLOBAL structure, including
> -                                      base of volatile variable storage area, base of
> -                                      NV variable storage area, and a lock.
> -
> -  @retval EFI_INVALID_PARAMETER       If VariableName is not an empty string,
> while
> -                                      VendorGuid is NULL.
> -  @retval EFI_SUCCESS                 Variable successfully found.
> -  @retval EFI_NOT_FOUND               Variable not found.
> -
> -**/
> -EFI_STATUS
> -FindVariable (
> -  IN  CHAR16                  *VariableName,
> -  IN  EFI_GUID                *VendorGuid,
> -  OUT VARIABLE_POINTER_TRACK  *PtrTrack,
> -  IN  VARIABLE_GLOBAL         *Global
> -  )
> -{
> -  VARIABLE_HEADER       *Variable[2];
> -  VARIABLE_STORE_HEADER *VariableStoreHeader[2];
> -  UINTN                 Index;
> -
> -  //
> -  // 0: Non-Volatile, 1: Volatile
> -  //
> -  VariableStoreHeader[0]  = (VARIABLE_STORE_HEADER *) ((UINTN) Global-
> >NonVolatileVariableBase);
> -  VariableStoreHeader[1]  = (VARIABLE_STORE_HEADER *) ((UINTN) Global-
> >VolatileVariableBase);
> -
> -  //
> -  // Start Pointers for the variable.
> -  // Actual Data Pointer where data can be written.
> -  //
> -  Variable[0] = (VARIABLE_HEADER *) HEADER_ALIGN (VariableStoreHeader[0]
> + 1);
> -  Variable[1] = (VARIABLE_HEADER *) HEADER_ALIGN (VariableStoreHeader[1]
> + 1);
> -
> -  if (VariableName[0] != 0 && VendorGuid == NULL) {
> -    return EFI_INVALID_PARAMETER;
> -  }
> -  //
> -  // Find the variable by walk through non-volatile and volatile variable store
> -  //
> -  for (Index = 0; Index < 2; Index++) {
> -    PtrTrack->StartPtr  = (VARIABLE_HEADER *) HEADER_ALIGN
> (VariableStoreHeader[Index] + 1);
> -    PtrTrack->EndPtr    = GetEndPointer (VariableStoreHeader[Index]);
> -
> -    while ((Variable[Index] < GetEndPointer (VariableStoreHeader[Index])) &&
> (Variable[Index] != NULL)) {
> -      if (Variable[Index]->StartId == VARIABLE_DATA && Variable[Index]->State
> == VAR_ADDED) {
> -        if (!(EfiAtRuntime () && ((Variable[Index]->Attributes &
> EFI_VARIABLE_RUNTIME_ACCESS) == 0))) {
> -          if (VariableName[0] == 0) {
> -            PtrTrack->CurrPtr   = Variable[Index];
> -            PtrTrack->Volatile  = (BOOLEAN) Index;
> -            return EFI_SUCCESS;
> -          } else {
> -            if (CompareGuid (VendorGuid, &Variable[Index]->VendorGuid)) {
> -              if (CompareMem (VariableName, GET_VARIABLE_NAME_PTR
> (Variable[Index]), Variable[Index]->NameSize) == 0) {
> -                PtrTrack->CurrPtr   = Variable[Index];
> -                PtrTrack->Volatile  = (BOOLEAN) Index;
> -                return EFI_SUCCESS;
> -              }
> -            }
> -          }
> -        }
> -      }
> -
> -      Variable[Index] = GetNextVariablePtr (Variable[Index]);
> -    }
> -  }
> -  PtrTrack->CurrPtr = NULL;
> -  return EFI_NOT_FOUND;
> -}
> -
> -/**
> -  This code finds variable in storage blocks (Volatile or Non-Volatile).
> -
> -  @param  VariableName           A Null-terminated Unicode string that is the
> name of
> -                                 the vendor's variable.
> -  @param  VendorGuid             A unique identifier for the vendor.
> -  @param  Attributes             If not NULL, a pointer to the memory location to
> return the
> -                                 attributes bitmask for the variable.
> -  @param  DataSize               Size of Data found. If size is less than the
> -                                 data, this value contains the required size.
> -  @param  Data                   On input, the size in bytes of the return Data buffer.
> -                                 On output, the size of data returned in Data.
> -  @param  Global                 Pointer to VARIABLE_GLOBAL structure
> -
> -  @retval EFI_SUCCESS            The function completed successfully.
> -  @retval EFI_NOT_FOUND          The variable was not found.
> -  @retval EFI_BUFFER_TOO_SMALL   DataSize is too small for the result.
> DataSize has
> -                                 been updated with the size needed to complete the request.
> -  @retval EFI_INVALID_PARAMETER  VariableName or VendorGuid or DataSize
> is NULL.
> -
> -**/
> -EFI_STATUS
> -EFIAPI
> -EmuGetVariable (
> -  IN      CHAR16            *VariableName,
> -  IN      EFI_GUID          *VendorGuid,
> -  OUT     UINT32            *Attributes OPTIONAL,
> -  IN OUT  UINTN             *DataSize,
> -  OUT     VOID              *Data,
> -  IN      VARIABLE_GLOBAL   *Global
> -  )
> -{
> -  VARIABLE_POINTER_TRACK  Variable;
> -  UINTN                   VarDataSize;
> -  EFI_STATUS              Status;
> -  UINT8                   *VariableDataPtr;
> -
> -  if (VariableName == NULL || VendorGuid == NULL || DataSize == NULL) {
> -    return EFI_INVALID_PARAMETER;
> -  }
> -
> -  if (VariableName[0] == 0) {
> -    return EFI_NOT_FOUND;
> -  }
> -
> -  AcquireLockOnlyAtBootTime(&Global->VariableServicesLock);
> -
> -  //
> -  // Find existing variable
> -  //
> -  Status = FindVariable (VariableName, VendorGuid, &Variable, Global);
> -
> -  if (Variable.CurrPtr == NULL || EFI_ERROR (Status)) {
> -    goto Done;
> -  }
> -  //
> -  // Get data size
> -  //
> -  VarDataSize = Variable.CurrPtr->DataSize;
> -  if (*DataSize >= VarDataSize) {
> -    if (Data == NULL) {
> -      Status = EFI_INVALID_PARAMETER;
> -      goto Done;
> -    }
> -    VariableDataPtr = GetVariableDataPtr (Variable.CurrPtr);
> -    ASSERT (VariableDataPtr != NULL);
> -
> -    CopyMem (Data, VariableDataPtr, VarDataSize);
> -    if (Attributes != NULL) {
> -      *Attributes = Variable.CurrPtr->Attributes;
> -    }
> -
> -    *DataSize = VarDataSize;
> -    UpdateVariableInfo (VariableName, VendorGuid, Variable.Volatile, TRUE,
> FALSE, FALSE, FALSE);
> -    Status = EFI_SUCCESS;
> -    goto Done;
> -  } else {
> -    *DataSize = VarDataSize;
> -    Status = EFI_BUFFER_TOO_SMALL;
> -    goto Done;
> -  }
> -
> -Done:
> -  ReleaseLockOnlyAtBootTime (&Global->VariableServicesLock);
> -  return Status;
> -}
> -
> -/**
> -
> -  This code Finds the Next available variable.
> -
> -  @param  VariableNameSize       The size of the VariableName buffer. The size
> must be large enough to fit input
> -                                 string supplied in VariableName buffer.
> -  @param  VariableName           On input, supplies the last VariableName that
> was returned by GetNextVariableName().
> -                                 On output, returns the Null-terminated Unicode string of the
> current variable.
> -  @param  VendorGuid             On input, supplies the last VendorGuid that was
> returned by GetNextVariableName().
> -                                 On output, returns the VendorGuid of the current variable.
> -  @param  Global                 Pointer to VARIABLE_GLOBAL structure.
> -
> -  @retval EFI_SUCCESS            The function completed successfully.
> -  @retval EFI_NOT_FOUND          The next variable was not found.
> -  @retval EFI_BUFFER_TOO_SMALL   The VariableNameSize is too small for the
> result.
> -                                 VariableNameSize has been updated with the size needed to
> complete the request.
> -  @retval EFI_INVALID_PARAMETER  VariableNameSize or VariableName or
> VendorGuid is NULL.
> -  @retval EFI_INVALID_PARAMETER  The input values of VariableName and
> VendorGuid are not a name and
> -                                 GUID of an existing variable.
> -  @retval EFI_INVALID_PARAMETER  Null-terminator is not found in the first
> VariableNameSize bytes of
> -                                 the input VariableName buffer.
> -
> -**/
> -EFI_STATUS
> -EFIAPI
> -EmuGetNextVariableName (
> -  IN OUT  UINTN             *VariableNameSize,
> -  IN OUT  CHAR16            *VariableName,
> -  IN OUT  EFI_GUID          *VendorGuid,
> -  IN      VARIABLE_GLOBAL   *Global
> -  )
> -{
> -  VARIABLE_POINTER_TRACK  Variable;
> -  UINTN                   VarNameSize;
> -  EFI_STATUS              Status;
> -  UINTN                   MaxLen;
> -
> -  if (VariableNameSize == NULL || VariableName == NULL || VendorGuid ==
> NULL) {
> -    return EFI_INVALID_PARAMETER;
> -  }
> -
> -  //
> -  // Calculate the possible maximum length of name string, including the Null
> terminator.
> -  //
> -  MaxLen = *VariableNameSize / sizeof (CHAR16);
> -  if ((MaxLen == 0) || (StrnLenS (VariableName, MaxLen) == MaxLen)) {
> -    //
> -    // Null-terminator is not found in the first VariableNameSize bytes of the
> input VariableName buffer,
> -    // follow spec to return EFI_INVALID_PARAMETER.
> -    //
> -    return EFI_INVALID_PARAMETER;
> -  }
> -
> -  AcquireLockOnlyAtBootTime(&Global->VariableServicesLock);
> -
> -  Status = FindVariable (VariableName, VendorGuid, &Variable, Global);
> -
> -  if (Variable.CurrPtr == NULL || EFI_ERROR (Status)) {
> -    //
> -    // For VariableName is an empty string, FindVariable() will try to find and
> return
> -    // the first qualified variable, and if FindVariable() returns error
> (EFI_NOT_FOUND)
> -    // as no any variable is found, still go to return the error (EFI_NOT_FOUND).
> -    //
> -    if (VariableName[0] != 0) {
> -      //
> -      // For VariableName is not an empty string, and FindVariable() returns error
> as
> -      // VariableName and VendorGuid are not a name and GUID of an existing
> variable,
> -      // there is no way to get next variable, follow spec to return
> EFI_INVALID_PARAMETER.
> -      //
> -      Status = EFI_INVALID_PARAMETER;
> -    }
> -    goto Done;
> -  }
> -
> -  while (TRUE) {
> -    if (VariableName[0] != 0) {
> -      //
> -      // If variable name is not NULL, get next variable
> -      //
> -      Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr);
> -    }
> -    //
> -    // If both volatile and non-volatile variable store are parsed,
> -    // return not found
> -    //
> -    if (Variable.CurrPtr >= Variable.EndPtr || Variable.CurrPtr == NULL) {
> -      Variable.Volatile = (BOOLEAN) (Variable.Volatile ^ ((BOOLEAN) 0x1));
> -      if (Variable.Volatile) {
> -        Variable.StartPtr = (VARIABLE_HEADER *) HEADER_ALIGN ((UINTN)
> (Global->VolatileVariableBase + sizeof (VARIABLE_STORE_HEADER)));
> -        Variable.EndPtr = (VARIABLE_HEADER *) GetEndPointer
> ((VARIABLE_STORE_HEADER *) ((UINTN) Global->VolatileVariableBase));
> -      } else {
> -        Status = EFI_NOT_FOUND;
> -        goto Done;
> -      }
> -
> -      Variable.CurrPtr = Variable.StartPtr;
> -      if (Variable.CurrPtr->StartId != VARIABLE_DATA) {
> -        continue;
> -      }
> -    }
> -    //
> -    // Variable is found
> -    //
> -    if (Variable.CurrPtr->StartId == VARIABLE_DATA && Variable.CurrPtr->State
> == VAR_ADDED) {
> -      if (!(EfiAtRuntime () && ((Variable.CurrPtr->Attributes &
> EFI_VARIABLE_RUNTIME_ACCESS) == 0))) {
> -        VarNameSize = Variable.CurrPtr->NameSize;
> -        if (VarNameSize <= *VariableNameSize) {
> -          CopyMem (
> -            VariableName,
> -            GET_VARIABLE_NAME_PTR (Variable.CurrPtr),
> -            VarNameSize
> -            );
> -          CopyMem (
> -            VendorGuid,
> -            &Variable.CurrPtr->VendorGuid,
> -            sizeof (EFI_GUID)
> -            );
> -          Status = EFI_SUCCESS;
> -        } else {
> -          Status = EFI_BUFFER_TOO_SMALL;
> -        }
> -
> -        *VariableNameSize = VarNameSize;
> -        goto Done;
> -      }
> -    }
> -  }
> -
> -Done:
> -  ReleaseLockOnlyAtBootTime (&Global->VariableServicesLock);
> -  return Status;
> -
> -}
> -
> -/**
> -
> -  This code sets variable in storage blocks (Volatile or Non-Volatile).
> -
> -  @param  VariableName           A Null-terminated Unicode string that is the
> name of the vendor's
> -                                 variable.  Each VariableName is unique for each
> -                                 VendorGuid.  VariableName must contain 1 or more
> -                                 Unicode characters.  If VariableName is an empty Unicode
> -                                 string, then EFI_INVALID_PARAMETER is returned.
> -  @param  VendorGuid             A unique identifier for the vendor
> -  @param  Attributes             Attributes bitmask to set for the variable
> -  @param  DataSize               The size in bytes of the Data buffer.  A size of zero
> causes the
> -                                 variable to be deleted.
> -  @param  Data                   The contents for the variable
> -  @param  Global                 Pointer to VARIABLE_GLOBAL structure
> -  @param  VolatileOffset         The offset of last volatile variable
> -  @param  NonVolatileOffset      The offset of last non-volatile variable
> -
> -  @retval EFI_SUCCESS            The firmware has successfully stored the variable
> and its data as
> -                                 defined by the Attributes.
> -  @retval EFI_INVALID_PARAMETER  An invalid combination of attribute bits
> was supplied, or the
> -                                 DataSize exceeds the maximum allowed, or VariableName is
> an empty
> -                                 Unicode string, or VendorGuid is NULL.
> -  @retval EFI_OUT_OF_RESOURCES   Not enough storage is available to hold
> the variable and its data.
> -  @retval EFI_DEVICE_ERROR       The variable could not be saved due to a
> hardware failure.
> -  @retval EFI_WRITE_PROTECTED    The variable in question is read-only or
> cannot be deleted.
> -  @retval EFI_NOT_FOUND          The variable trying to be updated or deleted
> was not found.
> -
> -**/
> -EFI_STATUS
> -EFIAPI
> -EmuSetVariable (
> -  IN CHAR16                  *VariableName,
> -  IN EFI_GUID                *VendorGuid,
> -  IN UINT32                  Attributes,
> -  IN UINTN                   DataSize,
> -  IN VOID                    *Data,
> -  IN VARIABLE_GLOBAL         *Global,
> -  IN UINTN                   *VolatileOffset,
> -  IN UINTN                   *NonVolatileOffset
> -  )
> -{
> -  VARIABLE_POINTER_TRACK  Variable;
> -  EFI_STATUS              Status;
> -
> -  //
> -  // Check input parameters
> -  //
> -  if (VariableName == NULL || VariableName[0] == 0 || VendorGuid == NULL) {
> -    return EFI_INVALID_PARAMETER;
> -  }
> -
> -  if (DataSize != 0 && Data == NULL) {
> -    return EFI_INVALID_PARAMETER;
> -  }
> -
> -  //
> -  // Not support authenticated variable write yet.
> -  //
> -  if ((Attributes & EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS) != 0) {
> -    return EFI_INVALID_PARAMETER;
> -  }
> -
> -  //
> -  //  Make sure if runtime bit is set, boot service bit is set also
> -  //
> -  if ((Attributes & (EFI_VARIABLE_RUNTIME_ACCESS |
> EFI_VARIABLE_BOOTSERVICE_ACCESS)) == EFI_VARIABLE_RUNTIME_ACCESS) {
> -    return EFI_INVALID_PARAMETER;
> -  }
> -
> -
> -  if ((UINTN)(~0) - DataSize < StrSize(VariableName)){
> -    //
> -    // Prevent whole variable size overflow
> -    //
> -    return EFI_INVALID_PARAMETER;
> -  }
> -
> -  //
> -  //  The size of the VariableName, including the Unicode Null in bytes plus
> -  //  the DataSize is limited to maximum size of PcdGet32
> (PcdMaxHardwareErrorVariableSize)
> -  //  bytes for HwErrRec, and PcdGet32 (PcdMaxVariableSize) bytes for the
> others.
> -  //
> -  if ((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) ==
> EFI_VARIABLE_HARDWARE_ERROR_RECORD) {
> -    if (StrSize (VariableName) + DataSize > PcdGet32
> (PcdMaxHardwareErrorVariableSize) - sizeof (VARIABLE_HEADER)) {
> -      return EFI_INVALID_PARAMETER;
> -    }
> -    //
> -    // According to UEFI spec, HARDWARE_ERROR_RECORD variable name
> convention should be L"HwErrRecXXXX"
> -    //
> -    if (StrnCmp(VariableName, L"HwErrRec", StrLen(L"HwErrRec")) != 0) {
> -      return EFI_INVALID_PARAMETER;
> -    }
> -  } else {
> -  //
> -  //  The size of the VariableName, including the Unicode Null in bytes plus
> -  //  the DataSize is limited to maximum size of PcdGet32 (PcdMaxVariableSize)
> bytes.
> -  //
> -    if (StrSize (VariableName) + DataSize > PcdGet32 (PcdMaxVariableSize) -
> sizeof (VARIABLE_HEADER)) {
> -      return EFI_INVALID_PARAMETER;
> -    }
> -  }
> -
> -  AcquireLockOnlyAtBootTime(&Global->VariableServicesLock);
> -
> -  //
> -  // Check whether the input variable is already existed
> -  //
> -
> -  Status = FindVariable (VariableName, VendorGuid, &Variable, Global);
> -
> -  //
> -  // Hook the operation of setting PlatformLangCodes/PlatformLang and
> LangCodes/Lang
> -  //
> -  AutoUpdateLangVariable (VariableName, Data, DataSize);
> -
> -  Status = UpdateVariable (VariableName, VendorGuid, Data, DataSize,
> Attributes, &Variable);
> -
> -  ReleaseLockOnlyAtBootTime (&Global->VariableServicesLock);
> -  return Status;
> -}
> -
> -/**
> -
> -  This code returns information about the EFI variables.
> -
> -  @param  Attributes                   Attributes bitmask to specify the type of
> variables
> -                                       on which to return information.
> -  @param  MaximumVariableStorageSize   On output the maximum size of the
> storage space available for
> -                                       the EFI variables associated with the attributes specified.
> -  @param  RemainingVariableStorageSize Returns the remaining size of the
> storage space available for EFI
> -                                       variables associated with the attributes specified.
> -  @param  MaximumVariableSize          Returns the maximum size of an
> individual EFI variable
> -                                       associated with the attributes specified.
> -  @param  Global                       Pointer to VARIABLE_GLOBAL structure.
> -
> -  @retval EFI_SUCCESS                  Valid answer returned.
> -  @retval EFI_INVALID_PARAMETER        An invalid combination of attribute bits
> was supplied
> -  @retval EFI_UNSUPPORTED              The attribute is not supported on this
> platform, and the
> -                                       MaximumVariableStorageSize,
> RemainingVariableStorageSize,
> -                                       MaximumVariableSize are undefined.
> -
> -**/
> -EFI_STATUS
> -EFIAPI
> -EmuQueryVariableInfo (
> -  IN  UINT32                 Attributes,
> -  OUT UINT64                 *MaximumVariableStorageSize,
> -  OUT UINT64                 *RemainingVariableStorageSize,
> -  OUT UINT64                 *MaximumVariableSize,
> -  IN  VARIABLE_GLOBAL        *Global
> -  )
> -{
> -  VARIABLE_HEADER        *Variable;
> -  VARIABLE_HEADER        *NextVariable;
> -  UINT64                 VariableSize;
> -  VARIABLE_STORE_HEADER  *VariableStoreHeader;
> -  UINT64                 CommonVariableTotalSize;
> -  UINT64                 HwErrVariableTotalSize;
> -
> -  CommonVariableTotalSize = 0;
> -  HwErrVariableTotalSize = 0;
> -
> -  if(MaximumVariableStorageSize == NULL || RemainingVariableStorageSize ==
> NULL || MaximumVariableSize == NULL || Attributes == 0) {
> -    return EFI_INVALID_PARAMETER;
> -  }
> -
> -  if((Attributes & (EFI_VARIABLE_NON_VOLATILE |
> EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS |
> EFI_VARIABLE_HARDWARE_ERROR_RECORD)) == 0) {
> -    //
> -    // Make sure the Attributes combination is supported by the platform.
> -    //
> -    return EFI_UNSUPPORTED;
> -  } else if ((Attributes & (EFI_VARIABLE_RUNTIME_ACCESS |
> EFI_VARIABLE_BOOTSERVICE_ACCESS)) == EFI_VARIABLE_RUNTIME_ACCESS) {
> -    //
> -    // Make sure if runtime bit is set, boot service bit is set also.
> -    //
> -    return EFI_INVALID_PARAMETER;
> -  } else if (EfiAtRuntime () && ((Attributes & EFI_VARIABLE_RUNTIME_ACCESS)
> == 0)) {
> -    //
> -    //   Make sure RT Attribute is set if we are in Runtime phase.
> -    //
> -    return EFI_INVALID_PARAMETER;
> -  } else if ((Attributes & (EFI_VARIABLE_NON_VOLATILE |
> EFI_VARIABLE_HARDWARE_ERROR_RECORD)) ==
> EFI_VARIABLE_HARDWARE_ERROR_RECORD) {
> -    //
> -    // Make sure Hw Attribute is set with NV.
> -    //
> -    return EFI_INVALID_PARAMETER;
> -  } else if ((Attributes & EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS) != 0) {
> -    //
> -    // Not support authentiated variable write yet.
> -    //
> -    return EFI_UNSUPPORTED;
> -  }
> -
> -  AcquireLockOnlyAtBootTime(&Global->VariableServicesLock);
> -
> -  if((Attributes & EFI_VARIABLE_NON_VOLATILE) == 0) {
> -    //
> -    // Query is Volatile related.
> -    //
> -    VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINTN) Global-
> >VolatileVariableBase);
> -  } else {
> -    //
> -    // Query is Non-Volatile related.
> -    //
> -    VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINTN) Global-
> >NonVolatileVariableBase);
> -  }
> -
> -  //
> -  // Now let's fill *MaximumVariableStorageSize
> *RemainingVariableStorageSize
> -  // with the storage size (excluding the storage header size)
> -  //
> -  *MaximumVariableStorageSize   = VariableStoreHeader->Size - sizeof
> (VARIABLE_STORE_HEADER);
> -
> -  //
> -  // Harware error record variable needs larger size.
> -  //
> -  if ((Attributes & (EFI_VARIABLE_NON_VOLATILE |
> EFI_VARIABLE_HARDWARE_ERROR_RECORD)) ==
> (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD))
> {
> -    *MaximumVariableStorageSize = PcdGet32 (PcdHwErrStorageSize);
> -    *MaximumVariableSize = PcdGet32 (PcdMaxHardwareErrorVariableSize) -
> sizeof (VARIABLE_HEADER);
> -  } else {
> -    if ((Attributes & EFI_VARIABLE_NON_VOLATILE) != 0) {
> -      ASSERT (PcdGet32 (PcdHwErrStorageSize) < VariableStoreHeader->Size);
> -      *MaximumVariableStorageSize = VariableStoreHeader->Size - sizeof
> (VARIABLE_STORE_HEADER) - PcdGet32 (PcdHwErrStorageSize);
> -    }
> -
> -    //
> -    // Let *MaximumVariableSize be PcdGet32 (PcdMaxVariableSize) with the
> exception of the variable header size.
> -    //
> -    *MaximumVariableSize = PcdGet32 (PcdMaxVariableSize) - sizeof
> (VARIABLE_HEADER);
> -  }
> -
> -  //
> -  // Point to the starting address of the variables.
> -  //
> -  Variable = (VARIABLE_HEADER *) HEADER_ALIGN (VariableStoreHeader + 1);
> -
> -  //
> -  // Now walk through the related variable store.
> -  //
> -  while (Variable < GetEndPointer (VariableStoreHeader)) {
> -    NextVariable = GetNextVariablePtr(Variable);
> -    if (NextVariable == NULL) {
> -      break;
> -    }
> -    VariableSize = (UINT64) (UINTN) NextVariable - (UINT64) (UINTN) Variable;
> -
> -    if ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) ==
> EFI_VARIABLE_HARDWARE_ERROR_RECORD) {
> -      HwErrVariableTotalSize += VariableSize;
> -    } else {
> -      CommonVariableTotalSize += VariableSize;
> -    }
> -
> -    //
> -    // Go to the next one.
> -    //
> -    Variable = NextVariable;
> -  }
> -
> -  if ((Attributes  & EFI_VARIABLE_HARDWARE_ERROR_RECORD) ==
> EFI_VARIABLE_HARDWARE_ERROR_RECORD){
> -    *RemainingVariableStorageSize = *MaximumVariableStorageSize -
> HwErrVariableTotalSize;
> -  } else {
> -    *RemainingVariableStorageSize = *MaximumVariableStorageSize -
> CommonVariableTotalSize;
> -  }
> -
> -  if (*RemainingVariableStorageSize < sizeof (VARIABLE_HEADER)) {
> -    *MaximumVariableSize = 0;
> -  } else if ((*RemainingVariableStorageSize - sizeof (VARIABLE_HEADER)) <
> *MaximumVariableSize) {
> -    *MaximumVariableSize = *RemainingVariableStorageSize - sizeof
> (VARIABLE_HEADER);
> -  }
> -
> -  ReleaseLockOnlyAtBootTime (&Global->VariableServicesLock);
> -  return EFI_SUCCESS;
> -}
> -
> -/**
> -  Initializes variable store area.
> -
> -  This function allocates memory space for variable store area and initializes its
> attributes.
> -
> -  @param  VolatileStore  Indicates if the variable store is volatile.
> -
> -**/
> -EFI_STATUS
> -InitializeVariableStore (
> -  IN  BOOLEAN               VolatileStore
> -  )
> -{
> -  EFI_STATUS            Status;
> -  VARIABLE_STORE_HEADER *VariableStore;
> -  BOOLEAN               FullyInitializeStore;
> -  EFI_PHYSICAL_ADDRESS  *VariableBase;
> -  UINTN                 *LastVariableOffset;
> -  VARIABLE_STORE_HEADER *VariableStoreHeader;
> -  VARIABLE_HEADER       *Variable;
> -  VOID                  *VariableData;
> -  EFI_HOB_GUID_TYPE     *GuidHob;
> -
> -  FullyInitializeStore = TRUE;
> -
> -  if (VolatileStore) {
> -    VariableBase = &mVariableModuleGlobal-
> >VariableGlobal[Physical].VolatileVariableBase;
> -    LastVariableOffset = &mVariableModuleGlobal->VolatileLastVariableOffset;
> -  } else {
> -    VariableBase = &mVariableModuleGlobal-
> >VariableGlobal[Physical].NonVolatileVariableBase;
> -    LastVariableOffset = &mVariableModuleGlobal-
> >NonVolatileLastVariableOffset;
> -  }
> -
> -  //
> -  // Note that in EdkII variable driver implementation, Hardware Error Record
> type variable
> -  // is stored with common variable in the same NV region. So the platform
> integrator should
> -  // ensure that the value of PcdHwErrStorageSize is less than or equal to the
> value of
> -  // PcdVariableStoreSize.
> -  //
> -  ASSERT (PcdGet32 (PcdHwErrStorageSize) <= PcdGet32 (PcdVariableStoreSize));
> -
> -  //
> -  // Allocate memory for variable store.
> -  //
> -  if (VolatileStore || (PcdGet64 (PcdEmuVariableNvStoreReserved) == 0)) {
> -    VariableStore = (VARIABLE_STORE_HEADER *) AllocateRuntimePool
> (PcdGet32 (PcdVariableStoreSize));
> -  } else {
> -    //
> -    // A memory location has been reserved for the NV variable store.  Certain
> -    // platforms may be able to preserve a memory range across system resets,
> -    // thereby providing better NV variable emulation.
> -    //
> -    VariableStore =
> -      (VARIABLE_STORE_HEADER *)(VOID*)(UINTN)
> -        PcdGet64 (PcdEmuVariableNvStoreReserved);
> -    if (
> -         (VariableStore->Size == PcdGet32 (PcdVariableStoreSize)) &&
> -         (VariableStore->Format == VARIABLE_STORE_FORMATTED) &&
> -         (VariableStore->State == VARIABLE_STORE_HEALTHY)
> -       ) {
> -      DEBUG((
> -        EFI_D_INFO,
> -        "Variable Store reserved at %p appears to be valid\n",
> -        VariableStore
> -        ));
> -      FullyInitializeStore = FALSE;
> -    }
> -  }
> -
> -  if (NULL == VariableStore) {
> -    return EFI_OUT_OF_RESOURCES;
> -  }
> -
> -  if (FullyInitializeStore) {
> -    SetMem (VariableStore, PcdGet32 (PcdVariableStoreSize), 0xff);
> -  }
> -
> -  //
> -  // Variable Specific Data
> -  //
> -  *VariableBase             = (EFI_PHYSICAL_ADDRESS) (UINTN) VariableStore;
> -  InitializeLocationForLastVariableOffset (VariableStore, LastVariableOffset);
> -
> -  CopyGuid (&VariableStore->Signature, &gEfiVariableGuid);
> -  VariableStore->Size       = PcdGet32 (PcdVariableStoreSize);
> -  VariableStore->Format     = VARIABLE_STORE_FORMATTED;
> -  VariableStore->State      = VARIABLE_STORE_HEALTHY;
> -  VariableStore->Reserved   = 0;
> -  VariableStore->Reserved1  = 0;
> -
> -  if (!VolatileStore) {
> -    //
> -    // Get HOB variable store.
> -    //
> -    GuidHob = GetFirstGuidHob (&gEfiVariableGuid);
> -    if (GuidHob != NULL) {
> -      VariableStoreHeader = (VARIABLE_STORE_HEADER *)
> GET_GUID_HOB_DATA (GuidHob);
> -      if (CompareGuid (&VariableStoreHeader->Signature, &gEfiVariableGuid) &&
> -          (VariableStoreHeader->Format == VARIABLE_STORE_FORMATTED) &&
> -          (VariableStoreHeader->State == VARIABLE_STORE_HEALTHY)
> -         ) {
> -        DEBUG ((EFI_D_INFO, "HOB Variable Store appears to be valid.\n"));
> -        //
> -        // Flush the HOB variable to Emulation Variable storage.
> -        //
> -        for ( Variable = (VARIABLE_HEADER *) HEADER_ALIGN
> (VariableStoreHeader + 1)
> -            ; (Variable < GetEndPointer (VariableStoreHeader) && (Variable != NULL))
> -            ; Variable = GetNextVariablePtr (Variable)
> -            ) {
> -          ASSERT (Variable->State == VAR_ADDED);
> -          ASSERT ((Variable->Attributes & EFI_VARIABLE_NON_VOLATILE) != 0);
> -          VariableData = GetVariableDataPtr (Variable);
> -          Status = EmuSetVariable (
> -                     GET_VARIABLE_NAME_PTR (Variable),
> -                     &Variable->VendorGuid,
> -                     Variable->Attributes,
> -                     Variable->DataSize,
> -                     VariableData,
> -                     &mVariableModuleGlobal->VariableGlobal[Physical],
> -                     &mVariableModuleGlobal->VolatileLastVariableOffset,
> -                     &mVariableModuleGlobal->NonVolatileLastVariableOffset
> -                     );
> -          ASSERT_EFI_ERROR (Status);
> -        }
> -      }
> -    }
> -  }
> -
> -  return EFI_SUCCESS;
> -}
> -
> -/**
> -  Initializes variable store area for non-volatile and volatile variable.
> -
> -  This function allocates and initializes memory space for global context of ESAL
> -  variable service and variable store area for non-volatile and volatile variable.
> -
> -  @param  ImageHandle           The Image handle of this driver.
> -  @param  SystemTable           The pointer of EFI_SYSTEM_TABLE.
> -
> -  @retval EFI_SUCCESS           Function successfully executed.
> -  @retval EFI_OUT_OF_RESOURCES  Fail to allocate enough memory resource.
> -
> -**/
> -EFI_STATUS
> -EFIAPI
> -VariableCommonInitialize (
> -  IN EFI_HANDLE         ImageHandle,
> -  IN EFI_SYSTEM_TABLE   *SystemTable
> -  )
> -{
> -  EFI_STATUS  Status;
> -
> -  //
> -  // Allocate memory for mVariableModuleGlobal
> -  //
> -  mVariableModuleGlobal = (ESAL_VARIABLE_GLOBAL *)
> AllocateRuntimeZeroPool (
> -                                                    sizeof (ESAL_VARIABLE_GLOBAL)
> -                                                   );
> -  if (NULL == mVariableModuleGlobal) {
> -    return EFI_OUT_OF_RESOURCES;
> -  }
> -
> -  EfiInitializeLock(&mVariableModuleGlobal-
> >VariableGlobal[Physical].VariableServicesLock, TPL_NOTIFY);
> -
> -  //
> -  // Intialize volatile variable store
> -  //
> -  Status = InitializeVariableStore (TRUE);
> -  if (EFI_ERROR (Status)) {
> -    FreePool(mVariableModuleGlobal);
> -    return Status;
> -  }
> -  //
> -  // Intialize non volatile variable store
> -  //
> -  Status = InitializeVariableStore (FALSE);
> -
> -  return Status;
> -}
> diff --git
> a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDx
> e.inf
> b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDx
> e.inf
> deleted file mode 100644
> index 12d52dd130e3..000000000000
> ---
> a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDx
> e.inf
> +++ /dev/null
> @@ -1,88 +0,0 @@
> -## @file
> -# Emulation Variable for EFI_RUNTIME_SERVICES.
> -#
> -# This module installs variable arch protocol and variable write arch protocol to
> provide
> -# four EFI_RUNTIME_SERVICES: SetVariable, GetVariable,
> GetNextVariableName and QueryVariableInfo.
> -#
> -# Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
> -#
> -#  This program and the accompanying materials
> -#  are licensed and made available under the terms and conditions of the BSD
> License
> -#  which accompanies this distribution. The full text of the license may be found
> at
> -#  http://opensource.org/licenses/bsd-license.php
> -#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS"
> BASIS,
> -#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER
> EXPRESS OR IMPLIED.
> -#
> -#
> -##
> -
> -[Defines]
> -  INF_VERSION                    = 0x00010005
> -  BASE_NAME                      = EmuVariableRuntimeDxe
> -  MODULE_UNI_FILE                = EmuVariableRuntimeDxe.uni
> -  FILE_GUID                      = 02B01AD5-7E59-43e8-A6D8-238180613A5A
> -  MODULE_TYPE                    = DXE_RUNTIME_DRIVER
> -  VERSION_STRING                 = 1.0
> -  ENTRY_POINT                    = VariableServiceInitialize
> -
> -#
> -# The following information is for reference only and not required by the build
> tools.
> -#
> -#  VALID_ARCHITECTURES           = IA32 X64 EBC
> -#
> -
> -[Sources]
> -  InitVariable.c
> -  EmuVariable.c
> -  Variable.h
> -
> -
> -[Packages]
> -  MdePkg/MdePkg.dec
> -  MdeModulePkg/MdeModulePkg.dec
> -
> -
> -[LibraryClasses]
> -  BaseLib
> -  UefiLib
> -  UefiBootServicesTableLib
> -  UefiDriverEntryPoint
> -  UefiRuntimeLib
> -  DebugLib
> -  MemoryAllocationLib
> -  BaseMemoryLib
> -  HobLib
> -  PcdLib
> -
> -[Protocols]
> -  gEfiVariableArchProtocolGuid                  ## PRODUCES
> -  gEfiVariableWriteArchProtocolGuid             ## PRODUCES
> -
> -[Guids]
> -  gEfiEventVirtualAddressChangeGuid             ## CONSUMES             ## Event
> -  ## SOMETIMES_CONSUMES   ## Variable:L"PlatformLang"
> -  ## SOMETIMES_PRODUCES   ## Variable:L"PlatformLang"
> -  ## SOMETIMES_CONSUMES   ## Variable:L"Lang"
> -  ## SOMETIMES_PRODUCES   ## Variable:L"Lang"
> -  gEfiGlobalVariableGuid
> -  ## PRODUCES             ## GUID # Signature of Variable store header
> -  ## CONSUMES             ## GUID # Signature of Variable store header
> -  ## SOMETIMES_CONSUMES   ## HOB
> -  ## SOMETIMES_PRODUCES   ## SystemTable
> -  gEfiVariableGuid
> -
> -[Pcd]
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvStoreReserved      ##
> CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize                 ##
> CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdMaxHardwareErrorVariableSize    ##
> CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdVariableStoreSize               ##
> CONSUMES
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdHwErrStorageSize                ##
> CONSUMES
> -
> -[FeaturePcd]
> -  gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics   ##
> CONSUMES # statistic the information of variable.
> -
> -[Depex]
> -  TRUE
> -
> -[UserExtensions.TianoCore."ExtraFiles"]
> -  EmuVariableRuntimeDxeExtra.uni
> diff --git
> a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDx
> e.uni
> b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDx
> e.uni
> deleted file mode 100644
> index 6ad601812169..000000000000
> ---
> a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDx
> e.uni
> +++ /dev/null
> @@ -1,22 +0,0 @@
> -// /** @file
> -// Emulation Variable for EFI_RUNTIME_SERVICES.
> -//
> -// This module installs variable arch protocol and variable write arch protocol
> to provide
> -// four EFI_RUNTIME_SERVICES: SetVariable, GetVariable,
> GetNextVariableName and QueryVariableInfo.
> -//
> -// Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
> -//
> -// This program and the accompanying materials
> -// are licensed and made available under the terms and conditions of the BSD
> License
> -// which accompanies this distribution. The full text of the license may be found
> at
> -// http://opensource.org/licenses/bsd-license.php
> -// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS"
> BASIS,
> -// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER
> EXPRESS OR IMPLIED.
> -//
> -// **/
> -
> -
> -#string STR_MODULE_ABSTRACT             #language en-US "Emulation Variable
> for EFI_RUNTIME_SERVICES"
> -
> -#string STR_MODULE_DESCRIPTION          #language en-US "This module
> installs variable arch protocol and variable write arch protocol to provide four
> EFI_RUNTIME_SERVICES: SetVariable, GetVariable, GetNextVariableName and
> QueryVariableInfo."
> -
> diff --git
> a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDx
> eExtra.uni
> b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDx
> eExtra.uni
> deleted file mode 100644
> index a5000373733e..000000000000
> ---
> a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariableRuntimeDx
> eExtra.uni
> +++ /dev/null
> @@ -1,19 +0,0 @@
> -// /** @file
> -// EmuVariableRuntimeDxe Localized Strings and Content
> -//
> -// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>
> -//
> -// This program and the accompanying materials
> -// are licensed and made available under the terms and conditions of the BSD
> License
> -// which accompanies this distribution. The full text of the license may be found
> at
> -// http://opensource.org/licenses/bsd-license.php
> -// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS"
> BASIS,
> -// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER
> EXPRESS OR IMPLIED.
> -//
> -// **/
> -
> -#string STR_PROPERTIES_MODULE_NAME
> -#language en-US
> -"Emulation Variable DXE Driver"
> -
> -
> diff --git a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/InitVariable.c
> b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/InitVariable.c
> deleted file mode 100644
> index dac0464253d6..000000000000
> --- a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/InitVariable.c
> +++ /dev/null
> @@ -1,259 +0,0 @@
> -/** @file
> -
> -  Implment all four UEFI runtime variable services and
> -  install variable architeture protocol.
> -
> -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
> -This program and the accompanying materials
> -are licensed and made available under the terms and conditions of the BSD
> License
> -which accompanies this distribution.  The full text of the license may be found
> at
> -http://opensource.org/licenses/bsd-license.php
> -
> -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
> -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS
> OR IMPLIED.
> -
> -**/
> -
> -#include "Variable.h"
> -
> -EFI_EVENT   mVirtualAddressChangeEvent = NULL;
> -
> -/**
> -
> -  This code finds variable in storage blocks (Volatile or Non-Volatile).
> -
> -  @param VariableName               Name of Variable to be found.
> -  @param VendorGuid                 Variable vendor GUID.
> -  @param Attributes                 Attribute value of the variable found.
> -  @param DataSize                   Size of Data found. If size is less than the
> -                                    data, this value contains the required size.
> -  @param Data                       The buffer to return the contents of the variable.
> May be NULL
> -                                    with a zero DataSize in order to determine the size buffer
> needed.
> -
> -  @return EFI_INVALID_PARAMETER     Invalid parameter
> -  @return EFI_SUCCESS               Find the specified variable
> -  @return EFI_NOT_FOUND             Not found
> -  @return EFI_BUFFER_TO_SMALL       DataSize is too small for the result
> -
> -**/
> -EFI_STATUS
> -EFIAPI
> -RuntimeServiceGetVariable (
> -  IN CHAR16        *VariableName,
> -  IN EFI_GUID      *VendorGuid,
> -  OUT UINT32       *Attributes OPTIONAL,
> -  IN OUT UINTN     *DataSize,
> -  OUT VOID         *Data OPTIONAL
> -  )
> -{
> -  return EmuGetVariable (
> -          VariableName,
> -          VendorGuid,
> -          Attributes OPTIONAL,
> -          DataSize,
> -          Data,
> -          &mVariableModuleGlobal->VariableGlobal[Physical]
> -          );
> -}
> -
> -/**
> -
> -  This code Finds the Next available variable.
> -
> -  @param  VariableNameSize       The size of the VariableName buffer. The size
> must be large enough to fit input
> -                                 string supplied in VariableName buffer.
> -  @param  VariableName           On input, supplies the last VariableName that
> was returned by GetNextVariableName().
> -                                 On output, returns the Null-terminated Unicode string of the
> current variable.
> -  @param  VendorGuid             On input, supplies the last VendorGuid that was
> returned by GetNextVariableName().
> -                                 On output, returns the VendorGuid of the current variable.
> -
> -  @retval EFI_SUCCESS            The function completed successfully.
> -  @retval EFI_NOT_FOUND          The next variable was not found.
> -  @retval EFI_BUFFER_TOO_SMALL   The VariableNameSize is too small for the
> result.
> -                                 VariableNameSize has been updated with the size needed to
> complete the request.
> -  @retval EFI_INVALID_PARAMETER  VariableNameSize or VariableName or
> VendorGuid is NULL.
> -  @retval EFI_INVALID_PARAMETER  The input values of VariableName and
> VendorGuid are not a name and
> -                                 GUID of an existing variable.
> -  @retval EFI_INVALID_PARAMETER  Null-terminator is not found in the first
> VariableNameSize bytes of
> -                                 the input VariableName buffer.
> -
> -**/
> -EFI_STATUS
> -EFIAPI
> -RuntimeServiceGetNextVariableName (
> -  IN OUT UINTN     *VariableNameSize,
> -  IN OUT CHAR16    *VariableName,
> -  IN OUT EFI_GUID  *VendorGuid
> -  )
> -{
> -  return EmuGetNextVariableName (
> -          VariableNameSize,
> -          VariableName,
> -          VendorGuid,
> -          &mVariableModuleGlobal->VariableGlobal[Physical]
> -          );
> -}
> -
> -/**
> -
> -  This code sets variable in storage blocks (Volatile or Non-Volatile).
> -
> -  @param VariableName                     Name of Variable to be found
> -  @param VendorGuid                       Variable vendor GUID
> -  @param Attributes                       Attribute value of the variable found
> -  @param DataSize                         Size of Data found. If size is less than the
> -                                          data, this value contains the required size.
> -  @param Data                             Data pointer
> -
> -  @return EFI_INVALID_PARAMETER           Invalid parameter
> -  @return EFI_SUCCESS                     Set successfully
> -  @return EFI_OUT_OF_RESOURCES            Resource not enough to set variable
> -  @return EFI_NOT_FOUND                   Not found
> -  @return EFI_WRITE_PROTECTED             Variable is read-only
> -
> -**/
> -EFI_STATUS
> -EFIAPI
> -RuntimeServiceSetVariable (
> -  IN CHAR16        *VariableName,
> -  IN EFI_GUID      *VendorGuid,
> -  IN UINT32        Attributes,
> -  IN UINTN         DataSize,
> -  IN VOID          *Data
> -  )
> -{
> -  return EmuSetVariable (
> -          VariableName,
> -          VendorGuid,
> -          Attributes,
> -          DataSize,
> -          Data,
> -          &mVariableModuleGlobal->VariableGlobal[Physical],
> -          &mVariableModuleGlobal->VolatileLastVariableOffset,
> -          &mVariableModuleGlobal->NonVolatileLastVariableOffset
> -          );
> -}
> -
> -/**
> -
> -  This code returns information about the EFI variables.
> -
> -  @param Attributes                     Attributes bitmask to specify the type of
> variables
> -                                        on which to return information.
> -  @param MaximumVariableStorageSize     Pointer to the maximum size of the
> storage space available
> -                                        for the EFI variables associated with the attributes
> specified.
> -  @param RemainingVariableStorageSize   Pointer to the remaining size of the
> storage space available
> -                                        for EFI variables associated with the attributes specified.
> -  @param MaximumVariableSize            Pointer to the maximum size of an
> individual EFI variables
> -                                        associated with the attributes specified.
> -
> -  @return EFI_INVALID_PARAMETER         An invalid combination of attribute
> bits was supplied.
> -  @return EFI_SUCCESS                   Query successfully.
> -  @return EFI_UNSUPPORTED               The attribute is not supported on this
> platform.
> -
> -**/
> -EFI_STATUS
> -EFIAPI
> -RuntimeServiceQueryVariableInfo (
> -  IN  UINT32                 Attributes,
> -  OUT UINT64                 *MaximumVariableStorageSize,
> -  OUT UINT64                 *RemainingVariableStorageSize,
> -  OUT UINT64                 *MaximumVariableSize
> -  )
> -{
> -  return EmuQueryVariableInfo (
> -          Attributes,
> -          MaximumVariableStorageSize,
> -          RemainingVariableStorageSize,
> -          MaximumVariableSize,
> -          &mVariableModuleGlobal->VariableGlobal[Physical]
> -          );
> -}
> -
> -/**
> -  Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.
> -
> -  This is a notification function registered on
> EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
> -  It convers pointer to new virtual address.
> -
> -  @param  Event        Event whose notification function is being invoked.
> -  @param  Context      Pointer to the notification function's context.
> -
> -**/
> -VOID
> -EFIAPI
> -VariableClassAddressChangeEvent (
> -  IN EFI_EVENT        Event,
> -  IN VOID             *Context
> -  )
> -{
> -  EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal-
> >PlatformLangCodes);
> -  EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->LangCodes);
> -  EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->PlatformLang);
> -  EfiConvertPointer (
> -    0x0,
> -    (VOID **) &mVariableModuleGlobal-
> >VariableGlobal[Physical].NonVolatileVariableBase
> -    );
> -  EfiConvertPointer (
> -    0x0,
> -    (VOID **) &mVariableModuleGlobal-
> >VariableGlobal[Physical].VolatileVariableBase
> -    );
> -  EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal);
> -}
> -
> -/**
> -  EmuVariable Driver main entry point. The Variable driver places the 4 EFI
> -  runtime services in the EFI System Table and installs arch protocols
> -  for variable read and write services being available. It also registers
> -  notification function for EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
> -
> -  @param[in] ImageHandle    The firmware allocated handle for the EFI image.
> -  @param[in] SystemTable    A pointer to the EFI System Table.
> -
> -  @retval EFI_SUCCESS       Variable service successfully initialized.
> -
> -**/
> -EFI_STATUS
> -EFIAPI
> -VariableServiceInitialize (
> -  IN EFI_HANDLE         ImageHandle,
> -  IN EFI_SYSTEM_TABLE   *SystemTable
> -  )
> -{
> -  EFI_HANDLE  NewHandle;
> -  EFI_STATUS  Status;
> -
> -  Status = VariableCommonInitialize (ImageHandle, SystemTable);
> -  ASSERT_EFI_ERROR (Status);
> -
> -  SystemTable->RuntimeServices->GetVariable         =
> RuntimeServiceGetVariable;
> -  SystemTable->RuntimeServices->GetNextVariableName =
> RuntimeServiceGetNextVariableName;
> -  SystemTable->RuntimeServices->SetVariable         = RuntimeServiceSetVariable;
> -  SystemTable->RuntimeServices->QueryVariableInfo   =
> RuntimeServiceQueryVariableInfo;
> -
> -  //
> -  // Now install the Variable Runtime Architectural Protocol on a new handle
> -  //
> -  NewHandle = NULL;
> -  Status = gBS->InstallMultipleProtocolInterfaces (
> -                  &NewHandle,
> -                  &gEfiVariableArchProtocolGuid,
> -                  NULL,
> -                  &gEfiVariableWriteArchProtocolGuid,
> -                  NULL,
> -                  NULL
> -                  );
> -  ASSERT_EFI_ERROR (Status);
> -
> -  Status = gBS->CreateEventEx (
> -                  EVT_NOTIFY_SIGNAL,
> -                  TPL_NOTIFY,
> -                  VariableClassAddressChangeEvent,
> -                  NULL,
> -                  &gEfiEventVirtualAddressChangeGuid,
> -                  &mVirtualAddressChangeEvent
> -                  );
> -  ASSERT_EFI_ERROR (Status);
> -
> -  return EFI_SUCCESS;
> -}
> diff --git a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h
> b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h
> deleted file mode 100644
> index 2851582d0dc0..000000000000
> --- a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h
> +++ /dev/null
> @@ -1,277 +0,0 @@
> -/** @file
> -
> -  The internal header file includes the common header files, defines
> -  internal structure and functions used by EmuVariable module.
> -
> -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
> -This program and the accompanying materials
> -are licensed and made available under the terms and conditions of the BSD
> License
> -which accompanies this distribution.  The full text of the license may be found
> at
> -http://opensource.org/licenses/bsd-license.php
> -
> -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
> -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS
> OR IMPLIED.
> -
> -**/
> -
> -#ifndef _VARIABLE_H_
> -#define _VARIABLE_H_
> -
> -#include <Uefi.h>
> -
> -#include <Protocol/VariableWrite.h>
> -#include <Protocol/Variable.h>
> -
> -#include <Library/BaseMemoryLib.h>
> -#include <Library/MemoryAllocationLib.h>
> -#include <Library/DebugLib.h>
> -#include <Library/UefiRuntimeLib.h>
> -#include <Library/UefiDriverEntryPoint.h>
> -#include <Library/UefiBootServicesTableLib.h>
> -#include <Library/UefiLib.h>
> -#include <Library/BaseLib.h>
> -#include <Library/PcdLib.h>
> -#include <Library/HobLib.h>
> -#include <Guid/VariableFormat.h>
> -#include <Guid/GlobalVariable.h>
> -
> -#include <Guid/EventGroup.h>
> -
> -#define GET_VARIABLE_NAME_PTR(a)  (CHAR16 *) ((UINTN) (a) + sizeof
> (VARIABLE_HEADER))
> -
> -///
> -/// The size of a 3 character ISO639 language code.
> -///
> -#define ISO_639_2_ENTRY_SIZE    3
> -
> -typedef enum {
> -  Physical,
> -  Virtual
> -} VARIABLE_POINTER_TYPE;
> -
> -typedef struct {
> -  VARIABLE_HEADER *CurrPtr;
> -  VARIABLE_HEADER *EndPtr;
> -  VARIABLE_HEADER *StartPtr;
> -  BOOLEAN         Volatile;
> -} VARIABLE_POINTER_TRACK;
> -
> -typedef struct {
> -  EFI_PHYSICAL_ADDRESS  VolatileVariableBase;
> -  EFI_PHYSICAL_ADDRESS  NonVolatileVariableBase;
> -  EFI_LOCK              VariableServicesLock;
> -} VARIABLE_GLOBAL;
> -
> -typedef struct {
> -  VARIABLE_GLOBAL VariableGlobal[2];
> -  UINTN           VolatileLastVariableOffset;
> -  UINTN           NonVolatileLastVariableOffset;
> -  UINTN           CommonVariableTotalSize;
> -  UINTN           HwErrVariableTotalSize;
> -  CHAR8           *PlatformLangCodes;
> -  CHAR8           *LangCodes;
> -  CHAR8           *PlatformLang;
> -  CHAR8           Lang[ISO_639_2_ENTRY_SIZE + 1];
> -} ESAL_VARIABLE_GLOBAL;
> -
> -///
> -/// Don't use module globals after the SetVirtualAddress map is signaled
> -///
> -extern ESAL_VARIABLE_GLOBAL *mVariableModuleGlobal;
> -
> -/**
> -  Initializes variable store area for non-volatile and volatile variable.
> -
> -  This function allocates and initializes memory space for global context of ESAL
> -  variable service and variable store area for non-volatile and volatile variable.
> -
> -  @param  ImageHandle           The Image handle of this driver.
> -  @param  SystemTable           The pointer of EFI_SYSTEM_TABLE.
> -
> -  @retval EFI_SUCCESS           Function successfully executed.
> -  @retval EFI_OUT_OF_RESOURCES  Fail to allocate enough memory resource.
> -
> -**/
> -EFI_STATUS
> -EFIAPI
> -VariableCommonInitialize (
> -  IN EFI_HANDLE         ImageHandle,
> -  IN EFI_SYSTEM_TABLE   *SystemTable
> -  );
> -
> -/**
> -  Entry point of EmuVariable service module.
> -
> -  This function is the entry point of EmuVariable service module.
> -  It registers all interfaces of Variable Services, initializes
> -  variable store for non-volatile and volatile variables, and registers
> -  notification function for EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
> -
> -  @param  ImageHandle   The Image handle of this driver.
> -  @param  SystemTable   The pointer of EFI_SYSTEM_TABLE.
> -
> -  @retval EFI_SUCCESS   Variable service successfully initialized.
> -
> -**/
> -EFI_STATUS
> -EFIAPI
> -VariableServiceInitialize (
> -  IN EFI_HANDLE         ImageHandle,
> -  IN EFI_SYSTEM_TABLE   *SystemTable
> -  );
> -
> -/**
> -  Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.
> -
> -  This is a notification function registered on
> EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
> -  It convers pointer to new virtual address.
> -
> -  @param  Event        Event whose notification function is being invoked.
> -  @param  Context      Pointer to the notification function's context.
> -
> -**/
> -VOID
> -EFIAPI
> -VariableClassAddressChangeEvent (
> -  IN EFI_EVENT        Event,
> -  IN VOID             *Context
> -  );
> -
> -/**
> -  This code finds variable in storage blocks (Volatile or Non-Volatile).
> -
> -  @param  VariableName           A Null-terminated Unicode string that is the
> name of
> -                                 the vendor's variable.
> -  @param  VendorGuid             A unique identifier for the vendor.
> -  @param  Attributes             If not NULL, a pointer to the memory location to
> return the
> -                                 attributes bitmask for the variable.
> -  @param  DataSize               Size of Data found. If size is less than the
> -                                 data, this value contains the required size.
> -  @param  Data                   On input, the size in bytes of the return Data buffer.
> -                                 On output, the size of data returned in Data.
> -  @param  Global                 Pointer to VARIABLE_GLOBAL structure
> -
> -  @retval EFI_SUCCESS            The function completed successfully.
> -  @retval EFI_NOT_FOUND          The variable was not found.
> -  @retval EFI_BUFFER_TOO_SMALL   DataSize is too small for the result.
> DataSize has
> -                                 been updated with the size needed to complete the request.
> -  @retval EFI_INVALID_PARAMETER  VariableName or VendorGuid or DataSize
> is NULL.
> -
> -**/
> -EFI_STATUS
> -EFIAPI
> -EmuGetVariable (
> -  IN      CHAR16            *VariableName,
> -  IN      EFI_GUID          *VendorGuid,
> -  OUT     UINT32            *Attributes OPTIONAL,
> -  IN OUT  UINTN             *DataSize,
> -  OUT     VOID              *Data,
> -  IN      VARIABLE_GLOBAL   *Global
> -  );
> -
> -/**
> -
> -  This code finds the next available variable.
> -
> -  @param  VariableNameSize       The size of the VariableName buffer. The size
> must be large enough to fit input
> -                                 string supplied in VariableName buffer.
> -  @param  VariableName           On input, supplies the last VariableName that
> was returned by GetNextVariableName().
> -                                 On output, returns the Null-terminated Unicode string of the
> current variable.
> -  @param  VendorGuid             On input, supplies the last VendorGuid that was
> returned by GetNextVariableName().
> -                                 On output, returns the VendorGuid of the current variable.
> -  @param  Global                 Pointer to VARIABLE_GLOBAL structure.
> -
> -  @retval EFI_SUCCESS            The function completed successfully.
> -  @retval EFI_NOT_FOUND          The next variable was not found.
> -  @retval EFI_BUFFER_TOO_SMALL   The VariableNameSize is too small for the
> result.
> -                                 VariableNameSize has been updated with the size needed to
> complete the request.
> -  @retval EFI_INVALID_PARAMETER  VariableNameSize or VariableName or
> VendorGuid is NULL.
> -  @retval EFI_INVALID_PARAMETER  The input values of VariableName and
> VendorGuid are not a name and
> -                                 GUID of an existing variable.
> -  @retval EFI_INVALID_PARAMETER  Null-terminator is not found in the first
> VariableNameSize bytes of
> -                                 the input VariableName buffer.
> -
> -**/
> -EFI_STATUS
> -EFIAPI
> -EmuGetNextVariableName (
> -  IN OUT  UINTN             *VariableNameSize,
> -  IN OUT  CHAR16            *VariableName,
> -  IN OUT  EFI_GUID          *VendorGuid,
> -  IN      VARIABLE_GLOBAL   *Global
> -  );
> -
> -/**
> -
> -  This code sets variable in storage blocks (Volatile or Non-Volatile).
> -
> -  @param  VariableName           A Null-terminated Unicode string that is the
> name of the vendor's
> -                                 variable.  Each VariableName is unique for each
> -                                 VendorGuid.  VariableName must contain 1 or more
> -                                 Unicode characters.  If VariableName is an empty Unicode
> -                                 string, then EFI_INVALID_PARAMETER is returned.
> -  @param  VendorGuid             A unique identifier for the vendor
> -  @param  Attributes             Attributes bitmask to set for the variable
> -  @param  DataSize               The size in bytes of the Data buffer.  A size of zero
> causes the
> -                                 variable to be deleted.
> -  @param  Data                   The contents for the variable
> -  @param  Global                 Pointer to VARIABLE_GLOBAL structure
> -  @param  VolatileOffset         The offset of last volatile variable
> -  @param  NonVolatileOffset      The offset of last non-volatile variable
> -
> -  @retval EFI_SUCCESS            The firmware has successfully stored the variable
> and its data as
> -                                 defined by the Attributes.
> -  @retval EFI_INVALID_PARAMETER  An invalid combination of attribute bits
> was supplied, or the
> -                                 DataSize exceeds the maximum allowed, or VariableName is
> an empty
> -                                 Unicode string, or VendorGuid is NULL.
> -  @retval EFI_OUT_OF_RESOURCES   Not enough storage is available to hold
> the variable and its data.
> -  @retval EFI_DEVICE_ERROR       The variable could not be saved due to a
> hardware failure.
> -  @retval EFI_WRITE_PROTECTED    The variable in question is read-only or
> cannot be deleted.
> -  @retval EFI_NOT_FOUND          The variable trying to be updated or deleted
> was not found.
> -
> -**/
> -EFI_STATUS
> -EFIAPI
> -EmuSetVariable (
> -  IN CHAR16                  *VariableName,
> -  IN EFI_GUID                *VendorGuid,
> -  IN UINT32                  Attributes,
> -  IN UINTN                   DataSize,
> -  IN VOID                    *Data,
> -  IN VARIABLE_GLOBAL         *Global,
> -  IN UINTN                   *VolatileOffset,
> -  IN UINTN                   *NonVolatileOffset
> -  );
> -
> -/**
> -
> -  This code returns information about the EFI variables.
> -
> -  @param  Attributes                   Attributes bitmask to specify the type of
> variables
> -                                       on which to return information.
> -  @param  MaximumVariableStorageSize   On output the maximum size of the
> storage space available for
> -                                       the EFI variables associated with the attributes specified.
> -  @param  RemainingVariableStorageSize Returns the remaining size of the
> storage space available for EFI
> -                                       variables associated with the attributes specified.
> -  @param  MaximumVariableSize          Returns the maximum size of an
> individual EFI variable
> -                                       associated with the attributes specified.
> -  @param  Global                       Pointer to VARIABLE_GLOBAL structure.
> -
> -  @retval EFI_SUCCESS                  Valid answer returned.
> -  @retval EFI_INVALID_PARAMETER        An invalid combination of attribute bits
> was supplied
> -  @retval EFI_UNSUPPORTED              The attribute is not supported on this
> platform, and the
> -                                       MaximumVariableStorageSize,
> RemainingVariableStorageSize,
> -                                       MaximumVariableSize are undefined.
> -
> -**/
> -EFI_STATUS
> -EFIAPI
> -EmuQueryVariableInfo (
> -  IN  UINT32                 Attributes,
> -  OUT UINT64                 *MaximumVariableStorageSize,
> -  OUT UINT64                 *RemainingVariableStorageSize,
> -  OUT UINT64                 *MaximumVariableSize,
> -  IN  VARIABLE_GLOBAL        *Global
> -  );
> -
> -#endif
> --
> 2.7.0.windows.1