xref: /openbsd-src/share/man/man4/re.4 (revision 50b7afb2c2c0993b0894d4e34bf857cb13ed9c80)
1.\" $OpenBSD: re.4,v 1.51 2013/12/31 21:09:34 brad 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: December 31 2013 $
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-530T C1 (8169/8110SB)
67.It
68D-Link DGE-660TD (8169/8110SB)
69.It
70Gigabyte 7N400 Pro2 Integrated Gigabit Ethernet (8110S)
71.It
72LevelOne GNC-0105T (8169S)
73.It
74Linksys EG1032v3 (8169S)
75.It
76Netgear GA311 (8169S)
77.It
78Netgear GA511 PC Card (8169)
79.It
80PLANEX COMMUNICATIONS Inc. GN-1200TC (8169S)
81.It
82Surecom EP-320G-TX1 (8169S)
83.It
84TTTech MC322 (8139C+)
85.It
86US Robotics USR997902 (8169S)
87.It
88Xterasys XN-152 10/100/1000 NIC (8169)
89.El
90.Pp
91NICs based on the 8139C+ and 810xE are capable of 10 and 100Mbps speeds
92over CAT5 cable.
93NICs based on the 8169, 816xS, 811xS and 8168 are capable of 10, 100 and
941000Mbps operation.
95.Pp
96All
97.Nm
98NICs support
99IPv4 transmit/receive IP/TCP/UDP checksum offload, VLAN tag insertion and
100stripping, and use a descriptor-based DMA mechanism.
101The 8102E(L), 8103E(L), 8168C/8111C, 8168D/8111D, 8168DP/8111DP and
1028168E/8111E chips also support IPv6 receive TCP/UDP checksum offload.
103.Pp
104The 8139C+ is a single-chip solution combining both a 10/100 MAC and PHY.
105The 8169 is a 10/100/1000 MAC only, requiring a GMII or TBI external PHY.
106The 8169S, 8110S, 8111B and 8168 are single-chip devices
107containing both a 10/100/1000 MAC and 10/100/1000 copper PHY.
108Standalone 10/100/1000 cards are available in both 32-bit PCI and 64-bit
109PCI models.
110The 8110S and 8111B are designed for embedded LAN-on-motherboard applications.
111.Pp
112The 8169, 8169S and 8110S also support Jumbo frames,
113which can be configured via the interface MTU setting.
114The MTU is limited to 7422, since the chip cannot transmit larger frames.
115Selecting an MTU larger than 1500 bytes with the
116.Xr ifconfig 8
117utility configures the adapter to transmit Jumbo frames.
118.Pp
119The
120.Nm
121driver additionally supports Wake on LAN (WoL).
122See
123.Xr arp 8
124and
125.Xr ifconfig 8
126for more details.
127.Pp
128The
129.Nm
130driver supports the following media types:
131.Bl -tag -width 10baseTXUTP
132.It autoselect
133Enable autoselection of the media type and options.
134The user can manually override the autoselected mode by adding media options
135to the appropriate
136.Xr hostname.if 5
137file.
138.It 10baseT/UTP
139Set 10Mbps operation.
140The
141.Xr ifconfig 8
142.Ic mediaopt
143option can also be used to select either
144.Ar full-duplex
145or
146.Ar half-duplex
147modes.
148.It 100baseTX
149Set 100Mbps (Fast Ethernet) operation.
150The
151.Xr ifconfig 8
152.Ic mediaopt
153option can also be used to select either
154.Ar full-duplex
155or
156.Ar half-duplex
157modes.
158.It 1000baseT
159Set 1000baseT operation over twisted pair.
160The Realtek GigE chips support 1000Mbps in
161.Ar full-duplex
162mode only.
163.\" .It 1000baseSX
164.\" Set 1000Mbps (Gigabit Ethernet) operation.
165.\" Both
166.\" .Ar full-duplex
167.\" and
168.\" .Ar half-duplex
169.\" modes are supported.
170.El
171.Pp
172The
173.Nm
174driver supports the following media options:
175.Bl -tag -width full-duplex
176.It full-duplex
177Force full duplex operation.
178.It half-duplex
179Force half duplex operation.
180.El
181.Pp
182For more information on configuring this device, see
183.Xr ifconfig 8 .
184.Sh SEE ALSO
185.Xr arp 4 ,
186.Xr eephy 4 ,
187.Xr ifmedia 4 ,
188.Xr intro 4 ,
189.Xr netintro 4 ,
190.Xr pci 4 ,
191.Xr rgephy 4 ,
192.Xr rlphy 4 ,
193.Xr hostname.if 5 ,
194.Xr ifconfig 8
195.Rs
196.%T Realtek Semiconductor RTL8139C+, RTL8169, RTL8169S and RTL8110S datasheets
197.%U http://www.realtek.com.tw
198.Re
199.Sh HISTORY
200The
201.Nm
202device driver first appeared in
203.Ox 3.6 .
204.Sh AUTHORS
205.An -nosplit
206The
207.Nm
208driver was written by
209.An Bill Paul Aq Mt wpaul@windriver.com
210and ported to
211.Ox
212by
213.An Peter Valchev Aq Mt pvalchev@openbsd.org .
214.Sh BUGS
215The Xterasys XN-152 32-bit PCI NIC, which uses the RTL8169 MAC and
216Marvell 88E1000 PHY, has a defect that causes DMA corruption
217if the board is plugged into a 64-bit PCI slot.
218The defect lies in the board design, not the chip itself: the PCI REQ64#
219and ACK64# lines should be pulled high, but they are not.
220The result is that the 8169 chip is tricked into performing 64-bit DMA
221transfers even though a 64-bit data path between the NIC and the bus does
222not actually exist.
223.Pp
224Unfortunately, it is not possible to correct this problem in software.
225The user should ensure the NIC is installed in a 32-bit PCI slot to avoid
226this problem.
227.Pp
228The Realtek 8169, 8169S and 8110S chips are only capable of transmitting
229Jumbo frames up to 7440 bytes in size.
230