xref: /freebsd/share/man/man4/safexcel.4 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1.\"-
2.\" Copyright (c) 2020 Rubicon Communications, LLC (Netgate)
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 July 29, 2020
26.Dt SAFEXCEL 4
27.Os
28.Sh NAME
29.Nm safexcel
30.Nd Inside Secure SafeXcel-IP-97 security packet engine
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 crypto"
37.Cd "device cryptodev"
38.Cd "device safexcel"
39.Ed
40.Pp
41Alternatively, to load the driver as a
42module at boot time, place the following line in
43.Xr loader.conf 5 :
44.Bd -literal -offset indent
45safexcel_load="YES"
46.Ed
47.Sh DESCRIPTION
48The
49.Nm
50driver implements
51.Xr crypto 4
52support for the cryptographic acceleration functions of the EIP-97 device
53found on some Marvell systems-on-chip.
54The driver can accelerate the following AES modes:
55.Pp
56.Bl -bullet -compact
57.It
58AES-CBC
59.It
60AES-CTR
61.It
62AES-XTS
63.It
64AES-GCM
65.It
66AES-CCM
67.El
68.Pp
69.Nm
70also implements SHA1 and SHA2 transforms, and can combine AES-CBC and AES-CTR
71with SHA1-HMAC and SHA2-HMAC for encrypt-then-authenticate operations.
72.Sh SEE ALSO
73.Xr crypto 4 ,
74.Xr ipsec 4 ,
75.Xr random 4 ,
76.Xr crypto 7 ,
77.Xr geli 8 ,
78.Xr crypto 9
79.Sh HISTORY
80The
81.Nm
82driver first appeared in
83.Fx 13.0 .
84