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: src/share/man/man4/bce.4,v 1.7 2007/02/09 18:26:13 brueffer Exp $
  30 .\"
  31 .Dd April 7, 2012
  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 .Dx :
  66 .Pp
  67 .Bl -item -offset indent -compact
  68 .It
  69 .\"IP/TCP/UDP checksum offload
  70 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 1000baseT
 113 Set 1000baseT 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 The
 132 .Nm
 133 driver supports
 134 .Xr polling 4 .
 135 .Sh TUNABLES
 136 .Bl -tag -width ".Va hw.bce.tx_ticks_int"
 137 .It Va hw.bce.tx_bds
 138 Maximum number of sending BDs which must be processed by the device
 139 before the device updates the status block and generates interrupt.
 140 It is used together with
 141 .Va hw.bce.tx_ticks
 142 to achieve TX interrupt moderation.
 143 Default value is 24.
 144 .It Va hw.bce.tx_bds_int
 145 Maximum number of sending BDs which must be processed by the device
 146 before the device updates the status block
 147 during host interrupt processing.
 148 Default value is 20.
 149 .It Va hw.bce.tx_ticks
 150 How often status block should be updated and interrupt should be generated
 151 by the device,
 152 due to sending packets.
 153 It is used together with
 154 .Va hw.bce.tx_bds
 155 to achieve TX interrupt moderation.
 156 Default value is 1000 (microseconds).
 157 .It Va hw.bce.tx_ticks_int
 158 How often status block should be updated by the device
 159 during host interrupt processing,
 160 due to sending packets.
 161 Default value is 80 (microseconds).
 162 .It Va hw.bce.rx_bds
 163 Maximum number of BDs which must be received by the device
 164 before the device updates the status block and generates interrupt.
 165 It is used together with
 166 .Va hw.bce.rx_ticks
 167 to achieve RX interrupt moderation.
 168 Default value is 24.
 169 .It Va hw.bce.rx_bds_int
 170 Maximum number of BDs which must be received by the device
 171 before the device updates the status block
 172 during host interrupt processing.
 173 Default value is 6.
 174 .It Va hw.bce.rx_ticks
 175 How often status block should be updated and interrupt should be generated
 176 by the device,
 177 due to receiving packets.
 178 It is used together with
 179 .Va hw.bce.rx_bds
 180 to achieve RX interrupt moderation.
 181 Default value is 100 (microseconds).
 182 .It Va hw.bce.rx_ticks_int
 183 How often status block should be updated by the device
 184 during host interrupt processing,
 185 due to receiving packets.
 186 Default value is 18 (microseconds).
 187 .It Va hw.bce.msi.enable
 188 By default, the driver will use MSI if it is supported.
 189 This behavior can be turned off by setting this tunable to 0.
 190 .El
 191 .Sh HARDWARE
 192 The
 193 .Nm
 194 driver provides support for various NICs based on the Broadcom NetXtreme II
 195 family of Gigabit Ethernet controllers, including the
 196 following:
 197 .Pp
 198 .Bl -bullet -compact
 199 .It
 200 HP NC370T Multifunction Gigabit Server Adapter
 201 .It
 202 HP NC370i Multifunction Gigabit Server Adapter
 203 .El
 204 .Sh DIAGNOSTICS
 205 .Bl -diag
 206 .It "bce%d: PCI memory allocation failed!"
 207 The driver has encountered a fatal initialization error.
 208 .It "bce%d: PCI map interrupt failed!"
 209 The driver has encountered a fatal initialization error.
 210 .It "bce%d: Unsupported controller revision (%c%d)"
 211 The driver does not support the controller revision in use.
 212 .It "bce%d: Controller initialization failed!"
 213 The driver has encountered a fatal initialization error.
 214 .It "bce%d: NVRAM test failed!"
 215 The driver could not access the controller NVRAM correctly.
 216 .It "bce%d: DMA resource allocation failed!"
 217 The driver could not allocate DMA memory to setup the controllers
 218 host memory data structures.
 219 .It "bce%d: Interface allocation failed!"
 220 The driver could not create a network interface for the controller.
 221 .It "bce%d: PHY probe failed!"
 222 The driver could not access the PHY used by the controller.
 223 .It "bce%d: Failed to setup IRQ!"
 224 The driver could not initialize the IRQ handler.
 225 .It "bce%d: Error: PHY read timeout!"
 226 The driver could not read a PHY register before the timeout period expired.
 227 .It "bce%d: PHY write timeout!"
 228 The driver could not write to the PHY register because a timeout occurred.
 229 .It "bce%d: Timeout error reading NVRAM at offset 0x%08X!"
 230 The driver could not write to NVRAM because a timeout occurred.
 231 .It "bce%d: Unknown Flash NVRAM found!"
 232 The driver does not recognize the NVRAM device being used and therefore
 233 cannot access it correctly.
 234 .It "bce%d: Invalid NVRAM magic value!"
 235 The driver cannot read NVRAM or the NVRAM is corrupt.
 236 .It "bce%d: Invalid Manufacturing Information NVRAM CRC!"
 237 The driver cannot read NVRAM or the NVRAM is corrupt.
 238 .It "bce%d: Invalid Feature Configuration Information NVRAM CRC!"
 239 The driver cannot read NVRAM or the NVRAM is corrupt.
 240 .It "bce%d: DMA mapping error!"
 241 The driver was unable to map memory into DMA addressable space required
 242 by the controller.
 243 .It "bce%d: Could not allocate parent DMA tag!"
 244 The driver could not allocate a PCI compatible DMA tag.
 245 .It "bce%d: Could not allocate status block DMA tag!"
 246 The driver could not allocate a DMA tag for the controller's
 247 status block.
 248 .It "bce%d: Could not allocate status block DMA memory!"
 249 The driver could not allocate DMA addressable memory for the controller's
 250 status block.
 251 .It "bce_d: Could not map status block DMA memory!"
 252 The driver could not map the status block memory into the controller's DMA
 253 address space.
 254 .It "bce%d: Could not allocate statistics block DMA tag!"
 255 The driver could not allocate a DMA tag for the controller's
 256 statistics block.
 257 .It "bce%d: Could not allocate statistics block DMA memory!"
 258 The driver could not allocate DMA addressable memory for the controller's
 259 statistics block.
 260 .It "bce%d: Could not map statistics block DMA memory!"
 261 The driver could not map the statistics block memory into the controller's DMA
 262 address space.
 263 .It "bce%d: Could not allocate TX descriptor chain DMA tag!"
 264 The driver could not allocate a DMA tag for the controller's
 265 TX chain.
 266 .It "bce%d: Could not allocate TX descriptor chain DMA memory!"
 267 The driver could not allocate DMA addressable memory for the controller's
 268 TX chain.
 269 .It "bce%d: Could not map TX descriptor chain DMA memory!"
 270 The driver could not map the TX descriptor chain memory into the controller's DMA
 271 address space.
 272 .It "bce%d: Could not allocate TX mbuf DMA tag!"
 273 The driver could not allocate a DMA tag for the controller's
 274 TX mbuf memory.
 275 .It "bce%d: Unable to create TX mbuf DMA map!"
 276 The driver could not map the TX mbuf memory into the controller's DMA
 277 address space.
 278 .It "bce%d: Could not allocate RX descriptor chain DMA tag!"
 279 The driver could not allocate a DMA tag for the controller's
 280 RX chain.
 281 .It "bce%d: Could not allocate RX descriptor chain "
 282 The driver could not allocate DMA addressable memory for the controller's
 283 RX chain.
 284 .It "bce%d: Could not map RX descriptor chain DMA memory!"
 285 The driver could not map the RX descriptor chain memory into the controller's DMA
 286 address space.
 287 .It "bce%d: Could not allocate RX mbuf DMA tag!"
 288 The driver could not allocate a DMA tag for the controller's
 289 RX mbuf memory.
 290 .It "bce%d: Unable to create RX mbuf DMA map!"
 291 The driver could not map the RX mbuf memory into the controller's DMA
 292 address space.
 293 .It "bce%d: Firmware synchronization timeout!"
 294 The driver was not able to synchronize with the firmware running on the
 295 controller.
 296 The firmware may be stopped or hung.
 297 .It "bce%d: Invalid Ethernet address!"
 298 The driver was not able to read a valid Ethernet MAC address from NVRAM.
 299 .It "bce%d: Reset failed!"
 300 The driver has encountered a fatal initialization error.
 301 .It "bce%d: Byte swap is incorrect!"
 302 The driver has encountered a fatal initialization error.
 303 Contact the author
 304 with details of the CPU architecture and system chipset in use.
 305 .It "bce%d: Firmware did not complete initialization!"
 306 The driver has encountered a fatal initialization error.
 307 .It "bce%d: Bootcode not running!"
 308 The driver has encountered a fatal initialization error.
 309 .It "bce%d: Error mapping mbuf into RX chain!"
 310 The driver could not map a RX mbuf into DMA addressable memory.
 311 .It "bce%d: Error filling RX chain: rx_bd[0x%04X]!"
 312 The driver was unable to allocate enough mbufs to fill the RX chain
 313 during initialization.
 314 Try increasing the number of mbufs available in
 315 the system, increase system memory.
 316 .\"or if using jumbo frames, make sure enough 9KB mbufs are available.
 317 .It "bce%d: Failed to allocate new mbuf, incoming frame dropped!"
 318 The driver was unable to allocate a new mbuf for the RX chain and reused
 319 the mbuf for the received frame, dropping the incoming frame in the process.
 320 Try increasing the number of mbufs available in the system or increase system
 321 memory.
 322 .It "bce%d: Controller reset failed!"
 323 A fatal initialization error has occurred.
 324 .It "bce%d: Controller initialization failed!"
 325 A fatal initialization error has occurred.
 326 .It "bce%d: Block initialization failed!"
 327 A fatal initialization error has occurred.
 328 .It "bce%d: Error mapping mbuf into TX chain!"
 329 The driver could not map a TX mbuf into DMA addressable memory.
 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 ifmedia 4 ,
 341 .Xr miibus 4 ,
 342 .Xr netintro 4 ,
 343 .Xr ng_ether 4 ,
 344 .Xr polling 4 ,
 345 .Xr vlan 4 ,
 346 .Xr ifconfig 8
 347 .Sh HISTORY
 348 The
 349 .Nm
 350 device driver first appeared in
 351 .Fx 6.1 .
 352 .Sh AUTHORS
 353 The
 354 .Nm
 355 driver was written by
 356 .An David Christensen Aq davidch@broadcom.com .