Configuration Stream

Reference Documentation

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

Detailed Description

Configuration streams are used to read and write configuration data and to set the filter configuration using NTPL commands. This includes everything that can be changed on the fly. All static configuration is done in the ntservice.ini file.

All configuration parameters are organized in a parameter tree structure NtConfig_t where some parameters are read only (static configuration parameters) and some parameters are read and write (dynamic configuration parameters).

To open a configuration stream call NT_ConfigOpen. Once the configuration stream is open use NT_ConfigRead and NT_ConfigWrite with the NtConfig_t structure to retrieve and change the configuration. When done, call NT_ConfigClose to close the stream.

Note
Changing a configuration setting will trigger an NT_EVENT_SOURCE_CONFIG when the changes have been made.

The configuration parameter types currently supported are:

  • Port settings - retrieves or changes link speed, IFG, MDI mode
  • Time stamp type Retrieves or changes time stamp configuration
  • Time synchronization Retrieves or changes time synchronization configuration
  • Sensor min/max alarm settings Retrieves or changes sensor min/max alarm limits configuration
  • Coordinated time synchronized transmit Sets the coordinated time synchronized transmit configuration

To set up or change filter configuration using NTPL commands use the NT_NTPL function call on an open configuration stream. For a complete description of the NTPL syntax see NTPL Overview.

For an example of using the configuration stream see config/config_example.c.

Note
The config 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_ConfigOpen (NtConfigStream_t *hStream, const char *name)
 Opens a configuration stream. More...
 
int NT_ConfigClose (NtConfigStream_t hStream)
 Closes a configuration stream. More...
 
int NT_ConfigRead (NtConfigStream_t hStream, NtConfig_t *data)
 Reads data from a configuration stream. More...
 
int NT_ConfigWrite (NtConfigStream_t hStream, NtConfig_t *data)
 Writes data to a configuration stream. More...
 
int NT_NTPL (NtConfigStream_t hStream, const char *ntplBuffer, NtNtplInfo_t *info, uint32_t validate)
 Sends an NTPL line buffer to the parser. More...
 

Data Structures

struct  NtPortSettingsManual_s
 
struct  NtPortSettingsAdvertise_s
 
struct  NtPortSettings_v2_s
 
struct  NtConfigPort_v2_s
 
struct  NtConfigTimestampRead_s
 
struct  NtConfigTimestampRead_s::NtConfigTimestampReadData_s
 
struct  NtConfigTimestampWrite_s
 
struct  NtConfigTimestampWrite_s::NtConfigTimestampWriteData_s
 
struct  NtConfigTimesyncWrite_s
 
struct  NtConfigTimesyncWrite_s::NtConfigTimesyncWriteData_s
 
struct  NtConfigTimesyncReset_s
 
struct  NtConfigPtpImplData_s
 
struct  NtConfigPtpImpl_s
 
struct  NtConfigSensor_s
 
struct  NtConfigSensor_s::NtConfigSensorData_s
 
struct  NtConfigGlobalSyncWrite_s
 
struct  NtConfigGlobalSyncWrite_s::NtConfigWriteGlobalSyncData_s
 
struct  NtConfigBypassData_s
 
struct  NtConfigBypass_s
 
union  NtConfigBypass_s::NtConfigBypassParam_u
 
struct  NtConfigBypassWatchdogTimerData_s
 
struct  NtConfigBypassWatchdogTimer_s
 
union  NtConfigBypassWatchdogTimer_s::NtConfigBypassWatchdogTimerParam_u
 
struct  NtConfigBypassWatchdogTimeoutData_s
 
struct  NtConfigBypassWatchdogTimeout_s
 
union  NtConfigBypassWatchdogTimeout_s::NtConfigBypassWatchdogTimeoutParam_u
 
struct  NtConfigAdapterMonitor_s
 
struct  NtConfigTransmitOnTimestamp_s
 
struct  NtConfigTransmitOnTimestamp_s::NtConfigTransmitOnTimestampData_s
 
struct  NtNimRawData_s
 
struct  NtConfigNimAccess_s
 
union  NtConfigNimAccess_s::NtNimAccess_u
 
struct  NtConfigPtpPortData_s
 
struct  NtConfigPtpPort_s
 
struct  NtNtplParserErrorData_s
 
struct  NtNtplInfo_s
 
union  NtNtplInfo_s::NtplReturnData_u
 
struct  NtVpd_s
 
union  NtVpd_s::data_u
 
struct  NtStreamTable
 
struct  NtStreamTableEdit
 
struct  NtStreamTableDelete
 
struct  NtConfigStreamTable_s
 
struct  NtConfig_s
 
union  NtConfig_s::NtConfig_u
 

Macros

#define VPD_USER_SIZE   400
 
#define NT_STREAM_TABLE_ID_INVALID   (~0U)
 
#define NT_STREAM_TABLE_SIZE_MAX   1024
 

Typedefs

typedef struct NtConfigStream_s * NtConfigStream_t
 
typedef struct NtConfigPtpImplData_s NtConfigPtpImplData_t
 
typedef struct NtConfigBypassData_s NtConfigBypassData_t
 
typedef struct NtConfigBypassWatchdogTimerData_s NtConfigBypassWatchdogTimerData_t
 
typedef struct NtConfigBypassWatchdogTimeoutData_s NtConfigBypassWatchdogTimeoutData_t
 
typedef struct NtConfigNimAccess_sNtConfigNimAccess_p
 
typedef struct NtConfigPtpPortData_s NtConfigPtpPortData_t
 
typedef struct NtConfigPtpPort_s NtConfigPtpPort_t
 
typedef struct NtNtplInfo_s NtNtplInfo_t
 
typedef struct NtVpd_s NtVpd_t
 
typedef struct NtConfigStreamTable_s NtConfigStreamTable_t
 
typedef struct NtConfig_s NtConfig_t
 

Enumerations

enum  NtConfigParm_e {
  NT_CONFIG_PARM_UNKNOWN =0, NT_CONFIG_PARM_PORT_COMPAT_0 = 1, NT_CONFIG_PARM_ADAPTER_TIMESTAMP, NT_CONFIG_PARM_ADAPTER_TIMESYNC,
  NT_CONFIG_PARM_SENSOR, NT_CONFIG_PARM_RESERVED_0, NT_CONFIG_PARM_BYPASS_ADAPTER, NT_CONFIG_PARM_BYPASS_PORT,
  NT_CONFIG_PARM_BYPASS_ADAPTER_WATCHDOG_TIMEOUT, NT_CONFIG_PARM_BYPASS_PORT_WATCHDOG_TIMEOUT, NT_CONFIG_PARM_BYPASS_ADAPTER_WATCHDOG_TIMER, NT_CONFIG_PARM_BYPASS_PORT_WATCHDOG_TIMER,
  NT_CONFIG_PARM_ADAPTER_GLOBAL_SYNC, NT_CONFIG_PARM_NIM_ACCESS, NT_CONFIG_PARM_VPD, NT_CONFIG_PARM_PTP_PORT,
  NT_CONFIG_PARM_ADAPTER_TIMESYNC_RESET, NT_CONFIG_PARM_ADAPTER_PTP_IMPL_CFG, NT_CONFIG_PARM_PORT_COMPAT_1, NT_CONFIG_PARM_ADAPTER_MONITOR,
  NT_CONFIG_PARM_PORT_TRANSMIT_ON_TIMESTAMP, NT_CONFIG_PARM_PORT_SETTINGS_V2, NT_CONFIG_PARM_STREAM_TABLE
}
 
enum  NtTimeSyncReset_e {
  NT_TIMESYNC_RESET_INVALID = 0, NT_TIMESYNC_RESET_COMPAT_0, NT_TIMESYNC_RESET_PTP_PORT_STAT, NT_TIMESYNC_RESET_HARD_RESET_TIME_TO_REF,
  NT_TIMESYNC_RESET_TS_STATISTICS
}
 
enum  NtNimAccessType_e { NT_NIM_READ_DATA_LIN }
 
enum  NtNTPLCommands_e { NT_NTPL_PARSER_VALIDATE_NORMAL, NT_NTPL_PARSER_VALIDATE_PARSE_ONLY }
 
enum  NtNTPLReturnType_e { NT_NTPL_PARSER_NORMAL, NT_NTPL_PARSER_ERROR_DATA }
 
enum  NtVpdCommands_e { NT_VPD_USER_DATA }
 
enum  NtStreamTableCmd_e { NT_STREAM_TABLE_CREATE, NT_STREAM_TABLE_DELETE, NT_STREAM_TABLE_EDIT, NT_STREAM_TABLE_MAX }
 

Data Structure Documentation

struct NtPortSettingsManual_s

Array of manual port setting parameters

Definition at line 128 of file stream_config.h.

Data Fields

enum NtLinkSpeed_e speed
 The interface speed - this is in effect if autoNegotiation = NT_LINK_AUTONEG_MANUAL. More...
 
enum NtLinkDuplex_e duplex
 The duplex mode - this is in effect if autoNegotiation = NT_LINK_AUTONEG_MANUAL. More...
 

Field Documentation

enum NtLinkSpeed_e NtPortSettingsManual_s::speed

The interface speed - this is in effect if autoNegotiation = NT_LINK_AUTONEG_MANUAL.

Examples:
eventMonitor_example.c.

Definition at line 129 of file stream_config.h.

Referenced by DumpConfigChangeEvents().

enum NtLinkDuplex_e NtPortSettingsManual_s::duplex

The duplex mode - this is in effect if autoNegotiation = NT_LINK_AUTONEG_MANUAL.

