OCS hba_api library

Updated: 15-Mar-2014

Description
    The OCS hpa_api library is an implementation of hbaapi as defined
    in the FC-HBA specification Revision 14 (T11/1568-D).

    This library provides a standard API which can be called to gather
    information about fibre channel HBAs that are controlled by the
    OCS SDK drivers.

Building
    Running a "make" in this directory will build the shared library
    libocshbaapi.so on a 32-bit system or libocshbaapi64.so on a
    64-bit system.

Installation
    Running "make install" will copy the library to either /usr/lib
    or /usr/lib64.  In addition it will check the system for the file
    /etc/hba.conf.  If the file exsits it will add a line to the file
    with a reference to the OCS HBA library.  If the file does not
    exist it will create it.

Test
    Running "make api_test" will build the api_test program which can
    be used to verify the operation of the library.  This requires
    that the SNIA libhbaapi library be present on the system.  On a
    RHEL system this can be installed with "yum install libhbaapi".

    Once the test program is built it can be run with:
        ./api_test [ -q | -v ]
    The -q option will result in no output and only the exit code being set.
    The -v option will display output meant to be read by a human.
    With neither option the output will be in a form meant to be parsed by
    machine.

Usage
    For an in-depth description of how to use the library refer to the
    FC-HBA documentation from T11.
