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: head/share/man/man4/ti.4 79727 2001-07-14 19:41:16Z schweikh $
32.\"
33.Dd March 4, 1999
34.Dt TI 4
35.Os
36.Sh NAME
37.Nm ti
38.Nd "Alteon Networks Tigon I and Tigon II gigabit ethernet driver"
39.Sh SYNOPSIS
40.Cd "device ti"
41.Sh DESCRIPTION
42The
43.Nm
44driver provides support for PCI gigabit ethernet adapters based on
45the Alteon Networks Tigon gigabit ethernet controller chip.
46The Tigon
47contains an embedded R4000 CPU, gigabit MAC, dual DMA channels and
48a PCI interface unit.
49The Tigon II contains two R4000 CPUs and other
50refinements.
51Either chip can be used in either a 32-bit or 64-bit PCI
52slot.
53Communication with the chip is achieved via PCI shared memory
54and bus master DMA.
55The Tigon I and II support hardware multicast
56address filtering, VLAN tag extraction and insertion, and jumbo
57ethernet frames sizes up to 9000 bytes.
58Note that the Tigon I chipset
59is no longer in active production: all new adapters should come equipped
60with Tigon II chipsets.
61.Pp
62There are several PCI boards available from both Alteon and other
63vendors that use the Tigon chipset under OEM contract.
64The
65.Nm
66driver has been tested with the following Tigon-based adapters:
67.Pp
68.Bl -bullet -compact -offset indent
69.It
70The Alteon AceNIC V gigabit ethernet adapter (1000baseSX)
71.It
72The Alteon AceNIC V gigabit ethernet adapter (1000baseT)
73.It
74The 3Com 3c985-SX gigabit ethernet adapter (Tigon 1)
75.It
76The 3Com 3c985B-SX gigabit ethernet adapter (Tigon 2)
77.It
78The Netgear GA620 gigabit ethernet adapter (1000baseSX)
79.It
80The Netgear GA620T gigabit ethernet adapter (1000baseT)
81.El
82.Pp
83The following should also be supported but have not yet been tested:
84.Pp
85.Bl -bullet -compact -offset indent
86.It
87The Digital EtherWORKS 1000SX PCI Gigabit Adapter
88.It
89Silicon Graphics PCI gigabit ethernet adapter
90.It
91Farallon PN9000SX Gigabit Ethernet adapter
92.It
93Asante PCI 1000BASE-SX Gigabit Ethernet Adapter
94.It
95Asante GigaNIX1000T Gigabit Ethernet Adapter
96.El
97.Pp
98While the Tigon chipset supports 10, 100 and 1000Mbps speeds, support for
9910 and 100Mbps speeds is only available on boards with the proper
100transceivers.
101Most adapters are only designed to work at 1000Mbps,
102however the driver should support those NICs that work at lower speeds
103as well.
104.Pp
105Support for jumbo frames is provided via the interface MTU setting.
106Selecting an MTU larger than 1500 bytes with the
107.Xr ifconfig 8
108utility configures the adapter to receive and transmit jumbo frames.
109Using jumbo frames can greatly improve performance for certain tasks,
110such as file transfers and data streaming.
111.Pp
112Support for vlans is also available using the
113.Xr vlan 4
114mechanism.
115See the
116.Xr vlan 4
117man page for more details.
118.Pp
119The
120.Nm
121driver supports the following media types:
122.Pp
123.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
124.It autoselect
125Enable autoselection of the media type and options.
126The user can manually override
127the autoselected mode by adding media options to the
128.Pa /etc/rc.conf
129file.
130.It 10baseT/UTP
131Set 10Mbps operation.
132The
133.Ar mediaopt
134option can also be used to select either
135.Ar full-duplex
136or
137.Ar half-duplex
138modes.
139.It 100baseTX
140Set 100Mbps (fast ethernet) operation.
141The
142.Ar mediaopt
143option can also be used to select either
144.Ar full-duplex
145or
146.Ar half-duplex
147modes.
148.It 1000baseSX
149Set 1000Mbps (gigabit ethernet) operation.
150Only full
151.Ar full-duplex
152mode is supported at this speed.
153.El
154.Pp
155The
156.Nm
157driver supports the following media options:
158.Pp
159.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
160.It full-duplex
161Force full duplex operation
162.It half-duplex
163Force half duplex operation.
164.El
165.Pp
166For more information on configuring this device, see
167.Xr ifconfig 8 .
168.Sh DIAGNOSTICS
169.Bl -diag
170.It "ti%d: couldn't map memory"
171A fatal initialization error has occurred.
172.It "ti%d: couldn't map interrupt"
173A fatal initialization error has occurred.
174.It "ti%d: no memory for softc struct!"
175The driver failed to allocate memory for per-device instance information
176during initialization.
177.It "ti%d: failed to enable memory mapping!"
178The driver failed to initialize PCI shared memory mapping.
179This might
180happen if the card is not in a bus-master slot.
181.It "ti%d: no memory for jumbo buffers!"
182The driver failed to allocate memory for jumbo frames during
183initialization.
184.It "ti%d: bios thinks we're in a 64 bit slot, but we aren't"
185The BIOS has programmed the NIC as though it had been installed in
186a 64-bit PCI slot, but in fact the NIC is in a 32-bit slot.
187This happens
188as a result of a bug in some BIOSes.
189This can be worked around on the
190Tigon II, but on the Tigon I initialization will fail.
191.It "ti%d: board self-diagnostics failed!"
192The ROMFAIL bit in the CPU state register was set after system
193startup, indicating that the on-board NIC diagnostics failed.
194.It "ti%d: unknown hwrev"
195The driver detected a board with an unsupported hardware revision.
196The
197.Nm
198driver supports revision 4 (Tigon 1) and revision 6 (Tigon 2) chips
199and has firmware only for those devices.
200.It "ti%d: watchdog timeout"
201The device has stopped responding to the network, or there is a problem with
202the network connection (cable).
203.El
204.Sh SEE ALSO
205.Xr arp 4 ,
206.Xr netintro 4 ,
207.Xr ng_ether 4 ,
208.Xr vlan 4 ,
209.Xr ifconfig 8
210.Rs
211.%T Alteon Gigabit Ethernet/PCI NIC manuals
212.%O http://sanjose.alteon.com/open.shtml
213.Re
214.Sh HISTORY
215The
216.Nm
217device driver first appeared in
218.Fx 3.0 .
219.Sh AUTHORS
220The
221.Nm
222driver was written by
223.An Bill Paul Aq wpaul@bsdi.com .
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: head/share/man/man4/ti.4 79727 2001-07-14 19:41:16Z schweikh $
32.\"
33.Dd March 4, 1999
34.Dt TI 4
35.Os
36.Sh NAME
37.Nm ti
38.Nd "Alteon Networks Tigon I and Tigon II gigabit ethernet driver"
39.Sh SYNOPSIS
40.Cd "device ti"
41.Sh DESCRIPTION
42The
43.Nm
44driver provides support for PCI gigabit ethernet adapters based on
45the Alteon Networks Tigon gigabit ethernet controller chip.
46The Tigon
47contains an embedded R4000 CPU, gigabit MAC, dual DMA channels and
48a PCI interface unit.
49The Tigon II contains two R4000 CPUs and other
50refinements.
51Either chip can be used in either a 32-bit or 64-bit PCI
52slot.
53Communication with the chip is achieved via PCI shared memory
54and bus master DMA.
55The Tigon I and II support hardware multicast
56address filtering, VLAN tag extraction and insertion, and jumbo
57ethernet frames sizes up to 9000 bytes.
58Note that the Tigon I chipset
59is no longer in active production: all new adapters should come equipped
60with Tigon II chipsets.
61.Pp
62There are several PCI boards available from both Alteon and other
63vendors that use the Tigon chipset under OEM contract.
64The
65.Nm
66driver has been tested with the following Tigon-based adapters:
67.Pp
68.Bl -bullet -compact -offset indent
69.It
70The Alteon AceNIC V gigabit ethernet adapter (1000baseSX)
71.It
72The Alteon AceNIC V gigabit ethernet adapter (1000baseT)
73.It
74The 3Com 3c985-SX gigabit ethernet adapter (Tigon 1)
75.It
76The 3Com 3c985B-SX gigabit ethernet adapter (Tigon 2)
77.It
78The Netgear GA620 gigabit ethernet adapter (1000baseSX)
79.It
80The Netgear GA620T gigabit ethernet adapter (1000baseT)
81.El
82.Pp
83The following should also be supported but have not yet been tested:
84.Pp
85.Bl -bullet -compact -offset indent
86.It
87The Digital EtherWORKS 1000SX PCI Gigabit Adapter
88.It
89Silicon Graphics PCI gigabit ethernet adapter
90.It
91Farallon PN9000SX Gigabit Ethernet adapter
92.It
93Asante PCI 1000BASE-SX Gigabit Ethernet Adapter
94.It
95Asante GigaNIX1000T Gigabit Ethernet Adapter
96.El
97.Pp
98While the Tigon chipset supports 10, 100 and 1000Mbps speeds, support for
9910 and 100Mbps speeds is only available on boards with the proper
100transceivers.
101Most adapters are only designed to work at 1000Mbps,
102however the driver should support those NICs that work at lower speeds
103as well.
104.Pp
105Support for jumbo frames is provided via the interface MTU setting.
106Selecting an MTU larger than 1500 bytes with the
107.Xr ifconfig 8
108utility configures the adapter to receive and transmit jumbo frames.
109Using jumbo frames can greatly improve performance for certain tasks,
110such as file transfers and data streaming.
111.Pp
112Support for vlans is also available using the
113.Xr vlan 4
114mechanism.
115See the
116.Xr vlan 4
117man page for more details.
118.Pp
119The
120.Nm
121driver supports the following media types:
122.Pp
123.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
124.It autoselect
125Enable autoselection of the media type and options.
126The user can manually override
127the autoselected mode by adding media options to the
128.Pa /etc/rc.conf
129file.
130.It 10baseT/UTP
131Set 10Mbps operation.
132The
133.Ar mediaopt
134option can also be used to select either
135.Ar full-duplex
136or
137.Ar half-duplex
138modes.
139.It 100baseTX
140Set 100Mbps (fast ethernet) operation.
141The
142.Ar mediaopt
143option can also be used to select either
144.Ar full-duplex
145or
146.Ar half-duplex
147modes.
148.It 1000baseSX
149Set 1000Mbps (gigabit ethernet) operation.
150Only full
151.Ar full-duplex
152mode is supported at this speed.
153.El
154.Pp
155The
156.Nm
157driver supports the following media options:
158.Pp
159.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
160.It full-duplex
161Force full duplex operation
162.It half-duplex
163Force half duplex operation.
164.El
165.Pp
166For more information on configuring this device, see
167.Xr ifconfig 8 .
168.Sh DIAGNOSTICS
169.Bl -diag
170.It "ti%d: couldn't map memory"
171A fatal initialization error has occurred.
172.It "ti%d: couldn't map interrupt"
173A fatal initialization error has occurred.
174.It "ti%d: no memory for softc struct!"
175The driver failed to allocate memory for per-device instance information
176during initialization.
177.It "ti%d: failed to enable memory mapping!"
178The driver failed to initialize PCI shared memory mapping.
179This might
180happen if the card is not in a bus-master slot.
181.It "ti%d: no memory for jumbo buffers!"
182The driver failed to allocate memory for jumbo frames during
183initialization.
184.It "ti%d: bios thinks we're in a 64 bit slot, but we aren't"
185The BIOS has programmed the NIC as though it had been installed in
186a 64-bit PCI slot, but in fact the NIC is in a 32-bit slot.
187This happens
188as a result of a bug in some BIOSes.
189This can be worked around on the
190Tigon II, but on the Tigon I initialization will fail.
191.It "ti%d: board self-diagnostics failed!"
192The ROMFAIL bit in the CPU state register was set after system
193startup, indicating that the on-board NIC diagnostics failed.
194.It "ti%d: unknown hwrev"
195The driver detected a board with an unsupported hardware revision.
196The
197.Nm
198driver supports revision 4 (Tigon 1) and revision 6 (Tigon 2) chips
199and has firmware only for those devices.
200.It "ti%d: watchdog timeout"
201The device has stopped responding to the network, or there is a problem with
202the network connection (cable).
203.El
204.Sh SEE ALSO
205.Xr arp 4 ,
206.Xr netintro 4 ,
207.Xr ng_ether 4 ,
208.Xr vlan 4 ,
209.Xr ifconfig 8
210.Rs
211.%T Alteon Gigabit Ethernet/PCI NIC manuals
212.%O http://sanjose.alteon.com/open.shtml
213.Re
214.Sh HISTORY
215The
216.Nm
217device driver first appeared in
218.Fx 3.0 .
219.Sh AUTHORS
220The
221.Nm
222driver was written by
223.An Bill Paul Aq wpaul@bsdi.com .