share/man/man4/cxgbe.4

   1 .\" Copyright (c) 2011-2014, 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 December 2, 2015
  35 .Dt CXGBE 4
  36 .Os
  37 .Sh NAME
  38 .Nm cxgbe
  39 .Nd "Chelsio T4 and T5 based 40Gb, 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 if_cxgbe_load="YES"
  55 .Ed
  56 .Sh DESCRIPTION
  57 The
  58 .Nm
  59 driver provides support for PCI Express Ethernet adapters based on
  60 the Chelsio Terminator 4 and Terminator 5 ASICs (T4 and T5).
  61 The driver supports Jumbo Frames, Transmit/Receive checksum offload,
  62 TCP segmentation offload (TSO), Large Receive Offload (LRO), VLAN
  63 tag insertion/extraction, VLAN checksum offload, VLAN TSO, and
  64 Receive Side Steering (RSS).
  65 For further hardware information and questions related to hardware
  66 requirements, see
  67 .Pa http://www.chelsio.com/ .
  68 .Pp
  69 Note that ports of T5 cards are named cxl and attach to a t5nex parent device
  70 (in contrast to ports named cxgbe that attach to a t4nex parent for a T4 card).
  71 Loader tunables with the hw.cxgbe prefix apply to both T4 and T5 cards.
  72 The sysctl MIBs are at dev.t5nex and dev.cxl for T5 cards and at dev.t4nex and
  73 dev.cxgbe for T4 cards.
  74 .Pp
  75 For more information on configuring this device, see
  76 .Xr ifconfig 8 .
  77 .Sh HARDWARE
  78 The
  79 .Nm
  80 driver supports 40Gb, 10Gb and 1Gb Ethernet adapters based on the T5 ASIC
  81 (ports will be named cxl):
  82 .Pp
  83 .Bl -bullet -compact
  84 .It
  85 Chelsio T580-CR
  86 .It
  87 Chelsio T580-LP-CR
  88 .It
  89 Chelsio T580-LP-SO-CR
  90 .It
  91 Chelsio T560-CR
  92 .It
  93 Chelsio T540-CR
  94 .It
  95 Chelsio T540-LP-CR
  96 .It
  97 Chelsio T522-CR
  98 .It
  99 Chelsio T520-LL-CR
 100 .It
 101 Chelsio T520-CR
 102 .It
 103 Chelsio T520-SO
 104 .It
 105 Chelsio T520-BT
 106 .It
 107 Chelsio T504-BT
 108 .El
 109 .Pp
 110 The
 111 .Nm
 112 driver supports 10Gb and 1Gb Ethernet adapters based on the T4 ASIC:
 113 .Pp
 114 .Bl -bullet -compact
 115 .It
 116 Chelsio T420-CR
 117 .It
 118 Chelsio T422-CR
 119 .It
 120 Chelsio T440-CR
 121 .It
 122 Chelsio T420-BCH
 123 .It
 124 Chelsio T440-BCH
 125 .It
 126 Chelsio T440-CH
 127 .It
 128 Chelsio T420-SO
 129 .It
 130 Chelsio T420-CX
 131 .It
 132 Chelsio T420-BT
 133 .It
 134 Chelsio T404-BT
 135 .El
 136 .Sh LOADER TUNABLES
 137 Tunables can be set at the
 138 .Xr loader 8
 139 prompt before booting the kernel or stored in
 140 .Xr loader.conf 5 .
 141 .Bl -tag -width indent
 142 .It Va hw.cxgbe.ntxq10g
 143 The number of tx queues to use for a 10Gb or 40Gb port.
 144 The default is 16 or the number
 145 of CPU cores in the system, whichever is less.
 146 .It Va hw.cxgbe.nrxq10g
 147 The number of rx queues to use for a 10Gb or 40Gb port.
 148 The default is 8 or the number
 149 of CPU cores in the system, whichever is less.
 150 .It Va hw.cxgbe.ntxq1g
 151 The number of tx queues to use for a 1Gb port.
 152 The default is 4 or the number
 153 of CPU cores in the system, whichever is less.
 154 .It Va hw.cxgbe.nrxq1g
 155 The number of rx queues to use for a 1Gb port.
 156 The default is 2 or the number
 157 of CPU cores in the system, whichever is less.
 158 .It Va hw.cxgbe.nofldtxq10g
 159 The number of TOE tx queues to use for a 10Gb or 40Gb port.
 160 The default is 8 or the
 161 number of CPU cores in the system, whichever is less.
 162 .It Va hw.cxgbe.nofldrxq10g
 163 The number of TOE rx queues to use for a 10Gb or 40Gb port.
 164 The default is 2 or the
 165 number of CPU cores in the system, whichever is less.
 166 .It Va hw.cxgbe.nofldtxq1g
 167 The number of TOE tx queues to use for a 1Gb port.
 168 The default is 2 or the
 169 number of CPU cores in the system, whichever is less.
 170 .It Va hw.cxgbe.nofldrxq1g
 171 The number of TOE rx queues to use for a 1Gb port.
 172 The default is 1.
 173 .It Va hw.cxgbe.num_vis
 174 The number of virtual interfaces (VIs) created for each port.
 175 Each virtual interface creates a separate network interface.
 176 The first virtual interface on each port is required and represents
 177 the primary network interface on the port.
 178 Additional virtual interfaces on a port are named vcxgbe (T4) or
 179 vcxl (T5) and only use a single rx and tx queue.
 180 Additional virtual interfaces use a single pair of queues
 181 for rx and tx as well an additional pair of queues for TOE rx and tx.
 182 The default is 1.
 183 .It Va hw.cxgbe.holdoff_timer_idx_10G
 184 .It Va hw.cxgbe.holdoff_timer_idx_1G
 185 The timer index value to use to delay interrupts.
 186 The holdoff timer list has the values 1, 5, 10, 50, 100, and 200
 187 by default (all values are in microseconds) and the index selects a
 188 value from this list.
 189 The default value is 1 which means the timer value is 5us.
 190 Different interfaces can be assigned different values at any time via the
 191 dev.cxgbe.X.holdoff_tmr_idx or dev.cxl.X.holdoff_tmr_idx sysctl.
 192 .It Va hw.cxgbe.holdoff_pktc_idx_10G
 193 .It Va hw.cxgbe.holdoff_pktc_idx_1G
 194 The packet-count index value to use to delay interrupts.
 195 The packet-count list has the values 1, 8, 16, and 32 by default
 196 and the index selects a value from this list.
 197 The default value is -1 which means packet counting is disabled and interrupts
 198 are generated based solely on the holdoff timer value.
 199 Different interfaces can be assigned different values via the
 200 dev.cxgbe.X.holdoff_pktc_idx or dev.cxl.X.holdoff_pktc_idx sysctl.
 201 This sysctl works only when the interface has never been marked up (as done by
 202 ifconfig up).
 203 .It Va hw.cxgbe.qsize_txq
 204 The size, in number of entries, of the descriptor ring used for a tx
 205 queue.
 206 A buf_ring of the same size is also allocated for additional
 207 software queuing.
 208 See
 209 .Xr ifnet 9 .
 210 The default value is 1024.
 211 Different interfaces can be assigned different values via the
 212 dev.cxgbe.X.qsize_txq sysctl or dev.cxl.X.qsize_txq sysctl.
 213 This sysctl works only when the interface has never been marked up (as done by
 214 ifconfig up).
 215 .It Va hw.cxgbe.qsize_rxq
 216 The size, in number of entries, of the descriptor ring used for an
 217 rx queue.
 218 The default value is 1024.
 219 Different interfaces can be assigned different values via the
 220 dev.cxgbe.X.qsize_rxq or dev.cxl.X.qsize_rxq sysctl.
 221 This sysctl works only when the interface has never been marked up (as done by
 222 ifconfig up).
 223 .It Va hw.cxgbe.interrupt_types
 224 The interrupt types that the driver is allowed to use.
 225 Bit 0 represents INTx (line interrupts), bit 1 MSI, bit 2 MSI-X.
 226 The default is 7 (all allowed).
 227 The driver will select the best possible type out of the allowed types by
 228 itself.
 229 .It Va hw.cxgbe.fw_install
 230 0 prohibits the driver from installing a firmware on the card.
 231 1 allows the driver to install a new firmware if internal driver
 232 heuristics indicate that the new firmware is preferable to the one
 233 already on the card.
 234 2 instructs the driver to always install the new firmware on the card as
 235 long as it is compatible with the driver and is a different version than
 236 the one already on the card.
 237 The default is 1.
 238 .It Va hw.cxgbe.fl_pktshift
 239 The number of bytes of padding inserted before the begining of an Ethernet
 240 frame in the receive buffer.
 241 The default value of 2 ensures that the Ethernet payload (usually the IP header)
 242 is at a 4 byte aligned address.
 243 0-7 are all valid values.
 244 .It Va hw.cxgbe.fl_pad
 245 A non-zero value ensures that writes from the hardware to a receive buffer are
 246 padded up to the specified boundary.
 247 The default is -1 which lets the driver pick a pad boundary.
 248 0 disables trailer padding completely.
 249 .It Va hw.cxgbe.cong_drop
 250 Controls the hardware response to congestion.
 251 -1 disables congestion feedback and is not recommended.
 252 0 instructs the hardware to backpressure its pipeline on congestion.
 253 This usually results in the port emitting PAUSE frames.
 254 1 instructs the hardware to drop frames destined for congested queues.
 255 .It Va hw.cxgbe.pause_settings
 256 PAUSE frame settings.
 257 Bit 0 is rx_pause, bit 1 is tx_pause.
 258 rx_pause = 1 instructs the hardware to heed incoming PAUSE frames, 0 instructs
 259 it to ignore them.
 260 tx_pause = 1 allows the hardware to emit PAUSE frames when its receive FIFO
 261 reaches a high threshold, 0 prohibits the hardware from emitting PAUSE frames.
 262 The default is 3 (both rx_pause and tx_pause = 1).
 263 This tunable establishes the default PAUSE settings for all ports.
 264 Settings can be displayed and controlled on a per-port basis via the
 265 dev.cxgbe.X.pause_settings (dev.cxl.X.pause_settings for T5 cards) sysctl.
 266 .It Va hw.cxgbe.buffer_packing
 267 Allow the hardware to deliver multiple frames in the same receive buffer
 268 opportunistically.
 269 The default is -1 which lets the driver decide.
 270 0 or 1 explicitly disable or enable this feature.
 271 .It Va hw.cxgbe.allow_mbufs_in_cluster
 272 1 allows the driver to lay down one or more mbufs within the receive buffer
 273 opportunistically.  This is the default.
 274 0 prohibits the driver from doing so.
 275 .It Va hw.cxgbe.largest_rx_cluster
 276 .It Va hw.cxgbe.safest_rx_cluster
 277 Sizes of rx clusters.  Each of these must be set to one of the sizes available
 278 (usually 2048, 4096, 9216, and 16384) and largest_rx_cluster must be greater
 279 than or equal to safest_rx_cluster.
 280 The defaults are 16384 and 4096 respectively.
 281 The driver will never attempt to allocate a receive buffer larger than
 282 largest_rx_cluster and will fall back to allocating buffers of
 283 safest_rx_cluster size if an allocation larger than safest_rx_cluster fails.
 284 Note that largest_rx_cluster merely establishes a ceiling -- the driver is
 285 allowed to allocate buffers of smaller sizes.
 286 .It Va hw.cxgbe.config_file
 287 Select a pre-packaged device configuration file.
 288 A configuration file contains a recipe for partitioning and configuring the
 289 hardware resources on the card.
 290 This tunable is for specialized applications only and should not be used in
 291 normal operation.
 292 The configuration profile currently in use is available in the dev.t4nex.X.cf
 293 and dev.t4nex.X.cfcsum (dev.t5nex for T5 cards) sysctls.
 294 .It Va hw.cxgbe.linkcaps_allowed
 295 .It Va hw.cxgbe.niccaps_allowed
 296 .It Va hw.cxgbe.toecaps_allowed
 297 .It Va hw.cxgbe.rdmacaps_allowed
 298 .It Va hw.cxgbe.iscsicaps_allowed
 299 .It Va hw.cxgbe.fcoecaps_allowed
 300 Disallowing capabilities provides a hint to the driver and firmware to not
 301 reserve hardware resources for that feature.
 302 Each of these is a bit field with a bit for each sub-capability within the
 303 capability.
 304 This tunable is for specialized applications only and should not be used in
 305 normal operation.
 306 The capabilities for which hardware resources have been reserved are listed in
 307 dev.t4nex.X.*caps or dev.t5nex.X.*caps sysctls.
 308 .El
 309 .Sh SUPPORT
 310 For general information and support,
 311 go to the Chelsio support website at:
 312 .Pa http://www.chelsio.com/ .
 313 .Pp
 314 If an issue is identified with this driver with a supported adapter,
 315 email all the specific information related to the issue to
 316 .Aq Mt support@chelsio.com .
 317 .Sh SEE ALSO
 318 .Xr altq 4 ,
 319 .Xr arp 4 ,
 320 .Xr cxgb 4 ,
 321 .Xr netintro 4 ,
 322 .Xr ng_ether 4 ,
 323 .Xr ifconfig 8
 324 .Sh HISTORY
 325 The
 326 .Nm
 327 device driver first appeared in
 328 .Fx 9.0 .
 329 Support for T5 cards first appeared in
 330 .Fx 9.2
 331 and
 332 .Fx 10.0 .
 333 .Sh AUTHORS
 334 .An -nosplit
 335 The
 336 .Nm
 337 driver was written by
 338 .An Navdeep Parhar Aq Mt np@FreeBSD.org .