| cxgbe.4 (256281) | cxgbe.4 (259622) |
|---|---|
| 1.\" Copyright (c) 2011-2012, Chelsio Inc | 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.\" --- 14 unchanged lines hidden (view full) --- 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.\" | 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.\" --- 14 unchanged lines hidden (view full) --- 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: stable/10/share/man/man4/cxgbe.4 251317 2013-06-03 17:30:21Z np $ | 32.\" $FreeBSD: stable/10/share/man/man4/cxgbe.4 259622 2013-12-19 19:15:24Z np $ |
| 33.\" | 33.\" |
| 34.Dd February 25, 2012 | 34.Dd December 18, 2013 |
| 35.Dt CXGBE 4 36.Os 37.Sh NAME 38.Nm cxgbe | 35.Dt CXGBE 4 36.Os 37.Sh NAME 38.Nm cxgbe |
| 39.Nd "Chelsio T4 10Gb and 1Gb Ethernet adapter driver" | 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" | 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" |
|
| 53if_cxgbe_load="YES" 54.Ed 55.Sh DESCRIPTION 56The 57.Nm 58driver provides support for PCI Express Ethernet adapters based on | 54if_cxgbe_load="YES" 55.Ed 56.Sh DESCRIPTION 57The 58.Nm 59driver provides support for PCI Express Ethernet adapters based on |
| 59the Chelsio Terminator 4 (T4) ASIC. | 60the Chelsio Terminator 4 and Terminator 5 ASICs (T4 and T5). |
| 60The driver supports Jumbo Frames, Transmit/Receive checksum offload, 61TCP segmentation offload (TSO), Large Receive Offload (LRO), VLAN 62tag insertion/extraction, VLAN checksum offload, VLAN TSO, and 63Receive Side Steering (RSS). 64For further hardware information and questions related to hardware 65requirements, see 66.Pa http://www.chelsio.com/ . 67.Pp | 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 75.Pp |
|
| 68For more information on configuring this device, see 69.Xr ifconfig 8 . 70.Sh HARDWARE 71The 72.Nm | 76For more information on configuring this device, see 77.Xr ifconfig 8 . 78.Sh HARDWARE 79The 80.Nm |
| 81driver supports 40Gb, 10Gb and 1Gb Ethernet adapters based on the T5 ASIC 82(ports will be named cxl): 83.Pp 84.Bl -bullet -compact 85.It 86Chelsio T580-CR 87.It 88Chelsio T580-LP-CR 89.It 90Chelsio T580-LP-SO-CR 91.It 92Chelsio T560-CR 93.It 94Chelsio T540-CR 95.It 96Chelsio T540-LP-CR 97.It 98Chelsio T522-CR 99.It 100Chelsio T520-LL-CR 101.It 102Chelsio T520-CR 103.It 104Chelsio T520-SO 105.It 106Chelsio T520-BT 107.It 108Chelsio T504-BT 109.El 110.Pp 111The 112.Nm |
|
| 73driver supports 10Gb and 1Gb Ethernet adapters based on the T4 ASIC: 74.Pp 75.Bl -bullet -compact 76.It 77Chelsio T420-CR 78.It 79Chelsio T422-CR 80.It --- 53 unchanged lines hidden (view full) --- 134.It Va hw.cxgbe.holdoff_timer_idx_10G 135.It Va hw.cxgbe.holdoff_timer_idx_1G 136The timer index value to use to delay interrupts. 137The holdoff timer list has the values 1, 5, 10, 50, 100, and 200 138by default (all values are in microseconds) and the index selects a 139value from this list. 140The default value is 1 for both 10Gb and 1Gb ports, which means the 141timer value is 5us. | 113driver supports 10Gb and 1Gb Ethernet adapters based on the T4 ASIC: 114.Pp 115.Bl -bullet -compact 116.It 117Chelsio T420-CR 118.It 119Chelsio T422-CR 120.It --- 53 unchanged lines hidden (view full) --- 174.It Va hw.cxgbe.holdoff_timer_idx_10G 175.It Va hw.cxgbe.holdoff_timer_idx_1G 176The timer index value to use to delay interrupts. 177The holdoff timer list has the values 1, 5, 10, 50, 100, and 200 178by default (all values are in microseconds) and the index selects a 179value from this list. 180The default value is 1 for both 10Gb and 1Gb ports, which means the 181timer value is 5us. |
| 142Different cxgbe interfaces can be assigned different values at any time via the 143dev.cxgbe.X.holdoff_tmr_idx sysctl. | 182Different interfaces can be assigned different values at any time via the 183dev.cxgbe.X.holdoff_tmr_idx or dev.cxl.X.holdoff_tmr_idx sysctl. |
| 144.It Va hw.cxgbe.holdoff_pktc_idx_10G 145.It Va hw.cxgbe.holdoff_pktc_idx_1G 146The packet-count index value to use to delay interrupts. 147The packet-count list has the values 1, 8, 16, and 32 by default 148and the index selects a value from this list. 149The default value is -1 for both 10Gb and 1Gb ports, which means packet 150counting is disabled and interrupts are generated based solely on the 151holdoff timer value. | 184.It Va hw.cxgbe.holdoff_pktc_idx_10G 185.It Va hw.cxgbe.holdoff_pktc_idx_1G 186The packet-count index value to use to delay interrupts. 187The packet-count list has the values 1, 8, 16, and 32 by default 188and the index selects a value from this list. 189The default value is -1 for both 10Gb and 1Gb ports, which means packet 190counting is disabled and interrupts are generated based solely on the 191holdoff timer value. |
| 152Different cxgbe interfaces can be assigned different values via the 153dev.cxgbe.X.holdoff_pktc_idx sysctl. | 192Different interfaces can be assigned different values via the 193dev.cxgbe.X.holdoff_pktc_idx or dev.cxl.X.holdoff_pktc_idx sysctl. |
| 154This sysctl works only when the interface has never been marked up (as done by 155ifconfig up). 156.It Va hw.cxgbe.qsize_txq 157The size, in number of entries, of the descriptor ring used for a tx 158queue. 159A buf_ring of the same size is also allocated for additional 160software queuing. 161See 162.Xr ifnet 9 . 163The default value is 1024. | 194This sysctl works only when the interface has never been marked up (as done by 195ifconfig up). 196.It Va hw.cxgbe.qsize_txq 197The size, in number of entries, of the descriptor ring used for a tx 198queue. 199A buf_ring of the same size is also allocated for additional 200software queuing. 201See 202.Xr ifnet 9 . 203The default value is 1024. |
| 164Different cxgbe interfaces can be assigned different values via the 165dev.cxgbe.X.qsize_txq sysctl. | 204Different interfaces can be assigned different values via the 205dev.cxgbe.X.qsize_txq sysctl or dev.cxl.X.qsize_txq sysctl. |
| 166This sysctl works only when the interface has never been marked up (as done by 167ifconfig up). 168.It Va hw.cxgbe.qsize_rxq 169The size, in number of entries, of the descriptor ring used for an 170rx queue. 171The default value is 1024. | 206This sysctl works only when the interface has never been marked up (as done by 207ifconfig up). 208.It Va hw.cxgbe.qsize_rxq 209The size, in number of entries, of the descriptor ring used for an 210rx queue. 211The default value is 1024. |
| 172Different cxgbe interfaces can be assigned different values via the 173dev.cxgbe.X.qsize_rxq sysctl. | 212Different interfaces can be assigned different values via the 213dev.cxgbe.X.qsize_rxq or dev.cxl.X.qsize_rxq sysctl. |
| 174This sysctl works only when the interface has never been marked up (as done by 175ifconfig up). 176.It Va hw.cxgbe.interrupt_types 177The interrupt types that the driver is allowed to use. 178Bit 0 represents INTx (line interrupts), bit 1 MSI, bit 2 MSI-X. 179The default is 7 (all allowed). 180The driver will select the best possible type out of the allowed types by 181itself. --- 44 unchanged lines hidden (view full) --- 226.Xr netintro 4 , 227.Xr ng_ether 4 , 228.Xr ifconfig 8 229.Sh HISTORY 230The 231.Nm 232device driver first appeared in 233.Fx 9.0 . | 214This sysctl works only when the interface has never been marked up (as done by 215ifconfig up). 216.It Va hw.cxgbe.interrupt_types 217The interrupt types that the driver is allowed to use. 218Bit 0 represents INTx (line interrupts), bit 1 MSI, bit 2 MSI-X. 219The default is 7 (all allowed). 220The driver will select the best possible type out of the allowed types by 221itself. --- 44 unchanged lines hidden (view full) --- 266.Xr netintro 4 , 267.Xr ng_ether 4 , 268.Xr ifconfig 8 269.Sh HISTORY 270The 271.Nm 272device driver first appeared in 273.Fx 9.0 . |
| 274Support for T5 cards first appeared in 275.Fx 9.2 276and 277.Fx 10.0 . |
|
| 234.Sh AUTHORS 235.An -nosplit 236The 237.Nm 238driver was written by 239.An Navdeep Parhar Aq np@FreeBSD.org . | 278.Sh AUTHORS 279.An -nosplit 280The 281.Nm 282driver was written by 283.An Navdeep Parhar Aq np@FreeBSD.org . |