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