[mirror_edk2.git] / MdeModulePkg / Application / UiApp / BootMaint / BootMaint.c

/** @file\r
  The functions for Boot Maintainence Main menu.\r
\r
Copyright (c) 2015, 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 "BootMaint.h"\r
\r
EFI_DEVICE_PATH_PROTOCOL  EndDevicePath[] = {\r
  {\r
    END_DEVICE_PATH_TYPE,\r
    END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
    {\r
      END_DEVICE_PATH_LENGTH,\r
      0\r
    }\r
  }\r
};\r
\r
HII_VENDOR_DEVICE_PATH  mBmmHiiVendorDevicePath = {\r
  {\r
    {\r
      HARDWARE_DEVICE_PATH,\r
      HW_VENDOR_DP,\r
      {\r
        (UINT8) (sizeof (VENDOR_DEVICE_PATH)),\r
        (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)\r
      }\r
    },\r
    //\r
    // {165A028F-0BB2-4b5f-8747-77592E3F6499}\r
    //\r
    { 0x165a028f, 0xbb2, 0x4b5f, { 0x87, 0x47, 0x77, 0x59, 0x2e, 0x3f, 0x64, 0x99 } }\r
  },\r
  {\r
    END_DEVICE_PATH_TYPE,\r
    END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
    { \r
      (UINT8) (END_DEVICE_PATH_LENGTH),\r
      (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)\r
    }\r
  }\r
};\r
\r
HII_VENDOR_DEVICE_PATH  mFeHiiVendorDevicePath = {\r
  {\r
    {\r
      HARDWARE_DEVICE_PATH,\r
      HW_VENDOR_DP,\r
      {\r
        (UINT8) (sizeof (VENDOR_DEVICE_PATH)),\r
        (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)\r
      }\r
    },\r
    //\r
    // {91DB4238-B0C8-472e-BBCF-F3A6541010F4}\r
    //\r
    { 0x91db4238, 0xb0c8, 0x472e, { 0xbb, 0xcf, 0xf3, 0xa6, 0x54, 0x10, 0x10, 0xf4 } }\r
  },\r
  {\r
    END_DEVICE_PATH_TYPE,\r
    END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
    { \r
      (UINT8) (END_DEVICE_PATH_LENGTH),\r
      (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)\r
    }\r
  }\r
};\r
\r
EFI_GUID mBootMaintGuid          = BOOT_MAINT_FORMSET_GUID;\r
EFI_GUID mFileExplorerGuid       = FILE_EXPLORE_FORMSET_GUID;\r
\r
CHAR16  mBootMaintStorageName[]     = L"BmmData";\r
CHAR16  mFileExplorerStorageName[]  = L"FeData";\r
BMM_CALLBACK_DATA *mBmmCallbackInfo = NULL;\r
BOOLEAN  mAllMenuInit               = FALSE;\r
BOOLEAN  mEnterFileExplorer         = FALSE;\r
\r
/**\r
  Init all memu.\r
\r
  @param CallbackData    The BMM context data.\r
\r
**/\r
VOID\r
InitAllMenu (\r
  IN  BMM_CALLBACK_DATA    *CallbackData\r
  );\r
\r
/**\r
  Free up all Menu Option list.\r
\r
**/\r
VOID\r
FreeAllMenu (\r
  VOID\r
  );\r
