Info Stream

Reference Documentation

product_line_custom
Intel® PAC
Napatech SmartNIC
category
Reference Information
Napatech Software Suite: Info Stream

Detailed Description

Info streams are used to access system information. The info stream is read only.

To open an info stream call NT_InfoOpen. Once the info stream is open, the info read command needs to be set in the NtInfo_t structure and depending on the info command an adapter number, port number or similar also needs to be set. Once the NtInfo_t structure query is filled out, a call to NT_InfoRead makes the system read out the requested data. When done, call NT_InfoClose to close the stream.

The info stream read commands currently supported are:

  • System info - this includes the number of ports, adapters and sensors
  • Adapter info - this includes the number of sensors, ports, PCI ID and bus ID
  • Port info - this includes the port state, speed and duplex
  • Sensor info - this includes the sensor type, name and value
  • Host buffer info - this includes the NUMA node, size and feed
  • Time sync info - this includes the time sync connector and time sync data
  • Time sync external info - this includes the time sync information from a connected device
  • Stream ID info - this includes the Stream ID.
  • Product info - this includes the Product type, Product ID, Serial Number, PBA ID, AVR version, CPLD version and FPGA versions
  • PTP info - this includes the PTP related information

For an example of using the info stream see info/info_example.c

Note
The info stream is not thread-safe. If the same stream handle is to be used by multiple threads, it must be mutex protected in the application.

Functions

int NT_InfoOpen (NtInfoStream_t *hStream, const char *name)
 Opens an info stream. More...
 
int NT_InfoRead (NtInfoStream_t hStream, NtInfo_t *info)
 Reads data from an info stream. More...
 
int NT_InfoClose (NtInfoStream_t hStream)
 Closes an info stream. More...
 

Data Structures

struct  NtInfoSystem_s
 
struct  NtversionAvr_s
 
union  Ntpciid_u
 
struct  Ntpciid_u::Ntpciid_s
 
union  Ntfpgaid_u
 
struct  NtInfoWis_v1_s
 
struct  NtInfoGlobalSync_s
 
struct  NtInfoSDRAMInfo_s
 
struct  NtInfoPCIeInfo_s
 
struct  NtInfoBondingInfo_t
 
struct  NtInfoAdapter_v6_s
 
struct  NtInfoAdapter_v6_s::Ntbusid_v6_u::Ntbusid_v6_s
 
union  NtInfoAdapter_v6_s::Ntbusid_v6_u
 
struct  NtLinkCapabilities_s
 
struct  NtNIMLinkLength_s
 
struct  NtBypassPortInfo_s
 
struct  NtInfoPort_v9_s
 
struct  NtInfoSensor_s
 
struct  NtInfoStreamId_s
 
struct  NtInfoHostBuffer_v1_s
 
struct  NtInfoStreams_s
 
struct  NtInfoTimeSyncSample_s
 
struct  NtInfoTimeSync_v4_s
 
struct  NtInfoTimeSyncStatusExt_s
 
struct  NtInfoTimeSyncStatistics_s
 
struct  NtInfoCmdSystem_s
 
struct  NtInfoCmdAdapter_v6_s
 
struct  NtInfoCmdPort_v9_s
 
struct  NtInfoCmdSensor_s
 
struct  NtInfoCmdHostBuffer_v1_s
 
struct  NtInfoCmdStream_s
 
struct  NtInfoCmdstreamID_s
 
struct  NtInfoCmdTimeSync_v4_s
 
struct  NtInfoCmdTimeSyncStat_s
 
struct  NtInfoCmdTimeSyncStatusExt_s
 
struct  NtPTPTimestamp_s
 
struct  NtPTPPortStat_s
 
struct  NtPTPPort_s
 
struct  NtPTPclkQuality_s
 
struct  NtPTPdefaultDs_s
 
struct  NtPTPcurrentDs_s
 
struct  NtPTPparentDs_s
 
struct  NtPTPtimePropertiesDs_s
 
struct  NtPTPportDs_s
 
struct  NtPTPDataSets_s
 
struct  NtPTPImplCfg_s
 
struct  NtInfoPTP_v2_s
 
struct  NtInfoCmdPTP_v2_s
 
struct  NtInfoProductInfo_v2_s
 
struct  NtInfoReadProductInfo_v2_s
 
struct  NtInfoFilterUsage3ga_s
 
struct  NtInfoFilterUsage4ga_s
 
struct  NtInfoFilterUsage_v1_s
 
struct  NtInfoCmdFilterUsage_v1_s
 
struct  NtInfoPortPathDelay_s
 
struct  NtInfoCmdPortPathDelay_s
 
struct  NtInfoPropertyValue_s
 
struct  NtInfoProperty_s
 
struct  NtInfo_s
 
union  NtInfo_s::NtInfo_u
 

Macros

#define NT_TIME_SYNC_CLOCK_RATE_ADJ_UNKNOWN   1000000000
 Used for timeSyncClockRateAdjustment and timeSyncOSClockRateAdjustment parameters to indicate that no clock rate adjustment is retrievable. More...
 
#define NT_PATH_DELAY_RX_DIR   0
 
#define NT_PATH_DELAY_TX_DIR   1
 

Typedefs

typedef struct NtInfoSensor_s NtInfoSensor_t
 
typedef struct NtInfoSensor_sNtInfoSensor_p
 
typedef struct NtInfoProductInfo_v2_s NtInfoProductInfo_v2_t
 
typedef struct NtInfoFilterUsage3ga_s NtInfoFilterUsage3ga_t
 
typedef struct NtInfoFilterUsage4ga_s NtInfoFilterUsage4ga_t
 
typedef struct NtInfoFilterUsage_v1_s NtInfoFilterUsage_v1_t
 
typedef struct NtInfoPortPathDelay_s NtInfoPortPathDelayInfo_t
 
typedef struct NtInfoPropertyValue_s NtInfoPropertyValue_t
 
typedef struct NtInfo_s NtInfo_t
 
typedef struct NtInfoStream_s * NtInfoStream_t
 

Enumerations

enum  NtInfoCmd_e {
  NT_INFO_CMD_READ_UNKNOWN =0, NT_INFO_CMD_READ_SYSTEM, NT_INFO_CMD_READ_COMPAT_0, NT_INFO_CMD_READ_COMPAT_1,
  NT_INFO_CMD_READ_SENSOR, NT_INFO_CMD_READ_COMPAT_3, NT_INFO_CMD_READ_STREAM, NT_INFO_CMD_READ_COMPAT_2,
  NT_INFO_CMD_READ_COMPAT_5, NT_INFO_CMD_READ_COMPAT_4, NT_INFO_CMD_READ_COMPAT_6, NT_INFO_CMD_READ_HOSTBUFFER_V1,
  NT_INFO_CMD_READ_COMPAT_9, NT_INFO_CMD_READ_STREAMID, NT_INFO_CMD_READ_COMPAT_10, NT_INFO_CMD_READ_TIMESYNC_STATUS_EXT,
  NT_INFO_CMD_READ_COMPAT_7, NT_INFO_CMD_READ_COMPAT_8, NT_INFO_CMD_READ_COMPAT_19, NT_INFO_CMD_READ_COMPAT_11,
  NT_INFO_CMD_READ_COMPAT_12, NT_INFO_CMD_READ_COMPAT_15, NT_INFO_CMD_READ_COMPAT_23, NT_INFO_CMD_READ_COMPAT_21,
  NT_INFO_CMD_READ_PATH_DELAY, NT_INFO_CMD_READ_COMPAT_13, NT_INFO_CMD_READ_COMPAT_14, NT_INFO_CMD_READ_COMPAT_17,
  NT_INFO_CMD_READ_COMPAT_16, NT_INFO_CMD_READ_TIMESYNC_STAT, NT_INFO_CMD_READ_PTP_V2, NT_INFO_CMD_READ_COMPAT_18,
  NT_INFO_CMD_READ_ADAPTER_V6, NT_INFO_CMD_READ_COMPAT_20, NT_INFO_CMD_READ_COMPAT_22, NT_INFO_CMD_READ_COMPAT_24,
  NT_INFO_CMD_READ_TIMESYNC_V4, NT_INFO_CMD_READ_PRODUCT_INFO_V2, NT_INFO_CMD_READ_FILTERUSAGE_V1, NT_INFO_CMD_READ_PROPERTY,
  NT_INFO_CMD_READ_PORT_V9
}
 
enum  { NT_AVR_NOT_VALID = 0, NT_AVR_VALID_2 = 1, NT_AVR_VALID_1 = 2 }
 
enum  NtPortFeatureMask_e {
  NT_PORT_FEATURE_DMA_TRANSMIT =1LL<<0, NT_PORT_FEATURE_HARDSLICE_AT_MAXFRAMESIZE =1LL<<1, NT_PORT_FEATURE_IPV4_TX_CHECKSUM_CALC =1LL<<2, NT_PORT_FEATURE_UDP_TX_CHECKSUM_CALC =1LL<<3,
  NT_PORT_FEATURE_TCP_TX_CHECKSUM_CALC =1LL<<4, NT_PORT_FEATURE_INJECT_TX_TS =1LL<<5, NT_PORT_FEATURE_TIMED_TX =1LL<<6, NT_PORT_FEATURE_BYPASS =1LL<<7,
  NT_PORT_FEATURE_DISABLE =1LL<<8, NT_PORT_FEATURE_64BIT_TIMESTAMP =1LL<<9, NT_PORT_FEATURE_RX_ONLY =1LL<<10, NT_PORT_FEATURE_TX_REPLICATE =1LL<<11,
  NT_PORT_FEATURE_FCS_TX_CHECKSUM_CALC =1LL<<12
}
 
enum  NtNimIdentifier_e {
  NT_NIM_UNKNOWN = 0x00, NT_NIM_GBIC = 0x01, NT_NIM_FIXED = 0x02, NT_NIM_SFP_SFP_PLUS = 0x03,
  NT_NIM_300_PIN_XBI = 0x04, NT_NIM_XEN_PAK = 0x05, NT_NIM_XFP = 0x06, NT_NIM_XFF = 0x07,
  NT_NIM_XFP_E = 0x08, NT_NIM_XPAK = 0x09, NT_NIM_X2 = 0x0A, NT_NIM_DWDM = 0x0B,
  NT_NIM_QSFP = 0x0C, NT_NIM_QSFP_PLUS = 0x0D, NT_NIM_QSFP28 = 0x11, NT_NIM_CFP4 = 0x12
}
 
enum  NtPortStatusMask_e { NT_PORT_IFG_BYTE_MODE =1LL<<0 }
 
enum  NtTsStatSupport_e { NT_TIMESYNC_STATISTICS_NO_SUPPORT = 0, NT_TIMESYNC_STATISTICS_PTP_ONLY = 1, NT_TIMESYNC_STATISTICS_FULL_SUPPORT = 2 }
 
enum  NtPTPNetProt_e {
  NT_PTP_NETW_PROTOCOL_NA = 0, NT_PTP_NETW_PROTOCOL_IPV4_UDP = 1, NT_PTP_NETW_PROTOCOL_IPV6_UDP = 2, NT_PTP_NETW_PROTOCOL_IEEE802_3 = 3,
  NT_PTP_NETW_PROTOCOL_DEVICENET = 4, NT_PTP_NETW_PROTOCOL_CONTROLNET = 5, NT_PTP_NETW_PROTOCOL_PROFINET = 6
}
 
enum  NtPTPFilter_e { NT_PTP_FILTER_NONE = 0, NT_PTP_FILTER_MIN = 1, NT_PTP_FILTER_PDV = 2 }
 
enum  NtPTPTimeSource_e {
  NT_PTP_TIMESOURCE_NA = 0, NT_PTP_TIMESOURCE_ATOMIC = 0x10, NT_PTP_TIMESOURCE_GPS = 0x20, NT_PTP_TIMESOURCE_TER_RADIO = 0x30,
  NT_PTP_TIMESOURCE_PTP = 0x40, NT_PTP_TIMESOURCE_NTP = 0x50, NT_PTP_TIMESOURCE_HAND_SET = 0x60, NT_PTP_TIMESOURCE_OTHER = 0x90,
  NT_PTP_TIMESOURCE_OSCILLATOR = 0xA0
}
 
enum  NtPTPDelayMech_e { NT_PTP_DELAY_MECHANISM_NA = 0x00, NT_PTP_DELAY_MECHANISM_E2E = 0x01, NT_PTP_DELAY_MECHANISM_P2P = 0x02, NT_PTP_DELAY_MECHANISM_DISABLED = 0xFE }
 
enum  NtPTPClockType_e {
  NT_PTP_CLOCK_TYPE_ORDINARY = 0, NT_PTP_CLOCK_TYPE_BOUNDARY = 1, NT_PTP_CLOCK_TYPE_P2P_TRANSPARENT = 2, NT_PTP_CLOCK_TYPE_E2E_TRANSPARENT = 3,
  NT_PTP_CLOCK_TYPE_MANAGEMENT = 4
}
 
enum  NtProductInfoType_e {
  NT_PRODUCT_INFO_TYPE_NONE =0, NT_PRODUCT_INFO_TYPE_GEN1, NT_PRODUCT_INFO_TYPE_GEN2, NT_PRODUCT_INFO_TYPE_NTBPE,
  NT_PRODUCT_INFO_TYPE_GEN3
}
 
enum  NtPathDelayStatus_e { NT_PATH_DELAY_SUCCESS = 0x0, NT_PATH_DELAY_NOT_SUPPORTED = 0x1, NT_PATH_DELAY_LINK_DOWN = 0x2, NT_PATH_DELAY_UNKNOWN_NIM = 0x4 }
 
enum  NtPropertyType_e { NT_PROPERTY_TYPE_INT = 0, NT_PROPERTY_TYPE_UINT, NT_PROPERTY_TYPE_STRING }
 

Data Structure Documentation

struct NtInfoSystem_s

This structure will return the system-wide information

Definition at line 128 of file stream_info.h.

Data Fields

uint8_t numNumaNodes
 The number of online NUMA nodes in the system. More...
 
uint8_t Reserved1 [3]
 
uint8_t numAdapters
 The number of adapters in the system. More...
 
uint8_t Reserved2 [3]
 
uint8_t numPorts
 The number of ports in the system. More...
 
uint8_t Reserved3 [3]
 
struct {
   int32_t   major
 The major release number. More...
 
   int32_t   minor
 The minor release number. More...
 
   int32_t   patch
 The major/minor patch release. More...
 
