xref: /netbsd-src/share/man/man4/virtio.4 (revision c38e7cc395b1472a774ff828e46123de44c628e9)
1.\"	$NetBSD: virtio.4,v 1.8 2017/05/16 23:21:53 jdolecek 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 May 17, 2017
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 pci? dev ? function ?"
35.Cd "ld* at virtio?"
36.Cd "vioif* at virtio?"
37.Cd "viomb* at virtio?"
38.Cd "viornd* at virtio?"
39.Cd "vioscsi* at virtio?"
40.Sh DESCRIPTION
41.Nm
42defines an interface for efficient, standard and extensible I/O between the
43hypervisor and the virtual machine.
44The
45.Nm
46device driver represents an emulated PCI device that the hypervisor makes
47available to the virtual machine.
48.Pp
49.Nm
50driver itself provides the core infrastructure to communicate
51with the hypervisor (called virtqueues) and supports the following devices:
52.Bl -tag -width xxxxx
53.It Xr ld 4
54A Disk device.
55.It Xr vioif 4
56An Ethernet device.
57.It Xr viomb 4
58A pseudo-device to release memory back to the hypervisor.
59.It Xr viornd 4
60An entropy source.
61.It Xr vioscsi 4
62A SCSI adapter.
63.El
64.Sh SEE ALSO
65.Xr ld 4 ,
66.Xr pci 4 ,
67.Xr vioif 4 ,
68.Xr viomb 4 ,
69.Xr viornd 4 ,
70.Xr vioscsi 4
71.Pp
72.Rs
73.%A Rusty Russell, IBM Corporation
74.%T Virtio PCI Card Specification
75.%U http://ozlabs.org/~rusty/virtio-spec/
76.Re
77.Sh HISTORY
78The
79.Nm
80driver first appeared in
81.Nx 6.0 .
82