man page for ti driver

2 files changed, 192 insertions, 2 deletions

diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index bf9e3931c21..8e160fa7792 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,4 +1,4 @@
-#	$OpenBSD: Makefile,v 1.65 1999/07/25 15:50:44 csapuntz Exp $
+#	$OpenBSD: Makefile,v 1.66 1999/07/25 17:12:55 jason Exp $
 #	$NetBSD: Makefile,v 1.22.4.2 1996/07/18 00:51:10 jtc Exp $
 
 MAN=	atalk.4 atapiscsi.4 audio.4 acd.4 adv.4 ahc.4 bpf.4 bridge.4 ccd.4 \
@@ -10,7 +10,7 @@ MAN=	atalk.4 atapiscsi.4 audio.4 acd.4 adv.4 ahc.4 bpf.4 bridge.4 ccd.4 \
 	ns.4 nsip.4 nsphy.4 null.4 opl.4 options.4 pcmcia.4 pn.4 pty.4 \
 	qsphy.4 raid.4 random.4 rl.4 rln.4 rlphy.4 route.4 scsi.4 sd.4 sl.4 \
 	sm.4 spp.4 sppp.4 sqphy.4 ss.4 st.4 sv.4 \
-	tb.4 tcp.4 termios.4 tl.4 tlphy.4 \
+	tb.4 tcp.4 termios.4 ti.4 tl.4 tlphy.4 \
 	tty.4 tp.4 tun.4 tx.4 udp.4 uk.4 unix.4 vnd.4 wb.4 we.4 wd.4 xl.4 ym.4
 MLINKS+=fd.4 stderr.4 fd.4 stdin.4 fd.4 stdout.4
 MLINKS+=netintro.4 networking.4
diff --git a/share/man/man4/ti.4 b/share/man/man4/ti.4
new file mode 100644
index 00000000000..698f3f4639c
--- /dev/null
+++ b/share/man/man4/ti.4
@@ -0,0 +1,190 @@
+.\"	$OpenBSD: ti.4,v 1.1 1999/07/25 17:12:55 jason Exp $
+.\"
+.\" Copyright (c) 1997, 1998, 1999
+.\"	Bill Paul <wpaul@ctr.columbia.edu>. 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: ti.4,v 1.1 1999/04/06 17:08:29 wpaul 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? dev ? function ?"
+.Sh DESCRIPTION
+The
+.Nm ti
+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
+.El
+.Pp
+The following should also be supported but have not yet been tested:
+.Bl -bullet -offset indent
+.It
+The Digital EtherWORKS 1000SX PCI Gigabit Adapter
+.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.
+The user can manually override
+the autoselected mode by adding media options to the appropriate
+.Pa /etc/hostname.tiX
+file.
+.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: couldn't map memory"
+A fatal initialization error has occurred.
+.It "ti%d: couldn't map interrupt"
+A fatal initialization error has occurred.
+.It "ti%d: no memory for softc struct!"
+The driver failed to allocate memory for per-device instance information
+during initialization.
+.It "ti%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 "ti%d: no memory for jumbo buffers!"
+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 arp 4 ,
+.Xr ifmedia 4 ,
+.Xr netintro 4 , 
+.Xr ifconfig 8
+.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
+.Fx 3.0 .
+.Ox
+support first appeared in
+.Ox 2.6 .
+.Sh AUTHOR
+The
+.Nm
+driver was written by
+.An Bill Paul Aq wpaul@ctr.columbia.edu .