xref: /netbsd-src/share/man/man4/ubsec.4 (revision b1c86f5f087524e68db12794ee9c3e3da1ab17a0)
1.\"	$NetBSD: ubsec.4,v 1.4 2004/04/29 19:42:29 jonathan Exp $
2.\"	$FreeBSD: src/share/man/man4/ubsec.4,v 1.1.2.1 2002/11/21 23:57:24 sam Exp $
3.\"	$OpenBSD: ubsec.4,v 1.26 2003/09/03 15:55:41 jason Exp $
4.\"
5.\" Copyright (c) 2000 Jason L. Wright (jason@thought.net)
6.\" All rights reserved.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20.\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
21.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
23.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
25.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
26.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27.\" POSSIBILITY OF SUCH DAMAGE.
28.\"
29.Dd June 10, 2000
30.Dt UBSEC 4
31.Os
32.Sh NAME
33.Nm ubsec
34.Nd Broadcom and BlueSteel uBsec 5x0x crypto accelerator
35.Sh SYNOPSIS
36.Cd "ubsec* at pci? dev ? function ?"
37.Sh DESCRIPTION
38The
39.Nm
40driver supports cards containing any of the following chips:
41.Bl -tag -width "Broadcom BCM5821" -offset indent
42.It Bluesteel 5501
43The original chipset, no longer made.
44This extremely rare unit
45was not very fast, lacked an RNG, and had a number of other bugs.
46.It Bluesteel 5601
47A faster and fixed version of the original, with a random number
48unit and large number engine added.
49.It Broadcom BCM5801
50A BCM5805 without public key engine or random number generator.
51.It Broadcom BCM5802
52A slower version of the BCM5805.
53.It Broadcom BCM5805
54Faster version of Bluesteel 5601.
55.It Broadcom BCM5820
5664 bit version of the chip, and significantly more advanced.
57.It Broadcom BCM5821
58Faster version of the BCM5820.
59(This is the chip found on the Sun Crypto Accelerator 1000.)
60.It Broadcom BCM5822
61Faster version of the BCM5820.
62.It Broadcom BCM5823
63Faster version of the BCM5822.
64.It Broadcom BCM5823
65Faster version of the BCM5821, with AES hardware.
66.El
67.Pp
68The
69.Nm
70driver registers itself to accelerate DES, Triple-DES, MD5, SHA1,
71MD5-HMAC, and SHA1-HMAC operations for
72.Xr opencrypto 9 ,
73and thus for
74.Xr fast_ipsec 4
75and
76.Xr crypto 4 .
77.Pp
78On those models which contain a public key engine (almost all of the
79more recent ones), this feature is registered with the
80.Xr crypto 4
81subsystem.
82.Pp
83On all models except the Bluesteel 5501 and Broadcom 5801, the driver
84registers itself to provide random data to the
85.Xr rnd 4
86subsystem.
87.Sh SEE ALSO
88.Xr crypto 4 ,
89.Xr fast_ipsec 4 ,
90.Xr intro 4 ,
91.Xr rnd 4 ,
92.Xr opencrypto 9
93.Sh HISTORY
94The
95.Nm
96device driver appeared in
97.Ox 2.8 .
98The
99.Nm
100device driver was imported to
101.Fx 5.0 ,
102back-ported to
103.Fx 4.8 ,
104and subsequently imported to
105.Nx 2.0 .
106.Sh BUGS
107The BCM5801 and BCM5802 have not actually been tested.
108.Pp
109Whilst some of the newer chips support AES, AES is not supported by the driver.
110