xref: /netbsd-src/share/man/man4/fxp.4 (revision e5548b402ae4c44fb816de42c7bba9581ce23ef5)
1.\"	$NetBSD: fxp.4,v 1.15 2005/10/16 19:23:35 wiz Exp $
2.\"
3.\" Copyright (c) 1998, 2002 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
8.\" NASA Ames Research Center.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. All advertising materials mentioning features or use of this software
19.\"    must display the following acknowledgement:
20.\"        This product includes software developed by the NetBSD
21.\"        Foundation, Inc. and its contributors.
22.\" 4. Neither the name of The NetBSD Foundation nor the names of its
23.\"    contributors may be used to endorse or promote products derived
24.\"    from this software without specific prior written permission.
25.\"
26.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36.\" POSSIBILITY OF SUCH DAMAGE.
37.\"
38.Dd October 15, 2005
39.Dt FXP 4
40.Os
41.Sh NAME
42.Nm fxp
43.Nd Intel i8255x 10/100 Ethernet device driver
44.Sh SYNOPSIS
45.Cd "fxp* at cardbus? function ?"
46.Cd "fxp* at pci? dev ? function ?"
47.Sh DESCRIPTION
48The
49.Nm
50device driver supports Ethernet interfaces based on the Intel i82557,
51i82558, i82559, and i82550 10/100 PCI Ethernet chips.
52.Pp
53Certain versions of the i8255x support loading microcode which implements
54a receive interrupt mitigation function, known as
55.Dq CPUSaver .
56Use of this option can improve performance in some situations by reducing
57interrupt load on the host.
58This option is available on the following chip versions:
59.Pp
60.Bl -bullet -compact
61.It
62i82558 step A4 (rev 4)
63.It
64i82558 step B0 (rev 5)
65.It
66i82559 step A0 (rev 8)
67.It
68i82559S step A (rev 9)
69.It
70i82550 (rev 12)
71.It
72i82550 step C (rev 13)
73.El
74.Pp
75This option is enabled by setting the
76.Dq link0
77option with
78.Xr ifconfig 8 .
79.Pp
80Some chipset revisions can suffer from a receiver-side lockup bug which
81can be mitigated by resetting the chip every sixteen seconds without
82traffic.
83Since the probe for affected chipsets generates false positives
84and the workaround can cause momentary loss of responsiveness, particularly
85noticeable when playing audio, the workaround is not enabled by default.
86The boot messages will indicate if any interface may have this issue.
87The workaround is enabled by setting the
88.Dq link1
89option with
90.Xr ifconfig 8 .
91.Sh HARDWARE
92Cards supported by the
93.Nm
94driver include:
95.Pp
96.Bl -bullet -compact
97.It
98Intel EtherExpress Pro 10+
99.It
100Intel EtherExpress Pro 100B
101.It
102Intel EtherExpress Pro 100+
103.It
104Intel InBusiness 10/100
105.It
106Intel PRO/100 S
107.El
108.Sh MEDIA SELECTION
109Media selection is supported via MII.
110See
111.Xr ifmedia 4
112and
113.Xr mii 4
114for more information.
115.Pp
116EtherExpress Pro 10+ boards may use a Seeq 80c24 AutoDUPLEX(tm)
117media interface.
118Boards with these chips do not support media
119selection, as the 80c24 has no programming interface, and no
120way to read link status.
121These boards claim a media of "manual"
122since they self-configure based on the configuration of the link
123partner (hub or switch).
124.Sh DIAGNOSTICS
125.Bl -diag
126.It "fxp0: WARNING: SCB timed out!"
127The driver timed out waiting for the chip's command interface to
128become ready.
129.It "fxp0: too many segments, aborting"
130The driver encountered a packet that included too many DMA segments,
131and was not able to allocate a new buffer to transmit the packet from.
132The packet has been dropped.
133.It "fxp0: too many segments, retrying"
134The driver encountered a packet that included too many DMA segments,
135and allocated a new buffer to transmit the packet from.
136.It "fxp0: can't load mbuf chain, error = %d"
137The driver was unable to load a transmit DMA map, and has reported the
138errno value.
139.It "fxp0: device timeout"
140The device failed to generate a transmit complete interrupt for the
141last packet transmitted.
142The device has been reset.
143.It "fxp0: can't load rx buffer, error = %d"
144The driver was unable to load the DMA map for a receive buffer, and
145has reported the errno value.
146This error is currently fatal, and will
147panic the system.
148.It "fxp0: fxp_mdi_read: timed out"
149The MDIO failed to become ready during an MII read operation.
150.It "fxp0: fxp_mdi_write: timed out"
151The MDIO failed to become ready during an MII write operation.
152.It "fxp0: May need receiver lock-up workaround"
153The interface may need to be periodically reset to workaround a receiver
154lock-up bug.
155.El
156.Sh SEE ALSO
157.Xr cardbus 4 ,
158.Xr ifmedia 4 ,
159.Xr intro 4 ,
160.Xr mii 4 ,
161.Xr pci 4 ,
162.Xr ifconfig 8
163