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