MINI58_BSP V3.01.005
The Board Support Package for Mini58 Series MCU
Macros | Functions
timer.h File Reference

Mini58 series TIMER driver header file. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define TIMER_ONESHOT_MODE   (0UL)
 
#define TIMER_PERIODIC_MODE   (1UL << TIMER_CTL_OPMODE_Pos)
 
#define TIMER_TOGGLE_MODE   (2UL << TIMER_CTL_OPMODE_Pos)
 
#define TIMER_CONTINUOUS_MODE   (3UL << TIMER_CTL_OPMODE_Pos)
 
#define TIMER_CAPTURE_FREE_COUNTING_MODE   (0UL)
 
#define TIMER_CAPTURE_TRIGGER_COUNTING_MODE   (TIMER_EXTCTL_CAPSEL_Msk)
 
#define TIMER_CAPTURE_COUNTER_RESET_MODE   (TIMER_EXTCTL_CAPFUNCS_Msk)
 
#define TIMER_CAPTURE_FALLING_EDGE   (0UL)
 
#define TIMER_CAPTURE_RISING_EDGE   (1UL << TIMER_EXTCTL_CAPEDGE_Pos)
 
#define TIMER_CAPTURE_FALLING_THEN_RISING_EDGE   (2UL << TIMER_EXTCTL_CAPEDGE_Pos)
 
#define TIMER_CAPTURE_RISING_THEN_FALLING_EDGE   (3UL << TIMER_EXTCTL_CAPEDGE_Pos)
 
#define TIMER_COUNTER_RISING_EDGE   (TIMER_EXTCTL_CNTPHASE_Msk)
 
#define TIMER_COUNTER_FALLING_EDGE   (0UL)
 
#define TIMER_TOGGLE_TMX_CNT_OUT   (0UL)
 
#define TIMER_TOGGLE_TMX_EXT   (TIMER_CTL_TGLPINSEL_Msk)
 
#define TIMER_SET_CMP_VALUE(timer, u32Value)
 This macro is used to set new Timer compared value. More...
 
#define TIMER_SET_PRESCALE_VALUE(timer, u32Value)
 This macro is used to set new Timer prescale value. More...
 
#define TIMER_IS_ACTIVE(timer)
 This macro is used to check if specify Timer is inactive or active. More...
 
#define TIMER_SELECT_TOUT_PIN(timer, u32ToutSel)
 This macro is used to select Timer toggle output pin. More...
 

Functions

__STATIC_INLINE void TIMER_Start (TIMER_T *timer)
 This function is used to start Timer counting. More...
 
__STATIC_INLINE void TIMER_Stop (TIMER_T *timer)
 This function is used to stop Timer counting. More...
 
__STATIC_INLINE void TIMER_EnableWakeup (TIMER_T *timer)
 This function is used to enable the Timer wake-up function. More...
 
__STATIC_INLINE void TIMER_DisableWakeup (TIMER_T *timer)
 This function is used to disable the Timer wake-up function. More...
 
__STATIC_INLINE void TIMER_EnableCaptureDebounce (TIMER_T *timer)
 This function is used to enable the capture pin detection de-bounce function. More...
 
__STATIC_INLINE void TIMER_DisableCaptureDebounce (TIMER_T *timer)
 This function is used to disable the capture pin detection de-bounce function. More...
 
__STATIC_INLINE void TIMER_EnableEventCounterDebounce (TIMER_T *timer)
 This function is used to enable the counter pin detection de-bounce function. More...
 
__STATIC_INLINE void TIMER_DisableEventCounterDebounce (TIMER_T *timer)
 This function is used to disable the counter pin detection de-bounce function. More...
 
__STATIC_INLINE void TIMER_EnableInt (TIMER_T *timer)
 This function is used to enable the Timer time-out interrupt function. More...
 
__STATIC_INLINE void TIMER_DisableInt (TIMER_T *timer)
 This function is used to disable the Timer time-out interrupt function. More...
 
__STATIC_INLINE void TIMER_EnableCaptureInt (TIMER_T *timer)
 This function is used to enable the Timer capture trigger interrupt function. More...
 
__STATIC_INLINE void TIMER_DisableCaptureInt (TIMER_T *timer)
 This function is used to disable the Timer capture trigger interrupt function. More...
 
__STATIC_INLINE uint32_t TIMER_GetIntFlag (TIMER_T *timer)
 This function indicates Timer time-out interrupt occurred or not. More...
 
__STATIC_INLINE void TIMER_ClearIntFlag (TIMER_T *timer)
 This function clears the Timer time-out interrupt flag. More...
 
__STATIC_INLINE uint32_t TIMER_GetCaptureIntFlag (TIMER_T *timer)
 This function indicates Timer capture interrupt occurred or not. More...
 
__STATIC_INLINE void TIMER_ClearCaptureIntFlag (TIMER_T *timer)
 This function clears the Timer capture interrupt flag. More...
 
__STATIC_INLINE uint32_t TIMER_GetWakeupFlag (TIMER_T *timer)
 This function indicates Timer has waked up system or not. More...
 
__STATIC_INLINE void TIMER_ClearWakeupFlag (TIMER_T *timer)
 This function clears the Timer wakeup interrupt flag. More...
 
__STATIC_INLINE uint32_t TIMER_GetCaptureData (TIMER_T *timer)
 This function gets the Timer capture data. More...
 
__STATIC_INLINE uint32_t TIMER_GetCounter (TIMER_T *timer)
 This function reports the current timer counter value. More...
 
uint32_t TIMER_Open (TIMER_T *timer, uint32_t u32Mode, uint32_t u32Freq)
 This API is used to configure timer to operate in specified mode and frequency. If timer cannot work in target frequency, a closest frequency will be chose and returned. More...
 
void TIMER_Close (TIMER_T *timer)
 This API stops Timer counting and disable the Timer interrupt function. More...
 
void TIMER_Delay (TIMER_T *timer, uint32_t u32Usec)
 This API is used to create a delay loop for u32usec micro seconds. More...
 
void TIMER_EnableCapture (TIMER_T *timer, uint32_t u32CapMode, uint32_t u32Edge)
 This API is used to enable timer capture function with specified mode and capture edge. More...
 
void TIMER_DisableCapture (TIMER_T *timer)
 This API is used to disable the Timer capture function. More...
 
void TIMER_EnableEventCounter (TIMER_T *timer, uint32_t u32Edge)
 This function is used to enable the Timer counter function with specify detection edge. More...
 
void TIMER_DisableEventCounter (TIMER_T *timer)
 This API is used to disable the Timer event counter function. More...
 
uint32_t TIMER_GetModuleClock (TIMER_T *timer)
 This API is used to get the clock frequency of Timer. More...
 

Detailed Description

Mini58 series TIMER driver header file.

Version
V1.00
Revision
7
Date
15/05/27 11:56a
Note
SPDX-License-Identifier: Apache-2.0 Copyright (C) 2022 Nuvoton Technology Corp. All rights reserved.

Definition in file timer.h.