share/man/man4/cxgbev.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 August 22, 2016
  35 .Dt CXGBEV 4
  36 .Os
  37 .Sh NAME
  38 .Nm cxgbev
  39 .Nd "Chelsio T4 and T5 based 40Gb, 10Gb, and 1Gb Ethernet VF 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 .Cd "device cxgbev"
  47 .Ed
  48 .Pp
  49 To load the driver as a
  50 module at boot time, place the following line in
  51 .Xr loader.conf 5 :
  52 .Bd -literal -offset indent
  53 if_cxgbev_load="YES"
  54 .Ed
  55 .Sh DESCRIPTION
  56 The
  57 .Nm
  58 driver provides support for Virtual Functions on PCI Express Ethernet adapters
  59 based on the Chelsio Terminator 4 and Terminator 5 ASICs (T4 and T5).
  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 Note that ports of T5 VFs are named cxlv and attach to a t5vf parent device
  69 (in contrast to ports named cxgbev that attach to a t4vf parent for a T4 VF).
  70 Loader tunables with the hw.cxgbe prefix apply to both T4 and T5 VFs.
  71 The Physical Function driver for T4 and T5 adapters shares these tunables.
  72 The sysctl MIBs are at dev.t5vf and dev.cxlv for T5 cards and at dev.t4vf and
  73 dev.cxgbev 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 Virtual Functions on 40Gb, 10Gb and 1Gb Ethernet adapters
  81 based on the T5 ASIC:
  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 Virtual Functions on 10Gb and 1Gb Ethernet adapters based
 113 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.holdoff_timer_idx_10G
 160 .It Va hw.cxgbe.holdoff_timer_idx_1G
 161 The timer index value to use to delay interrupts.
 162 The holdoff timer list has the values 1, 5, 10, 50, 100, and 200
 163 by default (all values are in microseconds) and the index selects a
 164 value from this list.
 165 The default value is 1 which means the timer value is 5us.
 166 Different interfaces can be assigned different values at any time via the
 167 dev.cxgbev.X.holdoff_tmr_idx or dev.cxlv.X.holdoff_tmr_idx sysctl.
 168 .It Va hw.cxgbe.holdoff_pktc_idx_10G
 169 .It Va hw.cxgbe.holdoff_pktc_idx_1G
 170 The packet-count index value to use to delay interrupts.
 171 The packet-count list has the values 1, 8, 16, and 32 by default
 172 and the index selects a value from this list.
 173 The default value is -1 which means packet counting is disabled and interrupts
 174 are generated based solely on the holdoff timer value.
 175 Different interfaces can be assigned different values via the
 176 dev.cxgbev.X.holdoff_pktc_idx or dev.cxlv.X.holdoff_pktc_idx sysctl.
 177 This sysctl works only when the interface has never been marked up (as done by
 178 ifconfig up).
 179 .It Va hw.cxgbe.qsize_txq
 180 The size, in number of entries, of the descriptor ring used for a tx
 181 queue.
 182 A buf_ring of the same size is also allocated for additional
 183 software queuing.
 184 See
 185 .Xr ifnet 9 .
 186 The default value is 1024.
 187 Different interfaces can be assigned different values via the
 188 dev.cxgbev.X.qsize_txq sysctl or dev.cxlv.X.qsize_txq sysctl.
 189 This sysctl works only when the interface has never been marked up (as done by
 190 ifconfig up).
 191 .It Va hw.cxgbe.qsize_rxq
 192 The size, in number of entries, of the descriptor ring used for an
 193 rx queue.
 194 The default value is 1024.
 195 Different interfaces can be assigned different values via the
 196 dev.cxgbev.X.qsize_rxq or dev.cxlv.X.qsize_rxq sysctl.
 197 This sysctl works only when the interface has never been marked up (as done by
 198 ifconfig up).
 199 .It Va hw.cxgbe.interrupt_types
 200 The interrupt types that the driver is allowed to use.
 201 Bit 0 represents INTx (line interrupts), bit 1 MSI, bit 2 MSI-X.
 202 The default is 7 (all allowed).
 203 The driver will select the best possible type out of the allowed types by
 204 itself.
 205 .It Va hw.cxgbe.fl_pktshift
 206 The number of bytes of padding inserted before the beginning of an Ethernet
 207 frame in the receive buffer.
 208 The default value of 2 ensures that the Ethernet payload (usually the IP header)
 209 is at a 4 byte aligned address.
 210 0-7 are all valid values.
 211 .It Va hw.cxgbe.fl_pad
 212 A non-zero value ensures that writes from the hardware to a receive buffer are
 213 padded up to the specified boundary.
 214 The default is -1 which lets the driver pick a pad boundary.
 215 0 disables trailer padding completely.
 216 .It Va hw.cxgbe.buffer_packing
 217 Allow the hardware to deliver multiple frames in the same receive buffer
 218 opportunistically.
 219 The default is -1 which lets the driver decide.
 220 0 or 1 explicitly disable or enable this feature.
 221 .It Va hw.cxgbe.allow_mbufs_in_cluster
 222 1 allows the driver to lay down one or more mbufs within the receive buffer
 223 opportunistically.
 224 This is the default.
 225 0 prohibits the driver from doing so.
 226 .It Va hw.cxgbe.largest_rx_cluster
 227 .It Va hw.cxgbe.safest_rx_cluster
 228 Sizes of rx clusters.
 229 Each of these must be set to one of the sizes available
 230 (usually 2048, 4096, 9216, and 16384) and largest_rx_cluster must be greater
 231 than or equal to safest_rx_cluster.
 232 The defaults are 16384 and 4096 respectively.
 233 The driver will never attempt to allocate a receive buffer larger than
 234 largest_rx_cluster and will fall back to allocating buffers of
 235 safest_rx_cluster size if an allocation larger than safest_rx_cluster fails.
 236 Note that largest_rx_cluster merely establishes a ceiling -- the driver is
 237 allowed to allocate buffers of smaller sizes.
 238 .El
 239 .Pp
 240 Certain settings and resources for Virtual Functions are dictated
 241 by the parent Physical Function driver.
 242 For example, the Physical Function driver limits the number of queues a
 243 Virtual Function is permitted to use.
 244 Some of these limits can be adjusted in the firmware configuration file
 245 used with the Physical Function driver.
 246 .Pp
 247 The PAUSE settings on the port of a Virtual Function are inherited from
 248 the settings of the same port on the Physical Function.
 249 Virtual Functions cannot modify the setting and track changes made to
 250 the associated port's setting by the Physical Function driver.
 251 .Pp
 252 Receive queues on a Virtual Function always drop packets in response to
 253 congestion
 254 .Po
 255 equivalent to setting
 256 .Va hw.cxgbe.cong_drop
 257 to 1
 258 .Pc .
 259 .Pp
 260 The VF driver currently depends on the PF driver.
 261 As a result, loading the VF driver will also load the PF driver as a
 262 dependency.
 263 .Sh SUPPORT
 264 For general information and support,
 265 go to the Chelsio support website at:
 266 .Pa http://www.chelsio.com/ .
 267 .Pp
 268 If an issue is identified with this driver with a supported adapter,
 269 email all the specific information related to the issue to
 270 .Aq Mt support@chelsio.com .
 271 .Sh SEE ALSO
 272 .Xr altq 4 ,
 273 .Xr arp 4 ,
 274 .Xr cxgbe 4 ,
 275 .Xr netintro 4 ,
 276 .Xr ng_ether 4 ,
 277 .Xr ifconfig 8
 278 .Sh HISTORY
 279 The
 280 .Nm
 281 device driver first appeared in
 282 .Fx 12.0 .
 283 .Sh AUTHORS
 284 .An -nosplit
 285 The
 286 .Nm
 287 driver was written by
 288 .An Navdeep Parhar Aq Mt np@FreeBSD.org
 289 and
 290 .An John Baldwin Aq Mt jhb@FreeBSD.org .