OvmfPkg: QemuBootOrderLib: expose QEMU's "-boot menu=on[,splash-time=N]"

The QEMU command line option

  -boot menu=on

is meant to have the guest firmware wait for a firmware-specific interval
for the user to enter the boot menu. During the wait, the user can opt to
enter the boot menu, or interrupt the wait and proceed to booting at once.
If the wait interval elapses, the firmware should boot as it normally
would.

The QEMU command line option

  -boot menu=on,splash-time=N

means the same, except the firmware should wait for cca. N milliseconds
instead of a firmware-specific interval.

We can approximate this behavior quite well for edk2's virtual platforms
because the Intel BDS front page already supports a progress bar, with
semantics similar to the above. Let's distill the fw_cfg bits underlying
"-boot menu=on,splash-time=N" for the BDS policies, in the form of a
timeout value they can pass to Intel's PlatformBdsEnterFrontPage().

If the boot menu is not requested, we return
"gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPlatformBootTimeOut", which
is what the virtual platforms use right now.

If the boot menu is requested without specifying the timeout, we return
the same PCD, unless it would cause us to skip the boot menu at once. In
the latter case, we return 3 seconds (as an approximation of the 2500 ms
SeaBIOS default.)

RHBZ: https://bugzilla.redhat.com/show_bug.cgi?id=1170507

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Jordan Justen <jordan.l.justen@intel.com>
Reviewed-by: Olivier Martin <Olivier.martin@arm.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@16610 6f19259b-4bc3-4df7-8a09-765794883524

OvmfPkg/Include/Library/QemuBootOrderLib.h

@@ -54,4 +54,16 @@ SetBootOrderFromQemu (
   IN  CONST LIST_ENTRY *BootOptionList
   );
 
+
+/**
+  Calculate the number of seconds we should be showing the FrontPage progress
+  bar for.
+
+  @return  The TimeoutDefault argument for PlatformBdsEnterFrontPage().
+**/
+UINT16
+GetFrontPageTimeoutFromQemu (
+  VOID
+  );
+
 #endif

OvmfPkg/Library/QemuBootOrderLib/QemuBootOrderLib.c

@@ -1571,3 +1571,53 @@ ErrorFreeFwCfg:
 
   return Status;
 }
+
+
+/**
+  Calculate the number of seconds we should be showing the FrontPage progress
+  bar for.
+
+  @return  The TimeoutDefault argument for PlatformBdsEnterFrontPage().
+**/
+UINT16
+GetFrontPageTimeoutFromQemu (
+  VOID
+  )
+{
+  FIRMWARE_CONFIG_ITEM BootMenuWaitItem;
+  UINTN                BootMenuWaitSize;
+
+  QemuFwCfgSelectItem (QemuFwCfgItemBootMenu);
+  if (QemuFwCfgRead16 () == 0) {
+    //
+    // The user specified "-boot menu=off", or didn't specify "-boot
+    // menu=(on|off)" at all. Return the platform default.
+    //
+    return PcdGet16 (PcdPlatformBootTimeOut);
+  }
+
+  if (RETURN_ERROR (QemuFwCfgFindFile ("etc/boot-menu-wait", &BootMenuWaitItem,
+                      &BootMenuWaitSize)) ||
+      BootMenuWaitSize != sizeof (UINT16)) {
+    //
+    // "-boot menu=on" was specified without "splash-time=N". In this case,
+    // return three seconds if the platform default would cause us to skip the
+    // front page, and return the platform default otherwise.
+    //
+    UINT16 Timeout;
+
+    Timeout = PcdGet16 (PcdPlatformBootTimeOut);
+    if (Timeout == 0) {
+      Timeout = 3;
+    }
+    return Timeout;
+  }
+
+  //
+  // "-boot menu=on,splash-time=N" was specified, where N is in units of
+  // milliseconds. The Intel BDS Front Page progress bar only supports whole
+  // seconds, round N up.
+  //
+  QemuFwCfgSelectItem (BootMenuWaitItem);
+  return (UINT16)((QemuFwCfgRead16 () + 999) / 1000);
+}

OvmfPkg/Library/QemuBootOrderLib/QemuBootOrderLib.inf

@@ -57,3 +57,6 @@
 [FeaturePcd]
   gUefiOvmfPkgTokenSpaceGuid.PcdQemuBootOrderPciTranslation
   gUefiOvmfPkgTokenSpaceGuid.PcdQemuBootOrderMmioTranslation
+
+[Pcd]
+  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPlatformBootTimeOut