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