1.31.16.30 TCx_Compare16bitPeriodGet Function

C

/* x = TC instance number */
uint16_t TCx_Compare16bitPeriodGet( void );

Summary

Reads the period value of given timer.

Description

This function reads the value of period.

Precondition

TCx_CompareInitialize() function must have been called first.

Parameters

None.

Returns

Timer's period value

Example

uint16_t period = 0;
TC0_CompareInitialize();
period = TC0_Compare16bitPeriodGet();

Remarks

The caller must know the number of significant bytes of timer. Period value is right-aligned.