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