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