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