share/man/man4/re.4

   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 21, 2020
  34 .Dt RE 4
  35 .Os
  36 .Sh NAME
  37 .Nm re
  38 .Nd "RealTek 816xS/811xS/8101E/8105E/8125 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,
  54 RTL8110S,
  55 RTL8168S,
  56 RTL8111S,
  57 RTL8101E
  58 and
  59 RTL8125
  60 PCI and PCIe ethernet controllers.
  61 .Pp
  62 NICs based on the
  63 8101E are capable of 10 and 100Mbps speeds over CAT5 cable.
  64 NICs based on the
  65 816xS and 811xS are capable of 10, 100 and 1000Mbps operation.
  66 NICs based on the
  67 8125 are capable of 10, 100, 1000Mbps and 2500Mbps operation.
  68 .Pp
  69 All NICs supported by the
  70 .Nm
  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).
  74 .Pp
  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
  78 PCI models.
  79 The 8110S is designed for embedded LAN-on-motherboard applications.
  80 .Pp
  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
  84 .\".Xr ifconfig 8
  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.
  88 .\".Pp
  89 The
  90 .Nm
  91 driver supports the following media types:
  92 .Bl -tag -width 10baseTXUTP
  93 .It Cm autoselect
  94 Enable autoselection of the media type and options.
  95 The user can manually override
  96 the autoselected mode by adding media options to
  97 .Xr rc.conf 5 .
  98 .It Cm 10baseT/UTP
  99 Set 10Mbps operation.
 100 The
 101 .Xr ifconfig 8
 102 .Ic mediaopt
 103 option can also be used to select either
 104 .Cm full-duplex
 105 or
 106 .Cm half-duplex
 107 modes.
 108 .It Cm 100baseTX
 109 Set 100Mbps (fast ethernet) operation.
 110 The
 111 .Xr ifconfig 8
 112 .Ic mediaopt
 113 option can also be used to select either
 114 .Cm full-duplex
 115 or
 116 .Cm half-duplex
 117 modes.
 118 .It Cm 1000baseT
 119 Set 1000baseT operation over twisted pair.
 120 The RealTek gigE chips support 1000Mbps in
 121 .Cm full-duplex
 122 mode only.
 123 .\" .It Cm 1000baseSX
 124 .\" Set 1000Mbps (gigabit ethernet) operation.
 125 .\" Both
 126 .\" .Cm full-duplex
 127 .\" and
 128 .\" .Cm half-duplex
 129 .\" modes are supported.
 130 .El
 131 .Pp
 132 The
 133 .Nm
 134 driver supports the following media options:
 135 .Bl -tag -width full-duplex
 136 .It Cm full-duplex
 137 Force full duplex operation.
 138 .It Cm half-duplex
 139 Force half duplex operation.
 140 .El
 141 .Pp
 142 For more information on configuring this device, see
 143 .Xr ifconfig 8 .
 144 The
 145 .Nm
 146 driver supports
 147 .Xr polling 4 .
 148 .Ss MIB Variables
 149 A number of per-interface variables are implemented in the
 150 .Va dev.re. Ns Em X
 151 branch of the
 152 .Xr sysctl 3
 153 MIB.
 154 .Bl -tag -width ".Va rx_desc_count"
 155 .It Va rx_desc_count
 156 Number of RX descriptors (read-only).
 157 Use the tunable
 158 .Va hw.re.rx_desc_count
 159 to configure it.
 160 .It Va tx_desc_count
 161 Number of TX descriptors (read-only).
 162 Use the tunable
 163 .Va hw.re.tx_desc_count
 164 to configure it.
 165 .It Va imtype
 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.
 173 .It Va sim_time
 174 If
 175 .Va imtype
 176 is set to 1,
 177 it controls interrupt moderation time (unit: 1us).
 178 It will not have any effect,
 179 if
 180 .Va imtype
 181 is 0 or 2.
 182 By default, it is set to 150us.
 183 .It Va hw_txtime
 184 If the controller does not support hardware interrupt moderation,
 185 then this sysctl node will not exist.
 186 If
 187 .Va imtype
 188 is set to 2,
 189 it controls TX interrupt moderation time (unit: 25us).
 190 It will not have any effect,
 191 if
 192 .Va imtype
 193 is 0 or 1.
 194 It is set to 5 (125us) by default.
 195 Due to lack of chip document,
 196 it may not work reliably.
 197 .It Va hw_rxtime
 198 If the controller does not support hardware interrupt moderation,
 199 then this sysctl node will not exist.
 200 If
 201 .Va imtype
 202 is set to 2,
 203 it controls RX interrupt moderation time (unit: 25us).
 204 It will not have any effect,
 205 if
 206 .Va imtype
 207 is 0 or 1.
 208 It is set to 2 (50us) by default.
 209 Due to lack of chip document,
 210 it may not work reliably.
 211 .El
 212 .Sh HARDWARE
 213 The
 214 .Nm
 215 driver supports RealTek
 216 RTL816xS,
 217 RTL811xS,
 218 RTL8105E,
 219 RTL8101E,
 220 and
 221 RTL8125
 222 based Fast Ethernet and Gigabit Ethernet adapters
 223 including:
 224 .Pp
 225 .Bl -bullet -compact
 226 .It
 227 Corega CG-LAPCIGT Gigabit Ethernet (8169S)
 228 .It
 229 D-Link DGE-528(T) Gigabit Ethernet (8169S)
 230 .It
 231 Gigabyte 7N400 Pro2 Integrated Gigabit Ethernet (8110S)
 232 .It
 233 LevelOne GNC-0105T (8169S)
 234 .It
 235 LinkSys EG1032 (32-bit PCI)
 236 .It
 237 PLANEX COMMUNICATIONS Inc.\& GN-1200TC (8169S)
 238 .El
 239 .Sh SEE ALSO
 240 .Xr arp 4 ,
 241 .Xr ifmedia 4 ,
 242 .Xr netintro 4 ,
 243 .Xr ng_ether 4 ,
 244 .Xr polling 4 ,
 245 .Xr vlan 4 ,
 246 .Xr ifconfig 8
 247 .\".Rs
 248 .\".%T RealTek Semiconductor RTL8169S and RTL8110S datasheets
 249 .\".%U http://www.realtek.com.tw
 250 .\".Re
 251 .Sh HISTORY
 252 The
 253 .Nm
 254 device driver first appeared in
 255 .Fx 5.2
 256 and
 257 .Dx 1.0 .
 258 .Sh AUTHORS
 259 The
 260 .Nm
 261 driver was written by
 262 .An Bill Paul Aq Mt wpaul@windriver.com .