Struct embassy_nrf::timer::Cc

pub struct Cc<'d, T: Instance> { /* private fields */ }

A representation of a timer’s Capture/Compare (CC) register.

A CC register holds a 32-bit value. This is used either to store a capture of the timer’s current count, or to specify the value for the timer to compare against.

The timer will fire the register’s COMPARE event when its counter reaches the value stored in the register. When the register’s CAPTURE task is triggered, the timer will store the current value of its counter in the register

Implementations

impl<'d, T: Instance> Cc<'d, T>

pub fn read(&self) -> u32

Get the current value stored in the register.

pub fn write(&self, value: u32)

Set the value stored in the register.

event_compare will fire when the timer’s counter reaches this value.

pub fn capture(&self) -> u32

Capture the current value of the timer’s counter in this register, and return it.

pub fn task_capture(&self) -> Task<'d>

Returns this CC register’s CAPTURE task, for use with PPI.

When triggered, this task will capture the current value of the timer’s counter in this register.

pub fn event_compare(&self) -> Event<'d>

Returns this CC register’s COMPARE event, for use with PPI.

This event will fire when the timer’s counter reaches the value in this CC register.

pub fn short_compare_clear(&self)

Enable the shortcut between this CC register’s COMPARE event and the timer’s CLEAR task.

This means that when the COMPARE event is fired, the CLEAR task will be triggered.

So, when the timer’s counter reaches the value stored in this register, the timer’s counter will be reset to 0.

pub fn unshort_compare_clear(&self)

Disable the shortcut between this CC register’s COMPARE event and the timer’s CLEAR task.

pub fn short_compare_stop(&self)

Enable the shortcut between this CC register’s COMPARE event and the timer’s STOP task.

This means that when the COMPARE event is fired, the STOP task will be triggered.

So, when the timer’s counter reaches the value stored in this register, the timer will stop counting up.

pub fn unshort_compare_stop(&self)

Disable the shortcut between this CC register’s COMPARE event and the timer’s STOP task.