xref: /openbsd/share/man/man4/virtio.4 (revision 4cfece93)
1.\"     $OpenBSD: virtio.4,v 1.16 2019/05/26 20:37:03 jmc Exp $
2.\"
3.\" Copyright (c) 2012 Stefan Fritsch <sf@sfritsch.de>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: May 26 2019 $
18.Dt VIRTIO 4
19.Os
20.Sh NAME
21.Nm virtio
22.Nd VirtIO support driver
23.Sh SYNOPSIS
24.Cd "virtio* at fdt?"
25.Cd "virtio* at pci? flags 0x00"
26.Sh DESCRIPTION
27The
28.Nm
29driver provides support service for paravirtualized devices using the VirtIO
30protocol.
31Such devices are provided by bhyve, KVM, QEMU, VirtualBox, and
32.Xr vmm 4 .
33.Pp
34Currently there are drivers for the following
35.Nm
36devices:
37.Pp
38.Bl -tag -width "vioscsi(4)XXX" -offset indent -compact
39.It Xr vio 4
40VirtIO network device
41.It Xr vioblk 4
42VirtIO disk
43.It Xr viocon 4
44VirtIO console device
45.It Xr viomb 4
46VirtIO memory ballooning driver
47.It Xr viornd 4
48VirtIO random number device
49.It Xr vioscsi 4
50VirtIO SCSI adapter
51.It Xr vmmci 4
52.Xr vmm 4
53control interface
54.El
55.Pp
56The
57.Nm
58driver conforms to the virtio 0.9.5 specification.
59The virtio 1.0 standard is only supported for PCI devices.
60.Pp
61By default 0.9 is preferred over 1.0.
62This can be changed by setting the bit 0x4 in the flags.
63Setting the bit 0x8 in the flags disables 1.0 support completely.
64.Sh SEE ALSO
65.Xr intro 4
66.Sh HISTORY
67The
68.Nm
69driver first appeared in
70.Ox 5.3 .
71.Sh AUTHORS
72.An -nosplit
73The
74.Nm
75driver was ported to
76.Ox
77and improved by
78.An Stefan Fritsch Aq Mt sf@sfritsch.de .
79It is based on the
80.Nx
81driver by
82.An Minoura Makoto .
83.Sh BUGS
84.Nm
85big-endian architectures are not yet supported.
86