Real-Time Interrupt-driven Concurrency (RTIC) framework for ARM Cortex-M microcontrollers
Find a file
datdenkikniet 002d0b0d16 Make embedded-hal-async dependency optional for better compatibility with HALs
Some hals implement traits for embedded-hal version `=1.0.0.alpha.<not 9>`, which is
explicitly incompatible with the version `=1.0.0.alpha.9` which embedded-hal-async
depends on. Making the dependency optional allows downstream projects to include
rtic-monotonic without requiring that all of their other libraries also implement
that specific version of embedded-hal 1.0
2023-03-01 00:35:19 +01:00
.cargo Move rtic macros to repo root, tune xtask 2023-03-01 00:35:13 +01:00
.github CI: Make clippy fail on error 2023-03-01 00:35:18 +01:00
book Book: Touchup README and preface 2023-03-01 00:35:12 +01:00
rtic Move rtic macros to repo root, tune xtask 2023-03-01 00:35:13 +01:00
rtic-arbiter Add authors to each Cargo.toml 2023-03-01 00:35:10 +01:00
rtic-channel Add authors to each Cargo.toml 2023-03-01 00:35:10 +01:00
rtic-common Add authors to each Cargo.toml 2023-03-01 00:35:10 +01:00
rtic-macros Move rtic macros to repo root, tune xtask 2023-03-01 00:35:13 +01:00
rtic-monotonics Make embedded-hal-async dependency optional for better compatibility with HALs 2023-03-01 00:35:19 +01:00
rtic-time Add authors to each Cargo.toml 2023-03-01 00:35:10 +01:00
xtask xtask: Propagate stdio/stderr, exitcodes 2023-03-01 00:35:18 +01:00
.gitattributes CHANGELOG merge=union 2022-02-15 19:51:54 +01:00
.gitignore Make identifiers deterministic. 2019-02-16 00:23:01 +01:00
.travis.yml Use travis to set the PATH properly 2020-06-02 20:25:33 +00:00
Cargo.toml Add rtic-arbiter to workspace 2023-03-01 00:35:17 +01:00
CNAME Rename RTFM to RTIC 2020-06-11 17:18:29 +00:00
CONTRIBUTING.md Docs: fix link 2022-02-15 18:30:54 +01: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 Rename RTFM to RTIC 2020-06-11 17:18:29 +00:00
README.md Book: Touchup README and preface 2023-03-01 00:35:12 +01:00
README_ru.md update russian book 2021-08-03 22:40:33 +03:00
redirect.html fix redirects and CNAME 2019-09-15 21:40:40 +02:00
rust-toolchain.toml Added thumbv8 to rust-toolchain 2023-03-01 00:35:14 +01:00

Real-Time Interrupt-driven Concurrency

The hardware accelerated Rust RTOS

A concurrency framework for building real-time systems.

crates.io docs.rs book matrix Meeting notes

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 a 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.

User documentation

Documentation for the development version.

API reference

Community provided examples repo

Chat

Join us and talk about RTIC in the Matrix room.

Weekly meeting minutes can be found over at RTIC HackMD

Contributing

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

Running tests locally

To check all Run-pass tests locally on your thumbv6m-none-eabi or thumbv7m-none-eabi target device, run

$ cargo xtask --target <your target>
#                       ˆˆˆˆˆˆˆˆˆˆˆˆ
#                   e.g. thumbv7m-none-eabi

Acknowledgments

This crate is based on the Real-Time For the Masses 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. ↩︎