                         ============================
                                    README
                         ============================

             QLogic BCM5771x/BCM578xx 10/20 GbE Diagnostic Tool -
	     	          eDiag Diagnostic utility for Linux

                    Copyright (c) 2015 QLogic Corporation
                             All rights reserved.

Introduction
------------
This is a Linux diag software package for 10G Ethernet network
controllers BCM5771x and BCM578xx. After untaring the 
file, it will expand the code tree into a directory called 
lediag-<version>-<platform>.

Limitations
-----------
* The software only works on Linux 2.6 kernels. i.e. ReadHat4.


Note: 
* You have to log in as ROOT or do "su - root" to build the device
  drivers and run lediag. 
* If the bnx2x driver is loaded, it has to be unloaded first so that the 
  lediag "driver" command can be used (this command is needed for all 
  traffic related tests). To check if the bnx2x is loaded, do: 
        lsmod | grep bnx2x
  if bnx2x is loaded, do:
	rmmod bnx2x


Compilation and Installation:
-----------------------------
Untar the tarball ( tar -xzvf lediag-<version>-<platform>.tar.zip) and 
run make in lediag-<version>-<platform> directory. It will compile the diagnostic kernel
driver.

It's important to understand that Linux eDiag is NOT compiled under GPL license.
Thus kernel part may not compile against kernels, which were configured with some
GPL-only features enabled. 
For instance "Kernel hacking  ---> Lock debugging: detect incorrect freeing of live locks".

To Load the driver
------------------

1) Run load.sh script, it will load the module, create character device
   node and run the application.
2) At the prompt do dev , it will list all 10gig devices supported.
3) a question mark at the prompt will list all supported commands.

To unload the driver
---------------------
One simply needs to exit the tool by entering command "exit" or pressing Ctl-C.


Supported kernels:
------------------
Currently we support the following distributions: RHEL4, RHEL5, RHEL6, 
SLES9, SLES10 and SLES11 and all Vanilla kernels up to 2.6.25 including.


Concurrent usage with bnx2x:
----------------------------
Starting from kernel 2.6.20 there is no limitation on concurrent usage
of Linux eDiag and bnx2x. Of course, if bnx2x is up, some of the lediag
functions will not be supported. On earlier kernels Linux eDiag can only 
be loaded AFTER bnx2x is loaded (for concurrent usage) and bnx2x can not 
be unloaded as long as Linux eDiag is in use.

Please refer to DOS ediag user document for complete usage information.