   int32_t   tag
 The release tag number. More...
 
version
 

Field Documentation

uint8_t NtInfoSystem_s::numNumaNodes

The number of online NUMA nodes in the system.

Examples:
info/info_example.c.

Definition at line 129 of file stream_info.h.

Referenced by main().

uint8_t NtInfoSystem_s::Reserved1[3]

Definition at line 130 of file stream_info.h.

uint8_t NtInfoSystem_s::numAdapters

The number of adapters in the system.

Examples:
bypass/config/bypass_config_example.c, bypass/info/bypass_info_example.c, bypass/watchdog/bypass_watchdog_example.c, info/info_example.c, pps/pps_example.c, and sensor/sensor_example.c.

Definition at line 131 of file stream_info.h.

Referenced by main().

uint8_t NtInfoSystem_s::Reserved2[3]

Definition at line 132 of file stream_info.h.

uint8_t NtInfoSystem_s::numPorts

The number of ports in the system.

Examples:
bypass/config/bypass_config_example.c, bypass/info/bypass_info_example.c, bypass/watchdog/bypass_watchdog_example.c, info/info_example.c, and sensor/sensor_example.c.

Definition at line 133 of file stream_info.h.

Referenced by main().

uint8_t NtInfoSystem_s::Reserved3[3]

Definition at line 134 of file stream_info.h.

int32_t NtInfoSystem_s::major

The major release number.

Examples:
bypass/config/bypass_config_example.c, bypass/info/bypass_info_example.c, bypass/watchdog/bypass_watchdog_example.c, and sensor/sensor_example.c.

Definition at line 139 of file stream_info.h.

Referenced by main().

int32_t NtInfoSystem_s::minor

The minor release number.

Examples:
bypass/config/bypass_config_example.c, bypass/info/bypass_info_example.c, bypass/watchdog/bypass_watchdog_example.c, and sensor/sensor_example.c.

Definition at line 140 of file stream_info.h.

Referenced by main().

int32_t NtInfoSystem_s::patch

The major/minor patch release.

Examples:
bypass/config/bypass_config_example.c, bypass/info/bypass_info_example.c, bypass/watchdog/bypass_watchdog_example.c, and sensor/sensor_example.c.

Definition at line 141 of file stream_info.h.

Referenced by main().

int32_t NtInfoSystem_s::tag

The release tag number.

Examples:
bypass/config/bypass_config_example.c, bypass/info/bypass_info_example.c, bypass/watchdog/bypass_watchdog_example.c, and sensor/sensor_example.c.

Definition at line 142 of file stream_info.h.

Referenced by main().

struct { ... } NtInfoSystem_s::version
struct NtversionAvr_s

Definition at line 152 of file stream_info.h.

Data Fields

uint8_t valid
 Does this structure contain valid data (not all adapters use this structure) More...
 
struct {
   uint8_t   version_major
 The major version. More...
 
   uint8_t   version_minor
 The minor version. More...
 
   uint8_t   version_build
 The build number. More...
 
avr [2]
 

Field Documentation

uint8_t NtversionAvr_s::valid

Does this structure contain valid data (not all adapters use this structure)

Definition at line 153 of file stream_info.h.

uint8_t NtversionAvr_s::version_major

The major version.

Definition at line 155 of file stream_info.h.

uint8_t NtversionAvr_s::version_minor

The minor version.

Definition at line 156 of file stream_info.h.

uint8_t NtversionAvr_s::version_build

The build number.

Definition at line 157 of file stream_info.h.

struct { ... } NtversionAvr_s::avr[2]
union Ntpciid_u

Definition at line 161 of file stream_info.h.

Data Fields

struct Ntpciid_u::Ntpciid_s s
 
uint32_t value
 The PCI ID, for example, 0x18540064. More...
 

Field Documentation

struct Ntpciid_u::Ntpciid_s Ntpciid_u::s
Examples:
info/info_example.c.

Referenced by main().

uint32_t Ntpciid_u::value

The PCI ID, for example, 0x18540064.

Definition at line 173 of file stream_info.h.

struct Ntpciid_u::Ntpciid_s

PCI ID can be read as: 32-bit value, 2 x 16-bit values defining device ID and vendor ID

Definition at line 169 of file stream_info.h.

Data Fields

uint16_t device
 The device ID, for example, NT20E in-line 0x64. More...
 
uint16_t vendor
 The vendor ID, for example, Napatech 0x18F4. More...
 

Field Documentation

uint16_t Ntpciid_u::Ntpciid_s::device

The device ID, for example, NT20E in-line 0x64.

Examples:
info/info_example.c.

Definition at line 170 of file stream_info.h.

Referenced by main().

uint16_t Ntpciid_u::Ntpciid_s::vendor

The vendor ID, for example, Napatech 0x18F4.

Examples:
info/info_example.c.

Definition at line 171 of file stream_info.h.

Referenced by main().

union Ntfpgaid_u

Definition at line 176 of file stream_info.h.

Data Fields

struct {
   uint32_t   rev:8
 The FPGA revision. More...
 
   uint32_t   ver:8
 The FPGA version. More...
 
   uint32_t   product:16
 The FPGA product code. More...
 
   uint32_t   item:12
 The FPGA item type (200 is FPGA, 201 is CPLD) More...
 
   uint32_t   build:10
 The build number - non-zero for R&D builds. More...
 
