From 75071a46d9329bb2dddcda6bd31251d8f96f6fd9 Mon Sep 17 00:00:00 2001 From: Emil Fresk Date: Wed, 23 Oct 2024 20:51:38 +0200 Subject: [PATCH] rtic-monotonics: Improve docs on interrupt priority --- rtic-monotonics/src/lib.rs | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/rtic-monotonics/src/lib.rs b/rtic-monotonics/src/lib.rs index 9fe0bbf11759..3db10f8a5721 100644 --- a/rtic-monotonics/src/lib.rs +++ b/rtic-monotonics/src/lib.rs @@ -25,6 +25,13 @@ //! tag, describing what parts _do_ support that monotonic. Monotonics without an //! `Available on crate features X only` tag are available on any `nrf52*` feature. //! +//! # Priority of interrupt handlers +//! +//! The priority of timer interrupts are based on `RTIC_ASYNC_MAX_LOGICAL_PRIO` generated by RTIC. +//! It is calculated to be 1 less than the maximum hardware task priority (to not have impact on +//! hardware tasks), or, if no hardware task is available, is set to the maximum priority in the +//! system. + // To build these docs correctly: // RUSTFLAGS="--cfg docsrs" cargo +nightly doc --features thumbv7-backend,cortex-m-systick,rp2040,nrf52840,imxrt_gpt1,imxrt_gpt2,imxrt-ral/imxrt1011,stm32h725ag,stm32_tim2,stm32_tim3,stm32_tim4,stm32_tim5,stm32_tim15