[mirror_edk2.git] / MdeModulePkg / Universal / Variable / RuntimeDxe / Variable.c

/** @file\r
\r
  Implement all four UEFI Runtime Variable services for the nonvolatile\r
  and volatile storage space and install variable architecture protocol.\r
  \r
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
**/\r
\r
#include "Variable.h"\r
\r
VARIABLE_MODULE_GLOBAL  *mVariableModuleGlobal;\r
EFI_EVENT   mVirtualAddressChangeEvent = NULL;\r
EFI_HANDLE  mHandle = NULL;\r
\r
///\r
/// The current Hii implementation accesses this variable many times on every boot.\r
/// Other common variables are only accessed once. This is why this cache algorithm\r
/// only targets a single variable. Probably to get an performance improvement out of\r
/// a Cache you would need a cache that improves the search performance for a variable.\r
///\r
VARIABLE_CACHE_ENTRY mVariableCache[] = {\r
  {\r
    &gEfiGlobalVariableGuid,\r
    L"Lang",\r
    0x00000000,\r
    0x00,\r
    NULL\r
  },\r
  {\r
    &gEfiGlobalVariableGuid,\r
    L"PlatformLang",\r
    0x00000000,\r
    0x00,\r
    NULL\r
  }\r
};\r
\r
VARIABLE_INFO_ENTRY *gVariableInfo      = NULL;\r
EFI_EVENT           mFvbRegistration    = NULL;\r
\r
/**\r
  Update the variable region with Variable information. These are the same \r
  arguments as the EFI Variable services.\r
\r
  @param[in] VariableName       Name of variable\r
\r
  @param[in] VendorGuid         Guid of variable\r
\r
  @param[in] Data               Variable data\r
\r
  @param[in] DataSize           Size of data. 0 means delete\r
\r
  @param[in] Attributes 	      Attribues of the variable\r
\r
  @param[in] Variable           The variable information which is used to keep track of variable usage.\r
\r
  @retval EFI_SUCCESS           The update operation is success.\r
\r
  @retval EFI_OUT_OF_RESOURCES  Variable region is full, can not write other data into this region.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UpdateVariable (\r
  IN      CHAR16                 *VariableName,\r
  IN      EFI_GUID               *VendorGuid,\r
  IN      VOID                   *Data,\r
  IN      UINTN                  DataSize,\r
  IN      UINT32                 Attributes OPTIONAL,\r
  IN      VARIABLE_POINTER_TRACK *Variable\r
  );\r
\r
/**\r
  Acquires lock only at boot time. Simply returns at runtime.\r
\r
  This is a temperary function which will be removed when\r
  EfiAcquireLock() in UefiLib can handle the call in UEFI\r
  Runtimer driver in RT phase.\r
  It calls EfiAcquireLock() at boot time, and simply returns\r
  at runtime.\r
\r
  @param  Lock         A pointer to the lock to acquire\r
\r
**/\r
VOID\r
AcquireLockOnlyAtBootTime (\r
  IN EFI_LOCK  *Lock\r
  )\r
{\r
  if (!EfiAtRuntime ()) {\r
    EfiAcquireLock (Lock);\r
  }\r
}\r
\r
/**\r
  Releases lock only at boot time. Simply returns at runtime.\r
\r
  This is a temperary function which will be removed when\r
  EfiReleaseLock() in UefiLib can handle the call in UEFI\r
  Runtimer driver in RT phase.\r
  It calls EfiReleaseLock() at boot time, and simply returns\r
  at runtime.\r
\r
  @param  Lock         A pointer to the lock to release\r
\r
**/\r
VOID\r
ReleaseLockOnlyAtBootTime (\r
  IN EFI_LOCK  *Lock\r
  )\r
{\r
  if (!EfiAtRuntime ()) {\r
    EfiReleaseLock (Lock);\r
  }\r
}\r
\r
\r
/**\r
  Routine used to track statistical information about variable usage. \r
  The data is stored in the EFI system table so it can be accessed later.\r
  VariableInfo.efi can dump out the table. Only Boot Services variable \r
  accesses are tracked by this code. The PcdVariableCollectStatistics\r
  build flag controls if this feature is enabled. \r
\r
  A read that hits in the cache will have Read and Cache true for \r
  the transaction. Data is allocated by this routine, but never\r
  freed.\r
\r
  @param[in] VariableName   Name of the Variable to track\r
  @param[in] VendorGuid     Guid of the Variable to track\r
  @param[in] Volatile       TRUE if volatile FALSE if non-volatile\r
  @param[in] Read           TRUE if GetVariable() was called\r
  @param[in] Write          TRUE if SetVariable() was called\r
  @param[in] Delete         TRUE if deleted via SetVariable()\r
  @param[in] Cache          TRUE for a cache hit.\r
\r
**/\r
VOID\r
UpdateVariableInfo (\r
  IN  CHAR16                  *VariableName,\r
  IN  EFI_GUID                *VendorGuid,\r
  IN  BOOLEAN                 Volatile,\r
  IN  BOOLEAN                 Read,\r
  IN  BOOLEAN                 Write,\r
  IN  BOOLEAN                 Delete,\r
  IN  BOOLEAN                 Cache\r
  )\r
{\r
  VARIABLE_INFO_ENTRY   *Entry;\r
\r
  if (FeaturePcdGet (PcdVariableCollectStatistics)) {\r
\r
    if (EfiAtRuntime ()) {\r
      // Don't collect statistics at runtime\r
      return;\r
    }\r
\r
    if (gVariableInfo == NULL) {\r
      //\r
      // on the first call allocate a entry and place a pointer to it in\r
      // the EFI System Table\r
      //\r
      gVariableInfo = AllocateZeroPool (sizeof (VARIABLE_INFO_ENTRY));\r
      ASSERT (gVariableInfo != NULL);\r
\r
      CopyGuid (&gVariableInfo->VendorGuid, VendorGuid);\r
      gVariableInfo->Name = AllocatePool (StrSize (VariableName));\r
      ASSERT (gVariableInfo->Name != NULL);\r
      StrCpy (gVariableInfo->Name, VariableName);\r
      gVariableInfo->Volatile = Volatile;\r
\r
      gBS->InstallConfigurationTable (&gEfiVariableGuid, gVariableInfo);\r
    }\r
\r
    \r
    for (Entry = gVariableInfo; Entry != NULL; Entry = Entry->Next) {\r
      if (CompareGuid (VendorGuid, &Entry->VendorGuid)) {\r
        if (StrCmp (VariableName, Entry->Name) == 0) {\r
          if (Read) {\r
            Entry->ReadCount++;\r
          }\r
          if (Write) {\r
            Entry->WriteCount++;\r
          }\r
          if (Delete) {\r
            Entry->DeleteCount++;\r
          }\r
          if (Cache) {\r
            Entry->CacheCount++;\r
          }\r
\r
          return;\r
        }\r
      }\r
\r
      if (Entry->Next == NULL) {\r
        //\r
        // If the entry is not in the table add it.\r
        // Next iteration of the loop will fill in the data\r
        //\r
        Entry->Next = AllocateZeroPool (sizeof (VARIABLE_INFO_ENTRY));\r
        ASSERT (Entry->Next != NULL);\r
\r
        CopyGuid (&Entry->Next->VendorGuid, VendorGuid);\r
        Entry->Next->Name = AllocatePool (StrSize (VariableName));\r
        ASSERT (Entry->Next->Name != NULL);\r
        StrCpy (Entry->Next->Name, VariableName);\r
        Entry->Next->Volatile = Volatile;\r
      }\r
\r
    }\r
  }\r
}\r
\r
\r
/**\r
\r
  This code checks if variable header is valid or not.\r
\r
  @param Variable        Pointer to the Variable Header.\r
\r
  @retval TRUE           Variable header is valid.\r
  @retval FALSE          Variable header is not valid.\r
\r
**/\r
BOOLEAN\r
IsValidVariableHeader (\r
  IN  VARIABLE_HEADER   *Variable\r
  )\r
{\r
  if (Variable == NULL || Variable->StartId != VARIABLE_DATA) {\r
    return FALSE;\r
  }\r
\r
  return TRUE;\r
}\r
\r
\r
/**\r
\r
  This function writes data to the FWH at the correct LBA even if the LBAs\r
  are fragmented.\r
\r
  @param Global                  Pointer to VARAIBLE_GLOBAL structure\r
  @param Volatile                Point out the Variable is Volatile or Non-Volatile\r
  @param SetByIndex              TRUE if target pointer is given as index\r
                                 FALSE if target pointer is absolute\r
  @param Fvb                     Pointer to the writable FVB protocol\r
  @param DataPtrIndex            Pointer to the Data from the end of VARIABLE_STORE_HEADER\r
                                 structure\r
  @param DataSize                Size of data to be written\r
  @param Buffer                  Pointer to the buffer from which data is written\r
\r
  @retval EFI_INVALID_PARAMETER  Parameters not valid\r
  @retval EFI_SUCCESS            Variable store successfully updated\r
\r
**/\r
EFI_STATUS\r
UpdateVariableStore (\r
  IN  VARIABLE_GLOBAL                     *Global,\r
  IN  BOOLEAN                             Volatile,\r
  IN  BOOLEAN                             SetByIndex,\r
  IN  EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  *Fvb,\r
  IN  UINTN                               DataPtrIndex,\r
  IN  UINT32                              DataSize,\r
  IN  UINT8                               *Buffer\r
  )\r
{\r
  EFI_FV_BLOCK_MAP_ENTRY      *PtrBlockMapEntry;\r
  UINTN                       BlockIndex2;\r
  UINTN                       LinearOffset;\r
  UINTN                       CurrWriteSize;\r
  UINTN                       CurrWritePtr;\r
  UINT8                       *CurrBuffer;\r
  EFI_LBA                     LbaNumber;\r
  UINTN                       Size;\r
  EFI_FIRMWARE_VOLUME_HEADER  *FwVolHeader;\r
  VARIABLE_STORE_HEADER       *VolatileBase;\r
  EFI_PHYSICAL_ADDRESS        FvVolHdr;\r
  EFI_PHYSICAL_ADDRESS        DataPtr;\r
  EFI_STATUS                  Status;\r
\r
  FwVolHeader = NULL;\r
  DataPtr     = DataPtrIndex;\r
\r
  //\r
  // Check if the Data is Volatile\r
  //\r
  if (!Volatile) {\r
    Status = Fvb->GetPhysicalAddress(Fvb, &FvVolHdr);\r
    ASSERT_EFI_ERROR (Status);\r
\r
    FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *) ((UINTN) FvVolHdr);\r
    //\r
    // Data Pointer should point to the actual Address where data is to be\r
    // written\r
    //\r
    if (SetByIndex) {\r
      DataPtr += mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase;\r
    }\r
\r
    if ((DataPtr + DataSize) >= ((EFI_PHYSICAL_ADDRESS) (UINTN) ((UINT8 *) FwVolHeader + FwVolHeader->FvLength))) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
  } else {\r
    //\r
    // Data Pointer should point to the actual Address where data is to be\r
    // written\r
    //\r
    VolatileBase = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.VolatileVariableBase);\r
    if (SetByIndex) {\r
      DataPtr += mVariableModuleGlobal->VariableGlobal.VolatileVariableBase;\r
    }\r
\r
    if ((DataPtr + DataSize) >= ((UINTN) ((UINT8 *) VolatileBase + VolatileBase->Size))) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
    \r
    //\r
    // If Volatile Variable just do a simple mem copy.\r
    //    \r
    CopyMem ((UINT8 *)(UINTN)DataPtr, Buffer, DataSize);\r
    return EFI_SUCCESS;\r
  }\r
  \r
  //\r
  // If we are here we are dealing with Non-Volatile Variables\r
  //\r
  LinearOffset  = (UINTN) FwVolHeader;\r
  CurrWritePtr  = (UINTN) DataPtr;\r
  CurrWriteSize = DataSize;\r
  CurrBuffer    = Buffer;\r
  LbaNumber     = 0;\r
