xref: /dflybsd-src/share/man/man4/pvscsi.4 (revision 1c0b11ab1b67963928ed4791f088991f9b9a0797)
17b13bc96SSascha Wildner.\" Copyright (c) 2018 VMware, Inc.
27b13bc96SSascha Wildner.\"
37b13bc96SSascha Wildner.\" SPDX-License-Identifier: (BSD-2-Clause OR GPL-2.0)
47b13bc96SSascha Wildner.\"
57b13bc96SSascha Wildner.\" $FreeBSD$
6*1c0b11abSSascha Wildner.Dd February 27, 2023
77b13bc96SSascha Wildner.Dt PVSCSI 4
87b13bc96SSascha Wildner.Os
97b13bc96SSascha Wildner.Sh NAME
107b13bc96SSascha Wildner.Nm pvscsi
117b13bc96SSascha Wildner.Nd VMware Paravirtual SCSI Controller
127b13bc96SSascha Wildner.Sh SYNOPSIS
137b13bc96SSascha WildnerTo compile this driver into the kernel,
147b13bc96SSascha Wildnerplace the following line in your
157b13bc96SSascha Wildnerkernel configuration file:
167b13bc96SSascha Wildner.Bd -ragged -offset indent
177b13bc96SSascha Wildner.Cd "device pci"
187b13bc96SSascha Wildner.Cd "device scbus"
197b13bc96SSascha Wildner.Cd "device pvscsi"
207b13bc96SSascha Wildner.Ed
217b13bc96SSascha Wildner.Pp
227b13bc96SSascha WildnerAlternatively, to load the driver as a
237b13bc96SSascha Wildnermodule at boot time, place the following line in
247b13bc96SSascha Wildner.Xr loader.conf 5 :
257b13bc96SSascha Wildner.Bd -literal -offset indent
267b13bc96SSascha Wildnerpvscsi_load="YES"
277b13bc96SSascha Wildner.Ed
287b13bc96SSascha Wildner.Pp
297b13bc96SSascha WildnerThe following tunables are settable from the
307b13bc96SSascha Wildner.Xr loader 8 :
317b13bc96SSascha Wildner.Bl -ohang
327b13bc96SSascha Wildner.It Va hw.pvscsi.request_ring_pages
337b13bc96SSascha Wildnercontrols how many pages are allocated for the device request ring.
347b13bc96SSascha WildnerA non-positive value will cause the driver to choose the value based on device
357b13bc96SSascha Wildnercapabilities.
367b13bc96SSascha WildnerA non-zero value will use that many number of pages up to a maximum of 32.
377b13bc96SSascha WildnerThe default setting is 0.
387b13bc96SSascha Wildner.It Va hw.pvscsi.max_queue_depth
397b13bc96SSascha Wildnercontrols the queue size for the adapter.
407b13bc96SSascha WildnerA non-positive value will cause the driver to choose the value based on number
417b13bc96SSascha Wildnerof request ring pages.
427b13bc96SSascha WildnerA non-zero value will set the queue size up to a maximum allowed by the number
437b13bc96SSascha Wildnerof request ring pages.
447b13bc96SSascha WildnerDefault is 0.
457b13bc96SSascha Wildner.It Va hw.pvscsi.use_msg
467b13bc96SSascha Wildnersetting to nonzero value enables the use of the PVSCSI message queue allowing
477b13bc96SSascha Wildnerfor disk hot-add and remove without manual rescan needed.
487b13bc96SSascha WildnerDefault is 1.
497b13bc96SSascha Wildner.It Va hw.pvscsi.use_msi
507b13bc96SSascha Wildnersetting to nonzero value enables the use of MSI interrupts.
517b13bc96SSascha WildnerDefault is 1.
52*1c0b11abSSascha Wildner.\".It Va hw.pvscsi.use_msix
53*1c0b11abSSascha Wildner.\"setting to nonzero value enables the use of MSI-X interrupts.
54*1c0b11abSSascha Wildner.\"Default is 1.
557b13bc96SSascha Wildner.It Va hw.pvscsi.use_req_call_threshold
567b13bc96SSascha Wildnersetting to nonzero value enables the request call threshold functionality.
577b13bc96SSascha WildnerTODO.
587b13bc96SSascha WildnerDefault is 1.
597b13bc96SSascha Wildner.El
607b13bc96SSascha Wildner.Sh DESCRIPTION
617b13bc96SSascha WildnerThe
627b13bc96SSascha Wildner.Nm
637b13bc96SSascha Wildnerdriver provides support for the VMware Paravirtual SCSI Controller (PVSCSI) in
647b13bc96SSascha Wildnervirtual machines by VMware.
657b13bc96SSascha Wildner.Sh SEE ALSO
667b13bc96SSascha Wildner.Xr cam 4 ,
677b13bc96SSascha Wildner.Xr da 4
687b13bc96SSascha Wildner.Sh HISTORY
697b13bc96SSascha WildnerThe
707b13bc96SSascha Wildner.Nm
717b13bc96SSascha Wildnerdriver first appeared in
727b13bc96SSascha Wildner.Fx 13.0 .
737b13bc96SSascha Wildner.Sh AUTHORS
747b13bc96SSascha Wildner.An Vishal Bhakta Aq Mt vbhakta@vmware.com .
75