#include <limits.h>#include <stdint.h>#include <stdbool.h>Go to the source code of this file.
Macros | |
| #define | NT_INLINE inline |
| #define | NT_MAX_NUM_ADAPTERS 16 |
| #define | NT_SENSOR_NAN (int)0x80000000 |
| Indicates that sensor value or sensor limit is not valid (Not a Number) More... | |
| #define | NT_MAX_STREAM_NAME_LENGTH 20 |
Detailed Description
This file contains the Common types that can be used by any interface
Definition in file commontypes.h.
Macro Definition Documentation
| #define NT_INLINE inline |
Define cross-platform NT_INLINE keyword for static inline functions
Definition at line 71 of file commontypes.h.
| #define NT_MAX_NUM_ADAPTERS 16 |
Definition at line 75 of file commontypes.h.
| #define NT_SENSOR_NAN (int)0x80000000 |
Indicates that sensor value or sensor limit is not valid (Not a Number)
Sensor value
- Examples:
- eventMonitor_example.c, and sensor/sensor_example.c.
Definition at line 897 of file commontypes.h.
Referenced by DisplaySensorData(), and NT_TranslateSensorValue().
| #define NT_MAX_STREAM_NAME_LENGTH 20 |
Maximum name length for streams
Definition at line 912 of file commontypes.h.
Typedef Documentation
| typedef enum NtAdapterType_e NtAdapterType_t |
Definition at line 285 of file commontypes.h.
| typedef enum NtAdapterPciGeneration_e NtAdapterPciGeneration_t |
Definition at line 300 of file commontypes.h.
| typedef enum NtAdapterHwGeneration_e NtAdapterHwGeneration_t |
Definition at line 316 of file commontypes.h.
Definition at line 332 of file commontypes.h.
| typedef enum NtProductType_e NtProductType_t |
Definition at line 367 of file commontypes.h.
| typedef enum NtProductFamily_e NtProductFamily_t |
Definition at line 389 of file commontypes.h.
| typedef enum NtPortType_e NtPortType_t |
Definition at line 520 of file commontypes.h.
| typedef enum NtPortType_e * NtPortType_p |
Definition at line 520 of file commontypes.h.
| typedef enum NtLinkState_e NtLinkState_t |
Definition at line 536 of file commontypes.h.
| typedef enum NtLinkState_e * NtLinkState_p |
Definition at line 536 of file commontypes.h.
| typedef enum NtLinkSpeed_e NtLinkSpeed_t |
Definition at line 558 of file commontypes.h.
| typedef enum NtLinkDuplex_e NtLinkDuplex_t |
Definition at line 569 of file commontypes.h.
| typedef enum NtLinkMDI_e NtLinkMDI_t |
Definition at line 581 of file commontypes.h.
| typedef enum NtLinkAutoNeg_e NtLinkAutoNeg_t |
Definition at line 594 of file commontypes.h.
| typedef enum NtForceTxLink_e NtForceTxLink_t |
Definition at line 606 of file commontypes.h.
| typedef enum NtTxPower_e NtTxPower_t |
Definition at line 619 of file commontypes.h.
| typedef enum NtPortId_e NtPortId_t |
Port ID mode
| typedef enum NtPortFec_e NtPortFec_t |
Port FEC (Forward Error Correction) mode
| typedef enum NtTimeSyncConnectorSetting_e NtTimeSyncConnectorSetting_t |
Definition at line 737 of file commontypes.h.
| typedef enum NtTimeSyncReference_e NtTimeSyncReference_t |
Definition at line 783 of file commontypes.h.
| typedef enum NtSensorType_e NtSensorType_t |
Definition at line 850 of file commontypes.h.
| typedef enum NtSensorSubType_e NtSensorSubType_t |
Definition at line 862 of file commontypes.h.
| typedef enum NtSensorState_e NtSensorState_t |
Definition at line 892 of file commontypes.h.
| typedef enum NtSensorsAdapterNT40E3_4_e NtSensorsAdapterNT40E3_4_t |
The following sensors are deprecated - generic types should be used instead.
| typedef enum NtSensorsPortNT40E3_4_e NtSensorsPortNT40E3_4_t |
| typedef enum NtSensorsAdapterNT20E3_2_e NtSensorsAdapterNT20E3_2_t |
The following sensors are deprecated - generic types should be used instead.
| typedef enum NtSensorsPortNT20E3_2_e NtSensorsPortNT20E3_2_t |
The following sensors are deprecated - generic types should be used instead.
| typedef enum NtSensorsPortNT40A01_4X1_e NtSensorsPortNT40A01_4X1_t |
| typedef enum NtSensorsAdapterNT50B01_e NtSensorsAdapterNT50B01_t |
| typedef enum NtSensorsAdapterPSU2GA_e NtSensorsAdapterPSU2GA_t |
The following sensors are deprecated - generic types should be used instead.
| typedef enum NtSensorsAdapterNT80E3_2_e NtSensorsAdapterNT80E3_2_t |
The following sensors are deprecated - generic types should be used instead.
| typedef enum NtSensorsAdapterNT100E3_e NtSensorsAdapterNT100E3_t |
| typedef enum NtSensorsAdapterNT200E3_e NtSensorsAdapterNT200E3_t |
The following sensors are deprecated - generic types should be used instead.
| typedef enum NtSensorsAdapterNT200A01_e NtSensorsAdapterNT200A01_t |
The following sensors are deprecated - generic types should be used instead.
| typedef enum NtSensorsAdapterNT200A02_e NtSensorsAdapterNT200A02_t |
The following sensors are deprecated - generic types should be used instead.
| typedef enum NtSensorsAdapterNT40E3_AFU_e NtSensorsAdapterNT40E3_AFU_t |
| typedef enum NtSensorsAdapterNT400D11_e NtSensorsAdapterNT400D11_t |
| typedef enum NtSensorsAdapterNT400D13_e NtSensorsAdapterNT400D13_t |
| typedef enum NtPTPProfile_e NtPTPProfile_t |
| typedef enum NtHostLoopback_e NtHostLoopback_t |
Host loopback position.
The available loopback positions are adapter dependent and undocumented but for each adapter a default host loopback position has been defined. Therefore only the following values should be used.
| typedef enum NtLineLoopback_e NtLineLoopback_t |
Line loopback position.
The available loopback positions are adapter dependent and undocumented but for each adapter a default line loopback position has been defined. Therefore only the following values should be used.
Enumeration Type Documentation
| enum IniFileCreateMode_e |
Enumeration used for specifying the flavour when generation the ini file.
| Enumerator | |
|---|---|
| INI_FILE_CREATE_MODE_MINIMUM | |
| INI_FILE_CREATE_MODE_NORMAL | |
| INI_FILE_CREATE_MODE_FULL | |
| INI_FILE_CREATE_MODE_DEBUG | |
| INI_FILE_CREATE_MODE_ILLEGAL | |
Definition at line 78 of file commontypes.h.
| enum HelpFileCreateMode_e |
Enumeration used for specifying the flavour when generation the ini help text file.
| Enumerator | |
|---|---|
| HELP_FILE_CREATE_MODE_NORMAL | |
| HELP_FILE_CREATE_MODE_FULL | |
| HELP_FILE_CREATE_MODE_SECRET | |
| HELP_FILE_CREATE_MODE_ILLEGAL | |
Definition at line 87 of file commontypes.h.
| enum NtTimestampType_e |
Timestamp type.
Definition at line 97 of file commontypes.h.
| enum NtTimestampMethod_e |
Time stamp method
| Enumerator | |
|---|---|
| NT_TIMESTAMP_METHOD_UNKNOWN |
Time stamp method unknown. |
| NT_TIMESTAMP_METHOD_SOF |
Time stamp at start of frame. |
| NT_TIMESTAMP_METHOD_EOF |
Time stamp at end of frame. |
Definition at line 116 of file commontypes.h.
Time stamp inject offset
Definition at line 125 of file commontypes.h.
Time stamp inject dynamic offset
Definition at line 135 of file commontypes.h.
| enum NtTxTimingMethod_e |
Relative TX timing method
| Enumerator | |
|---|---|
| NT_TX_TIMING_UNSUPPORTED |
Changing TX timing is unsupported. |
| NT_TX_TIMING_ABSOLUTE |
TX is made absolute (time stamp based) |
| NT_TX_TIMING_RELATIVE |
TX is made relative (IFG based) |
Definition at line 147 of file commontypes.h.
| enum NtThreadPriority_e |
Thread Priority
Definition at line 156 of file commontypes.h.
| enum NtWISMode_e |
WIS Mode bit mask
| Enumerator | |
|---|---|
| NT_WIS_MODE_DISABLED |
OC-192 WIS mode HW Support but disabled. |
| NT_WIS_MODE_ENABLED |
OC-192 WIS mode enabled. |
Definition at line 165 of file commontypes.h.
| Enumerator | |
|---|---|
| NT_HIGH_FREQUENCY_SAMPLING_DISABLE |
High frequency sampling not used. |
| NT_HIGH_FREQUENCY_SAMPLING_ENABLE |
High frequency sampling activated. |
Definition at line 170 of file commontypes.h.
| Enumerator | |
|---|---|
| NT_OS_TIMESYNC_FAILOVER_DISABLE |
OS Timesync failover disabled. |
| NT_OS_TIMESYNC_FAILOVER_ENABLE |
OS Timesync failover enabled. |
Definition at line 175 of file commontypes.h.
Host buffer types. Used to select between RX or TX host buffers.
Definition at line 184 of file commontypes.h.
Host buffer layout Defined how the host buffer layout is defined
Definition at line 194 of file commontypes.h.
| enum NtMsgEndpoint_e |
The stream types supported.
Definition at line 203 of file commontypes.h.
| enum NtAdapterType_e |
Adapter types
Definition at line 220 of file commontypes.h.
Adapter PCI generation
| Enumerator | |
|---|---|
| NT_ADAPTER_PCI_GENERATION_UNKNOWN | |
| NT_ADAPTER_PCI_GENERATION_1 | |
| NT_ADAPTER_PCI_GENERATION_2 | |
| NT_ADAPTER_PCI_GENERATION_3 | |
| NT_ADAPTER_PCI_GENERATION_4 | |
| NT_ADAPTER_PCI_GENERATION_5 | |
Definition at line 291 of file commontypes.h.
Adapter hardware generation
NOTE: This is NOT equal to PCIe generation
| Enumerator | |
|---|---|
| NT_ADAPTER_HW_GENERATION_UNKNOWN | |
| NT_ADAPTER_HW_GENERATION_1GA | |
| NT_ADAPTER_HW_GENERATION_2GA | |
| NT_ADAPTER_HW_GENERATION_3GA | |
| NT_ADAPTER_HW_GENERATION_4GA | |
Definition at line 308 of file commontypes.h.
Adapter FPGA Architecture Generation
NOTE: may differ from Adapter (hardware) generation
| Enumerator | |
|---|---|
| NT_ADAPTER_FPGA_ARCH_GENERATION_UNKNOWN | |
| NT_ADAPTER_FPGA_ARCH_GENERATION_1 | |
| NT_ADAPTER_FPGA_ARCH_GENERATION_2 | |
| NT_ADAPTER_FPGA_ARCH_GENERATION_3 | |
| NT_ADAPTER_FPGA_ARCH_GENERATION_4 | |
Definition at line 324 of file commontypes.h.
Packet descriptor type
Definition at line 337 of file commontypes.h.
Definition at line 348 of file commontypes.h.
| enum NtProductType_e |
Product types
Definition at line 358 of file commontypes.h.
| enum NtProfileType_e |
Profile types
Definition at line 372 of file commontypes.h.
| enum NtProductFamily_e |
Product family
| Enumerator | |
|---|---|
| NT_PRODUCT_FAMILY_UNKNOWN |
Unknown product family. |
| NT_PRODUCT_FAMILY_NT |
NT adapter family. |
| NT_PRODUCT_FAMILY_NIC |
Standard NIC product family. |
Definition at line 383 of file commontypes.h.
| enum NtFeatureType_e |
Definition at line 391 of file commontypes.h.
| enum NtSdramSize_e |
SDRAM module sizes
Definition at line 403 of file commontypes.h.
| enum NtSdramType_e |
SDRAM module type
| Enumerator | |
|---|---|
| NT_SDRAM_TYPE_UNKNOWN |
Unknown RAM type. |
| NT_SDRAM_TYPE_DDR2 |
RAM is DDR2. |
| NT_SDRAM_TYPE_DDR3 |
RAM is DDR3. |
| NT_SDRAM_TYPE_DDR4 |
RAM is DDR4. |
Definition at line 431 of file commontypes.h.
SDRAM OnboardMemorySplit
Definition at line 441 of file commontypes.h.
| enum NtPortType_e |
Port types The use of all non-generic XX_NOT_PRESENT is deprecated - use NT_PORT_TYPE_NIM_NOT_PRESENT instead
Definition at line 454 of file commontypes.h.
| enum NtLinkState_e |
Link state.
Just after start of ntservice the link state might be unknown since the monitoring routine is busy reading NIM state and NIM data. This might also be the case after a NIM is plugged into an interface. The error state indicates a HW reading error.
Definition at line 529 of file commontypes.h.
| enum NtLinkSpeed_e |
Link speed. Note this is a bitmask.
Definition at line 542 of file commontypes.h.
| enum NtLinkDuplex_e |
Link duplex mode
| Enumerator | |
|---|---|
| NT_LINK_DUPLEX_UNKNOWN | |
| NT_LINK_DUPLEX_HALF |
Half duplex. |
| NT_LINK_DUPLEX_FULL |
Full duplex. |
Definition at line 563 of file commontypes.h.
| enum NtLinkMDI_e |
Link MDI mode
| Enumerator | |
|---|---|
| NT_LINK_MDI_NA | |
| NT_LINK_MDI_AUTO |
MDI auto. |
| NT_LINK_MDI_MDI |
MDI mode. |
| NT_LINK_MDI_MDIX |
MDIX mode. |
Definition at line 574 of file commontypes.h.
| enum NtLinkAutoNeg_e |
Link Auto/Manual mode
| Enumerator | |
|---|---|
| NT_LINK_AUTONEG_NA | |
| NT_LINK_AUTONEG_MANUAL | |
| NT_LINK_AUTONEG_OFF |
Auto negotiation OFF. |
| NT_LINK_AUTONEG_AUTO | |
| NT_LINK_AUTONEG_ON |
Auto negotiation ON. |
Definition at line 586 of file commontypes.h.
| enum NtForceTxLink_e |
ForceTxLink mode
| Enumerator | |
|---|---|
| NT_FORCE_TX_LINK_UNKNOWN | |
| NT_FORCE_TX_LINK_DISABLE | |
| NT_FORCE_TX_LINK_ENABLE | |
Definition at line 600 of file commontypes.h.
| enum NtTxPower_e |
TX laser power mode
Definition at line 612 of file commontypes.h.
| enum NtPortId_e |
Port ID mode
Definition at line 624 of file commontypes.h.
| enum NtPortFec_e |
Port FEC (Forward Error Correction) mode
| Enumerator | |
|---|---|
| NT_PORT_FEC_NA |
FEC is not available/unsupported. |
| NT_PORT_FEC_ON |
FEC is active. |
| NT_PORT_FEC_OFF |
FEC is inactive. |
Definition at line 635 of file commontypes.h.
| enum NtIfgMode_e |
Ifg unit
| Enumerator | |
|---|---|
| NT_IFG_NS |
Ifg unit is in 10 ns ticks. |
| NT_IFG_BYTE |
Ifg unit is in bytes. |
Definition at line 645 of file commontypes.h.
| enum NtBypassTrigger_e |
| Enumerator | |
|---|---|
| NT_BYPASS_TRIGGER_NONE |
TODO: |
| NT_BYPASS_TRIGGER_PWRFAIL |
TODO: |
Definition at line 654 of file commontypes.h.
| enum NtBypassPortState_e |
Definition at line 662 of file commontypes.h.
| Enumerator | |
|---|---|
| NT_OPERATION_UNKNOWN |
TODO: |
| NT_OPERATION_READ |
TODO: |
| NT_OPERATION_WRITE |
TODO: |
Definition at line 672 of file commontypes.h.
| enum NtTimeSyncProtocol_e |
Time sync protocol
Definition at line 683 of file commontypes.h.
Time sync PPS actions
Definition at line 694 of file commontypes.h.
Time sync connectors
Definition at line 703 of file commontypes.h.
Time sync PPS current clock synchonization mode
Definition at line 714 of file commontypes.h.
Time sync connector settings
Definition at line 724 of file commontypes.h.
Time sync connector status
Definition at line 742 of file commontypes.h.
Time sync in-sync status
This is set according to the configured parameters TimeSyncOSInSyncLimit, TimeSyncPTPInSyncLimit, TimeSyncPPSInSyncLimit and TimeSyncNTTSInSyncLimit
Definition at line 755 of file commontypes.h.
Time sync PPS status
Definition at line 764 of file commontypes.h.
Time sync reference priority
Definition at line 773 of file commontypes.h.
Time sync frequency reference priority
Definition at line 788 of file commontypes.h.
Time sync sampling source identifier
Definition at line 797 of file commontypes.h.
Time sync sampling source status
Definition at line 810 of file commontypes.h.
| enum NtPTPPortState_e |
IEEE 1588 PTP port state identifier
Definition at line 821 of file commontypes.h.
| enum NtSensorType_e |
Sensor types
Definition at line 839 of file commontypes.h.
| enum NtSensorSubType_e |
Sensor subtypes
Definition at line 855 of file commontypes.h.
| enum NtSensorSource_e |
Sensor source
Definition at line 867 of file commontypes.h.
| enum NtSensorState_e |
Sensor state
Definition at line 884 of file commontypes.h.
| enum NtBondingType_e |
Master/Slave
Definition at line 902 of file commontypes.h.
NT20E2 Adapter sensors
When reading sensors using the Info Stream NtInfoSensor_t the source must be NtSensorSource_e::NT_SENSOR_SOURCE_ADAPTER to read the public sensors or NtSensorSource_e::NT_SENSOR_SOURCE_LEVEL1_ADAPTER to read the Diagnostic sensors.
Definition at line 923 of file commontypes.h.
| enum NtSensors_SFP |
Generic SFP/SFP+/SFP28 sensors
These sensors should be used instead of all adapter specific SFP sensors that have been deprecated..
| Enumerator | |
|---|---|
| NT_SENSOR_SFP_TEMP | |
| NT_SENSOR_SFP_SUPPLY | |
| NT_SENSOR_SFP_TX_BIAS | |
| NT_SENSOR_SFP_TX_POWER | |
| NT_SENSOR_SFP_RX_POWER | |
Definition at line 948 of file commontypes.h.
| enum NtSensors_QSFP |
Generic QSFP/QSFP+/QSFP28 sensors
These sensors should be used instead of all adapter specific QSFP sensors that have been deprecated..
Definition at line 962 of file commontypes.h.
Definition at line 980 of file commontypes.h.
NT40E2_4 Adapter sensors
When reading sensors using the Info Stream NtInfoSensor_t the source must be NtSensorSource_e::NT_SENSOR_SOURCE_ADAPTER to read the public sensors or NtSensorSource_e::NT_SENSOR_SOURCE_LEVEL1_ADAPTER to read the Diagnostic sensors.
Definition at line 1000 of file commontypes.h.
Definition at line 1020 of file commontypes.h.
NT40E2_1 Adapter sensors
When reading sensors using the Info Stream NtInfoSensor_t the source must be NtSensorSource_e::NT_SENSOR_SOURCE_ADAPTER to read the public sensors or NtSensorSource_e::NT_SENSOR_SOURCE_LEVEL1_ADAPTER to read the Diagnostic sensors.
Definition at line 1040 of file commontypes.h.
Definition at line 1059 of file commontypes.h.
| Enumerator | |
|---|---|
| NT_SENSOR_NT20E_FPGA |
FPGA temperature sensor (junction temperature) |
| NT_SENSOR_NT20E_PBA |
PCB temperature sensor (PCB temperature) |
| NT_SENSOR_NT20E_ADAPTER_MAX |
Number of NT20E adapter sensors. |
Definition at line 1080 of file commontypes.h.
| enum NtSensorsPortNT20E_e |
Definition at line 1087 of file commontypes.h.
| Enumerator | |
|---|---|
| NT_SENSOR_NT4E_FPGA |
FPGA temperature sensor (junction temperature) |
| NT_SENSOR_NT4E_PBA |
PCB temperature sensor (PCB temperature) |
| NT_SENSOR_NT4E_ADAPTER_MAX |
Number of NT4E adapter sensors. |
Definition at line 1098 of file commontypes.h.
| enum NtSensorsPortNT4E_e |
Definition at line 1106 of file commontypes.h.
Definition at line 1118 of file commontypes.h.
Definition at line 1136 of file commontypes.h.
Definition at line 1156 of file commontypes.h.
Definition at line 1168 of file commontypes.h.
Definition at line 1189 of file commontypes.h.
Definition at line 1201 of file commontypes.h.
Definition at line 1222 of file commontypes.h.
Definition at line 1234 of file commontypes.h.
Definition at line 1255 of file commontypes.h.
Definition at line 1268 of file commontypes.h.
Definition at line 1285 of file commontypes.h.
Definition at line 1304 of file commontypes.h.
Definition at line 1316 of file commontypes.h.
Definition at line 1343 of file commontypes.h.
Definition at line 1365 of file commontypes.h.
Definition at line 1391 of file commontypes.h.
Definition at line 1415 of file commontypes.h.
Definition at line 1436 of file commontypes.h.
Definition at line 1458 of file commontypes.h.
Definition at line 1478 of file commontypes.h.
Definition at line 1500 of file commontypes.h.
Definition at line 1515 of file commontypes.h.
Definition at line 1536 of file commontypes.h.
Definition at line 1558 of file commontypes.h.
Definition at line 1569 of file commontypes.h.
Definition at line 1583 of file commontypes.h.
| enum NtPTPProfile_e |
Definition at line 1595 of file commontypes.h.
| enum NtHostLoopback_e |
Host loopback position.
The available loopback positions are adapter dependent and undocumented but for each adapter a default host loopback position has been defined. Therefore only the following values should be used.
| Enumerator | |
|---|---|
| NT_HOST_LOOPBACK_NONE |
No host loopback. |
| NT_HOST_LOOPBACK_DEFAULT |
Default host loopback. |
Definition at line 1611 of file commontypes.h.
| enum NtLineLoopback_e |
Line loopback position.
The available loopback positions are adapter dependent and undocumented but for each adapter a default line loopback position has been defined. Therefore only the following values should be used.
| Enumerator | |
|---|---|
| NT_LINE_LOOPBACK_NONE |
No line loopback. |
| NT_LINE_LOOPBACK_DEFAULT |
Default line loopback. |
Definition at line 1622 of file commontypes.h.
| enum NtStreamIdState_e |
Stream-id state. When a stream-id is in the active state traffic is forwarded to the stream-id by the adapter When a stream-id is in the inactive state traffic is discarded by the adapter
| Enumerator | |
|---|---|
| NT_STREAM_ID_STATE_UNKNOWN |
Unknown stream-id state. |
| NT_STREAM_ID_STATE_ACTIVE |
Traffic is forwarded to the stream-id. |
| NT_STREAM_ID_STATE_INACTIVE |
Traffic is dropped. |
Definition at line 1632 of file commontypes.h.
| enum NtFeatureLevel_e |
Feature level. The feature level supported by the adapter/FPGA
Definition at line 1642 of file commontypes.h.