| Scott Johnson | 3c254ef | 2019-11-01 17:36:40 -0700 | [diff] [blame] | 1 | --- |
| 2 | title: "OpenTitan Utilities" |
| 3 | --- |
| Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 4 | |
| Scott Johnson | 3c254ef | 2019-11-01 17:36:40 -0700 | [diff] [blame] | 5 | This is the landing spot for utility script documentation within the OpenTitan project. |
| 6 | Primarily these are README files about tooling scripts used to generate technical content. |
| 7 | More description and information can be found within the [Reference Manual]({{< relref "doc/rm" >}}) and [User Guide]({{< relref "doc/ug" >}}) areas. |
| Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 8 | |
| Scott Johnson | 3c254ef | 2019-11-01 17:36:40 -0700 | [diff] [blame] | 9 | ## Utility READMEs |
| 10 | |
| 11 | * Docker Container [README]({{< relref "util/container/README.md" >}}) |
| 12 | * FPGA splice utility [README]({{< relref "util/fpga/README.md" >}}) |
| 13 | * `reggen.py` register generator tool [README]({{< relref "util/reggen/README.md" >}}) |
| 14 | * `spitest.py` script for interacting with SPI device code [README]({{< relref "util/simplespi/README.md" >}}) |
| Udi Jonnalagadda | df49fb8 | 2020-03-17 11:05:17 -0700 | [diff] [blame] | 15 | * `testplanner.py` utility for generating verification testplans from Hjson descriptors [README]({{< relref "util/dvsim/testplanner/README.md" >}}) |
| Scott Johnson | 3c254ef | 2019-11-01 17:36:40 -0700 | [diff] [blame] | 16 | * `tlgen.py` utility for TileLink bus matrix [README]({{< relref "util/tlgen/README.md" >}}) |
| 17 | * `uvmdvgen.py` utility for generating testbenches for comportable IP [README]({{< relref "util/uvmdvgen/README.md" >}}) |
| Michael Schaffner | b5a88f2 | 2019-11-26 19:43:37 -0800 | [diff] [blame] | 18 | * `fpvgen.py` utility for generating FPV testbenches for comportable IP [README]({{< relref "util/fpvgen/README.md" >}}) |
| Scott Johnson | 3c254ef | 2019-11-01 17:36:40 -0700 | [diff] [blame] | 19 | * `wavegen.py` utility for creating technical waveforms in documentation [README]({{< relref "util/wavegen/README.md" >}}) |