   uint32_t   reserved:10
 
s
 
uint64_t value
 The raw 64-bit FPGA ID. More...
 

Field Documentation

uint32_t Ntfpgaid_u::rev

The FPGA revision.

Examples:
hashref/calc_single_hash/calc_single_hash.c.

Definition at line 178 of file stream_info.h.

Referenced by set_adapter_info().

uint32_t Ntfpgaid_u::ver

The FPGA version.

Examples:
hashref/calc_single_hash/calc_single_hash.c.

Definition at line 179 of file stream_info.h.

Referenced by set_adapter_info().

uint32_t Ntfpgaid_u::product

The FPGA product code.

Examples:
hashref/calc_single_hash/calc_single_hash.c.

Definition at line 180 of file stream_info.h.

Referenced by set_adapter_info().

uint32_t Ntfpgaid_u::item

The FPGA item type (200 is FPGA, 201 is CPLD)

Examples:
hashref/calc_single_hash/calc_single_hash.c.

Definition at line 181 of file stream_info.h.

Referenced by set_adapter_info().

uint32_t Ntfpgaid_u::build

The build number - non-zero for R&D builds.

Examples:
hashref/calc_single_hash/calc_single_hash.c.

Definition at line 182 of file stream_info.h.

Referenced by set_adapter_info().

uint32_t Ntfpgaid_u::reserved

Definition at line 183 of file stream_info.h.

struct { ... } Ntfpgaid_u::s
Examples:
hashref/calc_single_hash/calc_single_hash.c.

Referenced by set_adapter_info().

uint64_t Ntfpgaid_u::value

The raw 64-bit FPGA ID.

Definition at line 185 of file stream_info.h.

struct NtInfoWis_v1_s

Structure to hold information about WIS mode

Definition at line 191 of file stream_info.h.

Data Fields

int supported
 Is WIS mode supported by the adapter - 1 supported, 0: not supported. More...
 
enum NtWISMode_e mode
 Is WIS mode enabled. More...
 
uint32_t mask
 Wismode port enable mask -> bit 0 = port0, bit 1 = port 1 etc. More...
 

Field Documentation

int NtInfoWis_v1_s::supported

Is WIS mode supported by the adapter - 1 supported, 0: not supported.

Definition at line 192 of file stream_info.h.

enum NtWISMode_e NtInfoWis_v1_s::mode

Is WIS mode enabled.

Definition at line 193 of file stream_info.h.

uint32_t NtInfoWis_v1_s::mask

Wismode port enable mask -> bit 0 = port0, bit 1 = port 1 etc.

Definition at line 194 of file stream_info.h.

struct NtInfoGlobalSync_s

Structure to hold information about global sync

Definition at line 200 of file stream_info.h.

Data Fields

int supported
 Is global sync supported. More...
 
uint32_t portEnableMask
 Enables coordinated time synchronized transmit on port bit mask. More...
 
uint64_t timeSynchronizedTxOffset
 Time offset between time stamp in first frame and adapter time. More...
 

Field Documentation

int NtInfoGlobalSync_s::supported

Is global sync supported.

Examples:
net/replayGS/replayGS_example.c.

Definition at line 201 of file stream_info.h.

Referenced by main().

uint32_t NtInfoGlobalSync_s::portEnableMask

Enables coordinated time synchronized transmit on port bit mask.

Definition at line 202 of file stream_info.h.

uint64_t NtInfoGlobalSync_s::timeSynchronizedTxOffset

Time offset between time stamp in first frame and adapter time.

Definition at line 203 of file stream_info.h.

struct NtInfoSDRAMInfo_s

Structure to read SDRAM information

Definition at line 209 of file stream_info.h.

Data Fields

int present
 Is the SDRAM present. More...
 
enum NtSdramSize_e size
 The physical SDRAM chip size. More...
 

Field Documentation

int NtInfoSDRAMInfo_s::present

Is the SDRAM present.

Definition at line 210 of file stream_info.h.

enum NtSdramSize_e NtInfoSDRAMInfo_s::size

The physical SDRAM chip size.

Definition at line 211 of file stream_info.h.

struct NtInfoPCIeInfo_s

Structure to read PCIe information

Definition at line 217 of file stream_info.h.

Data Fields

int pciGen
 PCI generation. More...
 
int numLanes
 Number of PCI lanes. More...
 
int numLanesSupported
 The number of lanes supported by the adapter. More...
 
int maxPayloadSupported
 The maximum supported payload by the adapter. More...
 
int maxPayload
 The negotiated maximum payload. More...
 
uint32_t measuredRxThroughput
 RX PCI throughput. More...
 
uint32_t measuredTxThroughput
 TX PCI throughput. More...
 
uint32_t measuredCombinedRxThroughput
 Combined RX throughput. More...
 
uint32_t measuredCombinedTxThroughput
 Combined RX throughput. More...
 

Field Documentation

int NtInfoPCIeInfo_s::pciGen

PCI generation.

Definition at line 218 of file stream_info.h.

int NtInfoPCIeInfo_s::numLanes

Number of PCI lanes.

Definition at line 219 of file stream_info.h.

int NtInfoPCIeInfo_s::numLanesSupported

The number of lanes supported by the adapter.

Definition at line 220 of file stream_info.h.

int NtInfoPCIeInfo_s::maxPayloadSupported

The maximum supported payload by the adapter.

Definition at line 221 of file stream_info.h.

int NtInfoPCIeInfo_s::maxPayload

The negotiated maximum payload.

Definition at line 222 of file stream_info.h.

uint32_t NtInfoPCIeInfo_s::measuredRxThroughput

RX PCI throughput.

Definition at line 223 of file stream_info.h.

uint32_t NtInfoPCIeInfo_s::measuredTxThroughput

TX PCI throughput.

Definition at line 224 of file stream_info.h.

uint32_t NtInfoPCIeInfo_s::measuredCombinedRxThroughput

Combined RX throughput.

Definition at line 225 of file stream_info.h.

uint32_t NtInfoPCIeInfo_s::measuredCombinedTxThroughput

Combined RX throughput.

Definition at line 226 of file stream_info.h.

struct NtInfoBondingInfo_t

Adapter bonding information

Definition at line 232 of file stream_info.h.

Data Fields

uint32_t bonded
 Has this adapter been bonded with another. More...
 
uint8_t remoteAdapter
 The adapter this adapter is bonded with. More...
 
enum NtBondingType_e type
 Is the adapter master or slave. More...
 

Field Documentation

uint32_t NtInfoBondingInfo_t::bonded

Has this adapter been bonded with another.

Definition at line 233 of file stream_info.h.

uint8_t NtInfoBondingInfo_t::remoteAdapter

The adapter this adapter is bonded with.

Definition at line 234 of file stream_info.h.

enum NtBondingType_e NtInfoBondingInfo_t::type

Is the adapter master or slave.

Definition at line 235 of file stream_info.h.

struct NtInfoAdapter_v6_s

This structure will return the adapter specific info version 6. Must be a mirror of NtInfoAdapter_v5_s with version 6 variables added to the bottom.

Definition at line 245 of file stream_info.h.

Data Fields

uint8_t numSensors
 The number of sensors on this adapter. More...
 
uint8_t Reserved1 [3]
 
uint8_t numLevel1Sensors
 The number of level 1 sensors on this adapter. More...
 
uint8_t Reserved2 [3]
 
uint8_t portOffset
 The port numbers of this adapter start at this port offset. More...
 
uint8_t Reserved3 [3]
 
uint8_t numPorts
 The number of ports on this adapter. More...
 
uint8_t Reserved4 [3]
 
uint8_t numPhysicalAdapters
 The number of physical adapters grouped in this virtual adapter. More...
 
uint8_t Reserved5 [3]
 
uint32_t numHostBuffersRx
 The number of RX host buffers on this adapter. More...
 
uint32_t numHostBuffersTx
 The number of TX host buffers on this adapter. More...
 
uint32_t numTsConnectors
 The number of time sync connectors on this adapter. More...
 
enum NtAdapterType_e adapterType
 The adapter type. More...
 
enum NtProductType_e productType
 The product line type. More...
 
enum NtProfileType_e profile
 The profile the adapter is using. More...
 
uint32_t supportedProfilesBitmask
 The profiles supported by the adapter - the value is represented as a bitmask of NtProfileType_e values. More...
 
uint32_t adapterFeatures
 The features supported by the adapter - the value is represented as a bitmask of NtFeatureType_e values. More...
 
enum NtProductFamily_e productFamily
 The product family. More...
 
char name [128]
 The adapter name. More...
 
char serialNo [50]
 The adapter serial number. More...
 
struct NtversionAvr_s avr
 
union NtInfoAdapter_v6_s::Ntbusid_v6_u busid
 
union Ntpciid_u pciid
 
struct NtInfoPCIeInfo_s pciInfo
 Information about the PCI bus. More...
 
union Ntfpgaid_u fpgaid
 
struct NtInfoSDRAMInfo_s sdramInfo
 The SDRAM information. More...
 
uint32_t extendedDescriptor
 The extended descriptor in use by RX - if 0 then no extended is used. More...
 
uint32_t supportedExtendedDescriptorsBitmask
 Bitmask of supported extended descriptors, for example, if bit 7 is set then extended descriptor 7 is supported, and if bit 8 it set then extended descriptor 8 is supported. More...
 
enum NtPacketDescriptorType_e descriptorType
 The descriptor type used. More...
 
enum NtTimestampType_e timestampType
 The time stamp type used by the adapter. More...
 
enum NtTimestampMethod_e timestampMethod
 The time stamp method (SOF/EOF) used by the adapter. More...
 
enum NtTxTimingMethod_e txTiming
 The TX timing. More...
 
struct NtInfoWis_v1_s wisMode
 Wis mode status. More...
 
enum NtTimestampInjectOffsetMode_e tsInjectModeOffset
 Time stamp injection offset mode. More...
 
struct NtInfoGlobalSync_s globalSync
 Global sync status. More...
 
NtInfoBondingInfo_t bondingInfo
 Adapter Bonding status. More...
 
enum NtFeatureLevel_e featureLevel
 Adapter/FPGA feature level. More...
 
uint16_t customId
 Custom identification number. More...
 

Field Documentation

uint8_t NtInfoAdapter_v6_s::numSensors

The number of sensors on this adapter.

Examples:
sensor/sensor_example.c.

Definition at line 246 of file stream_info.h.

Referenced by main().

uint8_t NtInfoAdapter_v6_s::Reserved1[3]

Definition at line 247 of file stream_info.h.

uint8_t NtInfoAdapter_v6_s::numLevel1Sensors

The number of level 1 sensors on this adapter.

Definition at line 248 of file stream_info.h.

uint8_t NtInfoAdapter_v6_s::Reserved2[3]

Definition at line 249 of file stream_info.h.

uint8_t NtInfoAdapter_v6_s::portOffset

The port numbers of this adapter start at this port offset.

Examples:
bypass/config/bypass_config_example.c, bypass/info/bypass_info_example.c, bypass/watchdog/bypass_watchdog_example.c, net/ipfdemo/ipfdemo_example.c, net/replayGS/replayGS_example.c, and sensor/sensor_example.c.

Definition at line 250 of file stream_info.h.

Referenced by main().

uint8_t NtInfoAdapter_v6_s::Reserved3[3]

Definition at line 251 of file stream_info.h.

uint8_t NtInfoAdapter_v6_s::numPorts

The number of ports on this adapter.

Examples:
bypass/config/bypass_config_example.c, bypass/info/bypass_info_example.c, bypass/watchdog/bypass_watchdog_example.c, net/ipfdemo/ipfdemo_example.c, and sensor/sensor_example.c.

Definition at line 252 of file stream_info.h.

Referenced by main().

uint8_t NtInfoAdapter_v6_s::Reserved4[3]

Definition at line 253 of file stream_info.h.

uint8_t NtInfoAdapter_v6_s::numPhysicalAdapters

The number of physical adapters grouped in this virtual adapter.

Definition at line 254 of file stream_info.h.

uint8_t NtInfoAdapter_v6_s::Reserved5[3]

Definition at line 255 of file stream_info.h.

uint32_t NtInfoAdapter_v6_s::numHostBuffersRx

The number of RX host buffers on this adapter.

Definition at line 256 of file stream_info.h.

uint32_t NtInfoAdapter_v6_s::numHostBuffersTx

The number of TX host buffers on this adapter.

Definition at line 257 of file stream_info.h.

uint32_t NtInfoAdapter_v6_s::numTsConnectors

The number of time sync connectors on this adapter.

Definition at line 258 of file stream_info.h.

enum NtAdapterType_e NtInfoAdapter_v6_s::adapterType

The adapter type.

Definition at line 259 of file stream_info.h.

enum NtProductType_e NtInfoAdapter_v6_s::productType

The product line type.

Examples:
bypass/watchdog/bypass_watchdog_example.c.

Definition at line 260 of file stream_info.h.

Referenced by main().

enum NtProfileType_e NtInfoAdapter_v6_s::profile

The profile the adapter is using.

Examples:
net/replayGS/replayGS_example.c.

Definition at line 261 of file stream_info.h.

Referenced by main().

uint32_t NtInfoAdapter_v6_s::supportedProfilesBitmask

The profiles supported by the adapter - the value is represented as a bitmask of NtProfileType_e values.

Definition at line 262 of file stream_info.h.

uint32_t NtInfoAdapter_v6_s::adapterFeatures

The features supported by the adapter - the value is represented as a bitmask of NtFeatureType_e values.

Definition at line 263 of file stream_info.h.

enum NtProductFamily_e NtInfoAdapter_v6_s::productFamily

The product family.

Definition at line 264 of file stream_info.h.

char NtInfoAdapter_v6_s::name[128]

The adapter name.

Examples:
sensor/sensor_example.c.

Definition at line 265 of file stream_info.h.

Referenced by main().

char NtInfoAdapter_v6_s::serialNo[50]

The adapter serial number.

Definition at line 266 of file stream_info.h.

struct NtversionAvr_s NtInfoAdapter_v6_s::avr

AVR version for Gen2 adapters: avr[0] = Main board AVR, avr[1] = Front board AVR

Definition at line 272 of file stream_info.h.

union NtInfoAdapter_v6_s::Ntbusid_v6_u NtInfoAdapter_v6_s::busid
Examples:
info/info_example.c.

Referenced by main().

union Ntpciid_u NtInfoAdapter_v6_s::pciid

PCI ID is read as: 32-bit value, 2 x 16-bit values defining device ID and vendor ID

Examples:
info/info_example.c.

Definition at line 293 of file stream_info.h.

Referenced by main().

struct NtInfoPCIeInfo_s NtInfoAdapter_v6_s::pciInfo

Information about the PCI bus.

Definition at line 294 of file stream_info.h.

union Ntfpgaid_u NtInfoAdapter_v6_s::fpgaid

The FPGA ID of the image currently running on the adapter. The format is: item-product-version-revision-build. For example, 200-9114-40-01-1023.

Definition at line 300 of file stream_info.h.

struct NtInfoSDRAMInfo_s NtInfoAdapter_v6_s::sdramInfo

The SDRAM information.

Definition at line 301 of file stream_info.h.

uint32_t NtInfoAdapter_v6_s::extendedDescriptor

The extended descriptor in use by RX - if 0 then no extended is used.

Examples:
net/ipfdemo/ipfdemo_example.c.

Definition at line 302 of file stream_info.h.

Referenced by main().

uint32_t NtInfoAdapter_v6_s::supportedExtendedDescriptorsBitmask

Bitmask of supported extended descriptors, for example, if bit 7 is set then extended descriptor 7 is supported, and if bit 8 it set then extended descriptor 8 is supported.

Definition at line 303 of file stream_info.h.

enum NtPacketDescriptorType_e NtInfoAdapter_v6_s::descriptorType

The descriptor type used.

Examples:
net/ipfdemo/ipfdemo_example.c.

Definition at line 304 of file stream_info.h.

Referenced by main().

enum NtTimestampType_e NtInfoAdapter_v6_s::timestampType

The time stamp type used by the adapter.

Examples:
net/replayGS/replayGS_example.c, and pps/pps_example.c.

Definition at line 305 of file stream_info.h.

Referenced by main().

enum NtTimestampMethod_e NtInfoAdapter_v6_s::timestampMethod

The time stamp method (SOF/EOF) used by the adapter.

Examples:
net/transmit_multifunction/transmit_multifunction_example.c.

Definition at line 306 of file stream_info.h.

Referenced by main().

enum NtTxTimingMethod_e NtInfoAdapter_v6_s::txTiming

The TX timing.

Examples:
net/replay/replay_example.c, net/replayGS/replayGS_example.c, and net/transmit_multifunction/transmit_multifunction_example.c.

Definition at line 307 of file stream_info.h.

Referenced by main().

struct NtInfoWis_v1_s NtInfoAdapter_v6_s::wisMode

Wis mode status.

Definition at line 308 of file stream_info.h.

enum NtTimestampInjectOffsetMode_e NtInfoAdapter_v6_s::tsInjectModeOffset

Time stamp injection offset mode.

Definition at line 309 of file stream_info.h.

struct NtInfoGlobalSync_s NtInfoAdapter_v6_s::globalSync

Global sync status.

Examples:
net/replayGS/replayGS_example.c.

Definition at line 310 of file stream_info.h.

Referenced by main().

NtInfoBondingInfo_t NtInfoAdapter_v6_s::bondingInfo

Adapter Bonding status.

Definition at line 311 of file stream_info.h.

enum NtFeatureLevel_e NtInfoAdapter_v6_s::featureLevel

Adapter/FPGA feature level.

Examples:
net/transmit_multifunction/transmit_multifunction_example.c, and net/vlandemo/vlandemo_example.c.

Definition at line 312 of file stream_info.h.

Referenced by _Is4GATxSupported(), and Is4GATxSupported().

uint16_t NtInfoAdapter_v6_s::customId

Custom identification number.

Definition at line 313 of file stream_info.h.

struct NtInfoAdapter_v6_s::Ntbusid_v6_u::Ntbusid_v6_s

Definition at line 278 of file stream_info.h.

Data Fields

uint32_t function:3
 The PCI function number. More...
 
uint32_t device:5
 The PCI device number. More...
 
uint32_t bus:8
 The PCI bus number. More...
 
uint32_t domain:16
 The PCI domain number. More...
 

Field Documentation

uint32_t NtInfoAdapter_v6_s::Ntbusid_v6_u::Ntbusid_v6_s::function

The PCI function number.

Examples:
info/info_example.c.

Definition at line 279 of file stream_info.h.

Referenced by main().

uint32_t NtInfoAdapter_v6_s::Ntbusid_v6_u::Ntbusid_v6_s::device

The PCI device number.

Examples:
info/info_example.c.

Definition at line 280 of file stream_info.h.

Referenced by main().

uint32_t NtInfoAdapter_v6_s::Ntbusid_v6_u::Ntbusid_v6_s::bus

The PCI bus number.

Examples:
info/info_example.c.

Definition at line 281 of file stream_info.h.

Referenced by main().

uint32_t NtInfoAdapter_v6_s::Ntbusid_v6_u::Ntbusid_v6_s::domain

The PCI domain number.

Examples:
info/info_example.c.

Definition at line 282 of file stream_info.h.

Referenced by main().

union NtInfoAdapter_v6_s::Ntbusid_v6_u

The bus ID of the device

Definition at line 277 of file stream_info.h.

Data Fields

struct NtInfoAdapter_v6_s::Ntbusid_v6_u::Ntbusid_v6_s s
 
uint32_t value
 The domain, bus, device and function as a 32-bit value. More...
 

Field Documentation

struct NtInfoAdapter_v6_s::Ntbusid_v6_u::Ntbusid_v6_s NtInfoAdapter_v6_s::Ntbusid_v6_u::s
Examples:
info/info_example.c.

Referenced by main().

uint32_t NtInfoAdapter_v6_s::Ntbusid_v6_u::value

The domain, bus, device and function as a 32-bit value.

Definition at line 284 of file stream_info.h.

struct NtLinkCapabilities_s

Definition at line 355 of file stream_info.h.

Data Fields

uint32_t halfDuplexMask
 The available half duplex (use NtLinkSpeed_e as the bitmask) More...
 
uint32_t fullDuplexMask
 The available full duplex (use NtLinkSpeed_e as the bitmask) More...
 
uint32_t speed
 The available speed (use NtLinkSpeed_e as the bitmask) More...
 
uint32_t mdi
 The available MDI mode (use NtLinkMDI_e as the bitmask) More...
 
uint32_t AutoNeg
 The available link mode (use NtLinkAutoNeg_e as the bitmask) More...
 
uint32_t duplex
 
uint16_t minTxPktSize
 The minimum transmit packet size, see also NtRMON1Counters_s::undersizePkts. More...
 
uint16_t maxTxPktSize
 The maximum transmit packet size. More...
 
uint32_t featureMask
 The feature mask of the port. More...
 

Field Documentation

uint32_t NtLinkCapabilities_s::halfDuplexMask

The available half duplex (use NtLinkSpeed_e as the bitmask)

Definition at line 356 of file stream_info.h.

uint32_t NtLinkCapabilities_s::fullDuplexMask

The available full duplex (use NtLinkSpeed_e as the bitmask)

Definition at line 357 of file stream_info.h.

uint32_t NtLinkCapabilities_s::speed

The available speed (use NtLinkSpeed_e as the bitmask)

Definition at line 358 of file stream_info.h.

uint32_t NtLinkCapabilities_s::mdi

The available MDI mode (use NtLinkMDI_e as the bitmask)

Definition at line 359 of file stream_info.h.

uint32_t NtLinkCapabilities_s::AutoNeg

The available link mode (use NtLinkAutoNeg_e as the bitmask)

Definition at line 360 of file stream_info.h.

uint32_t NtLinkCapabilities_s::duplex

Definition at line 361 of file stream_info.h.

uint16_t NtLinkCapabilities_s::minTxPktSize

The minimum transmit packet size, see also NtRMON1Counters_s::undersizePkts.

Definition at line 362 of file stream_info.h.

uint16_t NtLinkCapabilities_s::maxTxPktSize

The maximum transmit packet size.

Examples:
net/transmit_segment/transmit_segment_example.c, and net/transmit_segment_dyn_descr/transmit_segment_dyn_descr_example.cpp.

Definition at line 363 of file stream_info.h.

Referenced by get_max_packet_size(), and main().

uint32_t NtLinkCapabilities_s::featureMask
struct NtNIMLinkLength_s

Definition at line 367 of file stream_info.h.

Data Fields

uint16_t sm
 NIM link length (in meters) supported SM (9um). A value of 0xFFFF indicates that the length is >= 65535 m. More...
 
uint16_t ebw
 NIM link length (in meters) supported EBW (50um) More...
 
uint16_t mm50
 NIM link length (in meters) supported MM (50um) More...
 
uint16_t mm62
 NIM link length (in meters) supported MM (62.5um) More...
 
uint16_t copper
 NIM link length (in meters) supported copper. More...
 

Field Documentation

uint16_t NtNIMLinkLength_s::sm

NIM link length (in meters) supported SM (9um). A value of 0xFFFF indicates that the length is >= 65535 m.

Definition at line 368 of file stream_info.h.

uint16_t NtNIMLinkLength_s::ebw

NIM link length (in meters) supported EBW (50um)

Definition at line 369 of file stream_info.h.

uint16_t NtNIMLinkLength_s::mm50

NIM link length (in meters) supported MM (50um)

Definition at line 370 of file stream_info.h.

uint16_t NtNIMLinkLength_s::mm62

NIM link length (in meters) supported MM (62.5um)

Definition at line 371 of file stream_info.h.

uint16_t NtNIMLinkLength_s::copper

NIM link length (in meters) supported copper.

Definition at line 372 of file stream_info.h.

struct NtBypassPortInfo_s

Definition at line 378 of file stream_info.h.

Data Fields

uint8_t bypassPortsetNo
 < Read-only information about bypass port states More...
 
uint8_t Reserved1 [3]
 
enum NtBypassTrigger_e bypassTriggerModes
 Bypass triggers that affect this port state using NtBypassTrigger_e. More...
 
enum NtBypassPortState_e currentBypassPortState
 Current (live) bypass port state using NtBypassPortState_e. More...
 
enum NtBypassPortState_e onInitBypassPortState
 onInit bypass port state using NtBypassPortState_e More...
 
enum NtBypassPortState_e onPowerFailBypassPortState
 onPowerFail bypass port state using NtBypassPortState_e More...
 
enum NtBypassPortState_e onWatchdogFailBypassPortState
 onWatchdogFail bypass port state using NtBypassPortState_e More...
 
uint32_t bypassPortWatchdogTimeout
 Watchdog timeout (msec) More...
 
uint32_t bypassPortWatchdogTimeRemaining
 Watchdog remaining time before timeout (msec) More...
 

Field Documentation

uint8_t NtBypassPortInfo_s::bypassPortsetNo

< Read-only information about bypass port states

Portset (portpair) membership - within an adapter

Examples:
bypass/info/bypass_info_example.c.

Definition at line 379 of file stream_info.h.

Referenced by main().

uint8_t NtBypassPortInfo_s::Reserved1[3]

Definition at line 380 of file stream_info.h.

enum NtBypassTrigger_e NtBypassPortInfo_s::bypassTriggerModes

Bypass triggers that affect this port state using NtBypassTrigger_e.

Examples:
bypass/info/bypass_info_example.c.

Definition at line 381 of file stream_info.h.

Referenced by main().

enum NtBypassPortState_e NtBypassPortInfo_s::currentBypassPortState

Current (live) bypass port state using NtBypassPortState_e.

Examples:
bypass/info/bypass_info_example.c.

Definition at line 382 of file stream_info.h.

Referenced by main().

enum NtBypassPortState_e NtBypassPortInfo_s::onInitBypassPortState

onInit bypass port state using NtBypassPortState_e

Definition at line 383 of file stream_info.h.

enum NtBypassPortState_e NtBypassPortInfo_s::onPowerFailBypassPortState

onPowerFail bypass port state using NtBypassPortState_e

Definition at line 384 of file stream_info.h.

enum NtBypassPortState_e NtBypassPortInfo_s::onWatchdogFailBypassPortState

onWatchdogFail bypass port state using NtBypassPortState_e

Definition at line 385 of file stream_info.h.

uint32_t NtBypassPortInfo_s::bypassPortWatchdogTimeout

Watchdog timeout (msec)

Examples:
bypass/info/bypass_info_example.c.

Definition at line 386 of file stream_info.h.

Referenced by main().

uint32_t NtBypassPortInfo_s::bypassPortWatchdogTimeRemaining

Watchdog remaining time before timeout (msec)

Definition at line 387 of file stream_info.h.

struct NtInfoPort_v9_s

This structure will return the port specific information version 7. Must be a mirror of NtInfoPort_v8_s with version 9 variables added to the bottom.

Definition at line 397 of file stream_info.h.

Data Fields

enum NtPortType_e type
 The interface type. More...
 
enum NtLinkState_e state
 The port up or down. More...
 
enum NtLinkSpeed_e speed
 The interface speed. More...
 
enum NtLinkDuplex_e duplex
 The duplex mode. More...
 
int32_t flow
 0 = no flow control, 1 = flow control More...
 
enum NtLinkMDI_e mdi
 1 = auto, 2 = MDI, 4 = MDIX More...
 
uint8_t macAddress [6]
 The MAC address of the interface. More...
 
uint16_t maxFrameSize
 The current maximum frame size. More...
 
struct NtLinkCapabilities_s capabilities
 The link capabilities. More...
 
uint8_t adapterNo
 The adapter that has the port. More...
 
uint8_t Reserved1 [3]
 
uint8_t numSensors
 The number of sensors on this port. More...
 
uint8_t Reserved2 [3]
 
uint8_t numLevel1Sensors
 Number of level 1 sensors on this port. More...
 
uint8_t Reserved3 [3]
 
uint8_t numLevel2Sensors
 Number of level 2 sensors on this port. More...
 
uint8_t Reserved4 [3]
 
enum NtNimIdentifier_e nim_id
 NIM identifier. More...
 
uint8_t vendor_name [17]
 NIM Vendor name. More...
 
uint8_t product_no [17]
 NIM product number. More...
 
uint8_t serial_no [17]
 NIM serial number. More...
 
uint8_t date [9]
 NIM vendors manufacturing date. More...
 
uint8_t revision [5]
 NIM vendor revision. More...
 
uint8_t power_level_req
 NIM required power level. More...
 
uint8_t power_level_curr
 NIM current power level. More...
 
struct NtNIMLinkLength_s link_length
 
struct NtInfoAdapter_v6_s adapterInfo
 
struct NtBypassPortInfo_s bypass
 
uint32_t statusMask
 Adapter status mask holds information on how the port is configured at startup. More...
 
NtPortFec_t fecState
 The state of Forward Error Correction if applicable. More...
 
uint64_t nextPktNs
 Time till next package will be transmitted in ns. More...
 
uint64_t maxPktDelayedNs
 Max time pkts were late in being transmitted. More...
 

Field Documentation

enum NtPortType_e NtInfoPort_v9_s::type

The interface type.

Definition at line 398 of file stream_info.h.

enum NtLinkState_e NtInfoPort_v9_s::state

The port up or down.

Examples:
net/transmit_multifunction/transmit_multifunction_example.c.

Definition at line 399 of file stream_info.h.

Referenced by main().

enum NtLinkSpeed_e NtInfoPort_v9_s::speed

The interface speed.

Definition at line 400 of file stream_info.h.

Referenced by main().

enum NtLinkDuplex_e NtInfoPort_v9_s::duplex

The duplex mode.

Definition at line 401 of file stream_info.h.

int32_t NtInfoPort_v9_s::flow

0 = no flow control, 1 = flow control

Definition at line 402 of file stream_info.h.

enum NtLinkMDI_e NtInfoPort_v9_s::mdi

1 = auto, 2 = MDI, 4 = MDIX

Definition at line 403 of file stream_info.h.

uint8_t NtInfoPort_v9_s::macAddress[6]

The MAC address of the interface.

Definition at line 404 of file stream_info.h.

uint16_t NtInfoPort_v9_s::maxFrameSize

The current maximum frame size.

Definition at line 405 of file stream_info.h.

struct NtLinkCapabilities_s NtInfoPort_v9_s::capabilities

The link capabilities.

Capabilities reflect what the port is capable of, that is, what speed/duplex is possible. For example, if only 100 M full duplex is available, the capabilities would show: halfDuplexMask=0. fullDuplexMask=NT_LINK_SPEED_100M. Other capabilities are min/max transmit sizes.

Examples:
bypass/config/bypass_config_example.c, bypass/info/bypass_info_example.c, bypass/watchdog/bypass_watchdog_example.c, net/replay/replay_example.c, net/replay4GA/replay4ga_example.c, net/timestamp_inject/timestamp_inject_example.cpp, net/transmit_multifunction/transmit_multifunction_example.c, net/transmit_segment/transmit_segment_example.c, and net/transmit_segment_dyn_descr/transmit_segment_dyn_descr_example.cpp.

Definition at line 414 of file stream_info.h.

Referenced by featuresAvailable(), get_max_packet_size(), and main().

uint8_t NtInfoPort_v9_s::Reserved1[3]

Definition at line 416 of file stream_info.h.

uint8_t NtInfoPort_v9_s::numSensors

The number of sensors on this port.

Definition at line 417 of file stream_info.h.

uint8_t NtInfoPort_v9_s::Reserved2[3]

Definition at line 418 of file stream_info.h.

uint8_t NtInfoPort_v9_s::numLevel1Sensors

Number of level 1 sensors on this port.

Examples:
sensor/sensor_example.c.

Definition at line 419 of file stream_info.h.

Referenced by main().

uint8_t NtInfoPort_v9_s::Reserved3[3]

Definition at line 420 of file stream_info.h.

uint8_t NtInfoPort_v9_s::numLevel2Sensors

Number of level 2 sensors on this port.

Definition at line 421 of file stream_info.h.

uint8_t NtInfoPort_v9_s::Reserved4[3]

Definition at line 422 of file stream_info.h.

enum NtNimIdentifier_e NtInfoPort_v9_s::nim_id

NIM identifier.

NIM model information

Definition at line 427 of file stream_info.h.

uint8_t NtInfoPort_v9_s::vendor_name[17]

NIM Vendor name.

Definition at line 428 of file stream_info.h.

uint8_t NtInfoPort_v9_s::product_no[17]

NIM product number.

Definition at line 429 of file stream_info.h.

uint8_t NtInfoPort_v9_s::serial_no[17]

NIM serial number.

Definition at line 430 of file stream_info.h.

uint8_t NtInfoPort_v9_s::date[9]

NIM vendors manufacturing date.

Definition at line 431 of file stream_info.h.

uint8_t NtInfoPort_v9_s::revision[5]

NIM vendor revision.

Definition at line 432 of file stream_info.h.

uint8_t NtInfoPort_v9_s::power_level_req

NIM required power level.

Definition at line 433 of file stream_info.h.

uint8_t NtInfoPort_v9_s::power_level_curr

NIM current power level.

Definition at line 434 of file stream_info.h.

struct NtNIMLinkLength_s NtInfoPort_v9_s::link_length

Definition at line 435 of file stream_info.h.

struct NtInfoAdapter_v6_s NtInfoPort_v9_s::adapterInfo

Adapter information

Examples:
net/replayGS/replayGS_example.c, and net/transmit_multifunction/transmit_multifunction_example.c.

Definition at line 439 of file stream_info.h.

Referenced by main().

struct NtBypassPortInfo_s NtInfoPort_v9_s::bypass

Bypass port information

Examples:
bypass/info/bypass_info_example.c.

Definition at line 443 of file stream_info.h.

Referenced by main().

uint32_t NtInfoPort_v9_s::statusMask

Adapter status mask holds information on how the port is configured at startup.

Definition at line 444 of file stream_info.h.

NtPortFec_t NtInfoPort_v9_s::fecState

The state of Forward Error Correction if applicable.

Definition at line 445 of file stream_info.h.

uint64_t NtInfoPort_v9_s::nextPktNs

Time till next package will be transmitted in ns.

Definition at line 446 of file stream_info.h.

uint64_t NtInfoPort_v9_s::maxPktDelayedNs

Max time pkts were late in being transmitted.

Definition at line 447 of file stream_info.h.

struct NtInfoSensor_s

This structure will return the sensor specific information

The units used for the fields: value, valueLowest, valueHighest, limitLow and limitHigh depend on the type field. See NtSensorType_e.

For the limitLow and limitHigh fields the following applies:
If the sensor is located in a NIM (Network Interface Module), the limits are read from the NIM module via the DMI (Diagnostic Monitoring Interface) from the alarm and warning threshholds section, and the units are changed to internal representation. Only the alarm threshholds are used and are read only once during initialization. The limits cannot be changed.

The value field is updated internally on a regular basis and is also based on a value read from the NIM which is also changed to internal representation.

Not all NIM types support DMI data, and its presence must be determined by reading an option flag. In general, a NIM can read out: temperature, supply voltage, TX bias, TX optical power and RX optical power but not all NIM types support all 5 values.

If external calibration is used (most NIM use internal calibration), both the current value and the threshold values are subjected to the specified calibration along with the change to internal calibration.

Examples:
eventMonitor_example.c, and sensor/sensor_example.c.

Definition at line 480 of file stream_info.h.

Data Fields

enum NtSensorSource_e source
 The source of the sensor (port or adapter on which the sensor resides) More...
 
uint32_t sourceIndex
 The source index - the adapter number for adapter sensors and port number for port sensors. More...
 
uint32_t sensorIndex
 The sensor index within the source index (sensor number on the adapter or sensor number on the port) More...
 
enum NtSensorType_e type
 The sensor type. More...
 
enum NtSensorSubType_e subType
 The sensor subtype (if applicable) More...
 
enum NtSensorState_e state
 The current state (normal or alarm) More...
 
int32_t value
 The current value. More...
 
int32_t valueLowest
 The lowest value registered. More...
 
int32_t valueHighest
 The highest value registered. More...
 
int32_t limitLow
 The minimum sensor value before an alarm is triggered. More...
 
int32_t limitHigh
 The maximum sensor value before an alarm is triggered. More...
 
char name [50]
 The sensor name. More...
 
enum NtAdapterType_e adapterType
 The adapter type where the sensor resides. More...
 

Field Documentation

enum NtSensorSource_e NtInfoSensor_s::source

The source of the sensor (port or adapter on which the sensor resides)

Definition at line 481 of file stream_info.h.

uint32_t NtInfoSensor_s::sourceIndex

The source index - the adapter number for adapter sensors and port number for port sensors.

Examples:
eventMonitor_example.c.

Definition at line 482 of file stream_info.h.

Referenced by DumpSensor().

uint32_t NtInfoSensor_s::sensorIndex

The sensor index within the source index (sensor number on the adapter or sensor number on the port)

Examples:
eventMonitor_example.c.

Definition at line 483 of file stream_info.h.

Referenced by DumpSensor().

enum NtSensorType_e NtInfoSensor_s::type

The sensor type.

Examples:
eventMonitor_example.c, and sensor/sensor_example.c.

Definition at line 484 of file stream_info.h.

Referenced by DisplaySensorData(), and DumpSensor().

enum NtSensorSubType_e NtInfoSensor_s::subType

The sensor subtype (if applicable)

Examples:
sensor/sensor_example.c.

Definition at line 485 of file stream_info.h.

Referenced by DisplaySensorData().

enum NtSensorState_e NtInfoSensor_s::state

The current state (normal or alarm)

Examples:
eventMonitor_example.c, and sensor/sensor_example.c.

Definition at line 486 of file stream_info.h.

Referenced by DisplaySensorData(), DumpSensor(), and main().

int32_t NtInfoSensor_s::value

The current value.

Examples:
sensor/sensor_example.c.

Definition at line 487 of file stream_info.h.

Referenced by DisplaySensorData().

int32_t NtInfoSensor_s::valueLowest

The lowest value registered.

Examples:
sensor/sensor_example.c.

Definition at line 488 of file stream_info.h.

Referenced by DisplaySensorData().

int32_t NtInfoSensor_s::valueHighest

The highest value registered.

Examples:
sensor/sensor_example.c.

Definition at line 489 of file stream_info.h.

Referenced by DisplaySensorData().

int32_t NtInfoSensor_s::limitLow

The minimum sensor value before an alarm is triggered.

Examples:
eventMonitor_example.c, and sensor/sensor_example.c.

Definition at line 490 of file stream_info.h.

Referenced by DisplaySensorData(), and DumpSensor().

int32_t NtInfoSensor_s::limitHigh

The maximum sensor value before an alarm is triggered.

Examples:
eventMonitor_example.c, and sensor/sensor_example.c.

Definition at line 491 of file stream_info.h.

Referenced by DisplaySensorData(), and DumpSensor().

char NtInfoSensor_s::name[50]

The sensor name.

Examples:
eventMonitor_example.c, and sensor/sensor_example.c.

Definition at line 492 of file stream_info.h.

Referenced by DisplaySensorData(), and DumpSensor().

enum NtAdapterType_e NtInfoSensor_s::adapterType

The adapter type where the sensor resides.

Definition at line 493 of file stream_info.h.

struct NtInfoStreamId_s

StreamID specific information

Definition at line 500 of file stream_info.h.

Data Fields

int useCount
 Set to the number of streams using this stream ID. More...
 
int numHostBuffers
 The amount of hostbuffers currently in use by this stream ID. More...
 
enum NtStreamIdState_e state
 The current state of the stream ID. More...
 
uint64_t minHostBufferSize
 The minimum hostbuffer size this stream ID requires. More...
 
uint8_t numaNode
 The NUMA node on which this stream ID resides. More...
 

Field Documentation

int NtInfoStreamId_s::useCount

Set to the number of streams using this stream ID.

Definition at line 501 of file stream_info.h.

int NtInfoStreamId_s::numHostBuffers

The amount of hostbuffers currently in use by this stream ID.

Definition at line 502 of file stream_info.h.

enum NtStreamIdState_e NtInfoStreamId_s::state

The current state of the stream ID.

Definition at line 503 of file stream_info.h.

uint64_t NtInfoStreamId_s::minHostBufferSize

The minimum hostbuffer size this stream ID requires.

Definition at line 504 of file stream_info.h.

uint8_t NtInfoStreamId_s::numaNode

The NUMA node on which this stream ID resides.

Definition at line 505 of file stream_info.h.

struct NtInfoHostBuffer_v1_s

Host buffer specific information

Definition at line 511 of file stream_info.h.

Data Fields

uint8_t numaNode
 The NUMA node on which the host buffer resides. More...
 
uint8_t Reserved1 [3]
 
uint64_t size
 The size of the host buffer in bytes. More...
 
uint32_t feed
 The feed index per adapter and type. More...
 

Field Documentation

uint8_t NtInfoHostBuffer_v1_s::numaNode

The NUMA node on which the host buffer resides.

Definition at line 512 of file stream_info.h.

uint8_t NtInfoHostBuffer_v1_s::Reserved1[3]

Definition at line 513 of file stream_info.h.

uint64_t NtInfoHostBuffer_v1_s::size

The size of the host buffer in bytes.

Definition at line 514 of file stream_info.h.

uint32_t NtInfoHostBuffer_v1_s::feed

The feed index per adapter and type.

Definition at line 515 of file stream_info.h.

struct NtInfoStreams_s

Structure to hold information about currently active streams

Definition at line 522 of file stream_info.h.

Data Fields

int streamIDList [256]
 Holds all the stream IDs currently created in the system. More...
 
uint32_t count
 The number of stream IDs from the stream ID list. More...
 

Field Documentation

int NtInfoStreams_s::streamIDList[256]

Holds all the stream IDs currently created in the system.

Definition at line 523 of file stream_info.h.

uint32_t NtInfoStreams_s::count

The number of stream IDs from the stream ID list.

Definition at line 524 of file stream_info.h.

struct NtInfoTimeSyncSample_s

Structure to hold the sampled timestamps and status

Definition at line 533 of file stream_info.h.

Data Fields

enum NtTimeSyncSamplingSrcStatus_e sampledStatus
 Status of sampled timestamp (valid/invalid) More...
 
uint64_t sampledTime
 The sampled adapter time in ns since 1/1 1970 (unix epoch). if NATIVE timestamp format is configured, the epoch is user defined) More...
 
enum NtTimeSyncSamplingSrcStatus_e externalStatus
 Status of external reference timestamp (available/unavailable) More...
 
uint64_t externalTime
 The sampled external time in ns since 1/1 1970 (unix epoch). if NATIVE timestamp format is configured, the epoch is user defined) More...
 

Field Documentation

enum NtTimeSyncSamplingSrcStatus_e NtInfoTimeSyncSample_s::sampledStatus

Status of sampled timestamp (valid/invalid)

Definition at line 534 of file stream_info.h.

uint64_t NtInfoTimeSyncSample_s::sampledTime

The sampled adapter time in ns since 1/1 1970 (unix epoch). if NATIVE timestamp format is configured, the epoch is user defined)

