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