stk::hw::HiResClock Class Reference

High-resolution clock for high-precision measurements. More...

#include <stk_arch.h>

Static Public Member Functions
static Cycles	GetCycles ()
	Get number of clock cycles elapsed.
static uint32_t	GetFrequency ()
	Get clock frequency.
static Ticks	GetTimeUs ()
	Get elapsed time in microseconds.

Detailed Description

High-resolution clock for high-precision measurements.

Definition at line 437 of file stk_arch.h.

Member Function Documentation

GetCycles()

Cycles stk::hw::HiResClock::GetCycles ( )

static

Get number of clock cycles elapsed.

Note

ISR-safe.

Returns

Clock cycles.

Referenced by GetTimeUs(), and stk_hires_cycles().

Here is the caller graph for this function:

GetFrequency()

uint32_t stk::hw::HiResClock::GetFrequency ( )

static

Get clock frequency.

Note

ISR-safe.

Returns

Frequency in Hz.

Referenced by GetTimeUs(), and stk_hires_frequency().

Here is the caller graph for this function:

GetTimeUs()

Ticks stk::hw::HiResClock::GetTimeUs ( )

inlinestatic

Get elapsed time in microseconds.

Note

ISR-safe.

Returns

Microseconds.

Definition at line 455 of file stk_arch.h.

    {
        uint32_t freq = GetFrequency();
        STK_ASSERT(freq != 0); // guaranteed non-zero
 
        return static_cast<Ticks>((GetCycles() * 1000000ULL) / freq);
    }

References GetCycles(), GetFrequency(), and STK_ASSERT.

Referenced by stk_hires_time_us().

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• stk_arch.h