Home
7 Timeout Driver
This file recounts the basic use cases and implementation of the Timeout Driver.
7.2 Timeout Driver Example Source Code Reference
This file contains the APIs to demonstrate the common use cases of the Timeout Driver.
7.2.1 Functions
7.2.1.3 periodic_handler_payload
This handler executes a repeating, periodic timer that uses a payload argument.

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.2 Timeout Driver Example Source Code Reference
  This file contains the APIs to demonstrate the common use cases of the Timeout Driver.
  - 7.2.1 Functions
    - 7.2.1.1 oneshot_handler
      This timeout callback handler returns 0, does not reschedule the timer, so will execute only once.
    - 7.2.1.2 periodic_handler
      This timeout callback handler continuously reschedules a periodic timer to timeout with the number of ticks it returns.
    - 7.2.1.3 periodic_handler_payload
      This handler executes a repeating, periodic timer that uses a payload argument.
    - 7.2.1.4 counter_handler
      This handler executes a repeating timer that counts the ticks while an event is going on.
    - 7.2.1.5 Timeout_example_create_sched_oneshot
      Call this function to run a 1000-tick timer once. The timer will not be rescheduled in the associated callback function.
    - 7.2.1.6 Timeout_example_create_sched_periodic
      Call this function to run a 1000-tick timer continuously. The callback function reschedules the timer continuously.
    - 7.2.1.7 Timeout_example_create_sched_periodic_with_payload
      Call this function to run a 1000-tick timer 10 times, with the counter sent as a payload.
    - 7.2.1.8 Timeout_example_stopwatch_mode
      Call this function to count how many timer ticks have elapsed since the start of a timer
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.2.1.3 periodic_handler_payload

This handler executes a repeating, periodic timer that uses a payload argument.

static uint32_t periodic_handler_payload(
    void * payload
)

Parameters

payload

Type: void *

- any value that needs to be passed onto the handler.

Returns

Type: uint32_t