Definition at line 535 of file stream_info.h.

enum NtTimeSyncSamplingSrcStatus_e NtInfoTimeSyncSample_s::externalStatus

Status of external reference timestamp (available/unavailable)

Definition at line 536 of file stream_info.h.

uint64_t NtInfoTimeSyncSample_s::externalTime

The sampled external time in ns since 1/1 1970 (unix epoch). if NATIVE timestamp format is configured, the epoch is user defined)

Definition at line 537 of file stream_info.h.

struct NtInfoTimeSync_v4_s

Definition at line 546 of file stream_info.h.

Data Fields

uint32_t timeSyncSupported
 Is time sync supported by this adapter. More...
 
uint32_t ptpSupported
 Is PTP time sync available on this adapter. More...
 
enum NtTimeSyncConnectorSetting_e timeSyncConnectorExt1
 Timesync connector Ext1 setting. More...
 
enum NtTimeSyncConnectorSetting_e timeSyncConnectorInt1
 Timesync connector Int1 setting. More...
 
enum NtTimeSyncConnectorSetting_e timeSyncConnectorInt2
 Timesync connector Int2 setting. More...
 
enum NtTimeSyncReference_e tsRefPrio [4]
 Timesync source reference priority list. More...
 
enum NtTimeSyncReference_e timeRef
 The current time reference. More...
 
