xref: /freebsd/share/man/man4/virtio_scsi.4 (revision 2f001371c32f39c7e96253c56c30810b9840e4ca)
1*2f001371SPeter Grehan.\" Copyright (c) 2012 Bryan Venteicher
2*2f001371SPeter Grehan.\" All rights reserved.
3*2f001371SPeter Grehan.\"
4*2f001371SPeter Grehan.\" Redistribution and use in source and binary forms, with or without
5*2f001371SPeter Grehan.\" modification, are permitted provided that the following conditions
6*2f001371SPeter Grehan.\" are met:
7*2f001371SPeter Grehan.\" 1. Redistributions of source code must retain the above copyright
8*2f001371SPeter Grehan.\"    notice, this list of conditions and the following disclaimer.
9*2f001371SPeter Grehan.\" 2. Redistributions in binary form must reproduce the above copyright
10*2f001371SPeter Grehan.\"    notice, this list of conditions and the following disclaimer in the
11*2f001371SPeter Grehan.\"    documentation and/or other materials provided with the distribution.
12*2f001371SPeter Grehan.\"
13*2f001371SPeter Grehan.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14*2f001371SPeter Grehan.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15*2f001371SPeter Grehan.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16*2f001371SPeter Grehan.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17*2f001371SPeter Grehan.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18*2f001371SPeter Grehan.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19*2f001371SPeter Grehan.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20*2f001371SPeter Grehan.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21*2f001371SPeter Grehan.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22*2f001371SPeter Grehan.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23*2f001371SPeter Grehan.\" SUCH DAMAGE.
24*2f001371SPeter Grehan.\"
25*2f001371SPeter Grehan.\" $FreeBSD$
26*2f001371SPeter Grehan.\"
27*2f001371SPeter Grehan.Dd June 24, 2012
28*2f001371SPeter Grehan.Dt VIRTIO_SCSI 4
29*2f001371SPeter Grehan.Os
30*2f001371SPeter Grehan.Sh NAME
31*2f001371SPeter Grehan.Nm virtio_scsi
32*2f001371SPeter Grehan.Nd VirtIO SCSI driver
33*2f001371SPeter Grehan.Sh SYNOPSIS
34*2f001371SPeter GrehanTo compile this driver into the kernel,
35*2f001371SPeter Grehanplace the following lines in your
36*2f001371SPeter Grehankernel configuration file:
37*2f001371SPeter Grehan.Bd -ragged -offset indent
38*2f001371SPeter Grehan.Cd "device virtio_scsi"
39*2f001371SPeter Grehan.Ed
40*2f001371SPeter Grehan.Pp
41*2f001371SPeter GrehanAlternatively, to load the driver as a
42*2f001371SPeter Grehanmodule at boot time, place the following line in
43*2f001371SPeter Grehan.Xr loader.conf 5 :
44*2f001371SPeter Grehan.Bd -literal -offset indent
45*2f001371SPeter Grehanvirtio_scsi_load="YES"
46*2f001371SPeter Grehan.Ed
47*2f001371SPeter Grehan.Sh DESCRIPTION
48*2f001371SPeter GrehanThe
49*2f001371SPeter Grehan.Nm
50*2f001371SPeter Grehandevice driver provides support for VirtIO SCSI devices.
51*2f001371SPeter Grehan.Sh LOADER TUNABLES
52*2f001371SPeter GrehanTunables can be set at the
53*2f001371SPeter Grehan.Xr loader 8
54*2f001371SPeter Grehanprompt before booting the kernel or stored in
55*2f001371SPeter Grehan.Xr loader.conf 5 .
56*2f001371SPeter Grehan.Bl -tag -width "xxxxxx"
57*2f001371SPeter Grehan.It Va hw.vtscsi.bus_reset_disable
58*2f001371SPeter GrehanIn the initial QEMU release with VirtIO SCSI support, in-flight
59*2f001371SPeter Grehanoperations were not aborted when stopping the device, rendering
60*2f001371SPeter Grehanbus reset ineffective. This tunable disables attempts to issue
61*2f001371SPeter Grehanreset bus commands. The default value is 1.
62*2f001371SPeter Grehan.El
63*2f001371SPeter Grehan.Sh DEBUGGING
64*2f001371SPeter GrehanTo enable debugging prints from the
65*2f001371SPeter Grehan.Nm
66*2f001371SPeter Grehandriver, set the
67*2f001371SPeter Grehan.Bd -literal -offset indent
68*2f001371SPeter Grehanhw.vtscsi.X.debug_level
69*2f001371SPeter Grehan.Ed
70*2f001371SPeter Grehan.Pp
71*2f001371SPeter Grehanvariable, where X is the adapter number, either in
72*2f001371SPeter Grehan.Xr loader.conf 5
73*2f001371SPeter Grehanor via
74*2f001371SPeter Grehan.Xr sysctl 8 .
75*2f001371SPeter GrehanThe following bits have the described effects:
76*2f001371SPeter Grehan.Bl -tag -width 6n -offset indent
77*2f001371SPeter Grehan.It 0x01
78*2f001371SPeter GrehanEnable informational prints.
79*2f001371SPeter Grehan.It 0x02
80*2f001371SPeter GrehanEnable prints for driver errors.
81*2f001371SPeter Grehan.It 0x04
82*2f001371SPeter GrehanEnable tracing prints.
83*2f001371SPeter Grehan.El
84*2f001371SPeter Grehan.Sh SEE ALSO
85*2f001371SPeter Grehan.Xr virtio 4
86*2f001371SPeter Grehan.Sh HISTORY
87*2f001371SPeter GrehanThe
88*2f001371SPeter Grehan.Nm
89*2f001371SPeter Grehandriver was written by
90*2f001371SPeter Grehan.An Bryan Venteicher Aq bryanv@daemoninthecloset.org .
91*2f001371SPeter GrehanIt first appeared in
92*2f001371SPeter Grehan.Fx 10.0 .
93