readme.txt

网络编程,关于网卡驱动方面的资料.

:                           Installation Notes
                       Broadcom BCM5700 Linux Driver
                              Version 7.4.11
                                12/16/2004

                          Broadcom Corporation
                          16215 Alton Parkway,
                          Irvine, CA 92619-7013

                Copyright (c) 2000-2004 Broadcom Corporation
                           All rights reserved


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

  Introduction
  Limitations
  Packaging
  Installing Source RPM Package
  Building Driver From TAR File
  Patching Driver Into Kernel
  Unloading and Removing Driver
  Module Parameters
  Driver Messages
  Statistics
  

Introduction
============

This file describes the Linux driver for the Broadcom NetXtreme BCM5700
series 10/100/1000 Mbps PCI/PCI-X/PCI Express Ethernet Network Controllers.


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

The current version of the driver has been tested on the latest Red Hat, SuSE,
and United Linux distributions, as well as other similar Linux distributions
for i386, ia64, and x86_64 CPU architectures using 2.4.x and 2.6.x kernels. The
driver has been tested up to kernel version 2.4.27 and 2.6.8.

The driver should work on other little endian or big endian CPU architectures,
but only very limited testing has been done on some of these machines. The
Makefile may have to be modified to include architecture specific compile
switches, and some minor changes in the source files may also be required.
On these machines, patching the driver into the kernel is recommended (see
below for instructions).


Packaging
=========

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


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

The following are general guidelines for installing the driver. Refer to
DISTRIB.TXT for additional installation notes for various Linux distributions.

1. Install the source RPM package:

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

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

or

   rpmbuild -bb SPECS/bcm5700.spec (for RPM version 4.x.x)

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.2, 7.3,
2.1AS 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 as an addon driver (e.g. Red Hat 7.3, 2.1AS):

    /lib/modules/<kernel_version>/kernel/drivers/net/bcm/bcm5700.o

or

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

2.6.0 kernels:

    /lib/modules/<kernel_version>/kernel/drivers/net/bcm5700.ko

2.6.0 kernels with bcm5700 as an addon driver (e.g. SuSE 9 SLES):

    /lib/modules/<kernel_version>/kernel/drivers/net/bcm/bcm5700.ko

4. Load the driver:

   modprobe bcm5700

If loading the driver on Red Hat 7.3, 2.1 AS or other newer kernels with the
tg3 driver, refer to the "Removing tg3 Driver" in DISTRIB.TXT before loading
the driver.

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


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

The following are general guidelines for installing the driver. Refer to
DISTRIB.TXT for additional installation notes for various Linux distributions.

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 the running kernel:

   cd src
   make

3. Test the driver by loading it: 

   insmod bcm5700.o
or
   insmod bcm5700.ko (on 2.6.x kernels)

If loading the driver on Red Hat 7.3, 2.1 AS or other newer kernels with the
tg3 driver, refer to the "Removing tg3 Driver" in DISTRIB.TXT 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.


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

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

The following steps demonstrate how 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
   ....
   ....


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
"Installing Source RPM Package" for the location of the installed driver.


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