2 .\" Copyright (c) 2020 Rubicon Communications, LLC (Netgate)
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd Intel QuickAssist Technology (QAT) driver
34 To compile this driver into the kernel,
35 place the following lines in your
36 kernel configuration file:
37 .Bd -ragged -offset indent
39 .Cd "device cryptodev"
43 Alternatively, to load the driver as a
44 module at boot time, place the following lines in
46 .Bd -literal -offset indent
48 qat_c2xxxfw_load="YES"
49 qat_c3xxxfw_load="YES"
51 qat_d15xxfw_load="YES"
52 qat_dh895xccfw_load="YES"
59 support for some of the cryptographic acceleration functions of the Intel
60 QuickAssist (QAT) device.
63 driver supports the QAT devices integrated with Atom C2000 and C3000 and Xeon
64 C620 and D-1500 platforms, and the Intel QAT Adapter 8950.
65 Other platforms and adapters not listed here may also be supported.
66 QAT devices are enumerated through PCIe and are thus visible in
72 driver can accelerate AES in CBC, CTR, XTS (except for the C2000) and GCM modes,
73 and can perform authenticated encryption combining the CBC, CTR and XTS modes
74 with SHA1-HMAC and SHA2-HMAC.
77 driver can also compute SHA1 and SHA2 digests.
78 The implementation of AES-GCM has a firmware-imposed constraint that the length
79 of any additional authenticated data (AAD) must not exceed 240 bytes.
80 The driver thus rejects
82 requests that do not satisfy this constraint.
93 driver first appeared in
98 driver was written for
101 .An Hikaru Abe Aq Mt hikaru@iij.ad.jp
105 .An Mark Johnston Aq Mt markj@FreeBSD.org .
107 Some Atom C2000 QAT devices have two acceleration engines instead of one.
110 driver currently misbehaves when both are enabled and thus does not enable
111 the second acceleration engine if one is present.