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.

Typedefs
typedef enum ProfisharkAPIDeviceType	ProfisharkAPIDeviceType
	Profishark devices models.

typedef enum ProfisharkApiDeviceOptions	ProfisharkApiDeviceOptions
	Profishark device capabilities.

typedef struct ProfisharkAPIDeviceExtraInfo	ProfisharkAPIDeviceExtraInfo
	Profishark device extra information.

typedef struct ProfisharkApiSWVersion	ProfisharkApiSWVersion
	SW firmware or driver version.

typedef struct ProfisharkApiHWVersion	ProfisharkApiHWVersion
	HW firmware version.

typedef struct ProfisharkApiVersions	ProfisharkApiVersions
	firmwares and driver versions

typedef enum ProfisharkApiPortMode	ProfisharkApiPortMode
	Port Mode.

typedef enum ProfisharkApiPortSpeed	ProfisharkApiPortSpeed
	Link speed.

typedef enum ProfisharkApiPortDuplex	ProfisharkApiPortDuplex
	Link duplex.

typedef struct ProfisharkApiRJ45PortStatus	ProfisharkApiRJ45PortStatus
	RJ45 port link status.

typedef struct ProfisharkApiRJ45PortsStatus	ProfisharkApiRJ45PortsStatus
	Describe all RJ45 ports.

typedef enum ProfisharkApiSFPPortsStatusEncoding	ProfisharkApiSFPPortsStatusEncoding
	SFP module encoding.

typedef enum ProfisharkApiSFPPortsRateID	ProfisharkApiSFPPortsRateID
	SFP module rate ID.

typedef enum ProfisharkApiSFPPortsIdentifier	ProfisharkApiSFPPortsIdentifier
	SFP module identifier.

typedef enum ProfisharkApiSFPPortsConnector	ProfisharkApiSFPPortsConnector
	SFP module connector.

typedef enum ProfisharkApiSFPPortsDiagMonitoringType	ProfisharkApiSFPPortsDiagMonitoringType
	Diagnostic monitoring type.

typedef enum ProfisharkApiSFPPortsSFF8472	ProfisharkApiSFPPortsSFF8472
	SFF8472 compliance.

typedef enum ProfisharkApiSFPPortsDiagFlags	ProfisharkApiSFPPortsDiagFlags
	SFP module alarm, warning and gpios.

typedef enum ProfisharkApiSFPPortsOptionsLaserType	ProfisharkApiSFPPortsOptionsLaserType
	SFP module Laser type.

typedef enum ProfisharkApiSFPPortsOptionsLaserPower	ProfisharkApiSFPPortsOptionsLaserPower
	SFP module Laser power.

typedef enum ProfisharkApiSFPPortsOptionsReceiverOutput	ProfisharkApiSFPPortsOptionsReceiverOutput
	SFP module receiver output type.

typedef enum ProfisharkApiSFPPortsImplementation	ProfisharkApiSFPPortsImplementation
	implementation state for various SFP module features

typedef enum ProfisharkApiSFPPortsSONETReachSpecifier	ProfisharkApiSFPPortsSONETReachSpecifier
	SFP module SONET reach specifier.

typedef struct ProfisharkApiSFPPortStatus	ProfisharkApiSFPPortStatus
	Description of a SFP module.

typedef struct ProfisharkApiSFPPortsStatus	ProfisharkApiSFPPortsStatus
	Describe all SFP ports.

typedef enum ProfisharkApiPHYRegistersMasterSlave	ProfisharkApiPHYRegistersMasterSlave
	State of the master/slave resolution.

typedef struct ProfisharkApiPHYRegisters	ProfisharkApiPHYRegisters
	A PHY registers.

typedef struct ProfisharkApiPHYsRegisters	ProfisharkApiPHYsRegisters
	Describe all available PHYs registers.

typedef struct ProfisharkApiLinkStatus	ProfisharkApiLinkStatus
	Device link status.

typedef struct ProfisharkAPIDeviceHWFirmwareDesc	ProfisharkAPIDeviceHWFirmwareDesc
	Descriptions of a HW firmwares.