\r
  if (CurrWritePtr < LinearOffset) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  for (PtrBlockMapEntry = FwVolHeader->BlockMap; PtrBlockMapEntry->NumBlocks != 0; PtrBlockMapEntry++) {\r
    for (BlockIndex2 = 0; BlockIndex2 < PtrBlockMapEntry->NumBlocks; BlockIndex2++) {\r
      //\r
      // Check to see if the Variable Writes are spanning through multiple\r
      // blocks.\r
      //\r
      if ((CurrWritePtr >= LinearOffset) && (CurrWritePtr < LinearOffset + PtrBlockMapEntry->Length)) {\r
        if ((CurrWritePtr + CurrWriteSize) <= (LinearOffset + PtrBlockMapEntry->Length)) {\r
          Status = Fvb->Write (\r
                    Fvb,\r
                    LbaNumber,\r
                    (UINTN) (CurrWritePtr - LinearOffset),\r
                    &CurrWriteSize,\r
                    CurrBuffer\r
                    );\r
          return Status;\r
        } else {\r
          Size = (UINT32) (LinearOffset + PtrBlockMapEntry->Length - CurrWritePtr);\r
          Status = Fvb->Write (\r
                    Fvb,\r
                    LbaNumber,\r
                    (UINTN) (CurrWritePtr - LinearOffset),\r
                    &Size,\r
                    CurrBuffer\r
                    );\r
          if (EFI_ERROR (Status)) {\r
            return Status;\r
          }\r
\r
          CurrWritePtr  = LinearOffset + PtrBlockMapEntry->Length;\r
          CurrBuffer    = CurrBuffer + Size;\r
          CurrWriteSize = CurrWriteSize - Size;\r
        }\r
      }\r
\r
      LinearOffset += PtrBlockMapEntry->Length;\r
      LbaNumber++;\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
\r
  This code gets the current status of Variable Store.\r
\r
  @param VarStoreHeader  Pointer to the Variable Store Header.\r
\r
  @retval EfiRaw         Variable store status is raw\r
  @retval EfiValid       Variable store status is valid\r
  @retval EfiInvalid     Variable store status is invalid\r
\r
**/\r
VARIABLE_STORE_STATUS\r
GetVariableStoreStatus (\r
  IN VARIABLE_STORE_HEADER *VarStoreHeader\r
  )\r
{\r
  if (CompareGuid (&VarStoreHeader->Signature, &gEfiVariableGuid) &&\r
      VarStoreHeader->Format == VARIABLE_STORE_FORMATTED &&\r
      VarStoreHeader->State == VARIABLE_STORE_HEALTHY\r
      ) {\r
\r
    return EfiValid;\r
  } else if (((UINT32 *)(&VarStoreHeader->Signature))[0] == 0xffffffff &&\r
             ((UINT32 *)(&VarStoreHeader->Signature))[1] == 0xffffffff &&\r
             ((UINT32 *)(&VarStoreHeader->Signature))[2] == 0xffffffff &&\r
             ((UINT32 *)(&VarStoreHeader->Signature))[3] == 0xffffffff &&\r
             VarStoreHeader->Size == 0xffffffff &&\r
             VarStoreHeader->Format == 0xff &&\r
             VarStoreHeader->State == 0xff\r
          ) {\r
\r
    return EfiRaw;\r
  } else {\r
    return EfiInvalid;\r
  }\r
}\r
\r
\r
/**\r
\r
  This code gets the size of name of variable.\r
\r
  @param Variable        Pointer to the Variable Header\r
\r
  @return UINTN          Size of variable in bytes\r
\r
**/\r
UINTN\r
NameSizeOfVariable (\r
  IN  VARIABLE_HEADER   *Variable\r
  )\r
{\r
  if (Variable->State    == (UINT8) (-1) ||\r
      Variable->DataSize == (UINT32) (-1) ||\r
      Variable->NameSize == (UINT32) (-1) ||\r
      Variable->Attributes == (UINT32) (-1)) {\r
    return 0;\r
  }\r
  return (UINTN) Variable->NameSize;\r
}\r
\r
/**\r
\r
  This code gets the size of variable data.\r
\r
  @param Variable        Pointer to the Variable Header\r
\r
  @return Size of variable in bytes\r
\r
**/\r
UINTN\r
DataSizeOfVariable (\r
  IN  VARIABLE_HEADER   *Variable\r
  )\r
{\r
  if (Variable->State    == (UINT8)  (-1) ||\r
      Variable->DataSize == (UINT32) (-1) ||\r
      Variable->NameSize == (UINT32) (-1) ||\r
      Variable->Attributes == (UINT32) (-1)) {\r
    return 0;\r
  }\r
  return (UINTN) Variable->DataSize;\r
}\r
\r
/**\r
\r
  This code gets the pointer to the variable name.\r
\r
  @param Variable        Pointer to the Variable Header\r
\r
  @return Pointer to Variable Name which is Unicode encoding\r
\r
**/\r
CHAR16 *\r
GetVariableNamePtr (\r
  IN  VARIABLE_HEADER   *Variable\r
  )\r
{\r
\r
  return (CHAR16 *) (Variable + 1);\r
}\r
\r
/**\r
\r
  This code gets the pointer to the variable data.\r
\r
  @param Variable        Pointer to the Variable Header\r
\r
  @return Pointer to Variable Data\r
\r
**/\r
UINT8 *\r
GetVariableDataPtr (\r
  IN  VARIABLE_HEADER   *Variable\r
  )\r
{\r
  UINTN Value;\r
  \r
  //\r
  // Be careful about pad size for alignment\r
  //\r
  Value =  (UINTN) GetVariableNamePtr (Variable);\r
  Value += NameSizeOfVariable (Variable);\r
  Value += GET_PAD_SIZE (NameSizeOfVariable (Variable));\r
\r
  return (UINT8 *) Value;\r
}\r
\r
\r
/**\r
\r
  This code gets the pointer to the next variable header.\r
\r
  @param Variable        Pointer to the Variable Header\r
\r
  @return Pointer to next variable header\r
\r
**/\r
VARIABLE_HEADER *\r
GetNextVariablePtr (\r
  IN  VARIABLE_HEADER   *Variable\r
  )\r
{\r
  UINTN Value;\r
\r
  if (!IsValidVariableHeader (Variable)) {\r
    return NULL;\r
  }\r
\r
  Value =  (UINTN) GetVariableDataPtr (Variable);\r
  Value += DataSizeOfVariable (Variable);\r
  Value += GET_PAD_SIZE (DataSizeOfVariable (Variable));\r
\r
  //\r
  // Be careful about pad size for alignment\r
  //\r
  return (VARIABLE_HEADER *) HEADER_ALIGN (Value);\r
}\r
\r
/**\r
\r
  Gets the pointer to the first variable header in given variable store area.\r
\r
  @param VarStoreHeader  Pointer to the Variable Store Header.\r
\r
  @return Pointer to the first variable header\r
\r
**/\r
VARIABLE_HEADER *\r
GetStartPointer (\r
  IN VARIABLE_STORE_HEADER       *VarStoreHeader\r
  )\r
{\r
  //\r
  // The end of variable store\r
  //\r
  return (VARIABLE_HEADER *) HEADER_ALIGN (VarStoreHeader + 1);\r
}\r
\r
/**\r
\r
  Gets the pointer to the end of the variable storage area.\r
\r
  This function gets pointer to the end of the variable storage\r
  area, according to the input variable store header.\r
\r
  @param VarStoreHeader  Pointer to the Variable Store Header\r
\r
  @return Pointer to the end of the variable storage area  \r
\r
**/\r
VARIABLE_HEADER *\r
GetEndPointer (\r
  IN VARIABLE_STORE_HEADER       *VarStoreHeader\r
  )\r
{\r
  //\r
  // The end of variable store\r
  //\r
  return (VARIABLE_HEADER *) HEADER_ALIGN ((UINTN) VarStoreHeader + VarStoreHeader->Size);\r
}\r
\r
\r
/**\r
\r
  Variable store garbage collection and reclaim operation.\r
\r
  @param VariableBase            Base address of variable store\r
  @param LastVariableOffset      Offset of last variable\r
  @param IsVolatile              The variable store is volatile or not,\r
                                 if it is non-volatile, need FTW\r
  @param UpdatingVariable        Pointer to updateing variable.\r
\r
  @return EFI_OUT_OF_RESOURCES\r
  @return EFI_SUCCESS\r
  @return Others\r
\r
**/\r
EFI_STATUS\r
Reclaim (\r
  IN  EFI_PHYSICAL_ADDRESS  VariableBase,\r
  OUT UINTN                 *LastVariableOffset,\r
  IN  BOOLEAN               IsVolatile,\r
  IN  VARIABLE_HEADER       *UpdatingVariable\r
  )\r
{\r
  VARIABLE_HEADER       *Variable;\r
  VARIABLE_HEADER       *AddedVariable;\r
  VARIABLE_HEADER       *NextVariable;\r
  VARIABLE_HEADER       *NextAddedVariable;\r
  VARIABLE_STORE_HEADER *VariableStoreHeader;\r
  UINT8                 *ValidBuffer;\r
  UINTN                 MaximumBufferSize;\r
  UINTN                 VariableSize;\r
  UINTN                 VariableNameSize;\r
  UINTN                 UpdatingVariableNameSize;\r
  UINTN                 NameSize;\r
  UINT8                 *CurrPtr;\r
  VOID                  *Point0;\r
  VOID                  *Point1;\r
  BOOLEAN               FoundAdded;\r
  EFI_STATUS            Status;\r
  CHAR16                *VariableNamePtr;\r
  CHAR16                *UpdatingVariableNamePtr;\r
\r
  VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINTN) VariableBase);\r
  //\r
  // recaluate the total size of Common/HwErr type variables in non-volatile area.\r
  //\r
  if (!IsVolatile) {\r
    mVariableModuleGlobal->CommonVariableTotalSize = 0;\r
    mVariableModuleGlobal->HwErrVariableTotalSize  = 0;\r
  }\r
\r
  //\r
  // Start Pointers for the variable.\r
  //\r
  Variable          = GetStartPointer (VariableStoreHeader);\r
  MaximumBufferSize = sizeof (VARIABLE_STORE_HEADER);\r
\r
  while (IsValidVariableHeader (Variable)) {\r
    NextVariable = GetNextVariablePtr (Variable);\r
    if (Variable->State == VAR_ADDED || \r
        Variable->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)\r
       ) {\r
      VariableSize = (UINTN) NextVariable - (UINTN) Variable;\r
      MaximumBufferSize += VariableSize;\r
    }\r
\r
    Variable = NextVariable;\r
  }\r
