DSIM developers fork of RISCV-DV

Fork of https://github.com/google/riscv-dv/tree/master/, commit 9ecee87bbc41650ca0f8846de9a277bec2783e18 This project exists to aid integration of the Google RISCV-DV project and the Metrics dsim SystemVerilog simulator.

Quick and Dirty Summary

The git logs will give you more detail, but just to make it easy to find, the following files were modified:

• modified: src/riscv_asm_program_gen.sv
• modified: src/riscv_instr_cover_group.sv
• modified: yaml/simulator.yaml
• modified: .gitignore

As explained below the scriptware wants a set of shell environment variables set. At a minium you'll need (assuming you are running dsim/20191112.5.1):

• export DSIM="/tools/Metrics/dsim/20191112.5.1/bin/dsim"
• export DSIM_LIB_PATH="/tools/Metrics/dsim/20191112.5.1/uvm-1.2/src/dpi"
• export RISCV_GCC="/opt/riscv/bin/riscv32-unknown-elf-gcc"
• export RISCV_OBJCOPY="/opt/riscv/bin/riscv32-unknown-elf-objcopy"
• export SPIKE_PATH="/opt/riscv-64/bin/spike"

With the above changes/updates the following command generates a couple of test programs and runs them through the compiler. Still need to figure out how to get the ELF files generated.

$ python3 run.py --test riscv_arithmetic_basic_test --steps gen,gcc_compile --simulator dsim

TODO: So it compiles and runs, but more work is required. A few of the changes made simply comment out code that dsim doesn't like. We need to find out why and implement real fixes.

Overview

RISCV-DV is a SV/UVM based open-source instruction generator for RISC-V processor verification. It currently supports the following features:

• Supported instruction set: RV32IMAFDC, RV64IMAFDC
• Supported privileged mode: machine mode, supervisor mode, user mode
• Page table randomization and exception
• Privileged CSR setup randomization
• Privileged CSR test suite
• Trap/interrupt handling
• Test suite to stress test MMU
• Sub-program generation and random program calls
• Illegal instruction and HINT instruction generation
• Random forward/backward branch instructions
• Supports mixing directed instructions with random instruction stream
• Debug mode support, with fully randomized debug ROM
• Instruction generation coverage model
• Handshake communication with testbench
• Support handcoded assembly test
• Co-simulation with multiple ISS : spike, riscv-ovpsim, whisper, sail-riscv

Getting Started

Prerequisites

To be able to run the instruction generator, you need to have an RTL simulator which supports SystemVerilog and UVM 1.2. This generator has been verified with Synopsys VCS, Cadence Incisive/Xcelium, Mentor Questa, and Aldec Riviera-PRO simulators. Please make sure the EDA tool environment is properly setup before running the generator.

Install RISCV-DV

Getting the source

git clone https://github.com/google/riscv-dv.git

There are two ways that you can run scripts from riscv-dv.

For developers which may work on multiple clones in parallel, using directly run by python3 script is highly recommended. Example:

pip3 install -r requirements.txt    # install dependencies (only once)
python3 run.py --help

For normal users, using the python package is recommended. First, cd to the directory where riscv-dv is cloned and run:

export PATH=$HOME/.local/bin/:$PATH  # add ~/.local/bin to the $PATH (only once)
pip3 install --user -e .

This installs riscv-dv in a mode where any changes within the repo are immediately available simply by running run/cov. There is no need to repeatedly run pip install . after each change. Example for running:

run --help
cov --help

Use below command to install Verible, which is the tool to check Verilog style

verilog_style/build-verible.sh

This is the command to run Verilog style check. It's recommended to run and clean up all the style violations before submit a PR

verilog_style/run.sh

Document

To understand how to setup and customize the generator, please check the full document under docs directory. You can use the makefile to generate the document. HTML preview. You can find the prebuilt document under docs/build/singlehtml/index.html

External contributions and collaborations

This repository is still under active development. We hope the RISC-V processor verification platform development to be a collaborative effort of the RISC-V community. Free feel to submit issues, feature requests, pull requests through Github. You can also send your private collaboration request to riscv_dv_dev@google.com. Please refer to CONTRIBUTING.md for license related questions.

Supporting model

Please file an issue under this repository for any bug report / integration issue / feature request. We are looking forward to knowing your experience of using this flow and how we can make it better together.

Disclaimer

This is not an officially supported Google product.