Skip to content

Commit

Permalink
[monotonics] Fix STM32 read-modify-write race condition (#984)
Browse files Browse the repository at this point in the history
* Fix stm32 read-modify-write problem

The `SR` register for STM32 clears when writing a zero to a bit.
Therefore, all registers that should not be cleared need to be `1`.

`modify` here caused a read-modify-write error that could clear
unrelated flags.

* Add changelog

* Make initialization more deterministic

* Update changelog

* Beautification in comments

---------

Co-authored-by: Martin Stumpf <[email protected]>
  • Loading branch information
Finomnis and mstumpf-vected authored Oct 23, 2024
1 parent 0f532c6 commit 3dfef74
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 6 deletions.
5 changes: 5 additions & 0 deletions rtic-monotonics/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ For each category, *Added*, *Changed*, *Fixed* add new entries at the top!

- Update `esp32c3` dependency

### Fixed

- STM32: Make initialization more deterministic
- STM32: Fix race condition that caused missed interrupts

## v2.0.2 - 2024-07-05

### Added
Expand Down
29 changes: 23 additions & 6 deletions rtic-monotonics/src/stm32.rs
Original file line number Diff line number Diff line change
Expand Up @@ -246,9 +246,17 @@ macro_rules! make_timer {
// Trigger an update event to load the prescaler value to the clock.
$timer.egr().write(|r| r.set_ug(true));

// The above line raises an update event which will indicate that the timer is already finished.
// Since this is not the case, it should be cleared.
$timer.sr().modify(|r| r.set_uif(false));
// Clear timer value so it is known that we are at the first half period
$timer.cnt().write(|r| r.set_cnt(1));

// Triggering the update event might have raised overflow interrupts.
// Clear them to return to a known state.
$timer.sr().write(|r| {
r.0 = !0;
r.set_uif(false);
r.set_ccif(0, false);
r.set_ccif(1, false);
});

$tq.initialize(Self {});
$overflow.store(0, Ordering::SeqCst);
Expand Down Expand Up @@ -294,7 +302,10 @@ macro_rules! make_timer {
}

fn clear_compare_flag() {
$timer.sr().modify(|r| r.set_ccif(1, false));
$timer.sr().write(|r| {
r.0 = !0;
r.set_ccif(1, false);
});
}

fn pend_interrupt() {
Expand All @@ -312,13 +323,19 @@ macro_rules! make_timer {
fn on_interrupt() {
// Full period
if $timer.sr().read().uif() {
$timer.sr().modify(|r| r.set_uif(false));
$timer.sr().write(|r| {
r.0 = !0;
r.set_uif(false);
});
let prev = $overflow.fetch_add(1, Ordering::Relaxed);
assert!(prev % 2 == 1, "Monotonic must have missed an interrupt!");
}
// Half period
if $timer.sr().read().ccif(0) {
$timer.sr().modify(|r| r.set_ccif(0, false));
$timer.sr().write(|r| {
r.0 = !0;
r.set_ccif(0, false);
});
let prev = $overflow.fetch_add(1, Ordering::Relaxed);
assert!(prev % 2 == 0, "Monotonic must have missed an interrupt!");
}
Expand Down

0 comments on commit 3dfef74

Please sign in to comment.