Skip to content
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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions Language/Functions/External Interrupts/attachInterrupt.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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()`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
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()`.
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 `link:../../interrupts/nointerrupts[noInterrupts()]` and `link:../../interrupts/interrupts[interrupts()]`.

Provide links to the reference pages the reader is being instructed to see.


Consider a common technique for interupts. The interrupt routine sets a flag which is acted on by code in the main loop.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Consider a common technique for interupts. The interrupt routine sets a flag which is acted on by code in the main loop.
Consider a common technique for interrupts. The interrupt routine sets a flag which is acted on by code in the main loop.

[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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
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.
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 be 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.

[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]
Expand Down