Broadcom NetXtreme Ethernet Adapter
Linux Diagnostic readme.txt

Copyright  2006  Broadcom Corporation
All Rights Reserved
No part of this document may be reproduced, in any form or by any means,
without permission in writing from Broadcom Corporation. Broadcom Corporation
reserves the right to make changes to the products or information contained
in this document without notice. No liability is assumed as a result of their
use or application. No rights under any patent accompany the sale of any such
products or information. Epigram, InsideLine, and iLine10 are trademarks of
Broadcom Corporation.

Broadcom Corporation
16125 Alton Parkway
Irvine, CA 92619-7013
www.broadcom.com



This document should be found in the directory that contains the following
files:
- readme.txt          // this file
- release.txt         // contains descriptions of changes between releases
- b57ldiagp           // executable for PPC Linux
- b57ldiagi           // executable for x86 Linux
- b57ldiagi64         // executable for x86 64bit Linux
- cpu*.bin            // binary file necessary for the diagnostic CPU test
- b57ldiagman.pdf     // documentation for the diagnostic
- b57diag_script.doc  // documentation for DOS script files
                      // Linux script files follow the same format
- x.x.x               // directory containing the Linux diagnostic driver. 
                      // Diagnostic release 1.44 an on will contain a
                      // sub-directory with the driver source.
- runDiag             // script file that builds the diagnostic driver
                      // and then runs the diagnostic 

In order to run the Broadcom Linux diagnostic the following requirements 
must be met.
1.  A Power PC system that uses Linux SuSE Enterprise Server 9 or 10
    or an x86 based machine running Redhat Enterprise Linux AS 3 or 4.
2.  The system Ethernet controller belongs to the 5704, 5705, 575x, 572x
    5714, 5787 or the HTLE family of Broadcom devices.
3.  A command shell (sh, csh, tcsh, bash, etc) is required to interface with
    the text based diagnostics tool. The runDiag script requires bash.
4.  The executable (b57ldiagp, b57ldiagi, b57ldiagi64) must be run as root.
5.  Before running any of the diagnostic tests on a new device with a blank 
    NVRAM the user must program the NVRAM of the device using the "seprg"
    command. Not programming the devices NVRAM will cause diagnostics to 
    run very slow.
6.  In order to run the diagnostic run the "runDiag" script or follow the 
    steps below.
    6.1 "rmmod" the tg3 driver that ships with most Linux distributions.
    6.2 "rmmod" any other driver that is presently loaded and can be 
        associated with the device that you want to test (i.e. bcm5700).
    6.3 "make" and install the diagnostic driver (i.e. bcm57diag).
    6.4 "insmod" the bcm57diag.o/bcm57diag.ko driver for kernel 2.4/2.6.
    6.5 bring up the devices to be tested via "ifconfig eth<x> up"
    6.6 run the diagnostic


Warning
-------
Diagnostic fails when the interface is brought down during a diagnostic run.
The user must configure the Linux system so that the interface stays up 
during a diagnostic run.
A dhcp client can bring down the interface after diagnostic is started.
