1.14.2.9 CCPx_Timer32bitPeriodGet Function

C

/* x = CCP instance number */

uint32_t CCPx_Timer32bitPeriodGet( void )

Summary

Reads the period value of given timer.

Description

This function reads the value of period.

Precondition

CCPx_TimerInitialize() function must have been called first.

Parameters

None.

Returns

uint32_t - The timer's period value.

Example

uint32_t period = 0;
CCP1_TimerInitialize();
period = CCP1_Timer32bitPeriodGet();

Remarks

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