NAME

       hbaapi.h - C header file descriping the HBA API.

SYNOPSIS

       #include <stdint.h>
       #include <time.h>

   Functions
       HBA_UINT32 HBA_GetVersion (void)
           Return the version of the HBA API specification with which this library is compliant.
       HBA_STATUS HBA_LoadLibrary (void)
           Perform initialization of library.
       HBA_STATUS HBA_FreeLibrary (void)
           Free system resources that library has used.
       HBA_UINT32 HBA_GetWrapperLibraryAttributes (HBA_LIBRARYATTRIBUTES *)
           Return attributes of the OS specific HBA API library.
       HBA_UINT32 HBA_GetVendorLibraryAttributes (HBA_UINT32, HBA_LIBRARYATTRIBUTES *)
           Return attributes of the vendor specific HBA API library.
       HBA_UINT32 HBA_GetNumberOfAdapters (void)
           Return number of adapters.
       void HBA_RefreshInformation (HBA_HANDLE)
           Refresh information of an adapter.
       void HBA_RefreshAdapterConfiguration (void)
           Refresh information about configured adapters.
       void HBA_ResetStatistics (HBA_HANDLE, HBA_UINT32)
           According to FC-HBA this function is obsolete.
       HBA_STATUS HBA_GetAdapterName (HBA_UINT32, char *)
           Return name that identifies an adapter.
       HBA_HANDLE HBA_OpenAdapter (char *)
           Open an adapter.
       HBA_STATUS HBA_OpenAdapterByWWN (HBA_HANDLE *, HBA_WWN)
       void HBA_CloseAdapter (HBA_HANDLE)
           Close an open adapter.
       HBA_STATUS HBA_GetAdapterAttributes (HBA_HANDLE, HBA_ADAPTERATTRIBUTES *)
           Return attributes for an adapter.
       HBA_STATUS HBA_GetAdapterPortAttributes (HBA_HANDLE, HBA_UINT32, HBA_PORTATTRIBUTES *)
           Return attributes for an adapter port.
       HBA_STATUS HBA_GetDiscoveredPortAttributes (HBA_HANDLE, HBA_UINT32, HBA_UINT32,
           HBA_PORTATTRIBUTES *)
           Return attributes of an discovered port.
       HBA_STATUS HBA_GetPortAttributesByWWN (HBA_HANDLE, HBA_WWN, HBA_PORTATTRIBUTES *)
       HBA_STATUS HBA_GetPortStatistics (HBA_HANDLE, HBA_UINT32, HBA_PORTSTATISTICS *)
           Return statistics of an adapter port.
       HBA_STATUS HBA_GetFC4Statistics (HBA_HANDLE, HBA_WWN, HBA_UINT8, HBA_FC4STATISTICS *)
       HBA_STATUS HBA_GetBindingCapability (HBA_HANDLE, HBA_WWN, HBA_BIND_CAPABILITY *)
       HBA_STATUS HBA_GetBindingSupport (HBA_HANDLE, HBA_WWN, HBA_BIND_CAPABILITY *)
       HBA_STATUS HBA_SetBindingSupport (HBA_HANDLE, HBA_WWN, HBA_BIND_CAPABILITY)
       HBA_STATUS HBA_GetFcpTargetMapping (HBA_HANDLE, HBA_FCPTARGETMAPPING *)
           Retrieve mappings between OS SCSI targets/units and FCP targets/units.
       HBA_STATUS HBA_GetFcpTargetMappingV2 (HBA_HANDLE, HBA_WWN, HBA_FCPTARGETMAPPINGV2 *)
           Retrieve mappings between OS SCSI targets/units and FCP targets/units.
       HBA_STATUS HBA_GetFcpPersistentBinding (HBA_HANDLE, HBA_FCPBINDING *)
       HBA_STATUS HBA_GetPersistentBindingV2 (HBA_HANDLE, HBA_WWN, HBA_FCPBINDING2 *)
       HBA_STATUS HBA_SetPersistentBindingV2 (HBA_HANDLE, HBA_WWN, HBA_FCPBINDING2 *)
       HBA_STATUS HBA_RemovePersistentBinding (HBA_HANDLE, HBA_WWN, HBA_FCPBINDING2 *)
       HBA_STATUS HBA_RemoveAllPersistentBindings (HBA_HANDLE, HBA_WWN)
       HBA_STATUS HBA_GetFCPStatistics (HBA_HANDLE, const HBA_SCSIID *, HBA_FC4STATISTICS *)
       HBA_STATUS HBA_SendScsiInquiry (HBA_HANDLE, HBA_WWN, HBA_UINT64, HBA_UINT8, HBA_UINT32,
           void *, HBA_UINT32, void *, HBA_UINT32)
           Send a SCSI INQUIRY command to a FCP LUN.
       HBA_STATUS HBA_ScsiInquiryV2 (HBA_HANDLE, HBA_WWN, HBA_WWN, HBA_UINT64, HBA_UINT8,
           HBA_UINT8, void *, HBA_UINT32 *, HBA_UINT8 *, void *, HBA_UINT32 *)
           Send a SCSI INQUIRY command to a FCP LUN.
       HBA_STATUS HBA_SendReportLUNs (HBA_HANDLE, HBA_WWN, void *, HBA_UINT32, void *,
           HBA_UINT32)
           Send a SCSI REPORT LUNS command to a target.
       HBA_STATUS HBA_ScsiReportLUNsV2 (HBA_HANDLE, HBA_WWN, HBA_WWN, void *, HBA_UINT32 *,
           HBA_UINT8 *, void *, HBA_UINT32 *)
           Send a SCSI REPORT LUNS command to a target.
       HBA_STATUS HBA_SendReadCapacity (HBA_HANDLE, HBA_WWN, HBA_UINT64, void *, HBA_UINT32, void
           *, HBA_UINT32)
           Send a SCSI READ CAPACITY command to a FCP LUN.
       HBA_STATUS HBA_ScsiReadCapacityV2 (HBA_HANDLE, HBA_WWN, HBA_WWN, HBA_UINT64, void *,
           HBA_UINT32 *, HBA_UINT8 *, void *, HBA_UINT32 *)
           Send a SCSI READ CAPACITY command to a FCP LUN.
       HBA_STATUS HBA_SendCTPassThru (HBA_HANDLE, void *, HBA_UINT32, void *, HBA_UINT32)
           Send a CT pass thru - a CT frame constructed in userspace directly to the HBA / SAN.
       HBA_STATUS HBA_SendCTPassThruV2 (HBA_HANDLE, HBA_WWN, void *, HBA_UINT32, void *,
           HBA_UINT32 *)
           Send a CT pass thru - a CT frame constructed in userspace directly to the HBA / SAN.
       HBA_STATUS HBA_SetRNIDMgmtInfo (HBA_HANDLE, HBA_MGMTINFO *)
       HBA_STATUS HBA_GetRNIDMgmtInfo (HBA_HANDLE, HBA_MGMTINFO *)
       HBA_STATUS HBA_SendRNID (HBA_HANDLE, HBA_WWN, HBA_WWNTYPE, void *, HBA_UINT32 *)
           Send a RNID ELS to a port.
       HBA_STATUS HBA_SendRNIDV2 (HBA_HANDLE, HBA_WWN, HBA_WWN, HBA_UINT32, HBA_UINT32, void *,
           HBA_UINT32 *)
           Send a RNID ELS to a port.
       HBA_STATUS HBA_SendRPL (HBA_HANDLE, HBA_WWN, HBA_WWN, HBA_UINT32, HBA_UINT32, void *,
           HBA_UINT32 *)
       HBA_STATUS HBA_SendRPS (HBA_HANDLE, HBA_WWN, HBA_WWN, HBA_UINT32, HBA_WWN, HBA_UINT32,
           void *, HBA_UINT32 *)
       HBA_STATUS HBA_SendSRL (HBA_HANDLE, HBA_WWN, HBA_WWN, HBA_UINT32, void *, HBA_UINT32 *)
       HBA_STATUS HBA_SendLIRR (HBA_HANDLE, HBA_WWN, HBA_WWN, HBA_UINT8, HBA_UINT8, void *,
           HBA_UINT32 *)
       HBA_STATUS HBA_SendRLS (HBA_HANDLE, HBA_WWN, HBA_WWN, void *, HBA_UINT32 *)
       HBA_STATUS HBA_GetEventBuffer (HBA_HANDLE, HBA_EVENTINFO *, HBA_UINT32 *)
           Return events for an adapter from the event queue.
       HBA_STATUS HBA_RegisterForAdapterAddEvents (void(*)(void *, HBA_WWN, HBA_UINT32), void *,
           HBA_CALLBACKHANDLE *)
       HBA_STATUS HBA_RegisterForAdapterEvents (void(*)(void *, HBA_WWN, HBA_UINT32), void *,
           HBA_HANDLE, HBA_CALLBACKHANDLE *)
       HBA_STATUS HBA_RegisterForAdapterPortEvents (void(*)(void *, HBA_WWN, HBA_UINT32,
           HBA_UINT32), void *, HBA_HANDLE, HBA_WWN, HBA_CALLBACKHANDLE *)
       HBA_STATUS HBA_RegisterForAdapterPortStatEvents (void(*)(void *, HBA_WWN, HBA_UINT32),
           void *, HBA_HANDLE, HBA_WWN, HBA_PORTSTATISTICS, HBA_UINT32, HBA_CALLBACKHANDLE *)
       HBA_STATUS HBA_RegisterForTargetEvents (void(*)(void *, HBA_WWN, HBA_WWN, HBA_UINT32),
           void *, HBA_HANDLE, HBA_WWN, HBA_WWN, HBA_CALLBACKHANDLE *, HBA_UINT32)
       HBA_STATUS HBA_RegisterForLinkEvents (void(*)(void *, HBA_WWN, HBA_UINT32, void *,
           HBA_UINT32), void *, void *, HBA_UINT32, HBA_HANDLE, HBA_CALLBACKHANDLE *)
       HBA_STATUS HBA_RemoveCallback (HBA_CALLBACKHANDLE)

Detailed Description

       C header file descriping the HBA API.

       Contains function declarations, macro definitions etc. defined in FC-HBA

Author

       Generated automatically by Doxygen for ZFCP HBA API Library from the source code.