
Linux Drivers Software Release for all IBM Broadcom 570x-based
Gigabit Ethernet Adapters - including on-board Ethernet
==============================================================

Linux Drivers package with v2.2.27 Linux driver - from the Broadcom
v5.5.11 Drivers Software CD Release.

This drivers release supports up to Red Hat 7.3, SuSE 8.0, Turbo 7.0,
and Caldera 3.11.
This release supports up to kernel 2.4.18.


CONTENTS
--------

1.0   Overview
      1.1   Limitations
2.0   Change History
3.0   Build and Installation Instructions
4.0   Configuration Information
5.0   Web Sites and Support Phone Number
6.0   Trademarks and Notices


1.0  Overview
_____________

This package includes the Linux driver version 2.2.27 to support
all Linux OSes levels described above.  Also included is
Broadcom Advanced Server Program (BASP) Driver for Linux version
3.0.13 and a BASP SNMP agent for Linux.

Kernel level supported is up to 2.4.18.

This driver supports up to Broadcom BCM5703 silicon level,
including IBM Options P/N 22P7801.



1.1   Limitations
-----------------

No known limitation.


2.0   Change History
____________________


Version history:


v2.2.27 (07/03/02)

- Added additional workaround for 5703 on dual AMD CPUs using AMD762
chipset.

v2.2.26 (06/28/02)

- Adjusted EEPROM delay loop.
- Fixed some minor proc file problems.

v2.2.25 (06/21/02)

- Added 802.1Q VLAN
- Added a locking scheme for PHY access.

v2.2.24 (06/20/02)

- Fixed an intermittent crash problem with fiber NICs.
- Adjusted fiber autoneg. logic to work with 3Com 4900SX switch.
- Fixed intermittent VPD read failure.
- Added netif_carrier_on and netif_carrier_off.

v2.2.23 (06/19/02)

- Fixed some documentation errors.

v2.2.22 (06/06/02)

- Fixed a hang problem with BCM5700 NICs.

v2.2.21 (06/04/02)

- Fixed compile problem on RH7.3 with HIGHMEM enabled.
- Fixed non-zero stats on 5700/5701 when stats_coalesce_ticks is set
to 0.

v2.2.20 (05/02/02)

- Fixed a problem that caused ia64 to crash.
- Added workaround for ICH and ICH0 chipsets.

3.0   Build and Installation Instructions
_________________________________________

The driver is released in two packaging formats: source RPM and
compressed tar formats. The file names for the two packages are
bcm5700-<version>.src.rpm and bcm5700-<version>.tar.gz respectively.
Identical source files to build the driver are included in both
packages. The tar file contains additional utilities such as patches
and driver diskette images for network installation.


Installing Source RPM Package
=============================

1. Install the source RPM package:

   rpm -ivh bcm5700-<version>.src.rpm

If installing the driver on SuSE Linux, refer to the Notes section
below before continuing.

2. CD 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 that the RPM path is different for different Linux distributions.

3. Install the newly built package (driver and man page):

   rpm -ivh RPMS/i386/bcm5700-<version>.i386.rpm

Note that 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/<kernel_version>/net/bcm5700.o

2.4.x kernels:

    /lib/modules/<kernel_version>/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_version>/kernel/drivers/net/bcm/bcm5700.o

or

  /lib/modules/<kernel_version>/kernel/drivers/addon/bcm5700/bcm5700.o

4. Load the driver:

   insmod bcm5700

If loading the driver on Red Hat 7.3, 2.1 AS or newer Red Hat kernels,
refer to the Notes section below before loading the driver.

5. To configure network protocol and address, refer to various Linux
documentations.

Building Driver From TAR File
=============================

1. Create a directory and extract the files:

   tar xvzf bcm5700-<version>.tar.gz

If installing the driver on SuSE Linux, refer to the Notes section
below before continuing.

2. Build the driver bcm5700.o as a loadable module for the running
kernel:

   cd src
   make

3. Test the driver by loading it:

   insmod bcm5700.o

If loading the driver on Red Hat 7.3, 2.1 AS or newer Red Hat kernels,
refer to the Notes section below before loading the driver.

4. Install the driver and man page:

   make install

See RPM instructions above for the location of the installed driver.

