| Tobias Wölfel | 8d8921e | 2020-05-12 10:32:19 +0200 | [diff] [blame] | 1 | --- |
| Miguel Osorio | 44882ad | 2022-07-21 20:04:39 -0700 | [diff] [blame] | 2 | title: "OpenTitan" |
| Tobias Wölfel | 8d8921e | 2020-05-12 10:32:19 +0200 | [diff] [blame] | 3 | --- |
| lowRISC Contributors | 802543a | 2019-08-31 12:12:56 +0100 | [diff] [blame] | 4 | |
| Miguel Osorio | 44882ad | 2022-07-21 20:04:39 -0700 | [diff] [blame] | 5 | ## Introduction to OpenTitan |
| 6 | |
| Scott Johnson | 8573fa2 | 2019-11-01 14:49:56 -0700 | [diff] [blame] | 7 | [OpenTitan](https://opentitan.org) is an open source silicon Root of Trust (RoT) project. |
| 8 | OpenTitan will make the silicon RoT design and implementation more transparent, trustworthy, and secure for enterprises, platform providers, and chip manufacturers. |
| 9 | OpenTitan is administered by lowRISC CIC as a collaborative [project]({{< relref "doc/project" >}}) to produce high quality, open IP for instantiation as a full-featured product. |
| lowRISC Contributors | 802543a | 2019-08-31 12:12:56 +0100 | [diff] [blame] | 10 | This repository exists to enable collaboration across partners participating in the OpenTitan project. |
| 11 | |
| Timothy Trippel | 92bbc7b | 2021-07-12 22:59:01 +0000 | [diff] [blame] | 12 | ## Getting Started |
| 13 | |
| Jade Philipoom | 35f1fdb | 2022-03-21 22:42:34 +0000 | [diff] [blame] | 14 | To get started with OpenTitan, see the [Getting Started]({{< relref "doc/getting_started" >}}) page. |
| Timothy Trippel | 92bbc7b | 2021-07-12 22:59:01 +0000 | [diff] [blame] | 15 | For additional resources when working with OpenTitan, see the [list of user guides]({{< relref "doc/ug" >}}). |
| 16 | For details on coding styles or how to use our project-specific tooling, see the [reference manuals]({{< relref "doc/rm" >}}). |
| 17 | Lastly, the [Hardware Dashboard page]({{< relref "hw" >}}) contains technical documentation on the SoC, the Ibex processor core, and the individual IP blocks. |
| Scott Johnson | 8573fa2 | 2019-11-01 14:49:56 -0700 | [diff] [blame] | 18 | For questions about how the project is organized, see the [project]({{< relref "doc/project" >}}) landing spot for more information. |
| lowRISC Contributors | 802543a | 2019-08-31 12:12:56 +0100 | [diff] [blame] | 19 | |
| Miguel Osorio | c9a29a1 | 2022-08-11 15:54:43 -0700 | [diff] [blame] | 20 | ## Understaning OpenTitan |
| 21 | |
| 22 | * [Use Cases]({{< relref "doc/use_cases" >}}) |
| Miguel Osorio | ee10086 | 2022-09-07 17:31:52 -0700 | [diff] [blame] | 23 | * [Threat Model]({{< relref "doc/security/threat_model" >}}) |
| Miguel Osorio | c9a29a1 | 2022-08-11 15:54:43 -0700 | [diff] [blame] | 24 | * [Security]({{< relref "doc/security" >}}) |
| 25 | |
| 26 | ## Datasheets |
| 27 | |
| 28 | * [OpenTitan Earl Grey Chip Datasheet]({{< relref "hw/top_earlgrey/doc" >}}) |
| 29 | |
| 30 | ## Documentation |
| 31 | |
| 32 | * [Hardware]({{< relref "hw" >}}) |
| 33 | * [Software]({{< relref "sw" >}}) |
| 34 | |
| 35 | ## Development |
| 36 | |
| 37 | * [Getting Started]({{< relref "doc/getting_started" >}}) |
| 38 | * [User Guides]({{< relref "doc/ug" >}}) |
| 39 | * [Reference Manuals]({{< relref "doc/rm" >}}) |
| 40 | * [Style Guides]({{< relref "doc/sg" >}}) |
| 41 | |
| lowRISC Contributors | 802543a | 2019-08-31 12:12:56 +0100 | [diff] [blame] | 42 | ## Repository Structure |
| 43 | |
| 44 | The underlying |
| 45 | [repo](http://www.github.com/lowrisc/opentitan) |
| 46 | is set up as a monolithic repository to contain RTL, helper scripts, technical documentation, and other software necessary to produce our hardware designs. |
| 47 | |
| Alex Bradbury | ed7cc90 | 2019-11-05 11:29:48 +0000 | [diff] [blame] | 48 | Unless otherwise noted, everything in the repository is covered by the Apache License, Version 2.0. See the [LICENSE](https://github.com/lowRISC/opentitan/blob/master/LICENSE) file and [repository README](https://github.com/lowRISC/opentitan/blob/master/README.md) for more information on licensing and see the user guides below for more information on development methodology. |
