1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
<table class="head">
<tr>
<td class="head-ltitle">RE(4)</td>
<td class="head-vol">Device Drivers Manual</td>
<td class="head-rtitle">RE(4)</td>
</tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">re</code> — <span class="Nd">Realtek
8139C+/8169/816xS/811xS/8168/810xE/8111 PCI/PCIe Ethernet adapter
driver</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp">To compile this driver into the kernel, place the following lines
in your kernel configuration file:</p>
<div class="Bd Pp Bd-indent"><code class="Cd">device miibus</code>
<br/>
<code class="Cd">device re</code></div>
<p class="Pp">Alternatively, to load the driver as a module at boot time, place
the following line in <a class="Xr">loader.conf(5)</a>:</p>
<div class="Bd Pp Bd-indent Li">
<pre>if_re_load="YES"</pre>
</div>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">re</code> driver provides support for various
NICs based on the Realtek RTL8139C+, RTL8169, RTL816xS, RTL811xS, RTL8168,
RTL810xE and RTL8111 PCI and PCIe Ethernet controllers.</p>
<p class="Pp">NICs based on the 8139C+ and 810xE are capable of 10 and 100Mbps
speeds over CAT5 cable. NICs based on the 8169, 816xS, 811xS, 8168 and 8111
are capable of 10, 100 and 1000Mbps operation.</p>
<p class="Pp">All NICs supported by the <code class="Nm">re</code> driver have
TCP/IP checksum offload and hardware VLAN tagging/insertion features, and
use a descriptor-based DMA mechanism. They are also capable of TCP large
send (TCP segmentation offload).</p>
<p class="Pp">The 8139C+ is a single-chip solution combining both a 10/100 MAC
and PHY. The 8169 is a 10/100/1000 MAC only, requiring a GMII or TBI
external PHY. The 816xS, 811xS, 8168 and 8111 are single-chip devices
containing both a 10/100/1000 MAC and 10/100/1000 copper PHY. Standalone
10/100/1000 cards are available in both 32-bit PCI and 64-bit PCI models.
The 8110S is designed for embedded LAN-on-motherboard applications.</p>
<p class="Pp">The 8169, 8169S and 8110S also support jumbo frames, which can be
configured via the interface MTU setting. The MTU is limited to 7422, since
the chip cannot transmit larger frames. Selecting an MTU larger than 1500
bytes with the <a class="Xr">ifconfig(8)</a> utility configures the adapter
to receive and transmit jumbo frames.</p>
<p class="Pp">The <code class="Nm">re</code> driver supports the following media
types:</p>
<dl class="Bl-tag">
<dt id="autoselect"><a class="permalink" href="#autoselect"><code class="Cm">autoselect</code></a></dt>
<dd>Enable autoselection of the media type and options. The user can manually
override the autoselected mode by adding media options to
<a class="Xr">rc.conf(5)</a>.</dd>
<dt id="10baseT/UTP"><a class="permalink" href="#10baseT/UTP"><code class="Cm">10baseT/UTP</code></a></dt>
<dd>Set 10Mbps operation. The <a class="Xr">ifconfig(8)</a>
<code class="Cm">mediaopt</code> option can also be used to select either
<code class="Cm">full-duplex</code> or <code class="Cm">half-duplex</code>
modes.</dd>
<dt id="100baseTX"><a class="permalink" href="#100baseTX"><code class="Cm">100baseTX</code></a></dt>
<dd>Set 100Mbps (Fast Ethernet) operation. The <a class="Xr">ifconfig(8)</a>
<code class="Cm">mediaopt</code> option can also be used to select either
<code class="Cm">full-duplex</code> or <code class="Cm">half-duplex</code>
modes.</dd>
<dt id="1000baseTX"><a class="permalink" href="#1000baseTX"><code class="Cm">1000baseTX</code></a></dt>
<dd>Set 1000baseTX operation over twisted pair. The Realtek gigE chips support
1000Mbps in <code class="Cm">full-duplex</code> mode only.</dd>
</dl>
<p class="Pp">The <code class="Nm">re</code> driver supports the following media
options:</p>
<dl class="Bl-tag">
<dt id="full-duplex"><a class="permalink" href="#full-duplex"><code class="Cm">full-duplex</code></a></dt>
<dd>Force full duplex operation.</dd>
<dt id="half-duplex"><a class="permalink" href="#half-duplex"><code class="Cm">half-duplex</code></a></dt>
<dd>Force half duplex operation.</dd>
</dl>
<p class="Pp">For more information on configuring this device, see
<a class="Xr">ifconfig(8)</a>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1>
<p class="Pp">The <code class="Nm">re</code> driver supports Realtek RTL8139C+,
RTL8169, RTL816xS, RTL811xS, RTL8168, RTL810xE and RTL8111 based Fast
Ethernet and Gigabit Ethernet adapters including:</p>
<p class="Pp"></p>
<ul class="Bl-bullet Bl-compact">
<li>Alloy Computer Products EtherGOLD 1439E 10/100 (8139C+)</li>
<li>Compaq Evo N1015v Integrated Ethernet (8139C+)</li>
<li>Corega CG-LAPCIGT Gigabit Ethernet (8169S)</li>
<li>D-Link DGE-528(T) Gigabit Ethernet (8169S)</li>
<li>D-Link DGE-530(T) Gigabit Ethernet (8169S)</li>
<li>Killer E2600 Gigabit Ethernet (8168)</li>
<li>Gigabyte 7N400 Pro2 Integrated Gigabit Ethernet (8110S)</li>
<li>LevelOne GNC-0105T (8169S)</li>
<li>LinkSys EG1032 (32-bit PCI)</li>
<li>PLANEX COMMUNICATIONS Inc. GN-1200TC (8169S)</li>
<li>TP-Link TG-3468 v2 Gigabit Ethernet (8168)</li>
<li>USRobotics USR997902 Gigabit Ethernet (8169S)</li>
<li>Xterasys XN-152 10/100/1000 NIC (8169)</li>
</ul>
</section>
<section class="Sh">
<h1 class="Sh" id="LOADER_TUNABLES"><a class="permalink" href="#LOADER_TUNABLES">LOADER
TUNABLES</a></h1>
<p class="Pp">Tunables can be set at the <a class="Xr">loader(8)</a> prompt
before booting the kernel or stored in <a class="Xr">loader.conf(5)</a>.</p>
<dl class="Bl-tag">
<dt id="hw.re.intr_filter"><var class="Va">hw.re.intr_filter</var></dt>
<dd>This tunable makes driver use interrupt filter handler on controllers that
support MSI/MSI-X capability. If MSI/MSI-X is disabled by administrator
this tunable has no effect and driver will use interrupt filter handler.
The default value is 0 to use interrupt thread handler.</dd>
<dt id="hw.re.msi_disable"><var class="Va">hw.re.msi_disable</var></dt>
<dd>This tunable disables MSI support on the Ethernet hardware. The default
value is 0.</dd>
<dt id="hw.re.msix_disable"><var class="Va">hw.re.msix_disable</var></dt>
<dd>This tunable disables MSI-X support on the Ethernet hardware. The default
value is 0.</dd>
<dt id="hw.re.prefer_iomap"><var class="Va">hw.re.prefer_iomap</var></dt>
<dd>This tunable controls which register mapping should be used on the
specified device. A non-zero value enables I/O space register mapping. The
default value is 0 to use memory space register mapping.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="SYSCTL_VARIABLES"><a class="permalink" href="#SYSCTL_VARIABLES">SYSCTL
VARIABLES</a></h1>
<p class="Pp">The following variables are available as both
<a class="Xr">sysctl(8)</a> variables and <a class="Xr">loader(8)</a>
tunables:</p>
<dl class="Bl-tag">
<dt id="dev.re._d.int_rx_mod"><var class="Va">dev.re.%d.int_rx_mod</var></dt>
<dd>Maximum amount of time to delay receive interrupt processing in units of
1us. The accepted range is 0 to 65, the default is 65(65us). Value 0
completely disables the interrupt moderation. The interface need to be
brought down and up again before a change takes effect.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOSTICS</a></h1>
<dl class="Bl-diag">
<dt>re%d: couldn't map memory</dt>
<dd>A fatal initialization error has occurred.</dd>
<dt>re%d: couldn't map ports</dt>
<dd>A fatal initialization error has occurred.</dd>
<dt>re%d: couldn't map interrupt</dt>
<dd>A fatal initialization error has occurred.</dd>
<dt>re%d: no memory for softc struct!</dt>
<dd>The driver failed to allocate memory for per-device instance information
during initialization.</dd>
<dt>re%d: failed to enable memory mapping!</dt>
<dd>The driver failed to initialize PCI shared memory mapping. This might
happen if the card is not in a bus-master slot.</dd>
<dt>re%d: no memory for jumbo buffers!</dt>
<dd>The driver failed to allocate memory for jumbo frames during
initialization.</dd>
<dt>re%d: watchdog timeout</dt>
<dd>The device has stopped responding to the network, or there is a problem
with the network connection (cable).</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
ALSO</a></h1>
<p class="Pp"><a class="Xr">altq(4)</a>, <a class="Xr">arp(4)</a>,
<a class="Xr">miibus(4)</a>, <a class="Xr">netintro(4)</a>,
<a class="Xr">ng_ether(4)</a>, <a class="Xr">polling(4)</a>,
<a class="Xr">rge(4)</a>, <a class="Xr">rgephy(4)</a>,
<a class="Xr">vlan(4)</a>, <a class="Xr">ifconfig(8)</a></p>
<p class="Pp"><cite class="Rs"><span class="RsT">Realtek Semiconductor
RTL8139C+, RTL8169, RTL8169S and RTL8110S datasheets</span>,
<a class="RsU" href="https://www.realtek.com">https://www.realtek.com</a>.</cite></p>
</section>
<section class="Sh">
<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<p class="Pp">The <code class="Nm">re</code> device driver first appeared in
<span class="Ux">FreeBSD 5.2</span>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp">The <code class="Nm">re</code> driver was written by
<span class="An">Bill Paul</span>
<<a class="Mt" href="mailto:wpaul@windriver.com">wpaul@windriver.com</a>>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1>
<p class="Pp">The Xterasys XN-152 32-bit PCI NIC, which uses the RTL8169 MAC and
Marvell 88E1000 PHY, has a defect that causes DMA corruption if the board is
plugged into a 64-bit PCI slot. The defect lies in the board design, not the
chip itself: the PCI REQ64# and ACK64# lines should be pulled high, but they
are not. The result is that the 8169 chip is tricked into performing 64-bit
DMA transfers even though a 64-bit data path between the NIC and the bus
does not actually exist.</p>
<p class="Pp">Unfortunately, it is not possible to correct this problem in
software, however it is possible to detect it. When the
<code class="Nm">re</code> driver is loaded, it will run a diagnostic
routine designed to validate DMA operation by placing the chip in digital
loopback mode and initiating a packet transmission. If the card functions
properly, the transmitted data will be echoed back unmodified. If the echoed
data is corrupt, the driver will print an error message on the console and
abort the device attach. The user should ensure the NIC is installed in a
32-bit PCI slot to avoid this problem.</p>
<p class="Pp">The Realtek 8169, 8169S and 8110S chips appear to only be capable
of transmitting jumbo frames up to 7.5K in size.</p>
<p class="Pp">If this driver is causing problems then an updated driver from the
vendor can be found in ports under net/realtek-re-kmod.</p>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">November 7, 2022</td>
<td class="foot-os">FreeBSD 15.0</td>
</tr>
</table>
|
