[gpio] Clarify documentation of Darjeeling-only features
Nobody has claimed this yet.
- Dominant language
- SystemVerilog
- Stars
- 3.6k
- Forks
- 1.1k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 141
Description
Description
Some features (i.e. HW strap sampling, RACL) have been added to the now-templated GPIO IP as part of Darjeeling, but the documentation does not make it clear that they are not applicable to Earl Grey.
It would be good to correct this so that the Earl Grey GPIO documentation either does not refer to these features (i.e. remove using templating) or clarifies that they depend on a synthesis parameter.
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 from the Earl Grey GPIO documentation and locate the templated sections describing HW strap sampling and RACL. Check how the Darjeeling-only features are selected by the synthesis parameter; done when Earl Grey documentation omits them or clearly states their dependency.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100