Manpage for Level1 LXT1001 Gigabit Ethernet

1 files changed, 143 insertions, 0 deletions

diff --git a/share/man/man4/lge.4 b/share/man/man4/lge.4
new file mode 100644
index 00000000000..ffd9948a0bb
--- /dev/null
+++ b/share/man/man4/lge.4
@@ -0,0 +1,143 @@
+.\" $OpenBSD: lge.4,v 1.1 2001/09/04 20:37:23 nate Exp $
+.\" Copyright (c) 2001 Wind River Systems
+.\" Copyright (c) 1997, 1998, 1999, 2000, 2001
+.\"	Bill Paul <william.paul@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: src/share/man/man4/lge.4,v 1.3 2001/07/06 08:34:13 ru Exp $
+.\"
+.Dd May 30, 2001
+.Dt LGE 4
+.Os
+.Sh NAME
+.Nm lge
+.Nd "Level 1 LXT1001 NetCellerator PCI gigabit ethernet adapter driver"
+.Sh SYNOPSIS
+.Cd "device miibus"
+.Cd "device lge"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for various NICs based on the Level 1 LXT1001
+NetCellerator gigabit ethernet controller chip, including the
+following:
+.Pp
+.Bl -bullet -compact
+.It
+SMC TigerCard 1000 (SMC9462SX)
+.It
+D-Link DGE-500SX
+.El
+.Pp
+These NICs are capable of 1000mbps speeds over fiber optic cable.
+The LXT1001 also supports a GMII port for use with 10/100/1000 copper
+PHYs, however there aren't currently any NICs on the market that use
+this feature.
+.Pp
+The LXT1001 supports TCP/IP checksum offload for receive and
+VLAN-based filtering as well as a 64-bit multicast hash filter.
+It also supports 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.
+Using jumbo frames can greatly improve performance for certain tasks,
+such as file transfers and data streaming.
+.Pp
+The
+.Nm
+driver supports the following media types:
+.Bl -tag -width ".Cm 1000baseSX"
+.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 1000baseSX
+Set 1000baseSX operation over fiber optic cable.
+Both
+.Cm full-duplex
+and
+.Cm half-duplex
+modes are supported.
+.El
+.Pp
+The
+.Nm
+driver supports the following media options:
+.Bl -tag -width ".Cm 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 "lge%d: couldn't map memory"
+A fatal initialization error has occurred.
+.It "lge%d: couldn't map ports"
+A fatal initialization error has occurred.
+.It "lge%d: couldn't map interrupt"
+A fatal initialization error has occurred.
+.It "lge%d: no memory for softc struct!"
+The driver failed to allocate memory for per-device instance information
+during initialization.
+.It "lge%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 "lge%d: no memory for jumbo buffers!"
+The driver failed to allocate memory for jumbo frames during
+initialization.
+.It "lge%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 netintro 4 ,
+.Xr ng_ether 4 ,
+.Xr ifconfig 8
+.Rs
+.%T Level 1 LXT1001 Programming Manual
+.%O http://www.FreeBSD.org/~wpaul/Level1/LXT1001SRM.pdf
+.Re
+.Sh HISTORY
+The
+.Nm
+device driver first appeared in
+.Fx 5.0 .
+.Sh AUTHORS
+The
+.Nm
+driver was written by
+.An Bill Paul Aq william.paul@windriver.com .