5. To configure network protocol and address, refer to various Linux
documentations.

Notes
=====

Note 1: If compiling the driver for a SuSE Linux kernel and errors are
reported, follow the general guidelines below to rebuild the kernel
source tree:

cd /usr/src/linux-<kernel_version>.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 <kernel_version> is the actual kernel version used in the SuSE
distribution. Example: /usr/src/linux-2.4.4.SuSE

Note 2: If loading the driver on Red Hat 7.3, Red Hat 2.1 AS, and
other newer Red Hat kernels and patches, it is 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 do the following to unload
the tg3 driver:

rmmod tg3

It may also be necessary to manually edit the file /etc/modules.conf
to change interface alias names from tg3 to bcm5700. Example:

alias eth0 tg3

Replace tg3 with bcm5700:

alias eth0 bcm5700

See the man pages for ifconfig, rmmod, modules.conf for more detailed
information. It is also recommended to apply the pci patch described
in the next section.

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 running the patch
command.  For example, on Red Hat 7.2 for i386, apply the patch by
doing the following:

   patch -N -p1 -d /usr < pci-rh72-i386.patch

Run kudzu:

   kudzu

Patching Driver Into Kernel (Optional)
======================================

Patch files are included for patching the driver into some of the
latest 2.4.x kernel source trees. This step is optional and should
only be done by users familiar with configuring and building the
kernel. The patch will modify the orginal kernel's source code.

Follow the following steps to patch the driver into kernel:

1. Select the patch file that matches your kernel and apply the patch:

   patch -p1 -d <kernel_src_root> < bcm5700-<version>-2.4.<x>.patch

where <version> is the version of the bcm5700 driver and 2.4.<x> is
the version of the kernel to patch (e.g. 2.4.10).

Note: <kernel_src_root> is usually /usr/src/linux or
      /usr/src/linux-2.4.<x>

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 <kernel_src_root>
   make menuconfig

3. Compile the kernel:

   make dep
   make clean
   ....
   ....


Network Installation
====================

For network installations through NFS, FTP, or HTTP (using a network
boot disk or PXE), a driver diskette that contains the bcm5700 driver
is needed for Red Hat 7.x. The driver diskette images for the most
recent Red Hat versions are included. Boot drivers for other Linux
versions can be compiled by modifying the Makefile and the make
environment. Further information is available from Red Hat's website.

To create the driver diskette, select the appropriate image file,
gunzip it, and do the following:

dd if=dd.img of=/dev/fd0H1440.


Unloading and Removing Driver
=============================

To unload the driver, use ifconfig to bring down all eth# interfaces
opened by the driver, then do the following:

rmmod bcm5700


If the driver was installed using rpm, do the following to remove it:

rpm -e bcm5700


If the driver was installed using make install from the tar file, the
driver bcm5700.o has to be manually deleted from the system. Refer to
the section "Building Driver From TAR File" for the location of the
installed driver.


4.0 Configuration Information
_____________________________

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 form

    <parameter>=value[,value,...]

where the multiple values for the same parameter 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 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
    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
    autonegotiate 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 (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
    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.

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 ranges 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 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.

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 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 interrupt
    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, tx_pkt_desc_cnt, (and rx_jumbo_desc_cnt
    if using jumbo frames) should not be set much lower than their
    default values 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 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 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 400. 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
    generates transmit interrupt. The valid range is from 0 to 100,
    and default is 40.  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. 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 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
    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. Use dmesg -n <level> 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. 2.2.24 (06/20/02)

    Driver signon


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.
Refer to the complete v5.5x Sw CD release.


5.0   WEB Sites and Support Phone Number
________________________________________


IBM Support Web Site:
http://www.pc.ibm.com/support

IBM Marketing Netfinity Web Site:
http://www.pc.ibm.com/us/eserver/xseries

If you have any questions about this update, or problems
applying the update go to the following Help Center World
Telephone Numbers URL:
http://www.ibm.com/planetwide.


6.0   Trademarks and Notices
____________________________


The following terms are trademarks of the IBM Corporation in the
United States or other countries or both:

IBM
eserver xSeries

Broadcom and NetXtreme are trademarks or registered trademarks of
Broadcom Corporation

Other company, product, and service names may be trademarks or
service marks of others

