From 583a7aaaab54926ebc161cad2b6ec07bc01ab140 Mon Sep 17 00:00:00 2001
From: Sascha Wildner <saw@online.de>
Date: Sun, 14 Feb 2010 23:06:19 +0100
Subject: [PATCH] Sync hifn(4) documentation with FreeBSD, too.

---
 share/man/man4/hifn.4 | 81 ++++++++++++++++++++++++-------------------
 1 file changed, 45 insertions(+), 36 deletions(-)

diff --git a/share/man/man4/hifn.4 b/share/man/man4/hifn.4
index d751e8d47a..55313261e7 100644
--- a/share/man/man4/hifn.4
+++ b/share/man/man4/hifn.4
@@ -1,6 +1,5 @@
 .\"	$OpenBSD: hifn.4,v 1.32 2002/09/26 07:55:40 miod Exp $
-.\"	$FreeBSD: src/share/man/man4/hifn.4,v 1.1.2.1 2002/11/21 23:57:24 sam Exp $
-.\"	$DragonFly: src/share/man/man4/hifn.4,v 1.6 2007/12/04 09:11:11 hasso Exp $
+.\"	$FreeBSD: src/share/man/man4/hifn.4,v 1.9 2009/10/19 14:36:12 brueffer Exp $
 .\"
 .\" Copyright (c) 2000 Theo de Raadt
 .\" All rights reserved.
@@ -13,8 +12,6 @@
 .\" 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.
-.\" 3. The name of the author may not be used to endorse or promote products
-.\"    derived from this software without specific prior written permission.
 .\"
 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
@@ -28,20 +25,58 @@
 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd November 21, 2002
+.Dd February 14, 2010
 .Dt HIFN 4
 .Os
 .Sh NAME
 .Nm hifn
 .Nd Hifn 7751/7951/7811/7955/7956 crypto accelerator
 .Sh SYNOPSIS
-.Cd device hifn
+To compile this driver into the kernel,
+place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
+.Cd "device crypto"
+.Cd "device cryptodev"
+.Cd "device hifn"
+.Ed
+.Pp
+Alternatively, to load the driver as a
+module at boot time, place the following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+hifn_load="YES"
+.Ed
 .Sh DESCRIPTION
 The
 .Nm
 driver supports various cards containing the Hifn 7751, 7951,
+7811, 7955, and 7956 chipsets.
+.Pp
+The
+.Nm
+driver registers itself to accelerate DES, Triple-DES,
+AES (7955 and 7956 only), ARC4, MD5,
+MD5-HMAC, SHA1, and SHA1-HMAC operations for
+.Xr ipsec 4
+and
+.Xr crypto 4 .
+.Pp
+The Hifn
+.Tn 7951 ,
+.Tn 7811 ,
+.Tn 7955 ,
+and
+.Tn 7956
+will also supply data to the kernel
+.Xr random 4
+subsystem.
+.Sh HARDWARE
+The
+.Nm
+driver supports various cards containing the Hifn 7751, 7951,
 7811, 7955, and 7956
-chipsets, such as
+chipsets, such as:
 .Bl -tag -width namenamenamena -offset indent
 .It Invertex AEON
 No longer being made.
@@ -49,17 +84,11 @@ Came as 128KB SRAM model, or 2MB DRAM model.
 .It Hifn 7751
 Reference board with 512KB SRAM.
 .It PowerCrypt
-See
-.Pa http://www.powercrypt.com/ .
 Comes with 512KB SRAM.
 .It XL-Crypt
-See
-.Pa http://www.powercrypt.com/ .
 Only board based on 7811 (which is faster than 7751 and has
 a random number generator).
 .It NetSec 7751
-See
-.Pa http://www.netsec.net/ .
 Supports the most IPsec sessions, with 1MB SRAM.
 .It Soekris Engineering vpn1201 and vpn1211
 See
@@ -70,25 +99,6 @@ See
 .Pa http://www.soekris.com/ .
 Contains a 7955 and supports symmetric and random number operations.
 .El
-.Pp
-The
-.Nm
-driver registers itself to accelerate DES, Triple-DES,
-AES (7955 and 7956 only), ARC4, MD5,
-MD5-HMAC, SHA1, and SHA1-HMAC operations for
-.Xr ipsec 4
-and
-.Xr crypto 4 .
-.Pp
-The Hifn
-.Tn 7951 ,
-.Tn 7811 ,
-.Tn 7955 ,
-and
-.Tn 7956
-will also supply data to the kernel
-.Xr random 4
-subsystem.
 .Sh SEE ALSO
 .Xr crypt 3 ,
 .Xr crypto 4 ,
@@ -97,13 +107,13 @@ subsystem.
 .Xr random 4 ,
 .Xr crypto 9
 .Sh CAVEATS
-The Hifn 9751 shares the same PCI id.
+The Hifn 9751 shares the same PCI ID.
 This chip is basically a 7751, but with the cryptographic functions missing.
 Instead, the 9751 is only capable of doing compression.
 Since we do not currently attempt to use any of these chips to do
 compression, the 9751-based cards are not useful.
 .Pp
-Support for the 7955 and 7956 is incomplete; the asymetric crypto
+Support for the 7955 and 7956 is incomplete; the asymmetric crypto
 facilities are to be added and the performance is suboptimal.
 .Sh HISTORY
 The
@@ -113,8 +123,7 @@ device driver appeared in
 The
 .Nm
 device driver was imported to
-.Fx
-in 5.0.
+.Fx 5.0 .
 .Sh BUGS
 The 7751 chip starts out at initialization by only supporting compression.
 A proprietary algorithm, which has been reverse engineered, is required to
-- 
2.41.0