[PATCH 0/3] docs: drvbhyve: documentation updates
*** BLURB HERE *** Roman Bogorodskiy (3): docs: drvbhyve: document device passthrough docs: drvbhyve: improve the manpage link docs: drvbhyve: add guest-specific nodes section docs/drvbhyve.rst | 42 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 41 insertions(+), 1 deletion(-) -- 2.51.0
Signed-off-by: Roman Bogorodskiy <bogorodskiy@gmail.com> --- docs/drvbhyve.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/drvbhyve.rst b/docs/drvbhyve.rst index 9db17e55e3..94f6b65d77 100644 --- a/docs/drvbhyve.rst +++ b/docs/drvbhyve.rst @@ -659,3 +659,27 @@ As ``bhyve(1)`` uses one NVMe device per PCI address, it's modeled in a way that there is one device per controller. That is, if using more than one NVMe device, for device name users should increment controller number rather than namespace number, i.e.: ``nvme0n1``, ``nvme1n1``, etc. + +Device passthrough +~~~~~~~~~~~~~~~~~~ +:since:`Since 11.10.0`, it is possible to passthrough PCI devices. + +Example: + +:: + + ... + <hostdev mode='subsystem' type='pci' managed='no'> + <source> + <address domain='0x0000' bus='0x01' slot='0x00' function='0x0'/> + </source> + </hostdev> + ... + +Using passthrough devices requires wiring guest memory, see `Wiring guest memory`_. + +Note: currently, the `nodedev <drvnodedev.html>`_ driver is not supported +on FreeBSD. +Users must configure the device for passthrough manually either by +using ``devctl(8)`` or by setting ``pptdevs`` in ``loader.conf(5)``. +Please refer to the ``vmm(4)`` manual page for more details. -- 2.51.0
When linking to the bhyve(8) manual page, do not set manpath to a specific FreeBSD version so the latest actual version is displayed. Signed-off-by: Roman Bogorodskiy <bogorodskiy@gmail.com> --- docs/drvbhyve.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/drvbhyve.rst b/docs/drvbhyve.rst index 94f6b65d77..3efbc03ce5 100644 --- a/docs/drvbhyve.rst +++ b/docs/drvbhyve.rst @@ -393,7 +393,7 @@ exposed to the guest using the ``vgaconf`` attribute: If not specified, bhyve's default mode for ``vgaconf`` will be used. Please refer to the -`bhyve(8) <https://www.freebsd.org/cgi/man.cgi?query=bhyve&sektion=8&manpath=FreeBSD+12-current>`__ +`bhyve(8) <https://www.freebsd.org/cgi/man.cgi?query=bhyve&sektion=8>`__ manual page and the `bhyve wiki <https://wiki.freebsd.org/bhyve>`__ for more details on using the ``vgaconf`` option. -- 2.51.0
Add a section with guest-specific notes. Start with LPC slot address information for the Windows guests. Signed-off-by: Roman Bogorodskiy <bogorodskiy@gmail.com> --- docs/drvbhyve.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/drvbhyve.rst b/docs/drvbhyve.rst index 3efbc03ce5..73372ff7cf 100644 --- a/docs/drvbhyve.rst +++ b/docs/drvbhyve.rst @@ -683,3 +683,19 @@ on FreeBSD. Users must configure the device for passthrough manually either by using ``devctl(8)`` or by setting ``pptdevs`` in ``loader.conf(5)``. Please refer to the ``vmm(4)`` manual page for more details. + +Guest-specific considerations +----------------------------- + +Windows +~~~~~~~ + +For Windows guests, it is recommended to have the LPC controller on slot 31. +As the libvirt driver allocates slot 1 for the LPC controller by default, +the address must be specified explicitly: + +:: + + <controller type='isa' index='0'> + <address type='pci' domain='0x0000' bus='0x00' slot='0x1f' function='0x0'/> + </controller> -- 2.51.0
On 11/8/25 15:45, Roman Bogorodskiy wrote:
*** BLURB HERE ***
Roman Bogorodskiy (3): docs: drvbhyve: document device passthrough docs: drvbhyve: improve the manpage link docs: drvbhyve: add guest-specific nodes section
docs/drvbhyve.rst | 42 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 41 insertions(+), 1 deletion(-)
Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Michal
participants (2)
-
Michal Prívozník -
Roman Bogorodskiy