share/man/man4/cxgbe.4

   1 .\" Copyright (c) 2011-2012, 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 February 25, 2012
  35 .Dt CXGBE 4
  36 .Os
  37 .Sh NAME
  38 .Nm cxgbe
  39 .Nd "Chelsio T4 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 if_cxgbe_load="YES"
  54 .Ed
  55 .Sh DESCRIPTION
  56 The
  57 .Nm
  58 driver provides support for PCI Express Ethernet adapters based on
  59 the Chelsio Terminator 4 (T4) ASIC.
  60 The driver supports Jumbo Frames, Transmit/Receive checksum offload,
  61 TCP segmentation offload (TSO), Large Receive Offload (LRO), VLAN
  62 tag insertion/extraction, VLAN checksum offload, VLAN TSO, and
  63 Receive Side Steering (RSS).
  64 For further hardware information and questions related to hardware
  65 requirements, see
  66 .Pa http://www.chelsio.com/ .
  67 .Pp
  68 For more information on configuring this device, see
  69 .Xr ifconfig 8 .
  70 .Sh HARDWARE
  71 The
  72 .Nm
  73 driver supports 10Gb and 1Gb Ethernet adapters based on the T4 ASIC:
  74 .Pp
  75 .Bl -bullet -compact
  76 .It
  77 Chelsio T420-CR
  78 .It
  79 Chelsio T422-CR
  80 .It
  81 Chelsio T440-CR
  82 .It
  83 Chelsio T420-BCH
  84 .It
  85 Chelsio T440-BCH
  86 .It
  87 Chelsio T440-CH
  88 .It
  89 Chelsio T420-SO
  90 .It
  91 Chelsio T420-CX
  92 .It
  93 Chelsio T420-BT
  94 .It
  95 Chelsio T404-BT
  96 .El
  97 .Sh LOADER TUNABLES
  98 Tunables can be set at the
  99 .Xr loader 8
 100 prompt before booting the kernel or stored in
 101 .Xr loader.conf 5 .
 102 .Bl -tag -width indent
 103 .It Va hw.cxgbe.ntxq10g
 104 The number of tx queues to use for a 10Gb port.
 105 The default is 16 or the number
 106 of CPU cores in the system, whichever is less.
 107 .It Va hw.cxgbe.nrxq10g
 108 The number of rx queues to use for a 10Gb port.
 109 The default is 8 or the number
 110 of CPU cores in the system, whichever is less.
 111 .It Va hw.cxgbe.ntxq1g
 112 The number of tx queues to use for a 1Gb port.
 113 The default is 4 or the number
 114 of CPU cores in the system, whichever is less.
 115 .It Va hw.cxgbe.nrxq1g
 116 The number of rx queues to use for a 1Gb port.
 117 The default is 2 or the number
 118 of CPU cores in the system, whichever is less.
 119 .It Va hw.cxgbe.nofldtxq10g
 120 The number of TOE tx queues to use for a 10Gb port.
 121 The default is 8 or the
 122 number of CPU cores in the system, whichever is less.
 123 .It Va hw.cxgbe.nofldrxq10g
 124 The number of TOE rx queues to use for a 10Gb port.
 125 The default is 2 or the
 126 number of CPU cores in the system, whichever is less.
 127 .It Va hw.cxgbe.nofldtxq1g
 128 The number of TOE tx queues to use for a 1Gb port.
 129 The default is 2 or the
 130 number of CPU cores in the system, whichever is less.
 131 .It Va hw.cxgbe.nofldrxq1g
 132 The number of TOE rx queues to use for a 1Gb port.
 133 The default is 1.
 134 .It Va hw.cxgbe.holdoff_timer_idx_10G
 135 .It Va hw.cxgbe.holdoff_timer_idx_1G
 136 The timer index value to use to delay interrupts.
 137 The holdoff timer list has the values 1, 5, 10, 50, 100, and 200
 138 by default (all values are in microseconds) and the index selects a
 139 value from this list.
 140 The default value is 1 for both 10Gb and 1Gb ports, which means the
 141 timer value is 5us.
 142 Different cxgbe interfaces can be assigned different values at any time via the
 143 dev.cxgbe.X.holdoff_tmr_idx sysctl.
 144 .It Va hw.cxgbe.holdoff_pktc_idx_10G
 145 .It Va hw.cxgbe.holdoff_pktc_idx_1G
 146 The packet-count index value to use to delay interrupts.
 147 The packet-count list has the values 1, 8, 16, and 32 by default
 148 and the index selects a value from this list.
 149 The default value is -1 for both 10Gb and 1Gb ports, which means packet
 150 counting is disabled and interrupts are generated based solely on the
 151 holdoff timer value.
 152 Different cxgbe interfaces can be assigned different values via the
 153 dev.cxgbe.X.holdoff_pktc_idx sysctl.
 154 This sysctl works only when the interface has never been marked up (as done by
 155 ifconfig up).
 156 .It Va hw.cxgbe.qsize_txq
 157 The size, in number of entries, of the descriptor ring used for a tx
 158 queue.
 159 A buf_ring of the same size is also allocated for additional
 160 software queuing.
 161 See
 162 .Xr ifnet 9 .
 163 The default value is 1024.
 164 Different cxgbe interfaces can be assigned different values via the
 165 dev.cxgbe.X.qsize_txq sysctl.
 166 This sysctl works only when the interface has never been marked up (as done by
 167 ifconfig up).
 168 .It Va hw.cxgbe.qsize_rxq
 169 The size, in number of entries, of the descriptor ring used for an
 170 rx queue.
 171 The default value is 1024.
 172 Different cxgbe interfaces can be assigned different values via the
 173 dev.cxgbe.X.qsize_rxq sysctl.
 174 This sysctl works only when the interface has never been marked up (as done by
 175 ifconfig up).
 176 .It Va hw.cxgbe.interrupt_types
 177 The interrupt types that the driver is allowed to use.
 178 Bit 0 represents INTx (line interrupts), bit 1 MSI, bit 2 MSI-X.
 179 The default is 7 (all allowed).
 180 The driver will select the best possible type out of the allowed types by
 181 itself.
 182 .It Va hw.cxgbe.fw_install
 183 0 prohibits the driver from installing a firmware on the card.
 184 1 allows the driver to install a new firmware if internal driver
 185 heuristics indicate that the new firmware is preferable to the one
 186 already on the card.
 187 2 instructs the driver to always install the new firmware on the card as
 188 long as it is compatible with the driver and is a different version than
 189 the one already on the card.
 190 The default is 1.
 191 .It Va hw.cxgbe.config_file
 192 Select a pre-packaged device configuration file.
 193 A configuration file contains a recipe for partitioning and configuring the
 194 hardware resources on the card.
 195 This tunable is for specialized applications only and should not be used in
 196 normal operation.
 197 The configuration profile currently in use is available in the dev.t4nex.X.cf
 198 and dev.t4nex.X.cfcsum sysctls.
 199 .It Va hw.cxgbe.linkcaps_allowed
 200 .It Va hw.cxgbe.niccaps_allowed
 201 .It Va hw.cxgbe.toecaps_allowed
 202 .It Va hw.cxgbe.rdmacaps_allowed
 203 .It Va hw.cxgbe.iscsicaps_allowed
 204 .It Va hw.cxgbe.fcoecaps_allowed
 205 Disallowing capabilities provides a hint to the driver and firmware to not
 206 reserve hardware resources for that feature.
 207 Each of these is a bit field with a bit for each sub-capability within the
 208 capability.
 209 This tunable is for specialized applications only and should not be used in
 210 normal operation.
 211 The capabilities for which hardware resources have been reserved are listed in
 212 dev.t4nex.X.*caps sysctls.
 213 .El
 214 .Sh SUPPORT
 215 For general information and support,
 216 go to the Chelsio support website at:
 217 .Pa http://www.chelsio.com/ .
 218 .Pp
 219 If an issue is identified with this driver with a supported adapter,
 220 email all the specific information related to the issue to
 221 .Aq support@chelsio.com .
 222 .Sh SEE ALSO
 223 .Xr altq 4 ,
 224 .Xr arp 4 ,
 225 .Xr cxgb 4 ,
 226 .Xr netintro 4 ,
 227 .Xr ng_ether 4 ,
 228 .Xr ifconfig 8
 229 .Sh HISTORY
 230 The
 231 .Nm
 232 device driver first appeared in
 233 .Fx 9.0 .
 234 .Sh AUTHORS
 235 .An -nosplit
 236 The
 237 .Nm
 238 driver was written by
 239 .An Navdeep Parhar Aq np@FreeBSD.org .