Skip to content

drivers/periph/timer: add note about TIM_FLAG_RESET_ON_MATCH #14619

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jul 28, 2020
Merged

drivers/periph/timer: add note about TIM_FLAG_RESET_ON_MATCH #14619

merged 1 commit into from
Jul 28, 2020

Conversation

benpicco
Copy link
Contributor

@benpicco benpicco commented Jul 27, 2020 •
edited by maribu
Loading

Contribution description

This extends the documentation of timer_set_periodic() by clarifying that only one channel with TIM_FLAG_RESET_ON_MATCH can be active.
(Which also makes logical sense, the timer will reset when this channel matches, so no other channel match will be executed as long as this channel is enabled.)

Testing procedure

Issues/PRs references

#14391 (comment)

@benpicco benpicco added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Area: doc Area: Documentation Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer labels Jul 27, 2020
@benpicco benpicco requested a review from maribu July 27, 2020 15:19
@benpicco benpicco requested a review from MrKevinWeiss as a code owner July 27, 2020 15:19
@maribu maribu added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels Jul 27, 2020
@maribu
Copy link
Member

maribu commented Jul 27, 2020

While this is formally an API change, it only updates the documentation to the implementation reality.

maribu
maribu approved these changes Jul 27, 2020
View reviewed changes
Copy link
Member

@maribu maribu left a comment

Choose a reason for hiding this comment

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

ACK

@maribu maribu merged commit 76102ed into RIOT-OS:master Jul 28, 2020
@maribu maribu mentioned this pull request Jul 28, 2020
Merged
@benpicco benpicco deleted the drivers/include/periph/timer-note branch July 28, 2020 07:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maribu maribu maribu approved these changes

@MrKevinWeiss MrKevinWeiss Awaiting requested review from MrKevinWeiss MrKevinWeiss is a code owner

Assignees
No one assigned
Labels
Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs 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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@benpicco @maribu