diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/cyccnt.rs | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/src/cyccnt.rs b/src/cyccnt.rs index 338bbbe..6bc2ef0 100644 --- a/src/cyccnt.rs +++ b/src/cyccnt.rs @@ -30,6 +30,10 @@ pub struct Instant { impl Instant { /// Returns an instant corresponding to "now" + /// + /// *HEADS UP* this function can, and will, return nonsensical values if called within `init`. + /// Only use it in `idle` and tasks. In `init`, use the `init::Context.start` field, or the + /// `CYCCNT::zero` function, instead of this function pub fn now() -> Self { Instant { inner: DWT::get_cycle_count() as i32, |