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