Re: [PATCH v2 edk2-platforms 05/20] Platform/Broadcom/RPi3: Add Boot Manager library

[Ard Biesheuvel <ard.biesheuvel@linaro.org>]

On Mon, 10 Dec 2018 at 13:39, Pete Batard <pete@akeo.ie> wrote:
>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Pete Batard <pete@akeo.ie>

Reviewed-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

> ---
>  Platform/Broadcom/Bcm283x/Library/PlatformBootManagerLib/PlatformBm.c               | 831 ++++++++++++++++++++
>  Platform/Broadcom/Bcm283x/Library/PlatformBootManagerLib/PlatformBm.h               |  60 ++
>  Platform/Broadcom/Bcm283x/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf |  90 +++
>  3 files changed, 981 insertions(+)
>
> diff --git a/Platform/Broadcom/Bcm283x/Library/PlatformBootManagerLib/PlatformBm.c b/Platform/Broadcom/Bcm283x/Library/PlatformBootManagerLib/PlatformBm.c
> new file mode 100644
> index 000000000000..58eeb117c769
> --- /dev/null
> +++ b/Platform/Broadcom/Bcm283x/Library/PlatformBootManagerLib/PlatformBm.c
> @@ -0,0 +1,831 @@
> +/** @file
> + *
> + *  Copyright (c) 2018, Pete Batard <pete@akeo.ie>
> + *  Copyright (c) 2017-2018, Andrei Warkentin <andrey.warkentin@gmail.com>
> + *  Copyright (c) 2016, Linaro Ltd. All rights reserved.
> + *  Copyright (c) 2015-2016, Red Hat, Inc.
> + *  Copyright (c) 2014, ARM Ltd. All rights reserved.
> + *  Copyright (c) 2004-2016, Intel Corporation. All rights reserved.
> + *
> + *  This program and the accompanying materials
> + *  are licensed and made available under the terms and conditions of the BSD License
> + *  which accompanies this distribution.  The full text of the license may be found at
> + *  http://opensource.org/licenses/bsd-license.php
> + *
> + *  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
> + *  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
> + *
> + **/
> +
> +#include <Library/BootLogoLib.h>
> +#include <Library/CapsuleLib.h>
> +#include <Library/DevicePathLib.h>
> +#include <Library/HobLib.h>
> +#include <Library/PcdLib.h>
> +#include <Library/UefiBootManagerLib.h>
> +#include <Library/UefiLib.h>
> +#include <Library/PrintLib.h>
> +#include <Protocol/DevicePath.h>
> +#include <Protocol/EsrtManagement.h>
> +#include <Protocol/GraphicsOutput.h>
> +#include <Protocol/LoadedImage.h>
> +#include <Guid/EventGroup.h>
> +#include <Guid/TtyTerm.h>
> +#include <Protocol/BootLogo.h>
> +
> +#include "PlatformBm.h"
> +
> +#define BOOT_PROMPT L"ESC (setup), F1 (shell), ENTER (boot)"
> +
> +#define DP_NODE_LEN(Type) { (UINT8)sizeof (Type), (UINT8)(sizeof (Type) >> 8) }
> +
> +#pragma pack (1)
> +typedef struct {
> +  VENDOR_DEVICE_PATH         SerialDxe;
> +  UART_DEVICE_PATH           Uart;
> +  VENDOR_DEFINED_DEVICE_PATH TermType;
> +  EFI_DEVICE_PATH_PROTOCOL   End;
> +} PLATFORM_SERIAL_CONSOLE;
> +#pragma pack ()
> +
> +typedef struct {
> +  VENDOR_DEVICE_PATH            Custom;
> +  USB_DEVICE_PATH               Hub;
> +  USB_DEVICE_PATH               Dev;
> +  EFI_DEVICE_PATH_PROTOCOL      EndDevicePath;
> +} PLATFORM_USB_DEV;
> +
> +typedef struct {
> +  VENDOR_DEVICE_PATH            Custom;
> +  EFI_DEVICE_PATH_PROTOCOL      EndDevicePath;
> +} PLATFORM_SD_DEV;
> +
> +#define DW_USB_DXE_FILE_GUID { \
> +          0x4bf1704c, 0x03f4, 0x46d5, \
> +          { 0xbc, 0xa6, 0x82, 0xfa, 0x58, 0x0b, 0xad, 0xfd } \
> +          }
> +
> +#define ARASAN_MMC_DXE_FILE_GUID { \
> +          0x100c2cfa, 0xb586, 0x4198, \
> +          { 0x9b, 0x4c, 0x16, 0x83, 0xd1, 0x95, 0xb1, 0xda } \
> +          }
> +
> +#define SDHOST_MMC_DXE_FILE_GUID { \
> +          0x58abd787, 0xf64d, 0x4ca2, \
> +          { 0xa0, 0x34, 0xb9, 0xac, 0x2d, 0x5a, 0xd0, 0xcf } \
> +          }
> +
> +STATIC PLATFORM_SD_DEV mArasan = {
> +  //
> +  // VENDOR_DEVICE_PATH ArasanMMCHostDxe
> +  //
> +  {
> +    { HARDWARE_DEVICE_PATH, HW_VENDOR_DP, DP_NODE_LEN (VENDOR_DEVICE_PATH) },
> +    ARASAN_MMC_DXE_FILE_GUID
> +  },
> +
> +  //
> +  // EFI_DEVICE_PATH_PROTOCOL End
> +  //
> +  {
> +    END_DEVICE_PATH_TYPE, END_ENTIRE_DEVICE_PATH_SUBTYPE,
> +    DP_NODE_LEN (EFI_DEVICE_PATH_PROTOCOL)
> +  }
> +};
> +
> +STATIC PLATFORM_SD_DEV mSDHost = {
> +  //
> +  // VENDOR_DEVICE_PATH SdHostDxe
> +  //
> +  {
> +    { HARDWARE_DEVICE_PATH, HW_VENDOR_DP, DP_NODE_LEN (VENDOR_DEVICE_PATH) },
> +    SDHOST_MMC_DXE_FILE_GUID
> +  },
> +
> +  //
> +  // EFI_DEVICE_PATH_PROTOCOL End
> +  //
> +  {
> +    END_DEVICE_PATH_TYPE, END_ENTIRE_DEVICE_PATH_SUBTYPE,
> +    DP_NODE_LEN (EFI_DEVICE_PATH_PROTOCOL)
> +  }
> +};
> +
> +STATIC PLATFORM_USB_DEV mUsbHubPort = {
> +  //
> +  // VENDOR_DEVICE_PATH DwUsbHostDxe
> +  //
> +  {
> +    { HARDWARE_DEVICE_PATH, HW_VENDOR_DP, DP_NODE_LEN (VENDOR_DEVICE_PATH) },
> +    DW_USB_DXE_FILE_GUID
> +  },
> +
> +  //
> +  // USB_DEVICE_PATH Hub
> +  //
> +  {
> +    { MESSAGING_DEVICE_PATH, MSG_USB_DP, DP_NODE_LEN (USB_DEVICE_PATH) },
> +    0, 0
> +  },
> +
> +  //
> +  // USB_DEVICE_PATH Dev
> +  //
> +  {
> +    { MESSAGING_DEVICE_PATH, MSG_USB_DP, DP_NODE_LEN (USB_DEVICE_PATH) },
> +    1, 0
> +  },
> +
> +  //
> +  // EFI_DEVICE_PATH_PROTOCOL End
> +  //
> +  {
> +    END_DEVICE_PATH_TYPE, END_ENTIRE_DEVICE_PATH_SUBTYPE,
> +    DP_NODE_LEN (EFI_DEVICE_PATH_PROTOCOL)
> +  }
> +};
> +
> +#define SERIAL_DXE_FILE_GUID { \
> +          0xD3987D4B, 0x971A, 0x435F, \
> +          { 0x8C, 0xAF, 0x49, 0x67, 0xEB, 0x62, 0x72, 0x41 } \
> +          }
> +
> +STATIC PLATFORM_SERIAL_CONSOLE mSerialConsole = {
> +  //
> +  // VENDOR_DEVICE_PATH SerialDxe
> +  //
> +  {
> +    { HARDWARE_DEVICE_PATH, HW_VENDOR_DP, DP_NODE_LEN (VENDOR_DEVICE_PATH) },
> +    SERIAL_DXE_FILE_GUID
> +  },
> +
> +  //
> +  // UART_DEVICE_PATH Uart
> +  //
> +  {
> +    { MESSAGING_DEVICE_PATH, MSG_UART_DP, DP_NODE_LEN (UART_DEVICE_PATH) },
> +    0,                                      // Reserved
> +    FixedPcdGet64 (PcdUartDefaultBaudRate), // BaudRate
> +    FixedPcdGet8 (PcdUartDefaultDataBits),  // DataBits
> +    FixedPcdGet8 (PcdUartDefaultParity),    // Parity
> +    FixedPcdGet8 (PcdUartDefaultStopBits)   // StopBits
> +  },
> +
> +  //
> +  // VENDOR_DEFINED_DEVICE_PATH TermType
> +  //
> +  {
> +    {
> +      MESSAGING_DEVICE_PATH, MSG_VENDOR_DP,
> +      DP_NODE_LEN (VENDOR_DEFINED_DEVICE_PATH)
> +    }
> +    //
> +    // Guid to be filled in dynamically
> +    //
> +  },
> +
> +  //
> +  // EFI_DEVICE_PATH_PROTOCOL End
> +  //
> +  {
> +    END_DEVICE_PATH_TYPE, END_ENTIRE_DEVICE_PATH_SUBTYPE,
> +    DP_NODE_LEN (EFI_DEVICE_PATH_PROTOCOL)
> +  }
> +};
> +
> +
> +#pragma pack (1)
> +typedef struct {
> +  USB_CLASS_DEVICE_PATH    Keyboard;
> +  EFI_DEVICE_PATH_PROTOCOL End;
> +} PLATFORM_USB_KEYBOARD;
> +#pragma pack ()
> +
> +STATIC PLATFORM_USB_KEYBOARD mUsbKeyboard = {
> +  //
> +  // USB_CLASS_DEVICE_PATH Keyboard
> +  //
> +  {
> +    {
> +      MESSAGING_DEVICE_PATH, MSG_USB_CLASS_DP,
> +      DP_NODE_LEN (USB_CLASS_DEVICE_PATH)
> +    },
> +    0xFFFF, // VendorId: any
> +    0xFFFF, // ProductId: any
> +    3,      // DeviceClass: HID
> +    1,      // DeviceSubClass: boot
> +    1       // DeviceProtocol: keyboard
> +  },
> +
> +  //
> +  // EFI_DEVICE_PATH_PROTOCOL End
> +  //
> +  {
> +    END_DEVICE_PATH_TYPE, END_ENTIRE_DEVICE_PATH_SUBTYPE,
> +    DP_NODE_LEN (EFI_DEVICE_PATH_PROTOCOL)
> +  }
> +};
> +
> +STATIC EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *mSerialConProtocol;
> +
> +/**
> +  Check if the handle satisfies a particular condition.
> +
> +  @param[in] Handle      The handle to check.
> +  @param[in] ReportText  A caller-allocated string passed in for reporting
> +                         purposes. It must never be NULL.
> +
> +  @retval TRUE   The condition is satisfied.
> +  @retval FALSE  Otherwise. This includes the case when the condition could not
> +                 be fully evaluated due to an error.
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *FILTER_FUNCTION) (
> +  IN EFI_HANDLE   Handle,
> +  IN CONST CHAR16 *ReportText
> +  );
> +
> +
> +/**
> +  Process a handle.
> +
> +  @param[in] Handle      The handle to process.
> +  @param[in] ReportText  A caller-allocated string passed in for reporting
> +                         purposes. It must never be NULL.
> +**/
> +typedef
> +VOID
> +(EFIAPI *CALLBACK_FUNCTION)  (
> +  IN EFI_HANDLE   Handle,
> +  IN CONST CHAR16 *ReportText
> +  );
> +
> +/**
> +  Locate all handles that carry the specified protocol, filter them with a
> +  callback function, and pass each handle that passes the filter to another
> +  callback.
> +
> +  @param[in] ProtocolGuid  The protocol to look for.
> +
> +  @param[in] Filter        The filter function to pass each handle to. If this
> +                           parameter is NULL, then all handles are processed.
> +
> +  @param[in] Process       The callback function to pass each handle to that
> +                           clears the filter.
> +**/
> +STATIC
> +VOID
> +FilterAndProcess (
> +  IN EFI_GUID          *ProtocolGuid,
> +  IN FILTER_FUNCTION   Filter         OPTIONAL,
> +  IN CALLBACK_FUNCTION Process
> +  )
> +{
> +  EFI_STATUS Status;
> +  EFI_HANDLE *Handles;
> +  UINTN      NoHandles;
> +  UINTN      Idx;
> +
> +  Status = gBS->LocateHandleBuffer (ByProtocol, ProtocolGuid,
> +                  NULL /* SearchKey */, &NoHandles, &Handles);
> +  if (EFI_ERROR (Status)) {
> +    //
> +    // This is not an error, just an informative condition.
> +    //
> +    DEBUG ((DEBUG_VERBOSE, "%a: %g: %r\n", __FUNCTION__, ProtocolGuid,
> +      Status));
> +    return;
> +  }
> +
> +  ASSERT (NoHandles > 0);
> +  for (Idx = 0; Idx < NoHandles; ++Idx) {
> +    CHAR16        *DevicePathText;
> +    STATIC CHAR16 Fallback[] = L"<device path unavailable>";
> +
> +    //
> +    // The ConvertDevicePathToText() function handles NULL input transparently.
> +    //
> +    DevicePathText = ConvertDevicePathToText (
> +                       DevicePathFromHandle (Handles[Idx]),
> +                       FALSE, // DisplayOnly
> +                       FALSE  // AllowShortcuts
> +                       );
> +    if (DevicePathText == NULL) {
> +      DevicePathText = Fallback;
> +    }
> +
> +    if (Filter == NULL || Filter (Handles[Idx], DevicePathText)) {
> +      Process (Handles[Idx], DevicePathText);
> +    }
> +
> +    if (DevicePathText != Fallback) {
> +      FreePool (DevicePathText);
> +    }
> +  }
> +  gBS->FreePool (Handles);
> +}
> +
> +/**
> +  This CALLBACK_FUNCTION retrieves the EFI_DEVICE_PATH_PROTOCOL from the
> +  handle, and adds it to ConOut and ErrOut.
> +**/
> +STATIC
> +VOID
> +EFIAPI
> +AddOutput (
> +  IN EFI_HANDLE   Handle,
> +  IN CONST CHAR16 *ReportText
> +  )
> +{
> +  EFI_STATUS               Status;
> +  EFI_DEVICE_PATH_PROTOCOL *DevicePath;
> +
> +  DevicePath = DevicePathFromHandle (Handle);
> +  if (DevicePath == NULL) {
> +    DEBUG ((DEBUG_ERROR, "%a: %s: handle %p: device path not found\n",
> +      __FUNCTION__, ReportText, Handle));
> +    return;
> +  }
> +
> +  Status = EfiBootManagerUpdateConsoleVariable (ConOut, DevicePath, NULL);
> +  if (EFI_ERROR (Status)) {
> +    DEBUG ((DEBUG_ERROR, "%a: %s: adding to ConOut: %r\n", __FUNCTION__,
> +      ReportText, Status));
> +    return;
> +  }
> +
> +  Status = EfiBootManagerUpdateConsoleVariable (ErrOut, DevicePath, NULL);
> +  if (EFI_ERROR (Status)) {
> +    DEBUG ((DEBUG_ERROR, "%a: %s: adding to ErrOut: %r\n", __FUNCTION__,
> +      ReportText, Status));
> +    return;
> +  }
> +
> +  DEBUG ((DEBUG_VERBOSE, "%a: %s: added to ConOut and ErrOut\n", __FUNCTION__,
> +    ReportText));
> +}
> +
> +STATIC
> +INTN
> +PlatformRegisterBootOption (
> +  EFI_DEVICE_PATH_PROTOCOL *DevicePath,
> +  CHAR16                   *Description,
> +  UINT32                   Attributes
> +  )
> +{
> +  EFI_STATUS                        Status;
> +  INTN                              OptionIndex;
> +  EFI_BOOT_MANAGER_LOAD_OPTION      NewOption;
> +  EFI_BOOT_MANAGER_LOAD_OPTION      *BootOptions;
> +  UINTN                             BootOptionCount;
> +
> +  Status = EfiBootManagerInitializeLoadOption (
> +             &NewOption,
> +             LoadOptionNumberUnassigned,
> +             LoadOptionTypeBoot,
> +             Attributes,
> +             Description,
> +             DevicePath,
> +             NULL,
> +             0
> +             );
> +  ASSERT_EFI_ERROR (Status);
> +
> +  BootOptions = EfiBootManagerGetLoadOptions (
> +                  &BootOptionCount, LoadOptionTypeBoot
> +                  );
> +
> +  OptionIndex = EfiBootManagerFindLoadOption (
> +                  &NewOption, BootOptions, BootOptionCount
> +                  );
> +
> +  if (OptionIndex == -1) {
> +    Status = EfiBootManagerAddLoadOptionVariable (&NewOption, MAX_UINTN);
> +    ASSERT_EFI_ERROR (Status);
> +    OptionIndex = BootOptionCount;
> +  }
> +
> +  EfiBootManagerFreeLoadOption (&NewOption);
> +  EfiBootManagerFreeLoadOptions (BootOptions, BootOptionCount);
> +
> +  return OptionIndex;
> +}
> +
> +STATIC
> +INTN
> +PlatformRegisterFvBootOption (
> +  CONST EFI_GUID                   *FileGuid,
> +  CHAR16                           *Description,
> +  UINT32                           Attributes
> +  )
> +{
> +  EFI_STATUS                        Status;
> +  MEDIA_FW_VOL_FILEPATH_DEVICE_PATH FileNode;
> +  EFI_LOADED_IMAGE_PROTOCOL         *LoadedImage;
> +  EFI_DEVICE_PATH_PROTOCOL          *DevicePath;
> +  INTN OptionIndex;
> +
> +  Status = gBS->HandleProtocol (
> +                  gImageHandle,
> +                  &gEfiLoadedImageProtocolGuid,
> +                  (VOID **) &LoadedImage
> +                  );
> +  ASSERT_EFI_ERROR (Status);
> +
> +  EfiInitializeFwVolDevicepathNode (&FileNode, FileGuid);
> +  DevicePath = DevicePathFromHandle (LoadedImage->DeviceHandle);
> +  ASSERT (DevicePath != NULL);
> +  DevicePath = AppendDevicePathNode (
> +                 DevicePath,
> +                 (EFI_DEVICE_PATH_PROTOCOL *) &FileNode
> +                 );
> +  ASSERT (DevicePath != NULL);
> +
> +  OptionIndex = PlatformRegisterBootOption (DevicePath,
> +                                            Description,
> +                                            Attributes);
> +  FreePool (DevicePath);
> +
> +  return OptionIndex;
> +}
> +
> +
> +STATIC
> +VOID
> +PlatformRegisterOptionsAndKeys (
> +  VOID
> +  )
> +{
> +  EFI_STATUS                   Status;
> +  EFI_INPUT_KEY                Enter;
> +  EFI_INPUT_KEY                F1;
> +  EFI_INPUT_KEY                Esc;
> +  EFI_BOOT_MANAGER_LOAD_OPTION BootOption;
> +  INTN ShellOption;
> +
> +  ShellOption = PlatformRegisterFvBootOption (&gUefiShellFileGuid, L"UEFI Shell",
> +                                              LOAD_OPTION_ACTIVE);
> +  if (ShellOption != -1) {
> +    //
> +    // F1 boots Shell.
> +    //
> +    F1.ScanCode = SCAN_F1;
> +    F1.UnicodeChar = CHAR_NULL;
> +    Status = EfiBootManagerAddKeyOptionVariable (
> +      NULL, (UINT16) ShellOption, 0, &F1, NULL);
> +    ASSERT (Status == EFI_SUCCESS || Status == EFI_ALREADY_STARTED);
> +  }
> +
> +  //
> +  // Register ENTER as CONTINUE key
> +  //
> +  Enter.ScanCode    = SCAN_NULL;
> +  Enter.UnicodeChar = CHAR_CARRIAGE_RETURN;
> +  Status = EfiBootManagerRegisterContinueKeyOption (0, &Enter, NULL);
> +  ASSERT_EFI_ERROR (Status);
> +
> +  //
> +  // Map ESC to Boot Manager Menu
> +  //
> +  Esc.ScanCode    = SCAN_ESC;
> +  Esc.UnicodeChar = CHAR_NULL;
> +  Status = EfiBootManagerGetBootManagerMenu (&BootOption);
> +  ASSERT_EFI_ERROR (Status);
> +  Status = EfiBootManagerAddKeyOptionVariable (
> +             NULL, (UINT16) BootOption.OptionNumber, 0, &Esc, NULL
> +             );
> +  ASSERT (Status == EFI_SUCCESS || Status == EFI_ALREADY_STARTED);
> +}
> +
> +STATIC VOID
> +SerialConPrint (
> +  IN CHAR16 *Text
> +  )
> +{
> +  if (mSerialConProtocol != NULL) {
> +    mSerialConProtocol->OutputString (mSerialConProtocol, Text);
> +  }
> +}
> +
> +STATIC VOID EFIAPI
> +ExitBootServicesHandler (
> +                         EFI_EVENT     Event,
> +                         VOID          *Context
> +                         )
> +{
> +  EFI_STATUS Status;
> +  CHAR16 *OsBootStr;
> +  EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION Green;
> +  EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION Black;
> +  EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION Yellow;
> +  //
> +  // Long enough to occlude the string printed
> +  // in PlatformBootManagerWaitCallback.
> +  //
> +  STATIC CHAR16 *OsBootStrEL1 = L"Exiting UEFI and booting EL1 OS kernel!\r\n";
> +  STATIC CHAR16 *OsBootStrEL2 = L"Exiting UEFI and booting EL2 OS kernel!\r\n";
> +
> +  if (!PcdGet32 (PcdDebugShowUEFIExit)) {
> +    return;
> +  }
> +
> +  if (PcdGet32 (PcdHypEnable)) {
> +    OsBootStr = OsBootStrEL1;
> +  } else {
> +    OsBootStr = OsBootStrEL2;
> +  }
> +
> +  Green.Raw = 0x00007F00;
> +  Black.Raw = 0x00000000;
> +  Yellow.Raw = 0x00FFFF00;
> +
> +  Status = BootLogoUpdateProgress (Yellow.Pixel,
> +                                   Black.Pixel,
> +                                   OsBootStr,
> +                                   Green.Pixel,
> +                                   100, 0);
> +  if (Status == EFI_SUCCESS) {
> +    SerialConPrint(OsBootStr);
> +  } else {
> +    Print(L"\n");
> +    Print(OsBootStr);
> +    Print(L"\n");
> +  }
> +}
> +
> +//
> +// BDS Platform Functions
> +//
> +/**
> +  Do the platform init, can be customized by OEM/IBV
> +  Possible things that can be done in PlatformBootManagerBeforeConsole:
> +  > Update console variable: 1. include hot-plug devices;
> +  >                          2. Clear ConIn and add SOL for AMT
> +  > Register new Driver#### or Boot####
> +  > Register new Key####: e.g.: F12
> +  > Signal ReadyToLock event
> +  > Authentication action: 1. connect Auth devices;
> +  >                        2. Identify auto logon user.
> +**/
> +VOID
> +EFIAPI
> +PlatformBootManagerBeforeConsole (
> +  VOID
> +  )
> +{
> +  EFI_STATUS Status;
> +  EFI_EVENT ExitBSEvent;
> +  ESRT_MANAGEMENT_PROTOCOL *EsrtManagement;
> +
> +  Status = gBS->CreateEventEx (
> +                               EVT_NOTIFY_SIGNAL,
> +                               TPL_NOTIFY,
> +                               ExitBootServicesHandler,
> +                               NULL,
> +                               &gEfiEventExitBootServicesGuid,
> +                               &ExitBSEvent
> +                               );
> +  if (EFI_ERROR (Status)) {
> +    DEBUG ((DEBUG_ERROR, "%a: failed to register ExitBootServices handler\n",
> +            __FUNCTION__));
> +  }
> +
> +  if (GetBootModeHob() == BOOT_ON_FLASH_UPDATE) {
> +    DEBUG ((DEBUG_INFO, "ProcessCapsules Before EndOfDxe ......\n"));
> +    Status = ProcessCapsules ();
> +    DEBUG ((DEBUG_INFO, "ProcessCapsules returned %r\n", Status));
> +  } else {
> +    Status = gBS->LocateProtocol (&gEsrtManagementProtocolGuid, NULL,
> +                    (VOID **)&EsrtManagement);
> +    if (!EFI_ERROR (Status)) {
> +      EsrtManagement->SyncEsrtFmp ();
> +    }
> +  }
> +
> +  //
> +  // Now add the device path of all handles with GOP on them to ConOut and
> +  // ErrOut.
> +  //
> +  FilterAndProcess (&gEfiGraphicsOutputProtocolGuid, NULL, AddOutput);
> +
> +  //
> +  // Add the hardcoded short-form USB keyboard device path to ConIn.
> +  //
> +  EfiBootManagerUpdateConsoleVariable (ConIn,
> +    (EFI_DEVICE_PATH_PROTOCOL *)&mUsbKeyboard, NULL);
> +
> +  //
> +  // Add the hardcoded serial console device path to ConIn, ConOut, ErrOut.
> +  //
> +  ASSERT (FixedPcdGet8 (PcdDefaultTerminalType) == 4);
> +  CopyGuid (&mSerialConsole.TermType.Guid, &gEfiTtyTermGuid);
> +
> +  EfiBootManagerUpdateConsoleVariable (ConIn,
> +    (EFI_DEVICE_PATH_PROTOCOL *)&mSerialConsole, NULL);
> +  EfiBootManagerUpdateConsoleVariable (ConOut,
> +    (EFI_DEVICE_PATH_PROTOCOL *)&mSerialConsole, NULL);
> +  EfiBootManagerUpdateConsoleVariable (ErrOut,
> +    (EFI_DEVICE_PATH_PROTOCOL *)&mSerialConsole, NULL);
> +
> +  //
> +  // Signal EndOfDxe PI Event
> +  //
> +  EfiEventGroupSignal (&gEfiEndOfDxeEventGroupGuid);
> +
> +  //
> +  // Dispatch deferred images after EndOfDxe event and ReadyToLock installation.
> +  //
> +  EfiBootManagerDispatchDeferredImages ();
> +}
> +
> +/**
> +  Do the platform specific action after the console is ready
> +  Possible things that can be done in PlatformBootManagerAfterConsole:
> +  > Console post action:
> +    > Dynamically switch output mode from 100x31 to 80x25 for certain senarino
> +    > Signal console ready platform customized event
> +  > Run diagnostics like memory testing
> +  > Connect certain devices
> +  > Dispatch aditional option roms
> +  > Special boot: e.g.: USB boot, enter UI
> +**/
> +VOID
> +EFIAPI
> +PlatformBootManagerAfterConsole (
> +  VOID
> +  )
> +{
> +  UINTN Index;
> +  ESRT_MANAGEMENT_PROTOCOL      *EsrtManagement;
> +  EFI_STATUS                    Status;
> +  EFI_HANDLE SerialHandle;
> +
> +  Status = EfiBootManagerConnectDevicePath((EFI_DEVICE_PATH_PROTOCOL *)&mSerialConsole, &SerialHandle);
> +  if (Status == EFI_SUCCESS) {
> +    gBS->HandleProtocol(SerialHandle, &gEfiSimpleTextOutProtocolGuid,
> +                        (VOID **) &mSerialConProtocol);
> +  }
> +
> +  //
> +  // Show the splash screen.
> +  //
> +  Status = BootLogoEnableLogo ();
> +  if (Status == EFI_SUCCESS) {
> +    SerialConPrint(BOOT_PROMPT);
> +  } else {
> +    Print(BOOT_PROMPT);
> +  }
> +
> +  //
> +  // Connect the rest of the devices.
> +  //
> +  EfiBootManagerConnectAll ();
> +
> +  Status = gBS->LocateProtocol (&gEsrtManagementProtocolGuid, NULL,
> +                  (VOID **)&EsrtManagement);
> +  if (!EFI_ERROR (Status)) {
> +    EsrtManagement->SyncEsrtFmp ();
> +  }
> +
> +  if (GetBootModeHob() == BOOT_ON_FLASH_UPDATE) {
> +    DEBUG((DEBUG_INFO, "ProcessCapsules After EndOfDxe ......\n"));
> +    Status = ProcessCapsules ();
> +    DEBUG((DEBUG_INFO, "ProcessCapsules returned %r\n", Status));
> +  }
> +
> +  for (Index = 1; Index < 5; Index++) {
> +    UINT16 Desc[11];
> +    /*
> +     * Add boot options to allow booting from
> +     * a mass storage device plugged into any
> +     * of the RPi USB ports.
> +     */
> +    mUsbHubPort.Dev.ParentPortNumber = Index;
> +    UnicodeSPrint(Desc, sizeof (Desc), L"USB Port %u", Index);
> +    PlatformRegisterBootOption ((VOID *) &mUsbHubPort,
> +                                Desc, LOAD_OPTION_ACTIVE);
> +  }
> +
> +  PlatformRegisterBootOption ((VOID *) &mSDHost,
> +                              L"uSD on SD Host",
> +                              LOAD_OPTION_ACTIVE);
> +  PlatformRegisterBootOption ((VOID *) &mArasan,
> +                              L"uSD on Arasan MMC Host",
> +                              LOAD_OPTION_ACTIVE);
> +
> +  PlatformRegisterOptionsAndKeys ();
> +}
> +
> +/**
> +  This function is called each second during the boot manager waits the
> +  timeout.
> +
> +  @param TimeoutRemain  The remaining timeout.
> +**/
> +VOID
> +EFIAPI
> +PlatformBootManagerWaitCallback (
> +  UINT16          TimeoutRemain
> +  )
> +{
> +  EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION Black;
> +  EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION White;
> +  UINT16                              Timeout;
> +  EFI_STATUS                          Status;
> +  EFI_BOOT_LOGO_PROTOCOL *BootLogo;
> +
> +  Timeout = PcdGet16 (PcdPlatformBootTimeOut);
> +
> +  Black.Raw = 0x00000000;
> +  White.Raw = 0x00FFFFFF;
> +
> +  Status = BootLogoUpdateProgress (
> +    White.Pixel,
> +    Black.Pixel,
> +    BOOT_PROMPT,
> +    White.Pixel,
> +    (Timeout - TimeoutRemain) * 100 / Timeout,
> +    0
> +    );
> +  if (Status == EFI_SUCCESS) {
> +    SerialConPrint(L".");
> +  } else {
> +    Print(L".");
> +  }
> +
> +  if (TimeoutRemain == 0) {
> +    BootLogo = NULL;
> +
> +    //
> +    // Clear out the boot logo so that Windows displays its own logo
> +    // instead of ours.
> +    //
> +    Status = gBS->LocateProtocol (&gEfiBootLogoProtocolGuid, NULL, (VOID **) &BootLogo);
> +    if (!EFI_ERROR (Status) && (BootLogo != NULL)) {
> +      Status = BootLogo->SetBootLogo (BootLogo, NULL, 0, 0, 0, 0);
> +      ASSERT_EFI_ERROR (Status);
> +    };
> +
> +    gST->ConOut->ClearScreen (gST->ConOut);
> +  }
> +}
> +
> +/**
> +  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
> +PlatformBootManagerUnableToBoot(
> +    VOID
> +)
> +{
> +  EFI_STATUS                   Status;
> +  EFI_INPUT_KEY                Key;
> +  EFI_BOOT_MANAGER_LOAD_OPTION BootManagerMenu;
> +  UINTN                        Index;
> +
> +  //
> +  // BootManagerMenu doesn't contain the correct information when return status
> +  // is EFI_NOT_FOUND.
> +  //
> +  Status = EfiBootManagerGetBootManagerMenu(&BootManagerMenu);
> +  if (EFI_ERROR(Status)) {
> +    return;
> +  }
> +  //
> +  // Normally BdsDxe does not print anything to the system console, but this is
> +  // a last resort -- the end-user will likely not see any DEBUG messages
> +  // logged in this situation.
> +  //
> +  // AsciiPrint() will NULL-check gST->ConOut internally. We check gST->ConIn
> +  // here to see if it makes sense to request and wait for a keypress.
> +  //
> +  if (gST->ConIn != NULL) {
> +    AsciiPrint(
> +      "%a: No bootable option or device was found.\n"
> +      "%a: Press any key to enter the Boot Manager Menu.\n",
> +      gEfiCallerBaseName,
> +      gEfiCallerBaseName
> +    );
> +    Status = gBS->WaitForEvent(1, &gST->ConIn->WaitForKey, &Index);
> +    ASSERT_EFI_ERROR(Status);
> +    ASSERT(Index == 0);
> +
> +    //
> +    // Drain any queued keys.
> +    //
> +    while (!EFI_ERROR(gST->ConIn->ReadKeyStroke(gST->ConIn, &Key))) {
> +      //
> +      // just throw away Key
> +      //
> +    }
> +  }
> +
> +  for (;;) {
> +    EfiBootManagerBoot(&BootManagerMenu);
> +  }
> +}
> diff --git a/Platform/Broadcom/Bcm283x/Library/PlatformBootManagerLib/PlatformBm.h b/Platform/Broadcom/Bcm283x/Library/PlatformBootManagerLib/PlatformBm.h
> new file mode 100644
> index 000000000000..3717ba6174df
> --- /dev/null
> +++ b/Platform/Broadcom/Bcm283x/Library/PlatformBootManagerLib/PlatformBm.h
> @@ -0,0 +1,60 @@
> +/** @file
> + *
> + *  Copyright (c) 2017-2018, Andrei Warkentin <andrey.warkentin@gmail.com>
> + *  Copyright (c) 2016, Linaro Ltd. All rights reserved.
> + *  Copyright (c) 2015-2016, Red Hat, Inc.
> + *  Copyright (c) 2014, ARM Ltd. All rights reserved.
> + *  Copyright (c) 2004-2016, Intel Corporation. All rights reserved.
> + *
> + *  This program and the accompanying materials
> + *  are licensed and made available under the terms and conditions of the BSD License
> + *  which accompanies this distribution.  The full text of the license may be found at
> + *  http://opensource.org/licenses/bsd-license.php
> + *
> + *  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
> + *  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
> + *
> + **/
> +
> +#ifndef _PLATFORM_BM_H_
> +#define _PLATFORM_BM_H_
> +
> +#include <Library/BaseLib.h>
> +#include <Library/BaseMemoryLib.h>
> +#include <Library/DebugLib.h>
> +#include <Library/DevicePathLib.h>
> +#include <Library/MemoryAllocationLib.h>
> +#include <Library/UefiBootServicesTableLib.h>
> +#include <Library/UefiLib.h>
> +#include <Library/UefiRuntimeServicesTableLib.h>
> +
> +/**
> +  Use SystemTable Conout to stop video based Simple Text Out consoles from
> +  going to the video device. Put up LogoFile on every video device that is a
> +  console.
> +
> +  @param[in]  LogoFile   File name of logo to display on the center of the
> +                         screen.
> +
> +  @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo
> +                          displayed.
> +  @retval EFI_UNSUPPORTED Logo not found
> +**/
> +EFI_STATUS
> +EnableQuietBoot (
> +  IN  EFI_GUID  *LogoFile
> +  );
> +
> +/**
> +  Use SystemTable Conout to turn on video based Simple Text Out consoles. The
> +  Simple Text Out screens will now be synced up with all non video output
> +  devices
> +
> +  @retval EFI_SUCCESS     UGA devices are back in text mode and synced up.
> +**/
> +EFI_STATUS
> +DisableQuietBoot (
> +  VOID
> +  );
> +
> +#endif // _PLATFORM_BM_H_
> diff --git a/Platform/Broadcom/Bcm283x/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf b/Platform/Broadcom/Bcm283x/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf
> new file mode 100644
> index 000000000000..cb1d42364265
> --- /dev/null
> +++ b/Platform/Broadcom/Bcm283x/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf
> @@ -0,0 +1,90 @@
> +#/** @file
> +#
> +#  Copyright (c) 2017-2018, Andrei Warkentin <andrey.warkentin@gmail.com>
> +#  Copyright (c) 2016, Linaro Ltd. All rights reserved.
> +#  Copyright (c) 2015-2016, Red Hat, Inc.
> +#  Copyright (c) 2014, ARM Ltd. All rights reserved.
> +#  Copyright (c) 2007-2014, Intel Corporation. All rights reserved.
> +#
> +#  This program and the accompanying materials are licensed and made available
> +#  under the terms and conditions of the BSD License which accompanies this
> +#  distribution. The full text of the license may be found at
> +#  http://opensource.org/licenses/bsd-license.php
> +#
> +#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
> +#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR
> +#  IMPLIED.
> +#
> +#**/
> +
> +[Defines]
> +  INF_VERSION                    = 0x00010005
> +  BASE_NAME                      = PlatformBootManagerLib
> +  FILE_GUID                      = 92FD2DE3-B9CB-4B35-8141-42AD34D73C9F
> +  MODULE_TYPE                    = DXE_DRIVER
> +  VERSION_STRING                 = 1.0
> +  LIBRARY_CLASS                  = PlatformBootManagerLib|DXE_DRIVER
> +
> +#
> +# The following information is for reference only and not required by the build tools.
> +#
> +#  VALID_ARCHITECTURES           = AARCH64
> +#
> +
> +[Sources]
> +  PlatformBm.c
> +
> +[Packages]
> +  MdeModulePkg/MdeModulePkg.dec
> +  MdePkg/MdePkg.dec
> +  ShellPkg/ShellPkg.dec
> +  Platform/Broadcom/Bcm283x/RaspberryPiPkg.dec
> +
> +[LibraryClasses]
> +  BaseLib
> +  BaseMemoryLib
> +  BootLogoLib
> +  CapsuleLib
> +  DebugLib
> +  DevicePathLib
> +  DxeServicesLib
> +  HobLib
> +  MemoryAllocationLib
> +  PcdLib
> +  PrintLib
> +  UefiBootManagerLib
> +  UefiBootServicesTableLib
> +  UefiLib
> +
> +[FeaturePcd]
> +  gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport
> +
> +[FixedPcd]
> +  gEfiMdePkgTokenSpaceGuid.PcdUartDefaultBaudRate
> +  gEfiMdePkgTokenSpaceGuid.PcdUartDefaultDataBits
> +  gEfiMdePkgTokenSpaceGuid.PcdUartDefaultParity
> +  gEfiMdePkgTokenSpaceGuid.PcdUartDefaultStopBits
> +  gEfiMdePkgTokenSpaceGuid.PcdDefaultTerminalType
> +
> +[Pcd]
> +  gEfiMdePkgTokenSpaceGuid.PcdPlatformBootTimeOut
> +  gRaspberryPiTokenSpaceGuid.PcdHypEnable
> +  gRaspberryPiTokenSpaceGuid.PcdDebugShowUEFIExit
> +
> +[Guids]
> +  gEfiFileInfoGuid
> +  gEfiFileSystemInfoGuid
> +  gEfiFileSystemVolumeLabelInfoIdGuid
> +  gEfiEndOfDxeEventGroupGuid
> +  gEfiTtyTermGuid
> +  gUefiShellFileGuid
> +  gEfiEventExitBootServicesGuid
> +
> +[Protocols]
> +  gEfiDevicePathProtocolGuid
> +  gEfiGraphicsOutputProtocolGuid
> +  gEfiLoadedImageProtocolGuid
> +  gEfiSimpleFileSystemProtocolGuid
> +  gEsrtManagementProtocolGuid
> +  gEfiUsb2HcProtocolGuid
> +  gEfiBootLogoProtocolGuid
> --
> 2.17.0.windows.1
>