ArmVirtPkg: add QemuFwCfgToPcdDxe

Many universal DXE drivers in edk2 can be controlled by setting dynamic
PCDs. Such a PCD must be set before the consumer DXE driver is dispatched.

(In general we assume that the DXE driver will consume the PCD in its
entry point, or in the constructor of a library instance it links against.
In special cases this requirement can be relaxed a bit, if we know that
the DXE driver accesses the PCD only in a protocol member function that it
exports.)

On the QEMU platform, the PCD values to be set for the universal drivers
are frequently derived from fw_cfg files that QEMU exports.

In OvmfPkg we tend to handle this in the following way:

- For IA32 and X64, OvmfPkg provides a QemuFwCfgLib instance that is
  usable in PEI.

- In PlatformPei, fw_cfg files can be loaded and transformed to PCD
  values.

- Any DXE driver is bound to be dispatched after the PEI phase is done.

(In specific cases other ordering solutions might be possible, via Depex
or protocol notify, etc.)

In ArmVirtPkg/ArmVirtQemu, things differ a bit:

- We don't have an ArmVirtPkg-specific ("Platform") PEIM. This is actually
  a good thing for now, so let's not introduce one just for this purpose.

- Even if we had such a PEIM, it could not easily access fw_cfg: the MMIO
  addresses of the fw_cfg device are available only in the DTB that QEMU
  exports.

  (Accordingly, our QemuFwCfgLib instance is restricted to DXE_DRIVER
  modules: VirtFdtDxe parses the DTB, stores the fw_cfg addresses in PCDs,
  and then QemuFwCfgLib's constructor fetches those PCDs.)

  There are some examples in ArmVirtPkg where early code is forced to
  parse the DTB manually, but those examples are all painful, and our goal
  here (controlling universal DXE drivers) doesn't justify more of that
  pain.

Therefore, introduce a separate, minimal DXE driver that is dispatched
strictly after VirtFdtDxe (so that it can use QemuFwCfgLib), and strictly
before other DXE drivers (so that it can set dynamic PCDs for them).
Because VirtFdtDxe is already ordered with the APRIORI DXE file, it is
simplest to do the same for the new driver.

Actual fw_cfg files and PCDs shall be accessed in future patches.

Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

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

4 files changed, 78 insertions, 0 deletions

diff --git a/ArmVirtPkg/ArmVirtQemu.dsc b/ArmVirtPkg/ArmVirtQemu.dsc
index be2b984002..07d5a87e66 100644
--- a/ArmVirtPkg/ArmVirtQemu.dsc
+++ b/ArmVirtPkg/ArmVirtQemu.dsc
@@ -310,6 +310,7 @@
   # Platform Driver

   #

   ArmVirtPkg/VirtFdtDxe/VirtFdtDxe.inf

+  ArmVirtPkg/QemuFwCfgToPcdDxe/QemuFwCfgToPcd.inf

   OvmfPkg/VirtioBlkDxe/VirtioBlk.inf

   OvmfPkg/VirtioScsiDxe/VirtioScsi.inf

   OvmfPkg/VirtioNetDxe/VirtioNet.inf

diff --git a/ArmVirtPkg/ArmVirtQemu.fdf b/ArmVirtPkg/ArmVirtQemu.fdf
index 41bcda8060..5b6bda8c51 100644
--- a/ArmVirtPkg/ArmVirtQemu.fdf
+++ b/ArmVirtPkg/ArmVirtQemu.fdf
@@ -104,10 +104,12 @@ READ_LOCK_STATUS   = TRUE
   APRIORI DXE {

     INF MdeModulePkg/Universal/PCD/Dxe/Pcd.inf

     INF ArmVirtPkg/VirtFdtDxe/VirtFdtDxe.inf

+    INF ArmVirtPkg/QemuFwCfgToPcdDxe/QemuFwCfgToPcd.inf

   }

   INF MdeModulePkg/Core/Dxe/DxeMain.inf

   INF MdeModulePkg/Universal/PCD/Dxe/Pcd.inf

   INF ArmVirtPkg/VirtFdtDxe/VirtFdtDxe.inf

+  INF ArmVirtPkg/QemuFwCfgToPcdDxe/QemuFwCfgToPcd.inf

 

   #

   # PI DXE Drivers producing Architectural Protocols (EFI Services)

diff --git a/ArmVirtPkg/QemuFwCfgToPcdDxe/QemuFwCfgToPcd.c b/ArmVirtPkg/QemuFwCfgToPcdDxe/QemuFwCfgToPcd.c
new file mode 100644
index 0000000000..8f60e21789
--- /dev/null
+++ b/ArmVirtPkg/QemuFwCfgToPcdDxe/QemuFwCfgToPcd.c
@@ -0,0 +1,33 @@
+/** @file

+*  An "early" DXE driver that parses well-known fw-cfg files into dynamic PCDs

+*  that control other (universal) DXE drivers.

+*

+*  Copyright (C) 2015, Red Hat, Inc.

+*  Copyright (c) 2014, Linaro Ltd. All rights reserved.<BR>

+*

+*  This program and the accompanying materials are licensed and made available

+*  under the terms and conditions of the BSD License which accompanies this

+*  distribution.  The full text of the license may be found at

+*  http://opensource.org/licenses/bsd-license.php

+*

+*  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+*  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR

+*  IMPLIED.

+*

+**/

+

+#include <Uefi/UefiBaseType.h>

+#include <Uefi/UefiSpec.h>

+

+#include <Library/PcdLib.h>

+#include <Library/QemuFwCfgLib.h>

+

+EFI_STATUS

+EFIAPI

+ParseQemuFwCfgToPcd (

+  IN EFI_HANDLE       ImageHandle,

+  IN EFI_SYSTEM_TABLE *SystemTable

+  )

+{

+  return EFI_SUCCESS;

+}

diff --git a/ArmVirtPkg/QemuFwCfgToPcdDxe/QemuFwCfgToPcd.inf b/ArmVirtPkg/QemuFwCfgToPcdDxe/QemuFwCfgToPcd.inf
new file mode 100644
index 0000000000..a9983becef
--- /dev/null
+++ b/ArmVirtPkg/QemuFwCfgToPcdDxe/QemuFwCfgToPcd.inf
@@ -0,0 +1,42 @@
+## @file

+#  An "early" DXE driver that parses well-known fw-cfg files into dynamic PCDs

+#  that control other (universal) DXE drivers.

+#

+#  Copyright (C) 2015, Red Hat, Inc.

+#  Copyright (c) 2014, Linaro Ltd. All rights reserved.<BR>

+#

+#  This program and the accompanying materials are licensed and made available

+#  under the terms and conditions of the BSD License which accompanies this

+#  distribution.  The full text of the license may be found at

+#  http://opensource.org/licenses/bsd-license.php

+#

+#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR

+#  IMPLIED.

+#

+##

+

+[Defines]

+  INF_VERSION                    = 0x00010005

+  BASE_NAME                      = QemuFwCfgToPcdDxe

+  FILE_GUID                      = 5bb7cc92-1a36-4833-84cf-db7f8258e48d

+  MODULE_TYPE                    = DXE_DRIVER

+  VERSION_STRING                 = 1.0

+  ENTRY_POINT                    = ParseQemuFwCfgToPcd

+

+[Sources]

+  QemuFwCfgToPcd.c

+

+[Packages]

+  MdePkg/MdePkg.dec

+  OvmfPkg/OvmfPkg.dec

+

+[LibraryClasses]

+  PcdLib

+  QemuFwCfgLib

+  UefiDriverEntryPoint

+

+[Pcd]

+

+[Depex]

+  TRUE