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