Skip to content

Commit 22c4bd8

Browse files
callendorphCarl Allendorph
authored and
Carl Allendorph
committed
Updated README with setup instructions
1 parent a6907d2 commit 22c4bd8

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

README.md

+26-6
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,47 @@ This project contains a VHDL-based JTAG TAP Master controller. This controller c
44

55
The goal is to provide an AXI compatible interface that would allow easy integration with a host, for example in a Zynq-7000.
66

7+
This project uses [OSVVM](https://github.com/OSVVM/OsvvmLibraries) as a verification framework.
8+
79
## Setup
810

9-
Install `ghdl`:
11+
Install `ghdl >= 3.0.0`:
1012

1113
```
12-
$> sudo apt install ghdl gtkwave
14+
$> sudo snap install ghdl
1315
```
1416

15-
## Run Test Benches
17+
Install dependencies for OSVVM:
18+
19+
```
20+
$> sudo apt install tcl tcllib rlwrap
21+
```
22+
23+
Setup submodules
1624

1725
```
18-
$> make
26+
$> git submodule update --init
1927
```
2028

21-
Alternatively - you can run individual tests:
29+
## Run Test Benches
2230

2331
```
24-
$> make TAP_Basic
32+
$> ./run_tests.tclsh
2533
```
2634

35+
This should run to completion and generate several files in the root directory:
36+
37+
1. `TAPController_RunTest.html` - This is the main browser viewable report.
38+
1. There will also be an `*.xml` and `*.yml` variant.
39+
2. `reports` - More test suite specific HTMl reports.
40+
3. `results` - Simulation run logs.
41+
4. `logs` - Build logs
42+
3. `VHDL_LIBS` - directory where the GHDL compiled libraries are kept.
43+
44+
2745
## Synthesis
2846

2947
@TODO - Xilinx Demo Project
48+
49+
3050
@TODO - Xilinx Synthesis Report & Resource Utilization.

0 commit comments

Comments
 (0)