LSI Logic Host Bus Adapter (HBA) Application Programming Interface (API)
V2.0 Library for Windows
Version 2.00.04
03/08/2005
Contents
========
Overview
Requirements
Driver Requirements
HBA & Firmware Requirements
Operating System Requirements
Features
HBAAPI v2.0 Support Matrix
Installation
Release History
------------------------------------------------------------------------------
Overview
========
This document describes the LSI Logic implementation of the driver and library
that conform to the Fibre Channel HBA API (FC-HBA) specification (T11/Project 1568-D/
Revision 10, 18 September 2003for the Common HBA API. It contains basic information and the latest
release notes about the LSI Logic HBA API Library for the Windows operating
system.
------------------------------------------------------------------------------
Requirements
============
Driver Requirements
===================
The LSI Logic HBA API library requires LSI Logic Fibre Channel SCSI Miniport
drivers of version v1.09.02 or higher. Refer to the readme notes for the
driver to find additional information on configuring a pseudo device to allow
this API to function even when no devices are attached to the Fibre Channel
HBA.
HBA & Firmware Requirements
===========================
The LSI Logic HBA API library supports all LSI Logic controllers based on the
following chips:
- LSIFC919/929
- LSIFC919X/929X
The LSI Logic LSIFC919/929 controllers must use firmware version 1.00.10 or
higher, and the LSI Logic LSIFC919X/929X controllers must use firmware version
1.00.00 or higher.
Operating System Requirements
=============================
LSI Logic HBA API V2.0 library is compatible with with Microsoft Windows
Operating Systems that are supported by the LSI Logic PCI/PCI-X Fibre Channel
SCSI Miniport drivers.
------------------------------------------------------------------------------
Features
========
HBAAPI v2.0 Support Matrix
==========================
API Support Notes
--- ------- -----
HBA_GetVersion Yes
HBA_LoadLibrary Yes
HBA_FreeLibrary Yes
HBA_RegisterLibrary Yes
HBA_RegisterLibraryV2 Yes
HBA_GetWrapperLibraryAttributes Yes
HBA_GetVendorLibraryAttributes Yes
HBA_GetNumberOfAdapters Yes
HBA_RefreshAdapterConfiguration Yes
HBA_ResetStatistics Yes
HBA_GetAdapterName Yes
HBA_OpenAdapter Yes
HBA_OpenAdapterByWWN Yes
HBA_CloseAdapter Yes
HBA_GetAdapterAttributes Yes
HBA_GetAdapterPortAttributes Yes
HBA_GetDiscoveredPortAttributes Yes
HBA_GetPortAttributesByWWN Yes
HBA_GetPortStatistics Yes
HBA_GetBindingCapability Yes
HBA_GetBindingSupport Yes
HBA_GetFcpTargetMapping Yes
HBA_GetFcpTargetMappingV2 Yes
HBA_GetFcpPersistentBinding Yes
HBA_GetFPersistentBindingV2 Yes
HBA_SetPersistentBindingV2 Yes
HBA_RemovePersistentBinding Yes
HBA_RemoveAllPersistentBindings Yes
HBA_SendScsiInquiry Yes
HBA_ScsiInquiryV2 Yes
HBA_SendReportLUNs Yes
HBA_ScsiReportLunsV2 Yes
HBA_SendReadCapacity Yes
HBA_ReadCapacityV2 Yes
HBA_SendCTPassThru Yes
HBA_SendCTPassThruV2 Yes
HBA_SetRNIDMgmtInfo Yes
HBA_GetRNIDMgmtInfo Yes
HBA_SendRNID Yes Data Format 0xDF only
HBA_SendRNIDV2 Yes Data Format 0xDF only
HBA_SendRPL Yes
HBA_SendRPS Yes
HBA_SendSRL Yes
HBA_SendRLS Yes
HBA_GetEventBuffer Yes Link up/down, LIP & Registered State Change Notification
AdapterAttributes Support Notes
----------------- ------- -----
Manufacturer Yes
Serial Number Yes
Model Yes
Model Description Yes
Node WWN Yes
Node Symbolic Name Yes Port Symbolic Name
Hardware Version Yes Chip Revision
Driver Version Yes
Option ROM Version Yes
Firmware Version Yes
Vendor Specific ID Yes PCI Revision Id
Number Of Ports Yes
Driver Name Yes
AdapterPortAttributes Support Notes
--------------------- ------- -----
Node WWN Yes
Port WWN Yes
Port Symbolic Name Yes
Port FcId Yes
Port Type Yes
Port State Yes
Supported Class of Service Yes
Supported Fc4Types Yes
Active Fc4Types Yes
Port Supported Speed Yes
Port Speed Yes
Port Max Frame Size Yes
OS Device Name Yes
Number of Discovered Ports Yes
Fabric Name Yes Fabric WWNN (if present)
DiscoveredPortAttributes Support Notes
------------------------ ------- -----
Node WWN Yes
Port WWN Yes
Port Symbolic Name Yes
Port FcId Yes
Port Type Yes
Port State Yes
Supported Class of Service Yes
Port Supported Fc4Types Yes
Port Active Fc4Types Yes
Port Supported Speed Yes
Port Speed Yes
Port Max Frame Size Yes
OS Device Name Yes
Number of Discovered Ports Yes
Fabric Name Yes Fabric WWN (if present)
PortStatistics Support Notes
-------------- ------- -----
Seconds Since Statistics Reset Yes
TxFrames Yes
RxFrames Yes
TxWords Yes
RxWords Yes
LIPCount Yes
NOSCount Yes
ErrorFrames Yes
DumpedFrames Yes
LinkFailureCount Yes
LossOfSyncCount Yes
LossOfSignalCount Yes
PrimitiveSeqProtocolErrCount Yes
InvalidTxWordCount Yes
InvalidCRCCount Yes
------------------------------------------------------------------------------
Installation
============
* The LSI HBA API library is installed by using an InstallShield package.
The installation process checks and installs, if needed, the Common Library
DLL. The process also installs the LSI Logic Library File DLL, and provides
the correct settings to the System Registry to allow proper execution of the
LSI Logic HBA API Library.
* The following Registry entries are modified by the InstallShield
installation.
* HKLM\Software\SNIA\HBA\LSILogic
contains the full path of the LSI Logic library file
"%SystemRoot%\system32\hbaLSILogic.dll"
* HKLM\Software\SNIA\HBA\common
contains the full path of the common wrapper library file
"%SystemRoot%\system32\common2.dll"
------------------------------------------------------------------------------
Release History
===============
2.00.00 1/21/2004
This is the initial release of the LSI Logic HBA API Library.
2.00.01 4/26/2004
Fixed issues with HBA_SetPersistentBindingV2.
2.00.02 5/11/2004
Build the DLLs using 8-byte alignment, to be in sync w/ test tools.
2.00.03 9/08/2004
Corrected problem with getting attributes in a loop configuration with no end devices
attached to the switch.
2.00.04 03/08/2005
Corrected problem with HBA_FreeLibrary function
Corrected problem with HBA_sendRLS function
Removed SB (single byte) command support
Increased supported IOCTL payloads size (to 60KB)
------------------------------------------------------------------------------
Copyright (c) 2004 LSI Logic Corporation. All rights reserved.
Download Driver Pack
After your driver has been downloaded, follow these simple steps to install it.
Expand the archive file (if the download file is in zip or rar format).
If the expanded file has an .exe extension, double click it and follow the installation instructions.
Otherwise, open Device Manager by right-clicking the Start menu and selecting Device Manager.
Find the device and model you want to update in the device list.
Double-click on it to open the Properties dialog box.
From the Properties dialog box, select the Driver tab.
Click the Update Driver button, then follow the instructions.
Very important: You must reboot your system to ensure that any driver updates have taken effect.
For more help, visit our Driver Support section for step-by-step videos on how to install drivers for every file type.