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