xref: /dragonfly/share/man/man4/hifn.4 (revision 984263bc)
1.\"	$OpenBSD: hifn.4,v 1.32 2002/09/26 07:55:40 miod Exp $
2.\"	$FreeBSD: src/share/man/man4/hifn.4,v 1.1.2.1 2002/11/21 23:57:24 sam Exp $
3.\"
4.\" Copyright (c) 2000 Theo de Raadt
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. The name of the author may not be used to endorse or promote products
16.\"    derived from this software without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21.\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
22.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
27.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd November 21, 2002
31.Dt HIFN 4
32.Os
33.Sh NAME
34.Nm hifn
35.Nd Hifn 7751/7951/7811 crypto accelerator
36.Sh SYNOPSIS
37.Nm device hifn
38.Sh DESCRIPTION
39The
40.Nm
41driver supports various cards containing the Hifn 7751, Hifn 7951, or
42Hifn 7811
43chipsets, such as
44.Bl -tag -width namenamenamena -offset indent
45.It Invertex AEON
46No longer being made.
47Came as 128KB SRAM model, or 2MB DRAM model.
48.It Hifn 7751
49Reference board with 512KB SRAM.
50.It PowerCrypt
51See
52.Pa http://www.powercrypt.com/ .
53Comes with 512KB SRAM.
54.It XL-Crypt
55See
56.Pa http://www.powercrypt.com/ .
57Only board based on 7811 (which is faster than 7751 and has
58a random number generator).
59.It NetSec 7751
60See
61.Pa http://www.netsec.net/ .
62Supports the most IPsec sessions, with 1MB SRAM.
63.It Soekris Engineering vpn1201 and vpn1211
64See
65.Pa http://www.soekris.com/ .
66Contains a 7951 and supports symmetric and random number operations.
67.El
68.Pp
69The
70.Nm
71driver registers itself to accelerate DES, Triple-DES, ARC4, MD5,
72MD5-HMAC, SHA1, and SHA1-HMAC operations for
73.Xr ipsec 4
74and
75.Xr crypto 4 .
76.Pp
77The
78.Tn Hifn 7951
79and
80.Tn Hifn 7811
81will also supply data to the kernel
82.Xr random 4
83subsystem.
84.Sh BUGS
85The 7751 chip starts out at initialization by only supporting compression.
86A proprietary algorithm, which has been reverse engineered, is required to
87unlock the cryptographic functionality of the chip.
88It is possible for vendors to make boards which have a lock ID not known
89to the driver, but all vendors currently just use the obvious ID which is
9013 bytes of 0.
91.Sh SEE ALSO
92.Xr crypt 3 ,
93.Xr crypto 4 ,
94.Xr intro 4 ,
95.Xr ipsec 4 ,
96.Xr random 4 ,
97.Xr crypto 9
98.Sh CAVEATS
99The Hifn 9751 shares the same PCI id.
100This chip is basically a 7751, but with the cryptographic functions missing.
101Instead, the 9751 is only capable of doing compression.
102Since we do not currently attempt to use any of these chips to do
103compression, the 9751-based cards are not useful.
104.Sh HISTORY
105The
106.Nm
107device driver appeared in
108OpenBSD 2.7.
109The
110.Nm
111device driver was imported to FreeBSD in 5.0.
112