| Tobias Wölfel | 03d1cf3 | 2020-02-26 12:47:07 +0100 | [diff] [blame] | 1 | --- |
| 2 | title: "OpenTitan Software" |
| 3 | --- |
| 4 | |
| 5 | This is the landing spot for software documentation within the OpenTitan project. |
| Tobias Wölfel | 03d1cf3 | 2020-02-26 12:47:07 +0100 | [diff] [blame] | 6 | More description and information can be found within the [Reference Manual]({{< relref "doc/rm" >}}) and [User Guide]({{< relref "doc/ug" >}}) areas. |
| 7 | |
| Sam Elliott | b6745d3 | 2020-04-08 21:46:28 +0100 | [diff] [blame] | 8 | There are two major parts to the OpenTitan software stack: |
| 9 | |
| 10 | * The _device_ software, which runs on the OpenTitan platform. |
| 11 | * The _host_ software, which is run on a host device and interacts with an OpenTitan device. |
| 12 | |
| 13 | ## OpenTitan Software API Documentation |
| 14 | |
| 15 | The [OpenTitan Software API Documentation](/sw/apis/) contains automatically generated documentation for the public software APIs. |
| 16 | This includes the Device Interface Functions (DIFs). |
| 17 | |
| 18 | All DIFs are also documented on their respective [Hardware IP Specification]({{< relref "hw" >}}) |
| 19 | |
| Tobias Wölfel | 03d1cf3 | 2020-02-26 12:47:07 +0100 | [diff] [blame] | 20 | ## Software READMEs |
| 21 | |
| Tobias Wölfel | a47a415 | 2020-06-02 20:35:28 +0200 | [diff] [blame] | 22 | {{% sectionContent %}} |
| 23 | |
| 24 | ## Vendor in code see [HW vendor User Guide]({{< relref "doc/ug/vendor_hw.md" >}}) |
| 25 | |
| 26 | * [CoreMark](https://github.com/eembc/coremark) |
| 27 | * [RISC-V Compliance](https://github.com/riscv/riscv-compliance) |
| 28 | * [Google Test](https://github.com/google/googletest) |
| 29 | * [Cryptoc](https://chromium.googlesource.com/chromiumos/third_party/cryptoc/) |
