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