1 .\" All Rights Reserved, Copyright (C) Fujitsu Limited 1995
3 .\" This document may be used, modified, copied, distributed, and sold, in
4 .\" both source and printed form provided that the above copyright, these
5 .\" terms and the following disclaimer are retained. The name of the author
6 .\" and/or the contributor may not be used to endorse or promote products
7 .\" derived from this software without specific prior written permission.
9 .\" THIS DOCUMENT IS PROVIDED BY THE AUTHOR AND THE CONTRIBUTOR ``AS IS'' AND
10 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
11 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
12 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR THE CONTRIBUTOR BE LIABLE
13 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
14 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
15 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
16 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
17 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
18 .\" OUT OF THE USE OF THIS DOCUMENT, EVEN IF ADVISED OF THE POSSIBILITY OF
21 .\" Contributed by M. Sekiguchi <seki@sysrap.cs.fujitsu.co.jp>.
24 .\" $FreeBSD: src/share/man/man4/man4.i386/fe.4,v 1.14.2.8 2001/10/10 11:43:53 murray Exp $
25 .\" $DragonFly: src/share/man/man4/man4.i386/fe.4,v 1.5 2007/02/25 12:03:07 swildner Exp $
31 .Nd Fujitsu MB86960A/MB86965A based Ethernet adapters
33 .Cd "device fe0 at isa? port 0x300 irq ?"
37 is a network device driver
38 for Ethernet adapters based on Fujitsu MB86960A, MB86965A,
39 or other compatible chips.
41 The driver provides automatic I/O port address configuration and
42 automatic IRQ configuration,
43 when used with suitable adapter hardware.
45 The driver works with program I/O data transfer technique.
46 It gives a fair performance.
47 Shared memory is never used, even if the adapter has one.
49 It currently works with Fujitsu FMV-180 series for ISA,
50 Allied-Telesis AT1700 series and RE2000 series for ISA,
51 and Fujitsu MBH10302 PC card.
53 On the kernel configuration file, two parameters,
57 must be specified to reflect adapter hardware settings.
60 can be specified to provide additional configuration as an option.
61 Other parameters of the device statement
62 must appear as described on the synopsis.
66 parameter specifies a base I/O port address of the adapter.
67 It must match with the hardware setting of the adapter.
70 may be a left unspecified as
72 In that case, the driver tries to detect the hardware setting
73 of the I/O address automatically.
74 This feature may not work with some adapter hardware.
78 parameter specifies an IRQ number used by the adapter.
79 It must match the hardware setting of the adapter.
81 may be left unspecified as
83 in that case, the driver tries to detect
84 the hardware setting of the IRQ automatically.
85 This feature may not work on some adapters.
89 is a numeric value which consists of a combination of various device settings.
90 The following flags are defined in the current version.
91 To specify two or more settings for a device,
92 use a numeric sum of each flag value.
93 Flag bits not specified below are reserved and must be set to 0.
94 Actually, each bit is either just ignored by the driver,
95 or tested and used to control undocumented features of the driver.
96 Consult the source program for undocumented features.
99 These flag bits are used
100 to initialize DLCR6 register of MB86960A/MB86965A chip,
106 See below for more about DLCR6 override feature.
109 flag bits must be 0 unless the
112 to maintain the compatibility with future versions of the driver.
114 This flag overrides the default setting to the DLCR6 register
115 of MB86960A/MB86965A chip by a user supplied value,
116 which is taken from the lower 7 bits of the flag value.
117 This is a troubleshooting flag and should not be used
118 without understanding of the adapter hardware.
119 Consult the Fujitsu manual for more information
125 driver has some private options,
126 which can be specified with an
128 statement in the kernel configuration file.
129 The following lists the private options.
130 The driver also accepts some other undocumented options,
131 all of whose names start with a fixed prefix
133 Consult the source program for undocumented options.
134 .Bl -tag -width "FE_"
135 .It Dv "FE_DEBUG=" Ns Ar level
136 This option takes a numeric value
138 which controls the debugging level for the device and/or the driver.
141 option to a value which is not listed here
142 may cause undocumented behavior.
143 The default setting of this option is 1.
148 makes most of debugging codes,
149 including sanity check,
150 be excluded from the object code of the driver.
151 It generates fastest and smallest object code.
152 Some emergency messages are logged even under this setting, though.
156 makes minimum debugging codes be included,
157 setting the amount of logged messages minimum.
158 Only fatal error messages are logged under this setting.
162 makes standard debugging codes be included,
163 setting the amount of logged messages middle.
164 Messages on lair events and/or questionable conditions
165 are logged under this setting.
169 makes all debugging codes be included,
170 and set the amount of legged messages maximum.
171 Redundant messages such as those reporting usual actions
172 or dumping register values
173 are logged under this setting.
176 .Sh FEATURES SPECIFIC TO HARDWARE MODELS
179 driver has some features and limitations
180 which depend on adapter hardware models.
181 The following is a summary of such dependency.
182 .Ss Fujitsu FMV-180 series adapters
183 Both automatic IRQ detection and automatic I/O port address detection
184 is available with these adapters.
186 Automatic I/O port address detection feature of
188 works mostly fine for FMV-180 series.
189 It works even if there are two or more FMV-180s in a system.
190 However, some combination of other adapters may confuse the driver.
191 It is recommended not to use
193 when you experience some difficulties with hardware probe.
195 Automatic IRQ detection feature of
197 works reliably for FMV-180 series.
198 It is recommended to use
201 The hardware setting of IRQ is read
202 from the configuration EEPROM on the adapter,
203 even when the kernel config file specifies an IRQ value.
204 The driver will generate a warning message,
205 if the IRQ setting specified in the kernel config file
206 does not match one stored in EEPROM.
207 Then, it will use the value specified in the config file.
208 (This behavior has been changed from the previous releases.)
209 .Ss Allied-Telesis AT1700 series and RE2000 series adapters
210 Automatic I/O port address detection
211 is available with Allied-Telesis AT1700 series and RE2000 series,
212 while it is less reliable than FMV-180 series.
213 Using the feature with Allied-Telesis adapters
216 Automatic IRQ detection is also available with some limitation.
220 tries to get IRQ setting from the configuration EEPROM on the board,
223 is specified in the configuration file.
225 AT1700 series and RE2000 series seems to have two types of models;
226 One type allows IRQ selection from 3/4/5/9,
227 while the other from 10/11/12/15.
228 Identification of the models are not well known.
229 Hence, automatic IRQ detection with Allied-Telesis adapters
231 Specify an exact IRQ number if any troubles are encountered.
233 Differences between AT1700 series and RE2000 series
234 or minor models in those series are not recognized.
235 .Ss Fujitsu MBH10302 PC card
238 driver supports Fujitsu MBH10302 and compatible PC cards.
239 It requires the PC card (PCMCIA) support package.
252 .Sh AUTHORS, COPYRIGHT AND DISCLAIMER
255 driver was originally written and contributed by
256 .An M. Sekiguchi Aq seki@sysrap.cs.fujitsu.co.jp ,
264 .An Hidetoshi Kimura Aq h-kimura@tokyo.se.fujitsu.co.jp .
265 This manual page was written by
268 .Em "All Rights Reserved, Copyright (C) Fujitsu Limited 1995"
270 This document and the associated software may be used, modified,
271 copied, distributed, and sold, in both source and binary form provided
272 that the above copyright, these terms and the following disclaimer are
273 retained. The name of the author and/or the contributor may not be
274 used to endorse or promote products derived from this document and the
275 associated software without specific prior written permission.
277 THIS DOCUMENT AND THE ASSOCIATED SOFTWARE IS PROVIDED BY THE AUTHOR
280 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
281 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
282 PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR THE
283 CONTRIBUTOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
284 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
285 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
286 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
287 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
288 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
289 DOCUMENT AND THE ASSOCIATED SOFTWARE, EVEN IF ADVISED OF THE
290 POSSIBILITY OF SUCH DAMAGE.
292 Following are major known bugs:
294 Statistics on the number of collisions maintained by the
296 driver is not accurate;
301 shows slightly less value than true number of collisions.
303 More mbuf clusters are used than expected.
304 The packet receive routine has an intended violation
305 against the mbuf cluster allocation policy.
306 The unnecessarily allocated clusters are freed within short lifetime,
307 and it will not affect long term kernel memory usage.
309 Although XNS and IPX supports are included in the driver,
310 they are never be tested and must have a lot of bugs.