xref: /dragonfly/share/man/man4/ti.4 (revision 36a3d1d6)
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.4 2008/05/02 02:05:05 swildner 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.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
120.It autoselect
121Enable autoselection of the media type and options.
122The user can manually override
123the autoselected mode by adding media options to the
124.Pa /etc/rc.conf
125file.
126.It 10baseT/UTP
127Set 10Mbps operation.
128The
129.Ar mediaopt
130option can also be used to select either
131.Ar full-duplex
132or
133.Ar half-duplex
134modes.
135.It 100baseTX
136Set 100Mbps (fast ethernet) operation.
137The
138.Ar mediaopt
139option can also be used to select either
140.Ar full-duplex
141or
142.Ar half-duplex
143modes.
144.It 1000baseSX
145Set 1000Mbps (gigabit ethernet) operation.
146Only full
147.Ar full-duplex
148mode is supported at this speed.
149.El
150.Pp
151The
152.Nm
153driver supports the following media options:
154.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
155.It full-duplex
156Force full duplex operation
157.It half-duplex
158Force half duplex operation.
159.El
160.Pp
161For more information on configuring this device, see
162.Xr ifconfig 8 .
163.Sh DIAGNOSTICS
164.Bl -diag
165.It "ti%d: couldn't map memory"
166A fatal initialization error has occurred.
167.It "ti%d: couldn't map interrupt"
168A fatal initialization error has occurred.
169.It "ti%d: no memory for softc struct!"
170The driver failed to allocate memory for per-device instance information
171during initialization.
172.It "ti%d: failed to enable memory mapping!"
173The driver failed to initialize PCI shared memory mapping.
174This might
175happen if the card is not in a bus-master slot.
176.It "ti%d: no memory for jumbo buffers!"
177The driver failed to allocate memory for jumbo frames during
178initialization.
179.It "ti%d: bios thinks we're in a 64 bit slot, but we aren't"
180The BIOS has programmed the NIC as though it had been installed in
181a 64-bit PCI slot, but in fact the NIC is in a 32-bit slot.
182This happens
183as a result of a bug in some BIOSes.
184This can be worked around on the
185Tigon II, but on the Tigon I initialization will fail.
186.It "ti%d: board self-diagnostics failed!"
187The ROMFAIL bit in the CPU state register was set after system
188startup, indicating that the on-board NIC diagnostics failed.
189.It "ti%d: unknown hwrev"
190The driver detected a board with an unsupported hardware revision.
191The
192.Nm
193driver supports revision 4 (Tigon 1) and revision 6 (Tigon 2) chips
194and has firmware only for those devices.
195.It "ti%d: watchdog timeout"
196The device has stopped responding to the network, or there is a problem with
197the network connection (cable).
198.El
199.Sh SEE ALSO
200.Xr arp 4 ,
201.Xr ifmedia 4 ,
202.Xr netintro 4 ,
203.Xr ng_ether 4 ,
204.Xr vlan 4 ,
205.Xr ifconfig 8
206.Rs
207.%T Alteon Gigabit Ethernet/PCI NIC manuals
208.%O http://sanjose.alteon.com/open.shtml
209.Re
210.Sh HISTORY
211The
212.Nm
213device driver first appeared in
214.Fx 3.0 .
215.Sh AUTHORS
216The
217.Nm
218driver was written by
219.An Bill Paul Aq wpaul@bsdi.com .
220