MdeModulePkg/Library/BootMaintenanceManagerUiLib/BootMaintenance.c

   1 /** @file
   2 The functions for Boot Maintainence Main menu.
   3
   4 Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>
   5 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 "BootMaintenanceManager.h"
  16
  17 #define FRONT_PAGE_KEY_OFFSET          0x4000
  18 //
  19 // Boot video resolution and text mode.
  20 //
  21 UINT32    mBmmBootHorizontalResolution    = 0;
  22 UINT32    mBmmBootVerticalResolution      = 0;
  23 UINT32    mBmmBootTextModeColumn          = 0;
  24 UINT32    mBmmBootTextModeRow             = 0;
  25 //
  26 // BIOS setup video resolution and text mode.
  27 //
  28 UINT32    mBmmSetupTextModeColumn         = 0;
  29 UINT32    mBmmSetupTextModeRow            = 0;
  30 UINT32    mBmmSetupHorizontalResolution   = 0;
  31 UINT32    mBmmSetupVerticalResolution     = 0;
  32
  33 BOOLEAN   mBmmModeInitialized             = FALSE;
  34
  35 EFI_DEVICE_PATH_PROTOCOL  EndDevicePath[] = {
  36   {
  37     END_DEVICE_PATH_TYPE,
  38     END_ENTIRE_DEVICE_PATH_SUBTYPE,
  39     {
  40       END_DEVICE_PATH_LENGTH,
  41       0
  42     }
  43   }
  44 };
  45
  46 HII_VENDOR_DEVICE_PATH  mBmmHiiVendorDevicePath = {
  47   {
  48     {
  49       HARDWARE_DEVICE_PATH,
  50       HW_VENDOR_DP,
  51       {
  52         (UINT8) (sizeof (VENDOR_DEVICE_PATH)),
  53         (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)
  54       }
  55     },
  56     //
  57     // {165A028F-0BB2-4b5f-8747-77592E3F6499}
  58     //
  59     { 0x165a028f, 0xbb2, 0x4b5f, { 0x87, 0x47, 0x77, 0x59, 0x2e, 0x3f, 0x64, 0x99 } }
  60   },
  61   {
  62     END_DEVICE_PATH_TYPE,
  63     END_ENTIRE_DEVICE_PATH_SUBTYPE,
  64     {
  65       (UINT8) (END_DEVICE_PATH_LENGTH),
  66       (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)
  67     }
  68   }
  69 };
  70
  71 EFI_GUID mBootMaintGuid          = BOOT_MAINT_FORMSET_GUID;
  72
  73 CHAR16  mBootMaintStorageName[]     = L"BmmData";
  74 BMM_CALLBACK_DATA  gBootMaintenancePrivate = {
  75   BMM_CALLBACK_DATA_SIGNATURE,
  76   NULL,
  77   NULL,
  78   {
  79     BootMaintExtractConfig,
  80     BootMaintRouteConfig,
  81     BootMaintCallback
  82   }
  83 };
  84
  85 BMM_CALLBACK_DATA *mBmmCallbackInfo = &gBootMaintenancePrivate;
  86 BOOLEAN  mAllMenuInit               = FALSE;
  87
  88 /**
  89   Init all memu.
  90
  91   @param CallbackData    The BMM context data.
  92
  93 **/
  94 VOID
  95 InitAllMenu (
  96   IN  BMM_CALLBACK_DATA    *CallbackData
  97   );
  98
  99 /**
 100   Free up all Menu Option list.
 101
 102 **/
 103 VOID
 104 FreeAllMenu (
 105   VOID
 106   );
 107
 108 /**
 109   This function will change video resolution and text mode
 110   according to defined setup mode or defined boot mode
 111
 112   @param  IsSetupMode   Indicate mode is changed to setup mode or boot mode.
 113
 114   @retval  EFI_SUCCESS  Mode is changed successfully.
 115   @retval  Others       Mode failed to be changed.
 116
 117 **/
 118 EFI_STATUS
 119 BmmSetConsoleMode (
 120   BOOLEAN  IsSetupMode
 121   )
 122 {
 123   EFI_GRAPHICS_OUTPUT_PROTOCOL          *GraphicsOutput;
 124   EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL       *SimpleTextOut;
 125   UINTN                                 SizeOfInfo;
 126   EFI_GRAPHICS_OUTPUT_MODE_INFORMATION  *Info;
 127   UINT32                                MaxGopMode;
 128   UINT32                                MaxTextMode;
 129   UINT32                                ModeNumber;
 130   UINT32                                NewHorizontalResolution;
 131   UINT32                                NewVerticalResolution;
 132   UINT32                                NewColumns;
 133   UINT32                                NewRows;
 134   UINTN                                 HandleCount;
 135   EFI_HANDLE                            *HandleBuffer;
 136   EFI_STATUS                            Status;
 137   UINTN                                 Index;
 138   UINTN                                 CurrentColumn;
 139   UINTN                                 CurrentRow;
 140
 141   MaxGopMode  = 0;
 142   MaxTextMode = 0;
 143
 144   //
 145   // Get current video resolution and text mode
 146   //
 147   Status = gBS->HandleProtocol (
 148                   gST->ConsoleOutHandle,
 149                   &gEfiGraphicsOutputProtocolGuid,
 150                   (VOID**)&GraphicsOutput
 151                   );
 152   if (EFI_ERROR (Status)) {
 153     GraphicsOutput = NULL;
 154   }
 155
 156   Status = gBS->HandleProtocol (
 157                   gST->ConsoleOutHandle,
 158                   &gEfiSimpleTextOutProtocolGuid,
 159                   (VOID**)&SimpleTextOut
 160                   );
 161   if (EFI_ERROR (Status)) {
 162     SimpleTextOut = NULL;
 163   }
 164
 165   if ((GraphicsOutput == NULL) || (SimpleTextOut == NULL)) {
 166     return EFI_UNSUPPORTED;
 167   }
 168
 169   if (IsSetupMode) {
 170     //
 171     // The requried resolution and text mode is setup mode.
 172     //
 173     NewHorizontalResolution = mBmmSetupHorizontalResolution;
 174     NewVerticalResolution   = mBmmSetupVerticalResolution;
 175     NewColumns              = mBmmSetupTextModeColumn;
 176     NewRows                 = mBmmSetupTextModeRow;
 177   } else {
 178     //
 179     // The required resolution and text mode is boot mode.
 180     //
 181     NewHorizontalResolution = mBmmBootHorizontalResolution;
 182     NewVerticalResolution   = mBmmBootVerticalResolution;
 183     NewColumns              = mBmmBootTextModeColumn;
 184     NewRows                 = mBmmBootTextModeRow;
 185   }
 186
 187   if (GraphicsOutput != NULL) {
 188     MaxGopMode  = GraphicsOutput->Mode->MaxMode;
 189   }
 190
 191   if (SimpleTextOut != NULL) {
 192     MaxTextMode = SimpleTextOut->Mode->MaxMode;
 193   }
 194
 195   //
 196   // 1. If current video resolution is same with required video resolution,
 197   //    video resolution need not be changed.
 198   //    1.1. If current text mode is same with required text mode, text mode need not be changed.
 199   //    1.2. If current text mode is different from required text mode, text mode need be changed.
 200   // 2. If current video resolution is different from required video resolution, we need restart whole console drivers.
 201   //
 202   for (ModeNumber = 0; ModeNumber < MaxGopMode; ModeNumber++) {
 203     Status = GraphicsOutput->QueryMode (
 204                        GraphicsOutput,
 205                        ModeNumber,
 206                        &SizeOfInfo,
 207                        &Info
 208                        );
 209     if (!EFI_ERROR (Status)) {
 210       if ((Info->HorizontalResolution == NewHorizontalResolution) &&
 211           (Info->VerticalResolution == NewVerticalResolution)) {
 212         if ((GraphicsOutput->Mode->Info->HorizontalResolution == NewHorizontalResolution) &&
 213             (GraphicsOutput->Mode->Info->VerticalResolution == NewVerticalResolution)) {
 214           //
 215           // Current resolution is same with required resolution, check if text mode need be set
 216           //
 217           Status = SimpleTextOut->QueryMode (SimpleTextOut, SimpleTextOut->Mode->Mode, &CurrentColumn, &CurrentRow);
 218           ASSERT_EFI_ERROR (Status);
 219           if (CurrentColumn == NewColumns && CurrentRow == NewRows) {
 220             //
 221             // If current text mode is same with required text mode. Do nothing
 222             //
 223             FreePool (Info);
 224             return EFI_SUCCESS;
 225           } else {
 226             //
 227             // If current text mode is different from requried text mode.  Set new video mode
 228             //
 229             for (Index = 0; Index < MaxTextMode; Index++) {
 230               Status = SimpleTextOut->QueryMode (SimpleTextOut, Index, &CurrentColumn, &CurrentRow);
 231               if (!EFI_ERROR(Status)) {
 232                 if ((CurrentColumn == NewColumns) && (CurrentRow == NewRows)) {
 233                   //
 234                   // Required text mode is supported, set it.
 235                   //
 236                   Status = SimpleTextOut->SetMode (SimpleTextOut, Index);
 237                   ASSERT_EFI_ERROR (Status);
 238                   //
 239                   // Update text mode PCD.
 240                   //
 241                   Status = PcdSet32S (PcdConOutColumn, mBmmSetupTextModeColumn);
 242                   ASSERT_EFI_ERROR (Status);
 243                   Status = PcdSet32S (PcdConOutRow, mBmmSetupTextModeRow);
 244                   ASSERT_EFI_ERROR (Status);
 245                   FreePool (Info);
 246                   return EFI_SUCCESS;
 247                 }
 248               }
 249             }
 250             if (Index == MaxTextMode) {
 251               //
 252               // If requried text mode is not supported, return error.
 253               //
 254               FreePool (Info);
 255               return EFI_UNSUPPORTED;
 256             }
 257           }
 258         } else {
 259           //
 260           // If current video resolution is not same with the new one, set new video resolution.
 261           // In this case, the driver which produces simple text out need be restarted.
 262           //
 263           Status = GraphicsOutput->SetMode (GraphicsOutput, ModeNumber);
 264           if (!EFI_ERROR (Status)) {
 265             FreePool (Info);
 266             break;
 267           }
 268         }
 269       }
 270       FreePool (Info);
 271     }
 272   }
 273
 274   if (ModeNumber == MaxGopMode) {
 275     //
 276     // If the resolution is not supported, return error.
 277     //
 278     return EFI_UNSUPPORTED;
 279   }
 280
 281   //
 282   // Set PCD to Inform GraphicsConsole to change video resolution.
 283   // Set PCD to Inform Consplitter to change text mode.
 284   //
 285   Status = PcdSet32S (PcdVideoHorizontalResolution, NewHorizontalResolution);
 286   ASSERT_EFI_ERROR (Status);
 287   Status = PcdSet32S (PcdVideoVerticalResolution, NewVerticalResolution);
 288   ASSERT_EFI_ERROR (Status);
 289   Status = PcdSet32S (PcdConOutColumn, NewColumns);
 290   ASSERT_EFI_ERROR (Status);
 291   Status = PcdSet32S (PcdConOutRow, NewRows);
 292   ASSERT_EFI_ERROR (Status);
 293
 294   //
 295   // Video mode is changed, so restart graphics console driver and higher level driver.
 296   // Reconnect graphics console driver and higher level driver.
 297   // Locate all the handles with GOP protocol and reconnect it.
 298   //
 299   Status = gBS->LocateHandleBuffer (
 300                    ByProtocol,
 301                    &gEfiSimpleTextOutProtocolGuid,
 302                    NULL,
 303                    &HandleCount,
 304                    &HandleBuffer
 305                    );
 306   if (!EFI_ERROR (Status)) {
 307     for (Index = 0; Index < HandleCount; Index++) {
 308       gBS->DisconnectController (HandleBuffer[Index], NULL, NULL);
 309     }
 310     for (Index = 0; Index < HandleCount; Index++) {
 311       gBS->ConnectController (HandleBuffer[Index], NULL, NULL, TRUE);
 312     }
 313     if (HandleBuffer != NULL) {
 314       FreePool (HandleBuffer);
 315     }
 316   }
 317
 318   return EFI_SUCCESS;
 319 }
 320
 321 /**
 322   This function converts an input device structure to a Unicode string.
 323
 324   @param DevPath      A pointer to the device path structure.
 325
 326   @return             A new allocated Unicode string that represents the device path.
 327
 328 **/
 329 CHAR16 *
 330 UiDevicePathToStr (
 331   IN EFI_DEVICE_PATH_PROTOCOL     *DevPath
 332   )
 333 {
 334   EFI_STATUS                       Status;
 335   CHAR16                           *ToText;
 336   EFI_DEVICE_PATH_TO_TEXT_PROTOCOL *DevPathToText;
 337
 338   if (DevPath == NULL) {
 339     return NULL;
 340   }
 341
 342   Status = gBS->LocateProtocol (
 343                   &gEfiDevicePathToTextProtocolGuid,
 344                   NULL,
 345                   (VOID **) &DevPathToText
 346                   );
 347   ASSERT_EFI_ERROR (Status);
 348   ToText = DevPathToText->ConvertDevicePathToText (
 349                             DevPath,
 350                             FALSE,
 351                             TRUE
 352                             );
 353   ASSERT (ToText != NULL);
 354   return ToText;
 355 }
 356
 357 /**
 358   Extract filename from device path. The returned buffer is allocated using AllocateCopyPool.
 359   The caller is responsible for freeing the allocated buffer using FreePool().
 360
 361   @param DevicePath       Device path.
 362
 363   @return                 A new allocated string that represents the file name.
 364
 365 **/
 366 CHAR16 *
 367 ExtractFileNameFromDevicePath (
 368   IN   EFI_DEVICE_PATH_PROTOCOL *DevicePath
 369   )
 370 {
 371   CHAR16          *String;
 372   CHAR16          *MatchString;
 373   CHAR16          *LastMatch;
 374   CHAR16          *FileName;
 375   UINTN           Length;
 376
 377   ASSERT(DevicePath != NULL);
 378
 379   String = UiDevicePathToStr(DevicePath);
 380   MatchString = String;
 381   LastMatch   = String;
 382
 383   while(MatchString != NULL){
 384     LastMatch   = MatchString + 1;
 385     MatchString = StrStr(LastMatch,L"\\");
 386   }
 387
 388   Length = StrLen(LastMatch);
 389   FileName = AllocateCopyPool ((Length + 1) * sizeof(CHAR16), LastMatch);
 390   *(FileName + Length) = 0;
 391
 392   FreePool(String);
 393
 394   return FileName;
 395 }
 396
 397 /**
 398   Extract device path for given HII handle and class guid.
 399
 400   @param Handle          The HII handle.
 401
 402   @retval  NULL          Fail to get the device path string.
 403   @return  PathString    Get the device path string.
 404
 405 **/
 406 CHAR16 *
 407 BmmExtractDevicePathFromHiiHandle (
 408   IN      EFI_HII_HANDLE      Handle
 409   )
 410 {
 411   EFI_STATUS                       Status;
 412   EFI_HANDLE                       DriverHandle;
 413
 414   ASSERT (Handle != NULL);
 415
 416   if (Handle == NULL) {
 417     return NULL;
 418   }
 419
 420   Status = gHiiDatabase->GetPackageListHandle (gHiiDatabase, Handle, &DriverHandle);
 421   if (EFI_ERROR (Status)) {
 422     return NULL;
 423   }
 424
 425   //
 426   // Get device path string.
 427   //
 428   return ConvertDevicePathToText(DevicePathFromHandle (DriverHandle), FALSE, FALSE);
 429
 430 }
 431
 432 /**
 433   This function allows a caller to extract the current configuration for one
 434   or more named elements from the target driver.
 435
 436   @param This            Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
 437   @param Request         A null-terminated Unicode string in <ConfigRequest> format.
 438   @param Progress        On return, points to a character in the Request string.
 439                          Points to the string's null terminator if request was successful.
 440                          Points to the most recent '&' before the first failing name/value
 441                          pair (or the beginning of the string if the failure is in the
 442                          first name/value pair) if the request was not successful.
 443   @param Results         A null-terminated Unicode string in <ConfigAltResp> format which
 444                          has all values filled in for the names in the Request string.
 445                          String to be allocated by the called function.
 446
 447   @retval  EFI_SUCCESS            The Results is filled with the requested values.
 448   @retval  EFI_OUT_OF_RESOURCES   Not enough memory to store the results.
 449   @retval  EFI_INVALID_PARAMETER  Request is NULL, illegal syntax, or unknown name.
 450   @retval  EFI_NOT_FOUND          Routing data doesn't match any storage in this driver.
 451
 452 **/
 453 EFI_STATUS
 454 EFIAPI
 455 BootMaintExtractConfig (
 456   IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL   *This,
 457   IN  CONST EFI_STRING                       Request,
 458   OUT EFI_STRING                             *Progress,
 459   OUT EFI_STRING                             *Results
 460   )
 461 {
 462   EFI_STATUS         Status;
 463   UINTN              BufferSize;
 464   BMM_CALLBACK_DATA  *Private;
 465   EFI_STRING                       ConfigRequestHdr;
 466   EFI_STRING                       ConfigRequest;
 467   BOOLEAN                          AllocatedRequest;
 468   UINTN                            Size;
 469
 470   if (Progress == NULL || Results == NULL) {
 471     return EFI_INVALID_PARAMETER;
 472   }
 473
 474   *Progress = Request;
 475   if ((Request != NULL) && !HiiIsConfigHdrMatch (Request, &mBootMaintGuid, mBootMaintStorageName)) {
 476     return EFI_NOT_FOUND;
 477   }
 478
 479   ConfigRequestHdr = NULL;
 480   ConfigRequest    = NULL;
 481   AllocatedRequest = FALSE;
 482   Size             = 0;
 483
 484   Private = BMM_CALLBACK_DATA_FROM_THIS (This);
 485   //
 486   // Convert buffer data to <ConfigResp> by helper function BlockToConfig()
 487   //
 488   BufferSize = sizeof (BMM_FAKE_NV_DATA);
 489   ConfigRequest = Request;
 490   if ((Request == NULL) || (StrStr (Request, L"OFFSET") == NULL)) {
 491     //
 492     // Request has no request element, construct full request string.
 493     // Allocate and fill a buffer large enough to hold the <ConfigHdr> template
 494     // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator
 495     //
 496     ConfigRequestHdr = HiiConstructConfigHdr (&mBootMaintGuid, mBootMaintStorageName, Private->BmmDriverHandle);
 497     Size = (StrLen (ConfigRequestHdr) + 32 + 1) * sizeof (CHAR16);
 498     ConfigRequest = AllocateZeroPool (Size);
 499     ASSERT (ConfigRequest != NULL);
 500     AllocatedRequest = TRUE;
 501     UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr, (UINT64)BufferSize);
 502     FreePool (ConfigRequestHdr);
 503   }
 504
 505   Status = gHiiConfigRouting->BlockToConfig (
 506                                 gHiiConfigRouting,
 507                                 ConfigRequest,
 508                                 (UINT8 *) &Private->BmmFakeNvData,
 509                                 BufferSize,
 510                                 Results,
 511                                 Progress
 512                                 );
 513   //
 514   // Free the allocated config request string.
 515   //
 516   if (AllocatedRequest) {
 517     FreePool (ConfigRequest);
 518     ConfigRequest = NULL;
 519   }
 520   //
 521   // Set Progress string to the original request string.
 522   //
 523   if (Request == NULL) {
 524     *Progress = NULL;
 525   } else if (StrStr (Request, L"OFFSET") == NULL) {
 526     *Progress = Request + StrLen (Request);
 527   }
 528
 529   return Status;
 530 }
 531
 532 /**
 533   This function applies changes in a driver's configuration.
 534   Input is a Configuration, which has the routing data for this
 535   driver followed by name / value configuration pairs. The driver
 536   must apply those pairs to its configurable storage. If the
 537   driver's configuration is stored in a linear block of data
 538   and the driver's name / value pairs are in <BlockConfig>
 539   format, it may use the ConfigToBlock helper function (above) to
 540   simplify the job. Currently not implemented.
 541
 542   @param[in]  This                Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
 543   @param[in]  Configuration       A null-terminated Unicode string in
 544                                   <ConfigString> format.
 545   @param[out] Progress            A pointer to a string filled in with the
 546                                   offset of the most recent '&' before the
 547                                   first failing name / value pair (or the
 548                                   beginn ing of the string if the failure
 549                                   is in the first name / value pair) or
 550                                   the terminating NULL if all was
 551                                   successful.
 552
 553   @retval EFI_SUCCESS             The results have been distributed or are
 554                                   awaiting distribution.
 555   @retval EFI_OUT_OF_RESOURCES    Not enough memory to store the
 556                                   parts of the results that must be
 557                                   stored awaiting possible future
 558                                   protocols.
 559   @retval EFI_INVALID_PARAMETERS  Passing in a NULL for the
 560                                   Results parameter would result
 561                                   in this type of error.
 562   @retval EFI_NOT_FOUND           Target for the specified routing data
 563                                   was not found.
 564 **/
 565 EFI_STATUS
 566 EFIAPI
 567 BootMaintRouteConfig (
 568   IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
 569   IN CONST EFI_STRING                     Configuration,
 570   OUT EFI_STRING                          *Progress
 571   )
 572 {
 573   EFI_STATUS                      Status;
 574   UINTN                           BufferSize;
 575   EFI_HII_CONFIG_ROUTING_PROTOCOL *ConfigRouting;
 576   BMM_FAKE_NV_DATA                *NewBmmData;
 577   BMM_FAKE_NV_DATA                *OldBmmData;
 578   BM_CONSOLE_CONTEXT              *NewConsoleContext;
 579   BM_TERMINAL_CONTEXT             *NewTerminalContext;
 580   BM_MENU_ENTRY                   *NewMenuEntry;
 581   BM_LOAD_CONTEXT                 *NewLoadContext;
 582   UINT16                          Index;
 583   BOOLEAN                         TerminalAttChange;
 584   BMM_CALLBACK_DATA               *Private;
 585
 586   if (Progress == NULL) {
 587     return EFI_INVALID_PARAMETER;
 588   }
 589   *Progress = Configuration;
 590
 591   if (Configuration == NULL) {
 592     return EFI_INVALID_PARAMETER;
 593   }
 594
 595   //
 596   // Check routing data in <ConfigHdr>.
 597   // Note: there is no name for Name/Value storage, only GUID will be checked
 598   //
 599   if (!HiiIsConfigHdrMatch (Configuration, &mBootMaintGuid, mBootMaintStorageName)) {
 600     return EFI_NOT_FOUND;
 601   }
 602
 603   Status = gBS->LocateProtocol (
 604                   &gEfiHiiConfigRoutingProtocolGuid,
 605                   NULL,
 606                   (VOID **)&ConfigRouting
 607                   );
 608   if (EFI_ERROR (Status)) {
 609     return Status;
 610   }
 611
 612   Private = BMM_CALLBACK_DATA_FROM_THIS (This);
 613   //
 614   // Get Buffer Storage data from EFI variable
 615   //
 616   BufferSize = sizeof (BMM_FAKE_NV_DATA);
 617   OldBmmData = &Private->BmmOldFakeNVData;
 618   NewBmmData = &Private->BmmFakeNvData;
 619   //
 620   // Convert <ConfigResp> to buffer data by helper function ConfigToBlock()
 621   //
 622   Status = ConfigRouting->ConfigToBlock (
 623                             ConfigRouting,
 624                             Configuration,
 625                             (UINT8 *) NewBmmData,
 626                             &BufferSize,
 627                             Progress
 628                             );
 629   ASSERT_EFI_ERROR (Status);
 630   //
 631   // Compare new and old BMM configuration data and only do action for modified item to
 632   // avoid setting unnecessary non-volatile variable
 633   //
 634
 635   //
 636   // Check data which located in BMM main page and save the settings if need
 637   //
 638   if (CompareMem (&NewBmmData->BootNext, &OldBmmData->BootNext, sizeof (NewBmmData->BootNext)) != 0) {
 639     Status = Var_UpdateBootNext (Private);
 640   }
 641
 642   //
 643   // Check data which located in Boot Options Menu and save the settings if need
 644   //
 645   if (CompareMem (NewBmmData->BootOptionDel, OldBmmData->BootOptionDel, sizeof (NewBmmData->BootOptionDel)) != 0) {
 646     for (Index = 0;
 647          ((Index < BootOptionMenu.MenuNumber) && (Index < (sizeof (NewBmmData->BootOptionDel) / sizeof (NewBmmData->BootOptionDel[0]))));
 648          Index ++) {
 649       NewMenuEntry            = BOpt_GetMenuEntry (&BootOptionMenu, Index);
 650       NewLoadContext          = (BM_LOAD_CONTEXT *) NewMenuEntry->VariableContext;
 651       NewLoadContext->Deleted = NewBmmData->BootOptionDel[Index];
 652       NewBmmData->BootOptionDel[Index] = FALSE;
 653       NewBmmData->BootOptionDelMark[Index] = FALSE;
 654     }
 655
 656     Var_DelBootOption ();
 657   }
 658
 659   if (CompareMem (NewBmmData->BootOptionOrder, OldBmmData->BootOptionOrder, sizeof (NewBmmData->BootOptionOrder)) != 0) {
 660     Status = Var_UpdateBootOrder (Private);
 661   }
 662
 663   if (CompareMem (&NewBmmData->BootTimeOut, &OldBmmData->BootTimeOut, sizeof (NewBmmData->BootTimeOut)) != 0){
 664     Status = gRT->SetVariable(
 665                     L"Timeout",
 666                     &gEfiGlobalVariableGuid,
 667                     EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,
 668                     sizeof(UINT16),
 669                     &(NewBmmData->BootTimeOut)
 670                     );
 671     if (EFI_ERROR (Status)) {
 672       //
 673       // If set variable fail, and don't have the appropriate error status for RouteConfig fuction to return,
 674       // just return the EFI_NOT_FOUND.
 675       //
 676       if (Status == EFI_OUT_OF_RESOURCES) {
 677         return Status;
 678       } else {
 679         return EFI_NOT_FOUND;
 680       }
 681     }
 682     Private->BmmOldFakeNVData.BootTimeOut = NewBmmData->BootTimeOut;
 683   }
 684
 685   //
 686   // Check data which located in Driver Options Menu and save the settings if need
 687   //
 688   if (CompareMem (NewBmmData->DriverOptionDel, OldBmmData->DriverOptionDel, sizeof (NewBmmData->DriverOptionDel)) != 0) {
 689     for (Index = 0;
 690          ((Index < DriverOptionMenu.MenuNumber) && (Index < (sizeof (NewBmmData->DriverOptionDel) / sizeof (NewBmmData->DriverOptionDel[0]))));
 691          Index++) {
 692       NewMenuEntry            = BOpt_GetMenuEntry (&DriverOptionMenu, Index);
 693       NewLoadContext          = (BM_LOAD_CONTEXT *) NewMenuEntry->VariableContext;
 694       NewLoadContext->Deleted = NewBmmData->DriverOptionDel[Index];
 695       NewBmmData->DriverOptionDel[Index] = FALSE;
 696       NewBmmData->DriverOptionDelMark[Index] = FALSE;
 697     }
 698     Var_DelDriverOption ();
 699   }
 700
 701   if (CompareMem (NewBmmData->DriverOptionOrder, OldBmmData->DriverOptionOrder, sizeof (NewBmmData->DriverOptionOrder)) != 0) {
 702     Status = Var_UpdateDriverOrder (Private);
 703   }
 704
 705   if (CompareMem (&NewBmmData->ConsoleOutMode, &OldBmmData->ConsoleOutMode, sizeof (NewBmmData->ConsoleOutMode)) != 0){
 706     Var_UpdateConMode(Private);
 707   }
 708
 709   TerminalAttChange = FALSE;
 710   for (Index = 0; Index < TerminalMenu.MenuNumber; Index++) {
 711
 712     //
 713     // only need update modified items
 714     //
 715     if (CompareMem (&NewBmmData->COMBaudRate[Index], &OldBmmData->COMBaudRate[Index], sizeof (NewBmmData->COMBaudRate[Index])) == 0 &&
 716          CompareMem (&NewBmmData->COMDataRate[Index], &OldBmmData->COMDataRate[Index], sizeof (NewBmmData->COMDataRate[Index])) == 0 &&
 717          CompareMem (&NewBmmData->COMStopBits[Index], &OldBmmData->COMStopBits[Index], sizeof (NewBmmData->COMStopBits[Index])) == 0 &&
 718          CompareMem (&NewBmmData->COMParity[Index], &OldBmmData->COMParity[Index], sizeof (NewBmmData->COMParity[Index])) == 0 &&
 719          CompareMem (&NewBmmData->COMTerminalType[Index], &OldBmmData->COMTerminalType[Index], sizeof (NewBmmData->COMTerminalType[Index])) == 0 &&
 720          CompareMem (&NewBmmData->COMFlowControl[Index], &OldBmmData->COMFlowControl[Index], sizeof (NewBmmData->COMFlowControl[Index])) == 0) {
 721       continue;
 722     }
 723
 724     NewMenuEntry = BOpt_GetMenuEntry (&TerminalMenu, Index);
 725     ASSERT (NewMenuEntry != NULL);
 726     NewTerminalContext = (BM_TERMINAL_CONTEXT *) NewMenuEntry->VariableContext;
 727     NewTerminalContext->BaudRateIndex = NewBmmData->COMBaudRate[Index];
 728     ASSERT (NewBmmData->COMBaudRate[Index] < (sizeof (BaudRateList) / sizeof (BaudRateList[0])));
 729     NewTerminalContext->BaudRate      = BaudRateList[NewBmmData->COMBaudRate[Index]].Value;
 730     NewTerminalContext->DataBitsIndex = NewBmmData->COMDataRate[Index];
 731     ASSERT (NewBmmData->COMDataRate[Index] < (sizeof (DataBitsList) / sizeof (DataBitsList[0])));
 732     NewTerminalContext->DataBits      = (UINT8) DataBitsList[NewBmmData->COMDataRate[Index]].Value;
 733     NewTerminalContext->StopBitsIndex = NewBmmData->COMStopBits[Index];
 734     ASSERT (NewBmmData->COMStopBits[Index] < (sizeof (StopBitsList) / sizeof (StopBitsList[0])));
 735     NewTerminalContext->StopBits      = (UINT8) StopBitsList[NewBmmData->COMStopBits[Index]].Value;
 736     NewTerminalContext->ParityIndex   = NewBmmData->COMParity[Index];
 737     ASSERT (NewBmmData->COMParity[Index] < (sizeof (ParityList) / sizeof (ParityList[0])));
 738     NewTerminalContext->Parity        = (UINT8) ParityList[NewBmmData->COMParity[Index]].Value;
 739     NewTerminalContext->TerminalType  = NewBmmData->COMTerminalType[Index];
 740     NewTerminalContext->FlowControl   = NewBmmData->COMFlowControl[Index];
 741     ChangeTerminalDevicePath (
 742       NewTerminalContext->DevicePath,
 743       FALSE
 744       );
 745     TerminalAttChange = TRUE;
 746   }
 747   if (TerminalAttChange) {
 748     Var_UpdateConsoleInpOption ();
 749     Var_UpdateConsoleOutOption ();
 750     Var_UpdateErrorOutOption ();
 751   }
 752   //
 753   // Check data which located in Console Options Menu and save the settings if need
 754   //
 755   if (CompareMem (NewBmmData->ConsoleInCheck, OldBmmData->ConsoleInCheck, sizeof (NewBmmData->ConsoleInCheck)) != 0){
 756     for (Index = 0; Index < ConsoleInpMenu.MenuNumber; Index++){
 757       NewMenuEntry                = BOpt_GetMenuEntry(&ConsoleInpMenu, Index);
 758       NewConsoleContext           = (BM_CONSOLE_CONTEXT *)NewMenuEntry->VariableContext;
 759       ASSERT (Index < MAX_MENU_NUMBER);
 760       NewConsoleContext->IsActive = NewBmmData->ConsoleInCheck[Index];
 761     }
 762     for (Index = 0; Index < TerminalMenu.MenuNumber; Index++) {
 763       NewMenuEntry                = BOpt_GetMenuEntry (&TerminalMenu, Index);
 764       NewTerminalContext          = (BM_TERMINAL_CONTEXT *) NewMenuEntry->VariableContext;
 765       ASSERT (Index + ConsoleInpMenu.MenuNumber < MAX_MENU_NUMBER);
 766       NewTerminalContext->IsConIn = NewBmmData->ConsoleInCheck[Index + ConsoleInpMenu.MenuNumber];
 767     }
 768     Var_UpdateConsoleInpOption();
 769   }
 770
 771   if (CompareMem (NewBmmData->ConsoleOutCheck, OldBmmData->ConsoleOutCheck, sizeof (NewBmmData->ConsoleOutCheck)) != 0){
 772     for (Index = 0; Index < ConsoleOutMenu.MenuNumber; Index++){
 773       NewMenuEntry                = BOpt_GetMenuEntry(&ConsoleOutMenu, Index);
 774       NewConsoleContext           = (BM_CONSOLE_CONTEXT *)NewMenuEntry->VariableContext;
 775       ASSERT (Index < MAX_MENU_NUMBER);
 776       NewConsoleContext->IsActive = NewBmmData->ConsoleOutCheck[Index];
 777     }
 778     for (Index = 0; Index < TerminalMenu.MenuNumber; Index++) {
 779       NewMenuEntry                = BOpt_GetMenuEntry (&TerminalMenu, Index);
 780       NewTerminalContext          = (BM_TERMINAL_CONTEXT *) NewMenuEntry->VariableContext;
 781       ASSERT (Index + ConsoleOutMenu.MenuNumber < MAX_MENU_NUMBER);
 782       NewTerminalContext->IsConOut = NewBmmData->ConsoleOutCheck[Index + ConsoleOutMenu.MenuNumber];
 783     }
 784     Var_UpdateConsoleOutOption();
 785   }
 786
 787   if (CompareMem (NewBmmData->ConsoleErrCheck, OldBmmData->ConsoleErrCheck, sizeof (NewBmmData->ConsoleErrCheck)) != 0){
 788     for (Index = 0; Index < ConsoleErrMenu.MenuNumber; Index++){
 789       NewMenuEntry                = BOpt_GetMenuEntry(&ConsoleErrMenu, Index);
 790       NewConsoleContext           = (BM_CONSOLE_CONTEXT *)NewMenuEntry->VariableContext;
 791       ASSERT (Index < MAX_MENU_NUMBER);
 792       NewConsoleContext->IsActive = NewBmmData->ConsoleErrCheck[Index];
 793     }
 794     for (Index = 0; Index < TerminalMenu.MenuNumber; Index++) {
 795       NewMenuEntry                = BOpt_GetMenuEntry (&TerminalMenu, Index);
 796       NewTerminalContext          = (BM_TERMINAL_CONTEXT *) NewMenuEntry->VariableContext;
 797       ASSERT (Index + ConsoleErrMenu.MenuNumber < MAX_MENU_NUMBER);
 798       NewTerminalContext->IsStdErr = NewBmmData->ConsoleErrCheck[Index + ConsoleErrMenu.MenuNumber];
 799     }
 800     Var_UpdateErrorOutOption();
 801   }
 802
 803   if (CompareMem (NewBmmData->BootDescriptionData, OldBmmData->BootDescriptionData, sizeof (NewBmmData->BootDescriptionData)) != 0 ||
 804        CompareMem (NewBmmData->BootOptionalData, OldBmmData->BootOptionalData, sizeof (NewBmmData->BootOptionalData)) != 0) {
 805     Status = Var_UpdateBootOption (Private);
 806     NewBmmData->BootOptionChanged = FALSE;
 807     if (EFI_ERROR (Status)) {
 808       return Status;
 809     }
 810     BOpt_GetBootOptions (Private);
 811   }
 812
 813   if (CompareMem (NewBmmData->DriverDescriptionData, OldBmmData->DriverDescriptionData, sizeof (NewBmmData->DriverDescriptionData)) != 0 ||
 814        CompareMem (NewBmmData->DriverOptionalData, OldBmmData->DriverOptionalData, sizeof (NewBmmData->DriverOptionalData)) != 0) {
 815     Status = Var_UpdateDriverOption (
 816               Private,
 817               Private->BmmHiiHandle,
 818               NewBmmData->DriverDescriptionData,
 819               NewBmmData->DriverOptionalData,
 820               NewBmmData->ForceReconnect
 821               );
 822     NewBmmData->DriverOptionChanged = FALSE;
 823     NewBmmData->ForceReconnect      = TRUE;
 824     if (EFI_ERROR (Status)) {
 825       return Status;
 826     }
 827
 828     BOpt_GetDriverOptions (Private);
 829   }
 830
 831   //
 832   // After user do the save action, need to update OldBmmData.
 833   //
 834   CopyMem (OldBmmData, NewBmmData, sizeof (BMM_FAKE_NV_DATA));
 835
 836   return EFI_SUCCESS;
 837 }
 838
 839 /**
 840   This function processes the results of changes in configuration.
 841
 842
 843   @param This               Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
 844   @param Action             Specifies the type of action taken by the browser.
 845   @param QuestionId         A unique value which is sent to the original exporting driver
 846                             so that it can identify the type of data to expect.
 847   @param Type               The type of value for the question.
 848   @param Value              A pointer to the data being sent to the original exporting driver.
 849   @param ActionRequest      On return, points to the action requested by the callback function.
 850
 851   @retval EFI_SUCCESS           The callback successfully handled the action.
 852   @retval EFI_OUT_OF_RESOURCES  Not enough storage is available to hold the variable and its data.
 853   @retval EFI_DEVICE_ERROR      The variable could not be saved.
 854   @retval EFI_UNSUPPORTED       The specified Action is not supported by the callback.
 855   @retval EFI_INVALID_PARAMETER The parameter of Value or ActionRequest is invalid.
 856 **/
 857 EFI_STATUS
 858 EFIAPI
 859 BootMaintCallback (
 860   IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL         *This,
 861   IN        EFI_BROWSER_ACTION                     Action,
 862   IN        EFI_QUESTION_ID                        QuestionId,
 863   IN        UINT8                                  Type,
 864   IN        EFI_IFR_TYPE_VALUE                     *Value,
 865   OUT       EFI_BROWSER_ACTION_REQUEST             *ActionRequest
 866   )
 867 {
 868   BMM_CALLBACK_DATA *Private;
 869   BM_MENU_ENTRY     *NewMenuEntry;
 870   BMM_FAKE_NV_DATA  *CurrentFakeNVMap;
 871   UINTN             Index;
 872   EFI_DEVICE_PATH_PROTOCOL * File;
 873
 874   if (Action != EFI_BROWSER_ACTION_CHANGING && Action != EFI_BROWSER_ACTION_CHANGED) {
 875     //
 876     // Do nothing for other UEFI Action. Only do call back when data is changed.
 877     //
 878     return EFI_UNSUPPORTED;
 879   }
 880
 881   Private        = BMM_CALLBACK_DATA_FROM_THIS (This);
 882   //
 883   // Retrive uncommitted data from Form Browser
 884   //
 885   CurrentFakeNVMap = &Private->BmmFakeNvData;
 886   HiiGetBrowserData (&mBootMaintGuid, mBootMaintStorageName, sizeof (BMM_FAKE_NV_DATA), (UINT8 *) CurrentFakeNVMap);
 887
 888   if (Action == EFI_BROWSER_ACTION_CHANGING) {
 889     if (Value == NULL) {
 890       return EFI_INVALID_PARAMETER;
 891     }
 892
 893     UpdatePageId (Private, QuestionId);
 894
 895     if (QuestionId < FILE_OPTION_OFFSET) {
 896       if (QuestionId < CONFIG_OPTION_OFFSET) {
 897         switch (QuestionId) {
 898         case FORM_BOOT_ADD_ID:
 899           // Leave BMM and enter FileExplorer.
 900           ChooseFile (NULL, L".efi", CreateBootOptionFromFile, &File);
 901           break;
 902
 903         case FORM_DRV_ADD_FILE_ID:
 904           // Leave BMM and enter FileExplorer.
 905           ChooseFile (NULL, L".efi", CreateDriverOptionFromFile, &File);
 906           break;
 907
 908         case FORM_DRV_ADD_HANDLE_ID:
 909           CleanUpPage (FORM_DRV_ADD_HANDLE_ID, Private);
 910           UpdateDrvAddHandlePage (Private);
 911           break;
 912
 913         case FORM_BOOT_DEL_ID:
 914           CleanUpPage (FORM_BOOT_DEL_ID, Private);
 915           UpdateBootDelPage (Private);
 916           break;
 917
 918         case FORM_BOOT_CHG_ID:
 919         case FORM_DRV_CHG_ID:
 920           UpdatePageBody (QuestionId, Private);
 921           break;
 922
 923         case FORM_DRV_DEL_ID:
 924           CleanUpPage (FORM_DRV_DEL_ID, Private);
 925           UpdateDrvDelPage (Private);
 926           break;
 927
 928         case FORM_CON_IN_ID:
 929         case FORM_CON_OUT_ID:
 930         case FORM_CON_ERR_ID:
 931           UpdatePageBody (QuestionId, Private);
 932           break;
 933
 934         case FORM_CON_MODE_ID:
 935           CleanUpPage (FORM_CON_MODE_ID, Private);
 936           UpdateConModePage (Private);
 937           break;
 938
 939         case FORM_CON_COM_ID:
 940           CleanUpPage (FORM_CON_COM_ID, Private);
 941           UpdateConCOMPage (Private);
 942           break;
 943
 944         default:
 945           break;
 946         }
 947       } else if ((QuestionId >= TERMINAL_OPTION_OFFSET) && (QuestionId < CONSOLE_OPTION_OFFSET)) {
 948         Index                  = (UINT16) (QuestionId - TERMINAL_OPTION_OFFSET);
 949         Private->CurrentTerminal  = Index;
 950
 951         CleanUpPage (FORM_CON_COM_SETUP_ID, Private);
 952         UpdateTerminalPage (Private);
 953
 954       } else if (QuestionId >= HANDLE_OPTION_OFFSET) {
 955         Index                  = (UINT16) (QuestionId - HANDLE_OPTION_OFFSET);
 956
 957         NewMenuEntry            = BOpt_GetMenuEntry (&DriverMenu, Index);
 958         ASSERT (NewMenuEntry != NULL);
 959         Private->HandleContext  = (BM_HANDLE_CONTEXT *) NewMenuEntry->VariableContext;
 960
 961         CleanUpPage (FORM_DRV_ADD_HANDLE_DESC_ID, Private);
 962
 963         Private->MenuEntry                  = NewMenuEntry;
 964         Private->LoadContext->FilePathList  = Private->HandleContext->DevicePath;
 965
 966         UpdateDriverAddHandleDescPage (Private);
 967       }
 968     }
 969     if (QuestionId == KEY_VALUE_BOOT_FROM_FILE){
 970       // Leave BMM and enter FileExplorer.
 971       ChooseFile (NULL, L".efi", BootFromFile, &File);
 972     }
 973   } else if (Action == EFI_BROWSER_ACTION_CHANGED) {
 974     if ((Value == NULL) || (ActionRequest == NULL)) {
 975       return EFI_INVALID_PARAMETER;
 976     }
 977
 978     if (QuestionId == KEY_VALUE_SAVE_AND_EXIT_BOOT) {
 979       CurrentFakeNVMap->BootOptionChanged = FALSE;
 980       *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT;
 981     } else if (QuestionId == KEY_VALUE_SAVE_AND_EXIT_DRIVER) {
 982       CurrentFakeNVMap->DriverOptionChanged = FALSE;
 983       *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT;
 984     } else if (QuestionId == KEY_VALUE_NO_SAVE_AND_EXIT_DRIVER) {
 985       //
 986       // Discard changes and exit formset
 987       //
 988       CurrentFakeNVMap->DriverOptionalData[0]     = 0x0000;
 989       CurrentFakeNVMap->DriverDescriptionData[0]  = 0x0000;
 990       CurrentFakeNVMap->DriverOptionChanged = FALSE;
 991       CurrentFakeNVMap->ForceReconnect      = TRUE;
 992       *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT;
 993     } else if (QuestionId == KEY_VALUE_NO_SAVE_AND_EXIT_BOOT) {
 994       //
 995       // Discard changes and exit formset
 996       //
 997       CurrentFakeNVMap->BootOptionalData[0]     = 0x0000;
 998       CurrentFakeNVMap->BootDescriptionData[0]  = 0x0000;
 999       CurrentFakeNVMap->BootOptionChanged = FALSE;
1000       *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT;
1001     } else if (QuestionId == KEY_VALUE_BOOT_DESCRIPTION || QuestionId == KEY_VALUE_BOOT_OPTION) {
1002       CurrentFakeNVMap->BootOptionChanged = TRUE;
1003     } else if (QuestionId == KEY_VALUE_DRIVER_DESCRIPTION || QuestionId == KEY_VALUE_DRIVER_OPTION) {
1004       CurrentFakeNVMap->DriverOptionChanged = TRUE;
1005     }
1006
1007     if ((QuestionId >= BOOT_OPTION_DEL_QUESTION_ID) && (QuestionId < BOOT_OPTION_DEL_QUESTION_ID + MAX_MENU_NUMBER)) {
1008       if (Value->b){
1009         //
1010         // Means user try to delete this boot option but not press F10 or "Commit Changes and Exit" menu.
1011         //
1012         CurrentFakeNVMap->BootOptionDelMark[QuestionId - BOOT_OPTION_DEL_QUESTION_ID] = TRUE;
1013       } else {
1014         //
1015         // Means user remove the old check status.
1016         //
1017         CurrentFakeNVMap->BootOptionDelMark[QuestionId - BOOT_OPTION_DEL_QUESTION_ID] = FALSE;
1018       }
1019     } else if ((QuestionId >= DRIVER_OPTION_DEL_QUESTION_ID) && (QuestionId < DRIVER_OPTION_DEL_QUESTION_ID + MAX_MENU_NUMBER)) {
1020       if (Value->b){
1021         CurrentFakeNVMap->DriverOptionDelMark[QuestionId - DRIVER_OPTION_DEL_QUESTION_ID] = TRUE;
1022       } else {
1023         CurrentFakeNVMap->DriverOptionDelMark[QuestionId - DRIVER_OPTION_DEL_QUESTION_ID] = FALSE;
1024       }
1025     } else {
1026       switch (QuestionId) {
1027       case KEY_VALUE_SAVE_AND_EXIT:
1028       case KEY_VALUE_NO_SAVE_AND_EXIT:
1029         if (QuestionId == KEY_VALUE_SAVE_AND_EXIT) {
1030           *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT;
1031         } else if (QuestionId == KEY_VALUE_NO_SAVE_AND_EXIT) {
1032           DiscardChangeHandler (Private, CurrentFakeNVMap);
1033           *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT;
1034         }
1035
1036         break;
1037
1038       case FORM_RESET:
1039         gRT->ResetSystem (EfiResetCold, EFI_SUCCESS, 0, NULL);
1040         return EFI_UNSUPPORTED;
1041
1042       default:
1043         break;
1044       }
1045     }
1046   }
1047
1048   //
1049   // Pass changed uncommitted data back to Form Browser
1050   //
1051   HiiSetBrowserData (&mBootMaintGuid, mBootMaintStorageName, sizeof (BMM_FAKE_NV_DATA), (UINT8 *) CurrentFakeNVMap, NULL);
1052
1053   return EFI_SUCCESS;
1054 }
1055
1056 /**
1057   Discard all changes done to the BMM pages such as Boot Order change,
1058   Driver order change.
1059
1060   @param Private            The BMM context data.
1061   @param CurrentFakeNVMap   The current Fack NV Map.
1062
1063 **/
1064 VOID
1065 DiscardChangeHandler (
1066   IN  BMM_CALLBACK_DATA               *Private,
1067   IN  BMM_FAKE_NV_DATA                *CurrentFakeNVMap
1068   )
1069 {
1070   UINT16  Index;
1071
1072   switch (Private->BmmPreviousPageId) {
1073   case FORM_BOOT_CHG_ID:
1074     CopyMem (CurrentFakeNVMap->BootOptionOrder, Private->BmmOldFakeNVData.BootOptionOrder, sizeof (CurrentFakeNVMap->BootOptionOrder));
1075     break;
1076
1077   case FORM_DRV_CHG_ID:
1078     CopyMem (CurrentFakeNVMap->DriverOptionOrder, Private->BmmOldFakeNVData.DriverOptionOrder, sizeof (CurrentFakeNVMap->DriverOptionOrder));
1079     break;
1080
1081   case FORM_BOOT_DEL_ID:
1082     ASSERT (BootOptionMenu.MenuNumber <= (sizeof (CurrentFakeNVMap->BootOptionDel) / sizeof (CurrentFakeNVMap->BootOptionDel[0])));
1083     for (Index = 0; Index < BootOptionMenu.MenuNumber; Index++) {
1084       CurrentFakeNVMap->BootOptionDel[Index] = FALSE;
1085     }
1086     break;
1087
1088   case FORM_DRV_DEL_ID:
1089     ASSERT (DriverOptionMenu.MenuNumber <= (sizeof (CurrentFakeNVMap->DriverOptionDel) / sizeof (CurrentFakeNVMap->DriverOptionDel[0])));
1090     for (Index = 0; Index < DriverOptionMenu.MenuNumber; Index++) {
1091       CurrentFakeNVMap->DriverOptionDel[Index] = FALSE;
1092     }
1093     break;
1094
1095   case FORM_BOOT_NEXT_ID:
1096     CurrentFakeNVMap->BootNext = Private->BmmOldFakeNVData.BootNext;
1097     break;
1098
1099   case FORM_TIME_OUT_ID:
1100     CurrentFakeNVMap->BootTimeOut = Private->BmmOldFakeNVData.BootTimeOut;
1101     break;
1102
1103   case FORM_DRV_ADD_HANDLE_DESC_ID:
1104   case FORM_DRV_ADD_FILE_ID:
1105   case FORM_DRV_ADD_HANDLE_ID:
1106     CurrentFakeNVMap->DriverAddHandleDesc[0]          = 0x0000;
1107     CurrentFakeNVMap->DriverAddHandleOptionalData[0]  = 0x0000;
1108     break;
1109
1110   default:
1111     break;
1112   }
1113 }
1114
1115 /**
1116
1117   Update the menus in the BMM page.
1118
1119 **/
1120 VOID
1121 CustomizeMenus (
1122   VOID
1123   )
1124 {
1125   VOID                        *StartOpCodeHandle;
1126   VOID                        *EndOpCodeHandle;
1127   EFI_IFR_GUID_LABEL          *StartGuidLabel;
1128   EFI_IFR_GUID_LABEL          *EndGuidLabel;
1129
1130   //
1131   // Allocate space for creation of UpdateData Buffer
1132   //
1133   StartOpCodeHandle = HiiAllocateOpCodeHandle ();
1134   ASSERT (StartOpCodeHandle != NULL);
1135
1136   EndOpCodeHandle = HiiAllocateOpCodeHandle ();
1137   ASSERT (EndOpCodeHandle != NULL);
1138   //
1139   // Create Hii Extend Label OpCode as the start opcode
1140   //
1141   StartGuidLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));
1142   StartGuidLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
1143   StartGuidLabel->Number       = LABEL_FORM_MAIN_START;
1144   //
1145   // Create Hii Extend Label OpCode as the end opcode
1146   //
1147   EndGuidLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (EndOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));
1148   EndGuidLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
1149   EndGuidLabel->Number       = LABEL_FORM_MAIN_END;
1150
1151   //
1152   //Updata Front Page form
1153   //
1154   UiCustomizeBMMPage (
1155     mBmmCallbackInfo->BmmHiiHandle,
1156     StartOpCodeHandle
1157     );
1158
1159   HiiUpdateForm (
1160     mBmmCallbackInfo->BmmHiiHandle,
1161     &mBootMaintGuid,
1162     FORM_MAIN_ID,
1163     StartOpCodeHandle,
1164     EndOpCodeHandle
1165     );
1166
1167   HiiFreeOpCodeHandle (StartOpCodeHandle);
1168   HiiFreeOpCodeHandle (EndOpCodeHandle);
1169 }
1170
1171 /**
1172    Create dynamic code for BMM and initialize all of BMM configuration data in BmmFakeNvData and
1173    BmmOldFakeNVData member in BMM context data.
1174
1175   @param CallbackData    The BMM context data.
1176
1177 **/
1178 VOID
1179 InitializeBmmConfig (
1180   IN  BMM_CALLBACK_DATA    *CallbackData
1181   )
1182 {
1183   BM_MENU_ENTRY   *NewMenuEntry;
1184   BM_LOAD_CONTEXT *NewLoadContext;
1185   UINT16          Index;
1186
1187   ASSERT (CallbackData != NULL);
1188
1189   //
1190   // Initialize data which located in BMM main page
1191   //
1192   CallbackData->BmmFakeNvData.BootNext = NONE_BOOTNEXT_VALUE;
1193   for (Index = 0; Index < BootOptionMenu.MenuNumber; Index++) {
1194     NewMenuEntry    = BOpt_GetMenuEntry (&BootOptionMenu, Index);
1195     NewLoadContext  = (BM_LOAD_CONTEXT *) NewMenuEntry->VariableContext;
1196
1197     if (NewLoadContext->IsBootNext) {
1198       CallbackData->BmmFakeNvData.BootNext = Index;
1199       break;
1200     }
1201   }
1202
1203   CallbackData->BmmFakeNvData.BootTimeOut = PcdGet16 (PcdPlatformBootTimeOut);
1204
1205   //
1206   // Initialize data which located in Boot Options Menu
1207   //
1208   GetBootOrder (CallbackData);
1209
1210   //
1211   // Initialize data which located in Driver Options Menu
1212   //
1213   GetDriverOrder (CallbackData);
1214
1215   //
1216   // Initialize data which located in Console Options Menu
1217   //
1218   GetConsoleOutMode (CallbackData);
1219   GetConsoleInCheck (CallbackData);
1220   GetConsoleOutCheck (CallbackData);
1221   GetConsoleErrCheck (CallbackData);
1222   GetTerminalAttribute (CallbackData);
1223
1224   CallbackData->BmmFakeNvData.ForceReconnect = TRUE;
1225
1226   //
1227   // Update the menus.
1228   //
1229   CustomizeMenus ();
1230
1231   //
1232   // Backup Initialize BMM configuartion data to BmmOldFakeNVData
1233   //
1234   CopyMem (&CallbackData->BmmOldFakeNVData, &CallbackData->BmmFakeNvData, sizeof (BMM_FAKE_NV_DATA));
1235 }
1236
1237 /**
1238   Initialized all Menu Option List.
1239
1240   @param CallbackData    The BMM context data.
1241
1242 **/
1243 VOID
1244 InitAllMenu (
1245   IN  BMM_CALLBACK_DATA    *CallbackData
1246   )
1247 {
1248   InitializeListHead (&BootOptionMenu.Head);
1249   InitializeListHead (&DriverOptionMenu.Head);
1250   BOpt_GetBootOptions (CallbackData);
1251   BOpt_GetDriverOptions (CallbackData);
1252   BOpt_FindDrivers ();
1253   InitializeListHead (&ConsoleInpMenu.Head);
1254   InitializeListHead (&ConsoleOutMenu.Head);
1255   InitializeListHead (&ConsoleErrMenu.Head);
1256   InitializeListHead (&TerminalMenu.Head);
1257   LocateSerialIo ();
1258   GetAllConsoles ();
1259   mAllMenuInit = TRUE;
1260 }
1261
1262 /**
1263   Free up all Menu Option list.
1264
1265 **/
1266 VOID
1267 FreeAllMenu (
1268   VOID
1269   )
1270 {
1271   if (!mAllMenuInit){
1272     return;
1273   }
1274   BOpt_FreeMenu (&BootOptionMenu);
1275   BOpt_FreeMenu (&DriverOptionMenu);
1276   BOpt_FreeMenu (&DriverMenu);
1277   FreeAllConsoles ();
1278   mAllMenuInit = FALSE;
1279 }
1280
1281 /**
1282   Initial the boot mode related parameters.
1283
1284 **/
1285 VOID
1286 BmmInitialBootModeInfo (
1287   VOID
1288   )
1289 {
1290   EFI_STATUS                         Status;
1291   EFI_GRAPHICS_OUTPUT_PROTOCOL       *GraphicsOutput;
1292   EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL    *SimpleTextOut;
1293   UINTN                              BootTextColumn;
1294   UINTN                              BootTextRow;
1295
1296   if (mBmmModeInitialized) {
1297     return;
1298   }
1299
1300   //
1301   // After the console is ready, get current video resolution
1302   // and text mode before launching setup at first time.
1303   //
1304   Status = gBS->HandleProtocol (
1305                   gST->ConsoleOutHandle,
1306                   &gEfiGraphicsOutputProtocolGuid,
1307                   (VOID**)&GraphicsOutput
1308                   );
1309   if (EFI_ERROR (Status)) {
1310     GraphicsOutput = NULL;
1311   }
1312
1313   Status = gBS->HandleProtocol (
1314                   gST->ConsoleOutHandle,
1315                   &gEfiSimpleTextOutProtocolGuid,
1316                   (VOID**)&SimpleTextOut
1317                   );
1318   if (EFI_ERROR (Status)) {
1319     SimpleTextOut = NULL;
1320   }
1321
1322   if (GraphicsOutput != NULL) {
1323     //
1324     // Get current video resolution and text mode.
1325     //
1326     mBmmBootHorizontalResolution = GraphicsOutput->Mode->Info->HorizontalResolution;
1327     mBmmBootVerticalResolution   = GraphicsOutput->Mode->Info->VerticalResolution;
1328   }
1329
1330   if (SimpleTextOut != NULL) {
1331     Status = SimpleTextOut->QueryMode (
1332                               SimpleTextOut,
1333                               SimpleTextOut->Mode->Mode,
1334                               &BootTextColumn,
1335                               &BootTextRow
1336                               );
1337     mBmmBootTextModeColumn = (UINT32)BootTextColumn;
1338     mBmmBootTextModeRow    = (UINT32)BootTextRow;
1339   }
1340
1341   //
1342   // Get user defined text mode for setup.
1343   //
1344   mBmmSetupHorizontalResolution = PcdGet32 (PcdSetupVideoHorizontalResolution);
1345   mBmmSetupVerticalResolution   = PcdGet32 (PcdSetupVideoVerticalResolution);
1346   mBmmSetupTextModeColumn       = PcdGet32 (PcdSetupConOutColumn);
1347   mBmmSetupTextModeRow          = PcdGet32 (PcdSetupConOutRow);
1348
1349   mBmmModeInitialized           = TRUE;
1350 }
1351
1352 /**
1353
1354   Install Boot Maintenance Manager Menu driver.
1355
1356   @param ImageHandle     The image handle.
1357   @param SystemTable     The system table.
1358
1359   @retval  EFI_SUCEESS  Install Boot manager menu success.
1360   @retval  Other        Return error status.
1361
1362 **/
1363 EFI_STATUS
1364 EFIAPI
1365 BootMaintenanceManagerUiLibConstructor (
1366   IN EFI_HANDLE                            ImageHandle,
1367   IN EFI_SYSTEM_TABLE                      *SystemTable
1368   )
1369
1370 {
1371   EFI_STATUS               Status;
1372   UINT8                    *Ptr;
1373
1374   Status = EFI_SUCCESS;
1375
1376   //
1377   // Install Device Path Protocol and Config Access protocol to driver handle
1378   //
1379   Status = gBS->InstallMultipleProtocolInterfaces (
1380                   &mBmmCallbackInfo->BmmDriverHandle,
1381                   &gEfiDevicePathProtocolGuid,
1382                   &mBmmHiiVendorDevicePath,
1383                   &gEfiHiiConfigAccessProtocolGuid,
1384                   &mBmmCallbackInfo->BmmConfigAccess,
1385                   NULL
1386                   );
1387   ASSERT_EFI_ERROR (Status);
1388
1389   //
1390   // Post our Boot Maint VFR binary to the HII database.
1391   //
1392   mBmmCallbackInfo->BmmHiiHandle = HiiAddPackages (
1393                                     &mBootMaintGuid,
1394                                     mBmmCallbackInfo->BmmDriverHandle,
1395                                     BootMaintenanceManagerBin,
1396                                     BootMaintenanceManagerUiLibStrings,
1397                                     NULL
1398                                     );
1399   ASSERT (mBmmCallbackInfo->BmmHiiHandle != NULL);
1400
1401   //
1402   // Locate Formbrowser2 protocol
1403   //
1404   Status = gBS->LocateProtocol (&gEfiFormBrowser2ProtocolGuid, NULL, (VOID **) &mBmmCallbackInfo->FormBrowser2);
1405   ASSERT_EFI_ERROR (Status);
1406
1407   EfiBootManagerRefreshAllBootOption ();
1408
1409   //
1410   // Create LoadOption in BmmCallbackInfo for Driver Callback
1411   //
1412   Ptr = AllocateZeroPool (sizeof (BM_LOAD_CONTEXT) + sizeof (BM_FILE_CONTEXT) + sizeof (BM_HANDLE_CONTEXT) + sizeof (BM_MENU_ENTRY));
1413   ASSERT (Ptr != NULL);
1414
1415   //
1416   // Initialize Bmm callback data.
1417   //
1418   mBmmCallbackInfo->LoadContext = (BM_LOAD_CONTEXT *) Ptr;
1419   Ptr += sizeof (BM_LOAD_CONTEXT);
1420
1421   mBmmCallbackInfo->FileContext = (BM_FILE_CONTEXT *) Ptr;
1422   Ptr += sizeof (BM_FILE_CONTEXT);
1423
1424   mBmmCallbackInfo->HandleContext = (BM_HANDLE_CONTEXT *) Ptr;
1425   Ptr += sizeof (BM_HANDLE_CONTEXT);
1426
1427   mBmmCallbackInfo->MenuEntry     = (BM_MENU_ENTRY *) Ptr;
1428
1429   mBmmCallbackInfo->BmmPreviousPageId  = FORM_MAIN_ID;
1430   mBmmCallbackInfo->BmmCurrentPageId   = FORM_MAIN_ID;
1431
1432   InitAllMenu (mBmmCallbackInfo);
1433
1434   CreateUpdateData();
1435   //
1436   // Update boot maintenance manager page
1437   //
1438   InitializeBmmConfig(mBmmCallbackInfo);
1439
1440   BmmInitialBootModeInfo();
1441
1442   return EFI_SUCCESS;
1443 }
1444
1445 /**
1446   Unloads the application and its installed protocol.
1447
1448   @param ImageHandle       Handle that identifies the image to be unloaded.
1449   @param  SystemTable      The system table.
1450
1451   @retval EFI_SUCCESS      The image has been unloaded.
1452
1453 **/
1454 EFI_STATUS
1455 EFIAPI
1456 BootMaintenanceManagerUiLibDestructor (
1457   IN EFI_HANDLE                            ImageHandle,
1458   IN EFI_SYSTEM_TABLE                      *SystemTable
1459   )
1460
1461 {
1462   if (mStartOpCodeHandle != NULL) {
1463     HiiFreeOpCodeHandle (mStartOpCodeHandle);
1464   }
1465
1466   if (mEndOpCodeHandle != NULL) {
1467     HiiFreeOpCodeHandle (mEndOpCodeHandle);
1468   }
1469
1470   FreeAllMenu ();
1471
1472   //
1473   // Remove our IFR data from HII database
1474   //
1475   HiiRemovePackages (mBmmCallbackInfo->BmmHiiHandle);
1476
1477   gBS->UninstallMultipleProtocolInterfaces (
1478          mBmmCallbackInfo->BmmDriverHandle,
1479          &gEfiDevicePathProtocolGuid,
1480          &mBmmHiiVendorDevicePath,
1481          &gEfiHiiConfigAccessProtocolGuid,
1482          &mBmmCallbackInfo->BmmConfigAccess,
1483          NULL
1484          );
1485
1486   FreePool (mBmmCallbackInfo->LoadContext);
1487
1488   return EFI_SUCCESS;
1489 }
1490