mirror/rtic
1
0
Fork 0
mirror of https://github.com/rtic-rs/rtic.git synced 2024-12-24 02:49:34 +01:00
Code Issues Projects Releases Packages Wiki Activity
Real-Time Interrupt-driven Concurrency (RTIC) framework for ARM Cortex-M microcontrollers
445 commits 46 branches 47 tags 221 MiB
Rust 99.8%
HTML 0.1%
Find a file
Jorge Aparicio 3dd6df0bd0 CI: build 0.4 docs from the v0.4.x branch 
instead of using a specific tag; this way documentation changes done to the
v0.4.x branch will show up on the site as soon as they land -- right now they
require publishing a new v0.4.x release on crates.io and manually updating the
`after-success.sh` build script on master
2019-10-25 13:59:23 -05:00
.cargo v0.4.0 2018-11-03 17:16:55 +01:00
.github bors: do not merge PRs labeled S-blocked 2019-04-21 21:05:57 +02:00
book Fixed peripherals -> device typo 2019-10-23 20:31:33 +02:00
ci CI: build 0.4 docs from the v0.4.x branch 2019-10-25 13:59:23 -05:00
examples more monotonic timer docs 2019-10-15 18:44:49 -05: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 do not zero late resource memory on boot 2019-10-21 16:38:04 -05:00
src cyccnt::Instant: simplify the Send / Sync impl 2019-10-15 19:31:46 -05:00
tests drop the "multi" test 2019-08-21 10:56:59 +02:00
ui/single implement RFC #212 2019-07-10 22:42:44 +02:00
.gitignore Make identifiers deterministic. 2019-02-16 00:23:01 +01:00
.travis.yml adapt to changes in rtfm-syntax 2019-08-20 15:17:37 +02:00
build.rs WIP 2019-06-29 09:11:57 +02:00
Cargo.toml v0.5.0 beta release 2019-10-15 16:35:00 -05:00
CHANGELOG.md more monotonic timer docs 2019-10-15 18:44:49 -05: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

README.md

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