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