xref: /netbsd-src/share/man/man4/virtio.4 (revision 657abbd48b155fc1d67763eaec322a0c5041d87f)
1.\"	$NetBSD: virtio.4,v 1.11 2024/08/01 09:38:50 uwe Exp $
2.\"
3.\" Copyright (c) 2011 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
16.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
19.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25.\" POSSIBILITY OF SUCH DAMAGE.
26.\"
27.Dd June 7, 2018
28.Dt VIRTIO 4
29.Os
30.Sh NAME
31.Nm virtio
32.Nd Para-virtualized I/O in a virtual machine
33.Sh SYNOPSIS
34.Cd "virtio* at fdt?"
35.Cd "virtio* at pci? dev ? function ?"
36.Cd "ld* at virtio?"
37.Cd "viocon* at virtio?"
38.Cd "vioif* at virtio?"
39.Cd "viomb* at virtio?"
40.Cd "viornd* at virtio?"
41.Cd "vioscsi* at virtio?"
42.Sh DESCRIPTION
43.Nm
44defines an interface for efficient, standard and extensible I/O between the
45hypervisor and the virtual machine.
46The
47.Nm
48device driver represents an emulated device that the hypervisor makes
49available to the virtual machine.
50.Pp
51.Nm
52driver itself provides the core infrastructure to communicate
53with the hypervisor (called virtqueues) and supports the following devices:
54.Pp
55.Bl -tag -width Xr -compact
56.It Xr ld 4
57A Disk device.
58.It Xr viocon 4
59Console device.
60.It Xr vioif 4
61An Ethernet device.
62.It Xr viomb 4
63A pseudo-device to release memory back to the hypervisor.
64.It Xr viornd 4
65An entropy source.
66.It Xr vioscsi 4
67A SCSI adapter.
68.El
69.Sh SEE ALSO
70.Xr ld 4 ,
71.Xr pci 4 ,
72.Xr viocon 4 ,
73.Xr vioif 4 ,
74.Xr viomb 4 ,
75.Xr viornd 4 ,
76.Xr vioscsi 4
77.Pp
78.Rs
79.%A Rusty Russell, IBM Corporation
80.%T Virtio PCI Card Specification
81.%U http://ozlabs.org/~rusty/virtio-spec/
82.Re
83.Rs
84.%T Virtual I/O Device (VIRTIO) Version 1.0
85.%U https://docs.oasis-open.org/virtio/virtio/v1.0/virtio-v1.0.html
86.Re
87.Sh HISTORY
88The
89.Nm
90driver first appeared in
91.Nx 6.0 .
92