2 .\" Bill Paul <wpaul@windriver.com>. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by Bill Paul.
15 .\" 4. Neither the name of the author nor the names of any co-contributors
16 .\" may be used to endorse or promote products derived from this software
17 .\" without specific prior written permission.
19 .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29 .\" THE POSSIBILITY OF SUCH DAMAGE.
38 .Nd "RealTek 816xS/811xS/8101E/8105E/8125 PCI/PCIe Ethernet adapter driver"
43 Alternatively, to load the driver as a module at boot time, place the
45 .Pa /boot/loader.conf :
46 .Bd -literal -offset indent
52 driver provides support for various NICs based on the RealTek
60 PCI and PCIe ethernet controllers.
63 8101E are capable of 10 and 100Mbps speeds over CAT5 cable.
65 816xS and 811xS are capable of 10, 100 and 1000Mbps operation.
67 8125 are capable of 10, 100, 1000Mbps and 2500Mbps operation.
69 All NICs supported by the
71 driver have TCP/IP checksum offload and hardware VLAN tagging/insertion
72 features, and use a descriptor-based DMA mechanism. They are also
73 capable of TCP large send (TCP segmentation offload).
75 The 8169S and 8110S are single-chip devices containing both a 10/100/1000
76 MAC and 10/100/1000 copper PHY.
77 Standalone 10/100/1000 cards are available in both 32-bit PCI and 64-bit
79 The 8110S is designed for embedded LAN-on-motherboard applications.
81 .\"The 8169S and 8110S also support jumbo frames, which can be configured
82 .\"via the interface MTU setting.
83 .\"Selecting an MTU larger than 1500 bytes with the
85 .\"utility configures the adapter to receive and transmit jumbo frames.
86 .\"The maximum MTU setting for Jumbo Frames is 7426.
87 .\"This value coincides with the maximum Jumbo Frames size of 7440.
91 driver supports the following media types:
92 .Bl -tag -width 10baseTXUTP
94 Enable autoselection of the media type and options.
95 The user can manually override
96 the autoselected mode by adding media options to
103 option can also be used to select either
109 Set 100Mbps (fast ethernet) operation.
113 option can also be used to select either
119 Set 1000baseT operation over twisted pair.
120 The RealTek gigE chips support 1000Mbps in
123 .\" .It Cm 1000baseSX
124 .\" Set 1000Mbps (gigabit ethernet) operation.
129 .\" modes are supported.
134 driver supports the following media options:
135 .Bl -tag -width full-duplex
137 Force full duplex operation.
139 Force half duplex operation.
142 For more information on configuring this device, see
149 A number of per-interface variables are implemented in the
154 .Bl -tag -width ".Va rx_desc_count"
156 Number of RX descriptors (read-only).
158 .Va hw.re.rx_desc_count
161 Number of TX descriptors (read-only).
163 .Va hw.re.tx_desc_count
166 Interrupt moderation type.
167 0 means disable interrupt moderation.
168 1 means using simulated interrupt moderation (default).
169 2 means using hardware interrupt moderation,
170 if hardware supports it.
171 Due to lack of proper document,
172 hardware interrupt moderation (2) may not work as expected.
177 it controls interrupt moderation time (unit: 1us).
178 It will not have any effect,
182 By default, it is set to 150us.
184 If the controller does not support hardware interrupt moderation,
185 then this sysctl node will not exist.
189 it controls TX interrupt moderation time (unit: 25us).
190 It will not have any effect,
194 It is set to 5 (125us) by default.
195 Due to lack of chip document,
196 it may not work reliably.
198 If the controller does not support hardware interrupt moderation,
199 then this sysctl node will not exist.
203 it controls RX interrupt moderation time (unit: 25us).
204 It will not have any effect,
208 It is set to 2 (50us) by default.
209 Due to lack of chip document,
210 it may not work reliably.
215 driver supports RealTek
222 based Fast Ethernet and Gigabit Ethernet adapters
227 Corega CG-LAPCIGT Gigabit Ethernet (8169S)
229 D-Link DGE-528(T) Gigabit Ethernet (8169S)
231 Gigabyte 7N400 Pro2 Integrated Gigabit Ethernet (8110S)
233 LevelOne GNC-0105T (8169S)
235 LinkSys EG1032 (32-bit PCI)
237 PLANEX COMMUNICATIONS Inc.\& GN-1200TC (8169S)
248 .\".%T RealTek Semiconductor RTL8169S and RTL8110S datasheets
249 .\".%U http://www.realtek.com.tw
254 device driver first appeared in
261 driver was written by
262 .An Bill Paul Aq Mt wpaul@windriver.com .