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 November 26, 2010
  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 The driver supports TCP/UDP/IP checksum offload for both transmit
  55 and receive on i82550 and i82551.
  56 On i82559 only TCP/UDP checksum offload for receive is supported.
  57 TCP segmentation offload (TSO) for IPv4 as well as VLAN hardware
  58 tag insertion/stripping is supported on i82550 and i82551.
  59 Wake On Lan (WOL) support is provided on all controllers
  60 except i82557, i82259ER and early i82558 revisions.
  61 .Pp
  62 The
  63 .Nm
  64 driver supports the following media types:
  65 .Bl -tag -width "10baseT/UTP"
  66 .It Cm autoselect
  67 Enable autoselection of the media type and options.
  68 The autoselected mode can be overridden by adding the media options to
  69 .Xr rc.conf 5 .
  70 .It Cm 10baseT/UTP
  71 Set 10Mbps operation.
  72 .It Cm 100baseTX
  73 Set 100Mbps (Fast Ethernet) operation.
  74 .El
  75 .Pp
  76 The
  77 .Nm
  78 driver supports the following media options:
  79 .Bl -tag -width "full-duplex"
  80 .It Cm full-duplex
  81 Force full duplex operation.
  82 .It Cm half-duplex
  83 Force half duplex operation.
  84 .El
  85 .Pp
  86 Note that 100baseTX media type is not available on the Pro/10.
  87 For further information on configuring this device, see
  88 .Xr ifconfig 8 .
  89 .Pp
  90 The
  91 .Nm
  92 driver supports reception and transmission of extended frames
  93 for
  94 .Xr vlan 4 .
  95 This capability of
  96 .Nm
  97 can be controlled by means of the
  98 .Cm vlanmtu
  99 parameter
 100 to
 101 .Xr ifconfig 8 .
 102 .Pp
 103 The
 104 .Nm
 105 driver also supports a special link option:
 106 .Bl -tag -width link0
 107 .It Cm link0
 108 Some chip revisions have loadable microcode which can be used to reduce the
 109 interrupt load on the host cpu.
 110 Not all boards have microcode support.
 111 Setting the
 112 .Cm link0
 113 flag with
 114 .Xr ifconfig 8
 115 will download the microcode to the chip if it is available.
 116 .El
 117 .Sh HARDWARE
 118 Adapters supported by the
 119 .Nm
 120 driver include:
 121 .Pp
 122 .Bl -bullet -compact
 123 .It
 124 Intel EtherExpress PRO/10
 125 .It
 126 Intel InBusiness 10/100
 127 .It
 128 Intel PRO/100B / EtherExpressPRO/100 B PCI Adapter
 129 .It
 130 Intel PRO/100+ Management Adapter
 131 .It
 132 Intel PRO/100 VE Desktop Adapter
 133 .It
 134 Intel PRO/100 VM Network Connection
 135 .It
 136 Intel PRO/100 M Desktop Adapter
 137 .It
 138 Intel PRO/100 S Desktop, Server and Dual-Port Server Adapters
 139 .It
 140 Contec C-NET(PI)-100TX (PC-98)
 141 .It
 142 NEC PC-9821Ra20, Rv20, Xv13, Xv20 internal 100Base-TX (PC-98)
 143 .It
 144 NEC PC-9821X-B06 (PC-98)
 145 .It
 146 Many on-board network interfaces on Intel motherboards
 147 .El
 148 .Sh LOADER TUNABLES
 149 Tunables can be set at the
 150 .Xr loader 8
 151 prompt before booting the kernel or stored in
 152 .Xr loader.conf 5 .
 153 The following variables are available as both
 154 .Xr loader 8
 155 tunables and
 156 .Xr sysctl 8
 157 variables:
 158 .Bl -tag -width "xxxxxx"
 159 .It Va dev.fxp.%d.int_delay
 160 Maximum amount of time, in microseconds, that an interrupt may
 161 be delayed in an attempt to coalesce interrupts.
 162 This is only effective if the Intel microcode is loaded.
 163 The accepted range is 300 to 3000, the default is 1000.
 164 .It Va dev.fxp.%d.bundle_max
 165 Number of packets that will be bundled, before an interrupt is
 166 generated.
 167 This is only effective if the Intel microcode is loaded.
 168 The accepted range is 1 to 65535, the default is 6.
 169 .El
 170 .Sh SYSCTL VARIABLES
 171 The following variables are available as
 172 .Xr sysctl 8
 173 variables.
 174 .Bl -tag -width "xxxxxx"
 175 .It Va dev.fxp.%d.rnr
 176 This is a read-only variable and shows the number of events of
 177 RNR (resource not ready).
 178 .It Va dev.fxp.%d.stats
 179 This is a read-only variable and displays useful MAC counters
 180 maintained in the driver.
 181 .El
 182 .Sh DIAGNOSTICS
 183 .Bl -diag
 184 .It "fxp%d: couldn't map memory"
 185 A fatal initialization error has occurred.
 186 .It "fxp%d: couldn't map interrupt"
 187 A fatal initialization error has occurred.
 188 .It "fxp%d: Failed to malloc memory"
 189 There are not enough mbuf's available for allocation.
 190 .It "fxp%d: device timeout"
 191 The device has stopped responding to the network, or there is a problem with
 192 the network connection (cable).
 193 .It "fxp%d: Microcode loaded, int_delay: %d usec  bundle_max: %d"
 194 The chip has successfully downloaded the microcode, and changed the
 195 parameterized values to the given settings.
 196 .El
 197 .Sh SEE ALSO
 198 .Xr altq 4 ,
 199 .Xr arp 4 ,
 200 .Xr miibus 4 ,
 201 .Xr netintro 4 ,
 202 .Xr ng_ether 4 ,
 203 .Xr polling 4 ,
 204 .Xr vlan 4 ,
 205 .Xr ifconfig 8
 206 .Sh HISTORY
 207 The
 208 .Nm
 209 device driver first appeared in
 210 .Fx 2.1 .
 211 .Sh AUTHORS
 212 .An -nosplit
 213 The
 214 .Nm
 215 device driver was written by
 216 .An David Greenman .
 217 It has then been updated to use the busdma API and made endian-clean by
 218 .An Maxime Henrion .
 219 This manual page was written by
 220 .An David E. O'Brien .