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