share/man/man4/ubsec.4

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