Profishark API  2.3.12.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
General device information

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...
 

Detailed Description

Functions to get general information about a particuliar device.

Enumeration Type Documentation

Profishark device capabilities.

Enumerator
ProfisharkApiDeviceOptions_Basic 

Basic features, covers 'Features' and 'Capture' tabs in Profishark Manager

ProfisharkApiDeviceOptions_DualPorts 

The device has two network ports

ProfisharkApiDeviceOptions_SpanMode 

The device supports span mode

ProfisharkApiDeviceOptions_Gps 

The device has a timing board

ProfisharkApiDeviceOptions_Update 

The device support firmware update (only using Profishark Manager)

ProfisharkApiDeviceOptions_Poe 

The device has a PoE board

ProfisharkApiDeviceOptions_Sfp 

The device has SFP ports

ProfisharkApiDeviceOptions_Filter 

The device supports filtering

ProfisharkApiDeviceOptions_StatisticsV1 

The device supports V1 statistics

ProfisharkApiDeviceOptions_StatisticsV2 

The device supports V2 statistics

ProfisharkApiDeviceOptions_SpeedControl 

The device can control network ports speed

ProfisharkApiDeviceOptions_Loopback 

The device can set notwork ports in loopback mode

ProfisharkApiDeviceOptions_Phy88E3015 

The device uses a 88E3015 PHY

ProfisharkApiDeviceOptions_PhyVSC8641 

The device uses a VSC8641 PHY

ProfisharkApiDeviceOptions_PcapNG 

The device can output pcap-ng data

ProfisharkApiDeviceOptions_SlicingLength 

The device can change packet slicing length

ProfisharkApiDeviceOptions_PhyVSC8502 

The device uses a VSC8641 PHY

ProfisharkApiDeviceOptions_MultipleHW 

The device supports multiple HW firmwares

Profishark devices models.

Enumerator
ProfisharkAPIDeviceType_None 

No Profishark device

ProfisharkAPIDeviceType_BadDevice 

Profishark device with bad hardware firmware

ProfisharkAPIDeviceType_UnknownDevice 

Unknown Profishark device

ProfisharkAPIDeviceType_Profishark1G 

Profishark 1G

ProfisharkAPIDeviceType_C1GIGE_USB 

C1GIGE-USB

ProfisharkAPIDeviceType_Profishark1GPlus 

Profishark-1G+

ProfisharkAPIDeviceType_Profishark1G_v5 

Profishark-1G v5

ProfisharkAPIDeviceType_Profishark1G_v5_POE 

Profishark-1G v5 with PoE board

ProfisharkAPIDeviceType_Profishark1GPlus_POE 

Profishark-1G+ with PoE board

ProfisharkAPIDeviceType_Profishark1GPlus_GPS 

Profishark-1G+ with timing board

ProfisharkAPIDeviceType_Profishark1GPlus_GPS_POE 

Profishark-1G+ with PoE and timing boards

ProfisharkAPIDeviceType_Profishark10G 

Profishark-10G

ProfisharkAPIDeviceType_Profishark10G_GPS 

Profishark-10G with timing board

ProfisharkAPIDeviceType_Profishark100 

Profishark-100

ProfisharkAPIDeviceType_Profishark1G_v6 

Profishark-1G v6

Link duplex.

Enumerator
ProfisharkApiPortDuplex_Full 

Full duplex

ProfisharkApiPortDuplex_Half 

Half duplex

Port Mode.

Enumerator
ProfisharkApiPortMode_Inline 

Inline

ProfisharkApiPortMode_Span 

Span

Link speed.

Enumerator
ProfisharkApiPortSpeed_10Mbps 

10Mbps

ProfisharkApiPortSpeed_100Mbps 

100Mbps

ProfisharkApiPortSpeed_1Gbps 

1Gbps

ProfisharkApiPortSpeed_10Gbps 

10Gbps

ProfisharkApiPortSpeed_Unknown 

Unknown link speed

ProfisharkApiPortSpeed_Down 

Link is down

SFP module connector.

Other values under 0x80 are Reserved Values from 0x80 are Vendor specific

Diagnostic monitoring type.

