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 656419f922c0 ("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: 656419f922c047a3c48bd3f4ecea7d8e87d0b761
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>

1 files changed, 47 insertions, 0 deletions

diff --git a/OvmfPkg/Include/Library/BhyveFwCtlLib.h b/OvmfPkg/Include/Library/BhyveFwCtlLib.h
new file mode 100644
index 0000000000..13028ec4b5
--- /dev/null
+++ b/OvmfPkg/Include/Library/BhyveFwCtlLib.h
@@ -0,0 +1,47 @@
+/** @file

+  bhyve firmware configuration access

+

+  Copyright (c) 2020, Rebecca Cran <rebecca@bsdio.com>

+  Copyright (c) 2015 Nahanni Systems

+

+  SPDX-License-Identifier: BSD-2-Clause-Patent

+

+**/

+

+#ifndef __BHYVE_FW_CTL_LIB__

+#define __BHYVE_FW_CTL_LIB__

+

+/**

+  Sysctl-like interface to read host information via a dot-separated

+  ASCII OID.

+

+  The information is copied into the buffer specified by Item. The

+  size of the buffer is given by the location specified by Size

+  before the call, and that location gives the amount of data copied

+  after a successfull call, and after a call that returns a truncated

+  value with an error return of RETURN_BUFFER_TOO_SMALL.

+

+  The size of the available data can be determined by passing a NULL

+  argument for Item. The size will be returned in the location pointed

+  to by Size.

+

+  @param[]  Name    - ASCII OID name

+  @param[]  Data    - return buffer pointer

+  @param[]  Size    - pointer to length

+

+  @return    RETURN_SUCCESS          Valid data/len returned.

+          RETURN_UNSUPPORTED        f/w interface not present.

+          RETURN_NOT_FOUND      OID not found.

+        RETURN_BUFFER_TOO_SMALL      Return message truncated.

+        RETURN_INVALID_PARAMETER  Buffer too large

+        RETURN_PROTOCOL_ERROR     Unknown error from host

+ **/

+RETURN_STATUS

+EFIAPI

+BhyveFwCtlGet (

+  IN   CONST CHAR8    *Name,

+  OUT  VOID        *Item,

+  IN OUT  UINTN        *Size

+  );

+

+#endif