From 0935051d8b35f79d85475fa3449315f31faf469d Mon Sep 17 00:00:00 2001 From: Dan Whitman Date: Fri, 24 Jan 2025 15:08:52 -0500 Subject: [PATCH] ATSAMD RTC monotonic referral in documentation (#1014) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * rtic-monotonics: Adds a section to the module documentation about ATSAMD chip monotonics provided in the `atsamd-hal` crate * rtic-monotonics: Adds a section to README listing the supported microcontroller platforms. * rtic-sync: Fix clippy complaints error: the following explicit lifetimes could be elided: 'a --> rtic-sync/src/signal.rs:113:6 | 113 | impl<'a, T: Copy> SignalReader<'a, T> { | ^^ ^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#needless_lifetimes = note: `-D clippy::needless-lifetimes` implied by `-D warnings` = help: to override `-D warnings` add `#[allow(clippy::needless_lifetimes)]` help: elide the lifetimes | 113 - impl<'a, T: Copy> SignalReader<'a, T> { 113 + impl SignalReader<'_, T> { * xtask: Clippy fix warning warning: elided lifetime has a name --> xtask/src/cargo_command.rs:427:14 | 420 | fn build_args<'i, T: Iterator>( | -- lifetime `'i` declared here ... 427 | ) -> Vec<&str> { | ^ this elided lifetime gets resolved as `'i` | = note: `#[warn(elided_named_lifetimes)]` on by default --------- Co-authored-by: Dan Whitman Co-authored-by: Henrik Tjäder --- rtic-monotonics/README.md | 10 ++++++++++ rtic-monotonics/src/lib.rs | 5 +++++ rtic-sync/src/signal.rs | 2 +- xtask/src/cargo_command.rs | 2 +- 4 files changed, 17 insertions(+), 2 deletions(-) diff --git a/rtic-monotonics/README.md b/rtic-monotonics/README.md index 31a39225df3..caaf5f6ed71 100644 --- a/rtic-monotonics/README.md +++ b/rtic-monotonics/README.md @@ -15,6 +15,16 @@ For RTIC v1 see [`rtic-monotonic`](https://github.com/rtic-rs/rtic-monotonic) ### [Changelog `rtic-monotonics`](https://github.com/rtic-rs/rtic/blob/master/rtic-monotonics/CHANGELOG.md) +## Supported Platforms + +The following microcontroller families feature efficient monotonics using peripherals. +Refer to the [crate documentation](https://docs.rs/rtic-monotonics) for more details. + +- RP2040 +- i.MX RT +- nRF +- ATSAMD + ## License Licensed under either of diff --git a/rtic-monotonics/src/lib.rs b/rtic-monotonics/src/lib.rs index 3db10f8a572..38f3b5380b7 100644 --- a/rtic-monotonics/src/lib.rs +++ b/rtic-monotonics/src/lib.rs @@ -25,6 +25,11 @@ //! tag, describing what parts _do_ support that monotonic. Monotonics without an //! `Available on crate features X only` tag are available on any `nrf52*` feature. //! +//! # 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. diff --git a/rtic-sync/src/signal.rs b/rtic-sync/src/signal.rs index a7bef0f9b5b..afe49bdb04f 100644 --- a/rtic-sync/src/signal.rs +++ b/rtic-sync/src/signal.rs @@ -110,7 +110,7 @@ where } } -impl<'a, T: Copy> SignalReader<'a, T> { +impl SignalReader<'_, T> { /// Immediately read and evict the latest value stored in the Signal. fn take(&mut self) -> Store { critical_section::with(|_| { diff --git a/xtask/src/cargo_command.rs b/xtask/src/cargo_command.rs index ab57fd70e4b..e711f743365 100644 --- a/xtask/src/cargo_command.rs +++ b/xtask/src/cargo_command.rs @@ -424,7 +424,7 @@ impl<'a> CargoCommand<'a> { features: &'i Option, mode: Option<&'i BuildMode>, extra: T, - ) -> Vec<&str> { + ) -> Vec<&'i str> { let mut args: Vec<&str> = Vec::new(); if nightly {