Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 2.32 KB

README.md

File metadata and controls

52 lines (32 loc) · 2.32 KB
Raw

ci workflow

Basic example of simulating Verilog inside a VCV Rack plugin.

This plugin simulates the panel layout of the eurorack-pmod FPGA-based module. See rtl/core.sv for the Verilog source. This example is intentionally kept as simple as possible.

eurorack-pmod running inside VCV rack

Dependencies

  1. Install VCV rack binaries or build it from source.
  2. Install VCV rack SDK (or just put this folder in the plugins/ directory of Rack if you are building from source)
  3. Install Verilator (used to build a C++ simulation from the Verilog core). You can either get it from your package manager or use the one included in the oss-cad-suite.

Building and running

If you are using the SDK, make sure you have RACK_DIR set:

export RACK_DIR=<Rack SDK folder>

From the root directory of this repository:

$ make
$ make install

This plugin should now be visible on restarting VCV Rack.

Limitations

At the moment only the audio rate sample_clk is injected into the verilog core, I doubt verilator would be fast enough to simulate filters pipelined at the PLL clock (12MHz/24MHz).

Debugging

Some basic CI for Mac + Linux is in .github/workflows/main.yml, this may be useful to look at if you are having trouble building.

Sometimes it is useful to run VCVRack in development mode so that you get some more detailed logs if a plugin doesn't load correctly:

$ ./Rack --dev

For example, an update to verilator recently added an extra source dependency that was missing, causing an error like this --

[0.011 info src/plugin.cpp:130 loadPlugin] Loading plugin from /home/seb/Downloads/Rack2Free/plugins/eurorack-pmod-vcvrack
[0.011 warn src/plugin.cpp:196 loadPlugin] Could not load plugin /home/seb/Downloads/Rack2Free/plugins/eurorack-pmod-vcvrack: Failed to load library /home/seb/Downloads/Rack2Free/plugins/eurorack-pmod-vcvrack/plugin.so: /home/seb/Downloads/Rack2Free/plugins/eurorack-pmod-vcvrack/plugin.so: undefined symbol: _ZN12VlThreadPoolC1EP16VerilatedContextj