| Tobias Wölfel | 8d8921e | 2020-05-12 10:32:19 +0200 | [diff] [blame] | 1 | --- |
| 2 | title: "Reference Manuals" |
| 3 | --- |
| Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 4 | |
| 5 | * [Comportability Definition and Specification]({{< relref "comportability_specification" >}}) |
| Sam Elliott | b988cbc | 2020-04-20 19:56:54 +0100 | [diff] [blame] | 6 | * [Device Interface Function (DIF) Specification]({{< relref "device_interface_functions" >}}) |
| Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 7 | * Tool Guides |
| Timothy Chen | 4bdc6f7 | 2019-10-31 15:44:45 -0700 | [diff] [blame] | 8 | * [Topgen Tool]({{< relref "topgen_tool" >}}): 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. |
| Eunchan Kim | c8e630f | 2019-10-31 11:59:17 -0700 | [diff] [blame] | 9 | * [Register Tool]({{< relref "register_tool" >}}): Describes `regtool.py` and its Hjson format source. Used to generate documentation, rtl, header files and validation files for IP Registers and toplevel. |
| 10 | * [Crossbar Tool]({{< relref "crossbar_tool" >}}): Describes `tlgen.py` and its Hjson format source. Used to generate self-documentation, rtl files of the crossbars at the toplevel. |
| Miguel Osorio | ba17f11 | 2019-11-15 12:30:14 -0800 | [diff] [blame] | 11 | * [Vendor-In Tool]({{< relref "vendor_in_tool" >}}): 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. |
| Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 12 | * Coding Style Guides |
| 13 | * [Verilog Coding Style](https://github.com/lowRISC/style-guides/blob/master/VerilogCodingStyle.md) |
| 14 | * [Python Coding Style]({{< relref "python_coding_style.md" >}}) |
| 15 | * [Hjson Usage and Style Guide]({{< relref "hjson_usage_style.md" >}}) |
| 16 | * [Markdown Usage and Style Guide]({{< relref "markdown_usage_style.md" >}}) |
| 17 | * [C/C++ Style Guide]({{< relref "c_cpp_coding_style.md" >}}) |
| Miguel Young de la Sota | 6d335d7 | 2019-11-07 13:55:02 -0600 | [diff] [blame] | 18 | * [RISC-V Assembly Style Guide]({{< relref "asm_coding_style.md" >}}) |
| Michael Schaffner | b23eccd | 2019-11-07 11:34:27 -0800 | [diff] [blame] | 19 | * [FPGA Reference Manual]({{< relref "ref_manual_fpga.md" >}}) |
