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