ArmPkg/PlatformBootManagerLib: connect non-discoverable USB hosts

The way the BDS handles the short-form USB device path of the console
keyboard relies on USB host controllers to be locatable via their PCI
metadata, which implies that these controllers already have a PCI I/O
protocol installed on their handle.

This is not the case for non-discoverable USB host controllers that are
supported by the NonDiscoverable PCI device driver. These controllers
must be connected first, or the BDS will never notice their existence,
and will not enable any USB keyboards connected through them.

Let's work around this by connecting these handles explicitly. This is
a bit of a stopgap, but it is the cleanest way of dealing with this
without violating the UEFI driver model entirely. This ensures that
platforms that do not rely on ConnectAll() will keep working as
expected.

Signed-off-by: Ard Biesheuvel <ard.biesheuvel@arm.com>
Reviewed-by: Leif Lindholm <leif@nuviainc.com>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>

2 files changed, 46 insertions, 0 deletions

diff --git a/ArmPkg/Library/PlatformBootManagerLib/PlatformBm.c b/ArmPkg/Library/PlatformBootManagerLib/PlatformBm.c
index 3411219fbf..4aca1382b0 100644
--- a/ArmPkg/Library/PlatformBootManagerLib/PlatformBm.c
+++ b/ArmPkg/Library/PlatformBootManagerLib/PlatformBm.c
@@ -23,10 +23,12 @@
 #include <Protocol/EsrtManagement.h>

 #include <Protocol/GraphicsOutput.h>

 #include <Protocol/LoadedImage.h>

+#include <Protocol/NonDiscoverableDevice.h>

 #include <Protocol/PciIo.h>

 #include <Protocol/PciRootBridgeIo.h>

 #include <Protocol/PlatformBootManager.h>

 #include <Guid/EventGroup.h>

+#include <Guid/NonDiscoverableDevice.h>

 #include <Guid/TtyTerm.h>

 #include <Guid/SerialPortLibVendor.h>

 

@@ -255,6 +257,37 @@ IsPciDisplay (
 

 

 /**

+  This FILTER_FUNCTION checks if a handle corresponds to a non-discoverable

+  USB host controller.

+**/

+STATIC

+BOOLEAN

+EFIAPI

+IsUsbHost (

+  IN EFI_HANDLE   Handle,

+  IN CONST CHAR16 *ReportText

+  )

+{

+  NON_DISCOVERABLE_DEVICE   *Device;

+  EFI_STATUS                Status;

+

+  Status = gBS->HandleProtocol (Handle,

+                  &gEdkiiNonDiscoverableDeviceProtocolGuid,

+                  (VOID **)&Device);

+  if (EFI_ERROR (Status)) {

+    return FALSE;

+  }

+

+  if (CompareGuid (Device->Type, &gEdkiiNonDiscoverableUhciDeviceGuid) ||

+      CompareGuid (Device->Type, &gEdkiiNonDiscoverableEhciDeviceGuid) ||

+      CompareGuid (Device->Type, &gEdkiiNonDiscoverableXhciDeviceGuid)) {

+    return TRUE;

+  }

+  return FALSE;

+}

+

+

+/**

   This CALLBACK_FUNCTION attempts to connect a handle non-recursively, asking

   the matching driver to produce all first-level child handles.

 **/

@@ -575,6 +608,15 @@ PlatformBootManagerBeforeConsole (
   FilterAndProcess (&gEfiGraphicsOutputProtocolGuid, NULL, AddOutput);

 

   //

+  // The core BDS code connects short-form USB device paths by explicitly

+  // looking for handles with PCI I/O installed, and checking the PCI class

+  // code whether it matches the one for a USB host controller. This means

+  // non-discoverable USB host controllers need to have the non-discoverable

+  // PCI driver attached first.

+  //

+  FilterAndProcess (&gEdkiiNonDiscoverableDeviceProtocolGuid, IsUsbHost, Connect);

+

+  //

   // Add the hardcoded short-form USB keyboard device path to ConIn.

   //

   EfiBootManagerUpdateConsoleVariable (ConIn,

diff --git a/ArmPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf b/ArmPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf
index 87c9b1150c..2f726d117d 100644
--- a/ArmPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf
+++ b/ArmPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf
@@ -66,6 +66,9 @@
   gEfiMdePkgTokenSpaceGuid.PcdPlatformBootTimeOut

 

 [Guids]

+  gEdkiiNonDiscoverableEhciDeviceGuid

+  gEdkiiNonDiscoverableUhciDeviceGuid

+  gEdkiiNonDiscoverableXhciDeviceGuid

   gEfiFileInfoGuid

   gEfiFileSystemInfoGuid

   gEfiFileSystemVolumeLabelInfoIdGuid

@@ -74,6 +77,7 @@
   gUefiShellFileGuid

 

 [Protocols]

+  gEdkiiNonDiscoverableDeviceProtocolGuid

   gEfiDevicePathProtocolGuid

   gEfiGraphicsOutputProtocolGuid

   gEfiLoadedImageProtocolGuid