SwTimer#

ESwTimerStatus#

ESwTimerStatus

Defines return values from SwTimer methods.

ESwTimerStatus#

typedef enum ESwTimerStatus ESwTimerStatus

Defines return values from SwTimer methods.

SSwTimerLiaisonPtr#

typedef struct SSwTimerLiaison* SSwTimerLiaisonPtr

Typedef needed to include pointer for struct SSwTimerLiaison in struct SSwTimer, without requiring include of definition SSwTimerLiaison.

SSwTimer#

typedef struct SSwTimer SSwTimer

SSwTimerPrivate_t#

typedef struct SSwTimerPrivate_t SSwTimerPrivate_t

Timer Liaison object.

All content is private.

TimerSetCallback#

void TimerSetCallback (SSwTimer * pTimer, void(*)(SSwTimer *pTimer) pCallback)

Configures the callback method called on timer timeout.

If called on a timer that has a pending callback, the callback will be executed on the new callback method.

TimerStart#

ESwTimerStatus TimerStart (SSwTimer * pTimer, uint32_t iTimeout)

Configures Timer timeout and starts the timer.

If method is called on a timer that is already started, the timer will restart from zero and count towards the new timeout.

TimerStartFromISR#

ESwTimerStatus TimerStartFromISR (SSwTimer * pTimer, uint32_t iTimeout)

Configures Timer timeout and starts the timer from an Interrupt Service Routine.

If method is called on a timer that is already started, the timer will restart from zero and count towards the new timeout.

TimerRestart#

ESwTimerStatus TimerRestart (SSwTimer * pTimer)

Restarts the timer.

Starts an inactive timer. If called on a timer that is already started, the timer will restart from zero.

TimerRestartFromISR#

ESwTimerStatus TimerRestartFromISR (SSwTimer * pTimer)

Restarts the timer.

Starts an inactive timer. If called on a timer that is already started, the timer will restart from zero.

TimerStop#

ESwTimerStatus TimerStop (SSwTimer * pTimer)

Stops an active timer.

Method may be called on inactive timers. Any pending callbacks that has not been performed yet will be cleared.

TimerStopFromISR#

ESwTimerStatus TimerStopFromISR (SSwTimer * pTimer)

Stops an active timer from an Interrupt Service Routine.

Method may be called on inactive timers. Any pending callbacks that has not been performed yet will be cleared.

TimerIsActive#

bool TimerIsActive (SSwTimer * pTimer)

Returns if the timer is active.

Active is defined as the timer counting, or having a pending callback.

TimerHasPendingCallback#

bool TimerHasPendingCallback (SSwTimer * pTimer)

Returns if timer has a timeout callback pending.

TimerHasPendingCallbackFromISR#

bool TimerHasPendingCallbackFromISR (SSwTimer * pTimer)

Returns if timer has a timeout callback pending from an Interrupt Service Routine.

TimerGetMsUntilTimeout#

ESwTimerStatus TimerGetMsUntilTimeout (SSwTimer * pTimer, uint32_t refTaskTickCount, uint32_t * pMsUntilTimeout)

Queries a timer for number of milliseconds remaining before time out Method may be called on inactive timers, but in that case ESWTIMER_STATUS_FAILED will be returned and pMsUntilTimeout will not be modified.

TimerGetPeriod#

uint32_t TimerGetPeriod (SSwTimer * pTimer)

Returns the period of a freeRTOS timer.

PRIVATE_TIMER_SIZE#

#define PRIVATE_TIMER_SIZE

11

Space for holding FreeRTOS StaticEventGroup_t and EventGroupHandle_t.