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