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$
  25 .Dd July 16, 2005
  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 To compile this driver into the kernel,
  33 place the following line in your
  34 kernel configuration file:
  35 .Bd -ragged -offset indent
  36 .Cd "device fe"
  37 .Ed
  38 .Pp
  39 Alternatively, to load the driver as a
  40 module at boot time, place the following line in
  41 .Xr loader.conf 5 :
  42 .Bd -literal -offset indent
  43 if_fe_load="YES"
  44 .Ed
  45 .Pp
  46 In
  47 .Pa /boot/device.hints :
  48 .Cd hint.fe.0.at="isa"
  49 .Cd hint.fe.0.port="0x300"
  50 .Cd hint.fe.0.flags="0x0"
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 is a network device driver
  55 for Ethernet adapters based on Fujitsu MB86960A, MB86965A,
  56 or other compatible chips.
  57 .Pp
  58 The driver provides automatic I/O port address configuration and
  59 automatic IRQ configuration,
  60 when used with suitable adapter hardware.
  61 .Pp
  62 The driver works with program I/O data transfer technique.
  63 It gives a fair performance.
  64 Shared memory is never used, even if the adapter has one.
  65 .Pp
  66 It currently works with Fujitsu FMV-180 series for ISA,
  67 Allied-Telesis AT1700 series and RE2000 series for ISA,
  68 and Fujitsu MBH10302 PC card.
  69 .Ss Parameters
  70 In the
  71 .Pa /boot/device.hints
  72 file, two parameters,
  73 .Ar port
  74 and
  75 .Ar irq ,
  76 must be specified to reflect adapter hardware settings.
  77 Another parameter
  78 .Ar flags
  79 can be specified to provide additional configuration as an option.
  80 .Pp
  81 The
  82 .Ar port
  83 parameter specifies a base I/O port address of the adapter.
  84 It must match with the hardware setting of the adapter.
  85 The
  86 .Ar port
  87 may be left unspecified by removing
  88 .Dl hint.fe.0.port="..."
  89 from the file.
  90 In that case, the driver tries to detect the hardware setting
  91 of the I/O address automatically.
  92 This feature may not work with some adapter hardware.
  93 .Pp
  94 The
  95 .Ar irq
  96 parameter specifies an IRQ number used by the adapter.
  97 It must match the hardware setting of the adapter.
  98 .Ar Irq
  99 may be left unspecified by removing
 100 .Dl hint.fe.0.irq="..."
 101 from the file.
 102 in that case, the driver tries to detect
 103 the hardware setting of the IRQ automatically.
 104 This feature may not work on some adapters.
 105 .Pp
 106 The
 107 .Ar flags
 108 is a numeric value which consists of a combination of various device settings.
 109 The following flags are defined in the current version.
 110 To specify two or more settings for a device,
 111 use a numeric sum of each flag value.
 112 Flag bits not specified below are reserved and must be set to 0.
 113 Actually, each bit is either just ignored by the driver,
 114 or tested and used to control undocumented features of the driver.
 115 Consult the source program for undocumented features.
 116 .Bl -tag -width 8n
 117 .It Li 0x007F
 118 These flag bits are used
 119 to initialize DLCR6 register of MB86960A/MB86965A chip,
 120 when the
 121 .Li 0x0080
 122 bit of the
 123 .Ar flags
 124 is set.
 125 See below for more about DLCR6 override feature.
 126 The
 127 .Li 0x007F
 128 flag bits must be 0 unless the
 129 .Li 0x0080
 130 bit is set,
 131 to maintain the compatibility with future versions of the driver.
 132 .It Li 0x0080
 133 This flag overrides the default setting to the DLCR6 register
 134 of MB86960A/MB86965A chip by a user supplied value,
 135 which is taken from the lower 7 bits of the flag value.
 136 This is a troubleshooting flag and should not be used
 137 without understanding of the adapter hardware.
 138 Consult the Fujitsu manual for more information
 139 on DLCR6 settings.
 140 .El
 141 .Sh HARDWARE
 142 Controllers and cards supported by the
 143 .Nm
 144 driver include:
 145 .Pp
 146 .Bl -bullet -compact
 147 .It
 148 Allied Telesis RE1000, RE1000Plus, ME1500 (110-pin)
 149 .It
 150 CONTEC C-NET(98)P2, C-NET (9N)E (110-pin), C-NET(9N)C (ExtCard)
 151 .It
 152 CONTEC C-NET(PC)C PC Card Ethernet
 153 .It
 154 Eagle Tech NE200T
 155 .It
 156 Eiger Labs EPX-10BT
 157 .It
 158 Fujitsu FMV-J182, FMV-J182A
 159 .It
 160 Fujitsu MB86960A, MB86965A
 161 .It
 162 Fujitsu MBH10303, MBH10302 PC Card Ethernet
 163 .It
 164 Fujitsu Towa LA501 Ethernet
 165 .It
 166 HITACHI HT-4840-11 PC Card Ethernet
 167 .It
 168 NextCom J Link NC5310
 169 .It
 170 RATOC REX-5588, REX-9822, REX-4886, and REX-R280
 171 .It
 172 RATOC REX-9880/9881/9882/9883
 173 .It
 174 TDK LAC-98012, LAC-98013, LAC-98025, LAC-9N011 (110-pin)
 175 .It
 176 TDK LAK-CD011, LAK-CD021, LAK-CD021A, LAK-CD021BX
 177 .It
 178 Ungermann-Bass Access/PC N98C+(PC85152, PC85142), Access/NOTE
 179 N98(PC86132) (110-pin)
 180 .El
 181 .Sh FEATURES SPECIFIC TO HARDWARE MODELS
 182 The
 183 .Nm
 184 driver has some features and limitations
 185 which depend on adapter hardware models.
 186 The following is a summary of these dependencies.
 187 .Ss Fujitsu FMV-180 series adapters
 188 Both automatic IRQ detection and automatic I/O port address detection
 189 is available with these adapters.
 190 .Pp
 191 Automatic I/O port address detection feature of
 192 .Nm
 193 works mostly fine for FMV-180 series.
 194 It works even if there are two or more FMV-180s in a system.
 195 However, some combination of other adapters may confuse the driver.
 196 It is recommended to explicitly specify
 197 .Ar port
 198 when you experience some difficulties with hardware probe.
 199 .Pp
 200 Automatic IRQ detection feature of
 201 .Nm
 202 works reliably for FMV-180 series.
 203 It is recommended to explicitly specify
 204 .Ar irq
 205 always for FMV-180.
 206 The hardware setting of IRQ is read
 207 from the configuration EEPROM on the adapter,
 208 even when the kernel config file specifies an IRQ value.
 209 The driver will generate a warning message,
 210 if the IRQ setting specified in
 211 .Pa /boot/device.hints
 212 does not match one stored in EEPROM.
 213 Then, it will use the value specified in the file.
 214 (This behavior has been changed from the previous releases.)
 215 .Ss Allied-Telesis AT1700 series and RE2000 series adapters
 216 Automatic I/O port address detection
 217 is available with Allied-Telesis AT1700 series and RE2000 series,
 218 while it is less reliable than FMV-180 series.
 219 Using the feature with Allied-Telesis adapters
 220 is not recommended.
 221 .Pp
 222 Automatic IRQ detection is also available with some limitation.
 223 The
 224 .Nm
 225 driver
 226 tries to get IRQ setting from the configuration EEPROM on the board,
 227 if
 228 .Ar irq
 229 is not specified in
 230 .Pa /boot/device.hints .
 231 Unfortunately,
 232 AT1700 series and RE2000 series seems to have two types of models;
 233 One type allows IRQ selection from 3/4/5/9,
 234 while the other from 10/11/12/15.
 235 Identification of the models are not well known.
 236 Hence, automatic IRQ detection with Allied-Telesis adapters
 237 may not be reliable.
 238 Specify an exact IRQ number if any troubles are encountered.
 239 .Pp
 240 Differences between AT1700 series and RE2000 series
 241 or minor models in those series are not recognized.
 242 .Ss Fujitsu MBH10302 PC card
 243 The
 244 .Nm
 245 driver supports Fujitsu MBH10302 and compatible PC cards.
 246 It requires the PC card (PCMCIA) support package.
 247 .Sh SEE ALSO
 248 .Xr netstat 1 ,
 249 .Xr ed 4 ,
 250 .Xr netintro 4 ,
 251 .Xr ng_ether 4 ,
 252 .Xr ifconfig 8
 253 .Sh HISTORY
 254 The
 255 .Nm
 256 driver appeared in
 257 .Fx 2.0.5 .
 258 .Sh AUTHORS, COPYRIGHT AND DISCLAIMER
 259 The
 260 .Nm
 261 driver was originally written and contributed by
 262 .An M. Sekiguchi Aq seki@sysrap.cs.fujitsu.co.jp ,
 263 following the
 264 .Nm ed
 265 driver written by
 266 .An David Greenman .
 267 PC card support in
 268 .Nm
 269 is written by
 270 .An Hidetoshi Kimura Aq h-kimura@tokyo.se.fujitsu.co.jp .
 271 This manual page was written by
 272 .An M. Sekiguchi .
 273 .Pp
 274 .Em "All Rights Reserved, Copyright (C) Fujitsu Limited 1995"
 275 .Pp
 276 This document and the associated software may be used, modified,
 277 copied, distributed, and sold, in both source and binary form provided
 278 that the above copyright, these terms and the following disclaimer are
 279 retained.
 280 The name of the author and/or the contributor may not be
 281 used to endorse or promote products derived from this document and the
 282 associated software without specific prior written permission.
 283 .Pp
 284 THIS DOCUMENT AND THE ASSOCIATED SOFTWARE IS PROVIDED BY THE AUTHOR
 285 AND THE CONTRIBUTOR
 286 .Dq AS IS
 287 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 288 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 289 PURPOSE ARE DISCLAIMED.
 290 IN NO EVENT SHALL THE AUTHOR OR THE
 291 CONTRIBUTOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 292 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 293 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 294 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 295 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 296 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 297 DOCUMENT AND THE ASSOCIATED SOFTWARE, EVEN IF ADVISED OF THE
 298 POSSIBILITY OF SUCH DAMAGE.
 299 .Sh BUGS
 300 Following are major known bugs:
 301 .Pp
 302 Statistics on the number of collisions maintained by the
 303 .Nm
 304 driver is not accurate;
 305 the
 306 .Fl i
 307 option of
 308 .Xr netstat 1
 309 shows slightly less value than true number of collisions.
 310 .Pp
 311 More mbuf clusters are used than expected.
 312 The packet receive routine has an intended violation
 313 against the mbuf cluster allocation policy.
 314 The unnecessarily allocated clusters are freed within short lifetime,
 315 and it will not affect long term kernel memory usage.
 316 .Pp
 317 Although XNS and IPX support is included in the driver,
 318 it has never been tested and it is expected to have a lot of bugs.