xref: /freebsd/share/man/man4/safexcel.4 (revision 26eeda7bd65603cdc6ff764349f55416b9766b43)
1*26eeda7bSAlexander Ziaee.\"
2*26eeda7bSAlexander Ziaee.\" SPDX-License-Identifier: BSD-2-Clause
3*26eeda7bSAlexander Ziaee.\"
4b356ddf0SMark Johnston.\" Copyright (c) 2020 Rubicon Communications, LLC (Netgate)
5b356ddf0SMark Johnston.\"
6b356ddf0SMark Johnston.\" Redistribution and use in source and binary forms, with or without
7b356ddf0SMark Johnston.\" modification, are permitted provided that the following conditions
8b356ddf0SMark Johnston.\" are met:
9b356ddf0SMark Johnston.\" 1. Redistributions of source code must retain the above copyright
10b356ddf0SMark Johnston.\"    notice, this list of conditions and the following disclaimer.
11b356ddf0SMark Johnston.\" 2. Redistributions in binary form must reproduce the above copyright
12b356ddf0SMark Johnston.\"    notice, this list of conditions and the following disclaimer in the
13b356ddf0SMark Johnston.\"    documentation and/or other materials provided with the distribution.
14b356ddf0SMark Johnston.\"
15b356ddf0SMark Johnston.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16b356ddf0SMark Johnston.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17b356ddf0SMark Johnston.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18b356ddf0SMark Johnston.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19b356ddf0SMark Johnston.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20b356ddf0SMark Johnston.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21b356ddf0SMark Johnston.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22b356ddf0SMark Johnston.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23b356ddf0SMark Johnston.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24b356ddf0SMark Johnston.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25b356ddf0SMark Johnston.\" SUCH DAMAGE.
26b356ddf0SMark Johnston.\"
27*26eeda7bSAlexander Ziaee.Dd November 22, 2024
28b356ddf0SMark Johnston.Dt SAFEXCEL 4
29b356ddf0SMark Johnston.Os
30b356ddf0SMark Johnston.Sh NAME
31b356ddf0SMark Johnston.Nm safexcel
32*26eeda7bSAlexander Ziaee.Nd Inside Secure SafeXcel-IP-97 cryptographic offload engine
33b356ddf0SMark Johnston.Sh SYNOPSIS
34b356ddf0SMark JohnstonTo compile this driver into the kernel,
35b356ddf0SMark Johnstonplace the following lines in your
36b356ddf0SMark Johnstonkernel configuration file:
37b356ddf0SMark Johnston.Bd -ragged -offset indent
38b356ddf0SMark Johnston.Cd "device crypto"
39b356ddf0SMark Johnston.Cd "device cryptodev"
40b356ddf0SMark Johnston.Cd "device safexcel"
41b356ddf0SMark Johnston.Ed
42b356ddf0SMark Johnston.Pp
43b356ddf0SMark JohnstonAlternatively, to load the driver as a
44b356ddf0SMark Johnstonmodule at boot time, place the following line in
45b356ddf0SMark Johnston.Xr loader.conf 5 :
46b356ddf0SMark Johnston.Bd -literal -offset indent
47b356ddf0SMark Johnstonsafexcel_load="YES"
48b356ddf0SMark Johnston.Ed
49b356ddf0SMark Johnston.Sh DESCRIPTION
50b356ddf0SMark JohnstonThe
51b356ddf0SMark Johnston.Nm
52b356ddf0SMark Johnstondriver implements
53b356ddf0SMark Johnston.Xr crypto 4
54b356ddf0SMark Johnstonsupport for the cryptographic acceleration functions of the EIP-97 device
55b356ddf0SMark Johnstonfound on some Marvell systems-on-chip.
56b356ddf0SMark JohnstonThe driver can accelerate the following AES modes:
57b356ddf0SMark Johnston.Pp
58b356ddf0SMark Johnston.Bl -bullet -compact
59b356ddf0SMark Johnston.It
60b356ddf0SMark JohnstonAES-CBC
61b356ddf0SMark Johnston.It
62b356ddf0SMark JohnstonAES-CTR
63b356ddf0SMark Johnston.It
64b356ddf0SMark JohnstonAES-XTS
65b356ddf0SMark Johnston.It
66b356ddf0SMark JohnstonAES-GCM
67b356ddf0SMark Johnston.It
68b356ddf0SMark JohnstonAES-CCM
69b356ddf0SMark Johnston.El
70b356ddf0SMark Johnston.Pp
71b356ddf0SMark Johnston.Nm
72b356ddf0SMark Johnstonalso implements SHA1 and SHA2 transforms, and can combine AES-CBC and AES-CTR
73b356ddf0SMark Johnstonwith SHA1-HMAC and SHA2-HMAC for encrypt-then-authenticate operations.
74*26eeda7bSAlexander Ziaee.Sh HARDWARE
75*26eeda7bSAlexander ZiaeeThe
76*26eeda7bSAlexander Ziaee.Nm
77*26eeda7bSAlexander Ziaeedriver supports the cryptographic acceleration functions of the
78*26eeda7bSAlexander ZiaeeInside Secure EIP-97 device found on some Marvell systems-on-chip.
79b356ddf0SMark Johnston.Sh SEE ALSO
80b356ddf0SMark Johnston.Xr crypto 4 ,
81b356ddf0SMark Johnston.Xr ipsec 4 ,
82b356ddf0SMark Johnston.Xr random 4 ,
8340326c17SJohn-Mark Gurney.Xr crypto 7 ,
84b356ddf0SMark Johnston.Xr geli 8 ,
85b356ddf0SMark Johnston.Xr crypto 9
86b356ddf0SMark Johnston.Sh HISTORY
87b356ddf0SMark JohnstonThe
88b356ddf0SMark Johnston.Nm
89b356ddf0SMark Johnstondriver first appeared in
90b356ddf0SMark Johnston.Fx 13.0 .
91