OvmfPkg: fix DEC spec violation introduced by Bhyve addition

Sean reports that having two DEC files under OvmfPkg violates the DEC
spec:

> An EDK II Package (directory) is a directory that contains an EDK II
> package declaration (DEC) file. Only one DEC file is permitted per
> directory. EDK II Packages cannot be nested within other EDK II
> Packages.

This issue originates from commit 656419f922 ("Add BhyvePkg, to support
the bhyve hypervisor", 2020-07-31).

Remedy the problem as follows. (Note that these steps are not split to
multiple patches in order to keep Bhyve buildable across the transition.)

(1) Delete "OvmfPkg/Bhyve/BhyvePkg.dec".

(2) Point the [Packages] sections of the Bhyve-specific AcpiPlatformDxe,
    BhyveRfbDxe, and BhyveFwCtlLib INF files to "OvmfPkg.dec".

(3) Migrate the artifacts that "BhyvePkg.dec" used to have on top of
    "OvmfPkg.dec" as follows:

(3a) Merge the copyright notices from Rebecca Cran and Pluribus Networks
     into "OvmfPkg.dec".

(3b) Merge the "BhyveFwCtlLib" class header definition into "OvmfPkg.dec".

(3c) Merge value 0x2F8 for the fixed PcdDebugIoPort into
     "BhyvePkgX64.dsc".

(4) Unnest the the Include/Library/ and Library/ subtrees from under
    OvmfPkg/Bhyve to the corresponding, preexistent subtrees in OvmfPkg.
    The goal is to keep the [Includes] section in the "OvmfPkg.dec" file
    unchanged, plus simplify references in "BhyvePkgX64.dsc". Non-library
    modules remain under "OvmfPkg/Bhyve/".

(4a) The BhyveFwCtlLib class header, and sole instance, are already
     uniquely named, so their movements need not involve file renames.

(4b) Rename the Bhyve-specific PlatformBootManagerLib instance to
     PlatformBootManagerLibBhyve, in additon to moving it, for
     distinguishing it from OvmfPkg's preexistent lib instance. Apply the
     name change to all three of the lib instance directory name, the INF
     file, and the BASE_NAME define in the INF file.

(4c) Update lib class resolutions in "BhyvePkgX64.dsc" accordingly.

(5) Replace the "ACPI table storage" FILE_GUID in
    "OvmfPkg/Bhyve/AcpiTables/AcpiTables.inf" with a new GUID, and
    open-code the "ACPI table storage" GUID in the "ACPITABLE" FDF rule
    instead, replacing $(NAMED_GUID). This step is necessary because CI
    requires unique FILE_GUIDs over all INF files, and OVMF's original
    "AcpiTables.inf" already uses the "ACPI table storage" GUID as
    FILE_GUID.

Cc: Ard Biesheuvel <ard.biesheuvel@arm.com>
Cc: Jordan Justen <jordan.l.justen@intel.com>
Cc: Philippe Mathieu-Daudé <philmd@redhat.com>
Cc: Rebecca Cran <rebecca@bsdio.com>
Cc: Sean Brogan <spbrogan@outlook.com>
Fixes: 656419f922
Reported-by: Sean Brogan <spbrogan@outlook.com>
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Message-Id: <20200801155024.16439-1-lersek@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Reviewed-by: Rebecca Cran <rebecca@bsdio.com>

OvmfPkg/Library/BhyveFwCtlLib/BhyveFwCtlLib.c

@@ -0,0 +1,426 @@
+/** @file
+
+  Copyright (c) 2020, Rebecca Cran <rebecca@bsdio.com>
+  Copyright (c) 2011 - 2013, Intel Corporation. All rights reserved.<BR>
+  Copyright (C) 2013, Red Hat, Inc.
+  Copyright (c) 2015, Nahanni Systems.
+
+  SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#include "Uefi.h"
+#include <Library/BaseLib.h>
+#include <Library/BaseMemoryLib.h>
+#include <Library/DebugLib.h>
+#include <Library/IoLib.h>
+#include <Library/BhyveFwCtlLib.h>
+#include <Library/MemoryAllocationLib.h>
+#include <Library/UefiBootServicesTableLib.h>
+
+#define FW_PORT        0x510
+#define FW_IPORT    0x511
+
+/* Transport protocol basic operations */
+#define OP_NULL        1
+#define OP_ECHO        2
+#define OP_GET        3
+#define OP_GET_LEN    4
+#define OP_SET        5
+
+/* Transport protocol error returns */
+#define T_ESUCCESS    0
+#define T_ENOENT    2
+#define T_E2BIG        7
+#define T_EMSGSIZE    40
+
+#define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y))
+
+STATIC CONST CHAR8 mBhyveSig[4] = { 'B', 'H', 'Y', 'V' };
+
+STATIC BOOLEAN mBhyveFwCtlSupported = FALSE;
+
+STATIC INTN mBhyveFwCtlTxid = 0xa5;
+
+/* XXX Maybe a better inbuilt version of this ? */
+struct BIoVec {
+  VOID        *Base;
+  UINTN        Len;
+};
+
+struct MsgRxHdr {
+  UINT32    Sz;
+  UINT32    Op;
+  UINT32    TxId;
+  UINT32    Err;
+};
+
+STATIC
+RETURN_STATUS
+EFIAPI
+BhyveFwCtl_CvtErr (
+   IN UINT32    errno
+   )
+{
+  RETURN_STATUS        Status;
+
+  switch (errno) {
+  case T_ESUCCESS:
+    Status = RETURN_SUCCESS;
+    break;
+  case T_ENOENT:
+    Status = RETURN_NOT_FOUND;
+    break;
+  case T_E2BIG:
+    Status = RETURN_INVALID_PARAMETER;
+    break;
+  case T_EMSGSIZE:
+    Status = RETURN_BUFFER_TOO_SMALL;
+    break;
+  default:
+    Status = RETURN_PROTOCOL_ERROR;
+    break;
+  }
+
+  return Status;
+}
+
+STATIC
+UINTN
+EFIAPI
+BIov_WLen (
+   IN struct BIoVec b[]
+   )
+{
+  UINTN        i;
+  UINTN        tLen;
+
+  tLen = 0;
+
+  if (b != NULL) {
+    for (i = 0; b[i].Base != NULL; i++)
+      tLen += ROUNDUP (b[i].Len, sizeof(UINT32));
+  }
+
+  return tLen;
+}
+
+/**
+   Utility to send 1-3 bhyes of input as a 4-byte value
+   with trailing zeroes.
+ **/
+STATIC
+UINT32
+BIov_Send_Rem (
+   IN UINT32        *Data,
+   IN UINTN        Len
+   )
+{
+  union {
+    UINT8    c[4];
+    UINT32    w;
+  } u;
+  UINT8        *cdata;
+  UINTN        i;
+
+  cdata = (UINT8 *)Data;
+  u.w = 0;
+
+  for (i = 0; i < Len; i++)
+    u.c[i] = *cdata++;
+
+  return u.w;
+}
+
+/**
+   Send a block of data out the i/o port as 4-byte quantities,
+   appending trailing zeroes on the last if required.
+ **/
+STATIC
+VOID
+BIov_Send (
+  IN char    *Data,
+  IN UINTN    Len
+  )
+{
+  UINT32    *LData;
+
+  LData = (UINT32 *)Data;
+
+  while (Len > sizeof(UINT32)) {
+    IoWrite32 (FW_PORT, *LData++);
+    Len -= sizeof(UINT32);
+  }
+
+  if (Len > 0) {
+    IoWrite32 (FW_PORT, BIov_Send_Rem (LData, Len));
+  }
+}
+
+/**
+   Send data described by an array of iovecs out the i/o port.
+ **/
+STATIC
+VOID
+BIov_SendAll (
+   IN  struct BIoVec b[]
+   )
+{
+  INTN        i;
+
+  if (b != NULL) {
+    for (i = 0; b[i].Base; i++) {
+      BIov_Send (b[i].Base, b[i].Len);
+    }
+  }
+}
+
+/**
+   Prepend the transport header to a block of data and send.
+ **/
+STATIC
+VOID
+EFIAPI
+BhyveFwCtl_MsgSend(
+   IN  UINTN    OpCode,
+   IN  struct BIoVec Data[]
+   )
+{
+  struct BIoVec hIov[4];
+  UINT32        Hdr[3];
+  UINTN         i;
+
+  /* Set up header as an iovec */
+  for (i = 0; i < 3; i++) {
+    hIov[i].Base = &Hdr[i];
+    hIov[i].Len  = sizeof(Hdr[0]);
+  }
+  hIov[i].Base = NULL;
+  hIov[i].Len = 0;
+
+  /* Initialize header */
+  Hdr[0] = BIov_WLen (hIov) + BIov_WLen (Data);
+  Hdr[1] = OpCode;
+  Hdr[2] = mBhyveFwCtlTxid;
+
+  /* Send header and data */
+  BIov_SendAll (hIov);
+  BIov_SendAll (Data);
+}
+
+/**
+   Read a transport response and optional data from the i/o port.
+ **/
+STATIC
+RETURN_STATUS
+EFIAPI
+BhyveFwCtl_MsgRecv(
+   OUT  struct MsgRxHdr    *Rhdr,
+   OUT  struct BIoVec    Data[]
+   )
+{
+  RETURN_STATUS        Status;
+  UINT32        *Dp;
+  UINT32        Rd;
+  UINTN         remLen;
+  INTN            oLen, xLen;
+
+  Rd = IoRead32 (FW_PORT);
+  if (Rd < sizeof(struct MsgRxHdr)) {
+    ;
+  }
+
+  /* Read in header and setup initial error */
+  Rhdr->Sz   = Rd;
+  Rhdr->Op   = IoRead32 (FW_PORT);
+  Rhdr->TxId = IoRead32 (FW_PORT);
+  Rhdr->Err  = IoRead32 (FW_PORT);
+
+  /* Convert transport errno into UEFI error status */
+  Status = BhyveFwCtl_CvtErr(Rhdr->Err);
+
+  remLen = Rd - sizeof(struct MsgRxHdr);
+  xLen = 0;
+
+  /*
+   * A few cases to handle:
+   *  - the user didn't supply a read buffer
+   *  - the buffer is too small for the response
+   *  - the response is zero-length
+   */
+  if (Data != NULL) {
+    Dp = (UINT32 *)Data[0].Base;
+    oLen = remLen;
+    if (remLen > Data[0].Len) {
+      Status = RETURN_BUFFER_TOO_SMALL;
+      xLen = remLen - Data[0].Len;
+      oLen = remLen = Data[0].Len;
+    }
+    while (remLen > 0) {
+      *Dp++ = IoRead32 (FW_PORT);
+      remLen -= sizeof(UINT32);
+    }
+    Data[0].Len = oLen;
+  } else {
+    /* No user data, but data returned - drop */
+    if (remLen > 0) {
+      Status = RETURN_BUFFER_TOO_SMALL;
+      xLen = remLen;
+    }
+  }
+
+  /* Drop additional data */
+  while (xLen > 0) {
+    (void) IoRead32 (FW_PORT);
+    xLen -= sizeof(UINT32);
+  }
+
+  return Status;
+}
+
+
+STATIC
+RETURN_STATUS
+EFIAPI
+BhyveFwCtl_Msg(
+   IN   UINTN    OpCode,
+   IN   struct BIoVec Sdata[],
+   OUT  struct BIoVec Rdata[]
+   )
+{
+  struct MsgRxHdr     Rh;
+  RETURN_STATUS        Status;
+
+  Status = RETURN_SUCCESS;
+
+  BhyveFwCtl_MsgSend (OpCode, Sdata);
+  Status = BhyveFwCtl_MsgRecv (&Rh, Rdata);
+
+  mBhyveFwCtlTxid++;
+
+  return Status;
+}
+
+STATIC
+RETURN_STATUS
+EFIAPI
+BhyveFwCtlGetLen (
+  IN   CONST CHAR8    *Name,
+  IN OUT  UINTN        *Size
+  )
+{
+  struct BIoVec        Req[2], Resp[2];
+  RETURN_STATUS        Status;
+
+  Req[0].Base = (VOID *)Name;
+  Req[0].Len  = AsciiStrLen (Name) + 1;
+  Req[1].Base = NULL;
+
+  Resp[0].Base = Size;
+  Resp[0].Len  = sizeof(UINTN);
+  Resp[1].Base = NULL;
+
+  Status = BhyveFwCtl_Msg (OP_GET_LEN, Req, Resp);
+
+  return Status;
+}
+
+#define FMAXSZ    1024
+STATIC struct {
+  UINT64    fSize;
+  UINT32    fData[FMAXSZ];
+} FwGetvalBuf;
+
+STATIC
+RETURN_STATUS
+EFIAPI
+BhyveFwCtlGetVal (
+  IN   CONST CHAR8    *Name,
+  OUT  VOID        *Item,
+  IN OUT  UINTN        *Size
+  )
+{
+  struct BIoVec        Req[2], Resp[2];
+  RETURN_STATUS        Status;
+
+  /* Make sure temp buffer is larger than passed-in size */
+  if (*Size > sizeof(FwGetvalBuf.fData))
+      return RETURN_INVALID_PARAMETER;
+
+  Req[0].Base = (VOID *)Name;
+  Req[0].Len  = AsciiStrLen(Name) + 1;
+  Req[1].Base = NULL;
+
+  Resp[0].Base = &FwGetvalBuf;
+  Resp[0].Len  = sizeof(UINT64) + *Size;
+  Resp[1].Base = NULL;
+
+  Status = BhyveFwCtl_Msg (OP_GET, Req, Resp);
+
+  /*
+   * Copy out data on success (or on a truncated message).
+   * XXX This step can be eliminted with Msg() supporting
+   *     multiple iovecs.
+   */
+  if ((Status == RETURN_SUCCESS) || (Status == RETURN_BUFFER_TOO_SMALL)) {
+    *Size = FwGetvalBuf.fSize;
+    CopyMem (Item, FwGetvalBuf.fData, *Size);
+  }
+
+  return Status;
+}
+
+/**
+   Front end to the internal GET_LEN and GET protocols
+ **/
+RETURN_STATUS
+EFIAPI
+BhyveFwCtlGet (
+  IN   CONST CHAR8    *Name,
+  OUT  VOID        *Item,
+  IN OUT  UINTN        *Size
+  )
+{
+  RETURN_STATUS        Status;
+
+  if (mBhyveFwCtlSupported == FALSE)
+    return RETURN_UNSUPPORTED;
+
+  if (Item == NULL) {
+    Status = BhyveFwCtlGetLen (Name, Size);
+  } else {
+    Status = BhyveFwCtlGetVal (Name, Item, Size);
+  }
+
+  return Status;
+}
+
+
+/**
+   Library initialization. Probe the host to see if the f/w ctl
+   interface is supported.
+ **/
+RETURN_STATUS
+EFIAPI
+BhyveFwCtlInitialize (
+          VOID
+         )
+{
+  UINTN        i;
+  UINT8        ch;
+
+  DEBUG ((DEBUG_INFO, "FwCtlInitialize\n"));
+
+  IoWrite16 (FW_PORT, 0x0000);
+  for (i = 0; i < 4; i++) {
+    ch = IoRead8 (FW_IPORT);
+    if (ch != mBhyveSig[i]) {
+      DEBUG ((DEBUG_INFO, "Host f/w sig mismatch %c/%c\n", ch, mBhyveSig[i]));
+      return RETURN_SUCCESS;
+    }
+  }
+
+  mBhyveFwCtlSupported = TRUE;
+
+  return RETURN_SUCCESS;
+}

OvmfPkg/Library/BhyveFwCtlLib/BhyveFwCtlLib.inf

@@ -0,0 +1,41 @@
+## @file
+#
+#  Copyright (C) 2020, Rebecca Cran <rebecca@bsdio.com>
+#  Copyright (C) 2015 Nahanni Systems
+#  Copyright (c) 2008 - 2012, Intel Corporation. All rights reserved.<BR>
+#
+#  SPDX-License-Identifier: BSD-2-Clause-Patent
+#
+##
+
+[Defines]
+  INF_VERSION                    = 0x00010005
+  BASE_NAME                      = BhyveFwCtlLib
+  FILE_GUID                      = fd982666-67f9-11e5-a42a-0025908602f6
+  MODULE_TYPE                    = BASE
+  VERSION_STRING                 = 1.0
+  LIBRARY_CLASS                  = BhyveFwCtlLib|PEIM DXE_DRIVER DXE_RUNTIME_DRIVER
+
+  CONSTRUCTOR                    = BhyveFwCtlInitialize
+
+#
+# The following information is for reference only and not required by the build tools.
+#
+#  VALID_ARCHITECTURES           = X64
+#
+
+[Sources]
+  BhyveFwCtlLib.c
+
+[Packages]
+  MdePkg/MdePkg.dec
+  OvmfPkg/OvmfPkg.dec
+
+[LibraryClasses]
+  BaseLib
+  BaseMemoryLib
+  DebugLib
+  IoLib
+  MemoryAllocationLib
+  IntrinsicLib
+

OvmfPkg/Library/PlatformBootManagerLibBhyve/BdsPlatform.h

@@ -0,0 +1,190 @@
+/** @file
+  Platform BDS customizations include file.
+
+  Copyright (c) 2020, Rebecca Cran <rebecca@bsdio.com>
+  Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
+  SPDX-License-Identifier: BSD-2-Clause-Patent
+
+Module Name:
+
+  BdsPlatform.h
+
+Abstract:
+
+  Head file for BDS Platform specific code
+
+**/
+
+#ifndef _PLATFORM_SPECIFIC_BDS_PLATFORM_H_
+#define _PLATFORM_SPECIFIC_BDS_PLATFORM_H_
+
+
+#include <PiDxe.h>
+
+#include <IndustryStandard/Pci.h>
+#include <IndustryStandard/Acpi.h>
+#include <IndustryStandard/SmBios.h>
+#include <IndustryStandard/PeImage.h>
+#include <IndustryStandard/Virtio095.h>
+
+#include <Library/DebugLib.h>
+#include <Library/BaseMemoryLib.h>
+#include <Library/UefiBootServicesTableLib.h>
+#include <Library/UefiRuntimeServicesTableLib.h>
+#include <Library/MemoryAllocationLib.h>
+#include <Library/BaseLib.h>
+#include <Library/PcdLib.h>
+#include <Library/PciLib.h>
+#include <Library/UefiBootManagerLib.h>
+#include <Library/BootLogoLib.h>
+#include <Library/HobLib.h>
+#include <Library/UefiLib.h>
+#include <Library/DxeServicesTableLib.h>
+#include <Library/DevicePathLib.h>
+#include <Library/IoLib.h>
+#include <Library/NvVarsFileLib.h>
+#include <Library/QemuFwCfgLib.h>
+#include <Library/QemuFwCfgS3Lib.h>
+#include <Library/QemuBootOrderLib.h>
+
+#include <Protocol/Decompress.h>
+#include <Protocol/PciIo.h>
+#include <Protocol/FirmwareVolume2.h>
+#include <Protocol/SimpleFileSystem.h>
+#include <Protocol/PciRootBridgeIo.h>
+#include <Protocol/S3SaveState.h>
+#include <Protocol/DxeSmmReadyToLock.h>
+#include <Protocol/LoadedImage.h>
+
+#include <Guid/Acpi.h>
+#include <Guid/SmBios.h>
+#include <Guid/HobList.h>
+#include <Guid/GlobalVariable.h>
+#include <Guid/EventGroup.h>
+#include <Guid/DebugAgentGuid.h>
+
+#include <OvmfPlatforms.h>
+
+extern EFI_DEVICE_PATH_PROTOCOL   *gPlatformConnectSequence[];
+extern ACPI_HID_DEVICE_PATH       gPnpPs2KeyboardDeviceNode;
+extern ACPI_HID_DEVICE_PATH       gPnp16550ComPortDeviceNode;
+extern UART_DEVICE_PATH           gUartDeviceNode;
+extern VENDOR_DEVICE_PATH         gTerminalTypeDeviceNode;
+
+#define PCI_DEVICE_PATH_NODE(Func, Dev) \
+  { \
+    { \
+      HARDWARE_DEVICE_PATH, \
+      HW_PCI_DP, \
+      { \
+        (UINT8) (sizeof (PCI_DEVICE_PATH)), \
+        (UINT8) ((sizeof (PCI_DEVICE_PATH)) >> 8) \
+      } \
+    }, \
+    (Func), \
+    (Dev) \
+  }
+
+#define PNPID_DEVICE_PATH_NODE(PnpId) \
+  { \
+    { \
+      ACPI_DEVICE_PATH, \
+      ACPI_DP, \
+      { \
+        (UINT8) (sizeof (ACPI_HID_DEVICE_PATH)), \
+        (UINT8) ((sizeof (ACPI_HID_DEVICE_PATH)) >> 8) \
+      }, \
+    }, \
+    EISA_PNP_ID((PnpId)), \
+    0 \
+  }
+
+#define gPciIsaBridge \
+  PCI_DEVICE_PATH_NODE(0, 0x1f)
+
+#define gP2PBridge \
+  PCI_DEVICE_PATH_NODE(0, 0x1e)
+
+#define gPnpPs2Keyboard \
+  PNPID_DEVICE_PATH_NODE(0x0303)
+
+#define gPnp16550ComPort \
+  PNPID_DEVICE_PATH_NODE(0x0501)
+
+#define gUart \
+  { \
+    { \
+      MESSAGING_DEVICE_PATH, \
+      MSG_UART_DP, \
+      { \
+        (UINT8) (sizeof (UART_DEVICE_PATH)), \
+        (UINT8) ((sizeof (UART_DEVICE_PATH)) >> 8) \
+      } \
+    }, \
+    0, \
+    115200, \
+    8, \
+    1, \
+    1 \
+  }
+
+#define gPcAnsiTerminal \
+  { \
+    { \
+      MESSAGING_DEVICE_PATH, \
+      MSG_VENDOR_DP, \
+      { \
+        (UINT8) (sizeof (VENDOR_DEVICE_PATH)), \
+        (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8) \
+      } \
+    }, \
+    DEVICE_PATH_MESSAGING_PC_ANSI \
+  }
+
+#define gEndEntire \
+  { \
+    END_DEVICE_PATH_TYPE, \
+    END_ENTIRE_DEVICE_PATH_SUBTYPE, \
+    { \
+      END_DEVICE_PATH_LENGTH, \
+      0 \
+    } \
+  }
+
+#define PCI_CLASS_SCC          0x07
+#define PCI_SUBCLASS_SERIAL    0x00
+#define PCI_IF_16550           0x02
+#define IS_PCI_16550SERIAL(_p)           IS_CLASS3 (_p, PCI_CLASS_SCC, PCI_SUBCLASS_SERIAL, PCI_IF_16550)
+#define IS_PCI_ISA_PDECODE(_p)        IS_CLASS3 (_p, PCI_CLASS_BRIDGE, PCI_CLASS_BRIDGE_ISA_PDECODE, 0)
+
+typedef struct {
+  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;
+  UINTN                     ConnectType;
+} PLATFORM_CONSOLE_CONNECT_ENTRY;
+
+#define CONSOLE_OUT BIT0
+#define CONSOLE_IN  BIT1
+#define STD_ERROR   BIT2
+extern PLATFORM_CONSOLE_CONNECT_ENTRY  gPlatformConsole[];
+
+//
+// Platform BDS Functions
+//
+
+VOID
+PlatformInitializeConsole (
+  IN PLATFORM_CONSOLE_CONNECT_ENTRY   *PlatformConsole
+  );
+
+/**
+  Loads and boots UEFI Linux via the FwCfg interface.
+
+  @retval    EFI_NOT_FOUND - The Linux kernel was not found
+
+**/
+EFI_STATUS
+TryRunningQemuKernel (
+  VOID
+  );
+
+#endif // _PLATFORM_SPECIFIC_BDS_PLATFORM_H_

OvmfPkg/Library/PlatformBootManagerLibBhyve/PlatformBootManagerLibBhyve.inf

@@ -0,0 +1,75 @@
+## @file
+#  Platform BDS customizations library.
+#
+#  Copyright (c) 2020, Rebecca Cran <rebecca@bsdio.com>
+#  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
+#
+#  SPDX-License-Identifier: BSD-2-Clause-Patent
+#
+##
+
+[Defines]
+  INF_VERSION                    = 0x00010005
+  BASE_NAME                      = PlatformBootManagerLibBhyve
+  FILE_GUID                      = b0de5f0d-f676-42da-8d00-86997ee0dbb4
+  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           = IA32 X64 EBC
+#
+
+[Sources]
+  BdsPlatform.c
+  PlatformData.c
+  BdsPlatform.h
+
+[Packages]
+  MdePkg/MdePkg.dec
+  MdeModulePkg/MdeModulePkg.dec
+  SourceLevelDebugPkg/SourceLevelDebugPkg.dec
+  OvmfPkg/OvmfPkg.dec
+  SecurityPkg/SecurityPkg.dec
+  ShellPkg/ShellPkg.dec
+
+[LibraryClasses]
+  BaseLib
+  MemoryAllocationLib
+  UefiBootServicesTableLib
+  BaseMemoryLib
+  DebugLib
+  PcdLib
+  UefiBootManagerLib
+  BootLogoLib
+  DevicePathLib
+  PciLib
+  NvVarsFileLib
+  ReportStatusCodeLib
+  UefiLib
+  PlatformBmPrintScLib
+  Tcg2PhysicalPresenceLib
+
+[Pcd]
+  gUefiOvmfPkgTokenSpaceGuid.PcdEmuVariableEvent
+  gUefiOvmfPkgTokenSpaceGuid.PcdOvmfFlashVariablesEnable
+  gUefiOvmfPkgTokenSpaceGuid.PcdOvmfHostBridgePciDevId
+  gEfiMdePkgTokenSpaceGuid.PcdPlatformBootTimeOut
+
+[Pcd.IA32, Pcd.X64]
+  gEfiMdePkgTokenSpaceGuid.PcdFSBClock
+
+[Protocols]
+  gEfiDecompressProtocolGuid
+  gEfiPciRootBridgeIoProtocolGuid
+  gEfiS3SaveStateProtocolGuid                   # PROTOCOL SOMETIMES_CONSUMED
+  gEfiDxeSmmReadyToLockProtocolGuid             # PROTOCOL SOMETIMES_PRODUCED
+  gEfiLoadedImageProtocolGuid                   # PROTOCOL SOMETIMES_PRODUCED
+  gEfiFirmwareVolume2ProtocolGuid               # PROTOCOL SOMETIMES_CONSUMED
+
+[Guids]
+  gEfiEndOfDxeEventGroupGuid
+  gRootBridgesConnectedEventGroupGuid
+  gUefiShellFileGuid

OvmfPkg/Library/PlatformBootManagerLibBhyve/PlatformData.c

@@ -0,0 +1,171 @@
+/** @file
+  Defined the platform specific device path which will be used by
+  platform Bbd to perform the platform policy connect.
+
+  Copyright (c) 2020, Rebecca Cran <rebecca@bsdio.com>
+  Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.<BR>
+  SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#include "BdsPlatform.h"
+#include <Guid/QemuRamfb.h>
+
+//
+// Debug Agent UART Device Path structure
+//
+#pragma pack(1)
+typedef struct {
+  VENDOR_DEVICE_PATH        VendorHardware;
+  UART_DEVICE_PATH          Uart;
+  VENDOR_DEVICE_PATH        TerminalType;
+  EFI_DEVICE_PATH_PROTOCOL  End;
+} VENDOR_UART_DEVICE_PATH;
+#pragma pack()
+
+//
+// USB Keyboard Device Path structure
+//
+#pragma pack (1)
+typedef struct {
+  USB_CLASS_DEVICE_PATH    Keyboard;
+  EFI_DEVICE_PATH_PROTOCOL End;
+} USB_KEYBOARD_DEVICE_PATH;
+#pragma pack ()
+
+//
+// QemuRamfb Device Path structure
+//
+#pragma pack (1)
+typedef struct {
+  VENDOR_DEVICE_PATH        Vendor;
+  ACPI_ADR_DEVICE_PATH      AcpiAdr;
+  EFI_DEVICE_PATH_PROTOCOL  End;
+} VENDOR_RAMFB_DEVICE_PATH;
+#pragma pack ()
+
+ACPI_HID_DEVICE_PATH       gPnpPs2KeyboardDeviceNode  = gPnpPs2Keyboard;
+ACPI_HID_DEVICE_PATH       gPnp16550ComPortDeviceNode = gPnp16550ComPort;
+UART_DEVICE_PATH           gUartDeviceNode            = gUart;
+VENDOR_DEVICE_PATH         gTerminalTypeDeviceNode    = gPcAnsiTerminal;
+
+//
+// Platform specific keyboard device path
+//
+
+
+//
+// Debug Agent UART Device Path
+//
+VENDOR_UART_DEVICE_PATH gDebugAgentUartDevicePath = {
+  {
+    {
+      HARDWARE_DEVICE_PATH,
+      HW_VENDOR_DP,
+      {
+        (UINT8) (sizeof (VENDOR_DEVICE_PATH)),
+        (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)
+      }
+    },
+    EFI_DEBUG_AGENT_GUID,
+  },
+  {
+    {
+      MESSAGING_DEVICE_PATH,
+      MSG_UART_DP,
+      {
+        (UINT8) (sizeof (UART_DEVICE_PATH)),
+        (UINT8) ((sizeof (UART_DEVICE_PATH)) >> 8)
+      }
+    },
+    0,  // Reserved
+    0,  // BaudRate - Default
+    0,  // DataBits - Default
+    0,  // Parity   - Default
+    0,  // StopBits - Default
+  },
+  gPcAnsiTerminal,
+  gEndEntire
+};
+
+STATIC USB_KEYBOARD_DEVICE_PATH gUsbKeyboardDevicePath = {
+  {
+    {
+      MESSAGING_DEVICE_PATH,
+      MSG_USB_CLASS_DP,
+      {
+        (UINT8)sizeof (USB_CLASS_DEVICE_PATH),
+        (UINT8)(sizeof (USB_CLASS_DEVICE_PATH) >> 8)
+      }
+    },
+    0xFFFF, // VendorId: any
+    0xFFFF, // ProductId: any
+    3,      // DeviceClass: HID
+    1,      // DeviceSubClass: boot
+    1       // DeviceProtocol: keyboard
+  },
+  gEndEntire
+};
+
+STATIC VENDOR_RAMFB_DEVICE_PATH gQemuRamfbDevicePath = {
+  {
+    {
+      HARDWARE_DEVICE_PATH,
+      HW_VENDOR_DP,
+      {
+        (UINT8) (sizeof (VENDOR_DEVICE_PATH)),
+        (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)
+      }
+    },
+    QEMU_RAMFB_GUID,
+  },
+  {
+    {
+      ACPI_DEVICE_PATH,
+      ACPI_ADR_DP,
+      {
+        (UINT8) (sizeof (ACPI_ADR_DEVICE_PATH)),
+        (UINT8) ((sizeof (ACPI_ADR_DEVICE_PATH)) >> 8)
+      }
+    },
+    ACPI_DISPLAY_ADR (
+      1,                                       // DeviceIdScheme
+      0,                                       // HeadId
+      0,                                       // NonVgaOutput
+      1,                                       // BiosCanDetect
+      0,                                       // VendorInfo
+      ACPI_ADR_DISPLAY_TYPE_EXTERNAL_DIGITAL,  // Type
+      0,                                       // Port
+      0                                        // Index
+      ),
+  },
+  gEndEntire
+};
+
+//
+// Predefined platform default console device path
+//
+PLATFORM_CONSOLE_CONNECT_ENTRY   gPlatformConsole[] = {
+  {
+    (EFI_DEVICE_PATH_PROTOCOL *) &gDebugAgentUartDevicePath,
+    (CONSOLE_OUT | CONSOLE_IN | STD_ERROR)
+  },
+  {
+    (EFI_DEVICE_PATH_PROTOCOL *)&gUsbKeyboardDevicePath,
+    CONSOLE_IN
+  },
+  {
+    (EFI_DEVICE_PATH_PROTOCOL *)&gQemuRamfbDevicePath,
+    CONSOLE_OUT
+  },
+  {
+    NULL,
+    0
+  }
+};
+
+//
+// Predefined platform connect sequence
+//
+EFI_DEVICE_PATH_PROTOCOL    *gPlatformConnectSequence[] = { NULL };
+