xref: /openbsd-src/share/man/man4/ti.4 (revision 2b0358df1d88d06ef4139321dd05bd5e05d91eaf)
1.\"	$OpenBSD: ti.4,v 1.31 2008/10/28 06:27:28 brad Exp $
2.\"
3.\" Copyright (c) 1997, 1998, 1999
4.\"	Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by Bill Paul.
17.\" 4. Neither the name of the author nor the names of any co-contributors
18.\"    may be used to endorse or promote products derived from this software
19.\"   without specific prior written permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
22.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24.\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
25.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
31.\" THE POSSIBILITY OF SUCH DAMAGE.
32.\"
33.\"	$FreeBSD: src/share/man/man4/ti.4,v 1.11 2000/08/10 19:47:32 billf Exp $
34.\"
35.Dd $Mdocdate: October 28 2008 $
36.Dt TI 4
37.Os
38.Sh NAME
39.Nm ti
40.Nd Alteon Networks Tigon I and II Gigabit Ethernet device
41.Sh SYNOPSIS
42.Cd "ti* at pci?"
43.Sh DESCRIPTION
44The
45.Nm
46driver provides support for PCI Gigabit Ethernet adapters based on
47the Alteon Networks Tigon Gigabit Ethernet controller chip.
48The Tigon contains an embedded R4000 CPU, Gigabit MAC, dual DMA channels and
49a PCI interface unit.
50The Tigon II contains two R4000 CPUs and other refinements.
51Either chip can be used in either a 32-bit or 64-bit PCI slot.
52Communication with the chip is achieved via PCI shared memory and
53bus master DMA.
54The Tigon I and II support hardware multicast address filtering,
55VLAN tag insertion and stripping, and Jumbo frame sizes up to
569000 bytes.
57Note that the Tigon I chipset is no longer in active production: all new
58adapters should come equipped with Tigon II chipsets.
59.Pp
60There are several PCI boards available from both Alteon and other
61vendors that use the Tigon chipset under OEM contract.
62The
63.Nm
64driver has been tested with the following Tigon-based adapters:
65.Pp
66.Bl -bullet -compact -offset indent
67.It
68The Alteon AceNIC V Gigabit Ethernet adapter (1000baseSX)
69.It
70The Alteon AceNIC V Gigabit Ethernet adapter (1000baseT)
71.It
72The 3Com 3C985-SX Gigabit Ethernet adapter (Tigon 1)
73.It
74The 3Com 3C985B-SX Gigabit Ethernet adapter (Tigon 2)
75.It
76The Netgear GA620 Gigabit Ethernet adapter (1000baseSX)
77.It
78The Netgear GA620T Gigabit Ethernet adapter (1000baseT)
79.El
80.Pp
81The following should also be supported but have not yet been tested:
82.Pp
83.Bl -bullet -compact -offset indent
84.It
85The Digital EtherWORKS 1000SX PCI Gigabit Adapter
86.It
87Silicon Graphics PCI Gigabit Ethernet adapter
88.It
89Farallon PN9000SX Gigabit Ethernet adapter
90.El
91.Pp
92While the Tigon chipset supports 10, 100 and 1000Mbps speeds, support for
9310 and 100Mbps speeds is only available on boards with the proper
94transceivers.
95Most adapters are only designed to work at 1000Mbps, however the driver
96should support those NICs that work at lower speeds as well.
97.Pp
98Support for Jumbo frames is provided via the interface MTU setting.
99Selecting an MTU larger than 1500 bytes with the
100.Xr ifconfig 8
101utility configures the adapter to receive and transmit Jumbo frames.
102Using Jumbo frames can greatly improve performance for certain tasks,
103such as file transfers and data streaming.
104.Pp
105The
106.Nm
107driver supports the following media types:
108.Bl -tag -width full-duplex
109.It autoselect
110Enable autoselection of the media type and options.
111The user can manually override
112the autoselected mode by adding media options to the appropriate
113.Xr hostname.if 5
114file.
115.It 10baseT
116Set 10Mbps operation
117The
118.Ar mediaopt
119option can also be used to select either
120.Ar full-duplex
121or
122.Ar half-duplex
123modes.
124.It 100baseTX
125Set 100Mbps (Fast Ethernet) operation.
126The
127.Ar mediaopt
128option can also be used to select either
129.Ar full-duplex
130or
131.Ar half-duplex
132modes.
133.It 1000baseSX
134Set 1000Mbps (Gigabit Ethernet) on fiber operation.
135Only
136.Ar full-duplex
137mode is supported at this speed.
138.It 1000baseT
139Set 1000Mbps (Gigabit Ethernet) on copper operation.
140.El
141.Pp
142The
143.Nm
144driver supports the following media options:
145.Bl -tag -width full-duplex
146.It full-duplex
147Force full duplex operation
148.It half-duplex
149Force half duplex operation
150.El
151.Pp
152For more information on configuring this device, see
153.Xr ifconfig 8 .
154.Sh FILES
155Two firmware files are necessary, for Tigon 1 and Tigon 2 devices.
156These are loaded on demand
157when the device is attached:
158.Pp
159.Bl -tag -width Ds -offset indent -compact
160.It Pa /etc/firmware/tigon1
161.It Pa /etc/firmware/tigon2
162.El
163.Pp
164These firmware files are not free, and hence not included, because
165the vendor no longer exists to grant rights to the firmware files.
166.Sh DIAGNOSTICS
167.Bl -diag
168.It "ti%d: couldn't map memory"
169A fatal initialization error has occurred.
170.It "ti%d: couldn't map interrupt"
171A fatal initialization error has occurred.
172.It "ti%d: no memory for softc struct!"
173The driver failed to allocate memory for per-device instance information
174during initialization.
175.It "ti%d: failed to enable memory mapping!"
176The driver failed to initialize PCI shared memory mapping.
177This might happen if the card is not in a bus-master slot.
178.It "ti%d: no memory for jumbo buffers!"
179The driver failed to allocate memory for Jumbo frames during
180initialization.
181.It "ti%d: bios thinks we're in a 64 bit slot, but we aren't"
182The BIOS has programmed the NIC as though it had been installed in
183a 64-bit PCI slot, but in fact the NIC is in a 32-bit slot.
184This happens as a result of a bug in some BIOSes.
185This can be worked around on the Tigon II, but
186on the Tigon I initialization will fail.
187.It "ti%d: board self-diagnostics failed!"
188The ROMFAIL bit in the CPU state register was set after system
189startup, indicating that the on-board NIC diagnostics failed.
190.It "ti%d: unknown hwrev"
191The driver detected a board with an unsupported hardware revision.
192The
193.Nm
194driver supports revision 4 (Tigon 1) and revision 6 (Tigon 2) chips
195and has firmware only for those devices.
196.It "ti%d: watchdog timeout"
197The device has stopped responding to the network, or there is a problem with
198the network connection (cable).
199.El
200.Sh SEE ALSO
201.Xr arp 4 ,
202.Xr ifmedia 4 ,
203.Xr intro 4 ,
204.Xr netintro 4 ,
205.Xr pci 4 ,
206.Xr hostname.if 5 ,
207.Xr ifconfig 8
208.Sh HISTORY
209The
210.Nm
211device driver first appeared in
212.Fx 3.0 .
213.Ox
214support first appeared in
215.Ox 2.6 .
216.Sh AUTHORS
217The
218.Nm
219driver was written by
220.An Bill Paul Aq wpaul@bsdi.com .
221