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