typedef struct ProfisharkAPIDeviceHWFirmwaresDesc	ProfisharkAPIDeviceHWFirmwaresDesc
	Descriptions of the supported 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 , ProfisharkAPIDeviceType_Profishark1G_v7 , ProfisharkAPIDeviceType_Profishark1GPlus_GPS_v2 , ProfisharkAPIDeviceType_IOTA_1G , ProfisharkAPIDeviceType_IOTA_1GPlus , ProfisharkAPIDeviceType_IOTA_10G , ProfisharkAPIDeviceType_IOTA_10GPlus }
	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 , ProfisharkApiDeviceOptions_CaptureFullFrames = 0x80000 , ProfisharkApiDeviceOptions_CaptureNTPDisciplinedTimestamp = 0x100000 , ProfisharkApiDeviceOptions_PacketTypeFilter = 0x200000 , ProfisharkApiDeviceOptions_PPS_Resolution_5ns = 0x400000 , ProfisharkApiDeviceOptions_PPS_Resolution_8ns = 0x800000 , ProfisharkApiDeviceOptions_10G_1G_Autoneg = 0x1000000 , ProfisharkApiDeviceOptions_VLAN_Filter = 0x2000000 }
	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.

PROFISHARKAPI_API ProfisharkAPIRet	ProfisharkAPIGetDeviceMAC (ProfisharkApiDeviceHandle handle, uint8_t *mac)
	Get device MAC address.

PROFISHARKAPI_API_DEPRECATED ProfisharkApiDeviceOptions	ProfisharkAPIGetDeviceCapabilities (ProfisharkAPIDeviceType devType)
	Get device capabilities.

PROFISHARKAPI_API ProfisharkApiDeviceOptions	ProfisharkAPIGetDeviceCapabilitiesEx (ProfisharkApiDeviceHandle handle)
	Get device capabilities.

PROFISHARKAPI_API ProfisharkAPIRet	ProfisharkAPIGetDeviceExtraInfo (ProfisharkApiDeviceHandle handle, ProfisharkAPIDeviceExtraInfo *info)
	Get device extra information.

PROFISHARKAPI_API ProfisharkAPIRet	ProfisharkAPIGetVersions (ProfisharkApiDeviceHandle handle, ProfisharkApiVersions *versions)
	Get device firmwares and driver versions.

PROFISHARKAPI_API ProfisharkAPIRet	ProfisharkAPIGetLinkStatus (ProfisharkApiDeviceHandle handle, ProfisharkApiLinkStatus *status)
	Get device link status.

Detailed Description

Functions to get general information about a particuliar device.

Typedef Documentation

◆ ProfisharkApiSFPPortsConnector

typedef enum ProfisharkApiSFPPortsConnector ProfisharkApiSFPPortsConnector

SFP module connector.

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

◆ ProfisharkApiSFPPortsIdentifier

typedef enum ProfisharkApiSFPPortsIdentifier ProfisharkApiSFPPortsIdentifier

SFP module identifier.

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

◆ ProfisharkApiSFPPortsRateID

typedef enum ProfisharkApiSFPPortsRateID ProfisharkApiSFPPortsRateID

SFP module rate ID.

Other values are Unallocated

◆ ProfisharkApiSFPPortsSFF8472

typedef enum ProfisharkApiSFPPortsSFF8472 ProfisharkApiSFPPortsSFF8472

SFF8472 compliance.

Other values are unknown.

◆ ProfisharkApiSFPPortsStatusEncoding

typedef enum ProfisharkApiSFPPortsStatusEncoding ProfisharkApiSFPPortsStatusEncoding

SFP module encoding.

Values over 0x06 are Reserved

Enumeration Type Documentation

◆ ProfisharkApiDeviceOptions

enum ProfisharkApiDeviceOptions

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 network 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
ProfisharkApiDeviceOptions_CaptureFullFrames	The device supports full frames direct capture
ProfisharkApiDeviceOptions_CaptureNTPDisciplinedTimestamp	The device supports NTP disciplined timestamps
ProfisharkApiDeviceOptions_PacketTypeFilter	The device supports packets type filtering
ProfisharkApiDeviceOptions_PPS_Resolution_5ns	PPS resolution is 5ns
ProfisharkApiDeviceOptions_PPS_Resolution_8ns	PPS resolution is 8ns
ProfisharkApiDeviceOptions_10G_1G_Autoneg	The device can control 1G autonegociation (10G/10G+ devices with 1G firmware only)
ProfisharkApiDeviceOptions_VLAN_Filter	The device supports VLAN filtering

◆ ProfisharkAPIDeviceType

