| lowRISC Contributors | 802543a | 2019-08-31 12:12:56 +0100 | [diff] [blame] | 1 | # Introduction to OpenTitan |
| 2 | |
| Scott Johnson | 8573fa2 | 2019-11-01 14:49:56 -0700 | [diff] [blame] | 3 | [OpenTitan](https://opentitan.org) is an open source silicon Root of Trust (RoT) project. |
| 4 | OpenTitan will make the silicon RoT design and implementation more transparent, trustworthy, and secure for enterprises, platform providers, and chip manufacturers. |
| 5 | 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] | 6 | This repository exists to enable collaboration across partners participating in the OpenTitan project. |
| 7 | |
| 8 | To get started using or contributing to the OpenTitan codebase, see the |
| Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 9 | [list of user guides]({{< relref "doc/ug" >}}). |
| lowRISC Contributors | 802543a | 2019-08-31 12:12:56 +0100 | [diff] [blame] | 10 | For details on coding styles or how to use our project-specific tooling, see the |
| Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 11 | [reference manuals]({{< relref "doc/rm" >}}). |
| 12 | [This page]({{< relref "hw" >}}) |
| lowRISC Contributors | 802543a | 2019-08-31 12:12:56 +0100 | [diff] [blame] | 13 | 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] | 14 | 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] | 15 | |
| lowRISC Contributors | 802543a | 2019-08-31 12:12:56 +0100 | [diff] [blame] | 16 | ## Repository Structure |
| 17 | |
| 18 | The underlying |
| 19 | [repo](http://www.github.com/lowrisc/opentitan) |
| 20 | is set up as a monolithic repository to contain RTL, helper scripts, technical documentation, and other software necessary to produce our hardware designs. |
| 21 | |
| Alex Bradbury | ed7cc90 | 2019-11-05 11:29:48 +0000 | [diff] [blame] | 22 | 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. |
| lowRISC Contributors | 802543a | 2019-08-31 12:12:56 +0100 | [diff] [blame] | 23 | |
| 24 | ## Documentation Sections |
| 25 | |
| Tobias Wölfel | 834975a | 2020-02-26 12:43:46 +0100 | [diff] [blame] | 26 | * [General]({{< relref "doc" >}}) |
| 27 | * Project |
| 28 | * User Guides |
| 29 | * Reference Manuals |
| 30 | * Security |
| Srikrishna Iyer | d1f896e | 2020-03-05 13:52:40 -0800 | [diff] [blame] | 31 | * [Hardware Dashboard]({{< relref "hw" >}}) |
| 32 | * Design specifications |
| 33 | * Verification plans |
| 34 | * Results of tool-flows |
| 35 | * Comportable IPs |
| 36 | * Processor cores |
| 37 | * Top level designs |
| Tobias Wölfel | 03d1cf3 | 2020-02-26 12:47:07 +0100 | [diff] [blame] | 38 | * [Software]({{< relref "sw" >}}) |
| 39 | * READMEs of OpenTitan software |
| Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 40 | * [Tools]({{< relref "util" >}}) |
| Scott Johnson | 8573fa2 | 2019-11-01 14:49:56 -0700 | [diff] [blame] | 41 | * READMEs of OpenTitan tools |
