summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/rge.4 3.html
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:43 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:43 -0400
commitac5e55f5f2af5b92794c2aded46c6bae85b5f5ed (patch)
tree9367490586c84cba28652e443e3166d66c33b0d9 /static/freebsd/man4/rge.4 3.html
parent253e67c8b3a72b3a4757fdbc5845297628db0a4a (diff)
docs: Added All FreeBSD Manuals
Diffstat (limited to 'static/freebsd/man4/rge.4 3.html')
-rw-r--r--static/freebsd/man4/rge.4 3.html162
1 files changed, 162 insertions, 0 deletions
diff --git a/static/freebsd/man4/rge.4 3.html b/static/freebsd/man4/rge.4 3.html
new file mode 100644
index 00000000..90b19039
--- /dev/null
+++ b/static/freebsd/man4/rge.4 3.html
@@ -0,0 +1,162 @@
+<table class="head">
+ <tr>
+ <td class="head-ltitle">RGE(4)</td>
+ <td class="head-vol">Device Drivers Manual</td>
+ <td class="head-rtitle">RGE(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">rge</code> &#x2014; <span class="Nd">RealTek
+ RTL8125/RTL8126/RTL8127/Killer E3000 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 rge</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_rge_load=&quot;YES&quot;</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">rge</code> driver provides support for
+ various NICs based on the RealTek RTL8125, RTL8126 and RTL8127 PCIe Ethernet
+ controllers.</p>
+<p class="Pp">All of the NICs supported by this driver support 10, 100 and
+ 1000Mbit over CAT5 cable. NICs based on the RTL8125 additionally support
+ 2.5Gbit over CAT6 cable. NICs based on the RTL8126 additionally support
+ 2.5Gbit and 5Gbit over CAT6 cable. NICs based on the RTL8127 additionally
+ support 2.5Gbit, 5Gbit and 10Gbit over CAT6 cable.</p>
+<p class="Pp">All NICs supported by the <code class="Nm">rge</code> driver have
+ TCP/IP checksum offload, hardware VLAN tagging/insertion features, Wake On
+ Lan (WOL), and use a descriptor-based DMA mechanism. They are also capable
+ of TCP large send (TCP segmentation offload).</p>
+<p class="Pp">The RTL8125, RTL8126 and RTL8127 devices are single-chip solutions
+ combining both a MAC and PHY. The <code class="Nm">rge</code> driver manages
+ the PHY directly rather than using the <a class="Xr">miibus(4)</a>
+ interface. Standalone cards are available in 1x PCIe models.</p>
+<p class="Pp">The RTL8125, RTL8126 and RTL8127 also support jumbo frames, which
+ can be configured via the interface MTU setting. The MTU is limited to 9126.
+ 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">rge</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="1000baseT"><a class="permalink" href="#1000baseT"><code class="Cm">1000baseT</code></a></dt>
+ <dd>Set 1000baseT operation over twisted pair. The RealTek gigE chips support
+ 1000Mbps in <code class="Cm">full-duplex</code> mode only.</dd>
+ <dt id="2500Base-T"><a class="permalink" href="#2500Base-T"><code class="Cm">2500Base-T</code></a></dt>
+ <dd>Set 2500Base-T operation over twisted pair. The RealTek devices support
+ 2.5Gbit in <code class="Cm">full-duplex</code> mode only.</dd>
+ <dt id="5000Base-T"><a class="permalink" href="#5000Base-T"><code class="Cm">5000Base-T</code></a></dt>
+ <dd>Set 5000Base-T operation over twisted pair. The RealTek devices support
+ 5Gbit in <code class="Cm">full-duplex</code> mode only.</dd>
+ <dt id="10Gbase-T"><a class="permalink" href="#10Gbase-T"><code class="Cm">10Gbase-T</code></a></dt>
+ <dd>Set 10Gbase-T operation over twisted pair. The RealTek devices support
+ 10Gbit in <code class="Cm">full-duplex</code> mode only.</dd>
+</dl>
+<p class="Pp">The <code class="Nm">rge</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">rge</code> driver supports the following PCIe
+ Ethernet adapters:</p>
+<p class="Pp"></p>
+<ul class="Bl-bullet Bl-compact">
+ <li>RealTek RTL8125 (up to 2.5 Gbps)</li>
+ <li>RealTek RTL8126 (up to 5 Gbps)</li>
+ <li>RealTek RTL8127 (up to 10 Gbps)</li>
+ <li>Killer E3000 (up to 2.5 Gbps)</li>
+</ul>
+</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.rge._d.debug"><var class="Va">dev.rge.%d.debug</var></dt>
+ <dd>Configure runtime debug output. This is a 32 bit bitmask.</dd>
+ <dt id="dev.rge._d.rx_process_limit"><var class="Va">dev.rge.%d.rx_process_limit</var></dt>
+ <dd>Maximum number of RX packets to process per interrupt. The default value
+ is 16. Increasing this value may improve throughput on high-speed links at
+ the cost of increased interrupt latency.</dd>
+ <dt id="dev.rge._d.disable_aspm"><var class="Va">dev.rge.%d.disable_aspm</var></dt>
+ <dd>Disable PCIe Active State Power Management (ASPM) and Extended
+ Configuration Power Management (ECPM). The default value is 0 (leave ASPM
+ enabled). Setting this to 1 reduces latency at the cost of increased power
+ consumption. This tunable can only be set in
+ <a class="Xr">loader.conf(5)</a> and requires a reboot to take
+ 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>rge%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">re(4)</a>, <a class="Xr">vlan(4)</a>,
+ <a class="Xr">ifconfig(8)</a></p>
+<p class="Pp"><cite class="Rs"><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">rge</code> device driver first appeared in
+ <span class="Ux">FreeBSD 16.0</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">rge</code> driver was written by
+ <span class="An">Kevin Lo</span>
+ &lt;<a class="Mt" href="mailto:kevlo@openbsd.org">kevlo@openbsd.org</a>&gt;
+ and ported to FreeBSD by
+ <br/>
+ <span class="An">Adrian Chadd</span>
+ &lt;<a class="Mt" href="mailto:adrian@freebsd.org">adrian@freebsd.org</a>&gt;.</p>
+</section>
+</div>
+<table class="foot">
+ <tr>
+ <td class="foot-date">April 5, 2026</td>
+ <td class="foot-os">FreeBSD 15.0</td>
+ </tr>
+</table>