Rename dma::SingleChannel::listen_irq* to enable_irq*
#648
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
My motivation for this change is that the first time I encountered the `listen_irq*` methods, the name invoked a misleading picture in my mind: `channel.listen_irq0()` sounds like the channel is "listening" for the IRQ, and will do something once it triggers. That's not the case though: calling this method will cause the channel to *trigger* the interrupt -- some other part of the program must do the listening. Reasons to call it `enable_irq*` / `disable_irq*` instead: - The corresponding function in pico-sdk is called `dma_channel_set_irqX_enabled` - The INTEx register documentation also uses this terminology: "Interrupt Enables for IRQ X"
nilclass
force-pushed
the
rename-dma-channel-listen
branch
from
a51868d
to
4f3e7d8
Compare
jannic
approved these changes
Jul 12, 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.
My motivation for this change is that the first time I encountered the
listen_irq*methods, the name invoked a misleading picture in my mind:channel.listen_irq0()sounds like the channel is "listening" for the IRQ, and will do something once it triggers.That's not the case though: calling this method will cause the channel to trigger the interrupt -- some other part of the program must do the listening.
Reasons to call it
enable_irq*/disable_irq*instead:dma_channel_set_irqX_enabled