3.6 Timeout Driver

• struct tmrStruct_t

  Defines a timer instance.

• void stopTimeouts (void)

  Disables all the timers without deleting them. Timers can be restarted by calling starTimerAtHead.

• INLINE void setTimerDuration (uint32_t duration)

  Sets the number of ticks the timer will run for.

• INLINE uint32_t makeAbsolute (uint32_t timeout)

  Returns the total number of timer ticks since the last time-out occurred or since the module was started.

• INLINE uint32_t rebaseList (void)

  Adjusts the time base so that the timer can never wrap.

• INLINE void printList (void)

  Prints the times for each of the timers on the queue.

• bool sortedInsert (timerStruct_t *timer)

  Shows where the specific timer will be placed on the queue.

• void startTimerAtHead (void)

  Starts the timer queue from the beginning.

• bool timeout_deleteHelper (timerStruct_t *volatile *list, timerStruct_t *timer)

  Looks for a specific timer instance and removes it from the queue.

• INLINE void enqueueCallback (timerStruct_t *timer)

  Queues the timers that need their callback called with callNextCallback.

• void timeout_initialize (void)

  Sets the time-out Interrupt Service Routine (ISR) handler as the interrupt handler for the timer.

• void timeout_create (timerStruct_t *timer, uint32_t timeout)

  Queues and starts the timer. The running timer is cancelled and a new timer will start.

• void timeout_delete (timerStruct_t *timer)

  Cancels and removes a running timer.

• void timeout_flushAll (void)

  Cancels and removes all the timers in the queue.

• bool timeout_hasPendingTimeouts (void)

  Checks if there are any timers running or waiting to be called.

• bool timeout_hasPendingCallbacks (void)

  Checks if there are events being executed or waiting to be executed.

• INLINE void timeout_callNextCallback (void)

  Checks the list of expired timers and calls the first one.

• void timeout_isr (void)

  Handler function called whenever the timer peripheral interrupts. It counts the time elapsed and calls the next timer in the queue. It assumesthat the callback is complete before the next timer tick.

• void timeout_startTimer (timerStruct_t *timer)

  Starts a timer with maximum time-out which can be up to the maximum range of the timer divided by two only in Stopwatch/Cycle Counter mode.

• uint32_t timeout_stopTimer (timerStruct_t *timer)

  Stops the running timer and returns the number of ticks it counted, but only in Stopwatch/Cycle Counter mode.

• uint32_t timeout_getTimeRemaining (timerStruct_t *timer)

  Gets the number of ticks remaining before a specific timer runs out.

void enqueueCallback (timerStruct_t * timer)[inline]

Queues the timers that need their callback called with callNextCallback.

uint32_t makeAbsolute (uint32_t timeout)[inline]

Returns the total number of timer ticks since the last time-out occurred or since the module was started.

void printList (void )[inline]

Prints the times for each of the timers on the queue.

uint32_t rebaseList (void )[inline]

Adjusts the time base so that the timer can never wrap.

void setTimerDuration (uint32_t duration)[inline]

Sets the number of ticks the timer will run for.

bool sortedInsert (timerStruct_t * timer)

Shows where the specific timer will be placed on the queue.

void startTimerAtHead (void )

Starts the timer queue from the beginning.

void stopTimeouts (void )

Disables all the timers without deleting them. Timers can be restarted by calling starTimerAtHead.

INLINE void timeout_callNextCallback (void )[inline]

Checks the list of expired timers and calls the first one.

If the callback returned a value greater than 0, it reschedules the timer. It is recommended this is called from the main superloop (while(1)) in the code but, by design, it can also be called from the timer ISR as the last action in timeout_isr.

void timeout_create (timerStruct_t * timer, uint32_t timeout)

Queues and starts the timer. The running timer is cancelled and a new timer will start.

void timeout_delete (timerStruct_t * timer)

Cancels and removes a running timer.

bool timeout_deleteHelper (timerStruct_t *volatile * list, timerStruct_t * timer)

Looks for a specific timer instance and removes it from the queue.

void timeout_flushAll (void )

Cancels and removes all the timers in the queue.

uint32_t timeout_getTimeRemaining (timerStruct_t * timer)

Gets the number of ticks remaining before a specific timer runs out.

bool timeout_hasPendingCallbacks (void )

Checks if there are events being executed or waiting to be executed.

bool timeout_hasPendingTimeouts (void )

Checks if there are any timers running or waiting to be called.

void timeout_initialize (void )

Sets the time-out Interrupt Service Routine (ISR) handler as the interrupt handler for the timer.

void timeout_isr (void )

Handler function called whenever the timer peripheral interrupts. It counts the time elapsed and calls the next timer in the queue. It assumesthat the callback is complete before the next timer tick.

void timeout_startTimer (timerStruct_t * timer)

Starts a timer with maximum time-out which can be up to the maximum range of the timer divided by two only in Stopwatch/Cycle Counter mode.

uint32_t timeout_stopTimer (timerStruct_t * timer)

Stops the running timer and returns the number of ticks it counted, but only in Stopwatch/Cycle Counter mode.

uint32_t absoluteTime

The number of ticks the timer will count down.

timercallback_ptr_t callbackPtr

Pointer to the callback handler.

struct tmrStruct* next

Pointer to the next timer on the queue.

void* payload

The value that can be passed on to the callback.

uint32_t dummyHandler (void * payload)

volatile uint32_t absoluteTimeofLastTimeout = 0

timerStruct_t dummy

timerStruct_t dummy_exec = {dummyHandler}

timerStruct_t* volatile executeQueueHead = NULL

volatile bool isRunning = false

volatile uint32_t lastTimerLoad = 0

timerStruct_t* listHead = NULL

#define INLINE inline

#define timeout_mSecToTicks( a) ( ((uint32_t)(a)) * 32UL )

#define timeout_ticksToMsec( a) ( ((uint32_t)(a)) / 32UL )

typedef uint32_t(* timercallback_ptr_t) (void *payload)

typedef struct tmrStruct timerStruct_t