mirror/rtic
1
0
Fork 0
mirror of https://github.com/rtic-rs/rtic.git synced 2024-11-23 12:12:50 +01:00
Code Issues Projects Releases Packages Wiki Activity

update docs (#977)

Browse source 
Add notice for systems without native CAS operations
This commit is contained in:
Robin Mueller 2024-09-18 15:14:28 +02:00 committed by GitHub
parent 67c22862f6
commit d81c3758d5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
rtic-monotonics/src/lib.rs
View file

@ -1,6 +1,11 @@
//! In-tree implementations of the [`rtic_time::Monotonic`] (reexported) trait for //! In-tree implementations of the [`rtic_time::Monotonic`] (reexported) trait for
//! timers & clocks found on commonly used microcontrollers. //! timers & clocks found on commonly used microcontrollers.
//! //!
//! If you are using a microcontroller where CAS operations are not available natively, you might
//! have to enable the `critical-section` or `unsafe-assume-single-core` feature of the
//! [`portable-atomic`](https://docs.rs/portable-atomic/latest/portable_atomic/) dependency
//! yourself for this dependency to compile.
//!
//! To enable the implementations, you must enable a feature for the specific MCU you're targeting. //! To enable the implementations, you must enable a feature for the specific MCU you're targeting.
//! //!
//! # Cortex-M Systick //! # Cortex-M Systick