Examples:
eventMonitor_example.c.

Definition at line 130 of file stream_config.h.

Referenced by DumpConfigChangeEvents().

struct NtPortSettingsAdvertise_s

Array of parameters to be advertised when autonegotiation is enabled

Definition at line 136 of file stream_config.h.

Data Fields

uint32_t halfDuplexMask
 Available half duplex (uses NtLinkSpeed_e as bitmask) More...
 
uint32_t fullDuplexMask
 Available full duplex (uses NtLinkSpeed_e as bitmask) More...
 

Field Documentation

uint32_t NtPortSettingsAdvertise_s::halfDuplexMask

Available half duplex (uses NtLinkSpeed_e as bitmask)

Examples:
eventMonitor_example.c.

Definition at line 137 of file stream_config.h.

Referenced by DumpConfigChangeEvents().

uint32_t NtPortSettingsAdvertise_s::fullDuplexMask

Available full duplex (uses NtLinkSpeed_e as bitmask)

Examples:
eventMonitor_example.c.

Definition at line 138 of file stream_config.h.

Referenced by DumpConfigChangeEvents().

struct NtPortSettings_v2_s

The settings reflect how the interface should be configured. The advertise section tells what should be advertised when autonegotiation is enabled. halfDuplexMask=0. fullDuplexMask=NT_LINK_SPEED_100M.

When a parameter does not apply on a particular adapter, then this parameter is ignored.

Definition at line 154 of file stream_config.h.

Data Fields

int enable
 0 = Disable interface, 1 = Enable interface. If disabled, the port will still be visible, but has status link down. More...
 
enum NtLinkMDI_e mdi
 MDI mode. More...
 
enum NtLinkAutoNeg_e autoNegotiation
 Link speed negotiation mode (manual or auto). More...
 
struct NtPortSettingsManual_s manual
 Array of manual port setting parameters. More...
 
struct NtPortSettingsAdvertise_s advertise
 Array of parameters to be advertised when autonegotiation is enabled. More...
 
uint32_t minIFG
 Depending on the IfgMode parameter in ntservice.ini the minimum interframe-gap is either interpreted as 10 ns steps or bytes. If IfgMode is set to NS the value will be rounded up or down to the nearest HW-supported value, which depends on the link speed. The default minimum gap is 0 ns. If the IfgMode is set to BYTE the value is written directly to the HW. More...
 
uint32_t maxIFG
 Depending on the IfgMode parameter in ntservice.ini the maximum interframe-gap is either interpreted as 10 ns steps or bytes. If the IfgMode is set to NS the value will be rounded up or down to the nearest HW-supported value, which depends on the link speed. The default maximum gap is the maximum HW-supported value. If the IfgMode is set to BYTE the value will be written directly to the HW. Setting the maximum interframe gap to 0, corresponds to disabling the check for maximum IFG. More...
 
enum NtTxPower_e TxPower
 TX power state on read and command on write. Controls laser power on/off on fiber SFP, XFP, SFP+ and QSFP+ modules. Note that not all modules support enable/disable of the laser. An error code is returned if not supported. More...
 
int hostLoopback
 
int lineLoopback
 
enum NtPortId_e PortId
 
int wisModeEnable
 0 = Wismode disabled on port, 1 = Enable Wismode enabled on port. More...
 
int txReplicatePort
 
uint64_t txPortRateLimit
 

Field Documentation

int NtPortSettings_v2_s::enable

0 = Disable interface, 1 = Enable interface. If disabled, the port will still be visible, but has status link down.

Examples:
eventMonitor_example.c.

Definition at line 155 of file stream_config.h.

Referenced by DumpConfigChangeEvents().

enum NtLinkMDI_e NtPortSettings_v2_s::mdi

MDI mode.

Examples:
eventMonitor_example.c.

Definition at line 160 of file stream_config.h.

Referenced by DumpConfigChangeEvents().

enum NtLinkAutoNeg_e NtPortSettings_v2_s::autoNegotiation

Link speed negotiation mode (manual or auto).

NOTE: Cannot be set on optical NIM interfaces

Examples:
eventMonitor_example.c.

Definition at line 164 of file stream_config.h.

Referenced by DumpConfigChangeEvents().

struct NtPortSettingsManual_s NtPortSettings_v2_s::manual

Array of manual port setting parameters.

NOTE: Cannot be set on optical NIM interfaces

Examples:
eventMonitor_example.c.

Definition at line 168 of file stream_config.h.

Referenced by DumpConfigChangeEvents().

struct NtPortSettingsAdvertise_s NtPortSettings_v2_s::advertise

Array of parameters to be advertised when autonegotiation is enabled.

NOTE: Cannot be set on optical NIM interfaces

Examples:
eventMonitor_example.c.

Definition at line 172 of file stream_config.h.

Referenced by DumpConfigChangeEvents().

uint32_t NtPortSettings_v2_s::minIFG

Depending on the IfgMode parameter in ntservice.ini the minimum interframe-gap is either interpreted as 10 ns steps or bytes. If IfgMode is set to NS the value will be rounded up or down to the nearest HW-supported value, which depends on the link speed. The default minimum gap is 0 ns. If the IfgMode is set to BYTE the value is written directly to the HW.

Examples:
eventMonitor_example.c.

Definition at line 174 of file stream_config.h.

Referenced by DumpConfigChangeEvents().

uint32_t NtPortSettings_v2_s::maxIFG

Depending on the IfgMode parameter in ntservice.ini the maximum interframe-gap is either interpreted as 10 ns steps or bytes. If the IfgMode is set to NS the value will be rounded up or down to the nearest HW-supported value, which depends on the link speed. The default maximum gap is the maximum HW-supported value. If the IfgMode is set to BYTE the value will be written directly to the HW. Setting the maximum interframe gap to 0, corresponds to disabling the check for maximum IFG.

Examples:
eventMonitor_example.c.

Definition at line 175 of file stream_config.h.

Referenced by DumpConfigChangeEvents().

enum NtTxPower_e NtPortSettings_v2_s::TxPower

TX power state on read and command on write. Controls laser power on/off on fiber SFP, XFP, SFP+ and QSFP+ modules. Note that not all modules support enable/disable of the laser. An error code is returned if not supported.

Examples:
eventMonitor_example.c.

Definition at line 177 of file stream_config.h.

Referenced by DumpConfigChangeEvents().

int NtPortSettings_v2_s::hostLoopback

Host loopback position.
Applying host loopback has the effect that data sent from the host is looped back to the host on the same port regardless of, if a NIM (Network Interface Module) has been plugged in, and if a physical loopback has been applied. The link will therefore be reported as up despite that no NIM is present or that no physical link is present.
In general simultaneous host and line loopback is not allowed.
The available loopback positions are adapter dependent and applying a loopback position that is not supported will result in a returned error code by the API function. In general only the following values NtHostLoopback_e should be used.
Applying loopback along with settings that require PHY setup changes or applying these settings when already in loopback mode represents a conflict and will not be carried out. A returned error code will indicate this. In order to avoid conflicts, it is in general recommended to enable loopback separately.
When applying loopback special settings are used and for trispeed modules this means that the link speed is changed to maximum. The original settings are restored when loopback is removed.

Examples:
eventMonitor_example.c.

Definition at line 178 of file stream_config.h.

Referenced by DumpConfigChangeEvents(), and setHostLoopback().

int NtPortSettings_v2_s::lineLoopback

Line loopback position.
Applying line loopback has the effect that data sent from the line is looped back to the line on the same port. This requires that a NIM (Network Interface Module) has been plugged in. The link will in general be reported as up and traffic can be received by the host but any traffic transmitted by the host will be replaced by the traffic looped back. In general simultaneous host and line loopback is NOT allowed.
The available loopback positions are adapter dependent and applying a loopback position that is not supported will result in a returned error code by the API function. In general only the following values NtLineLoopback_e should be used.
Applying loopback along with settings that require PHY setup changes or applying these settings when already in loopback mode represents a conflict and will not be carried out. A returned error code will indicate this. In order to avoid conflicts, it is in general recommended to enable loopback separately.
When applying loopback special settings are used and for trispeed modules this means that the link speed is changed to maximum. The original settings are restored when loopback is removed.

Examples:
eventMonitor_example.c.

Definition at line 197 of file stream_config.h.

Referenced by DumpConfigChangeEvents().

enum NtPortId_e NtPortSettings_v2_s::PortId

Port identification state. Turns the port identification feature on/off. An error code is returned if not supported. When enabled the port led will start to blink regardless if the link is up or the port receives data or not.

Definition at line 216 of file stream_config.h.

int NtPortSettings_v2_s::wisModeEnable

0 = Wismode disabled on port, 1 = Enable Wismode enabled on port.

Definition at line 221 of file stream_config.h.

int NtPortSettings_v2_s::txReplicatePort

Set TX port replication.
An error code is returned if not supported or the configuration is invalid. When set to a different port it will replicate all TX traffic from that port. It will not be possible to transmit on this port when replication is activated. It is not possible to change the replication configuration while TX traffic is active on this port or the port it is replicating from.

Definition at line 222 of file stream_config.h.

uint64_t NtPortSettings_v2_s::txPortRateLimit

Set Tx port rate limit in bits per second.
A value of zero disables the Tx port rate limit. The resulting ports speed will be an aproximated value close to the specified value. An error code is returned if not supported or the configuration is invalid. Special case: a value in the range of 1 to 100 specifies a limit as percentage of the link speed.

Examples:
net/transmit_multifunction/transmit_multifunction_example.c.

Definition at line 229 of file stream_config.h.

