share/man/man4/ubsec.4

   1 .\"     $OpenBSD: ubsec.4,v 1.25 2003/08/12 19:42:46 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 .\" $FreeBSD$
  28 .\"
  29 .Dd May 16, 2009
  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 To compile this driver into the kernel,
  37 place the following lines in your
  38 kernel configuration file:
  39 .Bd -ragged -offset indent
  40 .Cd "device crypto"
  41 .Cd "device cryptodev"
  42 .Cd "device ubsec"
  43 .Ed
  44 .Pp
  45 Alternatively, to load the driver as a
  46 module at boot time, place the following line in
  47 .Xr loader.conf 5 :
  48 .Bd -literal -offset indent
  49 ubsec_load="YES"
  50 .Ed
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 driver supports cards containing Broadcom and BlueSteel uBsec 5x0x
  55 crypto accelerator chips.
  56 .Pp
  57 The
  58 .Nm
  59 driver registers itself to accelerate DES, Triple-DES, MD5-HMAC,
  60 and SHA1-HMAC operations for
  61 .Xr ipsec 4
  62 and
  63 .Xr crypto 4 .
  64 .Pp
  65 On those models which contain a public key engine (almost all of the
  66 more recent ones), this feature is registered with the
  67 .Xr crypto 4
  68 subsystem.
  69 .Pp
  70 On all models except the Bluesteel 5501 and Broadcom 5801, the driver
  71 registers itself to provide random data to the
  72 .Xr random 4
  73 subsystem.
  74 .Sh HARDWARE
  75 The
  76 .Nm
  77 driver supports cards containing any of the following chips:
  78 .Bl -tag -width "Broadcom BCM5822" -offset indent
  79 .It Bluesteel 5501
  80 The original chipset, no longer made.
  81 This extremely rare unit
  82 was not very fast, lacked an RNG, and had a number of other bugs.
  83 .It Bluesteel 5601
  84 A faster and fixed version of the original, with a random number
  85 unit and large number engine added.
  86 .It Broadcom BCM5801
  87 A BCM5805 without public key engine or random number generator.
  88 .It Broadcom BCM5802
  89 A slower version of the BCM5805.
  90 .It Broadcom BCM5805
  91 Faster version of Bluesteel 5601.
  92 .It Broadcom BCM5820
  93 64 bit version of the chip, and significantly more advanced.
  94 .It Broadcom BCM5821
  95 Faster version of the BCM5820.
  96 This is the chip found on the Sun Crypto Accelerator 1000.
  97 .It Broadcom BCM5822
  98 Faster version of the BCM5820.
  99 .It Broadcom BCM5823
 100 A BCM5822 with AES capability.
 101 .It Broadcom BCM5825
 102 Faster version of the BCM5823.
 103 .El
 104 .Sh SEE ALSO
 105 .Xr crypt 3 ,
 106 .Xr crypto 4 ,
 107 .Xr intro 4 ,
 108 .Xr ipsec 4 ,
 109 .Xr random 4 ,
 110 .Xr crypto 9
 111 .Sh HISTORY
 112 The
 113 .Nm
 114 device driver appeared in
 115 .Ox 2.8 .
 116 The
 117 .Nm
 118 device driver was imported to
 119 .Fx 5.0 .
 120 .Sh BUGS
 121 The BCM5801 and BCM5802 have not actually been tested.
 122 The AES capability of the BCM5823 is not yet supported; it is awaiting
 123 public disclosure of programming information from Broadcom.