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