\r
  //\r
  // Reserve the 1 Bytes with Oxff to identify the \r
  // end of the variable buffer. \r
  // \r
  MaximumBufferSize += 1;\r
  ValidBuffer = AllocatePool (MaximumBufferSize);\r
  if (ValidBuffer == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  SetMem (ValidBuffer, MaximumBufferSize, 0xff);\r
\r
  //\r
  // Copy variable store header\r
  //\r
  CopyMem (ValidBuffer, VariableStoreHeader, sizeof (VARIABLE_STORE_HEADER));\r
  CurrPtr = (UINT8 *) GetStartPointer ((VARIABLE_STORE_HEADER *) ValidBuffer);\r
\r
  //\r
  // Reinstall all ADDED variables as long as they are not identical to Updating Variable\r
  // \r
  Variable = GetStartPointer (VariableStoreHeader);\r
  while (IsValidVariableHeader (Variable)) {\r
    NextVariable = GetNextVariablePtr (Variable);\r
    if (Variable->State == VAR_ADDED) {\r
      if (UpdatingVariable != NULL) {\r
        if (UpdatingVariable == Variable) {\r
          Variable = NextVariable;\r
          continue;\r
        }\r
\r
        VariableNameSize         = NameSizeOfVariable(Variable);\r
        UpdatingVariableNameSize = NameSizeOfVariable(UpdatingVariable);\r
\r
        VariableNamePtr         = GetVariableNamePtr (Variable);\r
        UpdatingVariableNamePtr = GetVariableNamePtr (UpdatingVariable);\r
        if (CompareGuid (&Variable->VendorGuid, &UpdatingVariable->VendorGuid)    &&\r
            VariableNameSize == UpdatingVariableNameSize &&\r
            CompareMem (VariableNamePtr, UpdatingVariableNamePtr, VariableNameSize) == 0 ) {\r
          Variable = NextVariable;\r
          continue;\r
        }\r
      }\r
      VariableSize = (UINTN) NextVariable - (UINTN) Variable;\r
      CopyMem (CurrPtr, (UINT8 *) Variable, VariableSize);\r
      CurrPtr += VariableSize;\r
      if ((!IsVolatile) && ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {\r
        mVariableModuleGlobal->HwErrVariableTotalSize += VariableSize;\r
      } else if ((!IsVolatile) && ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {\r
        mVariableModuleGlobal->CommonVariableTotalSize += VariableSize;\r
      }\r
    }\r
    Variable = NextVariable;\r
  }\r
\r
  //\r
  // Reinstall the variable being updated if it is not NULL\r
  //\r
  if (UpdatingVariable != NULL) {\r
    VariableSize = (UINTN)(GetNextVariablePtr (UpdatingVariable)) - (UINTN)UpdatingVariable;\r
    CopyMem (CurrPtr, (UINT8 *) UpdatingVariable, VariableSize);\r
    CurrPtr += VariableSize;\r
    if ((!IsVolatile) && ((UpdatingVariable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {\r
        mVariableModuleGlobal->HwErrVariableTotalSize += VariableSize;\r
    } else if ((!IsVolatile) && ((UpdatingVariable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {\r
        mVariableModuleGlobal->CommonVariableTotalSize += VariableSize;\r
    }\r
  }\r
\r
  //\r
  // Reinstall all in delete transition variables\r
  // \r
  Variable      = GetStartPointer (VariableStoreHeader);\r
  while (IsValidVariableHeader (Variable)) {\r
    NextVariable = GetNextVariablePtr (Variable);\r
    if (Variable != UpdatingVariable && Variable->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r
\r
      //\r
      // Buffer has cached all ADDED variable. \r
      // Per IN_DELETED variable, we have to guarantee that\r
      // no ADDED one in previous buffer. \r
      // \r
     \r
      FoundAdded = FALSE;\r
      AddedVariable = GetStartPointer ((VARIABLE_STORE_HEADER *) ValidBuffer);\r
      while (IsValidVariableHeader (AddedVariable)) {\r
        NextAddedVariable = GetNextVariablePtr (AddedVariable);\r
        NameSize = NameSizeOfVariable (AddedVariable);\r
        if (CompareGuid (&AddedVariable->VendorGuid, &Variable->VendorGuid) &&\r
            NameSize == NameSizeOfVariable (Variable)\r
           ) {\r
          Point0 = (VOID *) GetVariableNamePtr (AddedVariable);\r
          Point1 = (VOID *) GetVariableNamePtr (Variable);\r
          if (CompareMem (Point0, Point1, NameSizeOfVariable (AddedVariable)) == 0) {\r
            FoundAdded = TRUE;\r
            break;\r
          }\r
        }\r
        AddedVariable = NextAddedVariable;\r
      }\r
      if (!FoundAdded) {\r
        //\r
        // Promote VAR_IN_DELETED_TRANSITION to VAR_ADDED\r
        //\r
        VariableSize = (UINTN) NextVariable - (UINTN) Variable;\r
        CopyMem (CurrPtr, (UINT8 *) Variable, VariableSize);\r
        ((VARIABLE_HEADER *) CurrPtr)->State = VAR_ADDED;\r
        CurrPtr += VariableSize;\r
        if ((!IsVolatile) && ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {\r
          mVariableModuleGlobal->HwErrVariableTotalSize += VariableSize;\r
        } else if ((!IsVolatile) && ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {\r
          mVariableModuleGlobal->CommonVariableTotalSize += VariableSize;\r
        }\r
      }\r
    }\r
\r
    Variable = NextVariable;\r
  }\r
\r
  if (IsVolatile) {\r
    //\r
    // If volatile variable store, just copy valid buffer\r
    //\r
    SetMem ((UINT8 *) (UINTN) VariableBase, VariableStoreHeader->Size, 0xff);\r
    CopyMem ((UINT8 *) (UINTN) VariableBase, ValidBuffer, (UINTN) (CurrPtr - (UINT8 *) ValidBuffer));\r
    Status              = EFI_SUCCESS;\r
  } else {\r
    //\r
    // If non-volatile variable store, perform FTW here.\r
    //\r
    Status = FtwVariableSpace (\r
              VariableBase,\r
              ValidBuffer,\r
              (UINTN) (CurrPtr - (UINT8 *) ValidBuffer)\r
              );\r
  }\r
  if (!EFI_ERROR (Status)) {\r
    *LastVariableOffset = (UINTN) (CurrPtr - (UINT8 *) ValidBuffer);\r
  } else {\r
    *LastVariableOffset = 0;\r
  }\r
\r
  FreePool (ValidBuffer);\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Update the Cache with Variable information. These are the same \r
  arguments as the EFI Variable services.\r
\r
  @param[in] VariableName  Name of variable\r
  @param[in] VendorGuid    Guid of variable\r
  @param[in] Attributes    Attribues of the variable\r
  @param[in] DataSize      Size of data. 0 means delete\r
  @param[in] Data          Variable data\r
\r
**/\r
VOID\r
UpdateVariableCache (\r
  IN      CHAR16            *VariableName,\r
  IN      EFI_GUID          *VendorGuid,\r
  IN      UINT32            Attributes,\r
  IN      UINTN             DataSize,\r
  IN      VOID              *Data\r
  )\r
{\r
  VARIABLE_CACHE_ENTRY      *Entry;\r
  UINTN                     Index;\r
\r
  if (EfiAtRuntime ()) {\r
    //\r
    // Don't use the cache at runtime\r
    // \r
    return;\r
  }\r
\r
  for (Index = 0, Entry = mVariableCache; Index < sizeof (mVariableCache)/sizeof (VARIABLE_CACHE_ENTRY); Index++, Entry++) {\r
    if (CompareGuid (VendorGuid, Entry->Guid)) {\r
      if (StrCmp (VariableName, Entry->Name) == 0) { \r
        Entry->Attributes = Attributes;\r
        if (DataSize == 0) {\r
          //\r
          // Delete Case\r
          //\r
          if (Entry->DataSize != 0) {\r
            FreePool (Entry->Data);\r
          }\r
          Entry->DataSize = DataSize;\r
        } else if (DataSize == Entry->DataSize) {\r
          CopyMem (Entry->Data, Data, DataSize);\r
        } else {\r
          Entry->Data = AllocatePool (DataSize);\r
          ASSERT (Entry->Data != NULL);\r
\r
          Entry->DataSize = DataSize;\r
          CopyMem (Entry->Data, Data, DataSize);\r
        }\r
      }\r
    }\r
  }\r
}\r
\r
\r
/**\r
  Search the cache to check if the variable is in it.\r
\r
  This function searches the variable cache. If the variable to find exists, return its data\r
  and attributes.\r
\r
  @param  VariableName          A Null-terminated Unicode string that is the name of the vendor's\r
                                variable.  Each VariableName is unique for each \r
                                VendorGuid.\r
  @param  VendorGuid            A unique identifier for the vendor\r
  @param  Attributes            Pointer to the attributes bitmask of the variable for output.\r
  @param  DataSize              On input, size of the buffer of Data.\r
                                On output, size of the variable's data.\r
  @param  Data                  Pointer to the data buffer for output.\r
\r
  @retval EFI_SUCCESS           VariableGuid & VariableName data was returned.\r
  @retval EFI_NOT_FOUND         No matching variable found in cache.\r
  @retval EFI_BUFFER_TOO_SMALL  *DataSize is smaller than size of the variable's data to return.\r
\r
**/\r
EFI_STATUS\r
FindVariableInCache (\r
  IN      CHAR16            *VariableName,\r
  IN      EFI_GUID          *VendorGuid,\r
  OUT     UINT32            *Attributes OPTIONAL,\r
  IN OUT  UINTN             *DataSize,\r
  OUT     VOID              *Data\r
  )\r
{\r
  VARIABLE_CACHE_ENTRY      *Entry;\r
  UINTN                     Index;\r
\r
  if (EfiAtRuntime ()) {\r
    // Don't use the cache at runtime\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  for (Index = 0, Entry = mVariableCache; Index < sizeof (mVariableCache)/sizeof (VARIABLE_CACHE_ENTRY); Index++, Entry++) {\r
    if (CompareGuid (VendorGuid, Entry->Guid)) {\r
      if (StrCmp (VariableName, Entry->Name) == 0) {\r
        if (Entry->DataSize == 0) {\r
          // Variable was deleted so return not found\r
          return EFI_NOT_FOUND;\r
        } else if (Entry->DataSize > *DataSize) {\r
          // If the buffer is too small return correct size\r
          *DataSize = Entry->DataSize;\r
          return EFI_BUFFER_TOO_SMALL;\r
        } else {\r
          *DataSize = Entry->DataSize;\r
          // Return the data\r
          CopyMem (Data, Entry->Data, Entry->DataSize);\r
          if (Attributes != NULL) {\r
            *Attributes = Entry->Attributes;\r
          }\r
          return EFI_SUCCESS;\r
        }\r
      }\r
    }\r
  }\r
  \r
  return EFI_NOT_FOUND;\r
}\r
\r
/**\r
  Finds variable in storage blocks of volatile and non-volatile storage areas.\r
\r
  This code finds variable in storage blocks of volatile and non-volatile storage areas.\r
  If VariableName is an empty string, then we just return the first\r
  qualified variable without comparing VariableName and VendorGuid.\r
  Otherwise, VariableName and VendorGuid are compared.\r
\r
  @param  VariableName                Name of the variable to be found\r
  @param  VendorGuid                  Vendor GUID to be found.\r
  @param  PtrTrack                    VARIABLE_POINTER_TRACK structure for output,\r
                                      including the range searched and the target position.\r
  @param  Global                      Pointer to VARIABLE_GLOBAL structure, including\r
                                      base of volatile variable storage area, base of\r
                                      NV variable storage area, and a lock.\r
\r
  @retval EFI_INVALID_PARAMETER       If VariableName is not an empty string, while\r
                                      VendorGuid is NULL\r
  @retval EFI_SUCCESS                 Variable successfully found\r
  @retval EFI_NOT_FOUND               Variable not found\r
\r
**/\r
EFI_STATUS\r
FindVariable (\r
  IN  CHAR16                  *VariableName,\r
  IN  EFI_GUID                *VendorGuid,\r
  OUT VARIABLE_POINTER_TRACK  *PtrTrack,\r
  IN  VARIABLE_GLOBAL         *Global\r
  )\r
{\r
  VARIABLE_HEADER         *Variable[2];\r
  VARIABLE_HEADER         *InDeletedVariable;\r
  VARIABLE_STORE_HEADER   *VariableStoreHeader[2];\r
  UINTN                   InDeletedStorageIndex;\r
  UINTN                   Index;\r
  VOID                    *Point;\r
\r
  //\r
  // 0: Volatile, 1: Non-Volatile\r
  // The index and attributes mapping must be kept in this order as RuntimeServiceGetNextVariableName\r
  // make use of this mapping to implement search algorithme.\r
  //\r
  VariableStoreHeader[0]  = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.VolatileVariableBase);\r
  VariableStoreHeader[1]  = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase);\r
\r
  //\r
  // Start Pointers for the variable.\r
  // Actual Data Pointer where data can be written.\r
  //\r
  Variable[0] = GetStartPointer (VariableStoreHeader[0]);\r
  Variable[1] = GetStartPointer (VariableStoreHeader[1]);\r
\r
  if (VariableName[0] != 0 && VendorGuid == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Find the variable by walk through volatile and then non-volatile variable store\r
  //\r
  InDeletedVariable     = NULL;\r
  InDeletedStorageIndex = 0;\r
  for (Index = 0; Index < 2; Index++) {\r
    while ((Variable[Index] < GetEndPointer (VariableStoreHeader[Index])) && IsValidVariableHeader (Variable[Index])) {\r
      if (Variable[Index]->State == VAR_ADDED || \r
          Variable[Index]->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)\r
         ) {\r
        if (!EfiAtRuntime () || ((Variable[Index]->Attributes & EFI_VARIABLE_RUNTIME_ACCESS) != 0)) {\r
          if (VariableName[0] == 0) {\r
            if (Variable[Index]->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r
              InDeletedVariable     = Variable[Index];\r
              InDeletedStorageIndex = Index;\r
            } else {\r
              PtrTrack->StartPtr  = GetStartPointer (VariableStoreHeader[Index]);\r
              PtrTrack->EndPtr    = GetEndPointer (VariableStoreHeader[Index]);\r
              PtrTrack->CurrPtr   = Variable[Index];\r
              PtrTrack->Volatile  = (BOOLEAN)(Index == 0);\r
\r
              return EFI_SUCCESS;\r
            }\r
          } else {\r
            if (CompareGuid (VendorGuid, &Variable[Index]->VendorGuid)) {\r
              Point = (VOID *) GetVariableNamePtr (Variable[Index]);\r
\r
              ASSERT (NameSizeOfVariable (Variable[Index]) != 0);\r
              if (CompareMem (VariableName, Point, NameSizeOfVariable (Variable[Index])) == 0) {\r
                if (Variable[Index]->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r
                  InDeletedVariable     = Variable[Index];\r
                  InDeletedStorageIndex = Index;\r
                } else {\r
                  PtrTrack->StartPtr  = GetStartPointer (VariableStoreHeader[Index]);\r
                  PtrTrack->EndPtr    = GetEndPointer (VariableStoreHeader[Index]);\r
                  PtrTrack->CurrPtr   = Variable[Index];\r
                  PtrTrack->Volatile  = (BOOLEAN)(Index == 0);\r
\r
                  return EFI_SUCCESS;\r
                }\r
              }\r
            }\r
          }\r
        }\r
      }\r
\r
      Variable[Index] = GetNextVariablePtr (Variable[Index]);\r
    }\r
    if (InDeletedVariable != NULL) {\r
      PtrTrack->StartPtr  = GetStartPointer (VariableStoreHeader[InDeletedStorageIndex]);\r
      PtrTrack->EndPtr    = GetEndPointer (VariableStoreHeader[InDeletedStorageIndex]);\r
      PtrTrack->CurrPtr   = InDeletedVariable;\r
      PtrTrack->Volatile  = (BOOLEAN)(InDeletedStorageIndex == 0);\r
      return EFI_SUCCESS;\r
    }\r
  }\r
  PtrTrack->CurrPtr = NULL;\r
  return EFI_NOT_FOUND;\r
}\r
\r
/**\r
  Get index from supported language codes according to language string.\r
\r
  This code is used to get corresponding index in supported language codes. It can handle\r
  RFC4646 and ISO639 language tags.\r
  In ISO639 language tags, take 3-characters as a delimitation to find matched string and calculate the index.\r
  In RFC4646 language tags, take semicolon as a delimitation to find matched string and calculate the index.\r
\r
  For example:\r
    SupportedLang  = "engfraengfra"\r
    Lang           = "eng"\r
    Iso639Language = TRUE\r
  The return value is "0".\r
  Another example:\r
    SupportedLang  = "en;fr;en-US;fr-FR"\r
    Lang           = "fr-FR"\r
    Iso639Language = FALSE\r
  The return value is "3".\r
\r
  @param  SupportedLang               Platform supported language codes.\r
  @param  Lang                        Configured language.\r
  @param  Iso639Language              A bool value to signify if the handler is operated on ISO639 or RFC4646.\r
\r
  @retval the index of language in the language codes.\r
\r
**/\r
UINTN\r
GetIndexFromSupportedLangCodes(\r
  IN  CHAR8            *SupportedLang,\r
  IN  CHAR8            *Lang,\r
  IN  BOOLEAN          Iso639Language\r
  ) \r
{\r
  UINTN    Index;\r
  UINTN    CompareLength;\r
  UINTN    LanguageLength;\r
\r
  if (Iso639Language) {\r
    CompareLength = ISO_639_2_ENTRY_SIZE;\r
    for (Index = 0; Index < AsciiStrLen (SupportedLang); Index += CompareLength) {\r
      if (AsciiStrnCmp (Lang, SupportedLang + Index, CompareLength) == 0) {\r
        //\r
        // Successfully find the index of Lang string in SupportedLang string.\r
        //\r
        Index = Index / CompareLength;\r
        return Index;\r
      }\r
    }\r
    ASSERT (FALSE);\r
    return 0;\r
  } else {\r
    //\r
    // Compare RFC4646 language code\r
    //\r
    Index = 0;\r
    for (LanguageLength = 0; Lang[LanguageLength] != '\0'; LanguageLength++);\r
\r
    for (Index = 0; *SupportedLang != '\0'; Index++, SupportedLang += CompareLength) {\r
      //\r
      // Skip ';' characters in SupportedLang\r
      //\r
      for (; *SupportedLang != '\0' && *SupportedLang == ';'; SupportedLang++);\r
      //\r
      // Determine the length of the next language code in SupportedLang\r
      //\r
      for (CompareLength = 0; SupportedLang[CompareLength] != '\0' && SupportedLang[CompareLength] != ';'; CompareLength++);\r
      \r
      if ((CompareLength == LanguageLength) && \r
          (AsciiStrnCmp (Lang, SupportedLang, CompareLength) == 0)) {\r
        //\r
        // Successfully find the index of Lang string in SupportedLang string.\r
        //\r
        return Index;\r
      }\r
    }\r
    ASSERT (FALSE);\r
    return 0;\r
  }\r
}\r
\r
/**\r
  Get language string from supported language codes according to index.\r
\r
  This code is used to get corresponding language string in supported language codes. It can handle\r
  RFC4646 and ISO639 language tags.\r
  In ISO639 language tags, take 3-characters as a delimitation. Find language string according to the index.\r
  In RFC4646 language tags, take semicolon as a delimitation. Find language string according to the index.\r
\r
  For example:\r
    SupportedLang  = "engfraengfra"\r
    Index          = "1"\r
    Iso639Language = TRUE\r
  The return value is "fra".\r
  Another example:\r
    SupportedLang  = "en;fr;en-US;fr-FR"\r
    Index          = "1"\r
    Iso639Language = FALSE\r
  The return value is "fr".\r
\r
  @param  SupportedLang               Platform supported language codes.\r
  @param  Index                       the index in supported language codes.\r
  @param  Iso639Language              A bool value to signify if the handler is operated on ISO639 or RFC4646.\r
\r
  @retval the language string in the language codes.\r
\r
**/\r
CHAR8 *\r
GetLangFromSupportedLangCodes (\r
  IN  CHAR8            *SupportedLang,\r
  IN  UINTN            Index,\r
  IN  BOOLEAN          Iso639Language\r
)\r
{\r
  UINTN    SubIndex;\r
  UINTN    CompareLength;\r
  CHAR8    *Supported;\r
\r
  SubIndex  = 0;\r
  Supported = SupportedLang;\r
  if (Iso639Language) {\r
    //\r
    // according to the index of Lang string in SupportedLang string to get the language.\r
    // As this code will be invoked in RUNTIME, therefore there is not memory allocate/free operation.\r
    // In driver entry, it pre-allocates a runtime attribute memory to accommodate this string.\r
    //\r
    CompareLength = ISO_639_2_ENTRY_SIZE;\r
    mVariableModuleGlobal->Lang[CompareLength] = '\0';\r
    return CopyMem (mVariableModuleGlobal->Lang, SupportedLang + Index * CompareLength, CompareLength);\r
\r
  } else {\r
    while (TRUE) {\r
      //\r
      // take semicolon as delimitation, sequentially traverse supported language codes.\r
      //\r
      for (CompareLength = 0; *Supported != ';' && *Supported != '\0'; CompareLength++) {\r
        Supported++;\r
      }\r
      if ((*Supported == '\0') && (SubIndex != Index)) {\r
        //\r
        // Have completed the traverse, but not find corrsponding string.\r
        // This case is not allowed to happen.\r
        //\r
        ASSERT(FALSE);\r
        return NULL;\r
      }\r
      if (SubIndex == Index) {\r
        //\r
        // according to the index of Lang string in SupportedLang string to get the language.\r
        // As this code will be invoked in RUNTIME, therefore there is not memory allocate/free operation.\r
        // In driver entry, it pre-allocates a runtime attribute memory to accommodate this string.\r
        //\r
        mVariableModuleGlobal->PlatformLang[CompareLength] = '\0';\r
        return CopyMem (mVariableModuleGlobal->PlatformLang, Supported - CompareLength, CompareLength);\r
      }\r
      SubIndex++;\r
    }\r
  }\r
}\r
\r
/**\r
  Returns a pointer to an allocated buffer that contains the best matching language \r
  from a set of supported languages.  \r
  \r
  This function supports both ISO 639-2 and RFC 4646 language codes, but language \r
  code types may not be mixed in a single call to this function. This function\r
  supports a variable argument list that allows the caller to pass in a prioritized\r
  list of language codes to test against all the language codes in SupportedLanguages.\r
\r
  If SupportedLanguages is NULL, then ASSERT().\r
\r
  @param[in]  SupportedLanguages  A pointer to a Null-terminated ASCII string that\r
                                  contains a set of language codes in the format \r
                                  specified by Iso639Language.\r
  @param[in]  Iso639Language      If TRUE, then all language codes are assumed to be\r
                                  in ISO 639-2 format.  If FALSE, then all language\r
                                  codes are assumed to be in RFC 4646 language format\r
  @param[in]  ...                 A variable argument list that contains pointers to \r
                                  Null-terminated ASCII strings that contain one or more\r
                                  language codes in the format specified by Iso639Language.\r
                                  The first language code from each of these language\r
                                  code lists is used to determine if it is an exact or\r
                                  close match to any of the language codes in \r
                                  SupportedLanguages.  Close matches only apply to RFC 4646\r
                                  language codes, and the matching algorithm from RFC 4647\r
                                  is used to determine if a close match is present.  If \r
                                  an exact or close match is found, then the matching\r
                                  language code from SupportedLanguages is returned.  If\r
                                  no matches are found, then the next variable argument\r
                                  parameter is evaluated.  The variable argument list \r
                                  is terminated by a NULL.\r
\r
  @retval NULL   The best matching language could not be found in SupportedLanguages.\r
  @retval NULL   There are not enough resources available to return the best matching \r
                 language.\r
  @retval Other  A pointer to a Null-terminated ASCII string that is the best matching \r
                 language in SupportedLanguages.\r
\r
**/\r
CHAR8 *\r
VariableGetBestLanguage (\r
  IN CONST CHAR8  *SupportedLanguages, \r
  IN BOOLEAN      Iso639Language,\r
  ...\r
  )\r
{\r
  VA_LIST      Args;\r
  CHAR8        *Language;\r
  UINTN        CompareLength;\r
  UINTN        LanguageLength;\r
  CONST CHAR8  *Supported;\r
  CHAR8        *Buffer;\r
\r
  ASSERT (SupportedLanguages != NULL);\r
\r
  VA_START (Args, Iso639Language);\r
  while ((Language = VA_ARG (Args, CHAR8 *)) != NULL) {\r
    //\r
    // Default to ISO 639-2 mode\r
    //\r
    CompareLength  = 3;\r
    LanguageLength = MIN (3, AsciiStrLen (Language));\r
\r
    //\r
    // If in RFC 4646 mode, then determine the length of the first RFC 4646 language code in Language\r
    //\r
    if (!Iso639Language) {\r
      for (LanguageLength = 0; Language[LanguageLength] != 0 && Language[LanguageLength] != ';'; LanguageLength++);\r
    }\r
\r
    //\r
    // Trim back the length of Language used until it is empty\r
    //\r
    while (LanguageLength > 0) {\r
      //\r
      // Loop through all language codes in SupportedLanguages\r
      //\r
      for (Supported = SupportedLanguages; *Supported != '\0'; Supported += CompareLength) {\r
        //\r
        // In RFC 4646 mode, then Loop through all language codes in SupportedLanguages\r
        //\r
        if (!Iso639Language) {\r
          //\r
          // Skip ';' characters in Supported\r
          //\r
          for (; *Supported != '\0' && *Supported == ';'; Supported++);\r
          //\r
          // Determine the length of the next language code in Supported\r
          //\r
          for (CompareLength = 0; Supported[CompareLength] != 0 && Supported[CompareLength] != ';'; CompareLength++);\r
          //\r
          // If Language is longer than the Supported, then skip to the next language\r
          //\r
          if (LanguageLength > CompareLength) {\r
            continue;\r
          }\r
        }\r
        //\r
        // See if the first LanguageLength characters in Supported match Language\r
        //\r
        if (AsciiStrnCmp (Supported, Language, LanguageLength) == 0) {\r
          VA_END (Args);\r
\r
          Buffer = Iso639Language ? mVariableModuleGlobal->Lang : mVariableModuleGlobal->PlatformLang;\r
          Buffer[CompareLength] = '\0';\r
          return CopyMem (Buffer, Supported, CompareLength);\r
        }\r
      }\r
\r
      if (Iso639Language) {\r
        //\r
        // If ISO 639 mode, then each language can only be tested once\r
        //\r
        LanguageLength = 0;\r
      } else {\r
        //\r
        // If RFC 4646 mode, then trim Language from the right to the next '-' character \r
        //\r
        for (LanguageLength--; LanguageLength > 0 && Language[LanguageLength] != '-'; LanguageLength--);\r
      }\r
    }\r
  }\r
  VA_END (Args);\r
\r
  //\r
  // No matches were found \r
  //\r
  return NULL;\r
}\r
\r
/**\r
  Hook the operations in PlatformLangCodes, LangCodes, PlatformLang and Lang.\r
\r
  When setting Lang/LangCodes, simultaneously update PlatformLang/PlatformLangCodes.\r
\r
  According to UEFI spec, PlatformLangCodes/LangCodes are only set once in firmware initialization,\r
  and are read-only. Therefore, in variable driver, only store the original value for other use.\r
\r
  @param[in] VariableName       Name of variable\r
\r
  @param[in] Data               Variable data\r
\r
  @param[in] DataSize           Size of data. 0 means delete\r
\r
**/\r
VOID\r
AutoUpdateLangVariable(\r
  IN  CHAR16             *VariableName,\r
  IN  VOID               *Data,\r
  IN  UINTN              DataSize\r
  )\r
{\r
  EFI_STATUS             Status;\r
  CHAR8                  *BestPlatformLang;\r
  CHAR8                  *BestLang;\r
  UINTN                  Index;\r
  UINT32                 Attributes;\r
  VARIABLE_POINTER_TRACK Variable;\r
  BOOLEAN                SetLanguageCodes;\r
\r
  //\r
  // Don't do updates for delete operation\r
  //\r
  if (DataSize == 0) {\r
    return;\r
  }\r
\r
  SetLanguageCodes = FALSE;\r
\r
  if (StrCmp (VariableName, L"PlatformLangCodes") == 0) {\r
    //\r
    // PlatformLangCodes is a volatile variable, so it can not be updated at runtime.\r
    //\r
    if (EfiAtRuntime ()) {\r
      return;\r
    }\r
\r
    SetLanguageCodes = TRUE;\r
\r
    //\r
    // According to UEFI spec, PlatformLangCodes is only set once in firmware initialization, and is read-only\r
    // Therefore, in variable driver, only store the original value for other use.\r
    //\r
    if (mVariableModuleGlobal->PlatformLangCodes != NULL) {\r
      FreePool (mVariableModuleGlobal->PlatformLangCodes);\r
    }\r
    mVariableModuleGlobal->PlatformLangCodes = AllocateRuntimeCopyPool (DataSize, Data);\r
    ASSERT (mVariableModuleGlobal->PlatformLangCodes != NULL);\r
\r
    //\r
    // PlatformLang holds a single language from PlatformLangCodes, \r
    // so the size of PlatformLangCodes is enough for the PlatformLang.\r
    //\r
    if (mVariableModuleGlobal->PlatformLang != NULL) {\r
      FreePool (mVariableModuleGlobal->PlatformLang);\r
    }\r
    mVariableModuleGlobal->PlatformLang = AllocateRuntimePool (DataSize);\r
    ASSERT (mVariableModuleGlobal->PlatformLang != NULL);\r
\r
  } else if (StrCmp (VariableName, L"LangCodes") == 0) {\r
    //\r
    // LangCodes is a volatile variable, so it can not be updated at runtime.\r
    //\r
    if (EfiAtRuntime ()) {\r
      return;\r
    }\r
\r
    SetLanguageCodes = TRUE;\r
\r
    //\r
    // According to UEFI spec, LangCodes is only set once in firmware initialization, and is read-only\r
    // Therefore, in variable driver, only store the original value for other use.\r
    //\r
    if (mVariableModuleGlobal->LangCodes != NULL) {\r
      FreePool (mVariableModuleGlobal->LangCodes);\r
    }\r
    mVariableModuleGlobal->LangCodes = AllocateRuntimeCopyPool (DataSize, Data);\r
    ASSERT (mVariableModuleGlobal->LangCodes != NULL);\r
  }\r
\r
  if (SetLanguageCodes \r
      && (mVariableModuleGlobal->PlatformLangCodes != NULL)\r
      && (mVariableModuleGlobal->LangCodes != NULL)) {\r
    //\r
    // Update Lang if PlatformLang is already set\r
    // Update PlatformLang if Lang is already set\r
    //\r
    Status = FindVariable (L"PlatformLang", &gEfiGlobalVariableGuid, &Variable, (VARIABLE_GLOBAL *) mVariableModuleGlobal);\r
    if (!EFI_ERROR (Status)) {\r
      //\r
      // Update Lang\r
      //\r
      VariableName = L"PlatformLang";\r
      Data         = GetVariableDataPtr (Variable.CurrPtr);\r
      DataSize     = Variable.CurrPtr->DataSize;\r
    } else {\r
      Status = FindVariable (L"Lang", &gEfiGlobalVariableGuid, &Variable, (VARIABLE_GLOBAL *) mVariableModuleGlobal);\r
      if (!EFI_ERROR (Status)) {\r
        //\r
        // Update PlatformLang\r
        //\r
        VariableName = L"Lang";\r
        Data         = GetVariableDataPtr (Variable.CurrPtr);\r
        DataSize     = Variable.CurrPtr->DataSize;\r
      } else {\r
        //\r
        // Neither PlatformLang nor Lang is set, directly return\r
        //\r
        return;\r
      }\r
    }\r
  }\r
  \r
  //\r
  // According to UEFI spec, "Lang" and "PlatformLang" is NV|BS|RT attributions.\r
  //\r
  Attributes = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS;\r
\r
  if (StrCmp (VariableName, L"PlatformLang") == 0) {\r
    //\r
    // Update Lang when PlatformLangCodes/LangCodes were set.\r
    //\r
    if ((mVariableModuleGlobal->PlatformLangCodes != NULL) && (mVariableModuleGlobal->LangCodes != NULL)) {\r
      //\r
      // When setting PlatformLang, firstly get most matched language string from supported language codes.\r
      //\r
      BestPlatformLang = VariableGetBestLanguage (mVariableModuleGlobal->PlatformLangCodes, FALSE, Data, NULL);\r
      if (BestPlatformLang != NULL) {\r
        //\r
        // Get the corresponding index in language codes.\r
        //\r
        Index = GetIndexFromSupportedLangCodes (mVariableModuleGlobal->PlatformLangCodes, BestPlatformLang, FALSE);\r
\r
        //\r
        // Get the corresponding ISO639 language tag according to RFC4646 language tag.\r
        //\r
        BestLang = GetLangFromSupportedLangCodes (mVariableModuleGlobal->LangCodes, Index, TRUE);\r
\r
        //\r
        // Successfully convert PlatformLang to Lang, and set the BestLang value into Lang variable simultaneously.\r
        //\r
        FindVariable (L"Lang", &gEfiGlobalVariableGuid, &Variable, (VARIABLE_GLOBAL *)mVariableModuleGlobal);\r
\r
        Status = UpdateVariable (L"Lang", &gEfiGlobalVariableGuid, BestLang, ISO_639_2_ENTRY_SIZE + 1, Attributes, &Variable);\r
\r
        DEBUG ((EFI_D_INFO, "Variable Driver Auto Update PlatformLang, PlatformLang:%a, Lang:%a\n", BestPlatformLang, BestLang));\r
\r
        ASSERT_EFI_ERROR(Status);\r
      }\r
    }\r
\r
  } else if (StrCmp (VariableName, L"Lang") == 0) {\r
    //\r
    // Update PlatformLang when PlatformLangCodes/LangCodes were set.\r
    //\r
    if ((mVariableModuleGlobal->PlatformLangCodes != NULL) && (mVariableModuleGlobal->LangCodes != NULL)) {\r
      //\r
      // When setting Lang, firstly get most matched language string from supported language codes.\r
      //\r
      BestLang = VariableGetBestLanguage (mVariableModuleGlobal->LangCodes, TRUE, Data, NULL);\r
      if (BestLang != NULL) {\r
        //\r
        // Get the corresponding index in language codes.\r
        //\r
        Index = GetIndexFromSupportedLangCodes (mVariableModuleGlobal->LangCodes, BestLang, TRUE);\r
\r
        //\r
        // Get the corresponding RFC4646 language tag according to ISO639 language tag.\r
        //\r
        BestPlatformLang = GetLangFromSupportedLangCodes (mVariableModuleGlobal->PlatformLangCodes, Index, FALSE);\r
\r
        //\r
        // Successfully convert Lang to PlatformLang, and set the BestPlatformLang value into PlatformLang variable simultaneously.\r
        //\r
        FindVariable (L"PlatformLang", &gEfiGlobalVariableGuid, &Variable, (VARIABLE_GLOBAL *)mVariableModuleGlobal);\r
\r
        Status = UpdateVariable (L"PlatformLang", &gEfiGlobalVariableGuid, BestPlatformLang, \r
                                 AsciiStrSize (BestPlatformLang), Attributes, &Variable);\r
\r
        DEBUG ((EFI_D_INFO, "Variable Driver Auto Update Lang, Lang:%a, PlatformLang:%a\n", BestLang, BestPlatformLang));\r
        ASSERT_EFI_ERROR (Status);\r
      }\r
    }\r
  }\r
}\r
\r
/**\r
  Update the variable region with Variable information. These are the same \r
  arguments as the EFI Variable services.\r
\r
  @param[in] VariableName       Name of variable\r
\r
  @param[in] VendorGuid         Guid of variable\r
\r
  @param[in] Data               Variable data\r
\r
  @param[in] DataSize           Size of data. 0 means delete\r
\r
  @param[in] Attributes         Attribues of the variable\r
\r
  @param[in] Variable           The variable information which is used to keep track of variable usage.\r
\r
  @retval EFI_SUCCESS           The update operation is success.\r
\r
  @retval EFI_OUT_OF_RESOURCES  Variable region is full, can not write other data into this region.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UpdateVariable (\r
  IN      CHAR16          *VariableName,\r
  IN      EFI_GUID        *VendorGuid,\r
  IN      VOID            *Data,\r
  IN      UINTN           DataSize,\r
  IN      UINT32          Attributes OPTIONAL,\r
  IN      VARIABLE_POINTER_TRACK *Variable\r
  )\r
{\r
  EFI_STATUS                          Status;\r
  VARIABLE_HEADER                     *NextVariable;\r
  UINTN                               ScratchSize;\r
  UINTN                               NonVolatileVarableStoreSize;\r
  UINTN                               VarNameOffset;\r
  UINTN                               VarDataOffset;\r
  UINTN                               VarNameSize;\r
  UINTN                               VarSize;\r
  BOOLEAN                             Volatile;\r
  EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  *Fvb;\r
  UINT8                               State;\r
  BOOLEAN                             Reclaimed;\r
\r
  Fvb               = mVariableModuleGlobal->FvbInstance;\r
  Reclaimed         = FALSE;\r
\r
  if (Variable->CurrPtr != NULL) {\r
    //\r
    // Update/Delete existing variable\r
    //\r
    Volatile = Variable->Volatile;\r
    \r
    if (EfiAtRuntime ()) {        \r
      //\r
      // If EfiAtRuntime and the variable is Volatile and Runtime Access,  \r
      // the volatile is ReadOnly, and SetVariable should be aborted and \r
      // return EFI_WRITE_PROTECTED.\r
      //\r
      if (Variable->Volatile) {\r
        Status = EFI_WRITE_PROTECTED;\r
        goto Done;\r
      }\r
      //\r
      // Only variable have NV attribute can be updated/deleted in Runtime\r
      //\r
      if ((Variable->CurrPtr->Attributes & EFI_VARIABLE_NON_VOLATILE) == 0) {\r
        Status = EFI_INVALID_PARAMETER;\r
        goto Done;      \r
      }\r
    }\r
    //\r
    // Setting a data variable with no access, or zero DataSize attributes\r
    // specified causes it to be deleted.\r
    //\r
    if (DataSize == 0 || (Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == 0) {    \r
      State = Variable->CurrPtr->State;\r
      State &= VAR_DELETED;\r
\r
      Status = UpdateVariableStore (\r
                 &mVariableModuleGlobal->VariableGlobal,\r
                 Variable->Volatile,\r
                 FALSE,\r
                 Fvb,\r
                 (UINTN) &Variable->CurrPtr->State,\r
                 sizeof (UINT8),\r
                 &State\r
                 ); \r
      if (!EFI_ERROR (Status)) {\r
        UpdateVariableInfo (VariableName, VendorGuid, Volatile, FALSE, FALSE, TRUE, FALSE);\r
        UpdateVariableCache (VariableName, VendorGuid, Attributes, DataSize, Data);\r
      }\r
      goto Done;     \r
    }\r
    //\r
    // If the variable is marked valid and the same data has been passed in\r
    // then return to the caller immediately.\r
    //\r
    if (DataSizeOfVariable (Variable->CurrPtr) == DataSize &&\r
        (CompareMem (Data, GetVariableDataPtr (Variable->CurrPtr), DataSize) == 0)) {\r
      \r
      UpdateVariableInfo (VariableName, VendorGuid, Volatile, FALSE, TRUE, FALSE, FALSE);\r
      Status = EFI_SUCCESS;\r
      goto Done;\r
    } else if ((Variable->CurrPtr->State == VAR_ADDED) ||\r
               (Variable->CurrPtr->State == (VAR_ADDED & VAR_IN_DELETED_TRANSITION))) {\r
\r
      //\r
      // Mark the old variable as in delete transition\r
      //\r
      State = Variable->CurrPtr->State;\r
      State &= VAR_IN_DELETED_TRANSITION;\r
\r
      Status = UpdateVariableStore (\r
                 &mVariableModuleGlobal->VariableGlobal,\r
                 Variable->Volatile,\r
                 FALSE,\r
                 Fvb,\r
                 (UINTN) &Variable->CurrPtr->State,\r
                 sizeof (UINT8),\r
                 &State\r
                 );      \r
      if (EFI_ERROR (Status)) {\r
        goto Done;  \r
      } \r
    }    \r
  } else {\r
    //\r
    // Not found existing variable. Create a new variable\r
    //  \r
    \r
    //\r
    // Make sure we are trying to create a new variable.\r
    // Setting a data variable with no access, or zero DataSize attributes means to delete it.    \r
    //\r
    if (DataSize == 0 || (Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == 0) {\r
      Status = EFI_NOT_FOUND;\r
      goto Done;\r
    }\r
        \r
    //\r
    // Only variable have NV|RT attribute can be created in Runtime\r
    //\r
    if (EfiAtRuntime () &&\r
        (((Attributes & EFI_VARIABLE_RUNTIME_ACCESS) == 0) || ((Attributes & EFI_VARIABLE_NON_VOLATILE) == 0))) {\r
      Status = EFI_INVALID_PARAMETER;\r
      goto Done;\r
    }         \r
  }\r
\r
  //\r
  // Function part - create a new variable and copy the data.\r
  // Both update a variable and create a variable will come here.\r
  //\r
  // Tricky part: Use scratch data area at the end of volatile variable store\r
  // as a temporary storage.\r
  //\r
  NextVariable = GetEndPointer ((VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.VolatileVariableBase));\r
  ScratchSize = MAX (PcdGet32 (PcdMaxVariableSize), PcdGet32 (PcdMaxHardwareErrorVariableSize));\r
\r
  SetMem (NextVariable, ScratchSize, 0xff);\r
\r
  NextVariable->StartId     = VARIABLE_DATA;\r
  NextVariable->Attributes  = Attributes;\r
  //\r
  // NextVariable->State = VAR_ADDED;\r
  //\r
  NextVariable->Reserved  = 0;\r
  VarNameOffset           = sizeof (VARIABLE_HEADER);\r
  VarNameSize             = StrSize (VariableName);\r
  CopyMem (\r
    (UINT8 *) ((UINTN) NextVariable + VarNameOffset),\r
    VariableName,\r
    VarNameSize\r
    );\r
  VarDataOffset = VarNameOffset + VarNameSize + GET_PAD_SIZE (VarNameSize);\r
  CopyMem (\r
    (UINT8 *) ((UINTN) NextVariable + VarDataOffset),\r
    Data,\r
    DataSize\r
    );\r
  CopyMem (&NextVariable->VendorGuid, VendorGuid, sizeof (EFI_GUID));\r
  //\r
  // There will be pad bytes after Data, the NextVariable->NameSize and\r
  // NextVariable->DataSize should not include pad size so that variable\r
  // service can get actual size in GetVariable\r
  //\r
  NextVariable->NameSize  = (UINT32)VarNameSize;\r
  NextVariable->DataSize  = (UINT32)DataSize;\r
\r
  //\r
  // The actual size of the variable that stores in storage should\r
  // include pad size.\r
  //\r
  VarSize = VarDataOffset + DataSize + GET_PAD_SIZE (DataSize);\r
  if ((Attributes & EFI_VARIABLE_NON_VOLATILE) != 0) {\r
    //\r
    // Create a nonvolatile variable\r
    //\r
    Volatile = FALSE;\r
    NonVolatileVarableStoreSize = ((VARIABLE_STORE_HEADER *)(UINTN)(mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase))->Size;\r
    if ((((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != 0) \r
      && ((VarSize + mVariableModuleGlobal->HwErrVariableTotalSize) > PcdGet32 (PcdHwErrStorageSize)))\r
      || (((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == 0) \r
      && ((VarSize + mVariableModuleGlobal->CommonVariableTotalSize) > NonVolatileVarableStoreSize - sizeof (VARIABLE_STORE_HEADER) - PcdGet32 (PcdHwErrStorageSize)))) {\r
      if (EfiAtRuntime ()) {\r
        Status = EFI_OUT_OF_RESOURCES;\r
        goto Done;\r
      }\r
      //\r
      // Perform garbage collection & reclaim operation\r
      //\r
      Status = Reclaim (mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase, \r
                        &mVariableModuleGlobal->NonVolatileLastVariableOffset, FALSE, Variable->CurrPtr);\r
      if (EFI_ERROR (Status)) {\r
        goto Done;\r
      }\r
      //\r
      // If still no enough space, return out of resources\r
      //\r
      if ((((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != 0) \r
        && ((VarSize + mVariableModuleGlobal->HwErrVariableTotalSize) > PcdGet32 (PcdHwErrStorageSize)))\r
        || (((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == 0) \r
        && ((VarSize + mVariableModuleGlobal->CommonVariableTotalSize) > NonVolatileVarableStoreSize - sizeof (VARIABLE_STORE_HEADER) - PcdGet32 (PcdHwErrStorageSize)))) {\r
        Status = EFI_OUT_OF_RESOURCES;\r
        goto Done;\r
      }\r
      Reclaimed = TRUE;\r
    }\r
    //\r
    // Three steps\r
    // 1. Write variable header\r
    // 2. Set variable state to header valid  \r
    // 3. Write variable data\r
    // 4. Set variable state to valid\r
    //\r
    //\r
    // Step 1:\r
    //\r
    Status = UpdateVariableStore (\r
               &mVariableModuleGlobal->VariableGlobal,\r
               FALSE,\r
               TRUE,\r
               Fvb,\r
               mVariableModuleGlobal->NonVolatileLastVariableOffset,\r
               sizeof (VARIABLE_HEADER),\r
               (UINT8 *) NextVariable\r
               );\r
\r
    if (EFI_ERROR (Status)) {\r
      goto Done;\r
    }\r
\r
    //\r
    // Step 2:\r
    //\r
    NextVariable->State = VAR_HEADER_VALID_ONLY;\r
    Status = UpdateVariableStore (\r
               &mVariableModuleGlobal->VariableGlobal,\r
               FALSE,\r
               TRUE,\r
               Fvb,\r
               mVariableModuleGlobal->NonVolatileLastVariableOffset,\r
               sizeof (VARIABLE_HEADER),\r
               (UINT8 *) NextVariable\r
               );\r
\r
    if (EFI_ERROR (Status)) {\r
      goto Done;\r
    }\r
    //\r
    // Step 3:\r
    //\r
    Status = UpdateVariableStore (\r
               &mVariableModuleGlobal->VariableGlobal,\r
               FALSE,\r
               TRUE,\r
               Fvb,\r
               mVariableModuleGlobal->NonVolatileLastVariableOffset + sizeof (VARIABLE_HEADER),\r
               (UINT32) VarSize - sizeof (VARIABLE_HEADER),\r
               (UINT8 *) NextVariable + sizeof (VARIABLE_HEADER)\r
               );\r
\r
    if (EFI_ERROR (Status)) {\r
      goto Done;\r
    }\r
    //\r
    // Step 4:\r
    //\r
    NextVariable->State = VAR_ADDED;\r
    Status = UpdateVariableStore (\r
               &mVariableModuleGlobal->VariableGlobal,\r
               FALSE,\r
               TRUE,\r
               Fvb,\r
               mVariableModuleGlobal->NonVolatileLastVariableOffset,\r
               sizeof (VARIABLE_HEADER),\r
               (UINT8 *) NextVariable\r
               );\r
\r
    if (EFI_ERROR (Status)) {\r
      goto Done;\r
    }\r
\r
    mVariableModuleGlobal->NonVolatileLastVariableOffset += HEADER_ALIGN (VarSize);\r
\r
    if ((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != 0) {\r
      mVariableModuleGlobal->HwErrVariableTotalSize += HEADER_ALIGN (VarSize);\r
    } else {\r
      mVariableModuleGlobal->CommonVariableTotalSize += HEADER_ALIGN (VarSize);\r
    }\r
  } else {\r
    //\r
    // Create a volatile variable\r
    //      \r
    Volatile = TRUE;\r
\r
    if ((UINT32) (VarSize + mVariableModuleGlobal->VolatileLastVariableOffset) >\r
        ((VARIABLE_STORE_HEADER *) ((UINTN) (mVariableModuleGlobal->VariableGlobal.VolatileVariableBase)))->Size) {\r
      //\r
      // Perform garbage collection & reclaim operation\r
      //\r
      Status = Reclaim (mVariableModuleGlobal->VariableGlobal.VolatileVariableBase, \r
                          &mVariableModuleGlobal->VolatileLastVariableOffset, TRUE, Variable->CurrPtr);\r
      if (EFI_ERROR (Status)) {\r
        goto Done;\r
      }\r
      //\r
      // If still no enough space, return out of resources\r
      //\r
      if ((UINT32) (VarSize + mVariableModuleGlobal->VolatileLastVariableOffset) >\r
            ((VARIABLE_STORE_HEADER *) ((UINTN) (mVariableModuleGlobal->VariableGlobal.VolatileVariableBase)))->Size\r
            ) {\r
        Status = EFI_OUT_OF_RESOURCES;\r
        goto Done;\r
      }\r
      Reclaimed = TRUE;\r
    }\r
\r
    NextVariable->State = VAR_ADDED;\r
    Status = UpdateVariableStore (\r
               &mVariableModuleGlobal->VariableGlobal,\r
               TRUE,\r
               TRUE,\r
               Fvb,\r
               mVariableModuleGlobal->VolatileLastVariableOffset,\r
               (UINT32) VarSize,\r
               (UINT8 *) NextVariable\r
               );\r
\r
    if (EFI_ERROR (Status)) {\r
      goto Done;\r
    }\r
\r
    mVariableModuleGlobal->VolatileLastVariableOffset += HEADER_ALIGN (VarSize);\r
  }\r
\r
  //\r
  // Mark the old variable as deleted\r
  //\r
  if (!Reclaimed && !EFI_ERROR (Status) && Variable->CurrPtr != NULL) {\r
    State = Variable->CurrPtr->State;\r
    State &= VAR_DELETED;\r
\r
    Status = UpdateVariableStore (\r
             &mVariableModuleGlobal->VariableGlobal,\r
             Variable->Volatile,\r
             FALSE,\r
             Fvb,\r
             (UINTN) &Variable->CurrPtr->State,\r
             sizeof (UINT8),\r
             &State\r
             );\r
  }\r
\r
  if (!EFI_ERROR (Status)) {\r
    UpdateVariableInfo (VariableName, VendorGuid, Volatile, FALSE, TRUE, FALSE, FALSE);\r
    UpdateVariableCache (VariableName, VendorGuid, Attributes, DataSize, Data);\r
  }\r
\r
Done:\r
  return Status;\r
}\r
\r
/**\r
\r
  This code finds variable in storage blocks (Volatile or Non-Volatile).\r
\r
  @param VariableName               Name of Variable to be found.\r
  @param VendorGuid                 Variable vendor GUID.\r
  @param Attributes                 Attribute value of the variable found.\r
  @param DataSize                   Size of Data found. If size is less than the\r
                                    data, this value contains the required size.\r
  @param Data                       Data pointer.\r
                      \r
  @return EFI_INVALID_PARAMETER     Invalid parameter\r
  @return EFI_SUCCESS               Find the specified variable\r
  @return EFI_NOT_FOUND             Not found\r
  @return EFI_BUFFER_TO_SMALL       DataSize is too small for the result\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RuntimeServiceGetVariable (\r
  IN      CHAR16            *VariableName,\r
  IN      EFI_GUID          *VendorGuid,\r
  OUT     UINT32            *Attributes OPTIONAL,\r
  IN OUT  UINTN             *DataSize,\r
  OUT     VOID              *Data\r
  )\r
{\r
  EFI_STATUS              Status;\r
  VARIABLE_POINTER_TRACK  Variable;\r
  UINTN                   VarDataSize;\r
\r
  if (VariableName == NULL || VendorGuid == NULL || DataSize == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  AcquireLockOnlyAtBootTime(&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
\r
  //\r
  // Find existing variable\r
  //\r
  Status = FindVariableInCache (VariableName, VendorGuid, Attributes, DataSize, Data);\r
  if ((Status == EFI_BUFFER_TOO_SMALL) || (Status == EFI_SUCCESS)){\r
    // Hit in the Cache\r
    UpdateVariableInfo (VariableName, VendorGuid, FALSE, TRUE, FALSE, FALSE, TRUE);\r
    goto Done;\r
  }\r
  \r
  Status = FindVariable (VariableName, VendorGuid, &Variable, &mVariableModuleGlobal->VariableGlobal);\r
  if (Variable.CurrPtr == NULL || EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
\r
  //\r
  // Get data size\r
  //\r
  VarDataSize = DataSizeOfVariable (Variable.CurrPtr);\r
  ASSERT (VarDataSize != 0);\r
\r
  if (*DataSize >= VarDataSize) {\r
    if (Data == NULL) {\r
      Status = EFI_INVALID_PARAMETER;\r
      goto Done;\r
    }\r
\r
    CopyMem (Data, GetVariableDataPtr (Variable.CurrPtr), VarDataSize);\r
    if (Attributes != NULL) {\r
      *Attributes = Variable.CurrPtr->Attributes;\r
    }\r
\r
    *DataSize = VarDataSize;\r
    UpdateVariableInfo (VariableName, VendorGuid, Variable.Volatile, TRUE, FALSE, FALSE, FALSE);\r
    UpdateVariableCache (VariableName, VendorGuid, Variable.CurrPtr->Attributes, VarDataSize, Data);\r
 \r
    Status = EFI_SUCCESS;\r
    goto Done;\r
  } else {\r
    *DataSize = VarDataSize;\r
    Status = EFI_BUFFER_TOO_SMALL;\r
    goto Done;\r
  }\r
\r
Done:\r
  ReleaseLockOnlyAtBootTime (&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
  return Status;\r
}\r
\r
\r
\r
/**\r
\r
  This code Finds the Next available variable.\r
\r
  @param VariableNameSize           Size of the variable name\r
  @param VariableName               Pointer to variable name\r
  @param VendorGuid                 Variable Vendor Guid\r
\r
  @return EFI_INVALID_PARAMETER     Invalid parameter\r
  @return EFI_SUCCESS               Find the specified variable\r
  @return EFI_NOT_FOUND             Not found\r
  @return EFI_BUFFER_TO_SMALL       DataSize is too small for the result\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RuntimeServiceGetNextVariableName (\r
  IN OUT  UINTN             *VariableNameSize,\r
  IN OUT  CHAR16            *VariableName,\r
  IN OUT  EFI_GUID          *VendorGuid\r
  )\r
{\r
  VARIABLE_POINTER_TRACK  Variable;\r
  UINTN                   VarNameSize;\r
  EFI_STATUS              Status;\r
\r
  if (VariableNameSize == NULL || VariableName == NULL || VendorGuid == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  AcquireLockOnlyAtBootTime(&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
\r
  Status = FindVariable (VariableName, VendorGuid, &Variable, &mVariableModuleGlobal->VariableGlobal);\r
  if (Variable.CurrPtr == NULL || EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
\r
  if (VariableName[0] != 0) {\r
    //\r
    // If variable name is not NULL, get next variable\r
    //\r
    Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr);\r
  }\r
\r
  while (TRUE) {\r
    //\r
    // If both volatile and non-volatile variable store are parsed,\r
    // return not found\r
    //\r
    if (Variable.CurrPtr >= Variable.EndPtr || Variable.CurrPtr == NULL) {\r
      Variable.Volatile = (BOOLEAN) (Variable.Volatile ^ ((BOOLEAN) 0x1));\r
      if (!Variable.Volatile) {\r
        Variable.StartPtr = GetStartPointer ((VARIABLE_STORE_HEADER *) (UINTN) mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase);\r
        Variable.EndPtr   = GetEndPointer ((VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase));\r
      } else {\r
        Status = EFI_NOT_FOUND;\r
        goto Done;\r
      }\r
\r
      Variable.CurrPtr = Variable.StartPtr;\r
      if (!IsValidVariableHeader (Variable.CurrPtr)) {\r
        continue;\r
      }\r
    }\r
    //\r
    // Variable is found\r
    //\r
    if (IsValidVariableHeader (Variable.CurrPtr) && Variable.CurrPtr->State == VAR_ADDED) {\r
      if ((EfiAtRuntime () && ((Variable.CurrPtr->Attributes & EFI_VARIABLE_RUNTIME_ACCESS) == 0)) == 0) {\r
        VarNameSize = NameSizeOfVariable (Variable.CurrPtr);\r
        ASSERT (VarNameSize != 0);\r
\r
        if (VarNameSize <= *VariableNameSize) {\r
          CopyMem (\r
            VariableName,\r
            GetVariableNamePtr (Variable.CurrPtr),\r
            VarNameSize\r
            );\r
          CopyMem (\r
            VendorGuid,\r
            &Variable.CurrPtr->VendorGuid,\r
            sizeof (EFI_GUID)\r
            );\r
          Status = EFI_SUCCESS;\r
        } else {\r
          Status = EFI_BUFFER_TOO_SMALL;\r
        }\r
\r
        *VariableNameSize = VarNameSize;\r
        goto Done;\r
      }\r
    }\r
\r
    Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr);\r
  }\r
\r
Done:\r
  ReleaseLockOnlyAtBootTime (&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
  return Status;\r
}\r
\r
/**\r
\r
  This code sets variable in storage blocks (Volatile or Non-Volatile).\r
\r
  @param VariableName                     Name of Variable to be found\r
  @param VendorGuid                       Variable vendor GUID\r
  @param Attributes                       Attribute value of the variable found\r
  @param DataSize                         Size of Data found. If size is less than the\r
                                          data, this value contains the required size.\r
  @param Data                             Data pointer\r
\r
  @return EFI_INVALID_PARAMETER           Invalid parameter\r
  @return EFI_SUCCESS                     Set successfully\r
  @return EFI_OUT_OF_RESOURCES            Resource not enough to set variable\r
  @return EFI_NOT_FOUND                   Not found\r
  @return EFI_WRITE_PROTECTED             Variable is read-only\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RuntimeServiceSetVariable (\r
  IN CHAR16                  *VariableName,\r
  IN EFI_GUID                *VendorGuid,\r
  IN UINT32                  Attributes,\r
  IN UINTN                   DataSize,\r
  IN VOID                    *Data\r
  )\r
{\r
  VARIABLE_POINTER_TRACK              Variable;\r
  EFI_STATUS                          Status;\r
  VARIABLE_HEADER                     *NextVariable;\r
  EFI_PHYSICAL_ADDRESS                Point;\r
\r
  //\r
  // Check input parameters\r
  //\r
  if (VariableName == NULL || VariableName[0] == 0 || VendorGuid == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (DataSize != 0 && Data == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Not support authenticated variable write yet.\r
  //\r
  if ((Attributes & EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS) != 0) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  //  Make sure if runtime bit is set, boot service bit is set also\r
  //\r
  if ((Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == EFI_VARIABLE_RUNTIME_ACCESS) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  //  The size of the VariableName, including the Unicode Null in bytes plus\r
  //  the DataSize is limited to maximum size of PcdGet32 (PcdMaxHardwareErrorVariableSize)\r
  //  bytes for HwErrRec, and PcdGet32 (PcdMaxVariableSize) bytes for the others.\r
  //\r
  if ((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {\r
    if ((DataSize > PcdGet32 (PcdMaxHardwareErrorVariableSize)) ||\r
        (sizeof (VARIABLE_HEADER) + StrSize (VariableName) + DataSize > PcdGet32 (PcdMaxHardwareErrorVariableSize))) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
    //\r
    // According to UEFI spec, HARDWARE_ERROR_RECORD variable name convention should be L"HwErrRecXXXX"\r
    //\r
    if (StrnCmp(VariableName, L"HwErrRec", StrLen(L"HwErrRec")) != 0) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
  } else {\r
    //\r
    //  The size of the VariableName, including the Unicode Null in bytes plus\r
    //  the DataSize is limited to maximum size of PcdGet32 (PcdMaxVariableSize) bytes.\r
    //\r
    if ((DataSize > PcdGet32 (PcdMaxVariableSize)) ||\r
        (sizeof (VARIABLE_HEADER) + StrSize (VariableName) + DataSize > PcdGet32 (PcdMaxVariableSize))) {\r
      return EFI_INVALID_PARAMETER;\r
    }  \r
  }  \r
\r
  AcquireLockOnlyAtBootTime(&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
\r
  //\r
  // Consider reentrant in MCA/INIT/NMI. It needs be reupdated;\r
  //\r
  if (1 < InterlockedIncrement (&mVariableModuleGlobal->VariableGlobal.ReentrantState)) {\r
    Point = mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase;;\r
    //\r
    // Parse non-volatile variable data and get last variable offset\r
    //\r
    NextVariable  = GetStartPointer ((VARIABLE_STORE_HEADER *) (UINTN) Point);\r
    while ((NextVariable < GetEndPointer ((VARIABLE_STORE_HEADER *) (UINTN) Point)) \r
        && IsValidVariableHeader (NextVariable)) {\r
      NextVariable = GetNextVariablePtr (NextVariable);\r
    }\r
    mVariableModuleGlobal->NonVolatileLastVariableOffset = (UINTN) NextVariable - (UINTN) Point;\r
  }\r
\r
  //\r
  // Check whether the input variable is already existed\r
  //\r
  FindVariable (VariableName, VendorGuid, &Variable, &mVariableModuleGlobal->VariableGlobal);\r
\r
  //\r
  // Hook the operation of setting PlatformLangCodes/PlatformLang and LangCodes/Lang\r
  //\r
  AutoUpdateLangVariable (VariableName, Data, DataSize);\r
\r
  Status = UpdateVariable (VariableName, VendorGuid, Data, DataSize, Attributes, &Variable);\r
\r
  InterlockedDecrement (&mVariableModuleGlobal->VariableGlobal.ReentrantState);\r
  ReleaseLockOnlyAtBootTime (&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
\r
  return Status;\r
}\r
\r
/**\r
\r
  This code returns information about the EFI variables.\r
\r
  @param Attributes                     Attributes bitmask to specify the type of variables\r
                                        on which to return information.\r
  @param MaximumVariableStorageSize     Pointer to the maximum size of the storage space available\r
                                        for the EFI variables associated with the attributes specified.\r
  @param RemainingVariableStorageSize   Pointer to the remaining size of the storage space available\r
                                        for EFI variables associated with the attributes specified.\r
  @param MaximumVariableSize            Pointer to the maximum size of an individual EFI variables\r
                                        associated with the attributes specified.\r
\r
  @return EFI_INVALID_PARAMETER         An invalid combination of attribute bits was supplied.\r
  @return EFI_SUCCESS                   Query successfully.\r
  @return EFI_UNSUPPORTED               The attribute is not supported on this platform.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RuntimeServiceQueryVariableInfo (\r
  IN  UINT32                 Attributes,\r
  OUT UINT64                 *MaximumVariableStorageSize,\r
  OUT UINT64                 *RemainingVariableStorageSize,\r
  OUT UINT64                 *MaximumVariableSize\r
  )\r
{\r
  VARIABLE_HEADER        *Variable;\r
  VARIABLE_HEADER        *NextVariable;\r
  UINT64                 VariableSize;\r
  VARIABLE_STORE_HEADER  *VariableStoreHeader;\r
  UINT64                 CommonVariableTotalSize;\r
  UINT64                 HwErrVariableTotalSize;\r
\r
  CommonVariableTotalSize = 0;\r
  HwErrVariableTotalSize = 0;\r
\r
  if(MaximumVariableStorageSize == NULL || RemainingVariableStorageSize == NULL || MaximumVariableSize == NULL || Attributes == 0) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if((Attributes & (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) == 0) {\r
    //\r
    // Make sure the Attributes combination is supported by the platform.\r
    //\r
    return EFI_UNSUPPORTED;  \r
  } else if ((Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == EFI_VARIABLE_RUNTIME_ACCESS) {\r
    //\r
    // Make sure if runtime bit is set, boot service bit is set also.\r
    //\r
    return EFI_INVALID_PARAMETER;\r
  } else if (EfiAtRuntime () && ((Attributes & EFI_VARIABLE_RUNTIME_ACCESS) == 0)) {\r
    //\r
    // Make sure RT Attribute is set if we are in Runtime phase.\r
    //\r
    return EFI_INVALID_PARAMETER;\r
  } else if ((Attributes & (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {\r
    //\r
    // Make sure Hw Attribute is set with NV.\r
    //\r
    return EFI_INVALID_PARAMETER;\r
  } else if ((Attributes & EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS) != 0) {\r
    //\r
    // Not support authentiated variable write yet.\r
    //\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  AcquireLockOnlyAtBootTime(&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
\r
  if((Attributes & EFI_VARIABLE_NON_VOLATILE) == 0) {\r
    //\r
    // Query is Volatile related.\r
    //\r
    VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.VolatileVariableBase);\r
  } else {\r
    //\r
    // Query is Non-Volatile related.\r
    //\r
    VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase);\r
  }\r
\r
  //\r
  // Now let's fill *MaximumVariableStorageSize *RemainingVariableStorageSize\r
  // with the storage size (excluding the storage header size).\r
  //\r
  *MaximumVariableStorageSize   = VariableStoreHeader->Size - sizeof (VARIABLE_STORE_HEADER);\r
\r
  //\r
  // Harware error record variable needs larger size.\r
  //\r
  if ((Attributes & (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) == (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {\r
    *MaximumVariableStorageSize = PcdGet32 (PcdHwErrStorageSize);\r
    *MaximumVariableSize = PcdGet32 (PcdMaxHardwareErrorVariableSize) - sizeof (VARIABLE_HEADER);\r
  } else {\r
    if ((Attributes & EFI_VARIABLE_NON_VOLATILE) != 0) {\r
      ASSERT (PcdGet32 (PcdHwErrStorageSize) < VariableStoreHeader->Size);\r
      *MaximumVariableStorageSize = VariableStoreHeader->Size - sizeof (VARIABLE_STORE_HEADER) - PcdGet32 (PcdHwErrStorageSize);\r
    }\r
\r
    //\r
    // Let *MaximumVariableSize be PcdGet32 (PcdMaxVariableSize) with the exception of the variable header size.\r
    //\r
    *MaximumVariableSize = PcdGet32 (PcdMaxVariableSize) - sizeof (VARIABLE_HEADER);\r
  }\r
\r
  //\r
  // Point to the starting address of the variables.\r
  //\r
  Variable = GetStartPointer (VariableStoreHeader);\r
\r
  //\r
  // Now walk through the related variable store.\r
  //\r
  while ((Variable < GetEndPointer (VariableStoreHeader)) && IsValidVariableHeader (Variable)) {\r
    NextVariable = GetNextVariablePtr (Variable);\r
    VariableSize = (UINT64) (UINTN) NextVariable - (UINT64) (UINTN) Variable;\r
\r
    if (EfiAtRuntime ()) {\r
      //\r
      // we don't take the state of the variables in mind\r
      // when calculating RemainingVariableStorageSize,\r
      // since the space occupied by variables not marked with\r
      // VAR_ADDED is not allowed to be reclaimed in Runtime.\r
      //\r
      if ((NextVariable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {\r
        HwErrVariableTotalSize += VariableSize;\r
      } else {\r
        CommonVariableTotalSize += VariableSize;\r
      }\r
    } else {\r
      //\r
      // Only care about Variables with State VAR_ADDED,because\r
      // the space not marked as VAR_ADDED is reclaimable now.\r
      //\r
      if (Variable->State == VAR_ADDED) {\r
        if ((NextVariable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {\r
          HwErrVariableTotalSize += VariableSize;\r
        } else {\r
          CommonVariableTotalSize += VariableSize;\r
        }\r
      }\r
    }\r
\r
    //\r
    // Go to the next one\r
    //\r
    Variable = NextVariable;\r
  }\r
\r
  if ((Attributes  & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD){\r
    *RemainingVariableStorageSize = *MaximumVariableStorageSize - HwErrVariableTotalSize;\r
  }else {\r
    *RemainingVariableStorageSize = *MaximumVariableStorageSize - CommonVariableTotalSize;\r
  }\r
\r
  if (*RemainingVariableStorageSize < sizeof (VARIABLE_HEADER)) {\r
    *MaximumVariableSize = 0;\r
  } else if ((*RemainingVariableStorageSize - sizeof (VARIABLE_HEADER)) < *MaximumVariableSize) {\r
    *MaximumVariableSize = *RemainingVariableStorageSize - sizeof (VARIABLE_HEADER);\r
  }\r
\r
  ReleaseLockOnlyAtBootTime (&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Notification function of EVT_GROUP_READY_TO_BOOT event group.\r
\r
  This is a notification function registered on EVT_GROUP_READY_TO_BOOT event group.\r
  When the Boot Manager is about to load and execute a boot option, it reclaims variable\r
  storage if free size is below the threshold.\r
\r
  @param  Event        Event whose notification function is being invoked\r
  @param  Context      Pointer to the notification function's context\r
\r
**/\r
VOID\r
EFIAPI\r
ReclaimForOS(\r
  EFI_EVENT  Event,\r
  VOID       *Context\r
  )\r
{\r
  EFI_STATUS                     Status;\r
  UINTN                          CommonVariableSpace;\r
  UINTN                          RemainingCommonVariableSpace;\r
  UINTN                          RemainingHwErrVariableSpace;\r
\r
  Status  = EFI_SUCCESS; \r
\r
  CommonVariableSpace = ((VARIABLE_STORE_HEADER *) ((UINTN) (mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase)))->Size - sizeof (VARIABLE_STORE_HEADER) - PcdGet32(PcdHwErrStorageSize); //Allowable max size of common variable storage space\r
\r
  RemainingCommonVariableSpace = CommonVariableSpace - mVariableModuleGlobal->CommonVariableTotalSize;\r
\r
  RemainingHwErrVariableSpace = PcdGet32 (PcdHwErrStorageSize) - mVariableModuleGlobal->HwErrVariableTotalSize;\r
  //\r
  // Check if the free area is blow a threshold.\r
  //\r
  if ((RemainingCommonVariableSpace < PcdGet32 (PcdMaxVariableSize))\r
    || ((PcdGet32 (PcdHwErrStorageSize) != 0) && \r
       (RemainingHwErrVariableSpace < PcdGet32 (PcdMaxHardwareErrorVariableSize)))){\r
    Status = Reclaim (\r
            mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase,\r
            &mVariableModuleGlobal->NonVolatileLastVariableOffset,\r
            FALSE,\r
            NULL\r
            );\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
}\r
\r
/**\r
  Initializes variable store area for non-volatile and volatile variable.\r
\r
  @param  FvbProtocol           Pointer to an instance of EFI Firmware Volume Block Protocol.\r
\r
  @retval EFI_SUCCESS           Function successfully executed.\r
  @retval EFI_OUT_OF_RESOURCES  Fail to allocate enough memory resource.\r
\r
**/\r
EFI_STATUS\r
VariableCommonInitialize (\r
  IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvbProtocol\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  VARIABLE_STORE_HEADER           *VolatileVariableStore;\r
  VARIABLE_STORE_HEADER           *VariableStoreHeader;\r
  VARIABLE_HEADER                 *NextVariable;\r
  EFI_PHYSICAL_ADDRESS            TempVariableStoreHeader;\r
  EFI_GCD_MEMORY_SPACE_DESCRIPTOR GcdDescriptor;\r
  EFI_PHYSICAL_ADDRESS            BaseAddress;\r
  UINT64                          Length;\r
  UINTN                           Index;\r
  UINT8                           Data;\r
  EFI_PHYSICAL_ADDRESS            VariableStoreBase;\r
  UINT64                          VariableStoreLength;\r
  EFI_EVENT                       ReadyToBootEvent;\r
  UINTN                           ScratchSize;\r
  UINTN                           VariableSize;\r
\r
  Status = EFI_SUCCESS;\r
  //\r
  // Allocate runtime memory for variable driver global structure.\r
  //\r
  mVariableModuleGlobal = AllocateRuntimeZeroPool (sizeof (VARIABLE_MODULE_GLOBAL));\r
  if (mVariableModuleGlobal == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  EfiInitializeLock(&mVariableModuleGlobal->VariableGlobal.VariableServicesLock, TPL_NOTIFY);\r
\r
  //\r
  // Note that in EdkII variable driver implementation, Hardware Error Record type variable\r
  // is stored with common variable in the same NV region. So the platform integrator should\r
  // ensure that the value of PcdHwErrStorageSize is less than or equal to the value of \r
  // PcdFlashNvStorageVariableSize.\r
  //\r
  ASSERT (PcdGet32 (PcdHwErrStorageSize) <= PcdGet32 (PcdFlashNvStorageVariableSize));\r
\r
  //\r
  // Allocate memory for volatile variable store, note that there is a scratch space to store scratch data.\r
  //\r
  ScratchSize = MAX (PcdGet32 (PcdMaxVariableSize), PcdGet32 (PcdMaxHardwareErrorVariableSize));\r
  VolatileVariableStore = AllocateRuntimePool (PcdGet32 (PcdVariableStoreSize) + ScratchSize);\r
  if (VolatileVariableStore == NULL) {\r
    FreePool (mVariableModuleGlobal);\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  SetMem (VolatileVariableStore, PcdGet32 (PcdVariableStoreSize) + ScratchSize, 0xff);\r
\r
  //\r
  //  Variable Specific Data\r
  //\r
  mVariableModuleGlobal->VariableGlobal.VolatileVariableBase = (EFI_PHYSICAL_ADDRESS) (UINTN) VolatileVariableStore;\r
  mVariableModuleGlobal->VolatileLastVariableOffset = (UINTN) GetStartPointer (VolatileVariableStore) - (UINTN) VolatileVariableStore;\r
  mVariableModuleGlobal->FvbInstance = FvbProtocol;\r
\r
  CopyGuid (&VolatileVariableStore->Signature, &gEfiVariableGuid);\r
  VolatileVariableStore->Size                       = PcdGet32 (PcdVariableStoreSize);\r
  VolatileVariableStore->Format                     = VARIABLE_STORE_FORMATTED;\r
  VolatileVariableStore->State                      = VARIABLE_STORE_HEALTHY;\r
  VolatileVariableStore->Reserved                   = 0;\r
  VolatileVariableStore->Reserved1                  = 0;\r
\r
  //\r
  // Get non volatile varaible store\r
  //\r
\r
  TempVariableStoreHeader = (EFI_PHYSICAL_ADDRESS) PcdGet64 (PcdFlashNvStorageVariableBase64);\r
  if (TempVariableStoreHeader == 0) {\r
    TempVariableStoreHeader = (EFI_PHYSICAL_ADDRESS) PcdGet32 (PcdFlashNvStorageVariableBase);\r
  }\r
  \r
  VariableStoreBase = TempVariableStoreHeader + \\r
                              (((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)(TempVariableStoreHeader)) -> HeaderLength);\r
  VariableStoreLength = (UINT64) PcdGet32 (PcdFlashNvStorageVariableSize) - \\r
                                (((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)(TempVariableStoreHeader)) -> HeaderLength);\r
  //\r
  // Mark the variable storage region of the FLASH as RUNTIME\r
  //\r
  BaseAddress = VariableStoreBase & (~EFI_PAGE_MASK);\r
  Length      = VariableStoreLength + (VariableStoreBase - BaseAddress);\r
  Length      = (Length + EFI_PAGE_SIZE - 1) & (~EFI_PAGE_MASK);\r
\r
  Status      = gDS->GetMemorySpaceDescriptor (BaseAddress, &GcdDescriptor);\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
\r
  Status = gDS->SetMemorySpaceAttributes (\r
                  BaseAddress,\r
                  Length,\r
                  GcdDescriptor.Attributes | EFI_MEMORY_RUNTIME\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
  //\r
  // Get address of non volatile variable store base\r
  //\r
  mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase = VariableStoreBase;\r
  VariableStoreHeader = (VARIABLE_STORE_HEADER *)(UINTN)VariableStoreBase;\r
  if (GetVariableStoreStatus (VariableStoreHeader) == EfiValid) {\r
    if (~VariableStoreHeader->Size == 0) {\r
      Status = UpdateVariableStore (\r
                &mVariableModuleGlobal->VariableGlobal,\r
                FALSE,\r
                FALSE,\r
                mVariableModuleGlobal->FvbInstance,\r
                (UINTN) &VariableStoreHeader->Size,\r
                sizeof (UINT32),\r
                (UINT8 *) &VariableStoreLength\r
                );\r
      //\r
      // As Variables are stored in NV storage, which are slow devices,such as flash.\r
      // Variable operation may skip checking variable program result to improve performance,\r
      // We can assume Variable program is OK through some check point.\r
      // Variable Store Size Setting should be the first Variable write operation,\r
      // We can assume all Read/Write is OK if we can set Variable store size successfully.\r
      // If write fail, we will assert here\r
      //\r
      ASSERT(VariableStoreHeader->Size == VariableStoreLength);\r
\r
      if (EFI_ERROR (Status)) {\r
        goto Done;\r
      }\r
    }\r
\r
    //\r
    // Parse non-volatile variable data and get last variable offset\r
    //\r
    NextVariable  = GetStartPointer ((VARIABLE_STORE_HEADER *)(UINTN)VariableStoreBase);\r
    Status        = EFI_SUCCESS;\r
\r
    while (IsValidVariableHeader (NextVariable)) {\r
      VariableSize = NextVariable->NameSize + NextVariable->DataSize + sizeof (VARIABLE_HEADER);\r
      if ((NextVariable->Attributes & (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) == (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {\r
        mVariableModuleGlobal->HwErrVariableTotalSize += HEADER_ALIGN (VariableSize);\r
      } else {\r
        mVariableModuleGlobal->CommonVariableTotalSize += HEADER_ALIGN (VariableSize);\r
      }\r
\r
      NextVariable = GetNextVariablePtr (NextVariable);\r
    }\r
\r
    mVariableModuleGlobal->NonVolatileLastVariableOffset = (UINTN) NextVariable - (UINTN) VariableStoreBase;\r
\r
    //\r
    // Check if the free area is really free.\r
    //\r
    for (Index = mVariableModuleGlobal->NonVolatileLastVariableOffset; Index < VariableStoreHeader->Size; Index++) {\r
      Data = ((UINT8 *) (UINTN) mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase)[Index];\r
      if (Data != 0xff) {\r
        //\r
        // There must be something wrong in variable store, do reclaim operation.\r
        //\r
        Status = Reclaim (\r
                  mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase,\r
                  &mVariableModuleGlobal->NonVolatileLastVariableOffset,\r
                  FALSE,\r
                  NULL\r
                  );\r
\r
        if (EFI_ERROR (Status)) {\r
          goto Done;\r
        }\r
\r
        break;\r
      }\r
    }\r
\r
    //\r
    // Register the event handling function to reclaim variable for OS usage.\r
    //\r
    Status = EfiCreateEventReadyToBootEx (\r
               TPL_NOTIFY, \r
               ReclaimForOS, \r
               NULL, \r
               &ReadyToBootEvent\r
               );\r
  } else {\r
    Status = EFI_VOLUME_CORRUPTED;\r
    DEBUG((EFI_D_INFO, "Variable Store header is corrupted\n"));\r
  }\r
\r
Done:\r
  if (EFI_ERROR (Status)) {\r
    FreePool (mVariableModuleGlobal);\r
    FreePool (VolatileVariableStore);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE\r
\r
  This is a notification function registered on EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.\r
  It convers pointer to new virtual address.\r
\r
  @param  Event        Event whose notification function is being invoked\r
  @param  Context      Pointer to the notification function's context\r
\r
**/\r
VOID\r
EFIAPI\r
VariableClassAddressChangeEvent (\r
  IN EFI_EVENT        Event,\r
  IN VOID             *Context\r
  )\r
{\r
  EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->GetBlockSize);\r
  EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->GetPhysicalAddress);\r
  EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->GetAttributes);\r
  EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->SetAttributes);\r
  EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->Read);\r
  EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->Write);\r
  EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->EraseBlocks);\r
  EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance);\r
  EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->PlatformLangCodes);\r
  EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->LangCodes);\r
  EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->PlatformLang);\r
  EfiConvertPointer (\r
    0x0,\r
    (VOID **) &mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase\r
    );\r
  EfiConvertPointer (\r
    0x0,\r
    (VOID **) &mVariableModuleGlobal->VariableGlobal.VolatileVariableBase\r
    );\r
  EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal);\r
}\r
\r
/**\r
  Firmware Volume Block Protocol notification event handler.\r
\r
  Discover NV Variable Store and install Variable Arch Protocol.\r
\r
  @param[in] Event    Event whose notification function is being invoked.\r
  @param[in] Context  Pointer to the notification function's context.\r
**/\r
VOID\r
EFIAPI\r
FvbNotificationEvent (\r
  IN  EFI_EVENT       Event,\r
  IN  VOID            *Context\r
  )\r
{\r
  EFI_STATUS                          Status;\r
  EFI_HANDLE                          *HandleBuffer;\r
  UINTN                               HandleCount;\r
  UINTN                               Index;\r
  EFI_PHYSICAL_ADDRESS                FvbBaseAddress;\r
  EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  *Fvb;\r
  EFI_FIRMWARE_VOLUME_HEADER          *FwVolHeader;\r
  EFI_FVB_ATTRIBUTES_2                Attributes;\r
  EFI_SYSTEM_TABLE                    *SystemTable;\r
  EFI_PHYSICAL_ADDRESS                NvStorageVariableBase;\r
\r
  SystemTable = (EFI_SYSTEM_TABLE *)Context;\r
  Fvb         = NULL;\r
  \r
  //\r
  // Locate all handles of Fvb protocol\r
  //\r
  Status = gBS->LocateHandleBuffer (\r
                  ByProtocol,\r
                  &gEfiFirmwareVolumeBlockProtocolGuid,\r
                  NULL,\r
                  &HandleCount,\r
                  &HandleBuffer\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return ;\r
  }\r
  \r
  //\r
  // Get the FVB to access variable store\r
  //\r
  for (Index = 0; Index < HandleCount; Index += 1, Status = EFI_NOT_FOUND, Fvb = NULL) {\r
    Status = gBS->HandleProtocol (\r
                    HandleBuffer[Index],\r
                    &gEfiFirmwareVolumeBlockProtocolGuid,\r
                    (VOID **) &Fvb\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      Status = EFI_NOT_FOUND;\r
      break;\r
    }\r
\r
    //\r
    // Ensure this FVB protocol supported Write operation.\r
    //\r
    Status = Fvb->GetAttributes (Fvb, &Attributes);\r
    if (EFI_ERROR (Status) || ((Attributes & EFI_FVB2_WRITE_STATUS) == 0)) {\r
      continue;     \r
    }\r
    //\r
    // Compare the address and select the right one\r
    //\r
    Status = Fvb->GetPhysicalAddress (Fvb, &FvbBaseAddress);\r
    if (EFI_ERROR (Status)) {\r
      continue;\r
    }\r
\r
    FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *) ((UINTN) FvbBaseAddress);\r
    NvStorageVariableBase = (EFI_PHYSICAL_ADDRESS) PcdGet64 (PcdFlashNvStorageVariableBase64);\r
    if (NvStorageVariableBase == 0) {\r
      NvStorageVariableBase = (EFI_PHYSICAL_ADDRESS) PcdGet32 (PcdFlashNvStorageVariableBase);\r
    }\r
    \r
    if ((NvStorageVariableBase >= FvbBaseAddress) && (NvStorageVariableBase < (FvbBaseAddress + FwVolHeader->FvLength))) {\r
      Status      = EFI_SUCCESS;\r
      break;\r
    }\r
  }\r
\r
  FreePool (HandleBuffer);\r
  if (!EFI_ERROR (Status) && Fvb != NULL) {\r
    //\r
    // Close the notify event to avoid install gEfiVariableArchProtocolGuid & gEfiVariableWriteArchProtocolGuid again.\r
    //\r
    Status = gBS->CloseEvent (Event);	\r
    ASSERT_EFI_ERROR (Status);\r
\r
    Status = VariableCommonInitialize (Fvb);\r
    ASSERT_EFI_ERROR (Status);\r
  \r
    SystemTable->RuntimeServices->GetVariable         = RuntimeServiceGetVariable;\r
    SystemTable->RuntimeServices->GetNextVariableName = RuntimeServiceGetNextVariableName;\r
    SystemTable->RuntimeServices->SetVariable         = RuntimeServiceSetVariable;\r
    SystemTable->RuntimeServices->QueryVariableInfo   = RuntimeServiceQueryVariableInfo;\r
  \r
    //\r
    // Now install the Variable Runtime Architectural Protocol on a new handle\r
    //\r
    Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &mHandle,\r
                  &gEfiVariableArchProtocolGuid, NULL,\r
                  &gEfiVariableWriteArchProtocolGuid, NULL,\r
                  NULL\r
                  );\r
    ASSERT_EFI_ERROR (Status);\r
  \r
    Status = gBS->CreateEventEx (\r
                  EVT_NOTIFY_SIGNAL,\r
                  TPL_NOTIFY,\r
                  VariableClassAddressChangeEvent,\r
                  NULL,\r
                  &gEfiEventVirtualAddressChangeGuid,\r
                  &mVirtualAddressChangeEvent\r
                  );\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
\r
}\r
\r
/**\r
  Variable Driver main entry point. The Variable driver places the 4 EFI\r
  runtime services in the EFI System Table and installs arch protocols \r
  for variable read and write services being availible. It also registers\r
  notification function for EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.\r
\r
  @param[in] ImageHandle    The firmware allocated handle for the EFI image.  \r
  @param[in] SystemTable    A pointer to the EFI System Table.\r
  \r
  @retval EFI_SUCCESS       Variable service successfully initialized.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
VariableServiceInitialize (\r
  IN EFI_HANDLE         ImageHandle,\r
  IN EFI_SYSTEM_TABLE   *SystemTable\r
  )\r
{\r
  //\r
  // Register FvbNotificationEvent () notify function.\r
  // \r
  EfiCreateProtocolNotifyEvent (\r
    &gEfiFirmwareVolumeBlockProtocolGuid,\r
    TPL_CALLBACK,\r
    FvbNotificationEvent,\r
    (VOID *)SystemTable,\r
    &mFvbRegistration\r
    );\r
\r
  return EFI_SUCCESS;\r
}\r
\r