xref: /freebsd/share/man/man4/qat.4 (revision 3c4ba5f55438f7afd4f4b0b56f88f2bb505fd6a6)
1.\" SPDX-License-Identifier: BSD-3-Clause
2.\" Copyright(c) 2007-2022 Intel Corporation
3.\" $FreeBSD$
4.Dd September 1, 2022
5.Dt QAT 4
6.Os
7.Sh NAME
8.Nm qat
9.Nd Intel (R) QuickAssist Technology (QAT) driver
10.Sh SYNOPSIS
11To load the driver call:
12.Pp
13.Bl -item -compact
14.It
15kldload qat
16.El
17.Pp
18In order to load the driver on boot add these lines to
19.Xr loader.conf 5 selecting firmware(s) suitable for installed device(s)
20.Pp
21.Bl -item -compact
22.It
23qat_200xx_fw_load="YES"
24.It
25qat_c3xxx_fw_load="YES"
26.It
27qat_c4xxx_fw_load="YES"
28.It
29qat_c62x_fw_load="YES"
30.It
31qat_dh895xcc_fw_load="YES"
32.It
33qat_4xxx_fw_load="YES"
34.It
35qat_load="YES"
36.El
37.Sh DESCRIPTION
38The
39.Nm
40driver supports cryptography and compression acceleration of the
41Intel (R) QuickAssist Technology (QAT) devices.
42.Pp
43The
44.Nm
45driver is intended for platforms that contain:
46.Bl -bullet -compact
47.It
48Intel (R) C62x Chipset
49.It
50Intel (R) Atom C3000 processor product family
51.It
52Intel (R) QuickAssist Adapter 8960/Intel (R) QuickAssist Adapter 8970
53(formerly known as "Lewis Hill")
54.It
55Intel (R) Communications Chipset 8925 to 8955 Series
56.It
57Intel (R) Atom P5300 processor product family
58.It
59Intel (R) QAT 4xxx Series
60.El
61.Pp
62The
63.Nm
64driver supports cryptography and compression acceleration.
65A complete API for offloading these operations is exposed in the kernel and may
66be used by any other entity directly.
67For details of usage and supported operations and algorithms refer to the
68following documentation available from
69.Lk 01.org :
70.Bl -bullet -compact
71.It
72.Rs
73.%A Intel (R)
74.%T QuickAssist Technology API Programmer's Guide
75.Re
76.It
77.Rs
78.%A Intel (R)
79.%T QuickAssist Technology Cryptographic API Reference Manual
80.Re
81.It
82.Rs
83.%A Intel (R)
84.%T QuickAssist Technology Data Compression API Reference Manual
85.Re
86.It
87.Rs
88.%A Intel (R)
89.%T QuickAssist Technology Performance Optimization Guide
90.Re
91.El
92.Pp
93In addition to exposing complete kernel API for offloading cryptography and
94compression operations, the
95.Nm
96driver also integrates with
97.Xr crypto 4 ,
98allowing offloading supported cryptography operations to Intel (R) QuickAssist
99Technology (QAT) devices.
100For details of usage and supported operations and algorithms refer to the
101documentation mentioned above and
102.Sx SEE ALSO
103section.
104.Sh COMPATIBILITY
105The
106.Nm
107driver replaced previous implementation introduced in
108.Fx 13.0 .
109Current version, in addition to
110.Xr crypto 4
111integration, supports also data compression and exposes a complete API for
112offloading data compression and cryptography operations.
113.Sh SEE ALSO
114.Xr crypto 4 ,
115.Xr ipsec 4 ,
116.Xr pci 4 ,
117.Xr crypto 7 ,
118.Xr crypto 9
119.Sh HISTORY
120This
121.Nm
122driver was introduced in
123.Fx 14.0 .
124.Fx 13.0 included a different version of
125.Nm
126driver.
127.Sh AUTHORS
128The
129.Nm
130driver was written by
131.An Intel (R) Corporation .
132