blob: b29f9efc1dc9f04b4a2b61b4dae5dfadeefb4d82 [file] [log] [blame] [view]
lowRISC Contributors802543a2019-08-31 12:12:56 +01001# Introduction to OpenTitan
2
Scott Johnson8573fa22019-11-01 14:49:56 -07003[OpenTitan](https://opentitan.org) is an open source silicon Root of Trust (RoT) project.
4OpenTitan will make the silicon RoT design and implementation more transparent, trustworthy, and secure for enterprises, platform providers, and chip manufacturers.
5OpenTitan 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 Contributors802543a2019-08-31 12:12:56 +01006This repository exists to enable collaboration across partners participating in the OpenTitan project.
7
8To get started using or contributing to the OpenTitan codebase, see the
Garret Kelly9eebde02019-10-22 15:36:49 -04009[list of user guides]({{< relref "doc/ug" >}}).
lowRISC Contributors802543a2019-08-31 12:12:56 +010010For details on coding styles or how to use our project-specific tooling, see the
Garret Kelly9eebde02019-10-22 15:36:49 -040011[reference manuals]({{< relref "doc/rm" >}}).
12[This page]({{< relref "hw" >}})
lowRISC Contributors802543a2019-08-31 12:12:56 +010013contains technical documentation on the SoC, the Ibex processor core, and the individual IP blocks.
Scott Johnson8573fa22019-11-01 14:49:56 -070014For questions about how the project is organized, see the [project]({{< relref "doc/project" >}}) landing spot for more information.
lowRISC Contributors802543a2019-08-31 12:12:56 +010015
lowRISC Contributors802543a2019-08-31 12:12:56 +010016## Repository Structure
17
18The underlying
19[repo](http://www.github.com/lowrisc/opentitan)
20is set up as a monolithic repository to contain RTL, helper scripts, technical documentation, and other software necessary to produce our hardware designs.
21
Alex Bradburyed7cc902019-11-05 11:29:48 +000022Unless 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 Contributors802543a2019-08-31 12:12:56 +010023
24## Documentation Sections
25
Scott Johnson8573fa22019-11-01 14:49:56 -070026* [Project]({{< relref "doc/project" >}})
lowRISC Contributors802543a2019-08-31 12:12:56 +010027 * How the OpenTitan project is organized
lowRISC Contributors802543a2019-08-31 12:12:56 +010028 * Progress tracking
Garret Kelly9eebde02019-10-22 15:36:49 -040029* [User Guides]({{< relref "doc/ug" >}})
lowRISC Contributors802543a2019-08-31 12:12:56 +010030 * How to get started with the repo
31 * How to emulate on an FPGA
Scott Johnson8573fa22019-11-01 14:49:56 -070032 * How hardware design is done in OpenTitan
lowRISC Contributors802543a2019-08-31 12:12:56 +010033 * How verification is done in OpenTitan
Garret Kelly9eebde02019-10-22 15:36:49 -040034* [Reference Manuals]({{< relref "doc/rm" >}})
lowRISC Contributors802543a2019-08-31 12:12:56 +010035 * Defining comportable IP peripherals
Scott Johnson8573fa22019-11-01 14:49:56 -070036 * Coding style guides for Verilog, Python, Hjson, C/C++ and Markdown
lowRISC Contributors802543a2019-08-31 12:12:56 +010037 * OpenTitan tools
Garret Kelly9eebde02019-10-22 15:36:49 -040038* [Hardware Specifications]({{< relref "hw" >}})
lowRISC Contributors802543a2019-08-31 12:12:56 +010039 * Top-level SoC
40 * Ibex processor core
41 * Comportable IP blocks
Garret Kelly9eebde02019-10-22 15:36:49 -040042* [Tools]({{< relref "util" >}})
Scott Johnson8573fa22019-11-01 14:49:56 -070043 * READMEs of OpenTitan tools