share/man/man4/ccr.4

   1 .\" Copyright (c) 2017, Chelsio Inc
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd March 11, 2019
  28 .Dt CCR 4
  29 .Os
  30 .Sh NAME
  31 .Nm ccr
  32 .Nd "Chelsio T6 crypto accelerator driver"
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place the following lines in your
  36 kernel configuration file:
  37 .Bd -ragged -offset indeunt
  38 .Cd "device ccr"
  39 .Ed
  40 .Pp
  41 To load the driver as a
  42 module at boot time, place the following line in
  43 .Xr loader.conf 5 :
  44 .Bd -literal -offset indent
  45 ccr_load="YES"
  46 .Ed
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 driver provides support for the crypto accelerator engine included on
  51 PCI Express Ethernet adapters based on the Chelsio Terminator 6 ASIC (T6).
  52 The driver accelerates AES-CBC, AES-CTR, AES-GCM, AES-XTS, SHA1, SHA2-224,
  53 SHA2-256, SHA2-384, SHA2-512, SHA1-HMAC, SHA2-224-HMAC,
  54 SHA2-256-HMAC, SHA2-384-HMAC, and SHA2-512-HMAC operations for
  55 .Xr crypto 4
  56 and
  57 .Xr ipsec 4 .
  58 The driver also supports chaining one of AES-CBC, AES-CTR, or AES-XTS with
  59 SHA1-HMAC, SHA2-224-HMAC, SHA2-256-HMAC, SHA2-384-HMAC, or SHA2-512-HMAC for
  60 encrypt-then-authenticate operations.
  61 For further hardware information and questions related to hardware
  62 requirements, see
  63 .Pa http://www.chelsio.com/ .
  64 .Pp
  65 The
  66 .Nm
  67 driver attaches as a child of an existing Chelsio NIC device and thus
  68 requires that the
  69 .Xr cxgbe 4
  70 driver be active.
  71 .Sh HARDWARE
  72 The
  73 .Nm
  74 driver supports the crypto accelerator engine included on adapters
  75 based on the T6 ASIC:
  76 .Pp
  77 .Bl -bullet -compact
  78 .It
  79 Chelsio T6225-CR
  80 .It
  81 Chelsio T6225-SO-CR
  82 .It
  83 Chelsio T62100-LP-CR
  84 .It
  85 Chelsio T62100-SO-CR
  86 .It
  87 Chelsio T62100-CR
  88 .El
  89 .Sh SUPPORT
  90 For general information and support,
  91 go to the Chelsio support website at:
  92 .Pa http://www.chelsio.com/ .
  93 .Pp
  94 If an issue is identified with this driver with a supported adapter,
  95 email all the specific information related to the issue to
  96 .Aq Mt support@chelsio.com .
  97 .Sh SEE ALSO
  98 .Xr crypto 4 ,
  99 .Xr cxgbe 4 ,
 100 .Xr ipsec 4
 101 .Sh HISTORY
 102 The
 103 .Nm
 104 device driver first appeared in
 105 .Fx 12.0 .
 106 .Sh AUTHORS
 107 .An -nosplit
 108 The
 109 .Nm
 110 driver was written by
 111 .An John Baldwin Aq Mt jhb@FreeBSD.org .