zephyr: Create Timer

Add a set of wrappers for Zephyr's timer.  Timers start as
`StoppedTimer`, which can be either dynamic or static (through object).
This can then be started either with `start_simple` or `start_callback`
which will return a `SimpleTimer` or a `CallbackTimer`.  This can then
be turned back into stopped timers with a `stop` method.

Signed-off-by: David Brown <[email protected]>

Author: d3zd3z

zephyr/src/lib.rs

@@ -17,6 +17,8 @@ pub mod object;
 pub mod sync;
 pub mod sys;
 pub mod time;
+#[cfg(CONFIG_RUST_ALLOC)]
+pub mod timer;
 
 pub use error::{Error, Result};
 

zephyr/src/sync/spinmutex.rs

@@ -41,6 +41,8 @@ pub enum SpinTryLockError {
 /// This is modeled after [`sync::Mutex`] but instead of using `k_mutex` from Zephyr, it uses
 /// `k_spinlock`.  It's main advantage is that it is usable from IRQ context.  However, it also is
 /// uninterruptible, and prevents even IRQ handlers from running.
+///
+/// [`sync::Mutex`]: crate::sync::Mutex
 pub struct SpinMutex<T: ?Sized> {
     inner: UnsafeCell<raw::k_spinlock>,
     data: UnsafeCell<T>,

zephyr/src/sys.rs

@@ -50,6 +50,8 @@ pub mod critical {
     //! This provides the underlying critical section crate, which is useful for external crates
     //! that want this interface.  However, it isn't a particularly hygienic interface to use.  For
     //! something a bit nicer, please see [`sync::SpinMutex`].
+    //!
+    //! [`sync::SpinMutex`]: crate::sync::SpinMutex
 
     use core::{ffi::c_int, ptr::addr_of_mut};
 

zephyr/src/sys/queue.rs

@@ -65,6 +65,10 @@ impl Queue {
     /// The timeout value can be [`Forever`] to block until there is a message, [`NoWait`] to check
     /// and immediately return if there is no message, or a [`Duration`] to indicate a specific
     /// timeout.
+    ///
+    /// [`Forever`]: crate::time::Forever
+    /// [`NoWait`]: crate::time::NoWait
+    /// [`Duration`]: crate::time::Duration
     pub unsafe fn recv<T>(&self, timeout: T) -> *mut c_void
         where T: Into<Timeout>
     {