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 December 15, 2009
  35 .Dt BGE 4
  36 .Os
  37 .Sh NAME
  38 .Nm bge
  39 .Nd "Broadcom BCM570x/5714/5721/5722/5750/5751/5752/5761/5784/5789/57780 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 .Sh DESCRIPTION
  56 The
  57 .Nm
  58 driver provides support for various NICs based on the Broadcom BCM570x,
  59 5714, 5721, 5722, 5750, 5751, 5752, 5761, 5784, 5789 and 57780 families
  60 of Gigabit Ethernet controller chips.
  61 .Pp
  62 All of these NICs are capable of 10, 100 and 1000Mbps speeds over CAT5
  63 copper cable, except for the SysKonnect SK-9D41 which supports only
  64 1000Mbps over multimode fiber.
  65 The BCM570x builds upon the technology of the Alteon Tigon II.
  66 It has two R4000 CPU cores and is PCI v2.2 and PCI-X v1.0 compliant.
  67 It supports IP, TCP
  68 and UDP checksum offload for both receive and transmit,
  69 multiple RX and TX DMA rings for QoS applications, rules-based
  70 receive filtering, and VLAN tag stripping/insertion as well as
  71 a 256-bit multicast hash filter.
  72 Additional features may be
  73 provided via value-add firmware updates.
  74 The BCM570x supports TBI (ten bit interface) and GMII
  75 transceivers, which means it can be used with either copper or 1000baseX
  76 fiber applications.
  77 Note however the device only supports a single
  78 speed in TBI mode.
  79 .Pp
  80 Most BCM5700-based cards also use the Broadcom BCM5401 or BCM5411 10/100/1000
  81 copper gigabit transceivers,
  82 which support autonegotiation of 10, 100 and 1000Mbps modes in
  83 full or half duplex.
  84 .Pp
  85 The BCM5700, BCM5701, BCM5702, BCM5703 and BCM5704 also support
  86 jumbo frames, which can be configured
  87 via the interface MTU setting.
  88 Selecting an MTU larger than 1500 bytes with the
  89 .Xr ifconfig 8
  90 utility configures the adapter to receive and transmit jumbo frames.
  91 Using jumbo frames can greatly improve performance for certain tasks,
  92 such as file transfers and data streaming.
  93 .Pp
  94 The
  95 .Nm
  96 driver supports the following media types:
  97 .Bl -tag -width ".Cm 10baseT/UTP"
  98 .It Cm autoselect
  99 Enable autoselection of the media type and options.
 100 The user can manually override
 101 the autoselected mode by adding media options to
 102 .Xr rc.conf 5 .
 103 .It Cm 10baseT/UTP
 104 Set 10Mbps operation.
 105 The
 106 .Xr ifconfig 8
 107 .Ic mediaopt
 108 option can also be used to select either
 109 .Cm full-duplex
 110 or
 111 .Cm half-duplex
 112 modes.
 113 .It Cm 100baseTX
 114 Set 100Mbps (Fast Ethernet) operation.
 115 The
 116 .Xr ifconfig 8
 117 .Ic mediaopt
 118 option can also be used to select either
 119 .Cm full-duplex
 120 or
 121 .Cm half-duplex
 122 modes.
 123 .It Cm 1000baseTX
 124 Set 1000baseTX operation over twisted pair.
 125 Only
 126 .Cm full-duplex
 127 mode is supported.
 128 .It Cm 1000baseSX
 129 Set 1000Mbps (Gigabit Ethernet) operation.
 130 Both
 131 .Cm full-duplex
 132 and
 133 .Cm half-duplex
 134 modes are supported.
 135 .El
 136 .Pp
 137 The
 138 .Nm
 139 driver supports the following media options:
 140 .Bl -tag -width ".Cm full-duplex"
 141 .It Cm full-duplex
 142 Force full duplex operation.
 143 .It Cm half-duplex
 144 Force half duplex operation.
 145 .El
 146 .Pp
 147 The
 148 .Nm
 149 driver also supports one special link option for 1000baseTX cards:
 150 .Bl -tag -width ".Cm link0"
 151 .It Cm link0
 152 With 1000baseTX cards, establishing a link between two ports requires
 153 that one port be configured as a master and the other a slave.
 154 With autonegotiation,
 155 the master/slave settings will be chosen automatically.
 156 However when manually selecting the link state, it is necessary to
 157 force one side of the link to be a master and the other a slave.
 158 The
 159 .Nm
 160 driver configures the ports as slaves by default.
 161 Setting the
 162 .Cm link0
 163 flag with
 164 .Xr ifconfig 8
 165 will set a port as a master instead.
 166 .El
 167 .Pp
 168 For more information on configuring this device, see
 169 .Xr ifconfig 8 .
 170 .Sh HARDWARE
 171 The
 172 .Nm
 173 driver provides support for various NICs based on the Broadcom BCM570x
 174 family of Gigabit Ethernet controller chips, including the
 175 following:
 176 .Pp
 177 .Bl -bullet -compact
 178 .It
 179 3Com 3c996-SX (1000baseSX)
 180 .It
 181 3Com 3c996-T (10/100/1000baseTX)
 182 .It
 183 Dell PowerEdge 1750 integrated BCM5704C NIC (10/100/1000baseTX)
 184 .It
 185 Dell PowerEdge 2550 integrated BCM5700 NIC (10/100/1000baseTX)
 186 .It
 187 Dell PowerEdge 2650 integrated BCM5703 NIC (10/100/1000baseTX)
 188 .It
 189 Dell PowerEdge R200 integrated BCM5750 NIC (10/100/1000baseTX)
 190 .It
 191 Dell PowerEdge R300 integrated BCM5722 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 LOADER TUNABLES
 212 The following tunable can be set at the
 213 .Xr loader 8
 214 prompt before booting the kernel, or stored in
 215 .Xr loader.conf 5 .
 216 .Bl -tag -width indent
 217 .It Va hw.bge.allow_asf
 218 Allow the ASF feature for cooperating with IPMI.
 219 Can cause system lockup problems on a small number of systems.
 220 Disabled by default.
 221 .El
 222 .Sh DIAGNOSTICS
 223 .Bl -diag
 224 .It "bge%d: couldn't map memory"
 225 A fatal initialization error has occurred.
 226 .It "bge%d: couldn't map ports"
 227 A fatal initialization error has occurred.
 228 .It "bge%d: couldn't map interrupt"
 229 A fatal initialization error has occurred.
 230 .It "bge%d: no memory for softc struct!"
 231 The driver failed to allocate memory for per-device instance information
 232 during initialization.
 233 .It "bge%d: failed to enable memory mapping!"
 234 The driver failed to initialize PCI shared memory mapping.
 235 This might
 236 happen if the card is not in a bus-master slot.
 237 .It "bge%d: no memory for jumbo buffers!"
 238 The driver failed to allocate memory for jumbo frames during
 239 initialization.
 240 .It "bge%d: watchdog timeout"
 241 The device has stopped responding to the network, or there is a problem with
 242 the network connection (cable).
 243 .El
 244 .Sh SEE ALSO
 245 .Xr altq 4 ,
 246 .Xr arp 4 ,
 247 .Xr miibus 4 ,
 248 .Xr netintro 4 ,
 249 .Xr ng_ether 4 ,
 250 .Xr polling 4 ,
 251 .Xr vlan 4 ,
 252 .Xr ifconfig 8
 253 .Sh HISTORY
 254 The
 255 .Nm
 256 device driver first appeared in
 257 .Fx 4.5 .
 258 .Sh AUTHORS
 259 The
 260 .Nm
 261 driver was written by
 262 .An Bill Paul Aq wpaul@windriver.com .