Profishark API
2.3.12.0
|
Functions to get general information about a particuliar device. More...
Data Structures | |
struct | ProfisharkAPIDeviceExtraInfo |
Profishark device extra information. More... | |
struct | ProfisharkApiSWVersion |
SW firmware or driver version. More... | |
struct | ProfisharkApiHWVersion |
HW firmware version. More... | |
struct | ProfisharkApiVersions |
firmwares and driver versions More... | |
struct | ProfisharkApiRJ45PortStatus |
RJ45 port link status. More... | |
struct | ProfisharkApiRJ45PortsStatus |
Describe all RJ45 ports. More... | |
struct | ProfisharkApiSFPPortStatus |
Description of a SFP module. More... | |
struct | ProfisharkApiSFPPortsStatus |
Describe all SFP ports. More... | |
struct | ProfisharkApiPHYRegisters |
A PHY registers. More... | |
struct | ProfisharkApiPHYsRegisters |
Describe all available PHYs registers. More... | |
struct | ProfisharkApiLinkStatus |
Device link status. More... | |
struct | ProfisharkAPIDeviceHWFirmwareDesc |
Descriptions of a HW firmwares. More... | |
struct | ProfisharkAPIDeviceHWFirmwaresDesc |
Descriptions of the supported HW firmwares. More... | |
Macros | |
#define | PROFISHARK_MAX_HW_NAME_LENGTH 32 |
Maximum length of a HW firmware name. | |
#define | PROFISHARK_MAX_HW_COUNT 4 |
Maximum number of HW firmwares. | |
Enumerations | |
enum | ProfisharkAPIDeviceType { ProfisharkAPIDeviceType_None, ProfisharkAPIDeviceType_BadDevice, ProfisharkAPIDeviceType_UnknownDevice, ProfisharkAPIDeviceType_Profishark1G, ProfisharkAPIDeviceType_C1GIGE_USB, ProfisharkAPIDeviceType_Profishark1GPlus, ProfisharkAPIDeviceType_Profishark1G_v5, ProfisharkAPIDeviceType_Profishark1G_v5_POE, ProfisharkAPIDeviceType_Profishark1GPlus_POE, ProfisharkAPIDeviceType_Profishark1GPlus_GPS, ProfisharkAPIDeviceType_Profishark1GPlus_GPS_POE, ProfisharkAPIDeviceType_Profishark10G, ProfisharkAPIDeviceType_Profishark10G_GPS, ProfisharkAPIDeviceType_Profishark100, ProfisharkAPIDeviceType_Profishark1G_v6 } |
Profishark devices models. More... | |
enum | ProfisharkApiDeviceOptions { ProfisharkApiDeviceOptions_Basic =0x1, ProfisharkApiDeviceOptions_DualPorts =0x2, ProfisharkApiDeviceOptions_SpanMode =0x4, ProfisharkApiDeviceOptions_Gps =0x8, ProfisharkApiDeviceOptions_Update =0x10, ProfisharkApiDeviceOptions_Poe =0x20, ProfisharkApiDeviceOptions_Sfp =0x40, ProfisharkApiDeviceOptions_Filter =0x80, ProfisharkApiDeviceOptions_StatisticsV1 =0x100, ProfisharkApiDeviceOptions_StatisticsV2 =0x200, ProfisharkApiDeviceOptions_SpeedControl =0x400, ProfisharkApiDeviceOptions_Loopback =0x800, ProfisharkApiDeviceOptions_Phy88E3015 =0x2000, ProfisharkApiDeviceOptions_PhyVSC8641 =0x4000, ProfisharkApiDeviceOptions_PcapNG =0x8000, ProfisharkApiDeviceOptions_SlicingLength =0x10000, ProfisharkApiDeviceOptions_PhyVSC8502 =0x20000, ProfisharkApiDeviceOptions_MultipleHW =0x40000 } |
Profishark device capabilities. More... | |
enum | ProfisharkApiPortMode { ProfisharkApiPortMode_Inline, ProfisharkApiPortMode_Span } |
Port Mode. More... | |
enum | ProfisharkApiPortSpeed { ProfisharkApiPortSpeed_10Mbps, ProfisharkApiPortSpeed_100Mbps, ProfisharkApiPortSpeed_1Gbps, ProfisharkApiPortSpeed_10Gbps, ProfisharkApiPortSpeed_Unknown, ProfisharkApiPortSpeed_Down } |
Link speed. More... | |
enum | ProfisharkApiPortDuplex { ProfisharkApiPortDuplex_Full, ProfisharkApiPortDuplex_Half } |
Link duplex. More... | |
enum | ProfisharkApiSFPPortsStatusEncoding { ProfisharkApiSFPPortsStatusEncoding_Unspecified =0x00, ProfisharkApiSFPPortsStatusEncoding_8B10B =0x01, ProfisharkApiSFPPortsStatusEncoding_4B5B =0x02, ProfisharkApiSFPPortsStatusEncoding_NRZ =0x03, ProfisharkApiSFPPortsStatusEncoding_Manchester =0x04, ProfisharkApiSFPPortsStatusEncoding_SONET_Scrambled =0x05, ProfisharkApiSFPPortsStatusEncoding_64B66B =0x06 } |
SFP module encoding. More... | |
enum | ProfisharkApiSFPPortsRateID { ProfisharkApiSFPPortsRateID_Unspecified =0x00, ProfisharkApiSFPPortsRateID_SFF_8079 =0x01, ProfisharkApiSFPPortsRateID_SFF_8431_RXOnly =0x02, ProfisharkApiSFPPortsRateID_SFF_8431_TXOnly =0x04, ProfisharkApiSFPPortsRateID_SFF_8431 =0x06, ProfisharkApiSFPPortsRateID_FC_PI_5_RXOnly =0x08, ProfisharkApiSFPPortsRateID_FC_PI_5 =0x0a } |
SFP module rate ID. More... | |
enum | ProfisharkApiSFPPortsIdentifier { ProfisharkApiSFPPortsIdentifier_Unknown, ProfisharkApiSFPPortsIdentifier_GBIC, ProfisharkApiSFPPortsIdentifier_SolderedToMB, ProfisharkApiSFPPortsIdentifier_SFP_SFPPlus, ProfisharkApiSFPPortsIdentifier_300pinXBI, ProfisharkApiSFPPortsIdentifier_XENPAK, ProfisharkApiSFPPortsIdentifier_XFP, ProfisharkApiSFPPortsIdentifier_XFF, ProfisharkApiSFPPortsIdentifier_XFP_E, ProfisharkApiSFPPortsIdentifier_XPAK, ProfisharkApiSFPPortsIdentifier_X2, ProfisharkApiSFPPortsIdentifier_DWDM_SFP, ProfisharkApiSFPPortsIdentifier_QSFP, ProfisharkApiSFPPortsIdentifier_QSFPPlus, ProfisharkApiSFPPortsIdentifier_CXP } |
SFP module identifier. More... | |
enum | ProfisharkApiSFPPortsConnector { ProfisharkApiSFPPortsConnector_Unknown, ProfisharkApiSFPPortsConnector_SC, ProfisharkApiSFPPortsConnector_FCStyle1Copper, ProfisharkApiSFPPortsConnector_FCStyle2Copper, ProfisharkApiSFPPortsConnector_BNC_TNC, ProfisharkApiSFPPortsConnector_FCCoax, ProfisharkApiSFPPortsConnector_FiberJack, ProfisharkApiSFPPortsConnector_LC, ProfisharkApiSFPPortsConnector_MT_RJ, ProfisharkApiSFPPortsConnector_MU, ProfisharkApiSFPPortsConnector_SG, ProfisharkApiSFPPortsConnector_OpticalPigtail, ProfisharkApiSFPPortsConnector_MPOParallelOptic, ProfisharkApiSFPPortsConnector_HSSDC_II, ProfisharkApiSFPPortsConnector_CopperPigtail, ProfisharkApiSFPPortsConnector_RJ45 } |
SFP module connector. More... | |
enum | ProfisharkApiSFPPortsDiagMonitoringType { ProfisharkApiSFPPortsDiagMonitoringType_IntCalibrated_AVPower, ProfisharkApiSFPPortsDiagMonitoringType_IntCalibrated_OMA, ProfisharkApiSFPPortsDiagMonitoringType_ExtCalibrated_AVPower, ProfisharkApiSFPPortsDiagMonitoringType_ExtCalibrated_OMA, ProfisharkApiSFPPortsDiagMonitoringType_None } |
Diagnostic monitoring type. More... | |
enum | ProfisharkApiSFPPortsSFF8472 { ProfisharkApiSFPPortsSFF8472_Undefined, ProfisharkApiSFPPortsSFF8472_Rev9_3, ProfisharkApiSFPPortsSFF8472_Rev9_5, ProfisharkApiSFPPortsSFF8472_Rev10_2, ProfisharkApiSFPPortsSFF8472_Rev10_4, ProfisharkApiSFPPortsSFF8472_Rev_11_0 } |
SFF8472 compliance. More... | |
enum | ProfisharkApiSFPPortsDiagFlags { ProfisharkApiSFPPortsDiagFlags_Alarm_Temperature =0x1, ProfisharkApiSFPPortsDiagFlags_Alarm_VCC =0x2, ProfisharkApiSFPPortsDiagFlags_Alarm_TXBias =0x4, ProfisharkApiSFPPortsDiagFlags_Alarm_TXPower =0x8, ProfisharkApiSFPPortsDiagFlags_Alarm_RXPower =0x10, ProfisharkApiSFPPortsDiagFlags_Warning_Temperature =0x20, ProfisharkApiSFPPortsDiagFlags_Warning_VCC =0x40, ProfisharkApiSFPPortsDiagFlags_Warning_TXBias =0x80, ProfisharkApiSFPPortsDiagFlags_Warning_TXPower =0x100, ProfisharkApiSFPPortsDiagFlags_Warning_RXPower =0x200, ProfisharkApiSFPPortsDiagFlags_Gpio_TXDisable =0x400, ProfisharkApiSFPPortsDiagFlags_Gpio_TXFault =0x800, ProfisharkApiSFPPortsDiagFlags_Gpio_RXLOS =0x1000 } |
SFP module alarm, warning and gpios. | |
enum | ProfisharkApiSFPPortsOptionsLaserType { ProfisharkApiSFPPortsOptionsLaser_Cooled, ProfisharkApiSFPPortsOptionsLaser_Uncooled_Unspecified } |
SFP module Laser type. More... | |
enum | ProfisharkApiSFPPortsOptionsLaserPower { ProfisharkApiSFPPortsOptionsLaserPower_Level2, ProfisharkApiSFPPortsOptionsLaserPower_Level1_Unspecified } |
SFP module Laser power. More... | |
enum | ProfisharkApiSFPPortsOptionsReceiverOutput { ProfisharkApiSFPPortsOptionsLinearReceiverOutput_Linear, ProfisharkApiSFPPortsOptionsLinearReceiverOutput_Limiting } |
SFP module receiver output type. More... | |
enum | ProfisharkApiSFPPortsImplementation { ProfisharkApiSFPPortsImplementation_Implemented, ProfisharkApiSFPPortsImplementation_NotImplemented, ProfisharkApiSFPPortsImplementation_Implemented_Inverted } |
implementation state for various SFP module features More... | |
enum | ProfisharkApiSFPPortsSONETReachSpecifier { ProfisharkApiSFPPortsSONETReachSpecifier_SR, ProfisharkApiSFPPortsSONETReachSpecifier_SR_1, ProfisharkApiSFPPortsSONETReachSpecifier_IR_1, ProfisharkApiSFPPortsSONETReachSpecifier_IR_2, ProfisharkApiSFPPortsSONETReachSpecifier_LR_1, ProfisharkApiSFPPortsSONETReachSpecifier_LR_2, ProfisharkApiSFPPortsSONETReachSpecifier_LR_3, ProfisharkApiSFPPortsSONETReachSpecifier_Unknown } |
SFP module SONET reach specifier. | |
enum | ProfisharkApiPHYRegistersMasterSlave { ProfisharkApiPHYRegistersMasterSlave_Master, ProfisharkApiPHYRegistersMasterSlave_Slave, ProfisharkApiPHYRegistersMasterSlave_NA } |
State of the master/slave resolution. | |
Functions | |
PROFISHARKAPI_API ProfisharkAPIRet | ProfisharkAPIGetDeviceType (ProfisharkApiDeviceHandle handle, ProfisharkAPIDeviceType &type) |
Get device type. More... | |
PROFISHARKAPI_API ProfisharkAPIRet | ProfisharkAPIGetDeviceMAC (ProfisharkApiDeviceHandle handle, uint8_t *mac) |
Get device MAC address. More... | |
PROFISHARKAPI_API ProfisharkApiDeviceOptions | ProfisharkAPIGetDeviceCapabilities (ProfisharkAPIDeviceType devType) |
Get device capabilities. More... | |
PROFISHARKAPI_API ProfisharkAPIRet | ProfisharkAPIGetDeviceExtraInfo (ProfisharkApiDeviceHandle handle, ProfisharkAPIDeviceExtraInfo &info) |
Get device extra information. More... | |
PROFISHARKAPI_API ProfisharkAPIRet | ProfisharkAPIGetVersions (ProfisharkApiDeviceHandle handle, ProfisharkApiVersions &versions) |
Get device firmwares and driver versions. More... | |
PROFISHARKAPI_API ProfisharkAPIRet | ProfisharkAPIGetLinkStatus (ProfisharkApiDeviceHandle handle, ProfisharkApiLinkStatus &status) |
Get device link status. More... | |
Functions to get general information about a particuliar device.
Profishark device capabilities.
Profishark devices models.
SFP module connector.
Other values under 0x80 are Reserved Values from 0x80 are Vendor specific
Diagnostic monitoring type.
SFP module identifier.
Other values under 0x80 are Reserved Values from 0x80 are Vendor specific
implementation state for various SFP module features
SFP module rate ID.
Other values are Unallocated
SFF8472 compliance.
Other values are unknown.
SFP module encoding.
Values over 0x06 are Reserved
PROFISHARKAPI_API ProfisharkApiDeviceOptions ProfisharkAPIGetDeviceCapabilities | ( | ProfisharkAPIDeviceType | devType | ) |
Get device capabilities.
devType | the type of the device |
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetDeviceExtraInfo | ( | ProfisharkApiDeviceHandle | handle, |
ProfisharkAPIDeviceExtraInfo & | info | ||
) |
Get device extra information.
handle | a handle to the device | |
[out] | info | a ProfisharkAPIDeviceExtraInfo that will be filled with the device extra information |
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_NoDev | if the device does not exist |
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetDeviceMAC | ( | ProfisharkApiDeviceHandle | handle, |
uint8_t * | mac | ||
) |
Get device MAC address.
handle | a handle to the device | |
[out] | mac | a 6 bytes array that will be filled with the device mac address |
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_NoDev | if the device does not exist |
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetDeviceType | ( | ProfisharkApiDeviceHandle | handle, |
ProfisharkAPIDeviceType & | type | ||
) |
Get device type.
handle | a handle to the device | |
[out] | type | a ProfisharkAPIDeviceType that will be filled with the device type |
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_NoDev | if the device does not exist |
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetLinkStatus | ( | ProfisharkApiDeviceHandle | handle, |
ProfisharkApiLinkStatus & | status | ||
) |
Get device link status.
handle | a handle to the device | |
[out] | status | a ProfisharkApiLinkStatus that will hold link information |
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_NoDev | if the device does not exist |
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetVersions | ( | ProfisharkApiDeviceHandle | handle, |
ProfisharkApiVersions & | versions | ||
) |
Get device firmwares and driver versions.
handle | a handle to the device | |
[out] | versions | a ProfisharkApiVersions that will hold versions information |
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_NoDev | if the device does not exist |