FILE NAME: bcm5700-2.0.25-1a.src.rpm TITLE: Compaq Tested and Approved bcm5700 Linux NIC Driver VERSION: 2.0.25 LANGUAGE: English CATEGORY: Software Solutions DIVISIONS: Systems PRODUCTS AFFECTED: Compaq NC7770 PCI-X Gigabit Server Adapter Compaq NC7780 Gigabit Server NIC OPERATING SYSTEM: Red Hat Linux Professional 7.1 Red Hat Linux Professional 7.2 SuSE SLES 7 Caldera OpenLinux Server 3.1 PREREQUISITES: Pentium-based computer, 128Mb RAM minimum EFFECTIVE DATE: January 28, 2002 SUPERSEDES: bcm5700-2.0.25-1.src.rpm DESCRIPTION: This RPM Package Manager contains the Compaq Tested and Approved bcm5700 Linux NIC driver for use with the bcm5700 network devices. ENHANCEMENTS/FIXES: Documentation enhancements HOW TO USE: Table of Contents ================= Introduction Limitations Packaging Installing Source RPM Package Notes Patching PCI Files Patching Driver Into Kernel Module Parameters Driver Messages Statistics Introduction ============ This file describes the Linux driver for the Compaq NC77xx bcm5700 series 10/100/1000 Mbps Ethernet Network Controllers. Additional information can be found in the MAN page for bcm5700, and in /usr/share/doc/bcm5700-2.0.25/RELEASE.TXT after driver installation. For SuSE, see /usr/share/doc/packages/bcm5700/RELEASE.TXT. For Caldera, see /usr/doc/bcm5700-2.0.25/RELEASE.TXT. User guides and additional Compaq server network adapter information can be found at . Limitations =========== The /proc/net/nicinfo/ethX.info file may report incorrect information regarding statistics, bus speed, and PCI slot. Please note that in some cases more tx_packets and/or rx_packets are reported than tx_bytes and/or rx_bytes, respectively. The reason for the error is due to counters rolling over. An error regarding the "PCI_BUS_SPEED" may also be encountered. 33MHz is displayed for 33MHz bus speeds, however 66MHz speed will be reported for 50MHz and 100MHz PCI-X busses as well as 66MHz PCI busses. Also note that "PCI_SLOT" is not the actual physical slot. "PCI_SLOT" represents the PCI device ID. Under lower speed and half duplex combinations, a higher error count may be generated. This error will have minimal effect on the overall system and session performance. Some error count generation is a normal and expected occurrence in these conditions. Ensure that your Compaq Server has the latest system ROM. Packaging ========= The driver is released in a source RPM format. The file name for the package is bcm5700-.src.rpm and is dependant on kernel source code. Installing Source RPM Package ============================= 1. Install the source RPM package: Note: For SuSE SLES 7 installations, refer to the NOTES section below before continuing. rpm -ivh bcm5700-.src.rpm 2. Change directory to the RPM path and build the binary driver for your kernel: cd /usr/src/{redhat,OpenLinux,turbo,packages,rpm ..} rpm -bb SPECS/bcm5700.spec Note: The RPM path is different for different Linux distributions. 3. Install the newly built package (driver and man page): rpm -ivh RPMS/i386/bcm5700-.i386.rpm Note: The --force option is needed if installing on Red Hat 7.1, 7.2, and others that already contain an older version of the driver. The driver will be 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): /lib/modules//kernel/drivers/net/bcm/bcm5700.o 4. Load the driver: insmod bcm5700 5. To configure network protocol and address, refer to your Linux vendor documentation. Notes ===== Note 1: For SuSE SLES 7.0 installation The bcm5700 driver requires recompiling the kernel source tree before installing the bcm5700 driver. But before the kernel source tree can be compiled, the kernel source code must be present. Install the kernel source code per SuSE instructions, then follow the commands below to rebuild the kernel source tree: cd /usr/src/linux-.SuSE cp /boot/vmlinuz.config .config cp /boot/vmlinuz.version.h include/linux/version.h cp /boot/vmlinuz.autoconf.h include/linux/autoconf.h make oldconfig make dep where is the actual kernel version used in the SuSE distribution. Example: /usr/src/linux-2.4.7.SuSE Note 2: For Caldera 3.1 OpenLinux Edit the file /etc/modules/default and insert the following line at the end of the file: bcm5700 This will allow the driver to stay resident after system reboots. Patching PCI Files (Optional) ============================= To use the Red Hat kudzu hardware detection utility, a number of files containing PCI vendor and device information need to be patched with information on the bcm5700 series NICs. Patch files for Red Hat 7.x are included. Apply the appropriate patch by doing the following: patch -N -p1 -d /usr < pci-rh7.patch Run kudzu: kudzu Patching Driver Into Kernel (Optional) ====================================== Patch files (bcm5700--2.4..patch) are included for patching the driver into some 2.4.x kernel's source tree. This step is optional and should only be done by users familiar with configuring and building the kernel. The patch will modify the original kernel's source code. Follow the following steps to patch the driver into the 2.4.x kernel: 1. Select the patch file that matches your kernel and apply the patch: patch -p1 -d < bcm5700-version>-2.4..patch Note: is usually /usr/src/linux or /usr/src/linux-2.4. 2. Configure the kernel to include the bcm5700 driver. It can be found under Network Device Support ---> Ethernet (1000 Mbit) ---> Broadcom BCM5700 support when make menuconfig is run. Select built-in or module for the driver: cd make menuconfig 3. Compile the kernel: make dep make clean .... .... Module Parameters ================= Optional parameters for the driver can be supplied as command line arguments to the insmod command. Typically, these parameters are set in the file /etc/modules.conf (see the man page for modules.conf). These parameters take the following form in the /etc/modules.conf file. alias eth0 bcm5700 alias eth1 bcm5700 [add] options bcm5700 =[value,value] =[value,value] where the multiple values for the same parameter are for multiple NICs installed in the system. Thus the first "value" represents the parameter for eth0, the second "value" represents the parameter for eth1... Note that default or other meaningful values will be used when invalid values are selected. Some combinations of parameter values may conflict and lead to failures. The driver cannot detect all such conflicting combinations. 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 duplex of the link and the setting of auto negotiation. 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 autonegotiate for the selected speed (and selected duplex) if auto_speed is set to 1. If auto_speed is set to 0, the selected speed and duplex 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 duplex of the link. This parameter is used together with line_speed to select the speed and duplex 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 (default) 1 pause receive enabled if auto_flow_control is set to 0, or pause receive advertised if auto_flow_control is set to 1 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 (default) 1 pause transmit enabled if auto_flow_control is set to 0, or pause transmit advertised if auto_flow_control is set to 1 auto_flow_control Enables or disables autonegotiation of flow control. This parameter 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 (default) 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) mtu Enables jumbo frames up to the specified MTU size. The valid range is from 1500 to 9000. Default is 1500. Note that the MTU size excludes the ethernet header size of 14 bytes. Actual frame size is MTU size + 14 bytes. 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 validation. 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) tx_pkt_desc_cnt Configures the number of transmit descriptors. Default is 100. The valid range is from 1 to 600. Note that the driver may not be able to allocate the required amount of memory if this parameter is set too high. 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 800. 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. 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. Note that each descriptor requires a buffer the size of a maximum jumbo frame. On systems with insufficient memory, it may be necessary to reduce this parameter. When the maximum frame size is less than 1528 (MTU size less than 1514), this parameter is not used and is always 0. rx_adaptive_coalesce Enables or disables adaptive adjustments to the receive interrupt coalescing parameters. Enabling it allows the driver to dynamically adjust the receive 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 much lower than the default value when this parameter is enabled. The valid values are: 0 disabled 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. Interrupt 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 100. This parameter is not used and will be adjusted automatically if rx_adaptive_coalesce is set to 1. rx_max_coalesce_frames Configures the number of received frames before the NIC generates receive interrupt. The valid range is from 0 to 100, and default is 10. This parameter and rx_coalesce_ticks cannot be both 0, otherwise no receive interrupts will be generated. It should also be set significantly 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 rx_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 500. tx_max_coalesce_frames Configures the number of transmitted frames before the NIC generates transmit interrupt. The valid range is from 0 to 100, and default is 75. This parameter and tx_coalesce_ticks cannot be both 0, otherwise no transmit completion interrupt will be generated. This parameter should always be set lower than tx_pkt_desc_cnt. stats_coalesce_ticks Configures the number of 1 usec ticks between periodic statistics block DMAs. The valid range is from 0 to 3600000000, and default is 1000000 (1 sec.). Set to 0 to disable statistics updates. This parameter is not used and will be set to default if rx_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 Driver Messages =============== The following are the most common sample messages that may be logged in the file /var/log/messages. Note: Some Linux distributions may not display messages to the console. To set messages to display on the console, at the command line use dmesg -n 6 to control the level at which messages will appear on the console. Most systems are set to level 6 by default. eth#: Broadcom BCM5701 1000Base-T found at mem faff0000, IRQ 16, node addr 0010180402d8 eth#: Broadcom BCM5701 Integrated Copper transceiver found eth#: Scatter-gather ON, 64-bit DMA ON, Tx Checksum ON, Rx Checksum ON NIC detected bcm5700: eth# NIC Link is Up, 1000 Mbps full duplex Link up and speed indication bcm5700: eth# NIC Link is Down Link down indication Statistics ========== Detailed statistics and configuration information can be viewed in the file /proc/net/nicinfo/eth#.info. Copyright 2000-2002, Compaq Computer Corporation. All rights reserved. Product names mentioned herein may be trademarks and/or registered trademarks of their respective companies