Skip to content

Commit 21c5a69

Browse files
author
Matthew Ballance
committed
Add primitive readme
Signed-off-by: Matthew Ballance <matt_ballance@mentor.com>
1 parent 972b9c8 commit 21c5a69

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,18 @@
11
# scvpi
2-
Provides a stub implementation of (System)Verilog VPI functions for SystemC
2+
Provides a stub implementation of (System)Verilog VPI functions for SystemC.
3+
Currently, this is just enough to allow cocotb to schedule coroutines.
4+
Access to signals, and other RTL-like things is not currently implemented. The purpose
5+
of this package is to enable running a Python testbench with high-level SystemC
6+
models.
7+
8+
9+
## Using scvpi
10+
11+
- Compile scvpi with your SystemC model
12+
- Add <scvpi>/src/scvpi.cpp to your SystemC files
13+
- Add <scvpi>/src as an include path
14+
15+
- Specify VPI libraries to load at runtime
16+
- Add +vpi=<path_to_so> to the SystemC command line
17+
18+

0 commit comments

Comments
 (0)