Referenced by _TxPortRateLimit().

struct NtConfigPort_v2_s

Definition at line 239 of file stream_config.h.

Data Fields

uint8_t portNo
 Port number to read from. More...
 
uint8_t Reserved1 [3]
 
struct NtPortSettings_v2_s data
 Port settings. More...
 

Field Documentation

uint8_t NtConfigPort_v2_s::portNo

Port number to read from.

Examples:
eventMonitor_example.c, and net/transmit_multifunction/transmit_multifunction_example.c.

Definition at line 240 of file stream_config.h.

Referenced by _TxPortRateLimit(), DumpConfigChangeEvents(), and setHostLoopback().

uint8_t NtConfigPort_v2_s::Reserved1[3]

Definition at line 241 of file stream_config.h.

struct NtPortSettings_v2_s NtConfigPort_v2_s::data

Port settings.

Examples:
eventMonitor_example.c, and net/transmit_multifunction/transmit_multifunction_example.c.

Definition at line 242 of file stream_config.h.

Referenced by _TxPortRateLimit(), DumpConfigChangeEvents(), and setHostLoopback().

struct NtConfigTimestampRead_s

Definition at line 248 of file stream_config.h.

Data Fields

uint8_t adapter
 Adapter number to read from. More...
 
uint8_t Reserved1 [3]
 
struct NtConfigTimestampRead_s::NtConfigTimestampReadData_s data
 

Field Documentation

uint8_t NtConfigTimestampRead_s::adapter

Adapter number to read from.

Examples:
config/config_example.c, net/replay4GA/replay4ga_example.c, net/replayGS/replayGS_example.c, net/transmit_on_timestamp/transmit_on_timestamp_example.c, and net/transmit_on_timestamp_setclock/transmit_on_timestamp_setclock_example.c.

Definition at line 249 of file stream_config.h.

Referenced by GetAdapterTimestamp(), and main().

uint8_t NtConfigTimestampRead_s::Reserved1[3]

Definition at line 250 of file stream_config.h.

struct NtConfigTimestampRead_s::NtConfigTimestampReadData_s

Definition at line 251 of file stream_config.h.

Data Fields

uint64_t ts
 The time stamp. More...
 
uint64_t nativeUnixTs
 Value converted to native Unix (read only) More...
 
enum NtTimestampType_e tsType
 The time stamp type used by the adapter. More...
 

Field Documentation

uint64_t NtConfigTimestampRead_s::NtConfigTimestampReadData_s::ts

The time stamp.

Examples:
config/config_example.c.

Definition at line 252 of file stream_config.h.

Referenced by main().

uint64_t NtConfigTimestampRead_s::NtConfigTimestampReadData_s::nativeUnixTs

Value converted to native Unix (read only)

Examples:
net/replay4GA/replay4ga_example.c, net/replayGS/replayGS_example.c, net/transmit_on_timestamp/transmit_on_timestamp_example.c, and net/transmit_on_timestamp_setclock/transmit_on_timestamp_setclock_example.c.

Definition at line 253 of file stream_config.h.

Referenced by GetAdapterTimestamp(), and main().

enum NtTimestampType_e NtConfigTimestampRead_s::NtConfigTimestampReadData_s::tsType

The time stamp type used by the adapter.

Examples:
config/config_example.c.

Definition at line 254 of file stream_config.h.

Referenced by main().

struct NtConfigTimestampWrite_s

Definition at line 261 of file stream_config.h.

Data Fields

uint8_t adapter
 Adapter number to write to. More...
 
uint8_t Reserved1 [3]
 
struct NtConfigTimestampWrite_s::NtConfigTimestampWriteData_s data
 

Field Documentation

uint8_t NtConfigTimestampWrite_s::adapter

Adapter number to write to.

Examples:
config/config_example.c, event/event_example.c, and eventMonitor_example.c.

Definition at line 262 of file stream_config.h.

Referenced by DumpConfigChangeEvents(), ForceAnEvent(), and main().

uint8_t NtConfigTimestampWrite_s::Reserved1[3]

Definition at line 263 of file stream_config.h.

struct NtConfigTimestampWrite_s::NtConfigTimestampWriteData_s NtConfigTimestampWrite_s::data
Examples:
config/config_example.c, event/event_example.c, and eventMonitor_example.c.

Referenced by DumpConfigChangeEvents(), ForceAnEvent(), and main().

struct NtConfigTimestampWrite_s::NtConfigTimestampWriteData_s

Definition at line 264 of file stream_config.h.

Data Fields

uint64_t ts
 The time stamp. More...
 
uint32_t bCurrent
 Uses current OS time. More...
 

Field Documentation

uint64_t NtConfigTimestampWrite_s::NtConfigTimestampWriteData_s::ts

The time stamp.

Examples:
config/config_example.c, event/event_example.c, and eventMonitor_example.c.

Definition at line 265 of file stream_config.h.

Referenced by DumpConfigChangeEvents(), ForceAnEvent(), and main().

uint32_t NtConfigTimestampWrite_s::NtConfigTimestampWriteData_s::bCurrent

Uses current OS time.

Examples:
config/config_example.c, event/event_example.c, and eventMonitor_example.c.

Definition at line 266 of file stream_config.h.

Referenced by DumpConfigChangeEvents(), ForceAnEvent(), and main().

struct NtConfigTimesyncWrite_s

Definition at line 273 of file stream_config.h.

Data Fields

uint8_t adapter
 Adapter number to write to. More...
 
uint8_t Reserved1 [3]
 
struct NtConfigTimesyncWrite_s::NtConfigTimesyncWriteData_s data
 

Field Documentation

uint8_t NtConfigTimesyncWrite_s::adapter

Adapter number to write to.

Examples:
eventMonitor_example.c, and pps/pps_example.c.

Definition at line 274 of file stream_config.h.

Referenced by DumpConfigChangeEvents(), and main().

uint8_t NtConfigTimesyncWrite_s::Reserved1[3]

Definition at line 275 of file stream_config.h.

struct NtConfigTimesyncWrite_s::NtConfigTimesyncWriteData_s NtConfigTimesyncWrite_s::data
Examples:
eventMonitor_example.c, and pps/pps_example.c.

Referenced by DumpConfigChangeEvents(), and main().

struct NtConfigTimesyncWrite_s::NtConfigTimesyncWriteData_s

Definition at line 276 of file stream_config.h.

Data Fields

uint32_t action
 0 = Reference time, 1 = Enable PPS, 2 = Disable PPS More...
 
uint64_t refTime
 PPS reference time. More...
 

Field Documentation

uint32_t NtConfigTimesyncWrite_s::NtConfigTimesyncWriteData_s::action

0 = Reference time, 1 = Enable PPS, 2 = Disable PPS

Examples:
eventMonitor_example.c, and pps/pps_example.c.

Definition at line 277 of file stream_config.h.

Referenced by DumpConfigChangeEvents(), and main().

uint64_t NtConfigTimesyncWrite_s::NtConfigTimesyncWriteData_s::refTime

PPS reference time.

Examples:
eventMonitor_example.c, and pps/pps_example.c.

Definition at line 278 of file stream_config.h.

Referenced by DumpConfigChangeEvents(), and main().

struct NtConfigTimesyncReset_s

Definition at line 298 of file stream_config.h.

Data Fields

uint8_t adapter
 Adapter number to write to. More...
 
uint8_t Reserved1 [3]
 
enum NtTimeSyncReset_e resetCmd
 Timesync reset command. More...
 

Field Documentation

uint8_t NtConfigTimesyncReset_s::adapter

Adapter number to write to.

Definition at line 299 of file stream_config.h.

uint8_t NtConfigTimesyncReset_s::Reserved1[3]

Definition at line 300 of file stream_config.h.

enum NtTimeSyncReset_e NtConfigTimesyncReset_s::resetCmd

Timesync reset command.

Definition at line 301 of file stream_config.h.

struct NtConfigPtpImplData_s

Definition at line 310 of file stream_config.h.

Data Fields

int32_t PTPDelayAsymmetry
 The PTP delay asymmetry compensation to set. More...
 

Field Documentation

int32_t NtConfigPtpImplData_s::PTPDelayAsymmetry

The PTP delay asymmetry compensation to set.

Definition at line 311 of file stream_config.h.

struct NtConfigPtpImpl_s

Definition at line 314 of file stream_config.h.

Data Fields

uint8_t adapter
 Adapter number to write to. More...
 
uint8_t Reserved1 [3]
 
NtConfigPtpImplData_t data
 

Field Documentation

uint8_t NtConfigPtpImpl_s::adapter

Adapter number to write to.

Definition at line 315 of file stream_config.h.

uint8_t NtConfigPtpImpl_s::Reserved1[3]

Definition at line 316 of file stream_config.h.

NtConfigPtpImplData_t NtConfigPtpImpl_s::data

Definition at line 317 of file stream_config.h.

struct NtConfigSensor_s

Definition at line 325 of file stream_config.h.

Data Fields

enum NtSensorSource_e source
 The source of the sensor - either a port or an 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 sensor group, see Sensors. More...
 
struct NtConfigSensor_s::NtConfigSensorData_s data
 

Field Documentation

enum NtSensorSource_e NtConfigSensor_s::source

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

Examples:
eventMonitor_example.c.

Definition at line 326 of file stream_config.h.

Referenced by DumpConfigChangeEvents().

uint32_t NtConfigSensor_s::sourceIndex

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

Examples:
eventMonitor_example.c.

Definition at line 327 of file stream_config.h.

Referenced by DumpConfigChangeEvents().