enum NtTimeSyncFreqReference_e tsFreqRefPrio [4]
 Timesync frequency reference priority list. More...
 
enum NtTimeSyncFreqReference_e freqRef
 The current frequency reference. More...
 
uint32_t timeSyncNTTSInSyncLimit
 The configured NT-TS in-sync limit. More...
 
uint32_t timeSyncOSInSyncLimit
 The configured OS in-sync limit. More...
 
uint32_t timeSyncPPSInSyncLimit
 The configured PPS in-sync limit. More...
 
uint32_t timeSyncPTPInSyncLimit
 The configured PTP in-sync limit. More...
 
enum NtTimeSyncInSyncStatus_e timeSyncInSyncStatus
 The timestamp clock time in-sync/out-of-sync status. More...
 
enum NtTimeSyncConStatus_e timeSyncCurrentConStatus
 The current time sync connector status. More...
 
enum NtTimeSyncPpsStatus_e timeSyncPpsEnable
 The time sync PPS enable. Activated by an application. More...
 
enum NtTimeSyncPpsSyncMode_e timeSyncPpsSyncMode
 When current timeref is PpsIn, this is the sync mode status. More...
 
uint32_t timeSyncClockAdjustmentMode
 The time sync timestamp clock adjustment mode. More...
 
uint32_t timeSyncHardReset
 If hard reset of clock is allowed (time jumps) More...
 
uint32_t timeSyncTimeJumpThreshold
 The time sync time jump threshold in seconds. More...
 
uint32_t timeSyncTimeOffset
 The time sync offset in nanoseconds. Used for NT-TS and PPS caple delay compensation. More...
 
uint64_t timeSyncPpsSampled
 The sampled PPS time. In ns since 1/1 1970 (unix epoch). if NATIVE timestamp format is configured, the epoch is user defined). Note that timeSyncPpsEnable must be true for this parameter to become valid. More...
 
int64_t timeSyncTimeSkew
 The time skew in ns (0 if not syncing to a time reference) More...
 
uint32_t highFrequencySampling
 The high frequency sampling status. More...
 
struct NtInfoTimeSyncSample_s sample [NT_TIMESYNC_SAMPLING_CNT]
 Timestamp sample sets. NtTimeSyncSamplingSrc_e. More...
 
uint64_t timeSyncCpuTsc [2]
 When TS sampling is app initiated through an event write, these values are cpu tsc values before and after the ts sampling. More...
 
int64_t timeSyncClockRateAdjustment
 The current clock rate adjustment imposed on the TS clock to synchronize to the referenced clock in nanoseconds per second. This is only supported on newer Gen2 adapters (FPGA version must be 46 or above) More...
 
uint32_t timeSyncAdapterToOSSyncEnabled
 Non-zero if this adapter is configured to synchronize the server OS clock. More...
 
int64_t timeSyncOSClockOffset
 The latest read OS clock offset to the adapter TS clock. More...
 
int64_t timeSyncOSClockRateAdjustment
 The current clock rate adjustment imposed on the server OS clock to synchronize to the adapter TS clock. More...
 

Field Documentation

uint32_t NtInfoTimeSync_v4_s::timeSyncSupported

Is time sync supported by this adapter.

Definition at line 547 of file stream_info.h.

uint32_t NtInfoTimeSync_v4_s::ptpSupported

Is PTP time sync available on this adapter.

Definition at line 548 of file stream_info.h.

enum NtTimeSyncConnectorSetting_e NtInfoTimeSync_v4_s::timeSyncConnectorExt1

Timesync connector Ext1 setting.

Examples:
pps/pps_example.c.

Definition at line 550 of file stream_info.h.

Referenced by main().

enum NtTimeSyncConnectorSetting_e NtInfoTimeSync_v4_s::timeSyncConnectorInt1

Timesync connector Int1 setting.

Examples:
pps/pps_example.c.

Definition at line 551 of file stream_info.h.

Referenced by main().

enum NtTimeSyncConnectorSetting_e NtInfoTimeSync_v4_s::timeSyncConnectorInt2

Timesync connector Int2 setting.

Examples:
pps/pps_example.c.

Definition at line 552 of file stream_info.h.

Referenced by main().

enum NtTimeSyncReference_e NtInfoTimeSync_v4_s::tsRefPrio[4]

Timesync source reference priority list.

Examples:
pps/pps_example.c.

Definition at line 553 of file stream_info.h.

Referenced by main().

enum NtTimeSyncReference_e NtInfoTimeSync_v4_s::timeRef

The current time reference.

Examples:
net/ipfdemo/ipfdemo_example.c, and pps/pps_example.c.

Definition at line 554 of file stream_info.h.

Referenced by main().

enum NtTimeSyncFreqReference_e NtInfoTimeSync_v4_s::tsFreqRefPrio[4]

Timesync frequency reference priority list.

Definition at line 555 of file stream_info.h.

enum NtTimeSyncFreqReference_e NtInfoTimeSync_v4_s::freqRef

The current frequency reference.

Definition at line 556 of file stream_info.h.

uint32_t NtInfoTimeSync_v4_s::timeSyncNTTSInSyncLimit

The configured NT-TS in-sync limit.

Definition at line 557 of file stream_info.h.

uint32_t NtInfoTimeSync_v4_s::timeSyncOSInSyncLimit

The configured OS in-sync limit.

Definition at line 558 of file stream_info.h.

uint32_t NtInfoTimeSync_v4_s::timeSyncPPSInSyncLimit

The configured PPS in-sync limit.

Definition at line 559 of file stream_info.h.

uint32_t NtInfoTimeSync_v4_s::timeSyncPTPInSyncLimit

The configured PTP in-sync limit.

Definition at line 560 of file stream_info.h.

enum NtTimeSyncInSyncStatus_e NtInfoTimeSync_v4_s::timeSyncInSyncStatus

The timestamp clock time in-sync/out-of-sync status.

Definition at line 561 of file stream_info.h.

enum NtTimeSyncConStatus_e NtInfoTimeSync_v4_s::timeSyncCurrentConStatus

The current time sync connector status.

Examples:
pps/pps_example.c.

Definition at line 562 of file stream_info.h.

Referenced by main().

enum NtTimeSyncPpsStatus_e NtInfoTimeSync_v4_s::timeSyncPpsEnable

The time sync PPS enable. Activated by an application.

Definition at line 563 of file stream_info.h.

enum NtTimeSyncPpsSyncMode_e NtInfoTimeSync_v4_s::timeSyncPpsSyncMode

When current timeref is PpsIn, this is the sync mode status.

Definition at line 564 of file stream_info.h.

uint32_t NtInfoTimeSync_v4_s::timeSyncClockAdjustmentMode

The time sync timestamp clock adjustment mode.

Examples:
pps/pps_example.c.

Definition at line 565 of file stream_info.h.

Referenced by main().

uint32_t NtInfoTimeSync_v4_s::timeSyncHardReset

If hard reset of clock is allowed (time jumps)

Examples:
pps/pps_example.c.

Definition at line 567 of file stream_info.h.

Referenced by main().

uint32_t NtInfoTimeSync_v4_s::timeSyncTimeJumpThreshold

The time sync time jump threshold in seconds.

Examples:
pps/pps_example.c.

Definition at line 569 of file stream_info.h.

Referenced by main().

uint32_t NtInfoTimeSync_v4_s::timeSyncTimeOffset

The time sync offset in nanoseconds. Used for NT-TS and PPS caple delay compensation.

Examples:
pps/pps_example.c.

Definition at line 571 of file stream_info.h.

Referenced by main().

uint64_t NtInfoTimeSync_v4_s::timeSyncPpsSampled

The sampled PPS time. In ns since 1/1 1970 (unix epoch). if NATIVE timestamp format is configured, the epoch is user defined). Note that timeSyncPpsEnable must be true for this parameter to become valid.

Examples:
pps/pps_example.c.

Definition at line 572 of file stream_info.h.

Referenced by main().

int64_t NtInfoTimeSync_v4_s::timeSyncTimeSkew

The time skew in ns (0 if not syncing to a time reference)

Examples:
pps/pps_example.c.

Definition at line 573 of file stream_info.h.

Referenced by main().

uint32_t NtInfoTimeSync_v4_s::highFrequencySampling

The high frequency sampling status.

Definition at line 574 of file stream_info.h.

struct NtInfoTimeSyncSample_s NtInfoTimeSync_v4_s::sample[NT_TIMESYNC_SAMPLING_CNT]

Timestamp sample sets. NtTimeSyncSamplingSrc_e.

Definition at line 575 of file stream_info.h.

uint64_t NtInfoTimeSync_v4_s::timeSyncCpuTsc[2]

When TS sampling is app initiated through an event write, these values are cpu tsc values before and after the ts sampling.

Definition at line 576 of file stream_info.h.

int64_t NtInfoTimeSync_v4_s::timeSyncClockRateAdjustment

The current clock rate adjustment imposed on the TS clock to synchronize to the referenced clock in nanoseconds per second. This is only supported on newer Gen2 adapters (FPGA version must be 46 or above)

Definition at line 578 of file stream_info.h.

uint32_t NtInfoTimeSync_v4_s::timeSyncAdapterToOSSyncEnabled

Non-zero if this adapter is configured to synchronize the server OS clock.

Definition at line 581 of file stream_info.h.

int64_t NtInfoTimeSync_v4_s::timeSyncOSClockOffset

The latest read OS clock offset to the adapter TS clock.

Definition at line 582 of file stream_info.h.

int64_t NtInfoTimeSync_v4_s::timeSyncOSClockRateAdjustment

The current clock rate adjustment imposed on the server OS clock to synchronize to the adapter TS clock.

Definition at line 583 of file stream_info.h.

struct NtInfoTimeSyncStatusExt_s

Time synchronization NT-TS remote info

Definition at line 589 of file stream_info.h.

Data Fields

uint32_t infoValid
 The information is valid if infoValid != 0. More...
 
uint32_t extDevSyncSignalOk
 The status of the external synchronization signal (1 if ok, otherwise 0) (Only used if the external device is a NT-TSU) More...
 
uint32_t extDevInSync
 The external device is in sync (1 if in sync, otherwise 0) (Only used if the external device is a NT-TSU or a NT-TSE) More...
 
uint32_t extDevTimeOfDayOk
 The external device delivers valid Time Of Day information (1 if valid, otherwise 0) (Only used if the external device is a NT-TSU or a NT-TSE) For the NT-TSU this indicates if the serial time stream is available. For the NT-TSE this field indicates if the Ethernet connection is up. More...
 
uint32_t extDevOsModeSyncEnabled
 The external device is synching to the OS time (1 if synching, otherwise 0) Only used if the external device is an adapter. More...
 
uint32_t extDevOsModeInSync
 The external device is in synchronization to the OS time (1 if in sync, otherwise 0) Only used if the external device is an adapter. More...
 
uint32_t extDevIsMaster
 The External device is master (1 if the external device is a NTTSU or NTTSE, otherwise 0) More...
 
uint32_t extAdapterIsMaster
 An external Adapter is master (1 if the external device is an adapter, otherwise 0) More...
 
uint32_t extDevMasterID
 Master ID of the external device. More...
 

Field Documentation

uint32_t NtInfoTimeSyncStatusExt_s::infoValid

The information is valid if infoValid != 0.

Definition at line 590 of file stream_info.h.

uint32_t NtInfoTimeSyncStatusExt_s::extDevSyncSignalOk

The status of the external synchronization signal (1 if ok, otherwise 0) (Only used if the external device is a NT-TSU)

Definition at line 591 of file stream_info.h.

uint32_t NtInfoTimeSyncStatusExt_s::extDevInSync

The external device is in sync (1 if in sync, otherwise 0) (Only used if the external device is a NT-TSU or a NT-TSE)

Definition at line 592 of file stream_info.h.

uint32_t NtInfoTimeSyncStatusExt_s::extDevTimeOfDayOk

The external device delivers valid Time Of Day information (1 if valid, otherwise 0) (Only used if the external device is a NT-TSU or a NT-TSE) For the NT-TSU this indicates if the serial time stream is available. For the NT-TSE this field indicates if the Ethernet connection is up.

Definition at line 593 of file stream_info.h.

uint32_t NtInfoTimeSyncStatusExt_s::extDevOsModeSyncEnabled

The external device is synching to the OS time (1 if synching, otherwise 0) Only used if the external device is an adapter.

Definition at line 594 of file stream_info.h.

uint32_t NtInfoTimeSyncStatusExt_s::extDevOsModeInSync

The external device is in synchronization to the OS time (1 if in sync, otherwise 0) Only used if the external device is an adapter.

Definition at line 595 of file stream_info.h.

uint32_t NtInfoTimeSyncStatusExt_s::extDevIsMaster

The External device is master (1 if the external device is a NTTSU or NTTSE, otherwise 0)

Definition at line 596 of file stream_info.h.

uint32_t NtInfoTimeSyncStatusExt_s::extAdapterIsMaster

An external Adapter is master (1 if the external device is an adapter, otherwise 0)

Definition at line 597 of file stream_info.h.

uint32_t NtInfoTimeSyncStatusExt_s::extDevMasterID

Master ID of the external device.

Definition at line 598 of file stream_info.h.

struct NtInfoTimeSyncStatistics_s

Overall Time synchronization performance statistics and time sync event counters

Definition at line 617 of file stream_info.h.

Data Fields

enum NtTsStatSupport_e supported
 Specifies the level of which this feature is supported by the adapter. More...
 
uint64_t ts
 The adapter time when retrieved in ns since 1/1 1970 (unix epoch). if NATIVE timestamp format is configured, the epoch is user defined) More...
 
uint64_t samples
 The number of skew samples this statistics report is based on. More...
 
int64_t skew
 The last recorded clock skew used to adjust the clock. More...
 
int64_t min
 The minimum clock skew measured. More...
 
int64_t max
 The maximum clock skew measured. More...
 
int64_t mean
 The calculate mean clock skew. More...
 
int64_t jitter
 The peak to peak jitter measured. More...
 
uint64_t secSinceReset
 Time elapsed since last reset in seconds (using the OS time) More...
 
