share/man/man4/cxgbe.4

   1 .\" Copyright (c) 2011-2016, 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 are met:
   6 .\"
   7 .\" 1. Redistributions of source code must retain the above copyright notice,
   8 .\"    this list of conditions and the following disclaimer.
   9 .\"
  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.
  13 .\"
  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.
  17 .\"
  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.
  29 .\"
  30 .\" * Other names and brands may be claimed as the property of others.
  31 .\"
  32 .\" $FreeBSD$
  33 .\"
  34 .Dd Sep 24, 2018
  35 .Dt CXGBE 4
  36 .Os
  37 .Sh NAME
  38 .Nm cxgbe
  39 .Nd "Chelsio T4-, T5-, and T6-based 100Gb, 40Gb, 25Gb, 10Gb, and 1Gb Ethernet adapter driver"
  40 .Sh SYNOPSIS
  41 To compile this driver into the kernel,
  42 place the following lines in your
  43 kernel configuration file:
  44 .Bd -ragged -offset indent
  45 .Cd "device cxgbe"
  46 .Ed
  47 .Pp
  48 To load the driver as a
  49 module at boot time, place the following lines in
  50 .Xr loader.conf 5 :
  51 .Bd -literal -offset indent
  52 t4fw_cfg_load="YES"
  53 t5fw_cfg_load="YES"
  54 t6fw_cfg_load="YES"
  55 if_cxgbe_load="YES"
  56 .Ed
  57 .Sh DESCRIPTION
  58 The
  59 .Nm
  60 driver provides support for PCI Express Ethernet adapters based on
  61 the Chelsio Terminator 4, Terminator 5, and Terminator 6 ASICs (T4, T5, and T6).
  62 The driver supports Jumbo Frames, Transmit/Receive checksum offload,
  63 TCP segmentation offload (TSO), Large Receive Offload (LRO), VLAN
  64 tag insertion/extraction, VLAN checksum offload, VLAN TSO, and
  65 Receive Side Steering (RSS).
  66 For further hardware information and questions related to hardware
  67 requirements, see
  68 .Pa http://www.chelsio.com/ .
  69 .Pp
  70 The
  71 .Nm
  72 driver uses different names for devices based on the associated ASIC:
  73 .Bl -column -offset indent "ASIC" "Port Name" "Parent Device"
  74 .It Sy ASIC Ta Sy Port Name Ta Sy Parent Device Ta Sy Virtual Interface
  75 .It T4 Ta cxgbe Ta t4nex Ta vcxgbe
  76 .It T5 Ta cxl Ta t5nex Ta vcxl
  77 .It T6 Ta cc Ta t6nex Ta vcc
  78 .El
  79 .Pp
  80 Loader tunables with the hw.cxgbe prefix apply to all cards.
  81 The driver provides sysctl MIBs for both ports and parent devices using
  82 the names above.
  83 For example, a T5 adapter provides port MIBs under dev.cxl and
  84 adapter-wide MIBs under dev.t5nex.
  85 References to sysctl MIBs in the remainder of this page use
  86 dev.<port> for port MIBs and dev.<nexus> for adapter-wide MIBs.
  87 .Pp
  88 For more information on configuring this device, see
  89 .Xr ifconfig 8 .
  90 .Sh HARDWARE
  91 The
  92 .Nm
  93 driver supports 100Gb and 25Gb Ethernet adapters based on the T6 ASIC:
  94 .Pp
  95 .Bl -bullet -compact
  96 .It
  97 Chelsio T6225-CR
  98 .It
  99 Chelsio T6225-SO-CR
 100 .It
 101 Chelsio T62100-LP-CR
 102 .It
 103 Chelsio T62100-SO-CR
 104 .It
 105 Chelsio T62100-CR
 106 .El
 107 .Pp
 108 The
 109 .Nm
 110 driver supports 40Gb, 10Gb and 1Gb Ethernet adapters based on the T5 ASIC:
 111 .Pp
 112 .Bl -bullet -compact
 113 .It
 114 Chelsio T580-CR
 115 .It
 116 Chelsio T580-LP-CR
 117 .It
 118 Chelsio T580-LP-SO-CR
 119 .It
 120 Chelsio T560-CR
 121 .It
 122 Chelsio T540-CR
 123 .It
 124 Chelsio T540-LP-CR
 125 .It
 126 Chelsio T522-CR
 127 .It
 128 Chelsio T520-LL-CR
 129 .It
 130 Chelsio T520-CR
 131 .It
 132 Chelsio T520-SO
 133 .It
 134 Chelsio T520-BT
 135 .It
 136 Chelsio T504-BT
 137 .El
 138 .Pp
 139 The
 140 .Nm
 141 driver supports 10Gb and 1Gb Ethernet adapters based on the T4 ASIC:
 142 .Pp
 143 .Bl -bullet -compact
 144 .It
 145 Chelsio T420-CR
 146 .It
 147 Chelsio T422-CR
 148 .It
 149 Chelsio T440-CR
 150 .It
 151 Chelsio T420-BCH
 152 .It
 153 Chelsio T440-BCH
 154 .It
 155 Chelsio T440-CH
 156 .It
 157 Chelsio T420-SO
 158 .It
 159 Chelsio T420-CX
 160 .It
 161 Chelsio T420-BT
 162 .It
 163 Chelsio T404-BT
 164 .El
 165 .Sh LOADER TUNABLES
 166 Tunables can be set at the
 167 .Xr loader 8
 168 prompt before booting the kernel or stored in
 169 .Xr loader.conf 5 .
 170 There are multiple tunables that control the number of queues of various
 171 types.
 172 A negative value for such a tunable instructs the driver to create
 173 up to that many queues if there are enough CPU cores available.
 174 .Bl -tag -width indent
 175 .It Va hw.cxgbe.ntxq
 176 Number of NIC tx queues used for a port.
 177 The default is 16 or the number
 178 of CPU cores in the system, whichever is less.
 179 .It Va hw.cxgbe.nrxq
 180 Number of NIC rx queues used for a port.
 181 The default is 8 or the number
 182 of CPU cores in the system, whichever is less.
 183 .It Va hw.cxgbe.nofldtxq
 184 Number of TOE tx queues used for a port.
 185 The default is 8 or the
 186 number of CPU cores in the system, whichever is less.
 187 .It Va hw.cxgbe.nofldrxq
 188 Number of TOE rx queues used for a port.
 189 The default is 2 or the
 190 number of CPU cores in the system, whichever is less.
 191 .It Va hw.cxgbe.num_vis
 192 Number of virtual interfaces (VIs) created for each port.
 193 Each virtual interface creates a separate network interface.
 194 The first virtual interface on each port is required and represents
 195 the primary network interface on the port.
 196 Additional virtual interfaces on a port are named using the Virtual Interface
 197 name from the table above.
 198 Additional virtual interfaces use a single pair of queues
 199 for rx and tx as well an additional pair of queues for TOE rx and tx.
 200 The default is 1.
 201 .It Va hw.cxgbe.holdoff_timer_idx
 202 .It Va hw.cxgbe.holdoff_timer_idx_ofld
 203 Timer index value used to delay interrupts.
 204 The holdoff timer list has the values 1, 5, 10, 50, 100, and 200
 205 by default (all values are in microseconds) and the index selects a
 206 value from this list.
 207 holdoff_timer_idx_ofld applies to queues used for TOE rx.
 208 The default value is 1 which means the timer value is 5us.
 209 Different interfaces can be assigned different values at any time via the
 210 dev.<port>.X.holdoff_tmr_idx and dev.<port>.X.holdoff_tmr_idx_ofld sysctls.
 211 .It Va hw.cxgbe.holdoff_pktc_idx
 212 .It Va hw.cxgbe.holdoff_pktc_idx_ofld
 213 Packet-count index value used to delay interrupts.
 214 The packet-count list has the values 1, 8, 16, and 32 by default,
 215 and the index selects a value from this list.
 216 holdoff_pktc_idx_ofld applies to queues used for TOE rx.
 217 The default value is -1 which means packet counting is disabled and interrupts
 218 are generated based solely on the holdoff timer value.
 219 Different interfaces can be assigned different values via the
 220 dev.<port>.X.holdoff_pktc_idx and dev.<port>.X.holdoff_pktc_idx_ofld sysctls.
 221 These sysctls work only when the interface has never been marked up (as done by
 222 ifconfig up).
 223 .It Va hw.cxgbe.qsize_txq
 224 Number of entries in a transmit queue's descriptor ring.
 225 A buf_ring of the same size is also allocated for additional
 226 software queuing.
 227 See
 228 .Xr ifnet 9 .
 229 The default value is 1024.
 230 Different interfaces can be assigned different values via the
 231 dev.<port>.X.qsize_txq sysctl.
 232 This sysctl works only when the interface has never been marked up (as done by
 233 ifconfig up).
 234 .It Va hw.cxgbe.qsize_rxq
 235 Number of entries in a receive queue's descriptor ring.
 236 The default value is 1024.
 237 Different interfaces can be assigned different values via the
 238 dev.<port>.X.qsize_rxq sysctl.
 239 This sysctl works only when the interface has never been marked up (as done by
 240 ifconfig up).
 241 .It Va hw.cxgbe.interrupt_types
 242 Permitted interrupt types.
 243 Bit 0 represents INTx (line interrupts), bit 1 MSI, and bit 2 MSI-X.
 244 The default is 7 (all allowed).
 245 The driver selects the best possible type out of the allowed types.
 246 .It Va hw.cxgbe.pcie_relaxed_ordering
 247 PCIe Relaxed Ordering.
 248 -1 indicates the driver should determine whether to enable or disable PCIe RO.
 249 0 disables PCIe RO.
 250 1 enables PCIe RO.
 251 2 indicates the driver should not modify the PCIe RO setting.
 252 The default is -1.
 253 .It Va hw.cxgbe.fw_install
 254 0 prohibits the driver from installing a firmware on the card.
 255 1 allows the driver to install a new firmware if internal driver
 256 heuristics indicate that the new firmware is preferable to the one
 257 already on the card.
 258 2 instructs the driver to always install the new firmware on the card as
 259 long as it is compatible with the driver and is a different version than
 260 the one already on the card.
 261 The default is 1.
 262 .It Va hw.cxgbe.fl_pktshift
 263 Number of padding bytes inserted before the beginning of an Ethernet
 264 frame in the receive buffer.
 265 The default value is 0.
 266 A value of of 2 would ensure that the Ethernet payload (usually the IP header)
 267 is at a 4 byte aligned address.
 268 0-7 are all valid values.
 269 .It Va hw.cxgbe.fl_pad
 270 A non-zero value ensures that writes from the hardware to a receive buffer are
 271 padded up to the specified boundary.
 272 The default is -1 which lets the driver pick a pad boundary.
 273 0 disables trailer padding completely.
 274 .It Va hw.cxgbe.cong_drop
 275 Controls the hardware response to congestion.
 276 -1 disables congestion feedback and is not recommended.
 277 0 instructs the hardware to backpressure its pipeline on congestion.
 278 This usually results in the port emitting PAUSE frames.
 279 1 instructs the hardware to drop frames destined for congested queues.
 280 .It Va hw.cxgbe.pause_settings
 281 PAUSE frame settings.
 282 Bit 0 is rx_pause, bit 1 is tx_pause, bit 2 is pause_autoneg.
 283 rx_pause = 1 instructs the hardware to heed incoming PAUSE frames, 0 instructs
 284 it to ignore them.
 285 tx_pause = 1 allows the hardware to emit PAUSE frames when its receive FIFO
 286 reaches a high threshold, 0 prohibits the hardware from emitting PAUSE frames.
 287 pause_autoneg = 1 overrides the rx_pause and tx_pause bits and instructs the
 288 hardware to negotiate PAUSE settings with the link peer.
 289 The default is 7 (all three = 1).
 290 This tunable establishes the default PAUSE settings for all ports.
 291 Settings can be displayed and controlled on a per-port basis via the
 292 dev.<port>.X.pause_settings sysctl.
 293 .It Va hw.cxgbe.fec
 294 FEC (Forward Error Correction) settings.
 295 0 diables FEC.
 296 Bit 0 enables RS FEC, bit 1 enables BASE-R FEC (aka Firecode FEC).
 297 The default is -1 which lets the driver pick a value.
 298 This tunable establishes the default FEC settings for all ports.
 299 Settings can be displayed and controlled on a per-port basis via the
 300 dev.<port>.X.fec sysctl.
 301 .It Va hw.cxgbe.autoneg
 302 Link autonegotiation settings.
 303 This tunable establishes the default autonegotiation settings for all ports.
 304 Settings can be displayed and controlled on a per-port basis via the
 305 dev.<port>.X.autoneg sysctl.
 306 0 disables autonegotiation.
 307 1 enables autonegotiation.
 308 The default is -1 which lets the driver pick a value.
 309 dev.<port>.X.autoneg is -1 for port and module combinations that do not support
 310 autonegotiation.
 311 .It Va hw.cxgbe.buffer_packing
 312 Allow the hardware to deliver multiple frames in the same receive buffer
 313 opportunistically.
 314 The default is -1 which lets the driver decide.
 315 0 or 1 explicitly disable or enable this feature.
 316 .It Va hw.cxgbe.allow_mbufs_in_cluster
 317 1 allows the driver to lay down one or more mbufs within the receive buffer
 318 opportunistically.
 319 This is the default.
 320 0 prohibits the driver from doing so.
 321 .It Va hw.cxgbe.largest_rx_cluster
 322 .It Va hw.cxgbe.safest_rx_cluster
 323 Sizes of rx clusters.
 324 Each of these must be set to one of the sizes available
 325 (usually 2048, 4096, 9216, and 16384) and largest_rx_cluster must be greater
 326 than or equal to safest_rx_cluster.
 327 The defaults are 16384 and 4096 respectively.
 328 The driver never attempts to allocate a receive buffer larger than
 329 largest_rx_cluster and falls back to allocating buffers of
 330 safest_rx_cluster size if an allocation larger than safest_rx_cluster fails.
 331 Note that largest_rx_cluster merely establishes a ceiling -- the driver is
 332 allowed to allocate buffers of smaller sizes.
 333 .It Va hw.cxgbe.config_file
 334 Select a pre-packaged device configuration file.
 335 A configuration file contains a recipe for partitioning and configuring the
 336 hardware resources on the card.
 337 This tunable is for specialized applications only and should not be used in
 338 normal operation.
 339 The configuration profile currently in use is available in the dev.<nexus>.X.cf
 340 and dev.<nexus>.X.cfcsum sysctls.
 341 .It Va hw.cxgbe.linkcaps_allowed
 342 .It Va hw.cxgbe.niccaps_allowed
 343 .It Va hw.cxgbe.toecaps_allowed
 344 .It Va hw.cxgbe.rdmacaps_allowed
 345 .It Va hw.cxgbe.iscsicaps_allowed
 346 .It Va hw.cxgbe.fcoecaps_allowed
 347 Disallowing capabilities provides a hint to the driver and firmware to not
 348 reserve hardware resources for that feature.
 349 Each of these is a bit field with a bit for each sub-capability within the
 350 capability.
 351 This tunable is for specialized applications only and should not be used in
 352 normal operation.
 353 The capabilities for which hardware resources have been reserved are listed in
 354 dev.<nexus>.X.*caps sysctls.
 355 .El
 356 .Sh SUPPORT
 357 For general information and support,
 358 go to the Chelsio support website at:
 359 .Pa http://www.chelsio.com/ .
 360 .Pp
 361 If an issue is identified with this driver with a supported adapter,
 362 email all the specific information related to the issue to
 363 .Aq Mt support@chelsio.com .
 364 .Sh SEE ALSO
 365 .Xr altq 4 ,
 366 .Xr arp 4 ,
 367 .Xr ccr 4 ,
 368 .Xr cxgb 4 ,
 369 .Xr cxgbev 4 ,
 370 .Xr netintro 4 ,
 371 .Xr ng_ether 4 ,
 372 .Xr ifconfig 8
 373 .Sh HISTORY
 374 The
 375 .Nm
 376 device driver first appeared in
 377 .Fx 9.0 .
 378 Support for T5 cards first appeared in
 379 .Fx 9.2
 380 and
 381 .Fx 10.0 .
 382 Support for T6 cards first appeared in
 383 .Fx 11.1
 384 and
 385 .Fx 12.0 .
 386 .Sh AUTHORS
 387 .An -nosplit
 388 The
 389 .Nm
 390 driver was written by
 391 .An Navdeep Parhar Aq Mt np@FreeBSD.org .