Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
luca-valente committed Nov 20, 2020
1 parent c1a6d9f commit be4a083
Showing 1 changed file with 36 additions and 5 deletions.
41 changes: 36 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,17 @@
This repository contains a set of test, implemented in C, that are used as regression tests in our CI flow. Indeed, these tests are performed any time a push is done in the pulp-open's branches and are intended to verify that the basic functionalities of Pulp have not been compromised by the changes. Through time, this repo will be ppulated by more and more specific tests, granted that they work with the current pulp implementation.

## Tests
You can run tests either locally in a manual fashion or use your GitLab CI
instance.
You can run tests either locally in a manual fashion or use your GitLab CI instance.

## Running software tests manually
Call the `./update-regression-tests` script in the pulp directory. This will populate this directory with all software tests.

To run the tests as they are the instructions are the following, from the pulp repo:
### To build Pulp
You have two options to run these tests, the first one is to test without the peripheral tests and the second one is to use them. The main difference is just the time the simulation will need: withouth the peripheral tests, there is no need to instantiate the Verification IPs, which are heavy and with tiny time steps (1ps).

### Option 1
If you chose the first option, please do the following, from the pulp repo:

#### To build Pulp
```
source setup/vsim.sh
Expand All @@ -22,7 +25,34 @@ cd sim
make all
```
### To run the tests
#### To run the tests
```
cd ..
source pulp-runtime/configs/pulp.sh
export PULP_RISCV_GCC_TOOLCHAIN= *path to riscv gcc toolchain*
make test-fast-regressions
```
### Option 2
If you chose the second option, you will have to download the VIPs in the `pulp/rtl/vip` folder, following the instruction in the relative READMEs. (You will not need the psram). And the you will have to do the following:


#### To build Pulp
```
source setup/vsim.sh
./update-ips
./generate-scripts --rt-dpi --i2c-vip --flash-vip --i2s-vip --hyper-vip --use-vip --verbose
cd sim
make all
```
#### To run the tests
```
cd ..
Expand All @@ -33,6 +63,7 @@ export PULP_RISCV_GCC_TOOLCHAIN= *path to riscv gcc toolchain*
make test-local-regressions
```


## Adding your own tests
You can add your own tests by putting them in a repository and adding them to
`update-tests` and `update-tests-gitlab` scripts in the top-level folder. Make
Expand Down

0 comments on commit be4a083

Please sign in to comment.