[doc,alert_handler] Need program guide for alert_hander_config
Nobody has claimed this yet.
- Dominant language
- SystemVerilog
- Stars
- 3.6k
- Forks
- 1.1k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 141
Description
As for other highly configurable IPs, alert_hander also has countless choice of configuration.
It would be helpful if we can introduce a few configuration profiles.
e.g.
[Using this as one config profile or subset of config profile](https://cs.opensource.google/opentitan/opentitan/+/master:sw/device/tests/sim_dv/all_escalation_resets_test.c;drc=cc31840bc26892d7be406972aa1868853d8e6660;l=652)
And add more clarity to what each value really mean.
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 sw/device/tests/sim_dv/all_escalation_resets_test.c, especially the configuration example linked in the issue, and inspect the alert_hander_config usage around it. Document a few configuration profiles or subsets and explain what each value means; done means the guide provides clear, usable profiles for the alert_hander configuration.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100