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_s *	NtInfoSensor_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

Version info

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

Referenced by main().

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.