xref: /openbsd-src/share/man/man4/re.4 (revision d13be5d47e4149db2549a9828e244d59dbc43f15)
1.\" $OpenBSD: re.4,v 1.47 2011/03/13 21:32:29 jmc Exp $
2.\" Copyright (c) 2003
3.\"	Bill Paul <wpaul@windriver.com>. All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
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.\" 3. All advertising materials mentioning features or use of this software
14.\"    must display the following acknowledgement:
15.\"	This product includes software developed by Bill Paul.
16.\" 4. Neither the name of the author nor the names of any co-contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"   without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
24.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30.\" THE POSSIBILITY OF SUCH DAMAGE.
31.\"
32.\" $FreeBSD: /repoman/r/ncvs/src/share/man/man4/re.4,v 1.4 2004/03/04 06:42:46 sanpei Exp $
33.\"
34.Dd $Mdocdate: March 13 2011 $
35.Dt RE 4
36.Os
37.Sh NAME
38.Nm re
39.Nd Realtek 8139C+/8169/816xS/811xS/8168/810xE 10/100/Gigabit Ethernet device
40.Sh SYNOPSIS
41.Cd "re* at pci?"
42.Cd "re* at cardbus?"
43.Cd "eephy* at mii?"
44.Cd "rgephy* at mii?"
45.Cd "rlphy* at mii?"
46.Sh DESCRIPTION
47The
48.Nm
49driver provides support for various NICs based on the
50Realtek RTL8139C+, RTL8169, RTL816xS, RTL811xS, RTL8168 and
51RTL810xE PCI and PCI Express Ethernet controllers,
52including the following:
53.Pp
54.Bl -bullet -compact
55.It
56Alloy Computer Products EtherGOLD 1439E 10/100 (8139C+)
57.It
58Buffalo LGY-PCI-GT (8169S)
59.It
60Compaq Evo N1015v Integrated Ethernet (8139C+)
61.It
62Corega CG-LAPCIGT (8169S)
63.It
64D-Link DGE-528T (8169S)
65.It
66D-Link DGE-660TD (8169/8110SB)
67.It
68Gigabyte 7N400 Pro2 Integrated Gigabit Ethernet (8110S)
69.It
70LevelOne GNC-0105T (8169S)
71.It
72Linksys EG1032v3 (8169S)
73.It
74Netgear GA311 (8169S)
75.It
76Netgear GA511 PC Card (8169)
77.It
78PLANEX COMMUNICATIONS Inc. GN-1200TC (8169S)
79.It
80Surecom EP-320G-TX1 (8169S)
81.It
82TTTech MC322 (8139C+)
83.It
84US Robotics USR997902 (8169S)
85.It
86Xterasys XN-152 10/100/1000 NIC (8169)
87.El
88.Pp
89NICs based on the 8139C+ and 810xE are capable of 10 and 100Mbps speeds
90over CAT5 cable.
91NICs based on the 8169, 816xS, 811xS and 8168 are capable of 10, 100 and
921000Mbps operation.
93.Pp
94All
95.Nm
96NICs support
97IPv4 transmit/receive IP/TCP/UDP checksum offload, VLAN tag insertion and
98stripping, and use a descriptor-based DMA mechanism.
99The 8102E(L), 8103E(L), 8168C/8111C, 8168D/8111D, 8168DP/8111DP and
1008168E/8111E chips also support IPv6 receive TCP/UDP checksum offload.
101.Pp
102The 8139C+ is a single-chip solution combining both a 10/100 MAC and PHY.
103The 8169 is a 10/100/1000 MAC only, requiring a GMII or TBI external PHY.
104The 8169S, 8110S, 8111B and 8168 are single-chip devices
105containing both a 10/100/1000 MAC and 10/100/1000 copper PHY.
106Standalone 10/100/1000 cards are available in both 32-bit PCI and 64-bit
107PCI models.
108The 8110S and 8111B are designed for embedded LAN-on-motherboard applications.
109.Pp
110The 8169, 8169S and 8110S also support Jumbo frames,
111which can be configured via the interface MTU setting.
112The MTU is limited to 7422, since the chip cannot transmit larger frames.
113Selecting an MTU larger than 1500 bytes with the
114.Xr ifconfig 8
115utility configures the adapter to transmit Jumbo frames.
116.Pp
117The
118.Nm
119driver additionally supports Wake on LAN (WoL).
120See
121.Xr arp 8
122and
123.Xr ifconfig 8
124for more details.
125.Pp
126The
127.Nm
128driver supports the following media types:
129.Bl -tag -width 10baseTXUTP
130.It autoselect
131Enable autoselection of the media type and options.
132The user can manually override the autoselected mode by adding media options
133to the appropriate
134.Xr hostname.if 5
135file.
136.It 10baseT/UTP
137Set 10Mbps operation.
138The
139.Xr ifconfig 8
140.Ic mediaopt
141option can also be used to select either
142.Ar full-duplex
143or
144.Ar half-duplex
145modes.
146.It 100baseTX
147Set 100Mbps (Fast Ethernet) operation.
148The
149.Xr ifconfig 8
150.Ic mediaopt
151option can also be used to select either
152.Ar full-duplex
153or
154.Ar half-duplex
155modes.
156.It 1000baseT
157Set 1000baseT operation over twisted pair.
158The Realtek GigE chips support 1000Mbps in
159.Ar full-duplex
160mode only.
161.\" .It 1000baseSX
162.\" Set 1000Mbps (Gigabit Ethernet) operation.
163.\" Both
164.\" .Ar full-duplex
165.\" and
166.\" .Ar half-duplex
167.\" modes are supported.
168.El
169.Pp
170The
171.Nm
172driver supports the following media options:
173.Bl -tag -width full-duplex
174.It full-duplex
175Force full duplex operation.
176.It half-duplex
177Force half duplex operation.
178.El
179.Pp
180For more information on configuring this device, see
181.Xr ifconfig 8 .
182.Sh SEE ALSO
183.Xr arp 4 ,
184.Xr eephy 4 ,
185.Xr ifmedia 4 ,
186.Xr intro 4 ,
187.Xr netintro 4 ,
188.Xr pci 4 ,
189.Xr rgephy 4 ,
190.Xr rlphy 4 ,
191.Xr hostname.if 5 ,
192.Xr ifconfig 8
193.Rs
194.%T Realtek Semiconductor RTL8139C+, RTL8169, RTL8169S and RTL8110S datasheets
195.%O http://www.realtek.com.tw
196.Re
197.Sh HISTORY
198The
199.Nm
200device driver first appeared in
201.Ox 3.6 .
202.Sh AUTHORS
203.An -nosplit
204The
205.Nm
206driver was written by
207.An Bill Paul Aq wpaul@windriver.com
208and ported to
209.Ox
210by
211.An Peter Valchev Aq pvalchev@openbsd.org .
212.Sh BUGS
213The Xterasys XN-152 32-bit PCI NIC, which uses the RTL8169 MAC and
214Marvell 88E1000 PHY, has a defect that causes DMA corruption
215if the board is plugged into a 64-bit PCI slot.
216The defect lies in the board design, not the chip itself: the PCI REQ64#
217and ACK64# lines should be pulled high, but they are not.
218The result is that the 8169 chip is tricked into performing 64-bit DMA
219transfers even though a 64-bit data path between the NIC and the bus does
220not actually exist.
221.Pp
222Unfortunately, it is not possible to correct this problem in software,
223however it is possible to detect it.
224The user should ensure the NIC is installed in a 32-bit PCI slot to avoid
225this problem.
226.Pp
227The Realtek 8169, 8169S and 8110S chips are only capable of transmitting
228Jumbo frames up to 7440 bytes in size.
229