summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/ntb_hw_intel.4 3.html
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:59:05 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:59:05 -0400
commit1f19f33e45791ea59aed048796fc68672c6723a5 (patch)
tree54625fba89e91d1c2177801ec635e8528bba937f /static/freebsd/man4/ntb_hw_intel.4 3.html
parentac5e55f5f2af5b92794c2aded46c6bae85b5f5ed (diff)
docs: Removed Precompiled HTML
Diffstat (limited to 'static/freebsd/man4/ntb_hw_intel.4 3.html')
-rw-r--r--static/freebsd/man4/ntb_hw_intel.4 3.html89
1 files changed, 0 insertions, 89 deletions
diff --git a/static/freebsd/man4/ntb_hw_intel.4 3.html b/static/freebsd/man4/ntb_hw_intel.4 3.html
deleted file mode 100644
index 7d2863f7..00000000
--- a/static/freebsd/man4/ntb_hw_intel.4 3.html
+++ /dev/null
@@ -1,89 +0,0 @@
-<table class="head">
- <tr>
- <td class="head-ltitle">NTB_HW_INTEL(4)</td>
- <td class="head-vol">Device Drivers Manual</td>
- <td class="head-rtitle">NTB_HW_INTEL(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">ntb_hw_intel</code> &#x2014;
- <span class="Nd">Intel(R) Non-Transparent Bridge driver</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 your kernel, place the following lines
- in your kernel configuration file:</p>
-<div class="Bd Pp Bd-indent"><code class="Cd">device ntb</code>
-<br/>
-<code class="Cd">device ntb_hw_intel</code></div>
-<p class="Pp">Or, to load the driver as a module at boot, place the following
- line in <a class="Xr">loader.conf(5)</a>:</p>
-<div class="Bd Pp Bd-indent Li">
-<pre>ntb_hw_intel_load=&quot;YES&quot;</pre>
-</div>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
-<p class="Pp">The <code class="Nm">ntb_hw_intel</code> driver provides support
- for the Non-Transparent Bridge (NTB) hardware in Intel Xeon E3/E5 and S1200
- processor families, which allow one of their PCIe ports to be switched from
- transparent to non-transparent bridge mode. In this mode the bridge looks
- not like a PCI bridge, but like a PCI endpoint device. The driver hides
- hardware details, exposing memory windows, scratchpads and doorbells of the
- other side via a hardware independent KPI to the <a class="Xr">ntb(4)</a>
- subsystem.</p>
-<p class="Pp">The hardware provides 2 or 3 memory windows to the other system's
- memory, 16 scratchpad registers and 14, 31 or 34 doorbells to interrupt the
- other system, depending on the platform. On Xeon processors one of the
- memory windows is typically consumed by the driver itself to work around
- multiple hardware errata.</p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="CONFIGURATION"><a class="permalink" href="#CONFIGURATION">CONFIGURATION</a></h1>
-<p class="Pp">The NTB configuration should be set by BIOS. It includes enabling
- NTB, choosing between NTB-to-NTB (back-to-back) or NTB-to-Root Port mode,
- enabling split BAR mode (one of two 64-bit BARs can be split into two 32-bit
- ones) and configuring BAR sizes in bits (from 12 to 29/39) for both NTB
- sides.</p>
-<p class="Pp">The recommended configuration is NTB-to-NTB mode, split bar
- enabled and all BAR sizes set to 20 (1 MiB). This needs to be done on both
- systems. Note, on Xeon SkyLake and newer platforms, split bar mode is not
- available.</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">if_ntb(4)</a>, <a class="Xr">ntb(4)</a>,
- <a class="Xr">ntb_transport(4)</a></p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
-<p class="Pp">The <code class="Nm">ntb_hw_intel</code> driver was developed by
- Intel and originally written by <span class="An">Carl Delsey</span>
- &lt;<a class="Mt" href="mailto:carl@FreeBSD.org">carl@FreeBSD.org</a>&gt;.
- Later improvements were done by <span class="An">Conrad E. Meyer</span>
- &lt;<a class="Mt" href="mailto:cem@FreeBSD.org">cem@FreeBSD.org</a>&gt; and
- <span class="An">Alexander Motin</span>
- &lt;<a class="Mt" href="mailto:mav@FreeBSD.org">mav@FreeBSD.org</a>&gt;.</p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1>
-<p class="Pp">NTB-to-Root Port mode is not yet supported, but it doesn't look
- very useful.</p>
-<p class="Pp">On Xeon v2/v3/v4 processors split BAR mode should be enabled to
- allow SB01BASE_LOCKUP errata workaround to be applied by the driver.</p>
-<p class="Pp">There is no way to protect your system from malicious behavior on
- the other system once the link is brought up. Anyone with root or kernel
- access on the other system can read or write to any location on your system.
- In other words, only connect two systems that completely trust each
- other.</p>
-</section>
-</div>
-<table class="foot">
- <tr>
- <td class="foot-date">October 11, 2020</td>
- <td class="foot-os">FreeBSD 15.0</td>
- </tr>
-</table>