From 8a91e853825ba176fd795ec857f6bd9f674dcbc3 Mon Sep 17 00:00:00 2001 From: Roman Bogorodskiy Date: Mon, 20 Mar 2017 17:53:18 +0400 Subject: [PATCH] docs: document bhyve UEFI support - Add a news entry - Update the driver page with documentation of the new options and some examples --- docs/drvbhyve.html.in | 94 +++++++++++++++++++++++++++++++++++++++++++ docs/news.xml | 13 ++++++ 2 files changed, 107 insertions(+) diff --git a/docs/drvbhyve.html.in b/docs/drvbhyve.html.in index 64a1ff694d..0aed121ff1 100644 --- a/docs/drvbhyve.html.in +++ b/docs/drvbhyve.html.in @@ -155,6 +155,57 @@ Note the addition of <bootloader>. </domain> +

Example config (Linux UEFI guest, VNC, tablet)

+ +

This is an example to boot into Fedora 25 installation:

+ +
+<domain type='bhyve'>
+    <name>fedora_uefi_vnc_tablet</name>
+    <memory unit='G'>4</memory>
+    <vcpu>2</vcpu>
+    <os>
+       <type>hvm</type>
+       <loader readonly="yes" type="pflash">/usr/local/share/uefi-firmware/BHYVE_UEFI.fd</loader>
+    </os>
+    <features>
+      <apic/>
+      <acpi/>
+    </features>
+    <clock offset='utc'/>
+    <on_poweroff>destroy</on_poweroff>
+    <on_reboot>restart</on_reboot>
+    <on_crash>destroy</on_crash>
+    <devices>
+      <disk type='file' device='cdrom'>
+        <driver name='file' type='raw'/>
+          <source file='/path/to/Fedora-Workstation-Live-x86_64-25-1.3.iso'/>
+        <target dev='hdc' bus='sata'/>
+        <readonly/>
+      </disk>
+      <disk type='file' device='disk'>
+        <driver name='file' type='raw'/>
+        <source file='/path/to/linux_uefi.img'/>
+        <target dev='hda' bus='sata'/>
+        </disk>
+      <interface type='bridge'>
+        <model type='virtio'/>
+        <source bridge="virbr0"/>
+      </interface>
+      <serial type="nmdm">
+        <source master="/dev/nmdm0A" slave="/dev/nmdm0B"/>
+      </serial>
+      <graphics type='vnc' port='5904'>
+        <listen type='address' address='127.0.0.1'/>
+      </graphics>
+      <controller type='usb' model='nec-xhci'/>
+      <input type='tablet' bus='usb'/>
+    </devices>
+</domain>
+
+ +

Please refer to the UEFI section for a more detailed explanation.

+

Guest usage / management

Connecting to a guest console

@@ -261,6 +312,49 @@ attempt to boot from the first partition in the disk image.

Caveat: bootloader_args does not support any quoting. Filenames, etc, must not have spaces or they will be tokenized incorrectly.

+

Using UEFI bootrom, VNC, and USB tables

+ +

Since 3.2.0, in addition to grub-bhyve, +non-FreeBSD guests could be also booted using an UEFI boot ROM, provided both guest OS and +installed bhyve(1) version support UEFI. To use that, loader +should be specified in the os section:

+ +
+<domain type='bhyve'>
+    ...
+    <os>
+       <type>hvm</type>
+       <loader readonly="yes" type="pflash">/usr/local/share/uefi-firmware/BHYVE_UEFI.fd</loader>
+    </os>
+    ...
+
+ +

This uses the UEFI firmware provided by +the sysutils/bhyve-firmware +FreeBSD port.

+ +

VNC and the tablet input device could be configured this way:

+ +
+<domain type='bhyve'>
+    <devices>
+      ...
+      <graphics type='vnc' port='5904'>
+        <listen type='address' address='127.0.0.1'/>
+      </graphics>
+      <controller type='usb' model='nec-xhci'/>
+      <input type='tablet' bus='usb'/>
+    </devices>
+    ...
+</domain>
+
+ +

This way, VNC will be accessible on 127.0.0.1:5904.

+ +

Please note that the tablet device requires to have an USB controller +of the nec-xhci model. Currently, only a single controller of this +type and a single tablet are supported per domain.

+

Clock configuration

Originally bhyve supported only localtime for RTC. Support for UTC time was introduced in diff --git a/docs/news.xml b/docs/news.xml index b2e21efcae..706a23f068 100644 --- a/docs/news.xml +++ b/docs/news.xml @@ -95,6 +95,19 @@ is exceeded. Currently only the qemu driver supports this. + +

+ bhyve: Add support for UEFI boot ROM, VNC, and USB tablet + + + The bhyve driver now supports booting using the UEFI boot ROM, + so non-FreeBSD guests that support UEFI could be booted without + using an external boot loader like grub-bhyve. Video is also + supported now, allowing to connect to guests via VNC and use + an USB tablet as an input device. Please refer to + the driver page for domain XML examples. + +
-- 2.39.5