Struct rtic_monotonics::systick::SYST

source ·

pub struct SYST { /* private fields */ }

Expand description

SysTick: System Timer

Implementations§

source §

impl SYST

source

pub fn clear_current(&mut self)

Clears current value to 0

After calling clear_current(), the next call to has_wrapped() will return false.

source

pub fn disable_counter(&mut self)

Disables counter

source

pub fn disable_interrupt(&mut self)

Disables SysTick interrupt

source

pub fn enable_counter(&mut self)

Enables counter

NOTE The reference manual indicates that:

“The SysTick counter reload and current value are undefined at reset, the correct initialization sequence for the SysTick counter is:

Program reload value
Clear current value
Program Control and Status register“

The sequence translates to self.set_reload(x); self.clear_current(); self.enable_counter()

source

pub fn enable_interrupt(&mut self)

Enables SysTick interrupt

source

pub fn get_clock_source(&mut self) -> SystClkSource

Gets clock source

NOTE This takes &mut self because the read operation is side effectful and can clear the bit that indicates that the timer has wrapped (cf. SYST.has_wrapped)

source

pub fn get_current() -> u32

Gets current value

source

pub fn get_reload() -> u32

Gets reload value

source

pub fn get_ticks_per_10ms() -> u32

Returns the reload value with which the counter would wrap once per 10 ms

Returns 0 if the value is not known (e.g. because the clock can change dynamically).

source

pub fn has_reference_clock() -> bool

Checks if an external reference clock is available

source

pub fn has_wrapped(&mut self) -> bool

Checks if the counter wrapped (underflowed) since the last check

NOTE This takes &mut self because the read operation is side effectful and will clear the bit of the read register.

source

pub fn is_counter_enabled(&mut self) -> bool

Checks if counter is enabled

NOTE This takes &mut self because the read operation is side effectful and can clear the bit that indicates that the timer has wrapped (cf. SYST.has_wrapped)

source

pub fn is_interrupt_enabled(&mut self) -> bool

Checks if SysTick interrupt is enabled

NOTE This takes &mut self because the read operation is side effectful and can clear the bit that indicates that the timer has wrapped (cf. SYST.has_wrapped)

source