xref: /freebsd/share/man/man4/qat.4 (revision d5b0e70f7e04d971691517ce1304d86a1e367e2e)
1.\" SPDX-License-Identifier: BSD-3-Clause
2.\" Copyright(c) 2007-2022 Intel Corporation
3.\" $FreeBSD$
4.Dd June 30, 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_load="YES"
34.El
35.Sh DESCRIPTION
36The
37.Nm
38driver supports cryptography and compression acceleration of the
39Intel (R) QuickAssist Technology (QAT) devices.
40.Pp
41The
42.Nm
43driver is intended for platforms that contain:
44.Bl -bullet -compact
45.It
46Intel (R) C62x Chipset
47.It
48Intel (R) Atom C3000 processor product family
49.It
50Intel (R) QuickAssist Adapter 8960/Intel (R) QuickAssist Adapter 8970
51(formerly known as "Lewis Hill")
52.It
53Intel (R) Communications Chipset 8925 to 8955 Series
54.It
55Intel (R) Atom P5300 processor product family
56.El
57.Pp
58The
59.Nm
60driver supports cryptography and compression acceleration.
61A complete API for offloading these operations is exposed in the kernel and may
62be used by any other entity directly.
63For details of usage and supported operations and algorithms refer to the
64following documentation available from
65.Lk 01.org :
66.Bl -bullet -compact
67.It
68.Rs
69.%A Intel (R)
70.%T QuickAssist Technology API Programmer's Guide
71.Re
72.It
73.Rs
74.%A Intel (R)
75.%T QuickAssist Technology Cryptographic API Reference Manual
76.Re
77.It
78.Rs
79.%A Intel (R)
80.%T QuickAssist Technology Data Compression API Reference Manual
81.Re
82.It
83.Rs
84.%A Intel (R)
85.%T QuickAssist Technology Performance Optimization Guide
86.Re
87.El
88.Pp
89In addition to exposing complete kernel API for offloading cryptography and
90compression operations, the
91.Nm
92driver also integrates with
93.Xr crypto 4 ,
94allowing offloading supported cryptography operations to Intel (R) QuickAssist
95Technology (QAT) devices.
96For details of usage and supported operations and algorithms refer to the
97documentation mentioned above and
98.Sx SEE ALSO
99section.
100.Sh COMPATIBILITY
101The
102.Nm
103driver replaced previous implementation introduced in
104.Fx 13.0 .
105Current version, in addition to
106.Xr crypto 4
107integration, supports also data compression and exposes a complete API for
108offloading data compression and cryptography operations.
109.Sh SEE ALSO
110.Xr crypto 4 ,
111.Xr ipsec 4 ,
112.Xr pci 4 ,
113.Xr crypto 7 ,
114.Xr crypto 9
115.Sh HISTORY
116This
117.Nm
118driver was introduced in
119.Fx 14.0 .
120.Fx 13.0 included a different version of
121.Nm
122driver.
123.Sh AUTHORS
124The
125.Nm
126driver was written by
127.An Intel (R) Corporation .
128