xref: /freebsd/share/man/man4/virtio_scsi.4 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1.\" Copyright (c) 2012 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.Dd June 24, 2012
26.Dt VIRTIO_SCSI 4
27.Os
28.Sh NAME
29.Nm virtio_scsi
30.Nd VirtIO SCSI driver
31.Sh SYNOPSIS
32To compile this driver into the kernel,
33place the following lines in your
34kernel configuration file:
35.Bd -ragged -offset indent
36.Cd "device virtio_scsi"
37.Ed
38.Pp
39Alternatively, to load the driver as a
40module at boot time, place the following line in
41.Xr loader.conf 5 :
42.Bd -literal -offset indent
43virtio_scsi_load="YES"
44.Ed
45.Sh DESCRIPTION
46The
47.Nm
48device driver provides support for VirtIO SCSI devices.
49.Sh LOADER TUNABLES
50Tunables can be set at the
51.Xr loader 8
52prompt before booting the kernel or stored in
53.Xr loader.conf 5 .
54.Bl -tag -width "xxxxxx"
55.It Va hw.vtscsi.bus_reset_disable
56In the initial QEMU release with VirtIO SCSI support, in-flight
57operations were not aborted when stopping the device, rendering
58bus reset ineffective.
59This tunable disables attempts to issue reset bus commands.
60The default value is 1.
61.El
62.Sh DEBUGGING
63To enable debugging prints from the
64.Nm
65driver, set the
66.Bd -literal -offset indent
67hw.vtscsi.X.debug_level
68.Ed
69.Pp
70variable, where X is the adapter number, either in
71.Xr loader.conf 5
72or via
73.Xr sysctl 8 .
74The following bits have the described effects:
75.Bl -tag -width 6n -offset indent
76.It 0x01
77Enable informational prints.
78.It 0x02
79Enable prints for driver errors.
80.It 0x04
81Enable tracing prints.
82.El
83.Sh SEE ALSO
84.Xr virtio 4
85.Sh HISTORY
86The
87.Nm
88driver was written by
89.An Bryan Venteicher Aq Mt bryanv@FreeBSD.org .
90It first appeared in
91.Fx 10.0 .
92