blob: 5c0ac231d21e4a66e55f025b167f4a629105a0a2 [file] [log] [blame] [view]
Hugo McNallyf6298b32023-02-12 14:47:22 +00001# Introduction to the OpenTitan Project
Scott Johnson8573fa22019-11-01 14:49:56 -07002
Alex Bradbury0c2e3622019-11-04 23:58:53 +00003OpenTitan is a collaborative hardware and software development program with contributors from many organizations.
Alex Bradburye04db852020-10-15 13:37:16 +01004This area gives some more information about how the project itself is organized and how to contribute.
Scott Johnson8573fa22019-11-01 14:49:56 -07005More information will be added over time.
6
7## Quality standards for open hardware IP
8
Hugo McNallyaef0a662023-02-11 19:44:55 +00009In 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.
10The current status of different IP is reflected in the [Hardware Dashboard](../../hw/README.md).
Scott Johnson8573fa22019-11-01 14:49:56 -070011The final state for developed IP is *Signed Off*, indicating that design and verification is complete, and the IP should be bug free.
Hugo McNallyaef0a662023-02-11 19:44:55 +000012To make it to that stage, a [Hardware Signoff Checklist](./checklist/README.md) is used to confirm completion.
Sam Elliottc0321822020-06-05 15:29:38 +010013[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 Johnson8573fa22019-11-01 14:49:56 -070014
Alex Bradburye04db852020-10-15 13:37:16 +010015## Contributing
16
Hugo McNallyaef0a662023-02-11 19:44:55 +000017See 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 Bradburye04db852020-10-15 13:37:16 +010018
Alex Bradbury0c2e3622019-11-04 23:58:53 +000019## Governance
20
21OpenTitan 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.
22As a lowRISC CIC Chartered Project, OpenTitan governance is handled via lowRISC's default Technical Charter.
23
24As described in full detail in the [OpenTitan Technical Charter](https://static.opentitan.org/technical-charter.pdf), our governance structure consists of:
Scott Johnson4e353842020-01-17 17:14:35 -080025* The Project Director, Dominic Rizzo, who is a representative of the lowRISC CIC's Board of Directors within the Steering Committee.
Alex Bradbury0c2e3622019-11-04 23:58:53 +000026* The Steering Committee, responsible for project oversight and agreeing the technical roadmap.
Hugo McNallyaef0a662023-02-11 19:44:55 +000027* The [Technical Committee](./technical_committee.md), responsible for technical decision making required to implement the technical roadmap.
Alex Bradbury0c2e3622019-11-04 23:58:53 +000028
Scott Johnson8573fa22019-11-01 14:49:56 -070029## Initiating new development
30
Hugo McNallyaef0a662023-02-11 19:44:55 +000031The [OpenTitan RFC process](./rfc_process.md) guides developers on how to initiate new development within the program.
Alex Bradburyb5f8e7f2019-11-04 23:01:28 +000032
33## Committers
34
35Committers are individuals with repository write access.
36Everyone 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 McNallyaef0a662023-02-11 19:44:55 +000037See the [Committers](./committers.md) definition and role description for more information.