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