lowRISC / lowRISC/opentitan

[doc] document our primitives

Open
#10 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Component:Doc Earlgrey-PROD Triaged Priority:P2 Type:Enhancement
Dominant language
SystemVerilog
Stars
3.6k
Forks
1.1k
Avg merge
2d 22h
Merged PRs (30d)
141

Description

- [ ] add mention in Comportability the recommendation to follow utilization guides for existing IP primitives
- [ ] pointer to a yet-to-be-written technical specification for all primitives (see below)
- [ ] list requirements for primitives (RTL, lint, DV, etc)
- [ ] suggest the protocol to add a primitive to our library (rationale as to why existing ones are insufficient)
- [ ] create said technical specification for all primitives; goal: concise but thorough, with rationale;
- [ ] Question: one master doc, or one per? (leaning former)
- [ ] Question: place under hw/ip/prim/doc/prim.md? or hw/ip/prim/README.md?
- [ ] Sections, similar to other technical specifications: feature set, overview, block diagram, interfaces, current level of verification (mini D/V status), CDC implications (a bit redundant with hw/formal/README.md section on CDC that is coming), regtool recommendations, software recommendations

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing Comportability guidance and the referenced hw/formal/README.md section on CDC. Compare hw/ip/prim/doc/prim.md and hw/ip/prim/README.md as possible locations, then define whether the specification is master or per-primitive and cover the listed requirements, verification, interfaces, CDC, regtool, and software sections. Done means the checklist and open placement questions are resolved in concise primitive documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.