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 4, 2012
  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 1000baseSX
 113 Sets 1000Mbps operation.
 114 Only
 115 .Cm full-duplex
 116 mode is supported at this speed.
 117 .It Cm 1000baseT
 118 Set 1000baseT operation over twisted pair.
 119 Only
 120 .Cm full-duplex
 121 mode is supported.
 122 .It Cm 2500BaseSX
 123 Set 2500Mbps operation.
 124 Only
 125 .Cm full-duplex
 126 mode is supported.
 127 .El
 128 .Pp
 129 The
 130 .Nm
 131 driver supports the following media options:
 132 .Bl -tag -width ".Cm full-duplex"
 133 .It Cm full-duplex
 134 Force full duplex operation.
 135 .It Cm half-duplex
 136 Force half duplex operation.
 137 .El
 138 .Pp
 139 For more information on configuring this device, see
 140 .Xr ifconfig 8 .
 141 .Sh HARDWARE
 142 The
 143 .Nm
 144 driver provides support for various NICs based on the Broadcom NetXtreme II
 145 family of Gigabit Ethernet controllers, including the
 146 following:
 147 .Pp
 148 .Bl -bullet -compact
 149 .It
 150 Broadcom NetXtreme II BCM5706 1000Base-SX
 151 .It
 152 Broadcom NetXtreme II BCM5706 1000Base-T
 153 .It
 154 Broadcom NetXtreme II BCM5708 1000Base-SX
 155 .It
 156 Broadcom NetXtreme II BCM5708 1000Base-T
 157 .It
 158 Broadcom NetXtreme II BCM5709 1000Base-SX
 159 .It
 160 Broadcom NetXtreme II BCM5709 1000Base-T
 161 .It
 162 Broadcom NetXtreme II BCM5716 1000Base-T
 163 .It
 164 Dell PowerEdge 1950 integrated BCM5708 NIC
 165 .It
 166 Dell PowerEdge 2950 integrated BCM5708 NIC
 167 .It
 168 Dell PowerEdge R710 integrated BCM5709 NIC
 169 .It
 170 HP NC370F Multifunction Gigabit Server Adapter
 171 .It
 172 HP NC370T Multifunction Gigabit Server Adapter
 173 .It
 174 HP NC370i Multifunction Gigabit Server Adapter
 175 .It
 176 HP NC371i Multifunction Gigabit Server Adapter
 177 .It
 178 HP NC373F PCIe Multifunc Giga Server Adapter
 179 .It
 180 HP NC373T PCIe Multifunction Gig Server Adapter
 181 .It
 182 HP NC373i Multifunction Gigabit Server Adapter
 183 .It
 184 HP NC373m Multifunction Gigabit Server Adapter
 185 .It
 186 HP NC374m PCIe Multifunction Adapter
 187 .It
 188 HP NC380T PCIe DP Multifunc Gig Server Adapter
 189 .It
 190 HP NC382T PCIe DP Multifunction Gigabit Server Adapter
 191 .It
 192 HP NC382i DP Multifunction Gigabit Server Adapter
 193 .It
 194 HP NC382m DP 1GbE Multifunction BL-c Adapter
 195 .El
 196 .Sh SYSCTL VARIABLES
 197 The following variables are available as both
 198 .Xr sysctl 8
 199 variables and
 200 .Xr loader 8
 201 tunables:
 202 .Bl -tag -width indent
 203 .It Va hw.bce.verbose
 204 Enable/Disable verbose logging and output to the console.
 205 Useful for debugging (default 0).
 206 .It Va hw.bce.msi_enable
 207 Enable/Disable MSI support (default 1).
 208 .It Va hw.bce.tso_enable
 209 Enable/Disable TSO support (default 1).
 210 .It Va hw.bce.strict_rx_mtu
 211 Enable/Disable strict RX frame size checking (default 0).
 212 .It Va hw.bce.hdr_split
 213 Enable/Disable frame header/payload splitting (default 1).
 214 .It Va hw.bce.rx_pages
 215 Set the number of memory pages assigned to recieve packets by the driver.
 216 Due to alignment issues, this value can only be of the set
 217 1, 2, 4 or 8 (default 2).
 218 .It Va hw.bce.tx_pages
 219 Set the number of memory pages assigned to transmit packets
 220 by the driver.
 221 Due to alignment issues, this value can only be of the set
 222 1, 2, 4 or 8 (default 2).
 223 .It Va hw.bce.rx_ticks
 224 Time in microsecond ticks to wait before generating a status
 225 block updates due to RX processing activity.
 226 Values from 0-100 are valid.
 227 A value of 0 disables this status block update.
 228 Cannot be set to 0 if hw.bce.rx_quick_cons_trip is also 0
 229 (default 18).
 230 .It Va hw.bce.rx_ticks_int
 231 Time in microsecond ticks to wait during RX interrupt
 232 processing before generating a status block update.
 233 Values from 0-100 are valid.
 234 Valid values are in the range from 0-100.
 235 A value of 0 disables this status block update (default 18).
 236 .It Va hw.bce.rx_quick_cons_trip
 237 Number of RX Quick BD Chain entries that must be completed
 238 before a status block is generated.
 239 Values from 0-256 are valid.
 240 A value of 0 disables this status block update.
 241 Cannot be set to 0 if hw.bce.rx_ticks is also 0 (default 6).
 242 .It Va hw.bce.rx_quick_cons_trip_int
 243 Number of RX quick BD entries that must be completed before
 244 a status block is generated duing interrupt processing.
 245 Values from 0-256 are valid.
 246 A value of 0 disables this status block update (default 6).
 247 .It Va hw.bce.tx_ticks
 248 Time in microsecond ticks to wait before a status block
 249 update is generated due to TX activitiy.
 250 Values from 0-100 are valid.
 251 A value of 0 disables this status block update.
 252 Cannot be set to 0 if hw.bce.tx_quick_cons_trip is also 0
 253 (default 80).
 254 .It Va hw.bce.tx_ticks_int
 255 Time in microsecond ticks to wait in interrupt processing
 256 before a status block update is generated due to TX activity
 257 Values from 0-100 are valid.
 258 A value of 0 disables this status block update (default 80).
 259 .It Va hw.bce.tx_cons_trip
 260 How many TX Quick BD Chain entries that must be completed
 261 before a status block is generated.
 262 Values from 0-100 are valid.
 263 A value of 0 disables this status block update.
 264 Cannot be set to 0 if hw.bce.tx_ticks is also 0 (default 20).
 265 .It Va hw.bce.tx_cons_trip_int
 266 How many TX Quick BD Chain entries that must be completed
 267 before a status block is generated during an interrupt.
 268 Values from 0-100 are valid.
 269 A value of 0 disables this status block update (default 20).
 270 .El
 271 .Sh DIAGNOSTICS
 272 .Bl -diag
 273 .It "bce%d: PCI memory allocation failed!"
 274 The driver has encountered a fatal initialization error.
 275 .It "bce%d: PCI map interrupt failed!"
 276 The driver has encountered a fatal initialization error.
 277 .It "bce%d: Unsupported controller revision (%c%d)"
 278 The driver does not support the controller revision in use.
 279 .It "bce%d: Controller initialization failed!"
 280 The driver has encountered a fatal initialization error.
 281 .It "bce%d: NVRAM test failed!"
 282 The driver could not access the controller NVRAM correctly.
 283 .It "bce%d: DMA resource allocation failed!"
 284 The driver could not allocate DMA memory to setup the controllers
 285 host memory data structures.
 286 .It "bce%d: Interface allocation failed!"
 287 The driver could not create a network interface for the controller.
 288 .It "bce%d: PHY probe failed!"
 289 The driver could not access the PHY used by the controller.
 290 .It "bce%d: Failed to setup IRQ!"
 291 The driver could not initialize the IRQ handler.
 292 .It "bce%d: Error: PHY read timeout!"
 293 The driver could not read a PHY register before the timeout period expired.
 294 .It "bce%d: PHY write timeout!"
 295 The driver could not write to the PHY register because a timeout occurred.
 296 .It "bce%d: Timeout error reading NVRAM at offset 0x%08X!"
 297 The driver could not write to NVRAM because a timeout occurred.
 298 .It "bce%d: Unknown Flash NVRAM found!"
 299 The driver does not recognize the NVRAM device being used and therefore
 300 cannot access it correctly.
 301 .It "bce%d: Invalid NVRAM magic value!"
 302 The driver cannot read NVRAM or the NVRAM is corrupt.
 303 .It "bce%d: Invalid Manufacturing Information NVRAM CRC!"
 304 The driver cannot read NVRAM or the NVRAM is corrupt.
 305 .It "bce%d: Invalid Feature Configuration Information NVRAM CRC!"
 306 The driver cannot read NVRAM or the NVRAM is corrupt.
 307 .It "bce%d: DMA mapping error!"
 308 The driver was unable to map memory into DMA addressable space required
 309 by the controller.
 310 .It "bce%d: Could not allocate parent DMA tag!"
 311 The driver could not allocate a PCI compatible DMA tag.
 312 .It "bce%d: Could not allocate status block DMA tag!"
 313 The driver could not allocate a DMA tag for the controller's
 314 status block.
 315 .It "bce%d: Could not allocate status block DMA memory!"
 316 The driver could not allocate DMA addressable memory for the controller's
 317 status block.
 318 .It "bce%d: Could not map status block DMA memory!"
 319 The driver could not map the status block memory into the controller's DMA
 320 address space.
 321 .It "bce%d: Could not allocate statistics block DMA tag!"
 322 The driver could not allocate a DMA tag for the controller's
 323 statistics block.
 324 .It "bce%d: Could not allocate statistics block DMA memory!"
 325 The driver could not allocate DMA addressable memory for the controller's
 326 statistics block.
 327 .It "bce%d: Could not map statistics block DMA memory!"
 328 The driver could not map the statistics block memory into the controller's DMA
 329 address space.
 330 .It "bce%d: Could not allocate TX descriptor chain DMA tag!"
 331 The driver could not allocate a DMA tag for the controller's
 332 TX chain.
 333 .It "bce%d: Could not allocate TX descriptor chain DMA memory!"
 334 The driver could not allocate DMA addressable memory for the controller's
 335 TX chain.
 336 .It "bce%d: Could not map TX descriptor chain DMA memory!"
 337 The driver could not map the TX descriptor chain memory into the controller's DMA
 338 address space.
 339 .It "bce%d: Could not allocate TX mbuf DMA tag!"
 340 The driver could not allocate a DMA tag for the controller's
 341 TX mbuf memory.
 342 .It "bce%d: Unable to create TX mbuf DMA map!"
 343 The driver could not map the TX mbuf memory into the controller's DMA
 344 address space.
 345 .It "bce%d: Could not allocate RX descriptor chain DMA tag!"
 346 The driver could not allocate a DMA tag for the controller's
 347 RX chain.
 348 .It "bce%d: Could not allocate RX descriptor chain "
 349 The driver could not allocate DMA addressable memory for the controller's
 350 RX chain.
 351 .It "bce%d: Could not map RX descriptor chain DMA memory!"
 352 The driver could not map the RX descriptor chain memory into the controller's DMA
 353 address space.
 354 .It "bce%d: Could not allocate RX mbuf DMA tag!"
 355 The driver could not allocate a DMA tag for the controller's
 356 RX mbuf memory.
 357 .It "bce%d: Unable to create RX mbuf DMA map!"
 358 The driver could not map the RX mbuf memory into the controller's DMA
 359 address space.
 360 .It "bce%d: Firmware synchronization timeout!"
 361 The driver was not able to synchronize with the firmware running on the
 362 controller.
 363 The firmware may be stopped or hung.
 364 .It "bce%d: Invalid Ethernet address!"
 365 The driver was not able to read a valid Ethernet MAC address from NVRAM.
 366 .It "bce%d: Reset failed!"
 367 The driver has encountered a fatal initialization error.
 368 .It "bce%d: Byte swap is incorrect!"
 369 The driver has encountered a fatal initialization error.
 370 Contact the author
 371 with details of the CPU architecture and system chipset in use.
 372 .It "bce%d: Firmware did not complete initialization!"
 373 The driver has encountered a fatal initialization error.
 374 .It "bce%d: Bootcode not running!"
 375 The driver has encountered a fatal initialization error.
 376 .It "bce%d: Error mapping mbuf into RX chain!"
 377 The driver could not map a RX mbuf into DMA addressable memory.
 378 .It "bce%d: Error filling RX chain: rx_bd[0x%04X]!"
 379 The driver was unable to allocate enough mbufs to fill the RX chain
 380 during initialization.
 381 Try increasing the number of mbufs available in
 382 the system, increase system memory, or if using jumbo frames, make sure
 383 enough 9KB mbufs are available.
 384 .It "bce%d: Failed to allocate new mbuf, incoming frame dropped!"
 385 The driver was unable to allocate a new mbuf for the RX chain and reused
 386 the mbuf for the received frame, dropping the incoming frame in the process.
 387 Try increasing the number of mbufs available in the system or increase system
 388 memory.
 389 .It "bce%d: Controller reset failed!"
 390 A fatal initialization error has occurred.
 391 .It "bce%d: Controller initialization failed!"
 392 A fatal initialization error has occurred.
 393 .It "bce%d: Block initialization failed!"
 394 A fatal initialization error has occurred.
 395 .It "bce%d: Error mapping mbuf into TX chain!"
 396 The driver could not map a TX mbuf into DMA addressable memory.
 397 .It "bce%d: Error registering poll function!"
 398 The driver received an error while attempting to register the poll function.
 399 .It "bce%d: Changing VLAN_MTU not supported."
 400 Changing the VLAN MTU is not currently supported by the driver.
 401 .It "bce%d: Cannot change VLAN_HWTAGGING while management firmware (ASF/IPMI/UMP) is running!"
 402 Management firmware to support ASF/IPMI/UMP requires that VLAN
 403 tag stripping be enabled in the controller.
 404 .It "bce%d: Changing VLAN_HWTAGGING not supported!"
 405 Disabling VLAN tag stripping is not currently supported by the driver.
 406 .It "bce%d: Watchdog timeout occurred, resetting!"
 407 The device has stopped responding to the network, there is a problem
 408 with the cable connection, or a driver logic problem has occurred..
 409 .It "bce%d: Fatal attention detected: 0x%08X!"
 410 A controller hardware failure has occurred.
 411 If the problem continues replace the controller.
 412 .El
 413 .Sh SUPPORT
 414 For general information and support,
 415 go to the Broadcom NIC Open Source Developer Resource Site:
 416 .Pa http://www.broadcom.com/support/ethernet_nic/open_source.php .
 417 .Sh SEE ALSO
 418 .Xr altq 4 ,
 419 .Xr arp 4 ,
 420 .Xr miibus 4 ,
 421 .Xr netintro 4 ,
 422 .Xr ng_ether 4 ,
 423 .Xr vlan 4 ,
 424 .Xr ifconfig 8
 425 .Sh HISTORY
 426 The
 427 .Nm
 428 device driver first appeared in
 429 .Fx 6.1 .
 430 .Sh AUTHORS
 431 The
 432 .Nm
 433 driver was written by
 434 .An David Christensen Aq davidch@broadcom.com .