1.15.2.23 CCPx_Compare32bitPeriodValueGet Function

C

/* x = CCP instance number */

uint32_t CCPx_Compare32bitPeriodValueGet( void )

Summary

Reads the period value of given timer.

Description

This function reads the value of period.

Precondition

CCPx_CompareInitialize() function must have been called first.

Parameters

None.

Returns

uint32_t - The timer's period value.

Example

uint32_t period = 0;
CCP1_CompareInitialize();
period = CCP1_Compare32bitPeriodValueGet();

Remarks

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