Add watchdog parameter-validation, and fix up misleading comments #1567
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JamesH65
reviewed
Dec 2, 2023
| @@ -34,6 +35,7 @@ uint32_t watchdog_get_count(void) { | |||
| // tag::watchdog_enable[] | |||
| // Helper function used by both watchdog_enable and watchdog_reboot | |||
| void _watchdog_enable(uint32_t delay_ms, bool pause_on_debug) { | |||
| valid_params_if(WATCHDOG, delay_ms <= 8388); // i.e. floor(0xffffff / 2000) | |||
There was a problem hiding this comment.
Magic number, although it is commented. Move to a define? Only a nit though.
There was a problem hiding this comment.
Could do, but I'm not sure if it's worth it when it only appears once in a debug-level assert?
| @@ -72,7 +77,7 @@ void watchdog_update(void); | |||
| * onto the RPI-RP2), then this value will be cleared, and so \ref watchdog_enable_caused_reboot will | |||
| * return false. | |||
| * | |||
| * \param delay_ms Number of milliseconds before watchdog will reboot without watchdog_update being called. Maximum of 0x7fffff, which is approximately 8.3 seconds | |||
| * \param delay_ms Number of milliseconds before watchdog will reboot without watchdog_update being called. Maximum of 8388, which is approximately 8.3 seconds | |||
There was a problem hiding this comment.
8.3 IIF the source clock is default?
| * | ||
| * By default the SDK assumes a 12MHz XOSC and sets the \ref watchdog_start_tick appropriately. | ||
| * | ||
| * \param pc If Zero, a standard boot will be performed, if non-zero this is the program counter to jump to on reset. | ||
| * \param sp If \p pc is non-zero, this will be the stack pointer used. | ||
| * \param delay_ms Initial load value. Maximum value 0x7fffff, approximately 8.3s. | ||
| * \param delay_ms Initial load value. Maximum value 8388, approximately 8.3s. |
There was a problem hiding this comment.
8.3 IIF the source clock is default?
There was a problem hiding this comment.
Well, you could argue that the \note If \ref watchdog_start_tick value does not give a 1MHz clock to the watchdog system, then the \p delay_ms parameter will not be in milliseconds. See the datasheet for more details. already covers that ? 🤷♂️
kilograham
approved these changes
Dec 15, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1238 and #1550 (and #1241 #1409 #1505 which are duplicates of #1238)