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