Enumerator
ProfisharkApiSFPPortsDiagMonitoringType_IntCalibrated_AVPower 

Internally calibrated, Average power

ProfisharkApiSFPPortsDiagMonitoringType_IntCalibrated_OMA 

Internally calibrated, OMA

ProfisharkApiSFPPortsDiagMonitoringType_ExtCalibrated_AVPower 

Externally calibrated, Average power

ProfisharkApiSFPPortsDiagMonitoringType_ExtCalibrated_OMA 

Externally calibrated, OMA

ProfisharkApiSFPPortsDiagMonitoringType_None 

No monitoring

SFP module identifier.

Other values under 0x80 are Reserved Values from 0x80 are Vendor specific

implementation state for various SFP module features

Enumerator
ProfisharkApiSFPPortsImplementation_Implemented 

Feature is implemented

ProfisharkApiSFPPortsImplementation_NotImplemented 

Feature is not implemented

ProfisharkApiSFPPortsImplementation_Implemented_Inverted 

Feature is implemented, but inverted

SFP module Laser power.

Enumerator
ProfisharkApiSFPPortsOptionsLaserPower_Level2 

Laser power level 2

ProfisharkApiSFPPortsOptionsLaserPower_Level1_Unspecified 

Laser power level 1 or unspecified

SFP module Laser type.

Enumerator
ProfisharkApiSFPPortsOptionsLaser_Cooled 

Cooled laser

ProfisharkApiSFPPortsOptionsLaser_Uncooled_Unspecified 

uncooled laser or unspecified

SFP module receiver output type.

Enumerator
ProfisharkApiSFPPortsOptionsLinearReceiverOutput_Linear 

Receiver has linear output

ProfisharkApiSFPPortsOptionsLinearReceiverOutput_Limiting 

Receiver has limiting output

SFP module rate ID.

Other values are Unallocated

SFF8472 compliance.

Other values are unknown.

SFP module encoding.

Values over 0x06 are Reserved

Function Documentation

PROFISHARKAPI_API ProfisharkApiDeviceOptions ProfisharkAPIGetDeviceCapabilities ( ProfisharkAPIDeviceType  devType)

Get device capabilities.

Parameters
devTypethe type of the device
Returns
a 64 bits integer that will hold a bitfield descibing the device capabilities. That bitfield values are described by ProfisharkApiDeviceOptions.
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetDeviceExtraInfo ( ProfisharkApiDeviceHandle  handle,
ProfisharkAPIDeviceExtraInfo info 
)

Get device extra information.

Parameters
handlea handle to the device
[out]infoa ProfisharkAPIDeviceExtraInfo that will be filled with the device extra information
Return values
ProfisharkAPIRet_Successon success
ProfisharkAPIRet_NoDevif the device does not exist
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetDeviceMAC ( ProfisharkApiDeviceHandle  handle,
uint8_t *  mac 
)

Get device MAC address.

Parameters
handlea handle to the device
[out]maca 6 bytes array that will be filled with the device mac address
Return values
ProfisharkAPIRet_Successon success
ProfisharkAPIRet_NoDevif the device does not exist
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetDeviceType ( ProfisharkApiDeviceHandle  handle,
ProfisharkAPIDeviceType type 
)

Get device type.

Parameters
handlea handle to the device
[out]typea ProfisharkAPIDeviceType that will be filled with the device type
Return values
ProfisharkAPIRet_Successon success
ProfisharkAPIRet_NoDevif the device does not exist
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetLinkStatus ( ProfisharkApiDeviceHandle  handle,
ProfisharkApiLinkStatus status 
)

Get device link status.

Parameters
handlea handle to the device
[out]statusa ProfisharkApiLinkStatus that will hold link information
Return values
ProfisharkAPIRet_Successon success
ProfisharkAPIRet_NoDevif the device does not exist
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetVersions ( ProfisharkApiDeviceHandle  handle,
ProfisharkApiVersions versions 
)

Get device firmwares and driver versions.

Parameters
handlea handle to the device
[out]versionsa ProfisharkApiVersions that will hold versions information
Return values
ProfisharkAPIRet_Successon success
ProfisharkAPIRet_NoDevif the device does not exist