Struct circuit_playground_express::timer::TimerCounter

pub struct TimerCounter<TC> { /* fields omitted */ }

A generic hardware timer counter. The counters are exposed in 16-bit mode only. The hardware allows configuring the 8-bit mode and pairing up some instances to run in 32-bit mode, but that functionality is not currently exposed by this hal implementation. TimerCounter implements both the Periodic and the CountDown embedded_hal timer traits. Before a hardware timer can be used, it must first have a clock configured.

Methods

impl<TC> TimerCounter<TC> where
    TC: Count16, 

pub fn enable_interrupt(&mut self)

Enable the interrupt generation for this hardware timer. This method only sets the clock configuration to trigger the interrupt; it does not configure the interrupt controller or define an interrupt handler.

pub fn disable_interrupt(&mut self)

Disables interrupt generation for this hardware timer. This method only sets the clock configuration to prevent triggering the interrupt; it does not configure the interrupt controller.

impl TimerCounter<TC3>

pub fn tc3_(clock: &Tcc2Tc3Clock, tc: TC3, pm: &mut PM) -> TimerCounter<TC3>

Configure this timer counter instance. The clock is obtained from the GenericClockController instance and its frequency impacts the resolution and maximum range of the timeout values that can be passed to the start method. Note that some hardware timer instances share the same clock generator instance and thus will be clocked at the same rate.

impl TimerCounter<TC4>

pub fn tc4_(clock: &Tc4Tc5Clock, tc: TC4, pm: &mut PM) -> TimerCounter<TC4>

Configure this timer counter instance. The clock is obtained from the GenericClockController instance and its frequency impacts the resolution and maximum range of the timeout values that can be passed to the start method. Note that some hardware timer instances share the same clock generator instance and thus will be clocked at the same rate.

impl TimerCounter<TC5>

pub fn tc5_(clock: &Tc4Tc5Clock, tc: TC5, pm: &mut PM) -> TimerCounter<TC5>

Configure this timer counter instance. The clock is obtained from the GenericClockController instance and its frequency impacts the resolution and maximum range of the timeout values that can be passed to the start method. Note that some hardware timer instances share the same clock generator instance and thus will be clocked at the same rate.

Trait Implementations

impl<TC> Periodic for TimerCounter<TC>

impl<TC> CountDown for TimerCounter<TC> where
    TC: Count16, 

type Time = Hertz

The unit of time used by this timer

fn start<T>(&mut self, timeout: T) where
    T: Into<Hertz>, 

Starts a new count down

fn wait(&mut self) -> Result<(), Error<Void>>

Non-blockingly "waits" until the count down finishes