\r
/**\r
  Create string tokens for a menu from its help strings and display strings\r
\r
  @param CallbackData       The BMM context data.\r
  @param HiiHandle          Hii Handle of the package to be updated.\r
  @param MenuOption         The Menu whose string tokens need to be created\r
\r
  @retval  EFI_SUCCESS      String tokens created successfully\r
  @retval  others           contain some errors\r
**/\r
EFI_STATUS\r
CreateMenuStringToken (\r
  IN BMM_CALLBACK_DATA                *CallbackData,\r
  IN EFI_HII_HANDLE                   HiiHandle,\r
  IN BM_MENU_OPTION                   *MenuOption\r
  )\r
{\r
  BM_MENU_ENTRY *NewMenuEntry;\r
  UINTN         Index;\r
\r
  for (Index = 0; Index < MenuOption->MenuNumber; Index++) {\r
    NewMenuEntry = BOpt_GetMenuEntry (MenuOption, Index);\r
\r
    NewMenuEntry->DisplayStringToken = HiiSetString (\r
                                         HiiHandle,\r
                                         0,\r
                                         NewMenuEntry->DisplayString,\r
                                         NULL\r
                                         );\r
\r
    if (NULL == NewMenuEntry->HelpString) {\r
      NewMenuEntry->HelpStringToken = NewMenuEntry->DisplayStringToken;\r
    } else {\r
      NewMenuEntry->HelpStringToken = HiiSetString (\r
                                        HiiHandle,\r
                                        0,\r
                                        NewMenuEntry->HelpString,\r
                                        NULL\r
                                        );\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This function allows a caller to extract the current configuration for one\r
  or more named elements from the target driver.\r
\r
\r
  @param This            Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
  @param Request         A null-terminated Unicode string in <ConfigRequest> format.\r
  @param Progress        On return, points to a character in the Request string.\r
                         Points to the string's null terminator if request was successful.\r
                         Points to the most recent '&' before the first failing name/value\r
                         pair (or the beginning of the string if the failure is in the\r
                         first name/value pair) if the request was not successful.\r
  @param Results         A null-terminated Unicode string in <ConfigAltResp> format which\r
                         has all values filled in for the names in the Request string.\r
                         String to be allocated by the called function.\r
\r
  @retval  EFI_SUCCESS            The Results is filled with the requested values.\r
  @retval  EFI_OUT_OF_RESOURCES   Not enough memory to store the results.\r
  @retval  EFI_INVALID_PARAMETER  Request is NULL, illegal syntax, or unknown name.\r
  @retval  EFI_NOT_FOUND          Routing data doesn't match any storage in this driver.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BootMaintExtractConfig (\r
  IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL   *This,\r
  IN  CONST EFI_STRING                       Request,\r
  OUT EFI_STRING                             *Progress,\r
  OUT EFI_STRING                             *Results\r
  )\r
{\r
  EFI_STATUS         Status;\r
  UINTN              BufferSize;\r
  BMM_CALLBACK_DATA  *Private;\r
  EFI_STRING                       ConfigRequestHdr;\r
  EFI_STRING                       ConfigRequest;\r
  BOOLEAN                          AllocatedRequest;\r
  UINTN                            Size;\r
\r
  if (Progress == NULL || Results == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  *Progress = Request;\r
  if ((Request != NULL) && !HiiIsConfigHdrMatch (Request, &mBootMaintGuid, mBootMaintStorageName)) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  ConfigRequestHdr = NULL;\r
  ConfigRequest    = NULL;\r
  AllocatedRequest = FALSE;\r
  Size             = 0;\r
\r
  Private = BMM_CALLBACK_DATA_FROM_THIS (This);\r
  //\r
  // Convert buffer data to <ConfigResp> by helper function BlockToConfig()\r
  //\r
  BufferSize = sizeof (BMM_FAKE_NV_DATA);\r
  ConfigRequest = Request;\r
  if ((Request == NULL) || (StrStr (Request, L"OFFSET") == NULL)) {\r
    //\r
    // Request has no request element, construct full request string.\r
    // Allocate and fill a buffer large enough to hold the <ConfigHdr> template\r
    // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator\r
    //\r
    ConfigRequestHdr = HiiConstructConfigHdr (&mBootMaintGuid, mBootMaintStorageName, Private->BmmDriverHandle);\r
    Size = (StrLen (ConfigRequestHdr) + 32 + 1) * sizeof (CHAR16);\r
    ConfigRequest = AllocateZeroPool (Size);\r
    ASSERT (ConfigRequest != NULL);\r
    AllocatedRequest = TRUE;\r
    UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr, (UINT64)BufferSize);\r
    FreePool (ConfigRequestHdr);\r
  }\r
\r
  Status = gHiiConfigRouting->BlockToConfig (\r
                                gHiiConfigRouting,\r
                                ConfigRequest,\r
                                (UINT8 *) &Private->BmmFakeNvData,\r
                                BufferSize,\r
                                Results,\r
                                Progress\r
                                );\r
  //\r
  // Free the allocated config request string.\r
  //\r
  if (AllocatedRequest) {\r
    FreePool (ConfigRequest);\r
    ConfigRequest = NULL;\r
  }\r
  //\r
  // Set Progress string to the original request string.\r
  //\r
  if (Request == NULL) {\r
    *Progress = NULL;\r
  } else if (StrStr (Request, L"OFFSET") == NULL) {\r
    *Progress = Request + StrLen (Request);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  This function applies changes in a driver's configuration.\r
  Input is a Configuration, which has the routing data for this\r
  driver followed by name / value configuration pairs. The driver\r
  must apply those pairs to its configurable storage. If the\r
  driver's configuration is stored in a linear block of data\r
  and the driver's name / value pairs are in <BlockConfig>\r
  format, it may use the ConfigToBlock helper function (above) to\r
  simplify the job. Currently not implemented.\r
\r
  @param[in]  This                Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
  @param[in]  Configuration       A null-terminated Unicode string in\r
                                  <ConfigString> format.   \r
  @param[out] Progress            A pointer to a string filled in with the\r
                                  offset of the most recent '&' before the\r
                                  first failing name / value pair (or the\r
                                  beginn ing of the string if the failure\r
                                  is in the first name / value pair) or\r
                                  the terminating NULL if all was\r
                                  successful.\r
\r
  @retval EFI_SUCCESS             The results have been distributed or are\r
                                  awaiting distribution.  \r
  @retval EFI_OUT_OF_RESOURCES    Not enough memory to store the\r
                                  parts of the results that must be\r
                                  stored awaiting possible future\r
                                  protocols.\r
  @retval EFI_INVALID_PARAMETERS  Passing in a NULL for the\r
                                  Results parameter would result\r
                                  in this type of error.\r
  @retval EFI_NOT_FOUND           Target for the specified routing data\r
                                  was not found.\r
**/\r
EFI_STATUS\r
EFIAPI\r
BootMaintRouteConfig (\r
  IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
  IN CONST EFI_STRING                     Configuration,\r
  OUT EFI_STRING                          *Progress\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  UINTN                           BufferSize;\r
  EFI_HII_CONFIG_ROUTING_PROTOCOL *ConfigRouting;\r
  BMM_FAKE_NV_DATA                *NewBmmData;\r
  BMM_FAKE_NV_DATA                *OldBmmData;\r
  BM_MENU_ENTRY                   *NewMenuEntry;\r
  BM_LOAD_CONTEXT                 *NewLoadContext;\r
  UINT16                          Index;  \r
  BMM_CALLBACK_DATA               *Private; \r
\r
  if (Progress == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  *Progress = Configuration;\r
\r
  if (Configuration == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Check routing data in <ConfigHdr>.\r
  // Note: there is no name for Name/Value storage, only GUID will be checked\r
  //\r
  if (!HiiIsConfigHdrMatch (Configuration, &mBootMaintGuid, mBootMaintStorageName)) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  Status = gBS->LocateProtocol (\r
                  &gEfiHiiConfigRoutingProtocolGuid, \r
                  NULL, \r
                  (VOID **)&ConfigRouting\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  \r
  Private = BMM_CALLBACK_DATA_FROM_THIS (This);  \r
  //\r
  // Get Buffer Storage data from EFI variable\r
  //\r
  BufferSize = sizeof (BMM_FAKE_NV_DATA);\r
  OldBmmData = &Private->BmmOldFakeNVData;\r
  NewBmmData = &Private->BmmFakeNvData;\r
  //\r
  // Convert <ConfigResp> to buffer data by helper function ConfigToBlock()\r
  //\r
  Status = ConfigRouting->ConfigToBlock (\r
                            ConfigRouting,\r
                            Configuration,\r
                            (UINT8 *) NewBmmData,\r
                            &BufferSize,\r
                            Progress\r
                            );\r
  ASSERT_EFI_ERROR (Status);    \r
  //\r
  // Compare new and old BMM configuration data and only do action for modified item to \r
  // avoid setting unnecessary non-volatile variable\r
  //\r
  \r
  //\r
  // Check data which located in BMM main page and save the settings if need\r
  //         \r
  if (CompareMem (&NewBmmData->BootNext, &OldBmmData->BootNext, sizeof (NewBmmData->BootNext)) != 0) {\r
    Status = Var_UpdateBootNext (Private);\r
  }\r
  \r
  //\r
  // Check data which located in Boot Options Menu and save the settings if need\r
  //      \r
  if (CompareMem (NewBmmData->BootOptionDel, OldBmmData->BootOptionDel, sizeof (NewBmmData->BootOptionDel)) != 0) {  \r
    for (Index = 0; \r
         ((Index < BootOptionMenu.MenuNumber) && (Index < (sizeof (NewBmmData->BootOptionDel) / sizeof (NewBmmData->BootOptionDel[0])))); \r
         Index ++) {\r
      NewMenuEntry            = BOpt_GetMenuEntry (&BootOptionMenu, Index);\r
      NewLoadContext          = (BM_LOAD_CONTEXT *) NewMenuEntry->VariableContext;\r
      NewLoadContext->Deleted = NewBmmData->BootOptionDel[Index];\r
      NewBmmData->BootOptionDel[Index] = FALSE;\r
    }\r
    \r
    Var_DelBootOption ();\r
  }\r
  \r
  if (CompareMem (NewBmmData->BootOptionOrder, OldBmmData->BootOptionOrder, sizeof (NewBmmData->BootOptionOrder)) != 0) {  \r
    Status = Var_UpdateBootOrder (Private);\r
  } \r
\r
  //\r
  // Check data which located in Driver Options Menu and save the settings if need\r
  //              \r
  if (CompareMem (NewBmmData->DriverOptionDel, OldBmmData->DriverOptionDel, sizeof (NewBmmData->DriverOptionDel)) != 0) {       \r
    for (Index = 0; \r
         ((Index < DriverOptionMenu.MenuNumber) && (Index < (sizeof (NewBmmData->DriverOptionDel) / sizeof (NewBmmData->DriverOptionDel[0])))); \r
         Index++) {\r
      NewMenuEntry            = BOpt_GetMenuEntry (&DriverOptionMenu, Index);\r
      NewLoadContext          = (BM_LOAD_CONTEXT *) NewMenuEntry->VariableContext;\r
      NewLoadContext->Deleted = NewBmmData->DriverOptionDel[Index];\r
      NewBmmData->DriverOptionDel[Index] = FALSE;\r
    }\r
    Var_DelDriverOption ();  \r
  }\r
  \r
  if (CompareMem (NewBmmData->DriverOptionOrder, OldBmmData->DriverOptionOrder, sizeof (NewBmmData->DriverOptionOrder)) != 0) {  \r
    Status = Var_UpdateDriverOrder (Private);\r
  }      \r
\r
  //\r
  // After user do the save action, need to update OldBmmData.\r
  //\r
  CopyMem (OldBmmData, NewBmmData, sizeof (BMM_FAKE_NV_DATA));\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This function processes the results of changes in configuration.\r
\r
\r
  @param This               Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
  @param Action             Specifies the type of action taken by the browser.\r
  @param QuestionId         A unique value which is sent to the original exporting driver\r
                            so that it can identify the type of data to expect.\r
  @param Type               The type of value for the question.\r
  @param Value              A pointer to the data being sent to the original exporting driver.\r
  @param ActionRequest      On return, points to the action requested by the callback function.\r
\r
  @retval EFI_SUCCESS           The callback successfully handled the action.\r
  @retval EFI_OUT_OF_RESOURCES  Not enough storage is available to hold the variable and its data.\r
  @retval EFI_DEVICE_ERROR      The variable could not be saved.\r
  @retval EFI_UNSUPPORTED       The specified Action is not supported by the callback.\r
  @retval EFI_INVALID_PARAMETER The parameter of Value or ActionRequest is invalid.\r
**/\r
EFI_STATUS\r
EFIAPI\r
BootMaintCallback (\r
  IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL         *This,\r
  IN        EFI_BROWSER_ACTION                     Action,\r
  IN        EFI_QUESTION_ID                        QuestionId,\r
  IN        UINT8                                  Type,\r
  IN        EFI_IFR_TYPE_VALUE                     *Value,\r
  OUT       EFI_BROWSER_ACTION_REQUEST             *ActionRequest\r
  )\r
{\r
  BMM_CALLBACK_DATA *Private;\r
  BM_MENU_ENTRY     *NewMenuEntry;\r
  BMM_FAKE_NV_DATA  *CurrentFakeNVMap;\r
  EFI_STATUS        Status;\r
  UINTN             OldValue;\r
  UINTN             NewValue;\r
  UINTN             Number;\r
  UINTN             Index;\r
\r
  //\r
  //Chech whether exit from FileExplorer and reenter BM,if yes,reclaim string depositories\r
  //\r
  if (Action == EFI_BROWSER_ACTION_FORM_OPEN){\r
    if(mEnterFileExplorer ){\r
      ReclaimStringDepository();\r
      mEnterFileExplorer = FALSE;\r
    }\r
  }\r
\r
  if (Action != EFI_BROWSER_ACTION_CHANGING && Action != EFI_BROWSER_ACTION_CHANGED) {\r
    //\r
    // Do nothing for other UEFI Action. Only do call back when data is changed.\r
    //\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  OldValue       = 0;\r
  NewValue       = 0;\r
  Number         = 0;\r
\r
  Private        = BMM_CALLBACK_DATA_FROM_THIS (This);\r
\r
  //\r
  // Retrive uncommitted data from Form Browser\r
  //\r
  CurrentFakeNVMap = &Private->BmmFakeNvData;\r
  HiiGetBrowserData (&mBootMaintGuid, mBootMaintStorageName, sizeof (BMM_FAKE_NV_DATA), (UINT8 *) CurrentFakeNVMap);\r
\r
  if (Action == EFI_BROWSER_ACTION_CHANGING) {\r
    if (Value == NULL) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
    \r
    UpdatePageId (Private, QuestionId);\r
\r
    if (QuestionId < FILE_OPTION_OFFSET) {\r
      if (QuestionId < CONFIG_OPTION_OFFSET) {\r
        switch (QuestionId) {\r
        case FORM_BOOT_ADD_ID:\r
          // Leave Bm and enter FileExplorer.\r
          Private->FeCurrentState = FileExplorerStateAddBootOption;\r
          Private->FeDisplayContext = FileExplorerDisplayUnknown;\r
          ReclaimStringDepository (); \r
          UpdateFileExplorer(Private, 0);\r
          mEnterFileExplorer = TRUE;\r
          break;\r
\r
        case FORM_DRV_ADD_FILE_ID:\r
          // Leave Bm and enter FileExplorer.\r
          Private->FeCurrentState = FileExplorerStateAddDriverOptionState;\r
          Private->FeDisplayContext = FileExplorerDisplayUnknown;\r
          ReclaimStringDepository ();\r
          UpdateFileExplorer(Private, 0);\r
          mEnterFileExplorer = TRUE;\r
          break;\r
\r
        case FORM_DRV_ADD_HANDLE_ID:\r
          CleanUpPage (FORM_DRV_ADD_HANDLE_ID, Private);\r
          UpdateDrvAddHandlePage (Private);\r
          break;\r
\r
        case FORM_BOOT_DEL_ID:\r
          CleanUpPage (FORM_BOOT_DEL_ID, Private);\r
          UpdateBootDelPage (Private);\r
          break;\r
\r
        case FORM_BOOT_CHG_ID:\r
        case FORM_DRV_CHG_ID:\r
          UpdatePageBody (QuestionId, Private);\r
          break;\r
\r
        case FORM_DRV_DEL_ID:\r
          CleanUpPage (FORM_DRV_DEL_ID, Private);\r
          UpdateDrvDelPage (Private);\r
          break;\r
\r
        case FORM_BOOT_NEXT_ID:\r
          CleanUpPage (FORM_BOOT_NEXT_ID, Private);\r
          UpdateBootNextPage (Private);\r
          break;\r
\r
        case FORM_TIME_OUT_ID:\r
          CleanUpPage (FORM_TIME_OUT_ID, Private);\r
          UpdateTimeOutPage (Private);\r
          break;\r
\r
        case FORM_CON_IN_ID:\r
        case FORM_CON_OUT_ID:\r
        case FORM_CON_ERR_ID:\r
          UpdatePageBody (QuestionId, Private);\r
          break;\r
\r
        case FORM_CON_MODE_ID:\r
          CleanUpPage (FORM_CON_MODE_ID, Private);\r
          UpdateConModePage (Private);\r
          break;\r
\r
        case FORM_CON_COM_ID:\r
          CleanUpPage (FORM_CON_COM_ID, Private);\r
          UpdateConCOMPage (Private);\r
          break;\r
\r
        default:\r
          break;\r
        }\r
      } else if ((QuestionId >= TERMINAL_OPTION_OFFSET) && (QuestionId < CONSOLE_OPTION_OFFSET)) {\r
        Index                  = (UINT16) (QuestionId - TERMINAL_OPTION_OFFSET);\r
        Private->CurrentTerminal  = Index;\r
\r
        CleanUpPage (FORM_CON_COM_SETUP_ID, Private);\r
        UpdateTerminalPage (Private);\r
\r
      } else if (QuestionId >= HANDLE_OPTION_OFFSET) {\r
        Index                  = (UINT16) (QuestionId - HANDLE_OPTION_OFFSET);\r
\r
        NewMenuEntry            = BOpt_GetMenuEntry (&DriverMenu, Index);\r
        ASSERT (NewMenuEntry != NULL);\r
        Private->HandleContext  = (BM_HANDLE_CONTEXT *) NewMenuEntry->VariableContext;\r
\r
        CleanUpPage (FORM_DRV_ADD_HANDLE_DESC_ID, Private);\r
\r
        Private->MenuEntry                  = NewMenuEntry;\r
        Private->LoadContext->FilePathList  = Private->HandleContext->DevicePath;\r
\r
        UpdateDriverAddHandleDescPage (Private);\r
      }\r
    }\r
    if (QuestionId == KEY_VALUE_BOOT_FROM_FILE){\r
      // Leave Bm and enter FileExplorer.\r
      Private->FeCurrentState = FileExplorerStateBootFromFile;\r
      Private->FeDisplayContext = FileExplorerDisplayUnknown;\r
      ReclaimStringDepository ();\r
      UpdateFileExplorer(Private, 0);\r
      mEnterFileExplorer = TRUE;\r
    }\r
  } else if (Action == EFI_BROWSER_ACTION_CHANGED) {\r
    if ((Value == NULL) || (ActionRequest == NULL)) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    switch (QuestionId) {\r
    case KEY_VALUE_SAVE_AND_EXIT:\r
    case KEY_VALUE_NO_SAVE_AND_EXIT:\r
      if (QuestionId == KEY_VALUE_SAVE_AND_EXIT) {\r
        Status = ApplyChangeHandler (Private, CurrentFakeNVMap, Private->BmmPreviousPageId);\r
        if (EFI_ERROR (Status)) {\r
          return Status;\r
        }\r
      } else if (QuestionId == KEY_VALUE_NO_SAVE_AND_EXIT) {\r
        DiscardChangeHandler (Private, CurrentFakeNVMap);\r
      }\r
\r
      //\r
      // Tell browser not to ask for confirmation of changes,\r
      // since we have already applied or discarded.\r
      //\r
      *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT;\r
\r
      break;\r
\r
    default:\r
      break;\r
    }\r
  }\r
\r
  //\r
  // Pass changed uncommitted data back to Form Browser\r
  //\r
  HiiSetBrowserData (&mBootMaintGuid, mBootMaintStorageName, sizeof (BMM_FAKE_NV_DATA), (UINT8 *) CurrentFakeNVMap, NULL);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Function handling request to apply changes for BMM pages.\r
\r
  @param Private            Pointer to callback data buffer.\r
  @param CurrentFakeNVMap   Pointer to buffer holding data of various values used by BMM\r
  @param FormId             ID of the form which has sent the request to apply change.\r
\r
  @retval  EFI_SUCCESS       Change successfully applied.\r
  @retval  Other             Error occurs while trying to apply changes.\r
\r
**/\r
EFI_STATUS\r
ApplyChangeHandler (\r
  IN  BMM_CALLBACK_DATA               *Private,\r
  IN  BMM_FAKE_NV_DATA                *CurrentFakeNVMap,\r
  IN  EFI_FORM_ID                     FormId\r
  )\r
{\r
  BM_CONSOLE_CONTEXT  *NewConsoleContext;\r
  BM_TERMINAL_CONTEXT *NewTerminalContext;\r
  BM_LOAD_CONTEXT     *NewLoadContext;\r
  BM_MENU_ENTRY       *NewMenuEntry;\r
  EFI_STATUS          Status;\r
  UINT16              Index;\r
\r
  Status = EFI_SUCCESS;\r
\r
  switch (FormId) {\r
  case FORM_BOOT_DEL_ID:\r
    for (Index = 0; \r
         ((Index < BootOptionMenu.MenuNumber) && (Index < (sizeof (CurrentFakeNVMap->BootOptionDel) / sizeof (CurrentFakeNVMap->BootOptionDel[0])))); \r
         Index ++) {\r
      NewMenuEntry            = BOpt_GetMenuEntry (&BootOptionMenu, Index);\r
      NewLoadContext          = (BM_LOAD_CONTEXT *) NewMenuEntry->VariableContext;\r
      NewLoadContext->Deleted = CurrentFakeNVMap->BootOptionDel[Index];\r
      CurrentFakeNVMap->BootOptionDel[Index] = FALSE;\r
    }\r
\r
    Var_DelBootOption ();\r
    break;\r
\r
  case FORM_DRV_DEL_ID:\r
    for (Index = 0; \r
         ((Index < DriverOptionMenu.MenuNumber) && (Index < (sizeof (CurrentFakeNVMap->DriverOptionDel) / sizeof (CurrentFakeNVMap->DriverOptionDel[0])))); \r
         Index++) {\r
      NewMenuEntry            = BOpt_GetMenuEntry (&DriverOptionMenu, Index);\r
      NewLoadContext          = (BM_LOAD_CONTEXT *) NewMenuEntry->VariableContext;\r
      NewLoadContext->Deleted = CurrentFakeNVMap->DriverOptionDel[Index];\r
      CurrentFakeNVMap->DriverOptionDel[Index] = FALSE;\r
    }\r
\r
    Var_DelDriverOption ();\r
    break;\r
\r
  case FORM_BOOT_CHG_ID:\r
    Status = Var_UpdateBootOrder (Private);\r
    break;\r
\r
  case FORM_DRV_CHG_ID:\r
    Status = Var_UpdateDriverOrder (Private);\r
    break;\r
\r
  case FORM_TIME_OUT_ID:\r
    Status = gRT->SetVariable (\r
                    L"Timeout",\r
                    &gEfiGlobalVariableGuid,\r
                    EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
                    sizeof (UINT16),\r
                    &(CurrentFakeNVMap->BootTimeOut)\r
                    );\r
    ASSERT_EFI_ERROR(Status);\r
\r
    Private->BmmOldFakeNVData.BootTimeOut = CurrentFakeNVMap->BootTimeOut;\r
    break;\r
\r
  case FORM_BOOT_NEXT_ID:\r
    Status = Var_UpdateBootNext (Private);\r
    break;\r
\r
  case FORM_CON_MODE_ID:\r
    Status = Var_UpdateConMode (Private);\r
    break;\r
\r
  case FORM_CON_COM_SETUP_ID:\r
    NewMenuEntry                      = BOpt_GetMenuEntry (&TerminalMenu, Private->CurrentTerminal);\r
\r
    ASSERT (NewMenuEntry != NULL);\r
\r
    NewTerminalContext                = (BM_TERMINAL_CONTEXT *) NewMenuEntry->VariableContext;\r
\r
    NewTerminalContext->BaudRateIndex = CurrentFakeNVMap->COMBaudRate;\r
    ASSERT (CurrentFakeNVMap->COMBaudRate < (sizeof (BaudRateList) / sizeof (BaudRateList[0])));\r
    NewTerminalContext->BaudRate      = BaudRateList[CurrentFakeNVMap->COMBaudRate].Value;\r
    NewTerminalContext->DataBitsIndex = CurrentFakeNVMap->COMDataRate;\r
    ASSERT (CurrentFakeNVMap->COMDataRate < (sizeof (DataBitsList) / sizeof (DataBitsList[0])));\r
    NewTerminalContext->DataBits      = (UINT8) DataBitsList[CurrentFakeNVMap->COMDataRate].Value;\r
    NewTerminalContext->StopBitsIndex = CurrentFakeNVMap->COMStopBits;\r
    ASSERT (CurrentFakeNVMap->COMStopBits < (sizeof (StopBitsList) / sizeof (StopBitsList[0])));\r
    NewTerminalContext->StopBits      = (UINT8) StopBitsList[CurrentFakeNVMap->COMStopBits].Value;\r
    NewTerminalContext->ParityIndex   = CurrentFakeNVMap->COMParity;\r
    ASSERT (CurrentFakeNVMap->COMParity < (sizeof (ParityList) / sizeof (ParityList[0])));\r
    NewTerminalContext->Parity        = (UINT8) ParityList[CurrentFakeNVMap->COMParity].Value;\r
    NewTerminalContext->TerminalType  = CurrentFakeNVMap->COMTerminalType;\r
\r
    ChangeTerminalDevicePath (\r
      NewTerminalContext->DevicePath,\r
      FALSE\r
      );\r
\r
    Var_UpdateConsoleInpOption ();\r
    Var_UpdateConsoleOutOption ();\r
    Var_UpdateErrorOutOption ();\r
    break;\r
\r
  case FORM_CON_IN_ID:\r
    for (Index = 0; Index < ConsoleInpMenu.MenuNumber; Index++) {\r
      NewMenuEntry                = BOpt_GetMenuEntry (&ConsoleInpMenu, Index);\r
      NewConsoleContext           = (BM_CONSOLE_CONTEXT *) NewMenuEntry->VariableContext;\r
      ASSERT (Index < MAX_MENU_NUMBER);\r
      NewConsoleContext->IsActive = CurrentFakeNVMap->ConsoleCheck[Index];\r
    }\r
\r
    for (Index = 0; Index < TerminalMenu.MenuNumber; Index++) {\r
      NewMenuEntry                = BOpt_GetMenuEntry (&TerminalMenu, Index);\r
      NewTerminalContext          = (BM_TERMINAL_CONTEXT *) NewMenuEntry->VariableContext;\r
      ASSERT (Index + ConsoleInpMenu.MenuNumber < MAX_MENU_NUMBER);\r
      NewTerminalContext->IsConIn = CurrentFakeNVMap->ConsoleCheck[Index + ConsoleInpMenu.MenuNumber];\r
    }\r
\r
    Var_UpdateConsoleInpOption ();\r
    break;\r
\r
  case FORM_CON_OUT_ID:\r
    for (Index = 0; Index < ConsoleOutMenu.MenuNumber; Index++) {\r
      NewMenuEntry                = BOpt_GetMenuEntry (&ConsoleOutMenu, Index);\r
      NewConsoleContext           = (BM_CONSOLE_CONTEXT *) NewMenuEntry->VariableContext;\r
      ASSERT (Index < MAX_MENU_NUMBER);\r
      NewConsoleContext->IsActive = CurrentFakeNVMap->ConsoleCheck[Index];\r
    }\r
\r
    for (Index = 0; Index < TerminalMenu.MenuNumber; Index++) {\r
      NewMenuEntry                  = BOpt_GetMenuEntry (&TerminalMenu, Index);\r
      NewTerminalContext            = (BM_TERMINAL_CONTEXT *) NewMenuEntry->VariableContext;\r
      ASSERT (Index + ConsoleOutMenu.MenuNumber < MAX_MENU_NUMBER);\r
      NewTerminalContext->IsConOut  = CurrentFakeNVMap->ConsoleCheck[Index + ConsoleOutMenu.MenuNumber];\r
    }\r
\r
    Var_UpdateConsoleOutOption ();\r
    break;\r
\r
  case FORM_CON_ERR_ID:\r
    for (Index = 0; Index < ConsoleErrMenu.MenuNumber; Index++) {\r
      NewMenuEntry                = BOpt_GetMenuEntry (&ConsoleErrMenu, Index);\r
      NewConsoleContext           = (BM_CONSOLE_CONTEXT *) NewMenuEntry->VariableContext;\r
      ASSERT (Index < MAX_MENU_NUMBER);\r
      NewConsoleContext->IsActive = CurrentFakeNVMap->ConsoleCheck[Index];\r
    }\r
\r
    for (Index = 0; Index < TerminalMenu.MenuNumber; Index++) {\r
      NewMenuEntry                  = BOpt_GetMenuEntry (&TerminalMenu, Index);\r
      NewTerminalContext            = (BM_TERMINAL_CONTEXT *) NewMenuEntry->VariableContext;\r
      ASSERT (Index + ConsoleErrMenu.MenuNumber < MAX_MENU_NUMBER);\r
      NewTerminalContext->IsStdErr  = CurrentFakeNVMap->ConsoleCheck[Index + ConsoleErrMenu.MenuNumber];\r
    }\r
\r
    Var_UpdateErrorOutOption ();\r
    break;\r
\r
  case FORM_DRV_ADD_HANDLE_DESC_ID:\r
    Status = Var_UpdateDriverOption (\r
               Private,\r
               Private->BmmHiiHandle,\r
               CurrentFakeNVMap->DriverAddHandleDesc,\r
               CurrentFakeNVMap->DriverAddHandleOptionalData,\r
               CurrentFakeNVMap->DriverAddForceReconnect\r
               );\r
    if (EFI_ERROR (Status)) {\r
      goto Error;\r
    }\r
\r
    BOpt_GetDriverOptions (Private);\r
    CreateMenuStringToken (Private, Private->BmmHiiHandle, &DriverOptionMenu);\r
    break;\r
\r
  default:\r
    break;\r
  }\r
\r
Error:\r
  return Status;\r
}\r
\r
/**\r
  Discard all changes done to the BMM pages such as Boot Order change,\r
  Driver order change.\r
\r
  @param Private            The BMM context data.\r
  @param CurrentFakeNVMap   The current Fack NV Map.\r
\r
**/\r
VOID\r
DiscardChangeHandler (\r
  IN  BMM_CALLBACK_DATA               *Private,\r
  IN  BMM_FAKE_NV_DATA                *CurrentFakeNVMap\r
  )\r
{\r
  UINT16  Index;\r
\r
  switch (Private->BmmPreviousPageId) {\r
  case FORM_BOOT_CHG_ID:\r
    CopyMem (CurrentFakeNVMap->BootOptionOrder, Private->BmmOldFakeNVData.BootOptionOrder, sizeof (CurrentFakeNVMap->BootOptionOrder));\r
    break;\r
	\r
  case FORM_DRV_CHG_ID:\r
    CopyMem (CurrentFakeNVMap->DriverOptionOrder, Private->BmmOldFakeNVData.DriverOptionOrder, sizeof (CurrentFakeNVMap->DriverOptionOrder));\r
    break;\r
\r
  case FORM_BOOT_DEL_ID:\r
    ASSERT (BootOptionMenu.MenuNumber <= (sizeof (CurrentFakeNVMap->BootOptionDel) / sizeof (CurrentFakeNVMap->BootOptionDel[0])));\r
    for (Index = 0; Index < BootOptionMenu.MenuNumber; Index++) {\r
      CurrentFakeNVMap->BootOptionDel[Index] = FALSE;\r
    }\r
    break;\r
\r
  case FORM_DRV_DEL_ID:\r
    ASSERT (DriverOptionMenu.MenuNumber <= (sizeof (CurrentFakeNVMap->DriverOptionDel) / sizeof (CurrentFakeNVMap->DriverOptionDel[0])));\r
    for (Index = 0; Index < DriverOptionMenu.MenuNumber; Index++) {\r
      CurrentFakeNVMap->DriverOptionDel[Index] = FALSE;\r
    }\r
    break;\r
\r
  case FORM_BOOT_NEXT_ID:\r
    CurrentFakeNVMap->BootNext = Private->BmmOldFakeNVData.BootNext;\r
    break;\r
\r
  case FORM_TIME_OUT_ID:\r
    CurrentFakeNVMap->BootTimeOut = Private->BmmOldFakeNVData.BootTimeOut;\r
    break;\r
\r
  case FORM_DRV_ADD_HANDLE_DESC_ID:\r
  case FORM_DRV_ADD_FILE_ID:\r
  case FORM_DRV_ADD_HANDLE_ID:\r
    CurrentFakeNVMap->DriverAddHandleDesc[0]          = 0x0000;\r
    CurrentFakeNVMap->DriverAddHandleOptionalData[0]  = 0x0000;\r
    break;\r
\r
  default:\r
    break;\r
  }\r
}\r
\r
\r
/**\r
  Create dynamic code for BMM.\r
\r
  @param  BmmCallbackInfo        The BMM context data.\r
\r
**/\r
VOID\r
InitializeDrivers(\r
  IN BMM_CALLBACK_DATA        *BmmCallbackInfo\r
  )\r
{\r
  EFI_HII_HANDLE              HiiHandle;\r
  VOID                        *StartOpCodeHandle;\r
  VOID                        *EndOpCodeHandle;\r
  EFI_IFR_GUID_LABEL          *StartLabel;\r
  EFI_IFR_GUID_LABEL          *EndLabel;\r
  UINTN                       Index;  \r
  EFI_STRING_ID               FormSetTitle;\r
  EFI_STRING_ID               FormSetHelp;  \r
  EFI_STRING                  String;\r
  EFI_STRING_ID               Token;\r
  EFI_STRING_ID               TokenHelp;  \r
  EFI_HII_HANDLE              *HiiHandles;\r
  UINTN                       SkipCount;\r
  EFI_GUID                    FormSetGuid;\r
  CHAR16                      *DevicePathStr;\r
  EFI_STRING_ID               DevicePathId;\r
\r
  HiiHandle = BmmCallbackInfo->BmmHiiHandle;\r
  //\r
  // Allocate space for creation of UpdateData Buffer\r
  //\r
  StartOpCodeHandle = HiiAllocateOpCodeHandle ();\r
  ASSERT (StartOpCodeHandle != NULL);\r
\r
  EndOpCodeHandle = HiiAllocateOpCodeHandle ();\r
  ASSERT (EndOpCodeHandle != NULL);\r
\r
  //\r
  // Create Hii Extend Label OpCode as the start opcode\r
  //\r
  StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r
  StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
  StartLabel->Number       = LABEL_BMM_PLATFORM_INFORMATION;\r
\r
  //\r
  // Create Hii Extend Label OpCode as the end opcode\r
  //\r
  EndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (EndOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r
  EndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
  EndLabel->Number       = LABEL_END;\r
\r
  //\r
  // Get all the Hii handles\r
  //\r
  HiiHandles = HiiGetHiiHandles (NULL);\r
  ASSERT (HiiHandles != NULL);\r
\r
  //\r
  // Search for formset of each class type\r
  //\r
  SkipCount = 0;\r
  for (Index = 0; HiiHandles[Index] != NULL; Index++) {\r
    if (!ExtractDisplayedHiiFormFromHiiHandle (HiiHandles[Index], &gEfiIfrBootMaintenanceGuid, SkipCount, &FormSetTitle, &FormSetHelp, &FormSetGuid)) {\r
      SkipCount = 0;\r
      continue;\r
    }\r
    String = HiiGetString (HiiHandles[Index], FormSetTitle, NULL);\r
    if (String == NULL) {\r
      String = HiiGetString (HiiHandle, STR_MISSING_STRING, NULL);\r
      ASSERT (String != NULL);\r
    }\r
    Token = HiiSetString (HiiHandle, 0, String, NULL);\r
    FreePool (String);\r
\r
    String = HiiGetString (HiiHandles[Index], FormSetHelp, NULL);\r
    if (String == NULL) {\r
      String = HiiGetString (HiiHandle, STR_MISSING_STRING, NULL);\r
      ASSERT (String != NULL);\r
    }\r
    TokenHelp = HiiSetString (HiiHandle, 0, String, NULL);\r
    FreePool (String);\r
\r
    DevicePathStr = ExtractDevicePathFromHiiHandle(HiiHandles[Index]);\r
    DevicePathId  = 0;\r
    if (DevicePathStr != NULL){\r
      DevicePathId = HiiSetString (HiiHandle, 0, DevicePathStr, NULL);\r
      FreePool (DevicePathStr);\r
    }\r
\r
    HiiCreateGotoExOpCode (\r
      StartOpCodeHandle,\r
      0,\r
      Token,\r
      TokenHelp,\r
      0,\r
      (EFI_QUESTION_ID) (Index + FRONT_PAGE_KEY_OFFSET),\r
      0,\r
      &FormSetGuid,\r
      DevicePathId\r
      );\r
    //\r
    //One packagelist may has more than one form package,\r
    //Index-- means keep current HiiHandle and still extract from the packagelist, \r
    //SkipCount++ means skip the formset which was found before in the same form package. \r
    //\r
    SkipCount++;\r
    Index--;\r
  }\r
\r
  HiiUpdateForm (\r
    HiiHandle,\r
    &mBootMaintGuid,\r
    FORM_MAIN_ID,\r
    StartOpCodeHandle,\r
    EndOpCodeHandle\r
    );\r
\r
  HiiFreeOpCodeHandle (StartOpCodeHandle);\r
  HiiFreeOpCodeHandle (EndOpCodeHandle);  \r
  FreePool (HiiHandles);\r
}\r
\r
\r
/**\r
  Create dynamic code for BMM.\r
\r
  @param  BmmCallbackInfo        The BMM context data.\r
\r
**/\r
VOID\r
InitializeBmmConfig(\r
  IN BMM_CALLBACK_DATA        *BmmCallbackInfo\r
  )\r
{\r
  UpdateBootDelPage (BmmCallbackInfo);\r
  UpdateDrvDelPage (BmmCallbackInfo);\r
\r
  if (TerminalMenu.MenuNumber > 0) {\r
    BmmCallbackInfo->CurrentTerminal = 0;\r
    UpdateTerminalPage (BmmCallbackInfo);\r
  }\r
\r
  InitializeDrivers (BmmCallbackInfo);\r
}\r
\r
/**\r
  Initialize the Boot Maintenance Utitliy.\r
\r
**/\r
VOID\r
InitializeBM (\r
  VOID\r
  )\r
{\r
  BMM_CALLBACK_DATA           *BmmCallbackInfo;\r
\r
  BmmCallbackInfo = mBmmCallbackInfo;\r
  BmmCallbackInfo->BmmPreviousPageId             = FORM_MAIN_ID;\r
  BmmCallbackInfo->BmmCurrentPageId              = FORM_MAIN_ID;\r
  BmmCallbackInfo->FeCurrentState                = FileExplorerStateInActive;\r
  BmmCallbackInfo->FeDisplayContext              = FileExplorerDisplayUnknown;\r
\r
  InitAllMenu (BmmCallbackInfo);\r
\r
  CreateMenuStringToken (BmmCallbackInfo, BmmCallbackInfo->BmmHiiHandle, &ConsoleInpMenu);\r
  CreateMenuStringToken (BmmCallbackInfo, BmmCallbackInfo->BmmHiiHandle, &ConsoleOutMenu);\r
  CreateMenuStringToken (BmmCallbackInfo, BmmCallbackInfo->BmmHiiHandle, &ConsoleErrMenu);\r
  CreateMenuStringToken (BmmCallbackInfo, BmmCallbackInfo->BmmHiiHandle, &BootOptionMenu);\r
  CreateMenuStringToken (BmmCallbackInfo, BmmCallbackInfo->BmmHiiHandle, &DriverOptionMenu);\r
  CreateMenuStringToken (BmmCallbackInfo, BmmCallbackInfo->BmmHiiHandle, &TerminalMenu);\r
  CreateMenuStringToken (BmmCallbackInfo, BmmCallbackInfo->BmmHiiHandle, &DriverMenu);\r
\r
  InitializeBmmConfig(BmmCallbackInfo);\r
}\r
\r
/**\r
  Initialized all Menu Option List.\r
\r
  @param CallbackData    The BMM context data.\r
\r
**/\r
VOID\r
InitAllMenu (\r
  IN  BMM_CALLBACK_DATA    *CallbackData\r
  )\r
{\r
  InitializeListHead (&BootOptionMenu.Head);\r
  InitializeListHead (&DriverOptionMenu.Head);\r
  BOpt_GetBootOptions (CallbackData);\r
  BOpt_GetDriverOptions (CallbackData);\r
  InitializeListHead (&FsOptionMenu.Head);\r
  BOpt_FindDrivers ();\r
  InitializeListHead (&DirectoryMenu.Head);\r
  InitializeListHead (&ConsoleInpMenu.Head);\r
  InitializeListHead (&ConsoleOutMenu.Head);\r
  InitializeListHead (&ConsoleErrMenu.Head);\r
  InitializeListHead (&TerminalMenu.Head);\r
  LocateSerialIo ();\r
  GetAllConsoles ();\r
  mAllMenuInit = TRUE;\r
}\r
\r
/**\r
  Free up all Menu Option list.\r
\r
**/\r
VOID\r
FreeAllMenu (\r
  VOID\r
  )\r
{\r
  if (!mAllMenuInit){\r
    return;\r
  }\r
  BOpt_FreeMenu (&DirectoryMenu);\r
  BOpt_FreeMenu (&FsOptionMenu);\r
  BOpt_FreeMenu (&BootOptionMenu);\r
  BOpt_FreeMenu (&DriverOptionMenu);\r
  BOpt_FreeMenu (&DriverMenu);\r
  FreeAllConsoles ();\r
  mAllMenuInit = FALSE;\r
}\r
\r
/**\r
  Initialize all the string depositories.\r
\r
**/\r
VOID\r
InitializeStringDepository (\r
  VOID\r
  )\r
{\r
  STRING_DEPOSITORY *StringDepository;\r
  StringDepository              = AllocateZeroPool (sizeof (STRING_DEPOSITORY) * STRING_DEPOSITORY_NUMBER);\r
  FileOptionStrDepository       = StringDepository++;\r
  ConsoleOptionStrDepository    = StringDepository++;\r
  BootOptionStrDepository       = StringDepository++;\r
  BootOptionHelpStrDepository   = StringDepository++;\r
  DriverOptionStrDepository     = StringDepository++;\r
  DriverOptionHelpStrDepository = StringDepository++;\r
  TerminalStrDepository         = StringDepository;\r
}\r
\r
/**\r
  Fetch a usable string node from the string depository and return the string token.\r
\r
  @param CallbackData       The BMM context data.\r
  @param StringDepository   The string repository.\r
\r
  @retval  EFI_STRING_ID           String token.\r
\r
**/\r
EFI_STRING_ID\r
GetStringTokenFromDepository (\r
  IN   BMM_CALLBACK_DATA     *CallbackData,\r
  IN   STRING_DEPOSITORY     *StringDepository\r
  )\r
{\r
  STRING_LIST_NODE  *CurrentListNode;\r
  STRING_LIST_NODE  *NextListNode;\r
\r
  CurrentListNode = StringDepository->CurrentNode;\r
\r
  if ((NULL != CurrentListNode) && (NULL != CurrentListNode->Next)) {\r
    //\r
    // Fetch one reclaimed node from the list.\r
    //\r
    NextListNode = StringDepository->CurrentNode->Next;\r
  } else {\r
    //\r
    // If there is no usable node in the list, update the list.\r
    //\r
    NextListNode = AllocateZeroPool (sizeof (STRING_LIST_NODE));\r
    ASSERT (NextListNode != NULL);\r
    NextListNode->StringToken = HiiSetString (CallbackData->BmmHiiHandle, 0, L" ", NULL);\r
    ASSERT (NextListNode->StringToken != 0);\r
\r
    StringDepository->TotalNodeNumber++;\r
\r
    if (NULL == CurrentListNode) {\r
      StringDepository->ListHead = NextListNode;\r
    } else {\r
      CurrentListNode->Next = NextListNode;\r
    }\r
  }\r
\r
  StringDepository->CurrentNode = NextListNode;\r
\r
  return StringDepository->CurrentNode->StringToken;\r
}\r
\r
/**\r
  Reclaim string depositories by moving the current node pointer to list head..\r
\r
**/\r
VOID\r
ReclaimStringDepository (\r
  VOID\r
  )\r
{\r
  UINTN             DepositoryIndex;\r
  STRING_DEPOSITORY *StringDepository;\r
\r
  StringDepository = FileOptionStrDepository;\r
  for (DepositoryIndex = 0; DepositoryIndex < STRING_DEPOSITORY_NUMBER; DepositoryIndex++) {\r
    StringDepository->CurrentNode = StringDepository->ListHead;\r
    StringDepository++;\r
  }\r
}\r
\r
/**\r
  Release resource for all the string depositories.\r
\r
**/\r
VOID\r
CleanUpStringDepository (\r
  VOID\r
  )\r
{\r
  UINTN             NodeIndex;\r
  UINTN             DepositoryIndex;\r
  STRING_LIST_NODE  *CurrentListNode;\r
  STRING_LIST_NODE  *NextListNode;\r
  STRING_DEPOSITORY *StringDepository;\r
\r
  //\r
  // Release string list nodes.\r
  //\r
  StringDepository = FileOptionStrDepository;\r
  for (DepositoryIndex = 0; DepositoryIndex < STRING_DEPOSITORY_NUMBER; DepositoryIndex++) {\r
    CurrentListNode = StringDepository->ListHead;\r
    for (NodeIndex = 0; NodeIndex < StringDepository->TotalNodeNumber; NodeIndex++) {\r
      NextListNode = CurrentListNode->Next;\r
      FreePool (CurrentListNode);\r
      CurrentListNode = NextListNode;\r
    }\r
\r
    StringDepository++;\r
  }\r
  //\r
  // Release string depository.\r
  //\r
  FreePool (FileOptionStrDepository);\r
}\r
\r
/**\r
  Install BootMaint and FileExplorer HiiPackages.\r
\r
**/\r
VOID\r
InitBootMaintenance(\r
  VOID\r
  )\r
{\r
  BMM_CALLBACK_DATA        *BmmCallbackInfo;\r
  EFI_STATUS               Status;\r
  UINT8                    *Ptr;\r
\r
  Status = EFI_SUCCESS;\r
\r
  if (!gConnectAllHappened){\r
    EfiBootManagerConnectAll();\r
    gConnectAllHappened = TRUE;\r
  }\r
\r
  EfiBootManagerRefreshAllBootOption ();\r
\r
  //\r
  // Create CallbackData structures for Driver Callback\r
  //\r
  BmmCallbackInfo = AllocateZeroPool (sizeof (BMM_CALLBACK_DATA));\r
  ASSERT (BmmCallbackInfo != NULL);\r
\r
  //\r
  // Create LoadOption in BmmCallbackInfo for Driver Callback\r
  //\r
  Ptr = AllocateZeroPool (sizeof (BM_LOAD_CONTEXT) + sizeof (BM_FILE_CONTEXT) + sizeof (BM_HANDLE_CONTEXT) + sizeof (BM_MENU_ENTRY));\r
  ASSERT (Ptr != NULL);\r
\r
  //\r
  // Initialize Bmm callback data.\r
  //\r
  BmmCallbackInfo->LoadContext = (BM_LOAD_CONTEXT *) Ptr;\r
  Ptr += sizeof (BM_LOAD_CONTEXT);\r
\r
  BmmCallbackInfo->FileContext = (BM_FILE_CONTEXT *) Ptr;\r
  Ptr += sizeof (BM_FILE_CONTEXT);\r
\r
  BmmCallbackInfo->HandleContext = (BM_HANDLE_CONTEXT *) Ptr;\r
  Ptr += sizeof (BM_HANDLE_CONTEXT);\r
\r
  BmmCallbackInfo->MenuEntry     = (BM_MENU_ENTRY *) Ptr;\r
\r
  BmmCallbackInfo->Signature                     = BMM_CALLBACK_DATA_SIGNATURE;\r
  BmmCallbackInfo->BmmConfigAccess.ExtractConfig = BootMaintExtractConfig;\r
  BmmCallbackInfo->BmmConfigAccess.RouteConfig   = BootMaintRouteConfig;\r
  BmmCallbackInfo->BmmConfigAccess.Callback      = BootMaintCallback;\r
  BmmCallbackInfo->BmmPreviousPageId             = FORM_MAIN_ID;\r
  BmmCallbackInfo->BmmCurrentPageId              = FORM_MAIN_ID;\r
  BmmCallbackInfo->FeConfigAccess.ExtractConfig  = FakeExtractConfig;\r
  BmmCallbackInfo->FeConfigAccess.RouteConfig    = FakeRouteConfig;\r
  BmmCallbackInfo->FeConfigAccess.Callback       = FileExplorerCallback;\r
  BmmCallbackInfo->FeCurrentState                = FileExplorerStateInActive;\r
  BmmCallbackInfo->FeDisplayContext              = FileExplorerDisplayUnknown;\r
\r
  //\r
  // Install Device Path Protocol and Config Access protocol to driver handle\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &BmmCallbackInfo->BmmDriverHandle,\r
                  &gEfiDevicePathProtocolGuid,\r
                  &mBmmHiiVendorDevicePath,\r
                  &gEfiHiiConfigAccessProtocolGuid,\r
                  &BmmCallbackInfo->BmmConfigAccess,\r
                  NULL\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Install Device Path Protocol and Config Access protocol to driver handle\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &BmmCallbackInfo->FeDriverHandle,\r
                  &gEfiDevicePathProtocolGuid,\r
                  &mFeHiiVendorDevicePath,\r
                  &gEfiHiiConfigAccessProtocolGuid,\r
                  &BmmCallbackInfo->FeConfigAccess,\r
                  NULL\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Post our Boot Maint VFR binary to the HII database.\r
  //\r
  BmmCallbackInfo->BmmHiiHandle = HiiAddPackages (\r
                                    &mBootMaintGuid,\r
                                    BmmCallbackInfo->BmmDriverHandle,\r
                                    BmBin,\r
                                    UiAppStrings,\r
                                    NULL\r
                                    );\r
  ASSERT (BmmCallbackInfo->BmmHiiHandle != NULL);\r
\r
  //\r
  // Post our File Explorer VFR binary to the HII database.\r
  //\r
  BmmCallbackInfo->FeHiiHandle = HiiAddPackages (\r
                                   &mFileExplorerGuid,\r
                                   BmmCallbackInfo->FeDriverHandle,\r
                                   FEBin,\r
                                   UiAppStrings,\r
                                   NULL\r
                                   );\r
  ASSERT (BmmCallbackInfo->FeHiiHandle != NULL);\r
\r
  //\r
  // Init OpCode Handle and Allocate space for creation of Buffer\r
  //\r
  mStartOpCodeHandle = HiiAllocateOpCodeHandle ();\r
  ASSERT (mStartOpCodeHandle != NULL);\r
\r
  mEndOpCodeHandle = HiiAllocateOpCodeHandle ();\r
  ASSERT (mEndOpCodeHandle != NULL);\r
\r
  //\r
  // Create Hii Extend Label OpCode as the start opcode\r
  //\r
  mStartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (mStartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r
  mStartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
\r
  //\r
  // Create Hii Extend Label OpCode as the end opcode\r
  //\r
  mEndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (mEndOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r
  mEndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
  mEndLabel->Number       = LABEL_END;\r
\r
  mBmmCallbackInfo = BmmCallbackInfo;\r
\r
  InitializeStringDepository ();\r
\r
}\r
\r
/**\r
  Remove the installed BootMaint and FileExplorer HiiPackages.\r
\r
**/\r
\r
VOID\r
FreeBMPackage(\r
  VOID\r
  )\r
{\r
  BMM_CALLBACK_DATA         *BmmCallbackInfo;\r
\r
  if (mStartOpCodeHandle != NULL) {\r
    HiiFreeOpCodeHandle (mStartOpCodeHandle);\r
  }\r
\r
  if (mEndOpCodeHandle != NULL) {\r
    HiiFreeOpCodeHandle (mEndOpCodeHandle);\r
  }\r
\r
  FreeAllMenu ();\r
  CleanUpStringDepository ();\r
\r
  BmmCallbackInfo = mBmmCallbackInfo;\r
\r
  //\r
  // Remove our IFR data from HII database\r
  //\r
  HiiRemovePackages (BmmCallbackInfo->BmmHiiHandle);\r
  HiiRemovePackages (BmmCallbackInfo->FeHiiHandle);\r
\r
  gBS->UninstallMultipleProtocolInterfaces (\r
         BmmCallbackInfo->FeDriverHandle,\r
         &gEfiDevicePathProtocolGuid,\r
         &mFeHiiVendorDevicePath,\r
         &gEfiHiiConfigAccessProtocolGuid,\r
         &BmmCallbackInfo->FeConfigAccess,\r
         NULL\r
         );\r
\r
  gBS->UninstallMultipleProtocolInterfaces (\r
         BmmCallbackInfo->BmmDriverHandle,\r
         &gEfiDevicePathProtocolGuid,\r
         &mBmmHiiVendorDevicePath,\r
         &gEfiHiiConfigAccessProtocolGuid,\r
         &BmmCallbackInfo->BmmConfigAccess,\r
         NULL\r
         );\r
\r
  FreePool (BmmCallbackInfo->LoadContext);\r
  FreePool (BmmCallbackInfo);\r
}\r
\r