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