xref: /openbsd/share/man/man4/re.4 (revision d415bd75)
1.\" $OpenBSD: re.4,v 1.56 2022/02/18 10:24:32 jsg 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: February 18 2022 $
35.Dt RE 4
36.Os
37.Sh NAME
38.Nm re
39.Nd Realtek 8139C+/8169/816xS/811xS/8168/810xE 10/100/1Gb 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 8168, 8169, 8169S and 8110S also support jumbo frames.
113.Pp
114The
115.Nm
116driver additionally supports Wake on LAN (WoL).
117See
118.Xr arp 8
119and
120.Xr ifconfig 8
121for more details.
122.Pp
123The
124.Nm
125driver supports the following media types:
126.Bl -tag -width 10baseTXUTP
127.It autoselect
128Enable autoselection of the media type and options.
129The user can manually override the autoselected mode by adding media options
130to the appropriate
131.Xr hostname.if 5
132file.
133.It 10baseT/UTP
134Set 10Mbps operation.
135The
136.Xr ifconfig 8
137.Ic mediaopt
138option can also be used to select either
139.Ar full-duplex
140or
141.Ar half-duplex
142modes.
143.It 100baseTX
144Set 100Mbps (Fast Ethernet) operation.
145The
146.Xr ifconfig 8
147.Ic mediaopt
148option can also be used to select either
149.Ar full-duplex
150or
151.Ar half-duplex
152modes.
153.It 1000baseT
154Set 1000baseT operation over twisted pair.
155The Realtek GigE chips support 1000Mbps in
156.Ar full-duplex
157mode only.
158.\" .It 1000baseSX
159.\" Set 1000Mbps (Gigabit Ethernet) operation.
160.\" Both
161.\" .Ar full-duplex
162.\" and
163.\" .Ar half-duplex
164.\" modes are supported.
165.El
166.Pp
167The
168.Nm
169driver supports the following media options:
170.Bl -tag -width full-duplex
171.It full-duplex
172Force full duplex operation.
173.It half-duplex
174Force half duplex operation.
175.El
176.Pp
177For more information on configuring this device, see
178.Xr ifconfig 8 .
179.Sh SEE ALSO
180.Xr arp 4 ,
181.Xr eephy 4 ,
182.Xr ifmedia 4 ,
183.Xr intro 4 ,
184.Xr netintro 4 ,
185.Xr pci 4 ,
186.Xr rgephy 4 ,
187.Xr rlphy 4 ,
188.Xr hostname.if 5 ,
189.Xr ifconfig 8
190.Rs
191.%T Realtek Semiconductor RTL8139C+, RTL8169, RTL8169S and RTL8110S datasheets
192.%U https://www.realtek.com/en
193.Re
194.Sh HISTORY
195The
196.Nm
197device driver first appeared in
198.Ox 3.6 .
199.Sh AUTHORS
200.An -nosplit
201The
202.Nm
203driver was written by
204.An Bill Paul Aq Mt wpaul@windriver.com
205and ported to
206.Ox
207by
208.An Peter Valchev Aq Mt pvalchev@openbsd.org .
209.Sh BUGS
210The Xterasys XN-152 32-bit PCI NIC, which uses the RTL8169 MAC and
211Marvell 88E1000 PHY, has a defect that causes DMA corruption
212if the board is plugged into a 64-bit PCI slot.
213The defect lies in the board design, not the chip itself: the PCI REQ64#
214and ACK64# lines should be pulled high, but they are not.
215The result is that the 8169 chip is tricked into performing 64-bit DMA
216transfers even though a 64-bit data path between the NIC and the bus does
217not actually exist.
218.Pp
219Unfortunately, it is not possible to correct this problem in software.
220The user should ensure the NIC is installed in a 32-bit PCI slot to avoid
221this problem.
222