1.31.16.45 TCx_CompareFrequencyGet Function

C

/* x = TC instance number */
uint32_t TCx_CompareFrequencyGet( void );

Summary

Provides the given 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

TCx_CompareInitialize() function must have been called first.

Parameters

None.

Returns

Frequency (in Hz) at which the timer's counter increments.

Example

uint32_t frequency = 0;
TC0_CompareInitialize();
frequency = TC0_CompareFrequencyGet();

Remarks

None.