Skip to content

Update the watchdog timing requirements #1155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

fkjagodzinski
Copy link
Member

Update the requirements according to ARMmbed/mbed-os#11203, that differentiates lower timeout limit for calibrated and uncalibrated watchdog clock.

This should wait until ARMmbed/mbed-os#11203 is merged to Mbed OS repo.

Update the requirements according to PR #11203 that differentiates lower
timeout limit for calibrated and uncalibrated watchdog clock.
@@ -11,7 +11,8 @@ Implement the ResetReason API when implementing the Watchdog API. The ResetReaso
- Sleep and debug modes don't stop the watchdog timer from counting down.
- The function `hal_watchdog_init` is safe to call repeatedly. The function's implementation must not do anything if `hal_watchdog_init` has already initialized the hardware watchdog timer.
- `UINT32_MAX` milliseconds is the maximum allowed max_timeout `hal_watchdog_get_platform_features()` returns; minimum timeout is 1 ms.
- The watchdog should trigger at or after the timeout value.
- The uncalibrated watchdog should trigger at or after the timeout value multiplied by the frequency accuracy ratio of its oscillator (typical_frequency / max_frequency).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the slash represent division, or does it mean "or" here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Division; Do you think we should use the word instead of the symbol here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I think that would clarify here. I'll make that change.

Clarify slash, as discussed in comments.
Copy link
Contributor

@AnotherButler AnotherButler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR 👍

@AnotherButler
Copy link
Contributor

The code dependency has merged to master but has a future tag on it, so I'm waiting to merge it.

Allow the watchdog reset to be delayed up to twice the timeout value in
deepsleep mode according to #11774.
@fkjagodzinski
Copy link
Member Author

There is another update for the watchdog timing. This time only for the deepsleep mode (based on ARMmbed/mbed-os#11774).

Since this PR is waiting, I pushed changes here. @AnotherButler, I hope this is acceptable; please let me know if this should land on a new docs PR. I'll remove the last commit in that case.

Copy link
Contributor

@jamesbeyond jamesbeyond left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

Add space for consistent spelling.
@fkjagodzinski
Copy link
Member Author

ARMmbed/mbed-os#11773 has been merged into master.

@iriark01
Copy link
Contributor

Merging PR, as code was merged to master.

@iriark01 iriark01 merged commit 8ab645e into ARMmbed:development Nov 26, 2019
@fkjagodzinski fkjagodzinski deleted the docs_update-watchdog_clock branch November 26, 2019 12:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants