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 June 24, 2007
  32 .Dt BCE 4
  33 .Os
  34 .Sh NAME
  35 .Nm bce
  36 .Nd "Broadcom NetXtreme II (BCM5706/BCM5708) 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 and BCM5708 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 The following features are supported in the
  63 .Nm
  64 driver under
  65 .Fx :
  66 .Pp
  67 .Bl -item -offset indent -compact
  68 .It
  69 IP/TCP/UDP checksum offload
  70 .It
  71 Jumbo frames (up to 9022 bytes)
  72 .It
  73 VLAN tag stripping
  74 .It
  75 Interrupt coalescing
  76 .It
  77 10/100/1000Mbps operation in full-duplex mode
  78 .It
  79 10/100Mbps operation in half-duplex mode
  80 .El
  81 .Pp
  82 The
  83 .Nm
  84 driver supports the following media types:
  85 .Bl -tag -width ".Cm 10baseT/UTP"
  86 .It Cm autoselect
  87 Enable autoselection of the media type and options.
  88 The user can manually override
  89 the autoselected mode by adding media options to
  90 .Xr rc.conf 5 .
  91 .It Cm 10baseT/UTP
  92 Set 10Mbps operation.
  93 The
  94 .Xr ifconfig 8
  95 .Cm mediaopt
  96 option can also be used to select either
  97 .Cm full-duplex
  98 or
  99 .Cm half-duplex
 100 modes.
 101 .It Cm 100baseTX
 102 Set 100Mbps (Fast Ethernet) operation.
 103 The
 104 .Xr ifconfig 8
 105 .Cm mediaopt
 106 option can also be used to select either
 107 .Cm full-duplex
 108 or
 109 .Cm half-duplex
 110 modes.
 111 .It Cm 1000baseTX
 112 Set 1000baseTX operation over twisted pair.
 113 Only
 114 .Cm full-duplex
 115 mode is supported.
 116 .El
 117 .Pp
 118 The
 119 .Nm
 120 driver supports the following media options:
 121 .Bl -tag -width ".Cm full-duplex"
 122 .It Cm full-duplex
 123 Force full duplex operation.
 124 .It Cm half-duplex
 125 Force half duplex operation.
 126 .El
 127 .Pp
 128 For more information on configuring this device, see
 129 .Xr ifconfig 8 .
 130 .Sh HARDWARE
 131 The
 132 .Nm
 133 driver provides support for various NICs based on the Broadcom NetXtreme II
 134 family of Gigabit Ethernet controllers, including the
 135 following:
 136 .Pp
 137 .Bl -bullet -compact
 138 .It
 139 HP NC370T Multifunction Gigabit Server Adapter
 140 .It
 141 HP NC370i Multifunction Gigabit Server Adapter
 142 .El
 143 .Sh SYSCTL VARIABLES
 144 The following variables are available as both
 145 .Xr sysctl 8
 146 variables and
 147 .Xr loader 8
 148 tunables:
 149 .Bl -tag -width indent
 150 .It Va hw.bce.msi_enable
 151 Whether or not MSI support is enabled in the driver.
 152 The default value is 1.
 153 .El
 154 .Sh DIAGNOSTICS
 155 .Bl -diag
 156 .It "bce%d: PCI memory allocation failed!"
 157 The driver has encountered a fatal initialization error.
 158 .It "bce%d: PCI map interrupt failed!"
 159 The driver has encountered a fatal initialization error.
 160 .It "bce%d: Unsupported controller revision (%c%d)"
 161 The driver does not support the controller revision in use.
 162 .It "bce%d: Controller initialization failed!"
 163 The driver has encountered a fatal initialization error.
 164 .It "bce%d: NVRAM test failed!"
 165 The driver could not access the controller NVRAM correctly.
 166 .It "bce%d: DMA resource allocation failed!"
 167 The driver could not allocate DMA memory to setup the controllers
 168 host memory data structures.
 169 .It "bce%d: Interface allocation failed!"
 170 The driver could not create a network interface for the controller.
 171 .It "bce%d: PHY probe failed!"
 172 The driver could not access the PHY used by the controller.
 173 .It "bce%d: Failed to setup IRQ!"
 174 The driver could not initialize the IRQ handler.
 175 .It "bce%d: Error: PHY read timeout!"
 176 The driver could not read a PHY register before the timeout period expired.
 177 .It "bce%d: PHY write timeout!"
 178 The driver could not write to the PHY register because a timeout occurred.
 179 .It "bce%d: Timeout error reading NVRAM at offset 0x%08X!"
 180 The driver could not write to NVRAM because a timeout occurred.
 181 .It "bce%d: Unknown Flash NVRAM found!"
 182 The driver does not recognize the NVRAM device being used and therefore
 183 cannot access it correctly.
 184 .It "bce%d: Invalid NVRAM magic value!"
 185 The driver cannot read NVRAM or the NVRAM is corrupt.
 186 .It "bce%d: Invalid Manufacturing Information NVRAM CRC!"
 187 The driver cannot read NVRAM or the NVRAM is corrupt.
 188 .It "bce%d: Invalid Feature Configuration Information NVRAM CRC!"
 189 The driver cannot read NVRAM or the NVRAM is corrupt.
 190 .It "bce%d: DMA mapping error!"
 191 The driver was unable to map memory into DMA addressable space required
 192 by the controller.
 193 .It "bce%d: Could not allocate parent DMA tag!"
 194 The driver could not allocate a PCI compatible DMA tag.
 195 .It "bce%d: Could not allocate status block DMA tag!"
 196 The driver could not allocate a DMA tag for the controller's
 197 status block.
 198 .It "bce%d: Could not allocate status block DMA memory!"
 199 The driver could not allocate DMA addressable memory for the controller's
 200 status block.
 201 .It "bce_d: Could not map status block DMA memory!"
 202 The driver could not map the status block memory into the controller's DMA
 203 address space.
 204 .It "bce%d: Could not allocate statistics block DMA tag!"
 205 The driver could not allocate a DMA tag for the controller's
 206 statistics block.
 207 .It "bce%d: Could not allocate statistics block DMA memory!"
 208 The driver could not allocate DMA addressable memory for the controller's
 209 statistics block.
 210 .It "bce%d: Could not map statistics block DMA memory!"
 211 The driver could not map the statistics block memory into the controller's DMA
 212 address space.
 213 .It "bce%d: Could not allocate TX descriptor chain DMA tag!"
 214 The driver could not allocate a DMA tag for the controller's
 215 TX chain.
 216 .It "bce%d: Could not allocate TX descriptor chain DMA memory!
 217 The driver could not allocate DMA addressable memory for the controller's
 218 TX chain.
 219 .It "bce%d: Could not map TX descriptor chain DMA memory!"
 220 The driver could not map the TX descriptor chain memory into the controller's DMA
 221 address space.
 222 .It "bce%d: Could not allocate TX mbuf DMA tag!"
 223 The driver could not allocate a DMA tag for the controller's
 224 TX mbuf memory.
 225 .It "bce%d: Unable to create TX mbuf DMA map!"
 226 The driver could not map the TX mbuf memory into the controller's DMA
 227 address space.
 228 .It "bce%d: Could not allocate RX descriptor chain DMA tag!"
 229 The driver could not allocate a DMA tag for the controller's
 230 RX chain.
 231 .It "bce%d: Could not allocate RX descriptor chain "
 232 The driver could not allocate DMA addressable memory for the controller's
 233 RX chain.
 234 .It "bce%d: Could not map RX descriptor chain DMA memory!"
 235 The driver could not map the RX descriptor chain memory into the controller's DMA
 236 address space.
 237 .It "bce%d: Could not allocate RX mbuf DMA tag!"
 238 The driver could not allocate a DMA tag for the controller's
 239 RX mbuf memory.
 240 .It "bce%d: Unable to create RX mbuf DMA map!"
 241 The driver could not map the RX mbuf memory into the controller's DMA
 242 address space.
 243 .It "bce%d: Firmware synchronization timeout!"
 244 The driver was not able to synchronize with the firmware running on the
 245 controller.
 246 The firmware may be stopped or hung.
 247 .It "bce%d: Invalid Ethernet address!"
 248 The driver was not able to read a valid Ethernet MAC address from NVRAM.
 249 .It "bce%d: Reset failed!"
 250 The driver has encountered a fatal initialization error.
 251 .It "bce%d: Byte swap is incorrect!"
 252 The driver has encountered a fatal initialization error.
 253 Contact the author
 254 with details of the CPU architecture and system chipset in use.
 255 .It "bce%d: Firmware did not complete initialization!"
 256 The driver has encountered a fatal initialization error.
 257 .It "bce%d: Bootcode not running!"
 258 The driver has encountered a fatal initialization error.
 259 .It "bce%d: Error mapping mbuf into RX chain!"
 260 The driver could not map a RX mbuf into DMA addressable memory.
 261 .It "bce%d: Error filling RX chain: rx_bd[0x%04X]!"
 262 The driver was unable to allocate enough mbufs to fill the RX chain
 263 during initialization.
 264 Try increasing the number of mbufs available in
 265 the system, increase system memory, or if using jumbo frames, make sure
 266 enough 9KB mbufs are available.
 267 .It "bce%d: Failed to allocate new mbuf, incoming frame dropped!"
 268 The driver was unable to allocate a new mbuf for the RX chain and reused
 269 the mbuf for the received frame, dropping the incoming frame in the process.
 270 Try increasing the number of mbufs available in the system or increase system
 271 memory.
 272 .It "bce%d: Controller reset failed!"
 273 A fatal initialization error has occurred.
 274 .It "bce%d: Controller initialization failed!"
 275 A fatal initialization error has occurred.
 276 .It "bce%d: Block initialization failed!"
 277 A fatal initialization error has occurred.
 278 .It "bce%d: Error mapping mbuf into TX chain!"
 279 The driver could not map a TX mbuf into DMA addressable memory.
 280 .It "bce%d: Error registering poll function!"
 281 The driver received an error while attempting to register the poll function.
 282 .It "bce%d: Changing VLAN_MTU not supported."
 283 Changing the VLAN MTU is not currently supported by the driver.
 284 .It "bce%d: Cannot change VLAN_HWTAGGING while management firmware (ASF/IPMI/UMP) is running!"
 285 Management firmware to support ASF/IPMI/UMP requires that VLAN
 286 tag stripping be enabled in the controller.
 287 .It "bce%d: Changing VLAN_HWTAGGING not supported!"
 288 Disabling VLAN tag stripping is not currently supported by the driver.
 289 .It "bce%d: Watchdog timeout occurred, resetting!"
 290 The device has stopped responding to the network, there is a problem
 291 with the cable connection, or a driver logic problem has occurred..
 292 .It "bce%d: Fatal attention detected: 0x%08X!"
 293 A controller hardware failure has occurred.
 294 If the problem continues replace the controller.
 295 .El
 296 .Sh SEE ALSO
 297 .Xr altq 4 ,
 298 .Xr arp 4 ,
 299 .Xr miibus 4 ,
 300 .Xr netintro 4 ,
 301 .Xr ng_ether 4 ,
 302 .Xr vlan 4 ,
 303 .Xr ifconfig 8
 304 .Sh HISTORY
 305 The
 306 .Nm
 307 device driver first appeared in
 308 .Fx 6.1 .
 309 .Sh AUTHORS
 310 The
 311 .Nm
 312 driver was written by
 313 .An David Christensen Aq davidch@broadcom.com .