more monotonic timer docs

covers

- initialization and configuration of the timer; this is now a responsibility of
  the application author
- correctness of `Monotonic::now()` in `#[init]`
- safety of `Monotonic::reset()`

closes #251
This commit is contained in:
Jorge Aparicio 2019-10-15 18:44:49 -05:00
parent 6196984d6d
commit eef4e7bf79
6 changed files with 33 additions and 5 deletions

View file

@ -138,9 +138,21 @@ pub trait Monotonic {
fn ratio() -> Fraction;
/// Returns the current time
///
/// # Correctness
///
/// This function is *allowed* to return nonsensical values if called before `reset` is invoked
/// by the runtime. Therefore application authors should *not* call this function during the
/// `#[init]` phase.
fn now() -> Self::Instant;
/// Resets the counter to *zero*
///
/// # Safety
///
/// This function will be called *exactly once* by the RTFM runtime after `#[init]` returns and
/// before tasks can start; this is also the case in multi-core applications. User code must
/// *never* call this function.
unsafe fn reset();
/// A `Self::Instant` that represents a count of *zero*