1 .\" Copyright (c) 1997, 1998, 1999
2 .\" Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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.
38 .Nd "Alteon Networks Tigon I and Tigon II gigabit ethernet driver"
41 .Cd "options TI_PRIVATE_JUMBOS"
42 .Cd "options TI_JUMBO_HDRSPLIT"
46 driver provides support for PCI gigabit ethernet adapters based on
47 the Alteon Networks Tigon gigabit ethernet controller chip.
49 contains an embedded R4000 CPU, gigabit MAC, dual DMA channels and
51 The Tigon II contains two R4000 CPUs and other
53 Either chip can be used in either a 32-bit or 64-bit PCI
55 Communication with the chip is achieved via PCI shared memory
57 The Tigon I and II support hardware multicast
58 address filtering, VLAN tag extraction and insertion, and jumbo
59 ethernet frames sizes up to 9000 bytes.
60 Note that the Tigon I chipset
61 is no longer in active production: all new adapters should come equipped
62 with Tigon II chipsets.
64 There are several PCI boards available from both Alteon and other
65 vendors that use the Tigon chipset under OEM contract.
68 driver has been tested with the following Tigon-based adapters:
70 .Bl -bullet -compact -offset indent
72 3Com 3c985-SX Gigabit Ethernet adapter (Tigon 1)
74 3Com 3c985B-SX Gigabit Ethernet adapter (Tigon 2)
76 Alteon AceNIC V Gigabit Ethernet adapter (1000baseSX)
78 Alteon AceNIC V Gigabit Ethernet adapter (1000baseT)
80 Netgear GA620 Gigabit Ethernet adapter (1000baseSX)
82 Netgear GA620T Gigabit Ethernet adapter (1000baseT)
85 The following should also be supported but have not yet been tested:
87 .Bl -bullet -compact -offset indent
89 Asante GigaNIX1000T Gigabit Ethernet adapter
91 Asante PCI 1000BASE-SX Gigabit Ethernet adapter
93 Digital EtherWORKS 1000SX PCI Gigabit adapter
95 Farallon PN9000SX Gigabit Ethernet adapter
99 Silicon Graphics PCI Gigabit Ethernet adapter
102 While the Tigon chipset supports 10, 100 and 1000Mbps speeds, support for
103 10 and 100Mbps speeds is only available on boards with the proper
105 Most adapters are only designed to work at 1000Mbps,
106 however the driver should support those NICs that work at lower speeds
109 Support for jumbo frames is provided via the interface MTU setting.
110 Selecting an MTU larger than 1500 bytes with the
112 utility configures the adapter to receive and transmit jumbo frames.
113 Using jumbo frames can greatly improve performance for certain tasks,
114 such as file transfers and data streaming.
116 Header splitting support for Tigon 2 boards (this option has no effect for
117 the Tigon 1) can be turned on with the
118 .Dv TI_JUMBO_HDRSPLIT
122 for more discussion on zero copy receive and header splitting.
126 driver normally uses jumbo receive buffers allocated by the
128 buffer allocator, but can be configured to use its own private pool of
129 jumbo buffers that are contiguous instead of buffers from the jumbo
130 allocator, which are made up of multiple page sized chunks.
131 To turn on private jumbos, use the
132 .Dv TI_PRIVATE_JUMBOS
135 Support for vlans is also available using the
140 man page for more details.
144 driver supports the following media types:
146 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
148 Enable autoselection of the media type and options.
149 The user can manually override
150 the autoselected mode by adding media options to the
154 Set 10Mbps operation.
157 option can also be used to select either
163 Set 100Mbps (fast ethernet) operation.
166 option can also be used to select either
172 Set 1000Mbps (gigabit ethernet) operation.
175 mode is supported at this speed.
180 driver supports the following media options:
182 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
184 Force full duplex operation
186 Force half duplex operation.
189 For more information on configuring this device, see
192 In addition to the standard
195 calls implemented by most network drivers, the
197 driver also includes a character device interface that can be used for
198 additional diagnostics, configuration and debugging.
200 device interface, and a specially patched version of
203 debug firmware running on the Tigon board.
205 These ioctls and their arguments are defined in the
208 .Bl -tag -width ".Dv ALT_WRITE_TG_MEM"
210 Return card statistics DMAed from the card into kernel memory approximately
211 every 2 seconds. (That time interval can be changed via the
213 ioctl.) The argument is
214 .Vt "struct ti_stats" .
215 .It Dv TIIOCGETPARAMS
216 Get various performance-related firmware parameters that largely affect how
217 interrupts are coalesced.
219 .Vt "struct ti_params" .
220 .It Dv TIIOCSETPARAMS
221 Set various performance-related firmware parameters that largely affect how
222 interrupts are coalesced. The argument is
223 .Vt "struct ti_params" .
225 Tell the NIC to trace the requested types of information.
229 Dump the trace buffer from the card.
231 .Vt "struct ti_trace_buf" .
233 This ioctl is used for compatibility with Alteon's Solaris driver.
234 They apparently only have one character interface for debugging, so they have
235 to tell it which Tigon instance they want to debug.
236 This ioctl is a noop for
238 .It Dv ALT_READ_TG_MEM
239 Read the requested memory region from the Tigon board.
241 .Vt "struct tg_mem" .
242 .It Dv ALT_WRITE_TG_MEM
243 Write to the requested memory region on the Tigon board.
245 .Vt "struct tg_mem" .
246 .It Dv ALT_READ_TG_REG
247 Read the requested register on the Tigon board.
249 .Vt "struct tg_reg" .
250 .It Dv ALT_WRITE_TG_REG
251 Write to the requested register on the Tigon board.
253 .Vt "struct tg_reg" .
256 .Bl -tag -width ".Pa /dev/ti[0-255]" -compact
257 .It Pa /dev/ti[0-255]
258 Tigon driver character interface.
262 .It "ti%d: couldn't map memory"
263 A fatal initialization error has occurred.
264 .It "ti%d: couldn't map interrupt"
265 A fatal initialization error has occurred.
266 .It "ti%d: no memory for softc struct!"
267 The driver failed to allocate memory for per-device instance information
268 during initialization.
269 .It "ti%d: failed to enable memory mapping!"
270 The driver failed to initialize PCI shared memory mapping.
272 happen if the card is not in a bus-master slot.
273 .It "ti%d: no memory for jumbo buffers!"
274 The driver failed to allocate memory for jumbo frames during
276 .It "ti%d: bios thinks we're in a 64 bit slot, but we aren't"
277 The BIOS has programmed the NIC as though it had been installed in
278 a 64-bit PCI slot, but in fact the NIC is in a 32-bit slot.
280 as a result of a bug in some BIOSes.
281 This can be worked around on the
282 Tigon II, but on the Tigon I initialization will fail.
283 .It "ti%d: board self-diagnostics failed!"
284 The ROMFAIL bit in the CPU state register was set after system
285 startup, indicating that the on-board NIC diagnostics failed.
286 .It "ti%d: unknown hwrev"
287 The driver detected a board with an unsupported hardware revision.
290 driver supports revision 4 (Tigon 1) and revision 6 (Tigon 2) chips
291 and has firmware only for those devices.
292 .It "ti%d: watchdog timeout"
293 The device has stopped responding to the network, or there is a problem with
294 the network connection (cable).
305 .%T Alteon Gigabit Ethernet/PCI NIC manuals
306 .%O http://sanjose.alteon.com/open.shtml
311 device driver first appeared in
317 driver was written by
318 .An Bill Paul Aq wpaul@bsdi.com .
319 The header splitting firmware modifications, character
321 interface and debugging support were written by
322 .An Kenneth Merry Aq ken@FreeBSD.org .
323 Initial zero copy support was written by
324 .An Andrew Gallatin Aq gallatin@FreeBSD.org .