xref: /freebsd/share/man/man4/cxgbe.4 (revision 63d1fd5970ec814904aa0f4580b10a0d302d08b2)
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 December 22, 2016
35.Dt CXGBE 4
36.Os
37.Sh NAME
38.Nm cxgbe
39.Nd "Chelsio T4-, T5-, and T6-based 100Gb, 40Gb, 25Gb, 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"
54t6fw_cfg_load="YES"
55if_cxgbe_load="YES"
56.Ed
57.Sh DESCRIPTION
58The
59.Nm
60driver provides support for PCI Express Ethernet adapters based on
61the Chelsio Terminator 4, Terminator 5, and Terminator 6 ASICs (T4, T5, and T6).
62The driver supports Jumbo Frames, Transmit/Receive checksum offload,
63TCP segmentation offload (TSO), Large Receive Offload (LRO), VLAN
64tag insertion/extraction, VLAN checksum offload, VLAN TSO, and
65Receive Side Steering (RSS).
66For further hardware information and questions related to hardware
67requirements, see
68.Pa http://www.chelsio.com/ .
69.Pp
70The
71.Nm
72driver uses different names for devices based on the associated ASIC:
73.Bl -column -offset indent "ASIC" "Port Name" "Parent Device"
74.It Sy ASIC Ta Sy Port Name Ta Sy Parent Device Ta Sy Virtual Interface
75.It T4 Ta cxgbe Ta t4nex Ta vcxgbe
76.It T5 Ta cxl Ta t5nex Ta vcxl
77.It T6 Ta cc Ta t6nex Ta vcc
78.El
79.Pp
80Loader tunables with the hw.cxgbe prefix apply to all cards.
81The driver provides sysctl MIBs for both ports and parent devices using
82the names above.
83For example, a T5 adapter provides port MIBs under dev.cxl and
84adapter-wide MIBs under dev.t5nex.
85References to sysctl MIBs in the remainder of this page use
86dev.<port> for port MIBs and dev.<nexus> for adapter-wide MIBs.
87.Pp
88For more information on configuring this device, see
89.Xr ifconfig 8 .
90.Sh HARDWARE
91The
92.Nm
93driver supports 100Gb and 25Gb Ethernet adapters based on the T6 ASIC:
94.Pp
95.Bl -bullet -compact
96.It
97Chelsio T6225-CR
98.It
99Chelsio T6225-SO-CR
100.It
101Chelsio T62100-LP-CR
102.It
103Chelsio T62100-SO-CR
104.It
105Chelsio T62100-CR
106.El
107.Pp
108The
109.Nm
110driver supports 40Gb, 10Gb and 1Gb Ethernet adapters based on the T5 ASIC:
111.Pp
112.Bl -bullet -compact
113.It
114Chelsio T580-CR
115.It
116Chelsio T580-LP-CR
117.It
118Chelsio T580-LP-SO-CR
119.It
120Chelsio T560-CR
121.It
122Chelsio T540-CR
123.It
124Chelsio T540-LP-CR
125.It
126Chelsio T522-CR
127.It
128Chelsio T520-LL-CR
129.It
130Chelsio T520-CR
131.It
132Chelsio T520-SO
133.It
134Chelsio T520-BT
135.It
136Chelsio T504-BT
137.El
138.Pp
139The
140.Nm
141driver supports 10Gb and 1Gb Ethernet adapters based on the T4 ASIC:
142.Pp
143.Bl -bullet -compact
144.It
145Chelsio T420-CR
146.It
147Chelsio T422-CR
148.It
149Chelsio T440-CR
150.It
151Chelsio T420-BCH
152.It
153Chelsio T440-BCH
154.It
155Chelsio T440-CH
156.It
157Chelsio T420-SO
158.It
159Chelsio T420-CX
160.It
161Chelsio T420-BT
162.It
163Chelsio T404-BT
164.El
165.Sh LOADER TUNABLES
166Tunables can be set at the
167.Xr loader 8
168prompt before booting the kernel or stored in
169.Xr loader.conf 5 .
170.Bl -tag -width indent
171.It Va hw.cxgbe.ntxq10g
172Number of tx queues used for a 10Gb or higher-speed port.
173The default is 16 or the number
174of CPU cores in the system, whichever is less.
175.It Va hw.cxgbe.nrxq10g
176Number of rx queues used for a 10Gb or higher-speed port.
177The default is 8 or the number
178of CPU cores in the system, whichever is less.
179.It Va hw.cxgbe.ntxq1g
180Number of tx queues used for a 1Gb port.
181The default is 4 or the number
182of CPU cores in the system, whichever is less.
183.It Va hw.cxgbe.nrxq1g
184Number of rx queues used for a 1Gb port.
185The default is 2 or the number
186of CPU cores in the system, whichever is less.
187.It Va hw.cxgbe.nofldtxq10g
188Number of TOE tx queues used for a 10Gb or higher-speed port.
189The default is 8 or the
190number of CPU cores in the system, whichever is less.
191.It Va hw.cxgbe.nofldrxq10g
192Number of TOE rx queues used for a 10Gb or higher-speed port.
193The default is 2 or the
194number of CPU cores in the system, whichever is less.
195.It Va hw.cxgbe.nofldtxq1g
196Number of TOE tx queues used for a 1Gb port.
197The default is 2 or the
198number of CPU cores in the system, whichever is less.
199.It Va hw.cxgbe.nofldrxq1g
200Number of TOE rx queues used for a 1Gb port.
201The default is 1.
202.It Va hw.cxgbe.num_vis
203Number of virtual interfaces (VIs) created for each port.
204Each virtual interface creates a separate network interface.
205The first virtual interface on each port is required and represents
206the primary network interface on the port.
207Additional virtual interfaces on a port are named using the Virtual Interface
208name from the table above.
209Additional virtual interfaces use a single pair of queues
210for rx and tx as well an additional pair of queues for TOE rx and tx.
211The default is 1.
212.It Va hw.cxgbe.holdoff_timer_idx_10G
213.It Va hw.cxgbe.holdoff_timer_idx_1G
214Timer index value used to delay interrupts.
215The holdoff timer list has the values 1, 5, 10, 50, 100, and 200
216by default (all values are in microseconds) and the index selects a
217value from this list.
218The default value is 1 which means the timer value is 5us.
219Different interfaces can be assigned different values at any time via the
220dev.<port>.X.holdoff_tmr_idx sysctl.
221.It Va hw.cxgbe.holdoff_pktc_idx_10G
222.It Va hw.cxgbe.holdoff_pktc_idx_1G
223Packet-count index value used to delay interrupts.
224The packet-count list has the values 1, 8, 16, and 32 by default,
225and the index selects a value from this list.
226The default value is -1 which means packet counting is disabled and interrupts
227are generated based solely on the holdoff timer value.
228Different interfaces can be assigned different values via the
229dev.<port>.X.holdoff_pktc_idx sysctl.
230This sysctl works only when the interface has never been marked up (as done by
231ifconfig up).
232.It Va hw.cxgbe.qsize_txq
233Number of entries in a transmit queue's descriptor ring.
234A buf_ring of the same size is also allocated for additional
235software queuing.
236See
237.Xr ifnet 9 .
238The default value is 1024.
239Different interfaces can be assigned different values via the
240dev.<port>.X.qsize_txq sysctl.
241This sysctl works only when the interface has never been marked up (as done by
242ifconfig up).
243.It Va hw.cxgbe.qsize_rxq
244Number of entries in a receive queue's descriptor ring.
245The default value is 1024.
246Different interfaces can be assigned different values via the
247dev.<port>.X.qsize_rxq sysctl.
248This sysctl works only when the interface has never been marked up (as done by
249ifconfig up).
250.It Va hw.cxgbe.interrupt_types
251Permitted interrupt types.
252Bit 0 represents INTx (line interrupts), bit 1 MSI, and bit 2 MSI-X.
253The default is 7 (all allowed).
254The driver selects the best possible type out of the allowed types.
255.It Va hw.cxgbe.fw_install
2560 prohibits the driver from installing a firmware on the card.
2571 allows the driver to install a new firmware if internal driver
258heuristics indicate that the new firmware is preferable to the one
259already on the card.
2602 instructs the driver to always install the new firmware on the card as
261long as it is compatible with the driver and is a different version than
262the one already on the card.
263The default is 1.
264.It Va hw.cxgbe.fl_pktshift
265Number of padding bytes inserted before the beginning of an Ethernet
266frame in the receive buffer.
267The default value of 2 ensures that the Ethernet payload (usually the IP header)
268is at a 4 byte aligned address.
2690-7 are all valid values.
270.It Va hw.cxgbe.fl_pad
271A non-zero value ensures that writes from the hardware to a receive buffer are
272padded up to the specified boundary.
273The default is -1 which lets the driver pick a pad boundary.
2740 disables trailer padding completely.
275.It Va hw.cxgbe.cong_drop
276Controls the hardware response to congestion.
277-1 disables congestion feedback and is not recommended.
2780 instructs the hardware to backpressure its pipeline on congestion.
279This usually results in the port emitting PAUSE frames.
2801 instructs the hardware to drop frames destined for congested queues.
281.It Va hw.cxgbe.pause_settings
282PAUSE frame settings.
283Bit 0 is rx_pause, bit 1 is tx_pause.
284rx_pause = 1 instructs the hardware to heed incoming PAUSE frames, 0 instructs
285it to ignore them.
286tx_pause = 1 allows the hardware to emit PAUSE frames when its receive FIFO
287reaches a high threshold, 0 prohibits the hardware from emitting PAUSE frames.
288The default is 3 (both rx_pause and tx_pause = 1).
289This tunable establishes the default PAUSE settings for all ports.
290Settings can be displayed and controlled on a per-port basis via the
291dev.<port>.X.pause_settings sysctl.
292.It Va hw.cxgbe.fec
293FEC (Forward Error Correction) settings.
2940 diables FEC.
295Bit 0 enables RS FEC, bit 1 enables BASE-R RS, bit 3 is reserved.
296The default is -1 which lets the driver pick a value.
297This tunable establishes the default FEC settings for all ports.
298Settings can be displayed and controlled on a per-port basis via the
299dev.<port>.X.fec sysctl.
300.It Va hw.cxgbe.autoneg
301Link autonegotiation settings.
302This tunable establishes the default autonegotiation settings for all ports.
303Settings can be displayed and controlled on a per-port basis via the
304dev.<port>.X.autoneg sysctl.
3050 disables autonegotiation.
3061 enables autonegotiation.
307The default is -1 which lets the driver pick a value.
308dev.<port>.X.autoneg is -1 for port and module combinations that do not support
309autonegotiation.
310.It Va hw.cxgbe.buffer_packing
311Allow the hardware to deliver multiple frames in the same receive buffer
312opportunistically.
313The default is -1 which lets the driver decide.
3140 or 1 explicitly disable or enable this feature.
315.It Va hw.cxgbe.allow_mbufs_in_cluster
3161 allows the driver to lay down one or more mbufs within the receive buffer
317opportunistically.
318This is the default.
3190 prohibits the driver from doing so.
320.It Va hw.cxgbe.largest_rx_cluster
321.It Va hw.cxgbe.safest_rx_cluster
322Sizes of rx clusters.
323Each of these must be set to one of the sizes available
324(usually 2048, 4096, 9216, and 16384) and largest_rx_cluster must be greater
325than or equal to safest_rx_cluster.
326The defaults are 16384 and 4096 respectively.
327The driver never attempts to allocate a receive buffer larger than
328largest_rx_cluster and falls back to allocating buffers of
329safest_rx_cluster size if an allocation larger than safest_rx_cluster fails.
330Note that largest_rx_cluster merely establishes a ceiling -- the driver is
331allowed to allocate buffers of smaller sizes.
332.It Va hw.cxgbe.config_file
333Select a pre-packaged device configuration file.
334A configuration file contains a recipe for partitioning and configuring the
335hardware resources on the card.
336This tunable is for specialized applications only and should not be used in
337normal operation.
338The configuration profile currently in use is available in the dev.<nexus>.X.cf
339and dev.<nexus>.X.cfcsum sysctls.
340.It Va hw.cxgbe.linkcaps_allowed
341.It Va hw.cxgbe.niccaps_allowed
342.It Va hw.cxgbe.toecaps_allowed
343.It Va hw.cxgbe.rdmacaps_allowed
344.It Va hw.cxgbe.iscsicaps_allowed
345.It Va hw.cxgbe.fcoecaps_allowed
346Disallowing capabilities provides a hint to the driver and firmware to not
347reserve hardware resources for that feature.
348Each of these is a bit field with a bit for each sub-capability within the
349capability.
350This tunable is for specialized applications only and should not be used in
351normal operation.
352The capabilities for which hardware resources have been reserved are listed in
353dev.<nexus>.X.*caps sysctls.
354.El
355.Sh SUPPORT
356For general information and support,
357go to the Chelsio support website at:
358.Pa http://www.chelsio.com/ .
359.Pp
360If an issue is identified with this driver with a supported adapter,
361email all the specific information related to the issue to
362.Aq Mt support@chelsio.com .
363.Sh SEE ALSO
364.Xr altq 4 ,
365.Xr arp 4 ,
366.Xr cxgb 4 ,
367.Xr cxgbev 4 ,
368.Xr netintro 4 ,
369.Xr ng_ether 4 ,
370.Xr ifconfig 8
371.Sh HISTORY
372The
373.Nm
374device driver first appeared in
375.Fx 9.0 .
376Support for T5 cards first appeared in
377.Fx 9.2
378and
379.Fx 10.0 .
380Support for T6 cards first appeared in
381.Fx 11.1
382and
383.Fx 12.0 .
384.Sh AUTHORS
385.An -nosplit
386The
387.Nm
388driver was written by
389.An Navdeep Parhar Aq Mt np@FreeBSD.org .
390