Skip to content

Commit 8e26308

Browse files
committed
Update READMEs
1 parent cd19f93 commit 8e26308

File tree

4 files changed

+16
-9
lines changed

4 files changed

+16
-9
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
# ARVI
2-
A simple single cycle RISC-V implementation in Verilog.
2+
A simple single cycle RISC-V implementation in SystemVerilog.
33

44
## Project now
5-
The project is a single-cycle processor implementing RV32I[M][A] instruction set. It also has some support to RISC-V's machine mode. The project also has a dual core mode (RV32A is necessary). Check rtl/arvi_defines.vh to see all different parameters ARVI can receive.
5+
The project is a single-cycle processor implementing RV32I[M][A] instruction set and it also has partial support to RISC-V's machine mode. The project also has a dual core mode (RV32A is necessary). Check rtl/arvi_defines.vh to see all different parameters ARVI can receive.
66

7-
This project contains a Performance Profiler to profile each executed program and retrieve information like how many instructions were issued, cache hits, and misses.
7+
Besides the processor, the project contains a Performance Profiler to profile each executed program in simulation and retrieve information like how many instructions were issued, cache hits, and misses.
88

99
#### Features
1010

1111
1. Single Cycle RV32I[M][A] RISC-V.
1212
2. Instruction cache.
1313
3. Machine mode privilege level support.
1414
4. Performance Profiler.
15+
5. FPGA Synthesis Script.
1516

1617
## Next steps
1718
1. Build pipeline.
1819
2. Implement a bus like Wishbone or AXI to communicate with other devices. At the moment only a simple bus is used.
19-
3. Create FPGA synthesis scripts.
2020

2121
## Project dependencies
2222
1. verilator
@@ -28,7 +28,7 @@ This project contains a Performance Profiler to profile each executed program an
2828

2929
#### all
3030
$make all
31-
Compile necessary files using to create an executable program.
31+
Compile necessary files to create an executable Verilator program.
3232

3333
#### regression-tests
3434
$make regression-tests
@@ -43,8 +43,7 @@ Run all benchmarks in tb/tests. All benchmarks are from [riscv-tests](https://gi
4343
#### performance
4444
$make performance
4545

46-
Retrieve all information in all ".performance_report" files in the project and put them into a file called dataframe.csv. You can use this file to check performance parameters when of a executed program.
47-
46+
Retrieve all information in all ".performance_report" files in the project and put them into a file named dataframe.csv. You can use this file to check performance parameters of an executed program.
4847

4948
## Command line arguments
5049

fpga/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# FPGA Synthesis
2+
3+
This folder contains all files necessary to handle synthesis targeting FPGA. The folder is divided in three subfolders:
4+
5+
- ip: Store IPs that can be used in FPGA.
6+
- part: Contain all available targets (FPGA or boards).
7+
- scripts: FPGA synthesis scripts.
8+
9+
Only basys3 board is currently supported and a simple blink program is available to it.

fpga/README.txt

Lines changed: 0 additions & 1 deletion
This file was deleted.

sim/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Testbench
22

3-
This folder contains scripts, tests (binaries), and C++ code to build the project. All file in tests are from riscv-tests and riscv-compliance projects which were compiled and putted here.
3+
This folder contains scripts, tests (binaries), and C++ code to build the project. All files in tests are from riscv-tests and riscv-compliance repositories which were compiled and inserted here.

0 commit comments

Comments
 (0)