xref: /freebsd/share/man/man4/virtio_blk.4 (revision 10b59a9b4add0320d52c15ce057dd697261e7dfc)
1*10b59a9bSPeter Grehan.\" Copyright (c) 2011 Bryan Venteicher
2*10b59a9bSPeter Grehan.\" All rights reserved.
3*10b59a9bSPeter Grehan.\"
4*10b59a9bSPeter Grehan.\" Redistribution and use in source and binary forms, with or without
5*10b59a9bSPeter Grehan.\" modification, are permitted provided that the following conditions
6*10b59a9bSPeter Grehan.\" are met:
7*10b59a9bSPeter Grehan.\" 1. Redistributions of source code must retain the above copyright
8*10b59a9bSPeter Grehan.\"    notice, this list of conditions and the following disclaimer.
9*10b59a9bSPeter Grehan.\" 2. Redistributions in binary form must reproduce the above copyright
10*10b59a9bSPeter Grehan.\"    notice, this list of conditions and the following disclaimer in the
11*10b59a9bSPeter Grehan.\"    documentation and/or other materials provided with the distribution.
12*10b59a9bSPeter Grehan.\"
13*10b59a9bSPeter Grehan.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14*10b59a9bSPeter Grehan.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15*10b59a9bSPeter Grehan.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16*10b59a9bSPeter Grehan.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17*10b59a9bSPeter Grehan.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18*10b59a9bSPeter Grehan.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19*10b59a9bSPeter Grehan.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20*10b59a9bSPeter Grehan.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21*10b59a9bSPeter Grehan.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22*10b59a9bSPeter Grehan.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23*10b59a9bSPeter Grehan.\" SUCH DAMAGE.
24*10b59a9bSPeter Grehan.\"
25*10b59a9bSPeter Grehan.\" $FreeBSD$
26*10b59a9bSPeter Grehan.\"
27*10b59a9bSPeter Grehan.Dd July 4, 2011
28*10b59a9bSPeter Grehan.Dt VIRTIO_BLK 4
29*10b59a9bSPeter Grehan.Os
30*10b59a9bSPeter Grehan.Sh NAME
31*10b59a9bSPeter Grehan.Nm virtio_blk
32*10b59a9bSPeter Grehan.Nd VirtIO Block driver
33*10b59a9bSPeter Grehan.Sh SYNOPSIS
34*10b59a9bSPeter GrehanTo compile this driver into the kernel,
35*10b59a9bSPeter Grehanplace the following lines in your
36*10b59a9bSPeter Grehankernel configuration file:
37*10b59a9bSPeter Grehan.Bd -ragged -offset indent
38*10b59a9bSPeter Grehan.Cd "device virtio_blk"
39*10b59a9bSPeter Grehan.Ed
40*10b59a9bSPeter Grehan.Pp
41*10b59a9bSPeter GrehanAlternatively, to load the driver as a
42*10b59a9bSPeter Grehanmodule at boot time, place the following line in
43*10b59a9bSPeter Grehan.Xr loader.conf 5 :
44*10b59a9bSPeter Grehan.Bd -literal -offset indent
45*10b59a9bSPeter Grehanvirtio_blk_load="YES"
46*10b59a9bSPeter Grehan.Ed
47*10b59a9bSPeter Grehan.Sh DESCRIPTION
48*10b59a9bSPeter GrehanThe
49*10b59a9bSPeter Grehan.Nm
50*10b59a9bSPeter Grehandevice driver provides support for VirtIO block devices.
51*10b59a9bSPeter Grehan.Pp
52*10b59a9bSPeter Grehan.Sh LOADER TUNABLES
53*10b59a9bSPeter GrehanTunables can be set at the
54*10b59a9bSPeter Grehan.Xr loader 8
55*10b59a9bSPeter Grehanprompt before booting the kernel or stored in
56*10b59a9bSPeter Grehan.Xr loader.conf 5 .
57*10b59a9bSPeter Grehan.Bl -tag -width "xxxxxx"
58*10b59a9bSPeter Grehan.It Va hw.vtblk.no_ident
59*10b59a9bSPeter GrehanThis tunable disables retrieving the device identification string
60*10b59a9bSPeter Grehanfrom the hypervisor. The default value is 0.
61*10b59a9bSPeter Grehan.El
62*10b59a9bSPeter Grehan.Sh SEE ALSO
63*10b59a9bSPeter Grehan.Xr virtio 4
64*10b59a9bSPeter Grehan.Sh HISTORY
65*10b59a9bSPeter GrehanThe
66*10b59a9bSPeter Grehan.Nm
67*10b59a9bSPeter Grehandriver was written by
68*10b59a9bSPeter Grehan.An Bryan Venteicher Aq bryanv@daemoninthecloset.org .
69*10b59a9bSPeter GrehanIt first appeared in
70*10b59a9bSPeter Grehan.Fx 9.0 .
71