uint32_t NtConfigSensor_s::sensorIndex

The sensor index within the sensor group, see Sensors.

Examples:
eventMonitor_example.c.

Definition at line 328 of file stream_config.h.

Referenced by DumpConfigChangeEvents().

struct NtConfigSensor_s::NtConfigSensorData_s NtConfigSensor_s::data
Examples:
eventMonitor_example.c.

Referenced by DumpConfigChangeEvents().

struct NtConfigSensor_s::NtConfigSensorData_s

Definition at line 329 of file stream_config.h.

Data Fields

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

Field Documentation

int32_t NtConfigSensor_s::NtConfigSensorData_s::limitLow

The minimum sensor value before an alarm is triggered.

Examples:
eventMonitor_example.c.

Definition at line 330 of file stream_config.h.

Referenced by DumpConfigChangeEvents().

int32_t NtConfigSensor_s::NtConfigSensorData_s::limitHigh

The maximum sensor value before an alarm is triggered.

Examples:
eventMonitor_example.c.

Definition at line 331 of file stream_config.h.

Referenced by DumpConfigChangeEvents().

struct NtConfigGlobalSyncWrite_s

Definition at line 340 of file stream_config.h.

Data Fields

uint8_t adapterNo
 Adapter number to write to. More...
 
uint8_t Reserved1 [3]
 
struct NtConfigGlobalSyncWrite_s::NtConfigWriteGlobalSyncData_s data
 

Field Documentation

uint8_t NtConfigGlobalSyncWrite_s::adapterNo

Adapter number to write to.

Examples:
net/replayGS/replayGS_example.c.

Definition at line 341 of file stream_config.h.

Referenced by SetGlobalSync().

uint8_t NtConfigGlobalSyncWrite_s::Reserved1[3]

Definition at line 342 of file stream_config.h.

struct NtConfigGlobalSyncWrite_s::NtConfigWriteGlobalSyncData_s NtConfigGlobalSyncWrite_s::data
Examples:
net/replayGS/replayGS_example.c.

Referenced by SetGlobalSync().

struct NtConfigGlobalSyncWrite_s::NtConfigWriteGlobalSyncData_s

Definition at line 343 of file stream_config.h.

Data Fields

uint32_t portEnableMask
 Enable coordinated time synchronized transmit on port bit mask. More...
 
uint64_t timeSynchronizedTxOffset
 Time offset between time stamp in first frame and adapter time. More...
 
int timeSynchronizedTxOffsetUpdate
 Set to 1 to update the offset value. More...
 

Field Documentation

uint32_t NtConfigGlobalSyncWrite_s::NtConfigWriteGlobalSyncData_s::portEnableMask

Enable coordinated time synchronized transmit on port bit mask.

Examples:
net/replayGS/replayGS_example.c.

Definition at line 344 of file stream_config.h.

Referenced by SetGlobalSync().

uint64_t NtConfigGlobalSyncWrite_s::NtConfigWriteGlobalSyncData_s::timeSynchronizedTxOffset

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

Examples:
net/replayGS/replayGS_example.c.

Definition at line 345 of file stream_config.h.

Referenced by SetGlobalSync().

int NtConfigGlobalSyncWrite_s::NtConfigWriteGlobalSyncData_s::timeSynchronizedTxOffsetUpdate

Set to 1 to update the offset value.

Examples:
net/replayGS/replayGS_example.c.

Definition at line 346 of file stream_config.h.

Referenced by SetGlobalSync().

struct NtConfigBypassData_s

Definition at line 356 of file stream_config.h.

Data Fields

enum NtBypassTrigger_e bypassTriggerModes
 Bypass triggers that affect bypass states using NtBypassTrigger_e. More...
 
enum NtBypassPortState_e currentBypassPortState
 Current (live) bypass state using NtBypassPortState_e. More...
 
enum NtBypassPortState_e onInitBypassPortState
 onInit bypass state using NtBypassPortState_e More...
 
enum NtBypassPortState_e onPowerFailBypassPortState
 onPowerFail bypass state using NtBypassPortState_e More...
 
enum NtBypassPortState_e onWatchdogFailBypassPortState
 onWatchdogFail bypass state using NtBypassPortState_e More...
 
uint32_t onPowerFailBypassSwitchDelay
 onPowerFail bypass switch delay (msec) More...
 

Field Documentation

enum NtBypassTrigger_e NtConfigBypassData_s::bypassTriggerModes

Bypass triggers that affect bypass states using NtBypassTrigger_e.

Examples:
bypass/config/bypass_config_example.c.

Definition at line 357 of file stream_config.h.

Referenced by main().

enum NtBypassPortState_e NtConfigBypassData_s::currentBypassPortState

Current (live) bypass state using NtBypassPortState_e.

Examples:
bypass/config/bypass_config_example.c, and bypass/watchdog/bypass_watchdog_example.c.

Definition at line 358 of file stream_config.h.

Referenced by main().

enum NtBypassPortState_e NtConfigBypassData_s::onInitBypassPortState

onInit bypass state using NtBypassPortState_e

Examples:
bypass/config/bypass_config_example.c.

Definition at line 359 of file stream_config.h.

Referenced by main().

enum NtBypassPortState_e NtConfigBypassData_s::onPowerFailBypassPortState

onPowerFail bypass state using NtBypassPortState_e

Examples:
bypass/config/bypass_config_example.c.

Definition at line 360 of file stream_config.h.

Referenced by main().

enum NtBypassPortState_e NtConfigBypassData_s::onWatchdogFailBypassPortState

onWatchdogFail bypass state using NtBypassPortState_e

Examples:
bypass/config/bypass_config_example.c, and bypass/watchdog/bypass_watchdog_example.c.

Definition at line 361 of file stream_config.h.

Referenced by main().

uint32_t NtConfigBypassData_s::onPowerFailBypassSwitchDelay

onPowerFail bypass switch delay (msec)

Definition at line 362 of file stream_config.h.

struct NtConfigBypass_s

Definition at line 365 of file stream_config.h.

Data Fields

union NtConfigBypass_s::NtConfigBypassParam_u u
 
NtConfigBypassData_t data
 

Field Documentation

NtConfigBypassData_t NtConfigBypass_s::data
Examples:
bypass/config/bypass_config_example.c, and bypass/watchdog/bypass_watchdog_example.c.

Definition at line 371 of file stream_config.h.

Referenced by main().

union NtConfigBypass_s::NtConfigBypassParam_u

Definition at line 366 of file stream_config.h.

Data Fields

uint8_t adapterNo
 < Input key parameter union More...
 
uint8_t portNo
 port number to read from or write to More...
 
uint32_t Reserved
 

Field Documentation

uint8_t NtConfigBypass_s::NtConfigBypassParam_u::adapterNo

< Input key parameter union

Adapter number to read from or write to

Examples:
bypass/config/bypass_config_example.c, and bypass/watchdog/bypass_watchdog_example.c.

Definition at line 367 of file stream_config.h.

Referenced by main().

uint8_t NtConfigBypass_s::NtConfigBypassParam_u::portNo

port number to read from or write to

Examples:
bypass/config/bypass_config_example.c, and bypass/watchdog/bypass_watchdog_example.c.

Definition at line 368 of file stream_config.h.

Referenced by main().

uint32_t NtConfigBypass_s::NtConfigBypassParam_u::Reserved

Definition at line 369 of file stream_config.h.

struct NtConfigBypassWatchdogTimerData_s
Examples:
bypass/watchdog/bypass_watchdog_example.c.

Definition at line 381 of file stream_config.h.

Data Fields

uint32_t bypassWatchdogTimeout
 Bypass watchdog timeout in msec. More...
 
uint32_t bypassWatchdogTimeRemaining
 Bypass watchdog remaining time before timeout (msec) More...
 

Field Documentation

uint32_t NtConfigBypassWatchdogTimerData_s::bypassWatchdogTimeout

Bypass watchdog timeout in msec.

Examples:
bypass/watchdog/bypass_watchdog_example.c.

Definition at line 383 of file stream_config.h.

Referenced by main().

uint32_t NtConfigBypassWatchdogTimerData_s::bypassWatchdogTimeRemaining

Bypass watchdog remaining time before timeout (msec)

Examples:
bypass/watchdog/bypass_watchdog_example.c.

Definition at line 384 of file stream_config.h.

Referenced by main().

struct NtConfigBypassWatchdogTimer_s

Definition at line 387 of file stream_config.h.

Data Fields

union NtConfigBypassWatchdogTimer_s::NtConfigBypassWatchdogTimerParam_u u
 
NtConfigBypassWatchdogTimerData_t data
 

Field Documentation

Examples:
bypass/watchdog/bypass_watchdog_example.c.

Referenced by main().

NtConfigBypassWatchdogTimerData_t NtConfigBypassWatchdogTimer_s::data
Examples:
bypass/watchdog/bypass_watchdog_example.c.

Definition at line 393 of file stream_config.h.

Referenced by main().

union NtConfigBypassWatchdogTimer_s::NtConfigBypassWatchdogTimerParam_u

Definition at line 388 of file stream_config.h.

Data Fields

uint8_t adapterNo
 < Input key parameter union More...
 
uint8_t portNo
 port number to read from or write to More...
 
uint32_t Reserved
 

Field Documentation

uint8_t NtConfigBypassWatchdogTimer_s::NtConfigBypassWatchdogTimerParam_u::adapterNo

< Input key parameter union

Adapter number to read from or write to

Examples:
bypass/watchdog/bypass_watchdog_example.c.

Definition at line 389 of file stream_config.h.

Referenced by main().

