Real-Time Interrupt-driven Concurrency (RTIC) framework for ARM Cortex-M microcontrollers
Find a file
bors[bot] 82efffd706
Merge #277
277: TimerQueue.dequeue: don't set SYST reload to 0 r=korken89 a=mpasternacki

ARM Architecture Reference Manual says: "Setting SYST_RVR to zero has the effect of disabling the SysTick counter independently of the counter enable bit."

If Monotonic's ratio is less than one, the timeout calculations
can compute zero if next task is scheduled after current instant, but
before next timer tick. This results in disabling SYST and freezing the
timer queue.

The division by ratio's denominator rounds downward and the dequeue
condition is `if instant < now`. If ratio is small enough, this results
in unnecessary interrupts:

Let's say `instant - now` is 99 and ratio is 1/25. Then, `dur` will
equal 3 and the next tick will happen at `now + 75`. In the next
interrupt, `instant > now` and additional tick needs to be scheduled
(which doesn't happen, because now `instant - now` is less than 25, so
reload will be set to 0 and timer queue will stop). Adding one to
computed duration will prevent both freezing and additional interrupts.

When ratio is 1 or close, timer queue code overhead will prevent this
from happening. I am working with a chip where CPU is clocked at 600MHz
and SysTick is 100kHz and the freeze happens quite often.

Co-authored-by: Maciej Pasternacki <maciej@3ofcoins.net>
2019-11-19 14:00:22 +00:00
.cargo CI: replace compiletest-rs with trybuild 2019-11-06 19:05:37 -05:00
.github bors: do not merge PRs labeled S-blocked 2019-04-21 21:05:57 +02:00
book remove references to 'beta' from the docs 2019-11-14 18:19:57 -05:00
ci fix CI 2019-11-14 18:55:07 -05:00
examples Added struct de-structure-ing example in tips & tricks 2019-11-07 14:12:16 +01:00
heterogeneous change Monotonic::ratio return type to Fraction 2019-07-11 13:28:25 +02:00
homogeneous change Monotonic::ratio return type to Fraction 2019-07-11 13:28:25 +02:00
macros v0.5.0 final release 2019-11-14 17:47:17 -05:00
src Merge #277 2019-11-19 14:00:22 +00:00
tests CI: replace compiletest-rs with trybuild 2019-11-06 19:05:37 -05:00
ui/single run cfail tests only when rustc --version == $MSRV 2019-11-06 19:39:57 -05:00
.gitignore Make identifiers deterministic. 2019-02-16 00:23:01 +01:00
.travis.yml CI: fix caching mechanism 2019-11-14 18:17:34 -05:00
build.rs WIP 2019-06-29 09:11:57 +02:00
Cargo.toml Bumped version to 0.5.1, cyccntr bugfix 2019-11-18 16:38:52 +01:00
CHANGELOG.md Fixed internal overflow on subtraiton in elapsed and duration 2019-11-18 16:36:17 +01:00
CNAME Added CNAME for rtfm.rs 2019-09-15 20:59:42 +02:00
CONTRIBUTING.md add CONTRIBUTING.md and link to Matrix room 2019-09-15 22:43:10 +02:00
LICENSE-APACHE initial commit 2017-03-05 00:29:08 -05:00
LICENSE-CC-BY-SA v0.4.0 2018-11-03 17:16:55 +01:00
LICENSE-MIT v0.5.0 beta release 2019-10-15 16:35:00 -05:00
README.md Fix matrix.to web link for the static room view. 2019-10-11 20:49:47 +01:00
redirect.html fix redirects and CNAME 2019-09-15 21:40:40 +02:00

Real Time For the Masses

A concurrency framework for building real time systems.

Features

  • Tasks as the unit of concurrency 1. Tasks can be event triggered (fired in response to asynchronous stimuli) or spawned by the application on demand.

  • Message passing between tasks. Specifically, messages can be passed to software tasks at spawn time.

  • A timer queue 2. Software tasks can be scheduled to run at some time in the future. This feature can be used to implement periodic tasks.

  • Support for prioritization of tasks and, thus, preemptive multitasking.

  • Efficient and data race free memory sharing through fine grained priority based critical sections 1.

  • Deadlock free execution guaranteed at compile time. This is an stronger guarantee than what's provided by the standard Mutex abstraction.

  • Minimal scheduling overhead. The task scheduler has minimal software footprint; the hardware does the bulk of the scheduling.

  • Highly efficient memory usage: All the tasks share a single call stack and there's no hard dependency on a dynamic memory allocator.

  • All Cortex-M devices are fully supported.

  • This task model is amenable to known WCET (Worst Case Execution Time) analysis and scheduling analysis techniques. (Though we haven't yet developed Rust friendly tooling for that.)

Requirements

  • Rust 1.36.0+

  • Applications must be written using the 2018 edition.

User documentation

API reference

Chat

Join us and talk about RTFM in the Matrix room.

Contributing

New features and big changes should go through the RFC process in the dedicated RFC repository.

Acknowledgments

This crate is based on the RTFM language created by the Embedded Systems group at Luleå University of Technology, led by Prof. Per Lindgren.

References

License

All source code (including code snippets) is licensed under either of

at your option.

The written prose contained within the book is licensed under the terms of the Creative Commons CC-BY-SA v4.0 license (LICENSE-CC-BY-SA or https://creativecommons.org/licenses/by-sa/4.0/legalcode).

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions.


  1. Eriksson, J., Häggström, F., Aittamaa, S., Kruglyak, A., & Lindgren, P. (2013, June). Real-time for the masses, step 1: Programming API and static priority SRP kernel primitives. In Industrial Embedded Systems (SIES), 2013 8th IEEE International Symposium on (pp. 110-113). IEEE. ↩︎

  2. Lindgren, P., Fresk, E., Lindner, M., Lindner, A., Pereira, D., & Pinho, L. M. (2016). Abstract timers and their implementation onto the arm cortex-m family of mcus. ACM SIGBED Review, 13(1), 48-53. ↩︎