Struct embedded_profiling::dwt_systick::DwtSystick

pub struct DwtSystick<const FREQ: u32> { /* fields omitted */ }

DWT and Systick combination implementing embedded_time::Clock and rtic_monotonic::Monotonic

The frequency of the DWT and SysTick is encoded using the parameter FREQ.

Implementations

impl<const FREQ: u32> DwtSystick<FREQ>

pub fn new(dcb: &mut DCB, dwt: DWT, systick: SYST, sysclk: u32) -> Self

Enable the DWT and provide a new Monotonic based on DWT and SysTick.

Note that the sysclk parameter should come from e.g. the HAL’s clock generation function so the real speed and the declared speed can be compared.

Panics

asserts that the compile time constant FREQ matches the runtime provided sysclk

Trait Implementations

impl<const FREQ: u32> EmbeddedProfiler for DwtSystick<FREQ>

fn read_clock(&self) -> EPInstant

Takes a reading from the clock

fn reset_clock(&mut self)

Optionally reset the clock to zero. This function will be called at the beginning of start_snapshot.

fn log_snapshot(&self, snapshot: &EPSnapshot)

Optionally log the snapshot to some output, like a serial port

fn at_start(&self)

Optional function that gets called at the start of the snapshot recording. If one would want to very simple profiling, they could use at_start and at_end to simply toggle a GPIO.

fn at_end(&self)

Optional function that gets called at the end of the snapshot recording

fn start_snapshot(&mut self) -> EPInstant

takes the starting snapshot of a specific trace

fn end_snapshot(&self, start: EPInstant, name: &'static str) -> EPSnapshot

computes the duration of the snapshot given the start time