uint8_t NtConfigBypassWatchdogTimer_s::NtConfigBypassWatchdogTimerParam_u::portNo

port number to read from or write to

Examples:
bypass/watchdog/bypass_watchdog_example.c.

Definition at line 390 of file stream_config.h.

Referenced by main().

uint32_t NtConfigBypassWatchdogTimer_s::NtConfigBypassWatchdogTimerParam_u::Reserved

Definition at line 391 of file stream_config.h.

struct NtConfigBypassWatchdogTimeoutData_s

Definition at line 402 of file stream_config.h.

Data Fields

uint32_t bypassWatchdogTimeout
 Bypass watchdog timeout (msec) More...
 

Field Documentation

uint32_t NtConfigBypassWatchdogTimeoutData_s::bypassWatchdogTimeout

Bypass watchdog timeout (msec)

Examples:
bypass/watchdog/bypass_watchdog_example.c.

Definition at line 403 of file stream_config.h.

Referenced by main().

struct NtConfigBypassWatchdogTimeout_s

Definition at line 406 of file stream_config.h.

Data Fields

union NtConfigBypassWatchdogTimeout_s::NtConfigBypassWatchdogTimeoutParam_u u
 
NtConfigBypassWatchdogTimeoutData_t data
 

Field Documentation

Examples:
bypass/watchdog/bypass_watchdog_example.c.

Referenced by main().

NtConfigBypassWatchdogTimeoutData_t NtConfigBypassWatchdogTimeout_s::data
Examples:
bypass/watchdog/bypass_watchdog_example.c.

Definition at line 412 of file stream_config.h.

Referenced by main().

union NtConfigBypassWatchdogTimeout_s::NtConfigBypassWatchdogTimeoutParam_u

Definition at line 407 of file stream_config.h.

Data Fields

uint8_t adapterNo
 < Input key parameter union More...
 
uint8_t portNo
 port number to read from or write to More...
 
uint32_t Reserved
 

Field Documentation

uint8_t NtConfigBypassWatchdogTimeout_s::NtConfigBypassWatchdogTimeoutParam_u::adapterNo

< Input key parameter union

Adapter number to read from or write to

Examples:
bypass/watchdog/bypass_watchdog_example.c.

Definition at line 408 of file stream_config.h.

Referenced by main().

uint8_t NtConfigBypassWatchdogTimeout_s::NtConfigBypassWatchdogTimeoutParam_u::portNo

port number to read from or write to

Examples:
bypass/watchdog/bypass_watchdog_example.c.

Definition at line 409 of file stream_config.h.

Referenced by main().

uint32_t NtConfigBypassWatchdogTimeout_s::NtConfigBypassWatchdogTimeoutParam_u::Reserved

Definition at line 410 of file stream_config.h.

struct NtConfigAdapterMonitor_s

Definition at line 415 of file stream_config.h.

Data Fields

uint8_t adapter
 Adapter number to write to. More...
 
unsigned portCtrlInterval
 Number of milliseconds between each scan. More...
 
bool run
 Indicate if the thread should run. More...
 

Field Documentation

uint8_t NtConfigAdapterMonitor_s::adapter

Adapter number to write to.

Definition at line 416 of file stream_config.h.

unsigned NtConfigAdapterMonitor_s::portCtrlInterval

Number of milliseconds between each scan.

Definition at line 417 of file stream_config.h.

bool NtConfigAdapterMonitor_s::run

Indicate if the thread should run.

Definition at line 418 of file stream_config.h.

struct NtConfigTransmitOnTimestamp_s

Definition at line 427 of file stream_config.h.

Data Fields

uint8_t portNo
 Port to configure transmit on timestamp for. More...
 
uint8_t Reserved [3]
 
struct NtConfigTransmitOnTimestamp_s::NtConfigTransmitOnTimestampData_s data
 

Field Documentation

uint8_t NtConfigTransmitOnTimestamp_s::portNo

Port to configure transmit on timestamp for.

Examples:
net/replay4GA/replay4ga_example.c, net/transmit_on_timestamp/transmit_on_timestamp_example.c, and net/transmit_on_timestamp_setclock/transmit_on_timestamp_setclock_example.c.

Definition at line 428 of file stream_config.h.

Referenced by main().

uint8_t NtConfigTransmitOnTimestamp_s::Reserved[3]

Definition at line 429 of file stream_config.h.

struct NtConfigTransmitOnTimestamp_s::NtConfigTransmitOnTimestampData_s

Definition at line 430 of file stream_config.h.

Data Fields

uint64_t timeDelta
 Delta in nanoseconds to add to packet time before comparing to adapter time. More...
 
bool enable
 Enable transmit on timestamp. More...
 
bool forceTxOnTs
 Force transmit on timestamp. More...
 
uint64_t timeDeltaAdjust
 Delta in nanoseconds added by adapter to timeDelta whenever a TXSETCLOCK packet is encountered. More...
 

Field Documentation

uint64_t NtConfigTransmitOnTimestamp_s::NtConfigTransmitOnTimestampData_s::timeDelta

Delta in nanoseconds to add to packet time before comparing to adapter time.

Examples:
net/replay4GA/replay4ga_example.c, net/transmit_on_timestamp/transmit_on_timestamp_example.c, and net/transmit_on_timestamp_setclock/transmit_on_timestamp_setclock_example.c.

Definition at line 431 of file stream_config.h.

Referenced by main().

bool NtConfigTransmitOnTimestamp_s::NtConfigTransmitOnTimestampData_s::enable

Enable transmit on timestamp.

Examples:
net/replay4GA/replay4ga_example.c, net/transmit_on_timestamp/transmit_on_timestamp_example.c, and net/transmit_on_timestamp_setclock/transmit_on_timestamp_setclock_example.c.

Definition at line 432 of file stream_config.h.

Referenced by main().

bool NtConfigTransmitOnTimestamp_s::NtConfigTransmitOnTimestampData_s::forceTxOnTs

Force transmit on timestamp.

Examples:
net/replay4GA/replay4ga_example.c, net/transmit_on_timestamp/transmit_on_timestamp_example.c, and net/transmit_on_timestamp_setclock/transmit_on_timestamp_setclock_example.c.

Definition at line 433 of file stream_config.h.

Referenced by main().

uint64_t NtConfigTransmitOnTimestamp_s::NtConfigTransmitOnTimestampData_s::timeDeltaAdjust

Delta in nanoseconds added by adapter to timeDelta whenever a TXSETCLOCK packet is encountered.

Examples:
net/transmit_on_timestamp/transmit_on_timestamp_example.c, and net/transmit_on_timestamp_setclock/transmit_on_timestamp_setclock_example.c.

Definition at line 434 of file stream_config.h.

Referenced by main().

struct NtNimRawData_s

Definition at line 447 of file stream_config.h.

Data Fields

uint16_t linAddr
 
uint16_t length
 
uint8_t data [512]
 

Field Documentation

uint16_t NtNimRawData_s::linAddr

Definition at line 448 of file stream_config.h.

uint16_t NtNimRawData_s::length

Definition at line 449 of file stream_config.h.

uint8_t NtNimRawData_s::data[512]

Definition at line 450 of file stream_config.h.

struct NtConfigNimAccess_s

Definition at line 453 of file stream_config.h.

Data Fields

enum NtNimAccessType_e accessType
 
uint8_t portNo
 
uint8_t Reserved1 [3]
 
union NtConfigNimAccess_s::NtNimAccess_u u
 

Field Documentation

enum NtNimAccessType_e NtConfigNimAccess_s::accessType

Definition at line 454 of file stream_config.h.

uint8_t NtConfigNimAccess_s::portNo

Definition at line 455 of file stream_config.h.

uint8_t NtConfigNimAccess_s::Reserved1[3]

Definition at line 456 of file stream_config.h.

union NtConfigNimAccess_s::NtNimAccess_u NtConfigNimAccess_s::u
union NtConfigNimAccess_s::NtNimAccess_u

Definition at line 458 of file stream_config.h.

Data Fields

struct NtNimRawData_s rawData
 

Field Documentation

struct NtNimRawData_s NtConfigNimAccess_s::NtNimAccess_u::rawData

Definition at line 459 of file stream_config.h.

struct NtConfigPtpPortData_s

Definition at line 466 of file stream_config.h.

Data Fields

int enable
 PTP active flag. More...
 
int port_enable
 PTP port enable flag. More...
 
enum NtLinkAutoNeg_e autoNegotiation
 Manual or auto negotiation of link speed and duplex mode. More...
 
struct NtPortSettingsManual_s manual
 Bit mask of manual port setting parameters. More...
 
struct NtPortSettingsAdvertise_s advertise
 The speeds to advertise during auto negotiation. More...
 

Field Documentation

int NtConfigPtpPortData_s::enable

PTP active flag.

On read: 0 = PTP is not active, 1 = PTP is active. On Write: Value is ignored.

Definition at line 471 of file stream_config.h.

int NtConfigPtpPortData_s::port_enable

PTP port enable flag.

On read: 0 = PTP port is not enabled, 1 = PTP port is enabled. On Write: 0 = disable PTP port, 1 = enable PTP port.

  A PTP port must be enabled to achieve link up.  

Definition at line 478 of file stream_config.h.

enum NtLinkAutoNeg_e NtConfigPtpPortData_s::autoNegotiation

Manual or auto negotiation of link speed and duplex mode.

This field specifies whether link speed and duplex mode of the PTP port is set manually or auto negotiated.

Definition at line 483 of file stream_config.h.

struct NtPortSettingsManual_s NtConfigPtpPortData_s::manual

