diff options
| author | Robin Mueller <31589589+robamu@users.noreply.github.com> | 2024-09-18 15:14:28 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-09-18 13:14:28 +0000 |
| commit | d81c3758d5633c22342cb60069243243f9d38df5 (patch) | |
| tree | 75df821f15cef60ebca5f0aa4bdaedf72a07870b | |
| parent | 67c22862f67c28b6313d9812b6bf6018764f18e0 (diff) | |
update docs (#977)
Add notice for systems without native CAS operations
| -rw-r--r-- | rtic-monotonics/src/lib.rs | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/rtic-monotonics/src/lib.rs b/rtic-monotonics/src/lib.rs index 70a89fc..9245f45 100644 --- a/rtic-monotonics/src/lib.rs +++ b/rtic-monotonics/src/lib.rs @@ -1,6 +1,11 @@ //! In-tree implementations of the [`rtic_time::Monotonic`] (reexported) trait for //! 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. //! //! # Cortex-M Systick |