|
Packit |
2e24a8 |
Linux* HBAAPI Vendor Library
|
|
Packit |
2e24a8 |
============================
|
|
Packit |
2e24a8 |
|
|
Packit |
2e24a8 |
Introduction
|
|
Packit |
2e24a8 |
------------
|
|
Packit |
2e24a8 |
|
|
Packit |
2e24a8 |
HBAAPI stands for Host Bus Adapter API (Applications Programming Interface).
|
|
Packit |
2e24a8 |
It is a C-level shared library to manage Fibre Channel Host Bus Adapters.
|
|
Packit |
2e24a8 |
The HBAAPI library source code may be downloaded from http://sourceforge.net/.
|
|
Packit |
2e24a8 |
For a detailed description of HBAAPI please see the FC-HBA working draft in
|
|
Packit |
2e24a8 |
http://www.t11.org/index.html. The HBAAPI shared library will also be built
|
|
Packit |
2e24a8 |
when the vendor library is built, and will be named as libHBAAPI.so.
|
|
Packit |
2e24a8 |
|
|
Packit |
2e24a8 |
The HBAAPI vendor library is a shared library with functions that support
|
|
Packit |
2e24a8 |
the API routines in the HBAAPI library. The HBAAPI vendor library will be
|
|
Packit |
2e24a8 |
named as libhbalinux.so and is loaded by the HBAAPI library as a dynamic
|
|
Packit |
2e24a8 |
library when the HBAAPI library is initialized. The vendor library invokes
|
|
Packit |
2e24a8 |
the /sys file system for information of FCoE network adapters, local ports,
|
|
Packit |
2e24a8 |
remote ports and discovered LUNs. It also gets adapter information with
|
|
Packit |
2e24a8 |
the assistance from libpciaccess while the information are not available in
|
|
Packit |
2e24a8 |
/sys. The ioctl calls are only used for SG_IO to issue SCSI commands to
|
|
Packit |
2e24a8 |
generic scsi block devices. No ioctl are called to the libfc.ko or fcoe.ko
|
|
Packit |
2e24a8 |
modules.
|
|
Packit |
2e24a8 |
|
|
Packit |
2e24a8 |
When applications are developed to link with libHBAAPI.so, they may
|
|
Packit |
2e24a8 |
indirectly invoke libhbalinux.so behind the libHBAAPI.so. For instructions
|
|
Packit |
2e24a8 |
of how to build and install the libraries, please see the file INSTALL.
|
|
Packit |
2e24a8 |
|
|
Packit |
2e24a8 |
|
|
Packit |
2e24a8 |
In This Release
|
|
Packit |
2e24a8 |
---------------
|
|
Packit |
2e24a8 |
|
|
Packit |
2e24a8 |
This release of the vendor library is implemented in association with the
|
|
Packit |
2e24a8 |
version 2.2 (August 2002) of HBAAPI code from Source Forge.
|
|
Packit |
2e24a8 |
|
|
Packit |
2e24a8 |
The supported API's in this release are:
|
|
Packit |
2e24a8 |
|
|
Packit |
2e24a8 |
HBA_GetVersion
|
|
Packit |
2e24a8 |
HBA_LoadLibrary
|
|
Packit |
2e24a8 |
HBA_FreeLibrary
|
|
Packit |
2e24a8 |
HBA_RegisterLibrary
|
|
Packit |
2e24a8 |
HBA_GetNumberOfAdapters
|
|
Packit |
2e24a8 |
HBA_GetAdapterName
|
|
Packit |
2e24a8 |
HBA_OpenAdapter
|
|
Packit |
2e24a8 |
HBA_CloseAdapter
|
|
Packit |
2e24a8 |
HBA_GetAdapterAttributes
|
|
Packit |
2e24a8 |
HBA_GetAdapterPortAttributes
|
|
Packit |
2e24a8 |
HBA_GetPortStatistics
|
|
Packit |
2e24a8 |
HBA_GetFC4Statistics
|
|
Packit |
2e24a8 |
HBA_GetFcpTargetMapping
|
|
Packit |
2e24a8 |
HBA_GetFcpTargetMappingV2
|
|
Packit |
2e24a8 |
HBA_SendScsiInquiry
|
|
Packit |
2e24a8 |
HBA_SendReportLUNs
|
|
Packit |
2e24a8 |
HBA_SendReadCapacity
|
|
Packit |
2e24a8 |
HBA_ScsiInquiryV2
|
|
Packit |
2e24a8 |
HBA_ScsiReportLUNsV2
|
|
Packit |
2e24a8 |
HBA_ScsiReadCapacityV2
|
|
Packit |
2e24a8 |
|
|
Packit |
2e24a8 |
Libhbalinux is maintained at www.Open-FCoE.org and the latest version can
|
|
Packit |
2e24a8 |
be obtained there. Questions, comments and contributions should take place
|
|
Packit |
2e24a8 |
on the development mailing list at www.Open-FCoE.org as well.
|
|
Packit |
2e24a8 |
|