xref: /freebsd/share/man/man4/safexcel.4 (revision 26eeda7bd65603cdc6ff764349f55416b9766b43)
1.\"
2.\" SPDX-License-Identifier: BSD-2-Clause
3.\"
4.\" Copyright (c) 2020 Rubicon Communications, LLC (Netgate)
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 AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.Dd November 22, 2024
28.Dt SAFEXCEL 4
29.Os
30.Sh NAME
31.Nm safexcel
32.Nd Inside Secure SafeXcel-IP-97 cryptographic offload engine
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 crypto"
39.Cd "device cryptodev"
40.Cd "device safexcel"
41.Ed
42.Pp
43Alternatively, to load the driver as a
44module at boot time, place the following line in
45.Xr loader.conf 5 :
46.Bd -literal -offset indent
47safexcel_load="YES"
48.Ed
49.Sh DESCRIPTION
50The
51.Nm
52driver implements
53.Xr crypto 4
54support for the cryptographic acceleration functions of the EIP-97 device
55found on some Marvell systems-on-chip.
56The driver can accelerate the following AES modes:
57.Pp
58.Bl -bullet -compact
59.It
60AES-CBC
61.It
62AES-CTR
63.It
64AES-XTS
65.It
66AES-GCM
67.It
68AES-CCM
69.El
70.Pp
71.Nm
72also implements SHA1 and SHA2 transforms, and can combine AES-CBC and AES-CTR
73with SHA1-HMAC and SHA2-HMAC for encrypt-then-authenticate operations.
74.Sh HARDWARE
75The
76.Nm
77driver supports the cryptographic acceleration functions of the
78Inside Secure EIP-97 device found on some Marvell systems-on-chip.
79.Sh SEE ALSO
80.Xr crypto 4 ,
81.Xr ipsec 4 ,
82.Xr random 4 ,
83.Xr crypto 7 ,
84.Xr geli 8 ,
85.Xr crypto 9
86.Sh HISTORY
87The
88.Nm
89driver first appeared in
90.Fx 13.0 .
91