Skip to content

Add blockquotes to chapter 15 #114

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

Open
lbellomo wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add blockquotes to chapter 15 #114

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 11 additions & 4 deletions mdbook/src/15-interrupts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,10 @@ that this ISR should be stored at the entry for the `GPIOTE` interrupt in the in
The `#[interrupt]` decoration is used at compile time to mark a function to be treated specially as
an ISR. (This is a "proc macro": you can read more about it in the [Rust book] if you wish.)

Essentially, a "proc macro" translates source code into other source code. If you are curious as to what any particular macro use translates into,
you could expand that macro invocation. You can do this by using either the Tools in the [Rust Playground] or the "rust-analyzer: Expand macro" command in your IDE.
> **NOTE** Essentially, a "proc macro" translates source code into other source code. If you are curious as
> to what any particular macro use translates into, you could expand that macro invocation. You can
> do this by using either the Tools in the [Rust Playground] or the "rust-analyzer: Expand macro"
> command in your IDE.

Marking a function with `#[interrupt]` implies several special things about the function:

Expand All @@ -51,7 +53,12 @@ interrupt when the pin connected to Button A goes from high to low voltage. Seco
configured to allow the interrupt. Order matters a bit: doing things in the "wrong" order may
generate an interrupt before you are ready to handle it.

**Note** As with most microcontrollers, there is a lot of flexibility in when the GPIOTE can generate an interrupt. Interrupts can be generated on low-to-high pin transition, high-to-low (as here), any change ("edge"), when low, or when high. On the nRF52833, interrupts generate an event that must be manually cleared in the ISR to ensure that the ISR is not called a second time for the same interrupt. Other microcontrollers may work a little differently — you should read Rust crate and microcontroller documentation to understand the details on a different board.
> **Note** As with most microcontrollers, there is a lot of flexibility in when the GPIOTE can
> generate an interrupt. Interrupts can be generated on low-to-high pin transition, high-to-low (as
> here), any change ("edge"), when low, or when high. On the nRF52833, interrupts generate an event
> that must be manually cleared in the ISR to ensure that the ISR is not called a second time for the
> same interrupt. Other microcontrollers may work a little differently — you should read Rust crate
> and microcontroller documentation to understand the details on a different board.

When you push the A Button, you will see an "ouch" message and then a panic. Why does the interrupt
handler call `panic!()`? Try commenting the `panic!()` call out and see what happens when you push
Expand All @@ -72,4 +79,4 @@ Normally, once an ISR is complete the main program continues running just as it
[NVIC and Interrupt Priority]: nvic-and-interrupt-priority.html
[Registers]: ../09-registers/index.html
[Rust Playground]: https://play.rust-lang.org/?version=stable&mode=debug&edition=2024
[Rust book]: https://doc.rust-lang.org/book/ch20-05-macros.html
[Rust book]: https://doc.rust-lang.org/book/ch20-05-macros.html
Loading