Home
7 Timeout Driver
This file recounts the basic use cases and implementation of the Timeout Driver.
7.1 Timeout Driver Source Code Reference
This file contains the Timeout Driver APIs.
7.1.2 Functions
7.1.2.17 timeout_create
This function adds to the queue and starts the timer. If the timer was already active/running it will be replaced by this and the old (active) timer will be removed/cancelled first.

Foundation Services

1 Introduction and Objectives of Foundation Services
Foundation Services is a collection of software components such as peripheral drivers, middleware, and software applications (examples) provided by Microchip. The framework supports the Microchip's 8- and 16- bit PIC, as well as AVR families of microcontrollers.
2 Getting Started: Foundation Services in MCC
3 Delay Drivers
4 I2C Drivers
5 Real Time Counter
This file explains the basic use cases and implementation of the Real Time Counter.
6 SPI Drivers
The driver provides basic SPI functionality supporting both Master and Slave, each with or without interrupts.
7 Timeout Driver
This file recounts the basic use cases and implementation of the Timeout Driver.
- 7.1 Timeout Driver Source Code Reference
  This file contains the Timeout Driver APIs.
  - 7.1.1 Structs
  - 7.1.2 Functions
    - 7.1.2.1 timeout_hasPendingTimeouts
      Call this function to check if there are any timers running or waiting to be called
    - 7.1.2.2 timeout_hasPendingCallbacks
      Call this function to check if there are events that are being executed or waiting to be executed
    - 7.1.2.3 stopTimeouts
      This function disables all the timers without deleting them from the list. Timers can be restarted by calling startTimerAtHead
    - 7.1.2.4 setTimerDuration
      This sets the number of ticks the timer will run for.
    - 7.1.2.5 makeAbsolute
      This function takes a number of ticks and returns the total number of timer ticks since the last timeout occurred or the timer module was started.
    - 7.1.2.6 timeout_getTimeRemaining
      This function gets the number of ticks remaining before a specific timer runs out.
    - 7.1.2.7 rebaseList
      This function adjusts the time base so that the timer can never wrap
    - 7.1.2.8 printList
      This function prints the times for each of the timer for each timer on the queue.
    - 7.1.2.9 sortedInsert
      This function figures out where the specific timer will be placed on the queue.
    - 7.1.2.10 startTimerAtHead
      This function starts the timer queue from the beginning.
    - 7.1.2.11 timeout_flushAll
      This function cancels and removes all timers in the queue
    - 7.1.2.12 timeout_deleteHelper
      This function looks for a specific timer instance and removes it from the queue.
    - 7.1.2.13 timeout_delete
      This function cancels and removes a running timer
    - 7.1.2.14 enqueueCallback
      This function moves a specific timer from the active list to the list of timers which are expired and needs their callbacks called in callNextCallback
    - 7.1.2.15 timeout_callNextCallback
      This function checks the list of expired timers and calls the first one in the list if the list is not empty. It also reschedules the timer if the callback returned a value greater than 0.It is recommended this is called from the main superloop (while(1)) in your code but by design this can also be called from the timer ISR. If you wish callbacks to happen from the ISR context you can call this as the last action in timeout_isr instead.
    - 7.1.2.16 timeout_initialize
      This function sets the timeout ISR handler as the the interrupt handler for the timer.
    - 7.1.2.17 timeout_create
      This function adds to the queue and starts the timer. If the timer was already active/running it will be replaced by this and the old (active) timer will be removed/cancelled first.
    - 7.1.2.18 timeout_isr
      This function is the handler that is called whenever the Timer peripheral interrupts. The handler counts the time elapsed and calls the next timer in the queue. It assumes that the callback is completed before the next timer tick.
    - 7.1.2.19 timeout_startTimer
      This function is specifically used in Stopwatch/cycle counter mode. It will start a timer with maximum timeout of up to the maximum range of the timer divided by 2.
    - 7.1.2.20 timeout_stopTimer
      This function is specifically used in Stopwatch/cycle counter mode. It will stop the running timer and return the number of ticks it counted.
- 7.2 Timeout Driver Example Source Code Reference
  This file contains the APIs to demonstrate the common use cases of the Timeout Driver.
8 UART Drivers
9 File List
Here is a list of all documented files with brief descriptions
10 Class List
Here is a list of all documented files with brief descriptions
The Microchip Website
Product Change Notification Service
Customer Support
Product Identification System
Microchip Devices Code Protection Feature
Legal Notice
Trademarks
Quality Management System
Worldwide Sales and Service

7.1.2.17 timeout_create

This function adds to the queue and starts the timer. If the timer was already active/running it will be replaced by this and the old (active) timer will be removed/cancelled first.

void timeout_create(
    timerStruct_t * timer,    uint32_t timeout
)

Parameters

*timer

Type: timerStruct_t *

- timer instance to be created and added to the list

timeout

Type: uint32_t

- number of timer ticks before this timer expires.

Returns

Type: void