
                           Installation Notes
               Broadcom BCM57DIAG Linux Diagnostic Driver
                              Version 9.0.5
                                03/06/2006

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

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


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

  Introduction
  Limitations
  Packaging
  Building Driver From TAR File
  Unloading and Removing Driver
   

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

This file describes the Linux Diagnostics 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 other Linux distributions for i386 and x86_64 CPU architectures
using 2.4.x and 2.6.x kernels. 
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.


Packaging
=========

The driver is released in a compressed tar format. The file name for the 
package is bcm57diag-<version>.tar.gz. 
Source files to build the driver are included in the package. 


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 bcm57diag-<version>.tar.gz

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

   cd src
   make

3. Test the driver by loading it: 

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

4. Install the driver and man page:

   make install

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


The driver will be installed in the following path:

2.4.x kernels:

    /lib/modules/<kernel_version>/kernel/drivers/net/bcm57diag.o

2.4.x kernels with bcm57diag as an addon driver (e.g. Red Hat 7.3, 2.1AS):

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

or

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

2.6.x kernels:

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

2.6.x kernels with bcm57diag as an addon driver (e.g. SuSE 9 SLES):

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

4. Load the driver:

   modprobe bcm57diag


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 bcm57diag


If the driver was installed using make install from the tar file, the driver
bcm57diag.o has to be manually deleted from the system. 


