diff options
Diffstat (limited to 'static/freebsd/man4/qat.4 3.html')
| -rw-r--r-- | static/freebsd/man4/qat.4 3.html | 174 |
1 files changed, 0 insertions, 174 deletions
diff --git a/static/freebsd/man4/qat.4 3.html b/static/freebsd/man4/qat.4 3.html deleted file mode 100644 index 5d4a0a9f..00000000 --- a/static/freebsd/man4/qat.4 3.html +++ /dev/null @@ -1,174 +0,0 @@ -<table class="head"> - <tr> - <td class="head-ltitle">QAT(4)</td> - <td class="head-vol">Device Drivers Manual</td> - <td class="head-rtitle">QAT(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">qat</code> — <span class="Nd">Intel - QuickAssist Technology driver</span></p> -</section> -<section class="Sh"> -<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> -<p class="Pp">To load the driver call:</p> -<p class="Pp"></p> -<ul class="Bl-item Bl-compact"> - <li>kldload qat</li> -</ul> -<p class="Pp">In order to load the driver on boot add these lines to - <a class="Xr">loader.conf(5)</a> selecting firmware(s) suitable for - installed device(s)</p> -<p class="Pp"></p> -<ul class="Bl-item Bl-compact"> - <li>qat_200xx_fw_load="YES"</li> - <li>qat_c3xxx_fw_load="YES"</li> - <li>qat_c4xxx_fw_load="YES"</li> - <li>qat_c62x_fw_load="YES"</li> - <li>qat_dh895xcc_fw_load="YES"</li> - <li>qat_4xxx_fw_load="YES"</li> - <li>qat_load="YES"</li> -</ul> -</section> -<section class="Sh"> -<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> -<p class="Pp">The <code class="Nm">qat</code> driver supports cryptography and - compression acceleration of the Intel (R) QuickAssist Technology (QAT) - devices.</p> -<p class="Pp">A complete API for offloading these operations is exposed in the - kernel and may be used by any other entity directly. In addition to exposing - a complete kernel API for offloading cryptography and compression - operations, the <code class="Nm">qat</code> driver also integrates with - <a class="Xr">crypto(4)</a>, allowing offloading supported operations to - Intel QuickAssist Technology devices.</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1> -<p class="Pp">The <code class="Nm">qat</code> driver supports the following - Intel QuickAssist Technology Engines:</p> -<p class="Pp"></p> -<ul class="Bl-bullet Bl-compact"> - <li>Intel (R) C62x Chipset</li> - <li>Intel (R) Atom C3000 processor product family</li> - <li>Intel (R) QuickAssist Adapter 8960/Intel (R) QuickAssist Adapter 8970 - (formerly known as "Lewis Hill")</li> - <li>Intel (R) Communications Chipset 8925 to 8955 Series</li> - <li>Intel (R) Atom P5300 processor product family</li> - <li>Intel (R) QAT 4xxx Series</li> -</ul> -</section> -<section class="Sh"> -<h1 class="Sh" id="SYSCTL_VARIABLES"><a class="permalink" href="#SYSCTL_VARIABLES">SYSCTL_VARIABLES</a></h1> -<p class="Pp">The following <a class="Xr">sysctl(8)</a> variables may be used to - reconfigure the <code class="Nm">qat</code> device. For configuration - persistence those variables may be set before loading the driver, either via - <a class="Xr">kenv(1)</a> or <a class="Xr">loader.conf(5)</a>.</p> -<p class="Pp">The specific device needs to be in the "down" state - before changing the configuration.</p> -<dl class="Bl-tag"> - <dt id="dev.qat.X.state"><var class="Va">dev.qat.X.state</var></dt> - <dd>Show or set current state of the device. Possible values: - "down", "up". - <p class="Pp" id="qat_ocf">NOTE: If the symmetric services are used for - device the - <a class="permalink" href="#qat_ocf"><b class="Sy">qat_ocf</b></a> - driver needs to be disabled prior the device reconfiguration.</p> - </dd> - <dt id="dev.qat_ocf.0.enable"><var class="Va">dev.qat_ocf.0.enable</var></dt> - <dd>Enable/disable the QAT cryptographic framework connectivity. Enabled by - default.</dd> - <dt id="dev.qat.X.cfg_services"><var class="Va">dev.qat.X.cfg_services</var></dt> - <dd>Override the device services enabled, may be one of: symmetric, - asymmetric, data compression. Possible values: "sym", - "asym", "dc", "sym;dc", "asym;dc", - "sym;asym". Default services configured are "sym;asym" - for even and "dc" for odd devices.</dd> - <dt id="dev.qat.X.cfg_mode"><var class="Va">dev.qat.X.cfg_mode</var></dt> - <dd>Override the device mode configuration for kernel space and user space - instances. Possible values: "ks", "us", - "ks;us". Default value "ks;us".</dd> - <dt id="dev.qat.X.num_user_processes"><var class="Va">dev.qat.X.num_user_processes</var></dt> - <dd>Override the number of uio user space processes that can connect to the - QAT device. Default: 2</dd> - <dt id="dev.qat.X.disable_safe_dc_mode"><var class="Va">dev.qat.X.disable_safe_dc_mode</var></dt> - <dd>Override history buffer mitigation. Disabled by default. If enabled, - decompression throughput increases but may result in a data leak if - <var class="Va">dev.qat.X.num_user_processes</var> is more than 1. Enable - this option only if your system is not prone to user data leaks.</dd> -</dl> -<p class="Pp">The following <a class="Xr">sysctl(8)</a> variables are - read-only:</p> -<dl class="Bl-tag"> - <dt id="dev.qat.X.frequency"><var class="Va">dev.qat.X.frequency</var></dt> - <dd>QAT device frequency value.</dd> - <dt id="dev.qat.X.mmp_version"><var class="Va">dev.qat.X.mmp_version</var></dt> - <dd>QAT MMP Library revision number.</dd> - <dt id="dev.qat.X.hw_version"><var class="Va">dev.qat.X.hw_version</var></dt> - <dd>QAT hardware revision number.</dd> - <dt id="dev.qat.X.fw_version"><var class="Va">dev.qat.X.fw_version</var></dt> - <dd>QAT firmware revision number.</dd> - <dt id="dev.qat.X.dev_cfg"><var class="Va">dev.qat.X.dev_cfg</var></dt> - <dd>Summary of device specific configuration.</dd> - <dt id="dev.qat.X.heartbeat"><var class="Va">dev.qat.X.heartbeat</var></dt> - <dd>QAT device heartbeat status. Value '1' indicates that the device is - operational. Value '0' means that the device is not responsive. Device - requires restart.</dd> - <dt id="dev.qat.X.heartbeat_failed"><var class="Va">dev.qat.X.heartbeat_failed</var></dt> - <dd>Number of QAT heartbeat failures received.</dd> - <dt id="dev.qat.X.heartbeat_sent"><var class="Va">dev.qat.X.heartbeat_sent</var></dt> - <dd>Number of QAT heartbeat requests sent.</dd> -</dl> -</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">crypto(4)</a>, <a class="Xr">ipsec(4)</a>, - <a class="Xr">pci(4)</a>, <a class="Xr">crypto(7)</a>, - <a class="Xr">crypto(9)</a></p> -<p class="Pp">For details of usage and supported operations and algorithms refer - to the following documentation available from Intel Download Center - <a class="Lk" href="https://downloadcenter.intel.com">https://downloadcenter.intel.com</a>:</p> -<p class="Pp"></p> -<ul class="Bl-bullet Bl-compact"> - <li> - <p class="Pp"><cite class="Rs"><span class="RsA">Intel (R)</span>, - <span class="RsT">QuickAssist Technology API Programmer's - Guide</span>.</cite></p> - </li> - <li> - <p class="Pp"><cite class="Rs"><span class="RsA">Intel (R)</span>, - <span class="RsT">QuickAssist Technology Cryptographic API Reference - Manual</span>.</cite></p> - </li> - <li> - <p class="Pp"><cite class="Rs"><span class="RsA">Intel (R)</span>, - <span class="RsT">QuickAssist Technology Data Compression API Reference - Manual</span>.</cite></p> - </li> - <li> - <p class="Pp"><cite class="Rs"><span class="RsA">Intel (R)</span>, - <span class="RsT">QuickAssist Technology Performance Optimization - Guide</span>.</cite></p> - </li> -</ul> -</section> -<section class="Sh"> -<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> -<p class="Pp">A <code class="Nm">qat</code> driver appeared in - <span class="Ux">FreeBSD 13.0</span>. It was superseded in - <span class="Ux">FreeBSD 14.0</span> by the upstream driver.</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">qat</code> driver was written by - <span class="An">Intel (R) Corporation</span>.</p> -</section> -</div> -<table class="foot"> - <tr> - <td class="foot-date">June 2, 2025</td> - <td class="foot-os">FreeBSD 15.0</td> - </tr> -</table> |