1.1.5.2 HTMx_CallbackRegister Function

C

/* x = HTM timer instance number */

void HTMx_CallbackRegister( HTM_TMR_CALLBACK callback_fn, uintptr_t context )

Summary

Allows application to register a callback with the PLIB

Description

This function sets the pointer to a client/application function to be called "back" when the HTM timer expires. It also passes a context value (usually a pointer to a context structure) that is passed into the function when it is called. The specified callback function will be called from the peripheral interrupt context. The callback should be registered before starting the timer.

Precondition

HTMx_Initialize() function must have been called first.

Parameters


Param	Description
callback_fn	A pointer to a function with a calling signature defined by the HTM_TMR_CALLBACK data type. Setting this to NULL disables the callback feature.
context	A value (usually a pointer) which is passed (unused) into the function identified by the callback parameter

Returns

None

Example

void htm_timeout_callback(uintptr_t context)
{
    /* Handle HTM timer timeout */
    
    /* Restart the HTM timer */
    HTM0_PeriodSet(32768);
}

HTM0_CallbackRegister(htm_timeout_callback, 0);

Remarks

None