SwTimerLiasion#

ESwTimerLiaisonStatus#

ESwTimerLiaisonStatus

Defines return values from SwTimerLiaison methods.

ESwTimerLiaisonStatus#

typedef enum ESwTimerLiaisonStatus ESwTimerLiaisonStatus

Defines return values from SwTimerLiaison methods.

SSwTimerLiaison#

typedef struct SSwTimerLiaison SSwTimerLiaison

TimerLiaison object.

All content is private.

TimerLiaisonInit#

void TimerLiaisonInit (SSwTimerLiaison * pThis, uint32_t iTimerPointerArraySize, SSwTimer ** pTimerPointerArray, uint8_t iTaskNotificationBitNumber, void * ReceiverTask)

Initialize TimerLiaison.

TimerLiaisonSetReceiverTask#

void TimerLiaisonSetReceiverTask (SSwTimerLiaison * pThis, void * ReceiverTask)

Configures the Receiver task of callbacks.

Provided as the TimerLiaison may be needed for registrering SwTimers before the receiver task is created, meaning TimerLiaision init is called prior to the Receiver task handle being available. Though not the intention, the receiver task can be changed run time.

TimerLiaisonRegister#

ESwTimerLiaisonStatus TimerLiaisonRegister (SSwTimerLiaison * pThis, SSwTimer * pTimer, bool bAutoReload, void(*)(SSwTimer *pTimer) pCallback)

Register a SwTimer to a TimerLiaison.

Initial SwTimer configuration is also performed.

Method creates a static FreeRTOS timer from the SwTimer object passed as argument. An SwTimer can NOT be registered to several TimerLiaisons. If calling method TimerLiaisonRegister on the same SwTimer object multiple times, all but the first call will be ignored. Unregistered timers are expected to be zero initialized SSwTimer structs.

TimerLiaisonNotificationHandler#

void TimerLiaisonNotificationHandler (SSwTimerLiaison * pThis)

Must be called from requested callback task when the task notification bit assigned to TimerLiaison is set.

Method will perform pending callbacks. There is no side effects from calling method when assigned task notification bit was not set.

TimerLiaisonClearPendingTimerEvent#

void TimerLiaisonClearPendingTimerEvent (SSwTimerLiaison * pThis, uint32_t TimerId)

Method provided for the SwTimers to call.

Method clears pending timeout callback (if one is pending).

TimerLiaisonClearPendingTimerEventFromISR#

void TimerLiaisonClearPendingTimerEventFromISR (SSwTimerLiaison * pThis, uint32_t TimerId)

Method provided for the SwTimers to call from ISR.

Method clears pending timeout callback (if one is pending).

TimerLiaisonHasPendingTimerEvent#

bool TimerLiaisonHasPendingTimerEvent (SSwTimerLiaison * pThis, uint32_t TimerId)

Method provided for the SwTimers to call.

Method returns if a timer has a pending timeout callback.

TimerLiaisonHasPendingTimerEventFromISR#

bool TimerLiaisonHasPendingTimerEventFromISR (SSwTimerLiaison * pThis, uint32_t TimerId)

Method provided for the SwTimers to call from ISR.

Method returns if a timer has a pending timeout callback.

PRIVATE_STATIC_TIMER_SIZE#

#define PRIVATE_STATIC_TIMER_SIZE

9

Space for holding FreeRTOS StaticTimer_t.