Skip to content

Commit fff70aa

Browse files
jayalpandreaskurth
jayalp
authored and
andreaskurth
committed
[doc] New page on membership
Addition of a new page on OpenTitan membership - Added a new graphic as part of the page - Edit to SUMMARY to add new page to book - Edit to "contributing" file to correct a link to CONTRIBUTING.md - Updated "temple" image to be vectorised Signed-off-by: Jay Alphey <[email protected]>
1 parent 7cb9804 commit fff70aa

File tree

4 files changed

+143
-2
lines changed

4 files changed

+143
-2
lines changed

‎SUMMARY.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
- [Governance and Policies](./doc/sections/governance.md)
1313

1414
- [Introduction](./doc/project_governance/README.md)
15+
- [Membership](./doc/project_governance/membership.md)
1516
- [Governing Board](./doc/project_governance/governing_board.md)
1617
- [Technical Committee](./doc/project_governance/technical_committee.md)
1718
- [Working Groups](./doc/project_governance/working_group.md)

‎doc/contributing/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Realistically, each piece of collateral in our repository is in a different stat
4242
See the [Hardware Development Stages](../project_governance/development_stages.md) for an example of how hardware progress is tracked.
4343

4444
We are happy to receive bug reports and eager to fix them.
45-
Please make reports by opening a new issue in the [GitHub issue tracker](https://github.com/lowRISC/opentitan/issues).
45+
Please make reports by opening a new issue in our [GitHub issue tracker](https://github.com/lowRISC/opentitan/issues).
4646

4747
## Contributing code
4848

@@ -79,7 +79,7 @@ For larger proposed changes we ask contributors to:
7979
and commits.
8080

8181
## License agreements
82-
The following information is detailed in the [CONTRIBUTING.md](../../CONTRIBUTING.md) file
82+
The following information is detailed in the [CONTRIBUTING.md](https://github.com/lowRISC/opentitan/blob/master/CONTRIBUTING.md) file
8383
* Contributor License agreement
8484
* Organisational Agreement
8585
* Use of Copyright messages

‎doc/images/ottemple.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎doc/project_governance/membership.md‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
# OpenTitan membership
2+
3+
OpenTitan is a collaborative hardware and software development program with contributors from many organizations.
4+
5+
If you are interested in joining the OpenTitan Project, please contact [email protected]
6+
7+
## Why join as a member?
8+
9+
Members have a range of benefits, including:
10+
- To contribute to, and influence the direction of the project
11+
- Early visibility into roadmaps and vulnerabilities
12+
- Marketing benefits and demonstrate leadership in security
13+
- Demonstrating compliance with the project/product - e.g. by using the trademark
14+
15+
**And helping ensure that the OpenTitan project has a strong future**
16+
17+
## Gold members
18+
19+
OpenTitan gold members are primarily organizations who are designing a security hardened chip integrating the whole of OpenTitan and/or want to have strong influence in the direction of the project.
20+
21+
**Key benefits:**
22+
- One seat on each of the [Governing Board](./governing_board.md) and [Technical Committee](./technical_committee.md) to steer roadmap and technical direction.
23+
- Use of [OpenTitan certification and trademark](./trademark.md).
24+
- Advance visibility of OpenTitan security issues ahead of fixes being implemented (subject to agreeing an additional NDA).
25+
- Ability to propose and/or work on new top-levels
26+
- Access to security hardening and trademark certification services from [lowRISC CIC](./lowRISC.md)
27+
28+
**Key Deliverables:**
29+
- Tapeout checklist
30+
31+
**[Member individual accounts](./useraccounts.md):**
32+
- Gold members are allowed up to 100 x individual accounts.
33+
34+
In addition Gold members gain all benefits available to Silver members
35+
36+
## Silver members
37+
38+
OpenTitan silver members are Organizations who want to integrate OpenTitan IP in their chips (rather than making hardened discrete chips based on Earl Grey), and do not feel the need to lead the direction of the project.
39+
40+
**Key benefits:**
41+
- One seat on the [Technical Committee](./technical_committee.md) to steer technical direction.
42+
- Access to agenda and minutes for the [Governing Board](./governing_board.md) and ability to propose topics.
43+
- Advanced visibility of the OpenTitan internal roadmaps
44+
- Ability to vote on roadmap and RFCs through [Technical Committee](./technical_committee.md) membership
45+
- Early access to major new features under development
46+
- Ability to have individuals function as [committers](./committers.md) once sufficient experience has been built.
47+
- Access to integration and certification services from [lowRISC CIC](./lowRISC.md)
48+
49+
**Key Deliverables:**
50+
- Settings for CDC/RDC, CWE checking and AI Agent tools
51+
- Integration documentation and tooling
52+
- Coverage gap analysis for latest release of each IP
53+
- Integration checklist
54+
- Pre-silicon FI verification
55+
- Information (from lowRISC) necessary for Common Criteria certification
56+
57+
**[Member individual accounts](./useraccounts.md):**
58+
- Silver members are allowed 10 x individual accounts and may purchase more.
59+
60+
In addition Silver members gain all benefits available to Bronze members
61+
62+
## Bronze members
63+
64+
OpenTitan bronze members are organisations who wish to support the project and enable members of their team to contribute.
65+
They may wish to use the IP in their devices, want to fix bugs or contribute IP to ensure future compatibility.
66+
67+
**Key Benefits:**
68+
- Members have their company logo on OpenTitan collateral and involvement in co-marketing
69+
- Employees are allowed to join [Working Groups](./working_group.md) to contribute to technical direction.
70+
- Membership allows individual employees to contribute
71+
72+
**Key Deliverables:**
73+
- Full test and coverage reports linked from the DV dashboard
74+
75+
**[Member individual accounts](./useraccounts.md)**
76+
- Bronze members are allowed 1 x individual account and may purchase more.
77+
78+
## Tools members
79+
80+
OpenTitan tools members are typically EDA tools organisations who wish to support reference designs for their tools.
81+
82+
**Key Benefits:**
83+
- Members have their company logo on OpenTitan collateral and involvement in co-marketing
84+
- Members' tools are integrated in the OpenTitan CI and regression testing flows.
85+
- Tools members are informed of results from regression testing, including any observed issues.
86+
87+
**[Member individual accounts](./useraccounts.md):**
88+
- Tools members are allowed 1 x individual account to address integration issues and may purchase more.
89+
90+
## Academic / NGO / Public Organization members
91+
92+
OpenTitan academic members are academic, NGO or public organisations who wish to be involved in OpenTitan for research or to promote the project.
93+
Flexible benefits to academic members can be negotiated with lowRISC depending on the expected contribution from the academic member.
94+
95+
**Key Benefits:**
96+
- Members have their company logo on OpenTitan collateral and involvement in co-marketing
97+
- Academic members are allowed to join [Working Groups](./working_group.md)
98+
- Academic members can contribute to technical direction.
99+
100+
**[Member individual accounts](./useraccounts.md):**
101+
- Academic members are allowed 5 x individual accounts and may purchase more.
102+
103+
## Individual collaborator
104+
105+
OpenTitan individual collaborators are individuals (e.g. academics) with rights to their own submissions.
106+
107+
Note that where individuals are working within organisations, these organisations should become members to ensure an [organisational contributor license](https://github.com/lowRISC/opentitan/blob/master/CONTRIBUTING.md) is available to cover IP rights.
108+
109+
**Key Benefits:**
110+
- Individual collaborators may contribute and join [Working Groups](./working_group.md) to contribute to technical direction.
111+
112+
## Summary
113+
114+
| Level | GB | TC | WG | Accounts | Key Benefits |
115+
| ----- | ---- | ---- | ---- | ----- | -------- |
116+
| Gold | 1 | 1 | Y | 100 | Steer roadmap and technical direction.<br>OpenTitan certification and trademark.<br>Advance visibility of security issues. |
117+
| Silver | | 1 | Y | 10 | Steer technical direction.<br>OpenTitan internal roadmaps.<br>Early access to new features.<br>Individuals as committers. |
118+
| Bronze | | | Y | 1 | Company logo on OpenTitan collateral.<br>Join Working Groups.<br>Contributor license. |
119+
120+
Membership benefits and deliverables are subject to change at the sole discretion of lowRISC CIC.
121+
122+
# How are membership fees used?
123+
124+
Member fees are used to fund work on OpenTitan.
125+
They ensure a strong foundation to the project.
126+
127+
![Applying membership fees](../images/ottemple.svg)
128+
129+
Member fees are applied in the priority shown below.
130+
The level of funding for later functions in the list depends on the funds available and the amount consumed by the critical items earlier in the list.
131+
132+
1. **Compliance and Governance** - Ensuring that the OpenTitan project is well run and compliant to legal requirements, and that all material is accurate, maintained and legal.
133+
Handling security vulnerabilities in OpenTitan-certified chips.
134+
2. **Infrastructure** - Purchasing, managing and maintaining the hardware and tools required to run OpenTitan.
135+
3. **Community** - Supporting the OpenTitan community, managing communication, running meetings, reviewing submitted code.
136+
4. **Quality** - Maintaining and improving the quality of the OpenTitan project, addressing newer tools versions, improving verification and reducing technical debt.
137+
Research into new threats and security mechanisms.
138+
5. **Visibility** - Increasing the visibility of OpenTitan and Open Source Silicon, publishing relevant papers, maintaining discussion and promoting the project at conferences.
139+
6. **Roadmap** - Progressing and supporting the OpenTitan roadmap

0 commit comments

Comments
 (0)