share/man/man4/pvscsi.4

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