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 May 9, 2017
  35 .Dt CXGBEV 4
  36 .Os
  37 .Sh NAME
  38 .Nm cxgbev
  39 .Nd "Chelsio T4-, T5-, and T6-based 100Gb, 40Gb, 25Gb, 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, Terminator 5, and Terminator 6 ASICs
  60 (T4, T5, and T6).
  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 The
  70 .Nm
  71 driver uses different names for devices based on the associated ASIC:
  72 .Bl -column -offset indent "ASIC" "Port Name"
  73 .It Sy ASIC Ta Sy Port Name Ta Sy Parent Device
  74 .It T4 Ta cxgbev Ta t4vf
  75 .It T5 Ta cxlv Ta t5vf
  76 .It T6 Ta ccv Ta t6vf
  77 .El
  78 .Pp
  79 Loader tunables with the hw.cxgbe prefix apply to VFs from all cards.
  80 The Physical Function driver for Chelsio Terminator adapters shares these
  81 tunables.
  82 The driver provides sysctl MIBs for both ports and parent devices using
  83 the names above.
  84 For example, a T5 VF provides port MIBs under dev.cxlv and
  85 parent device MIBs under dev.t5vf.
  86 References to sysctl MIBs in the remainder of this page use
  87 dev.<port> for port MIBs and dev.<nexus> for parent device MIBs.
  88 .Pp
  89 For more information on configuring this device, see
  90 .Xr ifconfig 8 .
  91 .Sh HARDWARE
  92 The
  93 .Nm
  94 driver supports Virtual Functions on 100Gb and 25Gb Ethernet adapters
  95 based on the T6 ASIC:
  96 .Pp
  97 .Bl -bullet -compact
  98 .It
  99 Chelsio T6225-CR
 100 .It
 101 Chelsio T6225-SO-CR
 102 .It
 103 Chelsio T62100-LP-CR
 104 .It
 105 Chelsio T62100-SO-CR
 106 .It
 107 Chelsio T62100-CR
 108 .El
 109 .Pp
 110 The
 111 .Nm
 112 driver supports Virtual Functions on 40Gb, 10Gb and 1Gb Ethernet adapters
 113 based on the T5 ASIC:
 114 .Pp
 115 .Bl -bullet -compact
 116 .It
 117 Chelsio T580-CR
 118 .It
 119 Chelsio T580-LP-CR
 120 .It
 121 Chelsio T580-LP-SO-CR
 122 .It
 123 Chelsio T560-CR
 124 .It
 125 Chelsio T540-CR
 126 .It
 127 Chelsio T540-LP-CR
 128 .It
 129 Chelsio T522-CR
 130 .It
 131 Chelsio T520-LL-CR
 132 .It
 133 Chelsio T520-CR
 134 .It
 135 Chelsio T520-SO
 136 .It
 137 Chelsio T520-BT
 138 .It
 139 Chelsio T504-BT
 140 .El
 141 .Pp
 142 The
 143 .Nm
 144 driver supports Virtual Functions on 10Gb and 1Gb Ethernet adapters based
 145 on the T4 ASIC:
 146 .Pp
 147 .Bl -bullet -compact
 148 .It
 149 Chelsio T420-CR
 150 .It
 151 Chelsio T422-CR
 152 .It
 153 Chelsio T440-CR
 154 .It
 155 Chelsio T420-BCH
 156 .It
 157 Chelsio T440-BCH
 158 .It
 159 Chelsio T440-CH
 160 .It
 161 Chelsio T420-SO
 162 .It
 163 Chelsio T420-CX
 164 .It
 165 Chelsio T420-BT
 166 .It
 167 Chelsio T404-BT
 168 .El
 169 .Sh LOADER TUNABLES
 170 Tunables can be set at the
 171 .Xr loader 8
 172 prompt before booting the kernel or stored in
 173 .Xr loader.conf 5 .
 174 .Bl -tag -width indent
 175 .It Va hw.cxgbe.ntxq
 176 Number of tx queues used for a port.
 177 The default is 16 or the number
 178 of CPU cores in the system, whichever is less.
 179 .It Va hw.cxgbe.nrxq
 180 Number of rx queues used for a port.
 181 The default is 8 or the number
 182 of CPU cores in the system, whichever is less.
 183 .It Va hw.cxgbe.holdoff_timer_idx
 184 Timer index value used to delay interrupts.
 185 The holdoff timer list has the values 1, 5, 10, 50, 100, and 200
 186 by default (all values are in microseconds) and the index selects a
 187 value from this list.
 188 The default value is 1 which means the timer value is 5us.
 189 Different interfaces can be assigned different values at any time via the
 190 dev.<port>.X.holdoff_tmr_idx sysctl.
 191 .It Va hw.cxgbe.holdoff_pktc_idx
 192 Packet-count index value used to delay interrupts.
 193 The packet-count list has the values 1, 8, 16, and 32 by default,
 194 and the index selects a value from this list.
 195 The default value is -1 which means packet counting is disabled and interrupts
 196 are generated based solely on the holdoff timer value.
 197 Different interfaces can be assigned different values via the
 198 dev.<port>.X.holdoff_pktc_idx sysctl.
 199 This sysctl works only when the interface has never been marked up (as done by
 200 ifconfig up).
 201 .It Va hw.cxgbe.qsize_txq
 202 Number of entries in a transmit queue's descriptor ring.
 203 A buf_ring of the same size is also allocated for additional
 204 software queuing.
 205 See
 206 .Xr ifnet 9 .
 207 The default value is 1024.
 208 Different interfaces can be assigned different values via the
 209 dev.<port>.X.qsize_txq sysctl.
 210 This sysctl works only when the interface has never been marked up (as done by
 211 ifconfig up).
 212 .It Va hw.cxgbe.qsize_rxq
 213 Number of entries in a receive queue's descriptor ring.
 214 The default value is 1024.
 215 Different interfaces can be assigned different values via the
 216 dev.<port>.X.qsize_rxq sysctl.
 217 This sysctl works only when the interface has never been marked up (as done by
 218 ifconfig up).
 219 .It Va hw.cxgbe.interrupt_types
 220 Permitted interrupt types.
 221 Bit 0 represents INTx (line interrupts), bit 1 MSI, and bit 2 MSI-X.
 222 The default is 7 (all allowed).
 223 The driver selects the best possible type out of the allowed types.
 224 Note that Virtual Functions do not support INTx interrupts and fail
 225 to attach if neither MSI nor MSI-X are enabled.
 226 .It Va hw.cxgbe.fl_pktshift
 227 Number of padding bytes inserted before the beginning of an Ethernet
 228 frame in the receive buffer.
 229 The default value of 2 ensures that the Ethernet payload (usually the IP header)
 230 is at a 4 byte aligned address.
 231 0-7 are all valid values.
 232 .It Va hw.cxgbe.fl_pad
 233 A non-zero value ensures that writes from the hardware to a receive buffer are
 234 padded up to the specified boundary.
 235 The default is -1 which lets the driver pick a pad boundary.
 236 0 disables trailer padding completely.
 237 .It Va hw.cxgbe.buffer_packing
 238 Allow the hardware to deliver multiple frames in the same receive buffer
 239 opportunistically.
 240 The default is -1 which lets the driver decide.
 241 0 or 1 explicitly disable or enable this feature.
 242 .It Va hw.cxgbe.allow_mbufs_in_cluster
 243 1 allows the driver to lay down one or more mbufs within the receive buffer
 244 opportunistically.
 245 This is the default.
 246 0 prohibits the driver from doing so.
 247 .It Va hw.cxgbe.largest_rx_cluster
 248 .It Va hw.cxgbe.safest_rx_cluster
 249 Sizes of rx clusters.
 250 Each of these must be set to one of the sizes available
 251 (usually 2048, 4096, 9216, and 16384) and largest_rx_cluster must be greater
 252 than or equal to safest_rx_cluster.
 253 The defaults are 16384 and 4096 respectively.
 254 The driver never attempts to allocate a receive buffer larger than
 255 largest_rx_cluster and falls back to allocating buffers of
 256 safest_rx_cluster size if an allocation larger than safest_rx_cluster fails.
 257 Note that largest_rx_cluster merely establishes a ceiling -- the driver is
 258 allowed to allocate buffers of smaller sizes.
 259 .El
 260 .Pp
 261 Certain settings and resources for Virtual Functions are dictated
 262 by the parent Physical Function driver.
 263 For example, the Physical Function driver limits the number of queues
 264 available to a Virtual Function.
 265 Some of these limits can be adjusted in the firmware configuration file
 266 used with the Physical Function driver.
 267 .Pp
 268 The PAUSE settings on the port of a Virtual Function are inherited from
 269 the settings of the same port on the Physical Function.
 270 Virtual Functions cannot modify the setting and track changes made to
 271 the associated port's setting by the Physical Function driver.
 272 .Pp
 273 Receive queues on a Virtual Function always drop packets in response to
 274 congestion
 275 .Po
 276 equivalent to setting
 277 .Va hw.cxgbe.cong_drop
 278 to 1
 279 .Pc .
 280 .Pp
 281 The VF driver currently depends on the PF driver.
 282 As a result, loading the VF driver also loads the PF driver as a
 283 dependency.
 284 .Sh SUPPORT
 285 For general information and support,
 286 go to the Chelsio support website at:
 287 .Pa http://www.chelsio.com/ .
 288 .Pp
 289 If an issue is identified with this driver with a supported adapter,
 290 email all the specific information related to the issue to
 291 .Aq Mt support@chelsio.com .
 292 .Sh SEE ALSO
 293 .Xr altq 4 ,
 294 .Xr arp 4 ,
 295 .Xr cxgbe 4 ,
 296 .Xr netintro 4 ,
 297 .Xr ng_ether 4 ,
 298 .Xr ifconfig 8
 299 .Sh HISTORY
 300 The
 301 .Nm
 302 device driver first appeared in
 303 .Fx 11.1
 304 and
 305 .Fx 11.1 .
 306 .Sh AUTHORS
 307 .An -nosplit
 308 The
 309 .Nm
 310 driver was written by
 311 .An Navdeep Parhar Aq Mt np@FreeBSD.org
 312 and
 313 .An John Baldwin Aq Mt jhb@FreeBSD.org .