share/man/man4/armv8crypto.4

   1 .\" Copyright (c) 2016 The FreeBSD Foundation
   2 .\" All rights reserved.
   3 .\"
   4 .\" This software was developed by Andrew Turner under
   5 .\" sponsorship from the FreeBSD Foundation.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd October 20, 2016
  31 .Dt ARMV8CRYPTO 4
  32 .Os
  33 .Sh NAME
  34 .Nm armv8crypto
  35 .Nd "driver for the AES accelerator on ARM CPUs"
  36 .Sh SYNOPSIS
  37 To compile this driver into the kernel,
  38 place the following lines in your
  39 kernel configuration file:
  40 .Bd -ragged -offset indent
  41 .Cd "device crypto"
  42 .Cd "device armv8crypto"
  43 .Ed
  44 .Pp
  45 Alternatively, to load the driver as a
  46 module at boot time, place the following line in
  47 .Xr loader.conf 5 :
  48 .Bd -literal -offset indent
  49 armv8crypto_load="YES"
  50 .Ed
  51 .Sh DESCRIPTION
  52 Starting with the ARMv8 architecture ARM Limited has added optional
  53 cryptography instructions to accelerate AES, SHA-1, SHA-2, and
  54 finite field arithmetic.
  55 .Pp
  56 The processor capability is reported as AES in the Instruction Set
  57 Attributes 0 line at boot.
  58 The
  59 .Nm
  60 driver does not attach on systems that lack the required CPU capability.
  61 .Pp
  62 The
  63 .Nm
  64 driver registers itself to accelerate AES operations for
  65 .Xr crypto 4 .
  66 .Sh SEE ALSO
  67 .Xr crypt 3 ,
  68 .Xr crypto 4 ,
  69 .Xr intro 4 ,
  70 .Xr ipsec 4 ,
  71 .Xr random 4 ,
  72 .Xr crypto 9
  73 .Sh HISTORY
  74 The
  75 .Nm
  76 driver first appeared in
  77 .Fx 11.0 .
  78 .Sh AUTHORS
  79 .An -nosplit
  80 The
  81 .Nm
  82 driver was written by
  83 .An Andrew Turner Aq Mt andrew@FreeBSD.org .