nickelpro/RISCVBusiness

RISCVBusiness

Design documents and project information for the RISC-V Business project can be found here:

RISCV-Business Documentation

Current User-Level ISA Spec : v2.1 Current Privileged ISA Spec : v1.12

Getting Started

Getting started with RISCV Business consists of three steps: setting up the RISCV tool-chain, setting up the WAF build system, and finally interacting with the RISCV Business project itself.

Fusesoc

This project uses the Fusesoc build system. Use the following commands to get started...

# install project dependencies &
# setup git pre-commit hook
./setup.sh

# For ease of use, use the makefile to run FuseSoC tests
make # shows all build targets available

# configure the RISC-V core
make config 
# or python3 scripts/config_core.py <custom>.yml
#   if you want to use a config other than example.yml

make verilate # build with Verilator, or...
make xcelium # build with Xcelium

Congrats! All dependencies are now set up. Now you can run simulations/tests:

# Run ISA tests
run_tests_verilator.py

# Run specify binary on Verliator core simulation
./rvb_out/sim-verilator/Vtop_core meminit.bin

Generating RISC-V tool-chain

Refer to the following link for instructions on installing the RISC-V software tools:

RISC-V Software Installation

Execute the following commands to download the correct version of the RISC-V tools:

git clone https://github.com/riscv/riscv-tools.git
git checkout 4635ab67966c763a84f7217bc2c20b65dcabc7ec
git submodule update --init --recursive

Change the line to build the riscv-gnu-toolchain tools to:

build_project riscv-gnu-toolchain --prefix=$RISCV --with-xlen="$with_xlen" --with-arch=RV32IM

Then run after setting the environment variable "RISCV" to your install location:

./build.sh

Setup and Run RISCV Business

First, clone the repository

git clone git@github.com:JakeStevens/RISCVBusiness.git

Once the directory is cloned, the configuration for a core must be generated before the project can be simulated/synthesized. This can be done using the example.yml configuration provided, or using a modification of that file.

./scripts/config_core.py example.yml

Run the following command to run the regression test on RISCV-Business. All tests should pass:

./run_tests.py

Refer to the LICENSE file for licensing information.