Struct cortex_m::peripheral::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

pub fn is_precise() -> bool

Checks if the calibration value is precise

Returns false if using the reload value returned by get_ticks_per_10ms() may result in a period significantly deviating from 10 ms.

source

pub fn set_clock_source(&mut self, clk_source: SystClkSource)

Sets clock source

source

pub fn set_reload(&mut self, value: u32)

Sets reload value

Valid values are between 1 and 0x00ffffff.

NOTE To make the timer wrap every N ticks set the reload value to N - 1

source§

impl SYST

source

pub const PTR: *const RegisterBlock = {0xe000e010 as *const peripheral::syst::RegisterBlock}

Pointer to the register block

source

pub const fn ptr() -> *const RegisterBlock

👎Deprecated since 0.7.5: Use the associated constant PTR instead

Returns a pointer to the register block

Trait Implementations§

source§

impl Deref for SYST

§

type Target = RegisterBlock

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl Send for SYST

Auto Trait Implementations§

§

impl Freeze for SYST

§

impl RefUnwindSafe for SYST

§

impl !Sync for SYST

§

impl Unpin for SYST

§

impl UnwindSafe for SYST

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.