Repository navigation
drivers/periph/timer: documentation and code style improvements - #22377
Merged
Merged
Conversation
crasbe
added
the
Type: enhancement
crasbe
added
Impact: minor
kfessel
reviewed
Jun 12, 2026
kfessel
approved these changes
Jun 12, 2026
This file contains hidden or 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
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.
Contribution description
Just the usual stuff. The only noteworthy addition is the information that
TIM_FLAG_RESET_ON_MATCHandTIM_FLAG_RESET_ON_SETreset the counter to zero. That was unclear which is why I looked at the code and decided to add this piece of information.Also, since the RP2350 timer implementation uses
ERRNOreturn values, I adapted the return value information for the timer functions and added a note that some functions can, but not necessarily will return ERRNOs on error.Testing procedure
Look at the docs 👀
Issues/PRs references
Noticed while reviewing #22375.
Declaration of AI-Tools / LLMs usage:
AI-Tools / LLMs that were used are: