                        ===========
                        R E A D M E
                        ===========

       Cavium Management Application Programming Interface
                       	 for Linux

           Copyright (c) 2000 - 2018 Marvell Semiconductor Inc.
                     All rights reserved.
                         August 28, 2015


Table of Contents
-----------------

    1.  Overview
    2.  Supported Platforms
    3.  Installation
    4.  Files
    5.  Uninstall - RPM package
    6.  Upgrade - RPM package
    7.  Dependency
    8.  Known Limitations



1. Overview
-----------

QLMAPI is a shared library that provides various management APIs for
ethernet network controllers. QLMAPI also provides many advanced
features to manage and configure QLogic gigabit ethernet controllers.



2. Supported Platforms
----------------------

QLMAPI supports x86, x86_64, ia64 and PPC64 architectures on the following platforms:

RedHat Enterprise Linux 5
RedHat Enterprise Linux 6
Suse Linux Enterprise Server 10
Suse Linux Enterprise Server 11

Application should define symbol 'LINUX' before include 'qlgctype.h'
and 'QLMAPI.h'. Currently, QLMAPI for Linux implements only part of
Windows QLMAPI APIs.

Please also refer to 'Dependency' section for more information.



3. Installation
---------------
To install the RPM package, run

  % rpm -i qlmapilnx-{version}.{arch}.rpm

  To be backward compatible and allow 32-bit applications to remain 
  intact, the RPM package for x86_64 architecture will install the 
  32-bit library (libqlmapi) to support 32-bit applications. In 
  addition, it will provide the 64-bit library (libqlmapi_x64) for 
  64-bit applications.



4. Files
--------
  a) For x86 platforms: 
    libqlmapi.so.{version}        QLMAPI 32-bit shared library 

  b) For x86_64 platforms: 
    libqlmapi_x64.so.{version}    QLMAPI 64-bit shared library 
    libqlmapi.so.{version}        QLMAPI 32-bit shared library 

  c) For PPC64 platforms: 
    libqlmapi_ppc64.so.{version}  QLMAPI 64-bit shared library for PPC
 
  d) For IA64 platforms: 
    libqlmapi_ia64.so.{version}   QLMAPI 64-bit shared library for IA64
 
  In addition, here are the common files released for all platforms: 
    readme.txt                   this file
    release.txt                  release text
    QLMAPI.h                      QLMAPI header file
    qlgctype.h                    Data type header file
    qlgc_pci.ids                 QLogic PCI id file

    Note: QLMAPILNX_v6.3.28 and later support the search path to locate
          qlgc_pci.ids in the following order: 
          
          Priority 1: The path set by $QLMAPI_PCI_LOCATION.
          Priority 2: The $PWD path for current directory. 
          Priority 3: The /usr/share directory.



5. Uninstall - RPM package
---------------------------

To uninstall RPM package, 

  % rpm -e qlmapilnx



6. Upgrade - RPM package
---------------------------

To upgrade RPM package, 

  % rpm -U --force qlmapilnx-{version}.{arch}.rpm



7. Dependency
------------------

Advanced features like diagnostics related APIs and proprietary 
information for QLogic network adapters are available to the 
QLogic network adapters running the following driver versions:
    1. all bnx2 versions (driver version >= 1.3.25 is recommended).
    2. tg3 with driver version >= 3.37.
    3. all bcm5700 driver versions.


For installation of QLogic network adapter driver, please refer
to the 'readme.txt' and 'release.txt' in driver package.



8. Known Limitations
---------------------
    1. On PPC64, QLmapiGetBIOS() and QLmapiGetSystemASFTables() will return
       QLMAPI_UNSUPPORT_PLATFORM.
