111 lines
4.9 KiB
C
111 lines
4.9 KiB
C
/**
|
|
* TIMER Generated Driver Interface Header File
|
|
*
|
|
* @file timer_interface.h
|
|
*
|
|
* @defgroup timerdriver Timer Driver
|
|
*
|
|
* @brief The Timer driver is an 8-bit, 16-bit or 32-bit timer that can operate as a
|
|
* free-running interval timer using PIC®, dsPIC® and AVR® microcontrollers (MCUs).
|
|
*
|
|
* @skipline @version Firmware Driver Version 1.7.0
|
|
*/
|
|
|
|
/*
|
|
© [2025] Microchip Technology Inc. and its subsidiaries.
|
|
|
|
Subject to your compliance with these terms, you may use Microchip
|
|
software and any derivatives exclusively with Microchip products.
|
|
You are responsible for complying with 3rd party license terms
|
|
applicable to your use of 3rd party software (including open source
|
|
software) that may accompany Microchip software. SOFTWARE IS ?AS IS.?
|
|
NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS
|
|
SOFTWARE, INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT,
|
|
MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
|
|
WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
|
|
INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY
|
|
KIND WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF
|
|
MICROCHIP HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE
|
|
FORESEEABLE. TO THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP?S
|
|
TOTAL LIABILITY ON ALL CLAIMS RELATED TO THE SOFTWARE WILL NOT
|
|
EXCEED AMOUNT OF FEES, IF ANY, YOU PAID DIRECTLY TO MICROCHIP FOR
|
|
THIS SOFTWARE.
|
|
*/
|
|
|
|
#ifndef TIMER_INTERFACE_H
|
|
#define TIMER_INTERFACE_H
|
|
|
|
// Section: Included Files
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
|
|
// Section: Data Type Definitions
|
|
|
|
/**
|
|
* @ingroup timerdriver
|
|
* @brief Defines the deprecated SCCPx_Timer_PeriodCountSet or TMRx_PeriodCountSet API.
|
|
* Set it to 1 for backward compatibility for 16-bit MCUs only.
|
|
*/
|
|
#define TIMER_PERIODCOUNTSET_API_SUPPORT 0
|
|
|
|
/**
|
|
* @ingroup timerdriver
|
|
* @brief The InterruptPrioritySet API is not supported.
|
|
*/
|
|
#define TIMER_INTERRUPT_PRIORITY_SUPPORT 0
|
|
|
|
/**
|
|
@ingroup timerdriver
|
|
@struct TIMER_INTERFACE
|
|
@brief Structure containing the function pointers of the Timer driver
|
|
*/
|
|
struct TIMER_INTERFACE
|
|
{
|
|
void (*Initialize)(void);
|
|
///< Pointer to MCCPx_Timer_Initialize, SCCPx_Timer_Initialize or TMRx_Initialize (e.g., \ref SCCP1_Timer_Initialize or \ref TMR1_Initialize).
|
|
|
|
void (*Deinitialize)(void);
|
|
///< Pointer to MCCPx_Timer_Deinitialize, SCCPx_Timer_Deinitialize or TMRx_Deinitialize (e.g., \ref SCCP1_Timer_Deinitialize or \ref TMR1_Deinitialize).
|
|
|
|
void (*Start)(void);
|
|
///< Pointer to MCCPx_Timer_Start, SCCPx_Timer_Start or TMRx_Start (e.g., \ref SCCP1_Timer_Start or \ref TMR1_Start).
|
|
|
|
void (*Stop)(void);
|
|
///< Pointer to MCCPx_Timer_Stop, SCCPx_Timer_Stop or TMRx_Stop (e.g., \ref SCCP1_Timer_Stop or \ref TMR1_Stop).
|
|
|
|
#if TIMER_PERIODCOUNTSET_API_SUPPORT
|
|
void (*PeriodCountSet)(size_t count);
|
|
///< Pointer to MCCPx_Timer_PeriodCountSet, SCCPx_Timer_PeriodCountSet or TMRx_PeriodCountSet (e.g., \ref SCCP1_Timer_PeriodCountSet or \ref TMR1_PeriodCountSet).
|
|
#endif
|
|
|
|
void (*PeriodSet)(uint32_t count);
|
|
///< Pointer to MCCPx_Timer_PeriodSet, SCCPx_Timer_PeriodSet or TMRx_PeriodSet (e.g., \ref SCCP1_Timer_PeriodSet or \ref TMR1_PeriodSet).
|
|
|
|
uint32_t (*PeriodGet)(void);
|
|
///< Pointer to MCCPx_Timer_PeriodGet, SCCPx_Timer_PeriodGet or TMRx_PeriodGet (e.g., \ref SCCP1_Timer_PeriodGet or \ref TMR1_PeriodGet).
|
|
|
|
uint32_t (*CounterGet)(void);
|
|
///< Pointer to MCCPx_Timer_CounterGet, SCCPx_Timer_CounterGet or TMRx_CounterGet (e.g., \ref SCCP1_Timer_CounterGet or \ref TMR1_CounterGet).
|
|
|
|
void (*CounterSet)(uint32_t count);
|
|
///< Pointer to MCCPx_Timer_CounterSet, SCCPx_Timer_CounterSet or TMRx_CounterSet (e.g., \ref SCCP1_Timer_CounterSet or \ref TMR1_CounterSet).
|
|
|
|
uint32_t (*MaxCountGet)(void);
|
|
///< Pointer to MCCPx_Timer_MaxCountGet, SCCPx_Timer_MaxCountGet or TMRx_MaxCountGet (e.g., \ref SCCP1_Timer_MaxCountGet or \ref TMR1_MaxCountGet).
|
|
|
|
#if TIMER_INTERRUPT_PRIORITY_SUPPORT
|
|
void (*InterruptPrioritySet)(enum INTERRUPT_PRIORITY priority);
|
|
///< Pointer to MCCPx_Timer_InterruptPrioritySet, SCCPx_Timer_InterruptPrioritySet or TMRx_InterruptPrioritySet (e.g., \ref SCCP1_Timer_InterruptPrioritySet or \ref TMR1_InterruptPrioritySet).
|
|
#endif
|
|
|
|
void (*TimeoutCallbackRegister)(void (*CallbackHandler)(void));
|
|
///< Pointer to MCCPx_TimeoutCallbackRegister, SCCPx_TimeoutCallbackRegister or TMRx_TimeoutCallbackRegister (e.g., \ref SCCP1_TimeoutCallbackRegister or \ref TMR1_TimeoutCallbackRegister).
|
|
|
|
void (*Tasks)(void);
|
|
///< Pointer to MCCPx_Timer_Tasks, SCCPx_Timer_Tasks or TMRx_Tasks (e.g., \ref SCCP1_Timer_Tasks or \ref TMR1_Tasks, supported only in Polling mode).
|
|
};
|
|
|
|
#endif // TIMER_INTERFACE_H
|
|
|