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