diff options
| author | Dan Whitman <dwhitman44@gmail.com> | 2025-01-24 15:08:52 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-01-24 20:08:52 +0000 |
| commit | 0935051d8b35f79d85475fa3449315f31faf469d (patch) | |
| tree | 057667f98432f3b8fc10c9cee305741c9f0c5703 /rtic-monotonics | |
| parent | 26b1ab05eb5a444d0c2d723963b5459589a0c28b (diff) | |
ATSAMD RTC monotonic referral in documentation (#1014)
* 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<T: Copy> 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<Item = &'i str>>(
| -- 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 <daniel.whitman.2@us.af.mil>
Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
Diffstat (limited to 'rtic-monotonics')
| -rw-r--r-- | rtic-monotonics/README.md | 10 | ||||
| -rw-r--r-- | rtic-monotonics/src/lib.rs | 5 |
2 files changed, 15 insertions, 0 deletions
diff --git a/rtic-monotonics/README.md b/rtic-monotonics/README.md index 31a3922..caaf5f6 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 3db10f8..38f3b53 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. |
