Skip to content

Update README to clarify make arch-test usage #583

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 4, 2025
Merged

Update README to clarify make arch-test usage #583

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,8 @@ $ brew install dtc
```

#### Build and run system emulation
Build and run using default images (the default images will be fetched from [rv32emu-prebuilt](https://github.com/sysprog21/rv32emu-prebuilt) before running):
Build and run using default images (the default images will be fetched from [rv32emu-prebuilt](https://github.com/sysprog21/rv32emu-prebuilt) before running).
If `ENABLE_ARCH_TEST=1` was previously set, run `make distclean` before proceeding.
```shell
$ make ENABLE_SYSTEM=1 system
```
Expand Down Expand Up @@ -192,9 +193,10 @@ $ python3 -m pip install git+https://github.com/riscv/riscof

[RISC-V GNU Compiler Toolchain](https://github.com/riscv-collab/riscv-gnu-toolchain) should be prepared in advance.
You can obtain prebuilt GNU toolchain for `riscv32-elf` from the [Automated Nightly Release](https://github.com/riscv-collab/riscv-gnu-toolchain/releases).
If `ENABLE_SYSTEM=1` was previously set, run `make distclean` before proceeding.
Then, run the following command:
```shell
$ make arch-test
$ make ENABLE_ARCH_TEST=1 arch-test
```

For macOS users, installing `sdiff` might be required:
Expand All @@ -204,7 +206,7 @@ $ brew install diffutils

To run the tests for specific extension, set the environmental variable `RISCV_DEVICE` to one of `I`, `M`, `A`, `F`, `C`, `Zifencei`, `privilege`, `SYSTEM`.
```shell
$ make arch-test RISCV_DEVICE=I
$ make ENABLE_ARCH_TEST=1 arch-test RISCV_DEVICE=I
```

Current progress of this emulator in riscv-arch-test (RV32):
Expand Down