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 September 3, 2004 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.Cd "options TI_PRIVATE_JUMBOS" 42.Cd "options TI_JUMBO_HDRSPLIT" 43.Sh DESCRIPTION 44The 45.Nm 46driver provides support for PCI Gigabit Ethernet adapters based on 47the Alteon Networks Tigon Gigabit Ethernet controller chip. 48The Tigon 49contains an embedded R4000 CPU, gigabit MAC, dual DMA channels and 50a PCI interface unit. 51The Tigon II contains two R4000 CPUs and other 52refinements. 53Either chip can be used in either a 32-bit or 64-bit PCI 54slot. 55Communication with the chip is achieved via PCI shared memory 56and bus master DMA. 57The Tigon I and II support hardware multicast 58address filtering, VLAN tag extraction and insertion, and jumbo 59Ethernet frames sizes up to 9000 bytes. 60Note that the Tigon I chipset 61is no longer in active production: all new adapters should come equipped 62with Tigon II chipsets. 63.Pp 64While the Tigon chipset supports 10, 100 and 1000Mbps speeds, support for 6510 and 100Mbps speeds is only available on boards with the proper 66transceivers. 67Most adapters are only designed to work at 1000Mbps, 68however the driver should support those NICs that work at lower speeds 69as well. 70.Pp 71Support for jumbo frames is provided via the interface MTU setting. 72Selecting an MTU larger than 1500 bytes with the 73.Xr ifconfig 8 74utility configures the adapter to receive and transmit jumbo frames. 75Using jumbo frames can greatly improve performance for certain tasks, 76such as file transfers and data streaming. 77.Pp 78Header splitting support for Tigon 2 boards (this option has no effect for 79the Tigon 1) can be turned on with the 80.Dv TI_JUMBO_HDRSPLIT 81option. 82See 83.Xr zero_copy 9 84for more discussion on zero copy receive and header splitting. 85.Pp 86The 87.Nm 88driver normally uses jumbo receive buffers allocated by the 89.Xr jumbo 9 90buffer allocator, but can be configured to use its own private pool of 91jumbo buffers that are contiguous instead of buffers from the jumbo 92allocator, which are made up of multiple page sized chunks. 93To turn on private jumbos, use the 94.Dv TI_PRIVATE_JUMBOS 95option. 96.Pp 97Support for vlans is also available using the 98.Xr vlan 4 99mechanism. 100See the 101.Xr vlan 4 102man page for more details. 103.Pp 104The 105.Nm 106driver supports the following media types: 107.Pp 108.Bl -tag -width xxxxxxxxxxxxxxxxxxxx 109.It autoselect 110Enable autoselection of the media type and options. 111The user can manually override 112the autoselected mode by adding media options to the 113.Pa /etc/rc.conf 114file. 115.It 10baseT/UTP 116Set 10Mbps operation. 117The 118.Ar mediaopt 119option can also be used to select either 120.Ar full-duplex 121or 122.Ar half-duplex 123modes. 124.It 100baseTX 125Set 100Mbps (Fast Ethernet) operation. 126The 127.Ar mediaopt 128option can also be used to select either 129.Ar full-duplex 130or 131.Ar half-duplex 132modes. 133.It 1000baseSX 134Set 1000Mbps (Gigabit Ethernet) operation. 135Only full 136.Ar full-duplex 137mode is supported at this speed. 138.El 139.Pp 140The 141.Nm 142driver supports the following media options: 143.Pp 144.Bl -tag -width xxxxxxxxxxxxxxxxxxxx 145.It full-duplex 146Force full duplex operation 147.It half-duplex 148Force half duplex operation. 149.El 150.Pp 151For more information on configuring this device, see 152.Xr ifconfig 8 . 153.Sh HARDWARE 154The 155.Nm 156driver supports Gigabit Ethernet adapters based on the 157Alteon Tigon I and II chips. 158The 159.Nm 160driver has been tested with the following adapters: 161.Pp 162.Bl -bullet -compact 163.It 1643Com 3c985-SX Gigabit Ethernet adapter (Tigon 1) 165.It 1663Com 3c985B-SX Gigabit Ethernet adapter (Tigon 2) 167.It 168Alteon AceNIC V Gigabit Ethernet adapter (1000baseSX) 169.It 170Alteon AceNIC V Gigabit Ethernet adapter (1000baseT) 171.It 172Digital EtherWORKS 1000SX PCI Gigabit adapter 173.It 174Netgear GA620 Gigabit Ethernet adapter (1000baseSX) 175.It 176Netgear GA620T Gigabit Ethernet adapter (1000baseT) 177.El 178.Pp 179The following adapters should also be supported but have 180not yet been tested: 181.Pp 182.Bl -bullet -compact 183.It 184Asante GigaNIX1000T Gigabit Ethernet adapter 185.It 186Asante PCI 1000BASE-SX Gigabit Ethernet adapter 187.It 188Farallon PN9000SX Gigabit Ethernet adapter 189.It 190NEC Gigabit Ethernet 191.It 192Silicon Graphics PCI Gigabit Ethernet adapter 193.El 194.Sh IOCTLS 195In addition to the standard 196.Xr socket 2 197.Xr ioctl 2 198calls implemented by most network drivers, the 199.Nm 200driver also includes a character device interface that can be used for 201additional diagnostics, configuration and debugging. 202With this character 203device interface, and a specially patched version of 204.Xr gdb 1 , 205the user can 206debug firmware running on the Tigon board. 207.Pp 208These ioctls and their arguments are defined in the 209.In sys/tiio.h 210header file. 211.Bl -tag -width ".Dv ALT_WRITE_TG_MEM" 212.It Dv TIIOCGETSTATS 213Return card statistics DMAed from the card into kernel memory approximately 214every 2 seconds. 215(That time interval can be changed via the 216.Dv TIIOCSETPARAMS 217ioctl.) 218The argument is 219.Vt "struct ti_stats" . 220.It Dv TIIOCGETPARAMS 221Get various performance-related firmware parameters that largely affect how 222interrupts are coalesced. 223The argument is 224.Vt "struct ti_params" . 225.It Dv TIIOCSETPARAMS 226Set various performance-related firmware parameters that largely affect how 227interrupts are coalesced. 228The argument is 229.Vt "struct ti_params" . 230.It Dv TIIOCSETTRACE 231Tell the NIC to trace the requested types of information. 232The argument is 233.Vt ti_trace_type . 234.It Dv TIIOCGETTRACE 235Dump the trace buffer from the card. 236The argument is 237.Vt "struct ti_trace_buf" . 238.It Dv ALT_ATTACH 239This ioctl is used for compatibility with Alteon's Solaris driver. 240They apparently only have one character interface for debugging, so they have 241to tell it which Tigon instance they want to debug. 242This ioctl is a noop for 243.Fx . 244.It Dv ALT_READ_TG_MEM 245Read the requested memory region from the Tigon board. 246The argument is 247.Vt "struct tg_mem" . 248.It Dv ALT_WRITE_TG_MEM 249Write to the requested memory region on the Tigon board. 250The argument is 251.Vt "struct tg_mem" . 252.It Dv ALT_READ_TG_REG 253Read the requested register on the Tigon board. 254The argument is 255.Vt "struct tg_reg" . 256.It Dv ALT_WRITE_TG_REG 257Write to the requested register on the Tigon board. 258The argument is 259.Vt "struct tg_reg" . 260.El 261.Sh FILES 262.Bl -tag -width ".Pa /dev/ti[0-255]" -compact 263.It Pa /dev/ti[0-255] 264Tigon driver character interface. 265.El 266.Sh DIAGNOSTICS 267.Bl -diag 268.It "ti%d: couldn't map memory" 269A fatal initialization error has occurred. 270.It "ti%d: couldn't map interrupt" 271A fatal initialization error has occurred. 272.It "ti%d: no memory for softc struct!" 273The driver failed to allocate memory for per-device instance information 274during initialization. 275.It "ti%d: failed to enable memory mapping!" 276The driver failed to initialize PCI shared memory mapping. 277This might 278happen if the card is not in a bus-master slot. 279.It "ti%d: no memory for jumbo buffers!" 280The driver failed to allocate memory for jumbo frames during 281initialization. 282.It "ti%d: bios thinks we're in a 64 bit slot, but we aren't" 283The BIOS has programmed the NIC as though it had been installed in 284a 64-bit PCI slot, but in fact the NIC is in a 32-bit slot. 285This happens 286as a result of a bug in some BIOSes. 287This can be worked around on the 288Tigon II, but on the Tigon I initialization will fail. 289.It "ti%d: board self-diagnostics failed!" 290The ROMFAIL bit in the CPU state register was set after system 291startup, indicating that the on-board NIC diagnostics failed. 292.It "ti%d: unknown hwrev" 293The driver detected a board with an unsupported hardware revision. 294The 295.Nm 296driver supports revision 4 (Tigon 1) and revision 6 (Tigon 2) chips 297and has firmware only for those devices. 298.It "ti%d: watchdog timeout" 299The device has stopped responding to the network, or there is a problem with 300the network connection (cable). 301.El 302.Sh SEE ALSO 303.Xr arp 4 , 304.Xr netintro 4 , 305.Xr ng_ether 4 , 306.Xr vlan 4 , 307.Xr ifconfig 8 , 308.Xr jumbo 9 , 309.Xr zero_copy 9 310.Sh HISTORY 311The 312.Nm 313device driver first appeared in 314.Fx 3.0 . 315.Sh AUTHORS 316.An -nosplit 317The 318.Nm 319driver was written by 320.An Bill Paul Aq wpaul@bsdi.com . 321The header splitting firmware modifications, character 322.Xr ioctl 2 323interface and debugging support were written by 324.An Kenneth Merry Aq ken@FreeBSD.org . 325Initial zero copy support was written by 326.An Andrew Gallatin Aq gallatin@FreeBSD.org . 327