Skip to content

Commit 8169f3e

Browse files
committed
docs: modify dir folder intro and fix an unit test make bug
1 parent ae3b30d commit 8169f3e

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -102,23 +102,33 @@ To compatible with SoC test, All types of TreeCore have same memory map range:
102102
This section introduces how to set up development environment and runs unit test for your own riscv processor. Project directory is:
103103
```bash
104104
env ->
105-
| hello_world_tb.gtkw
106-
| hello_world_tb.sh
107-
| hello_world_tb.v
105+
| hello_world_tb.gtkw # gtkwave wave config
106+
| hello_world_tb.sh # compile script
107+
| hello_world_tb.v # hello world verilog module
108108
fpga ->
109-
| bare_metal
109+
| bare_metal/ # bare metal verilog module for fpga
110110
report ->
111-
| tc_l2.md
111+
| tc_l2.md # treecore l2 wiki
112112
rtl ->
113-
|
114-
tests
115-
tools
113+
| Makefile # main Makefile for rtl test
114+
| scripts/ # tool scripts called from main Makefile
115+
| build.sc # chisel config
116+
| tc_l(x)[1, 2, 3] # rtl project
117+
tests ->
118+
| compile_rtl.py # bare metal module compile script
119+
| compliance_test.py # isa compliance test
120+
| run_all_isa_test.py # run all isa test
121+
tools ->
122+
| bin2mem.py # convert bin file to mem file
123+
| bin2mif.py # convert bin file to mif file
116124
```
117125

118126
### Enviroment Setup
119127
> NOTE: All of the components and tools are installed under linux operation system. To gurantee the compatibility and stability, I strongly recommend using `ubuntu 20.04 LTS`. `ubuntu 18.04` and `ubuntu 16.04` is not supported official.
120128
121-
If you're new to TreeCore project, we suggest you start with the install section. Remeber you only need to install once time. First, you need to install verilator, mill and other dependency libraries:
129+
If you're new to TreeCore project, we suggest you start with the install section. Remeber you **ONLY** need to install the below libraries once.
130+
131+
First, you need to install verilator, mill, difftest, abstract-machine and other dependency libraries:
122132
```bash
123133
$ git clone https://github.com/microdynamics-cpu/tree-core-cpu.git
124134
$ cd tree-core-cpu/rtl
@@ -180,13 +190,13 @@ $ make riscvTestBuild
180190
$ make cpuTestBuild
181191
$ make amTestBuild
182192
```
183-
> NOTE: you need to enough memory to compile the application binaries.
193+
> NOTE: you need enough memory to compile the application binaries.
184194
185195
### Recursive test
186196
After you modify the processor design, you need to run recursive unit test to gurantee the modification is correct.
187197

188198
```bash
189-
$ make unit-tests
199+
$ make CHIP_TARGET=tc_l2 unit-test # CHIP_TARGET value is tc_l1, tc_l2, tc_lx...
190200
```
191201

192202
The unit tests display the progress, testcase name, PASS or FAIL and ipc value.

0 commit comments

Comments
 (0)