summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/ccr.4 3.html
blob: c2695093f4e3047185e6b019f87e42e3da8be911 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
<table class="head">
  <tr>
    <td class="head-ltitle">CCR(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">CCR(4)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">ccr</code> &#x2014; <span class="Nd">Chelsio T6
    crypto accelerator driver</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp">To compile this driver into the kernel, place the following lines
    in your kernel configuration file:</p>
<div class="Bd Pp Bd-indent"><code class="Cd">device ccr</code>
<br/>
<code class="Cd">device cxgbe</code></div>
<p class="Pp">To load the driver as a module at boot time, place the following
    line in <a class="Xr">loader.conf(5)</a>:</p>
<div class="Bd Pp Bd-indent Li">
<pre>ccr_load=&quot;YES&quot;</pre>
</div>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">ccr</code> driver provides support for the
    crypto accelerator engine included on PCI Express Ethernet adapters based on
    the Chelsio Terminator 6 ASIC (T6). The driver accelerates AES-CBC, AES-CCM,
    AES-CTR, AES-GCM, AES-XTS, SHA1, SHA2-224, SHA2-256, SHA2-384, SHA2-512,
    SHA1-HMAC, SHA2-224-HMAC, SHA2-256-HMAC, SHA2-384-HMAC, and SHA2-512-HMAC
    operations for <a class="Xr">crypto(9)</a> consumers such as
    <a class="Xr">ktls(4)</a>, <a class="Xr">geli(4)</a>, and
    <a class="Xr">ipsec(4)</a>. The driver also supports chaining one of
    AES-CBC, AES-CTR, or AES-XTS with SHA1-HMAC, SHA2-224-HMAC, SHA2-256-HMAC,
    SHA2-384-HMAC, or SHA2-512-HMAC for encrypt-then-authenticate operations.
    For further hardware information and questions related to hardware
    requirements, see <span class="Pa">http://www.chelsio.com/</span>.</p>
<p class="Pp">The <code class="Nm">ccr</code> driver attaches as a child of an
    existing Chelsio NIC device and thus requires that the
    <a class="Xr">cxgbe(4)</a> driver be active.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1>
<p class="Pp">The <code class="Nm">ccr</code> driver supports the crypto
    accelerator engine included on adapters based on the T6 ASIC:</p>
<p class="Pp"></p>
<ul class="Bl-bullet Bl-compact">
  <li>Chelsio T6225-CR</li>
  <li>Chelsio T6225-SO-CR</li>
  <li>Chelsio T62100-LP-CR</li>
  <li>Chelsio T62100-SO-CR</li>
  <li>Chelsio T62100-CR</li>
</ul>
</section>
<section class="Sh">
<h1 class="Sh" id="SUPPORT"><a class="permalink" href="#SUPPORT">SUPPORT</a></h1>
<p class="Pp">For general information and support, go to the Chelsio support
    website at: <span class="Pa">http://www.chelsio.com/</span>.</p>
<p class="Pp">If an issue is identified with this driver with a supported
    adapter, email all the specific information related to the issue to
    &lt;<a class="Mt" href="mailto:support@chelsio.com">support@chelsio.com</a>&gt;.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">crypto(4)</a>, <a class="Xr">cxgbe(4)</a>,
    <a class="Xr">geli(4)</a>, <a class="Xr">ipsec(4)</a>,
    <a class="Xr">ktls(4)</a>, <a class="Xr">crypto(7)</a>,
    <a class="Xr">crypto(9)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<p class="Pp">The <code class="Nm">ccr</code> device driver first appeared in
    <span class="Ux">FreeBSD 12.0</span>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp">The <code class="Nm">ccr</code> driver was written by
    <span class="An">John Baldwin</span>
    &lt;<a class="Mt" href="mailto:jhb@FreeBSD.org">jhb@FreeBSD.org</a>&gt;.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">November 25, 2024</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>