[doc] Potential additions to comportability definition and specification
Nobody has claimed this yet.
- Dominant language
- SystemVerilog
- Stars
- 3.6k
- Forks
- 1.1k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 141
Description
### Description
The [OpenTitan comportability definition and specification](https://opentitan.org/book/doc/contributing/hw/comportability/index.html) covers many aspects of our hardware IP blocks and is the first source of inspiration when designing new hardware IP blocks.
However, the current version of the definition and specification doesn't touch on some other aspects that would be nice to align our IP blocks on. Most likely, we won't go back and change existing and very mature hardware blocks but it would be relevant to give some recommendation regarding these aspects to improve coherence of future designs.
Examples of such aspects include:
- [x] #7901
- [ ] #15473
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked OpenTitan comportability definition and specification, then review the completed item in #7901 and the outstanding work in #15473. Identify additional hardware-IP aspects that should be standardized and update the specification with recommendations for future designs.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, embedded-iot
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100