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