xref: /freebsd/share/man/man4/cxgbe.4 (revision 884a2a699669ec61e2366e3e358342dbc94be24a)
1.\" Copyright (c) 2011, 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 February 14, 2011
35.Dt CXGBE 4
36.Os
37.Sh NAME
38.Nm cxgbe
39.Nd "Chelsio T4 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 line in
50.Xr loader.conf 5 :
51.Bd -literal -offset indent
52if_cxgbe_load="YES"
53.Ed
54.Sh DESCRIPTION
55The
56.Nm
57driver provides support for PCI Express Ethernet adapters based on
58the Chelsio Terminator 4 (T4) ASIC.
59The driver supprts Jumbo Frames, Transmit/Receive checksum offload,
60TCP segmentation offload (TSO), Large Receive Offload (LRO), VLAN
61tag insertion/extraction, VLAN checksum offload, VLAN TSO, and
62Receive Side Steering (RSS).
63For further hardware information and questions related to hardware
64requirements, see
65.Pa http://www.chelsio.com/ .
66.Pp
67For more information on configuring this device, see
68.Xr ifconfig 8 .
69.Sh HARDWARE
70The
71.Nm
72driver supports 10Gb and 1Gb Ethernet adapters based on the T4 ASIC:
73.Pp
74.Bl -bullet -compact
75.It
76Chelsio T420-CR
77.It
78Chelsio T422-CR
79.It
80Chelsio T440-CR
81.It
82Chelsio T420-BCH
83.It
84Chelsio T440-BCH
85.It
86Chelsio T440-CH
87.It
88Chelsio T420-SO
89.It
90Chelsio T420-CX
91.It
92Chelsio T420-BT
93.It
94Chelsio T404-BT
95.El
96.Sh LOADER TUNABLES
97Tunables can be set at the
98.Xr loader 8
99prompt before booting the kernel or stored in
100.Xr loader.conf 5 .
101.Bl -tag -width indent
102.It Va hw.cxgbe.max_ntxq_10G_port
103The maximum number of tx queues to use for a 10Gb port.
104The default value is 8.
105.It Va hw.cxgbe.max_nrxq_10G_port
106The maximum number of rx queues to use for a 10Gb port.
107The default value is 8.
108.It Va hw.cxgbe.max_ntxq_1G_port
109The maximum number of tx queues to use for a 1Gb port.
110The default value is 2.
111.It Va hw.cxgbe.max_nrxq_1G_port
112The maximum number of rx queues to use for a 1Gb port.
113The default value is 2.
114.It Va hw.cxgbe.holdoff_timer_idx_10G
115.It Va hw.cxgbe.holdoff_timer_idx_1G
116The timer index value to use to delay interrupts.
117The holdoff timer list has the values 1, 5, 10, 50, 100, and 200
118by default (all values are in microseconds) and the index selects a
119value from this list.
120The default value is 1 for both 10Gb and 1Gb ports, which means the
121timer value is 5us.
122.It Va hw.cxgbe.holdoff_pktc_idx_10G
123.It Va hw.cxgbe.holdoff_pktc_idx_1G
124The packet-count index value to use to delay interrupts.
125The packet-count list has the values 1, 8, 16, and 32 by default
126and the index selects a value from this list.
127The default value is 2 for both 10Gb and 1Gb ports, which means 16
128packets (or the holdoff timer going off) before an interrupt is
129generated.
130.It Va hw.cxgbe.qsize_txq
131The size, in number of entries, of the descriptor ring used for a tx
132queue.
133A buf_ring of the same size is also allocated for additional
134software queuing.  See
135.Xr ifnet 9 .
136The default value is 1024.
137.It Va hw.cxgbe.qsize_rxq
138The size, in number of entries, of the descriptor ring used for an
139rx queue.
140The default value is 1024.
141.El
142.Sh SUPPORT
143For general information and support,
144go to the Chelsio support website at:
145.Pa http://www.chelsio.com/ .
146.Pp
147If an issue is identified with this driver with a supported adapter,
148email all the specific information related to the issue to
149.Aq support@chelsio.com .
150.Sh SEE ALSO
151.Xr altq 4 ,
152.Xr arp 4 ,
153.Xr cxgb 4 ,
154.Xr netintro 4 ,
155.Xr ng_ether 4 ,
156.Xr ifconfig 8
157.Sh HISTORY
158The
159.Nm
160device driver first appeared in
161.Fx 9.0
162.Sh AUTHORS
163.An -nosplit
164The
165.Nm
166driver was written by
167.An Navdeep Parhar Aq np@FreeBSD.org .
168