double stdDevSqr
 The calculated standard deviation square. More...
 
uint64_t signalLostCnt
 The number of signal lost events that has occured since last reset. More...
 
uint64_t syncLostCnt
 The number of out-of-sync events (or synchronization lost events) that has occured since last reset. More...
 
uint64_t hardResetCnt
 The number of clock hard reset events that has occured since last reset (including the application triggered) More...
 

Field Documentation

enum NtTsStatSupport_e NtInfoTimeSyncStatistics_s::supported

Specifies the level of which this feature is supported by the adapter.

Definition at line 618 of file stream_info.h.

uint64_t NtInfoTimeSyncStatistics_s::ts

The adapter time when retrieved in ns since 1/1 1970 (unix epoch). if NATIVE timestamp format is configured, the epoch is user defined)

Definition at line 619 of file stream_info.h.

uint64_t NtInfoTimeSyncStatistics_s::samples

The number of skew samples this statistics report is based on.

Definition at line 620 of file stream_info.h.

int64_t NtInfoTimeSyncStatistics_s::skew

The last recorded clock skew used to adjust the clock.

Definition at line 621 of file stream_info.h.

int64_t NtInfoTimeSyncStatistics_s::min

The minimum clock skew measured.

Definition at line 622 of file stream_info.h.

int64_t NtInfoTimeSyncStatistics_s::max

The maximum clock skew measured.

Definition at line 623 of file stream_info.h.

int64_t NtInfoTimeSyncStatistics_s::mean

The calculate mean clock skew.

Definition at line 624 of file stream_info.h.

int64_t NtInfoTimeSyncStatistics_s::jitter

The peak to peak jitter measured.

Definition at line 625 of file stream_info.h.

uint64_t NtInfoTimeSyncStatistics_s::secSinceReset

Time elapsed since last reset in seconds (using the OS time)

Definition at line 626 of file stream_info.h.

double NtInfoTimeSyncStatistics_s::stdDevSqr

The calculated standard deviation square.

Definition at line 627 of file stream_info.h.

uint64_t NtInfoTimeSyncStatistics_s::signalLostCnt

The number of signal lost events that has occured since last reset.

Definition at line 629 of file stream_info.h.

uint64_t NtInfoTimeSyncStatistics_s::syncLostCnt

The number of out-of-sync events (or synchronization lost events) that has occured since last reset.

Definition at line 630 of file stream_info.h.

uint64_t NtInfoTimeSyncStatistics_s::hardResetCnt

The number of clock hard reset events that has occured since last reset (including the application triggered)

Definition at line 631 of file stream_info.h.

struct NtInfoCmdSystem_s

NT_INFO_CMD_READ_SYSTEM specific data

Definition at line 638 of file stream_info.h.

Data Fields

struct NtInfoSystem_s data
 System data. More...
 

Field Documentation

struct NtInfoSystem_s NtInfoCmdSystem_s::data
struct NtInfoCmdAdapter_v6_s

NT_INFO_CMD_READ_ADAPTER_V6 specific data. The adapterNo must be initialized for the relevant adapter.

Definition at line 646 of file stream_info.h.

Data Fields

uint8_t adapterNo
 The adapter to query. More...
 
uint8_t Reserved1 [3]
 
struct NtInfoAdapter_v6_s data
 The adapter data. More...
 

Field Documentation

uint8_t NtInfoCmdAdapter_v6_s::Reserved1[3]

Definition at line 648 of file stream_info.h.

struct NtInfoCmdPort_v9_s

NT_INFO_CMD_READ_PORT_V9 specific data. The portNo must be initialized for the relevant port.

Definition at line 656 of file stream_info.h.

Data Fields

uint8_t portNo
 The port to query. More...
 
uint8_t Reserved1 [3]
 
struct NtInfoPort_v9_s data
 The port data. More...
 

Field Documentation

uint8_t NtInfoCmdPort_v9_s::Reserved1[3]

Definition at line 658 of file stream_info.h.

struct NtInfoCmdSensor_s

NT_INFO_CMD_READ_SENSOR specific data. The group, adapterNo/portNo and grpIndex must be initialized for the relevant sensor. For example, to read sensor 2 from port 4, do the following: info.u.cmd = NT_INFO_CMD_READ_SENSOR; info.u.sensor.source = NT_SENSOR_SOURCE_PORT; info.u.sensor.sourceIndex= 4; info.u.sensor.sensorIndex = 2; NT_ReadInfo(h, &info);

Definition at line 673 of file stream_info.h.

Data Fields

enum NtSensorSource_e source
 The source of the sensor - either a port or adapter sensor. More...
 
uint32_t sourceIndex
 The source index - either adapter number or port number on which the sensor resides. More...
 
uint32_t sensorIndex
 The sensor index within the source index, for example, 2 for sensor 2 on port 4. More...
 
struct NtInfoSensor_s data
 The sensor data. More...
 

Field Documentation

enum NtSensorSource_e NtInfoCmdSensor_s::source

The source of the sensor - either a port or adapter sensor.

Examples:
eventMonitor_example.c, and sensor/sensor_example.c.

Definition at line 674 of file stream_info.h.

Referenced by GetSensorData(), and main().

uint32_t NtInfoCmdSensor_s::sourceIndex

The source index - either adapter number or port number on which the sensor resides.

Examples:
eventMonitor_example.c, and sensor/sensor_example.c.

Definition at line 675 of file stream_info.h.

Referenced by GetSensorData(), and main().

uint32_t NtInfoCmdSensor_s::sensorIndex

The sensor index within the source index, for example, 2 for sensor 2 on port 4.

Examples:
eventMonitor_example.c, and sensor/sensor_example.c.

Definition at line 676 of file stream_info.h.

Referenced by GetSensorData(), and main().

struct NtInfoSensor_s NtInfoCmdSensor_s::data

The sensor data.

Examples:
eventMonitor_example.c, and sensor/sensor_example.c.

Definition at line 677 of file stream_info.h.

Referenced by DumpSensor(), and main().

struct NtInfoCmdHostBuffer_v1_s

NT_INFO_CMD_READ_HOSTBUFFER_V1 specific data. The adapterNo, hostBufferNo and hostBufferType must be initialized for the relevant adapter, host buffer number and host buffer type.

Definition at line 684 of file stream_info.h.

Data Fields

uint8_t adapterNo
 The adapter to query. More...
 
uint8_t Reserved1 [3]
 
uint32_t hostBufferNo
 The host buffer to query. More...
 
enum NtNetHostBufferType_e hostBufferType
 The host buffer type, that is, CAPTURE or TX. More...
 
struct NtInfoHostBuffer_v1_s data
 The host buffer data. More...
 

Field Documentation

uint8_t NtInfoCmdHostBuffer_v1_s::adapterNo

The adapter to query.

Definition at line 685 of file stream_info.h.

uint8_t NtInfoCmdHostBuffer_v1_s::Reserved1[3]

Definition at line 686 of file stream_info.h.

uint32_t NtInfoCmdHostBuffer_v1_s::hostBufferNo

The host buffer to query.

Definition at line 687 of file stream_info.h.

enum NtNetHostBufferType_e NtInfoCmdHostBuffer_v1_s::hostBufferType

The host buffer type, that is, CAPTURE or TX.

Definition at line 688 of file stream_info.h.

struct NtInfoHostBuffer_v1_s NtInfoCmdHostBuffer_v1_s::data

The host buffer data.

Definition at line 689 of file stream_info.h.

struct NtInfoCmdStream_s

NT_INFO_CMD_READ_STREAM specific data. Returning information about streams. Currently only the list of active streams is supported.

Definition at line 696 of file stream_info.h.

Data Fields

struct NtInfoStreams_s data
 

Field Documentation

struct NtInfoStreams_s NtInfoCmdStream_s::data

Definition at line 699 of file stream_info.h.

struct NtInfoCmdstreamID_s

NT_INFO_CMD_READ_STREAMID specific data. Returning information about a streamID.

Definition at line 706 of file stream_info.h.

Data Fields

int streamId
 The streamID to query. More...
 
struct NtInfoStreamId_s data
 The streamID data. More...
 

Field Documentation

int NtInfoCmdstreamID_s::streamId

The streamID to query.

Definition at line 707 of file stream_info.h.

struct NtInfoStreamId_s NtInfoCmdstreamID_s::data

The streamID data.

Definition at line 708 of file stream_info.h.

struct NtInfoCmdTimeSync_v4_s

NT_INFO_CMD_READ_TIMESYNC_V4 specific data. The adapterNo must be initialized for the relevant adapter.

Definition at line 715 of file stream_info.h.

Data Fields

uint8_t adapterNo
 The adapter to query. More...
 
uint8_t Reserved1 [2]
 
struct NtInfoTimeSync_v4_s data
 The time sync data. More...
 

Field Documentation

uint8_t NtInfoCmdTimeSync_v4_s::adapterNo

The adapter to query.

Examples:
net/ipfdemo/ipfdemo_example.c, and pps/pps_example.c.

Definition at line 716 of file stream_info.h.

Referenced by main().

uint8_t NtInfoCmdTimeSync_v4_s::Reserved1[2]

Definition at line 717 of file stream_info.h.

struct NtInfoTimeSync_v4_s NtInfoCmdTimeSync_v4_s::data

The time sync data.

Examples:
net/ipfdemo/ipfdemo_example.c, and pps/pps_example.c.

Definition at line 718 of file stream_info.h.

Referenced by main().

struct NtInfoCmdTimeSyncStat_s

NT_INFO_CMD_READ_TIMESYNC_STAT specific data. The adapterNo must be initialized for the relevant adapter.

Definition at line 725 of file stream_info.h.

Data Fields

uint8_t adapterNo
 The adapter to query. More...
 
uint8_t Reserved1 [2]
 
struct NtInfoTimeSyncStatistics_s data
 The time sync data. More...
 

Field Documentation

uint8_t NtInfoCmdTimeSyncStat_s::adapterNo

The adapter to query.

Definition at line 726 of file stream_info.h.

uint8_t NtInfoCmdTimeSyncStat_s::Reserved1[2]

Definition at line 727 of file stream_info.h.

struct NtInfoTimeSyncStatistics_s NtInfoCmdTimeSyncStat_s::data

The time sync data.

Definition at line 728 of file stream_info.h.

struct NtInfoCmdTimeSyncStatusExt_s

NT_INFO_CMD_READ_TIMESYNC_EXT_STATUS specific data. The adapterNo must be initialized for the relevant adapter.

Definition at line 736 of file stream_info.h.

Data Fields

uint8_t adapterNo
 The adapter to query. More...
 
uint8_t Reserved1 [3]
 
struct NtInfoTimeSyncStatusExt_s data
 The time sync data. More...
 

Field Documentation

uint8_t NtInfoCmdTimeSyncStatusExt_s::adapterNo

The adapter to query.

Definition at line 737 of file stream_info.h.

uint8_t NtInfoCmdTimeSyncStatusExt_s::Reserved1[3]

Definition at line 738 of file stream_info.h.

struct NtInfoTimeSyncStatusExt_s NtInfoCmdTimeSyncStatusExt_s::data

The time sync data.

Definition at line 739 of file stream_info.h.

struct NtPTPTimestamp_s

Timestamp structure used for PTP information request Number of seconds since configured Epoch (if PTP timescale, this is TAI time)

Definition at line 797 of file stream_info.h.

Data Fields

uint32_t sec
 Number of seconds and nano seconds since Epoch. More...
 
uint32_t nsec
 

Field Documentation

uint32_t NtPTPTimestamp_s::sec

Number of seconds and nano seconds since Epoch.

Definition at line 798 of file stream_info.h.

uint32_t NtPTPTimestamp_s::nsec

Definition at line 799 of file stream_info.h.

struct NtPTPPortStat_s

Rx and Tx port statistics for the PTP ethernet port

Definition at line 805 of file stream_info.h.

Data Fields

uint32_t txGoodBytes
 Number of Good bytes transmitted. More...
 
uint32_t txGoodBroadcast
 Number of Good Broadcast frames transmitted. More...
 
uint32_t txGoodMulticast
 Number of Good Multicast frames transmitted. More...
 
uint32_t txGoodUnicast
 Number of Good Unicast frames transmitted. More...
 
uint32_t rxGoodBytes
 Number of Good bytes received. More...
 
uint32_t rxGoodBroadcast
 Number of Good Broadcast frames received. More...
 
uint32_t rxGoodMulticast
 Number of Good Multicast frames received. More...
 
uint32_t rxGoodUnicast
 Number of Good Unicast frames received. More...
 
uint32_t rxGoodLegalLength
 Number of Good legal length received with errors received. More...
 
uint32_t rxFragmented
 Number of Fragmented frames received. More...
 
uint32_t rxJabber
 Number of Jabber frames received. More...
 
uint32_t rxBadBytes
 Number of Bad bytes received. More...
 
uint32_t rxDiscarded
 Number of Discarded frames received. More...
 

Field Documentation

uint32_t NtPTPPortStat_s::txGoodBytes

Number of Good bytes transmitted.

Definition at line 807 of file stream_info.h.

uint32_t NtPTPPortStat_s::txGoodBroadcast

Number of Good Broadcast frames transmitted.

Definition at line 808 of file stream_info.h.

uint32_t NtPTPPortStat_s::txGoodMulticast

Number of Good Multicast frames transmitted.

Definition at line 809 of file stream_info.h.

uint32_t NtPTPPortStat_s::txGoodUnicast

Number of Good Unicast frames transmitted.

Definition at line 810 of file stream_info.h.

uint32_t NtPTPPortStat_s::rxGoodBytes

Number of Good bytes received.

Definition at line 811 of file stream_info.h.

uint32_t NtPTPPortStat_s::rxGoodBroadcast

Number of Good Broadcast frames received.

Definition at line 812 of file stream_info.h.

uint32_t NtPTPPortStat_s::rxGoodMulticast

Number of Good Multicast frames received.

Definition at line 813 of file stream_info.h.

uint32_t NtPTPPortStat_s::rxGoodUnicast

Number of Good Unicast frames received.

Definition at line 814 of file stream_info.h.

uint32_t NtPTPPortStat_s::rxGoodLegalLength

Number of Good legal length received with errors received.

Definition at line 815 of file stream_info.h.

uint32_t NtPTPPortStat_s::rxFragmented

Number of Fragmented frames received.

Definition at line 816 of file stream_info.h.

uint32_t NtPTPPortStat_s::rxJabber

Number of Jabber frames received.

Definition at line 817 of file stream_info.h.

uint32_t NtPTPPortStat_s::rxBadBytes

Number of Bad bytes received.

Definition at line 818 of file stream_info.h.

uint32_t NtPTPPortStat_s::rxDiscarded

Number of Discarded frames received.

Definition at line 819 of file stream_info.h.

struct NtPTPPort_s

Information structure for PTP port

Definition at line 836 of file stream_info.h.

Data Fields

enum NtPTPClockType_e clockType
 Ordinary, boundary or transparent clock. More...
 
uint8_t physicalLayerProtocol [65]
 Ethernet IEEE 802.3. More...
 
int16_t physicalAddressLen
 Length of physical address. More...
 
uint8_t physicalAdress [6]
 Physical address. More...
 
uint8_t protocolAddress [33]
 ex. IPv4:10.10.10.50 or Layer2:00:0D:E9:33:22:11 More...
 
uint8_t manufacturerId [3]
 Manufacturer identification. More...
 
uint8_t productDescription [129]
 Product description. More...
 
uint8_t revisionData [129]
 Product revision. More...
 
uint8_t userDescr [129]
 User description. More...
 
uint8_t profileId [6]
 Configured PTP profile. More...
 
