Documentation: Clarify GPIO interrupt behaviour #814
Merged
Conversation
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
lurch
reviewed
May 9, 2022
| @@ -401,7 +401,8 @@ void gpio_set_dormant_irq_enabled(uint gpio, uint32_t events, bool enabled); | |||
| * | |||
| * \param gpio GPIO number | |||
| * \param events Bitmask of events to clear. See \ref gpio_set_irq_enabled for details. | |||
| * | |||
| * | |||
| * \note \ref gpio_set_irq_enabled_with_callback calls this function before the callback. | |||
There was a problem hiding this comment.
gpio_set_irq_enabled_with_callback doesn't directly call gpio_acknowledge_irq. Did you mean something like "The default GPIO IRQ-handler automatically calls this function before calling any callback-function" ?
There was a problem hiding this comment.
Sorry yes, I meant to imply that callbacks set with gpio_set_irq_enabled_with_callback don't need to acknowledge the IRQ as it's done before the user callback runs. I've reworded it, hopefully it reads better now.
|
Not picking this up yet, as this API may get reworked shortly. |
|
@kilograham You could merge it now and then just let it get replaced if/when the API gets redeveloped 😀 |
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.
Just some small documentation updates to clarify a few things I had to investigate to find answers to, related to how the GPIO interrupts work.