-
-
Notifications
You must be signed in to change notification settings - Fork 732
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.
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
Update attachInterrupt.adoc #842
Open
MalcolmBoura
wants to merge
1
commit into
arduino:master
Choose a base branch
from
MalcolmBoura:patch-3
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -55,6 +55,40 @@ Generally, an ISR should be as short and fast as possible. If your sketch uses m | |||||
|
||||||
Typically global variables are used to pass data between an ISR and the main program. To make sure variables shared between an ISR and the main program are updated correctly, declare them as `volatile`. | ||||||
|
||||||
Races, code which changes behaviour depending upon timing, can be a problem if both normal code and interrupt code tries to access variables at the same time. This leads to highly intermittent and hard to find bugs. The simplest solution is to disable interrupts when accessing shared variables from non-interrupt code. Interrupts are disabled by default in interrupt functions so unless interrupts are turned on there is no problem there. See `noInterrupts()` and `interrupts()`. | ||||||
|
||||||
Consider a common technique for interupts. The interrupt routine sets a flag which is acted on by code in the main loop. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
[source,arduino] | ||||||
---- | ||||||
volatile bool iHaveBeenInterrupted = false; | ||||||
void interrupt() { | ||||||
iHaveBeenInterrupted = true; | ||||||
} | ||||||
|
||||||
void checkForInterrupt() { | ||||||
if (iHaveBeenInterrupted) { // line A | ||||||
iHaveBeenInterrupted = false; // line B | ||||||
// Do what is necessary | ||||||
} | ||||||
} | ||||||
---- | ||||||
If the interrupt occurs between testing the flag in line A and the clearing of the flag in line B then the flag will set by the interrupt and immediately cleared by the non-interrupt code resulting in the interrupt being ignored. The solution is to prevent the interrupt from interrupting at that critical point. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
[source,arduino] | ||||||
---- | ||||||
void checkForInterrupt() { | ||||||
noInterupts(); // disable interrupts | ||||||
if (iHaveBeenInterrupted) { // line A | ||||||
iHaveBeenInterrupted = false; // line B | ||||||
interrupts(); // turn interrupts back on again as soon as possible | ||||||
// Do what is necessary | ||||||
} | ||||||
else { | ||||||
interrupts(); // turn interrupts back on again as soon as possible | ||||||
} | ||||||
} | ||||||
---- | ||||||
The same problem, and other related problems, can arise with any data shared between an interrupt function and non-interrupt code. | ||||||
|
||||||
For more information on interrupts, see http://gammon.com.au/interrupts[Nick Gammon's notes]. | ||||||
|
||||||
[float] | ||||||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Provide links to the reference pages the reader is being instructed to see.