- Add polling(4) support for jme(4)
[dragonfly.git] / share / man / man4 / fxp.4
1 .\"
2 .\" Copyright (c) 1997 David E. O'Brien
3 .\"
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 .\"
26 .\" $FreeBSD: src/share/man/man4/fxp.4,v 1.11.2.8 2003/02/17 21:20:39 trhodes Exp $
27 .\" $DragonFly: src/share/man/man4/fxp.4,v 1.6 2008/07/11 10:38:50 thomas Exp $
28 .\"
29 .Dd January 19, 1997
30 .Dt FXP 4
31 .Os
32 .Sh NAME
33 .Nm fxp
34 .Nd Intel EtherExpress Pro/100B ethernet device driver
35 .Sh SYNOPSIS
36 .Cd "device miibus"
37 .Cd "device fxp"
38 .Sh DESCRIPTION
39 The
40 .Nm
41 driver provides support for the EtherExpress Pro/10, InBusiness
42 10/100, Pro/100 B, Pro/100+, Pro/100 VE, Pro/100 M, and Pro/100 S
43 PCI Fast Ethernet adapters based on the Intel i82557, i82558, i82559,
44 i82550, or i82562 Ethernet chips.
45 Many on-board network interfaces on Intel motherboards use these chips
46 and are also supported.
47 .Pp
48 The
49 .Nm
50 driver supports the following media types:
51 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
52 .It autoselect
53 Enable autoselection of the media type and options
54 .It 10baseT/UTP
55 Set 10Mbps operation
56 .It 100baseTX
57 Set 100Mbps (fast ethernet) operation
58 .El
59 .Pp
60 The
61 .Nm
62 driver supports the following media options:
63 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
64 .It full-duplex
65 Set full duplex operation
66 .El
67 .Pp
68 Note that 100baseTX media type is not available on the Pro/10.
69 For further information on configuring this device, see
70 .Xr ifconfig 8 .
71 .Pp
72 The
73 .Nm
74 driver also supports a special link option:
75 .Bl -tag -width link0
76 .It Cm link0
77 Some chip revisions have loadable microcode which can be used to reduce the
78 interrupt load on the host cpu.
79 Not all boards have support microcode support.
80 Setting the
81 .Cm link0
82 flag with
83 .Xr ifconfig 8
84 will download the microcode to the chip if it is available.
85 .El
86 .Pp
87 For more information on configuring this device, see
88 .Xr ifconfig 8 .
89 The
90 .Nm
91 driver supports
92 .Xr polling 4 .
93 .Sh DIAGNOSTICS
94 .Bl -diag
95 .It "fxp%d: couldn't map memory"
96 A fatal initialization error has occurred.
97 .It "fxp%d: couldn't map interrupt"
98 A fatal initialization error has occurred.
99 .It "fxp%d: Failed to malloc memory"
100 There are not enough mbuf's available for allocation.
101 .It "fxp%d: device timeout"
102 The device has stopped responding to the network, or there is a problem with
103 the network connection (cable).
104 .It "fxp%d: Microcode loaded, int_delay: %d usec  bundle_max: %d"
105 The chip has successfully downloaded the microcode, and changed the
106 parameterized values to the given settings.
107 .El
108 .Sh SEE ALSO
109 .Xr arp 4 ,
110 .Xr ifmedia 4 ,
111 .Xr miibus 4 ,
112 .Xr netintro 4 ,
113 .Xr ng_ether 4 ,
114 .Xr polling 4 ,
115 .Xr ifconfig 8
116 .Sh HISTORY
117 The
118 .Nm
119 device driver first appeared in
120 .Fx 2.1 .
121 .Sh AUTHORS
122 .An -nosplit
123 The
124 .Nm
125 device driver was written by
126 .An David Greenman .
127 This manual page was written by
128 .An David E. O'Brien .