share/man/man4/safexcel.4

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