Struct systick_monotonic::Systick

pub struct Systick<const TIMER_HZ: u32> { /* private fields */ }

Systick implementing rtic_monotonic::Monotonic which runs at a settable rate using the TIMER_HZ parameter.

Implementations

impl<const TIMER_HZ: u32> Systick<TIMER_HZ>

pub fn new(systick: SYST, sysclk: u32) -> Self

Provide a new Monotonic based on SysTick.

The sysclk parameter is the speed at which SysTick runs at. This value should come from the clock generation function of the used HAL.

Notice that the actual rate of the timer is a best approximation based on the given sysclk and TIMER_HZ.

Trait Implementations

impl<const TIMER_HZ: u32> Monotonic for Systick<TIMER_HZ>

const DISABLE_INTERRUPT_ON_EMPTY_QUEUE: bool = false

This tells RTIC if it should disable the interrupt bound to the monotonic if there are no scheduled tasks. One may want to set this to false if one is using the on_interrupt method to perform housekeeping and need overflow interrupts to happen, such as when extending a 16 bit timer to 32/64 bits, even if there are no scheduled tasks.

type Instant = Instant<u64, 1, TIMER_HZ>

The type for instant, defining an instant in time.

type Duration = Duration<u64, 1, TIMER_HZ>

The type for duration, defining an duration of time.

fn now(&mut self) -> Self::Instant

Get the current time.

unsafe fn reset(&mut self)

Optionally resets the counter to zero for a fixed baseline in a system.

fn set_compare(&mut self, _val: Self::Instant)

Set the compare value of the timer interrupt.

fn clear_compare_flag(&mut self)

Clear the compare interrupt flag.

fn zero() -> Self::Instant

The time at time zero. Used by RTIC before the monotonic has been initialized.

fn on_interrupt(&mut self)

Optional. Commonly used for performing housekeeping of a timer when it has been extended, e.g. a 16 bit timer extended to 32/64 bits. This will be called at the end of the interrupt handler after all other operations have finished.

fn enable_timer(&mut self)

Optional. This is used to save power, this is called when the Monotonic interrupt is enabled.

fn disable_timer(&mut self)

Optional. This is used to save power, this is called when the Monotonic interrupt is disabled.