share/man/man4/ubsec.4

   1 .\"     $NetBSD: ubsec.4,v 1.3 2004/04/29 08:44:17 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 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
  38 The
  39 .Nm
  40 driver supports cards containing any of the following chips:
  41 .Bl -tag -width "Broadcom BCM5821" -offset indent
  42 .It Bluesteel 5501
  43 The original chipset, no longer made.
  44 This extremely rare unit
  45 was not very fast, lacked an RNG, and had a number of other bugs.
  46 .It Bluesteel 5601
  47 A faster and fixed version of the original, with a random number
  48 unit and large number engine added.
  49 .It Broadcom BCM5801
  50 A BCM5805 without public key engine or random number generator.
  51 .It Broadcom BCM5802
  52 A slower version of the BCM5805.
  53 .It Broadcom BCM5805
  54 Faster version of Bluesteel 5601.
  55 .It Broadcom BCM5820
  56 64 bit version of the chip, and significantly more advanced.
  57 .It Broadcom BCM5821
  58 Faster version of the BCM5820.
  59 (This is the chip found on the Sun Crypto Accelerator 1000.)
  60 .It Broadcom BCM5822
  61 Faster version of the BCM5820.
  62 .It Broadcom BCM5823
  63 Faster version of the BCM5822.
  64 .It Broadcom BCM5823
  65 Faster version of the BCM5821, with AES hardware.
  66 .El
  67 .Pp
  68 The
  69 .Nm
  70 driver registers itself to accelerate DES, Triple-DES, MD5, SHA1,
  71 MD5-HMAC, and SHA1-HMAC operations for
  72 .Xr opencrypto 9 ,
  73 and thus for
  74 .Xr fast_ipsec 4
  75 and
  76 .Xr crypto 4 .
  77 .Pp
  78 On those models which contain a public key engine (almost all of the
  79 more recent ones), this feature is registered with the
  80 .Xr crypto 4
  81 subsystem.
  82 .Pp
  83 On all models except the Bluesteel 5501 and Broadcom 5801, the driver
  84 registers itself to provide random data to the
  85 .Xr rnd 4
  86 subsystem.
  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
  94 The
  95 .Nm
  96 device driver appeared in
  97 .Ox 2.8 .
  98 The
  99 .Nm
 100 device driver was imported to
 101 .Fx 5.0 ,
 102 back-ported to
 103 .Fx 4.8 ,
 104 and subsequently imported to
 105 .Nx 2.0 .
 106 .Sh BUGS
 107 The BCM5801 and BCM5802 have not actually been tested.
 108 .Pp
 109 Whilst some of the newer chips support AES, AES is not supported by the driver.