enum NtLinkSpeed_e linkSpeed
 Current link speed on PTP ethernet port. More...
 
enum NtPTPNetProt_e ptpNetProt
 Configured PTP network protocol. More...
 
enum NtPTPFilter_e ptpFilter
 Configured PTP filter. More...
 
enum NtPTPProfile_e ptpProfile
 The PTP profile configured on this adapter. More...
 
uint32_t ipAddress
 IP address. More...
 
uint32_t ipSubmask
 IP subnet mask. More...
 
uint32_t ipGateway
 IP gateway. More...
 
bool dhcp
 DHCP enabled. More...
 
uint16_t vlanId
 Configured Vlan Id. More...
 
uint16_t vlanPrio
 Configured Vlan priority. More...
 

Field Documentation

enum NtPTPClockType_e NtPTPPort_s::clockType

Ordinary, boundary or transparent clock.

Definition at line 838 of file stream_info.h.

uint8_t NtPTPPort_s::physicalLayerProtocol[65]

Ethernet IEEE 802.3.

Definition at line 839 of file stream_info.h.

int16_t NtPTPPort_s::physicalAddressLen

Length of physical address.

Definition at line 840 of file stream_info.h.

uint8_t NtPTPPort_s::physicalAdress[6]

Physical address.

Definition at line 841 of file stream_info.h.

uint8_t NtPTPPort_s::protocolAddress[33]

ex. IPv4:10.10.10.50 or Layer2:00:0D:E9:33:22:11

Definition at line 842 of file stream_info.h.

uint8_t NtPTPPort_s::manufacturerId[3]

Manufacturer identification.

Definition at line 843 of file stream_info.h.

uint8_t NtPTPPort_s::productDescription[129]

Product description.

Definition at line 844 of file stream_info.h.

uint8_t NtPTPPort_s::revisionData[129]

Product revision.

Definition at line 845 of file stream_info.h.

uint8_t NtPTPPort_s::userDescr[129]

User description.

Definition at line 846 of file stream_info.h.

uint8_t NtPTPPort_s::profileId[6]

Configured PTP profile.

Definition at line 847 of file stream_info.h.

enum NtLinkSpeed_e NtPTPPort_s::linkSpeed

Current link speed on PTP ethernet port.

Definition at line 850 of file stream_info.h.

enum NtPTPNetProt_e NtPTPPort_s::ptpNetProt

Configured PTP network protocol.

Definition at line 851 of file stream_info.h.

enum NtPTPFilter_e NtPTPPort_s::ptpFilter

Configured PTP filter.

Definition at line 852 of file stream_info.h.

enum NtPTPProfile_e NtPTPPort_s::ptpProfile

The PTP profile configured on this adapter.

Definition at line 853 of file stream_info.h.

uint32_t NtPTPPort_s::ipAddress

IP address.

Definition at line 854 of file stream_info.h.

uint32_t NtPTPPort_s::ipSubmask

IP subnet mask.

Definition at line 855 of file stream_info.h.

uint32_t NtPTPPort_s::ipGateway

IP gateway.

Definition at line 856 of file stream_info.h.

bool NtPTPPort_s::dhcp

DHCP enabled.

Definition at line 857 of file stream_info.h.

uint16_t NtPTPPort_s::vlanId

Configured Vlan Id.

Definition at line 858 of file stream_info.h.

uint16_t NtPTPPort_s::vlanPrio

Configured Vlan priority.

Definition at line 859 of file stream_info.h.

struct NtPTPclkQuality_s

IEEE 1588 PTP clock quality

Definition at line 867 of file stream_info.h.

Data Fields

uint8_t clkClass
 Clock class. More...
 
uint8_t clkAccuracy
 Clock accuracy. More...
 
uint16_t clkVariance
 Clock variance. More...
 

Field Documentation

uint8_t NtPTPclkQuality_s::clkClass

Clock class.

Definition at line 868 of file stream_info.h.

uint8_t NtPTPclkQuality_s::clkAccuracy

Clock accuracy.

Definition at line 869 of file stream_info.h.

uint16_t NtPTPclkQuality_s::clkVariance

Clock variance.

Definition at line 870 of file stream_info.h.

struct NtPTPdefaultDs_s

IEEE 1588 PTP Default Data Set

Definition at line 876 of file stream_info.h.

Data Fields

bool twoStepFlag
 One or two step clock. More...
 
uint8_t clockId [8]
 Clock Id. More...
 
uint16_t NumPorts
 Number of ports. More...
 
struct NtPTPclkQuality_s clkQuality
 Clock quality. More...
 
uint8_t priority1
 Master priority1 for BMC. More...
 
uint8_t priority2
 Master priority2 for BMC. More...
 
uint8_t domain
 PTP domain operating in. More...
 
bool slaveOnly
 Slave-only identifier. More...
 

Field Documentation

bool NtPTPdefaultDs_s::twoStepFlag

One or two step clock.

Definition at line 878 of file stream_info.h.

uint8_t NtPTPdefaultDs_s::clockId[8]

Clock Id.

Definition at line 879 of file stream_info.h.

uint16_t NtPTPdefaultDs_s::NumPorts

Number of ports.

Definition at line 880 of file stream_info.h.

struct NtPTPclkQuality_s NtPTPdefaultDs_s::clkQuality

Clock quality.

Definition at line 881 of file stream_info.h.

uint8_t NtPTPdefaultDs_s::priority1

Master priority1 for BMC.

Definition at line 883 of file stream_info.h.

uint8_t NtPTPdefaultDs_s::priority2

Master priority2 for BMC.

Definition at line 884 of file stream_info.h.

uint8_t NtPTPdefaultDs_s::domain

PTP domain operating in.

Definition at line 885 of file stream_info.h.

bool NtPTPdefaultDs_s::slaveOnly

Slave-only identifier.

Definition at line 886 of file stream_info.h.

struct NtPTPcurrentDs_s

IEEE 1588 PTP Current Data Set

Definition at line 892 of file stream_info.h.

Data Fields

uint16_t stepsRemoved
 Steps removed information for BMC. More...
 
int64_t offsFromMaster
 Current offset from master. More...
 
int64_t meanPathDelay
 Current mean path delay. More...
 

Field Documentation

uint16_t NtPTPcurrentDs_s::stepsRemoved

Steps removed information for BMC.

Definition at line 893 of file stream_info.h.

int64_t NtPTPcurrentDs_s::offsFromMaster

Current offset from master.

Definition at line 894 of file stream_info.h.

int64_t NtPTPcurrentDs_s::meanPathDelay

Current mean path delay.

Definition at line 895 of file stream_info.h.

struct NtPTPparentDs_s

IEEE 1588 PTP Parent Data Set

Definition at line 901 of file stream_info.h.

Data Fields

uint8_t parentPortId [8]
 Parent port identifier. More...
 
bool parentStat
 Is observed variance and observed phase change measured. More...
 
uint16_t observedOffsScaledLogVariance
 Observed offset variance of the parent clock, measured by this clock. More...
 
int32_t observedPhaseChangeRate
 Observed phase change rate of the parent clock, measured by this clock. More...
 
struct NtPTPclkQuality_s gmQuality
 Grand Master clock quality. More...
 
uint8_t gmId [8]
 Grand Master clock Id. More...
 
uint8_t gmPriority1
 Grand Master priority 1. More...
 
uint8_t gmPriority2
 Grand Master priority 2. More...
 
union {
   struct {
      uint8_t   grandmasterId
 Power profile Grand master ID. More...
 
      uint32_t   grandmasterTimeInaccuracy
 Power profile grand master time inacuuracy. More...
 
      uint32_t   networkTimeInaccuracy
 Power profile network time inaccuracy. More...
 
      uint8_t   keyField
 Alternate time offset indicator tlv keyField. More...
 
      uint32_t   currentOffset
 Alternate time offset indicator tlv currentOffset. More...
 
      uint32_t   jumpSeconds
 Alternate time offset indicator tlv jumpSeconds. More...
 
      uint64_t   timeOfNextJump
 Alternate time offset indicator tlv timeOfNextJump. More...
 
      char   displayName [10]
 Alternate time offset indicator tlv displayName. More...
 
   }   power
 
   struct {
      uint32_t   IPv4_Addr
 IP address of Unicast grand master. More...
 
      uint8_t   ssm_ql
 Telecom profile SSM quality level. More...
 
