ticklock 0.0.8

Duration, Instant, Frequency abstraction for embedded
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

//! Provide timer abstraction

use nb;
use void::Void;
use core::time::Duration;
use core::ops::Sub;
use core::convert::Into;

/// Tell if subtractions overflow.
pub trait CheckedSub {

    /// Return true if no overflow will occur.
    fn checked_sub_impl(self, rhs: Self) -> bool;
}

impl CheckedSub for u32 {
    fn checked_sub_impl(self, rhs: u32) -> bool {
        self.checked_sub(rhs).is_some()
    }
}

impl CheckedSub for i32 {
    fn checked_sub_impl(self, rhs: i32) -> bool {
        self.checked_sub(rhs).is_some()
    }
}

/// A `Timer` trait to represent count down / up time.
/// This is a typical peripheral that has an internal counter that decrease or increase over time until it reach its limit.
pub trait Timer
where
    Self : Sized
{

    /// Inner type of the counter
    type U : Sub<Output = Self::U> + Into<u32> + CheckedSub + Copy;

    /// Pause the execution for Duration.
    fn delay(&mut self, d: Duration);

    /// Pause execution assuming interrupt is enabled
    /// and correctly handler.
    fn delay_with_interrupt(&mut self, d: Duration) {
        // By default is a not optimal delay.
        self.delay(d);
    }

    /// Start a timer counter
    /// The timer is being move and dedicated
    /// to the instant needs.
    fn start(self) ->  TimerInstant<Self>;

    /// Stop the counting timer.
    /// This method is only used by `TimerInstant` to release the timer.
    fn stop(self) -> Self;

    /// Test if the counter has wrapped to its initial value
    fn has_wrapped(&mut self) -> bool;

    /// The maximum / minimum value.
    /// For count down timer this should be the maximum value. Or the reload value.
    /// For count up limit_value should return 0.
    fn limit_value(&self) -> Self::U;

    /// Return the current counter value.
    fn get_current(&mut self) -> Self::U;

    /// Return the duration between 2 counted value.
    fn tick(&mut self) -> Duration;
}


/// Capture an instant from a timer.
pub struct TimerInstant<T>
where T : Timer
{
    delay: T,
}

impl<T> TimerInstant<T>
where T : Timer
{
    /// Capture an Instant with a given timer.
    pub fn now(delay: T) -> Self {
        TimerInstant {
            delay,
        }
    }

    /// None blocking variant of delay.
    pub fn wait(&mut self, d: Duration) -> nb::Result<(), Void> {
        if self.elapsed() < d {
            Err(nb::Error::WouldBlock)
        } else {
            Ok(())
        }
    }

    /// Give the elapsed time from the Instant.
    pub fn elapsed(&mut self) -> Duration {
        if self.delay.has_wrapped() {
            panic!("Can not tell the elapse time as we have wrapped.")
        }
        let limit = self.delay.limit_value();
        let current = self.delay.get_current();

        if limit.checked_sub_impl(current) {
            self.delay.tick() * (limit - current).into()
        } else {
            self.delay.tick() * (current - limit).into()
        }
    }

    /// Release the instant and stop the timer
    pub fn stop(self) -> T {
        self.delay.stop()
    }
}