Improve docs around AON timer #3187

2026-09-07T06:32:39-05:00

will-v-pi commented

2026-09-07 06:32:39 -05:00

(Migrated from github.com)

Improve low_power_start_aon_timer docs, and refer to them from low_power_dormant_for_ms and low_power_pstate_for_ms

Also mention that AON timer persists across most warm reboots on RP2350

Fixes #3180

Improve `low_power_start_aon_timer` docs, and refer to them from `low_power_dormant_for_ms` and `low_power_pstate_for_ms` Also mention that AON timer persists across most warm reboots on RP2350 Fixes #3180

peterharperuk (Migrated from github.com) reviewed

2026-09-07 06:32:39 -05:00

lurch (Migrated from github.com) reviewed

2026-09-07 06:45:03 -05:00

src/rp2_common/pico_low_power/include/pico/low_power.h

					
				@ -430,6 +434,9 @@ static inline int low_power_dormant_for_ms(uint32_t ms, dormant_clock_source_t d

				 *  \ingroup pico_low_power

				 *

				 * See \ref low_power_pstate_until_aon_timer for more information.

Based on the comments in the linked issue, should this also mention that the AON timer will also continue to run after wake-up? (i.e. even if it wasn't running before)

Based on the comments in the linked issue, should this also mention that the AON timer will also _continue_ to run after wake-up? (i.e. even if it wasn't running before)

will-v-pi (Migrated from github.com) reviewed

2026-09-07 06:47:53 -05:00

src/rp2_common/pico_low_power/include/pico/low_power.h

					
				@ -430,6 +434,9 @@ static inline int low_power_dormant_for_ms(uint32_t ms, dormant_clock_source_t d

				 *  \ingroup pico_low_power

				 *

				 * See \ref low_power_pstate_until_aon_timer for more information.

I don't think that's necessary - the low_power_start_aon_timer docs should make it clear that the timer is started, and this makes no mention of stopping it after

I don't think that's necessary - the `low_power_start_aon_timer` docs should make it clear that the timer is started, and this makes no mention of stopping it after

This pull request can be merged automatically.

You are not authorized to merge this pull request.

View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u origin 'aon-docs-fix:aon-docs-fix'

git switch 'aon-docs-fix'

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git switch 'develop'

git merge --no-ff 'aon-docs-fix'

git switch 'aon-docs-fix'

git rebase 'develop'

git switch 'develop'

git merge --ff-only 'aon-docs-fix'

git switch 'aon-docs-fix'

git rebase 'develop'

git switch 'develop'

git merge --no-ff 'aon-docs-fix'

git switch 'develop'

git merge --squash 'aon-docs-fix'