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
|
<table class="head">
<tr>
<td class="head-ltitle">QAT_C2XXX(4)</td>
<td class="head-vol">Device Drivers Manual</td>
<td class="head-rtitle">QAT_C2XXX(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_c2xxx</code> — <span class="Nd">Intel
QuickAssist Technology (QAT) driver for Atom C2000 chipsets</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 lines
in your kernel configuration file:</p>
<div class="Bd Pp Bd-indent"><code class="Cd">device crypto</code>
<br/>
<code class="Cd">device cryptodev</code>
<br/>
<code class="Cd">device qat</code></div>
<p class="Pp">Alternatively, to load the driver as a module at boot time, place
the following lines in <a class="Xr">loader.conf(5)</a>:</p>
<div class="Bd Pp Bd-indent Li">
<pre>qat_c2xxx_load="YES"
qat_c2xxxfw_load="YES"</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">qat_c2xxx</code> driver implements
<a class="Xr">crypto(4)</a> support for some of the cryptographic
acceleration functions of the Intel QuickAssist (QAT) device found on Atom
C2000 devices. QAT devices are enumerated through PCIe and are thus visible
in <a class="Xr">pciconf(8)</a> output.</p>
<p class="Pp">The <code class="Nm">qat_c2xxx</code> driver can accelerate AES in
CBC, CTR, and GCM modes, and can perform authenticated encryption combining
the CBC, and CTR modes with SHA1-HMAC and SHA2-HMAC. The
<code class="Nm">qat_c2xxx</code> driver can also compute SHA1 and SHA2
digests. The implementation of AES-GCM has a firmware-imposed constraint
that the length of any additional authenticated data (AAD) must not exceed
240 bytes. The driver thus rejects <a class="Xr">crypto(9)</a> requests that
do not satisfy this constraint.</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">crypto(4)</a>, <a class="Xr">ipsec(4)</a>,
<a class="Xr">pci(4)</a>, <a class="Xr">qat(4)</a>,
<a class="Xr">random(4)</a>, <a class="Xr">crypto(7)</a>,
<a class="Xr">crypto(9)</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">qat_c2xxx</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">The <code class="Nm">qat_c2xxx</code> driver was written for
<span class="Ux">NetBSD</span> by <span class="An">Hikaru Abe</span>
<<a class="Mt" href="mailto:hikaru@iij.ad.jp">hikaru@iij.ad.jp</a>>.
<br/>
<span class="An">Mark Johnston</span>
<<a class="Mt" href="mailto:markj@FreeBSD.org">markj@FreeBSD.org</a>>
ported the driver to <span class="Ux">FreeBSD</span>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1>
<p class="Pp">Some Atom C2000 QAT devices have two acceleration engines instead
of one. The <code class="Nm">qat_c2xxx</code> driver currently misbehaves
when both are enabled and thus does not enable the second acceleration
engine if one is present.</p>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">July 21, 2022</td>
<td class="foot-os">FreeBSD 15.0</td>
</tr>
</table>
|
