RealTek 8139C+/8169/8169S/8110S man page from FreeBSD

1 files changed, 212 insertions, 0 deletions

diff --git a/share/man/man4/re.4 b/share/man/man4/re.4
new file mode 100644
index 00000000000..7e187757123
--- /dev/null
+++ b/share/man/man4/re.4
@@ -0,0 +1,212 @@
+.\" $OpenBSD: re.4,v 1.1 2004/06/05 06:30:23 pvalchev Exp $
+.\" Copyright (c) 2003
+.\"	Bill Paul <wpaul@windriver.com>. All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"	This product includes software developed by Bill Paul.
+.\" 4. Neither the name of the author nor the names of any co-contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"   without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
+.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+.\" THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.\" $FreeBSD: /repoman/r/ncvs/src/share/man/man4/re.4,v 1.4 2004/03/04 06:42:46 sanpei Exp $
+.\"
+.Dd September 4, 2003
+.Dt RE 4
+.Os
+.Sh NAME
+.Nm re
+.Nd "RealTek 8139C+/8169/8169S/8110S PCI ethernet adapter driver"
+.Sh SYNOPSIS
+.Cd "re* at pci? dev ? function ?"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for various NICs based on the RealTek RTL8139C+,
+RTL8169, RTL8169S and RTL8110S PCI ethernet controllers, including
+the following:
+.Pp
+.Bl -bullet -compact
+.It
+Alloy Computer Products EtherGOLD 1439E 10/100 (8139C+)
+.It
+Compaq Evo N1015v Integrated Ethernet (8139C+)
+.It
+Gigabyte 7N400 Pro2 Integrated Gigabit Ethernet (8110S)
+.It
+PLANEX COMMUNICATIONS Inc. GN-1200TC (8169S)
+.It
+Xterasys XN-152 10/100/1000 NIC (8169)
+.El
+.Pp
+NICs based on the 8139C+ are capable of 10 and 100Mbps speeds over CAT5
+cable. NICs based on the 8169, 8169S and 8110S are capable of 10, 100 and
+1000Mbps operation.
+.\" .Pp
+.\" All NICs supported by the
+.\" .Nm
+.\" 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).
+.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 8169S and 8110S 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.
+.\" .Pp
+.\" The 8169, 8169S and 8110S also support jumbo frames, which can be configured
+.\" via the interface MTU setting.
+.\" Selecting an MTU larger than 1500 bytes with the
+.\" .Xr ifconfig 8
+.\" utility configures the adapter to receive and transmit jumbo frames.
+.Pp
+The
+.Nm
+driver supports the following media types:
+.Bl -tag -width 10baseTXUTP
+.It Cm autoselect
+Enable autoselection of the media type and options.
+The user can manually override
+the autoselected mode by adding media options to
+.Xr rc.conf 5 .
+.It Cm 10baseT/UTP
+Set 10Mbps operation.
+The
+.Xr ifconfig 8
+.Ic mediaopt
+option can also be used to select either
+.Cm full-duplex
+or
+.Cm half-duplex
+modes.
+.It Cm 100baseTX
+Set 100Mbps (fast ethernet) operation.
+The
+.Xr ifconfig 8
+.Ic mediaopt
+option can also be used to select either
+.Cm full-duplex
+or
+.Cm half-duplex
+modes.
+.It Cm 1000baseTX
+Set 1000baseTX operation over twisted pair.
+The RealTek gigE chips support 1000Mbps in
+.Cm full-duplex
+mode only.
+.\" .It Cm 1000baseSX
+.\" Set 1000Mbps (gigabit ethernet) operation.
+.\" Both
+.\" .Cm full-duplex
+.\" and
+.\" .Cm half-duplex
+.\" modes are supported.
+.El
+.Pp
+The
+.Nm
+driver supports the following media options:
+.Bl -tag -width full-duplex
+.It Cm full-duplex
+Force full duplex operation.
+.It Cm half-duplex
+Force half duplex operation.
+.El
+.Pp
+For more information on configuring this device, see
+.Xr ifconfig 8 .
+.Sh DIAGNOSTICS
+.Bl -diag
+.It "re%d: couldn't map memory"
+A fatal initialization error has occurred.
+.It "re%d: couldn't map ports"
+A fatal initialization error has occurred.
+.It "re%d: couldn't map interrupt"
+A fatal initialization error has occurred.
+.It "re%d: no memory for softc struct!"
+The driver failed to allocate memory for per-device instance information
+during initialization.
+.It "re%d: failed to enable memory mapping!"
+The driver failed to initialize PCI shared memory mapping.
+This might
+happen if the card is not in a bus-master slot.
+.It "re%d: no memory for jumbo buffers!"
+The driver failed to allocate memory for jumbo frames during
+initialization.
+.It "re%d: watchdog timeout"
+The device has stopped responding to the network, or there is a problem with
+the network connection (cable).
+.El
+.Sh SEE ALSO
+.Xr arp 4 ,
+.Xr rgephy 4 ,
+.Xr ifmedia 4 ,
+.Xr intro 4 ,
+.Xr netintro 4 ,
+.Xr pci 4 ,
+.Xr vlan 4 ,
+.Xr hostname.if 5 ,
+.Xr ifconfig 8
+.Rs
+.%T RealTek Semiconductor RTL8139C+, RTL8169, RTL8169S and RTL8110S datasheets
+.%O http://www.realtek.com.tw
+.Re
+.Sh HISTORY
+The
+.Nm
+device driver first appeared in
+.Ox 3.6 .
+.Sh AUTHORS
+The
+.Nm
+driver was written by
+.An Bill Paul Aq wpaul@windriver.com
+and ported to
+.Ox
+by
+.An Peter Valchev Aq pvalchev@openbsd.org .
+.Sh BUGS
+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.
+.Pp
+Unfortunately, it is not possible to correct this problem in software,
+however it is possible to detect it. When the
+.Nm
+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 insure the NIC is installed in a 32-bit PCI slot to
+avoid this problem.
+.Pp
+The RealTek 8169, 8169S and 8110S chips appear to only be capable of
+transmitting jumbo frames up to 7.5K in size.