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