| Hugo McNally | f6298b3 | 2023-02-12 14:47:22 +0000 | [diff] [blame] | 1 | # Reference Manuals |
| Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 2 | |
| Hugo McNally | aef0a66 | 2023-02-11 19:44:55 +0000 | [diff] [blame] | 3 | * [Comportability Definition and Specification](../doc/contributing/hw/comportability/README.md) |
| 4 | * [Device Interface Function (DIF) Specification](../doc/contributing/sw/device_interface_functions.md) |
| Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 5 | * Tool Guides |
| Hugo McNally | aef0a66 | 2023-02-11 19:44:55 +0000 | [diff] [blame] | 6 | * [Topgen Tool](./topgen/README.md): Describes `topgen.py` and its Hjson format source. Used to generate rtl and validation files for top specific modules such as PLIC, Pinmux and crossbar. |
| 7 | * [Register Tool](./reggen/README.md): Describes `regtool.py` and its Hjson format source. Used to generate documentation, rtl, header files and validation files for IP Registers and toplevel. |
| 8 | * [Ipgen Tool](./ipgen/README.md): Describes `ipgen.py` and its Hjson control file. Used to generate IP blocks from IP templates. |
| 9 | * [Crossbar Tool](./tlgen/README.md): Describes `tlgen.py` and its Hjson format source. Used to generate self-documentation, rtl files of the crossbars at the toplevel. |
| 10 | * [Vendor-In Tool](./doc/vendor.md): Describes `util/vendor.py` and its Hjson control file. Used to pull a local copy of code maintained in other upstream repositories and apply local patch sets. |
| 11 | * [FPGA Reference Manual](../doc/contributing/fpga/ref_manual_fpga.md) |
| Hugo McNally | 544e7a6 | 2023-02-12 01:12:36 +0000 | [diff] [blame] | 12 | * [OpenTitan Continuous Integration](../doc/contributing/ci/README.md) |
