share/man/man4/fxp.4

   1 .\"
   2 .\" Copyright (c) 1997 David E. O'Brien
   3 .\"
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd July 16, 2005
  29 .Dt FXP 4
  30 .Os
  31 .Sh NAME
  32 .Nm fxp
  33 .Nd "Intel EtherExpress PRO/100 Ethernet device driver"
  34 .Sh SYNOPSIS
  35 To compile this driver into the kernel,
  36 place the following lines in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device miibus"
  40 .Cd "device fxp"
  41 .Ed
  42 .Pp
  43 Alternatively, to load the driver as a
  44 module at boot time, place the following line in
  45 .Xr loader.conf 5 :
  46 .Bd -literal -offset indent
  47 if_fxp_load="YES"
  48 .Ed
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 driver provides support for Ethernet adapters based on the Intel
  53 i82557, i82558, i82559, i82550, and i82562 chips.
  54 .Pp
  55 The
  56 .Nm
  57 driver supports the following media types:
  58 .Pp
  59 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  60 .It autoselect
  61 Enable autoselection of the media type and options
  62 .It 10baseT/UTP
  63 Set 10Mbps operation
  64 .It 100baseTX
  65 Set 100Mbps (Fast Ethernet) operation
  66 .El
  67 .Pp
  68 The
  69 .Nm
  70 driver supports the following media options:
  71 .Pp
  72 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  73 .It full-duplex
  74 Set full duplex operation
  75 .El
  76 .Pp
  77 Note that 100baseTX media type is not available on the Pro/10.
  78 For further information on configuring this device, see
  79 .Xr ifconfig 8 .
  80 .Pp
  81 The
  82 .Nm
  83 driver supports reception and transmission of extended frames
  84 for
  85 .Xr vlan 4 .
  86 This capability of
  87 .Nm
  88 can be controlled by means of the
  89 .Cm vlanmtu
  90 parameter
  91 to
  92 .Xr ifconfig 8 .
  93 .Pp
  94 The
  95 .Nm
  96 driver also supports a special link option:
  97 .Bl -tag -width link0
  98 .It Cm link0
  99 Some chip revisions have loadable microcode which can be used to reduce the
 100 interrupt load on the host cpu.
 101 Not all boards have microcode support.
 102 Setting the
 103 .Cm link0
 104 flag with
 105 .Xr ifconfig 8
 106 will download the microcode to the chip if it is available.
 107 .El
 108 .Sh HARDWARE
 109 Adapters supported by the
 110 .Nm
 111 driver include:
 112 .Pp
 113 .Bl -bullet -compact
 114 .It
 115 Intel EtherExpress PRO/10
 116 .It
 117 Intel InBusiness 10/100
 118 .It
 119 Intel PRO/100B / EtherExpressPRO/100 B PCI Adapter
 120 .It
 121 Intel PRO/100+ Management Adapter
 122 .It
 123 Intel PRO/100 VE Desktop Adapter
 124 .It
 125 Intel PRO/100 M Desktop Adapter
 126 .It
 127 Intel PRO/100 S Desktop, Server and Dual-Port Server Adapters
 128 .It
 129 Contec C-NET(PI)-100TX (PC-98)
 130 .It
 131 NEC PC-9821Ra20, Rv20, Xv13, Xv20 internal 100Base-TX (PC-98)
 132 .It
 133 NEC PC-9821X-B06 (PC-98)
 134 .It
 135 Many on-board network interfaces on Intel motherboards
 136 .El
 137 .Sh DIAGNOSTICS
 138 .Bl -diag
 139 .It "fxp%d: couldn't map memory"
 140 A fatal initialization error has occurred.
 141 .It "fxp%d: couldn't map interrupt"
 142 A fatal initialization error has occurred.
 143 .It "fxp%d: Failed to malloc memory"
 144 There are not enough mbuf's available for allocation.
 145 .It "fxp%d: device timeout"
 146 The device has stopped responding to the network, or there is a problem with
 147 the network connection (cable).
 148 .It "fxp%d: Ethernet address ff:ff:ff:ff:ff:ff"
 149 In some Alpha's (AXPpci and Multia) you must tell the driver to use (slower)
 150 I/O rather than memory to access the card.
 151 Create, if it does not yet exist, and add to the file
 152 .Pa /boot/device.hints
 153 the line
 154 .Dq Li hint.fxp.0.prefer_iomap="0" .
 155 .It "fxp%d: Microcode loaded, int_delay: %d usec  bundle_max: %d"
 156 The chip has successfully downloaded the microcode, and changed the
 157 parameterized values to the given settings.
 158 .El
 159 .Sh SEE ALSO
 160 .Xr altq 4 ,
 161 .Xr arp 4 ,
 162 .Xr miibus 4 ,
 163 .Xr netintro 4 ,
 164 .Xr ng_ether 4 ,
 165 .Xr polling 4 ,
 166 .Xr vlan 4 ,
 167 .Xr ifconfig 8
 168 .Sh HISTORY
 169 The
 170 .Nm
 171 device driver first appeared in
 172 .Fx 2.1 .
 173 .Sh AUTHORS
 174 .An -nosplit
 175 The
 176 .Nm
 177 device driver was written by
 178 .An David Greenman .
 179 It has then been updated to use the busdma API and made endian-clean by
 180 .An Maxime Henrion .
 181 This manual page was written by
 182 .An David E. O'Brien .