[src/trunk]: src add a man page for sun8icrypto(4)

[nia <nia%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/543749e9ceaf
branches:  trunk
changeset: 378897:543749e9ceaf
user:      nia <nia%NetBSD.org@localhost>
date:      Tue Apr 27 21:13:38 2021 +0000

description:
add a man page for sun8icrypto(4)

diffstat:

 distrib/sets/lists/man/mi                |    5 +-
 share/man/man4/man4.evbarm/Makefile      |    4 +-
 share/man/man4/man4.evbarm/sun8icrypto.4 |  109 +++++++++++++++++++++++++++++++
 3 files changed, 115 insertions(+), 3 deletions(-)

diffs (159 lines):

diff -r ba631f3cb7e7 -r 543749e9ceaf distrib/sets/lists/man/mi
--- a/distrib/sets/lists/man/mi Tue Apr 27 20:31:01 2021 +0000
+++ b/distrib/sets/lists/man/mi Tue Apr 27 21:13:38 2021 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: mi,v 1.1717 2021/04/01 00:03:01 riastradh Exp $
+# $NetBSD: mi,v 1.1718 2021/04/27 21:13:38 nia Exp $
 #
 # Note: don't delete entries from here - mark them as "obsolete" instead.
 #
@@ -1107,6 +1107,7 @@
 ./usr/share/man/cat4/evbarm/iopaau.0           man-sys-catman          .cat
 ./usr/share/man/cat4/evbarm/iopwdog.0          man-sys-catman          .cat
 ./usr/share/man/cat4/evbarm/rktsadc.0          man-sys-catman          .cat
+./usr/share/man/cat4/evbarm/sun8icrypto.0      man-sys-catman          .cat
 ./usr/share/man/cat4/evbarm/vcaudio.0          man-sys-catman          .cat
 ./usr/share/man/cat4/evbarm/vchiq.0            man-sys-catman          .cat
 ./usr/share/man/cat4/evbmips/aupci.0           man-sys-catman          .cat
@@ -4336,6 +4337,7 @@
 ./usr/share/man/html4/evbarm/iopaau.html       man-sys-htmlman         html
 ./usr/share/man/html4/evbarm/iopwdog.html      man-sys-htmlman         html
 ./usr/share/man/html4/evbarm/rktsadc.html      man-sys-htmlman         html
+./usr/share/man/html4/evbarm/sun8icrypto.html  man-sys-htmlman         html
 ./usr/share/man/html4/evbarm/vcaudio.html      man-sys-htmlman         html
 ./usr/share/man/html4/evbarm/vchiq.html                man-sys-htmlman         html
 ./usr/share/man/html4/evbmips/aupci.html       man-sys-htmlman         html
@@ -7338,6 +7340,7 @@
 ./usr/share/man/man4/evbarm/iopaau.4           man-sys-man             .man
 ./usr/share/man/man4/evbarm/iopwdog.4          man-sys-man             .man
 ./usr/share/man/man4/evbarm/rktsadc.4          man-sys-man             .man
+./usr/share/man/man4/evbarm/sun8icrypto.4      man-sys-man             .man
 ./usr/share/man/man4/evbarm/vcaudio.4          man-sys-man             .man
 ./usr/share/man/man4/evbarm/vchiq.4            man-sys-man             .man
 ./usr/share/man/man4/evbmips/aupci.4           man-sys-man             .man
diff -r ba631f3cb7e7 -r 543749e9ceaf share/man/man4/man4.evbarm/Makefile
--- a/share/man/man4/man4.evbarm/Makefile       Tue Apr 27 20:31:01 2021 +0000
+++ b/share/man/man4/man4.evbarm/Makefile       Tue Apr 27 21:13:38 2021 +0000
@@ -1,7 +1,7 @@
-#      $NetBSD: Makefile,v 1.11 2021/02/26 10:33:46 nia Exp $
+#      $NetBSD: Makefile,v 1.12 2021/04/27 21:13:38 nia Exp $
 
 MAN=   awge.4 bcmgpio.4 cpsw.4 epgpio.4 gxio.4 intro.4 iopaau.4 iopwdog.4 \
-       rktsadc.4 vcaudio.4 vchiq.4
+       rktsadc.4 sun8icrypto.4 vcaudio.4 vchiq.4
 
 MANSUBDIR=/evbarm
 
diff -r ba631f3cb7e7 -r 543749e9ceaf share/man/man4/man4.evbarm/sun8icrypto.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/man4.evbarm/sun8icrypto.4  Tue Apr 27 21:13:38 2021 +0000
@@ -0,0 +1,109 @@
+.\" $NetBSD: sun8icrypto.4,v 1.1 2021/04/27 21:13:38 nia Exp $
+.\"
+.\" Copyright (c) 2021 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
+.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+.\" POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd April 25, 2021
+.Dt SUN8ICRYPTO 4
+.Os
+.Sh NAME
+.Nm sun8icrypto
+.Nd driver for Allwinner Crypto Engine
+.Sh SYNOPSIS
+.Cd "sun8icrypto* at fdt?"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for the cryptographic processors on Allwinner
+A64 and H5 systems-on-a-chip.
+The Allwinner Crypto Engine is the successor to the earlier
+Allwinner Security System.
+.Pp
+The hardware includes a True Random Number Generator (TRNG) that is
+used as an entropy source for the
+.Xr rnd 4
+system, and implementations of various cryptographic algorithms
+that can be used with
+.Xr ipsec 4
+and
+.Xr crypto 4 .
+.Pp
+The following
+.Xr opencrypto 9
+algorithms are supported:
+.Pp
+.Bl -bullet -compact -offset indent
+.It
+.Dv CRYPTO_AES_CBC
+.It
+.Dv CRYPTO_AES_CTR
+.It
+.Dv CRYPTO_AES_ECB
+.It
+.Dv CRYPTO_AES_XTS
+.It
+.Dv CRYPTO_DES_CBC
+.It
+.Dv CRYPTO_DES_ECB
+.It
+.Dv CRYPTO_3DES_CBC
+.It
+.Dv CRYPTO_3DES_ECB
+.It
+.Dv CRYPTO_MD5
+.It
+.Dv CRYPTO_SHA1
+.It
+.Dv CRYPTO_SHA224
+.It
+.Dv CRYPTO_SHA256
+.It
+.Dv CRYPTO_SHA1_HMAC
+.It
+.Dv CRYPTO_SHA2_256_HMAC
+.El
+.Sh SEE ALSO
+.Xr crypto 4 ,
+.Xr ipsec 4 ,
+.Xr rnd 4 ,
+.Xr entropy 7 ,
+.Xr opencrypto 9
+.Sh HISTORY
+The
+.Nm
+device driver first appeared in
+.Nx 9.1 .
+.Sh CAVEATS
+The
+.Nm
+TRNG's underlying source of randomness is not documented by Allwinner,
+so is not trusted as a reliable source of entropy.
+Initial tests using NIST's SP800-90B tools showed highly biased
+runs of output, suggesting any potential physical source is not
+subject to whitening.
+.Pp
+Cryptographic operations using
+.Nm
+are generally slower than using the CPU on supported devices, but provide
+an advantage in terms of hardware offloading if the CPU is busy.