Documentation Home Page HYPERSIM Home Page
Pour la documentation en FRANÇAIS, utilisez l'outil de traduction de votre navigateur Chrome, Edge ou Safari. Voir un exemple.

Oregano syn1588 | Configuration

Accessing the I/O Interface Configuration

The C37.118 master communication protocol can be configured in the I/O Interface Configuration tool that can be opened from the HYPERSIM ribbon.

For more information on the general use of the I/O Interface Configuration, read here.

General Configuration

The Synchronization driver is configured within a single page.


The only supported hardware at the moment is the Oregano Syn1588 PCIe card.

Enable verbose mode

If enabled, additional information will be displayed in the HYPERSIM log.
Note that this option impacts real-time performance.

Synchronization mode

Select whether the card will be synchronized using PTP, IRIG-B, or 1PPS. When configured in PTP mode, the driver can operate as a PTP master or a PTP slave. The operation mode depends on the selected PTP profile and priority. When configured in IRIG-B or 1 PPS mode, the driver will expect to receive a valid signal on the external SMA connector. In this mode, the driver can also operate as a PTP master to synchronize other PTP slaves on the network.

Possible options are:

  • PTP

  • IRIG-B

  • 1 PPS

Generate sync signal

This option is only available when the external synchronization mode is PTP. When operating in PTP mode, the external SMA connector can be used to generate a 1 PPS or an IRIG-B signal.

Possible options are:

  • Disabled

  • IRIG-B

  • 1 PPS

Wait for next second

If this parameter is enabled, the beginning of the simulation will be delayed until the next second change. The rising edge of the synchronization signal will be aligned with the rising edge of the 1 PPS signal in either PTP, IRIG-B, or 1 PPS mode. If this parameter is disabled, the simulation can begin in the middle of a second.

Wait for synchronization timeout (seconds)

The synchronization process will begin once the model is loaded but the simulation will not begin until the timeout configured by this parameter has expired. This parameter should be tuned to make sure the simulation is started with a good synchronization with the external source. To begin the simulation immediately after the model is loaded, set this parameter to zero.

Network interface

This field is not mandatory, it can be left blank or set to "auto" to allow the software to automatically discover the network interface.

Otherwise, this parameter must match with the network interface name of the IEEE1588 compatible hardware. An error will be displayed at execution time in case the network interface does not support PTP. 

PTP profile

Select the PTP profile that matches your architecture. A PTP profile specifies a preset of IEEE1588 configuration and operation mode. For more information, please consult the IEEE 1588-2008 standard.

Possible options are:

  • Default

  • P2P default

  • Power

  • Power slave

  • Power 2 (only supported on 32-bit Linux platforms (x86))

  • Power 2 slave (only supported on 32-bit Linux platforms (x86))

  • C37 238 2017 (not supported on 32-bit Linux platforms (x86))

  • C37 238 2017 slave (not supported on 32-bit Linux platforms (x86))


  • SMPTE slave

  • Telecom master

  • Telecom 2

  • Telecom 2 slave

  • gPTP

  • gPTP slave

Delay mechanism

The mechanism used to calculate the delays incurred during the propagation of the packets across the network.

Possible options are:

  • Peer to peer

  • End to end


Select this option if the synchronization hardware is connected to a VLAN. In this case, the VLAN index needs to be specified.

VLAN index

If the option Use VLAN is enabled, the VLAN index must be specified.


The value chosen for the priority will be taken into account by the Best Master Clock Algorithm (BMCA). A lower value means a higher priority. If the IEEE1588 card is operating in master mode and another device with a higher priority appears, on the network, the simulator will become a slave.

Advanced options

The Oregano Syn1588 PCIe card has the possibility to handle some custom specialized configurations. It should only be used by advanced users or with the help of the OPAL-RT's support team.

Time offset (s)

The time offset to apply on the timestamp read from the hardware, expressed in seconds. This parameter accepts values with precision up to the nanosecond. If set to a non-null value, the driver will output the original time as well as the shifted timestamp.
If the clock is not well synchronized (timestamp starting at 0 seconds) the original clock may be compensated to avoid a negative shifted timestamp.

Apply this configuration automatically next time the system boots

If enabled, the card will be configured by an OS service launched at boot time. This will provide a stabilized offset with the Grandmaster clock at the beginning of the simulation.
This feature is not supported on 32-bit Linux platforms (x86).

Enable virtual mode

In virtual mode, the model can be executed even if this I/O interface is not compatible with the hardware configuration of the system. The connections between the model and the I/O interface will be done during the initialization, but the I/O interface will not do anything. The virtual mode can be used to troubleshoot problems on a system without having the required hardware, or to prepare a model with different I/O interfaces even if the final hardware platform is not available.


If for any reasons your system requires many seconds to have a good synchronization with the synchronization source, the option Apply this configuration automatically next time the system boots can be enabled. Another option is to increase the Wait for synchronization timeout. If this value is too high, the HYPERSIM initialization watchdog might prevent the simulation to be launched. In this case, please contact OPAL-RT's technical support.


OPAL-RT TECHNOLOGIES, Inc. | 1751, rue Richardson, bureau 1060 | Montréal, Québec Canada H3K 1G6 | | +1 514-935-2323