IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/FileExplorer.c

   1 /** @file
   2   File explorer related functions.
   3
   4 Copyright (c) 2004 - 2008, Intel Corporation. <BR>
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #include "BootMaint.h"
  16
  17 /**
  18   Update the File Explore page.
  19
  20   @param CallbackData    The BMM context data.
  21   @param MenuOption      Pointer to menu options to display.
  22
  23 **/
  24 VOID
  25 UpdateFileExplorePage (
  26   IN BMM_CALLBACK_DATA            *CallbackData,
  27   BM_MENU_OPTION                  *MenuOption
  28   )
  29 {
  30   UINTN           Index;
  31   BM_MENU_ENTRY   *NewMenuEntry;
  32   BM_FILE_CONTEXT *NewFileContext;
  33   EFI_FORM_ID     FormId;
  34
  35   NewMenuEntry    = NULL;
  36   NewFileContext  = NULL;
  37   FormId          = 0;
  38
  39   RefreshUpdateData ();
  40   mStartLabel->Number = FORM_FILE_EXPLORER_ID;
  41
  42   for (Index = 0; Index < MenuOption->MenuNumber; Index++) {
  43     NewMenuEntry    = BOpt_GetMenuEntry (MenuOption, Index);
  44     NewFileContext  = (BM_FILE_CONTEXT *) NewMenuEntry->VariableContext;
  45
  46     if (NewFileContext->IsBootLegacy) {
  47       continue;
  48     }
  49
  50     if ((NewFileContext->IsDir) || (BOOT_FROM_FILE_STATE == CallbackData->FeCurrentState)) {
  51       //
  52       // Create Text opcode for directory, also create Text opcode for file in BOOT_FROM_FILE_STATE.
  53       //
  54       HiiCreateActionOpCode (
  55         mStartOpCodeHandle,
  56         (UINT16) (FILE_OPTION_OFFSET + Index),
  57         NewMenuEntry->DisplayStringToken,
  58         STRING_TOKEN (STR_NULL_STRING),
  59         EFI_IFR_FLAG_CALLBACK,
  60         0
  61         );
  62     } else {
  63       //
  64       // Create Goto opcode for file in ADD_BOOT_OPTION_STATE or ADD_DRIVER_OPTION_STATE.
  65       //
  66       if (ADD_BOOT_OPTION_STATE == CallbackData->FeCurrentState) {
  67         FormId = FORM_BOOT_ADD_DESCRIPTION_ID;
  68       } else if (ADD_DRIVER_OPTION_STATE == CallbackData->FeCurrentState) {
  69         FormId = FORM_DRIVER_ADD_FILE_DESCRIPTION_ID;
  70       }
  71
  72       HiiCreateGotoOpCode (
  73         mStartOpCodeHandle,
  74         FormId,
  75         NewMenuEntry->DisplayStringToken,
  76         STRING_TOKEN (STR_NULL_STRING),
  77         EFI_IFR_FLAG_CALLBACK,
  78         (UINT16) (FILE_OPTION_OFFSET + Index)
  79         );
  80     }
  81   }
  82
  83   HiiUpdateForm (
  84     CallbackData->FeHiiHandle,
  85     &mFileExplorerGuid,
  86     FORM_FILE_EXPLORER_ID,
  87     mStartOpCodeHandle, // Label FORM_FILE_EXPLORER_ID
  88     mEndOpCodeHandle    // LABEL_END
  89     );
  90 }
  91
  92 /**
  93   Update the file explower page with the refershed file system.
  94
  95
  96   @param CallbackData    BMM context data
  97   @param KeyValue        Key value to identify the type of data to expect.
  98
  99   @retval  TRUE           Inform the caller to create a callback packet to exit file explorer.
 100   @retval  FALSE          Indicate that there is no need to exit file explorer.
 101
 102 **/
 103 BOOLEAN
 104 UpdateFileExplorer (
 105   IN BMM_CALLBACK_DATA            *CallbackData,
 106   IN UINT16                       KeyValue
 107   )
 108 {
 109   UINT16          FileOptionMask;
 110   BM_MENU_ENTRY   *NewMenuEntry;
 111   BM_FILE_CONTEXT *NewFileContext;
 112   EFI_FORM_ID     FormId;
 113   BOOLEAN         ExitFileExplorer;
 114   EFI_STATUS      Status;
 115
 116   NewMenuEntry      = NULL;
 117   NewFileContext    = NULL;
 118   ExitFileExplorer  = FALSE;
 119
 120   FileOptionMask    = (UINT16) (FILE_OPTION_MASK & KeyValue);
 121
 122   if (UNKNOWN_CONTEXT == CallbackData->FeDisplayContext) {
 123     //
 124     // First in, display file system.
 125     //
 126     BOpt_FreeMenu (&FsOptionMenu);
 127     BOpt_FindFileSystem (CallbackData);
 128     CreateMenuStringToken (CallbackData, CallbackData->FeHiiHandle, &FsOptionMenu);
 129
 130     UpdateFileExplorePage (CallbackData, &FsOptionMenu);
 131
 132     CallbackData->FeDisplayContext = FILE_SYSTEM;
 133   } else {
 134     if (FILE_SYSTEM == CallbackData->FeDisplayContext) {
 135       NewMenuEntry = BOpt_GetMenuEntry (&FsOptionMenu, FileOptionMask);
 136     } else if (DIRECTORY == CallbackData->FeDisplayContext) {
 137       NewMenuEntry = BOpt_GetMenuEntry (&DirectoryMenu, FileOptionMask);
 138     }
 139
 140     CallbackData->FeDisplayContext  = DIRECTORY;
 141
 142     NewFileContext                  = (BM_FILE_CONTEXT *) NewMenuEntry->VariableContext;
 143
 144     if (NewFileContext->IsDir ) {
 145       RemoveEntryList (&NewMenuEntry->Link);
 146       BOpt_FreeMenu (&DirectoryMenu);
 147       Status = BOpt_FindFiles (CallbackData, NewMenuEntry);
 148        if (EFI_ERROR (Status)) {
 149          ExitFileExplorer = TRUE;
 150          goto exit;
 151        }
 152       CreateMenuStringToken (CallbackData, CallbackData->FeHiiHandle, &DirectoryMenu);
 153       BOpt_DestroyMenuEntry (NewMenuEntry);
 154
 155       UpdateFileExplorePage (CallbackData, &DirectoryMenu);
 156
 157     } else {
 158       switch (CallbackData->FeCurrentState) {
 159       case BOOT_FROM_FILE_STATE:
 160         //
 161         // Here boot from file
 162         //
 163         BootThisFile (NewFileContext);
 164         ExitFileExplorer = TRUE;
 165         break;
 166
 167       case ADD_BOOT_OPTION_STATE:
 168       case ADD_DRIVER_OPTION_STATE:
 169         if (ADD_BOOT_OPTION_STATE == CallbackData->FeCurrentState) {
 170           FormId = FORM_BOOT_ADD_DESCRIPTION_ID;
 171         } else {
 172           FormId = FORM_DRIVER_ADD_FILE_DESCRIPTION_ID;
 173         }
 174
 175         CallbackData->MenuEntry = NewMenuEntry;
 176         CallbackData->LoadContext->FilePathList = ((BM_FILE_CONTEXT *) (CallbackData->MenuEntry->VariableContext))->DevicePath;
 177
 178         //
 179         // Create Subtitle op-code for the display string of the option.
 180         //
 181         RefreshUpdateData ();
 182         mStartLabel->Number = FormId;
 183
 184         HiiCreateSubTitleOpCode (
 185           mStartOpCodeHandle,
 186           NewMenuEntry->DisplayStringToken,
 187           0,
 188           0,
 189           0
 190           );
 191
 192         HiiUpdateForm (
 193           CallbackData->FeHiiHandle,
 194           &mFileExplorerGuid,
 195           FormId,
 196           mStartOpCodeHandle, // Label FormId
 197           mEndOpCodeHandle    // LABEL_END
 198           );
 199         break;
 200
 201       default:
 202         break;
 203       }
 204     }
 205   }
 206   exit:
 207   return ExitFileExplorer;
 208 }
 209
 210 /**
 211   This function processes the results of changes in configuration.
 212   When user select a interactive opcode, this callback will be triggered.
 213   Based on the Question(QuestionId) that triggers the callback, the corresponding
 214   actions is performed. It handles:
 215
 216   1) the addition of boot option.
 217   2) the addition of driver option.
 218   3) exit from file browser
 219   4) update of file content if a dir is selected.
 220   5) boot the file if a file is selected in "boot from file"
 221
 222
 223   @param This            Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
 224   @param Action          Specifies the type of action taken by the browser.
 225   @param QuestionId      A unique value which is sent to the original exporting driver
 226                          so that it can identify the type of data to expect.
 227   @param Type            The type of value for the question.
 228   @param Value           A pointer to the data being sent to the original exporting driver.
 229   @param ActionRequest   On return, points to the action requested by the callback function.
 230
 231   @retval  EFI_SUCCESS           The callback successfully handled the action.
 232   @retval  EFI_OUT_OF_RESOURCES  Not enough storage is available to hold the variable and its data.
 233   @retval  EFI_DEVICE_ERROR      The variable could not be saved.
 234   @retval  EFI_UNSUPPORTED       The specified Action is not supported by the callback.
 235   @retval  EFI_INVALID_PARAMETER If paramter Value or ActionRequest is NULL.
 236 **/
 237 EFI_STATUS
 238 EFIAPI
 239 FileExplorerCallback (
 240   IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL   *This,
 241   IN  EFI_BROWSER_ACTION                     Action,
 242   IN  EFI_QUESTION_ID                        QuestionId,
 243   IN  UINT8                                  Type,
 244   IN  EFI_IFR_TYPE_VALUE                     *Value,
 245   OUT EFI_BROWSER_ACTION_REQUEST             *ActionRequest
 246   )
 247 {
 248   BMM_CALLBACK_DATA     *Private;
 249   FILE_EXPLORER_NV_DATA *NvRamMap;
 250   EFI_STATUS            Status;
 251
 252   if ((Value == NULL) || (ActionRequest == NULL)) {
 253     return EFI_INVALID_PARAMETER;
 254   }
 255
 256   Status         = EFI_SUCCESS;
 257   Private        = FE_CALLBACK_DATA_FROM_THIS (This);
 258   *ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
 259
 260   //
 261   // Retrieve uncommitted data from Form Browser
 262   //
 263   NvRamMap = &Private->FeFakeNvData;
 264   HiiGetBrowserData (&mFileExplorerGuid, mFileExplorerStorageName, sizeof (FILE_EXPLORER_NV_DATA), (UINT8 *) NvRamMap);
 265
 266   if (QuestionId == KEY_VALUE_SAVE_AND_EXIT_BOOT || QuestionId == KEY_VALUE_SAVE_AND_EXIT_DRIVER) {
 267     //
 268     // Apply changes and exit formset
 269     //
 270     if (ADD_BOOT_OPTION_STATE == Private->FeCurrentState) {
 271       Status = Var_UpdateBootOption (Private, NvRamMap);
 272       if (EFI_ERROR (Status)) {
 273         return Status;
 274       }
 275
 276       BOpt_GetBootOptions (Private);
 277       CreateMenuStringToken (Private, Private->FeHiiHandle, &BootOptionMenu);
 278     } else if (ADD_DRIVER_OPTION_STATE == Private->FeCurrentState) {
 279       Status = Var_UpdateDriverOption (
 280                 Private,
 281                 Private->FeHiiHandle,
 282                 NvRamMap->DescriptionData,
 283                 NvRamMap->OptionalData,
 284                 NvRamMap->ForceReconnect
 285                 );
 286       if (EFI_ERROR (Status)) {
 287         return Status;
 288       }
 289
 290       BOpt_GetDriverOptions (Private);
 291       CreateMenuStringToken (Private, Private->FeHiiHandle, &DriverOptionMenu);
 292     }
 293
 294     *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;
 295   } else if (QuestionId == KEY_VALUE_NO_SAVE_AND_EXIT_BOOT || QuestionId == KEY_VALUE_NO_SAVE_AND_EXIT_DRIVER) {
 296     //
 297     // Discard changes and exit formset
 298     //
 299     NvRamMap->OptionalData[0]     = 0x0000;
 300     NvRamMap->DescriptionData[0]  = 0x0000;
 301     *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;
 302   } else if (QuestionId < FILE_OPTION_OFFSET) {
 303     //
 304     // Exit File Explorer formset
 305     //
 306     *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;
 307   } else {
 308     if (UpdateFileExplorer (Private, QuestionId)) {
 309       *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;
 310     }
 311   }
 312
 313   return Status;
 314 }