xref: /freebsd/share/man/man4/ccr.4 (revision 35c0a8c449fd2b7f75029ebed5e10852240f0865)
1.\" Copyright (c) 2017, Chelsio Inc
2.\" All rights reserved.
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 November 25, 2024
26.Dt CCR 4
27.Os
28.Sh NAME
29.Nm ccr
30.Nd "Chelsio T6 crypto accelerator driver"
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 ccr"
37.Cd "device cxgbe"
38.Ed
39.Pp
40To load the driver as a
41module at boot time, place the following line in
42.Xr loader.conf 5 :
43.Bd -literal -offset indent
44ccr_load="YES"
45.Ed
46.Sh DESCRIPTION
47The
48.Nm
49driver provides support for the crypto accelerator engine included on
50PCI Express Ethernet adapters based on the Chelsio Terminator 6 ASIC (T6).
51The driver accelerates AES-CBC, AES-CCM, AES-CTR, AES-GCM, AES-XTS,
52SHA1, SHA2-224, SHA2-256, SHA2-384, SHA2-512,
53SHA1-HMAC, SHA2-224-HMAC, SHA2-256-HMAC, SHA2-384-HMAC, and SHA2-512-HMAC
54operations for
55.Xr crypto 9
56consumers such as
57.Xr ktls 4 ,
58.Xr geli 4 ,
59and
60.Xr ipsec 4 .
61The driver also supports chaining one of AES-CBC, AES-CTR, or AES-XTS with
62SHA1-HMAC, SHA2-224-HMAC, SHA2-256-HMAC, SHA2-384-HMAC, or SHA2-512-HMAC for
63encrypt-then-authenticate operations.
64For further hardware information and questions related to hardware
65requirements, see
66.Pa http://www.chelsio.com/ .
67.Pp
68The
69.Nm
70driver attaches as a child of an existing Chelsio NIC device and thus
71requires that the
72.Xr cxgbe 4
73driver be active.
74.Sh HARDWARE
75The
76.Nm
77driver supports the crypto accelerator engine included on adapters
78based on the T6 ASIC:
79.Pp
80.Bl -bullet -compact
81.It
82Chelsio T6225-CR
83.It
84Chelsio T6225-SO-CR
85.It
86Chelsio T62100-LP-CR
87.It
88Chelsio T62100-SO-CR
89.It
90Chelsio T62100-CR
91.El
92.Sh SUPPORT
93For general information and support,
94go to the Chelsio support website at:
95.Pa http://www.chelsio.com/ .
96.Pp
97If an issue is identified with this driver with a supported adapter,
98email all the specific information related to the issue to
99.Aq Mt support@chelsio.com .
100.Sh SEE ALSO
101.Xr crypto 4 ,
102.Xr cxgbe 4 ,
103.Xr geli 4 ,
104.Xr ipsec 4 ,
105.Xr ktls 4 ,
106.Xr crypto 7 ,
107.Xr crypto 9
108.Sh HISTORY
109The
110.Nm
111device driver first appeared in
112.Fx 12.0 .
113.Sh AUTHORS
114.An -nosplit
115The
116.Nm
117driver was written by
118.An John Baldwin Aq Mt jhb@FreeBSD.org .
119