share/man/man4/bge.4

   1 .\" Copyright (c) 2001 Wind River Systems
   2 .\" Copyright (c) 1997, 1998, 1999, 2000, 2001
   3 .\"     Bill Paul <wpaul@windriver.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 November 15, 2005
  35 .Dt BGE 4
  36 .Os
  37 .Sh NAME
  38 .Nm bge
  39 .Nd "Broadcom BCM570x/5714/5721/5750/5751/5752/5789 PCI Gigabit Ethernet adapter driver"
  40 .Sh SYNOPSIS
  41 To compile this driver into the kernel,
  42 place the following lines in your
  43 kernel configuration file:
  44 .Bd -ragged -offset indent
  45 .Cd "device miibus"
  46 .Cd "device bge"
  47 .Ed
  48 .Pp
  49 Alternatively, to load the driver as a
  50 module at boot time, place the following line in
  51 .Xr loader.conf 5 :
  52 .Bd -literal -offset indent
  53 if_bge_load="YES"
  54 .Ed
  55 .Pp
  56 The following tunable is settable from the loader:
  57 .Bl -ohang -offset indent
  58 .It Va hw.bge.fake_autoneg
  59 set to 1 for special handling of the BCM5704 HW (default is 0).
  60 .El
  61 .Sh DESCRIPTION
  62 The
  63 .Nm
  64 driver provides support for various NICs based on the Broadcom BCM570x,
  65 5714, 5721, 5750, 5751, 5752 and 5789 families of Gigabit Ethernet
  66 controller chips.
  67 .Pp
  68 All of these NICs are capable of 10, 100 and 1000Mbps speeds over CAT5
  69 copper cable, except for the SysKonnect SK-9D41 which supports only
  70 1000Mbps over multimode fiber.
  71 The BCM570x builds upon the technology of the Alteon Tigon II.
  72 It has two R4000 CPU cores and is PCI v2.2 and PCI-X v1.0 compliant.
  73 It supports IP, TCP
  74 and UDP checksum offload for both receive and transmit,
  75 multiple RX and TX DMA rings for QoS applications, rules-based
  76 receive filtering, and VLAN tag stripping/insertion as well as
  77 a 256-bit multicast hash filter.
  78 Additional features may be
  79 provided via value-add firmware updates.
  80 The BCM570x supports TBI (ten bit interface) and GMII
  81 transceivers, which means it can be used with either copper or 1000baseX
  82 fiber applications.
  83 Note however the device only supports a single
  84 speed in TBI mode.
  85 .Pp
  86 Most BCM5700-based cards also use the Broadcom BCM5401 or BCM5411 10/100/1000
  87 copper gigabit transceivers,
  88 which support autonegotiation of 10, 100 and 1000Mbps modes in
  89 full or half duplex.
  90 .Pp
  91 The BCM5700, BCM5701, BCM5703, BCM5704, BCM5714 and BCM5780 also support
  92 jumbo frames, which can be configured
  93 via the interface MTU setting.
  94 Selecting an MTU larger than 1500 bytes with the
  95 .Xr ifconfig 8
  96 utility configures the adapter to receive and transmit jumbo frames.
  97 Using jumbo frames can greatly improve performance for certain tasks,
  98 such as file transfers and data streaming.
  99 .Pp
 100 The
 101 .Nm
 102 driver supports the following media types:
 103 .Bl -tag -width ".Cm 10baseT/UTP"
 104 .It Cm autoselect
 105 Enable autoselection of the media type and options.
 106 The user can manually override
 107 the autoselected mode by adding media options to
 108 .Xr rc.conf 5 .
 109 .It Cm 10baseT/UTP
 110 Set 10Mbps 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 100baseTX
 120 Set 100Mbps (Fast Ethernet) operation.
 121 The
 122 .Xr ifconfig 8
 123 .Ic mediaopt
 124 option can also be used to select either
 125 .Cm full-duplex
 126 or
 127 .Cm half-duplex
 128 modes.
 129 .It Cm 1000baseTX
 130 Set 1000baseTX operation over twisted pair.
 131 Only
 132 .Cm full-duplex
 133 mode is supported.
 134 .It Cm 1000baseSX
 135 Set 1000Mbps (Gigabit Ethernet) operation.
 136 Both
 137 .Cm full-duplex
 138 and
 139 .Cm half-duplex
 140 modes are supported.
 141 .El
 142 .Pp
 143 The
 144 .Nm
 145 driver supports the following media options:
 146 .Bl -tag -width ".Cm full-duplex"
 147 .It Cm full-duplex
 148 Force full duplex operation.
 149 .It Cm half-duplex
 150 Force half duplex operation.
 151 .El
 152 .Pp
 153 The
 154 .Nm
 155 driver also supports one special link option for 1000baseTX cards:
 156 .Bl -tag -width ".Cm link0"
 157 .It Cm link0
 158 With 1000baseTX cards, establishing a link between two ports requires
 159 that one port be configured as a master and the other a slave.
 160 With autonegotiation,
 161 the master/slave settings will be chosen automatically.
 162 However when manually selecting the link state, it is necessary to
 163 force one side of the link to be a master and the other a slave.
 164 The
 165 .Nm
 166 driver configures the ports as slaves by default.
 167 Setting the
 168 .Cm link0
 169 flag with
 170 .Xr ifconfig 8
 171 will set a port as a master instead.
 172 .El
 173 .Pp
 174 For more information on configuring this device, see
 175 .Xr ifconfig 8 .
 176 .Sh HARDWARE
 177 The
 178 .Nm
 179 driver provides support for various NICs based on the Broadcom BCM570x
 180 family of Gigabit Ethernet controller chips, including the
 181 following:
 182 .Pp
 183 .Bl -bullet -compact
 184 .It
 185 3Com 3c996-T (10/100/1000baseTX)
 186 .It
 187 Dell PowerEdge 1750 integrated BCM5704C NIC (10/100/1000baseTX)
 188 .It
 189 Dell PowerEdge 2550 integrated BCM5700 NIC (10/100/1000baseTX)
 190 .It
 191 Dell PowerEdge 2650 integrated BCM5703 NIC (10/100/1000baseTX)
 192 .It
 193 IBM x235 server integrated BCM5703x NIC (10/100/1000baseTX)
 194 .It
 195 HP Compaq dc7600 integrated BCM5752 NIC (10/100/1000baseTX)
 196 .It
 197 HP ProLiant NC7760 embedded Gigabit NIC (10/100/1000baseTX)
 198 .It
 199 HP ProLiant NC7770 PCI-X Gigabit NIC (10/100/1000baseTX)
 200 .It
 201 HP ProLiant NC7771 PCI-X Gigabit NIC (10/100/1000baseTX)
 202 .It
 203 HP ProLiant NC7781 embedded PCI-X Gigabit NIC (10/100/1000baseTX)
 204 .It
 205 Netgear GA302T (10/100/1000baseTX)
 206 .It
 207 SysKonnect SK-9D21 (10/100/1000baseTX)
 208 .It
 209 SysKonnect SK-9D41 (1000baseSX)
 210 .El
 211 .Sh DIAGNOSTICS
 212 .Bl -diag
 213 .It "bge%d: couldn't map memory"
 214 A fatal initialization error has occurred.
 215 .It "bge%d: couldn't map ports"
 216 A fatal initialization error has occurred.
 217 .It "bge%d: couldn't map interrupt"
 218 A fatal initialization error has occurred.
 219 .It "bge%d: no memory for softc struct!"
 220 The driver failed to allocate memory for per-device instance information
 221 during initialization.
 222 .It "bge%d: failed to enable memory mapping!"
 223 The driver failed to initialize PCI shared memory mapping.
 224 This might
 225 happen if the card is not in a bus-master slot.
 226 .It "bge%d: no memory for jumbo buffers!"
 227 The driver failed to allocate memory for jumbo frames during
 228 initialization.
 229 .It "bge%d: watchdog timeout"
 230 The device has stopped responding to the network, or there is a problem with
 231 the network connection (cable).
 232 .El
 233 .Sh SEE ALSO
 234 .Xr arp 4 ,
 235 .Xr miibus 4 ,
 236 .Xr netintro 4 ,
 237 .Xr ng_ether 4 ,
 238 .Xr polling 4 ,
 239 .Xr vlan 4 ,
 240 .Xr ifconfig 8
 241 .Sh HISTORY
 242 The
 243 .Nm
 244 device driver first appeared in
 245 .Fx 4.5 .
 246 .Sh AUTHORS
 247 The
 248 .Nm
 249 driver was written by
 250 .An Bill Paul Aq wpaul@windriver.com .