VERILATOR-SST

Verilator-SST is a framework for generating SST subcomponents based on provided (System)Verilog code. It uses Verilator to produce a C++ RTL simulator program that is managed by the generated SST Subcomponent. The generated subcomponents can be created with one of two supported interfaces:

1. Link Interface

Generates links for each port in the Verilog top module, which can be written or read using the SST::VerilatorSST::PortEvent class.

2. Direct Interface (C++ API)

Write/read ports using the exposed writePort, writePortAtTick, and readPort functions from a parent component.

Subcomponents can only be generated with one of these interfaces exposed.

• When using the link interface, the VerilatorComponent class should be used as the parent component.
• When using the C++ API, specific options must be set to avoid errors (see Build Options).

Reading/Writing Ports

There are two modes of reading/writing ports in the Verilated model: VPI and Direct (not to be confused with the above mentioned Direct C++ API, which is an SST-side interface). Direct reads/writes access the variables directly and may be faster than VPI, with both methods offering consistent behavior.

Handling inout Ports

inout ports are accessible through normal methods. Verilator implements inout ports as an input port and two output ports:

• <inout_name>__en: Checks whether the port is being driven by the model.
• <inout_name>__out: Reads the value.

The input port is used for writing operations and is assigned the original port name according to the Verilog module. VerilatorSST abstracts these ports and ensures:

• If the signal is not driven when a read occurs, or is driven when a write occurs, the program will err out.

Tristate ports are not supported in the available versions of Verilator, so inout behavior can only be achieved through the above mentioned three-port abstraction. As a result, inout ports cannot be accessed properly through VPI.

Therefore, inout ports should be read/written by their original names using Direct reads/writes.

---

Dependencies

• Verilator >v5.022 (Version 5.026 or greater is required for inout port support)
• SST >13.1.0
• Python (>3.6.8)
• CMake (>3.24.2)

---

Build

To build the project, run the following commands:

git clone git@github.com:tactcomplabs/verilator-sst.git
cd verilator-sst/
mkdir build && cd build
cmake ../
make
make install

To verify that the installation works properly, run:

make test

This will generate two subcomponents for each included example Verilog code (one using the links interface, one using the direct interface) and will use the relevant test component to verify their functionality.

---

Build Options

Project Arguments

-DDISABLE_TESTING                        # Disables testing (enabled by default)
-DENABLE_INOUT_HANDLING=ON               # Allows designs with inout ports (requires Verilator 5.026 or greater)
-DENABLE_CUSTOM_MODULE=ON                # Required to build an external module with CLI model arguments
-DVERILATOR_INCLUDE=<verilator include path>  # Set automatically if not assigned

Model Arguments

-DVERILOG_SOURCE_DIR=<path to verilog source tree>
-DVERILOG_DEVICE=<name of verilog device to simulate>      # Used in the name of the subcomponent
-DVERILOG_TOP=<name of the top level verilog module>
-DVERILOG_TOP_SOURCES=<list of verilog top source files>
-DVERILATOR_OPTIONS=<additional verilator compilation options>  # Defaults to empty string
-DENABLE_CLK_HANDLING=ON                                   # Generates automatic clock port handling (for C++ API interface)
-DENABLE_LINK_HANDLING=ON                                  # Generates links and link handlers (for links interface; on by default)
-DCLOCK_PORT_NAME=<name of clock port>                     # Defaults to "clk", used with ENABLE_LINK_HANDLING

Note: ENABLE_CLK_HANDLING and ENABLE_LINK_HANDLING cannot be set to ON simultaneously.

---

Debug

To build with debug options enabled, run:

cmake -DCMAKE_BUILD_TYPE=Debug ../  # instead of cmake ../

---