| blob | 0adbc657f926c5a2df40cd54195abfe984d4a875 |
1 .\" Copyright (c) 2003
2 .\" Bill Paul <wpaul@windriver.com>. All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
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.
18 .\"
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.
30 .\"
31 .\" $FreeBSD$
32 .\"
33 .Dd November 14, 2016
34 .Dt RE 4
35 .Os
36 .Sh NAME
37 .Nm re
38 .Nd "RealTek 816xS/811xS/8101E/8105E PCI/PCIe Ethernet adapter driver"
39 .Sh SYNOPSIS
40 .Cd "device miibus"
41 .Cd "device re"
42 .Pp
43 Alternatively, to load the driver as a module at boot time, place the
44 following line in
45 .Pa /boot/loader.conf :
46 .Bd -literal -offset indent
47 if_re_load="YES"
48 .Ed
49 .Sh DESCRIPTION
50 The
51 .Nm
52 driver provides support for various NICs based on the RealTek
53 RTL8169S, RTL8110S, RTL8168S, RTL8111S and RTL8101E
54 PCI and PCIe ethernet controllers.
55 .Pp
56 NICs based on the
57 8101E are capable of 10 and 100Mbps speeds over CAT5 cable.
58 NICs based on the
59 816xS and 811xS are capable of 10, 100 and 1000Mbps operation.
60 .Pp
61 All NICs supported by the
62 .Nm
63 driver have TCP/IP checksum offload and hardware VLAN tagging/insertion
64 features, and use a descriptor-based DMA mechanism. They are also
65 capable of TCP large send (TCP segmentation offload).
66 .Pp
67 The 8169S and 8110S are single-chip devices containing both a 10/100/1000
68 MAC and 10/100/1000 copper PHY. Standalone 10/100/1000 cards are available
69 in both 32-bit PCI and 64-bit PCI models. The 8110S is designed for
70 embedded LAN-on-motherboard applications.
71 .Pp
72 .\"The 8169S and 8110S also support jumbo frames, which can be configured
73 .\"via the interface MTU setting.
74 .\"Selecting an MTU larger than 1500 bytes with the
75 .\".Xr ifconfig 8
76 .\"utility configures the adapter to receive and transmit jumbo frames.
77 .\"The maximum MTU setting for Jumbo Frames is 7426.
78 .\"This value coincides with the maximum Jumbo Frames size of 7440.
79 .\".Pp
80 The
81 .Nm
82 driver supports the following media types:
83 .Bl -tag -width 10baseTXUTP
84 .It Cm autoselect
85 Enable autoselection of the media type and options.
86 The user can manually override
87 the autoselected mode by adding media options to
88 .Xr rc.conf 5 .
89 .It Cm 10baseT/UTP
90 Set 10Mbps operation.
91 The
92 .Xr ifconfig 8
93 .Ic mediaopt
94 option can also be used to select either
95 .Cm full-duplex
96 or
97 .Cm half-duplex
98 modes.
99 .It Cm 100baseTX
100 Set 100Mbps (fast ethernet) operation.
101 The
102 .Xr ifconfig 8
103 .Ic mediaopt
104 option can also be used to select either
105 .Cm full-duplex
106 or
107 .Cm half-duplex
108 modes.
109 .It Cm 1000baseT
110 Set 1000baseT operation over twisted pair.
111 The RealTek gigE chips support 1000Mbps in
112 .Cm full-duplex
113 mode only.
114 .\" .It Cm 1000baseSX
115 .\" Set 1000Mbps (gigabit ethernet) operation.
116 .\" Both
117 .\" .Cm full-duplex
118 .\" and
119 .\" .Cm half-duplex
120 .\" modes are supported.
121 .El
122 .Pp
123 The
124 .Nm
125 driver supports the following media options:
126 .Bl -tag -width full-duplex
127 .It Cm full-duplex
128 Force full duplex operation.
129 .It Cm half-duplex
130 Force half duplex operation.
131 .El
132 .Pp
133 For more information on configuring this device, see
134 .Xr ifconfig 8 .
135 The
136 .Nm
137 driver supports
138 .Xr polling 4 .
139 .Ss MIB Variables
140 A number of per-interface variables are implemented in the
141 .Va dev.re. Ns Em X
142 branch of the
143 .Xr sysctl 3
144 MIB.
145 .Bl -tag -width ".Va rx_desc_count"
146 .It Va rx_desc_count
147 Number of RX descriptors (read-only).
148 Use the tunable
149 .Va hw.re.rx_desc_count
150 to configure it.
151 .It Va tx_desc_count
152 Number of TX descriptors (read-only).
153 Use the tunable
154 .Va hw.re.tx_desc_count
155 to configure it.
156 .It Va imtype
157 Interrupt moderation type.
158 0 means disable interrupt moderation.
159 1 means using simulated interrupt moderation (default).
160 2 means using hardware interrupt moderation,
161 if hardware supports it.
162 Due to lack of proper document,
163 hardware interrupt moderation (2) may not work as expected.
164 .It Va sim_time
165 If
166 .Va imtype
167 is set to 1,
168 it controls interrupt moderation time (unit: 1us).
169 It will not have any effect,
170 if
171 .Va imtype
172 is 0 or 2.
173 By default, it is set to 150us.
174 .It Va hw_txtime
175 If the controller does not support hardware interrupt moderation,
176 then this sysctl node will not exist.
177 If
178 .Va imtype
179 is set to 2,
180 it controls TX interrupt moderation time (unit: 25us).
181 It will not have any effect,
182 if
183 .Va imtype
184 is 0 or 1.
185 It is set to 5 (125us) by default.
186 Due to lack of chip document,
187 it may not work reliably.
188 .It Va hw_rxtime
189 If the controller does not support hardware interrupt moderation,
190 then this sysctl node will not exist.
191 If
192 .Va imtype
193 is set to 2,
194 it controls RX interrupt moderation time (unit: 25us).
195 It will not have any effect,
196 if
197 .Va imtype
198 is 0 or 1.
199 It is set to 2 (50us) by default.
200 Due to lack of chip document,
201 it may not work reliably.
202 .El
203 .Sh HARDWARE
204 The
205 .Nm
206 driver supports RealTek RTL816xS, RTL811xS,
207 RTL8105E, and RTL8101E based Fast Ethernet and Gigabit Ethernet adapters
208 including:
209 .Pp
210 .Bl -bullet -compact
211 .It
212 Corega CG-LAPCIGT Gigabit Ethernet (8169S)
213 .It
214 D-Link DGE-528(T) Gigabit Ethernet (8169S)
215 .It
216 Gigabyte 7N400 Pro2 Integrated Gigabit Ethernet (8110S)
217 .It
218 LevelOne GNC-0105T (8169S)
219 .It
220 LinkSys EG1032 (32-bit PCI)
221 .It
222 PLANEX COMMUNICATIONS Inc.\& GN-1200TC (8169S)
223 .El
224 .Sh SEE ALSO
225 .Xr arp 4 ,
226 .Xr ifmedia 4 ,
227 .Xr netintro 4 ,
228 .Xr ng_ether 4 ,
229 .Xr polling 4 ,
230 .Xr vlan 4 ,
231 .Xr ifconfig 8
232 .\".Rs
233 .\".%T RealTek Semiconductor RTL8169S and RTL8110S datasheets
234 .\".%O http://www.realtek.com.tw
235 .\".Re
236 .Sh HISTORY
237 The
238 .Nm
239 device driver first appeared in
240 .Fx 5.2
241 and
242 .Dx 1.0 .
243 .Sh AUTHORS
244 The
245 .Nm
246 driver was written by
247 .An Bill Paul Aq Mt wpaul@windriver.com .