enum ProfisharkAPIDeviceType

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	DEPRECATED. Profishark-1G+ with timing board detected.
ProfisharkAPIDeviceType_Profishark1G_v5	Profishark-1G v5
ProfisharkAPIDeviceType_Profishark1G_v5_POE	DEPRECATED. Profishark-1G v5 with PoE board. Device was never released.
ProfisharkAPIDeviceType_Profishark1GPlus_POE	DEPRECATED. Profishark-1G+ with PoE board. Device was never released.
ProfisharkAPIDeviceType_Profishark1GPlus_GPS	Profishark-1G+ with timing board
ProfisharkAPIDeviceType_Profishark1GPlus_GPS_POE	DEPRECATED. Profishark-1G+ with PoE and timing boards. Device was never released.
ProfisharkAPIDeviceType_Profishark10G	Profishark-10G
ProfisharkAPIDeviceType_Profishark10G_GPS	Profishark-10G with timing board
ProfisharkAPIDeviceType_Profishark100	Profishark-100
ProfisharkAPIDeviceType_Profishark1G_v6	Profishark-1G v6
ProfisharkAPIDeviceType_Profishark1G_v7	Profishark-1G v7. Based on ProfisharkAPIDeviceType_Profishark1GPlus_GPS, but without timing board.
ProfisharkAPIDeviceType_Profishark1GPlus_GPS_v2	Profishark-1G+ v2
ProfisharkAPIDeviceType_IOTA_1G	IOTA 1G
ProfisharkAPIDeviceType_IOTA_1GPlus	IOTA 1G+
ProfisharkAPIDeviceType_IOTA_10G	IOTA 10G
ProfisharkAPIDeviceType_IOTA_10GPlus	IOTA 10G+

◆ ProfisharkApiPortDuplex

enum ProfisharkApiPortDuplex

Link duplex.

Enumerator
ProfisharkApiPortDuplex_Full	Full duplex
ProfisharkApiPortDuplex_Half	Half duplex

◆ ProfisharkApiPortMode

enum ProfisharkApiPortMode

Port Mode.

Enumerator
ProfisharkApiPortMode_Inline	Inline
ProfisharkApiPortMode_Span	Span

◆ ProfisharkApiPortSpeed

enum ProfisharkApiPortSpeed

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

◆ ProfisharkApiSFPPortsConnector

enum ProfisharkApiSFPPortsConnector

SFP module connector.

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

◆ ProfisharkApiSFPPortsDiagMonitoringType

enum ProfisharkApiSFPPortsDiagMonitoringType

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

◆ ProfisharkApiSFPPortsIdentifier

enum ProfisharkApiSFPPortsIdentifier

SFP module identifier.

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

◆ ProfisharkApiSFPPortsImplementation

enum ProfisharkApiSFPPortsImplementation

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

◆ ProfisharkApiSFPPortsOptionsLaserPower

enum ProfisharkApiSFPPortsOptionsLaserPower

SFP module Laser power.

Enumerator
ProfisharkApiSFPPortsOptionsLaserPower_Level2	Laser power level 2
ProfisharkApiSFPPortsOptionsLaserPower_Level1_Unspecified	Laser power level 1 or unspecified

◆ ProfisharkApiSFPPortsOptionsLaserType

enum ProfisharkApiSFPPortsOptionsLaserType

SFP module Laser type.

Enumerator
ProfisharkApiSFPPortsOptionsLaser_Cooled	Cooled laser
ProfisharkApiSFPPortsOptionsLaser_Uncooled_Unspecified	uncooled laser or unspecified

◆ ProfisharkApiSFPPortsOptionsReceiverOutput

enum ProfisharkApiSFPPortsOptionsReceiverOutput

SFP module receiver output type.

Enumerator
ProfisharkApiSFPPortsOptionsLinearReceiverOutput_Linear	Receiver has linear output
ProfisharkApiSFPPortsOptionsLinearReceiverOutput_Limiting	Receiver has limiting output

◆ ProfisharkApiSFPPortsRateID

enum ProfisharkApiSFPPortsRateID

SFP module rate ID.

Other values are Unallocated

◆ ProfisharkApiSFPPortsSFF8472

enum ProfisharkApiSFPPortsSFF8472

SFF8472 compliance.

Other values are unknown.

◆ ProfisharkApiSFPPortsStatusEncoding

enum ProfisharkApiSFPPortsStatusEncoding

SFP module encoding.

Values over 0x06 are Reserved

Function Documentation

◆ ProfisharkAPIGetDeviceCapabilities()

PROFISHARKAPI_API_DEPRECATED ProfisharkApiDeviceOptions ProfisharkAPIGetDeviceCapabilities ( ProfisharkAPIDeviceType devType )

Get device capabilities.

Parameters

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

