share/man/man4/bce.4

   1 .\" Copyright (c) 2006 Broadcom Corporation
   2 .\"  David Christensen <davidch@broadcom.com>.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\"
   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. Neither the name of Broadcom Corporation nor the name of its contributors
  14 .\"    may be used to endorse or promote products derived from this software
  15 .\"    without specific prior written consent.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS'
  18 .\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
  21 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  22 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  23 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  25 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  27 .\" THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd January 15, 2009
  32 .Dt BCE 4
  33 .Os
  34 .Sh NAME
  35 .Nm bce
  36 .Nd "Broadcom NetXtreme II (BCM5706/5708/5709/5716) PCI/PCIe Gigabit Ethernet adapter driver"
  37 .Sh SYNOPSIS
  38 To compile this driver into the kernel,
  39 place the following lines in your
  40 kernel configuration file:
  41 .Bd -ragged -offset indent
  42 .Cd "device miibus"
  43 .Cd "device bce"
  44 .Ed
  45 .Pp
  46 Alternatively, to load the driver as a
  47 module at boot time, place the following line in
  48 .Xr loader.conf 5 :
  49 .Bd -literal -offset indent
  50 if_bce_load="YES"
  51 .Ed
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 driver supports Broadcom's NetXtreme II product family, including the
  56 BCM5706, BCM5708, BCM5709 and BCM5716 Ethernet controllers.
  57 .Pp
  58 The NetXtreme II product family is composed of various Converged NIC (or CNIC)
  59 Ethernet controllers which support a TCP Offload Engine (TOE), Remote DMA (RDMA),
  60 and iSCSI acceleration, in addition to standard L2 Ethernet traffic, all on the
  61 same controller.
  62 .Pp
  63 The following features are supported in the
  64 .Nm
  65 driver under
  66 .Fx :
  67 .Pp
  68 .Bl -item -offset indent -compact
  69 .It
  70 IP/TCP/UDP checksum offload
  71 .It
  72 Jumbo frames (up to 9022 bytes)
  73 .It
  74 VLAN tag stripping
  75 .It
  76 Interrupt coalescing
  77 .It
  78 10/100/1000Mbps operation in full-duplex mode
  79 .It
  80 10/100Mbps operation in half-duplex mode
  81 .El
  82 .Pp
  83 The
  84 .Nm
  85 driver supports the following media types:
  86 .Bl -tag -width ".Cm 10baseT/UTP"
  87 .It Cm autoselect
  88 Enable autoselection of the media type and options.
  89 The user can manually override
  90 the autoselected mode by adding media options to
  91 .Xr rc.conf 5 .
  92 .It Cm 10baseT/UTP
  93 Set 10Mbps operation.
  94 The
  95 .Xr ifconfig 8
  96 .Cm mediaopt
  97 option can also be used to select either
  98 .Cm full-duplex
  99 or
 100 .Cm half-duplex
 101 modes.
 102 .It Cm 100baseTX
 103 Set 100Mbps (Fast Ethernet) operation.
 104 The
 105 .Xr ifconfig 8
 106 .Cm mediaopt
 107 option can also be used to select either
 108 .Cm full-duplex
 109 or
 110 .Cm half-duplex
 111 modes.
 112 .It Cm 1000baseTX
 113 Set 1000baseTX operation over twisted pair.
 114 Only
 115 .Cm full-duplex
 116 mode is supported.
 117 .El
 118 .Pp
 119 The
 120 .Nm
 121 driver supports the following media options:
 122 .Bl -tag -width ".Cm full-duplex"
 123 .It Cm full-duplex
 124 Force full duplex operation.
 125 .It Cm half-duplex
 126 Force half duplex operation.
 127 .El
 128 .Pp
 129 For more information on configuring this device, see
 130 .Xr ifconfig 8 .
 131 .Sh HARDWARE
 132 The
 133 .Nm
 134 driver provides support for various NICs based on the Broadcom NetXtreme II
 135 family of Gigabit Ethernet controllers, including the
 136 following:
 137 .Pp
 138 .Bl -bullet -compact
 139 .It
 140 Broadcom NetXtreme II BCM5706 1000Base-SX
 141 .It
 142 Broadcom NetXtreme II BCM5706 1000Base-T
 143 .It
 144 Broadcom NetXtreme II BCM5708 1000Base-SX
 145 .It
 146 Broadcom NetXtreme II BCM5708 1000Base-T
 147 .It
 148 Broadcom NetXtreme II BCM5709 1000Base-SX
 149 .It
 150 Broadcom NetXtreme II BCM5709 1000Base-T
 151 .It
 152 Broadcom NetXtreme II BCM5716 1000Base-T
 153 .It
 154 Dell PowerEdge 1950 integrated BCM5708 NIC
 155 .It
 156 Dell PowerEdge 2950 integrated BCM5708 NIC
 157 .It
 158 HP NC370F Multifunction Gigabit Server Adapter
 159 .It
 160 HP NC370T Multifunction Gigabit Server Adapter
 161 .It
 162 HP NC370i Multifunction Gigabit Server Adapter
 163 .It
 164 HP NC371i Multifunction Gigabit Server Adapter
 165 .It
 166 HP NC373F PCIe Multifunc Giga Server Adapter
 167 .It
 168 HP NC373T PCIe Multifunction Gig Server Adapter
 169 .It
 170 HP NC373i Multifunction Gigabit Server Adapter
 171 .It
 172 HP NC373m Multifunction Gigabit Server Adapter
 173 .It
 174 HP NC374m PCIe Multifunction Adapter
 175 .It
 176 HP NC380T PCIe DP Multifunc Gig Server Adapter
 177 .It
 178 HP NC382T PCIe DP Multifunction Gigabit Server Adapter
 179 .It
 180 HP NC382i DP Multifunction Gigabit Server Adapter
 181 .It
 182 HP NC382m DP 1GbE Multifunction BL-c Adapter
 183 .El
 184 .Sh SYSCTL VARIABLES
 185 The following variables are available as both
 186 .Xr sysctl 8
 187 variables and
 188 .Xr loader 8
 189 tunables:
 190 .Bl -tag -width indent
 191 .It Va hw.bce.msi_enable
 192 Whether or not MSI support is enabled in the driver.
 193 The default value is 1.
 194 .El
 195 .Sh DIAGNOSTICS
 196 .Bl -diag
 197 .It "bce%d: PCI memory allocation failed!"
 198 The driver has encountered a fatal initialization error.
 199 .It "bce%d: PCI map interrupt failed!"
 200 The driver has encountered a fatal initialization error.
 201 .It "bce%d: Unsupported controller revision (%c%d)"
 202 The driver does not support the controller revision in use.
 203 .It "bce%d: Controller initialization failed!"
 204 The driver has encountered a fatal initialization error.
 205 .It "bce%d: NVRAM test failed!"
 206 The driver could not access the controller NVRAM correctly.
 207 .It "bce%d: DMA resource allocation failed!"
 208 The driver could not allocate DMA memory to setup the controllers
 209 host memory data structures.
 210 .It "bce%d: Interface allocation failed!"
 211 The driver could not create a network interface for the controller.
 212 .It "bce%d: PHY probe failed!"
 213 The driver could not access the PHY used by the controller.
 214 .It "bce%d: Failed to setup IRQ!"
 215 The driver could not initialize the IRQ handler.
 216 .It "bce%d: Error: PHY read timeout!"
 217 The driver could not read a PHY register before the timeout period expired.
 218 .It "bce%d: PHY write timeout!"
 219 The driver could not write to the PHY register because a timeout occurred.
 220 .It "bce%d: Timeout error reading NVRAM at offset 0x%08X!"
 221 The driver could not write to NVRAM because a timeout occurred.
 222 .It "bce%d: Unknown Flash NVRAM found!"
 223 The driver does not recognize the NVRAM device being used and therefore
 224 cannot access it correctly.
 225 .It "bce%d: Invalid NVRAM magic value!"
 226 The driver cannot read NVRAM or the NVRAM is corrupt.
 227 .It "bce%d: Invalid Manufacturing Information NVRAM CRC!"
 228 The driver cannot read NVRAM or the NVRAM is corrupt.
 229 .It "bce%d: Invalid Feature Configuration Information NVRAM CRC!"
 230 The driver cannot read NVRAM or the NVRAM is corrupt.
 231 .It "bce%d: DMA mapping error!"
 232 The driver was unable to map memory into DMA addressable space required
 233 by the controller.
 234 .It "bce%d: Could not allocate parent DMA tag!"
 235 The driver could not allocate a PCI compatible DMA tag.
 236 .It "bce%d: Could not allocate status block DMA tag!"
 237 The driver could not allocate a DMA tag for the controller's
 238 status block.
 239 .It "bce%d: Could not allocate status block DMA memory!"
 240 The driver could not allocate DMA addressable memory for the controller's
 241 status block.
 242 .It "bce_d: Could not map status block DMA memory!"
 243 The driver could not map the status block memory into the controller's DMA
 244 address space.
 245 .It "bce%d: Could not allocate statistics block DMA tag!"
 246 The driver could not allocate a DMA tag for the controller's
 247 statistics block.
 248 .It "bce%d: Could not allocate statistics block DMA memory!"
 249 The driver could not allocate DMA addressable memory for the controller's
 250 statistics block.
 251 .It "bce%d: Could not map statistics block DMA memory!"
 252 The driver could not map the statistics block memory into the controller's DMA
 253 address space.
 254 .It "bce%d: Could not allocate TX descriptor chain DMA tag!"
 255 The driver could not allocate a DMA tag for the controller's
 256 TX chain.
 257 .It "bce%d: Could not allocate TX descriptor chain DMA memory!
 258 The driver could not allocate DMA addressable memory for the controller's
 259 TX chain.
 260 .It "bce%d: Could not map TX descriptor chain DMA memory!"
 261 The driver could not map the TX descriptor chain memory into the controller's DMA
 262 address space.
 263 .It "bce%d: Could not allocate TX mbuf DMA tag!"
 264 The driver could not allocate a DMA tag for the controller's
 265 TX mbuf memory.
 266 .It "bce%d: Unable to create TX mbuf DMA map!"
 267 The driver could not map the TX mbuf memory into the controller's DMA
 268 address space.
 269 .It "bce%d: Could not allocate RX descriptor chain DMA tag!"
 270 The driver could not allocate a DMA tag for the controller's
 271 RX chain.
 272 .It "bce%d: Could not allocate RX descriptor chain "
 273 The driver could not allocate DMA addressable memory for the controller's
 274 RX chain.
 275 .It "bce%d: Could not map RX descriptor chain DMA memory!"
 276 The driver could not map the RX descriptor chain memory into the controller's DMA
 277 address space.
 278 .It "bce%d: Could not allocate RX mbuf DMA tag!"
 279 The driver could not allocate a DMA tag for the controller's
 280 RX mbuf memory.
 281 .It "bce%d: Unable to create RX mbuf DMA map!"
 282 The driver could not map the RX mbuf memory into the controller's DMA
 283 address space.
 284 .It "bce%d: Firmware synchronization timeout!"
 285 The driver was not able to synchronize with the firmware running on the
 286 controller.
 287 The firmware may be stopped or hung.
 288 .It "bce%d: Invalid Ethernet address!"
 289 The driver was not able to read a valid Ethernet MAC address from NVRAM.
 290 .It "bce%d: Reset failed!"
 291 The driver has encountered a fatal initialization error.
 292 .It "bce%d: Byte swap is incorrect!"
 293 The driver has encountered a fatal initialization error.
 294 Contact the author
 295 with details of the CPU architecture and system chipset in use.
 296 .It "bce%d: Firmware did not complete initialization!"
 297 The driver has encountered a fatal initialization error.
 298 .It "bce%d: Bootcode not running!"
 299 The driver has encountered a fatal initialization error.
 300 .It "bce%d: Error mapping mbuf into RX chain!"
 301 The driver could not map a RX mbuf into DMA addressable memory.
 302 .It "bce%d: Error filling RX chain: rx_bd[0x%04X]!"
 303 The driver was unable to allocate enough mbufs to fill the RX chain
 304 during initialization.
 305 Try increasing the number of mbufs available in
 306 the system, increase system memory, or if using jumbo frames, make sure
 307 enough 9KB mbufs are available.
 308 .It "bce%d: Failed to allocate new mbuf, incoming frame dropped!"
 309 The driver was unable to allocate a new mbuf for the RX chain and reused
 310 the mbuf for the received frame, dropping the incoming frame in the process.
 311 Try increasing the number of mbufs available in the system or increase system
 312 memory.
 313 .It "bce%d: Controller reset failed!"
 314 A fatal initialization error has occurred.
 315 .It "bce%d: Controller initialization failed!"
 316 A fatal initialization error has occurred.
 317 .It "bce%d: Block initialization failed!"
 318 A fatal initialization error has occurred.
 319 .It "bce%d: Error mapping mbuf into TX chain!"
 320 The driver could not map a TX mbuf into DMA addressable memory.
 321 .It "bce%d: Error registering poll function!"
 322 The driver received an error while attempting to register the poll function.
 323 .It "bce%d: Changing VLAN_MTU not supported."
 324 Changing the VLAN MTU is not currently supported by the driver.
 325 .It "bce%d: Cannot change VLAN_HWTAGGING while management firmware (ASF/IPMI/UMP) is running!"
 326 Management firmware to support ASF/IPMI/UMP requires that VLAN
 327 tag stripping be enabled in the controller.
 328 .It "bce%d: Changing VLAN_HWTAGGING not supported!"
 329 Disabling VLAN tag stripping is not currently supported by the driver.
 330 .It "bce%d: Watchdog timeout occurred, resetting!"
 331 The device has stopped responding to the network, there is a problem
 332 with the cable connection, or a driver logic problem has occurred..
 333 .It "bce%d: Fatal attention detected: 0x%08X!"
 334 A controller hardware failure has occurred.
 335 If the problem continues replace the controller.
 336 .El
 337 .Sh SEE ALSO
 338 .Xr altq 4 ,
 339 .Xr arp 4 ,
 340 .Xr miibus 4 ,
 341 .Xr netintro 4 ,
 342 .Xr ng_ether 4 ,
 343 .Xr vlan 4 ,
 344 .Xr ifconfig 8
 345 .Sh HISTORY
 346 The
 347 .Nm
 348 device driver first appeared in
 349 .Fx 6.1 .
 350 .Sh AUTHORS
 351 The
 352 .Nm
 353 driver was written by
 354 .An David Christensen Aq davidch@broadcom.com .