sel4_driver_interfaces/
timer.rs

Help
1//
2// Copyright 2024, Colias Group, LLC
3//
4// SPDX-License-Identifier: BSD-2-Clause
5//
6
7use core::cell::RefCell;
8use core::fmt;
9use core::ops::Deref;
10use core::time::Duration;
11
12use lock_api::{Mutex, RawMutex};
13
14use crate::{HandleInterrupt, WrappedMutex, WrappedRefCell, WrappedRefCellError};
15
16pub trait ErrorType {
17    type Error: fmt::Debug;
18}
19
20pub trait Clock: ErrorType {
21    fn get_time(&mut self) -> Result<Duration, Self::Error>;
22}
23
24pub trait Timers: Clock {
25    type TimerLayout;
26
27    type Timer;
28
29    fn timer_layout(&mut self) -> Result<Self::TimerLayout, Self::Error>;
30
31    fn set_timeout_on(&mut self, timer: Self::Timer, relative: Duration)
32        -> Result<(), Self::Error>;
33
34    fn clear_timeout_on(&mut self, timer: Self::Timer) -> Result<(), Self::Error>;
35}
36
37pub trait Timer: Clock {
38    fn set_timeout(&mut self, relative: Duration) -> Result<(), Self::Error>;
39
40    fn clear_timeout(&mut self) -> Result<(), Self::Error>;
41}
42
43pub struct TrivialTimers<T>(pub T);
44
45impl<T: ErrorType> ErrorType for TrivialTimers<T> {
46    type Error = T::Error;
47}
48
49impl<T: Clock> Clock for TrivialTimers<T> {
50    fn get_time(&mut self) -> Result<Duration, Self::Error> {
51        self.0.get_time()
52    }
53}
54
55impl<T: Timer> Timers for TrivialTimers<T> {
56    type TimerLayout = ();
57
58    type Timer = ();
59
60    fn timer_layout(&mut self) -> Result<Self::TimerLayout, Self::Error> {
61        Ok(())
62    }
63
64    fn set_timeout_on(
65        &mut self,
66        _timer: Self::Timer,
67        relative: Duration,
68    ) -> Result<(), Self::Error> {
69        self.0.set_timeout(relative)
70    }
71
72    fn clear_timeout_on(&mut self, _timer: Self::Timer) -> Result<(), Self::Error> {
73        self.0.clear_timeout()
74    }
75}
76
77pub struct DefaultTimer<T>(pub T);
78
79impl<T: ErrorType> ErrorType for DefaultTimer<T> {
80    type Error = T::Error;
81}
82
83impl<T: Clock> Clock for DefaultTimer<T> {
84    fn get_time(&mut self) -> Result<Duration, Self::Error> {
85        self.0.get_time()
86    }
87}
88
89impl<T: Timers<Timer: Default>> Timer for DefaultTimer<T> {
90    fn set_timeout(&mut self, relative: Duration) -> Result<(), Self::Error> {
91        self.0.set_timeout_on(Default::default(), relative)
92    }
93
94    fn clear_timeout(&mut self) -> Result<(), Self::Error> {
95        self.0.clear_timeout_on(Default::default())
96    }
97}
98
99pub struct NumTimers(pub usize);
100
101pub struct SingleTimer<T>(pub T);
102
103impl<T: ErrorType> ErrorType for SingleTimer<T> {
104    type Error = T::Error;
105}
106
107impl<T: Clock> Clock for SingleTimer<T> {
108    fn get_time(&mut self) -> Result<Duration, Self::Error> {
109        self.0.get_time()
110    }
111}
112
113impl<T: Timer> Timers for SingleTimer<T> {
114    type TimerLayout = NumTimers;
115
116    type Timer = usize;
117
118    fn timer_layout(&mut self) -> Result<Self::TimerLayout, Self::Error> {
119        Ok(NumTimers(1))
120    }
121
122    fn set_timeout_on(
123        &mut self,
124        _timer: Self::Timer,
125        relative: Duration,
126    ) -> Result<(), Self::Error> {
127        self.0.set_timeout(relative)
128    }
129
130    fn clear_timeout_on(&mut self, _timer: Self::Timer) -> Result<(), Self::Error> {
131        self.0.clear_timeout()
132    }
133}
134
135impl<T: HandleInterrupt> HandleInterrupt for SingleTimer<T> {
136    fn handle_interrupt(&mut self) {
137        self.0.handle_interrupt()
138    }
139}
140
141// // //
142
143impl<T: Deref<Target = RefCell<U>>, U: ErrorType> ErrorType for &WrappedRefCell<T> {
144    type Error = WrappedRefCellError<U::Error>;
145}
146
147impl<T: Deref<Target = RefCell<U>>, U: Clock> Clock for &WrappedRefCell<T> {
148    fn get_time(&mut self) -> Result<Duration, Self::Error> {
149        self.with_mut(|this| this.get_time())
150    }
151}
152
153impl<T: Deref<Target = RefCell<U>>, U: Timers> Timers for &WrappedRefCell<T> {
154    type TimerLayout = U::TimerLayout;
155
156    type Timer = U::Timer;
157
158    fn timer_layout(&mut self) -> Result<Self::TimerLayout, Self::Error> {
159        self.with_mut(|this| this.timer_layout())
160    }
161
162    fn set_timeout_on(
163        &mut self,
164        timer: Self::Timer,
165        relative: Duration,
166    ) -> Result<(), Self::Error> {
167        self.with_mut(|this| this.set_timeout_on(timer, relative))
168    }
169
170    fn clear_timeout_on(&mut self, timer: Self::Timer) -> Result<(), Self::Error> {
171        self.with_mut(|this| this.clear_timeout_on(timer))
172    }
173}
174
175impl<T: Deref<Target = RefCell<U>>, U: Timer> Timer for &WrappedRefCell<T> {
176    fn set_timeout(&mut self, relative: Duration) -> Result<(), Self::Error> {
177        self.with_mut(|this| this.set_timeout(relative))
178    }
179
180    fn clear_timeout(&mut self) -> Result<(), Self::Error> {
181        self.with_mut(|this| this.clear_timeout())
182    }
183}
184
185impl<R: RawMutex, T: Deref<Target = Mutex<R, U>>, U: ErrorType> ErrorType for &WrappedMutex<T> {
186    type Error = U::Error;
187}
188
189impl<R: RawMutex, T: Deref<Target = Mutex<R, U>>, U: Clock> Clock for &WrappedMutex<T> {
190    fn get_time(&mut self) -> Result<Duration, Self::Error> {
191        self.with_mut(|this| this.get_time())
192    }
193}
194
195impl<R: RawMutex, T: Deref<Target = Mutex<R, U>>, U: Timers> Timers for &WrappedMutex<T> {
196    type TimerLayout = U::TimerLayout;
197
198    type Timer = U::Timer;
199
200    fn timer_layout(&mut self) -> Result<Self::TimerLayout, Self::Error> {
201        self.with_mut(|this| this.timer_layout())
202    }
203
204    fn set_timeout_on(
205        &mut self,
206        timer: Self::Timer,
207        relative: Duration,
208    ) -> Result<(), Self::Error> {
209        self.with_mut(|this| this.set_timeout_on(timer, relative))
210    }
211
212    fn clear_timeout_on(&mut self, timer: Self::Timer) -> Result<(), Self::Error> {
213        self.with_mut(|this| this.clear_timeout_on(timer))
214    }
215}
216
217impl<R: RawMutex, T: Deref<Target = Mutex<R, U>>, U: Timer> Timer for &WrappedMutex<T> {
218    fn set_timeout(&mut self, relative: Duration) -> Result<(), Self::Error> {
219        self.with_mut(|this| this.set_timeout(relative))
220    }
221
222    fn clear_timeout(&mut self) -> Result<(), Self::Error> {
223        self.with_mut(|this| this.clear_timeout())
224    }
225}
sel4_driver_interfaces/timer.rs

sel4_driver_interfaces/
timer.rs
