xref: /freebsd/share/man/man4/cxgb.4 (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1.\" Copyright (c) 2007-2008, 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.Dd March 14, 2007
33.Dt CXGB 4
34.Os
35.Sh NAME
36.Nm cxgb
37.Nd "Chelsio T3 10 Gigabit Ethernet adapter driver"
38.Sh SYNOPSIS
39To compile this driver into the kernel,
40place the following lines in your
41kernel configuration file:
42.Bd -ragged -offset indent
43.Cd "device firmware"
44.Cd "device cxgb"
45.Ed
46.Pp
47To load the driver as a
48module at boot time, place the following line in
49.Xr loader.conf 5 :
50.Bd -literal -offset indent
51if_cxgb_load="YES"
52.Ed
53.Sh DESCRIPTION
54The
55.Nm
56driver supports Transmit/Receive checksum offload,
57Jumbo Frames, TCP segmentation offload (TSO), Large Receive Offload (LRO),
58VLAN hardware insertion / extraction, and VLAN checksum offload.
59For further hardware information, see
60.Pa http://www.chelsio.com/ .
61.Pp
62For questions related to hardware requirements,
63refer to the documentation supplied with your Chelsio T3 adapter.
64All hardware requirements listed apply to use with
65.Fx .
66.Pp
67Support for Jumbo Frames is provided via the interface MTU setting.
68Selecting an MTU larger than 1500 bytes with the
69.Xr ifconfig 8
70utility configures the adapter to receive and transmit Jumbo Frames.
71The maximum MTU size for Jumbo Frames is 9000.
72.Pp
73For more information on configuring this device, see
74.Xr ifconfig 8 .
75.Sh HARDWARE
76The
77.Nm
78driver supports 10 Gigabit and 1 Gigabit Ethernet adapters based on the T3 and T3B chipset:
79.Pp
80.Bl -bullet -compact
81.It
82Chelsio 10GBase-CX4
83.It
84Chelsio 10GBase-LR
85.It
86Chelsio 10GBase-SR
87.El
88.Sh LOADER TUNABLES
89Tunables can be set at the
90.Xr loader 8
91prompt before booting the kernel or stored in
92.Xr loader.conf 5 .
93.Sh DIAGNOSTICS
94.Bl -diag
95.It "cxgb%d: Unable to allocate bus resource: memory"
96A fatal initialization error has occurred.
97.It "cxgb%d: Unable to allocate bus resource: interrupt"
98A fatal initialization error has occurred.
99.It "cxgb%d: Could not find firmware image %s"
100The appropriate firmware kld module was not installed.
101This is a fatal initialization error.
102.El
103.Sh SUPPORT
104For general information and support,
105go to the Chelsio support website at:
106.Pa http://www.chelsio.com/ .
107.Pp
108If an issue is identified with the released source code on the supported kernel
109with a supported adapter, email the specific information related to the
110issue to
111.Aq Mt support@chelsio.com .
112.Sh SEE ALSO
113.Xr altq 4 ,
114.Xr arp 4 ,
115.Xr netintro 4 ,
116.Xr ng_ether 4 ,
117.Xr ifconfig 8
118.Sh HISTORY
119The
120.Nm
121device driver first appeared in
122.Fx 6.3
123and
124.Fx 7.0 .
125.Sh AUTHORS
126.An -nosplit
127The
128.Nm
129driver was written by
130.An Kip Macy Aq Mt kmacy@FreeBSD.org
131with substantial support from
132.An Scott Long Aq Mt scottl@FreeBSD.org .
133