Bit mask of manual port setting parameters.

This field specifies the manually configured link speed and duplex mode of the PTP port. These values are ignored when auto negotiation is enabled.

Definition at line 489 of file stream_config.h.

struct NtPortSettingsAdvertise_s NtConfigPtpPortData_s::advertise

The speeds to advertise during auto negotiation.

This field is a bit mask of the speeds that are advertised during auto negotiation. These values are ignored when auto negotiation is disabled.

Definition at line 495 of file stream_config.h.

struct NtConfigPtpPort_s

Definition at line 503 of file stream_config.h.

Data Fields

uint8_t adapterNo
 Number of adapter with PTP functionality. More...
 
uint8_t portNo
 PTP port number. More...
 
uint8_t reserved [2]
 Reserved for future use. More...
 
NtConfigPtpPortData_t data
 

Field Documentation

uint8_t NtConfigPtpPort_s::adapterNo

Number of adapter with PTP functionality.

Definition at line 504 of file stream_config.h.

uint8_t NtConfigPtpPort_s::portNo

PTP port number.

On Read: Always 0 (zero), currently. On Write: Must be 0 (zero), currently.

Definition at line 509 of file stream_config.h.

uint8_t NtConfigPtpPort_s::reserved[2]

Reserved for future use.

Definition at line 510 of file stream_config.h.

NtConfigPtpPortData_t NtConfigPtpPort_s::data

Definition at line 511 of file stream_config.h.

struct NtNtplParserErrorData_s

NTPL parser error description and error code

Definition at line 530 of file stream_config.h.

Data Fields

char errBuffer [3][NT_MAX_NTPL_BUFFER_SIZE]
 NTPL error description. More...
 
int32_t errCode
 NTPL error code. More...
 

Field Documentation

struct NtNtplInfo_s

Data Fields

enum NtNTPLReturnType_e eType
 Returned status. More...
 
uint32_t ntplId
 ID of the NTPL command. More...
 
int streamId
 The selected stream ID. More...
 
uint64_t ts
 Time when the NTPL command is in effect. More...
 
enum NtTimestampType_e timestampType
 The time stamp type of NtNtplInfo_t::ts. More...
 
union NtNtplInfo_s::NtplReturnData_u u
 

Field Documentation

enum NtNTPLReturnType_e NtNtplInfo_s::eType

Returned status.

Definition at line 568 of file stream_config.h.

uint32_t NtNtplInfo_s::ntplId
int NtNtplInfo_s::streamId

The selected stream ID.

Definition at line 570 of file stream_config.h.

uint64_t NtNtplInfo_s::ts
enum NtTimestampType_e NtNtplInfo_s::timestampType

The time stamp type of NtNtplInfo_t::ts.

Definition at line 572 of file stream_config.h.

union NtNtplInfo_s::NtplReturnData_u

NTPL return data. Error or filter information.

Definition at line 580 of file stream_config.h.

Data Fields

struct NtNtplParserErrorData_s errorData
 Error code and error text. More...
 

Field Documentation

struct NtVpd_s

Definition at line 608 of file stream_config.h.

Data Fields

uint8_t adapterNo
 Adapter number to write to. More...
 
uint16_t length
 Length of data. More...
 
enum NtVpdCommands_e vpdCommand
 VPD command using command NtVpdCommands_e. More...
 
union NtVpd_s::data_u u
 

Field Documentation

uint8_t NtVpd_s::adapterNo

Adapter number to write to.

Definition at line 609 of file stream_config.h.

uint16_t NtVpd_s::length

Length of data.

Definition at line 610 of file stream_config.h.

enum NtVpdCommands_e NtVpd_s::vpdCommand

VPD command using command NtVpdCommands_e.

Definition at line 611 of file stream_config.h.

union NtVpd_s::data_u NtVpd_s::u
union NtVpd_s::data_u

Definition at line 612 of file stream_config.h.

Data Fields

uint8_t userData [VPD_USER_SIZE]
 Userdata section of VPD. More...
 

Field Documentation

uint8_t NtVpd_s::data_u::userData[VPD_USER_SIZE]

Userdata section of VPD.

Definition at line 613 of file stream_config.h.

struct NtStreamTable

NtStreamTable - used when creating and querying stream tables

Definition at line 641 of file stream_config.h.

Data Fields

uint32_t id
 
char tag [40]
 NTPL tag (See Delete command) More...
 
uint16_t tableSize
 Number of entries in the table. More...
 
int16_t table [NT_STREAM_TABLE_SIZE_MAX]
 Table entries. If < 0 the table entry is disabled. More...
 

Field Documentation

uint32_t NtStreamTable::id

Unique stream table identifier.

When creating a new table the allocated ID is returned in this member. When querying a table the application must set the ID of the table to be queried.

Definition at line 648 of file stream_config.h.

char NtStreamTable::tag[40]

NTPL tag (See Delete command)

Definition at line 649 of file stream_config.h.

uint16_t NtStreamTable::tableSize

Number of entries in the table.

Definition at line 650 of file stream_config.h.

int16_t NtStreamTable::table[NT_STREAM_TABLE_SIZE_MAX]

Table entries. If < 0 the table entry is disabled.

Definition at line 651 of file stream_config.h.

struct NtStreamTableEdit

NtStreamTableEdit - used for editing a previously created table

Definition at line 657 of file stream_config.h.

Data Fields

uint32_t id
 Identifier selecting which table to edit. More...
 
uint16_t tableSize
 Number of entries in table. More...
 
uint64_t editMask [(NT_STREAM_TABLE_SIZE_MAX+63)/64]
 Bitmask indicating which entries to edit. More...
 
int16_t table [NT_STREAM_TABLE_SIZE_MAX]
 Table entries. More...
 

Field Documentation

uint32_t NtStreamTableEdit::id

Identifier selecting which table to edit.

Definition at line 658 of file stream_config.h.

uint16_t NtStreamTableEdit::tableSize

Number of entries in table.

Definition at line 659 of file stream_config.h.

uint64_t NtStreamTableEdit::editMask[(NT_STREAM_TABLE_SIZE_MAX+63)/64]

Bitmask indicating which entries to edit.

Definition at line 660 of file stream_config.h.

int16_t NtStreamTableEdit::table[NT_STREAM_TABLE_SIZE_MAX]

Table entries.

Definition at line 661 of file stream_config.h.

struct NtStreamTableDelete

NtStreamTableDelete - used when deleting a table

Definition at line 667 of file stream_config.h.

Data Fields

uint32_t id
 Identifier selecting which table to delete. More...
 

Field Documentation

uint32_t NtStreamTableDelete::id

Identifier selecting which table to delete.

Definition at line 668 of file stream_config.h.

struct NtConfigStreamTable_s

Stream table command message structure.

This message structure enables the creation, deletion and manipulation of stream tables. A stream table consists an array of StreamIds that are indexed by bits in the packet hash to select the stream a packet should be sent to. Each stream table is identified by a 32-bit number which can be used in the NTPL Assign Command. Stream tables can be manipulated on the fly to suit an applications dynamic needs.

Definition at line 682 of file stream_config.h.

Data Fields

enum NtStreamTableCmd_e cmd
 
union {
   struct NtStreamTable   table
 
   struct NtStreamTableEdit   edit
 
