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