Hugo McNally | f6298b3 | 2023-02-12 14:47:22 +0000 | [diff] [blame] | 1 | # Introduction to the OpenTitan Project |
Scott Johnson | 8573fa2 | 2019-11-01 14:49:56 -0700 | [diff] [blame] | 2 | |
Alex Bradbury | 0c2e362 | 2019-11-04 23:58:53 +0000 | [diff] [blame] | 3 | OpenTitan is a collaborative hardware and software development program with contributors from many organizations. |
Alex Bradbury | e04db85 | 2020-10-15 13:37:16 +0100 | [diff] [blame] | 4 | This area gives some more information about how the project itself is organized and how to contribute. |
Scott Johnson | 8573fa2 | 2019-11-01 14:49:56 -0700 | [diff] [blame] | 5 | More information will be added over time. |
| 6 | |
| 7 | ## Quality standards for open hardware IP |
| 8 | |
Hugo McNally | aef0a66 | 2023-02-11 19:44:55 +0000 | [diff] [blame] | 9 | In order to gauge the quality of the different IP that is in our repository, we define a series of [Hardware Development Stages](./development_stages.md) to track the designs. |
| 10 | The current status of different IP is reflected in the [Hardware Dashboard](../../hw/README.md). |
Scott Johnson | 8573fa2 | 2019-11-01 14:49:56 -0700 | [diff] [blame] | 11 | The final state for developed IP is *Signed Off*, indicating that design and verification is complete, and the IP should be bug free. |
Hugo McNally | aef0a66 | 2023-02-11 19:44:55 +0000 | [diff] [blame] | 12 | To make it to that stage, a [Hardware Signoff Checklist](./checklist/README.md) is used to confirm completion. |
Sam Elliott | c032182 | 2020-06-05 15:29:38 +0100 | [diff] [blame] | 13 | [Here](https://github.com/lowRISC/opentitan/blob/master/util/uvmdvgen/checklist.md.tpl) is a template that can be used as a checklist item. |
Scott Johnson | 8573fa2 | 2019-11-01 14:49:56 -0700 | [diff] [blame] | 14 | |
Alex Bradbury | e04db85 | 2020-10-15 13:37:16 +0100 | [diff] [blame] | 15 | ## Contributing |
| 16 | |
Hugo McNally | aef0a66 | 2023-02-11 19:44:55 +0000 | [diff] [blame] | 17 | See our documentation on [Contributing to OpenTitan](../contributing/README.md) (and the more in-depth [Detailed Contribution Guide](../contributing/detailed_contribution_guide/README.md)) for general guidance on how we work, making bug reports, dealing with security issues, and contributing code. |
Alex Bradbury | e04db85 | 2020-10-15 13:37:16 +0100 | [diff] [blame] | 18 | |
Alex Bradbury | 0c2e362 | 2019-11-04 23:58:53 +0000 | [diff] [blame] | 19 | ## Governance |
| 20 | |
| 21 | OpenTitan is stewarded by lowRISC CIC, a not-for-profit company that uses collaborative engineering to develop and maintain open source silicon designs and tools for the long term. |
| 22 | As a lowRISC CIC Chartered Project, OpenTitan governance is handled via lowRISC's default Technical Charter. |
| 23 | |
| 24 | As described in full detail in the [OpenTitan Technical Charter](https://static.opentitan.org/technical-charter.pdf), our governance structure consists of: |
Scott Johnson | 4e35384 | 2020-01-17 17:14:35 -0800 | [diff] [blame] | 25 | * The Project Director, Dominic Rizzo, who is a representative of the lowRISC CIC's Board of Directors within the Steering Committee. |
Alex Bradbury | 0c2e362 | 2019-11-04 23:58:53 +0000 | [diff] [blame] | 26 | * The Steering Committee, responsible for project oversight and agreeing the technical roadmap. |
Hugo McNally | aef0a66 | 2023-02-11 19:44:55 +0000 | [diff] [blame] | 27 | * The [Technical Committee](./technical_committee.md), responsible for technical decision making required to implement the technical roadmap. |
Alex Bradbury | 0c2e362 | 2019-11-04 23:58:53 +0000 | [diff] [blame] | 28 | |
Scott Johnson | 8573fa2 | 2019-11-01 14:49:56 -0700 | [diff] [blame] | 29 | ## Initiating new development |
| 30 | |
Hugo McNally | aef0a66 | 2023-02-11 19:44:55 +0000 | [diff] [blame] | 31 | The [OpenTitan RFC process](./rfc_process.md) guides developers on how to initiate new development within the program. |
Alex Bradbury | b5f8e7f | 2019-11-04 23:01:28 +0000 | [diff] [blame] | 32 | |
| 33 | ## Committers |
| 34 | |
| 35 | Committers are individuals with repository write access. |
| 36 | Everyone is able and encouraged to contribute and to help with code review, but committers are responsible for the final approval and merge of contributions. |
Hugo McNally | aef0a66 | 2023-02-11 19:44:55 +0000 | [diff] [blame] | 37 | See the [Committers](./committers.md) definition and role description for more information. |