   struct NtStreamTableDelete   del
 
u
 

Field Documentation

enum NtStreamTableCmd_e NtConfigStreamTable_s::cmd

Definition at line 683 of file stream_config.h.

struct NtStreamTable NtConfigStreamTable_s::table

Definition at line 685 of file stream_config.h.

struct NtStreamTableEdit NtConfigStreamTable_s::edit

Definition at line 686 of file stream_config.h.

struct NtStreamTableDelete NtConfigStreamTable_s::del

Definition at line 687 of file stream_config.h.

union { ... } NtConfigStreamTable_s::u
struct NtConfig_s

Data Fields

enum NtConfigParm_e parm
 Configuration parameter. More...
 
union NtConfig_s::NtConfig_u u
 

Field Documentation

union NtConfig_s::NtConfig_u

Definition at line 708 of file stream_config.h.

Data Fields

struct NtConfigPort_v2_s portSettings_v2
 Port setting struct is used when reading or writing using command NT_CONFIG_PARM_PORT_SETTINGS_V2. More...
 
struct NtConfigTimestampRead_s timestampRead
 Time stamp read struct is used when reading using command NT_CONFIG_PARM_ADAPTER_TIMESTAMP. More...
 
struct NtConfigTimestampWrite_s timestampWrite
 Time stamp write struct is used when writing using command NT_CONFIG_PARM_ADAPTER_TIMESTAMP. More...
 
struct NtConfigTimesyncWrite_s timesyncWrite
 Time sync write struct is used when writing using command NT_CONFIG_PARM_ADAPTER_TIMESYNC. More...
 
struct NtConfigSensor_s sensor
 Sensor read and write struct is used to read or write sensor alarm limits using command NT_CONFIG_PARM_SENSOR. More...
 
struct NtConfigGlobalSyncWrite_s globalSyncWrite
 Stream write struct is used when writing using command NT_CONFIG_PARM_ADAPTER_GLOBAL_SYNC. More...
 
struct NtConfigBypass_s bypassConfig
 Bypass adapter and port setting struct is used when reading or writing using commands NT_CONFIG_PARM_BYPASS_PORT NT_CONFIG_PARM_BYPASS_ADAPTER. More...
 
struct NtConfigBypassWatchdogTimer_s bypassWatchdogTimer
 Bypass watchdog reading or writing using commands NT_CONFIG_PARM_BYPASS_PORT_WATCHDOG_TIMER NT_CONFIG_PARM_BYPASS_ADAPTER_WATCHDOG_TIMER. More...
 
struct NtConfigBypassWatchdogTimeout_s bypassWatchdogTimeout
 Bypass watchdog reading or writing using commands NT_CONFIG_PARM_BYPASS_PORT_WATCHDOG_TIMEOUT NT_CONFIG_PARM_BYPASS_ADAPTER_WATCHDOG_TIMEOUT. More...
 
struct NtConfigNimAccess_s nimAccess
 NIM data access using command NT_CONFIG_PARM_NIM_ACCESS. More...
 
struct NtVpd_s vpdData
 VPD write structure NT_CONFIG_PARM_VPD. More...
 
struct NtConfigPtpPort_s ptpPort
 PTP port configuation NT_CONFIG_PARM_PTP_PORT. More...
 
struct NtConfigTimesyncReset_s timesyncReset
 Time sync hard reset time command. More...
 
struct NtConfigPtpImpl_s ptpImplCfg
 PTP configuration settings. More...
 
struct NtConfigAdapterMonitor_s adapterMonitorSettings
 Adapter Monitor settings. More...
 
struct NtConfigTransmitOnTimestamp_s transmitOnTimestamp
 Port transmit on timestamp settings. More...
 
struct NtConfigStreamTable_s streamTable
 Stream table configuration. More...
 

Field Documentation

struct NtConfigPort_v2_s NtConfig_s::NtConfig_u::portSettings_v2

Port setting struct is used when reading or writing using command NT_CONFIG_PARM_PORT_SETTINGS_V2.

Examples:
eventMonitor_example.c, and net/transmit_multifunction/transmit_multifunction_example.c.

Definition at line 709 of file stream_config.h.

Referenced by _TxPortRateLimit(), DumpConfigChangeEvents(), and setHostLoopback().

struct NtConfigTimestampRead_s NtConfig_s::NtConfig_u::timestampRead

Time stamp read struct is used when reading using command NT_CONFIG_PARM_ADAPTER_TIMESTAMP.

Examples:
config/config_example.c, net/replay4GA/replay4ga_example.c, net/replayGS/replayGS_example.c, net/transmit_on_timestamp/transmit_on_timestamp_example.c, and net/transmit_on_timestamp_setclock/transmit_on_timestamp_setclock_example.c.

Definition at line 713 of file stream_config.h.

Referenced by GetAdapterTimestamp(), and main().

struct NtConfigTimestampWrite_s NtConfig_s::NtConfig_u::timestampWrite

Time stamp write struct is used when writing using command NT_CONFIG_PARM_ADAPTER_TIMESTAMP.

Examples:
config/config_example.c, event/event_example.c, and eventMonitor_example.c.

Definition at line 714 of file stream_config.h.

Referenced by DumpConfigChangeEvents(), ForceAnEvent(), and main().

struct NtConfigTimesyncWrite_s NtConfig_s::NtConfig_u::timesyncWrite

Time sync write struct is used when writing using command NT_CONFIG_PARM_ADAPTER_TIMESYNC.

Examples:
eventMonitor_example.c, and pps/pps_example.c.

Definition at line 715 of file stream_config.h.

Referenced by DumpConfigChangeEvents(), and main().

struct NtConfigSensor_s NtConfig_s::NtConfig_u::sensor

Sensor read and write struct is used to read or write sensor alarm limits using command NT_CONFIG_PARM_SENSOR.

Examples:
eventMonitor_example.c.

Definition at line 716 of file stream_config.h.

Referenced by DumpConfigChangeEvents().

struct NtConfigGlobalSyncWrite_s NtConfig_s::NtConfig_u::globalSyncWrite

Stream write struct is used when writing using command NT_CONFIG_PARM_ADAPTER_GLOBAL_SYNC.

Examples:
net/replayGS/replayGS_example.c.

Definition at line 717 of file stream_config.h.

Referenced by SetGlobalSync().

struct NtConfigBypass_s NtConfig_s::NtConfig_u::bypassConfig

Bypass adapter and port setting struct is used when reading or writing using commands NT_CONFIG_PARM_BYPASS_PORT NT_CONFIG_PARM_BYPASS_ADAPTER.

Examples:
bypass/config/bypass_config_example.c, and bypass/watchdog/bypass_watchdog_example.c.

Definition at line 718 of file stream_config.h.

Referenced by main().

struct NtConfigBypassWatchdogTimer_s NtConfig_s::NtConfig_u::bypassWatchdogTimer

Bypass watchdog reading or writing using commands NT_CONFIG_PARM_BYPASS_PORT_WATCHDOG_TIMER NT_CONFIG_PARM_BYPASS_ADAPTER_WATCHDOG_TIMER.

Examples:
bypass/watchdog/bypass_watchdog_example.c.

Definition at line 719 of file stream_config.h.

Referenced by main().

struct NtConfigBypassWatchdogTimeout_s NtConfig_s::NtConfig_u::bypassWatchdogTimeout

Bypass watchdog reading or writing using commands NT_CONFIG_PARM_BYPASS_PORT_WATCHDOG_TIMEOUT NT_CONFIG_PARM_BYPASS_ADAPTER_WATCHDOG_TIMEOUT.

Examples:
bypass/watchdog/bypass_watchdog_example.c.

Definition at line 720 of file stream_config.h.

Referenced by main().

struct NtConfigNimAccess_s NtConfig_s::NtConfig_u::nimAccess

NIM data access using command NT_CONFIG_PARM_NIM_ACCESS.

Definition at line 721 of file stream_config.h.

struct NtVpd_s NtConfig_s::NtConfig_u::vpdData

VPD write structure NT_CONFIG_PARM_VPD.

Definition at line 725 of file stream_config.h.

struct NtConfigPtpPort_s NtConfig_s::NtConfig_u::ptpPort

PTP port configuation NT_CONFIG_PARM_PTP_PORT.

Definition at line 726 of file stream_config.h.

struct NtConfigTimesyncReset_s NtConfig_s::NtConfig_u::timesyncReset

Time sync hard reset time command.

Definition at line 727 of file stream_config.h.

struct NtConfigPtpImpl_s NtConfig_s::NtConfig_u::ptpImplCfg

PTP configuration settings.

Definition at line 728 of file stream_config.h.

struct NtConfigAdapterMonitor_s NtConfig_s::NtConfig_u::adapterMonitorSettings

Adapter Monitor settings.

Definition at line 732 of file stream_config.h.

struct NtConfigTransmitOnTimestamp_s NtConfig_s::NtConfig_u::transmitOnTimestamp

Port transmit on timestamp settings.

Examples:
net/replay4GA/replay4ga_example.c, net/transmit_on_timestamp/transmit_on_timestamp_example.c, and net/transmit_on_timestamp_setclock/transmit_on_timestamp_setclock_example.c.

Definition at line 733 of file stream_config.h.

Referenced by main().

struct NtConfigStreamTable_s NtConfig_s::NtConfig_u::streamTable

Stream table configuration.

Definition at line 736 of file stream_config.h.

Function Documentation

int NT_ConfigOpen ( NtConfigStream_t hStream,
const char *  name 
)

Opens a configuration stream.

This function is called to retrieve a handle to a configuration stream

Parameters
[out]hStreamReference to an NtConfigStream_t stream pointer
[in]nameStream friendly name - used in, for example, logging statements
Return values
0Success
!=0Error
Examples:
bypass/config/bypass_config_example.c, bypass/watchdog/bypass_watchdog_example.c, config/config_example.c, event/event_example.c, net/analysis/analysis_example.c, net/capture/capture_example.c, net/inline/inline_example.c, net/ipfdemo/ipfdemo_example.c, net/netflow/netflow_example.c, net/numa/numa_example.c, net/replay4GA/replay4ga_example.c, net/replayGS/replayGS_example.c, net/streamidstatistics/streamidstatistics_example.c, net/timestamp_inject/timestamp_inject_example.cpp, net/transmit_multifunction/transmit_multifunction_example.c, net/transmit_on_timestamp/transmit_on_timestamp_example.c, net/transmit_on_timestamp_setclock/transmit_on_timestamp_setclock_example.c, net/vlandemo/vlandemo_example.c, and pps/pps_example.c.

Referenced by _TxPortRateLimit(), applyNtpl(), assignNtplFilters(), ForceAnEvent(), GetAdapterTimestamp(), main(), SetGlobalSync(), and setHostLoopback().

int NT_ConfigClose ( NtConfigStream_t  hStream)

Closes a configuration stream.

This function is called to close a configuration stream

Parameters
[in]hStreamReference to a NtConfigStream_t stream pointer
Return values
0Success
!=0Error
Examples:
config/config_example.c, event/event_example.c, net/analysis/analysis_example.c, net/capture/capture_example.c, net/inline/inline_example.c, net/ipfdemo/ipfdemo_example.c, net/netflow/netflow_example.c, net/numa/numa_example.c, net/replay4GA/replay4ga_example.c, net/replayGS/replayGS_example.c, net/streamidstatistics/streamidstatistics_example.c, net/timestamp_inject/timestamp_inject_example.cpp, net/transmit_multifunction/transmit_multifunction_example.c, net/vlandemo/vlandemo_example.c, and pps/pps_example.c.

Referenced by _TxPortRateLimit(), applyNtpl(), assignNtplFilters(), ForceAnEvent(), GetAdapterTimestamp(), main(), SetGlobalSync(), and setHostLoopback().

int NT_ConfigRead ( NtConfigStream_t  hStream,
NtConfig_t data 
)

Reads data from a configuration stream.

Returns configuration data

Parameters
[in]hStreamNtSystemStream_t handle
[in,out]dataNtConfig_t structure containing configuration query and serving as output buffer for data
Return values
0Success
!=0Error
Examples:
bypass/config/bypass_config_example.c, bypass/watchdog/bypass_watchdog_example.c, config/config_example.c, net/replay4GA/replay4ga_example.c, net/replayGS/replayGS_example.c, net/transmit_multifunction/transmit_multifunction_example.c, net/transmit_on_timestamp/transmit_on_timestamp_example.c, and net/transmit_on_timestamp_setclock/transmit_on_timestamp_setclock_example.c.

Referenced by _TxPortRateLimit(), GetAdapterTimestamp(), main(), and setHostLoopback().

int NT_ConfigWrite ( NtConfigStream_t  hStream,
NtConfig_t data 
)

Writes data to a configuration stream.

Writes configuration data

Parameters
[in]hStreamNtSystemStream_t handle
[in,out]dataNtConfig_t structure containing the configuration to write
Return values
0Success
!=0Error
Examples:
bypass/config/bypass_config_example.c, bypass/watchdog/bypass_watchdog_example.c, config/config_example.c, event/event_example.c, net/replay4GA/replay4ga_example.c, net/replayGS/replayGS_example.c, net/transmit_multifunction/transmit_multifunction_example.c, net/transmit_on_timestamp/transmit_on_timestamp_example.c, net/transmit_on_timestamp_setclock/transmit_on_timestamp_setclock_example.c, and pps/pps_example.c.

Referenced by _TxPortRateLimit(), ForceAnEvent(), main(), SetGlobalSync(), and setHostLoopback().

int NT_NTPL ( NtConfigStream_t  hStream,
const char *  ntplBuffer,
NtNtplInfo_t info,
uint32_t  validate 
)

Sends an NTPL line buffer to the parser.

This function is used to send an NTPL line buffer to the parser. The config stream is defined by the hStream stream handle.

When using validate mode no data is written to the adapter. The different modes define how far down the parsing is done.

Note: Return data is stored in the stream handle and must be read by the HAL functions.

Parameters
[in]hStreamConfig stream for the NTPL
[in]ntplBufferNTPL line buffer containing NTPL code
[in]infoNTPL Info
[in]validateSet parsing mode to validate. See NtNTPLCommands_e
Return values
NT_SUCCESSNTPL command has been succesfully executed
NT_ERROR_WRONG_STREAM_TYPEThe stream is not a config stream
NT_ERROR_NT_SERVICE_NOT_STARTEDNT service is not started
NT_ERROR_INVALID_STREAM_POINTERStream handle is a NULL pointer
NT_ERROR_INVALID_STREAM_HANDLEStream handle is not a valid handle
NT_STATUS_TRYAGAINHost buffers are temporarily unavailable - please try again
Examples:
net/analysis/analysis_example.c, net/capture/capture_example.c, net/inline/inline_example.c, net/ipfdemo/ipfdemo_example.c, net/netflow/netflow_example.c, net/numa/numa_example.c, net/streamidstatistics/streamidstatistics_example.c, net/timestamp_inject/timestamp_inject_example.cpp, and net/vlandemo/vlandemo_example.c.

Referenced by applyNtpl(), main(), and anonymous_namespace{flowmatch_example_ntpl.cpp}::ntplCall().

Macro Definition Documentation

#define VPD_USER_SIZE   400

Definition at line 599 of file stream_config.h.

#define NT_STREAM_TABLE_ID_INVALID   (~0U)

Definition at line 635 of file stream_config.h.

#define NT_STREAM_TABLE_SIZE_MAX   1024

Definition at line 636 of file stream_config.h.

Typedef Documentation

typedef struct NtConfigStream_s* NtConfigStream_t

Configuration stream handle

Definition at line 123 of file stream_config.h.

Definition at line 463 of file stream_config.h.

Definition at line 497 of file stream_config.h.

Definition at line 513 of file stream_config.h.

typedef struct NtNtplInfo_s NtNtplInfo_t

NTPL Info

typedef struct NtVpd_s NtVpd_t

Stream table command message structure.

This message structure enables the creation, deletion and manipulation of stream tables. A stream table consists an array of StreamIds that are indexed by bits in the packet hash to select the stream a packet should be sent to. Each stream table is identified by a 32-bit number which can be used in the NTPL Assign Command. Stream tables can be manipulated on the fly to suit an applications dynamic needs.

typedef struct NtConfig_s NtConfig_t

Enumeration Type Documentation

Configuration parameters

Enumerator
NT_CONFIG_PARM_UNKNOWN 

Unknown command.

NT_CONFIG_PARM_PORT_COMPAT_0 

Port settings configuration parameter - defined in stream_config_compat.h.

NT_CONFIG_PARM_ADAPTER_TIMESTAMP 

Time stamp configuration parameter - use NtConfigTimestampRead_s or NtConfigTimestampWrite_s.

NT_CONFIG_PARM_ADAPTER_TIMESYNC 

Time synchronization configuration parameter - use NtConfigTimesyncWrite_s.

NT_CONFIG_PARM_SENSOR 

Sensor configuration parameter - use NtConfigSensor_s.

NT_CONFIG_PARM_RESERVED_0 

Reserved.

NT_CONFIG_PARM_BYPASS_ADAPTER 

Bypass adapter settings configuration parameter - use NtConfigBypass_s.

NT_CONFIG_PARM_BYPASS_PORT 

Bypass port settings configuration parameter - use NtConfigBypass_s.

NT_CONFIG_PARM_BYPASS_ADAPTER_WATCHDOG_TIMEOUT 

Bypass watchdog timeout setup configuration parameter - use NtConfigBypassWatchdogTimeout_s.

NT_CONFIG_PARM_BYPASS_PORT_WATCHDOG_TIMEOUT 

Bypass adapter port watchdog timeout setup configuration parameter - use NtConfigBypassWatchdogTimeout_s.

NT_CONFIG_PARM_BYPASS_ADAPTER_WATCHDOG_TIMER 

Bypass adapter watchdog settings configuration parameter - use NtConfigBypassWatchdogTimer_s.

NT_CONFIG_PARM_BYPASS_PORT_WATCHDOG_TIMER 

Bypass port watchdog settings configuration parameter - use NtConfigBypassWatchdogTimer_s.

NT_CONFIG_PARM_ADAPTER_GLOBAL_SYNC 

Enable/disable GlobalSync on the adapter - use NtConfigGlobalSyncWrite_s.

NT_CONFIG_PARM_NIM_ACCESS 

NIM data access for a Port - use NtConfigNimAccess_s.

NT_CONFIG_PARM_VPD 

VPD data access. - use NtVpd_s.

NT_CONFIG_PARM_PTP_PORT 

PTP port on PTP adapter - defined in stream_config_compat.h.

NT_CONFIG_PARM_ADAPTER_TIMESYNC_RESET 

Timesync hard reset and PTP stat reset - use NtConfigTimesyncReset_s.

NT_CONFIG_PARM_ADAPTER_PTP_IMPL_CFG 

PTP configuration settings - use NtConfigPtpImpl_s.

NT_CONFIG_PARM_PORT_COMPAT_1 

Port settings configuration parameter - defined in stream_config_compat.h.

NT_CONFIG_PARM_ADAPTER_MONITOR 

AdapterMonitor configuration parameter - use NtConfigAdapterMonitor_s.

NT_CONFIG_PARM_PORT_TRANSMIT_ON_TIMESTAMP 

Port TX time delta - use NtConfigTransmitOnTimestamp_s.

NT_CONFIG_PARM_PORT_SETTINGS_V2 

Port settings configuration parameter - use NtConfigPort_v2_s.

NT_CONFIG_PARM_STREAM_TABLE 

Stream table manipulation parameter - use NtConfigStreamTable_s.

Definition at line 92 of file stream_config.h.

TimeSync Reset commands

Enumerator
NT_TIMESYNC_RESET_INVALID 
NT_TIMESYNC_RESET_COMPAT_0 

Command for backward compatibility - defined in stream_config_compat.h.

NT_TIMESYNC_RESET_PTP_PORT_STAT 

Reset PTP port statistics.

NT_TIMESYNC_RESET_HARD_RESET_TIME_TO_REF 

Hard reset Time to reference clock (temporary time jumps allowed)

NT_TIMESYNC_RESET_TS_STATISTICS 

Reset global time sync statistics.

Definition at line 287 of file stream_config.h.

Enumerator
NT_NIM_READ_DATA_LIN 

Read NIM data using linear address convention.

Definition at line 441 of file stream_config.h.

NTPL command execution mode

Enumerator
NT_NTPL_PARSER_VALIDATE_NORMAL 

NTPL expression is validated and executed.

NT_NTPL_PARSER_VALIDATE_PARSE_ONLY 

NTPL expression is only validated and has no effect.

Definition at line 522 of file stream_config.h.

NTPL return values

Enumerator
NT_NTPL_PARSER_NORMAL 

No error data returned.

NT_NTPL_PARSER_ERROR_DATA 

Error data returned - errorData is filled.

Definition at line 554 of file stream_config.h.

VPD commands

Enumerator
NT_VPD_USER_DATA 

Definition at line 604 of file stream_config.h.

Stream table commands.

Enumerator
NT_STREAM_TABLE_CREATE 
NT_STREAM_TABLE_DELETE 
NT_STREAM_TABLE_EDIT 
NT_STREAM_TABLE_MAX 

Definition at line 628 of file stream_config.h.