Skip to content

Commit cd0c35c

Browse files
committed
Adding documentation about how to run in PV, LT, and AT models
1 parent 86fcc0b commit cd0c35c

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

modules/filter/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,13 @@ Some additional options can used to debug and dump the waveform:
4242
* `IPS_DUMP_EN`: Creates a VCD file with each value of the window and kernel,
4343
and the result.
4444

45+
To compile a specific model, you can use the switches:
46+
47+
* `IPS_FILTER_PV_EN`: Programmer's View model.
48+
* `IPS_FILTER_LT_EN`: Loosely Timed model.
49+
* `IPS_FILTER_AT_EN`: Approximately Timed model.
50+
* `IPS_FILTER_CA_EN`: Cycle Approximate model (pending to be implemented).
51+
4552
### **Compilation**
4653
Runs the `make` command with the corresponding switches to compile.
4754

@@ -58,6 +65,9 @@ make run
5865
```
5966

6067
### **Open Waveform**
68+
69+
Since VCD is not generated, this command will not work for the PV model.
70+
6171
```shell
6272
make waveform
6373
```

0 commit comments

Comments
 (0)