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 July 21, 2022 28.Dt QAT_C2XXX 4 29.Os 30.Sh NAME 31.Nm qat_c2xxx 32.Nd Intel QuickAssist Technology (QAT) driver for Atom C2000 chipsets 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_c2xxx_load="YES" 48qat_c2xxxfw_load="YES" 49.Ed 50.Sh DESCRIPTION 51The 52.Nm 53driver implements 54.Xr crypto 4 55support for some of the cryptographic acceleration functions of the Intel 56QuickAssist (QAT) device found on Atom C2000 devices. 57QAT devices are enumerated through PCIe and are thus visible in 58.Xr pciconf 8 59output. 60.Pp 61The 62.Nm 63driver can accelerate AES in CBC, CTR, and GCM modes, 64and can perform authenticated encryption combining the CBC, and CTR modes 65with SHA1-HMAC and SHA2-HMAC. 66The 67.Nm 68driver can also compute SHA1 and SHA2 digests. 69The implementation of AES-GCM has a firmware-imposed constraint that the length 70of any additional authenticated data (AAD) must not exceed 240 bytes. 71The driver thus rejects 72.Xr crypto 9 73requests that do not satisfy this constraint. 74.Sh SEE ALSO 75.Xr crypto 4 , 76.Xr ipsec 4 , 77.Xr pci 4 , 78.Xr qat 4 , 79.Xr random 4 , 80.Xr crypto 7 , 81.Xr crypto 9 82.Sh HISTORY 83The 84.Nm 85driver first appeared in 86.Fx 13.0 . 87.Sh AUTHORS 88The 89.Nm 90driver was written for 91.Nx 92by 93.An Hikaru Abe Aq Mt hikaru@iij.ad.jp . 94.An Mark Johnston Aq Mt markj@FreeBSD.org 95ported the driver to 96.Fx . 97.Sh BUGS 98Some Atom C2000 QAT devices have two acceleration engines instead of one. 99The 100.Nm 101driver currently misbehaves when both are enabled and thus does not enable 102the second acceleration engine if one is present. 103