[clkmgr] update clockmanager documentation for Mocha
Nobody has claimed this yet.
- Dominant language
- SystemVerilog
- Stars
- 38
- Forks
- 21
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 14
Description
Currently, all the clkmgr documentation referencing the EarlGray configuration. However, there are considerable differences between Mocha's configuration and that of EarlGray. Update the documentation in hw/top_chip/ip_autogen/clkmgr/doc/theory_of_operation.md and hw/top_chip/ip_autogen/clkmgr/README.md to reflect the design of Mocha.
Contributor guide
No contributing guide indexed for this repository
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 hw/top_chip/ip_autogen/clkmgr/doc/theory_of_operation.md and hw/top_chip/ip_autogen/clkmgr/README.md, noting each reference to the EarlGray configuration. Compare those descriptions with the Mocha clock-manager design, then update both documents so they accurately describe Mocha rather than EarlGray.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, embedded-iot
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100