xref: /netbsd-src/share/man/man4/qat.4 (revision 87bee1d0282418fa954c1037956c296d640039b9)
1.\"	$NetBSD: qat.4,v 1.1 2019/11/20 09:37:45 hikaru Exp $
2.\"
3.\" Copyright (c) 2019 Internet Initiative Japan, Inc.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
16.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
19.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25.\" POSSIBILITY OF SUCH DAMAGE.
26.\"
27.Dd November 20, 2019
28.Dt QAT 4
29.Os
30.Sh NAME
31.Nm qat
32.Nd Intel QuickAssist crypto accelerator
33.Sh SYNOPSIS
34.Cd "qat* at pci? dev ? function ?"
35.Sh DESCRIPTION
36The
37.Nm
38driver supports the following system-on-chips, chipsets, and PCIe adapters,
39which are integrated with QuickAssist:
40.Pp
41.Bl -bullet -compact
42.It
43Intel Atom C2000 processor
44.It
45Intel Atom C3000 processor
46.It
47Intel Xeon D-1500 processor
48.It
49Intel Xeon D-2100 processor
50.It
51Intel C620 chipset
52.It
53Intel QuickAssist Adapter 8960/8970
54.El
55.Pp
56When the
57.Nm
58driver is attached, it automatically registers itself to accelerate
59DES-CBC, 3DES-CBC, AES-CBC, HMAC-SHA1, HMAC-SHA256, HMAC-SHA384,
60and HMAC-SHA512 operations for
61.Xr opencrypto 9 ,
62and thus for
63.Xr ipsec 4
64and
65.Xr crypto 4 .
66.Sh FILES
67The
68.Nm
69driver loads the firmware which is located in
70.Pa /libdata/firmware/qat/ ,
71by
72.Xr firmload 9 .
73.Sh SEE ALSO
74.Xr crypto 4 ,
75.Xr intro 4 ,
76.Xr ipsec 4 ,
77.Xr firmload 9 ,
78.Xr opencrypto 9
79.Sh HISTORY
80The
81.Nm
82driver first appeared in
83.Nx 10.0 .
84.Sh AUTHORS
85The
86.Nm
87driver was written by
88.An Hikaru Abe Aq Mt hikaru@iij.ad.jp .
89