Useful add-ons: zfcp HBA API library

jump to next version   jump to zfcp HBA API library overview

If you download any software from this web site please be aware of the Warranty Disclaimer and Limitation of Liabilities.

for use with "June 2003 stream"

Notes:

• Superseded for use with "April 2004 stream" by lib-zfcp-hbaapi-1.3.tar.gz.
  If used with "April 2004 stream" kernel patch 16 (or higher) is required.
• Usage of zfcp HBA API library 1.3 with "June 2003 stream" is experimental.

lib-zfcp-hbaapi-1.2.tar.gz MD5 recommended (2005-03-23)

This package is a complete replacement for lib-zfcp-hbaapi-1.1.tar.gz and contains the following changes:

• added support for HBA_SendRPS and HBA_SendRLS
• minor changes of doxygen documentation
• added environment variable LIB_ZFCP_HBAAPI_DEVICE to set the device file name of the zfcp_hbaapi device
• removed possible dead log when HBA_FreeLibrary is called
• new package version (1.2), new library version (0:2:0)

Description

This is lib-zfcp-hbaapi (zfcp HBA API library). It is part of an implementation of FC-HBA for the ZFCP device driver.

The zfcp device driver is a FCP device driver for Linux on zSeries. The whole implementation of FC-HBA for the zfcp device driver is called zfcp HBA API. Its implementation consists of the following parts.

• zfcp HBA API Library - a shared library which provides the API defined in FC-HBA.


• The kernel module zfcp_hbaapi which provides a misc device with certain IO controls for communication between kernel and user space. The module registers callback functions in the zfcp device driver and is able to use functionality provided by the zfcp device driver. This module is the connection between zfcp HBA API Library and the zfcp device driver.


• The zfcp device driver contains hooks at which callback functions of the zfcp_hbaapi kernel module are invoked. Furthermore the device driver provides functionality which can be used by the zfcp_hbaapi kernel module.

Hardware Requirements

The zfcp HBA API support is only available on IBM eServer zSeries 990 mainframes with a microcode level (MCL) that includes the enhancements of October 31, 2003. Please ensure to use the latest available microcode level.

Installation

The package doxygen (www.doxygen.org) is required for the complete build of the sources.

Generic installation instructions are given in file INSTALL. To build and install lib-zfcp-hbaapi, use the following steps:
1. ./configure
2. make
3. make docs
4. make install
lib-zfcp-hbaapi installs by default in /usr/local/lib, the HBA API header file is installed in /usr/local/include and documentation is installed in /usr/local/share/zfcp-hbaapi-1.2. The library is named libzfcphbaapi.so. The HBA API header file is named hbaapi.h and should be included by applications that link against libzfcphbaapi.so.