Page MenuHomeFreeBSD
Differential D55533 Diff 173025 share/man/man4/virtio.4

Changeset View

Standalone View

View Options

share/man/man4/virtio.4

Show All 16 Lines
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.Dd May 26, 2019 .Dd March 2, 2026
tuexenUnsubmitted
Done
Inline Actions

Please bump the date.

tuexen: Please bump the date.
.Dt VIRTIO 4 .Dt VIRTIO 4
.Os .Os
.Sh NAME .Sh NAME
.Nm virtio .Nm virtio
.Nd VirtIO Device Support .Nd VirtIO Device Support
.Sh SYNOPSIS .Sh SYNOPSIS
To compile VirtIO device support into the kernel, place the following lines To compile VirtIO device support into the kernel, place the following lines
in your kernel configuration file: in your kernel configuration file:
Show All 15 Lines
interface or disk controller to provide the VM with I/O. interface or disk controller to provide the VM with I/O.
This emulation is often inefficient. This emulation is often inefficient.
.Pp .Pp
VirtIO defines an interface for efficient I/O between the hypervisor and VM. VirtIO defines an interface for efficient I/O between the hypervisor and VM.
The The
.Nm .Nm
module provides a shared memory transport called a virtqueue. module provides a shared memory transport called a virtqueue.
The The
.Xr virtio_pci .Sy virtio_pci
device driver represents an emulated PCI device that the hypervisor makes device driver represents an emulated PCI device that the hypervisor makes
available to the VM. available to the VM.
This device provides the probing, configuration, and This device provides the probing, configuration, and
ziaeeUnsubmitted
Not Done
Inline Actions
module provides a shared memory transport called a virtqueue.
- The virtio_pci device driver represents an emulated PCI device that the
- hypervisor makes available to the VM.
+ The
+ .Sy virtio_pci
+ device driver represents an emulated PCI device that the hypervisor makes
+ available to the VM.
This device provides the probing, configuration, and

At the bottom of mdoc(7) it links to the extended style guide maintained by our manpage compiler which states you use Sy for things which have no manual in this operating system, for visual consistency with Nm.

ziaee: At the bottom of mdoc(7) it links to the extended style guide maintained by our manpage…
timo.voelker_fh-muenster.deAuthorUnsubmitted
Done
Inline Actions

I looked for an alternative to Xr. Sy is perfect, thanks!

timo.voelker_fh-muenster.de: I looked for an alternative to Xr. Sy is perfect, thanks!
interrupt notifications needed to interact with the hypervisor. interrupt notifications needed to interact with the hypervisor.
.Fx .Fx
supports the following VirtIO devices: supports the following VirtIO devices:
.Bl -hang -offset indent -width xxxxxxxx .Bl -hang -offset indent -width xxxxxxxx
.It Sy Ethernet .It Sy Ethernet
An emulated Ethernet device is provided by the An emulated Ethernet device is provided by the
.Xr vtnet 4 .Xr vtnet 4
device driver. device driver.
Show All 17 Lines
.It Sy GPU .It Sy GPU
Graphics support is provided by the Graphics support is provided by the
.Xr virtio_gpu 4 .Xr virtio_gpu 4
device driver. device driver.
.It Sy SCSI .It Sy SCSI
An emulated SCSI HBA is provided by the An emulated SCSI HBA is provided by the
.Xr virtio_scsi 4 .Xr virtio_scsi 4
device driver. device driver.
.El
.Sh LOADER TUNABLES
Tunables can be set at the
.Xr loader 8
prompt before booting the kernel or stored in
.Xr loader.conf 5 .
.Bl -tag -width "hw.virtio.pci.transitional"
ziaeeUnsubmitted
Done
Inline Actions
.Xr loader.conf 5 .
- .Bl -tag -width "xxxxxx"
+ .Bl -tag -width "hw.virtio.pci.transitional"
.It Va hw.virtio.pci.disable_msix

per style.mdoc(5)

ziaee: per style.mdoc(5)
.It Va hw.virtio.pci.disable_msix
If set to 1, disables MSI-X.
The default value is 0.
.It Va hw.virtio.pci.transitional
For a transitional
.Nm
device, this tunable specifies whether to negotiate
modern mode and use the modern
tuexenUnsubmitted
Not Done
Inline Actions

Isn't the default value 0 right now?

tuexen: Isn't the default value 0 right now?
timo.voelker_fh-muenster.deAuthorUnsubmitted
Done
Inline Actions

Isn't the default value 0 right now?

Good catch!

timo.voelker_fh-muenster.de: > Isn't the default value 0 right now? Good catch!
ziaeeUnsubmitted
Done
Inline Actions
.It Va hw.virtio.pci.transitional
- For a transitional VirtIO device, this tunable specifies whether to negotiate
- modern mode and use the modern VirtIO driver (1) or to negotiate legacy mode and
- use the legacy driver (0).
+ For a transitional
+ .Nm
+ device, this tunable specifies whether to negotiate modern mode
+ and use the modern
+ .Nm
+ driver
+ .Pq 1
+ or to negotiate legacy mode and use the legacy driver
+ .Pq 0 .
The default value is 1.
.El
.Sh SEE ALSO
ziaee:
.Nm
driver
.Pq 1
or to negotiate legacy mode and
use the legacy
.Nm
driver
.Pq 1 .
The default value is 0.
.El .El
.Sh SEE ALSO .Sh SEE ALSO
.Xr virtio_balloon 4 , .Xr virtio_balloon 4 ,
.Xr virtio_blk 4 , .Xr virtio_blk 4 ,
.Xr virtio_console 4 , .Xr virtio_console 4 ,
.Xr virtio_gpu 4 , .Xr virtio_gpu 4 ,
.Xr virtio_random 4 , .Xr virtio_random 4 ,
.Xr virtio_scsi 4 , .Xr virtio_scsi 4 ,
Show All 9 Lines