stream_config.h
Go to the documentation of this file.
72 * @li <tt>Sensor min/max alarm settings</tt> Retrieves or changes sensor min/max alarm limits configuration
73 * @li <tt>Coordinated time synchronized transmit</tt> Sets the coordinated time synchronized transmit configuration
83 * @note The config stream is not thread-safe. If the same stream handle is to be used by multiple threads,
94 NT_CONFIG_PARM_PORT_COMPAT_0 = 1, //!< Port settings configuration parameter - defined in stream_config_compat.h
95 NT_CONFIG_PARM_ADAPTER_TIMESTAMP, //!< Time stamp configuration parameter - use @ref NtConfigTimestampRead_s or @ref NtConfigTimestampWrite_s
96 NT_CONFIG_PARM_ADAPTER_TIMESYNC, //!< Time synchronization configuration parameter - use @ref NtConfigTimesyncWrite_s
99 NT_CONFIG_PARM_BYPASS_ADAPTER, //!< Bypass adapter settings configuration parameter - use @ref NtConfigBypass_s
100 NT_CONFIG_PARM_BYPASS_PORT, //!< Bypass port settings configuration parameter - use @ref NtConfigBypass_s
101 NT_CONFIG_PARM_BYPASS_ADAPTER_WATCHDOG_TIMEOUT, //!< Bypass watchdog timeout setup configuration parameter - use @ref NtConfigBypassWatchdogTimeout_s
102 NT_CONFIG_PARM_BYPASS_PORT_WATCHDOG_TIMEOUT, //!< Bypass adapter port watchdog timeout setup configuration parameter - use @ref NtConfigBypassWatchdogTimeout_s
103 NT_CONFIG_PARM_BYPASS_ADAPTER_WATCHDOG_TIMER, //!< Bypass adapter watchdog settings configuration parameter - use @ref NtConfigBypassWatchdogTimer_s
104 NT_CONFIG_PARM_BYPASS_PORT_WATCHDOG_TIMER, //!< Bypass port watchdog settings configuration parameter - use @ref NtConfigBypassWatchdogTimer_s
105 NT_CONFIG_PARM_ADAPTER_GLOBAL_SYNC, //!< Enable/disable GlobalSync on the adapter - use @ref NtConfigGlobalSyncWrite_s
109 NT_CONFIG_PARM_ADAPTER_TIMESYNC_RESET, //!< Timesync hard reset and PTP stat reset - use @ref NtConfigTimesyncReset_s
110 NT_CONFIG_PARM_ADAPTER_PTP_IMPL_CFG, //!< PTP configuration settings - use @ref NtConfigPtpImpl_s
111 NT_CONFIG_PARM_PORT_COMPAT_1, //!< Port settings configuration parameter - defined in stream_config_compat.h
112 NT_CONFIG_PARM_ADAPTER_MONITOR, //!< AdapterMonitor configuration parameter - use @ref NtConfigAdapterMonitor_s
113 NT_CONFIG_PARM_PORT_TRANSMIT_ON_TIMESTAMP, //!< Port TX time delta - use @ref NtConfigTransmitOnTimestamp_s
114 NT_CONFIG_PARM_PORT_SETTINGS_V2, //!< Port settings configuration parameter - use @ref NtConfigPort_v2_s
128 NtLinkSpeed_t speed; //!< The interface speed - this is in effect if @ref NtLinkAutoNeg_e "autoNegotiation" = @ref NT_LINK_AUTONEG_MANUAL
129 NtLinkDuplex_t duplex; //!< The duplex mode - this is in effect if @ref NtLinkAutoNeg_e "autoNegotiation" = @ref NT_LINK_AUTONEG_MANUAL
151 * Note: This is part of the NTDS structure. Changing this requires the service to be recompiled.
154 int enable; //!< 0 = Disable interface, 1 = Enable interface. If disabled, the port will still be visible, but has status link down.
171 struct NtPortSettingsAdvertise_s advertise; //!< Array of parameters to be advertised when autonegotiation is enabled
173 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.
174 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.
176 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.
232 //!< Special case: a value in the range of 1 to 100 specifies a limit as percentage of the link speed.
240 uint8_t Reserved1[3];
249 uint8_t Reserved1[3];
262 uint8_t Reserved1[3];
274 uint8_t Reserved1[3];
288 NT_TIMESYNC_RESET_COMPAT_0, //!< Command for backward compatibility - defined in stream_config_compat.h
290 NT_TIMESYNC_RESET_HARD_RESET_TIME_TO_REF, //!< Hard reset Time to reference clock (temporary time jumps allowed)
299 uint8_t Reserved1[3];
315 uint8_t Reserved1[3];
325 enum NtSensorSource_e source; //!< The source of the sensor - either a port or an adapter sensor
326 uint32_t sourceIndex; //!< The source index - either adapter number or port number on which the sensor resides
327 uint32_t sensorIndex; //!< The sensor index within the sensor group, see @ref MainDocMainFeaturesInfo_Sensors
341 uint8_t Reserved1[3];
344 uint64_t timeSynchronizedTxOffset; //!< Time offset between time stamp in first frame and adapter time
356 enum NtBypassTrigger_e bypassTriggerModes; //!< Bypass triggers that affect bypass states using @ref NtBypassTrigger_e
357 enum NtBypassPortState_e currentBypassPortState; //!< Current (live) bypass state using @ref NtBypassPortState_e
358 enum NtBypassPortState_e onInitBypassPortState; //!< onInit bypass state using @ref NtBypassPortState_e
359 enum NtBypassPortState_e onPowerFailBypassPortState; //!< onPowerFail bypass state using @ref NtBypassPortState_e
360 enum NtBypassPortState_e onWatchdogFailBypassPortState; //!< onWatchdogFail bypass state using @ref NtBypassPortState_e
428 uint8_t Reserved[3];
430 uint64_t timeDelta; //!< Delta in nanoseconds to add to packet time before comparing to adapter time
433 uint64_t timeDeltaAdjust; //!< Delta in nanoseconds added by adapter to timeDelta whenever a TXSETCLOCK packet is encountered
449 uint8_t data[512];
455 uint8_t Reserved1[3];
545 uint8_t group4PlusCount; //!< Number of group filters used combining 4 patterns with 4 different dynamic offsets
546 uint8_t group8Count; //!< Number of group filters used combining 8 patterns with 2 different dynamic offsets
582 struct NtNtplFilterCounters_s aFilterInfo[NT_MAX_NUM_ADAPTERS]; // Deprecated. Use info stream instead
637 struct NtConfigPort_v2_s portSettings_v2; //!< Port setting struct is used when reading or writing using command @ref NT_CONFIG_PARM_PORT_SETTINGS_V2
639 struct NtConfigPort_v1_s portSettings_v1; //!< Port setting struct is used when reading or writing using command @ref NT_CONFIG_PARM_PORT_SETTINGS_V1
641 struct NtConfigTimestampRead_s timestampRead; //!< Time stamp read struct is used when reading using command @ref NT_CONFIG_PARM_ADAPTER_TIMESTAMP
642 struct NtConfigTimestampWrite_s timestampWrite; //!< Time stamp write struct is used when writing using command @ref NT_CONFIG_PARM_ADAPTER_TIMESTAMP
643 struct NtConfigTimesyncWrite_s timesyncWrite; //!< Time sync write struct is used when writing using command @ref NT_CONFIG_PARM_ADAPTER_TIMESYNC
644 struct NtConfigSensor_s sensor; //!< Sensor read and write struct is used to read or write sensor alarm limits using command @ref NT_CONFIG_PARM_SENSOR
645 struct NtConfigGlobalSyncWrite_s globalSyncWrite; //!< Stream write struct is used when writing using command @ref NT_CONFIG_PARM_ADAPTER_GLOBAL_SYNC
646 struct NtConfigBypass_s bypassConfig; //!< Bypass adapter and port setting struct is used when reading or writing using commands @ref NT_CONFIG_PARM_BYPASS_PORT @ref NT_CONFIG_PARM_BYPASS_ADAPTER
647 struct NtConfigBypassWatchdogTimer_s bypassWatchdogTimer; //!< Bypass watchdog reading or writing using commands @ref NT_CONFIG_PARM_BYPASS_PORT_WATCHDOG_TIMER @ref NT_CONFIG_PARM_BYPASS_ADAPTER_WATCHDOG_TIMER
648 struct NtConfigBypassWatchdogTimeout_s bypassWatchdogTimeout; //!< Bypass watchdog reading or writing using commands @ref NT_CONFIG_PARM_BYPASS_PORT_WATCHDOG_TIMEOUT @ref NT_CONFIG_PARM_BYPASS_ADAPTER_WATCHDOG_TIMEOUT
649 struct NtConfigNimAccess_s nimAccess; //!< NIM data access using command @ref NT_CONFIG_PARM_NIM_ACCESS
651 struct NtConfigSensor_s sensorWrite; //!< Sensor write struct is used when writing using command @ref NT_CONFIG_PARM_SENSOR
661 struct NtConfigTransmitOnTimestamp_s transmitOnTimestamp; //!< Port transmit on timestamp settings
698 * @param[in,out] data NtConfig_t structure containing configuration query and serving as output buffer for data
743 int NT_NTPL(NtConfigStream_t hStream, const char *ntplBuffer, NtNtplInfo_t *info, uint32_t validate);