No empty .Rs/.Re
[netbsd-mini2440.git] / share / man / man4 / ti.4
blobf4d0b299d6f89aeec4895d84cb2e813f1c542dd1
1 .\"     $NetBSD: ti.4,v 1.10 2004/02/15 22:54:27 snj Exp $
2 .\"
3 .\" Copyright (c) 1997, 1998, 1999
4 .\"     Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. All advertising materials mentioning features or use of this software
15 .\"    must display the following acknowledgement:
16 .\"     This product includes software developed by Bill Paul.
17 .\" 4. Neither the name of the author nor the names of any co-contributors
18 .\"    may be used to endorse or promote products derived from this software
19 .\"   without specific prior written permission.
20 .\"
21 .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
25 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
31 .\" THE POSSIBILITY OF SUCH DAMAGE.
32 .\"
33 .\" FreeBSD Id: src/share/man/man4/ti.4,v 1.5 2000/01/23 16:13:24 asmodai Exp
34 .\"
35 .Dd June 2, 2001
36 .Dt TI 4
37 .Os
38 .Sh NAME
39 .Nm ti
40 .Nd
41 Alteon Networks Tigon I and Tigon II gigabit
42 .Tn Ethernet
43 driver
44 .Sh SYNOPSIS
45 .Cd "ti* at pci? dev ? function ?"
46 .Sh DESCRIPTION
47 The
48 .Nm
49 driver provides support for PCI gigabit
50 .Tn Ethernet
51 adapters based on the Alteon Networks Tigon gigabit
52 .Tn Ethernet
53 controller chip.
54 The Tigon contains an embedded R4000 CPU, gigabit MAC, dual DMA channels
55 and a PCI interface unit.
56 The Tigon II contains two R4000 CPUs and other refinements.
57 Either chip can be used in either a 32-bit or 64-bit PCI slot.
58 Communication with the chip is achieved via PCI shared memory
59 and bus master DMA.
60 The Tigon I and II support hardware multicast address filtering,
61 VLAN tag extraction and insertion, and jumbo
62 .Tn Ethernet
63 frames sizes up to 9000 bytes.
64 Note that the Tigon I chipset is no longer in active production:
65 all new adapters should come equipped with Tigon II chipsets.
66 .Pp
67 There are several PCI boards available from both Alteon and other
68 vendors that use the Tigon chipset under OEM contract.
69 The
70 .Nm
71 driver has been tested with the following Tigon-based adapters:
72 .Bl -bullet -offset indent
73 .It
74 The Alteon AceNIC V gigabit (1000BASE-SX and 1000BASE-T variants)
75 .Tn Ethernet
76 adapter
77 .It
78 The 3Com 3c985-SX gigabit
79 .Tn Ethernet
80 adapter
81 .It
82 The Netgear GA620 gigabit (1000BASE-SX and 1000BASE-T variants)
83 .Tn Ethernet
84 adapter
85 .It
86 The Digital EtherWORKS 1000SX PCI Gigabit Adapter (DEGPA)
87 .El
88 .Pp
89 The following should also be supported but have not yet been tested:
90 .Bl -bullet -offset indent
91 .It
92 Silicon Graphics PCI gigabit
93 .Tn Ethernet
94 adapter
95 .El
96 .Pp
97 While the Tigon chipset supports 10, 100 and 1000Mbps speeds, support for
98 10 and 100Mbps speeds is only available on boards with the proper
99 transceivers.
100 Most adapters are only designed to work at 1000Mbps, however the driver
101 should support those NICs that work at lower speeds as well.
103 Support for jumbo frames is provided via the interface MTU setting.
104 Selecting an MTU larger than 1500 bytes with the
105 .Xr ifconfig 8
106 utility configures the adapter to receive and transmit jumbo frames.
107 Using jumbo frames can greatly improve performance for certain tasks,
108 such as file transfers and data streaming.
112 driver supports the following media types:
114 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
115 .It autoselect
116 Enable autoselection of the media type and options.
117 .It 10baseT/UTP
118 Set 10Mbps operation.
120 .Ar mediaopt
121 option can also be used to select either
122 .Ar full-duplex
124 .Ar half-duplex modes .
125 .It 100baseTX
126 Set 100Mbps (fast
127 .Tn Ethernet )
128 operation.
130 .Ar mediaopt
131 option can also be used to select either
132 .Ar full-duplex
134 .Ar half-duplex
135 modes.
136 .It 1000baseSX
137 Set 1000Mbps (gigabit
138 .Tn Ethernet over multimode fiber ) operation.
139 Only full
140 .Ar full-duplex
141 mode is supported at this speed.
142 .It 1000baseT
143 Set 1000Mbps (gigabit
144 .Tn Ethernet over twisted pair ) operation.
145 Only full
146 .Ar full-duplex
147 mode is supported at this speed.
152 driver supports the following media options:
154 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
155 .It full-duplex
156 Force full duplex operation.
157 .It half-duplex
158 Force half duplex operation.
161 The Alteon Tigon and Tigon II support IPv4/TCP/UDP checksumming in
162 hardware.
165 supports this feature of the chip's firmware.
167 .Xr ifconfig 8
168 for information on how to enable this feature.
170 For more information on configuring this device, see
171 .Xr ifconfig 8 .
172 .Sh DIAGNOSTICS
173 .Bl -diag
174 .It "ti%d: can't map memory space"
175 A fatal initialization error has occurred.
176 .It "ti%d: couldn't map / establish interrupt"
177 A fatal initialization error has occurred.
178 .It "ti%d: jumbo buffer allocation failed"
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 as a result of a bug in some BIOSes.
185 This can be worked around on the Tigon II, but on the Tigon I
186 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.
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).
200 .Sh SEE ALSO
201 .Xr netintro 4 ,
202 .Xr pci 4 ,
203 .Xr ifconfig 8
204 .Sh HISTORY
207 device driver first appeared in
208 .Nx 1.4.2 .
209 .Sh AUTHORS
212 driver was written by
213 .An Bill Paul Aq wpaul@ctr.columbia.edu .
214 .Sh BUGS
215 The driver currently tries to access some on-board memory transparently.
216 This mapping (BUS_SPACE_MAP_LINEAR) fails on systems where the corresponding
217 PCI memory range is located in "sparse" space only.
219 This driver currently does not work on big-endian systems.