System76PayloadPkg: Customize BootManagerUiLib

Signed-off-by: Tim Crawford <tcrawford@system76.com>

Author: crawfxrd

System76PayloadPkg/Library/BootManagerUiLib/BootManager.c

@@ -7,6 +7,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 **/
 
 #include "BootManager.h"
+#include <Protocol/BlockIo.h>
 #include <Protocol/LoadedImage.h>
 
 UINT16    mKeyInput;
@@ -28,6 +29,10 @@ UINT32  mBmSetupVerticalResolution   = 0;
 
 BOOLEAN  mBmModeInitialized = FALSE;
 
+STATIC EFI_EVENT mBmRefreshEvent;
+STATIC CONST EFI_GUID mBmRefreshGuid = BOOT_MANAGER_REFRESH_GUID;
+STATIC VOID *mBlockIoRegistration; // Unused
+
 CHAR16  *mDeviceTypeStr[] = {
   L"Legacy BEV",
   L"Legacy Floppy",
@@ -497,22 +502,10 @@ UpdateBootManager (
   EFI_STATUS                    Status;
   EFI_LOADED_IMAGE_PROTOCOL     *LoadedImage;
   EFI_DEVICE_PATH_PROTOCOL      *DevicePath;
+  UINTN                         OptionCount = 0;
 
   DeviceType = (UINT16)-1;
 
-  //
-  // for better user experience
-  // 1. User changes HD configuration (e.g.: unplug HDD), here we have a chance to remove the HDD boot option
-  // 2. User enables/disables UEFI PXE, here we have a chance to add/remove EFI Network boot option
-  //
-  EfiBootManagerRefreshAllBootOption ();
-
-  //
-  // BdsDxe doesn't group the legacy boot options for the same device type
-  // It's UI's choice.
-  //
-  GroupMultipleLegacyBootOption4SameType ();
-
   BootOption = EfiBootManagerGetLoadOptions (&BootOptionCount, LoadOptionTypeBoot);
 
   HiiHandle = gBootManagerPrivate.HiiHandle;
@@ -580,6 +573,8 @@ UpdateBootManager (
       continue;
     }
 
+    OptionCount++;
+
     //
     // Group the legacy boot option in the sub title created dynamically
     //
@@ -635,6 +630,10 @@ UpdateBootManager (
       );
   }
 
+  if (OptionCount == 0) {
+    HiiCreateSubTitleOpCode (StartOpCodeHandle, STRING_TOKEN (STR_NO_BOOTABLE_MEDIA), 0, 0, 0);
+  }
+
   if (NeedEndOp) {
     HiiCreateEndOpCode (StartOpCodeHandle);
   }
@@ -885,6 +884,26 @@ BootManagerCallback (
   return EFI_SUCCESS;
 }
 
+STATIC
+VOID
+EFIAPI
+RefreshBootOptions(
+  IN  EFI_EVENT   Event,
+  IN  VOID        *Context
+  )
+{
+  EFI_TPL OldTpl = gBS->RaiseTPL(TPL_CALLBACK);
+
+  EfiBootManagerRefreshAllBootOption();
+
+  // BdsDxe doesn't group the legacy boot options for the same device type. It's UI's choice.
+  GroupMultipleLegacyBootOption4SameType();
+
+  UpdateBootManager();
+
+  gBS->RestoreTPL (OldTpl);
+}
+
 /**
 
   Install Boot Manager Menu driver.
@@ -933,6 +952,23 @@ BootManagerUiLibConstructor (
 
   BmInitialBootModeInfo ();
 
+  Status = gBS->CreateEventEx(
+      EVT_NOTIFY_SIGNAL,
+      TPL_CALLBACK,
+      RefreshBootOptions,
+      NULL,
+      &mBmRefreshGuid,
+      &mBmRefreshEvent
+      );
+  ASSERT_EFI_ERROR(Status);
+
+  Status = gBS->RegisterProtocolNotify (
+      &gEfiBlockIoProtocolGuid,
+      mBmRefreshEvent,
+      &mBlockIoRegistration
+      );
+  ASSERT_EFI_ERROR (Status);
+
   return EFI_SUCCESS;
 }
 
@@ -953,6 +989,8 @@ BootManagerUiLibDestructor (
 {
   EFI_STATUS  Status;
 
+  gBS->CloseEvent(mBmRefreshEvent);
+
   Status = gBS->UninstallMultipleProtocolInterfaces (
                   gBootManagerPrivate.DriverHandle,
                   &gEfiDevicePathProtocolGuid,

System76PayloadPkg/Library/BootManagerUiLib/BootManager.h

@@ -1,10 +1,6 @@
-/** @file
-  The boot manager reference implementation
-
-Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.<BR>
-SPDX-License-Identifier: BSD-2-Clause-Patent
-
-**/
+// SPDX-License-Identifier: BSD-2-Clause-Patent
+// SPDX-FileCopyrightText: Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.<BR>
+// SPDX-FileCopyrightText: 2025 System76, Inc.
 
 #ifndef _EFI_BOOT_MANAGER_H_
 #define _EFI_BOOT_MANAGER_H_
@@ -38,19 +34,16 @@ typedef struct {
 } HII_VENDOR_DEVICE_PATH;
 #pragma pack()
 
-//
-// These are defined as the same with vfr file
-//
-#define BOOT_MANAGER_FORMSET_GUID \
-  { \
-  0x847bc3fe, 0xb974, 0x446d, {0x94, 0x49, 0x5a, 0xd5, 0x41, 0x2e, 0x99, 0x3b} \
-  }
+// XXX: Must match VFR
+
+#define BOOT_MANAGER_FORMSET_GUID { 0x3f56106a, 0xa83f, 0x4417, { 0x90, 0x21, 0xc7, 0x77, 0x5c, 0x1d, 0x73, 0xfe }}
+#define BOOT_MANAGER_REFRESH_GUID { 0x7648c827, 0xbe32, 0x44d2, { 0xa1, 0x33, 0xf1, 0x7f, 0x93, 0x76, 0xc7, 0x00 }}
 
-#define BOOT_MANAGER_FORM_ID  0x1000
+#define BOOT_MANAGER_FORM_ID    0x1030
 
-#define LABEL_BOOT_OPTION      0x00
-#define LABEL_BOOT_OPTION_END  0x01
-#define MAX_STRING_LEN         200
+#define LABEL_BOOT_OPTION       0x00
+#define LABEL_BOOT_OPTION_END   0x01
+#define MAX_STRING_LEN          200
 
 //
 // Variable created with this flag will be "Efi:...."

System76PayloadPkg/Library/BootManagerUiLib/BootManagerStrings.uni

@@ -1,36 +1,10 @@
-///** @file
-//
-// Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
 // SPDX-License-Identifier: BSD-2-Clause-Patent
-//
-// Module Name:
-//
-//   BootManagerStrings.uni
-//
-// Abstract:
-//
-//   String definitions for Boot Manager formset.
-//
-// Revision History:
-//
-// --*/
+// SPDX-FileCopyrightText: 2025 System76, Inc.
 
-/=#
-#langdef   en-US "English"
-#langdef   fr-FR "Français"
-
-#string STR_BM_BANNER                  #language en-US  "Boot Manager"
-                                       #language fr-FR  "Boot Manager"
-#string STR_BOOT_MANAGER_HELP          #language en-US  "This selection will take you to the Boot Manager"
-                                       #language fr-FR  "This selection will take you to the Boot Manager"
-#string STR_HELP_FOOTER                #language en-US  "Use the <↑> and <↓> keys to choose a boot option, the <Enter> key to select a boot option, and the <Esc> key to exit the Boot Manager Menu."
-                                       #language fr-FR  "<↑> pour <↓> changer l'option, <ENTRER> choisir une option, <ESC> pour sortir"
-#string STR_AND                        #language en-US  " and "
-                                       #language fr-FR  " et "
-#string STR_BOOT_OPTION_BANNER         #language en-US  "Boot Manager Menu"
-                                       #language fr-FR  "le Menu d'Option de Botte"
-#string STR_ANY_KEY_CONTINUE           #language en-US  "Press any key to continue..."
-                                       #language fr-FR  "Appuie n'importe quelle pour continuer..."
-#string STR_LAST_STRING                #language en-US  ""
-                                       #language fr-FR  ""
+#langdef en-US "English"
 
+#string STR_BM_BANNER                 #language en-US "One Time Boot"
+#string STR_BOOT_MANAGER_HELP         #language en-US "Boot an entry one time"
+#string STR_ANY_KEY_CONTINUE          #language en-US "Press any key to continue..."
+#string STR_NO_BOOTABLE_MEDIA         #language en-US "No bootable media found"
+#string STR_EMPTY_STRING              #language en-US ""

System76PayloadPkg/Library/BootManagerUiLib/BootManagerUiLib.inf

@@ -51,6 +51,7 @@
   gEfiHiiConfigAccessProtocolGuid               ## CONSUMES
   gEfiDevicePathToTextProtocolGuid              ## CONSUMES
   gEdkiiFormBrowserEx2ProtocolGuid              ## CONSUMES
+  gEfiBlockIoProtocolGuid
 
 [FeaturePcd]
 

System76PayloadPkg/Library/BootManagerUiLib/BootManagerUiLib.uni

@@ -1,20 +1,5 @@
-// /** @file
-// Boot Manager Library used by UiApp.
-//
-// Boot Manager Library used by UiApp.
-//
-// Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
-//
 // SPDX-License-Identifier: BSD-2-Clause-Patent
-//
-// **/
-
-#string STR_MODULE_ABSTRACT
-#language en-US
-"Boot Manager Library used by UiApp."
-
-#string STR_MODULE_DESCRIPTION
-#language en-US
-"Boot Manager Library used by UiApp."
-
+// SPDX-FileCopyrightText: 2025 System76, Inc.
 
+#string STR_MODULE_ABSTRACT #language en-US "Boot manager library"
+#string STR_MODULE_DESCRIPTION #language en-US "Boot manager library"

System76PayloadPkg/Library/BootManagerUiLib/BootManagerVfr.Vfr

@@ -1,17 +1,14 @@
-///** @file
-//
-//  Boot Manager formset.
-//
-//  Copyright (c) 2004 - 2015, Intel Corporation. All rights reserved.<BR>
-//  SPDX-License-Identifier: BSD-2-Clause-Patent
-//
-//**/
-#define FORMSET_GUID  { 0x847bc3fe, 0xb974, 0x446d, 0x94, 0x49, 0x5a, 0xd5, 0x41, 0x2e, 0x99, 0x3b }
+// SPDX-License-Identifier: BSD-2-Clause-Patent
+// SPDX-FileCopyrightText: Copyright (c) 2004 - 2015, Intel Corporation. All rights reserved.<BR>
+// SPDX-FileCopyrightText: 2025 System76, Inc.
 
-#define BOOT_MANAGER_FORM_ID     0x1000
+#define FORMSET_GUID { 0x3f56106a, 0xa83f, 0x4417, 0x90, 0x21, 0xc7, 0x77, 0x5c, 0x1d, 0x73, 0xfe }
+#define BOOT_MANAGER_REFRESH_GUID { 0x7648c827, 0xbe32, 0x44d2, { 0xa1, 0x33, 0xf1, 0x7f, 0x93, 0x76, 0xc7, 0x00 }}
 
-#define LABEL_BOOT_OPTION        0x00
-#define LABEL_BOOT_OPTION_END    0x01
+#define BOOT_MANAGER_FORM_ID    0x1030
+
+#define LABEL_BOOT_OPTION       0x00
+#define LABEL_BOOT_OPTION_END   0x01
 
 formset
   guid      = FORMSET_GUID,
@@ -20,32 +17,22 @@ formset
   classguid = gEfiIfrFrontPageGuid,
 
   form formid = BOOT_MANAGER_FORM_ID,
-       title  = STRING_TOKEN(STR_BM_BANNER);
-
-    subtitle text = STRING_TOKEN(STR_LAST_STRING);
-    subtitle text = STRING_TOKEN(STR_BOOT_OPTION_BANNER);
-    subtitle text = STRING_TOKEN(STR_LAST_STRING);
+    title  = STRING_TOKEN(STR_BM_BANNER);
+    refreshguid = BOOT_MANAGER_REFRESH_GUID;
 
-    //
-    //Add this invisable text in order to indicate enter Boot Manager form.
-    //
+    // Add this invisable text in order to indicate enter Boot Manager form.
     suppressif TRUE;
           text
-              help  = STRING_TOKEN(STR_LAST_STRING ),
-              text  = STRING_TOKEN(STR_LAST_STRING ),
+              help  = STRING_TOKEN(STR_EMPTY_STRING),
+              text  = STRING_TOKEN(STR_EMPTY_STRING),
               flags = INTERACTIVE,
               key   = 0x1212;
      endif;
 
-    //
-    // This is where we will dynamically add choices for the Boot Manager
-    //
     label LABEL_BOOT_OPTION;
+    // Dynamically generated values.
     label LABEL_BOOT_OPTION_END;
 
-    subtitle text = STRING_TOKEN(STR_LAST_STRING);
-    subtitle text = STRING_TOKEN(STR_HELP_FOOTER);
-
   endform;
 
 endformset;