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: src/share/man/man4/nge.4,v 1.4.2.6 2002/08/15 16:35:37 ambrisko Exp $
  33 .\"
  34 .Dd May 11, 2001
  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 .Cd "device miibus"
  42 .Cd "device nge"
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 driver provides support for various NICs based on the National Semiconductor
  47 DP83820 and DP83821 gigabit ethernet controller chips, including the
  48 following:
  49 .Pp
  50 .Bl -bullet -compact
  51 .It
  52 SMC EZ Card 1000 (SMC9462TX)
  53 .It
  54 D-Link DGE-500T
  55 .It
  56 Asante FriendlyNet GigaNIX 1000TA and 1000TPC
  57 .It
  58 Addtron AEG320T
  59 .It
  60 LinkSys EG1032 (32-bit PCI) and EG1064 (64-bit PCI)
  61 .It
  62 Surecom Technology EP-320G-TX
  63 .It
  64 Netgear GA621
  65 .It
  66 Netgear GA622T
  67 .El
  68 .Pp
  69 All of these NICs are capable of 10, 100 and 1000mbps speeds over CAT5
  70 copper cable.
  71 The DP83820 supports TBI (ten bit interface) and GMII
  72 transceivers, which means it can be used with either copper or 1000baseX
  73 fiber applications.
  74 The DP83820 supports TCP/IP checksum offload and
  75 VLAN tagging/insertion as well as a 2048-bit multicast hash filter
  76 and up to 4 pattern match buffers.
  77 .Pp
  78 Most cards also use the DP83861 10/100/1000 copper gigabit transceiver
  79 chip, which supports autonegotiation of 10, 100 and 1000mbps modes in
  80 full or half duplex.
  81 .Pp
  82 The DP83820 also supports jumbo frames, which can be configured
  83 via the interface MTU setting.
  84 Selecting an MTU larger than 1500 bytes with the
  85 .Xr ifconfig 8
  86 utility configures the adapter to receive and transmit jumbo frames.
  87 Using jumbo frames can greatly improve performance for certain tasks,
  88 such as file transfers and data streaming.
  89 .Pp
  90 The
  91 .Nm
  92 driver supports the following media types:
  93 .Bl -tag -width 10baseTXUTP
  94 .It Cm autoselect
  95 Enable autoselection of the media type and options.
  96 The user can manually override
  97 the autoselected mode by adding media options to
  98 .Xr rc.conf 5 .
  99 .It Cm 10baseT/UTP
 100 Set 10Mbps operation.
 101 The
 102 .Xr ifconfig 8
 103 .Ic mediaopt
 104 option can also be used to select either
 105 .Cm full-duplex
 106 or
 107 .Cm half-duplex
 108 modes.
 109 .It Cm 100baseTX
 110 Set 100Mbps (fast ethernet) operation.
 111 The
 112 .Xr ifconfig 8
 113 .Ic mediaopt
 114 option can also be used to select either
 115 .Cm full-duplex
 116 or
 117 .Cm half-duplex
 118 modes.
 119 .It Cm 1000baseT
 120 Set 1000baseT operation over twisted pair.
 121 .Cm full-duplex
 122 and
 123 .Cm half-duplex
 124 modes are supported.
 125 .It Cm 1000baseSX
 126 Set 1000Mbps (gigabit ethernet) operation.
 127 Both
 128 .Cm full-duplex
 129 and
 130 .Cm half-duplex
 131 modes are supported.
 132 .El
 133 .Pp
 134 The
 135 .Nm
 136 driver supports the following media options:
 137 .Bl -tag -width full-duplex
 138 .It Cm full-duplex
 139 Force full duplex operation.
 140 .It Cm half-duplex
 141 Force half duplex operation.
 142 .El
 143 .Pp
 144 The
 145 .Nm
 146 driver also supports one special link option for 1000baseT cards:
 147 .Bl -tag -width link0
 148 .It Cm link0
 149 With 1000baseT cards, establishing a link between two ports requires
 150 that one port be configured as a master and the other a slave.
 151 With autonegotiation,
 152 the master/slave settings will be chosen automatically.
 153 However when manually selecting the link state, it is necessary to
 154 force one side of the link to be a master and the other a slave.
 155 The
 156 .Nm
 157 driver configures the ports as slaves by default.
 158 Setting the
 159 .Cm link0
 160 flag with
 161 .Xr ifconfig 8
 162 will set a port as a master instead.
 163 .El
 164 .Pp
 165 For more information on configuring this device, see
 166 .Xr ifconfig 8 .
 167 The
 168 .Nm
 169 driver supports
 170 .Xr polling 4 .
 171 .Sh DIAGNOSTICS
 172 .Bl -diag
 173 .It "nge%d: couldn't map memory"
 174 A fatal initialization error has occurred.
 175 .It "nge%d: couldn't map ports"
 176 A fatal initialization error has occurred.
 177 .It "nge%d: couldn't map interrupt"
 178 A fatal initialization error has occurred.
 179 .It "nge%d: no memory for softc struct!"
 180 The driver failed to allocate memory for per-device instance information
 181 during initialization.
 182 .It "nge%d: failed to enable memory mapping!"
 183 The driver failed to initialize PCI shared memory mapping.
 184 This might
 185 happen if the card is not in a bus-master slot.
 186 .It "nge%d: no memory for jumbo buffers!"
 187 The driver failed to allocate memory for jumbo frames during
 188 initialization.
 189 .It "nge%d: watchdog timeout"
 190 The device has stopped responding to the network, or there is a problem with
 191 the network connection (cable).
 192 .El
 193 .Sh SEE ALSO
 194 .Xr arp 4 ,
 195 .Xr ifmedia 4 ,
 196 .Xr miibus 4 ,
 197 .Xr netintro 4 ,
 198 .Xr ng_ether 4 ,
 199 .Xr polling 4 ,
 200 .Xr vlan 4 ,
 201 .Xr ifconfig 8
 202 .Rs
 203 .%T National Semiconductor DP83820 datasheet
 204 .%O http://www.national.com
 205 .Re
 206 .Rs
 207 .%T National Semiconductor DP83861 datasheet
 208 .%O http://www.national.com
 209 .Re
 210 .Sh HISTORY
 211 The
 212 .Nm
 213 device driver first appeared in
 214 .Fx 4.4 .
 215 .Sh AUTHORS
 216 The
 217 .Nm
 218 driver was written by
 219 .An Bill Paul Aq Mt wpaul@bsdi.com .