1.\"- 2.\" Copyright (c) 2020 Rubicon Communications, LLC (Netgate) 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 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. 12.\" 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 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" 27.Dd May 7, 2021 28.Dt QAT 4 29.Os 30.Sh NAME 31.Nm qat 32.Nd Intel QuickAssist Technology (QAT) driver 33.Sh SYNOPSIS 34To compile this driver into the kernel, 35place the following lines in your 36kernel configuration file: 37.Bd -ragged -offset indent 38.Cd "device crypto" 39.Cd "device cryptodev" 40.Cd "device qat" 41.Ed 42.Pp 43Alternatively, to load the driver as a 44module at boot time, place the following lines in 45.Xr loader.conf 5 : 46.Bd -literal -offset indent 47qat_load="YES" 48qat_c2xxxfw_load="YES" 49qat_c3xxxfw_load="YES" 50qat_c62xfw_load="YES" 51qat_d15xxfw_load="YES" 52qat_dh895xccfw_load="YES" 53.Ed 54.Sh DESCRIPTION 55The 56.Nm 57driver implements 58.Xr crypto 4 59support for some of the cryptographic acceleration functions of the Intel 60QuickAssist (QAT) device. 61The 62.Nm 63driver supports the QAT devices integrated with Atom C2000 and C3000 and Xeon 64C620 and D-1500 platforms, and the Intel QAT Adapter 8950. 65Other platforms and adapters not listed here may also be supported. 66QAT devices are enumerated through PCIe and are thus visible in 67.Xr pciconf 8 68output. 69.Pp 70The 71.Nm 72driver can accelerate AES in CBC, CTR, XTS (except for the C2000) and GCM modes, 73and can perform authenticated encryption combining the CBC, CTR and XTS modes 74with SHA1-HMAC and SHA2-HMAC. 75The 76.Nm 77driver can also compute SHA1 and SHA2 digests. 78The implementation of AES-GCM has a firmware-imposed constraint that the length 79of any additional authenticated data (AAD) must not exceed 240 bytes. 80The driver thus rejects 81.Xr crypto 9 82requests that do not satisfy this constraint. 83.Sh SEE ALSO 84.Xr crypto 4 , 85.Xr ipsec 4 , 86.Xr pci 4 , 87.Xr random 4 , 88.Xr crypto 7 , 89.Xr crypto 9 90.Sh HISTORY 91The 92.Nm 93driver first appeared in 94.Fx 13.0 . 95.Sh AUTHORS 96The 97.Nm 98driver was written for 99.Nx 100by 101.An Hikaru Abe Aq Mt hikaru@iij.ad.jp . 102.An Mark Johnston Aq Mt markj@FreeBSD.org 103ported the driver to 104.Fx . 105.Sh BUGS 106Some Atom C2000 QAT devices have two acceleration engines instead of one. 107The 108.Nm 109driver currently misbehaves when both are enabled and thus does not enable 110the second acceleration engine if one is present. 111