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