xref: /freebsd/share/man/man4/virtio_scsi.4 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
12f001371SPeter Grehan.\" Copyright (c) 2012 Bryan Venteicher
22f001371SPeter Grehan.\" All rights reserved.
32f001371SPeter Grehan.\"
42f001371SPeter Grehan.\" Redistribution and use in source and binary forms, with or without
52f001371SPeter Grehan.\" modification, are permitted provided that the following conditions
62f001371SPeter Grehan.\" are met:
72f001371SPeter Grehan.\" 1. Redistributions of source code must retain the above copyright
82f001371SPeter Grehan.\"    notice, this list of conditions and the following disclaimer.
92f001371SPeter Grehan.\" 2. Redistributions in binary form must reproduce the above copyright
102f001371SPeter Grehan.\"    notice, this list of conditions and the following disclaimer in the
112f001371SPeter Grehan.\"    documentation and/or other materials provided with the distribution.
122f001371SPeter Grehan.\"
132f001371SPeter Grehan.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
142f001371SPeter Grehan.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
152f001371SPeter Grehan.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
162f001371SPeter Grehan.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
172f001371SPeter Grehan.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
182f001371SPeter Grehan.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
192f001371SPeter Grehan.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
202f001371SPeter Grehan.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
212f001371SPeter Grehan.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
222f001371SPeter Grehan.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
232f001371SPeter Grehan.\" SUCH DAMAGE.
242f001371SPeter Grehan.\"
252f001371SPeter Grehan.Dd June 24, 2012
262f001371SPeter Grehan.Dt VIRTIO_SCSI 4
272f001371SPeter Grehan.Os
282f001371SPeter Grehan.Sh NAME
292f001371SPeter Grehan.Nm virtio_scsi
302f001371SPeter Grehan.Nd VirtIO SCSI driver
312f001371SPeter Grehan.Sh SYNOPSIS
322f001371SPeter GrehanTo compile this driver into the kernel,
332f001371SPeter Grehanplace the following lines in your
342f001371SPeter Grehankernel configuration file:
352f001371SPeter Grehan.Bd -ragged -offset indent
362f001371SPeter Grehan.Cd "device virtio_scsi"
372f001371SPeter Grehan.Ed
382f001371SPeter Grehan.Pp
392f001371SPeter GrehanAlternatively, to load the driver as a
402f001371SPeter Grehanmodule at boot time, place the following line in
412f001371SPeter Grehan.Xr loader.conf 5 :
422f001371SPeter Grehan.Bd -literal -offset indent
432f001371SPeter Grehanvirtio_scsi_load="YES"
442f001371SPeter Grehan.Ed
452f001371SPeter Grehan.Sh DESCRIPTION
462f001371SPeter GrehanThe
472f001371SPeter Grehan.Nm
482f001371SPeter Grehandevice driver provides support for VirtIO SCSI devices.
492f001371SPeter Grehan.Sh LOADER TUNABLES
502f001371SPeter GrehanTunables can be set at the
512f001371SPeter Grehan.Xr loader 8
522f001371SPeter Grehanprompt before booting the kernel or stored in
532f001371SPeter Grehan.Xr loader.conf 5 .
542f001371SPeter Grehan.Bl -tag -width "xxxxxx"
552f001371SPeter Grehan.It Va hw.vtscsi.bus_reset_disable
562f001371SPeter GrehanIn the initial QEMU release with VirtIO SCSI support, in-flight
572f001371SPeter Grehanoperations were not aborted when stopping the device, rendering
58*25972509SEdward Tomasz Napieralabus reset ineffective.
59*25972509SEdward Tomasz NapieralaThis tunable disables attempts to issue reset bus commands.
60*25972509SEdward Tomasz NapieralaThe default value is 1.
612f001371SPeter Grehan.El
622f001371SPeter Grehan.Sh DEBUGGING
632f001371SPeter GrehanTo enable debugging prints from the
642f001371SPeter Grehan.Nm
652f001371SPeter Grehandriver, set the
662f001371SPeter Grehan.Bd -literal -offset indent
672f001371SPeter Grehanhw.vtscsi.X.debug_level
682f001371SPeter Grehan.Ed
692f001371SPeter Grehan.Pp
702f001371SPeter Grehanvariable, where X is the adapter number, either in
712f001371SPeter Grehan.Xr loader.conf 5
722f001371SPeter Grehanor via
732f001371SPeter Grehan.Xr sysctl 8 .
742f001371SPeter GrehanThe following bits have the described effects:
752f001371SPeter Grehan.Bl -tag -width 6n -offset indent
762f001371SPeter Grehan.It 0x01
772f001371SPeter GrehanEnable informational prints.
782f001371SPeter Grehan.It 0x02
792f001371SPeter GrehanEnable prints for driver errors.
802f001371SPeter Grehan.It 0x04
812f001371SPeter GrehanEnable tracing prints.
822f001371SPeter Grehan.El
832f001371SPeter Grehan.Sh SEE ALSO
842f001371SPeter Grehan.Xr virtio 4
852f001371SPeter Grehan.Sh HISTORY
862f001371SPeter GrehanThe
872f001371SPeter Grehan.Nm
882f001371SPeter Grehandriver was written by
896c899950SBaptiste Daroussin.An Bryan Venteicher Aq Mt bryanv@FreeBSD.org .
902f001371SPeter GrehanIt first appeared in
912f001371SPeter Grehan.Fx 10.0 .
92