share/man/man4/man4.i386/fe.4

   1 .\" All Rights Reserved, Copyright (C) Fujitsu Limited 1995
   2 .\"
   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.
   8 .\"
   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
  19 .\" SUCH DAMAGE.
  20 .\"
  21 .\" Contributed by M. Sekiguchi <seki@sysrap.cs.fujitsu.co.jp>.
  22 .\" for fe driver.
  23 .\"
  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 $
  26 .Dd March 3, 1996
  27 .Dt FE 4 i386
  28 .Os
  29 .Sh NAME
  30 .Nm fe
  31 .Nd Fujitsu MB86960A/MB86965A based Ethernet adapters
  32 .Sh SYNOPSIS
  33 .Cd "device fe0 at isa? port 0x300 irq ?"
  34 .Sh DESCRIPTION
  35 The
  36 .Nm
  37 is a network device driver
  38 for Ethernet adapters based on Fujitsu MB86960A, MB86965A,
  39 or other compatible chips.
  40 .Pp
  41 The driver provides automatic I/O port address configuration and
  42 automatic IRQ configuration,
  43 when used with suitable adapter hardware.
  44 .Pp
  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.
  48 .Pp
  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.
  52 .Ss Parameters
  53 On the kernel configuration file, two parameters,
  54 .Ar port
  55 and
  56 .Ar irq ,
  57 must be specified to reflect adapter hardware settings.
  58 Another parameter
  59 .Ar flags
  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.
  63 .Pp
  64 The
  65 .Ar port
  66 parameter specifies a base I/O port address of the adapter.
  67 It must match with the hardware setting of the adapter.
  68 The
  69 .Ar port
  70 may be a left unspecified as
  71 .Dq Li \&? .
  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.
  75 .Pp
  76 The
  77 .Ar irq
  78 parameter specifies an IRQ number used by the adapter.
  79 It must match the hardware setting of the adapter.
  80 .Ar Irq
  81 may be left unspecified as
  82 .Dq Li \&? ;
  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.
  86 .Pp
  87 The
  88 .Ar flags
  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.
  97 .Bl -tag -width 8n
  98 .It Li 0x007F
  99 These flag bits are used
 100 to initialize DLCR6 register of MB86960A/MB86965A chip,
 101 when the
 102 .Li 0x0080
 103 bit of the
 104 .Ar flags
 105 is set.
 106 See below for more about DLCR6 override feature.
 107 The
 108 .Li 0x007F
 109 flag bits must be 0 unless the
 110 .Li 0x0080
 111 bit is set,
 112 to maintain the compatibility with future versions of the driver.
 113 .It Li 0x0080
 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
 120 on DLCR6 settings.
 121 .El
 122 .Sh OPTIONS
 123 The
 124 .Nm
 125 driver has some private options,
 126 which can be specified with an
 127 .Dq option
 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
 132 .Dv "FE_" .
 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
 137 .Ar level
 138 which controls the debugging level for the device and/or the driver.
 139 Setting the
 140 .Dv "FE_DEBUG"
 141 option to a value which is not listed here
 142 may cause undocumented behavior.
 143 The default setting of this option is 1.
 144 .Bl -bullet
 145 .It
 146 Setting
 147 .Dv "FE_DEBUG=0"
 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.
 153 .It
 154 Setting
 155 .Dv "FE_DEBUG=1"
 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.
 159 .It
 160 Setting
 161 .Dv "FE_DEBUG=2"
 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.
 166 .It
 167 Setting
 168 .Dv "FE_DEBUG=3"
 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.
 174 .El
 175 .El
 176 .Sh FEATURES SPECIFIC TO HARDWARE MODELS
 177 The
 178 .Nm
 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.
 185 .Pp
 186 Automatic I/O port address detection feature of
 187 .Nm
 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
 192 .Em "port ?"
 193 when you experience some difficulties with hardware probe.
 194 .Pp
 195 Automatic IRQ detection feature of
 196 .Nm
 197 works reliably for FMV-180 series.
 198 It is recommended to use
 199 .Em "irq ?"
 200 always for FMV-180.
 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
 214 is not recommended.
 215 .Pp
 216 Automatic IRQ detection is also available with some limitation.
 217 The
 218 .Nm
 219 driver
 220 tries to get IRQ setting from the configuration EEPROM on the board,
 221 if
 222 .Dq irq ?\&
 223 is specified in the configuration file.
 224 Unfortunately,
 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
 230 may not be reliable.
 231 Specify an exact IRQ number if any troubles are encountered.
 232 .Pp
 233 Differences between AT1700 series and RE2000 series
 234 or minor models in those series are not recognized.
 235 .Ss Fujitsu MBH10302 PC card
 236 The
 237 .Nm
 238 driver supports Fujitsu MBH10302 and compatible PC cards.
 239 It requires the PC card (PCMCIA) support package.
 240 .Sh SEE ALSO
 241 .Xr netstat 1 ,
 242 .Xr ed 4 ,
 243 .Xr ifmedia 4 ,
 244 .Xr netintro 4 ,
 245 .Xr ng_ether 4 ,
 246 .Xr ifconfig 8
 247 .Sh HISTORY
 248 The
 249 .Nm
 250 driver appeared in
 251 .Fx 2.0.5 .
 252 .Sh AUTHORS, COPYRIGHT AND DISCLAIMER
 253 The
 254 .Nm
 255 driver was originally written and contributed by
 256 .An M. Sekiguchi Aq seki@sysrap.cs.fujitsu.co.jp ,
 257 following the
 258 .Nm ed
 259 driver written by
 260 .An David Greenman .
 261 PC card support in
 262 .Nm
 263 is written by
 264 .An Hidetoshi Kimura Aq h-kimura@tokyo.se.fujitsu.co.jp .
 265 This manual page was written by
 266 .An M. Sekiguchi .
 267 .Pp
 268 .Em "All Rights Reserved, Copyright (C) Fujitsu Limited 1995"
 269 .Pp
 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.
 276 .Pp
 277 THIS DOCUMENT AND THE ASSOCIATED SOFTWARE IS PROVIDED BY THE AUTHOR
 278 AND THE CONTRIBUTOR
 279 .Dq AS IS
 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.
 291 .Sh BUGS
 292 Following are major known bugs:
 293 .Pp
 294 Statistics on the number of collisions maintained by the
 295 .Nm
 296 driver is not accurate;
 297 the
 298 .Fl i
 299 option of
 300 .Xr netstat 1
 301 shows slightly less value than true number of collisions.
 302 .Pp
 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.
 308 .Pp
 309 Although XNS and IPX supports are included in the driver,
 310 they are never be tested and must have a lot of bugs.