xref: /freebsd/share/man/man4/pvscsi.4 (revision 911f0260390e18cf85f3dbf2c719b593efdc1e3c)
1.\" Copyright (c) 2018 VMware, Inc.
2.\"
3.\" SPDX-License-Identifier: (BSD-2-Clause OR GPL-2.0)
4.\"
5.\" $FreeBSD$
6.Dd December 5, 2018
7.Dt PVSCSI 4
8.Os
9.Sh NAME
10.Nm pvscsi
11.Nd VMware Paravirtual SCSI Controller
12.Sh SYNOPSIS
13To compile this driver into the kernel,
14place the following line in your
15kernel configuration file:
16.Bd -ragged -offset indent
17.Cd "device pci"
18.Cd "device scbus"
19.Cd "device pvscsi"
20.Ed
21.Pp
22Alternatively, to load the driver as a
23module at boot time, place the following line in
24.Xr loader.conf 5 :
25.Bd -literal -offset indent
26pvscsi_load="YES"
27.Ed
28.Pp
29The following tunables are settable from the
30.Xr loader 8 :
31.Bl -ohang
32.It Va hw.pvscsi.request_ring_pages
33controls how many pages are allocated for the device request ring.
34A non-positive value will cause the driver to choose the value based on device
35capabilities.
36A non-zero value will use that many number of pages up to a maximum of 32.
37The default setting is 0.
38.It Va hw.pvscsi.max_queue_depth
39controls the queue size for the adapter.
40A non-positive value will cause the driver to choose the value based on number
41of request ring pages.
42A non-zero value will set the queue size up to a maximum allowed by the number
43of request ring pages.
44Default is 0.
45.It Va hw.pvscsi.use_msg
46setting to nonzero value enables the use of the PVSCSI message queue allowing
47for disk hot-add and remove without manual rescan needed.
48Default is 1.
49.It Va hw.pvscsi.use_msi
50setting to nonzero value enables the use of MSI interrupts.
51Default is 1.
52.It Va hw.pvscsi.use_msix
53setting to nonzero value enables the use of MSI-X interrupts.
54Default is 1.
55.It Va hw.pvscsi.use_req_call_threshold
56setting to nonzero value enables the request call threshold functionality.
57TODO.
58Default is 1.
59.El
60.Sh DESCRIPTION
61The
62.Nm
63driver provides support for the VMware Paravirtual SCSI Controller (PVSCSI) in
64virtual machines by VMware.
65.Sh SEE ALSO
66.Xr cam 4 ,
67.Xr da 4
68.Sh HISTORY
69The
70.Nm
71driver first appeared in
72.Fx 13.0 .
73.Sh AUTHORS
74.An Vishal Bhakta Aq Mt vbhakta@vmware.com .
75