lowRISC / lowRISC/ibex

Display configuration parameters in Verilator simulation

Open
#1,364 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Component:Tool-and-Build Good First Issue Type:Enhancement
Dominant language
SystemVerilog
Stars
2.1k
Forks
810
Avg merge
5d 23h
Merged PRs (30d)
9

Description

To help users identify how their Verilator simulation of Ibex was built it would be nice to display the parameters (or name of the configuration) that were chosen when running the simulation -- either by default, or as part of a config parameter (e.g. --version).

The parameter values should be available from Verilator at runtime, so we probably don't need any compile-time magic to pass them in.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the Verilator simulation entry point and trace how runtime options such as --version are handled. Check which configuration parameter values Verilator exposes at runtime, then define the output that identifies the build configuration; done when a simulation displays those selected parameters or its configuration name.

Written by the indexing model from the issue text.

Assessment

Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.