share/man/man4/hifn.4

   1 .\"     $OpenBSD: hifn.4,v 1.32 2002/09/26 07:55:40 miod Exp $
   2 .\"     $FreeBSD: src/share/man/man4/hifn.4,v 1.1.2.1 2002/11/21 23:57:24 sam Exp $
   3 .\"     $DragonFly: src/share/man/man4/hifn.4,v 1.5 2007/05/12 21:22:10 swildner 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 November 21, 2002
  32 .Dt HIFN 4
  33 .Os
  34 .Sh NAME
  35 .Nm hifn
  36 .Nd Hifn 7751/7951/7811 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, Hifn 7951, or
  43 Hifn 7811
  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 .El
  69 .Pp
  70 The
  71 .Nm
  72 driver registers itself to accelerate DES, Triple-DES, ARC4, MD5,
  73 MD5-HMAC, SHA1, and SHA1-HMAC operations for
  74 .Xr ipsec 4
  75 and
  76 .Xr crypto 4 .
  77 .Pp
  78 The
  79 .Tn Hifn 7951
  80 and
  81 .Tn Hifn 7811
  82 will also supply data to the kernel
  83 .Xr random 4
  84 subsystem.
  85 .Sh SEE ALSO
  86 .Xr crypt 3 ,
  87 .Xr crypto 4 ,
  88 .Xr intro 4 ,
  89 .Xr ipsec 4 ,
  90 .Xr random 4 ,
  91 .Xr crypto 9
  92 .Sh CAVEATS
  93 The Hifn 9751 shares the same PCI id.
  94 This chip is basically a 7751, but with the cryptographic functions missing.
  95 Instead, the 9751 is only capable of doing compression.
  96 Since we do not currently attempt to use any of these chips to do
  97 compression, the 9751-based cards are not useful.
  98 .Sh HISTORY
  99 The
 100 .Nm
 101 device driver appeared in
 102 .Ox 2.7 .
 103 The
 104 .Nm
 105 device driver was imported to
 106 .Fx
 107 in 5.0.
 108 .Sh BUGS
 109 The 7751 chip starts out at initialization by only supporting compression.
 110 A proprietary algorithm, which has been reverse engineered, is required to
 111 unlock the cryptographic functionality of the chip.
 112 It is possible for vendors to make boards which have a lock ID not known
 113 to the driver, but all vendors currently just use the obvious ID which is
 114 13 bytes of 0.