summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/fxp.4 3.html
blob: aef306f3a54f5c595dcc3dae322e3aac19eaad12 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
<table class="head">
  <tr>
    <td class="head-ltitle">FXP(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">FXP(4)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">fxp</code> &#x2014; <span class="Nd">Intel
    EtherExpress PRO/100 Ethernet device driver</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp">To compile this driver into the kernel, place the following lines
    in your kernel configuration file:</p>
<div class="Bd Pp Bd-indent"><code class="Cd">device miibus</code>
<br/>
<code class="Cd">device fxp</code></div>
<p class="Pp">Alternatively, to load the driver as a module at boot time, place
    the following line in <a class="Xr">loader.conf(5)</a>:</p>
<div class="Bd Pp Bd-indent Li">
<pre>if_fxp_load=&quot;YES&quot;</pre>
</div>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">fxp</code> driver provides support for
    Ethernet adapters based on the Intel i82557, i82558, i82559, i82550, and
    i82562 chips. The driver supports TCP/UDP/IP checksum offload for both
    transmit and receive on i82550 and i82551. On i82559 only TCP/UDP checksum
    offload for receive is supported. TCP segmentation offload (TSO) for IPv4 as
    well as VLAN hardware tag insertion/stripping is supported on i82550 and
    i82551. Wake On Lan (WOL) support is provided on all controllers except
    i82557, i82259ER and early i82558 revisions.</p>
<p class="Pp">The <code class="Nm">fxp</code> driver supports the following
    media types:</p>
<dl class="Bl-tag">
  <dt id="autoselect"><a class="permalink" href="#autoselect"><code class="Cm">autoselect</code></a></dt>
  <dd>Enable autoselection of the media type and options. The autoselected mode
      can be overridden by adding the media options to
      <a class="Xr">rc.conf(5)</a>.</dd>
  <dt id="10baseT/UTP"><a class="permalink" href="#10baseT/UTP"><code class="Cm">10baseT/UTP</code></a></dt>
  <dd>Set 10Mbps operation.</dd>
  <dt id="100baseTX"><a class="permalink" href="#100baseTX"><code class="Cm">100baseTX</code></a></dt>
  <dd>Set 100Mbps (Fast Ethernet) operation.</dd>
</dl>
<p class="Pp">The <code class="Nm">fxp</code> driver supports the following
    media options:</p>
<dl class="Bl-tag">
  <dt id="full-duplex"><a class="permalink" href="#full-duplex"><code class="Cm">full-duplex</code></a></dt>
  <dd>Force full duplex operation.</dd>
  <dt id="half-duplex"><a class="permalink" href="#half-duplex"><code class="Cm">half-duplex</code></a></dt>
  <dd>Force half duplex operation.</dd>
</dl>
<p class="Pp">Note that 100baseTX media type is not available on the Pro/10. For
    further information on configuring this device, see
    <a class="Xr">ifconfig(8)</a>.</p>
<p class="Pp">The <code class="Nm">fxp</code> driver supports reception and
    transmission of extended frames for <a class="Xr">vlan(4)</a>. This
    capability of <code class="Nm">fxp</code> can be controlled by means of the
    <code class="Cm">vlanmtu</code> parameter to
  <a class="Xr">ifconfig(8)</a>.</p>
<p class="Pp">The <code class="Nm">fxp</code> driver also supports a special
    link option:</p>
<dl class="Bl-tag">
  <dt id="link0"><a class="permalink" href="#link0"><code class="Cm">link0</code></a></dt>
  <dd>Some chip revisions have loadable microcode which can be used to reduce
      the interrupt load on the host cpu. Not all boards have microcode support.
      Setting the <code class="Cm">link0</code> flag with
      <a class="Xr">ifconfig(8)</a> will download the microcode to the chip if
      it is available.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1>
<p class="Pp">Adapters supported by the <code class="Nm">fxp</code> driver
    include:</p>
<p class="Pp"></p>
<ul class="Bl-bullet Bl-compact">
  <li>Intel EtherExpress PRO/10</li>
  <li>Intel InBusiness 10/100</li>
  <li>Intel PRO/100B / EtherExpressPRO/100 B PCI Adapter</li>
  <li>Intel PRO/100+ Management Adapter</li>
  <li>Intel PRO/100 VE Desktop Adapter</li>
  <li>Intel PRO/100 VM Network Connection</li>
  <li>Intel PRO/100 M Desktop Adapter</li>
  <li>Intel PRO/100 S Desktop, Server and Dual-Port Server Adapters</li>
  <li>Many on-board network interfaces on Intel motherboards</li>
</ul>
</section>
<section class="Sh">
<h1 class="Sh" id="LOADER_TUNABLES"><a class="permalink" href="#LOADER_TUNABLES">LOADER
  TUNABLES</a></h1>
<p class="Pp">Tunables can be set at the <a class="Xr">loader(8)</a> prompt
    before booting the kernel or stored in <a class="Xr">loader.conf(5)</a>. The
    following variables are available as both <a class="Xr">loader(8)</a>
    tunables and <a class="Xr">sysctl(8)</a> variables:</p>
<dl class="Bl-tag">
  <dt id="dev.fxp._d.int_delay"><var class="Va">dev.fxp.%d.int_delay</var></dt>
  <dd>Maximum amount of time, in microseconds, that an interrupt may be delayed
      in an attempt to coalesce interrupts. This is only effective if the Intel
      microcode is loaded. The accepted range is 300 to 3000, the default is
      1000.</dd>
  <dt id="dev.fxp._d.bundle_max"><var class="Va">dev.fxp.%d.bundle_max</var></dt>
  <dd>Number of packets that will be bundled, before an interrupt is generated.
      This is only effective if the Intel microcode is loaded. The accepted
      range is 1 to 65535, the default is 6.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="SYSCTL_VARIABLES"><a class="permalink" href="#SYSCTL_VARIABLES">SYSCTL
  VARIABLES</a></h1>
<p class="Pp">The following variables are available as
    <a class="Xr">sysctl(8)</a> variables.</p>
<dl class="Bl-tag">
  <dt id="dev.fxp._d.rnr"><var class="Va">dev.fxp.%d.rnr</var></dt>
  <dd>This is a read-only variable and shows the number of events of RNR
      (resource not ready).</dd>
  <dt id="dev.fxp._d.stats"><var class="Va">dev.fxp.%d.stats</var></dt>
  <dd>This is a read-only variable and displays useful MAC counters maintained
      in the driver.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOSTICS</a></h1>
<dl class="Bl-diag">
  <dt>fxp%d: couldn't map memory</dt>
  <dd>A fatal initialization error has occurred.</dd>
  <dt>fxp%d: couldn't map interrupt</dt>
  <dd>A fatal initialization error has occurred.</dd>
  <dt>fxp%d: Failed to malloc memory</dt>
  <dd>There are not enough mbuf's available for allocation.</dd>
  <dt>fxp%d: device timeout</dt>
  <dd>The device has stopped responding to the network, or there is a problem
      with the network connection (cable).</dd>
  <dt>fxp%d: Microcode loaded, int_delay: %d usec bundle_max: %d</dt>
  <dd>The chip has successfully downloaded the microcode, and changed the
      parameterized values to the given settings.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">altq(4)</a>, <a class="Xr">arp(4)</a>,
    <a class="Xr">miibus(4)</a>, <a class="Xr">netintro(4)</a>,
    <a class="Xr">ng_ether(4)</a>, <a class="Xr">polling(4)</a>,
    <a class="Xr">vlan(4)</a>, <a class="Xr">ifconfig(8)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<p class="Pp">The <code class="Nm">fxp</code> device driver first appeared in
    <span class="Ux">FreeBSD 2.1</span>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp">The <code class="Nm">fxp</code> device driver was written by
    <span class="An">David Greenman</span>. It has then been updated to use the
    busdma API and made endian-clean by <span class="An">Maxime Henrion</span>.
    This manual page was written by <span class="An">David E.
  O'Brien</span>.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">November 26, 2010</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>