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