Skip to content

drivers/periph/timer: documentation and code style improvements#22377

Merged
crasbe merged 1 commit into
RIOT-OS:masterfrom
crasbe:pr/timer_doc
Jun 12, 2026
Merged

drivers/periph/timer: documentation and code style improvements#22377
crasbe merged 1 commit into
RIOT-OS:masterfrom
crasbe:pr/timer_doc

Conversation

@crasbe

@crasbe crasbe commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Contribution description

Just the usual stuff. The only noteworthy addition is the information that TIM_FLAG_RESET_ON_MATCH and TIM_FLAG_RESET_ON_SET reset 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 ERRNO return 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:

  • none

@crasbe crasbe requested a review from AnnsAnns June 12, 2026 09:46
@crasbe crasbe added the Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation label Jun 12, 2026
@crasbe crasbe requested a review from MrKevinWeiss as a code owner June 12, 2026 09:46
@crasbe crasbe added Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Jun 12, 2026
@github-actions github-actions Bot added the Area: drivers Area: Device drivers label Jun 12, 2026
@riot-ci

riot-ci commented Jun 12, 2026

Copy link
Copy Markdown

Murdock results

✔️ PASSED

fde0e14 drivers/periph/timer: documentation and code style improvements

Success Failures Total Runtime
11123 0 11124 10m:39s

Artifacts

Comment thread drivers/include/periph/timer.h

@kfessel kfessel left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍

Comment thread drivers/include/periph/timer.h
Comment thread drivers/include/periph/timer.h
@crasbe crasbe enabled auto-merge June 12, 2026 11:43
@crasbe crasbe added this pull request to the merge queue Jun 12, 2026
Merged via the queue into RIOT-OS:master with commit 2810aba Jun 12, 2026
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: drivers Area: Device drivers CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants