Re: [edk2-platforms] [PATCH 06/11] BoardModulePkg: Add Generic BoardBootManagerLib

["Kubacki, Michael A" <michael.a.kubacki@intel.com>]

Reviewed-by: Michael Kubacki <michael.a.kubacki@intel.com>

> -----Original Message-----
> From: Agyeman, Prince <prince.agyeman@intel.com>
> Sent: Friday, December 13, 2019 5:33 PM
> To: devel@edk2.groups.io
> Cc: Kubacki, Michael A <michael.a.kubacki@intel.com>; Chiu, Chasel
> <chasel.chiu@intel.com>; Desimone, Nathaniel L
> <nathaniel.l.desimone@intel.com>
> Subject: [edk2-platforms] [PATCH 06/11] BoardModulePkg: Add Generic
> BoardBootManagerLib
> 
> This library implements a generic PlatformBootManagerWaitCallback and
> PlatformBootManagerUnableToBoot which will be linked Minplatform's
> PlatformBootManager library instance.
> 
> Cc: Michael Kubacki <michael.a.kubacki@intel.com>
> Cc: Chasel Chiu <chasel.chiu@intel.com>
> Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
> 
> Signed-off-by: Prince Agyeman <prince.agyeman@intel.com>
> ---
>  .../BoardBootManagerLib/BoardBootManager.c    | 103
> ++++++++++++++++++
>  .../BoardBootManagerLib.inf                   |  39 +++++++
>  .../BoardBootManagerLib.c                     |   2 +-
>  3 files changed, 143 insertions(+), 1 deletion(-)  create mode 100644
> Platform/Intel/BoardModulePkg/Library/BoardBootManagerLib/BoardBoot
> Manager.c
>  create mode 100644
> Platform/Intel/BoardModulePkg/Library/BoardBootManagerLib/BoardBoot
> ManagerLib.inf
> 
> diff --git
> a/Platform/Intel/BoardModulePkg/Library/BoardBootManagerLib/BoardBoo
> tManager.c
> b/Platform/Intel/BoardModulePkg/Library/BoardBootManagerLib/BoardBoo
> tManager.c
> new file mode 100644
> index 0000000000..f6628d4125
> --- /dev/null
> +++
> b/Platform/Intel/BoardModulePkg/Library/BoardBootManagerLib/BoardBoo
> +++ tManager.c
> @@ -0,0 +1,103 @@
> +/** @file
> +  This file include board specific boot manager callbacks
> +
> +  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
> +  SPDX-License-Identifier: BSD-2-Clause-Patent **/
> +
> +
> +#include <Library/DebugLib.h>
> +#include <Library/UefiBootServicesTableLib.h>
> +#include <Library/PlatformBootManagerLib.h>
> +#include <Library/UefiLib.h>
> +#include <Library/HobLib.h>
> +#include <Library/PrintLib.h>
> +#include <Library/PerformanceLib.h>
> +#include <Library/BoardBootManagerLib.h>
> +
> +
> +BOOLEAN    mHotKeypressed = FALSE;
> +EFI_EVENT  HotKeyEvent    = NULL;
> +UINTN      mBootMenuOptionNumber;
> +
> +/**
> +  This function is called each second during the boot manager waits timeout.
> +
> +  @param TimeoutRemain  The remaining timeout.
> +**/
> +VOID
> +EFIAPI
> +BoardBootManagerWaitCallback (
> +  UINT16          TimeoutRemain
> +  )
> +{
> +  EFI_STATUS                    Status;
> +  EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *TxtInEx;
> +  EFI_KEY_DATA                  KeyData;
> +  BOOLEAN                       PausePressed;
> +
> +  //
> +  // Pause on PAUSE key
> +  //
> +  Status = gBS->HandleProtocol (gST->ConsoleInHandle,
> + &gEfiSimpleTextInputExProtocolGuid, (VOID **) &TxtInEx);
> + ASSERT_EFI_ERROR (Status);
> +
> +  PausePressed = FALSE;
> +
> +  while (TRUE) {
> +    Status = TxtInEx->ReadKeyStrokeEx (TxtInEx, &KeyData);
> +    if (EFI_ERROR (Status)) {
> +      break;
> +    }
> +
> +    if (KeyData.Key.ScanCode == SCAN_PAUSE) {
> +      PausePressed = TRUE;
> +      break;
> +    }
> +  }
> +
> +  //
> +  // Loop until non-PAUSE key pressed
> +  //
> +  while (PausePressed) {
> +    Status = TxtInEx->ReadKeyStrokeEx (TxtInEx, &KeyData);
> +    if (!EFI_ERROR (Status)) {
> +      DEBUG ((
> +        DEBUG_INFO, "[PauseCallback] %x/%x %x/%x\n",
> +        KeyData.Key.ScanCode, KeyData.Key.UnicodeChar,
> +        KeyData.KeyState.KeyShiftState, KeyData.KeyState.KeyToggleState
> +        ));
> +      PausePressed = (BOOLEAN) (KeyData.Key.ScanCode == SCAN_PAUSE);
> +    }
> +  }
> +}
> +
> +/**
> +  The function is called when no boot option could be launched,
> +  including platform recovery options and options pointing to
> +applications
> +  built into firmware volumes.
> +
> +  If this function returns, BDS attempts to enter an infinite loop.
> +**/
> +VOID
> +EFIAPI
> +BoardBootManagerUnableToBoot (
> +  VOID
> +  )
> +{
> +  EFI_STATUS                   Status;
> +  EFI_BOOT_MANAGER_LOAD_OPTION BootDeviceList;
> +  CHAR16                       OptionName[sizeof ("Boot####")];
> +
> +  if (mBootMenuOptionNumber == LoadOptionNumberUnassigned) {
> +    return;
> +  }
> +  UnicodeSPrint (OptionName, sizeof (OptionName), L"Boot%04x",
> +mBootMenuOptionNumber);
> +  Status = EfiBootManagerVariableToLoadOption (OptionName,
> +&BootDeviceList);
> +  if (EFI_ERROR (Status)) {
> +    return;
> +  }
> +  for (;;) {
> +    EfiBootManagerBoot (&BootDeviceList);
> +  }
> +}
> diff --git
> a/Platform/Intel/BoardModulePkg/Library/BoardBootManagerLib/BoardBoo
> tManagerLib.inf
> b/Platform/Intel/BoardModulePkg/Library/BoardBootManagerLib/BoardBoo
> tManagerLib.inf
> new file mode 100644
> index 0000000000..38ff52ca81
> --- /dev/null
> +++
> b/Platform/Intel/BoardModulePkg/Library/BoardBootManagerLib/BoardBoo
> +++ tManagerLib.inf
> @@ -0,0 +1,39 @@
> +## @file
> +#  The module definition file for BoardBootManagerLib.
> +#
> +#  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR> #
> +SPDX-License-Identifier: BSD-2-Clause-Patent # ##
> +
> +[Defines]
> +  INF_VERSION                    = 0x00010005
> +  BASE_NAME                      = BoardBootManagerLib
> +  FILE_GUID                      = E7512AE0-6CB1-47ED-B6FF-94A97A86BABB
> +  MODULE_TYPE                    = DXE_DRIVER
> +  VERSION_STRING                 = 1.0
> +  LIBRARY_CLASS                  = BoardBootManagerLib|DXE_DRIVER
> +
> +
> +#
> +# The following information is for reference only and not required by the
> build tools.
> +#
> +#  VALID_ARCHITECTURES           = IA32 X64 EBC
> +#
> +
> +[Sources]
> +  BoardBootManager.c
> +
> +[LibraryClasses]
> +  BaseLib
> +  UefiBootServicesTableLib
> +  DebugLib
> +  UefiLib
> +  HobLib
> +  UefiBootManagerLib
> +  TimerLib
> +
> +[Packages]
> +  MdePkg/MdePkg.dec
> +  MdeModulePkg/MdeModulePkg.dec
> +  MinPlatformPkg/MinPlatformPkg.dec
> diff --git
> a/Platform/Intel/MinPlatformPkg/Bds/Library/BoardBootManagerLibNull/Bo
> ardBootManagerLib.c
> b/Platform/Intel/MinPlatformPkg/Bds/Library/BoardBootManagerLibNull/Bo
> ardBootManagerLib.c
> index 46fce8f59f..6bc518f02c 100644
> ---
> a/Platform/Intel/MinPlatformPkg/Bds/Library/BoardBootManagerLibNull/Bo
> ardBootManagerLib.c
> +++
> b/Platform/Intel/MinPlatformPkg/Bds/Library/BoardBootManagerLibNull/
> +++ BoardBootManagerLib.c
> @@ -1,7 +1,7 @@
>  /** @file
>    This file include board specific boot manager callbacks
> 
> -  Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>
> +  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
>    SPDX-License-Identifier: BSD-2-Clause-Patent  **/
> 
> --
> 2.19.1.windows.1