BCM5700(4) BCM5700(4) NAME bcm5700 - Broadcom NetXtreme BCM5700 series Gigabit Ethernet device driver SYNOPSIS insmod bcm5700.o [line_speed=n,...] [auto_speed=n,...] [full_duplex=n,...] [rx_flow_control=n,...] [tx_flow_control=n,...] [auto_flow_control=n,...] [mtu=n,...] [tx_checksum=n,...] [rx_check- sum=n,...] [scatter_gather=n,...] [nic_tx_bd=n,...] [tx_pkt_desc_cnt=n,...] [rx_std_desc_cnt=n,...] [rx_jumbo_desc_cnt=n,...] [adaptive_coalesce=n,...] [rx_coa- lesce_ticks=n,...] [rx_max_coalesce_frames=n,...] [tx_coa- lesce_ticks=n,...] [tx_max_coalesce_frames=n,...] [stats_coa- lesce_ticks=n,...] [enable_wol=n,...] [enable_tso=n,...] [vlan_tag_mode=n,...] [delay_link=n,...] [disable_d3hot=n,...] DESCRIPTION bcm5700 is the low-level device driver for the Broadcom NetXtreme BCM5700 series PCI/PCI-X and PCI Express Gigabit Ethernet NIC. The driver has been tested on most 2.4.x and 2.6.x kernels up to 2.4.26 and 2.6.7 for i386, ia64, and x86_64 systems. It should also work on other big-endian and little-endian CPU platforms, but only very limited test- ing has been done and minor modifications to the Makefile and source files may be required. The driver supports up to 16 NICs and allocates the next available eth- ernet device (eth0..eth#) for each NIC found. The driver is available as a loadable module or can be compiled into the kernel. The loadable module binary bcm5700.o is installed in the following path: 2.2.x kernels: /lib/modules//net/bcm5700.o 2.4.x kernels: /lib/modules//kernel/drivers/net/bcm5700.o 2.4.x kernels with bcm5700 driver patched in (e.g. Red Hat 7.1, 7.2, 7.3): /lib/modules//kernel/drivers/net/bcm/bcm5700.o or /lib/modules//ker- nel/drivers/addon/bcm5700/bcm5700.o Note: If loading the driver on Red Hat 7.3 or other newer kernels and patches, it may be necessary to unload the tg3 driver first if it is loaded. While tg3 is a fully functioning driver written by Red Hat et al, Broadcom recommends users to use the bcm5700 driver written and tested by Broadcom. Use ifconfig to bring down all eth# interfaces used by tg3 and use rmmod to unload tg3. It may also be necessary to manu- ally edit the file /etc/modules.conf to change interface alias names from tg3 to bcm5700. See the man page for modules.conf for more details. Refer to various Linux documentations on how to configure network pro- tocol and address. PARAMETERS Optional parameters for the driver can be supplied as command line arguments to the insmod command. These parameters can also be set in the file /etc/modules.conf (see the man page for modules.conf). These parameters take the form =n1[,n2,...] where the multiple values n1,n2,... are for multiple NICs installed in the system. Note that default or other meaningful values will be used when invalid values are selected. Some combinations of parameters may conflict and lead to failures. The driver cannot detect all such conflicting combi- nations. All the parameters are listed below. line_speed Selects the line speed of the link. This parameter is used together with full_duplex and auto_speed to select the speed and duplexity of the link and the setting of autonegotiation. The valid values are: 0 Autonegotiate for highest speed supported by link partner (default) 10 10 Mbps 100 100 Mbps 1000 1000 Mbps If line_speed is set to 10, 100, or 1000, the NIC will autonego- tiate for the selected speed (and selected duplexity) if auto_speed is set to 1. If auto_speed is set to 0, the selected speed and duplexity will be set without autonegotiation. Note that 1000 Mbps must be negotiated for copper twisted pair links. auto_speed Enables or disables autonegotiation. The valid values are: 0 Autonegotiation disabled 1 Autonegotiation enabled (default) Note that this parameter is ignored and assumed 1 if line_speed is set to 0. full_duplex Selects the duplexity of the link. This paramter is used together with line_speed to select the speed and duplexity of the link. Note that this parameter is ignored if line_speed is 0. The valid values are: 0 half duplex 1 full duplex (default) rx_flow_control Enables or disables receiving flow control (pause) frames. This parameter is used together with auto_flow_control. The valid values are: 0 pause receive disabled 1 pause receive enabled if auto_flow_control is set to 0, or pause receive advertised if auto_flow_control is set to 1 (default) tx_flow_control Enables or disables transmitting flow control (pause) frames. This parameter is used together with auto_flow_control. The valid values are: 0 pause transmit disabled 1 pause transmit enabled if auto_flow_control is set to 0, or pause transmit advertised if auto_flow_control is set to 1 (default) auto_flow_control Enables or disables autonegotiation of flow control. This param- eter is used together with rx_flow_control and tx_flow_control to determine the advertised flow control capability. The valid values are: 0 flow control autonegotiation disabled 1 flow control autonegotiation enabled with capability specified in rx_flow_control and tx_flow_control (only valid if line_speed is set to 0 or auto_speed is set to 1) (default) mtu Enables jumbo frames up to the specified MTU size. The valid range for this parameter is 1500 to 9000. Default is 1500 which is standard ethernet (non-jumbo) MTU size. Note that the MTU size excludes the ethernet header size of 14 bytes. Actual frame size is MTU size + 14 bytes. Jumbo MTU sizes are not supported on BCM5705 chips. The MTU size can also be changed using ifconfig after the driver is loaded. See the ifconfig man page for details. tx_checksum Enables or disables hardware transmit TCP/UDP checksum. The valid values are: 0 checksum disabled 1 checksum enabled (default) rx_checksum Enables or disables hardware receive TCP/UDP checksum valida- tion. The valid values are: 0 checksum disabled 1 checksum enabled (default) scatter_gather Enables or disables scatter-gather and 64-bit DMA on x86. This option is only useful when running on TUX-enabled kernels or newer kernels with zero-copy TCP. The valid values are: 0 scatter-gather and 64-bit DMA on x86 disabled 1 scatter-gather and 64-bit DMA on x86 enabled (default) nic_tx_bd Enables either NIC based or host based transmit buffer descrip- tors (Tx BDs). NIC based Tx BDs may be slightly faster on cer- tain machines on earlier 2.4 kernels where each transmit packet is usually entirely contiguous. On later kernels with scatter- gather and TCP segmentation option, host based Tx BDs using DMA transfer are usually faster. NIC based Tx BDs are not supported on 5705 family controllers. The valid values are: 0 NIC based transmit buffer descriptors disabled (using host based transmit buffer descriptors) (default) 1 NIC based transmit buffer descriptors enabled (not sup- ported on 5705 family controllers) tx_pkt_desc_cnt Configures the number of transmit descriptors. Default is 120. The valid range is from 1 to 511. Note that the driver may not be able to allocate the required amount of memory if this param- eter is set too high. Depending on kernel and CPU architecture, each descriptor may require up to about 268 bytes. This parame- ter should not be set less than 80 if adaptive_coalesce (see below) is enabled. rx_std_desc_cnt Configures the number of receive descriptors for frames up to 1528 bytes. Default is 200. The valid range is from 1 to 511. This parameter should not be set less than 80 on systems with high network traffic. Setting this parameter higher allows the NIC to buffer larger bursts of network traffic without dropping frames, especially on slower systems. Note that the driver may not be able to allocate the required amount of memory if this parameter is set too high. Depending on kernel and CPU architec- ture, each descriptor may require up to about 268 bytes. Each descriptor also requires a socket buffer of at least 1536 bytes. This parameter should not be set less than 50 if adaptive_coa- lesce (see below) is enabled. rx_jumbo_desc_cnt Configures the number of receive descriptors for jumbo frames larger than 1528 bytes. Default is 128 and valid range is from 1 to 255. When jumbo frames larger than 1528 bytes are used, this parameter should not be set lower than 60 on systems with high network traffic. Setting this parameter higher allows the NIC to buffer larger bursts of jumbo traffic without dropping frames, especially on slower systems. Depending on kernel and CPU archi- tecture, each descriptor may require up to about 268 bytes. Each descriptor also requires a socket buffer the size of a maximum jumbo frame. On systems with insufficient memory, it may be nec- essary to reduce this parameter. This parameter should not be set less than 50 if adaptive_coalesce (see below) is enabled. When the maximum frame size is 1528 or smaller (MTU size 1514 or smaller), this parameter is not used and is always 0. adaptive_coalesce Enables or disables adaptive adjustments to the various inter- rupt coalescing parameters. Enabling it allows the driver to dynamically adjust the interrupt coalescing parameters to achieve high throughput during heavy traffic and low latency during light traffic. rx_std_desc_cnt, (and rx_jumbo_desc_cnt if using jumbo frames) should not be set less than 50, and tx_pkt_desc_cnt should not be set less than 80 when this parame- ter is enabled. Note that if the kernel supports the NAPI receive polling mode, interrupt coalescing will be handled in a different way and this parameter will not be used. The valid values are: 0 disabled (always disabled in NAPI mode) 1 enabled (default) rx_coalesce_ticks Configures the number of 1 usec ticks before the NIC generates receive interrupt after receiving a frame. This parameter works in conjunction with the rx_max_coalesce_frames parameter. Inter- rupt will be generated when either of these thresholds is exceeded. 0 means this parameter is ignored and interrupt will be generated when the rx_max_coalesce_frames threshold is reached. The valid range is from 0 to 500, and default is 60 (18 if using NAPI mode). This parameter is not used and will be adjusted automatically if adaptive_coalesce is set to 1. rx_max_coalesce_frames Configures the number of received frames before the NIC gener- ates receive interrupt. The valid range is from 0 to 100, and default is 15 (6 if using NAPI mode). This parameter and rx_coa- lesce_ticks cannot be both 0, otherwise no receive interrupts will be generated. It should also be set lower than rx_std_desc_cnt (and rx_jumbo_desc_cnt if using jumbo frames). This parameter is not used and will be adjusted automatically if adaptive_coalesce is set to 1. tx_coalesce_ticks Configures the number of 1 usec ticks before the NIC generates transmit interrupt after transmitting a frame. This parameter works in conjunction with the tx_max_coalesce_frames parameter. Interrupt will be generated when either of these thresholds is exceeded. 0 means this parameter is ignored and interrupt will be generated when the tx_max_coalesce_frames threshold is reached. The valid range is from 0 to 500, and default is 200. This parameter is not used and will be adjusted automatically if adaptive_coalesce is set to 1. tx_max_coalesce_frames Configures the number of transmitted frames before the NIC gen- erates transmit interrupt. The valid range is from 0 to 100, and default is 35. This parameter and tx_coalesce_ticks cannot be both 0, otherwise no transmit completion interrupts will be gen- erated. This parameter should always be set lower than tx_pkt_desc_cnt. This parameter is not used and will be adjusted automatically if adaptive_coalesce is set to 1. stats_coalesce_ticks Configures the number of 1 usec ticks between periodic statis- tics block DMAs. The valid range is from 100 to 3600000000, and default is 1000000 (1 sec.). 0 is also valid and is used to dis- able statistics updates. This parameter is not used and will be set to default if adaptive_coalesce is set to 1. enable_wol Enables or disables magic packet Wake-On-LAN when the system is shutdown. Note that not all systems support Wake-On-LAN. The valid values are: 0 magic packet Wake-On-LAN disabled (default) 1 magic packet Wake-On-LAN enabled enable_tso Enables or disables TCP Segmentation Option (TSO) when using kernels that support it. This parameter is only defined on newer kernels that support TSO. The valid values are: 0 TSO disabled 1 TSO enabled (default) vlan_tag_mode This parameter controls the stripping of VLAN tags on incoming packets, and is used to allow VLAN tagged ASF or IPMI packets to be received properly. The valid values are: 0 Auto mode (default) 1 Normal strip mode 2 Forced strip mode In normal mode, VLAN tags are only stripped if VLANs are regis- tered by the 802.1q VLAN module or BASP. In forced strip mode, VLAN tags are always stripped. Auto mode will select normal strip mode if ASF/IPMI is disabled, or forced strip mode if ASF/IPMI is enabled. delay_link If set to 1, this parameter will cause the driver to return -EOPNOTSUPP when the SIOCGMIIREG or ETHTOOL_GLINK ioctls are called during the first 6 seconds after driver reset. When the driver resets the NIC during ifconfig, the link will drop and it may take several seconds for the link to come up after autonego- tiation completes. Some applications, such as ifup, may not wait long enough for the link before giving up. Setting this parame- ter to 1 may get around such problems. The default value is 0, which means that the driver will always return true link states to all ioctl calls, when applicable. disable_d3hot If set to 1, this parameter will cause the driver to never put the device in D3Hot power state when the NIC is shutdown or sus- pended. If set, this parameter will also disable the Wake-On-Lan setting. A rare D3Hot related problem was seen during repeated shutdown of PCI Express devices on systems running 2.6 kernels. DRIVER MESSAGES The following are the most common sample messages that may be logged in the file /var/log/messages. Use dmesg -n to control the level at which messages will appear on the console. Most systems are set to level 6 by default. Broadcom Gigabit Ethernet Driver bcm5700 with Broadcom NIC Extension (NICE) ver. 7.3.5 (06/23/04) Driver signon eth#: Broadcom BCM5704 1000Base-T found at mem faff0000, IRQ 16, node addr 0010180402d8 eth#: Broadcom BCM5704 Integrated Copper transceiver found eth#: Scatter-gather ON, 64-bit DMA ON, Tx Checksum ON, Rx Checksum ON, 802.1Q VLAN ON, NAPI ON NIC detected bcm5700: eth# NIC Link is Up, 1000 Mbps full duplex, receive & transmit flow control ON Link up and speed indication bcm5700: eth# NIC Link is Down Link down indication FILES /proc/net/nicinfo/eth#.info Detailed statistics and configuration file. AUTHOR Michael Chan - mchan@broadcom.com SEE ALSO ifconfig(8), insmod(8), modules.conf(5). Broadcom Corporation 06/23/04 BCM5700(4)