ArmVirtPkg/NorFlashQemuLib: disable NOR flash DT nodes upon discovery

Our UEFI guest firmware takes ownership of the emulated NOR flash in
order to support the variable runtime services, and it does not expect
the OS to interfere with the underlying storage directly. So disable
the NOR flash DT nodes as we discover them, in a way similar to how we
disable the PL031 RTC in the device tree when we attach our RTC runtime
driver to it.

Note that this also hides the NOR flash bank that carries the UEFI
executable code, but this is not intended to be updatable from inside
the guest anyway, and if it was, we should use capsule update to do so.
Also, the first -pflash argument that defines the backing for this flash
bank is often issued with the 'readonly' modifier, in order to prevent
any changes whatsoever to be made to the executable firmware image by
the guest.

This issue has become relevant due to the following Linux changes,
which enable the flash driver stack for default build configurations
targetting arm64 and 32-bit ARM.

ce693fc2a877
("arm64: defconfig: Enable flash device drivers for QorIQ boards", 2020-03-16).

5f068190cc10
("ARM: multi_v7_defconfig: Enable support for CFI NOR FLASH", 2019-04-03)

Reviewed-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Signed-off-by: Ard Biesheuvel <ard.biesheuvel@arm.com>

diff --git a/ArmVirtPkg/Library/NorFlashQemuLib/NorFlashQemuLib.c b/ArmVirtPkg/Library/NorFlashQemuLib/NorFlashQemuLib.c
index 9b1d1184bdd3df97a165731f2b928598bb784f1e..271d7f0efbc09e9848608b6fc3de55d600c905cb 100644 (file)
--- a/ArmVirtPkg/Library/NorFlashQemuLib/NorFlashQemuLib.c
+++ b/ArmVirtPkg/Library/NorFlashQemuLib/NorFlashQemuLib.c
@@ -86,6 +86,22 @@ NorFlashPlatformGetDevices (
       mNorFlashDevices[Num].BlockSize         = QEMU_NOR_BLOCK_SIZE;\r
       Num++;\r
     }\r
+\r
+    //\r
+    // UEFI takes ownership of the NOR flash, and exposes its functionality\r
+    // through the UEFI Runtime Services GetVariable, SetVariable, etc. This\r
+    // means we need to disable it in the device tree to prevent the OS from\r
+    // attaching its device driver as well.\r
+    // Note that this also hides other flash banks, but the only other flash\r
+    // bank we expect to encounter is the one that carries the UEFI executable\r
+    // code, which is not intended to be guest updatable, and is usually backed\r
+    // in a readonly manner by QEMU anyway.\r
+    //\r
+    Status = FdtClient->SetNodeProperty (FdtClient, Node, "status",\r
+                          "disabled", sizeof ("disabled"));\r
+    if (EFI_ERROR (Status)) {\r
+      DEBUG ((DEBUG_WARN, "Failed to set NOR flash status to 'disabled'\n"));\r
+    }\r
   }\r
 \r
   *NorFlashDescriptions = mNorFlashDevices;\r