summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/pvscsi.4 3.html
blob: f8c8baaa50cf9b9b9b0ba00cd5401b7961b5d343 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
<table class="head">
  <tr>
    <td class="head-ltitle">PVSCSI(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">PVSCSI(4)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">pvscsi</code> &#x2014; <span class="Nd">VMware
    Paravirtual SCSI Controller</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp">To compile this driver into the kernel, place the following line
    in your kernel configuration file:</p>
<div class="Bd Pp Bd-indent"><code class="Cd">device pci</code>
<br/>
<code class="Cd">device scbus</code>
<br/>
<code class="Cd">device pvscsi</code></div>
<p class="Pp">Alternatively, to load the driver as a module at boot time, place
    the following line in <a class="Xr">loader.conf(5)</a>:</p>
<div class="Bd Pp Bd-indent Li">
<pre>pvscsi_load=&quot;YES&quot;</pre>
</div>
<p class="Pp">The following tunables are settable from the
    <a class="Xr">loader(8)</a>:</p>
<dl class="Bl-ohang">
  <dt id="hw.pvscsi.request_ring_pages"><var class="Va">hw.pvscsi.request_ring_pages</var></dt>
  <dd>controls how many pages are allocated for the device request ring. A
      non-positive value will cause the driver to choose the value based on
      device capabilities. A non-zero value will use that many number of pages
      up to a maximum of 32. The default setting is 0.</dd>
  <dt id="hw.pvscsi.max_queue_depth"><var class="Va">hw.pvscsi.max_queue_depth</var></dt>
  <dd>controls the queue size for the adapter. A non-positive value will cause
      the driver to choose the value based on number of request ring pages. A
      non-zero value will set the queue size up to a maximum allowed by the
      number of request ring pages. Default is 0.</dd>
  <dt id="hw.pvscsi.use_msg"><var class="Va">hw.pvscsi.use_msg</var></dt>
  <dd>setting to nonzero value enables the use of the PVSCSI message queue
      allowing for disk hot-add and remove without manual rescan needed. Default
      is 1.</dd>
  <dt id="hw.pvscsi.use_msi"><var class="Va">hw.pvscsi.use_msi</var></dt>
  <dd>setting to nonzero value enables the use of MSI interrupts. Default is
    1.</dd>
  <dt id="hw.pvscsi.use_msix"><var class="Va">hw.pvscsi.use_msix</var></dt>
  <dd>setting to nonzero value enables the use of MSI-X interrupts. Default is
      1.</dd>
  <dt id="hw.pvscsi.use_req_call_threshold"><var class="Va">hw.pvscsi.use_req_call_threshold</var></dt>
  <dd>setting to nonzero value enables the request call threshold functionality.
      TODO. Default is 1.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">pvscsi</code> driver provides support for the
    VMware Paravirtual SCSI Controller (PVSCSI) in virtual machines by
  VMware.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">cam(4)</a>, <a class="Xr">da(4)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<p class="Pp">The <code class="Nm">pvscsi</code> driver first appeared in
    <span class="Ux">FreeBSD 13.0</span>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp"><span class="An">Vishal Bhakta</span>
    &lt;<a class="Mt" href="mailto:vbhakta@vmware.com">vbhakta@vmware.com</a>&gt;.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">December 5, 2018</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>