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 .\" $DragonFly: src/share/man/man4/bce.4,v 1.3 2008/05/29 13:30:15 sephe Exp $
  31 .\"
  32 .Dd May 29, 2008
  33 .Dt BCE 4
  34 .Os
  35 .Sh NAME
  36 .Nm bce
  37 .Nd "Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet adapter driver"
  38 .Sh SYNOPSIS
  39 To compile this driver into the kernel,
  40 place the following lines in your
  41 kernel configuration file:
  42 .Bd -ragged -offset indent
  43 .Cd "device miibus"
  44 .Cd "device bce"
  45 .Ed
  46 .Pp
  47 Alternatively, to load the driver as a
  48 module at boot time, place the following line in
  49 .Xr loader.conf 5 :
  50 .Bd -literal -offset indent
  51 if_bce_load="YES"
  52 .Ed
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 driver supports Broadcom's NetXtreme II product family, including the
  57 BCM5706 and BCM5708 Ethernet controllers.
  58 .Pp
  59 The NetXtreme II product family is composed of various Converged NIC (or CNIC)
  60 Ethernet controllers which support a TCP Offload Engine (TOE), Remote DMA (RDMA),
  61 and iSCSI acceleration, in addition to standard L2 Ethernet traffic, all on the
  62 same controller.
  63 The following features are supported in the
  64 .Nm
  65 driver under
  66 .Dx :
  67 .Pp
  68 .Bl -item -offset indent -compact
  69 .It
  70 .\"IP/TCP/UDP checksum offload
  71 TCP/UDP checksum offload
  72 .\".It
  73 .\"Jumbo frames (up to 9022 bytes)
  74 .It
  75 VLAN tag stripping
  76 .It
  77 Interrupt coalescing
  78 .It
  79 10/100/1000Mbps operation in full-duplex mode
  80 .It
  81 10/100Mbps operation in half-duplex mode
  82 .El
  83 .Pp
  84 The
  85 .Nm
  86 driver supports the following media types:
  87 .Bl -tag -width ".Cm 10baseT/UTP"
  88 .It Cm autoselect
  89 Enable autoselection of the media type and options.
  90 The user can manually override
  91 the autoselected mode by adding media options to
  92 .Xr rc.conf 5 .
  93 .It Cm 10baseT/UTP
  94 Set 10Mbps operation.
  95 The
  96 .Xr ifconfig 8
  97 .Cm 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 100baseTX
 104 Set 100Mbps (Fast Ethernet) operation.
 105 The
 106 .Xr ifconfig 8
 107 .Cm mediaopt
 108 option can also be used to select either
 109 .Cm full-duplex
 110 or
 111 .Cm half-duplex
 112 modes.
 113 .It Cm 1000baseT
 114 Set 1000baseT operation over twisted pair.
 115 Only
 116 .Cm full-duplex
 117 mode is supported.
 118 .El
 119 .Pp
 120 The
 121 .Nm
 122 driver supports the following media options:
 123 .Bl -tag -width ".Cm full-duplex"
 124 .It Cm full-duplex
 125 Force full duplex operation.
 126 .It Cm half-duplex
 127 Force half duplex operation.
 128 .El
 129 .Pp
 130 For more information on configuring this device, see
 131 .Xr ifconfig 8 .
 132 .Sh TUNABLES
 133 .Bl -tag -width ".Va hw.bce.tx_ticks_int"
 134 .It Va hw.bce.tx_bds
 135 Maximum number of sending BDs which must be processed by the device
 136 before the device updates the status block and generates interrupt.
 137 It is used together with
 138 .Va hw.bce.tx_ticks
 139 to achieve TX interrupt moderation.
 140 Default value is 24.
 141 .It Va hw.bce.tx_bds_int
 142 Maximum number of sending BDs which must be processed by the device
 143 before the device updates the status block
 144 during host interrupt processing.
 145 Default value is 20.
 146 .It Va hw.bce.tx_ticks
 147 How often status block should be updated and interrupt should be generated
 148 by the device,
 149 due to sending packets.
 150 It is used together with
 151 .Va hw.bce.tx_bds
 152 to achieve TX interrupt moderation.
 153 Default value is 1000 (microseconds).
 154 .It Va hw.bce.tx_ticks_int
 155 How often status block should be updated by the device
 156 during host interrupt processing,
 157 due to sending packets.
 158 Default value is 80 (microseconds).
 159 .It Va hw.bce.rx_bds
 160 Maximum number of BDs which must be received by the device
 161 before the device updates the status block and generates interrupt.
 162 It is used together with
 163 .Va hw.bce.rx_ticks
 164 to achieve RX interrupt moderation.
 165 Default value is 24.
 166 .It Va hw.bce.rx_bds_int
 167 Maximum number of BDs which must be received by the device
 168 before the device updates the status block
 169 during host interrupt processing.
 170 Default value is 6.
 171 .It Va hw.bce.rx_ticks
 172 How often status block should be updated and interrupt should be generated
 173 by the device,
 174 due to receiving packets.
 175 It is used together with
 176 .Va hw.bce.rx_bds
 177 to achieve RX interrupt moderation.
 178 Default value is 125 (microseconds).
 179 .It Va hw.bce.rx_ticks_int
 180 How often status block should be updated by the device
 181 during host interrupt processing,
 182 due to receiving packets.
 183 Default value is 18 (microseconds).
 184 .El
 185 .Sh HARDWARE
 186 The
 187 .Nm
 188 driver provides support for various NICs based on the Broadcom NetXtreme II
 189 family of Gigabit Ethernet controllers, including the
 190 following:
 191 .Pp
 192 .Bl -bullet -compact
 193 .It
 194 HP NC370T Multifunction Gigabit Server Adapter
 195 .It
 196 HP NC370i Multifunction Gigabit Server Adapter
 197 .El
 198 .Sh DIAGNOSTICS
 199 .Bl -diag
 200 .It "bce%d: PCI memory allocation failed!"
 201 The driver has encountered a fatal initialization error.
 202 .It "bce%d: PCI map interrupt failed!"
 203 The driver has encountered a fatal initialization error.
 204 .It "bce%d: Unsupported controller revision (%c%d)"
 205 The driver does not support the controller revision in use.
 206 .It "bce%d: Controller initialization failed!"
 207 The driver has encountered a fatal initialization error.
 208 .It "bce%d: NVRAM test failed!"
 209 The driver could not access the controller NVRAM correctly.
 210 .It "bce%d: DMA resource allocation failed!"
 211 The driver could not allocate DMA memory to setup the controllers
 212 host memory data structures.
 213 .It "bce%d: Interface allocation failed!"
 214 The driver could not create a network interface for the controller.
 215 .It "bce%d: PHY probe failed!"
 216 The driver could not access the PHY used by the controller.
 217 .It "bce%d: Failed to setup IRQ!"
 218 The driver could not initialize the IRQ handler.
 219 .It "bce%d: Error: PHY read timeout!"
 220 The driver could not read a PHY register before the timeout period expired.
 221 .It "bce%d: PHY write timeout!"
 222 The driver could not write to the PHY register because a timeout occurred.
 223 .It "bce%d: Timeout error reading NVRAM at offset 0x%08X!"
 224 The driver could not write to NVRAM because a timeout occurred.
 225 .It "bce%d: Unknown Flash NVRAM found!"
 226 The driver does not recognize the NVRAM device being used and therefore
 227 cannot access it correctly.
 228 .It "bce%d: Invalid NVRAM magic value!"
 229 The driver cannot read NVRAM or the NVRAM is corrupt.
 230 .It "bce%d: Invalid Manufacturing Information NVRAM CRC!"
 231 The driver cannot read NVRAM or the NVRAM is corrupt.
 232 .It "bce%d: Invalid Feature Configuration Information NVRAM CRC!"
 233 The driver cannot read NVRAM or the NVRAM is corrupt.
 234 .It "bce%d: DMA mapping error!"
 235 The driver was unable to map memory into DMA addressable space required
 236 by the controller.
 237 .It "bce%d: Could not allocate parent DMA tag!"
 238 The driver could not allocate a PCI compatible DMA tag.
 239 .It "bce%d: Could not allocate status block DMA tag!"
 240 The driver could not allocate a DMA tag for the controller's
 241 status block.
 242 .It "bce%d: Could not allocate status block DMA memory!"
 243 The driver could not allocate DMA addressable memory for the controller's
 244 status block.
 245 .It "bce_d: Could not map status block DMA memory!"
 246 The driver could not map the status block memory into the controller's DMA
 247 address space.
 248 .It "bce%d: Could not allocate statistics block DMA tag!"
 249 The driver could not allocate a DMA tag for the controller's
 250 statistics block.
 251 .It "bce%d: Could not allocate statistics block DMA memory!"
 252 The driver could not allocate DMA addressable memory for the controller's
 253 statistics block.
 254 .It "bce%d: Could not map statistics block DMA memory!"
 255 The driver could not map the statistics block memory into the controller's DMA
 256 address space.
 257 .It "bce%d: Could not allocate TX descriptor chain DMA tag!"
 258 The driver could not allocate a DMA tag for the controller's
 259 TX chain.
 260 .It "bce%d: Could not allocate TX descriptor chain DMA memory!
 261 The driver could not allocate DMA addressable memory for the controller's
 262 TX chain.
 263 .It "bce%d: Could not map TX descriptor chain DMA memory!"
 264 The driver could not map the TX descriptor chain memory into the controller's DMA
 265 address space.
 266 .It "bce%d: Could not allocate TX mbuf DMA tag!"
 267 The driver could not allocate a DMA tag for the controller's
 268 TX mbuf memory.
 269 .It "bce%d: Unable to create TX mbuf DMA map!"
 270 The driver could not map the TX mbuf memory into the controller's DMA
 271 address space.
 272 .It "bce%d: Could not allocate RX descriptor chain DMA tag!"
 273 The driver could not allocate a DMA tag for the controller's
 274 RX chain.
 275 .It "bce%d: Could not allocate RX descriptor chain "
 276 The driver could not allocate DMA addressable memory for the controller's
 277 RX chain.
 278 .It "bce%d: Could not map RX descriptor chain DMA memory!"
 279 The driver could not map the RX descriptor chain memory into the controller's DMA
 280 address space.
 281 .It "bce%d: Could not allocate RX mbuf DMA tag!"
 282 The driver could not allocate a DMA tag for the controller's
 283 RX mbuf memory.
 284 .It "bce%d: Unable to create RX mbuf DMA map!"
 285 The driver could not map the RX mbuf memory into the controller's DMA
 286 address space.
 287 .It "bce%d: Firmware synchronization timeout!"
 288 The driver was not able to synchronize with the firmware running on the
 289 controller.
 290 The firmware may be stopped or hung.
 291 .It "bce%d: Invalid Ethernet address!"
 292 The driver was not able to read a valid Ethernet MAC address from NVRAM.
 293 .It "bce%d: Reset failed!"
 294 The driver has encountered a fatal initialization error.
 295 .It "bce%d: Byte swap is incorrect!"
 296 The driver has encountered a fatal initialization error.
 297 Contact the author
 298 with details of the CPU architecture and system chipset in use.
 299 .It "bce%d: Firmware did not complete initialization!"
 300 The driver has encountered a fatal initialization error.
 301 .It "bce%d: Bootcode not running!"
 302 The driver has encountered a fatal initialization error.
 303 .It "bce%d: Error mapping mbuf into RX chain!"
 304 The driver could not map a RX mbuf into DMA addressable memory.
 305 .It "bce%d: Error filling RX chain: rx_bd[0x%04X]!"
 306 The driver was unable to allocate enough mbufs to fill the RX chain
 307 during initialization.
 308 Try increasing the number of mbufs available in
 309 the system, increase system memory.
 310 .\"or if using jumbo frames, make sure enough 9KB mbufs are available.
 311 .It "bce%d: Failed to allocate new mbuf, incoming frame dropped!"
 312 The driver was unable to allocate a new mbuf for the RX chain and reused
 313 the mbuf for the received frame, dropping the incoming frame in the process.
 314 Try increasing the number of mbufs available in the system or increase system
 315 memory.
 316 .It "bce%d: Controller reset failed!"
 317 A fatal initialization error has occurred.
 318 .It "bce%d: Controller initialization failed!"
 319 A fatal initialization error has occurred.
 320 .It "bce%d: Block initialization failed!"
 321 A fatal initialization error has occurred.
 322 .It "bce%d: Error mapping mbuf into TX chain!"
 323 The driver could not map a TX mbuf into DMA addressable memory.
 324 .It "bce%d: Watchdog timeout occurred, resetting!"
 325 The device has stopped responding to the network, there is a problem
 326 with the cable connection, or a driver logic problem has occurred..
 327 .It "bce%d: Fatal attention detected: 0x%08X!"
 328 A controller hardware failure has occurred.
 329 If the problem continues replace the controller.
 330 .El
 331 .Sh SEE ALSO
 332 .Xr altq 4 ,
 333 .Xr arp 4 ,
 334 .Xr ifmedia 4 ,
 335 .Xr miibus 4 ,
 336 .Xr netintro 4 ,
 337 .Xr ng_ether 4 ,
 338 .Xr vlan 4 ,
 339 .Xr ifconfig 8
 340 .Sh HISTORY
 341 The
 342 .Nm
 343 device driver first appeared in
 344 .Fx 6.1 .
 345 .Sh AUTHORS
 346 The
 347 .Nm
 348 driver was written by
 349 .An David Christensen Aq davidch@broadcom.com .