From a2f153249f926876e7169016f3dc8e861a9ef065 Mon Sep 17 00:00:00 2001
From: Emil Fresk <emil.fresk@gmail.com>
Date: Sat, 1 Apr 2023 20:48:23 +0200
Subject: Added nRF monotonics

---
 rtic-monotonics/src/rp2040.rs | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

(limited to 'rtic-monotonics/src/rp2040.rs')

diff --git a/rtic-monotonics/src/rp2040.rs b/rtic-monotonics/src/rp2040.rs
index 9d2f4f3..5e880cd 100644
--- a/rtic-monotonics/src/rp2040.rs
+++ b/rtic-monotonics/src/rp2040.rs
@@ -1,4 +1,25 @@
 //! A monotonic implementation for RP2040's Timer peripheral.
+//!
+//! # Example
+//!
+//! ```
+//! use rtic_monotonics::rp2040::*;
+//!
+//! # async fn usage() {
+//! # let timer = unsafe { core::mem::transmute(()) };
+//! # let mut resets = unsafe { core::mem::transmute(()) };
+//! // Generate the required token
+//! let token = rtic_monotonics::create_rp2040_monotonic_token!();
+//!
+//! // Start the monotonic
+//! Timer::start(timer, &mut resets, token);
+//!
+//! loop {
+//!      // Use the monotonic
+//!      Timer::delay(100.millis()).await;
+//! }
+//! # }
+//! ```
 
 use super::Monotonic;
 pub use super::{TimeoutError, TimerQueue};
@@ -41,6 +62,7 @@ impl Timer {
     }
 
     /// Timeout at a specific time.
+    #[inline]
     pub async fn timeout_at<F: Future>(
         instant: <Self as Monotonic>::Instant,
         future: F,
@@ -64,6 +86,7 @@ impl Timer {
     }
 
     /// Delay to some specific time instant.
+    #[inline]
     pub async fn delay_until(instant: <Self as Monotonic>::Instant) {
         TIMER_QUEUE.delay_until(instant).await;
     }
-- 
cgit v1.2.3