xref: /netbsd-src/share/man/man4/ubsec.4 (revision 5fe4139bcae1f2e72b43b45451e96b5440620bb7)
1.\"	$NetBSD: ubsec.4,v 1.7 2018/06/15 23:11:56 wiz 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 13, 2018
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 Broadcom BCM5801
47A BCM5805 without public key engine or random number generator.
48.It Broadcom BCM5802
49A slower version of the BCM5805.
50.It Broadcom BCM5805
51Faster version of Bluesteel 5601.
52.It Broadcom BCM5820
5364 bit version of the chip, and significantly more advanced.
54.It Broadcom BCM5821
55Faster version of the BCM5820.
56This is the chip found on the Sun Crypto Accelerator 1000.
57.It Broadcom BCM5822
58Faster version of the BCM5820.
59.It Broadcom BCM5823
60Faster version of the BCM5822 that also supports AES.
61.It Broadcom BCM5825
62Faster PCI Express or PCI-X version of the chip.
63.It Broadcom BCM5860
64IPSec/SSL Security Processor that is faster and has more features.
65.It Broadcom BCM5861
66Faster version of the BCM5860.
67.It Broadcom BCM5862
68Faster version of the BCM5861.
69.El
70.Pp
71The
72.Nm
73driver registers itself to accelerate DES, Triple-DES, MD5, SHA1,
74MD5-HMAC, and SHA1-HMAC operations for
75.Xr opencrypto 9 ,
76and thus for
77.Xr ipsec 4
78and
79.Xr crypto 4 .
80The driver also supports acceleration of AES-CBC with the BCM5823 or newer.
81.Pp
82On those models which contain a public key engine (almost all of the
83more recent ones), this feature is registered with the
84.Xr crypto 4
85subsystem.
86.Pp
87On all models except the Bluesteel 5501 and Broadcom 5801, the driver
88registers itself to provide random data to the
89.Xr rnd 4
90subsystem.
91.Sh SEE ALSO
92.Xr crypto 4 ,
93.Xr intro 4 ,
94.Xr ipsec 4 ,
95.Xr rnd 4 ,
96.Xr opencrypto 9
97.Sh HISTORY
98The
99.Nm
100device driver appeared in
101.Ox 2.8 .
102The
103.Nm
104device driver was imported to
105.Fx 5.0 ,
106back-ported to
107.Fx 4.8 ,
108and subsequently imported to
109.Nx 2.0 .
110.Sh BUGS
111The BCM5801 and BCM5802 have not actually been tested.
112