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