1 .\" Copyright (c) 2011, Chelsio Inc
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions are met:
7 .\" 1. Redistributions of source code must retain the above copyright notice,
8 .\" this list of conditions and the following disclaimer.
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.
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.
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.
30 .\" * Other names and brands may be claimed as the property of others.
39 .Nd "Chelsio T4 10Gb and 1Gb Ethernet adapter driver"
41 To compile this driver into the kernel,
42 place the following lines in your
43 kernel configuration file:
44 .Bd -ragged -offset indent
48 To load the driver as a
49 module at boot time, place the following line in
51 .Bd -literal -offset indent
57 driver provides support for PCI Express Ethernet adapters based on
58 the Chelsio Terminator 4 (T4) ASIC.
59 The driver supprts Jumbo Frames, Transmit/Receive checksum offload,
60 TCP segmentation offload (TSO), Large Receive Offload (LRO), VLAN
61 tag insertion/extraction, VLAN checksum offload, VLAN TSO, and
62 Receive Side Steering (RSS).
64 For further hardware information and questions related to hardware
66 .Pa http://www.chelsio.com/ .
68 For more information on configuring this device, see
73 driver supports 10Gb and 1Gb Ethernet adapters based on the T4 ASIC:
98 Tunables can be set at the
100 prompt before booting the kernel or stored in
102 .Bl -tag -width indent
103 .It Va hw.cxgbe.max_ntxq_10G_port
104 The maximum number of tx queues to use for a 10Gb port.
105 The default value is 8.
106 .It Va hw.cxgbe.max_nrxq_10G_port
107 The maximum number of rx queues to use for a 10Gb port.
108 The default value is 8.
109 .It Va hw.cxgbe.max_ntxq_1G_port
110 The maximum number of tx queues to use for a 1Gb port.
111 The default value is 2.
112 .It Va hw.cxgbe.max_nrxq_1G_port
113 The maximum number of rx queues to use for a 1Gb port.
114 The default value is 2.
115 .It Va hw.cxgbe.holdoff_timer_idx_10G
116 .It Va hw.cxgbe.holdoff_timer_idx_1G
117 The timer index value to use to delay interrupts.
118 The holdoff timer list has the values 1, 5, 10, 50, 100, and 200
119 by default (all values are in microseconds) and the index selects a
120 value from this list.
121 The default value is 1 for both 10Gb and 1Gb ports, which means the
123 .It Va hw.cxgbe.holdoff_pktc_idx_10G
124 .It Va hw.cxgbe.holdoff_pktc_idx_1G
125 The packet-count index value to use to delay interrupts.
126 The packet-count list has the values 1, 8, 16, and 32 by default
127 and the index selects a value from this list.
128 The default value is 2 for both 10Gb and 1Gb ports, which means 16
129 packets (or the holdoff timer going off) before an interrupt is
131 .It Va hw.cxgbe.qsize_txq
132 The size, in number of entries, of the descriptor ring used for a tx
134 A buf_ring of the same size is also allocated for additional
135 software queuing. See
137 The default value is 1024.
138 .It Va hw.cxgbe.qsize_rxq
139 The size, in number of entries, of the descriptor ring used for an
141 The default value is 1024.
143 For general information and support,
144 go to the Chelsio support website at:
145 .Pa http://www.chelsio.com/ .
147 If an issue is identified with this driver with a supported adapter,
148 email all the specific information related to the issue to
149 .Aq support@chelsio.com .
160 device driver first appeared in
166 driver was written by
167 .An Navdeep Parhar Aq np@FreeBSD.org .