share/man/man4/hifn.4

   1 .\"     $OpenBSD: hifn.4,v 1.32 2002/09/26 07:55:40 miod Exp $
   2 .\"
   3 .\" Copyright (c) 2000 Theo de Raadt
   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. The name of the author may not be used to endorse or promote products
  15 .\"    derived from this software without specific prior written permission.
  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 .\" $FreeBSD$
  30 .\"
  31 .Dd September 12, 2004
  32 .Dt HIFN 4
  33 .Os
  34 .Sh NAME
  35 .Nm hifn
  36 .Nd Hifn 7751/7951/7811/7955/7956 crypto accelerator
  37 .Sh SYNOPSIS
  38 .Cd device hifn
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 driver supports various cards containing the Hifn 7751, 7951,
  43 7811, 7955, and 7956 chipsets.
  44 .Pp
  45 The
  46 .Nm
  47 driver registers itself to accelerate DES, Triple-DES,
  48 AES (7955 and 7956 only), ARC4, MD5,
  49 MD5-HMAC, SHA1, and SHA1-HMAC operations for
  50 .Xr ipsec 4
  51 and
  52 .Xr crypto 4 .
  53 .Pp
  54 The Hifn
  55 .Tn 7951 ,
  56 .Tn 7811 ,
  57 .Tn 7955 ,
  58 and
  59 .Tn 7956
  60 will also supply data to the kernel
  61 .Xr random 4
  62 subsystem.
  63 .Sh HARDWARE
  64 The
  65 .Nm
  66 driver supports various cards containing the Hifn 7751, 7951,
  67 7811, 7955, and 7956
  68 chipsets, such as:
  69 .Bl -tag -width namenamenamena -offset indent
  70 .It Invertex AEON
  71 No longer being made.
  72 Came as 128KB SRAM model, or 2MB DRAM model.
  73 .It Hifn 7751
  74 Reference board with 512KB SRAM.
  75 .It PowerCrypt
  76 See
  77 .Pa http://www.powercrypt.com/ .
  78 Comes with 512KB SRAM.
  79 .It XL-Crypt
  80 See
  81 .Pa http://www.powercrypt.com/ .
  82 Only board based on 7811 (which is faster than 7751 and has
  83 a random number generator).
  84 .It NetSec 7751
  85 See
  86 .Pa http://www.netsec.net/ .
  87 Supports the most IPsec sessions, with 1MB SRAM.
  88 .It Soekris Engineering vpn1201 and vpn1211
  89 See
  90 .Pa http://www.soekris.com/ .
  91 Contains a 7951 and supports symmetric and random number operations.
  92 .It Soekris Engineering vpn1401 and vpn1411
  93 See
  94 .Pa http://www.soekris.com/ .
  95 Contains a 7955 and supports symmetric and random number operations.
  96 .El
  97 .Sh SEE ALSO
  98 .Xr crypt 3 ,
  99 .Xr crypto 4 ,
 100 .Xr intro 4 ,
 101 .Xr ipsec 4 ,
 102 .Xr random 4 ,
 103 .Xr crypto 9
 104 .Sh CAVEATS
 105 The Hifn 9751 shares the same PCI ID.
 106 This chip is basically a 7751, but with the cryptographic functions missing.
 107 Instead, the 9751 is only capable of doing compression.
 108 Since we do not currently attempt to use any of these chips to do
 109 compression, the 9751-based cards are not useful.
 110 .Pp
 111 Support for the 7955 and 7956 is incomplete; the asymmetric crypto
 112 facilities are to be added and the performance is suboptimal.
 113 .Sh HISTORY
 114 The
 115 .Nm
 116 device driver appeared in
 117 .Ox 2.7 .
 118 The
 119 .Nm
 120 device driver was imported to
 121 .Fx 5.0 .
 122 .Sh BUGS
 123 The 7751 chip starts out at initialization by only supporting compression.
 124 A proprietary algorithm, which has been reverse engineered, is required to
 125 unlock the cryptographic functionality of the chip.
 126 It is possible for vendors to make boards which have a lock ID not known
 127 to the driver, but all vendors currently just use the obvious ID which is
 128 13 bytes of 0.