share/man/man4/ubsec.4

   1 .\"     $OpenBSD: ubsec.4,v 1.18 2002/09/26 07:55:41 miod Exp $
   2 .\"     $FreeBSD: src/share/man/man4/ubsec.4,v 1.1.2.1 2002/11/21 23:57:24 sam Exp $
   3 .\"
   4 .\" Copyright (c) 2000 Jason L. Wright (jason@thought.net)
   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. All advertising materials mentioning features or use of this software
  16 .\"    must display the following acknowledgement:
  17 .\"     This product includes software developed by Jason L. Wright
  18 .\" 4. The name of the author may not be used to endorse or promote products
  19 .\"    derived from this software without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  22 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  23 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  24 .\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
  25 .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  26 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  27 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  29 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  30 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31 .\" POSSIBILITY OF SUCH DAMAGE.
  32 .\"
  33 .Dd April 21, 2018
  34 .Dt UBSEC 4
  35 .Os
  36 .Sh NAME
  37 .Nm ubsec
  38 .Nd Broadcom and BlueSteel uBsec 5x0x crypto accelerator
  39 .Sh SYNOPSIS
  40 .Cd device ubsec
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 driver supports cards containing any of the following chips:
  45 .Bl -tag -width "Broadcom BCM5821" -offset indent
  46 .It Bluesteel 5501
  47 The original chipset, no longer made.  This extremely rare unit
  48 was not very fast, lacked a RNG, and had a number of other bugs.
  49 .It Bluesteel 5601
  50 A faster and fixed version of the original, with a random number
  51 unit and large number engine added.
  52 .It Broadcom BCM5801
  53 A BCM5805 without public key engine or random number generator.
  54 .It Broadcom BCM5802
  55 A slower version of the BCM5805.
  56 .It Broadcom BCM5805
  57 Faster version of Bluesteel 5601.
  58 .It Broadcom BCM5820
  59 64 bit version of the chip, and significantly more advanced.
  60 .It Broadcom BCM5821
  61 Faster version of the BCM5820.
  62 .It Broadcom BCM5822
  63 Faster version of the BCM5820.
  64 .It Broadcom BCM5823
  65 A BCM5822 with AES capability.
  66 .It Broadcom BCM5825
  67 Faster version of the BCM5823.
  68 .El
  69 .Pp
  70 The
  71 .Nm
  72 driver registers itself to accelerate DES, Triple-DES, MD5-HMAC,
  73 and SHA1-HMAC operations for
  74 .Xr crypto 4 .
  75 .Pp
  76 On those models which contain a public key engine (almost all of the
  77 more recent ones), this feature is registered with the
  78 .Xr crypto 4
  79 subsystem.
  80 .Pp
  81 On all models except the Bluesteel 5501 and Broadcom 5801, the driver
  82 registers itself to provide random data to the
  83 .Xr random 4
  84 subsystem.
  85 .Sh SEE ALSO
  86 .Xr crypt 3 ,
  87 .Xr crypto 4 ,
  88 .Xr intro 4 ,
  89 .Xr random 4 ,
  90 .Xr crypto 9
  91 .Sh HISTORY
  92 The
  93 .Nm
  94 device driver appeared in
  95 .Ox 2.8 .
  96 The
  97 .Nm
  98 device driver was imported to
  99 .Fx
 100 in 5.0.
 101 .Sh BUGS
 102 The BCM5801 and BCM5802 have not actually been tested.
 103 The AES capability of the BCM5823 is not yet supported; it is awaiting
 104 public disclosure of programming information from Broadcom.