lowRISC / lowRISC/opentitan

[doc] AON Timer wdog bite reset missing sw initialization documentation

Open
#18,513 1 comment 0 reactions 0 assignees View on GitHub
Earlgrey-PROD Candidate
Dominant language
SystemVerilog
Stars
3.6k
Forks
1.1k
Avg merge
2d 22h
Merged PRs (30d)
141

Description

### Description

To enable the AON Timer watchdog bite reset functionality, it seems that some additional configuration is needed to be performed by SW in the pwrmgr. The steps were found from the AON timer bark/bite test:
1. Write 1 to the watchdog reset bit in pwrmgr.[RESET_EN](https://opentitan.org/book/hw/top_earlgrey/ip/pwrmgr/data/autogen/pwrmgr.html#reset_en) (looking at the test for earlgrey, it uses bit 1)
2. Write 1 to the pwrmgr.[CFG_CDC_SYNC](https://opentitan.org/book/hw/top_earlgrey/ip/pwrmgr/data/autogen/pwrmgr.html#cfg_cdc_sync) register
3. Poll the pwrmgr.CFG_CDC_SYNC until reading 0.

These steps are not documented in the watchdog programmer's guide, nor are they documented in the pwrmgr. Unless I am missing something, without this configuration sequence the watchdog bite will not reset the system even when enabled. Please make a note of this in the AON timer documentation.

Issue was tested on Verilator simulation.

Contributor guide

Open the contributing guide

Research direction

Start with the AON timer watchdog programmer's guide and pwrmgr documentation, then compare them with the AON timer bark/bite test. Document the RESET_EN and CFG_CDC_SYNC writes and polling sequence; done when the required bite-reset initialization is explicit in the AON timer documentation.

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
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.