Struct rtic_monotonics::rp2040::TIMER

pub struct TIMER { /* private fields */ }

Controls time and alarms
time is a 64 bit value indicating the time in usec since power-on
timeh is the top 32 bits of time & timel is the bottom 32 bits
to change time write to timelw before timehw
to read time read from timelr before timehr
An alarm is set by setting alarm_enable and writing to the corresponding alarm register
When an alarm is pending, the corresponding alarm_running signal will be high
An alarm can be cancelled before it has finished by clearing the alarm_enable
When an alarm fires, the corresponding alarm_irq is set and alarm_running is cleared
To clear the interrupt write a 1 to the corresponding alarm_irq

Implementations

impl TIMER

pub const PTR: *const RegisterBlock = {0x40054000 as *const rp2040_pac::timer::RegisterBlock}

Pointer to the register block

pub const fn ptr() -> *const RegisterBlock

Return the pointer to the register block

pub unsafe fn steal() -> TIMER

Steal an instance of this peripheral

Safety

Ensure that the new instance of the peripheral cannot be used in a way that may race with any existing instances, for example by only accessing read-only or write-only registers, or by consuming the original peripheral and using critical sections to coordinate access between multiple new instances.

Additionally, other software such as HALs may rely on only one peripheral instance existing to ensure memory safety; ensure no stolen instances are passed to such software.

Methods from Deref<Target = RegisterBlock>

pub fn timehw(&self) -> &Reg<TIMEHW_SPEC>

0x00 - Write to bits 63:32 of time
always write timelw before timehw

pub fn timelw(&self) -> &Reg<TIMELW_SPEC>

0x04 - Write to bits 31:0 of time
writes do not get copied to time until timehw is written

pub fn timehr(&self) -> &Reg<TIMEHR_SPEC>

0x08 - Read from bits 63:32 of time
always read timelr before timehr

pub fn timelr(&self) -> &Reg<TIMELR_SPEC>

0x0c - Read from bits 31:0 of time

pub fn alarm0(&self) -> &Reg<ALARM0_SPEC>

0x10 - Arm alarm 0, and configure the time it will fire.
Once armed, the alarm fires when TIMER_ALARM0 == TIMELR.
The alarm will disarm itself once it fires, and can
be disarmed early using the ARMED status register.

pub fn alarm1(&self) -> &Reg<ALARM1_SPEC>

0x14 - Arm alarm 1, and configure the time it will fire.
Once armed, the alarm fires when TIMER_ALARM1 == TIMELR.
The alarm will disarm itself once it fires, and can
be disarmed early using the ARMED status register.

pub fn alarm2(&self) -> &Reg<ALARM2_SPEC>

0x18 - Arm alarm 2, and configure the time it will fire.
Once armed, the alarm fires when TIMER_ALARM2 == TIMELR.
The alarm will disarm itself once it fires, and can
be disarmed early using the ARMED status register.

pub fn alarm3(&self) -> &Reg<ALARM3_SPEC>

0x1c - Arm alarm 3, and configure the time it will fire.
Once armed, the alarm fires when TIMER_ALARM3 == TIMELR.
The alarm will disarm itself once it fires, and can
be disarmed early using the ARMED status register.

pub fn armed(&self) -> &Reg<ARMED_SPEC>

0x20 - Indicates the armed/disarmed status of each alarm.
A write to the corresponding ALARMx register arms the alarm.
Alarms automatically disarm upon firing, but writing ones here
will disarm immediately without waiting to fire.

pub fn timerawh(&self) -> &Reg<TIMERAWH_SPEC>

0x24 - Raw read from bits 63:32 of time (no side effects)

pub fn timerawl(&self) -> &Reg<TIMERAWL_SPEC>

0x28 - Raw read from bits 31:0 of time (no side effects)

pub fn dbgpause(&self) -> &Reg<DBGPAUSE_SPEC>

0x2c - Set bits high to enable pause when the corresponding debug ports are active

pub fn pause(&self) -> &Reg<PAUSE_SPEC>

0x30 - Set high to pause the timer

pub fn intr(&self) -> &Reg<INTR_SPEC>

0x34 - Raw Interrupts

pub fn inte(&self) -> &Reg<INTE_SPEC>

0x38 - Interrupt Enable

pub fn intf(&self) -> &Reg<INTF_SPEC>

0x3c - Interrupt Force

pub fn ints(&self) -> &Reg<INTS_SPEC>

0x40 - Interrupt status after masking & forcing

Trait Implementations

impl Debug for TIMER

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for TIMER

type Target = RegisterBlock

The resulting type after dereferencing.

fn deref(&self) -> &<TIMER as Deref>::Target

Dereferences the value.

impl Send for TIMER