Skip to content

Commit

Permalink
ATSAMD RTC monotonic referral in documentation (#1014)
Browse files Browse the repository at this point in the history
* 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 <[email protected]>
Co-authored-by: Henrik Tjäder <[email protected]>
  • Loading branch information
3 people authored Jan 24, 2025
1 parent 26b1ab0 commit 0935051
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 2 deletions.
10 changes: 10 additions & 0 deletions rtic-monotonics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions rtic-monotonics/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion rtic-sync/src/signal.rs
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ where
}
}

impl<'a, T: Copy> SignalReader<'a, T> {
impl<T: Copy> SignalReader<'_, T> {
/// Immediately read and evict the latest value stored in the Signal.
fn take(&mut self) -> Store<T> {
critical_section::with(|_| {
Expand Down
2 changes: 1 addition & 1 deletion xtask/src/cargo_command.rs
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@ impl<'a> CargoCommand<'a> {
features: &'i Option<String>,
mode: Option<&'i BuildMode>,
extra: T,
) -> Vec<&str> {
) -> Vec<&'i str> {
let mut args: Vec<&str> = Vec::new();

if nightly {
Expand Down

0 comments on commit 0935051

Please sign in to comment.