share/man/man4/nge.4

   1 .\" Copyright (c) 2001 Wind River Systems
   2 .\" Copyright (c) 1997, 1998, 1999, 2000, 2001
   3 .\"     Bill Paul <wpaul@bsdi.com>. All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by Bill Paul.
  16 .\" 4. Neither the name of the author nor the names of any co-contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"   without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  24 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  30 .\" THE POSSIBILITY OF SUCH DAMAGE.
  31 .\"
  32 .\" $FreeBSD$
  33 .\"
  34 .Dd July 16, 2005
  35 .Dt NGE 4
  36 .Os
  37 .Sh NAME
  38 .Nm nge
  39 .Nd "National Semiconductor PCI Gigabit Ethernet adapter driver"
  40 .Sh SYNOPSIS
  41 To compile support for the
  42 .Nm
  43 driver into your kernel, place the following lines in your
  44 kernel configuration file:
  45 .Bd -ragged -offset indent
  46 .Cd "device miibus"
  47 .Cd "device nge"
  48 .Ed
  49 .Pp
  50 Alternatively, to load the
  51 .Nm
  52 driver at boot time, place the following line in
  53 .Xr loader.conf 5 :
  54 .Bd -literal -offset indent
  55 if_nge_load="YES"
  56 .Ed
  57 .Sh DESCRIPTION
  58 The
  59 .Nm
  60 driver provides support for various NICs based on the National Semiconductor
  61 DP83820 and DP83821 Gigabit Ethernet controller chips.
  62 .Pp
  63 The DP83820 supports TBI (ten bit interface) and GMII
  64 transceivers, which means it can be used with either copper or 1000baseX
  65 fiber applications.
  66 The DP83820 supports TCP/IP checksum offload and
  67 VLAN tagging/insertion as well as a 2048-bit multicast hash filter
  68 and up to 4 pattern match buffers.
  69 .Pp
  70 Most cards also use the DP83861 10/100/1000 copper gigabit transceiver
  71 chip, which supports autonegotiation of 10, 100 and 1000Mbps modes in
  72 full or half duplex.
  73 .Pp
  74 The DP83820 also supports jumbo frames, which can be configured
  75 via the interface MTU setting.
  76 Selecting an MTU larger than 1500 bytes with the
  77 .Xr ifconfig 8
  78 utility configures the adapter to receive and transmit jumbo frames.
  79 Using jumbo frames can greatly improve performance for certain tasks,
  80 such as file transfers and data streaming.
  81 .Pp
  82 The
  83 .Nm
  84 driver supports the following media types:
  85 .Bl -tag -width 10baseTXUTP
  86 .It Cm autoselect
  87 Enable autoselection of the media type and options.
  88 The user can manually override
  89 the autoselected mode by adding media options to
  90 .Xr rc.conf 5 .
  91 .It Cm 10baseT/UTP
  92 Set 10Mbps operation.
  93 The
  94 .Xr ifconfig 8
  95 .Ic mediaopt
  96 option can also be used to select either
  97 .Cm full-duplex
  98 or
  99 .Cm half-duplex
 100 modes.
 101 .It Cm 100baseTX
 102 Set 100Mbps (Fast Ethernet) operation.
 103 The
 104 .Xr ifconfig 8
 105 .Ic mediaopt
 106 option can also be used to select either
 107 .Cm full-duplex
 108 or
 109 .Cm half-duplex
 110 modes.
 111 .It Cm 1000baseTX
 112 Set 1000baseTX operation over twisted pair.
 113 .Cm full-duplex
 114 and
 115 .Cm half-duplex
 116 modes are supported.
 117 .It Cm 1000baseSX
 118 Set 1000Mbps (Gigabit Ethernet) operation.
 119 Both
 120 .Cm full-duplex
 121 and
 122 .Cm half-duplex
 123 modes are supported.
 124 .El
 125 .Pp
 126 The
 127 .Nm
 128 driver supports the following media options:
 129 .Bl -tag -width full-duplex
 130 .It Cm full-duplex
 131 Force full duplex operation.
 132 .It Cm half-duplex
 133 Force half duplex operation.
 134 .El
 135 .Pp
 136 The
 137 .Nm
 138 driver also supports one special link option for 1000baseTX cards:
 139 .Bl -tag -width link0
 140 .It Cm link0
 141 With 1000baseTX cards, establishing a link between two ports requires
 142 that one port be configured as a master and the other a slave.
 143 With autonegotiation,
 144 the master/slave settings will be chosen automatically.
 145 However when manually selecting the link state, it is necessary to
 146 force one side of the link to be a master and the other a slave.
 147 The
 148 .Nm
 149 driver configures the ports as slaves by default.
 150 Setting the
 151 .Cm link0
 152 flag with
 153 .Xr ifconfig 8
 154 will set a port as a master instead.
 155 .El
 156 .Pp
 157 For more information on configuring this device, see
 158 .Xr ifconfig 8 .
 159 .Sh HARDWARE
 160 The
 161 .Nm
 162 driver supports National Semiconductor DP83820 and DP83821 based
 163 Gigabit Ethernet adapters including:
 164 .Pp
 165 .Bl -bullet -compact
 166 .It
 167 Addtron AEG320T
 168 .It
 169 Ark PC SOHO-GA2500T (32-bit PCI) and SOHO-GA2000T (64-bit PCI)
 170 .It
 171 Asante FriendlyNet GigaNIX 1000TA and 1000TPC
 172 .It
 173 D-Link DGE-500T
 174 .It
 175 LinkSys EG1032 (32-bit PCI) and EG1064 (64-bit PCI)
 176 .It
 177 Netgear GA621
 178 .It
 179 Netgear GA622T
 180 .It
 181 SMC EZ Card 1000 (SMC9462TX)
 182 .It
 183 Surecom Technology EP-320G-TX
 184 .It
 185 Trendware TEG-PCITX (32-bit PCI) and TEG-PCITX2 (64-bit PCI)
 186 .El
 187 .Sh DIAGNOSTICS
 188 .Bl -diag
 189 .It "nge%d: couldn't map memory"
 190 A fatal initialization error has occurred.
 191 .It "nge%d: couldn't map ports"
 192 A fatal initialization error has occurred.
 193 .It "nge%d: couldn't map interrupt"
 194 A fatal initialization error has occurred.
 195 .It "nge%d: no memory for softc struct!"
 196 The driver failed to allocate memory for per-device instance information
 197 during initialization.
 198 .It "nge%d: failed to enable memory mapping!"
 199 The driver failed to initialize PCI shared memory mapping.
 200 This might
 201 happen if the card is not in a bus-master slot.
 202 .It "nge%d: no memory for jumbo buffers!"
 203 The driver failed to allocate memory for jumbo frames during
 204 initialization.
 205 .It "nge%d: watchdog timeout"
 206 The device has stopped responding to the network, or there is a problem with
 207 the network connection (cable).
 208 .El
 209 .Sh SEE ALSO
 210 .Xr arp 4 ,
 211 .Xr miibus 4 ,
 212 .Xr netintro 4 ,
 213 .Xr ng_ether 4 ,
 214 .Xr polling 4 ,
 215 .Xr vlan 4 ,
 216 .Xr ifconfig 8
 217 .Rs
 218 .%T National Semiconductor DP83820 datasheet
 219 .%O http://www.national.com
 220 .Re
 221 .Rs
 222 .%T National Semiconductor DP83861 datasheet
 223 .%O http://www.national.com
 224 .Re
 225 .Sh HISTORY
 226 The
 227 .Nm
 228 device driver first appeared in
 229 .Fx 4.4 .
 230 .Sh AUTHORS
 231 The
 232 .Nm
 233 driver was written by
 234 .An Bill Paul Aq wpaul@bsdi.com .