[doc] flash_ctrl does not document certain fields
Nobody has claimed this yet.
- Dominant language
- SystemVerilog
- Stars
- 3.6k
- Forks
- 1.1k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 141
Description
### Description
Many values in the [flash_ctrl registers](https://opentitan.org/book/hw/ip/flash_ctrl/doc/registers.html) are in fact mubi values but this is not documented as such. `[MP_REGION_CFG](https://opentitan.org/book/hw/ip/flash_ctrl/doc/registers.html#mp_region_cfg)` is one example out of many. Furthermore, it is not documented what happens for invalid values. For example if `SCRAMBLE_EN` is 0, is scrambling enabled or disabled? (seems to disable)
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 flash_ctrl registers documentation, especially MP_REGION_CFG and the SCRAMBLE_EN field. Review the other register values for mubi encoding and document how invalid values are handled, including whether an invalid SCRAMBLE_EN value enables or disables scrambling. Done means the affected fields and invalid-value behavior are explicitly described.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, embedded-iot
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100