hbaapi.h(3)

💖 hbaapi.h(3) 💖

okay bestie, welcome to the Library Functions Manual for hbaapi.h(3) — the C header that’s basically the HBA API’s whole personality. Pull up, hydrate, and let’s get into it. 💅✨

---

🌸 NAME 🌸

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

---

✨ SYNOPSIS ✨

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

🧚 Functions 🧚

• HBA_UINT32 HBA_GetVersion (void) — returns the version of the HBA API specification with which this library is compliant. 💖
• HBA_STATUS HBA_LoadLibrary (void) — performs initialization of library.
• HBA_STATUS HBA_FreeLibrary (void) — frees system resources that library has used.
• HBA_UINT32 HBA_GetNumberOfAdapters (void) — returns number of adapters.
• void HBA_RefreshInformation (HBA_HANDLE) — refreshes information of an adapter.
• void HBA_RefreshAdapterConfiguration (void) — according to a discussion with Bob Nixon (editor of FC-HBA) this function has no effect in an HBA specific library. 🫶
• void HBA_ResetStatistics (HBA_HANDLE, HBA_UINT32) — according to FC-HBA this function is obsolete.
• HBA_STATUS HBA_GetAdapterName (HBA_UINT32, char *) — returns name that identifies an adapter.
• HBA_HANDLE HBA_OpenAdapter (char *) — opens an adapter.
• HBA_STATUS HBA_OpenAdapterByWWN (HBA_HANDLE *, HBA_WWN)
• void HBA_CloseAdapter (HBA_HANDLE) — closes an open adapter.
• HBA_STATUS HBA_GetAdapterAttributes (HBA_HANDLE, HBA_ADAPTERATTRIBUTES *) — returns attributes for an adapter.
• HBA_STATUS HBA_GetAdapterPortAttributes (HBA_HANDLE, HBA_UINT32, HBA_PORTATTRIBUTES *) — returns attributes for an adapter port.
• HBA_STATUS HBA_GetDiscoveredPortAttributes (HBA_HANDLE, HBA_UINT32, HBA_UINT32, HBA_PORTATTRIBUTES *) — returns 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 *) — returns 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 *) — retrieves mappings between OS SCSI targets/units and FCP targets/units.
• HBA_STATUS HBA_GetFcpTargetMappingV2 (HBA_HANDLE, HBA_WWN, HBA_FCPTARGETMAPPINGV2 *) — retrieves 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) — sends 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 *) — sends a SCSI INQUIRY command to a FCP LUN.
• HBA_STATUS HBA_SendReportLUNs (HBA_HANDLE, HBA_WWN, void *, HBA_UINT32, void *, HBA_UINT32) — sends 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 *) — sends a SCSI REPORT LUNS command to a target.
• HBA_STATUS HBA_SendReadCapacity (HBA_HANDLE, HBA_WWN, HBA_UINT64, void *, HBA_UINT32, void *, HBA_UINT32) — sends 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 *) — sends a SCSI READ CAPACITY command to a FCP LUN.
• HBA_STATUS HBA_SendCTPassThru (HBA_HANDLE, void *, HBA_UINT32, void *, HBA_UINT32) — sends 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 *) — sends 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 *) — sends a RNID ELS to a port.
• HBA_STATUS HBA_SendRNIDV2 (HBA_HANDLE, HBA_WWN, HBA_WWN, HBA_UINT32, HBA_UINT32, void *, HBA_UINT32 *) — sends 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 *) — returns 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.

---

Mwah 💖 — this page is from the ZFCP HBA API Library, Version 1, page label hbaapi.h(3). The footer doesn’t list a date, so I’m not gonna invent one, bestie — periodt. 🎀🦋