xref: /freebsd/share/man/man4/virtio_scsi.4 (revision 6c89995002b9c6d1a9c7365483c55c106fc752d5)
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.\" $FreeBSD$
262f001371SPeter Grehan.\"
272f001371SPeter Grehan.Dd June 24, 2012
282f001371SPeter Grehan.Dt VIRTIO_SCSI 4
292f001371SPeter Grehan.Os
302f001371SPeter Grehan.Sh NAME
312f001371SPeter Grehan.Nm virtio_scsi
322f001371SPeter Grehan.Nd VirtIO SCSI driver
332f001371SPeter Grehan.Sh SYNOPSIS
342f001371SPeter GrehanTo compile this driver into the kernel,
352f001371SPeter Grehanplace the following lines in your
362f001371SPeter Grehankernel configuration file:
372f001371SPeter Grehan.Bd -ragged -offset indent
382f001371SPeter Grehan.Cd "device virtio_scsi"
392f001371SPeter Grehan.Ed
402f001371SPeter Grehan.Pp
412f001371SPeter GrehanAlternatively, to load the driver as a
422f001371SPeter Grehanmodule at boot time, place the following line in
432f001371SPeter Grehan.Xr loader.conf 5 :
442f001371SPeter Grehan.Bd -literal -offset indent
452f001371SPeter Grehanvirtio_scsi_load="YES"
462f001371SPeter Grehan.Ed
472f001371SPeter Grehan.Sh DESCRIPTION
482f001371SPeter GrehanThe
492f001371SPeter Grehan.Nm
502f001371SPeter Grehandevice driver provides support for VirtIO SCSI devices.
512f001371SPeter Grehan.Sh LOADER TUNABLES
522f001371SPeter GrehanTunables can be set at the
532f001371SPeter Grehan.Xr loader 8
542f001371SPeter Grehanprompt before booting the kernel or stored in
552f001371SPeter Grehan.Xr loader.conf 5 .
562f001371SPeter Grehan.Bl -tag -width "xxxxxx"
572f001371SPeter Grehan.It Va hw.vtscsi.bus_reset_disable
582f001371SPeter GrehanIn the initial QEMU release with VirtIO SCSI support, in-flight
592f001371SPeter Grehanoperations were not aborted when stopping the device, rendering
602f001371SPeter Grehanbus reset ineffective. This tunable disables attempts to issue
612f001371SPeter Grehanreset bus commands. The default value is 1.
622f001371SPeter Grehan.El
632f001371SPeter Grehan.Sh DEBUGGING
642f001371SPeter GrehanTo enable debugging prints from the
652f001371SPeter Grehan.Nm
662f001371SPeter Grehandriver, set the
672f001371SPeter Grehan.Bd -literal -offset indent
682f001371SPeter Grehanhw.vtscsi.X.debug_level
692f001371SPeter Grehan.Ed
702f001371SPeter Grehan.Pp
712f001371SPeter Grehanvariable, where X is the adapter number, either in
722f001371SPeter Grehan.Xr loader.conf 5
732f001371SPeter Grehanor via
742f001371SPeter Grehan.Xr sysctl 8 .
752f001371SPeter GrehanThe following bits have the described effects:
762f001371SPeter Grehan.Bl -tag -width 6n -offset indent
772f001371SPeter Grehan.It 0x01
782f001371SPeter GrehanEnable informational prints.
792f001371SPeter Grehan.It 0x02
802f001371SPeter GrehanEnable prints for driver errors.
812f001371SPeter Grehan.It 0x04
822f001371SPeter GrehanEnable tracing prints.
832f001371SPeter Grehan.El
842f001371SPeter Grehan.Sh SEE ALSO
852f001371SPeter Grehan.Xr virtio 4
862f001371SPeter Grehan.Sh HISTORY
872f001371SPeter GrehanThe
882f001371SPeter Grehan.Nm
892f001371SPeter Grehandriver was written by
90*6c899950SBaptiste Daroussin.An Bryan Venteicher Aq Mt bryanv@FreeBSD.org .
912f001371SPeter GrehanIt first appeared in
922f001371SPeter Grehan.Fx 10.0 .
93