Struct imxrt_hal::pit::Chained

pub struct Chained<const L: u8, const H: u8> { /* private fields */ }

Two chained PIT timer channels.

When the low timer counts down to zero, the high timer is decremented by one. This doubles the width of the timer.

Timers must be chained in sequence. For example, timer 2 (high) can be chained to timer 1 (low). But, timer 3 cannot be chained to timer 1.

Chaining channel 1 and 0 enables the lifetime register. The lifetime register allows us to read two 32-bit registers without rollover. Otherwise, the implementation handles rollovers in software with a small loop and comparison.

Implementations

impl Chained<0, 1>

pub fn new(low: Pit<0>, high: Pit<1>) -> Self

Chain together channels 0 and 1.

This creates the lifetime timer.

pub fn lifetime_value(&self) -> u64

Read the lifetime register value.

This is only supported when chaining channels 0 and channel 1. Returns 0 if the timer is disabled. The lifetime registers account for rollover possibility in hardware.

This method implements the recommended fix for errata ERR050130.

impl Chained<1, 2>

pub fn new(low: Pit<1>, high: Pit<2>) -> Self

Chain together channels 1 and 2.

impl Chained<2, 3>

pub fn new(low: Pit<2>, high: Pit<3>) -> Self

Chain together channels 2 and 3.

impl<const L: u8, const H: u8> Chained<L, H>

pub fn release(self) -> (Pit<L>, Pit<H>)

Release the chained timers.

When release returns, the timer chain is disabled, and the timer channels are disabled.

pub fn set_interrupt_enable(&mut self, enable: bool)

Enable (true) or disable (false) interrupt generation when the chained timer expires.

pub fn is_interrupt_enabled(&self) -> bool

Indicates if timeouts will (true) or will not (false) generate interrupts.

pub fn set_load_timer_value(&mut self, ticks: u64)

Loads the timer value for the next timer run.

ticks is in clock ticks.

pub fn load_timer_value(&self) -> u64

Returns the load timer value for the next timer run, in ticks.

pub fn current_timer_value(&self) -> u64

Reads the current timer value, in clock ticks.

Returns 0 if the timer is disabled.

pub fn enable(&mut self)

Enable the chained timer.

pub fn disable(&mut self)

Disable the chained timer.

pub fn is_enabled(&self) -> bool

Returns true if the chained timer is enabled.

pub fn is_elapsed(&self) -> bool

Returns true if the chained timer has elapsed.

pub fn clear_elapsed(&mut self)

Clear the elapsed flag.