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