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 .Dd March 3, 1996
  26 .Dt FE 4 i386
  27 .Os
  28 .Sh NAME
  29 .Nm fe
  30 .Nd Fujitsu MB86960A/MB86965A based Ethernet adapters
  31 .Sh SYNOPSIS
  32 .Cd "device fe0 at isa? port 0x300 irq ?"
  33 .Sh DESCRIPTION
  34 The
  35 .Nm
  36 is a network device driver
  37 for Ethernet adapters based on Fujitsu MB86960A, MB86965A,
  38 or other compatible chips.
  39 .Pp
  40 The driver provides automatic I/O port address configuration and
  41 automatic IRQ configuration,
  42 when used with suitable adapter hardware.
  43 .Pp
  44 The driver works with program I/O data transfer technique.
  45 It gives a fair performance.
  46 Shared memory is never used, even if the adapter has one.
  47 .Pp
  48 It currently works with Fujitsu FMV-180 series for ISA,
  49 Allied-Telesis AT1700 series and RE2000 series for ISA,
  50 and Fujitsu MBH10302 PC card.
  51 .Ss Parameters
  52 On the kernel configuration file, two parameters,
  53 .Ar port
  54 and
  55 .Ar irq ,
  56 must be specified to reflect adapter hardware settings.
  57 Another parameter
  58 .Ar flags
  59 can be specified to provide additional configuration as an option.
  60 Other parameters of the device statement
  61 must appear as described on the synopsis.
  62 .Pp
  63 The
  64 .Ar port
  65 parameter specifies a base I/O port address of the adapter.
  66 It must match with the hardware setting of the adapter.
  67 The
  68 .Ar port
  69 may be a left unspecified as
  70 .Dq Li \&? .
  71 In that case, the driver tries to detect the hardware setting
  72 of the I/O address automatically.
  73 This feature may not work with some adapter hardware.
  74 .Pp
  75 The
  76 .Ar irq
  77 parameter specifies an IRQ number used by the adapter.
  78 It must match the hardware setting of the adapter.
  79 .Ar Irq
  80 may be left unspecified as
  81 .Dq Li \&? ;
  82 in that case, the driver tries to detect
  83 the hardware setting of the IRQ automatically.
  84 This feature may not work on some adapters.
  85 .Pp
  86 The
  87 .Ar flags
  88 is a numeric value which consists of a combination of various device settings.
  89 The following flags are defined in the current version.
  90 To specify two or more settings for a device,
  91 use a numeric sum of each flag value.
  92 Flag bits not specified below are reserved and must be set to 0.
  93 Actually, each bit is either just ignored by the driver,
  94 or tested and used to control undocumented features of the driver.
  95 Consult the source program for undocumented features.
  96 .Bl -tag -width 8n
  97 .It Li 0x007F
  98 These flag bits are used
  99 to initialize DLCR6 register of MB86960A/MB86965A chip,
 100 when the
 101 .Li 0x0080
 102 bit of the
 103 .Ar flags
 104 is set.
 105 See below for more about DLCR6 override feature.
 106 The
 107 .Li 0x007F
 108 flag bits must be 0 unless the
 109 .Li 0x0080
 110 bit is set,
 111 to maintain the compatibility with future versions of the driver.
 112 .It Li 0x0080
 113 This flag overrides the default setting to the DLCR6 register
 114 of MB86960A/MB86965A chip by a user supplied value,
 115 which is taken from the lower 7 bits of the flag value.
 116 This is a troubleshooting flag and should not be used
 117 without understanding of the adapter hardware.
 118 Consult the Fujitsu manual for more information
 119 on DLCR6 settings.
 120 .El
 121 .Sh OPTIONS
 122 The
 123 .Nm
 124 driver has some private options,
 125 which can be specified with an
 126 .Dq option
 127 statement in the kernel configuration file.
 128 The following lists the private options.
 129 The driver also accepts some other undocumented options,
 130 all of whose names start with a fixed prefix
 131 .Dv "FE_" .
 132 Consult the source program for undocumented options.
 133 .Bl -tag -width "FE_"
 134 .It Dv "FE_DEBUG=" Ns Ar level
 135 This option takes a numeric value
 136 .Ar level
 137 which controls the debugging level for the device and/or the driver.
 138 Setting the
 139 .Dv "FE_DEBUG"
 140 option to a value which is not listed here
 141 may cause undocumented behavior.
 142 The default setting of this option is 1.
 143 .Bl -bullet
 144 .It
 145 Setting
 146 .Dv "FE_DEBUG=0"
 147 makes most of debugging codes,
 148 including sanity check,
 149 be excluded from the object code of the driver.
 150 It generates fastest and smallest object code.
 151 Some emergency messages are logged even under this setting, though.
 152 .It
 153 Setting
 154 .Dv "FE_DEBUG=1"
 155 makes minimum debugging codes be included,
 156 setting the amount of logged messages minimum.
 157 Only fatal error messages are logged under this setting.
 158 .It
 159 Setting
 160 .Dv "FE_DEBUG=2"
 161 makes standard debugging codes be included,
 162 setting the amount of logged messages middle.
 163 Messages on lair events and/or questionable conditions
 164 are logged under this setting.
 165 .It
 166 Setting
 167 .Dv "FE_DEBUG=3"
 168 makes all debugging codes be included,
 169 and set the amount of legged messages maximum.
 170 Redundant messages such as those reporting usual actions
 171 or dumping register values
 172 are logged under this setting.
 173 .El
 174 .El
 175 .Sh FEATURES SPECIFIC TO HARDWARE MODELS
 176 The
 177 .Nm
 178 driver has some features and limitations
 179 which depend on adapter hardware models.
 180 The following is a summary of such dependency.
 181 .Ss Fujitsu FMV-180 series adapters
 182 Both automatic IRQ detection and automatic I/O port address detection
 183 is available with these adapters.
 184 .Pp
 185 Automatic I/O port address detection feature of
 186 .Nm
 187 works mostly fine for FMV-180 series.
 188 It works even if there are two or more FMV-180s in a system.
 189 However, some combination of other adapters may confuse the driver.
 190 It is recommended not to use
 191 .Em "port ?"
 192 when you experience some difficulties with hardware probe.
 193 .Pp
 194 Automatic IRQ detection feature of
 195 .Nm
 196 works reliably for FMV-180 series.
 197 It is recommended to use
 198 .Em "irq ?"
 199 always for FMV-180.
 200 The hardware setting of IRQ is read
 201 from the configuration EEPROM on the adapter,
 202 even when the kernel config file specifies an IRQ value.
 203 The driver will generate a warning message,
 204 if the IRQ setting specified in the kernel config file
 205 does not match one stored in EEPROM.
 206 Then, it will use the value specified in the config file.
 207 (This behavior has been changed from the previous releases.)
 208 .Ss Allied-Telesis AT1700 series and RE2000 series adapters
 209 Automatic I/O port address detection
 210 is available with Allied-Telesis AT1700 series and RE2000 series,
 211 while it is less reliable than FMV-180 series.
 212 Using the feature with Allied-Telesis adapters
 213 is not recommended.
 214 .Pp
 215 Automatic IRQ detection is also available with some limitation.
 216 The
 217 .Nm
 218 driver
 219 tries to get IRQ setting from the configuration EEPROM on the board,
 220 if
 221 .Dq irq ?\&
 222 is specified in the configuration file.
 223 Unfortunately,
 224 AT1700 series and RE2000 series seems to have two types of models;
 225 One type allows IRQ selection from 3/4/5/9,
 226 while the other from 10/11/12/15.
 227 Identification of the models are not well known.
 228 Hence, automatic IRQ detection with Allied-Telesis adapters
 229 may not be reliable.
 230 Specify an exact IRQ number if any troubles are encountered.
 231 .Pp
 232 Differences between AT1700 series and RE2000 series
 233 or minor models in those series are not recognized.
 234 .Ss Fujitsu MBH10302 PC card
 235 The
 236 .Nm
 237 driver supports Fujitsu MBH10302 and compatible PC cards.
 238 It requires the PC card (PCMCIA) support package.
 239 .Sh SEE ALSO
 240 .Xr netstat 1 ,
 241 .Xr ed 4 ,
 242 .Xr ifmedia 4 ,
 243 .Xr netintro 4 ,
 244 .Xr ng_ether 4 ,
 245 .Xr ifconfig 8
 246 .Sh HISTORY
 247 The
 248 .Nm
 249 driver appeared in
 250 .Fx 2.0.5 .
 251 .Sh AUTHORS, COPYRIGHT AND DISCLAIMER
 252 The
 253 .Nm
 254 driver was originally written and contributed by
 255 .An M. Sekiguchi Aq Mt seki@sysrap.cs.fujitsu.co.jp ,
 256 following the
 257 .Xr ed 4
 258 driver written by
 259 .An David Greenman .
 260 PC card support in
 261 .Nm
 262 is written by
 263 .An Hidetoshi Kimura Aq Mt h-kimura@tokyo.se.fujitsu.co.jp .
 264 This manual page was written by
 265 .An M. Sekiguchi .
 266 .Pp
 267 .Em "All Rights Reserved, Copyright (C) Fujitsu Limited 1995"
 268 .Pp
 269 This document and the associated software may be used, modified,
 270 copied, distributed, and sold, in both source and binary form provided
 271 that the above copyright, these terms and the following disclaimer are
 272 retained.  The name of the author and/or the contributor may not be
 273 used to endorse or promote products derived from this document and the
 274 associated software without specific prior written permission.
 275 .Pp
 276 THIS DOCUMENT AND THE ASSOCIATED SOFTWARE IS PROVIDED BY THE AUTHOR
 277 AND THE CONTRIBUTOR
 278 .Dq AS IS
 279 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 280 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 281 PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR THE
 282 CONTRIBUTOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 283 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 284 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 285 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 286 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 287 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 288 DOCUMENT AND THE ASSOCIATED SOFTWARE, EVEN IF ADVISED OF THE
 289 POSSIBILITY OF SUCH DAMAGE.
 290 .Sh BUGS
 291 Following are major known bugs:
 292 .Pp
 293 Statistics on the number of collisions maintained by the
 294 .Nm
 295 driver is not accurate;
 296 the
 297 .Fl i
 298 option of
 299 .Xr netstat 1
 300 shows slightly less value than true number of collisions.
 301 .Pp
 302 More mbuf clusters are used than expected.
 303 The packet receive routine has an intended violation
 304 against the mbuf cluster allocation policy.
 305 The unnecessarily allocated clusters are freed within short lifetime,
 306 and it will not affect long term kernel memory usage.
 307 .Pp
 308 Although XNS and IPX supports are included in the driver,
 309 they are never be tested and must have a lot of bugs.