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: head/share/man/man4/ti.4 79727 2001-07-14 19:41:16Z schweikh $
|
| 31.\" $FreeBSD: head/share/man/man4/ti.4 98849 2002-06-26 03:37:47Z ken $ |
32.\"
33.Dd March 4, 1999
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. See
118.Xr zero_copy 9
119for more discussion on zero copy receive and header splitting.
120.Pp
121The
122.Nm
123driver normally uses jumbo receive buffers allocated by the
124.Xr jumbo 9
125buffer allocator, but can be configured to use its own private pool of
126jumbo buffers that are contiguous instead of buffers from the jumbo
127allocator, which are made up of multiple page sized chunks. To turn on
128private jumbos, use the
129.Dv TI_PRIVATE_JUMBOS
130option.
131.Pp |
132Support for vlans is also available using the
133.Xr vlan 4
134mechanism.
135See the
136.Xr vlan 4
137man page for more details.
138.Pp
139The
140.Nm
141driver supports the following media types:
142.Pp
143.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
144.It autoselect
145Enable autoselection of the media type and options.
146The user can manually override
147the autoselected mode by adding media options to the
148.Pa /etc/rc.conf
149file.
150.It 10baseT/UTP
151Set 10Mbps operation.
152The
153.Ar mediaopt
154option can also be used to select either
155.Ar full-duplex
156or
157.Ar half-duplex
158modes.
159.It 100baseTX
160Set 100Mbps (fast ethernet) operation.
161The
162.Ar mediaopt
163option can also be used to select either
164.Ar full-duplex
165or
166.Ar half-duplex
167modes.
168.It 1000baseSX
169Set 1000Mbps (gigabit ethernet) operation.
170Only full
171.Ar full-duplex
172mode is supported at this speed.
173.El
174.Pp
175The
176.Nm
177driver supports the following media options:
178.Pp
179.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
180.It full-duplex
181Force full duplex operation
182.It half-duplex
183Force half duplex operation.
184.El
185.Pp
186For more information on configuring this device, see
187.Xr ifconfig 8 .
|
188.Sh IOCTLS
189In addition to the standard
190.Xr socket 2
191.Xr ioctl 2
192calls implemented by most network drivers, the
193.Nm
194driver also includes a character device interface that can be used for
195additional diagnostics, configuration and debugging. With this character
196device interface, and a specially patched version of gdb, the user can
197debug firmware running on the Tigon board.
198.Pp
199These ioctls and their arguments are defined in the
200.Aq Pa sys/tiio.h
201header file.
202.Bl -tag -width ALT_WRITE_TG_MEM
203.It Dv TIIOCGETSTATS
204Return card statistics DMAed from the card into kernel memory approximately
205every 2 seconds. (That time interval can be changed via the
206.Dv TIIOCSETPARAMS
207ioctl.) The argument is
208.Va struct ti_stats .
209.It Dv TIIOCGETPARAMS
210Get various performance-related firmware parameters that largely affect how
211interrupts are coalesced. The argument is
212.Va struct ti_params .
213.It Dv TIIOCSETPARAMS
214Set various performance-related firmware parameters that largely affect how
215interrupts are coalesced. The argument is
216.Va struct ti_params .
217.It Dv TIIOCSETTRACE
218Tell the NIC to trace the requested types of information.
219The argument is
220.Va ti_trace_type .
221.It Dv TIIOCGETTRACE
222Dump the trace buffer from the card. The argument is
223.Va struct ti_trace_buf .
224.It Dv ALT_ATTACH
225This ioctl is used for compatibility with Alteon's Solaris driver. They
226apparantly only have one character interface for debugging, so they have
227to tell it which Tigon instance they want to debug. This ioctl is a noop
228for FreeBSD.
229.It Dv ALT_READ_TG_MEM
230Read the requested memory region from the Tigon board. The argument is
231.Va struct tg_mem .
232.It Dv ALT_WRITE_TG_MEM
233Write to the requested memory region on the Tigon board. The argument is
234.Va struct tg_mem .
235.It Dv ALT_READ_TG_REG
236Read the requested register on the Tigon board. The argument is
237.Va struct tg_reg .
238.It Dv ALT_WRITE_TG_REG
239Write to the requested register on the Tigon board. The argument is
240.Va struct tg_reg .
241.El
242.Sh FILES
243.Bl -tag -width /dev/ti[0-255] -compact
244.It Pa /dev/ti[0-255]
245Tigon driver character interface. |
246.Sh DIAGNOSTICS
247.Bl -diag
248.It "ti%d: couldn't map memory"
249A fatal initialization error has occurred.
250.It "ti%d: couldn't map interrupt"
251A fatal initialization error has occurred.
252.It "ti%d: no memory for softc struct!"
253The driver failed to allocate memory for per-device instance information
254during initialization.
255.It "ti%d: failed to enable memory mapping!"
256The driver failed to initialize PCI shared memory mapping.
257This might
258happen if the card is not in a bus-master slot.
259.It "ti%d: no memory for jumbo buffers!"
260The driver failed to allocate memory for jumbo frames during
261initialization.
262.It "ti%d: bios thinks we're in a 64 bit slot, but we aren't"
263The BIOS has programmed the NIC as though it had been installed in
264a 64-bit PCI slot, but in fact the NIC is in a 32-bit slot.
265This happens
266as a result of a bug in some BIOSes.
267This can be worked around on the
268Tigon II, but on the Tigon I initialization will fail.
269.It "ti%d: board self-diagnostics failed!"
270The ROMFAIL bit in the CPU state register was set after system
271startup, indicating that the on-board NIC diagnostics failed.
272.It "ti%d: unknown hwrev"
273The driver detected a board with an unsupported hardware revision.
274The
275.Nm
276driver supports revision 4 (Tigon 1) and revision 6 (Tigon 2) chips
277and has firmware only for those devices.
278.It "ti%d: watchdog timeout"
279The device has stopped responding to the network, or there is a problem with
280the network connection (cable).
281.El
282.Sh SEE ALSO
283.Xr arp 4 ,
284.Xr netintro 4 ,
285.Xr ng_ether 4 ,
286.Xr vlan 4 ,
|
209.Xr ifconfig 8
|
287.Xr ifconfig 8 ,
288.Xr zero_copy 9 ,
289.Xr jumbo 9 |
290.Rs
291.%T Alteon Gigabit Ethernet/PCI NIC manuals
292.%O http://sanjose.alteon.com/open.shtml
293.Re
294.Sh HISTORY
295The
296.Nm
297device driver first appeared in
298.Fx 3.0 .
299.Sh AUTHORS
300The
301.Nm
302driver was written by
303.An Bill Paul Aq wpaul@bsdi.com .
|
304The header splitting firmware modifications, character ioctl interface and
305debugging support were written by
306.An Kenneth Merry Aq ken@FreeBSD.org .
307Initial zero copy support was written by
308.An Andrew Gallatin Aq gallatin@FreeBSD.org . |
|