1.18.5.7 CORETIMER_FrequencyGet Function

C

uint32_t CORETIMER_FrequencyGet(void);

Summary

Provides the given Core timer's counter-increment frequency.

Description

This function provides the frequency at which the given counter increments. It can be used to convert differences between counter values to real time or real-time intervals to timer period values.

Precondition

CORETIMER_Initialize() function must have been called first.

Parameters

None.

Returns

frequency - The frequency (in Hz) at which the timer counter increments.

Example

uint32_t frequency;

CORETIMER_Initialize();
frequency = CORETIMER_FrequencyGet();

Remarks

Should be generated for interrupt mode only.