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 December 15, 2008
  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 .Pp
  66 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  67 .It autoselect
  68 Enable autoselection of the media type and options
  69 .It 10baseT/UTP
  70 Set 10Mbps operation
  71 .It 100baseTX
  72 Set 100Mbps (Fast Ethernet) operation
  73 .El
  74 .Pp
  75 The
  76 .Nm
  77 driver supports the following media options:
  78 .Pp
  79 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  80 .It full-duplex
  81 Set full duplex operation
  82 .El
  83 .Pp
  84 Note that 100baseTX media type is not available on the Pro/10.
  85 For further information on configuring this device, see
  86 .Xr ifconfig 8 .
  87 .Pp
  88 The
  89 .Nm
  90 driver supports reception and transmission of extended frames
  91 for
  92 .Xr vlan 4 .
  93 This capability of
  94 .Nm
  95 can be controlled by means of the
  96 .Cm vlanmtu
  97 parameter
  98 to
  99 .Xr ifconfig 8 .
 100 .Pp
 101 The
 102 .Nm
 103 driver also supports a special link option:
 104 .Bl -tag -width link0
 105 .It Cm link0
 106 Some chip revisions have loadable microcode which can be used to reduce the
 107 interrupt load on the host cpu.
 108 Not all boards have microcode support.
 109 Setting the
 110 .Cm link0
 111 flag with
 112 .Xr ifconfig 8
 113 will download the microcode to the chip if it is available.
 114 .El
 115 .Sh HARDWARE
 116 Adapters supported by the
 117 .Nm
 118 driver include:
 119 .Pp
 120 .Bl -bullet -compact
 121 .It
 122 Intel EtherExpress PRO/10
 123 .It
 124 Intel InBusiness 10/100
 125 .It
 126 Intel PRO/100B / EtherExpressPRO/100 B PCI Adapter
 127 .It
 128 Intel PRO/100+ Management Adapter
 129 .It
 130 Intel PRO/100 VE Desktop Adapter
 131 .It
 132 Intel PRO/100 VM Network Connection
 133 .It
 134 Intel PRO/100 M Desktop Adapter
 135 .It
 136 Intel PRO/100 S Desktop, Server and Dual-Port Server Adapters
 137 .It
 138 Contec C-NET(PI)-100TX (PC-98)
 139 .It
 140 NEC PC-9821Ra20, Rv20, Xv13, Xv20 internal 100Base-TX (PC-98)
 141 .It
 142 NEC PC-9821X-B06 (PC-98)
 143 .It
 144 Many on-board network interfaces on Intel motherboards
 145 .El
 146 .Sh DIAGNOSTICS
 147 .Bl -diag
 148 .It "fxp%d: couldn't map memory"
 149 A fatal initialization error has occurred.
 150 .It "fxp%d: couldn't map interrupt"
 151 A fatal initialization error has occurred.
 152 .It "fxp%d: Failed to malloc memory"
 153 There are not enough mbuf's available for allocation.
 154 .It "fxp%d: device timeout"
 155 The device has stopped responding to the network, or there is a problem with
 156 the network connection (cable).
 157 .It "fxp%d: Microcode loaded, int_delay: %d usec  bundle_max: %d"
 158 The chip has successfully downloaded the microcode, and changed the
 159 parameterized values to the given settings.
 160 .El
 161 .Sh SEE ALSO
 162 .Xr altq 4 ,
 163 .Xr arp 4 ,
 164 .Xr miibus 4 ,
 165 .Xr netintro 4 ,
 166 .Xr ng_ether 4 ,
 167 .Xr polling 4 ,
 168 .Xr vlan 4 ,
 169 .Xr ifconfig 8
 170 .Sh HISTORY
 171 The
 172 .Nm
 173 device driver first appeared in
 174 .Fx 2.1 .
 175 .Sh AUTHORS
 176 .An -nosplit
 177 The
 178 .Nm
 179 device driver was written by
 180 .An David Greenman .
 181 It has then been updated to use the busdma API and made endian-clean by
 182 .An Maxime Henrion .
 183 This manual page was written by
 184 .An David E. O'Brien .