[src/trunk]: src/share/man/man4 add manpage for the if_ti Gigabit Ethernet dr...

[drochner <drochner%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/3c458c85afff
branches:  trunk
changeset: 481932:3c458c85afff
user:      drochner <drochner%NetBSD.org@localhost>
date:      Wed Feb 09 14:21:06 2000 +0000

description:
add manpage for the if_ti Gigabit Ethernet driver, from FreeBSD,
with slight modifications

diffstat:

 share/man/man4/Makefile |    4 +-
 share/man/man4/ti.4     |  183 ++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 185 insertions(+), 2 deletions(-)

diffs (205 lines):

diff -r 8611db6a39da -r 3c458c85afff share/man/man4/Makefile
--- a/share/man/man4/Makefile   Wed Feb 09 13:57:06 2000 +0000
+++ b/share/man/man4/Makefile   Wed Feb 09 14:21:06 2000 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: Makefile,v 1.128 2000/02/07 18:00:10 bouyer Exp $
+#      $NetBSD: Makefile,v 1.129 2000/02/09 14:21:06 drochner Exp $
 #      @(#)Makefile    8.1 (Berkeley) 6/18/93
 
 MAN=   adw.4 ahb.4 ahc.4 aria.4 atalk.4 audio.4 awi.4 bha.4 bpf.4 cardbus.4 \
@@ -11,7 +11,7 @@
        pciide.4 pckbc.4 pckbd.4 pcppi.4 pcscp.4 pms.4 ppp.4 \
        pty.4 puc.4 qsphy.4 raid.4 ray.4 rl.4 rnd.4 route.4 scsi.4 sd.4 \
        sl.4 sm.4 speaker.4 spp.4 sqphy.4 ss.4 st.4 sv.4 strip.4 \
-       tb.4 tcp.4 termios.4 tl.4 tlp.4 tlphy.4 tp.4 tr.4 tty.4 \
+       tb.4 tcp.4 termios.4 ti.4 tl.4 tlp.4 tlphy.4 tp.4 tr.4 tty.4 \
        tun.4 tqphy.4 udp.4 uha.4 uk.4 ukphy.4 unix.4 vga.4 \
        vnd.4 vr.4 wd.4 wdc.4 wi.4 wscons.4 wsdisplay.4 wskbd.4 \
        wsmouse.4 wsmux.4 ym.4 zero.4 zstty.4
diff -r 8611db6a39da -r 3c458c85afff share/man/man4/ti.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/ti.4       Wed Feb 09 14:21:06 2000 +0000
@@ -0,0 +1,183 @@
+.\" Copyright (c) 1997, 1998, 1999
+.\"    Bill Paul <wpaul%ctr.columbia.edu@localhost>. 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 Id: src/share/man/man4/ti.4,v 1.5 2000/01/23 16:13:24 asmodai Exp
+.\" $NetBSD: ti.4,v 1.1 2000/02/09 14:21:06 drochner Exp $
+.\"
+.Dd March 4, 1999
+.Dt TI 4
+.Os
+.Sh NAME
+.Nm ti
+.Nd
+Alteon Networks Tigon I and Tigon II gigabit ethernet driver
+.Sh SYNOPSIS
+.Cd "ti* at pci?"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for PCI gigabit ethernet adapters based on
+the Alteon Networks Tigon gigabit ethernet controller chip. The Tigon
+contains an embedded R4000 CPU, gigabit MAC, dual DMA channels and
+a PCI interface unit. The Tigon II contains two R4000 CPUs and other
+refinements. Either chip can be used in either a 32-bit or 64-bit PCI
+slot. Communication with the chip is achieved via PCI shared memory
+and bus master DMA. The Tigon I and II support hardware multicast
+address filtering, VLAN tag extraction and insertion, and jumbo
+ethernet frames sizes up to 9000 bytes. Note that the Tigon I chipset
+is no longer in active production: all new adapters should come equipped
+with Tigon II chipsets.
+.Pp
+There are several PCI boards available from both Alteon and other
+vendors that use the Tigon chipset under OEM contract. The
+.Nm
+driver has been tested with the following Tigon-based adapters:
+.Bl -bullet -offset indent
+.It
+The Alteon AceNIC V gigabit ethernet adapter
+.It
+The 3Com 3c985-SX gigabit ethernet adapter
+.It
+The Netgear GA620 gigabit ethernet adapter
+.It
+The Digital EtherWORKS 1000SX PCI Gigabit Adapter (DEGPA)
+.El
+.Pp
+The following should also be supported but have not yet been tested:
+.Bl -bullet -offset indent
+.It
+Silicon Graphics PCI gigabit ethernet adapter
+.El
+.Pp
+While the Tigon chipset supports 10, 100 and 1000Mbps speeds, support for
+10 and 100Mbps speeds is only available on boards with the proper
+transceivers. Most adapters are only designed to work at 1000Mbps,
+however the driver should support those NICs that work at lower speeds
+as well.
+.Pp
+Support for jumbo frames is provided 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:
+.Pp
+.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
+.It autoselect
+Enable autoselection of the media type and options.
+.It 10baseT/UTP
+Set 10Mbps operation. The
+.Ar mediaopt
+option can also be used to select either
+.Ar full-duplex
+or
+.Ar half-duplex modes.
+.It 100baseTX
+Set 100Mbps (fast ethernet) operation. The
+.Ar mediaopt
+option can also be used to select either
+.Ar full-duplex
+or
+.Ar half-duplex
+modes.
+.It 1000baseSX
+Set 1000Mbps (gigabit ethernet) operation. Only full
+.Ar full-duplex
+mode is supported at this speed.
+.El
+.Pp
+The
+.Nm
+driver supports the following media options:
+.Pp
+.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
+.It full-duplex
+Force full duplex operation
+.It half-duplex
+Force half duplex operation.
+.El
+.Pp
+For more information on configuring this device, see
+.Xr ifconfig 8 .
+.Sh DIAGNOSTICS
+.Bl -diag
+.It "ti%d: can't map memory space"
+A fatal initialization error has occurred.
+.It "ti%d: couldn't map / establish interrupt"
+A fatal initialization error has occurred.
+.It "ti%d: jumbo buffer allocation failed"
+The driver failed to allocate memory for jumbo frames during
+initialization.
+.It "ti%d: bios thinks we're in a 64 bit slot, but we aren't"
+The BIOS has programmed the NIC as though it had been installed in
+a 64-bit PCI slot, but in fact the NIC is in a 32-bit slot. This happens
+as a result of a bug in some BIOSes. This can be worked around on the
+Tigon II, but on the Tigon I initialization will fail.
+.It "ti%d: board self-diagnostics failed!"
+The ROMFAIL bit in the CPU state register was set after system
+startup, indicating that the on-board NIC diagnostics failed.
+.It "ti%d: unknown hwrev"
+The driver detected a board with an unsupported hardware revision. The
+.Nm
+driver supports revision 4 (Tigon 1) and revision 6 (Tigon 2) chips
+and has firmware only for those devices.
+.It "ti%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 netintro 4 , 
+.Xr ifconfig 8 ,
+.Xr pci 4
+.Rs
+.%T Alteon Gigabit Ethernet/PCI NIC manuals
+.%O http://www.alteon.com/support/openkits
+.Re
+.Sh HISTORY
+The
+.Nm
+device driver first appeared in
+.Nx 1.5/1.4.2 .
+.Sh AUTHORS
+The
+.Nm
+driver was written by
+.An Bill Paul Aq wpaul%ctr.columbia.edu@localhost .
+.Sh BUGS
+The driver currently tries to access some on-board memory transparently.
+This mapping (BUS_SPACE_MAP_LINEAR) fails on systems where the corresponding
+PCI memory range is located in "sparse" space only.
+.Pp
+VLAN tagging is not supported in 
+.Nx .