xref: /freebsd/share/man/man4/man4.aarch64/armv8crypto.4 (revision e32fecd0c2c3ee37c47ee100f169e7eb0282a873)
1.\" Copyright (c) 2016 The FreeBSD Foundation
2.\"
3.\" This software was developed by Andrew Turner under
4.\" sponsorship from the FreeBSD Foundation.
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.\" $FreeBSD$
28.\"
29.Dd July 29, 2020
30.Dt ARMV8CRYPTO 4
31.Os
32.Sh NAME
33.Nm armv8crypto
34.Nd "driver for the AES accelerator on ARM CPUs"
35.Sh SYNOPSIS
36To compile this driver into the kernel,
37place the following lines in your
38kernel configuration file:
39.Bd -ragged -offset indent
40.Cd "device crypto"
41.Cd "device armv8crypto"
42.Ed
43.Pp
44Alternatively, to load the driver as a
45module at boot time, place the following line in
46.Xr loader.conf 5 :
47.Bd -literal -offset indent
48armv8crypto_load="YES"
49.Ed
50.Sh DESCRIPTION
51Starting with the ARMv8 architecture ARM Limited has added optional
52cryptography instructions to accelerate AES, SHA-1, SHA-2, and
53finite field arithmetic.
54.Pp
55The processor capability is reported as AES in the Instruction Set
56Attributes 0 line at boot.
57The
58.Nm
59driver does not attach on systems that lack the required CPU capability.
60.Pp
61The
62.Nm
63driver registers itself to accelerate AES operations for
64.Xr crypto 4 .
65.Sh SEE ALSO
66.Xr crypt 3 ,
67.Xr crypto 4 ,
68.Xr intro 4 ,
69.Xr ipsec 4 ,
70.Xr random 4 ,
71.Xr crypto 7 ,
72.Xr crypto 9
73.Sh HISTORY
74The
75.Nm
76driver first appeared in
77.Fx 11.0 .
78.Sh AUTHORS
79.An -nosplit
80The
81.Nm
82driver was written by
83.An Andrew Turner Aq Mt andrew@FreeBSD.org .
84