[mirror_edk2.git] / EdkCompatibilityPkg / Compatibility / FrameworkHiiToUefiHiiThunk / UefiIfrDefault.c

/** @file\r
  Function and Macro defintions for to extract default values from UEFI Form package.\r
\r
  Copyright (c) 2008, Intel Corporation\r
  All rights reserved. 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
\r
#include <FrameworkDxe.h>\r
\r
#include <Protocol/FrameworkHii.h>\r
#include <Protocol/HiiDatabase.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
\r
#include "UefiIfrParser.h"\r
#include "UefiIfrDefault.h"\r
\r
//\r
// Extern Variables\r
//\r
extern CONST EFI_HII_DATABASE_PROTOCOL            *mHiiDatabase;\r
extern CONST EFI_HII_IMAGE_PROTOCOL               *mHiiImageProtocol;\r
extern CONST EFI_HII_STRING_PROTOCOL              *mHiiStringProtocol;\r
extern CONST EFI_HII_CONFIG_ROUTING_PROTOCOL      *mHiiConfigRoutingProtocol;\r
\r
extern EFI_GUID          gZeroGuid;\r
\r
/**\r
  Fetch the Ifr binary data of a FormSet.\r
\r
  @param  Handle                 PackageList Handle\r
  @param  FormSetGuid            GUID of a formset. If not specified (NULL or zero\r
                                 GUID), take the first FormSet found in package\r
                                 list.\r
  @param  BinaryLength           The length of the FormSet IFR binary.\r
  @param  BinaryData             The buffer designed to receive the FormSet.\r
\r
  @retval EFI_SUCCESS            Buffer filled with the requested FormSet.\r
                                 BufferLength was updated.\r
  @retval EFI_INVALID_PARAMETER  The handle is unknown.\r
  @retval EFI_NOT_FOUND          A form or FormSet on the requested handle cannot\r
                                 be found with the requested FormId.\r
\r
**/\r
EFI_STATUS\r
GetIfrBinaryData (\r
  IN  EFI_HII_HANDLE   Handle,\r
  IN OUT EFI_GUID      *FormSetGuid,\r
  OUT UINTN            *BinaryLength,\r
  OUT UINT8            **BinaryData\r
  )\r
{\r
  EFI_STATUS                   Status;\r
  EFI_HII_PACKAGE_LIST_HEADER  *HiiPackageList;\r
  UINTN                        BufferSize;\r
  UINT8                        *Package;\r
  UINT8                        *OpCodeData;\r
  UINT32                       Offset;\r
  UINT32                       Offset2;\r
  BOOLEAN                      ReturnDefault;\r
  UINT32                       PackageListLength;\r
  EFI_HII_PACKAGE_HEADER       PackageHeader;\r
\r
  OpCodeData = NULL;\r
  Package = NULL;\r
  ZeroMem (&PackageHeader, sizeof (EFI_HII_PACKAGE_HEADER));;\r
\r
  //\r
  // if FormSetGuid is NULL or zero GUID, return first FormSet in the package list\r
  //\r
  if (FormSetGuid == NULL || CompareGuid (FormSetGuid, &gZeroGuid)) {\r
    ReturnDefault = TRUE;\r
  } else {\r
    ReturnDefault = FALSE;\r
  }\r
\r
  //\r
  // Get HII PackageList\r
  //\r
  BufferSize = 0;\r
  HiiPackageList = NULL;\r
  Status = mHiiDatabase->ExportPackageLists (mHiiDatabase, Handle, &BufferSize, HiiPackageList);\r
  if (Status == EFI_BUFFER_TOO_SMALL) {\r
    HiiPackageList = AllocatePool (BufferSize);\r
    ASSERT (HiiPackageList != NULL);\r
\r
    Status = mHiiDatabase->ExportPackageLists (mHiiDatabase, Handle, &BufferSize, HiiPackageList);\r
  }\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Get Form package from this HII package List\r
  //\r
  Offset = sizeof (EFI_HII_PACKAGE_LIST_HEADER);\r
  Offset2 = 0;\r
  CopyMem (&PackageListLength, &HiiPackageList->PackageLength, sizeof (UINT32));\r
\r
  while (Offset < PackageListLength) {\r
    Package = ((UINT8 *) HiiPackageList) + Offset;\r
    CopyMem (&PackageHeader, Package, sizeof (EFI_HII_PACKAGE_HEADER));\r
\r
    if (PackageHeader.Type == EFI_HII_PACKAGE_FORM) {\r
      //\r
      // Search FormSet in this Form Package\r
      //\r
      Offset2 = sizeof (EFI_HII_PACKAGE_HEADER);\r
      while (Offset2 < PackageHeader.Length) {\r
        OpCodeData = Package + Offset2;\r
\r
        if (((EFI_IFR_OP_HEADER *) OpCodeData)->OpCode == EFI_IFR_FORM_SET_OP) {\r
          //\r
          // Check whether return default FormSet\r
          //\r
          if (ReturnDefault) {\r
            break;\r
          }\r
\r
          //\r
          // FormSet GUID is specified, check it\r
          //\r
          if (CompareGuid (FormSetGuid, (EFI_GUID *)(OpCodeData + sizeof (EFI_IFR_OP_HEADER)))) {\r
            break;\r
          }\r
        }\r
\r
        Offset2 += ((EFI_IFR_OP_HEADER *) OpCodeData)->Length;\r
      }\r
\r
      if (Offset2 < PackageHeader.Length) {\r
        //\r
        // Target formset found\r
        //\r
        break;\r
      }\r
    }\r
\r
    Offset += PackageHeader.Length;\r
  }\r
\r
  if (Offset >= PackageListLength) {\r
    //\r
    // Form package not found in this Package List\r
    //\r
    gBS->FreePool (HiiPackageList);\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  if (ReturnDefault && FormSetGuid != NULL) {\r
    //\r
    // Return the default FormSet GUID\r
    //\r
    CopyMem (FormSetGuid, &((EFI_IFR_FORM_SET *) OpCodeData)->Guid, sizeof (EFI_GUID));\r
  }\r
\r
  //\r
  // To determine the length of a whole FormSet IFR binary, one have to parse all the Opcodes\r
  // in this FormSet; So, here just simply copy the data from start of a FormSet to the end\r
  // of the Form Package.\r
  //\r
  *BinaryLength = PackageHeader.Length - Offset2;\r
  *BinaryData = AllocateCopyPool (*BinaryLength, OpCodeData);\r
\r
  gBS->FreePool (HiiPackageList);\r
\r
  if (*BinaryData == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Initialize the internal data structure of a FormSet.\r
\r
  @param  Handle                 PackageList Handle\r
  @param  FormSetGuid            GUID of a formset. If not specified (NULL or zero\r
                                 GUID), take the first FormSet found in package\r
                                 list.\r
  @param  FormSet                FormSet data structure.\r
\r
  @retval EFI_SUCCESS            The function completed successfully.\r
  @retval EFI_NOT_FOUND          The specified FormSet could not be found.\r
\r
**/\r
EFI_STATUS\r
InitializeFormSet (\r
  IN  EFI_HII_HANDLE                   Handle,\r
  IN OUT EFI_GUID                      *FormSetGuid,\r
  OUT FORM_BROWSER_FORMSET             *FormSet\r
  )\r
{\r
  EFI_STATUS                Status;\r
  EFI_HANDLE                DriverHandle;\r
\r
  Status = GetIfrBinaryData (Handle, FormSetGuid, &FormSet->IfrBinaryLength, &FormSet->IfrBinaryData);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  FormSet->HiiHandle = Handle;\r
  CopyMem (&FormSet->Guid, FormSetGuid, sizeof (EFI_GUID));\r
\r
  //\r
  // Retrieve ConfigAccess Protocol associated with this HiiPackageList\r
  //\r
  Status = mHiiDatabase->GetPackageListHandle (mHiiDatabase, Handle, &DriverHandle);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  FormSet->DriverHandle = DriverHandle;\r
  Status = gBS->HandleProtocol (\r
                  DriverHandle,\r
                  &gEfiHiiConfigAccessProtocolGuid,\r
                  (VOID **) &FormSet->ConfigAccess\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Configuration Driver don't attach ConfigAccess protocol to its HII package\r
    // list, then there will be no configuration action required\r
    //\r
    FormSet->ConfigAccess = NULL;\r
  }\r
\r
  //\r
  // Parse the IFR binary OpCodes\r
  //\r
  Status = ParseOpCodes (FormSet);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  return Status;\r
}\r
\r
/**\r
  Set the data position at Offset with Width in Node->Buffer based \r
  the value passed in.\r
\r
  @param  Node                    The Buffer Storage Node.\r
  @param Value                    The input value.\r
  @param Offset                   The offset in Node->Buffer for the update.\r
  @param Width                    The length of the Value.\r
  \r
  @retval VOID\r
\r
**/\r
VOID\r
SetNodeBuffer (\r
  OUT UEFI_IFR_BUFFER_STORAGE_NODE        *Node,\r
  IN  CONST   EFI_HII_VALUE               *Value,\r
  IN  UINTN                               Offset,\r
  IN  UINTN                               Width\r
  )\r
{\r
  ASSERT (Node->Signature == UEFI_IFR_BUFFER_STORAGE_NODE_SIGNATURE);\r
  ASSERT (Offset + Width <= Node->Size);\r
\r
  CopyMem (Node->Buffer + Offset, &Value->Value.u8, Width);\r
}\r
\r
\r
/**\r
  Reset Question to its default value.\r
\r
  @param  FormSet                FormSet data structure.\r
  @param  DefaultId              The Class of the default.\r
\r
  @retval EFI_SUCCESS            Question is reset to default value.\r
\r
**/\r
EFI_STATUS\r
GetQuestionDefault (\r
  IN FORM_BROWSER_FORMSET             *FormSet,\r
  IN FORM_BROWSER_FORM                *Form,\r
  IN FORM_BROWSER_STATEMENT           *Question,\r
  IN UINT16                           DefaultId,\r
  IN UINT16                           VarStoreId,\r
  OUT UEFI_IFR_BUFFER_STORAGE_NODE        *Node\r
  )\r
{\r
  EFI_STATUS              Status;\r
  LIST_ENTRY              *Link;\r
  QUESTION_DEFAULT        *Default;\r
  QUESTION_OPTION         *Option;\r
  EFI_HII_VALUE           *HiiValue;\r
\r
  Status = EFI_SUCCESS;\r
\r
  //\r
  // Statement don't have storage, skip them\r
  //\r
  if (Question->QuestionId == 0) {\r
    return Status;\r
  }\r
\r
  if (Question->VarStoreId != VarStoreId) {\r
    return Status;\r
  }\r
\r
  ASSERT (Question->Storage->Type == EFI_HII_VARSTORE_BUFFER);\r
\r
  //\r
  // There are three ways to specify default value for a Question:\r
  //  1, use nested EFI_IFR_DEFAULT (highest priority)\r
  //  2, set flags of EFI_ONE_OF_OPTION (provide Standard and Manufacturing default)\r
  //  3, set flags of EFI_IFR_CHECKBOX (provide Standard and Manufacturing default) (lowest priority)\r
  //\r
  HiiValue = &Question->HiiValue;\r
\r
  //\r
  // EFI_IFR_DEFAULT has highest priority\r
  //\r
  if (!IsListEmpty (&Question->DefaultListHead)) {\r
    Link = GetFirstNode (&Question->DefaultListHead);\r
    while (!IsNull (&Question->DefaultListHead, Link)) {\r
      Default = QUESTION_DEFAULT_FROM_LINK (Link);\r
\r
      if (Default->DefaultId == DefaultId) {\r
        if (Default->ValueExpression != NULL) {\r
          //\r
          // Default is provided by an Expression, evaluate it\r
          //\r
          Status = EvaluateExpression (FormSet, Form, Default->ValueExpression);\r
          if (EFI_ERROR (Status)) {\r
            return Status;\r
          }\r
\r
          CopyMem (HiiValue, &Default->ValueExpression->Result, sizeof (EFI_HII_VALUE));\r
        } else {\r
          //\r
          // Default value is embedded in EFI_IFR_DEFAULT\r
          //\r
          CopyMem (HiiValue, &Default->Value, sizeof (EFI_HII_VALUE));\r
        }\r
       \r
        SetNodeBuffer (Node, HiiValue, Question->VarStoreInfo.VarOffset, Question->StorageWidth);\r
        return EFI_SUCCESS;\r
      }\r
\r
      Link = GetNextNode (&Question->DefaultListHead, Link);\r
    }\r
  }\r
\r
  //\r
  // EFI_ONE_OF_OPTION\r
  //\r
  if ((Question->Operand == EFI_IFR_ONE_OF_OP) && !IsListEmpty (&Question->OptionListHead)) {\r
    if (DefaultId <= EFI_HII_DEFAULT_CLASS_MANUFACTURING)  {\r
      //\r
      // OneOfOption could only provide Standard and Manufacturing default\r
      //\r
      Link = GetFirstNode (&Question->OptionListHead);\r
      while (!IsNull (&Question->OptionListHead, Link)) {\r
        Option = QUESTION_OPTION_FROM_LINK (Link);\r
\r
        if (((DefaultId == EFI_HII_DEFAULT_CLASS_STANDARD) && (Option->Flags & EFI_IFR_OPTION_DEFAULT)) ||\r
            ((DefaultId == EFI_HII_DEFAULT_CLASS_MANUFACTURING) && (Option->Flags & EFI_IFR_OPTION_DEFAULT_MFG))\r
           ) {\r
          CopyMem (HiiValue, &Option->Value, sizeof (EFI_HII_VALUE));\r
\r
          SetNodeBuffer (Node, HiiValue, Question->VarStoreInfo.VarOffset, Question->StorageWidth);\r
          return EFI_SUCCESS;\r
        }\r
\r
        Link = GetNextNode (&Question->OptionListHead, Link);\r
      }\r
    }\r
  }\r
\r
  //\r
  // EFI_IFR_CHECKBOX - lowest priority\r
  //\r
  if (Question->Operand == EFI_IFR_CHECKBOX_OP) {\r
    if (DefaultId <= EFI_HII_DEFAULT_CLASS_MANUFACTURING)  {\r
      //\r
      // Checkbox could only provide Standard and Manufacturing default\r
      //\r
      if (((DefaultId == EFI_HII_DEFAULT_CLASS_STANDARD) && (Question->Flags & EFI_IFR_CHECKBOX_DEFAULT)) ||\r
          ((DefaultId == EFI_HII_DEFAULT_CLASS_MANUFACTURING) && (Question->Flags & EFI_IFR_CHECKBOX_DEFAULT_MFG))\r
         ) {\r
        HiiValue->Value.b = TRUE;\r
      } else {\r
        HiiValue->Value.b = FALSE;\r
      }\r
\r
      SetNodeBuffer (Node, HiiValue, Question->VarStoreInfo.VarOffset, Question->StorageWidth);\r
      return EFI_SUCCESS;\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Reset Questions in a Form to their default value.\r
\r
  @param  FormSet                FormSet data structure.\r
  @param  Form                   The Form which to be reset.\r
  @param  DefaultId              The Class of the default.\r
\r
  @retval EFI_SUCCESS            The function completed successfully.\r
\r
**/\r
EFI_STATUS\r
ExtractFormDefault (\r
  IN FORM_BROWSER_FORMSET             *FormSet,\r
  IN FORM_BROWSER_FORM                *Form,\r
  IN UINT16                           DefaultId,\r
  IN UINT16                           VarStoreId,\r
  OUT UEFI_IFR_BUFFER_STORAGE_NODE        *Node\r
  )\r
{\r
  EFI_STATUS              Status;\r
  LIST_ENTRY              *Link;\r
  FORM_BROWSER_STATEMENT  *Question;\r
\r
  Link = GetFirstNode (&Form->StatementListHead);\r
  while (!IsNull (&Form->StatementListHead, Link)) {\r
    Question = FORM_BROWSER_STATEMENT_FROM_LINK (Link);\r
    //\r
    // Reset Question to its default value\r
    //\r
    Status = GetQuestionDefault (FormSet, Form, Question, DefaultId, VarStoreId, Node);\r
    if (EFI_ERROR (Status)) {\r
      continue;\r
    }\r
\r
    Link = GetNextNode (&Form->StatementListHead, Link);\r
  }\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Destroy all the buffer allocated for the fileds of\r
  UEFI_IFR_BUFFER_STORAGE_NODE. The Node itself\r
  will be freed too.\r
\r
  @param  FormSet                FormSet data structure.\r
  @param  DefaultId              The Class of the default.\r
\r
  @retval   VOID\r
\r
**/\r
VOID\r
DestroyDefaultNode (\r
  IN UEFI_IFR_BUFFER_STORAGE_NODE        *Node\r
  )\r
{\r
  SafeFreePool (Node->Buffer);\r
  SafeFreePool (Node->Name);\r
  SafeFreePool (Node);\r
}\r
\r
\r
/**\r
  Get the default value for Buffer Type storage named by\r
  a Default Store and a Storage Store from a FormSet.\r
  The result is in the a instance of UEFI_IFR_BUFFER_STORAGE_NODE\r
  allocated by this function. It is inserted to the link list.\r
  \r
  @param  DefaultStore            The Default Store.\r
  @param  Storage                   The Storage.\r
  @param  FormSet                  The Form Set.\r
  @param  UefiDefaultsListHead The head of link list for the output.\r
\r
  @retval   EFI_SUCCESS          Successful.\r
  \r
**/\r
EFI_STATUS\r
GetBufferTypeDefaultIdAndStorageId (\r
  IN        FORMSET_DEFAULTSTORE        *DefaultStore,\r
  IN        FORMSET_STORAGE             *Storage,\r
  IN        FORM_BROWSER_FORMSET        *FormSet,\r
  OUT       LIST_ENTRY                  *UefiDefaultsListHead\r
 )\r
{\r
  UEFI_IFR_BUFFER_STORAGE_NODE        *Node;\r
  LIST_ENTRY              *Link;\r
  FORM_BROWSER_FORM       *Form;\r
  EFI_STATUS              Status;\r
\r
  Node = AllocateZeroPool (sizeof (UEFI_IFR_BUFFER_STORAGE_NODE));\r
  ASSERT (Node != NULL);\r
\r
  Node->Signature = UEFI_IFR_BUFFER_STORAGE_NODE_SIGNATURE;\r
  Node->Name      = AllocateCopyPool (StrSize (Storage->Name), Storage->Name);\r
  Node->DefaultId = DefaultStore->DefaultId;\r
  Node->StoreId   = Storage->VarStoreId;\r
  CopyGuid (&Node->Guid, &Storage->Guid);\r
  Node->Size      = Storage->Size;\r
  Node->Buffer    = AllocateZeroPool (Node->Size);\r
  //\r
  // Extract default from IFR binary\r
  //\r
  Link = GetFirstNode (&FormSet->FormListHead);\r
  while (!IsNull (&FormSet->FormListHead, Link)) {\r
    Form = FORM_BROWSER_FORM_FROM_LINK (Link);\r
\r
    Status = ExtractFormDefault (FormSet, Form, DefaultStore->DefaultId, Storage->VarStoreId, Node);\r
    ASSERT_EFI_ERROR (Status);\r
\r
    Link = GetNextNode (&FormSet->FormListHead, Link);\r
  }\r
\r
  InsertTailList (UefiDefaultsListHead, &Node->List);\r
  \r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Get the default value for Buffer Type storage named by\r
  a Default Store from a FormSet.\r
  The result is in the a instance of UEFI_IFR_BUFFER_STORAGE_NODE\r
  allocated by this function. The output can be multiple instances\r
  of UEFI_IFR_BUFFER_STORAGE_NODE. It is inserted to the link list.\r
  \r
  @param  DefaultStore            The Default Store.\r
  @param  FormSet                  The Form Set.\r
  @param  UefiDefaultsListHead The head of link list for the output.\r
\r
  @retval   EFI_SUCCESS          Successful.\r
  \r
**/\r
EFI_STATUS\r
GetBufferTypeDefaultId (\r
  IN  FORMSET_DEFAULTSTORE  *DefaultStore,\r
  IN  FORM_BROWSER_FORMSET  *FormSet,\r
  OUT       LIST_ENTRY      *UefiDefaultsListHead\r
  )\r
{\r
  LIST_ENTRY                  *StorageLink;\r
  FORMSET_STORAGE             *Storage;\r
  EFI_STATUS                  Status;\r
\r
  StorageLink = GetFirstNode (&FormSet->StorageListHead);\r
\r
  while (!IsNull (&FormSet->StorageListHead, StorageLink)) {\r
    Storage = FORMSET_STORAGE_FROM_LINK(StorageLink);\r
\r
    if (Storage->Type == EFI_HII_VARSTORE_BUFFER) {\r
      Status = GetBufferTypeDefaultIdAndStorageId (DefaultStore, Storage, FormSet, UefiDefaultsListHead);\r
    }\r
\r
    StorageLink = GetNextNode (&FormSet->StorageListHead, StorageLink);\r
  }\r
  \r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Get the default value for Buffer Type storage from the first FormSet\r
  in the Package List specified by a EFI_HII_HANDLE.\r
  \r
  The results can be multiple instances of UEFI_IFR_BUFFER_STORAGE_NODE. \r
  They are inserted to the link list.\r
  \r
  @param  UefiHiiHandle           The handle for the package list.\r
  @param  UefiDefaultsListHead The head of link list for the output.\r
\r
  @retval   EFI_SUCCESS          Successful.\r
  \r
**/\r
EFI_STATUS\r
UefiIfrGetBufferTypeDefaults (\r
  IN  EFI_HII_HANDLE      UefiHiiHandle,\r
  OUT LIST_ENTRY          **UefiDefaults\r
  )\r
{\r
  FORM_BROWSER_FORMSET *FormSet;\r
  EFI_GUID              FormSetGuid;\r
  LIST_ENTRY            *DefaultLink;\r
  FORMSET_DEFAULTSTORE  *DefaultStore;\r
  EFI_STATUS            Status;\r
\r
  ASSERT (UefiDefaults != NULL);\r
\r
  FormSet = AllocateZeroPool (sizeof (FORM_BROWSER_FORMSET));    \r
  ASSERT (FormSet != NULL);\r
\r
  CopyGuid (&FormSetGuid, &gZeroGuid);\r
  Status = InitializeFormSet (UefiHiiHandle, &FormSetGuid, FormSet);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  *UefiDefaults = AllocateZeroPool (sizeof (LIST_ENTRY));\r
  ASSERT (UefiDefaults != NULL);\r
  InitializeListHead (*UefiDefaults);\r
\r
  DefaultLink = GetFirstNode (&FormSet->DefaultStoreListHead);\r
  while (!IsNull (&FormSet->DefaultStoreListHead, DefaultLink)) {\r
    DefaultStore = FORMSET_DEFAULTSTORE_FROM_LINK(DefaultLink);\r
\r
    Status = GetBufferTypeDefaultId (DefaultStore, FormSet, *UefiDefaults);\r
    ASSERT_EFI_ERROR (Status);\r
\r
    DefaultLink = GetNextNode (&FormSet->DefaultStoreListHead, DefaultLink);    \r
  }\r
\r
  DestroyFormSet (FormSet);\r
  \r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Convert the UEFI Buffer Type default values to a Framework HII default\r
  values specified by a EFI_HII_VARIABLE_PACK_LIST structure.\r
  \r
  @param  ListHead                  The link list of UEFI_IFR_BUFFER_STORAGE_NODE\r
                                              which contains the default values retrived from\r
                                              a UEFI form set.\r
  @param  DefaultMask            The default mask.\r
                                             The valid values are FRAMEWORK_EFI_IFR_FLAG_DEFAULT\r
                                             and FRAMEWORK_EFI_IFR_FLAG_MANUFACTURING.\r
                                            UEFI spec only map FRAMEWORK_EFI_IFR_FLAG_DEFAULT and FRAMEWORK_EFI_IFR_FLAG_MANUFACTURING \r
                                            from specification to valid default class.\r
  @param  VariablePackList     The output default value in a format defined in Framework.\r
                                             \r
\r
  @retval   EFI_SUCCESS                       Successful.\r
  @retval   EFI_INVALID_PARAMETER      The default mask is not FRAMEWORK_EFI_IFR_FLAG_DEFAULT or \r
                                                           FRAMEWORK_EFI_IFR_FLAG_MANUFACTURING.\r
**/\r
EFI_STATUS\r
UefiDefaultsToFwDefaults (\r
  IN     LIST_ENTRY                  *ListHead,\r
  IN     UINTN                       DefaultMask,\r
  OUT    EFI_HII_VARIABLE_PACK_LIST  **VariablePackList\r
  )\r
{\r
  LIST_ENTRY                        *List;\r
  UEFI_IFR_BUFFER_STORAGE_NODE      *Node;\r
  UINTN                             Size;\r
  UINTN                             Count;\r
  UINT16                            DefaultId;\r
  EFI_HII_VARIABLE_PACK             *Pack;\r
  EFI_HII_VARIABLE_PACK_LIST        *PackList;\r
\r
  if (DefaultMask == FRAMEWORK_EFI_IFR_FLAG_DEFAULT) {\r
    DefaultId = EFI_HII_DEFAULT_CLASS_STANDARD;\r
  } else if (DefaultMask == FRAMEWORK_EFI_IFR_FLAG_MANUFACTURING) {\r
    DefaultId = EFI_HII_DEFAULT_CLASS_MANUFACTURING;\r
  } else {\r
    //\r
    // UEFI spec only map FRAMEWORK_EFI_IFR_FLAG_DEFAULT and FRAMEWORK_EFI_IFR_FLAG_MANUFACTURING \r
    // from specification to valid default class.\r
    //\r
    ASSERT (FALSE);\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  \r
  //\r
  // Calculate the size of the output EFI_HII_VARIABLE_PACK_LIST structure\r
  //\r
  Size = 0;\r
  Count = 0;\r
  List = GetFirstNode (ListHead);\r
  while (!IsNull (ListHead, List)) {\r
    Node = UEFI_IFR_BUFFER_STORAGE_NODE_FROM_LIST(List);\r
\r
    if (Node->DefaultId == DefaultId) {\r
      Size += Node->Size;\r
      Size += StrSize (Node->Name);\r
\r
      Count++;\r
    }\r
    \r
    List = GetNextNode (ListHead, List);  \r
  }\r
\r
  Size = Size + Count * (sizeof (EFI_HII_VARIABLE_PACK_LIST) + sizeof (EFI_HII_VARIABLE_PACK));\r
  \r
  *VariablePackList = AllocateZeroPool (Size);\r
  ASSERT (*VariablePackList != NULL);\r
\r
  List = GetFirstNode (ListHead);\r
\r
  PackList = (EFI_HII_VARIABLE_PACK_LIST *) *VariablePackList;\r
  Pack     = (EFI_HII_VARIABLE_PACK *) (PackList + 1);\r
  while (!IsNull (ListHead, List)) {\r
    Node = UEFI_IFR_BUFFER_STORAGE_NODE_FROM_LIST(List);\r
\r
    Size = 0;    \r
    if (Node->DefaultId == DefaultId) {\r
      Size += Node->Size;\r
      Size += StrSize (Node->Name);\r
      Size += sizeof (EFI_HII_VARIABLE_PACK);      \r
\r
      //\r
      // In UEFI, 0 is defined to be invalid for EFI_IFR_VARSTORE.VarStoreId.\r
      // So the default storage of Var Store in VFR from a Framework module \r
      // should be translated to 0xFFEE.\r
      //\r
      if (Node->StoreId == RESERVED_VARSTORE_ID) {\r
        Pack->VariableId = 0;\r
      } else {\r
        Pack->VariableId = Node->StoreId;\r
      }\r
      //\r
      // Initialize EFI_HII_VARIABLE_PACK\r
      //\r
      Pack->Header.Type   = 0;\r
      Pack->Header.Length = (UINT32) Size;\r
      Pack->VariableNameLength = (UINT32) StrSize (Node->Name);\r
      CopyMem (&Pack->VariableGuid, &Node->Guid, sizeof (EFI_GUID));\r
      \r
      CopyMem ((UINT8 *) Pack + sizeof (EFI_HII_VARIABLE_PACK), Node->Name, StrSize (Node->Name));\r
      CopyMem ((UINT8 *) Pack + sizeof (EFI_HII_VARIABLE_PACK) + Pack->VariableNameLength, Node->Buffer, Node->Size);\r
\r
      Size += sizeof (EFI_HII_VARIABLE_PACK_LIST);\r
\r
      //\r
      // initialize EFI_HII_VARIABLE_PACK_LIST\r
      //\r
      PackList->VariablePack = Pack;\r
      PackList->NextVariablePack = (EFI_HII_VARIABLE_PACK_LIST *)((UINT8 *) PackList + Size);\r
            \r
    }\r
    \r
    List = GetNextNode (ListHead, List);  \r
  }\r
  \r
  \r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Free up all buffer allocated for the link list of UEFI_IFR_BUFFER_STORAGE_NODE.\r
    \r
  @param  ListHead                  The link list of UEFI_IFR_BUFFER_STORAGE_NODE\r
                                              which contains the default values retrived from\r
                                              a UEFI form set.\r
                                             \r
\r
  @retval   VOID\r
**/\r
VOID\r
FreeDefaultList (\r
  IN     LIST_ENTRY                  *ListHead\r
  )\r
{\r
  LIST_ENTRY *Link;\r
  UEFI_IFR_BUFFER_STORAGE_NODE *Default;\r
\r
  Link = GetFirstNode (ListHead);\r
  \r
  while (!IsNull (ListHead, Link)) {\r
    Default = UEFI_IFR_BUFFER_STORAGE_NODE_FROM_LIST(Link);\r
\r
    RemoveEntryList (Link);\r
   \r
    DestroyDefaultNode (Default);\r
    \r
    Link = GetNextNode (ListHead, Link);\r
  }\r
\r
  FreePool (ListHead);\r
}\r
\r