share/man/man4/cxgbe.4

   1 .\" Copyright (c) 2011-2013, 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 18, 2013
  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 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 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 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 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 for both 10Gb and 1Gb ports, which means the
 181 timer value is 5us.
 182 Different interfaces can be assigned different values at any time via the
 183 dev.cxgbe.X.holdoff_tmr_idx or dev.cxl.X.holdoff_tmr_idx sysctl.
 184 .It Va hw.cxgbe.holdoff_pktc_idx_10G
 185 .It Va hw.cxgbe.holdoff_pktc_idx_1G
 186 The packet-count index value to use to delay interrupts.
 187 The packet-count list has the values 1, 8, 16, and 32 by default
 188 and the index selects a value from this list.
 189 The default value is -1 for both 10Gb and 1Gb ports, which means packet
 190 counting is disabled and interrupts are generated based solely on the
 191 holdoff timer value.
 192 Different interfaces can be assigned different values via the
 193 dev.cxgbe.X.holdoff_pktc_idx or dev.cxl.X.holdoff_pktc_idx sysctl.
 194 This sysctl works only when the interface has never been marked up (as done by
 195 ifconfig up).
 196 .It Va hw.cxgbe.qsize_txq
 197 The size, in number of entries, of the descriptor ring used for a tx
 198 queue.
 199 A buf_ring of the same size is also allocated for additional
 200 software queuing.
 201 See
 202 .Xr ifnet 9 .
 203 The default value is 1024.
 204 Different interfaces can be assigned different values via the
 205 dev.cxgbe.X.qsize_txq sysctl or dev.cxl.X.qsize_txq sysctl.
 206 This sysctl works only when the interface has never been marked up (as done by
 207 ifconfig up).
 208 .It Va hw.cxgbe.qsize_rxq
 209 The size, in number of entries, of the descriptor ring used for an
 210 rx queue.
 211 The default value is 1024.
 212 Different interfaces can be assigned different values via the
 213 dev.cxgbe.X.qsize_rxq or dev.cxl.X.qsize_rxq sysctl.
 214 This sysctl works only when the interface has never been marked up (as done by
 215 ifconfig up).
 216 .It Va hw.cxgbe.interrupt_types
 217 The interrupt types that the driver is allowed to use.
 218 Bit 0 represents INTx (line interrupts), bit 1 MSI, bit 2 MSI-X.
 219 The default is 7 (all allowed).
 220 The driver will select the best possible type out of the allowed types by
 221 itself.
 222 .It Va hw.cxgbe.fw_install
 223 0 prohibits the driver from installing a firmware on the card.
 224 1 allows the driver to install a new firmware if internal driver
 225 heuristics indicate that the new firmware is preferable to the one
 226 already on the card.
 227 2 instructs the driver to always install the new firmware on the card as
 228 long as it is compatible with the driver and is a different version than
 229 the one already on the card.
 230 The default is 1.
 231 .It Va hw.cxgbe.config_file
 232 Select a pre-packaged device configuration file.
 233 A configuration file contains a recipe for partitioning and configuring the
 234 hardware resources on the card.
 235 This tunable is for specialized applications only and should not be used in
 236 normal operation.
 237 The configuration profile currently in use is available in the dev.t4nex.X.cf
 238 and dev.t4nex.X.cfcsum sysctls.
 239 .It Va hw.cxgbe.linkcaps_allowed
 240 .It Va hw.cxgbe.niccaps_allowed
 241 .It Va hw.cxgbe.toecaps_allowed
 242 .It Va hw.cxgbe.rdmacaps_allowed
 243 .It Va hw.cxgbe.iscsicaps_allowed
 244 .It Va hw.cxgbe.fcoecaps_allowed
 245 Disallowing capabilities provides a hint to the driver and firmware to not
 246 reserve hardware resources for that feature.
 247 Each of these is a bit field with a bit for each sub-capability within the
 248 capability.
 249 This tunable is for specialized applications only and should not be used in
 250 normal operation.
 251 The capabilities for which hardware resources have been reserved are listed in
 252 dev.t4nex.X.*caps sysctls.
 253 .El
 254 .Sh SUPPORT
 255 For general information and support,
 256 go to the Chelsio support website at:
 257 .Pa http://www.chelsio.com/ .
 258 .Pp
 259 If an issue is identified with this driver with a supported adapter,
 260 email all the specific information related to the issue to
 261 .Aq support@chelsio.com .
 262 .Sh SEE ALSO
 263 .Xr altq 4 ,
 264 .Xr arp 4 ,
 265 .Xr cxgb 4 ,
 266 .Xr netintro 4 ,
 267 .Xr ng_ether 4 ,
 268 .Xr ifconfig 8
 269 .Sh HISTORY
 270 The
 271 .Nm
 272 device driver first appeared in
 273 .Fx 9.0 .
 274 Support for T5 cards first appeared in
 275 .Fx 9.2
 276 and
 277 .Fx 10.0 .
 278 .Sh AUTHORS
 279 .An -nosplit
 280 The
 281 .Nm
 282 driver was written by
 283 .An Navdeep Parhar Aq np@FreeBSD.org .