diff options
| author | Emil Fresk <emil.fresk@gmail.com> | 2024-10-23 20:51:38 +0200 |
|---|---|---|
| committer | Emil Fresk <emil.fresk@gmail.com> | 2024-10-23 20:57:42 +0200 |
| commit | 0f532c6b48cc436233765dea19520b911cd671a5 (patch) | |
| tree | 16dc712759b96c278d688a05f89d9c88a33d11cc /rtic-monotonics/src | |
| parent | 1461977cf7cf1f221d8f854ff261e7f91655bf46 (diff) | |
rtic-monotonics: Improve docs on interrupt priority
Diffstat (limited to 'rtic-monotonics/src')
| -rw-r--r-- | rtic-monotonics/src/lib.rs | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/rtic-monotonics/src/lib.rs b/rtic-monotonics/src/lib.rs index 9fe0bbf..3db10f8 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 |