1 .\" Copyright (c) 2011-2012, Chelsio Inc
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions are met:
7 .\" 1. Redistributions of source code must retain the above copyright notice,
8 .\" this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the Chelsio Inc nor the names of its
15 .\" contributors may be used to endorse or promote products derived from
16 .\" this software without specific prior written permission.
18 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 .\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 .\" POSSIBILITY OF SUCH DAMAGE.
30 .\" * Other names and brands may be claimed as the property of others.
39 .Nd "Chelsio T4 10Gb and 1Gb Ethernet adapter driver"
41 To compile this driver into the kernel,
42 place the following lines in your
43 kernel configuration file:
44 .Bd -ragged -offset indent
48 To load the driver as a
49 module at boot time, place the following line in
51 .Bd -literal -offset indent
57 driver provides support for PCI Express Ethernet adapters based on
58 the Chelsio Terminator 4 (T4) ASIC.
59 The driver supports Jumbo Frames, Transmit/Receive checksum offload,
60 TCP segmentation offload (TSO), Large Receive Offload (LRO), VLAN
61 tag insertion/extraction, VLAN checksum offload, VLAN TSO, and
62 Receive Side Steering (RSS).
63 For further hardware information and questions related to hardware
65 .Pa http://www.chelsio.com/ .
67 For more information on configuring this device, see
72 driver supports 10Gb and 1Gb Ethernet adapters based on the T4 ASIC:
97 Tunables can be set at the
99 prompt before booting the kernel or stored in
101 .Bl -tag -width indent
102 .It Va hw.cxgbe.ntxq10g
103 The number of tx queues to use for a 10Gb port.
104 The default is 16 or the number
105 of CPU cores in the system, whichever is less.
106 .It Va hw.cxgbe.nrxq10g
107 The number of rx queues to use for a 10Gb port.
108 The default is 8 or the number
109 of CPU cores in the system, whichever is less.
110 .It Va hw.cxgbe.ntxq1g
111 The number of tx queues to use for a 1Gb port.
112 The default is 4 or the number
113 of CPU cores in the system, whichever is less.
114 .It Va hw.cxgbe.nrxq1g
115 The number of rx queues to use for a 1Gb port.
116 The default is 2 or the number
117 of CPU cores in the system, whichever is less.
118 .It Va hw.cxgbe.nofldtxq10g
119 The number of TOE tx queues to use for a 10Gb port.
120 The default is 8 or the
121 number of CPU cores in the system, whichever is less.
122 .It Va hw.cxgbe.nofldrxq10g
123 The number of TOE rx queues to use for a 10Gb port.
124 The default is 2 or the
125 number of CPU cores in the system, whichever is less.
126 .It Va hw.cxgbe.nofldtxq1g
127 The number of TOE tx queues to use for a 1Gb port.
128 The default is 2 or the
129 number of CPU cores in the system, whichever is less.
130 .It Va hw.cxgbe.nofldrxq1g
131 The number of TOE rx queues to use for a 1Gb port.
133 .It Va hw.cxgbe.holdoff_timer_idx_10G
134 .It Va hw.cxgbe.holdoff_timer_idx_1G
135 The timer index value to use to delay interrupts.
136 The holdoff timer list has the values 1, 5, 10, 50, 100, and 200
137 by default (all values are in microseconds) and the index selects a
138 value from this list.
139 The default value is 1 for both 10Gb and 1Gb ports, which means the
141 Different cxgbe interfaces can be assigned different values at any time via the
142 dev.cxgbe.X.holdoff_tmr_idx sysctl.
143 .It Va hw.cxgbe.holdoff_pktc_idx_10G
144 .It Va hw.cxgbe.holdoff_pktc_idx_1G
145 The packet-count index value to use to delay interrupts.
146 The packet-count list has the values 1, 8, 16, and 32 by default
147 and the index selects a value from this list.
148 The default value is -1 for both 10Gb and 1Gb ports, which means packet
149 counting is disabled and interrupts are generated based solely on the
151 Different cxgbe interfaces can be assigned different values via the
152 dev.cxgbe.X.holdoff_pktc_idx sysctl.
153 This sysctl works only when the interface has never been marked up (as done by
155 .It Va hw.cxgbe.qsize_txq
156 The size, in number of entries, of the descriptor ring used for a tx
158 A buf_ring of the same size is also allocated for additional
162 The default value is 1024.
163 Different cxgbe interfaces can be assigned different values via the
164 dev.cxgbe.X.qsize_txq sysctl.
165 This sysctl works only when the interface has never been marked up (as done by
167 .It Va hw.cxgbe.qsize_rxq
168 The size, in number of entries, of the descriptor ring used for an
170 The default value is 1024.
171 Different cxgbe interfaces can be assigned different values via the
172 dev.cxgbe.X.qsize_rxq sysctl.
173 This sysctl works only when the interface has never been marked up (as done by
175 .It Va hw.cxgbe.interrupt_types
176 The interrupt types that the driver is allowed to use.
177 Bit 0 represents INTx (line interrupts), bit 1 MSI, bit 2 MSI-X.
178 The default is 7 (all allowed).
179 The driver will select the best possible type out of the allowed types by
181 .It Va hw.cxgbe.fw_install
182 0 prohibits the driver from installing a firmware on the card.
183 1 allows the driver to install a new firmware if internal driver
184 heuristics indicate that the new firmware is preferable to the one
186 2 instructs the driver to always install the new firmware on the card as
187 long as it is compatible with the driver and is a different version than
188 the one already on the card.
190 .It Va hw.cxgbe.config_file
191 Select a pre-packaged device configuration file.
192 A configuration file contains a recipe for partitioning and configuring the
193 hardware resources on the card.
194 This tunable is for specialized applications only and should not be used in
196 The configuration profile currently in use is available in the dev.t4nex.X.cf
197 and dev.t4nex.X.cfcsum sysctls.
198 .It Va hw.cxgbe.linkcaps_allowed
199 .It Va hw.cxgbe.niccaps_allowed
200 .It Va hw.cxgbe.toecaps_allowed
201 .It Va hw.cxgbe.rdmacaps_allowed
202 .It Va hw.cxgbe.iscsicaps_allowed
203 .It Va hw.cxgbe.fcoecaps_allowed
204 Disallowing capabilities provides a hint to the driver and firmware to not
205 reserve hardware resources for that feature.
206 Each of these is a bit field with a bit for each sub-capability within the
208 This tunable is for specialized applications only and should not be used in
210 The capabilities for which hardware resources have been reserved are listed in
211 dev.t4nex.X.*caps sysctls.
214 For general information and support,
215 go to the Chelsio support website at:
216 .Pa http://www.chelsio.com/ .
218 If an issue is identified with this driver with a supported adapter,
219 email all the specific information related to the issue to
220 .Aq support@chelsio.com .
231 device driver first appeared in
237 driver was written by
238 .An Navdeep Parhar Aq np@FreeBSD.org .