share/man/man4/hifn.4

   1 .\"     $NetBSD: hifn.4,v 1.5 2004/04/29 19:05:36 jonathan Exp $
   2 .\"     $OpenBSD: hifn.4,v 1.32 2002/09/26 07:55:40 miod Exp $
   3 .\"     $FreeBSD: src/share/man/man4/hifn.4,v 1.1.2.2 2003/10/08 23:57:50 sam Exp $
   4 .\"
   5 .\" Copyright (c) 2000 Theo de Raadt
   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 .\" 3. The name of the author may not be used to endorse or promote products
  17 .\"    derived from this software without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  20 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  21 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22 .\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
  23 .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  24 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  25 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  27 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  28 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29 .\" POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .Dd October 8, 2003
  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 "hifn* at pci? dev ? function ?"
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 driver supports various cards containing the Hifn 7751, 7951,
  43 7811, 7955, and 7956
  44 chipsets, such as
  45 .Bl -tag -width namenamenamena -offset indent
  46 .It Invertex AEON
  47 No longer being made.
  48 Came as 128KB SRAM model, or 2MB DRAM model.
  49 .It Hifn 7751
  50 Reference board with 512KB SRAM.
  51 .It PowerCrypt
  52 See
  53 .Pa http://www.powercrypt.com/ .
  54 Comes with 512KB SRAM.
  55 .It XL-Crypt
  56 See
  57 .Pa http://www.powercrypt.com/ .
  58 Only board based on 7811 (which is faster than 7751 and has
  59 a random number generator).
  60 .It NetSec 7751
  61 See
  62 .Pa http://www.netsec.net/ .
  63 Supports the most IPsec sessions, with 1MB SRAM.
  64 .It Soekris Engineering vpn1201 and vpn1211
  65 See
  66 .Pa http://www.soekris.com/ .
  67 Contains a 7951 and supports symmetric and random number operations.
  68 .It Soekris Engineering vpn1401 and vpn1411
  69 See
  70 .Pa http://www.soekris.com/ .
  71 Contains a 7955 and supports symmetric and random number operations.
  72 .El
  73 .Pp
  74 The
  75 .Nm
  76 driver registers itself to accelerate DES, Triple-DES,
  77 AES (7955 and 7956 only), ARC4, MD5,
  78 MD5-HMAC, SHA1, and SHA1-HMAC operations for
  79 .Xr opencrypto 9 ,
  80 and thus for
  81 .Xr fast_ipsec 4
  82 and
  83 .Xr crypto 4 .
  84 .Pp
  85 The Hifn
  86 .Tn 7951 ,
  87 .Tn 7811 ,
  88 .Tn 7955 ,
  89 and
  90 .Tn 7956
  91 may also supply data to the kernel
  92 .Xr rnd 4
  93 subsystem.
  94 .Sh SEE ALSO
  95 .Xr crypto 4 ,
  96 .Xr fast_ipsec 4 ,
  97 .Xr intro 4 ,
  98 .Xr rnd 4 ,
  99 .Xr opencrypto 9
 100 .Sh HISTORY
 101 The
 102 .Nm
 103 device driver appeared in
 104 .Ox 2.7 .
 105 The
 106 .Nm
 107 device driver was imported to
 108 .Fx 5.0 ,
 109 back-ported to
 110 .Fx 4.8 ,
 111 and subsequently imported into
 112 .Nx 2.0 .
 113 .Sh CAVEATS
 114 The Hifn 9751 shares the same PCI ID.
 115 This chip is basically a 7751, but with the cryptographic functions missing.
 116 Instead, the 9751 is only capable of doing compression.
 117 Since we do not currently attempt to use any of these chips to do
 118 compression, the 9751-based cards are not useful.
 119 .Pp
 120 Support for the 7955 and 7956 is incomplete; the asymmetric crypto
 121 facilities are to be added and the performance is suboptimal.
 122 .Pp
 123 Supplying data to the kernel
 124 .Xr rnd 4
 125 subsystem has been disabled, pending verification that the on-chip
 126 RNG is statistically adequate.
 127 .Sh BUGS
 128 The 7751 chip starts out at initialization by only supporting compression.
 129 A proprietary algorithm, which has been reverse engineered, is required to
 130 unlock the cryptographic functionality of the chip.
 131 It is possible for vendors to make boards which have a lock ID not known
 132 to the driver, but all vendors currently just use the obvious ID which is
 133 13 bytes of 0.