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