      uint8_t   priority
 The configured priority of current grand master. More...
 
   }   telecom
 
profile
 information received on Announce depending on PTP profile used More...
 

Field Documentation

uint8_t NtPTPparentDs_s::parentPortId[8]

Parent port identifier.

Definition at line 902 of file stream_info.h.

bool NtPTPparentDs_s::parentStat

Is observed variance and observed phase change measured.

Definition at line 903 of file stream_info.h.

uint16_t NtPTPparentDs_s::observedOffsScaledLogVariance

Observed offset variance of the parent clock, measured by this clock.

Definition at line 904 of file stream_info.h.

int32_t NtPTPparentDs_s::observedPhaseChangeRate

Observed phase change rate of the parent clock, measured by this clock.

Definition at line 905 of file stream_info.h.

struct NtPTPclkQuality_s NtPTPparentDs_s::gmQuality

Grand Master clock quality.

Definition at line 906 of file stream_info.h.

uint8_t NtPTPparentDs_s::gmId[8]

Grand Master clock Id.

Definition at line 907 of file stream_info.h.

uint8_t NtPTPparentDs_s::gmPriority1

Grand Master priority 1.

Definition at line 908 of file stream_info.h.

uint8_t NtPTPparentDs_s::gmPriority2

Grand Master priority 2.

Definition at line 909 of file stream_info.h.

uint8_t NtPTPparentDs_s::grandmasterId

Power profile Grand master ID.

Definition at line 914 of file stream_info.h.

uint32_t NtPTPparentDs_s::grandmasterTimeInaccuracy

Power profile grand master time inacuuracy.

Definition at line 915 of file stream_info.h.

uint32_t NtPTPparentDs_s::networkTimeInaccuracy

Power profile network time inaccuracy.

Definition at line 916 of file stream_info.h.

uint8_t NtPTPparentDs_s::keyField

Alternate time offset indicator tlv keyField.

Definition at line 917 of file stream_info.h.

uint32_t NtPTPparentDs_s::currentOffset

Alternate time offset indicator tlv currentOffset.

Definition at line 918 of file stream_info.h.

uint32_t NtPTPparentDs_s::jumpSeconds

Alternate time offset indicator tlv jumpSeconds.

Definition at line 919 of file stream_info.h.

uint64_t NtPTPparentDs_s::timeOfNextJump

Alternate time offset indicator tlv timeOfNextJump.

Definition at line 920 of file stream_info.h.

char NtPTPparentDs_s::displayName[10]

Alternate time offset indicator tlv displayName.

Definition at line 921 of file stream_info.h.

struct { ... } NtPTPparentDs_s::power
uint32_t NtPTPparentDs_s::IPv4_Addr

IP address of Unicast grand master.

Definition at line 924 of file stream_info.h.

uint8_t NtPTPparentDs_s::ssm_ql

Telecom profile SSM quality level.

Definition at line 925 of file stream_info.h.

uint8_t NtPTPparentDs_s::priority

The configured priority of current grand master.

Definition at line 926 of file stream_info.h.

struct { ... } NtPTPparentDs_s::telecom
union { ... } NtPTPparentDs_s::profile

information received on Announce depending on PTP profile used

struct NtPTPtimePropertiesDs_s

IEEE 1588 PTP Time Properties Data Set

Definition at line 934 of file stream_info.h.

Data Fields

int16_t currentUtcOffset
 Current UTC offset used. This may be from GM or configured if currUtcOffsValid is false. More...
 
bool currUtcOffsValid
 Is current UTC offset specified by GM valid. More...
 
bool leap59
 True if last minute of current UTC day is 59 sec. More...
 
bool leap61
 True if last minute of current UTC day is 61 sec. More...
 
bool timeTraceable
 True if timescale and current UTC offset is traceable to a primary source. More...
 
bool frequencyTraceable
 True if the frequency determining the timescale is traceable to a primary source. More...
 
bool ptpTimescale
 True if GM timescale is PTP. More...
 
enum NtPTPTimeSource_e timeSource
 Identifies the source used by the GM. More...
 

Field Documentation

int16_t NtPTPtimePropertiesDs_s::currentUtcOffset

Current UTC offset used. This may be from GM or configured if currUtcOffsValid is false.

Definition at line 935 of file stream_info.h.

bool NtPTPtimePropertiesDs_s::currUtcOffsValid

Is current UTC offset specified by GM valid.

Definition at line 936 of file stream_info.h.

bool NtPTPtimePropertiesDs_s::leap59

True if last minute of current UTC day is 59 sec.

Definition at line 937 of file stream_info.h.

bool NtPTPtimePropertiesDs_s::leap61

True if last minute of current UTC day is 61 sec.

Definition at line 938 of file stream_info.h.

bool NtPTPtimePropertiesDs_s::timeTraceable

True if timescale and current UTC offset is traceable to a primary source.

Definition at line 939 of file stream_info.h.

bool NtPTPtimePropertiesDs_s::frequencyTraceable

True if the frequency determining the timescale is traceable to a primary source.

Definition at line 940 of file stream_info.h.

bool NtPTPtimePropertiesDs_s::ptpTimescale

True if GM timescale is PTP.

Definition at line 941 of file stream_info.h.

enum NtPTPTimeSource_e NtPTPtimePropertiesDs_s::timeSource

Identifies the source used by the GM.

Definition at line 942 of file stream_info.h.

struct NtPTPportDs_s

IEEE 1588 PTP Port Data Set

Definition at line 949 of file stream_info.h.

Data Fields

uint8_t portId [8]
 Port Identity. More...
 
enum NtPTPPortState_e state
 Current PTP port state. More...
 
int64_t peerMeanPathDelay
 If using Peer-to-Peer delay mechanism this is the measured P2P propagation delay for this port. More...
 
uint8_t versionNumber
 PTP version number of this port. More...
 
int8_t logMinDelReqInt
 Current minimum delay request interval (when E2E used) More...
 
int8_t logAnnoInt
 Current mean announce interval. More...
 
uint8_t announceReceiptTimeout
 Configured announce receipt timeout multiplier. More...
 
int8_t logSyncInt
 Configured sync interval used in master mode. More...
 
enum NtPTPDelayMech_e delayMechanism
 Configured propagation delay mechanism. More...
 
int8_t logMinPDelayReqInt
 Configured minimum peer delay request interval (when P2P used) More...
 

Field Documentation

uint8_t NtPTPportDs_s::portId[8]

Port Identity.

Definition at line 950 of file stream_info.h.

enum NtPTPPortState_e NtPTPportDs_s::state

Current PTP port state.

Definition at line 951 of file stream_info.h.

int64_t NtPTPportDs_s::peerMeanPathDelay

If using Peer-to-Peer delay mechanism this is the measured P2P propagation delay for this port.

Definition at line 952 of file stream_info.h.

uint8_t NtPTPportDs_s::versionNumber

PTP version number of this port.

Definition at line 953 of file stream_info.h.

int8_t NtPTPportDs_s::logMinDelReqInt

Current minimum delay request interval (when E2E used)

Definition at line 955 of file stream_info.h.

int8_t NtPTPportDs_s::logAnnoInt

Current mean announce interval.

Definition at line 956 of file stream_info.h.

uint8_t NtPTPportDs_s::announceReceiptTimeout

Configured announce receipt timeout multiplier.

Definition at line 957 of file stream_info.h.

int8_t NtPTPportDs_s::logSyncInt

Configured sync interval used in master mode.

Definition at line 958 of file stream_info.h.

enum NtPTPDelayMech_e NtPTPportDs_s::delayMechanism

Configured propagation delay mechanism.

Definition at line 959 of file stream_info.h.

int8_t NtPTPportDs_s::logMinPDelayReqInt

Configured minimum peer delay request interval (when P2P used)

Definition at line 960 of file stream_info.h.

struct NtPTPDataSets_s

IEEE 1588 PTP all Data Sets

Definition at line 966 of file stream_info.h.

Data Fields

struct NtPTPdefaultDs_s defaultDs
 Default Data Set. More...
 
struct NtPTPcurrentDs_s currentDs
 Current Data Set. More...
 
struct NtPTPparentDs_s parentDs
 Parent Data Set. More...
 
struct NtPTPtimePropertiesDs_s timePropDs
 Time Property Data Set. More...
 
struct NtPTPportDs_s portDs
 Port Data Set. More...
 

Field Documentation

struct NtPTPdefaultDs_s NtPTPDataSets_s::defaultDs

Default Data Set.

Definition at line 967 of file stream_info.h.

struct NtPTPcurrentDs_s NtPTPDataSets_s::currentDs

Current Data Set.

Definition at line 968 of file stream_info.h.

struct NtPTPparentDs_s NtPTPDataSets_s::parentDs

Parent Data Set.

Definition at line 969 of file stream_info.h.

struct NtPTPtimePropertiesDs_s NtPTPDataSets_s::timePropDs

Time Property Data Set.

Definition at line 970 of file stream_info.h.

struct NtPTPportDs_s NtPTPDataSets_s::portDs

Port Data Set.

Definition at line 971 of file stream_info.h.

struct NtPTPImplCfg_s

Definition at line 974 of file stream_info.h.

Data Fields

int32_t PTPDelayAsymmetry
 PTP Delay asymmetry compensation parameter in ns. More...
 

Field Documentation

int32_t NtPTPImplCfg_s::PTPDelayAsymmetry

PTP Delay asymmetry compensation parameter in ns.

Definition at line 975 of file stream_info.h.

struct NtInfoPTP_v2_s

PTP information structure

Definition at line 983 of file stream_info.h.

Data Fields

bool enabled
 Is PTP stack configured to be used (slave, master or ptp pps sampling) More...
 
struct NtPTPTimestamp_s ts
 Timestamp at this info retrieval. More...
 
struct NtPTPPort_s ptpPort
 PTP port information structure. More...
 
struct NtPTPDataSets_s ptpDataSets
 PTP data sets (according to IEEE1588-2008 spec.) More...
 
struct NtPTPPortStat_s ptpPortStat
 PTP ethernet port statistics. More...
 
struct NtPTPImplCfg_s ptpImplCfg
 PTP implementation configuration settings. More...
 

Field Documentation

bool NtInfoPTP_v2_s::enabled

Is PTP stack configured to be used (slave, master or ptp pps sampling)

Definition at line 984 of file stream_info.h.

struct NtPTPTimestamp_s NtInfoPTP_v2_s::ts

Timestamp at this info retrieval.

Definition at line 985 of file stream_info.h.

struct NtPTPPort_s NtInfoPTP_v2_s::ptpPort

PTP port information structure.

Definition at line 986 of file stream_info.h.

struct NtPTPDataSets_s NtInfoPTP_v2_s::ptpDataSets

PTP data sets (according to IEEE1588-2008 spec.)

Definition at line 987 of file stream_info.h.

struct NtPTPPortStat_s NtInfoPTP_v2_s::ptpPortStat

PTP ethernet port statistics.

Definition at line 988 of file stream_info.h.

struct NtPTPImplCfg_s NtInfoPTP_v2_s::ptpImplCfg

PTP implementation configuration settings.

Definition at line 989 of file stream_info.h.

struct NtInfoCmdPTP_v2_s

NT_INFO_CMD_READ_PTP_V2 specific data.

Definition at line 995 of file stream_info.h.

Data Fields

uint8_t adapterNo
 The adapter to query. More...
 
uint8_t Reserved1 [2]
 
struct NtInfoPTP_v2_s data
 Query PTP information structure. More...
 

Field Documentation

uint8_t NtInfoCmdPTP_v2_s::adapterNo

The adapter to query.

Definition at line 996 of file stream_info.h.

uint8_t NtInfoCmdPTP_v2_s::Reserved1[2]

Definition at line 997 of file stream_info.h.

struct NtInfoPTP_v2_s NtInfoCmdPTP_v2_s::data

Query PTP information structure.

Definition at line 998 of file stream_info.h.

struct NtInfoProductInfo_v2_s

Structure to read product information

Examples:
info/info_example.c.

Definition at line 1015 of file stream_info.h.

Data Fields

enum NtProductInfoType_e infoType
 Information from Gen 1, Gen 2, NTBPE or Gen 3 adapter. More...
 
char ProductId [32]
 Product ID (P/N) More...
 
char SerialNo [2][32]
 Serial number (only index 0 used on Gen 1 otherwise 0 = main, 1 = front) More...
 
char PbaId [2][32]
 PBA ID (only index 0 used on Gen 1 otherwise 0 = main, 1 = front) More...
 
char AvrId [2][32]
 AVR version (only on Gen 2) More...
 
char CpldVersion [32]
 CPLD Version. More...
 
char fpgaId1 [40]
 FPGA Image #0 ID. More...
 
char fpgaId2 [40]
 FPGA Image #1 ID. More...
 
uint16_t customId
 Custom ID. More...
 
uint8_t userId [8]
 User ID. More...
 

Field Documentation

enum NtProductInfoType_e NtInfoProductInfo_v2_s::infoType

Information from Gen 1, Gen 2, NTBPE or Gen 3 adapter.

Examples:
info/info_example.c.

Definition at line 1016 of file stream_info.h.

Referenced by showProductInfo().

char NtInfoProductInfo_v2_s::ProductId[32]

Product ID (P/N)

Examples:
info/info_example.c.

Definition at line 1017 of file stream_info.h.

Referenced by showProductInfo().

char NtInfoProductInfo_v2_s::SerialNo[2][32]

Serial number (only index 0 used on Gen 1 otherwise 0 = main, 1 = front)

Examples:
info/info_example.c.

Definition at line 1018 of file stream_info.h.

Referenced by showProductInfo().

char NtInfoProductInfo_v2_s::PbaId[2][32]

PBA ID (only index 0 used on Gen 1 otherwise 0 = main, 1 = front)

Examples:
info/info_example.c.

Definition at line 1019 of file stream_info.h.

Referenced by showProductInfo().

char NtInfoProductInfo_v2_s::AvrId[2][32]

AVR version (only on Gen 2)

Examples:
info/info_example.c.

Definition at line 1020 of file stream_info.h.

Referenced by showProductInfo().

char NtInfoProductInfo_v2_s::CpldVersion[32]

CPLD Version.

Examples:
info/info_example.c.

Definition at line 1021 of file stream_info.h.

Referenced by showProductInfo().

char NtInfoProductInfo_v2_s::fpgaId1[40]

FPGA Image #0 ID.

Examples:
info/info_example.c.

Definition at line 1022 of file stream_info.h.

Referenced by showProductInfo().

char NtInfoProductInfo_v2_s::fpgaId2[40]

FPGA Image #1 ID.

Examples:
info/info_example.c.

Definition at line 1023 of file stream_info.h.

Referenced by showProductInfo().

uint16_t NtInfoProductInfo_v2_s::customId

Custom ID.

Definition at line 1024 of file stream_info.h.

uint8_t NtInfoProductInfo_v2_s::userId[8]

User ID.

Definition at line 1025 of file stream_info.h.

struct NtInfoReadProductInfo_v2_s

Product info

Definition at line 1032 of file stream_info.h.

Data Fields

uint8_t adapterNo
 Adapter number to query for product information. More...
 
NtInfoProductInfo_v2_t data
 Product Information returned. More...
 

Field Documentation

uint8_t NtInfoReadProductInfo_v2_s::adapterNo

Adapter number to query for product information.

Examples:
info/info_example.c.

Definition at line 1033 of file stream_info.h.

Referenced by showProductInfo().

NtInfoProductInfo_v2_t NtInfoReadProductInfo_v2_s::data

Product Information returned.

Examples:
info/info_example.c.

Definition at line 1034 of file stream_info.h.

Referenced by showProductInfo().

struct NtInfoFilterUsage3ga_s

Structure to read NTPL filter usage for gen. 3 adapters

Definition at line 1041 of file stream_info.h.

Data Fields

int32_t sizeCount
 Number of frame length filters used. More...
 
int32_t protocolCount
 Number of protocol filters used. More...
 
int32_t errorCount
 Number of error filters used. More...
 
int32_t patternCount
 Number of data filters used. More...
 
int32_t dynOffsetCount
 Number of dynamic offsets used. More...
 
int32_t group4PlusCount
 Number of group filters used combining 4 patterns with 4 different dynamic offsets. More...
 
int32_t group8Count
 Number of group filters used combining 8 patterns with 2 different dynamic offsets. More...
 
int32_t ipmatchCount
 Number of IP match filters used. More...
 
int32_t ipmatchListOuter
 Number of IP match list outer resources used. More...
 
int32_t ipmatchListInner
 Number of IP match list inner resources used. More...
 

Field Documentation

int32_t NtInfoFilterUsage3ga_s::sizeCount

Number of frame length filters used.

Definition at line 1042 of file stream_info.h.

int32_t NtInfoFilterUsage3ga_s::protocolCount

Number of protocol filters used.

Definition at line 1043 of file stream_info.h.

int32_t NtInfoFilterUsage3ga_s::errorCount

Number of error filters used.

Definition at line 1044 of file stream_info.h.

int32_t NtInfoFilterUsage3ga_s::patternCount

Number of data filters used.

Definition at line 1045 of file stream_info.h.

int32_t NtInfoFilterUsage3ga_s::dynOffsetCount

Number of dynamic offsets used.

Definition at line 1046 of file stream_info.h.

int32_t NtInfoFilterUsage3ga_s::group4PlusCount

Number of group filters used combining 4 patterns with 4 different dynamic offsets.

Definition at line 1047 of file stream_info.h.

int32_t NtInfoFilterUsage3ga_s::group8Count

Number of group filters used combining 8 patterns with 2 different dynamic offsets.

Definition at line 1048 of file stream_info.h.

int32_t NtInfoFilterUsage3ga_s::ipmatchCount

Number of IP match filters used.

Definition at line 1049 of file stream_info.h.

int32_t NtInfoFilterUsage3ga_s::ipmatchListOuter

Number of IP match list outer resources used.

Definition at line 1050 of file stream_info.h.

int32_t NtInfoFilterUsage3ga_s::ipmatchListInner

Number of IP match list inner resources used.

Definition at line 1051 of file stream_info.h.

struct NtInfoFilterUsage4ga_s

Structure to read NTPL filter usage for gen. 4 adapters

Definition at line 1057 of file stream_info.h.

Data Fields

uint32_t categorizerFunctionCount
 Number of categorizer functions used. More...
 
uint32_t sizeCount
 Number of frame length comparators used. More...
 
uint32_t patternExtractorCount
 Number of data extractors used. More...
 
uint32_t patternCompareCount
 Number of data comparators used. More...
 
uint32_t keyMatchCAMUsage
 CAM usage in percent. More...
 
uint32_t keyMatchTCAMUsage
 TCAM usage in percent. More...
 

Field Documentation

uint32_t NtInfoFilterUsage4ga_s::categorizerFunctionCount

Number of categorizer functions used.

Definition at line 1058 of file stream_info.h.

uint32_t NtInfoFilterUsage4ga_s::sizeCount

Number of frame length comparators used.

Definition at line 1059 of file stream_info.h.

uint32_t NtInfoFilterUsage4ga_s::patternExtractorCount

Number of data extractors used.

Definition at line 1060 of file stream_info.h.

uint32_t NtInfoFilterUsage4ga_s::patternCompareCount

Number of data comparators used.

Definition at line 1061 of file stream_info.h.

uint32_t NtInfoFilterUsage4ga_s::keyMatchCAMUsage

CAM usage in percent.

Definition at line 1062 of file stream_info.h.

uint32_t NtInfoFilterUsage4ga_s::keyMatchTCAMUsage

TCAM usage in percent.

Definition at line 1063 of file stream_info.h.

struct NtInfoFilterUsage_v1_s

Definition at line 1066 of file stream_info.h.

Data Fields

enum NtAdapterFpgaArchGeneration_e generation
 Adapter generation. More...
 
union {
   NtInfoFilterUsage3ga_t   filterUsage3ga
 
   NtInfoFilterUsage4ga_t   filterUsage4ga
 
u
 

Field Documentation

enum NtAdapterFpgaArchGeneration_e NtInfoFilterUsage_v1_s::generation

Adapter generation.

Definition at line 1067 of file stream_info.h.

NtInfoFilterUsage3ga_t NtInfoFilterUsage_v1_s::filterUsage3ga

Definition at line 1069 of file stream_info.h.

NtInfoFilterUsage4ga_t NtInfoFilterUsage_v1_s::filterUsage4ga

Definition at line 1070 of file stream_info.h.

union { ... } NtInfoFilterUsage_v1_s::u
struct NtInfoCmdFilterUsage_v1_s

Filter usage command

Definition at line 1077 of file stream_info.h.

Data Fields

uint8_t adapterNo
 Adapter number to query for filter usage. More...
 
uint8_t Reserved1 [3]
 
uint32_t ntplId
 Ntpl ID to query. 0 will retrieve total usage. More...
 
NtInfoFilterUsage_v1_t data
 Filter usage information returned. More...
 

Field Documentation

uint8_t NtInfoCmdFilterUsage_v1_s::adapterNo

Adapter number to query for filter usage.

Definition at line 1078 of file stream_info.h.

uint8_t NtInfoCmdFilterUsage_v1_s::Reserved1[3]

Definition at line 1079 of file stream_info.h.

uint32_t NtInfoCmdFilterUsage_v1_s::ntplId

Ntpl ID to query. 0 will retrieve total usage.

Definition at line 1080 of file stream_info.h.

NtInfoFilterUsage_v1_t NtInfoCmdFilterUsage_v1_s::data

Filter usage information returned.

Definition at line 1081 of file stream_info.h.

struct NtInfoPortPathDelay_s

Structure used for returning port path delay information

Definition at line 1101 of file stream_info.h.

Data Fields

enum NtPathDelayStatus_e status
 status code More...
 
int32_t delay
 The delay. More...
 

Field Documentation

enum NtPathDelayStatus_e NtInfoPortPathDelay_s::status

status code

Definition at line 1102 of file stream_info.h.

int32_t NtInfoPortPathDelay_s::delay

The delay.

Definition at line 1103 of file stream_info.h.

struct NtInfoCmdPortPathDelay_s

Definition at line 1111 of file stream_info.h.

Data Fields

uint8_t portNo
 Virtual port number on which to query path delay. More...
 
uint8_t direction
 NT_PATH_DELAY_RX_DIR or NT_PATH_DELAY_TX_DIR. More...
 
uint8_t Reserved1 [2]
 
NtInfoPortPathDelayInfo_t data
 Delay information (returned to caller) More...
 

Field Documentation

uint8_t NtInfoCmdPortPathDelay_s::portNo

Virtual port number on which to query path delay.

Definition at line 1112 of file stream_info.h.

uint8_t NtInfoCmdPortPathDelay_s::direction

NT_PATH_DELAY_RX_DIR or NT_PATH_DELAY_TX_DIR.

Definition at line 1113 of file stream_info.h.

uint8_t NtInfoCmdPortPathDelay_s::Reserved1[2]

Definition at line 1114 of file stream_info.h.

NtInfoPortPathDelayInfo_t NtInfoCmdPortPathDelay_s::data