diff options
Diffstat (limited to 'rtic-monotonics')
| -rw-r--r-- | rtic-monotonics/src/lib.rs | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/rtic-monotonics/src/lib.rs b/rtic-monotonics/src/lib.rs index a02ddb5..ea2085a 100644 --- a/rtic-monotonics/src/lib.rs +++ b/rtic-monotonics/src/lib.rs @@ -9,27 +9,37 @@ //! To enable the implementations, you must enable a feature for the specific MCU you're targeting. //! //! # Cortex-M Systick -//! The `systick` monotonic works on all cortex-M parts, and requires that the feature `cortex-m-systick` is enabled. +//! The `systick` monotonic works on all Arm Cortex-M parts, and requires that the feature `cortex-m-systick` is enabled. //! //! # RP2040 //! The RP2040 monotonics require that the `rp2040` feature is enabled. //! +//! # RP2350 +//! The RP2350 monotonics require that the `rp235x` feature is enabled. +//! //! # i.MX RT //! The i.MX RT monotonics require that the feature `imxrt_gpt1` or `imxrt_gpt2` is enabled. //! //! # nRF -//! nRF monotonics require that one of the available `nrf52*` features is enabled. +//! nRF monotonics require that one of the available `nrf52*` features is enabled. Monotonic +//! implementations are available for both high-resolution TIMER and low-resolution RTC peripherals. //! //! All implementations of timers for the nRF52 family are documented here. Monotonics that //! are not available on all parts in this family will have an `Available on crate features X only` //! tag, describing what parts _do_ support that monotonic. Monotonics without an //! `Available on crate features X only` tag are available on any `nrf52*` feature. //! +//! # ESP32C3 and ESP32C6 +//! Enable either the `esp32c3-systimer` or `esp32c6-systimer` feature, as appropriate. +//! +//! # STM32 +//! Enable one of the `stm32*` features, as appropriate. Implementations are available for +//! a selection of STM32 timers. +//! //! # ATSAMD //! Monotonics for the ATSAMD family of parts using the real time clock (RTC) are provided in the //! [`atsamd-hal`](https://docs.rs/atsamd-hal/latest/atsamd_hal/rtc/rtic/index.html) //! crate with the `rtic` feature enabled. -//! //! # Priority of interrupt handlers //! //! The priority of timer interrupts are based on `RTIC_ASYNC_MAX_LOGICAL_PRIO` generated by RTIC. |