xref: /dragonfly/share/man/man4/re.4 (revision 49781055)
1.\" Copyright (c) 2003
2.\"	Bill Paul <wpaul@windriver.com>. 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
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by Bill Paul.
15.\" 4. Neither the name of the author nor the names of any co-contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"   without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
23.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29.\" THE POSSIBILITY OF SUCH DAMAGE.
30.\"
31.\" $FreeBSD$
32.\" $DragonFly: src/share/man/man4/re.4,v 1.2 2005/12/04 18:07:47 dillon Exp $
33.\"
34.Dd September 4, 2003
35.Dt RE 4
36.Os
37.Sh NAME
38.Nm re
39.Nd "RealTek 8139C+/8169/8169S/8110S PCI ethernet adapter driver"
40.Sh SYNOPSIS
41.Cd "device miibus"
42.Cd "device re"
43.Sh DESCRIPTION
44The
45.Nm
46driver provides support for various NICs based on the RealTek RTL8139C+,
47RTL8169, RTL8169S and RTL8110S PCI ethernet controllers, including
48the following:
49.Pp
50.Bl -bullet -compact
51.It
52Alloy Computer Products EtherGOLD 1439E 10/100 (8139C+)
53.It
54Compaq Evo N1015v Integrated Ethernet (8139C+)
55.It
56D-Link DGE-528(T) Gigabit Ethernet (8169S)
57.It
58Gigabyte 7N400 Pro2 Integrated Gigabit Ethernet (8110S)
59.It
60PLANEX COMMUNICATIONS Inc. GN-1200TC (8169S)
61.It
62Xterasys XN-152 10/100/1000 NIC (8169)
63.El
64.Pp
65NICs based on the 8139C+ are capable of 10 and 100Mbps speeds over CAT5
66cable. NICs based on the 8169, 8169S and 8110S are capable of 10, 100 and
671000Mbps operation.
68.Pp
69All NICs supported by the
70.Nm
71driver have TCP/IP checksum offload and hardware VLAN tagging/insertion
72features, and use a descriptor-based DMA mechanism. They are also
73capable of TCP large send (TCP segmentation offload).
74.Pp
75The 8139C+ is a single-chip solution combining both a 10/100 MAC and PHY.
76The 8169 is a 10/100/1000 MAC only, requiring a GMII or TBI external PHY.
77The 8169S and 8110S are single-chip devices containing both a 10/100/1000
78MAC and 10/100/1000 copper PHY. Standalone 10/100/1000 cards are available
79in both 32-bit PCI and 64-bit PCI models. The 8110S is designed for
80embedded LAN-on-motherboard applications.
81.Pp
82The 8169, 8169S and 8110S also support jumbo frames, which can be configured
83via the interface MTU setting.
84Selecting an MTU larger than 1500 bytes with the
85.Xr ifconfig 8
86utility configures the adapter to receive and transmit jumbo frames.
87.Pp
88The
89.Nm
90driver supports the following media types:
91.Bl -tag -width 10baseTXUTP
92.It Cm autoselect
93Enable autoselection of the media type and options.
94The user can manually override
95the autoselected mode by adding media options to
96.Xr rc.conf 5 .
97.It Cm 10baseT/UTP
98Set 10Mbps operation.
99The
100.Xr ifconfig 8
101.Ic mediaopt
102option can also be used to select either
103.Cm full-duplex
104or
105.Cm half-duplex
106modes.
107.It Cm 100baseTX
108Set 100Mbps (fast ethernet) operation.
109The
110.Xr ifconfig 8
111.Ic mediaopt
112option can also be used to select either
113.Cm full-duplex
114or
115.Cm half-duplex
116modes.
117.It Cm 1000baseTX
118Set 1000baseTX operation over twisted pair.
119The RealTek gigE chips support 1000Mbps in
120.Cm full-duplex
121mode only.
122.\" .It Cm 1000baseSX
123.\" Set 1000Mbps (gigabit ethernet) operation.
124.\" Both
125.\" .Cm full-duplex
126.\" and
127.\" .Cm half-duplex
128.\" modes are supported.
129.El
130.Pp
131The
132.Nm
133driver supports the following media options:
134.Bl -tag -width full-duplex
135.It Cm full-duplex
136Force full duplex operation.
137.It Cm half-duplex
138Force half duplex operation.
139.El
140.Pp
141For more information on configuring this device, see
142.Xr ifconfig 8 .
143.Sh DIAGNOSTICS
144.Bl -diag
145.It "re%d: couldn't map memory"
146A fatal initialization error has occurred.
147.It "re%d: couldn't map ports"
148A fatal initialization error has occurred.
149.It "re%d: couldn't map interrupt"
150A fatal initialization error has occurred.
151.It "re%d: no memory for softc struct!"
152The driver failed to allocate memory for per-device instance information
153during initialization.
154.It "re%d: failed to enable memory mapping!"
155The driver failed to initialize PCI shared memory mapping.
156This might
157happen if the card is not in a bus-master slot.
158.It "re%d: no memory for jumbo buffers!"
159The driver failed to allocate memory for jumbo frames during
160initialization.
161.It "re%d: watchdog timeout"
162The device has stopped responding to the network, or there is a problem with
163the network connection (cable).
164.El
165.Sh SEE ALSO
166.Xr arp 4 ,
167.Xr miibus 4 ,
168.Xr netintro 4 ,
169.Xr ng_ether 4 ,
170.Xr vlan 4 ,
171.Xr ifconfig 8
172.Rs
173.%T RealTek Semiconductor RTL8139C+, RTL8169, RTL8169S and RTL8110S datasheets
174.%O http://www.realtek.com.tw
175.Re
176.Sh HISTORY
177The
178.Nm
179device driver first appeared in
180.Fx 5.2
181and
182.Dx 1.0 .
183.Sh AUTHORS
184The
185.Nm
186driver was written by
187.An Bill Paul Aq wpaul@windriver.com .
188.Sh BUGS
189The Xterasys XN-152 32-bit PCI NIC, which uses the RTL8169 MAC and
190Marvell 88E1000 PHY, has a defect that causes DMA corruption
191if the board is plugged into a 64-bit PCI slot. The defect
192lies in the board design, not the chip itself: the PCI REQ64# and ACK64#
193lines should be pulled high, but they are not. The result is that the
1948169 chip is tricked into performing 64-bit DMA transfers even though
195a 64-bit data path between the NIC and the bus does not actually exist.
196.Pp
197Unfortunately, it is not possible to correct this problem in software,
198however it is possible to detect it. When the
199.Nm
200driver is loaded, it will run a diagnostic routine designed to
201validate DMA operation by placing the chip in digital loopback mode
202and initiating a packet transmission. If the card functions properly,
203the transmitted data will
204be echoed back unmodified. If the echoed data is corrupt, the driver
205will print an error message on the console and abort the device attach. The
206user should insure the NIC is installed in a 32-bit PCI slot to
207avoid this problem.
208.Pp
209The RealTek 8169, 8169S and 8110S chips appear to only be capable of
210transmitting jumbo frames up to 7440 bytes in size.
211