Deprecated:: Deprecated, Will still work, but capabilities available only in later firmwares will not be returned. Use ProfisharkAPIGetDeviceCapabilitiesEx instead.

◆ ProfisharkAPIGetDeviceCapabilitiesEx()

PROFISHARKAPI_API ProfisharkApiDeviceOptions ProfisharkAPIGetDeviceCapabilitiesEx ( ProfisharkApiDeviceHandle handle )

Get device capabilities.

Parameters

	handle	a handle to the device
[out]	options	a 64 bits integer that will hold a bitfield descibing the device capabilities. That bitfield values are described by ProfisharkApiDeviceOptions.

Returns: a 64 bits integer that will hold a bitfield descibing the device capabilities. That bitfield values are described by ProfisharkApiDeviceOptions.

◆ ProfisharkAPIGetDeviceExtraInfo()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetDeviceExtraInfo	(	ProfisharkApiDeviceHandle	handle,
		ProfisharkAPIDeviceExtraInfo *	info
	)

Get device extra information.

Parameters

	handle	a handle to the device
[out]	info	a ProfisharkAPIDeviceExtraInfo that will be filled with the device extra information

Return values

ProfisharkAPIRet_Success	on success
ProfisharkAPIRet_NoDev	if the device does not exist

◆ ProfisharkAPIGetDeviceMAC()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetDeviceMAC	(	ProfisharkApiDeviceHandle	handle,
		uint8_t *	mac
	)

Get device MAC address.

Parameters

	handle	a handle to the device
[out]	mac	a 6 bytes array that will be filled with the device mac address

Return values

ProfisharkAPIRet_Success	on success
ProfisharkAPIRet_NoDev	if the device does not exist

◆ ProfisharkAPIGetDeviceType()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetDeviceType	(	ProfisharkApiDeviceHandle	handle,
		ProfisharkAPIDeviceType *	type
	)

Get device type.

Parameters

	handle	a handle to the device
[out]	type	a ProfisharkAPIDeviceType that will be filled with the device type

Return values

ProfisharkAPIRet_Success	on success
ProfisharkAPIRet_NoDev	if the device does not exist

◆ ProfisharkAPIGetLinkStatus()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetLinkStatus	(	ProfisharkApiDeviceHandle	handle,
		ProfisharkApiLinkStatus *	status
	)

Get device link status.

Parameters

	handle	a handle to the device
[out]	status	a ProfisharkApiLinkStatus that will hold link information

Return values

ProfisharkAPIRet_Success	on success
ProfisharkAPIRet_NoDev	if the device does not exist

◆ ProfisharkAPIGetVersions()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetVersions	(	ProfisharkApiDeviceHandle	handle,
		ProfisharkApiVersions *	versions
	)

Get device firmwares and driver versions.

Parameters

	handle	a handle to the device
[out]	versions	a ProfisharkApiVersions that will hold versions information

Return values

ProfisharkAPIRet_Success	on success
ProfisharkAPIRet_NoDev	if the device does not exist

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ ProfisharkApiSFPPortsConnector

◆ ProfisharkApiSFPPortsIdentifier

◆ ProfisharkApiSFPPortsRateID

◆ ProfisharkApiSFPPortsSFF8472

◆ ProfisharkApiSFPPortsStatusEncoding

Enumeration Type Documentation

◆ ProfisharkApiDeviceOptions

◆ ProfisharkAPIDeviceType

◆ ProfisharkApiPortDuplex

◆ ProfisharkApiPortMode

◆ ProfisharkApiPortSpeed

◆ ProfisharkApiSFPPortsConnector

◆ ProfisharkApiSFPPortsDiagMonitoringType

◆ ProfisharkApiSFPPortsIdentifier

◆ ProfisharkApiSFPPortsImplementation

◆ ProfisharkApiSFPPortsOptionsLaserPower

◆ ProfisharkApiSFPPortsOptionsLaserType

◆ ProfisharkApiSFPPortsOptionsReceiverOutput

◆ ProfisharkApiSFPPortsRateID

◆ ProfisharkApiSFPPortsSFF8472

◆ ProfisharkApiSFPPortsStatusEncoding

Function Documentation

◆ ProfisharkAPIGetDeviceCapabilities()

◆ ProfisharkAPIGetDeviceCapabilitiesEx()

◆ ProfisharkAPIGetDeviceExtraInfo()

◆ ProfisharkAPIGetDeviceMAC()

◆ ProfisharkAPIGetDeviceType()

◆ ProfisharkAPIGetLinkStatus()

◆ ProfisharkAPIGetVersions()