mirror/rtic
1
0
Fork 0
mirror of https://github.com/rtic-rs/rtic.git synced 2024-11-23 20:22:51 +01:00
Code Issues Projects Releases Packages Wiki Activity

Minor docs update to monotonic

Browse source
This commit is contained in:
Emil Fresk 2019-11-13 20:56:31 +01:00
parent 72e84cb297
commit 2441b7e389
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/lib.rs
View file

@ -128,10 +128,12 @@ pub struct Fraction {
/// A monotonic clock / counter /// A monotonic clock / counter
pub trait Monotonic { pub trait Monotonic {
/// A measurement of this clock /// A measurement of this clock, use `CYCCNT` as a reference implementation for `Instant`.
/// Note that the Instant must be a signed value such as `i32`.
type Instant: Copy + Ord + Sub; type Instant: Copy + Ord + Sub;
/// The ratio between the SysTick (system timer) frequency and this clock frequency /// The ratio between the system timer (SysTick) frequency and this clock frequency, i.e.
/// `Monotonic clock * Fraction = System clock`
/// ///
/// The ratio must be expressed in *reduced* `Fraction` form to prevent overflows. That is /// The ratio must be expressed in *reduced* `Fraction` form to prevent overflows. That is
/// `2 / 3` instead of `4 / 6` /// `2 / 3` instead of `4 / 6`