Real-Time Interrupt-driven Concurrency (RTIC) framework for ARM Cortex-M microcontrollers
Find a file
2024-12-06 14:23:33 +01:00
.cargo Fix config pickup behaviour so that both examples and usage-examples build 2023-04-16 13:08:46 +02:00
.github Fix CI with 1.80 2024-08-07 21:09:58 +02:00
book Book: Fix link to systick-monotonic (#981) 2024-10-16 17:53:39 +00:00
ci/expected Update support/example for ESP32-C3 to use latest versions of dependencies (#975) 2024-10-16 19:29:51 +00:00
examples bump esp32c3 (#997) 2024-11-27 18:59:55 +00:00
rtic Add default docs feature to rtic-macros 2024-12-06 14:23:33 +01:00
rtic-common Fix clippy lints 2024-05-27 11:26:06 +02:00
rtic-macros Add default docs feature to rtic-macros 2024-12-06 14:23:33 +01:00
rtic-monotonics bump esp32c3 (#997) 2024-11-27 18:59:55 +00:00
rtic-sync Fix documentation (docs.rs) and release 2.1.2 2024-12-06 14:09:26 +01:00
rtic-time Fix documentation (docs.rs) and release 2.1.2 2024-12-06 14:09:26 +01:00
xtask Update embedded-hal-bus to 0.2 and fix portable-atomic features 2024-06-23 09:20:32 +02:00
.gitattributes CHANGELOG merge=union 2022-02-15 19:51:54 +01:00
.gitignore CI: Add ESP32-C3 QEMU support (#914) 2024-04-10 18:35:14 +00:00
Cargo.toml Fixed new TAIT requirement and release v2.0.1 of RTIC 2023-07-25 08:16:13 +00:00
check-book.sh Add check-book.sh script 2023-05-11 19:20:58 +02:00
CNAME Rename RTFM to RTIC 2020-06-11 17:18:29 +00:00
CONTRIBUTING.md fix included examples and markdown(book) (#912) 2024-04-03 22:01:46 +00: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 Fix small error in readme (#856) 2023-12-04 18:18:42 +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 Feature/rp235x (#970) 2024-09-29 04:19:37 +00: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 delayed or scheduled to continue running 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. ↩︎