1. DOMSA01.exe Driver
2. RELEASE.TXT File Contents

RELEASE.TXT Driver File Contents (DOMSA01.exe)

                          Broadcom Corporation
                          16215 Alton Parkway,
                          Irvine, CA 92619-7013
			  
                              Release Notes
                       Broadcom BCM5700 Linux Driver
                               11/22/2000

Table of Contents
=================

  Introduction
  Limitations
  Packaging
  Installing Source RPM Package
  Building Driver From TAR File
  Module Parameters
  Revision History
  
			       
Introduction
============

This file describes the Linux driver for Broadcom's BCM5700 10/100/1000
Mbps Ethernet Network Interface Chip.


Limitations
===========

The current version of the driver has only been tested on Redhat 6.2 and 7 Linux
distributions for i386 (kernel version 2.2.14 and 2.2.16). The driver has only
been tested as a loadable module.


Packaging
=========

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 files to build the driver are
included in both packages.


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

1. Install the source RPM package:

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

2. CD to the RPM path and build the binary driver for your kernel:

   cd /usr/src/{redhat,OpenLinux,turbo, ..}
   rpm -bb SPECS/bcm5700.spec

Note that the RPM path is different for different Linux distributions.

3. Install the newly built package:

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

The driver will be installed as /lib/modules/<kernel_version>/net/bcm5700.o.

4. Load the driver:

   insmod bcm5700

Note: A newly installed Redhat 7's Enterprise kernel needs to be recompiled to
regenerate versioned symbols before any newly compiled driver can load.


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

1. Create a directory and extract the files:

   tar xvzf bcm5700-<version>.tar.gz

2. Build the driver bcm5700.o as a loadable module for both uniprocessor and
multiprocessor systems:

   make

3. Test the driver by loading it: 

   insmod bcm5700.o

4. Install the driver in /lib/modules/<kernel_version>/net:

   install -m 644 bcm5700.o /lib/modules/<kernel_version>/net

Note: A newly installed Redhat 7's Enterprise kernel needs to be recompiled to
regenerate versioned symbols before any newly compiled driver can load.


Module Parameters
=================

Optional parameters for the driver can be supplied as command line arguments 
to the insmod command. 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 values will be used when invalid values are selected.

All the parameters are listed below.

line_speed

    Selects the line speed of the link. This parameter is used together with
    full_duplex to select the speed and duplexity of the link.
    
    The valid values are:
    
    0      Autonegotiate  (default)
    10     10 Mbps
    100    100 Mbps

    Note that selecting 1000 Mbps manually is invalid. 1000 Mbps can only be
    achieved through autonegotiation.
    
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)

mtu

    Enables jumbo frames up to the specified MTU size. The valid range is
    from 1500 to 8184. Default is 1500.   

   
Revision History
================
v1.3.6 (11/22/00)

- Fixed LED problems.

v1.3.5 (11/21/00)

- Fixed some flow control auto negotiation problems.

v1.3.4 (11/17/00)

- Fixed a problem of missing interrupts.
- Resolved all fixed speed related problems.

v1.3.3 (11/13/00)

- Fixed the problem of memory allocation failure in some machines.

v1.3.2 (11/09/00)

- Made more changes regarding fixed speeds. Also removed manual selection
  of 1000 Mbps.
- Made a SRPM package.

v1.03b (10/31/00)

- Fixed problems #452, #441, #364, and other speed related problems in the
  Lower Module.

v1.03 (10/30/00)

- Released Lower Module as tigon3.o.

v1.02c (10/27/00)

- Fixed the fixed speed problem in Lower Module.

v1.02b (10/24/00)

- Added new parameters for flow control settings.
- Fixed problem with uninitialized statistics counters (problem #338).

v1.02  (10/16/00)

- Modified for B0 chips, should also work for other chips.
- Reenabled TCP/UDP receive hardware checksums.

v1.01b (10/09/00)

- Changed driver to use pci* routines instead of pcibios* routines to obtain
  the correct IRQ on some MP machines.
- Resolved Problems #253, #257.

v1.01 (09/27/00)

- Added statistics collection function.
- Added jumbo frames support.
- Added MII related ioctl calls.
- Disabled UDP/TCP receive checksum offload to workaround a memory corruption
  problem in A1 chips.
- Fixed interrupt sharing problem.

v1.00 (09/13/00)

-First release of the driver for BCM5700 A1 chips.