Struct stm32l4xx_hal::lptimer::LowPowerTimer

pub struct LowPowerTimer<LPTIM> { /* private fields */ }

A low power hardware timer

Supported things:

• Compare match
• Auto reload matches

Implementations

impl LowPowerTimer<LPTIM1>

pub fn lptim1(
    lptim: LPTIM1,
    config: LowPowerTimerConfig,
    apb1rn: &mut <LPTIM1 as RccBus>::Bus,
    ccipr: &mut CCIPR,
    clocks: Clocks
) -> Self

Consume the LPTIM and produce a LowPowerTimer that encapsulates said LPTIM.

config contains details about the desired configuration for the LowPowerTimer

Panics

This function panics if the value of ARR is less than or equal to CMP, and if the clock source is HSI16, LSI, or LSE and that clock is not enabled.

pub fn listen(&mut self, event: Event)

Enable interrupts for the specified event

pub fn unlisten(&mut self, event: Event)

Disable interrupts for the specified event

pub fn is_event_triggered(&self, event: Event) -> bool

Check if the specified event has been triggered for this LowPowerTimer.

If this function returns true for an Event that this LowPowerTimer is listening for, LowPowerTimer::clear_event_flag must be called for that event to prevent the interrupt from looping eternally. This is not done in a single function to avoid using a mutable reference for an operation that does not require it.

pub fn clear_event_flag(&mut self, event: Event)

Clear the interrupt flag for the specified event

pub fn set_compare_match(&mut self, value: u16)

Set the compare match field for this LowPowerTimer

pub fn set_autoreload(&mut self, arr_value: u16)

Set auto reload register has to be used after enabling of lptim

pub fn get_counter(&self) -> u16

Get the current counter value for this LowPowerTimer

pub fn get_arr(&self) -> u16

Get the value of the ARR register for this LowPowerTimer

pub fn pause(&mut self)

pub fn resume(&mut self)

impl LowPowerTimer<LPTIM2>

pub fn lptim2(
    lptim: LPTIM2,
    config: LowPowerTimerConfig,
    apb1rn: &mut <LPTIM2 as RccBus>::Bus,
    ccipr: &mut CCIPR,
    clocks: Clocks
) -> Self

Consume the LPTIM and produce a LowPowerTimer that encapsulates said LPTIM.

config contains details about the desired configuration for the LowPowerTimer

Panics

This function panics if the value of ARR is less than or equal to CMP, and if the clock source is HSI16, LSI, or LSE and that clock is not enabled.

pub fn listen(&mut self, event: Event)

Enable interrupts for the specified event

pub fn unlisten(&mut self, event: Event)

Disable interrupts for the specified event

pub fn is_event_triggered(&self, event: Event) -> bool

Check if the specified event has been triggered for this LowPowerTimer.

If this function returns true for an Event that this LowPowerTimer is listening for, LowPowerTimer::clear_event_flag must be called for that event to prevent the interrupt from looping eternally. This is not done in a single function to avoid using a mutable reference for an operation that does not require it.

pub fn clear_event_flag(&mut self, event: Event)

Clear the interrupt flag for the specified event

pub fn set_compare_match(&mut self, value: u16)

Set the compare match field for this LowPowerTimer

pub fn set_autoreload(&mut self, arr_value: u16)

Set auto reload register has to be used after enabling of lptim

pub fn get_counter(&self) -> u16

Get the current counter value for this LowPowerTimer

pub fn get_arr(&self) -> u16

Get the value of the ARR register for this LowPowerTimer

pub fn pause(&mut self)

pub fn resume(&mut self)