From: Roman Bogorodskiy <bogorodskiy@gmail.com>
Date: Tue, 20 May 2025 17:01:52 +0000 (+0200)
Subject: docs: drvbhyve: document NVRAM support
X-Git-Tag: v11.4.0-rc1~22
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=eb9b48bddffda9169e930a43d9475ca7bb4d26d6;p=thirdparty%2Flibvirt.git

docs: drvbhyve: document NVRAM support

Add a couple of examples of the explicit NVRAM configuration, and also
an automatic configuration, along with `<os firmware="efi">`.

Signed-off-by: Roman Bogorodskiy <bogorodskiy@gmail.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
---

diff --git a/docs/drvbhyve.rst b/docs/drvbhyve.rst
index e93ef0f447..7eec4a2123 100644
--- a/docs/drvbhyve.rst
+++ b/docs/drvbhyve.rst
@@ -329,6 +329,26 @@ This uses the UEFI firmware provided by the
 `sysutils/bhyve-firmware <https://www.freshports.org/sysutils/bhyve-firmware/>`__
 FreeBSD port.
 
+:since:`Since 11.4.0`, it's possible to configure an NVRAM file:
+
+::
+
+    <os>
+      <type>hvm</type>
+      <loader readonly="yes" type="pflash">/usr/local/share/uefi-firmware/BHYVE_UEFI.fd</loader>
+      <nvram template='/usr/local/share/edk2-bhyve/BHYVE_UEFI_VARS.fd'>/var/lib/libvirt/bhyve/nvram/myvm.fd</nvram>
+    </os>
+
+Alternatively, it's also possible to let the driver automatically configure
+the firmware and NVRAM:
+
+::
+
+    <os firmware='efi'>
+      <type>hvm</type>
+      <nvram/>
+    </os>
+
 VNC and the tablet input device could be configured this way:
 
 ::