xref: /freebsd/share/man/man4/stge.4 (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1.\"	$NetBSD: stge.4,v 1.7 2003/02/14 15:20:20 grant Exp $
2.\"
3.\" Copyright (c) 2001 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Jason R. Thorpe.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE 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.Dd November 23, 2010
31.Dt STGE 4
32.Os
33.Sh NAME
34.Nm stge
35.Nd Sundance/Tamarack TC9021 Gigabit Ethernet adapter driver
36.Sh SYNOPSIS
37To compile this driver into the kernel,
38place the following lines in your
39kernel configuration file:
40.Bd -ragged -offset indent
41.Cd "device miibus"
42.Cd "device stge"
43.Ed
44.Pp
45Alternatively, to load the driver as a
46module at boot time, place the following line in
47.Xr loader.conf 5 :
48.Bd -literal -offset indent
49if_stge_load="YES"
50.Ed
51.Sh DESCRIPTION
52The
53.Nm
54device driver provides support for various NICs based on the
55Sundance/Tamarack TC9021 Gigabit Ethernet controller chip.
56.Pp
57The Sundance/Tamarack TC9021 is found on the D-Link DGE-550T
58and the Antares Microsystems Gigabit Ethernet board.
59It uses an external PHY or an external 10-bit interface.
60.Pp
61All NICs supported by the
62.Nm
63driver have TCP/UDP/IP checksum offload for both receive and
64transmit, hardware VLAN tag stripping/insertion features, and
65receive interrupt moderation mechanism as well as a 64-bit
66multicast hash filter.
67The Sundance/Tamarack TC9021 supports TBI (ten bit interface)
68and GMII transceivers, which means it can be used with either
69copper or 1000baseX fiber applications.
70.Pp
71The Sundance/Tamarack TC9021 also supports jumbo frames, which can be
72configured via the interface MTU setting.
73Selecting an MTU larger than 1500 bytes with the
74.Xr ifconfig 8
75utility configures the adapter to receive and transmit jumbo frames.
76.Pp
77The
78.Nm
79driver supports the following media types:
80.Bl -tag -width ".Cm 10baseT/UTP"
81.It Cm autoselect
82Enable autoselection of the media type and options.
83The user can manually override
84the autoselected mode by adding media options to
85.Xr rc.conf 5 .
86.It Cm 10baseT/UTP
87Set 10Mbps operation.
88The
89.Xr ifconfig 8
90.Cm mediaopt
91option can also be used to select either
92.Cm full-duplex
93or
94.Cm half-duplex
95modes.
96.It Cm 100baseTX
97Set 100Mbps (Fast Ethernet) operation.
98The
99.Xr ifconfig 8
100.Cm mediaopt
101option can also be used to select either
102.Cm full-duplex
103or
104.Cm half-duplex
105modes.
106.It Cm 1000baseTX
107Set 1000baseTX operation over twisted pair.
108The Sundance/Tamarack supports 1000Mbps in
109.Cm autoselect
110mode only.
111.\" .It Cm 1000baseSX
112.\" Set 1000Mbps (Gigabit Ethernet) operation.
113.\" Both
114.\" .Cm full-duplex
115.\" and
116.\" .Cm half-duplex
117.\" modes are supported.
118.El
119.Pp
120The
121.Nm
122driver supports the following media options:
123.Bl -tag -width ".Cm full-duplex"
124.It Cm full-duplex
125Force full duplex operation.
126.It Cm half-duplex
127Force half duplex operation.
128.El
129.Pp
130For more information on configuring this device, see
131.Xr ifconfig 8 .
132.Sh HARDWARE
133The
134.Nm
135driver provides support for various NICs based on the Sundance/Tamarack
136TC9021 based Gigabit Ethernet controller chips, including:
137.Pp
138.Bl -bullet -compact
139.It
140Antares Microsystems Gigabit Ethernet
141.It
142ASUS NX1101 Gigabit Ethernet
143.It
144D-Link DL-4000 Gigabit Ethernet
145.It
146IC Plus IP1000A Gigabit Ethernet
147.It
148Sundance ST-2021 Gigabit Ethernet
149.It
150Sundance ST-2023 Gigabit Ethernet
151.It
152Sundance TC9021 Gigabit Ethernet
153.It
154Tamarack TC9021 Gigabit Ethernet
155.El
156.Sh SYSCTL VARIABLES
157The following variables are available as both
158.Xr sysctl 8
159variables and
160.Xr loader 8
161tunables:
162.Bl -tag -width indent
163.It Va dev.stge.%d.rxint_nframe
164Number of frames between RxDMAComplete interrupts.
165The accepted range is 1 to 255, default value is 8 frames.
166The interface has to be brought down and up again before a change takes effect.
167.It Va dev.stge.%d.rxint_dmawait
168Maximum amount of time to wait in 1us increments before issuing
169an Rx interrupt if the number of frames received is less than
170.Va rxint_nframe .
171The accepted range is 0 to 4194, default value is 30 microseconds.
172The interface has to be brought down and up again before a change takes effect.
173.El
174.Sh SEE ALSO
175.Xr altq 4 ,
176.Xr arp 4 ,
177.Xr miibus 4 ,
178.Xr netintro 4 ,
179.Xr ng_ether 4 ,
180.Xr polling 4 ,
181.Xr vlan 4 ,
182.Xr ifconfig 8
183.Sh HISTORY
184The
185.Nm
186driver was ported from
187.Nx
188and first appeared in
189.Fx 6.2 .
190The
191.Nx
192version was written by
193.An Jason R. Thorpe Aq Mt thorpej@NetBSD.org .
194.Sh AUTHORS
195The
196.Nm
197driver was ported by
198.An Pyun YongHyeon Aq Mt yongari@FreeBSD.org .
199