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: src/share/man/man4/bge.4,v 1.1.2.4 2003/02/17 21:20:39 trhodes Exp $
  33 .\"
  34 .Dd October 20, 2015
  35 .Dt BGE 4
  36 .Os
  37 .Sh NAME
  38 .Nm bge
  39 .Nd "Broadcom BCM570x PCI gigabit ethernet adapter driver"
  40 .Sh SYNOPSIS
  41 .Cd "device miibus"
  42 .Cd "device bge"
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 driver provides support for various NICs based on the Broadcom BCM570x
  47 family of gigabit ethernet controller chips, including the
  48 following:
  49 .Pp
  50 .Bl -bullet -compact
  51 .It
  52 3Com 3c996-T (10/100/1000baseT)
  53 .It
  54 Dell PowerEdge 2550 integrated BCM5700 NIC (10/100/1000baseT)
  55 .It
  56 Netgear GA302T (10/100/1000baseT)
  57 .It
  58 SysKonnect SK-9D21 (10/100/1000baseT)
  59 .It
  60 SysKonnect SK-9D41 (1000baseSX)
  61 .El
  62 .Pp
  63 All of these NICs are capable of 10, 100 and 1000Mbps speeds over CAT5
  64 copper cable, except for the SysKonnect SK-9D41 which supports only
  65 1000Mbps over multimode fiber.
  66 The BCM570x builds upon the technology of the Alteon Tigon II.
  67 It has two R4000 CPU cores and is PCI v2.2 and PCI-X v1.0 compliant.
  68 It supports IP, TCP
  69 and UDP checksum offload for both receive and transmit,
  70 multiple RX and TX DMA rings for QoS applications, rules-based
  71 receive filtering, and VLAN tag stripping/insertion as well as
  72 a 256-bit multicast hash filter.
  73 Additional features may be
  74 provided via value-add firmware updates.
  75 The BCM570x supports TBI (ten bit interface) and GMII
  76 transceivers, which means it can be used with either copper or 1000baseX
  77 fiber applications.
  78 Note however the device only supports a single
  79 speed in TBI mode.
  80 .Pp
  81 Most cards also use the Broadcom BCM5401 or BCM5411 10/100/1000
  82 copper gigabit transceivers,
  83 which support autonegotiation of 10, 100 and 1000mbps modes in
  84 full or half duplex.
  85 .Pp
  86 The BCM5700 also supports 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 1000baseT
 124 Set 1000baseT operation over twisted pair.
 125 .Cm full-duplex
 126 and
 127 .Cm half-duplex
 128 modes are supported.
 129 .It Cm 1000baseSX
 130 Set 1000Mbps (gigabit ethernet) operation.
 131 Both
 132 .Cm full-duplex
 133 and
 134 .Cm half-duplex
 135 modes are supported.
 136 .El
 137 .Pp
 138 The
 139 .Nm
 140 driver supports the following media options:
 141 .Bl -tag -width ".Cm full-duplex"
 142 .It Cm full-duplex
 143 Force full duplex operation.
 144 .It Cm half-duplex
 145 Force half duplex operation.
 146 .El
 147 .Pp
 148 The
 149 .Nm
 150 driver also supports one special link option for 1000baseT cards:
 151 .Bl -tag -width ".Cm link0"
 152 .It Cm link0
 153 With 1000baseT cards, establishing a link between two ports requires
 154 that one port be configured as a master and the other a slave.
 155 With autonegotiation,
 156 the master/slave settings will be chosen automatically.
 157 However when manually selecting the link state, it is necessary to
 158 force one side of the link to be a master and the other a slave.
 159 The
 160 .Nm
 161 driver configures the ports as slaves by default.
 162 Setting the
 163 .Cm link0
 164 flag with
 165 .Xr ifconfig 8
 166 will set a port as a master instead.
 167 .El
 168 .Pp
 169 For more information on configuring this device, see
 170 .Xr ifconfig 8 .
 171 The
 172 .Nm
 173 driver supports
 174 .Xr polling 4 .
 175 .Sh LOADER TUNABLES
 176 .Bl -tag -width indent
 177 .It Va hw.iwn.msi.enable
 178 By default, the driver will use MSI if it is supported.
 179 This behavior can be turned off by setting this tunable to 0.
 180 .It Va hw.bge.fake_autoneg
 181 Set to 1 for some
 182 .Tn IBM
 183 blade servers,
 184 if auto-negotiation between the onboard
 185 .Nm
 186 and the switch module is broken.
 187 Disabled by default.
 188 .El
 189 .Sh DIAGNOSTICS
 190 .Bl -diag
 191 .It "bge%d: couldn't map memory"
 192 A fatal initialization error has occurred.
 193 .It "bge%d: couldn't map ports"
 194 A fatal initialization error has occurred.
 195 .It "bge%d: couldn't map interrupt"
 196 A fatal initialization error has occurred.
 197 .It "bge%d: no memory for softc struct!"
 198 The driver failed to allocate memory for per-device instance information
 199 during initialization.
 200 .It "bge%d: failed to enable memory mapping!"
 201 The driver failed to initialize PCI shared memory mapping.
 202 This might
 203 happen if the card is not in a bus-master slot.
 204 .It "bge%d: no memory for jumbo buffers!"
 205 The driver failed to allocate memory for jumbo frames during
 206 initialization.
 207 .It "bge%d: watchdog timeout"
 208 The device has stopped responding to the network, or there is a problem with
 209 the network connection (cable).
 210 .El
 211 .Sh SEE ALSO
 212 .Xr arp 4 ,
 213 .Xr ifmedia 4 ,
 214 .Xr miibus 4 ,
 215 .Xr netintro 4 ,
 216 .Xr ng_ether 4 ,
 217 .Xr polling 4 ,
 218 .Xr vlan 4 ,
 219 .Xr ifconfig 8
 220 .Sh HISTORY
 221 The
 222 .Nm
 223 device driver first appeared in
 224 .Fx 4.5 .
 225 .Sh AUTHORS
 226 The
 227 .Nm
 228 driver was written by
 229 .An Bill Paul Aq Mt wpaul@windriver.com .