Real-Time Interrupt-driven Concurrency (RTIC) framework for ARM Cortex-M microcontrollers
Find a file
bors[bot] 4c98bcd237
Merge #269
269: [v0.4.x] CI: pin to an older nightly r=korken89 a=japaric

to workaround compiletest-rs being broken on recent nightlies

this is a backport of #267 and it's required to land #265 

I'm not backporting #268  (compiletest -> trybuild) because this branch has compile-pass tests which depend on compiletest and can't be ported to trybuild

Co-authored-by: Jorge Aparicio <jorge@japaric.io>
2019-11-13 20:43:04 +00:00
.cargo v0.4.0 2018-11-03 17:16:55 +01:00
.github v0.4.0 2018-11-03 17:16:55 +01:00
book Merge #261 2019-10-23 20:40:08 +00:00
ci install rustc-dev component 2019-11-13 15:27:19 -05:00
examples book: indirection for faster message passing 2019-05-01 20:15:58 +02:00
macros Merge #186 2019-10-23 20:49:30 +00:00
src Merge #261 2019-10-23 20:40:08 +00:00
tests check task priority at compile time 2019-04-16 23:04:24 +02:00
.gitignore Make identifiers deterministic. 2019-02-16 00:23:01 +01:00
.travis.yml install rustc-dev component 2019-11-13 15:27:19 -05:00
build.rs note that the timer queue is not supported on ARMv6-M 2018-12-16 19:38:22 +01:00
Cargo.toml fix armv6-m build 2019-05-01 20:16:01 +02:00
CHANGELOG.md Docs updates 2019-10-23 21:48:44 +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.4.0 2018-11-03 17:16:55 +01:00
README.md Docs updates 2019-10-23 21:48:44 +02:00
redirect.html fancier redirect page 2019-02-14 21:57:43 +01: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 supported. The core features of RTFM are supported on all Cortex-M devices. The timer queue is currently only supported on ARMv7-M devices.

  • 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

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. ↩︎