Support : Knowledge base

Knowledge Base

Welcome to OPAL-RT’s Knowledge Base

OPAL-RT offers a repository of support information for optimal use of its technology.

Loading…

Please note that OPAL-RT knowledge base is not fully optimized for mobile platforms.

For optimal experience, use a desktop computer.

Reference Number: AA-02234// Views: AA-02234// Created: 2023-10-25 15:06:28// Last Updated: 2024-10-02 08:55:27
General Article
Oregano — Checking the compatibility of the Oregano card with an OPAL-RT Simulator's OS and installed versions of RT-LAB/HYPERSIM

Oregano, OS and RT-LAB/HYPERSIM compatibility

There are four pieces of information that we need to know to check if the Oregano syn1588 card will be able to function correctly with a given simulator. They are as follows:

  1. Oregano card revision, that is the physical hardware version of the card.
  2. Oregano firmware version, the firmware that is presently installed on the card.
  3. The OS of the simulator.
  4. The installed versions of RT-LAB/HYPERSIM on the Simulator. 

Before going over which versions of each item are compatible with each other, it is necessary to discuss how to check the version number of each item.

Determining the Version number of each item

Checking the Oregano card version

Typically, there are four versions of Oregano cards that are compaitble with OPAL-RT Simulators; revision 1.9, 2.1, 2.3 and 2.3.1. If you have purchased your Oregano card separately from your OPAL-RT simulator and it happens to be revision 2.3.1, it will require a firmware downgrade before it can be used with an OPAL-RT simulator. Regardless, there are two methods to check the revision number.

  1. Check the revision number listed on the Oregano board. 

Log into your simulator via MobaXterm, How to Install and Connect MobaXterm. Assuming the Oregano card is detected on the PCIE lane of the simulator, there are one of two commands applicable; older revisions of the card will be "Altera" and newer revisions will be "Mein." The Oregano devices will be listed as "Ethernet Controller" devices. 

lspci | grep Altera
lspci | grep Mein

For example, the output of the Altera command will be similar to the following:
01:00.0 Ethernet controller: Altera Corporation Unknown device 1000 (rev 03)


Let us interpret this output:

  • "Ethernet Controller" — This indicates that the PCIe device has the hardware capability to control/manage ethernet communications, many devices with ethernet ports will have ethernet controllers.
  • "Altera Corporation" —  Self-evident
  • "Unknown Device" — The Vendor ID is not found or not available
  • "1000" — Device ID
  • "(rev 03)" — Revision ID

The key piece of information here is the Revision ID, since it is "(rev 03)," that indicates the example device is revision 2.1.

Conversely, for newer devices, an example of the "Mein" command's output:
01:00.0 Ethernet controller [0200]: Meinberg Funkuren Device [1360:0a01] (rev 01)

  • "Ethernet Controller" — As above
  • "Meinberg Funkuren Device" —  Self-evident
  • "1360" — The Vendor ID
  • "0a01" — Device ID
  • "(rev 01)" — Revision ID

The above information indicates that this device is Oregano revision 2.3


Checking the Oregano firmware version

There are two firmware versions supported for Oregano card with the OPAL-RT Simulator. Build 782 and 808, once again, these firmware builds depend on the revision of the Oregano card. To check the Oregano firmware version please login to you simulator via SSH and follow the steps outlined below. Note: If you have the red-hat operating system the method below will not work, for that case you would need to connect the Oregano card to a Windows PC and use the syn1588 NIC Updator tool to detect the firmware version, for this process please contact OPAL-RT customer support. Once again, if you purchased your Oregano 2.3.1 separately from your OPAL-RT simulator, it will require a firmware downgrade, once more, contact customer support.

  1. Assuming that the Oregano card is connected to the target and can be detected on the PCIe bus; we first need to load the Oregano kernel modules, to do that, execute the following two commands in succession:

    cd /usr/opalrt/common/bin/modules
    ./oregano_load_module `pwd` 

    Please note
    : The quotes around pwd are not the regular quotation marks.
    Then, execute the next set of commands:

    cd /home/oregano/syn1588_linux_updater
    ./syn1588
    listcards
    card
    build


Checking the Simulator's OS version

Broadly, there are two main OS' supported on OPAL-RT Simulators, each with various versions. The two OS' in question are Red-Hat and OPAL-RT Linux. The commands to check each OS are listed below:

Red-Hat: uname -r
OPAL-RT Linux: opalrtlinux_version 


Checking the Installed Versions of RT-LAB/HYPERSIM on the Simulator

From the host PC, the versions of RT-LAB and of HYPERSIM can each be checked within the actual software.

  1. Within RT-LAB, to see the list of installed versions on the target, select the target of interest and navigate to the "Software" tab. Refer to the screenshot below.


  2. Within HYPERSIM, the UI may be different but the process is largely the same. Select the target of interest and click the "versions" tab. Refer to the screenshot below


Determining the compatibility of each item

The key characteristic which determines all else, is the Oregano revision. Shown below is a helpful flowchart in determining what versions of RT-LAB/HYPERSIM you need for your given card:



Some other caveats and notes:

  • Oregano revision 2.3 requires OPAL-RT Linux version 3.5.4. and above.
  • If on Red-Hat, the oldest versions of RT-LAB and HYPERSIM that are supported are 11.0.8 and R6.0.9.o742 respectively.