KitsUVM

Random attempt trying to rebuild a better easier_uvm.

Features

Focuses on:

improving generated files by checking DUT ports and matching interface ports
using standard configuration files (TOML)
allowing semi-automated VIP testbench (self-test)

Usage

Building

Cargo is needed to build KitsUVM: rust & cargo setup

Examples

Some basic examples are provided in:

Fifo (top and self-test combined)
HealthCheck (self-test only)

Code left to user to fill in

Mandatory code to fill in before getting a usable simulation:

bin
- chmod +x run script(s)
VIP
- do_drive_controller() and do_drive_responder() by default issue a fatal (vip/*/*_driver.sv)
- do_mon() by default issues a fatal (vip/*/*_monitor.sv)
- clocking blocks port directions of cb_cont_drv and cb_resp_drv in self-test only (vip/*/*_if.sv)
Top
- write_from_*() by default print received packets (top/top_scoreboard.sv)

Output

out
├── bin
│   ├── run.sh
│   └── <VIP>_self_test.sh
├── dut
│   ├── dut_files.txt
│   └── <DUT>.sv
├── <VIP>_st
│   ├── (top like structure)
│   ...
├── top
│   ├── config.sv
│   ├── env.sv
│   ├── pkg.sv
│   ├── scoreboard.sv
│   ├── seq_lib.sv
│   ├── tb
│   │   ├── tb.sv
│   │   └── th.sv
│   └── test
│       ├── test_pkg.sv
│       └── test.sv
└── vip
    ├── <VIP>
    ... ├── agent.sv
        ├── config.sv
        ├── coverage.sv
        ├── driver.sv
        ├── if.sv
        ├── monitor.sv
        ├── pkg.sv
        ├── seq_lib.sv
        ├── sequencer.sv
        └── tx.sv

How does it work?

flowchart LR
  CLI[CLI] -->|config files paths & \n launch options| TOMLParser[TOML \n Parser]
  ConfigFiles --o TOMLParser
  subgraph ConfigFiles[Config Files]
    direction LR
    ProjectCfg[./project.toml]
    Instances[./instances.toml]
    VIPs[[./vip.toml]]
  end

  TOMLParser -->|generates| UVM[Renderable \n Structs]
  TOMLParser -->|DUT path & \n config| SVParser[SV \n Parser]

  DUT --o SVParser
  subgraph DUT[DUT File]
    DUTFile[./dut.sv]
  end
  SVParser -->|DUT & \n vips compat| UVM

  UVM -->|drives| Tera[Template \n engine]
  TemplateFiles --o Tera
  subgraph TemplateFiles[Template Files]
    TemplateDir[[./templates/*.j2]]
  end

  Tera -->|renders| Project
  subgraph Project[UVM Project]
    direction LR
    binDir[bin]
    DUTDir[dut]
    topDir[top]
    topSTDir[vip_st]
    vipDir[vip]
  end

WiP

further decrease release binary size? (currently around 40MB for release build)-> min-sized-rust and optional sv-parser dependency
performance enhancement -> async read/write for config files
handle multiple files DUT
convert2string() string and special types handling (by default returns all values as int representation)
handle generic parameters for DUT and VIP

Credits

Relies on:

tera (template engine)
toml-rs (TOML parser)
sv-parser (SystemVerilog parser)

Special thanks to uvm_code_gen for mentoring and the templates :)

vmorillon / kitsuvm