Nt32Pkg: Keep boot behavior using new BDS almost same as that using old BDS

[mirror_edk2.git] / Nt32Pkg / Library / PlatformBootManagerLib / PlatformBootManager.c

/** @file\r
  This file include all platform action which can be customized\r
  by IBV/OEM.\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 "PlatformBootManager.h"\r
\r
\r
EFI_GUID mUefiShellFileGuid = { 0x7C04A583, 0x9E3E, 0x4f1c, 0xAD, 0x65, 0xE0, 0x52, 0x68, 0xD0, 0xB4, 0xD1 };\r
\r
/**\r
  Perform the platform diagnostic, such like test memory. OEM/IBV also\r
  can customize this function to support specific platform diagnostic.\r
\r
  @param MemoryTestLevel  The memory test intensive level\r
  @param QuietBoot        Indicate if need to enable the quiet boot\r
\r
**/\r
VOID\r
PlatformBootManagerDiagnostics (\r
  IN EXTENDMEM_COVERAGE_LEVEL    MemoryTestLevel,\r
  IN BOOLEAN                     QuietBoot\r
  )\r
{\r
  EFI_STATUS                     Status;\r
\r
  //\r
  // Here we can decide if we need to show\r
  // the diagnostics screen\r
  // Notes: this quiet boot code should be remove\r
  // from the graphic lib\r
  //\r
  if (QuietBoot) {\r
    PlatformBootManagerEnableQuietBoot (PcdGetPtr(PcdLogoFile));\r
\r
    //\r
    // Perform system diagnostic\r
    //\r
    Status = PlatformBootManagerMemoryTest (MemoryTestLevel);\r
    if (EFI_ERROR (Status)) {\r
      PlatformBootManagerDisableQuietBoot ();\r
    }\r
\r
    return;\r
  }\r
\r
  //\r
  // Perform system diagnostic\r
  //\r
  Status = PlatformBootManagerMemoryTest (MemoryTestLevel);\r
}\r
\r
/**\r
  Return the index of the load option in the load option array.\r
\r
  The function consider two load options are equal when the \r
  OptionType, Attributes, Description, FilePath and OptionalData are equal.\r
\r
  @param Key    Pointer to the load option to be found.\r
  @param Array  Pointer to the array of load options to be found.\r
  @param Count  Number of entries in the Array.\r
\r
  @retval -1          Key wasn't found in the Array.\r
  @retval 0 ~ Count-1 The index of the Key in the Array.\r
**/\r
INTN\r
PlatformFindLoadOption (\r
  IN CONST EFI_BOOT_MANAGER_LOAD_OPTION *Key,\r
  IN CONST EFI_BOOT_MANAGER_LOAD_OPTION *Array,\r
  IN UINTN                              Count\r
  )\r
{\r
  UINTN                             Index;\r
\r
  for (Index = 0; Index < Count; Index++) {\r
    if ((Key->OptionType == Array[Index].OptionType) &&\r
        (Key->Attributes == Array[Index].Attributes) &&\r
        (StrCmp (Key->Description, Array[Index].Description) == 0) &&\r
        (CompareMem (Key->FilePath, Array[Index].FilePath, GetDevicePathSize (Key->FilePath)) == 0) &&\r
        (Key->OptionalDataSize == Array[Index].OptionalDataSize) &&\r
        (CompareMem (Key->OptionalData, Array[Index].OptionalData, Key->OptionalDataSize) == 0)) {\r
      return (INTN) Index;\r
    }\r
  }\r
\r
  return -1;\r
}\r
\r
VOID\r
PlatformRegisterFvBootOption (\r
  EFI_GUID                         *FileGuid,\r
  CHAR16                           *Description,\r
  UINT32                           Attributes\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  UINTN                             OptionIndex;\r
  EFI_BOOT_MANAGER_LOAD_OPTION      NewOption;\r
  EFI_BOOT_MANAGER_LOAD_OPTION      *BootOptions;\r
  UINTN                             BootOptionCount;\r
  MEDIA_FW_VOL_FILEPATH_DEVICE_PATH FileNode;\r
  EFI_LOADED_IMAGE_PROTOCOL         *LoadedImage;\r
  EFI_DEVICE_PATH_PROTOCOL          *DevicePath;\r
\r
  Status = gBS->HandleProtocol (gImageHandle, &gEfiLoadedImageProtocolGuid, (VOID **) &LoadedImage);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  EfiInitializeFwVolDevicepathNode (&FileNode, FileGuid);\r
  DevicePath = AppendDevicePathNode (\r
                 DevicePathFromHandle (LoadedImage->DeviceHandle),\r
                 (EFI_DEVICE_PATH_PROTOCOL *) &FileNode\r
                 );\r
\r
  Status = EfiBootManagerInitializeLoadOption (\r
             &NewOption,\r
             LoadOptionNumberUnassigned,\r
             LoadOptionTypeBoot,\r
             Attributes,\r
             Description,\r
             DevicePath,\r
             NULL,\r
             0\r
             );\r
  if (!EFI_ERROR (Status)) {\r
    BootOptions = EfiBootManagerGetLoadOptions (&BootOptionCount, LoadOptionTypeBoot);\r
\r
    OptionIndex = PlatformFindLoadOption (&NewOption, BootOptions, BootOptionCount);\r
\r
    if (OptionIndex == -1) {\r
      Status = EfiBootManagerAddLoadOptionVariable (&NewOption, (UINTN) -1);\r
      ASSERT_EFI_ERROR (Status);\r
    }\r
    EfiBootManagerFreeLoadOption (&NewOption);\r
    EfiBootManagerFreeLoadOptions (BootOptions, BootOptionCount);\r
  }\r
}\r
\r
/**\r
  Do the platform specific action before the console is connected.\r
\r
  Such as:\r
    Update console variable;\r
    Register new Driver#### or Boot####;\r
    Signal ReadyToLock event.\r
**/\r
VOID\r
EFIAPI\r
PlatformBootManagerBeforeConsole (\r
  VOID\r
  )\r
{\r
  UINTN                        Index;\r
  EFI_STATUS                   Status;\r
  WIN_NT_SYSTEM_CONFIGURATION  *Configuration;\r
  EFI_INPUT_KEY                Enter;\r
  EFI_INPUT_KEY                F2;\r
  EFI_BOOT_MANAGER_LOAD_OPTION BootOption;\r
\r
  GetVariable2 (L"Setup", &gEfiWinNtSystemConfigGuid, (VOID **) &Configuration, NULL);\r
  if (Configuration != NULL) {\r
    //\r
    // SetupVariable is corrupt\r
    //\r
    Configuration->ConOutRow = PcdGet32 (PcdConOutColumn);\r
    Configuration->ConOutColumn = PcdGet32 (PcdConOutRow);\r
\r
    Status = gRT->SetVariable (\r
                    L"Setup",\r
                    &gEfiWinNtSystemConfigGuid,\r
                    EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
                    sizeof (WIN_NT_SYSTEM_CONFIGURATION),\r
                    Configuration\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((EFI_D_ERROR, "Failed to save Setup Variable to non-volatile storage, Status = %r\n", Status));\r
    }\r
    FreePool (Configuration);\r
  }\r
\r
  //\r
  // Update the ocnsole variables.\r
  //\r
  for (Index = 0; gPlatformConsole[Index].DevicePath != NULL; Index++) {\r
    if ((gPlatformConsole[Index].ConnectType & CONSOLE_IN) == CONSOLE_IN) {\r
      EfiBootManagerUpdateConsoleVariable (ConIn, gPlatformConsole[Index].DevicePath, NULL);\r
    }\r
\r
    if ((gPlatformConsole[Index].ConnectType & CONSOLE_OUT) == CONSOLE_OUT) {\r
      EfiBootManagerUpdateConsoleVariable (ConOut, gPlatformConsole[Index].DevicePath, NULL);\r
    }\r
\r
    if ((gPlatformConsole[Index].ConnectType & STD_ERROR) == STD_ERROR) {\r
      EfiBootManagerUpdateConsoleVariable (ErrOut, gPlatformConsole[Index].DevicePath, NULL);\r
    }\r
  }\r
\r
  //\r
  // Register ENTER as CONTINUE key\r
  //\r
  Enter.ScanCode    = SCAN_NULL;\r
  Enter.UnicodeChar = CHAR_CARRIAGE_RETURN;\r
  EfiBootManagerRegisterContinueKeyOption (0, &Enter, NULL);\r
  //\r
  // Map F2 to Boot Manager Menu\r
  //\r
  F2.ScanCode    = SCAN_F2;\r
  F2.UnicodeChar = CHAR_NULL;\r
  EfiBootManagerGetBootManagerMenu (&BootOption);\r
  EfiBootManagerAddKeyOptionVariable (NULL, (UINT16) BootOption.OptionNumber, 0, &F2, NULL);\r
  //\r
  // Register UEFI Shell\r
  //\r
  PlatformRegisterFvBootOption (&mUefiShellFileGuid, L"UEFI Shell", LOAD_OPTION_ACTIVE);\r
}\r
\r
/**\r
  Do the platform specific action after the console is connected.\r
\r
  Such as:\r
    Dynamically switch output mode;\r
    Signal console ready platform customized event;\r
    Run diagnostics like memory testing;\r
    Connect certain devices;\r
    Dispatch aditional option roms.\r
**/\r
VOID\r
EFIAPI\r
PlatformBootManagerAfterConsole (\r
  VOID\r
  )\r
{\r
  EFI_GRAPHICS_OUTPUT_BLT_PIXEL  Black;\r
  EFI_GRAPHICS_OUTPUT_BLT_PIXEL  White;\r
\r
  Black.Blue = Black.Green = Black.Red = Black.Reserved = 0;\r
  White.Blue = White.Green = White.Red = White.Reserved = 0xFF;\r
\r
  EfiBootManagerConnectAll ();\r
  EfiBootManagerRefreshAllBootOption ();\r
\r
  PlatformBootManagerDiagnostics (QUICK, TRUE);\r
  \r
  PrintXY (10, 10, &White, &Black, L"F2    to enter Boot Manager Menu.                                            ");\r
  PrintXY (10, 30, &White, &Black, L"Enter to boot directly.");\r
}\r
\r
/**\r
  This function is called each second during the boot manager waits the timeout.\r
\r
  @param TimeoutRemain  The remaining timeout.\r
**/\r
VOID\r
EFIAPI\r
PlatformBootManagerWaitCallback (\r
  UINT16          TimeoutRemain\r
  )\r
{\r
  EFI_GRAPHICS_OUTPUT_BLT_PIXEL Black;\r
  EFI_GRAPHICS_OUTPUT_BLT_PIXEL White;\r
  UINT16                        Timeout;\r
\r
  Timeout = PcdGet16 (PcdPlatformBootTimeOut);\r
\r
  Black.Blue = Black.Green = Black.Red = Black.Reserved = 0;\r
  White.Blue = White.Green = White.Red = White.Reserved = 0xFF;\r
\r
  PlatformBootManagerShowProgress (\r
    White,\r
    Black,\r
    L"Start boot option",\r
    White,\r
    (Timeout - TimeoutRemain) * 100 / Timeout,\r
    0\r
    );\r
}\r